Macros
#define	DEFINE_ERROR (symbol, value)
	Macro used by `error-def.h` to define all of the return codes. More...

Enumerations
enum	{ EMBER_ERROR_CODE_COUNT }

Generic Messages
These messages are system wide.
#define	EMBER_SUCCESS (x00)
	The generic "no error" message. More...

#define	EMBER_ERR_FATAL (x01)
	The generic "fatal error" message. More...

#define	EMBER_BAD_ARGUMENT (x02)
	An invalid value was passed as an argument to a function. More...

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

#define	EMBER_INVALID_CALL (x70)
	The API call is not allowed given the current state of the stack. More...

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

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

Packet Buffer Module Errors
#define	EMBER_NO_BUFFERS (x18)
	There are no more buffers. More...

Serial Manager Errors
#define	EMBER_SERIAL_INVALID_BAUD_RATE (x20)
	Specified an invalid baud rate. More...

#define	EMBER_SERIAL_INVALID_PORT (x21)
	Specified an invalid serial port. More...

#define	EMBER_SERIAL_TX_OVERFLOW (x22)
	Tried to send too much data. More...

#define	EMBER_SERIAL_RX_OVERFLOW (x23)
	There was not enough space to store a received character and the character was dropped. More...

#define	EMBER_SERIAL_RX_FRAME_ERROR (x24)
	Detected a UART framing error. More...

#define	EMBER_SERIAL_RX_PARITY_ERROR (x25)
	Detected a UART parity error. More...

#define	EMBER_SERIAL_RX_EMPTY (x26)
	There is no received data to process. More...

#define	EMBER_SERIAL_RX_OVERRUN_ERROR (x27)
	The receive interrupt was not handled in time, and a character was dropped. More...

MAC Errors
#define	EMBER_MAC_NO_DATA (x31)
	No pending data exists for device doing a data poll. More...

#define	EMBER_MAC_JOINED_NETWORK (x32)
	Attempt to scan when we are joined to a network. More...

#define	EMBER_MAC_SYNC_TIMEOUT (x33)
	The frequency hopping client failed the frequency hopping synchronization procedure, it timed out trying to reach the frequency hopping server. More...

#define	EMBER_MAC_SYNC_WRONG_SEED (x34)
	The frequency hopping client failed the frequency hopping synchronization procedure, the server is currently using a different seed. More...

#define	EMBER_MAC_SECURITY_FAILED (x35)
	MAC security operation failed. More...

#define	EMBER_MAC_COMMAND_TRANSMIT_FAILURE (x36)
	Failed to scan current channel because we were unable to transmit the relevent MAC command. More...

#define	EMBER_MAC_UNKNOWN_DESTINATION (x37)
	Transmission failed: the destination node does not appear in the neighbor or child tables. More...

#define	EMBER_MAC_SECURITY_NOT_SUPPORTED (x38)
	Transmission failed: the local node does not support security or a secured transmission has been requested to a child that does not support security. More...

#define	EMBER_MAC_TRANSMIT_QUEUE_FULL (x39)
	The MAC transmit queue is full. More...

#define	EMBER_MAC_UNKNOWN_HEADER_TYPE (x3A)
	MAC header FCF error on receive. More...

#define	EMBER_MAC_ACK_HEADER_TYPE (x3B)
	MAC ACK header received. More...

#define	EMBER_MAC_SCANNING (x3D)
	The MAC can't complete this task because it is scanning. More...

#define	EMBER_MAC_BUSY (x3E)
	The requested operation cannot be completed because the MAC is currently busy performing some high priority task. More...

#define	EMBER_MAC_NO_ACK_RECEIVED (x40)
	We expected to receive an ACK following the transmission, but the MAC level ACK was never received. More...

#define	EMBER_MAC_INDIRECT_TIMEOUT (x41)
	Indirect data message timed out before polled. More...

#define	EMBER_MAC_INDIRECT_MESSAGE_PURGED (x42)
	Transmission failed: the indirect message was purged because the destination child has been removed or updated. More...

Simulated EEPROM Errors
#define	EMBER_SIM_EEPROM_ERASE_PAGE_GREEN (x43)
	The Simulated EEPROM is telling the application that there is at least one flash page to be erased. The GREEN status means the current page has not filled above the ::ERASE_CRITICAL_THRESHOLD. More...

#define	EMBER_SIM_EEPROM_ERASE_PAGE_RED (x44)
	The Simulated EEPROM is telling the application that there is at least one flash page to be erased. The RED status means the current page has filled above the ::ERASE_CRITICAL_THRESHOLD. More...

#define	EMBER_SIM_EEPROM_FULL (x45)
	The Simulated EEPROM has run out of room to write any 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. More...

#define	EMBER_SIM_EEPROM_INIT_1_FAILED (x48)
	Attempt 1 to initialize the Simulated EEPROM has failed. More...

#define	EMBER_SIM_EEPROM_INIT_2_FAILED (x49)
	Attempt 2 to initialize the Simulated EEPROM has failed. More...

#define	EMBER_SIM_EEPROM_INIT_3_FAILED (x4A)
	Attempt 3 to initialize the Simulated EEPROM has failed. More...

#define	EMBER_SIM_EEPROM_REPAIRING (x4D)
	The Simulated EEPROM is repairing itself. More...

Flash Errors
#define	EMBER_ERR_FLASH_WRITE_INHIBITED (x46)
	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. More...

#define	EMBER_ERR_FLASH_VERIFY_FAILED (x47)
	A fatal error has occurred while trying to write data to the Flash and the write verification has failed. 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. More...

#define	EMBER_ERR_FLASH_PROG_FAIL (x4B)

#define	EMBER_ERR_FLASH_ERASE_FAIL (x4C)

Bootloader Errors
#define	EMBER_ERR_BOOTLOADER_TRAP_TABLE_BAD (x58)
	The bootloader received an invalid message (failed attempt to go into bootloader). More...

#define	EMBER_ERR_BOOTLOADER_TRAP_UNKNOWN (x59)
	Bootloader received an invalid message (failed attempt to go into bootloader). More...

#define	EMBER_ERR_BOOTLOADER_NO_IMAGE (x05A)
	The bootloader cannot complete the bootload operation because either an image was not found or the image exceeded memory bounds. More...

Transport Errors
#define	EMBER_MESSAGE_TOO_LONG (x74)
	The message to be transmitted is too big to fit into a single over-the-air packet. More...

HAL Module Errors
#define	EMBER_ADC_CONVERSION_DONE (x80)
	Conversion is complete. More...

#define	EMBER_ADC_CONVERSION_BUSY (x81)
	Conversion cannot be done because a request is being processed. More...

#define	EMBER_ADC_CONVERSION_DEFERRED (x82)
	Conversion is deferred until the current request has been processed. More...

#define	EMBER_ADC_NO_CONVERSION_PENDING (x84)
	No results are pending. More...

#define	EMBER_SLEEP_INTERRUPTED (x85)
	Sleeping (for a duration) has been abnormally interrupted and exited prematurely. More...

PHY Errors
#define	EMBER_PHY_TX_UNDERFLOW (x88)
	The transmit hardware buffer underflowed. More...

#define	EMBER_PHY_TX_INCOMPLETE (x89)
	The transmit hardware did not finish transmitting a packet. More...

#define	EMBER_PHY_INVALID_CHANNEL (x8A)
	An unsupported channel setting was specified. More...

#define	EMBER_PHY_INVALID_POWER (x8B)
	An unsupported power setting was specified. More...

#define	EMBER_PHY_TX_BUSY (x8C)
	The requested operation cannot be completed because the radio is currently busy, either transmitting a packet or performing calibration. More...

#define	EMBER_PHY_TX_CCA_FAIL (x8D)
	The transmit attempt failed because all CCA attempts indicated that the channel was busy. More...

#define	EMBER_PHY_ACK_RECEIVED (x8F)
	The expected ACK was received after the last transmission. More...

Return Codes Passed to emberStackStatusHandler()
See also emberStackStatusHandler() .
#define	EMBER_NETWORK_UP (x90)
	The stack software has completed initialization and is ready to send and receive packets over the air. More...

#define	EMBER_NETWORK_DOWN (x91)
	The network is not operating. More...

#define	EMBER_JOIN_SCAN_FAILED (x93)
	The node failed to initiate the scanning process during the joining process. More...

#define	EMBER_JOIN_FAILED (x94)
	An attempt to join a network failed. More...

#define	EMBER_JOIN_DENIED (x95)
	An attempt to join a network was rejected. More...

#define	EMBER_JOIN_TIMEOUT (x96)
	The node timed out waiting for a response during the joining process. More...

#define	EMBER_NO_VALID_BEACONS (xAB)
	An attempt to join or rejoin the network failed because no valid beacons could be heard by the joining node. More...

Security Errors
#define	EMBER_KEY_INVALID (xB2)
	The passed key data is not valid. A key of all zeros or all F's are reserved values and cannot be used. More...

#define	EMBER_SECURITY_DATA_INVALID (xBD)
	The security data provided was not valid, or an integrity check failed. More...

Miscellaneous Network Errors
#define	EMBER_NOT_JOINED (x93)
	The node has not joined a network. More...

Miscellaneous Utility Errors
#define	EMBER_INDEX_OUT_OF_RANGE (xB1)
	An index was passed into the function that was larger than the valid range. More...

#define	EMBER_TABLE_FULL (xB4)
	There are no empty entries left in the table. More...

#define	EMBER_TABLE_ENTRY_ERASED (xB6)
	The requested table entry has been erased and contains no valid data. More...

#define	EMBER_LIBRARY_NOT_PRESENT (xB5)
	The requested function cannot be executed because the library that contains the necessary functionality is not present. More...

#define	EMBER_OPERATION_IN_PROGRESS (xBA)
	The stack accepted the command and is currently processing the request. The results will be returned via an appropriate handler. More...

Application Errors
These error codes are available for application use.
#define	EMBER_APPLICATION_ERROR_0 (xF0)
	This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL. More...

#define	EMBER_APPLICATION_ERROR_1 (xF1)
	This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL. More...

#define	EMBER_APPLICATION_ERROR_2 (xF2)
	This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL. More...

#define	EMBER_APPLICATION_ERROR_3 (xF3)
	This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL. More...

#define	EMBER_APPLICATION_ERROR_4 (xF4)
	This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL. More...

#define	EMBER_APPLICATION_ERROR_5 (xF5)
	This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL. More...

#define	EMBER_APPLICATION_ERROR_6 (xF6)
	This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL. More...

#define	EMBER_APPLICATION_ERROR_7 (xF7)
	This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL. More...

#define	EMBER_APPLICATION_ERROR_8 (xF8)
	This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL. More...

#define	EMBER_APPLICATION_ERROR_9 (xF9)
	This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL. More...

#define	EMBER_APPLICATION_ERROR_10 (xFA)
	This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL. More...

#define	EMBER_APPLICATION_ERROR_11 (xFB)
	This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL. More...

#define	EMBER_APPLICATION_ERROR_12 (xFC)
	This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL. More...

#define	EMBER_APPLICATION_ERROR_13 (xFD)
	This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL. More...

#define	EMBER_APPLICATION_ERROR_14 (xFE)
	This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL. More...

#define	EMBER_APPLICATION_ERROR_15 (xFF)
	This error is reserved for customer application use. This will never be returned from any portion of the network stack or HAL. More...

Detailed Description

Many Ember 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.

Macro Definition Documentation

#define DEFINE_ERROR	(	`symbol,`
		`value`
	)

Macro used by error-def.h to define all of the return codes.

Parameters

`symbol`	The name of the constant being defined. All Ember returns begin with EMBER_. For example, ::EMBER_CONNECTION_OPEN.
`value`	The value of the return code. For example, 0x61.

Definition at line 34 of file error.h .

#define EMBER_ADC_CONVERSION_BUSY ( x81 )

Conversion cannot be done because a request is being processed.

Definition at line 602 of file error-def.h .

#define EMBER_ADC_CONVERSION_DEFERRED ( x82 )

Conversion is deferred until the current request has been processed.

Definition at line 612 of file error-def.h .

#define EMBER_ADC_CONVERSION_DONE ( x80 )

Conversion is complete.

Definition at line 592 of file error-def.h .

#define EMBER_ADC_NO_CONVERSION_PENDING ( x84 )

No results are pending.

Definition at line 621 of file error-def.h .

#define EMBER_APPLICATION_ERROR_0 ( xF0 )