Stack Information#

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

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

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

Return the number of PHY interfaces present.

The radio calibration callback function.

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

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

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

Get the current scheduler priorities used for Zigbee multiprotocol operations.

Set the current scheduler priorities used for Zigbee multiprotocol operations.

Set the multiprotocol slip time.

Get the multiprotocol slip time.

Get current beacon classification parameter settings.

Set current beacon classification parameters.

Set the route record policy.

Get the route record policy.

Get the total count of the tokens configured.

Get information of a token by providing the index.

Get token data by providing the token key and index for the indexed token.

Set token data by providing the token key, index for an indexed token and token data.

Update function to accept a rejoin channel mask for Multi-MAC end device types. The following function is called for a Multi-MAC end device to allow the user configuration of the device to update channel mask for the scenario where a rejoin is initiated due to end device timeout event. Based on the Multi-MAC end device configuration this call is expected to update the mask so that the rejoin interface will be selected. As per the SE 1.4 errata, the "Multi-MAC Selection" end device can change the rejoin interface where as the Multi-MAC Joining end devices shall not.

Factory reset all configured zigbee tokens.

The application must provide a definition for this variable.

The application must provide a definition for this variable.

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

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.

Return the current join status.

Indicate whether the stack is currently up.

Write node data to the stack token.

Check when the next stack event is scheduled to run.

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

Return the EUI64 ID of the local node.

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

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

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

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

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

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

Set the descriptor capability field of the node.

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

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

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

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

Set the current logical and physical channel.

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

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

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

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

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

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

Set the configured 802.15.4 CCA mode in the radio. For a list of CCA modes, please refer to RAIL documentation regarding RAIL_IEEE802154_CcaMode_t.

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

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

Retrieve the number of configured endpoints.

Retrieve the endpoint description for the given endpoint.

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

Determine whether nodeId is valid.

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

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

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.

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

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

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

Copy 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().

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

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

Set neighbor's initial outgoing link cost.

Get neighbor's initial outgoing link cost.

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

Check whether resetting the incoming FC for a rejoining neighbor is enabled.

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

Set the frame counter for the specified neighbor or child.

Copy 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().

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

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

return the value of the stack compliance revision, as is reflected in the node descriptor

Return the depth of the node in the network.

Return the number of active entries in the neighbor table.

Return the size of the route table.

Increment and returns the Zigbee sequence number.

Get maximum number of NWK retries.

This indicates the presence, absence, or status of an Ember stack library.

named constants for supported stack revisions