DigitalHooks Class Reference
Class to customise behaviour for digital functions. More...
#include <DigitalHooks.h>
Public Member Functions | |
virtual void | badPin (const char *function, uint16_t pin) |
Report invalid pin number. More... | |
virtual bool | pinMode (uint16_t pin, uint8_t mode) |
Set pin mode. More... | |
virtual void | digitalWrite (uint16_t pin, uint8_t val) |
Change pin output. More... | |
virtual uint8_t | digitalRead (uint16_t pin, uint8_t mode) |
Read pin state. More... | |
virtual void | pullup (uint16_t pin, bool enable) |
Set or clear pullup state for a pin. More... | |
virtual unsigned long | pulseIn (uint16_t pin, uint8_t state, unsigned long timeout) |
Measure duration of pulse on GPIO. More... | |
virtual uint16_t | analogRead (uint16_t pin) |
Sample analogue input. More... | |
Detailed Description
Class to customise behaviour for digital functions.
- Note
- By default, actions get output to console but this can get very busy. The easiest way to change the behaviour is by sub-classing DigitalHooks and passing the new class instance to
setDigitalHooks()
.
Member Function Documentation
◆ analogRead()
Sample analogue input.
- Parameters
-
pin GPIO to read
- Return values
-
uint16_t Sample value
◆ badPin()
|
virtual |
Report invalid pin number.
- Parameters
-
function Name of function which was called pin The pin number
◆ digitalRead()
Read pin state.
- Parameters
-
pin Has already been range checked mode The currently set mode for this pin val State for pin
◆ digitalWrite()
Change pin output.
- Parameters
-
pin Has already been range checked val New pin value
◆ pinMode()
Set pin mode.
- Parameters
-
pin Has already been range checked mode
- Return values
-
true if mode can be set for this pin, will be stored
◆ pullup()
Set or clear pullup state for a pin.
- Parameters
-
pin Has already been range checked enable true for pullup, false for no pullup
◆ pulseIn()
|
virtual |
Measure duration of pulse on GPIO.
- Parameters
-
pin GPIO to measure state State of pulse to measure [HIGH | LOW] timeout Maximum duration of pulse
- Return values
-
unsigned long Pulse duration in microseconds
The documentation for this class was generated from the following file: