Plugin Commands: Events Server#
The events-server plugin contributes several commands to the application framework's CLI. These commands are be used for adding, clearing, and printing events.
Macros#
plugin events-server add [endpoint:1] [logId:1] [eventId:2] [eventTime:4] [eventData:-1]
plugin events-server clear [endpoint:1] [logId:1]
plugin events-server eprint [endpoint:1] [logId:1] [index:1]
plugin events-server print [endpoint:1] [logId:1]
plugin events-server publish [nodeId:2] [srcEndpoint:1] [dstEndpoint:1] [logId:1] [index:1] [eventControl:1]
plugin events-server set [endpoint:1] [logId:1] [index:1] [eventId:2] [eventTime:4] [eventData:-1]
Macro Definition Documentation#
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_EVENTS_SERVER_PLUGIN_EVENTS_SERVER_ADD#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_EVENTS_SERVER_PLUGIN_EVENTS_SERVER_ADD
plugin events-server add [endpoint:1] [logId:1] [eventId:2] [eventTime:4] [eventData:-1]
Append the event to the event log for the provided endpoint. Once the event log is full, new events will start overwriting old events at the beginning of the table.
endpoint - INT8U - the relevant endpoint
logId - INT8U - the relevant log
eventId - INT16U - the event id
eventTime - INT32U - the event time
eventData - OCTET_STRING - additional event data
3075 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_EVENTS_SERVER_PLUGIN_EVENTS_SERVER_CLEAR#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_EVENTS_SERVER_PLUGIN_EVENTS_SERVER_CLEAR
plugin events-server clear [endpoint:1] [logId:1]
Clear out the specified event log for the provided endpoint.
endpoint - INT8U - the relevant endpoint
logId - INT8U - the log to be cleared
3082 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_EVENTS_SERVER_PLUGIN_EVENTS_SERVER_EPRINT#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_EVENTS_SERVER_PLUGIN_EVENTS_SERVER_EPRINT
plugin events-server eprint [endpoint:1] [logId:1] [index:1]
Print the event at the given index in the specified event log for the provided endpoint.
endpoint - INT8U - the relevant endpoint
logId - INT8U - the relevant log
index - INT8U - the index within the event log to print
3090 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_EVENTS_SERVER_PLUGIN_EVENTS_SERVER_PRINT#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_EVENTS_SERVER_PLUGIN_EVENTS_SERVER_PRINT
plugin events-server print [endpoint:1] [logId:1]
Print the specified event log for the provided endpoint.
endpoint - INT8U - the relevant endpoint
logId - INT8U - the log to be printed
3097 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_EVENTS_SERVER_PLUGIN_EVENTS_SERVER_PUBLISH#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_EVENTS_SERVER_PLUGIN_EVENTS_SERVER_PUBLISH
plugin events-server publish [nodeId:2] [srcEndpoint:1] [dstEndpoint:1] [logId:1] [index:1] [eventControl:1]
Publish an event.
nodeId - INT16U - the destination node id
srcEndpoint - INT8U - the source endpoint
dstEndpoint - INT8U - the destination endpoint
logId - INT8U - the relevant log
index - INT8U - the index within the event log to set
eventControl - INT8U - the event control
3108 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_EVENTS_SERVER_PLUGIN_EVENTS_SERVER_SET#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_EVENTS_SERVER_PLUGIN_EVENTS_SERVER_SET
plugin events-server set [endpoint:1] [logId:1] [index:1] [eventId:2] [eventTime:4] [eventData:-1]
Set the event at the specified index in the event log for the provided endpoint.
endpoint - INT8U - the relevant endpoint
logId - INT8U - the relevant log
index - INT8U - the index within the event log to set
eventId - INT16U - the event id
eventTime - INT32U - the event time
eventData - OCTET_STRING - additional event data
3119 of file ./app/framework/test/headers/cli.doc