Counters#

API and Callbacks for the Counters Component.

This component provides support for reading and manipulating counters that record different events in the stack.

API#

sl_zigbee_af_counters_send_request(sl_802154_short_addr_t destination, bool clearCounters)
bool
sl_zigbee_af_counters_is_incoming_request(sl_zigbee_aps_frame_t *apsFrame, sl_802154_short_addr_t sender)
bool
sl_zigbee_af_counters_is_incoming_response(sl_zigbee_aps_frame_t *apsFrame)
bool
sl_zigbee_af_counters_is_outgoing_response(sl_zigbee_aps_frame_t *apsFrame, sl_status_t status)

Macros#

#define
MAX_PAYLOAD_LENGTH 48

API Documentation#

sl_zigbee_af_counters_send_request#

sl_status_t sl_zigbee_af_counters_send_request (sl_802154_short_addr_t destination, bool clearCounters)
Parameters
TypeDirectionArgument NameDescription
sl_802154_short_addr_tN/Adestination

the address of the node to send the request to.

boolN/AclearCounters

whether or not the destination should reset its counters to zero after successfully reporting them back to the requester. Because of technical constraints, counters are always cleared on a network coprocessor, such as the EM260.

Send an request to the specified destination to send back a report of the non-zero counters.

Returns

  • SL_STATUS_OK if the request was successfully submitted for sending. See ::sl_zigbee_send_unicast() or ::sl_zigbee_ezsp_send_unicast for possible failure statuses.


Definition at line 88 of file app/framework/plugin/counters/counters-ota.h

sl_zigbee_af_counters_is_incoming_request#

bool sl_zigbee_af_counters_is_incoming_request (sl_zigbee_aps_frame_t * apsFrame, sl_802154_short_addr_t sender)
Parameters
TypeDirectionArgument NameDescription
sl_zigbee_aps_frame_t *N/AapsFrame

the APS frame passed to the incoming message handler.

sl_802154_short_addr_tN/Asender

the node ID of the sender of the request.

Call this function at the beginning of the incoming message handler. It returns true if the incoming message was a counter's request and should be ignored by the rest of the incoming message handler.

Returns

  • true if the message was a counters request and should be ignored by the rest of the incoming message handler.


Definition at line 101 of file app/framework/plugin/counters/counters-ota.h

sl_zigbee_af_counters_is_incoming_response#

bool sl_zigbee_af_counters_is_incoming_response (sl_zigbee_aps_frame_t * apsFrame)
Parameters
TypeDirectionArgument NameDescription
sl_zigbee_aps_frame_t *N/AapsFrame

the APS frame passed to the incoming message handler.

Call this function within the incoming message handler to determine if the message is a counter's response. If so, it is up to the application to decode the payload whose format is described above.

Returns

  • true if the message is a counters response.


Definition at line 112 of file app/framework/plugin/counters/counters-ota.h

sl_zigbee_af_counters_is_outgoing_response#

bool sl_zigbee_af_counters_is_outgoing_response (sl_zigbee_aps_frame_t * apsFrame, sl_status_t status, return)
Parameters
TypeDirectionArgument NameDescription
sl_zigbee_aps_frame_t *N/AapsFrame

the APS frame passed to the message sent handler.

sl_status_tN/Astatus

the status passed to the message sent handler.

N/Areturn

true if the message was a counters response and should be ignored by the rest of the message sent handler.

Call this function at the beginning of the message sent handler. It returns true if the message was a counters response and should be ignored by the rest of the handler.


Definition at line 123 of file app/framework/plugin/counters/counters-ota.h