Public Member Functions | Public Attributes | Private Member Functions | List of all members
rotary_encoder.decoder Class Reference

Public Member Functions

def __init__ (self, pi, gpioA, gpioB, callback)
 
def cancel (self)
 

Public Attributes

 callback
 
 cbA
 
 cbB
 
 gpioA
 
 gpioB
 
 lastGpio
 
 levA
 
 levB
 
 pi
 

Private Member Functions

def _pulse (self, gpio, level, tick)
 

Detailed Description

Class to decode mechanical rotary encoder pulses.

Definition at line 5 of file rotary_encoder.py.

Constructor & Destructor Documentation

◆ __init__()

def rotary_encoder.decoder.__init__ (   self,
  pi,
  gpioA,
  gpioB,
  callback 
)
Instantiate the class with the pi and gpios connected to
rotary encoder contacts A and B.  The common contact
should be connected to ground.  The callback is
called when the rotary encoder is turned.  It takes
one parameter which is +1 for clockwise and -1 for
counterclockwise.

EXAMPLE

import time
import pigpio

import rotary_encoder

pos = 0

def callback(way):

   global pos

   pos += way

   print("pos={}".format(pos))

pi = pigpio.pi()

decoder = rotary_encoder.decoder(pi, 7, 8, callback)

time.sleep(300)

decoder.cancel()

pi.stop()

Definition at line 9 of file rotary_encoder.py.

Member Function Documentation

◆ _pulse()

def rotary_encoder.decoder._pulse (   self,
  gpio,
  level,
  tick 
)
private
Decode the rotary encoder pulse.

       +---------+         +---------+      0
       |         |         |         |
   A         |         |         |         |
       |         |         |         |
   +---------+         +---------+         +----- 1

 +---------+         +---------+            0
 |         |         |         |
   B   |         |         |         |
 |         |         |         |
   ----+         +---------+         +---------+  1

Definition at line 67 of file rotary_encoder.py.

◆ cancel()

def rotary_encoder.decoder.cancel (   self)
Cancel the rotary encoder decoder.

Definition at line 100 of file rotary_encoder.py.

Member Data Documentation

◆ callback

rotary_encoder.decoder.callback

Definition at line 51 of file rotary_encoder.py.

◆ cbA

rotary_encoder.decoder.cbA

Definition at line 64 of file rotary_encoder.py.

◆ cbB

rotary_encoder.decoder.cbB

Definition at line 65 of file rotary_encoder.py.

◆ gpioA

rotary_encoder.decoder.gpioA

Definition at line 49 of file rotary_encoder.py.

◆ gpioB

rotary_encoder.decoder.gpioB

Definition at line 50 of file rotary_encoder.py.

◆ lastGpio

rotary_encoder.decoder.lastGpio

Definition at line 56 of file rotary_encoder.py.

◆ levA

rotary_encoder.decoder.levA

Definition at line 53 of file rotary_encoder.py.

◆ levB

rotary_encoder.decoder.levB

Definition at line 54 of file rotary_encoder.py.

◆ pi

rotary_encoder.decoder.pi

Definition at line 48 of file rotary_encoder.py.


The documentation for this class was generated from the following file:


cob_hand_bridge
Author(s): Mathias Lüdtke
autogenerated on Tue Aug 2 2022 02:13:57