Stack Information#

emberSetTxPowerMode#

EmberStatus emberSetTxPowerMode (uint16_t txPowerMode)

Enables boost power mode and/or the alternate transmit path.

Boost power mode is a high-performance radio mode, which offers increased transmit power and receive sensitivity at the cost of an increase in power consumption. emberInit() calls this function using the power mode and transmitter output settings as specified in the MFG_PHY_CONFIG token (with each bit inverted so that the default token value of 0xffff corresponds to normal power mode and bi-directional RF transmitter output). The application only needs to call emberSetTxPowerMode() to use a power mode or transmitter output setting different than specified in the MFG_PHY_CONFIG token. After the initial call to emberSetTxPowerMode(), the stack will automatically maintain the specified power mode configuration across sleep/wake cycles.

Returns

• EMBER_SUCCESS if successful; an error code otherwise.

emberGetTxPowerMode#

uint16_t emberGetTxPowerMode (void )

Returns the current configuration of boost power mode and alternate transmitter output.

Returns

• The current TX power mode.

emberSetNodeId#

EmberStatus emberSetNodeId (EmberNodeId nodeId)

Sets the short node ID of the node. Notice that it can only be set if the stack is in the INITAL state.

Returns

• EMBER_SUCCESS if successful; an error code otherwise.

emberGetPhyInterfaceCount#

uint8_t emberGetPhyInterfaceCount (void )

Returns the number of PHY interfaces present.

Returns

• The number of PHY interface(s).

emberRadioNeedsCalibratingHandler#

void emberRadioNeedsCalibratingHandler (void )

The radio calibration callback function.

The Voltage Controlled Oscillator (VCO) can drift with temperature changes. During every call to emberTick(), the stack will check to see if the VCO has drifted. If the VCO has drifted, the stack will call emberRadioNeedsCalibratingHandler() to inform the application that it should perform calibration of the current channel as soon as possible. Calibration can take up to 150 ms. The default callback function implementation provided here performs the calibration immediately. The application can define its own callback by defining ::EMBER_APPLICATION_HAS_CUSTOM_RADIO_CALIBRATION_CALLBACK in its CONFIGURATION_HEADER. It can then failsafe any critical processes or peripherals before calling ::emberCalibrateCurrentChannel(). The application must call ::emberCalibrateCurrentChannel() in response to this callback to maintain expected radio performance.

sl_mac_calibrate_current_channel#

void sl_mac_calibrate_current_channel (void )

Calibrates the current channel. The stack will notify the application of the need for channel calibration via the emberRadioNeedsCalibratingHandler() callback function during emberTick(). This function should only be called from within the context of the emberRadioNeedsCalibratingHandler() callback function. Calibration can take up to 150 ms. Note if this function is called when the radio is off, it will turn the radio on and leave it on.

emberSetLongUpTime#

void emberSetLongUpTime (bool hasLongUpTime)

sets the device uptime to be long or short the uptime is then advertised in the beacons

emberSetHubConnectivity#

void emberSetHubConnectivity (bool connected)

sets the hub connectivity to be true or false the hub connectivity is then advertised in the beacons

emberIsUpTimeLong#

bool emberIsUpTimeLong (void )

Returns

• true if device uptime is long, false otherwise

emberIsHubConnected#

bool emberIsHubConnected (void )

Returns

• true if there is hub connectivity, false otherwise

emberRadioGetSchedulerPriorities#

EmberStatus emberRadioGetSchedulerPriorities (EmberMultiprotocolPriorities * priorities)

API used to get the current scheduler priorities used for Zigbee multiprotocol operations.

Returns

• EMBER_SUCCESS if called in a multiprotocol app and EMBER_INVALID_CALL otherwise.

For more details on what these priorities are and how to use them see UG305, the Dynamic Multiprotocol User Guide.

emberRadioSetSchedulerPriorities#

EmberStatus emberRadioSetSchedulerPriorities (const EmberMultiprotocolPriorities * priorities)

API used to set the current scheduler priorities used for Zigbee multiprotocol operations.

Returns

• EMBER_SUCCESS if called in a multiprotocol app and EMBER_INVALID_CALL otherwise.

For more details on what these priorities are and how to use them see UG305, the Dynamic Multiprotocol User Guide.

emberRadioSetSchedulerSliptime#

EmberStatus emberRadioSetSchedulerSliptime (uint32_t slipTime)

Set the multiprotocol slip time.

Returns

• EMBER_SUCCESS if called in a multiprotocol app and EMBER_INVALID_CALL otherwise.

Use this to update the slip time passed to the radio scheduler for each transmit from the PHY layer. The smaller this is set the lower the potential multi-protocol induced latency is, but it makes packets more likely to fail to be transmitted. For more details on slip time see UG305.

emberRadioGetSchedulerSliptime#

EmberStatus emberRadioGetSchedulerSliptime (uint32_t * slipTime)

Get the multiprotocol slip time.

Returns

• EMBER_SUCCESS if called in a multiprotocol app and EMBER_INVALID_CALL otherwise.

Use this to get the current value of the multiprotocol slip time used for each transmit at the PHY layer. For more details on slip time see UG305.

emberGetBeaconClassificationParams#

EmberStatus emberGetBeaconClassificationParams (EmberBeaconClassificationParams * param)

API used to get current beacon classification parameter settings.

emberSetBeaconClassificationParams#

EmberStatus emberSetBeaconClassificationParams (EmberBeaconClassificationParams * param)

API used to set current beacon classification parameters.

slx_zigbee_routing_set_route_record_policy#

EmberStatus slx_zigbee_routing_set_route_record_policy (sl_zigbee_route_record_policy_type_t policy)

Set the route record policy.

Returns

• EMBER_SUCCESS if route record policy was sucessfully set EMBER_BAD_ARGUMENT otherwise.

Use this to set the policy for senidng a route record message to a concentrator Note that policies other than the default ROUTE_RECORD_POLICY_ACK_BY_SOURCE_ROUTED_MESSAGE may result in behaviour not compliant with the Zigbee specification

slx_zigbee_routing_get_route_record_policy#

uint8_t slx_zigbee_routing_get_route_record_policy (void )

Get the route record policy.

Returns

• The route record policy

Use this to get the current value of the route record policy

emberStackProfileId#

const uint8_t emberStackProfileId[]

The application must provide a definition for this variable.

profileId#

uint16_t EmberEndpointDescription::profileId

Identifies the endpoint's application profile.

deviceId#

uint16_t EmberEndpointDescription::deviceId

The endpoint's device ID within the application profile.

deviceVersion#

uint8_t EmberEndpointDescription::deviceVersion

The endpoint's device version.

inputClusterCount#

uint8_t EmberEndpointDescription::inputClusterCount

The number of input clusters.

outputClusterCount#

uint8_t EmberEndpointDescription::outputClusterCount

The number of output clusters.

endpoint#

uint8_t EmberEndpoint::endpoint

An endpoint of the application on this node.

description#

EmberEndpointDescription const* EmberEndpoint::description

The endpoint's description.

inputClusterList#

uint16_t const* EmberEndpoint::inputClusterList

Input clusters the endpoint will accept.

outputClusterList#

uint16_t const* EmberEndpoint::outputClusterList

Output clusters the endpoint may send.

emberEndpointCount#

uint8_t emberEndpointCount

The application must provide a definition for this variable.

emberEndpoints#

EmberEndpoint emberEndpoints[]

If emberEndpointCount is nonzero, the application must provide descriptions for each endpoint.

This can be done either by providing a definition of emberEndpoints or by providing definitions of emberGetEndpoint(), emberGetEndpointDescription() and emberGetEndpointCluster(). Using the array is often simpler, but consumes large amounts of memory if emberEndpointCount is large.

If the application provides definitions for the three functions, it must define EMBER_APPLICATION_HAS_GET_ENDPOINT in its CONFIGURATION_HEADER.

emberStackStatusHandler#

void emberStackStatusHandler (EmberStatus status)

A callback invoked when the status of the stack changes. If the status parameter equals EMBER_NETWORK_UP, the emberGetNetworkParameters() function can be called to get the new network parameters. If any of the parameters are stored in nonvolatile memory by the application, the stored values should be updated.

The application is free to begin messaging after it receives the EMBER_NETWORK_UP status. However, routes discovered immediately after the stack comes up may be suboptimal because the routes are based on the neighbor table's information about two-way links with neighboring nodes, which is obtained from periodic ZigBee Link Status messages. It can take two or three link status exchange periods (of 16 seconds each) before the neighbor table has a good estimate of link quality to neighboring nodes. Therefore, the application may improve the quality of initially discovered routes by waiting after startup to give the neighbor table time to be populated.

emberNetworkState#

EmberNetworkStatus emberNetworkState (void )

Returns 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 )

Indicates 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; it does not indicate whether other nodes are able to communicate with this node.

Returns

• True if the stack is up, false otherwise.

emberWriteNodeData#

EmberStatus emberWriteNodeData (bool erase)

Writes node data to stack token.

Returns

• The status of the operation and an error code if unsuccessful.

emberGetEui64#

EmberEUI64 emberGetEui64 (void )

Returns the EUI64 ID of the local node.

Returns

• The 64-bit ID.

emberIsLocalEui64#

bool emberIsLocalEui64 (EmberEUI64 eui64)

Determines whether eui64 is the local node's EUI64 ID.

Returns

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

emberGetNodeId#

EmberNodeId emberGetNodeId (void )

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

Returns

• The 16-bit ID.

emberRadioGetNodeId#

EmberNodeId emberRadioGetNodeId (void )

Returns the 16-bit node ID of local node on the network it is currently tuned on.

Returns

• The 16-bit ID.

emberSetManufacturerCode#

void emberSetManufacturerCode (uint16_t code)

Sets the manufacturer code to the specified value. The manufacturer code is one of the fields of the node descriptor.

emberSetPowerDescriptor#

void emberSetPowerDescriptor (uint16_t descriptor)

Sets the power descriptor to the specified value. The power descriptor is a dynamic value, therefore this function should be called whenever the value changes.

emberSetMaximumIncomingTransferSize#

void emberSetMaximumIncomingTransferSize (uint16_t size)

Sets the maximum incoming transfer size to the specified value. The maximum incoming transfer size is one of the fields of the node descriptor.

emberSetMaximumOutgoingTransferSize#

void emberSetMaximumOutgoingTransferSize (uint16_t size)

Sets the maximum outgoing transfer size to the specified value. The maximum outgoing transfer size is one of the fields of the node descriptor.

emberSetDescriptorCapability#

void emberSetDescriptorCapability (uint8_t capability)

Sets the descriptor capability field of the node.

emberGetNetworkParameters#

EmberStatus emberGetNetworkParameters (EmberNetworkParameters * parameters)

Copies the current network parameters into the structure provided by the caller.

Returns

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

emberGetRadioParameters#

EmberStatus emberGetRadioParameters (uint8_t phyIndex, EmberMultiPhyRadioParameters * parameters)

Copies the current radio parameters into the structure provided by the caller.

Returns

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

emberGetNodeType#

EmberStatus emberGetNodeType (EmberNodeType * resultLocation)

Copies the current node type into the location provided by the caller.

Returns

• An EmberStatus value that indicates the success or failure of the command.

emberSetRadioChannel#

EmberStatus emberSetRadioChannel (uint8_t channel)

Sets the channel to use for sending and receiving messages on the current logical network. For a list of available radio channels, see the technical specification for the RF communication module in your Developer Kit.

Note: When using this API, all devices on a network must use the same channel.

Returns

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

emberSetLogicalAndRadioChannel#

EmberStatus emberSetLogicalAndRadioChannel (uint8_t channel)

Sets the current logical and physical channel.

emberGetRadioChannel#

uint8_t emberGetRadioChannel (void )

Gets the radio channel to which a node is set on the current logical network. The possible return values depend on the radio in use. For a list of available radio channels, see the technical specification for the RF communication module in your Developer Kit.

Returns

• The current radio channel.

emberSetRadioPower#

EmberStatus emberSetRadioPower (int8_t power)

Sets the radio output power at which a node is to operate for the current logical network. Ember radios have discrete power settings. For a list of available power settings, see the technical specification for the RF communication module in your Developer Kit. Note that using this API on a running network will directly impact the established link qualities which the neighboring nodes have with the node on which it is called. This can lead to disruption of existing routes and erratic network behavior. Note that, if the requested power level is not available on a given radio, this function will use the next higher available power level.

Returns

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

emberGetRadioPower#

int8_t emberGetRadioPower (void )

Gets the radio output power of the current logical network at which a node is operating. Ember radios have discrete power settings. For a list of available power settings, see the technical specification for the RF communication module in your Developer Kit.

Returns

• The current radio output power, in dBm.

emberGetRailHandle#

void* emberGetRailHandle (void )

Returns the RAIL level handle required to make RAIL API calls. Will return NULL if RAIL is not in use.

Returns

• A RAIL handle

emberGetPanId#

EmberPanId emberGetPanId (void )

Returns the local node's PAN ID of the current logical network.

Returns

• A PAN ID.

emberRadioGetPanId#

EmberPanId emberRadioGetPanId (void )

Returns the local node's PAN ID of the current radio network.

Returns

• A PAN ID.

emberGetExtendedPanId#

void emberGetExtendedPanId (uint8_t * resultLocation)

Fetches a node's 8 byte Extended PAN identifier. If this is called when a device is not currently on a network (see emberNetworkState), the Extended PAN ID returned will be an invalid value.

emberGetEndpoint#

uint8_t emberGetEndpoint (uint8_t index)

Retrieves the endpoint number for the index'th endpoint. index must be less than the value of emberEndpointCount.

This function is provided by the stack, using the data from emberEndpoints, unless the application defines EMBER_APPLICATION_HAS_GET_ENDPOINT in its CONFIGURATION_HEADER.

Returns

• The endpoint number for the index'th endpoint.

emberGetEndpointDescription#

bool emberGetEndpointDescription (uint8_t endpoint, EmberEndpointDescription * result)

Retrieves the endpoint description for the given endpoint.

This function is provided by the stack, using the data from emberEndpoints, unless the application defines ::EMBER_APPLICATION_HAS_GET_ENDPOINT in its ::CONFIGURATION_HEADER.

Returns

• True if the description was copied to result, or false if the endpoint is not active.

emberGetEndpointCluster#

uint16_t emberGetEndpointCluster (uint8_t endpoint, EmberClusterListId listId, uint8_t listIndex)

Retrieves a cluster ID from one of the cluster lists associated with the given endpoint.

This function is provided by the stack, using the data from emberEndpoints, unless the application defines ::EMBER_APPLICATION_HAS_GET_ENDPOINT in its CONFIGURATION_HEADER.

Returns

• The cluster ID at position listIndex in the specified endpoint cluster list.

emberIsNodeIdValid#

bool emberIsNodeIdValid (EmberNodeId nodeId)

Determines whether nodeId is valid.

Returns

• True if nodeId is valid, false otherwise.

emberLookupNodeIdByEui64#

EmberNodeId emberLookupNodeIdByEui64 (EmberEUI64 eui64)

Returns the node ID that corresponds to the specified EUI64. The node ID is found by searching through all stack tables for the specified EUI64.

Returns

• The short ID of the node or EMBER_NULL_NODE_ID if the short ID is not known.

emberLookupEui64ByNodeId#

EmberStatus emberLookupEui64ByNodeId (EmberNodeId nodeId, EmberEUI64 eui64Return)

Returns the EUI64 that corresponds to the specified node ID. The EUI64 is found by searching through all stack tables for the specified node ID.

Returns

• An EmberStatus value:

  • EMBER_SUCCESS - eui64Return has been set to the EUI64 of the node.

  • EMBER_ERR_FATAL - The EUI64 of the node is not known.

emberCounterHandler#

void emberCounterHandler (EmberCounterType type, EmberCounterInfo info)

A callback invoked to inform the application of the occurrence of an event defined by EmberCounterType, for example, transmissions and receptions at different layers of the stack.

The application must define ::EMBER_APPLICATION_HAS_COUNTER_HANDLER in its CONFIGURATION_HEADER to use this. This function may be called in ISR context, so processing should be kept to a minimum.

emberCounterRequiresPhyIndex#

bool emberCounterRequiresPhyIndex (EmberCounterType type)

emberCounterRequiresDestinationNodeId#

bool emberCounterRequiresDestinationNodeId (EmberCounterType type)

emberStackTokenChangedHandler#

void emberStackTokenChangedHandler (uint16_t tokenAddress)

A callback invoked to inform the application that a stack token has changed.

emberRtosIdleHandler#

