Skip to content

Stutchbury/EncoderAdapter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

EncoderAdapter

EncoderAdapter is a library providing a unified encoder API. Included is an implementation for PJRC's Encoder library.

Its primary use is for the InputEvents library's EventEncoder and EventEncoderButton classes but can also be used as a general purpose encoder adapter when writing code for different boards.

The library provides a consistent encoder API, specifying three methods that must be implemeted by concrete classes:

  • bool EncoderAdapter::begin(void)
  • int32_t EncoderAdapter::getPosition(void)
  • void EncoderAdapter::setPosition(int32_t)

Concrete implementations will likely have more methods and should implement all those required to configure the underlying library. All adapters are 'header only' to allow the Arduino IDE to compile when the underlying encoder libraries are not installed.

An adapter for PJRC's popular quadrature Encoder library is provided as the PjrcEncoderAdapter class.

Note: Although this library lists no dependencies, it is dependent on whichever underlying encoder library is chosen.

Please see full Doxygen generated API documentation for more information.

About

EncoderAdapter is a library providing a unified encoder API.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages