nanoFramework.Iot.Device.RotaryEncoder 1.1.1

Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package nanoFramework.Iot.Device.RotaryEncoder --version 1.1.1
                    
NuGet\Install-Package nanoFramework.Iot.Device.RotaryEncoder -Version 1.1.1
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="nanoFramework.Iot.Device.RotaryEncoder" Version="1.1.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="nanoFramework.Iot.Device.RotaryEncoder" Version="1.1.1" />
                    
Directory.Packages.props
<PackageReference Include="nanoFramework.Iot.Device.RotaryEncoder" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add nanoFramework.Iot.Device.RotaryEncoder --version 1.1.1
                    
#r "nuget: nanoFramework.Iot.Device.RotaryEncoder, 1.1.1"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package nanoFramework.Iot.Device.RotaryEncoder@1.1.1
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=nanoFramework.Iot.Device.RotaryEncoder&version=1.1.1
                    
Install as a Cake Addin
#tool nuget:?package=nanoFramework.Iot.Device.RotaryEncoder&version=1.1.1
                    
Install as a Cake Tool

Quadrature Rotary Encoder

A Rotary encoder is a device that detects angular position. One use of this is similar to a volume control on an FM radio where the user turns a shaft and the loudness of the broadcast is changed. Incremental rotary encoders do not provide information on their exact position but supply information about how much they have moved and in which direction.

Board

image of rotary encoder

Typically a quadrature rotary encoder will have two outputs A and B, perhaps called clock and data. For each part of a rotation then the A pin will provide a clock signal and the B pin will provide a data signal that is out of phase with the clock. The sign of the phase difference between the pins indicates the direction of rotation.

encoder

From above if we look at Pin B (data) at the time of a falling edge on Pin A (clk) then the if the value of pin P is 1 then the direction is clockwise and if it is 0 then the rotation is counter clockwise.

Usage

This sample shows how to implement an FM radio tuner control using the ScaledQuadradureEncoder binding. It simply prints the tuner value to the console as the knob is turned.

rotary example

This binding implements scaled quadrature rotary encoder as ScaledQuadratureEncoder. The value is a double. You can for example set it up as a tuning dial for an FM radio with a range of 88.0 to 108.0 with a step of 0.1.

The code below shows an example of using the encoder as an FM tuner control.

// create a RotaryEncoder that represents an FM Radio tuning dial with a range of 88 -> 108 MHz
ScaledQuadratureEncoder encoder = new ScaledQuadratureEncoder(pinA: 5, pinB: 6, PinEventTypes.Falling, pulsesPerRotation: 20, pulseIncrement: 0.1, rangeMin: 88.0, rangeMax: 108.0) { Value = 88 };
// 2 milliseconds debonce time
encoder.Debounce = TimeSpan.FromMilliseconds(2);
// Register to Value change events
encoder.ValueChanged += (o, e) =>
{
    Debug.WriteLine($"Tuned to {e.Value}MHz");
};

This binding also features

  • Debounce functionality on the clock signal.
  • Acceleration so that rotating the encoder moves it further the faster the rotation.
  • Events when the value changes.

Also available is a QuadratureRotaryEncoder binding which has properties that represent the rotation of the encoder and the raw pulses.

Limitations

This binding is suitable for manual and small rotations where it is not a big deal if one or few rotations may be lost.

This binding is not suitable for motor control with a very high rate and very precise number of counts.

The precision really depends of the hardware you are using and it is not possible to give specific range of usage. You may have to try to understand if this is working for you or not.

Product Compatible and additional computed target framework versions.
.NET Framework net is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.2.864 221 4/2/2025
1.2.852 205 3/11/2025
1.2.822 155 2/26/2025
1.2.775 164 2/4/2025
1.2.772 148 2/4/2025
1.2.755 148 1/31/2025
1.2.737 133 1/13/2025
1.2.696 156 12/16/2024
1.2.673 163 10/23/2024
1.2.662 151 10/11/2024
1.2.631 158 8/28/2024
1.2.590 167 7/17/2024
1.2.570 166 6/14/2024
1.2.560 168 5/29/2024
1.2.548 150 5/15/2024
1.2.436 285 11/10/2023
1.2.416 157 11/8/2023
1.2.329 279 5/26/2023
1.2.313 260 5/12/2023
1.2.297 266 5/3/2023
1.2.208 438 1/3/2023
1.2.203 422 12/28/2022
1.2.159 505 11/14/2022
1.2.153 483 11/5/2022
1.2.141 524 10/25/2022
1.2.128 505 10/22/2022
1.2.125 532 10/12/2022
1.2.122 588 10/12/2022
1.2.114 543 10/8/2022
1.2.95 551 9/22/2022
1.2.87 598 9/15/2022
1.2.73 531 9/8/2022
1.1.116.8772 572 6/24/2022
1.1.113.2032 554 6/23/2022
1.1.58.10097 564 5/23/2022
1.1.3 580 4/15/2022
1.1.1 563 4/14/2022
1.0.277-preview.126 208 3/25/2022
1.0.277-preview.125 202 3/25/2022
1.0.277-preview.112 203 3/19/2022
1.0.277-preview.111 207 3/18/2022
1.0.277-preview.106 218 3/15/2022
1.0.277-preview.99 208 3/10/2022
1.0.277-preview.98 207 3/8/2022
1.0.277-preview.60 225 2/4/2022
1.0.277-preview.53 225 1/31/2022
1.0.277-preview.32 231 1/27/2022
1.0.277-preview.17 219 1/24/2022
1.0.277-preview.15 218 1/21/2022
1.0.277-preview.1 221 1/11/2022
1.0.259 448 12/9/2021
1.0.218 295 10/18/2021
1.0.155 484 8/31/2021
1.0.135 262 7/16/2021
1.0.134 262 7/15/2021
1.0.133 281 7/14/2021
1.0.125 292 7/5/2021
1.0.121 292 6/29/2021
1.0.119 321 6/28/2021
1.0.25 296 5/21/2021