SPIPerif class
#include <main/perif/SPIPerif.hpp>
Contents
A peripheral for SPI connections.
Base classes
- class Perif
Public functions
- auto begin() -> bool pure virtual
- auto isConnected() -> bool pure virtual
- void update()
- void registerHook(function<void(DevMap&)>&& hook)
Public variables
Protected functions
- void updateData() pure virtual
- void representData() pure virtual
- auto getTimer() -> Timer&
Protected variables
Function documentation
bool perif::
| Returns | whether the peripheral initialization succeeded |
|---|
Performs initialization of a peripheral. Necessary to avoid initialization in the constructor which causes many side effects.
bool perif::
| Returns | if the sensor is connected |
|---|
Returns whether the sensor is connected or not.
void perif::
Performs a manual update of peripheral data and notifies observers.
void perif::
| Parameters | |
|---|---|
| hook | the observer function |
Registers a hook for obtaining sensor data on update in Json format.
void perif::
Updates sensor data. Subclasses should maintain a reference to the data obtained from this function so it can be provided to observers.
void perif::
The representation of this peripheral's data in a meaningful way for debugging, caching, and database operations.
Timer& perif::
| Returns | a timer reference |
|---|
Obtains a reference to this peripheral's timer.
Variable documentation
DevMap perif::
The key-value mapping of peripheral data.
list<function<void(DevMap&)>> perif::
Hooks registered to this peripheral so observers can be notified of any necessary changes.
Timer perif::
A timer for managing peripheral updates.