djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentation for rotaryio.IncrementalEncoder

Browse Source 
Update the documentation in circuitpython/shared-bindings/rotaryio/IncrementalEncoder.c
to explicitly state that rotaryio.IncrementalEncoder assumes the encoder's pins are
connected to ground and sets pull-ups on the pins accordingly.

Closes #5847

Signed-off-by: Sumitra Sharma <sumitraartsy@gmail.com>
This commit is contained in:
Sumitra Sharma 2023-10-02 21:05:21 +05:30
parent ed4d4a6b43
commit fd4a61233e
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
shared-bindings/rotaryio/IncrementalEncoder.c
View File

@ -35,7 +35,9 @@
#include "shared-bindings/util.h" #include "shared-bindings/util.h"
//| class IncrementalEncoder: //| class IncrementalEncoder:
//| """IncrementalEncoder determines the relative rotational position based on two series of pulses.""" //| """IncrementalEncoder determines the relative rotational position based on two series of pulses.
//| It assumes that the encoder's common pin(s) are connected to ground,and enables pull-ups on
//| pin_a and pin_b."""
//| //|
//| def __init__( //| def __init__(
//| self, pin_a: microcontroller.Pin, pin_b: microcontroller.Pin, divisor: int = 4 //| self, pin_a: microcontroller.Pin, pin_b: microcontroller.Pin, divisor: int = 4