2021-05-17 10:29:53 -04:00
|
|
|
#pragma once
|
|
|
|
//
|
|
|
|
// FILE: rotaryDecoder.h
|
|
|
|
// AUTHOR: Rob Tillaart
|
2022-11-23 09:19:55 -05:00
|
|
|
// VERSION: 0.1.3
|
2021-05-17 10:29:53 -04:00
|
|
|
// DATE: 2021-05-08
|
|
|
|
// PURPOSE: rotary decoder library for Arduino
|
|
|
|
// URL: https://github.com/RobTillaart/rotaryDecoder
|
|
|
|
|
|
|
|
|
|
|
|
#include "Arduino.h"
|
|
|
|
#include "Wire.h"
|
|
|
|
|
2022-11-23 09:19:55 -05:00
|
|
|
#define ROTARY_DECODER_LIB_VERSION (F("0.1.3"))
|
2021-05-17 10:29:53 -04:00
|
|
|
|
|
|
|
|
|
|
|
class rotaryDecoder
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
explicit rotaryDecoder(const int8_t address, TwoWire *wire = &Wire);
|
|
|
|
|
|
|
|
#if defined (ESP8266) || defined(ESP32)
|
2021-11-15 15:55:49 -05:00
|
|
|
bool begin(uint8_t sda, uint8_t scl, uint8_t count = 4);
|
2021-05-17 10:29:53 -04:00
|
|
|
#endif
|
|
|
|
|
2021-11-15 15:55:49 -05:00
|
|
|
bool begin(uint8_t count = 4);
|
2021-05-17 10:29:53 -04:00
|
|
|
bool isConnected();
|
|
|
|
|
|
|
|
void readInitialState();
|
|
|
|
|
2022-11-23 09:19:55 -05:00
|
|
|
// for polling version,
|
|
|
|
// checkChange is bit faster than a call to update
|
|
|
|
// so useful if there are only a few updates
|
2021-05-17 10:29:53 -04:00
|
|
|
bool checkChange();
|
|
|
|
|
2022-11-23 09:19:55 -05:00
|
|
|
// read and update the counters
|
|
|
|
bool update(); // assumes two directions => +1 and -1
|
|
|
|
bool updateSingle(); // assumes single direction => + ++ +++
|
2021-05-17 10:29:53 -04:00
|
|
|
|
2022-11-23 09:19:55 -05:00
|
|
|
// re = rotary encoder
|
2021-05-17 10:29:53 -04:00
|
|
|
int32_t getValue(uint8_t re) { return _encoder[re]; };
|
2021-11-15 15:55:49 -05:00
|
|
|
void setValue(uint8_t re, int32_t value = 0) { _encoder[re] = value; };
|
2021-05-17 10:29:53 -04:00
|
|
|
|
2022-11-23 09:19:55 -05:00
|
|
|
// DEBUG
|
2021-05-17 10:29:53 -04:00
|
|
|
uint8_t getLastPosition(uint8_t re) { return _lastPos[re]; };
|
|
|
|
|
2021-12-27 15:02:58 -05:00
|
|
|
|
2021-05-17 10:29:53 -04:00
|
|
|
private:
|
2021-11-15 15:55:49 -05:00
|
|
|
uint8_t _count = 0;
|
|
|
|
uint8_t _lastValue = 0;
|
2021-05-17 10:29:53 -04:00
|
|
|
uint8_t _lastPos[4] = { 0,0,0,0 };
|
|
|
|
int32_t _encoder[4] = { 0,0,0,0 };
|
|
|
|
|
|
|
|
uint8_t _read8();
|
|
|
|
uint8_t _address;
|
|
|
|
TwoWire * _wire;
|
|
|
|
};
|
|
|
|
|
2021-12-27 15:02:58 -05:00
|
|
|
|
2022-11-23 09:19:55 -05:00
|
|
|
// -- END OF FILE --
|
2021-12-27 15:02:58 -05:00
|
|
|
|