WheelEncoder Class Reference

API for the DFRobot Wheel Encoder. More...

Detailed Description

• ID: wheelencoder
• Name: DFRobot Wheel Encoder
• Category: other
• Manufacturer: dfrobot
• Link: http://www.dfrobot.com/index.php?route=product/product&product_id=98
• Connection: gpio This sensor was developed for the DFRobot Wheel Encoder, though it could be used for any counting time-based task.

When you instantiate a class of this type, the gpio pin specified is connected to an interrupt. Whenever a low to high transition occurs on the gpio pin, the internal counter is incremented by one.

This class also includes a millisecond counter, so that you can correlate the number of counts to a time period for calculating an RPM or other value as needed.

Public Member Functions
synchronized void	delete ()
	WheelEncoder (int pin)
long	getMillis ()
void	initClock ()
void	clearCounter ()
void	startCounter ()
void	stopCounter ()
long	counter ()

Constructor & Destructor Documentation

WheelEncoder

(

int

pin

)

DFRobot Wheel Encoder sensor constructor

Parameters

pin	Digital pin to use

Member Function Documentation

void clearCounter

(

)

Resets the counter to 0. The counter should be stopped via stopCounter() prior to calling this function.

long counter

(

)

Gets the current counter value

Returns

counter value

long getMillis

(

)

Returns the number of milliseconds elapsed since initClock() was last called.

Returns

Elapsed milliseconds

void initClock

(

)

Resets the clock

void startCounter

(

)

Starts the counter. This function will also clear the current count and reset the clock.

void stopCounter

(

)

Stops the counter

---

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

• /var/lib/jenkins/workspace/upm-doc-stable/build-33/src/wheelencoder/WheelEncoder.java