End Devices#

@0#

@0

Define tasks that are taken into account when dealing with sleep related behavior.

As opposed to its subset of EMBER_HIGH_PRIORITY_TASKS, these tasks do not necessarily prevent the device from going to sleep. However, they are taken into account when calculating how long we can sleep until the next event.

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() in order to receive messages. Parents will hold messages for EMBER_INDIRECT_TRANSMISSION_TIMEOUT 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 where there are no high-priority tasks, allowing the device to sleep.

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

Returns

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

emberParentTokenSet#

bool emberParentTokenSet (void)

Indicate whether the parent token has been set by association.

Returns

• True if the parent token has been set.

emberOkToHibernate#

bool emberOkToHibernate (void)

Indicate whether the stack currently has any tasks pending.

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

Returns

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

emberOkToLongPoll#

bool emberOkToLongPoll (void)

Indicate whether the stack is currently in a state that does not require the application to periodically poll.

Returns

• True if the application may stop polling periodically.

emberStackPowerDown#

void emberStackPowerDown (void)

Immediately turn the radio power completely off.

Calling this function will render all other stack functions except emberStackPowerUp() non-functional until the radio is powered back on.

emberStackPowerUp#

void emberStackPowerUp (void)

Initialize the radio. Typically called coming out of deep sleep.

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

emberSendLinkPowerDeltaRequest#

EmberStatus emberSendLinkPowerDeltaRequest (void)

Send a link power delta request to the parent.

emberGetAvgParentRssi#

int8_t emberGetAvgParentRssi (void)

Accessor function for recent average RSSI value between this device and the parent (SoC only).

emberGetParentId#

EmberNodeId emberGetParentId (void)

Accessor function for the parent's node ID if applicable (SoC only).

emberSetChildTimeoutOptionMask#

EmberStatus emberSetChildTimeoutOptionMask (uint16_t mask)

: Bit mask that decides which timeout values are acceptable for a child. It defaults to 0xFFFF which covers all the following 15 options:

#define SECONDS_10 0 #define MINUTES_2 1 #define MINUTES_4 2 #define MINUTES_8 3 #define MINUTES_16 4 #define MINUTES_32 5 #define MINUTES_64 6 #define MINUTES_128 7 #define MINUTES_256 8 #define MINUTES_512 9 #define MINUTES_1024 10 #define MINUTES_2048 11 #define MINUTES_4096 12 #define MINUTES_8192 13 #define MINUTES_16384 14 // ~11 days

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.

emberChildId#

EmberNodeId emberChildId (uint8_t childIndex)

Convert a child index to a node ID.

Returns

• The node ID of the child or EMBER_NULL_NODE_ID if there isn't a child at the childIndex specified.

emberChildPower#

int8_t emberChildPower (uint8_t childIndex)

Return radio power value of the child from the given childIndex.

Returns

• The power of the child or maximum radio power, which is the power value provided by the user while forming/joining a network if there isn't a child at the childIndex specified.

emberSetChildPower#

void emberSetChildPower (uint8_t childIndex, int8_t newPower)

Set the radio power value for a given child index.

emberChildIndex#

uint8_t emberChildIndex (EmberNodeId childId)

Convert a node ID to a child index.

Returns

• The child index or 0xFF if the node ID does not belong to a child.

emberGetChildData#

EmberStatus emberGetChildData (uint8_t index, EmberChildData *childData)

Get the EUI64 and node type of the child at the provided index. If there is no child at 'index', it returns EMBER_NOT_JOINED. Possible child indexes run from zero to emberMaxChildCount() - 1.

Returns

• Returns EMBER_SUCCESS if a child is found at that index, EMBER_NOT_JOINED if not.

emberSetChildData#

EmberStatus emberSetChildData (uint8_t index, EmberChildData *childData)

Sets the EUI64, node ID, and node type of the child at the provided index in nonvolatile memory. No other data from the childData argument is used or copied. The user is responsible for rebooting the device after calling this API in order to initialize RAM-based child data. Possible child indexes run from zero to emberMaxChildCount() - 1.

Returns

• Returns EMBER_SUCCESS if successfully setting child at that index, EMBER_INDEX_OUT_OF_RANGE if provided index is out of range.

Note

• This API only sets the child data to nonvolatile memory. A reboot is required after calling this API to read the nonvolatile child data and set it to RAM structures. This API does not set other child RAM data, such as power and timeout values.

emberChildJoinHandler#

void emberChildJoinHandler (uint8_t index, bool joining)

Called by the stack when a child joins or leaves. 'Joining' is true if the child is joining and false if leaving.

The index is the same as the value that should be passed to emberGetChildData() to get this child's data. Note that if the child is leaving, emberGetChildData() will return EMBER_NOT_JOINED if called with this index. If the application includes emberChildJoinHandler(), it must define EMBER_APPLICATION_HAS_CHILD_JOIN_HANDLER in its CONFIGURATION_HEADER

emberSetKeepAliveMode#

EmberStatus emberSetKeepAliveMode (EmberKeepAliveMode mode)

@ brief Set the keep alive mode.

emberGetKeepAliveMode#

EmberKeepAliveMode emberGetKeepAliveMode (void)

@ brief Get the keep alive mode.

Returns

• mode One of the four configurations in the EmberKeepAliveMode.

emberPollForData#

EmberStatus emberPollForData (void)

Request any pending data from the parent node. This function allows an end device to query its parent for any pending data.

End devices must call this function periodically to maintain contact with their parent. The parent will remove a child if it has not received a poll from it within the configured timeout.

If the end device has lost contact with its parent, emberPollForData() calls ::emberRejoinNetwork(true) and returns EMBER_ERR_FATAL.

The default values for the timeouts are set in config/ember-configuration-defaults.h and can be overridden in the application's configuration header.

Returns

• An EmberStatus value:

  • EMBER_SUCCESS - The poll message has been submitted for transmission.

  • EMBER_INVALID_CALL - The node is not an end device.

  • EMBER_NOT_JOINED - The node is not part of a network.

  • EMBER_MAC_TRANSMIT_QUEUE_FULL - The MAC layer transmit queue is full.

  • EMBER_NO_BUFFERS - No buffers available to create the data poll message.

  • EMBER_ERR_FATAL - Too much time has elapsed since the last successful poll. A rejoin attempt has been initiated. This error is not "fatal". The command can be retried until successful.

emberSetMacPollFailureWaitTime#

void emberSetMacPollFailureWaitTime (uint32_t waitBeforeRetryIntervalMs)

@ brief Set the retry interval (in milliseconds) for mac data poll. This function is useful for sleepy end devices. The retry interval is the time in milliseconds the device waits before retrying a data poll when a MAC level data poll fails for any reason. The retry feature can be disabled by setting the retry interval to zero.

emberPollCompleteHandler#

void emberPollCompleteHandler (EmberStatus status)

@ brief Called by the stack when a data poll to the parent is complete.

If the application includes emberPollCompleteHandler(), it must define EMBER_APPLICATION_HAS_POLL_COMPLETE_HANDLER within its CONFIGURATION_HEADER

emberSetMessageFlag#

EmberStatus emberSetMessageFlag (EmberNodeId childId)

Set a flag to indicate that a message is pending for a child. The next time that the child polls, it will be informed that it has a pending message. The message is sent from emberPollHandler, which is called when the child requests data.

Returns

• An EmberStatus value.

  • EMBER_SUCCESS - The next time that the child polls, it will be informed that it has pending data.

  • EMBER_NOT_JOINED - The child identified by childId is not our child.

emberClearMessageFlag#

EmberStatus emberClearMessageFlag (EmberNodeId childId)

Clear a flag to indicate that there are no more messages for a child. The next time the child polls, it will be informed that it does not have any pending messages.

Returns

• An EmberStatus value.

  • EMBER_SUCCESS - The next time that the child polls, it will be informed that it does not have any pending messages.

  • EMBER_NOT_JOINED - The child identified by childId is not our child.

emberPollHandler#

void emberPollHandler (EmberNodeId childId, bool transmitExpected)

Called to allow the application to send a message in response to a poll from a child.

This function is called when a child polls, provided that the pending message flag is set for that child (see emberSetMessageFlag(). The message should be sent to the child using emberSendUnicast() with the EMBER_APS_OPTION_POLL_RESPONSE option.

If the application includes ::emberPollHanlder(), it must define EMBER_APPLICATION_HAS_POLL_HANDLER in its CONFIGURATION_HEADER.

emberAddChild#

EmberStatus emberAddChild (EmberNodeId shortId, EmberEUI64 longId, EmberNodeType nodeType)

Add a child to the child/neighbor table only on SoC, allowing direct manipulation of these tables by the application. This can affect the network functionality, and needs to be used wisely. If used appropriately, the application can maintain more than the maximum of children provided by the stack.

Returns

• An EmberStatus value.

  • EMBER_SUCCESS - This node has been successfully added.

  • EMBER_ERR_FATAL - The child was not added to the child/neighbor table.

emberRemoveChild#

EmberStatus emberRemoveChild (EmberEUI64 childEui64)

Remove a node from child/neighbor table only on SoC, allowing direct manipulation of these tables by the application. This can affect the network functionality, and needs to be used wisely.

Returns

• An EmberStatus value.

  • EMBER_SUCCESS - This node has been successfully removed.

  • EMBER_ERR_FATAL - The node was not found in either of the child or neighbor tables.

emberRemoveNeighbor#

void emberRemoveNeighbor (EmberNodeId shortId, EmberEUI64 longId)

Remove a neighbor from neighbor table only on SoC, allowing direct manipulation of neighbor table by the application. This can affect the network functionality, and needs to be used wisely.

emberChildCount#

uint8_t emberChildCount (void)

Return the number of children the node currently has.

Returns

• The number of children.

emberRouterChildCount#

uint8_t emberRouterChildCount (void)

Return the number of router children that the node currently has.

Returns

• The number of router children.

emberMaxChildCount#

uint8_t emberMaxChildCount (void)

Return the maximum number of children for this node. The return value is undefined for nodes that are not joined to a network.

Returns

• The maximum number of children.

emberMaxRouterChildCount#

uint8_t emberMaxRouterChildCount (void)

Return the maximum number of router children for this node. The return value is undefined for nodes that are not joined to a network.

Returns

• The maximum number of router children.

emberGetParentNodeId#

EmberNodeId emberGetParentNodeId (void)

Return the parent's node ID. The return value is undefined for nodes without parents (coordinators and nodes that are not joined to a network).

Returns

• The parent's node ID.

emberGetParentEui64#

EmberEUI64 emberGetParentEui64 (void)

Return the parent's EUI64. The return value is undefined for nodes without parents (coordinators and nodes that are not joined to a network).

Returns

• The parent's EUI64.