//

Utilities Frames#


Name: nop	ID: 0x0005
Description: A command which does nothing. The Host can use this to set the sleep mode or to check the status of the NCP.
Command Parameters: None
Response Parameters: None


Name: echo	ID: 0x0081
Description: Variable length data from the Host is echoed back by the NCP. This command has no other effects and is designed for testing the link between the Host and NCP.
Command Parameters:
uint8_t dataLength	The length of the data parameter in bytes.
uint8_t[] data	The data to be echoed back.
Response Parameters:
uint8_t echoLength	The length of the echo parameter in bytes.
uint8_t[] echo	The echo of the data.


Name: invalidCommand	ID: 0x0058
Description: Indicates that the NCP received an invalid command. This frame is a response to an invalid command.
Response Parameters:
sl_zigbee_ezsp_status_t reason	The reason why the command was invalid.


Name: callback	ID: 0x0006
Description: Allows the NCP to respond with a pending callback.
Command Parameters: None
The response to this command can be any of the callback responses.


Name: noCallbacks	ID: 0x0007
Description: Indicates that there are currently no pending callbacks.
This frame is a response to the callback command.
Response Parameters: None


Name: setToken	ID: 0x0009
Description: Sets a token (8 bytes of non-volatile storage) in the Simulated EEPROM of the NCP.
Command Parameters:
uint8_t tokenId	Which token to set.
uint8_t[8] tokenData	The data to write to the token.
Response Parameters:
sl_status_t status	An sl_status_t value indicating success or the reason for failure.


Name: getToken	ID: 0x000A
Description: Retrieves a token (8 bytes of non-volatile storage) from the Simulated EEPROM of the NCP.
Command Parameters:
uint8_t tokenId	Which token to read.
Response Parameters:
sl_status_t status	An sl_status_t value indicating success or the reason for failure.
uint8_t[8] tokenData	The contents of the token.


Name: getMfgToken	ID: 0x000B
Description: Retrieves a manufacturing token from the Flash Information Area of the NCP (except for SL_ZIGBEE_EZSP_STACK_CAL_DATA which is managed by the stack).
Command Parameters:
sl_zigbee_ezsp_mfg_token_id_t tokenId	Which manufacturing token to read.
Response Parameters:
uint8_t tokenDataLength	The length of the tokenData parameter in bytes.
uint8_t[] tokenData	The manufacturing token data.


Name: setMfgToken	ID: 0x000C
Description: Sets a manufacturing token in the Customer Information Block (CIB) area of the NCP if that token currently unset (fully erased). Cannot be used with SL_ZIGBEE_EZSP_STACK_CAL_DATA, SL_ZIGBEE_EZSP_STACK_CAL_FILTER, SL_ZIGBEE_EZSP_MFG_ASH_CONFIG, or SL_ZIGBEE_EZSP_MFG_CBKE_DATA token.
Command Parameters:
sl_zigbee_ezsp_mfg_token_id_t tokenId	Which manufacturing token to set.
uint8_t tokenDataLength	The length of the tokenData parameter in bytes.
uint8_t[] tokenData	The manufacturing token data.
Response Parameters:
sl_status_t status	An sl_status_t value indicating success or the reason for failure.


Name: stackTokenChangedHandler	ID: 0x000D
Description: A callback invoked to inform the application that a stack token has changed.
This frame is a response to the callback command.
Response Parameters:
uint16_t tokenAddress	The address of the stack token that has changed.


Name: getRandomNumber	ID: 0x0049
Description: Returns a pseudorandom number.
Command Parameters: None
Response Parameters:
sl_status_t status	Always returns SL_STATUS_OK.
uint16_t value	A pseudorandom number.


Name: setTimer	ID: 0x000E
Description: Sets a timer on the NCP. There are 2 independent timers available for use by the Host. A timer can be cancelled by setting time to 0 or units to SL_ZIGBEE_EVENT_INACTIVE.
Command Parameters:
uint8_t timerId	Which timer to set (0 or 1).
uint16_t time	The delay before the timerHandler callback will be generated. Note that the timer clock is free running and is not synchronized with this command. This means that the actual delay will be between time and (time - 1). The maximum delay is 32767.
EmberEventUnits units	The units for time.
bool repeat	If true, a timerHandler callback will be generated repeatedly. If false, only a single timer-Handler callback will be generated.
Response Parameters:
sl_status_t status	An sl_status_t value indicating success or the reason for failure.


Name: getTimer	ID: 0x004E
Description: Gets information about a timer. The Host can use this command to find out how much longer it will be before a previously set timer will generate a callback.
Command Parameters:
uint8_t timerId	Which timer to get information about (0 or 1).
Response Parameters:
uint16_t time	The delay before the timerHandler callback will be generated.
sl_zigbee_event_units_t units	The units for time.
bool repeat	True if a timerHandler callback will be generated repeatedly. False if only a single timer-Handler callback will be generated.


Name: timerHandler	ID: 0x000F
Description: A callback from the timer.
This frame is a response to the callback command.
Response Parameters:
uint8_t timerId	Which timer generated the callback (0 or 1).


Name: debugWrite	ID: 0x0012
Description: Sends a debug message from the Host to the Network Analyzer utility via the NCP.
Command Parameters:
bool binaryMessage	true if the message should be interpreted as binary data, false if the message should be interpreted as ASCII text.
uint8_t messageLength	The length of the messageContents parameter in bytes.
uint8_t[] messageContents	The binary message.
Response Parameters:
sl_status_t status	An sl_status_t value indicating success or the reason for failure.


Name: readAndClearCounters	ID: 0x0065
Description: Retrieves and clears Ember counters. See the sl_zigbee_counter_type_t enumeration for the counter types.
Command Parameters: None
Response Parameters:
uint16_t[SL_ZIGBEE_COUNTER_TY PE_COUNT]values	A list of all counter values ordered according to the EmberCounterType enumeration.


Name: readCounters	ID: 0x00F1
Description: Retrieves Ember counters. See the sl_zigbee_counter_type_t enumeration for the counter types.
Command Parameters: None
Response Parameters:
uint16_t[SL_ZIGBEE_COUNTER_TYP E_COUNT] values	A list of all counter values ordered according to the sl_zigbee_counter_type_t enumeration.


Name: counterRolloverHandler	ID: 0x00F2
Description: This call is fired when a counter exceeds its threshold.
This frame is a response to the callback command.
Response Parameters:
sl_zigbee_counter_type_t type	Type of Counter


Name: delayTest	ID: 0x009D
Description: Used to test that UART flow control is working correctly.
Command Parameters:
uint16_t delay	Data will not be read from the host for this many milliseconds.
Response Parameters: None


Name: getLibraryStatus	ID: 0x0001
Description: This retrieves the status of the passed library ID to determine if it is compiled into the stack.
Command Parameters:
sl_zigbee_library_id_t libraryId	The ID of the library being queried.
Response Parameters:
sl_zigbee_library_status_t status	The status of the library being queried.


Name: getXncpInfo	ID: 0x0013
Description: Allows the HOST to know whether the NCP is running the XNCP library. If so, the response contains also the manufacturer ID and the version number of the XNCP application that is running on the NCP.
Command Parameters: None
Response Parameters:
sl_status_t status	SL_STATUS_OK if the NCP is running the XNCP library. SL_STATUS_INVALID_STATE otherwise.
uint16_t manufacturerId	The manufactured ID the user has defined in the XNCP application.
uint16_t versionNumber	The version number of the XNCP application.


Name: customFrame	ID: 0x0047
Description: Provides the customer a custom EZSP frame. On the NCP, these frames are only handled if the XNCP library is included. On the NCP side these frames are handled in the sl_zigbee_xncp_incoming_custom_ezsp_message_cb() callback function.
Command Parameters:
uint8_t payloadLength	The length of the custom frame payload (maximum 119 bytes).
uint8_t[] payload	The payload of the custom frame.
Response Parameters:
sl_status_t status	The status returned by the custom command.
uint8_t replyLength	The length of the response.
uint8_t[] reply	The response.


Name: customFrameHandler	ID: 0x0054
Description: A callback indicating a custom EZSP message has been received. This frame is a response to the callback command.
Response Parameters:
uint8_t payloadLength	The length of the custom frame payload.
uint8_t[] payload	The payload of the custom frame.


Name: getEui64	ID:
Description: Returns the EUI64 ID of the local node.
Command Parameters: None
Response Parameters:
sl_802154_long_addr_t eui64	The 64-bit ID.


Name: getNodeId	ID: 0x0027
Description: Returns the 16-bit node ID of the local node.
Command Parameters: None
Response Parameters:
sl_802154_short_addr_t nodeId	The 16-bit ID.


Name: getPhyInterfaceCount	ID: 0x00FC
Description: Returns number of phy interfaces present.
Command Parameters: None
Response Parameters:
uint8_t interfaceCount	Value indicate how many phy interfaces present.


Name: getTrueRandomEntropySource	ID: 0x004F
Description: Returns the entropy source used for true random number generation.
Command Parameters: None
Response Parameters:
sl_zigbee_entropy_source_t entropySource	Value indicates the used entropy source.


Name: setupDelayedJoin	ID: 0x003A
Description: Extend a joiner's timeout to wait for the network key on the joiner default key timeout is 3 sec, and only values greater equal to 3 sec are accepted.
Command Parameters:
uint8_t networkKeyTimeoutS	Network key timeout
Response Parameters:
sl_status_t status	An sl_status_t value indicating success or the reason for failure.


Name: radioGetSchedulerPriorities	ID: 0x012A
Description: Get the current scheduler priorities for multiprotocol apps.
Command Parameters: None
Response Parameters:
sl_zigbee_multiprotocol_priorities_t priorities	The current priorities.


Name: radioSetSchedulerPriorities	ID: 0x012B
Description: Set the current scheduler priorities for multiprotocol apps.
Command Parameters:
	The current priorities.
sl_zigbee_multiprotocol_priorities_t priorities
Response Parameters: None


Name: radioGetSchedulerSliptime	ID: 0x012C
Description: Get the current multiprotocol sliptime.
Command Parameters: None
Response Parameters:
uint32_t[1] slipTime	Value of the current slip time.


Name: radioSetSchedulerSliptime	ID: 0x012D
Description: Set the current multiprotocol sliptime.
Command Parameters:
uint32_t slipTime	Value of the current slip time.
Response Parameters: None


Name: counterRequiresPhyIndex	ID: 0x0132
Description: Check if a particular counter is one that could report from either a 2.4GHz or sub-GHz interface.
Command Parameters:
	The counter to be checked.
sl_zigbee_counter_type_t counter
Response Parameters:
bool requires	Whether this counter requires a PHY index when operating on a dual-PHY system.


Name: counterRequiresDestinationNodeId	ID: 0x0133
Description: Check if a particular counter can report on the destination node ID they have been triggered from.
Command Parameters:
sl_zigbee_counter_type_t counter	The counter to be checked.
Response Parameters:
bool requires	Whether this counter requires the destination node ID.