Serial Wombat Arduino Library
serialWombatQuadEnc.h
Go to the documentation of this file.
1 #pragma once
2 #include <stdint.h>
3 #include "SerialWombat.h"
4 
5 class SerialWombat;
6 
10 typedef enum
11 {
19 
20 
21 
76 {
77 public:
78 
81  SerialWombatQuadEnc(SerialWombat& serialWombat);
82 
90  void begin(uint8_t pin, uint8_t secondPin);
91 
100  void begin(uint8_t pin, uint8_t secondPin, uint16_t debounce_mS, bool pullUpsEnabled);
101 
110  void begin(uint8_t pin, uint8_t secondPin, uint16_t debounce_mS, bool pullUpsEnabled, QE_READ_MODE_t readState);
111 
114  uint16_t read();
115 
123 
124  uint16_t read(uint16_t replacementValue);
125 
128  void write(uint16_t value);
129 private:
130  SerialWombat& _sw;
131  uint8_t _pin = 255;
132  uint8_t _secondPin;
133 };
134 
SerialWombatQuadEnc::begin
void begin(uint8_t pin, uint8_t secondPin)
Simple initialization for SerialWombatQuadEnc.
Definition: serialWombatQuadEnc.cpp:10
QE_READ_MODE_t
QE_READ_MODE_t
Definition: serialWombatQuadEnc.h:10
QE_ONBOTH_POLL
@ QE_ONBOTH_POLL
1mS Polling, process on low to high and high to low transition
Definition: serialWombatQuadEnc.h:17
SerialWombatQuadEnc::SerialWombatQuadEnc
SerialWombatQuadEnc(SerialWombat &serialWombat)
Constructor for the SerialWombatQuadEnc class.
Definition: serialWombatQuadEnc.cpp:3
QE_ONHIGH_INT
@ QE_ONHIGH_INT
Interrupt driven, process on low to high transition.
Definition: serialWombatQuadEnc.h:13
QE_ONHIGH_POLL
@ QE_ONHIGH_POLL
1mS Polling, process on low to high transition
Definition: serialWombatQuadEnc.h:16
SerialWombat.h
QE_ONBOTH_INT
@ QE_ONBOTH_INT
Interrupt driven, process on low to high and high to low transition.
Definition: serialWombatQuadEnc.h:14
SerialWombatQuadEnc::read
uint16_t read()
Read the quadrature encoder position from the Serial Wombat.
Definition: serialWombatQuadEnc.cpp:29
SerialWombatQuadEnc
A class that uses two Serial Wombat input pins to read quadrature encoder input.
Definition: serialWombatQuadEnc.h:75
SerialWombat
Definition: SerialWombat.h:72
QE_ONLOW_POLL
@ QE_ONLOW_POLL
1mS Polling, process on high to low transition
Definition: serialWombatQuadEnc.h:15
QE_ONLOW_INT
@ QE_ONLOW_INT
Interrupt driven, process on high to low transition.
Definition: serialWombatQuadEnc.h:12
SerialWombatQuadEnc::write
void write(uint16_t value)
This function initializes the position of the encoder.
Definition: serialWombatQuadEnc.cpp:39