bool emberRtosIdleHandler (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.

emberRtosStackWakeupIsrHandler#

void emberRtosStackWakeupIsrHandler (void )

A callback to request the application to wake up the stack task.

emberGetNeighbor#

EmberStatus emberGetNeighbor (uint8_t index, EmberNeighborTableEntry * result)

Copies a neighbor table entry to the structure that result points to. Neighbor table entries are stored in ascending order by node ID, with all unused entries at the end of the table. The number of active neighbors can be obtained using emberNeighborCount().

Returns

• EMBER_ERR_FATAL if the index is greater or equal to the number of active neighbors, or if the device is an end device. Returns EMBER_SUCCESS otherwise.

emberSetRoutingShortcutThreshold#

EmberStatus emberSetRoutingShortcutThreshold (uint8_t costThresh)

Sets the routing shortcut threshold to directly use a neighbor instead of performing routing.

Returns

• ::return EMBER_BAD_ARGUMENT if the costThresh is not 1, 3, 5, 7 Returns EMBER_SUCCESS otherwise.

emberGetRoutingShortcutThreshold#

uint8_t emberGetRoutingShortcutThreshold (void )

Gets the routing shortcut threshold used to separate between directly using a neighbor vs. performing routing.

Returns

• the routingShortcutThresh which takes one of the following values: 1, 3, 5, or 7.

emberSetInitialNeighborOutgoingCost#

EmberStatus emberSetInitialNeighborOutgoingCost (uint8_t cost)

Sets neighbor's initial outgoing link cost.

Returns

• EMBER_BAD_ARGUMENT if the cost is not any of 0, 1, 3, 5, or 7. Returns EMBER_SUCCESS otherwise NOTE: There is no EZSP version of this function yet.

emberGetInitialNeighborOutgoingCost#

uint8_t emberGetInitialNeighborOutgoingCost (void )

Gets neighbor's initial outgoing link cost.

Returns

• The default cost associated with new neighbor's outgoing links. NOTE: There is no EZSP version of this function yet.

emberResetRejoiningNeighborsFC#

void emberResetRejoiningNeighborsFC (bool reset)

Indicates whether a rejoining neighbor's incoming FC should be reset.

Returns

• ::void NOTE: There is no EZSP version of this function yet.

emberIsResetRejoiningNeighborsFCEnabled#

bool emberIsResetRejoiningNeighborsFCEnabled (void )

Checks if resetting the incoming FC for a rejoining neighbor is enabled.

Returns

• ::True or False. NOTE: There is no EZSP version of this function yet.

emberGetNeighborFrameCounter#

EmberStatus emberGetNeighborFrameCounter (EmberEUI64 nodeEui64, uint32_t * returnFrameCounter)

This function gets the last received frame counter as found in the Network Auxiliary header for the specified neighbor or child.

Returns

• EmberStatus depending on whether the frame counter is found in the neighbor or child table.

emberGetRouteTableEntry#

EmberStatus emberGetRouteTableEntry (uint8_t index, EmberRouteTableEntry * result)

Copies a route table entry to the structure that the result points to. Unused route table entries have a destination of 0xFFFF. The route table size can be obtained via emberRouteTableSize().

Returns

• EMBER_ERR_FATAL if the index is out of range or the device is an end device, and EMBER_SUCCESS otherwise.

emberStackProfile#

uint8_t emberStackProfile (void )

Returns the stack profile of the network which the node has joined.

Returns

• The stack profile.

emberSecurityLevel#

uint8_t emberSecurityLevel (void )

Returns the security level of the network which the node has joined.

Returns

• The security level.

emberTreeDepth#

uint8_t emberTreeDepth (void )

Returns the depth of the node in the network.

Returns

• The current depth.

emberNeighborCount#

uint8_t emberNeighborCount (void )

Returns the number of active entries in the neighbor table.

Returns

• The number of active entries in the neighbor table.

emberRouteTableSize#

uint8_t emberRouteTableSize (void )

Returns the size of the route table.

Returns

• The size of the route table.

emberNextZigbeeSequenceNumber#

uint8_t emberNextZigbeeSequenceNumber (void )

Increments and returns the Zigbee sequence number.

Returns

• The next Zigbee sequence number.

emberGetMaxNwkRetries#

uint8_t emberGetMaxNwkRetries (void )

Get max number of NWK retries.

Returns the maximum number of NWK retries that will be attempted

Returns

• uint8_t Max NWK retries

EMBER_MAJOR_VERSION#

#define EMBER_MAJOR_VERSION

6

EMBER_MINOR_VERSION#

#define EMBER_MINOR_VERSION

9

EMBER_PATCH_VERSION#

#define EMBER_PATCH_VERSION

0

EMBER_SPECIAL_VERSION#

#define EMBER_SPECIAL_VERSION

0

EMBER_BUILD_NUMBER#

#define EMBER_BUILD_NUMBER

0

EMBER_FULL_VERSION#

#define EMBER_FULL_VERSION

EMBER_VERSION_TYPE#

#define EMBER_VERSION_TYPE

EMBER_VERSION_TYPE_GA

SOFTWARE_VERSION#

#define SOFTWARE_VERSION

EMBER_FULL_VERSION

Software version. High byte = release number, low byte = patch number.