RotaryEncoder Class Reference

API for the Grove Rotary Encoder. More...

Detailed Description

• ID: rotaryencoder
• Name: Grove Rotary Encoder
• Category: other
• Manufacturer: seeed
• Link: http://www.seeedstudio.com/wiki/Grove_-_Encoder
• Connection: gpio
• Kit: hak

UPM module for the Grove rotary encoder. This rotary encoder encodes a rotation signal into electronic pulses that can be used to measure rotation and direction. It is useful in cases where a rotary knob is required, but using a potentiometer is not desirable. A rotary encoder can turn a full 360 degrees without a stop and does not place a resistive load on the circuit, as is the case with a potentiometer.

This module maintains a position that is incremented or decremented according to the rotation on the encoder.

  // Instantiate a Grove Rotary Encoder, using signal pins D2 and D3
  upm::RotaryEncoder* rotaryencoder = new upm::RotaryEncoder(2, 3);
  
  while (shouldRun)
    {
      cout << "Position: " << rotaryencoder->position() << endl;
      usleep(100000);
    }

Public Member Functions
	RotaryEncoder (int pinA, int pinB)
	~RotaryEncoder ()
void	initPosition (int count=0)
int	position ()

Static Public Member Functions
static void	signalAISR (void *ctx)

Constructor & Destructor Documentation

RotaryEncoder	(	int	pinA,
		int	pinB
	)

RotaryEncoder constructor

Parameters

pinA	Digital pin to use for signal A
pinB	Digital pin to use for signal B

~RotaryEncoder

(

)

RotaryEncoder destructor

Member Function Documentation

void initPosition

(

int

count = 0

)

Resets the position to a given number; default is 0.

Parameters

count

Integer to initialize the position to

int position

(

)

Gets the position value

void signalAISR ( void *  ctx )

static

Interrupt service routine (ISR) for signal A

Parameters

ctx	User context for the ISR (*this pointer)

---

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

• /var/lib/jenkins/workspace/upm-doc-stable/src/rotaryencoder/rotaryencoder.h
• /var/lib/jenkins/workspace/upm-doc-stable/src/rotaryencoder/rotaryencoder.cxx