Class to customise behaviour for digital functions.
More...
#include <DigitalHooks.h>
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()
.
◆ analogRead()
virtual uint16_t DigitalHooks::analogRead |
( |
uint16_t |
pin | ) |
|
|
virtual |
Sample analogue input.
- Parameters
-
- Return values
-
◆ badPin()
virtual void DigitalHooks::badPin |
( |
const char * |
function, |
|
|
uint16_t |
pin |
|
) |
| |
|
virtual |
Report invalid pin number.
- Parameters
-
function | Name of function which was called |
pin | The pin number |
◆ digitalRead()
virtual uint8_t DigitalHooks::digitalRead |
( |
uint16_t |
pin, |
|
|
uint8_t |
mode |
|
) |
| |
|
virtual |
Read pin state.
- Parameters
-
pin | Has already been range checked |
mode | The currently set mode for this pin |
val | State for pin |
◆ digitalWrite()
virtual void DigitalHooks::digitalWrite |
( |
uint16_t |
pin, |
|
|
uint8_t |
val |
|
) |
| |
|
virtual |
Change pin output.
- Parameters
-
pin | Has already been range checked |
val | New pin value |
◆ pinMode()
virtual bool DigitalHooks::pinMode |
( |
uint16_t |
pin, |
|
|
uint8_t |
mode |
|
) |
| |
|
virtual |
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()
virtual void DigitalHooks::pullup |
( |
uint16_t |
pin, |
|
|
bool |
enable |
|
) |
| |
|
virtual |
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 unsigned long DigitalHooks::pulseIn |
( |
uint16_t |
pin, |
|
|
uint8_t |
state, |
|
|
unsigned long |
timeout |
|
) |
| |
|
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: