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#

enum
EMBER_LOGGER_ZIGBEE_BOOT_EVENT_ID = 0
EMBER_LOGGER_ZIGBEE_JOIN_NETWORK_ID = 1
EMBER_LOGGER_ZIGBEE_TRUST_CENTER_REJOIN_ID = 2
EMBER_LOGGER_ZIGBEE_SECURE_REJOIN_ID = 3
EMBER_LOGGER_ZIGBEE_LEAVE_WITHOUT_REJOIN_ID = 4
EMBER_LOGGER_ZIGBEE_LEAVE_WITH_REJOIN_ID = 5
EMBER_LOGGER_ZIGBEE_TRUST_CENTER_LINK_KEY_CHANGE_ID = 6
EMBER_LOGGER_ZIGBEE_NETWORK_KEY_SEQUENCE_NUMBER_CHANGE_ID = 7
EMBER_LOGGER_ZIGBEE_RESET_ID = 8
EMBER_LOGGER_ZIGBEE_CHANNEL_CHANGE_ID = 9
EMBER_LOGGER_ZIGBEE_PARENT_CHANGE_ID = 10
EMBER_LOGGER_ZIGBEE_DUTY_CYCLE_CHANGE_ID = 11
EMBER_LOGGER_ZIGBEE_CHILD_ADDED_ID = 12
EMBER_LOGGER_ZIGBEE_CHILD_REMOVED_ID = 13
EMBER_LOGGER_ZIGBEE_CHILD_TIMED_OUT_ID = 14
EMBER_LOGGER_ZIGBEE_STACK_STATUS_ID = 15
EMBER_LOGGER_ZIGBEE_TIME_SYNC_ID = 16
EMBER_LOGGER_ZIGBEE_TRUST_CENTER_JOIN_DECISION_ID = 17
EMBER_LOGGER_ZIGBEE_NULL_ID = 0xFFFF
}

A list of identifiers for system events.

enum
EMBER_LOGGER_ZIGBEE_FACILITY_BASE = 0
EMBER_LOGGER_ZIGBEE_FACILITY_MAC = 1
EMBER_LOGGER_ZIGBEE_FACILITY_NETWORK = 2
EMBER_LOGGER_ZIGBEE_FACILITY_APS = 3
EMBER_LOGGER_ZIGBEE_FACILITY_SECURITY = 4
EMBER_LOGGER_ZIGBEE_FACILITY_ZDO = 5
EMBER_LOGGER_ZIGBEE_FACILITY_ZCL = 6
EMBER_LOGGER_ZIGBEE_FACILITY_BDB = 7
EMBER_LOGGER_ZIGBEE_FACILITY_SMART_ENERGY = 8
}

A list of facilities for system events, identifying which layer they occurred in.

Functions#

void
emberAfPluginZigBeeEventLoggerAddBootEvent(uint32_t bootCount, uint16_t resetType)

Record an event indicating that the device has booted.

void
emberAfPluginZigBeeEventLoggerAddJoinNetwork(EmberPanId panId, uint8_t channelNumber, uint8_t page, uint8_t *extendedPanId)

Record an event indicating that a network was successfully joined.

void
emberAfPluginZigBeeEventLoggerAddTrustCenterRejoin(uint32_t channelMask, EmberRejoinReason reason)

Record an event indicating that a trust center rejoin was attempted.

void
emberAfPluginZigBeeEventLoggerAddSecureRejoin(uint32_t channelMask, EmberRejoinReason reason)

Record an event indicating that a secure rejoin was attempted.

void
emberAfPluginZigBeeEventLoggerAddLeaveWithoutRejoin(EmberNodeId sourceNode, EmberLeaveReason reason)

Record an event indicating that a device has left-without-rejoin.

void
emberAfPluginZigBeeEventLoggerAddLeaveWithRejoin(EmberNodeId sourceNode, EmberLeaveReason reason)

Record an event indicating that a device has left-with-rejoin.

void

Record an event indicating that an attempt was made to update the trust center link key.

void

Record an event indicating that the network key sequence number has changed.

void
emberAfPluginZigBeeEventLoggerAddReset(uint8_t resetCode, uint8_t extendedReason)

Record an event indicating that the local device has reset.

void
emberAfPluginZigBeeEventLoggerAddChannelChange(uint8_t page, uint8_t channel)

Record an event indicating that the network's channel has changed.

void
emberAfPluginZigBeeEventLoggerAddParentChange(EmberNodeId parentNodeId, EmberEUI64 parentEui64)

Record an event indicating that the local device's parent has changed.

void
emberAfPluginZigBeeEventLoggerAddDutyCycleChange(EmberDutyCycleState state, EmberDutyCycleHectoPct limitThreshold, EmberDutyCycleHectoPct criticalThreshold, EmberDutyCycleHectoPct suspendedLimit)

Record an event indicating that the duty cycle has changed.

void
emberAfPluginZigBeeEventLoggerAddChildAdded(EmberNodeId childNodeId, EmberEUI64 childEui64)

Record an event indicating that a child device has joined the local device.

void
emberAfPluginZigBeeEventLoggerAddChildRemoved(EmberNodeId childNodeId, EmberEUI64 childEui64)

Record an event indicating that a child device has been removed from the local device.

void
emberAfPluginZigBeeEventLoggerAddChildTimedOut(EmberNodeId childNodeId, EmberEUI64 childEui64)

Record an event indicating that a child device has been timed out by the local device.

void

Record an event indicating that the stack status has changed.

void
emberAfPluginZigBeeEventLoggerAddTimeSync(uint32_t utcTime, uint32_t secondsSinceBoot)

Record an event indicating that the clock time has been synchronized.

void
emberAfPluginZigBeeEventLoggerAddTrustCenterJoinDecision(EmberNodeId nodeId, uint8_t decision)

Record an event indicating that a device has attempted to join or rejoin the network.

Macros#

#define

The version of this feature.

#define
EMBER_ZIGBEE_LOGGER_AREA (0 << LOGGER_AREA_BIT_SHIFT)
#define

The length of the Boot Event event data.

#define

The length of the Join Network event data.

#define

The length of the Trust Center Rejoin event data.

#define

The length of the Secure Rejoin event data.

#define

The length of the Leave Without Rejoin event data.

#define

The length of the Leave With Rejoin event data.

#define

The length of the Trust Center Link Key Change event data.

#define

The length of the Network Key Sequence Number Change event data.

#define

The length of the Reset event data.

#define

The length of the Channel Change event data.

#define

The length of the Parent Change event data.

#define

The length of the Duty Cycle Change event data.

#define

The length of the Child Added event data.

#define

The length of the Child Removed event data.

#define

The length of the Child Timed Out event data.

#define

The length of the Stack Status event data.

#define

The length of the Time Sync event data.

#define

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

Definition at line 45 of file stack/include/zigbee-event-logger-gen.h

EmberZigbeeLoggerFacilityTypes#

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

Definition at line 71 of file stack/include/zigbee-event-logger-gen.h

Function Documentation#

emberAfPluginZigBeeEventLoggerAddBootEvent#

void emberAfPluginZigBeeEventLoggerAddBootEvent (uint32_t bootCount, uint16_t resetType)

Record an event indicating that the device has booted.

Parameters
N/AbootCount

The number of times the device has booted.

N/AresetType

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.


Definition at line 125 of file stack/include/zigbee-event-logger-gen.h

emberAfPluginZigBeeEventLoggerAddJoinNetwork#

void emberAfPluginZigBeeEventLoggerAddJoinNetwork (EmberPanId panId, uint8_t channelNumber, uint8_t page, uint8_t * extendedPanId)

Record an event indicating that a network was successfully joined.

Parameters
N/ApanId

The PAN ID of the network.

N/AchannelNumber

The channel of the network.

N/Apage

The page of the network joined.

N/AextendedPanId

The extended PAN ID of the network.


Definition at line 133 of file stack/include/zigbee-event-logger-gen.h

emberAfPluginZigBeeEventLoggerAddTrustCenterRejoin#

void emberAfPluginZigBeeEventLoggerAddTrustCenterRejoin (uint32_t channelMask, EmberRejoinReason reason)

Record an event indicating that a trust center rejoin was attempted.

Parameters
N/AchannelMask

The channel mask used when searching for the network.

N/Areason

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.


Definition at line 139 of file stack/include/zigbee-event-logger-gen.h

emberAfPluginZigBeeEventLoggerAddSecureRejoin#

void emberAfPluginZigBeeEventLoggerAddSecureRejoin (uint32_t channelMask, EmberRejoinReason reason)

Record an event indicating that a secure rejoin was attempted.

Parameters
N/AchannelMask

The channel mask used when searching for the network.

N/Areason

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.


Definition at line 145 of file stack/include/zigbee-event-logger-gen.h

emberAfPluginZigBeeEventLoggerAddLeaveWithoutRejoin#

void emberAfPluginZigBeeEventLoggerAddLeaveWithoutRejoin (EmberNodeId sourceNode, EmberLeaveReason reason)

Record an event indicating that a device has left-without-rejoin.

Parameters
N/AsourceNode

The node ID of the device leaving.

N/Areason

An EmberLeaveReason enumeration, indicating why the device left.


Definition at line 151 of file stack/include/zigbee-event-logger-gen.h

emberAfPluginZigBeeEventLoggerAddLeaveWithRejoin#

void emberAfPluginZigBeeEventLoggerAddLeaveWithRejoin (EmberNodeId sourceNode, EmberLeaveReason reason)

Record an event indicating that a device has left-with-rejoin.

Parameters
N/AsourceNode

The node ID of the device leaving-and-rejoining.

N/Areason

An EmberLeaveReason enumeration, indicating why the device left.


Definition at line 157 of file stack/include/zigbee-event-logger-gen.h

emberAfPluginZigBeeEventLoggerAddTrustCenterLinkKeyChange#

void emberAfPluginZigBeeEventLoggerAddTrustCenterLinkKeyChange (void )

Record an event indicating that an attempt was made to update the trust center link key.

Parameters
N/A

Definition at line 161 of file stack/include/zigbee-event-logger-gen.h

emberAfPluginZigBeeEventLoggerAddNetworkKeySequenceChange#

void emberAfPluginZigBeeEventLoggerAddNetworkKeySequenceChange (uint8_t sequence)

Record an event indicating that the network key sequence number has changed.

Parameters
N/Asequence

The new network key sequence number.


Definition at line 166 of file stack/include/zigbee-event-logger-gen.h

emberAfPluginZigBeeEventLoggerAddReset#

void emberAfPluginZigBeeEventLoggerAddReset (uint8_t resetCode, uint8_t extendedReason)

Record an event indicating that the local device has reset.

Parameters
N/AresetCode

The reset code. See reset-def.h.

N/AextendedReason

The extended reset reason. See reset-def.h.


Definition at line 172 of file stack/include/zigbee-event-logger-gen.h

emberAfPluginZigBeeEventLoggerAddChannelChange#

void emberAfPluginZigBeeEventLoggerAddChannelChange (uint8_t page, uint8_t channel)

Record an event indicating that the network's channel has changed.

Parameters
N/Apage

The new page number.

N/Achannel

The new channel number.


Definition at line 178 of file stack/include/zigbee-event-logger-gen.h

emberAfPluginZigBeeEventLoggerAddParentChange#

void emberAfPluginZigBeeEventLoggerAddParentChange (EmberNodeId parentNodeId, EmberEUI64 parentEui64)

Record an event indicating that the local device's parent has changed.

Parameters
N/AparentNodeId

The new parent's short address.

N/AparentEui64

The new parent's long address.


Definition at line 184 of file stack/include/zigbee-event-logger-gen.h

emberAfPluginZigBeeEventLoggerAddDutyCycleChange#

void emberAfPluginZigBeeEventLoggerAddDutyCycleChange (EmberDutyCycleState state, EmberDutyCycleHectoPct limitThreshold, EmberDutyCycleHectoPct criticalThreshold, EmberDutyCycleHectoPct suspendedLimit)

Record an event indicating that the duty cycle has changed.

Parameters
N/Astate

An EmberDutyCycleState state.

N/AlimitThreshold

An EmberDutyCycleHectoPct limit.

N/AcriticalThreshold

An EmberDutyCycleHectoPct critical threshold.

N/AsuspendedLimit

An EmberDutyCycleHectoPct suspend limit.


Definition at line 192 of file stack/include/zigbee-event-logger-gen.h

emberAfPluginZigBeeEventLoggerAddChildAdded#

void emberAfPluginZigBeeEventLoggerAddChildAdded (EmberNodeId childNodeId, EmberEUI64 childEui64)

Record an event indicating that a child device has joined the local device.

Parameters
N/AchildNodeId

The child's short address.

N/AchildEui64

The child's long address.


Definition at line 198 of file stack/include/zigbee-event-logger-gen.h

emberAfPluginZigBeeEventLoggerAddChildRemoved#

void emberAfPluginZigBeeEventLoggerAddChildRemoved (EmberNodeId childNodeId, EmberEUI64 childEui64)

Record an event indicating that a child device has been removed from the local device.

Parameters
N/AchildNodeId

The child's short address.

N/AchildEui64

The child's long address.


Definition at line 204 of file stack/include/zigbee-event-logger-gen.h

emberAfPluginZigBeeEventLoggerAddChildTimedOut#

void emberAfPluginZigBeeEventLoggerAddChildTimedOut (EmberNodeId childNodeId, EmberEUI64 childEui64)

Record an event indicating that a child device has been timed out by the local device.

Parameters
N/AchildNodeId

The child's short address.

N/AchildEui64

The child's long address.


Definition at line 210 of file stack/include/zigbee-event-logger-gen.h

emberAfPluginZigBeeEventLoggerAddStackStatus#

void emberAfPluginZigBeeEventLoggerAddStackStatus (EmberStatus status)

Record an event indicating that the stack status has changed.

Parameters
N/Astatus

An EmberStatus value indicating the change.


Definition at line 215 of file stack/include/zigbee-event-logger-gen.h

emberAfPluginZigBeeEventLoggerAddTimeSync#

void emberAfPluginZigBeeEventLoggerAddTimeSync (uint32_t utcTime, uint32_t secondsSinceBoot)

Record an event indicating that the clock time has been synchronized.

Parameters
N/AutcTime

The updated UTC time.

N/AsecondsSinceBoot

The number of seconds that have elapsed since boot.


Definition at line 221 of file stack/include/zigbee-event-logger-gen.h

emberAfPluginZigBeeEventLoggerAddTrustCenterJoinDecision#

void emberAfPluginZigBeeEventLoggerAddTrustCenterJoinDecision (EmberNodeId nodeId, uint8_t decision)

Record an event indicating that a device has attempted to join or rejoin the network.

Parameters
N/AnodeId

The short address of the device attempting to join or rejoin.

N/Adecision

The join or rejoin decision taken by the local device.

Note

  • This event is only recorded on a trust center device.


Definition at line 227 of file stack/include/zigbee-event-logger-gen.h

Macro Definition Documentation#

ZIGBEE_EVENT_LOGGER_VERSION#

#define ZIGBEE_EVENT_LOGGER_VERSION
Value:
1

The version of this feature.


Definition at line 37 of file stack/include/zigbee-event-logger-gen.h

LOGGER_AREA_BIT_SHIFT#

#define LOGGER_AREA_BIT_SHIFT
Value:
12

Definition at line 39 of file stack/include/zigbee-event-logger-gen.h

EMBER_ZIGBEE_LOGGER_AREA#

#define EMBER_ZIGBEE_LOGGER_AREA
Value:
(0 << LOGGER_AREA_BIT_SHIFT)

Definition at line 40 of file stack/include/zigbee-event-logger-gen.h

EMBER_LOGGER_ZIGBEE_BOOT_EVENT_LENGTH#

#define EMBER_LOGGER_ZIGBEE_BOOT_EVENT_LENGTH
Value:
6

The length of the Boot Event event data.


Definition at line 84 of file stack/include/zigbee-event-logger-gen.h

EMBER_LOGGER_ZIGBEE_JOIN_NETWORK_LENGTH#

#define EMBER_LOGGER_ZIGBEE_JOIN_NETWORK_LENGTH
Value:
12

The length of the Join Network event data.


Definition at line 86 of file stack/include/zigbee-event-logger-gen.h

EMBER_LOGGER_ZIGBEE_TRUST_CENTER_REJOIN_LENGTH#

#define EMBER_LOGGER_ZIGBEE_TRUST_CENTER_REJOIN_LENGTH
Value:
5

The length of the Trust Center Rejoin event data.


Definition at line 88 of file stack/include/zigbee-event-logger-gen.h

EMBER_LOGGER_ZIGBEE_SECURE_REJOIN_LENGTH#

#define EMBER_LOGGER_ZIGBEE_SECURE_REJOIN_LENGTH
Value:
5

The length of the Secure Rejoin event data.


Definition at line 90 of file stack/include/zigbee-event-logger-gen.h

EMBER_LOGGER_ZIGBEE_LEAVE_WITHOUT_REJOIN_LENGTH#

#define EMBER_LOGGER_ZIGBEE_LEAVE_WITHOUT_REJOIN_LENGTH
Value:
3

The length of the Leave Without Rejoin event data.


Definition at line 92 of file stack/include/zigbee-event-logger-gen.h

EMBER_LOGGER_ZIGBEE_LEAVE_WITH_REJOIN_LENGTH#

#define EMBER_LOGGER_ZIGBEE_LEAVE_WITH_REJOIN_LENGTH
Value:
3

The length of the Leave With Rejoin event data.


Definition at line 94 of file stack/include/zigbee-event-logger-gen.h

EMBER_LOGGER_ZIGBEE_TRUST_CENTER_LINK_KEY_CHANGE_LENGTH#

#define EMBER_LOGGER_ZIGBEE_TRUST_CENTER_LINK_KEY_CHANGE_LENGTH
Value:
0

The length of the Trust Center Link Key Change event data.


Definition at line 96 of file stack/include/zigbee-event-logger-gen.h

EMBER_LOGGER_ZIGBEE_NETWORK_KEY_SEQUENCE_NUMBER_CHANGE_LENGTH#

#define EMBER_LOGGER_ZIGBEE_NETWORK_KEY_SEQUENCE_NUMBER_CHANGE_LENGTH
Value:
1

The length of the Network Key Sequence Number Change event data.


Definition at line 98 of file stack/include/zigbee-event-logger-gen.h

EMBER_LOGGER_ZIGBEE_RESET_LENGTH#

#define EMBER_LOGGER_ZIGBEE_RESET_LENGTH
Value:
2

The length of the Reset event data.


Definition at line 100 of file stack/include/zigbee-event-logger-gen.h

EMBER_LOGGER_ZIGBEE_CHANNEL_CHANGE_LENGTH#

#define EMBER_LOGGER_ZIGBEE_CHANNEL_CHANGE_LENGTH
Value:
2

The length of the Channel Change event data.


Definition at line 102 of file stack/include/zigbee-event-logger-gen.h

EMBER_LOGGER_ZIGBEE_PARENT_CHANGE_LENGTH#

#define EMBER_LOGGER_ZIGBEE_PARENT_CHANGE_LENGTH
Value:
10

The length of the Parent Change event data.


Definition at line 104 of file stack/include/zigbee-event-logger-gen.h

EMBER_LOGGER_ZIGBEE_DUTY_CYCLE_CHANGE_LENGTH#

#define EMBER_LOGGER_ZIGBEE_DUTY_CYCLE_CHANGE_LENGTH
Value:
7

The length of the Duty Cycle Change event data.


Definition at line 106 of file stack/include/zigbee-event-logger-gen.h

EMBER_LOGGER_ZIGBEE_CHILD_ADDED_LENGTH#

#define EMBER_LOGGER_ZIGBEE_CHILD_ADDED_LENGTH
Value:
10

The length of the Child Added event data.


Definition at line 108 of file stack/include/zigbee-event-logger-gen.h

EMBER_LOGGER_ZIGBEE_CHILD_REMOVED_LENGTH#

#define EMBER_LOGGER_ZIGBEE_CHILD_REMOVED_LENGTH
Value:
10

The length of the Child Removed event data.


Definition at line 110 of file stack/include/zigbee-event-logger-gen.h

EMBER_LOGGER_ZIGBEE_CHILD_TIMED_OUT_LENGTH#

#define EMBER_LOGGER_ZIGBEE_CHILD_TIMED_OUT_LENGTH
Value:
10

The length of the Child Timed Out event data.


Definition at line 112 of file stack/include/zigbee-event-logger-gen.h

EMBER_LOGGER_ZIGBEE_STACK_STATUS_LENGTH#

#define EMBER_LOGGER_ZIGBEE_STACK_STATUS_LENGTH
Value:
1

The length of the Stack Status event data.


Definition at line 114 of file stack/include/zigbee-event-logger-gen.h

EMBER_LOGGER_ZIGBEE_TIME_SYNC_LENGTH#

#define EMBER_LOGGER_ZIGBEE_TIME_SYNC_LENGTH
Value:
8

The length of the Time Sync event data.


Definition at line 116 of file stack/include/zigbee-event-logger-gen.h

EMBER_LOGGER_ZIGBEE_TRUST_CENTER_JOIN_DECISION_LENGTH#

#define EMBER_LOGGER_ZIGBEE_TRUST_CENTER_JOIN_DECISION_LENGTH
Value:
3

The length of the Trust Center Join Decision event data.


Definition at line 118 of file stack/include/zigbee-event-logger-gen.h