Status Codes#

Return-code definitions for Connect stack API functions.

Many Connect API functions return an EmberStatus value to indicate the success or failure of the call.

Return codes are one byte long.

This page documents the possible status codes and their meanings.

See error-def.h for source code.

See also error.h for information on how the values for the return codes are built up from these definitions. The file error-def.h is separated from error.h because utilities will use this file to parse the return codes.

Note

  • Do not include error-def.h directly. It is included by error.h inside an enum typedef, which is in turn included by ember.h.

Enumerations#

enum
EMBER_SUCCESS = 0x00
EMBER_ERR_FATAL = 0x01
EMBER_BAD_ARGUMENT = 0x02
EMBER_EEPROM_MFG_STACK_VERSION_MISMATCH = 0x04
EMBER_INVALID_CALL = 0x70
EMBER_EEPROM_MFG_VERSION_MISMATCH = 0x06
EMBER_EEPROM_STACK_VERSION_MISMATCH = 0x07
EMBER_NO_BUFFERS = 0x18
EMBER_SERIAL_INVALID_BAUD_RATE = 0x20
EMBER_SERIAL_INVALID_PORT = 0x21
EMBER_SERIAL_TX_OVERFLOW = 0x22
EMBER_SERIAL_RX_OVERFLOW = 0x23
EMBER_SERIAL_RX_FRAME_ERROR = 0x24
EMBER_SERIAL_RX_PARITY_ERROR = 0x25
EMBER_SERIAL_RX_EMPTY = 0x26
EMBER_SERIAL_RX_OVERRUN_ERROR = 0x27
EMBER_MAC_NO_DATA = 0x31
EMBER_MAC_SYNC_TIMEOUT = 0x33
EMBER_MAC_SYNC_WRONG_SEED = 0x34
EMBER_MAC_SECURITY_FAILED = 0x35
EMBER_MAC_UNKNOWN_DESTINATION = 0x37
EMBER_MAC_SECURITY_NOT_SUPPORTED = 0x38
EMBER_MAC_TRANSMIT_QUEUE_FULL = 0x39
EMBER_MAC_ACK_HEADER_TYPE = 0x3B
EMBER_MAC_SCANNING = 0x3D
EMBER_MAC_BUSY = 0x3E
EMBER_MAC_NO_ACK_RECEIVED = 0x40
EMBER_MAC_INDIRECT_TIMEOUT = 0x41
EMBER_MAC_INDIRECT_MESSAGE_PURGED = 0x42
EMBER_ERR_FLASH_PROG_FAIL = 0x4B
EMBER_MESSAGE_TOO_LONG = 0x74
EMBER_ADC_CONVERSION_DONE = 0x80
EMBER_ADC_CONVERSION_BUSY = 0x81
EMBER_ADC_CONVERSION_DEFERRED = 0x82
EMBER_ADC_NO_CONVERSION_PENDING = 0x84
EMBER_SLEEP_INTERRUPTED = 0x85
EMBER_PHY_TX_INCOMPLETE = 0x89
EMBER_PHY_INVALID_CHANNEL = 0x8A
EMBER_PHY_INVALID_POWER = 0x8B
EMBER_PHY_TX_BUSY = 0x8C
EMBER_PHY_TX_CCA_FAIL = 0x8D
EMBER_PHY_CALIBRATING = 0x8E
EMBER_PHY_ACK_RECEIVED = 0x8F
EMBER_NETWORK_UP = 0x90
EMBER_NETWORK_DOWN = 0x91
EMBER_JOIN_SCAN_FAILED = 0x92
EMBER_JOIN_FAILED = 0x94
EMBER_JOIN_DENIED = 0x95
EMBER_JOIN_TIMEOUT = 0x96
EMBER_NO_VALID_BEACONS = 0xAB
EMBER_SECURITY_DATA_INVALID = 0xBD
EMBER_NOT_JOINED = 0x93
EMBER_TABLE_FULL = 0xB4
EMBER_LIBRARY_NOT_PRESENT = 0xB5
EMBER_CHILD_NOT_FOUND = 0xB6
EMBER_NVM3_ERR_OPENED_WITH_OTHER_PARAMETERS = 0xC1
EMBER_NVM3_ERR_ALIGNMENT_INVALID = 0xC2
EMBER_NVM3_ERR_SIZE_TOO_SMALL = 0xC3
EMBER_NVM3_ERR_PAGE_SIZE_NOT_SUPPORTED = 0xC4
EMBER_NVM3_ERR_TOKEN_INIT = 0xC5
EMBER_NVM3_ERR_UNKNOWN = 0xC7
EMBER_NCP_UNKNOWN_COMMAND_ID = 0xD0
EMBER_APPLICATION_ERROR_0 = 0xF0
EMBER_APPLICATION_ERROR_1 = 0xF1
EMBER_APPLICATION_ERROR_2 = 0xF2
EMBER_APPLICATION_ERROR_3 = 0xF3
EMBER_APPLICATION_ERROR_4 = 0xF4
EMBER_APPLICATION_ERROR_5 = 0xF5
EMBER_APPLICATION_ERROR_6 = 0xF6
EMBER_APPLICATION_ERROR_7 = 0xF7
EMBER_APPLICATION_ERROR_8 = 0xF8
EMBER_APPLICATION_ERROR_9 = 0xF9
EMBER_APPLICATION_ERROR_10 = 0xFA
EMBER_APPLICATION_ERROR_11 = 0xFB
EMBER_APPLICATION_ERROR_12 = 0xFC
EMBER_APPLICATION_ERROR_13 = 0xFD
EMBER_APPLICATION_ERROR_14 = 0xFE
EMBER_APPLICATION_ERROR_15 = 0xFF
}

Enumeration Documentation#

EmberStatus#

EmberStatus
Enumerator
EMBER_SUCCESS

The generic "no error" message.

EMBER_ERR_FATAL

The generic "fatal error" message.

EMBER_BAD_ARGUMENT

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

EMBER_EEPROM_MFG_STACK_VERSION_MISMATCH

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

EMBER_INVALID_CALL

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

EMBER_EEPROM_MFG_VERSION_MISMATCH

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

EMBER_EEPROM_STACK_VERSION_MISMATCH

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

EMBER_NO_BUFFERS

There are no more buffers (either in the stack heap or the queue used by the associated module, such as indirect queue).

EMBER_SERIAL_INVALID_BAUD_RATE

Specified an invalid baud rate.

EMBER_SERIAL_INVALID_PORT

Specified an invalid serial port.

EMBER_SERIAL_TX_OVERFLOW

Tried to send too much data.

EMBER_SERIAL_RX_OVERFLOW

There was not enough space to store a received character and some characters were dropped.

EMBER_SERIAL_RX_FRAME_ERROR

Detected a UART framing error.

EMBER_SERIAL_RX_PARITY_ERROR

Detected a UART parity error.

EMBER_SERIAL_RX_EMPTY

There is no received data to process.

EMBER_SERIAL_RX_OVERRUN_ERROR

The receive interrupt was not handled in time and some characters were dropped.

EMBER_MAC_NO_DATA

No pending data exists for device doing a data poll.

EMBER_MAC_SYNC_TIMEOUT

The frequency hopping client failed the frequency hopping synchronization procedure. It timed out trying to reach the frequency hopping server.

EMBER_MAC_SYNC_WRONG_SEED

The frequency hopping client failed the frequency hopping synchronization procedure. The server is currently using a different seed.

EMBER_MAC_SECURITY_FAILED

MAC security operation failed.

EMBER_MAC_UNKNOWN_DESTINATION

Transmission failed: the destination node does not appear in the neighbor or child tables.

EMBER_MAC_SECURITY_NOT_SUPPORTED

Transmission failed: the local node does not support security or a secured transmission has been requested to a child that does not support security.

EMBER_MAC_TRANSMIT_QUEUE_FULL

The MAC transmit queue is full.

EMBER_MAC_ACK_HEADER_TYPE

MAC ACK header received.

EMBER_MAC_SCANNING

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

EMBER_MAC_BUSY

The requested operation cannot be completed because MAC is currently busy performing a high-priority task.

EMBER_MAC_NO_ACK_RECEIVED

Expected to receive an ACK following the transmission, but the MAC level ACK was never received.

EMBER_MAC_INDIRECT_TIMEOUT

Indirect data message timed out before polled.

EMBER_MAC_INDIRECT_MESSAGE_PURGED

Transmission failed: the indirect message was purged because the destination child has been removed or updated, or because emberPurgeIndirectMessages() was called.

EMBER_ERR_FLASH_PROG_FAIL

A fatal error has occurred while trying to write data to the flash, possibly due to write protection or an invalid address. The 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.

EMBER_MESSAGE_TOO_LONG

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

EMBER_ADC_CONVERSION_DONE

Conversion is complete.

EMBER_ADC_CONVERSION_BUSY

Conversion cannot be done because a request is being processed.

EMBER_ADC_CONVERSION_DEFERRED

Conversion is deferred until the current request has been processed.

EMBER_ADC_NO_CONVERSION_PENDING

No results are pending.

EMBER_SLEEP_INTERRUPTED

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

EMBER_PHY_TX_INCOMPLETE

The transmit hardware did not finish transmitting a packet.

EMBER_PHY_INVALID_CHANNEL

An unsupported channel setting was specified.

EMBER_PHY_INVALID_POWER

An unsupported power setting was specified.

EMBER_PHY_TX_BUSY

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

EMBER_PHY_TX_CCA_FAIL

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

EMBER_PHY_CALIBRATING

The requested operation cannot be completed because the stack has triggered a radio calibration. Wait for about one second for it to complete.

EMBER_PHY_ACK_RECEIVED

The expected ACK was received after the last transmission.

EMBER_NETWORK_UP

The stack software has completed initialization required to be in a network and is ready to send and receive packets over the air.

EMBER_NETWORK_DOWN

The network is not operating.

EMBER_JOIN_SCAN_FAILED

The node failed to initiate the scanning process during the joining process.

EMBER_JOIN_FAILED

An attempt to join a network failed.

EMBER_JOIN_DENIED

An attempt to join a network was rejected.

EMBER_JOIN_TIMEOUT

The node timed out waiting for a response during the joining process.

EMBER_NO_VALID_BEACONS

An attempt to join or rejoin the network failed because no valid beacons was received by the joining node.

EMBER_SECURITY_DATA_INVALID

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

EMBER_NOT_JOINED

The node has not joined a network. Returned by emberNetworkInit() if there was no connection data saved in tokens.

EMBER_TABLE_FULL

There are no empty entries left in the table.

EMBER_LIBRARY_NOT_PRESENT

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

EMBER_CHILD_NOT_FOUND

The requested NodeId has not been found in the child list or grandchildren list (start network only).

EMBER_NVM3_ERR_OPENED_WITH_OTHER_PARAMETERS

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

EMBER_NVM3_ERR_ALIGNMENT_INVALID

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

EMBER_NVM3_ERR_SIZE_TOO_SMALL

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

EMBER_NVM3_ERR_PAGE_SIZE_NOT_SUPPORTED

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

EMBER_NVM3_ERR_TOKEN_INIT

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

EMBER_NVM3_ERR_UNKNOWN

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

EMBER_NCP_UNKNOWN_COMMAND_ID

The NCP does not know the command ID that the host sent. This can correspond to a version mismatch, where an API is available on the host but not on the NCP.

EMBER_APPLICATION_ERROR_0

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

EMBER_APPLICATION_ERROR_1

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

EMBER_APPLICATION_ERROR_2

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

EMBER_APPLICATION_ERROR_3

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

EMBER_APPLICATION_ERROR_4

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

EMBER_APPLICATION_ERROR_5

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

EMBER_APPLICATION_ERROR_6

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

EMBER_APPLICATION_ERROR_7

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

EMBER_APPLICATION_ERROR_8

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

EMBER_APPLICATION_ERROR_9

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

EMBER_APPLICATION_ERROR_10

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

EMBER_APPLICATION_ERROR_11

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

EMBER_APPLICATION_ERROR_12

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

EMBER_APPLICATION_ERROR_13

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

EMBER_APPLICATION_ERROR_14

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

EMBER_APPLICATION_ERROR_15

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


Definition at line 58 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/protocol/flex/stack/include/error-def.h