rotaryio
– Support for reading rotation sensors¶
The rotaryio
module contains classes to read different rotation encoding schemes. See
Wikipedia’s Rotary Encoder page for more
background.
Warning
This module is not available in some SAMD21 (aka M0) builds. See the Support Matrix for more info.
All classes change hardware state and should be deinitialized when they
are no longer needed if the program continues after use. To do so, either
call deinit()
or use a context manager. See
Lifetime and ContextManagers for more info.
-
class
rotaryio.
IncrementalEncoder
(pin_a: microcontroller.Pin, pin_b: microcontroller.Pin)¶ IncrementalEncoder determines the relative rotational position based on two series of pulses.
Create an IncrementalEncoder object associated with the given pins. It tracks the positional state of an incremental rotary encoder (also known as a quadrature encoder.) Position is relative to the position when the object is contructed.
- Parameters
For example:
import rotaryio import time from board import * enc = rotaryio.IncrementalEncoder(D1, D2) last_position = None while True: position = enc.position if last_position == None or position != last_position: print(position) last_position = position
-
position
:int¶ The current position in terms of pulses. The number of pulses per rotation is defined by the specific hardware.
-
deinit
(self) → None¶ Deinitializes the IncrementalEncoder and releases any hardware resources for reuse.
-
__enter__
(self) → IncrementalEncoder¶ No-op used by Context Managers.
-
__exit__
(self) → None¶ Automatically deinitializes the hardware when exiting a context. See Lifetime and ContextManagers for more info.