Zigbee Event Logger APIs#
This file describes functionality for the Zigbee Event Logger feature. This feature is used to record salient events in the stack and application layer. The system event data is stored in a buffer, with hooks for the application to print and decode the logged data.
See zigbee-event-logger-gen.h for source code.
Enumerations#
A list of identifiers for system events.
A list of facilities for system events, identifying which layer they occurred in.
Functions#
Record an event indicating that the device has booted.
Record an event indicating that a network was successfully joined.
Record an event indicating that a trust center rejoin was attempted.
Record an event indicating that a secure rejoin was attempted.
Record an event indicating that a device has left-without-rejoin.
Record an event indicating that a device has left-with-rejoin.
Record an event indicating that an attempt was made to update the trust center link key.
Record an event indicating that the network key sequence number has changed.
Record an event indicating that the local device has reset.
Record an event indicating that the network's channel has changed.
Record an event indicating that the local device's parent has changed.
Record an event indicating that the duty cycle has changed.
Record an event indicating that a child device has joined the local device.
Record an event indicating that a child device has been removed from the local device.
Record an event indicating that a child device has been timed out by the local device.
Record an event indicating that the stack status has changed.
Record an event indicating that the clock time has been synchronized.
Record an event indicating that a device has attempted to join or rejoin the network.
Macros#
The version of this feature.
The length of the Boot Event event data.
The length of the Join Network event data.
The length of the Trust Center Rejoin event data.
The length of the Secure Rejoin event data.
The length of the Leave Without Rejoin event data.
The length of the Leave With Rejoin event data.
The length of the Trust Center Link Key Change event data.
The length of the Network Key Sequence Number Change event data.
The length of the Reset event data.
The length of the Channel Change event data.
The length of the Parent Change event data.
The length of the Duty Cycle Change event data.
The length of the Child Added event data.
The length of the Child Removed event data.
The length of the Child Timed Out event data.
The length of the Stack Status event data.
The length of the Time Sync event data.
The length of the Trust Center Join Decision event data.
Enumeration Documentation#
EmberZigbeeLoggerEventTypes#
EmberZigbeeLoggerEventTypes
A list of identifiers for system events.
| Enumerator | |
|---|---|
| EMBER_LOGGER_ZIGBEE_BOOT_EVENT_ID | |
| EMBER_LOGGER_ZIGBEE_JOIN_NETWORK_ID | |
| EMBER_LOGGER_ZIGBEE_TRUST_CENTER_REJOIN_ID | |
| EMBER_LOGGER_ZIGBEE_SECURE_REJOIN_ID | |
| EMBER_LOGGER_ZIGBEE_LEAVE_WITHOUT_REJOIN_ID | |
| EMBER_LOGGER_ZIGBEE_LEAVE_WITH_REJOIN_ID | |
| EMBER_LOGGER_ZIGBEE_TRUST_CENTER_LINK_KEY_CHANGE_ID | |
| EMBER_LOGGER_ZIGBEE_NETWORK_KEY_SEQUENCE_NUMBER_CHANGE_ID | |
| EMBER_LOGGER_ZIGBEE_RESET_ID | |
| EMBER_LOGGER_ZIGBEE_CHANNEL_CHANGE_ID | |
| EMBER_LOGGER_ZIGBEE_PARENT_CHANGE_ID | |
| EMBER_LOGGER_ZIGBEE_DUTY_CYCLE_CHANGE_ID | |
| EMBER_LOGGER_ZIGBEE_CHILD_ADDED_ID | |
| EMBER_LOGGER_ZIGBEE_CHILD_REMOVED_ID | |
| EMBER_LOGGER_ZIGBEE_CHILD_TIMED_OUT_ID | |
| EMBER_LOGGER_ZIGBEE_STACK_STATUS_ID | |
| EMBER_LOGGER_ZIGBEE_TIME_SYNC_ID | |
| EMBER_LOGGER_ZIGBEE_TRUST_CENTER_JOIN_DECISION_ID | |
| EMBER_LOGGER_ZIGBEE_NULL_ID | |
45 of file stack/include/zigbee-event-logger-gen.hEmberZigbeeLoggerFacilityTypes#
EmberZigbeeLoggerFacilityTypes
A list of facilities for system events, identifying which layer they occurred in.
| Enumerator | |
|---|---|
| EMBER_LOGGER_ZIGBEE_FACILITY_BASE | |
| EMBER_LOGGER_ZIGBEE_FACILITY_MAC | |
| EMBER_LOGGER_ZIGBEE_FACILITY_NETWORK | |
| EMBER_LOGGER_ZIGBEE_FACILITY_APS | |
| EMBER_LOGGER_ZIGBEE_FACILITY_SECURITY | |
| EMBER_LOGGER_ZIGBEE_FACILITY_ZDO | |
| EMBER_LOGGER_ZIGBEE_FACILITY_ZCL | |
| EMBER_LOGGER_ZIGBEE_FACILITY_BDB | |
| EMBER_LOGGER_ZIGBEE_FACILITY_SMART_ENERGY | |
71 of file stack/include/zigbee-event-logger-gen.hFunction Documentation#
emberAfPluginZigBeeEventLoggerAddBootEvent#
void emberAfPluginZigBeeEventLoggerAddBootEvent (uint32_t bootCount, uint16_t resetType)
Record an event indicating that the device has booted.
| N/A | bootCount | The number of times the device has booted. |
| N/A | resetType | A reset cause. See micro.h and reset-def.h. |
Note
This API only works on SoC. It does not work on host or NCP.
125 of file stack/include/zigbee-event-logger-gen.hemberAfPluginZigBeeEventLoggerAddJoinNetwork#
void emberAfPluginZigBeeEventLoggerAddJoinNetwork (EmberPanId panId, uint8_t channelNumber, uint8_t page, uint8_t * extendedPanId)
Record an event indicating that a network was successfully joined.
| N/A | panId | The PAN ID of the network. |
| N/A | channelNumber | The channel of the network. |
| N/A | page | The page of the network joined. |
| N/A | extendedPanId | The extended PAN ID of the network. |
133 of file stack/include/zigbee-event-logger-gen.hemberAfPluginZigBeeEventLoggerAddTrustCenterRejoin#
void emberAfPluginZigBeeEventLoggerAddTrustCenterRejoin (uint32_t channelMask, EmberRejoinReason reason)
Record an event indicating that a trust center rejoin was attempted.
| N/A | channelMask | The channel mask used when searching for the network. |
| N/A | reason | An EmberRejoinReason enumeration, indicating why the rejoin was initiated. |
Note
This event only indicates that a rejoin was attempted, not that it was successful. A Join Network event, following this event, indicates success.
139 of file stack/include/zigbee-event-logger-gen.hemberAfPluginZigBeeEventLoggerAddSecureRejoin#
void emberAfPluginZigBeeEventLoggerAddSecureRejoin (uint32_t channelMask, EmberRejoinReason reason)
Record an event indicating that a secure rejoin was attempted.
| N/A | channelMask | The channel mask used when searching for the network. |
| N/A | reason | An EmberRejoinReason enumeration, indicating why the rejoin was initiated. |
Note
This event only indicates that a rejoin was attempted, not that it was successful. A Join Network event, following this event, indicates success.
145 of file stack/include/zigbee-event-logger-gen.hemberAfPluginZigBeeEventLoggerAddLeaveWithoutRejoin#
void emberAfPluginZigBeeEventLoggerAddLeaveWithoutRejoin (EmberNodeId sourceNode, EmberLeaveReason reason)
Record an event indicating that a device has left-without-rejoin.
| N/A | sourceNode | The node ID of the device leaving. |
| N/A | reason | An EmberLeaveReason enumeration, indicating why the device left. |
151 of file stack/include/zigbee-event-logger-gen.hemberAfPluginZigBeeEventLoggerAddLeaveWithRejoin#
void emberAfPluginZigBeeEventLoggerAddLeaveWithRejoin (EmberNodeId sourceNode, EmberLeaveReason reason)
Record an event indicating that a device has left-with-rejoin.
| N/A | sourceNode | The node ID of the device leaving-and-rejoining. |
| N/A | reason | An EmberLeaveReason enumeration, indicating why the device left. |
157 of file stack/include/zigbee-event-logger-gen.hemberAfPluginZigBeeEventLoggerAddTrustCenterLinkKeyChange#
void emberAfPluginZigBeeEventLoggerAddTrustCenterLinkKeyChange (void )
Record an event indicating that an attempt was made to update the trust center link key.
| N/A |
161 of file stack/include/zigbee-event-logger-gen.hemberAfPluginZigBeeEventLoggerAddNetworkKeySequenceChange#
void emberAfPluginZigBeeEventLoggerAddNetworkKeySequenceChange (uint8_t sequence)
Record an event indicating that the network key sequence number has changed.
| N/A | sequence | The new network key sequence number. |
166 of file stack/include/zigbee-event-logger-gen.hemberAfPluginZigBeeEventLoggerAddReset#
void emberAfPluginZigBeeEventLoggerAddReset (uint8_t resetCode, uint8_t extendedReason)
Record an event indicating that the local device has reset.
| N/A | resetCode | The reset code. See reset-def.h. |
| N/A | extendedReason | The extended reset reason. See reset-def.h. |
172 of file stack/include/zigbee-event-logger-gen.hemberAfPluginZigBeeEventLoggerAddChannelChange#
void emberAfPluginZigBeeEventLoggerAddChannelChange (uint8_t page, uint8_t channel)
Record an event indicating that the network's channel has changed.
| N/A | page | The new page number. |
| N/A | channel | The new channel number. |
178 of file stack/include/zigbee-event-logger-gen.hemberAfPluginZigBeeEventLoggerAddParentChange#
void emberAfPluginZigBeeEventLoggerAddParentChange (EmberNodeId parentNodeId, EmberEUI64 parentEui64)
Record an event indicating that the local device's parent has changed.
| N/A | parentNodeId | The new parent's short address. |
| N/A | parentEui64 | The new parent's long address. |
184 of file stack/include/zigbee-event-logger-gen.hemberAfPluginZigBeeEventLoggerAddDutyCycleChange#
void emberAfPluginZigBeeEventLoggerAddDutyCycleChange (EmberDutyCycleState state, EmberDutyCycleHectoPct limitThreshold, EmberDutyCycleHectoPct criticalThreshold, EmberDutyCycleHectoPct suspendedLimit)
Record an event indicating that the duty cycle has changed.
| N/A | state | An EmberDutyCycleState state. |
| N/A | limitThreshold | An EmberDutyCycleHectoPct limit. |
| N/A | criticalThreshold | An EmberDutyCycleHectoPct critical threshold. |
| N/A | suspendedLimit | An EmberDutyCycleHectoPct suspend limit. |
192 of file stack/include/zigbee-event-logger-gen.hemberAfPluginZigBeeEventLoggerAddChildAdded#
void emberAfPluginZigBeeEventLoggerAddChildAdded (EmberNodeId childNodeId, EmberEUI64 childEui64)
Record an event indicating that a child device has joined the local device.
| N/A | childNodeId | The child's short address. |
| N/A | childEui64 | The child's long address. |
198 of file stack/include/zigbee-event-logger-gen.hemberAfPluginZigBeeEventLoggerAddChildRemoved#
void emberAfPluginZigBeeEventLoggerAddChildRemoved (EmberNodeId childNodeId, EmberEUI64 childEui64)
Record an event indicating that a child device has been removed from the local device.
| N/A | childNodeId | The child's short address. |
| N/A | childEui64 | The child's long address. |
204 of file stack/include/zigbee-event-logger-gen.hemberAfPluginZigBeeEventLoggerAddChildTimedOut#
void emberAfPluginZigBeeEventLoggerAddChildTimedOut (EmberNodeId childNodeId, EmberEUI64 childEui64)
Record an event indicating that a child device has been timed out by the local device.
| N/A | childNodeId | The child's short address. |
| N/A | childEui64 | The child's long address. |
210 of file stack/include/zigbee-event-logger-gen.hemberAfPluginZigBeeEventLoggerAddStackStatus#
void emberAfPluginZigBeeEventLoggerAddStackStatus (EmberStatus status)
Record an event indicating that the stack status has changed.
| N/A | status | An EmberStatus value indicating the change. |
215 of file stack/include/zigbee-event-logger-gen.hemberAfPluginZigBeeEventLoggerAddTimeSync#
void emberAfPluginZigBeeEventLoggerAddTimeSync (uint32_t utcTime, uint32_t secondsSinceBoot)
Record an event indicating that the clock time has been synchronized.
| N/A | utcTime | The updated UTC time. |
| N/A | secondsSinceBoot | The number of seconds that have elapsed since boot. |
221 of file stack/include/zigbee-event-logger-gen.hemberAfPluginZigBeeEventLoggerAddTrustCenterJoinDecision#
void emberAfPluginZigBeeEventLoggerAddTrustCenterJoinDecision (EmberNodeId nodeId, uint8_t decision)
Record an event indicating that a device has attempted to join or rejoin the network.
| N/A | nodeId | The short address of the device attempting to join or rejoin. |
| N/A | decision | The join or rejoin decision taken by the local device. |
Note
This event is only recorded on a trust center device.
227 of file stack/include/zigbee-event-logger-gen.hMacro Definition Documentation#
ZIGBEE_EVENT_LOGGER_VERSION#
#define ZIGBEE_EVENT_LOGGER_VERSIONValue:
1
The version of this feature.
37 of file stack/include/zigbee-event-logger-gen.hLOGGER_AREA_BIT_SHIFT#
#define LOGGER_AREA_BIT_SHIFTValue:
12
39 of file stack/include/zigbee-event-logger-gen.hEMBER_ZIGBEE_LOGGER_AREA#
#define EMBER_ZIGBEE_LOGGER_AREAValue:
(0 << LOGGER_AREA_BIT_SHIFT)
40 of file stack/include/zigbee-event-logger-gen.hEMBER_LOGGER_ZIGBEE_BOOT_EVENT_LENGTH#
#define EMBER_LOGGER_ZIGBEE_BOOT_EVENT_LENGTHValue:
6
The length of the Boot Event event data.
84 of file stack/include/zigbee-event-logger-gen.hEMBER_LOGGER_ZIGBEE_JOIN_NETWORK_LENGTH#
#define EMBER_LOGGER_ZIGBEE_JOIN_NETWORK_LENGTHValue:
12
The length of the Join Network event data.
86 of file stack/include/zigbee-event-logger-gen.hEMBER_LOGGER_ZIGBEE_TRUST_CENTER_REJOIN_LENGTH#
#define EMBER_LOGGER_ZIGBEE_TRUST_CENTER_REJOIN_LENGTHValue:
5
The length of the Trust Center Rejoin event data.
88 of file stack/include/zigbee-event-logger-gen.hEMBER_LOGGER_ZIGBEE_SECURE_REJOIN_LENGTH#
#define EMBER_LOGGER_ZIGBEE_SECURE_REJOIN_LENGTHValue:
5
The length of the Secure Rejoin event data.
90 of file stack/include/zigbee-event-logger-gen.hEMBER_LOGGER_ZIGBEE_LEAVE_WITHOUT_REJOIN_LENGTH#
#define EMBER_LOGGER_ZIGBEE_LEAVE_WITHOUT_REJOIN_LENGTHValue:
3
The length of the Leave Without Rejoin event data.
92 of file stack/include/zigbee-event-logger-gen.hEMBER_LOGGER_ZIGBEE_LEAVE_WITH_REJOIN_LENGTH#
#define EMBER_LOGGER_ZIGBEE_LEAVE_WITH_REJOIN_LENGTHValue:
3
The length of the Leave With Rejoin event data.
94 of file stack/include/zigbee-event-logger-gen.hEMBER_LOGGER_ZIGBEE_TRUST_CENTER_LINK_KEY_CHANGE_LENGTH#
#define EMBER_LOGGER_ZIGBEE_TRUST_CENTER_LINK_KEY_CHANGE_LENGTHValue:
0
The length of the Trust Center Link Key Change event data.
96 of file stack/include/zigbee-event-logger-gen.hEMBER_LOGGER_ZIGBEE_NETWORK_KEY_SEQUENCE_NUMBER_CHANGE_LENGTH#
#define EMBER_LOGGER_ZIGBEE_NETWORK_KEY_SEQUENCE_NUMBER_CHANGE_LENGTHValue:
1
The length of the Network Key Sequence Number Change event data.
98 of file stack/include/zigbee-event-logger-gen.hEMBER_LOGGER_ZIGBEE_RESET_LENGTH#
#define EMBER_LOGGER_ZIGBEE_RESET_LENGTHValue:
2
The length of the Reset event data.
100 of file stack/include/zigbee-event-logger-gen.hEMBER_LOGGER_ZIGBEE_CHANNEL_CHANGE_LENGTH#
#define EMBER_LOGGER_ZIGBEE_CHANNEL_CHANGE_LENGTHValue:
2
The length of the Channel Change event data.
102 of file stack/include/zigbee-event-logger-gen.hEMBER_LOGGER_ZIGBEE_PARENT_CHANGE_LENGTH#
#define EMBER_LOGGER_ZIGBEE_PARENT_CHANGE_LENGTHValue:
10
The length of the Parent Change event data.
104 of file stack/include/zigbee-event-logger-gen.hEMBER_LOGGER_ZIGBEE_DUTY_CYCLE_CHANGE_LENGTH#
#define EMBER_LOGGER_ZIGBEE_DUTY_CYCLE_CHANGE_LENGTHValue:
7
The length of the Duty Cycle Change event data.
106 of file stack/include/zigbee-event-logger-gen.hEMBER_LOGGER_ZIGBEE_CHILD_ADDED_LENGTH#
#define EMBER_LOGGER_ZIGBEE_CHILD_ADDED_LENGTHValue:
10
The length of the Child Added event data.
108 of file stack/include/zigbee-event-logger-gen.hEMBER_LOGGER_ZIGBEE_CHILD_REMOVED_LENGTH#
#define EMBER_LOGGER_ZIGBEE_CHILD_REMOVED_LENGTHValue:
10
The length of the Child Removed event data.
110 of file stack/include/zigbee-event-logger-gen.hEMBER_LOGGER_ZIGBEE_CHILD_TIMED_OUT_LENGTH#
#define EMBER_LOGGER_ZIGBEE_CHILD_TIMED_OUT_LENGTHValue:
10
The length of the Child Timed Out event data.
112 of file stack/include/zigbee-event-logger-gen.hEMBER_LOGGER_ZIGBEE_STACK_STATUS_LENGTH#
#define EMBER_LOGGER_ZIGBEE_STACK_STATUS_LENGTHValue:
1
The length of the Stack Status event data.
114 of file stack/include/zigbee-event-logger-gen.hEMBER_LOGGER_ZIGBEE_TIME_SYNC_LENGTH#
#define EMBER_LOGGER_ZIGBEE_TIME_SYNC_LENGTHValue:
8
The length of the Time Sync event data.
116 of file stack/include/zigbee-event-logger-gen.hEMBER_LOGGER_ZIGBEE_TRUST_CENTER_JOIN_DECISION_LENGTH#
#define EMBER_LOGGER_ZIGBEE_TRUST_CENTER_JOIN_DECISION_LENGTHValue:
3
The length of the Trust Center Join Decision event data.
118 of file stack/include/zigbee-event-logger-gen.h