Return-code definitions for Ember Connect stack API functions. More...

Enumerations

enum  EmberStatus {
  EMBER_SUCCESS,
  EMBER_ERR_FATAL,
  EMBER_BAD_ARGUMENT,
  EMBER_EEPROM_MFG_STACK_VERSION_MISMATCH,
  EMBER_INVALID_CALL,
  EMBER_EEPROM_MFG_VERSION_MISMATCH,
  EMBER_EEPROM_STACK_VERSION_MISMATCH,
  EMBER_NO_BUFFERS,
  EMBER_SERIAL_INVALID_BAUD_RATE,
  EMBER_SERIAL_INVALID_PORT,
  EMBER_SERIAL_TX_OVERFLOW,
  EMBER_SERIAL_RX_OVERFLOW,
  EMBER_SERIAL_RX_FRAME_ERROR,
  EMBER_SERIAL_RX_PARITY_ERROR,
  EMBER_SERIAL_RX_EMPTY,
  EMBER_SERIAL_RX_OVERRUN_ERROR,
  EMBER_MAC_NO_DATA,
  EMBER_MAC_SYNC_TIMEOUT,
  EMBER_MAC_SYNC_WRONG_SEED,
  EMBER_MAC_SECURITY_FAILED,
  EMBER_MAC_UNKNOWN_DESTINATION,
  EMBER_MAC_SECURITY_NOT_SUPPORTED,
  EMBER_MAC_TRANSMIT_QUEUE_FULL,
  EMBER_MAC_ACK_HEADER_TYPE,
  EMBER_MAC_SCANNING,
  EMBER_MAC_BUSY,
  EMBER_MAC_NO_ACK_RECEIVED,
  EMBER_MAC_INDIRECT_TIMEOUT,
  EMBER_MAC_INDIRECT_MESSAGE_PURGED,
  EMBER_SIM_EEPROM_ERASE_PAGE_GREEN,
  EMBER_SIM_EEPROM_ERASE_PAGE_RED,
  EMBER_SIM_EEPROM_FULL,
  EMBER_SIM_EEPROM_INIT_1_FAILED,
  EMBER_SIM_EEPROM_INIT_2_FAILED,
  EMBER_SIM_EEPROM_INIT_3_FAILED,
  EMBER_SIM_EEPROM_REPAIRING,
  EMBER_ERR_FLASH_WRITE_INHIBITED,
  EMBER_ERR_FLASH_VERIFY_FAILED,
  EMBER_ERR_FLASH_PROG_FAIL,
  EMBER_ERR_FLASH_ERASE_FAIL,
  EMBER_ERR_BOOTLOADER_TRAP_TABLE_BAD,
  EMBER_ERR_BOOTLOADER_TRAP_UNKNOWN,
  EMBER_ERR_BOOTLOADER_NO_IMAGE,
  EMBER_MESSAGE_TOO_LONG,
  EMBER_ADC_CONVERSION_DONE,
  EMBER_ADC_CONVERSION_BUSY,
  EMBER_ADC_CONVERSION_DEFERRED,
  EMBER_ADC_NO_CONVERSION_PENDING,
  EMBER_SLEEP_INTERRUPTED,
  EMBER_PHY_TX_UNDERFLOW,
  EMBER_PHY_TX_INCOMPLETE,
  EMBER_PHY_INVALID_CHANNEL,
  EMBER_PHY_INVALID_POWER,
  EMBER_PHY_TX_BUSY,
  EMBER_PHY_TX_CCA_FAIL,
  EMBER_PHY_ACK_RECEIVED,
  EMBER_NETWORK_UP,
  EMBER_NETWORK_DOWN,
  EMBER_JOIN_SCAN_FAILED,
  EMBER_JOIN_FAILED,
  EMBER_JOIN_DENIED,
  EMBER_JOIN_TIMEOUT,
  EMBER_NO_VALID_BEACONS,
  EMBER_SECURITY_DATA_INVALID,
  EMBER_NOT_JOINED,
  EMBER_INDEX_OUT_OF_RANGE,
  EMBER_TABLE_FULL,
  EMBER_LIBRARY_NOT_PRESENT,
  EMBER_OPERATION_IN_PROGRESS,
  EMBER_NVM3_TOKEN_NO_VALID_PAGES,
  EMBER_NVM3_ERR_OPENED_WITH_OTHER_PARAMETERS,
  EMBER_NVM3_ERR_ALIGNMENT_INVALID,
  EMBER_NVM3_ERR_SIZE_TOO_SMALL,
  EMBER_NVM3_ERR_PAGE_SIZE_NOT_SUPPORTED,
  EMBER_NVM3_ERR_TOKEN_INIT,
  EMBER_NVM3_ERR_UPGRADE,
  EMBER_NVM3_ERR_UNKNOWN,
  EMBER_APPLICATION_ERROR_0,
  EMBER_APPLICATION_ERROR_1,
  EMBER_APPLICATION_ERROR_2,
  EMBER_APPLICATION_ERROR_3,
  EMBER_APPLICATION_ERROR_4,
  EMBER_APPLICATION_ERROR_5,
  EMBER_APPLICATION_ERROR_6,
  EMBER_APPLICATION_ERROR_7,
  EMBER_APPLICATION_ERROR_8,
  EMBER_APPLICATION_ERROR_9,
  EMBER_APPLICATION_ERROR_10,
  EMBER_APPLICATION_ERROR_11,
  EMBER_APPLICATION_ERROR_12,
  EMBER_APPLICATION_ERROR_13,
  EMBER_APPLICATION_ERROR_14,
  EMBER_APPLICATION_ERROR_15
}
 

Detailed Description

Return-code definitions for Ember Connect stack API functions.

See Status Codes for documentation.

License

Copyright 2018 Silicon Laboratories Inc. www.silabs.com

The licensor of this software is Silicon Laboratories Inc. Your use of this software is governed by the terms of Silicon Labs Master Software License Agreement (MSLA) available at www.silabs.com/about-us/legal/master-software-license-agreement. This software is distributed to you in Source Code format and is governed by the sections of the MSLA applicable to Source Code.

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.

Enumeration Type Documentation

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.

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 the character was 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 a character was 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 the MAC is currently busy performing some high priority task.

EMBER_MAC_NO_ACK_RECEIVED 

We 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.

EMBER_SIM_EEPROM_ERASE_PAGE_GREEN 

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.

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

EMBER_SIM_EEPROM_ERASE_PAGE_RED 

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.

Due to the shrinking availability of write space, there is a danger of data loss. The application must call the function ::halSimEepromErasePage() as soon as possible to erase a page.

EMBER_SIM_EEPROM_FULL 

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.

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

EMBER_SIM_EEPROM_INIT_1_FAILED 

Attempt 1 to initialize the Simulated EEPROM has failed.

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

EMBER_SIM_EEPROM_INIT_2_FAILED 

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.

EMBER_SIM_EEPROM_INIT_3_FAILED 

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.

EMBER_SIM_EEPROM_REPAIRING 

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 repairing is occurring. There are debugging scenarios where an app might want to know that repairing is happening; such as monitoring frequency.

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

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.

EMBER_ERR_FLASH_VERIFY_FAILED 

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.

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_ERR_FLASH_ERASE_FAIL 

A fatal error has occurred while trying to erase flash, possibly due to write protection. 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_ERR_BOOTLOADER_TRAP_TABLE_BAD 

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

EMBER_ERR_BOOTLOADER_TRAP_UNKNOWN 

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

EMBER_ERR_BOOTLOADER_NO_IMAGE 

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

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_UNDERFLOW 

The transmit hardware buffer underflowed.

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_ACK_RECEIVED 

The expected ACK was received after the last transmission.

EMBER_NETWORK_UP 

The stack software has completed initialization 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 could be heard 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.

EMBER_INDEX_OUT_OF_RANGE 

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

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 that contains the necessary functionality is not present.

EMBER_OPERATION_IN_PROGRESS 

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

EMBER_NVM3_TOKEN_NO_VALID_PAGES 

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

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_UPGRADE 

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

EMBER_NVM3_ERR_UNKNOWN 

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

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 44 of file error-def.h.