Stack Information#

emberStackStatusHandler#

void emberStackStatusHandler (EmberStatus status)

A callback invoked when the status of the stack changes.

The application is free to begin messaging once it receives the EMBER_NETWORK_UP status.

emberStackIsrHandler#

void emberStackIsrHandler (void )

This handler is invoked in ISR context when certain stack-related ISR routines fire.

emberStackIdleHandler#

bool emberStackIdleHandler (uint32_t * idleTimeMs)

A callback to allow the application to manage idling the MCU.

Returns

• true if the application is managing idling the MCU, false otherwise. If this function returns false, the stack will manage idling the MCU.

emberRadioNeedsCalibratingHandler#

void emberRadioNeedsCalibratingHandler (void )

The radio calibration callback function.

This handler is invoked by the stack upon receiving a "calibration needed" event from the radio to inform the application that it should perform calibration of the current channel as soon as possible using the emberCalibrateCurrentChannel() API. While calibration only takes tens of microseconds, the application can failsafe any critical processes or peripherals before calling emberCalibrateCurrentChannel(). The application must call emberCalibrateCurrentChannel() in response to this callback to maintain expected radio performance.

emberChildJoinHandler#

void emberChildJoinHandler (EmberNodeType nodeType, EmberNodeId nodeId)

Invoked at coordinator, range extender, or mac mode nodes when a new child has joined the device.

emberStackPowerDown#

void emberStackPowerDown (void )

Immediately turns the radio power completely off.

After calling this function, do not call any other stack function except emberStackPowerUp() because all other stack functions require that the radio is powered to operate properly.

emberStackPowerUp#

void emberStackPowerUp (void )

Power up the radio. Typically called coming out of sleep.

For non-sleepy devices, also turns the radio on and leaves it in RX mode.

emberNetworkState#

EmberNetworkStatus emberNetworkState (void )

Return the current join status.

Returns a value indicating whether the node is joining, joined to, or leaving a network.

Returns

• An EmberNetworkStatus value indicating the current join status.

emberStackIsUp#

bool emberStackIsUp (void )

Indicate whether the stack is currently up.

Returns true if the stack is joined to a network and ready to send and receive messages. This reflects only the state of the local node and does not indicate whether or not other nodes are able to communicate with this node.

Returns

• true if the stack is up, false otherwise.

emberSetSecurityKey#

EmberStatus emberSetSecurityKey (EmberKeyData * key)

Write a key at the address of the formerly used security key. The key set by this function will not be used by the stack. The API is meant to be used to erase a key as it is now managed by PSA Crypto API.

Returns

• An EmberStatus value of EMBER_SUCCESS if the key was successfully set. Otherwise, it returns an EmberStatus value of EMBER_INVALID_CALL.

emberGetSecurityKey#

EmberStatus emberGetSecurityKey (EmberKeyData * key)

Get the legacy security key. This function does not return the value set with the PSA Crypto API.

Returns

• An EmberStatus value of EMBER_SUCCESS if the key was successfully read.

emberSetRadioChannelExtended#

EmberStatus emberSetRadioChannelExtended (uint16_t channel, bool persistent)

Set the channel for sending and receiving messages on the current network. The available channels depend on the radio config you use. Channels can differ more than the frequency if it's a multi-PHY config.

Note

• Care should be taken when using this API. All devices on a network must use the same channel.

Returns

• An EmberStatus value of:

  • EMBER_SUCCESS if the stack accepted the channel change.

  • EMBER_INVALID_CALL if the node is currently performing frequency hopping.

  • EMBER_PHY_INVALID_CHANNEL if the passed channel is invalid.

  • EMBER_MAC_BUSY if the MAC is currently performing a high priority task.

emberSetRadioChannel#

EmberStatus emberSetRadioChannel (uint16_t channel)

Set the channel for sending and receiving messages on the current network. The available channels depend on the radio config you use. Channels can differ more than the frequency if it's a multi-PHY config.

Note

• Care should be taken when using this API. All devices on a network must use the same channel. Each call triggers a token write. Excessive usage might cause flash to wear-out.

Returns

• An EmberStatus value of:

  • EMBER_SUCCESS if the stack accepted the channel change.

  • EMBER_INVALID_CALL if the node is currently performing frequency hopping.

  • EMBER_PHY_INVALID_CHANNEL if the passed channel is invalid.

  • EMBER_MAC_BUSY if the MAC is currently performing a high priority task.

emberGetRadioChannel#

uint16_t emberGetRadioChannel (void )

Get the radio channel, to which a node is set, on the current network. The available channels depend on the radio config you use. Channels can differ more than the frequency if it's a multi-PHY config.

Returns

• The current radio channel.

emberGetDefaultChannel#

uint16_t emberGetDefaultChannel (void )

Get the first available channel in the current radio configuration.

Returns

• The first available channel in the radio configuration. 0xffff if error

emberPhyConfigInit#

EmberStatus emberPhyConfigInit (EmberPhyType phyType)

Indicate if the PHY configuration of the stack. Currently only supporting EMBER_RADIO_CONFIGURATOR and EMBER_STANDARD_PHY_2_4GHZ. It must be called before initializing the stack.

Returns

• EMBER_BAD_ARGUMENT if phyType is incorrect EMBER_INVALID_CALL if API is called after stack initialization EMBER_SUCCESS otherwise

emberCalibrateCurrentChannelExtended#

EmberStatus emberCalibrateCurrentChannelExtended (uint32_t calValueIn, uint32_t * calValueOut)

Perform image rejection calibration on the current channel. The stack will notify the application that it needs channel calibration via the emberRadioNeedsCalibratingHandler() callback function during emberTick(). This function should only be called from within the context of the emberRadioNeedsCalibratingHandler() callback function. Note if this function is called when the radio is off, it will turn the radio on and leave it on.

Returns

• An EmberStatus value indicating the success or failure of the command.

emberCalibrateCurrentChannel#

EmberStatus emberCalibrateCurrentChannel (void )

Perform image rejection calibration on the current channel. The stack will notify the application that it needs channel calibration via the emberRadioNeedsCalibratingHandler() callback function during emberTick(). This function should only be called from within the context of the emberRadioNeedsCalibratingHandler() callback function. Note if this function is called when the radio is off, it will turn the radio on and leave it on.

emberApplyIrCalibration#

EmberStatus emberApplyIrCalibration (uint32_t calValue)

Apply Image Rejection calibration on the current channel. The stack will notify the application that it needs channel calibration via the emberRadioNeedsCalibratingHandler() callback function during emberTick(). This function should only be called from within the context of the emberRadioNeedsCalibratingHandler() callback function. Note if this function is called when the radio is off, it will turn the radio on and leave it on.

Returns

• An EmberStatus value indicating the success or failure of the command.

emberTempCalibration#

EmberStatus emberTempCalibration (void )

Perform Temperature VCO calibration calibration on the current channel. The stack will notify the application that it needs channel calibration via the emberRadioNeedsCalibratingHandler() callback function during emberTick(). This function should only be called from within the context of the emberRadioNeedsCalibratingHandler() callback function. Note if this function is called when the radio is off, it will turn the radio on and leave it on.

Returns

• An EmberStatus value indicating the success or failure of the command.

emberGetCalType#

EmberCalType emberGetCalType (void )

Fetch calibration type associated to the latest emberRadioNeedsCalibratingHandler() callback.

Returns

• An EmberCalType value indicating which type of calibration should be performed.

emberSetRadioPower#

EmberStatus emberSetRadioPower (int16_t power, bool persistent)

Set the radio output power at which a node is to operate for the current network. The radio has a finite power resolution, so it will approximate the requested power with the closest possible value at or below the requested value.

Note

• Care should be taken when using this API on a running network, because it directly impacts the established link qualities neighboring nodes have with the node on which it is called. This can lead to disruption of existing routes and erratic network behavior.

Returns

• An EmberStatus value indicating the success or failure of the command. Failure indicates that the requested power level is out of range.

emberGetRadioPower#

int16_t emberGetRadioPower (void )

Get the radio output power of the current network at which a node is operating. This might be different to what you set using emberSetRadioPower because the radio has a finite power resolution, and emberSetRadioPower must approximate to the closest possible value at or below the requested value. This API however returns with the actual setting.

Returns

• Current radio output power, in deci-dBm.

emberSetRadioPowerMode#

EmberStatus emberSetRadioPowerMode (bool radioOn)

Allow the application to turn the radio on/off. This API is intended for use with direct devices only.

Returns

• An EmberStatus value indicating the success or failure of the command. Failure indicates that the node type is a type other than EMBER_DIRECT_DEVICE.

emberSetUnencryptedPacketsAcceptance#

EmberStatus emberSetUnencryptedPacketsAcceptance (bool accept)

Set if the stack should forward unencrypted messages to the application.

Returns

• An EmberStatus value of EMBER_INVALID_CALL if trying to filter out unencrypted message and if the stack cannot receive encrypted messages (eg. no security key is set). An EmberStatus value of EMBER_SUCCESS otherwise.

emberSetMacParams#

EmberStatus emberSetMacParams (int8_t ccaThreshold, uint8_t maxCcaAttempts, uint8_t minBackoffExp, uint8_t maxBackoffExp, uint16_t ccaBackoff, uint16_t ccaDuration, uint8_t maxRetries, uint32_t csmaTimeout, uint16_t ackTimeout)

Set the MAC layer transmission parameters.

Note

• The CSMA/CA (CCA) values are directly used in RAIL's RAIL_CsmaConfig_t and further information can be found in the RAIL API documentation.

Returns

• An EmberStatus value indicating whether the MAC parameters were successfully set or the reason of failure.

emberMacGetParentAddress#

EmberStatus emberMacGetParentAddress (EmberMacAddress * parentAddress)

Retrieve the parent address. This API can be invoked only for nodes of EMBER_MAC_MODE_DEVICE or EMBER_MAC_MODE_SLEEPY_DEVICE type.

Returns

• An EmberStatus value of EMBER_SUCCESS if the parent address was successfully retrieved, otherwise an EmberStatus value indicating the reason of failure.

emberStackIdleTimeMs#

uint32_t emberStackIdleTimeMs (uint16_t * currentStackTasks)

Return the time in milliseconds the stack could idle for.

Returns

• Allowed idle time in milliseconds.

emberGetInt32uMillisecondTick#

uint32_t emberGetInt32uMillisecondTick (void )

Return the current time in milliseconds.

Returns

• Current time in milliseconds.

emberCurrentStackTasks#

uint16_t emberCurrentStackTasks (void )

Return a bitmask indicating the stack's current tasks.

The mask EMBER_HIGH_PRIORITY_TASKS defines which tasks are high-priority. Devices should not sleep if any high-priority tasks are active. Active tasks that are not high-priority are waiting for messages to arrive from other devices. If there are active tasks, but no high-priority ones, the device may sleep but should periodically wake up and call emberPollForData() to receive messages. Parents will hold messages for EMBER_INDIRECT_TRANSMISSION_TIMEOUT_MS milliseconds before discarding them.

Returns

• A bitmask of the stack's active tasks.

emberOkToNap#

bool emberOkToNap (void )

Indicate whether the stack is currently in a state with no high-priority tasks and may sleep.

Tasks may be expecting incoming messages, in which case the device should periodically wake up and call emberPollForData() to receive messages. This function can only be called when the node type is EMBER_STAR_SLEEPY_END_DEVICE.

Returns

• true if the application may sleep but the stack may be expecting incoming messages.

emberOkToHibernate#

bool emberOkToHibernate (void )

Indicate whether the stack currently has any pending tasks.

If no tasks are pending , emberTick() does not need to be called until next stack API function is called. This function can only be called when the node type is EMBER_STAR_SLEEPY_END_DEVICE.

Returns

• true if the application may sleep for as long as it wishes.

emberGetEui64#

uint8_t * emberGetEui64 (void )

Return the EUI64 ID of the local node.

Returns

• The 64-bit ID.

emberIsLocalEui64#

bool emberIsLocalEui64 (EmberEUI64 eui64)

Determine whether eui64 is the local node's EUI64 ID. EUI64 is easily accessible in SoC mode, but in Host-NCP, the address is stored on the NCP. This API can be used on the Host to compare a value with the locally stored one.

Returns

• true if eui64 is the local node's ID, otherwise false.

emberGetNodeId#

EmberNodeId emberGetNodeId (void )

Return the 16-bit node ID of local node on the current network.

Returns

• The 16-bit ID. Byte order is little endian.

emberGetPanId#

EmberPanId emberGetPanId (void )

Return the local node's PAN ID of the current network.

Returns

• The PAN ID.

emberGetNodeType#

EmberNodeType emberGetNodeType (void )

Return an EmberNodeType value indicating the type of the node.

Returns

• The node type.

emberGetParentId#

EmberNodeId emberGetParentId (void )

Return the parent's node ID.

Returns

• The parent's node ID.

emberGetVersionInfo#

EmberStatus emberGetVersionInfo (uint16_t * platform_version, uint16_t * connect_stack_version, uint32_t * bootloader_version)

Get the Platform, Stack and bootloader versions all at once. The version format are not all the same. Please refer to the corresponding documentation to handle the information correctly. The Platform version corresponds to the deprecated GSDK version.

Returns

• EMBER_SUCCESS if successful

EMBER_HIGH_PRIORITY_TASKS#

#define EMBER_HIGH_PRIORITY_TASKS

  (EMBER_OUTGOING_MESSAGES | EMBER_INCOMING_MESSAGES | EMBER_RADIO_IS_ON)

A mask of the tasks that prevent a device from sleeping.

EMBER_INVALID_CHANNEL#

#define EMBER_INVALID_CHANNEL

65535

Invalid channel number.