Loading...
Searching...
No Matches
VLCB::EventProducerServiceWithDiagnostics Class Reference
#include <EventProducerServiceWithDiagnostics.h>
Inheritance diagram for VLCB::EventProducerServiceWithDiagnostics:
Public Member Functions | |
| virtual void | reportDiagnostics (byte serviceIndex, byte diagnosticsCode) override |
| Report a given diagnostic value. | |
| virtual int | getDiagnosticCount () override |
| report how many diagnostics this service supports. | |
| Public Member Functions inherited from VLCB::EventProducerService | |
| void | setRequestEventHandler (void(*fptr)(byte index, const VlcbMessage *msg)) |
| register the user handler for learned events | |
| virtual void | processAction (const Action &action) override |
| Called when there is an action available. | |
| virtual VlcbServiceTypes | getServiceID () const override |
| Return a unique ID for this service. | |
| virtual byte | getServiceVersionID () const override |
| Return the version of the service specification implemented by this service. | |
| void | sendShortEvent (bool state, int eventNumber) |
| Send a short event. | |
| void | sendLongEvent (bool state, int eventNumber) |
| Send a long event. | |
| void | sendLongEventWithSpoofedNodeNumber (bool state, int nodeNumber, int eventNumber) |
| Send a long event with a spoofed node number. | |
| void | sendEventAtIndex (bool state, byte evIndex) |
| Send an event from the taught events table. | |
| void | sendEventAtIndex (bool state, byte evIndex, byte data1) |
| Send an event from the taught events table with data. | |
| void | sendEventAtIndex (bool state, byte evIndex, byte data1, byte data2) |
| Send an event from the taught events table with data. | |
| void | sendEventAtIndex (bool state, byte evIndex, byte data1, byte data2, byte data3) |
| Send an event from the taught events table with data. | |
| void | sendEventResponse (bool state, byte index) |
| void | sendEventResponse (bool state, byte index, byte data1) |
| void | sendEventResponse (bool state, byte index, byte data1, byte data2) |
| void | sendEventResponse (bool state, byte index, byte data1, byte data2, byte data3) |
| Public Member Functions inherited from VLCB::Service | |
| void | setController (Controller *ctrl) |
| Set a pointer to the controller object for use in implementing class. | |
| virtual void | begin () |
| This optional method is called at the beginning of the Arduino sketch. Define this method for the service to do any setup required at the beginning. | |
| virtual void | process () |
| This method that be called regularly from the VLCB core to let the service perform regular tasks. | |
| virtual Data | getServiceData () |
| Return Data bytes specific for the implementing service. The meaning of each data byte is defined in the service specification. | |
Additional Inherited Members | |
| Protected Member Functions inherited from VLCB::Service | |
| bool | isThisNodeNumber (unsigned int nodeNumber) |
| Helper function to decide if a given node number is the same as that assigned to this node. | |
| Protected Attributes inherited from VLCB::EventProducerService | |
| unsigned int | diagEventsProduced = 0 |
| Protected Attributes inherited from VLCB::Service | |
| Controller * | controller |
| Pointer to the Controller object that can be used by implementing classes. | |
Member Function Documentation
◆ reportDiagnostics()
|
overridevirtual |
Report a given diagnostic value.
- Parameters
-
serviceIndex index of the service. Not used by the implementation, just passed through to the response message. diagnosticsCode code for the diagnostic to report. This code is specific to the implemented service.
Reimplemented from VLCB::Service.
◆ getDiagnosticCount()
|
overridevirtual |
report how many diagnostics this service supports.
Reimplemented from VLCB::Service.
The documentation for this class was generated from the following files:
