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#
sl_zigbee_zigbee_logger_event_types_t#
sl_zigbee_zigbee_logger_event_types_t
A list of identifiers for system events.
| Enumerator | |
|---|---|
| SL_ZIGBEE_LOGGER_ZIGBEE_BOOT_EVENT_ID | |
| SL_ZIGBEE_LOGGER_ZIGBEE_JOIN_NETWORK_ID | |
| SL_ZIGBEE_LOGGER_ZIGBEE_TRUST_CENTER_REJOIN_ID | |
| SL_ZIGBEE_LOGGER_ZIGBEE_SECURE_REJOIN_ID | |
| SL_ZIGBEE_LOGGER_ZIGBEE_LEAVE_WITHOUT_REJOIN_ID | |
| SL_ZIGBEE_LOGGER_ZIGBEE_LEAVE_WITH_REJOIN_ID | |
| SL_ZIGBEE_LOGGER_ZIGBEE_TRUST_CENTER_LINK_KEY_CHANGE_ID | |
| SL_ZIGBEE_LOGGER_ZIGBEE_NETWORK_KEY_SEQUENCE_NUMBER_CHANGE_ID | |
| SL_ZIGBEE_LOGGER_ZIGBEE_RESET_ID | |
| SL_ZIGBEE_LOGGER_ZIGBEE_CHANNEL_CHANGE_ID | |
| SL_ZIGBEE_LOGGER_ZIGBEE_PARENT_CHANGE_ID | |
| SL_ZIGBEE_LOGGER_ZIGBEE_DUTY_CYCLE_CHANGE_ID | |
| SL_ZIGBEE_LOGGER_ZIGBEE_CHILD_ADDED_ID | |
| SL_ZIGBEE_LOGGER_ZIGBEE_CHILD_REMOVED_ID | |
| SL_ZIGBEE_LOGGER_ZIGBEE_CHILD_TIMED_OUT_ID | |
| SL_ZIGBEE_LOGGER_ZIGBEE_STACK_STATUS_ID | |
| SL_ZIGBEE_LOGGER_ZIGBEE_TIME_SYNC_ID | |
| SL_ZIGBEE_LOGGER_ZIGBEE_TRUST_CENTER_JOIN_DECISION_ID | |
| SL_ZIGBEE_LOGGER_ZIGBEE_NULL_ID | |
48 of file stack/include/zigbee-event-logger-gen.hsl_zigbee_zigbee_logger_facility_types_t#
sl_zigbee_zigbee_logger_facility_types_t
A list of facilities for system events, identifying which layer they occurred in.
| Enumerator | |
|---|---|
| SL_ZIGBEE_LOGGER_ZIGBEE_FACILITY_BASE | |
| SL_ZIGBEE_LOGGER_ZIGBEE_FACILITY_MAC | |
| SL_ZIGBEE_LOGGER_ZIGBEE_FACILITY_NETWORK | |
| SL_ZIGBEE_LOGGER_ZIGBEE_FACILITY_APS | |
| SL_ZIGBEE_LOGGER_ZIGBEE_FACILITY_SECURITY | |
| SL_ZIGBEE_LOGGER_ZIGBEE_FACILITY_ZDO | |
| SL_ZIGBEE_LOGGER_ZIGBEE_FACILITY_ZCL | |
| SL_ZIGBEE_LOGGER_ZIGBEE_FACILITY_BDB | |
| SL_ZIGBEE_LOGGER_ZIGBEE_FACILITY_SMART_ENERGY | |
74 of file stack/include/zigbee-event-logger-gen.hFunction Documentation#
sl_zigbee_af_zig_bee_event_logger_add_boot_event#
void sl_zigbee_af_zig_bee_event_logger_add_boot_event (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.
128 of file stack/include/zigbee-event-logger-gen.hsl_zigbee_af_zig_bee_event_logger_add_join_network#
void sl_zigbee_af_zig_bee_event_logger_add_join_network (sl_802154_pan_id_t 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. |
136 of file stack/include/zigbee-event-logger-gen.hsl_zigbee_af_zig_bee_event_logger_add_trust_center_rejoin#
void sl_zigbee_af_zig_bee_event_logger_add_trust_center_rejoin (uint32_t channelMask, sl_zigbee_rejoin_reason_t 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 sl_zigbee_rejoin_reason_t 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.
142 of file stack/include/zigbee-event-logger-gen.hsl_zigbee_af_zig_bee_event_logger_add_secure_rejoin#
void sl_zigbee_af_zig_bee_event_logger_add_secure_rejoin (uint32_t channelMask, sl_zigbee_rejoin_reason_t 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 sl_zigbee_rejoin_reason_t 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.
148 of file stack/include/zigbee-event-logger-gen.hsl_zigbee_af_zig_bee_event_logger_add_leave_without_rejoin#
void sl_zigbee_af_zig_bee_event_logger_add_leave_without_rejoin (sl_802154_short_addr_t sourceNode, sl_zigbee_leave_reason_t 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 sl_zigbee_leave_reason_t enumeration, indicating why the device left. |
154 of file stack/include/zigbee-event-logger-gen.hsl_zigbee_af_zig_bee_event_logger_add_leave_with_rejoin#
void sl_zigbee_af_zig_bee_event_logger_add_leave_with_rejoin (sl_802154_short_addr_t sourceNode, sl_zigbee_leave_reason_t 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 sl_zigbee_leave_reason_t enumeration, indicating why the device left. |
160 of file stack/include/zigbee-event-logger-gen.hsl_zigbee_af_zig_bee_event_logger_add_trust_center_link_key_change#
void sl_zigbee_af_zig_bee_event_logger_add_trust_center_link_key_change (void )
Record an event indicating that an attempt was made to update the trust center link key.
| N/A |
164 of file stack/include/zigbee-event-logger-gen.hsl_zigbee_af_zig_bee_event_logger_add_network_key_sequence_change#
void sl_zigbee_af_zig_bee_event_logger_add_network_key_sequence_change (uint8_t sequence)
Record an event indicating that the network key sequence number has changed.
| N/A | sequence | The new network key sequence number. |
169 of file stack/include/zigbee-event-logger-gen.hsl_zigbee_af_zig_bee_event_logger_add_reset#
void sl_zigbee_af_zig_bee_event_logger_add_reset (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. |
175 of file stack/include/zigbee-event-logger-gen.hsl_zigbee_af_zig_bee_event_logger_add_channel_change#
void sl_zigbee_af_zig_bee_event_logger_add_channel_change (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. |
181 of file stack/include/zigbee-event-logger-gen.hsl_zigbee_af_zig_bee_event_logger_add_parent_change#
void sl_zigbee_af_zig_bee_event_logger_add_parent_change (sl_802154_short_addr_t parentNodeId, sl_802154_long_addr_t 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. |
187 of file stack/include/zigbee-event-logger-gen.hsl_zigbee_af_zig_bee_event_logger_add_duty_cycle_change#
void sl_zigbee_af_zig_bee_event_logger_add_duty_cycle_change (sl_zigbee_duty_cycle_state_t state, sl_zigbee_duty_cycle_hecto_pct_t limitThreshold, sl_zigbee_duty_cycle_hecto_pct_t criticalThreshold, sl_zigbee_duty_cycle_hecto_pct_t suspendedLimit)
Record an event indicating that the duty cycle has changed.
| N/A | state | An sl_zigbee_duty_cycle_state_t state. |
| N/A | limitThreshold | An sl_zigbee_duty_cycle_hecto_pct_t limit. |
| N/A | criticalThreshold | An sl_zigbee_duty_cycle_hecto_pct_t critical threshold. |
| N/A | suspendedLimit | An sl_zigbee_duty_cycle_hecto_pct_t suspend limit. |
195 of file stack/include/zigbee-event-logger-gen.hsl_zigbee_af_zig_bee_event_logger_add_child_added#
void sl_zigbee_af_zig_bee_event_logger_add_child_added (sl_802154_short_addr_t childNodeId, sl_802154_long_addr_t 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. |
201 of file stack/include/zigbee-event-logger-gen.hsl_zigbee_af_zig_bee_event_logger_add_child_removed#
void sl_zigbee_af_zig_bee_event_logger_add_child_removed (sl_802154_short_addr_t childNodeId, sl_802154_long_addr_t 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. |
207 of file stack/include/zigbee-event-logger-gen.hsl_zigbee_af_zig_bee_event_logger_add_child_timed_out#
void sl_zigbee_af_zig_bee_event_logger_add_child_timed_out (sl_802154_short_addr_t childNodeId, sl_802154_long_addr_t 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. |
213 of file stack/include/zigbee-event-logger-gen.hsl_zigbee_af_zig_bee_event_logger_add_stack_status#
void sl_zigbee_af_zig_bee_event_logger_add_stack_status (sl_status_t status)
Record an event indicating that the stack status has changed.
| N/A | status | An sl_status_t value indicating the change. |
218 of file stack/include/zigbee-event-logger-gen.hsl_zigbee_af_zig_bee_event_logger_add_time_sync#
void sl_zigbee_af_zig_bee_event_logger_add_time_sync (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. |
224 of file stack/include/zigbee-event-logger-gen.hsl_zigbee_af_zig_bee_event_logger_add_trust_center_join_decision#
void sl_zigbee_af_zig_bee_event_logger_add_trust_center_join_decision (sl_802154_short_addr_t 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.
230 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.
40 of file stack/include/zigbee-event-logger-gen.hLOGGER_AREA_BIT_SHIFT#
#define LOGGER_AREA_BIT_SHIFTValue:
12
42 of file stack/include/zigbee-event-logger-gen.hSL_ZIGBEE_ZIGBEE_LOGGER_AREA#
#define SL_ZIGBEE_ZIGBEE_LOGGER_AREAValue:
(0 << LOGGER_AREA_BIT_SHIFT)
43 of file stack/include/zigbee-event-logger-gen.hSL_ZIGBEE_LOGGER_ZIGBEE_BOOT_EVENT_LENGTH#
#define SL_ZIGBEE_LOGGER_ZIGBEE_BOOT_EVENT_LENGTHValue:
6
The length of the Boot Event event data.
87 of file stack/include/zigbee-event-logger-gen.hSL_ZIGBEE_LOGGER_ZIGBEE_JOIN_NETWORK_LENGTH#
#define SL_ZIGBEE_LOGGER_ZIGBEE_JOIN_NETWORK_LENGTHValue:
12
The length of the Join Network event data.
89 of file stack/include/zigbee-event-logger-gen.hSL_ZIGBEE_LOGGER_ZIGBEE_TRUST_CENTER_REJOIN_LENGTH#
#define SL_ZIGBEE_LOGGER_ZIGBEE_TRUST_CENTER_REJOIN_LENGTHValue:
5
The length of the Trust Center Rejoin event data.
91 of file stack/include/zigbee-event-logger-gen.hSL_ZIGBEE_LOGGER_ZIGBEE_SECURE_REJOIN_LENGTH#
#define SL_ZIGBEE_LOGGER_ZIGBEE_SECURE_REJOIN_LENGTHValue:
5
The length of the Secure Rejoin event data.
93 of file stack/include/zigbee-event-logger-gen.hSL_ZIGBEE_LOGGER_ZIGBEE_LEAVE_WITHOUT_REJOIN_LENGTH#
#define SL_ZIGBEE_LOGGER_ZIGBEE_LEAVE_WITHOUT_REJOIN_LENGTHValue:
3
The length of the Leave Without Rejoin event data.
95 of file stack/include/zigbee-event-logger-gen.hSL_ZIGBEE_LOGGER_ZIGBEE_LEAVE_WITH_REJOIN_LENGTH#
#define SL_ZIGBEE_LOGGER_ZIGBEE_LEAVE_WITH_REJOIN_LENGTHValue:
3
The length of the Leave With Rejoin event data.
97 of file stack/include/zigbee-event-logger-gen.hSL_ZIGBEE_LOGGER_ZIGBEE_TRUST_CENTER_LINK_KEY_CHANGE_LENGTH#
#define SL_ZIGBEE_LOGGER_ZIGBEE_TRUST_CENTER_LINK_KEY_CHANGE_LENGTHValue:
0
The length of the Trust Center Link Key Change event data.
99 of file stack/include/zigbee-event-logger-gen.hSL_ZIGBEE_LOGGER_ZIGBEE_NETWORK_KEY_SEQUENCE_NUMBER_CHANGE_LENGTH#
#define SL_ZIGBEE_LOGGER_ZIGBEE_NETWORK_KEY_SEQUENCE_NUMBER_CHANGE_LENGTHValue:
1
The length of the Network Key Sequence Number Change event data.
101 of file stack/include/zigbee-event-logger-gen.hSL_ZIGBEE_LOGGER_ZIGBEE_RESET_LENGTH#
#define SL_ZIGBEE_LOGGER_ZIGBEE_RESET_LENGTHValue:
2
The length of the Reset event data.
103 of file stack/include/zigbee-event-logger-gen.hSL_ZIGBEE_LOGGER_ZIGBEE_CHANNEL_CHANGE_LENGTH#
#define SL_ZIGBEE_LOGGER_ZIGBEE_CHANNEL_CHANGE_LENGTHValue:
2
The length of the Channel Change event data.
105 of file stack/include/zigbee-event-logger-gen.hSL_ZIGBEE_LOGGER_ZIGBEE_PARENT_CHANGE_LENGTH#
#define SL_ZIGBEE_LOGGER_ZIGBEE_PARENT_CHANGE_LENGTHValue:
10
The length of the Parent Change event data.
107 of file stack/include/zigbee-event-logger-gen.hSL_ZIGBEE_LOGGER_ZIGBEE_DUTY_CYCLE_CHANGE_LENGTH#
#define SL_ZIGBEE_LOGGER_ZIGBEE_DUTY_CYCLE_CHANGE_LENGTHValue:
7
The length of the Duty Cycle Change event data.
109 of file stack/include/zigbee-event-logger-gen.hSL_ZIGBEE_LOGGER_ZIGBEE_CHILD_ADDED_LENGTH#
#define SL_ZIGBEE_LOGGER_ZIGBEE_CHILD_ADDED_LENGTHValue:
10
The length of the Child Added event data.
111 of file stack/include/zigbee-event-logger-gen.hSL_ZIGBEE_LOGGER_ZIGBEE_CHILD_REMOVED_LENGTH#
#define SL_ZIGBEE_LOGGER_ZIGBEE_CHILD_REMOVED_LENGTHValue:
10
The length of the Child Removed event data.
113 of file stack/include/zigbee-event-logger-gen.hSL_ZIGBEE_LOGGER_ZIGBEE_CHILD_TIMED_OUT_LENGTH#
#define SL_ZIGBEE_LOGGER_ZIGBEE_CHILD_TIMED_OUT_LENGTHValue:
10
The length of the Child Timed Out event data.
115 of file stack/include/zigbee-event-logger-gen.hSL_ZIGBEE_LOGGER_ZIGBEE_STACK_STATUS_LENGTH#
#define SL_ZIGBEE_LOGGER_ZIGBEE_STACK_STATUS_LENGTHValue:
4
The length of the Stack Status event data.
117 of file stack/include/zigbee-event-logger-gen.hSL_ZIGBEE_LOGGER_ZIGBEE_TIME_SYNC_LENGTH#
#define SL_ZIGBEE_LOGGER_ZIGBEE_TIME_SYNC_LENGTHValue:
8
The length of the Time Sync event data.
119 of file stack/include/zigbee-event-logger-gen.hSL_ZIGBEE_LOGGER_ZIGBEE_TRUST_CENTER_JOIN_DECISION_LENGTH#
#define SL_ZIGBEE_LOGGER_ZIGBEE_TRUST_CENTER_JOIN_DECISION_LENGTHValue:
3
The length of the Trust Center Join Decision event data.
121 of file stack/include/zigbee-event-logger-gen.h