Status Codes

EmberZNet Stack API Reference

The generic "no error" message.

The generic "fatal error" message.

An invalid value was passed as an argument to a function.

The requested information was not found.

The manufacturing and stack token format in non-volatile memory is different than what the stack expects (returned at initialization).

The static memory definitions in ember-static-memory.h are incompatible with this stack version.

The manufacturing token format in non-volatile memory is different than what the stack expects (returned at initialization).

The stack token format in non-volatile memory is different than what the stack expects (returned at initialization).

There are no more buffers.

Specifies an invalid baud rate.

Specifies an invalid serial port.

Tried to send too much data.

There wasn't enough space to store a received character and the character was dropped.

Detected a UART framing error.

Detected a UART parity error.

There is no received data to process.

The receive interrupt was not handled in time and a character was dropped.

The MAC transmit queue is full.

MAC header FCF error on receive.

MAC ACK header received.

The MAC can't complete this task because it is scanning.

No pending data exists for a data poll.

Attempts to scan when joined to a network.

Scan duration must be 0 to 14 inclusive. Tried to scan with an incorrect duration value.

emberStartScan was called with an incorrect scan type.

emberStartScan was called with an invalid channel mask.

Failed to scan the current channel because the relevant MAC command could not be transmitted.

An ACK was expected following the transmission but the MAC level ACK was never received.

MAC failed to transmit a message because it could not successfully perform a radio network switch.

An indirect data message timed out before a poll requested it.

The Simulated EEPROM is telling the application that at least one flash page to be erased. The GREEN status means the current page has not filled above the ::ERASE_CRITICAL_THRESHOLD.

The application should call the function halSimEepromErasePage() when it can to erase a page.

The Simulated EEPROM is telling the application that at least one flash page must be erased. The RED status means the current page has filled above the ::ERASE_CRITICAL_THRESHOLD.

Due to the shrinking availability of write space, data could be lost. The application must call the function halSimEepromErasePage() as soon as possible to erase a page.

The Simulated EEPROM has run out of room to write new data and the data trying to be set has been lost. This error code is the result of ignoring the ::SIM_EEPROM_ERASE_PAGE_RED error code.

The application must call the function halSimEepromErasePage() to make room for any further calls to set a token.

Attempt 1 to initialize the Simulated EEPROM has failed.

This failure means the information already stored in the Flash (or a lack thereof), is fatally incompatible with the token information compiled into the code image being run.

Attempt 2 to initialize the Simulated EEPROM has failed.

This failure means Attempt 1 failed, and the token system failed to properly reload default tokens and reset the Simulated EEPROM.

Attempt 3 to initialize the Simulated EEPROM has failed.

This failure means one or both of the tokens ::TOKEN_MFG_NVDATA_VERSION or ::TOKEN_STACK_NVDATA_VERSION were incorrect and the token system failed to properly reload default tokens and reset the Simulated EEPROM.

The Simulated EEPROM is repairing itself.

While there's nothing for an app to do when the SimEE is going to repair itself (SimEE has to be fully functional for the rest of the system to work), alert the application to the fact that repair is occurring. There are debugging scenarios where an app might want to know that repair is happening, such as monitoring frequency.

Note

Common situations will trigger an expected repair, such as using an erased chip or changing token definitions.

A fatal error has occurred while trying to write data to the Flash. The target memory attempting to be programmed is already programmed. The flash write routines were asked to flip a bit from a 0 to 1, which is physically impossible and the write was therefore inhibited. The data in the Flash cannot be trusted after this error.

A fatal error has occurred while trying to write data to the Flash and the write verification has failed. Data in the Flash cannot be trusted after this error and it is possible this error is the result of exceeding the life cycles of the Flash.

A fatal error has occurred while trying to write data to the Flash possibly due to write protection or an invalid address. Data in the Flash cannot be trusted after this error and it is possible this error is the result of exceeding the life cycles of the Flash.

A fatal error has occurred while trying to erase the Flash possibly due to write protection. Data in the Flash cannot be trusted after this error and it is possible this error is the result of exceeding the life cycles of the Flash.

The bootloader received an invalid message (failed attempt to go into bootloader).

The bootloader received an invalid message (failed attempt to go into the bootloader).

The bootloader cannot complete the bootload operation because either an image was not found or the image exceeded memory bounds.

The APS layer attempted to send or deliver a message and failed.

This binding index is out of range for the current binding table.

This address table index is out of range for the current address table.

An invalid binding table index was given to a function.

The API call is not allowed given the current state of the stack.

The link cost to a node is not known.

The maximum number of in-flight messages = i.e., EMBER_APS_UNICAST_MESSAGE_COUNT, has been reached.

The message to be transmitted is too big to fit into a single over-the-air packet.

The application is trying to delete or overwrite a binding that is in use.

The application is trying to overwrite an address table entry that is in use.

An attempt was made to transmit during the suspend period.

Security match.

Drop frame.

Security match.

Security match.

Security match.

Security match.

Security match.

Security match.

The conversion is complete.

The conversion cannot be done because a request is being processed.

The conversion is deferred until the current request has been processed.

No results are pending.

Sleeping (for a duration) has been abnormally interrupted and exited prematurely.

The transmit attempt failed because the radio scheduler could not find a slot to transmit this packet in or a higher priority event interrupted it.

The transmit hardware buffer underflowed.

The transmit hardware did not finish transmitting a packet.

An unsupported channel setting was specified.

An unsupported power setting was specified.

The requested operation cannot be completed because the radio is currently busy, either transmitting a packet or performing calibration.

The transmit attempt failed because all CCA attempts indicated that the channel was busy.

