#include "Accessories.hpp"
|
static void | begin (int inEEPROMStart = -1, int inEEPROMSize = -1) |
|
static void | RaiseEvent (unsigned long inId, ACCESSORIES_EVENT_TYPE inEvent = ACCESSORIES_EVENT_MOVEPOSITIONID, int inData = 0) |
|
static void | ReceiveEvent (unsigned long inID, ACCESSORIES_EVENT_TYPE lastEventType, int inData) |
|
static bool | loop () |
|
static void | printEvent (unsigned long inId, ACCESSORIES_EVENT_TYPE inEventType, int inEventData) |
|
static void | printAccessories () |
|
This is the main class of the library. All data and functions are static. There is no way to instantiate this class.
Definition at line 16 of file Accessories.hpp.
void Accessories::begin |
( |
int |
inEEPROMStart = -1 , |
|
|
int |
inEEPROMSize = -1 |
|
) |
| |
|
static |
Initialize the instance.
- Parameters
-
inEEPROMStart | Defines the starting byte address to save accessories status. If the size is -1, there will be no EEPROM saving. Default is -1. |
inEEPROMSize | Defines the total size of EEPROM memory available to save accessories status. If the size is -1, there will be no EEPROM saving. Default is -1. |
Definition at line 24 of file Accessories.cpp.
bool Accessories::loop |
( |
| ) |
|
|
static |
Main loop function. This function will call all necessary internal loop functions for each accessory activated...
- Returns
- True if something rest to execute.
Definition at line 156 of file Accessories.cpp.
void Accessories::printAccessories |
( |
| ) |
|
|
static |
Print the full list of declared accessories. The list is printed on the console in a hierarchical way, with details like accessories and ports. There is also all data (pins, events) associated with each item.
Definition at line 134 of file Accessories.cpp.
void Accessories::printEvent |
( |
unsigned long |
inId, |
|
|
ACCESSORIES_EVENT_TYPE |
inEventType, |
|
|
int |
inEventData |
|
) |
| |
|
static |
Print on the console the given event in plain English.
Definition at line 57 of file Accessories.cpp.
void Accessories::RaiseEvent |
( |
unsigned long |
inId, |
|
|
ACCESSORIES_EVENT_TYPE |
inEvent = ACCESSORIES_EVENT_MOVEPOSITIONID , |
|
|
int |
inData = 0 |
|
) |
| |
|
static |
Raise a new event.
- Parameters
-
inId | Id of a MovePosition of an accessory or an accessory item. |
inEvent | Type of the new event. Default is ACCESSORIES_EVENT_MOVEPOSITIONID. |
inData | Associated data to the event type. Default is 0. |
Definition at line 116 of file Accessories.cpp.
void Accessories::ReceiveEvent |
( |
unsigned long |
inID, |
|
|
ACCESSORIES_EVENT_TYPE |
lastEventType, |
|
|
int |
inData |
|
) |
| |
|
static |
Receive an event from external source.
- Parameters
-
inID | Id of the an accessory or an accessory item. |
lastEventType | Type of the new event. |
inData | Associated data to the event type. |
Definition at line 121 of file Accessories.cpp.
The documentation for this class was generated from the following files: