Provides GPIO management and centralises control of any defined NODE-PINK functions.
For further information on how to use this plugin see
H4P_PinMachine bally(...This plugin is a "singleton" - there may be only one single instance of it in the app. It may be instantiated as any name the user chooses, prefix all API calls below with that name.
N/A
stop will disconnect from PinMachine and initiate closedown of all Plugins the depend on PinMachine
start will connect to PinMachine and start webserver and all dependent services
For guidance on the use of the ui... functions, see Customising the web UI
/*
Constructor
*/
H4P_PinMachine():
/*
Common parameters:
p = HPIO pin number
b = a boll ON or OFF
*/
void all(bool b); // logicalWrite(b) to ALL managed GPIO pins
uint8_t logicalRead(uint8_t p); // return LOGICAL value of pin (normalised for sense ACTIVE_LOW / _HIGH)
void logicalWrite(uint8_t p,bool b); // return LOGICAL value of pin (normalised for sense ACTIVE_LOW / _HIGH)
int getValue(uint8_t p); // return internal value conceptual pin can be -ve, ny number up to 4GB depending on pin type
msg inject(uint8_t p,uint32_t metal,bool timer=false); // used internally, user should never need to call this
bool isAnalog(uint8_t p); // true if pin is configured as an Analog pin
h4pGPIO* isManaged(uint8_t p){ return h4pPinMap.count(p) ? h4pPinMap[p]:nullptr; } // true if pin has h4pGPIO object assigned to it
bool isOutput(uint8_t p); // true is assigned h4pGPIO is in OUTPUT mode
H4_TIMER periodicRead(uint8_t p,uint32_t f); // used internally, user should never need to call this
msg runFlow(uint8_t p,msg); // used internally, user should never need to call this
Extensive examples can be found in the examples/01_GPIO_PIN_MACHINE folder
(c) 2021 Phil Bowles [email protected]