The transmit attempt was blocked from going over the air. Typically this is due to the Radio Hold Off (RHO) or Coexistence plugins as they can prevent transmits based on external signals.

The expected ACK was received after the last transmission.

The stack software has completed initialization and is ready to send and receive packets over the air.

The network is not operating.

An attempt to join a network failed.

After moving, a mobile node's attempt to re-establish contact with the network failed.

An attempt to join as a router failed due to a Zigbee versus Zigbee Pro incompatibility. Zigbee devices joining Zigbee Pro networks (or vice versa) must join as End Devices, not Routers.

The local node ID has changed. The application can get the new node ID by calling emberGetNodeId().

The local PAN ID has changed. The application can get the new PAN ID by calling emberGetPanId().

The channel has changed.

An attempt to join or rejoin the network failed because no router beacons could be heard by the joining node.

An attempt was made to join a Secured Network using a pre-configured key, but the Trust Center sent back a Network Key in-the-clear when an encrypted Network Key was required. (EMBER_REQUIRE_ENCRYPTED_KEY).

An attempt was made to join a Secured Network, but the device did not receive a Network Key.

After a device joined a Secured Network, a Link Key was requested (EMBER_GET_LINK_KEY_WHEN_JOINING) but no response was ever received.

An attempt was made to join a Secured Network without a pre-configured key, but the Trust Center sent encrypted data using a pre-configured key.

The passed key data is not valid. A key of all zeros or all F's are reserved values and cannot be used.

The chosen security level (the value of EMBER_SECURITY_LEVEL) is not supported by the stack.

An error occurred when trying to encrypt at the APS Level.

In order to APS encrypt an outgoing packet, the sender needs to know the EUI64 of the destination. This error occurs because the EUI64 of the destination can't be determined from the short address (no entry in the neighbor, child, binding or address tables).

Everytime this error code is seen, note that the stack initiates an IEEE address discovery request behind the scenes. Responses to the request are stored in the trust center cache portion of the address table. Note that you need at least 1 entry allocated for TC cache in the address table plugin. Depending on the available rows in the table, newly discovered addresses may replace old ones. The address table plugin is enabled by default on the host. If you are using an SoC platform, please be sure to add the address table plugin.

When customers choose to send APS messages by using short addresses, they should incorporate a retry mechanism and try again, no sooner than 2 seconds later, to resend the APS message. If the app always receives 0xBE (EMBER_IEEE_ADDR_DISCOVERY_IN_PROGRESS) after multiple retries, that might indicate that: a) destination node is not on the network b) there are problems with the health of the network c) there may not be any space set asidein the address table for the newly discovered address - this can be rectified by reserving more entries for the trust center cache in the address table plugin

An error occurred when trying to encrypt at the APS Level.

This error occurs either because the long address of the recipient can't be determined from the short address (no entry in the binding table) or there is no link key entry in the table associated with the destination, or there was a failure to load the correct key into the encryption core.

There was an attempt to form or join a network with security without calling emberSetInitialSecurityState() first.

There was an attempt to set an entry in the key table using an invalid long address. Invalid addresses include:

• The local device's IEEE address
• Trust Center's IEEE address
• An existing table entry's IEEE address
• An address consisting of all zeros or all F's

There was an attempt to set a security configuration that is not valid given the other security settings.

There was an attempt to broadcast a key switch too quickly after broadcasting the next network key. The Trust Center must wait at least a period equal to the broadcast timeout so that all routers have a chance to receive the broadcast of the new network key.

The received signature corresponding to the message that was passed to the CBKE Library failed verification and is not valid.

The message could not be sent because the link key corresponding to the destination is not authorized for use in APS data messages. APS Commands (sent by the stack) are allowed. To use it for encryption of APS data messages it must be authorized using a key agreement protocol (such as CBKE).

The security data provided was not valid, or an integrity check failed.

The node has not joined a network.

A message cannot be sent because the network is currently overloaded.

The application tried to send a message using an endpoint that it has not defined.

The application tried to use a binding that has been remotely modified and the change has not yet been reported to the application.

An attempt to generate random bytes failed because of insufficient random data from the radio.

A Zigbee route error command frame was received indicating that a source routed message from this node failed en route.

A Zigbee route error command frame was received indicating that a message sent to this node along a many-to-one route failed en route. The route error frame was delivered by an ad-hoc search for a functioning route.

A critical and fatal error indicating that the version of the stack trying to run does not match with the chip it's running on. The software (stack) on the chip must be replaced with software compatible with the chip.

An index was passed into the function that was larger than the valid range.

There are no empty entries left in the table.

The requested table entry has been erased and contains no valid data.

The requested function cannot be executed because the library that contains the necessary functionality is not present.

The stack accepted the command and is currently processing the request. The results will be returned via an appropriate handler.

The EUI of the Trust center has changed due to a successful rejoin. The device may need to perform other authentication to verify the new TC is authorized to take over.

NVM3 is telling the application that the initialization was aborted as no valid NVM3 page was found.

NVM3 is telling the application that the initialization was aborted as the NVM3 instance was already opened with other parameters.

NVM3 is telling the application that the initialization was aborted as the NVM3 instance is not aligned properly in memory.

NVM3 is telling the application that the initialization was aborted as the size of the NVM3 instance is too small.

NVM3 is telling the application that the initialization was aborted as the NVM3 page size is not supported.

NVM3 is telling the application that there was an error initializing some of the tokens.

NVM3 is telling the application there has been an error when attempting to upgrade SimEE tokens.

NVM3 is telling the application that there has been an unknown error.

This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL.

This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL.

This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL.

This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL.

This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL.

This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL.

This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL.

This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL.

This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL.

This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL.

This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL.

This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL.

This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL.

This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL.

This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL.

This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL.