Modules#

EmberEndpointDescription

EmberEndpoint

Stack Information#

See stack-info.h for source code.

See also config.h.

This documentation was produced from the following software release and build.

SOFTWARE_VERSION

0x4700

High byte = release number, low byte = patch number

Radio-specific Functions#

emberSetTxPowerMode(uint16_t txPowerMode)

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

uint16_t

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

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.

uint8_t

Returns the number of PHY interfaces present.

void

The radio calibration callback function.

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.

void
emberSetLongUpTime(bool hasLongUpTime)

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

void
emberSetHubConnectivity(bool connected)

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

emberRadioGetSchedulerPriorities(EmberMultiprotocolPriorities *priorities)

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

emberRadioSetSchedulerPriorities(const EmberMultiprotocolPriorities *priorities)

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

Set the multiprotocol slip time.

emberRadioGetSchedulerSliptime(uint32_t *slipTime)

Get the multiprotocol slip time.

emberGetBeaconClassificationParams(EmberBeaconClassificationParams *param)

API used to get current beacon classification parameter settings.

emberSetBeaconClassificationParams(EmberBeaconClassificationParams *param)

API used to set current beacon classification parameters.

slx_zigbee_routing_set_route_record_policy(sl_zigbee_route_record_policy_type_t policy)

Set the route record policy.

uint8_t

Get the route record policy.

Variables#

const uint8_t

The application must provide a definition for this variable.

uint16_t
uint16_t
uint8_t
uint16_t const *
uint16_t const *
uint8_t

The application must provide a definition for this variable.

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

Functions#

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.

Returns the current join status.

bool

Indicates whether the stack is currently up.

emberWriteNodeData(bool erase)

Writes node data to stack token.

EmberEUI64

Returns the EUI64 ID of the local node.

bool
emberIsLocalEui64(EmberEUI64 eui64)

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

EmberNodeId

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

EmberNodeId

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

void

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

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.

void

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

void

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

void
emberSetDescriptorCapability(uint8_t capability)

Sets the descriptor capability field of the node.

emberGetNetworkParameters(EmberNetworkParameters *parameters)

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

emberGetRadioParameters(uint8_t phyIndex, EmberMultiPhyRadioParameters *parameters)

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

emberGetNodeType(EmberNodeType *resultLocation)

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

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.

Sets the current logical and physical channel.

uint8_t

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.

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.

int8_t

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.

void *

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

EmberPanId

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

EmberPanId

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

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.

uint8_t
emberGetEndpoint(uint8_t index)

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

bool
emberGetEndpointDescription(uint8_t endpoint, EmberEndpointDescription *result)

Retrieves the endpoint description for the given endpoint.

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.

bool
emberIsNodeIdValid(EmberNodeId nodeId)

Determines whether nodeId is valid.

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.

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.

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.

bool
emberCounterRequiresPhyIndex(EmberCounterType type)
bool
void
emberStackTokenChangedHandler(uint16_t tokenAddress)

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

bool
emberRtosIdleHandler(uint32_t *idleTimeMs)

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

void

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

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

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

uint8_t

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

Sets neighbor's initial outgoing link cost.

uint8_t

Gets neighbor's initial outgoing link cost.

void

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

bool

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

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.

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

uint8_t

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

uint8_t

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

uint8_t

Returns the depth of the node in the network.

uint8_t

Returns the number of active entries in the neighbor table.

uint8_t

Returns the size of the route table.

uint8_t

Increments and returns the Zigbee sequence number.

uint8_t

Get max number of NWK retries.

Macros#

#define
#define
EMBER_VERSION_TYPE EMBER_VERSION_TYPE_GA
#define
SOFTWARE_VERSION EMBER_FULL_VERSION

Radio-specific Functions Documentation#

emberSetTxPowerMode#

EmberStatus emberSetTxPowerMode (uint16_t txPowerMode)

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

Parameters
N/AtxPowerMode

Specifies which transmit power mode options should be activated. This parameter should be set to one of the literal values described in stack/include/ember-types.h. Any power option not specified in the txPowerMode parameter will be deactivated.

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


Definition at line 733 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberGetTxPowerMode#

uint16_t emberGetTxPowerMode (void )

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

Parameters
N/A

Returns

  • The current TX power mode.


Definition at line 740 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

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.

Parameters
N/AnodeId

Specifies the short ID to be assigned to the node.

Returns


Definition at line 749 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberGetPhyInterfaceCount#

uint8_t emberGetPhyInterfaceCount (void )

Returns the number of PHY interfaces present.

Parameters
N/A

Returns

  • The number of PHY interface(s).


Definition at line 755 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberRadioNeedsCalibratingHandler#

void emberRadioNeedsCalibratingHandler (void )

The radio calibration callback function.

Parameters
N/A

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.


Definition at line 773 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

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.

Parameters
N/A

Definition at line 783 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberSetLongUpTime#

void emberSetLongUpTime (bool hasLongUpTime)

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

Parameters
N/AhasLongUpTime

Definition at line 790 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberSetHubConnectivity#

void emberSetHubConnectivity (bool connected)

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

Parameters
N/Aconnected

Definition at line 795 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberIsUpTimeLong#

bool emberIsUpTimeLong (void )
Parameters
N/A

Returns

  • true if device uptime is long, false otherwise


Definition at line 799 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberIsHubConnected#

bool emberIsHubConnected (void )
Parameters
N/A

Returns

  • true if there is hub connectivity, false otherwise


Definition at line 803 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberRadioGetSchedulerPriorities#

EmberStatus emberRadioGetSchedulerPriorities (EmberMultiprotocolPriorities * priorities)

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

Parameters
N/Apriorities

A pointer to a structure to store the current priorities in. This must not be NULL.

Returns

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


Definition at line 816 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberRadioSetSchedulerPriorities#

EmberStatus emberRadioSetSchedulerPriorities (const EmberMultiprotocolPriorities * priorities)

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

Parameters
N/Apriorities

A pointer to a structure of the new priorities to use. This must not be NULL.

Returns

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


Definition at line 829 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberRadioSetSchedulerSliptime#

EmberStatus emberRadioSetSchedulerSliptime (uint32_t slipTime)

Set the multiprotocol slip time.

Parameters
N/AslipTime

The value to set the slip time to for each transmit.

Returns

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.


Definition at line 842 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberRadioGetSchedulerSliptime#

EmberStatus emberRadioGetSchedulerSliptime (uint32_t * slipTime)

Get the multiprotocol slip time.

Parameters
N/AslipTime

A pointer to the place to store the current slip time

Returns

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.


Definition at line 853 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberGetBeaconClassificationParams#

EmberStatus emberGetBeaconClassificationParams (EmberBeaconClassificationParams * param)

API used to get current beacon classification parameter settings.

Parameters
N/Aparam

Definition at line 858 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberSetBeaconClassificationParams#

EmberStatus emberSetBeaconClassificationParams (EmberBeaconClassificationParams * param)

API used to set current beacon classification parameters.

Parameters
N/Aparam

Definition at line 862 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

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.

Parameters
N/Apolicy

A pointer to the place to store the current slip time

Returns

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


Definition at line 874 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

slx_zigbee_routing_get_route_record_policy#

uint8_t slx_zigbee_routing_get_route_record_policy (void )

Get the route record policy.

Parameters
N/A

Returns

  • The route record policy

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


Definition at line 882 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

Variable Documentation#

emberStackProfileId#

const uint8_t emberStackProfileId[]

The application must provide a definition for this variable.


Definition at line 344 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

profileId#

uint16_t EmberEndpointDescription::profileId

Identifies the endpoint's application profile.


Definition at line 355 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

deviceId#

uint16_t EmberEndpointDescription::deviceId

The endpoint's device ID within the application profile.


Definition at line 357 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

deviceVersion#

uint8_t EmberEndpointDescription::deviceVersion

The endpoint's device version.


Definition at line 359 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

inputClusterCount#

uint8_t EmberEndpointDescription::inputClusterCount

The number of input clusters.


Definition at line 361 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

outputClusterCount#

uint8_t EmberEndpointDescription::outputClusterCount

The number of output clusters.


Definition at line 363 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

endpoint#

uint8_t EmberEndpoint::endpoint

An endpoint of the application on this node.


Definition at line 371 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

description#

EmberEndpointDescription const* EmberEndpoint::description

The endpoint's description.


Definition at line 373 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

inputClusterList#

uint16_t const* EmberEndpoint::inputClusterList

Input clusters the endpoint will accept.


Definition at line 375 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

outputClusterList#

uint16_t const* EmberEndpoint::outputClusterList

Output clusters the endpoint may send.


Definition at line 377 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberEndpointCount#

uint8_t emberEndpointCount

The application must provide a definition for this variable.


Definition at line 381 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

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.


Definition at line 396 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

Function Documentation#

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.


Definition at line 64 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberNetworkState#

EmberNetworkStatus emberNetworkState (void )

Returns the current join status.

Parameters
N/A

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

Returns


Definition at line 73 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberStackIsUp#

bool emberStackIsUp (void )

Indicates whether the stack is currently up.

Parameters
N/A

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.


Definition at line 84 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberWriteNodeData#

EmberStatus emberWriteNodeData (bool erase)

Writes node data to stack token.

Parameters
N/Aerase

Indicates whether the node type should be erased.

Returns

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


Definition at line 92 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberGetEui64#

EmberEUI64 emberGetEui64 (void )

Returns the EUI64 ID of the local node.

Parameters
N/A

Returns

  • The 64-bit ID.


Definition at line 99 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberIsLocalEui64#

bool emberIsLocalEui64 (EmberEUI64 eui64)

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

Parameters
N/Aeui64

An EUI64 ID.

Returns

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


Definition at line 107 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberGetNodeId#

EmberNodeId emberGetNodeId (void )

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

Parameters
N/A

Returns

  • The 16-bit ID.


Definition at line 114 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberRadioGetNodeId#

EmberNodeId emberRadioGetNodeId (void )

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

Parameters
N/A

Returns

  • The 16-bit ID.


Definition at line 121 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

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.

Parameters
N/Acode

The manufacturer code for the local node.


Definition at line 128 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

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.

Parameters
N/Adescriptor

The new power descriptor for the local node.


Definition at line 136 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

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.

Parameters
N/Asize

The maximum incoming transfer size for the local node.


Definition at line 144 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

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.

Parameters
N/Asize

The maximum outgoing transfer size for the local node.


Definition at line 152 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberSetDescriptorCapability#

void emberSetDescriptorCapability (uint8_t capability)

Sets the descriptor capability field of the node.

Parameters
N/Acapability

The descriptor capability of the local node.


Definition at line 158 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberGetNetworkParameters#

EmberStatus emberGetNetworkParameters (EmberNetworkParameters * parameters)

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

Parameters
N/Aparameters

A pointer to an EmberNetworkParameters value into which the current network parameters will be copied.

Returns

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


Definition at line 233 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberGetRadioParameters#

EmberStatus emberGetRadioParameters (uint8_t phyIndex, EmberMultiPhyRadioParameters * parameters)

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

Parameters
N/AphyIndex

The index of the PHY interface for radio parameters.

  • For 2.4 or Subghz only (switched) device, index will be ignored.

  • For simultaneous dual radio, returns radio parameters based on the provided PHY index. parameters A pointer to an EmberMultiPhyRadioParameters value into which the current radio parameters will be copied.

N/Aparameters

Returns

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


Definition at line 248 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberGetNodeType#

EmberStatus emberGetNodeType (EmberNodeType * resultLocation)

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

Parameters
N/AresultLocation

A pointer to an EmberNodeType value into which the current node type will be copied.

Returns

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


Definition at line 259 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

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.

Parameters
N/Achannel

The desired radio channel.

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.


Definition at line 274 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberSetLogicalAndRadioChannel#

EmberStatus emberSetLogicalAndRadioChannel (uint8_t channel)

Sets the current logical and physical channel.

Parameters
N/Achannel

Definition at line 279 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

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.

Parameters
N/A

Returns

  • The current radio channel.


Definition at line 288 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

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.

Parameters
N/Apower

A desired radio output power, in dBm.

Returns

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


Definition at line 307 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

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.

Parameters
N/A

Returns

  • The current radio output power, in dBm.


Definition at line 316 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberGetRailHandle#

void* emberGetRailHandle (void )

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

Parameters
N/A

Returns

  • A RAIL handle


Definition at line 323 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberGetPanId#

EmberPanId emberGetPanId (void )

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

Parameters
N/A

Returns

  • A PAN ID.


Definition at line 329 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberRadioGetPanId#

EmberPanId emberRadioGetPanId (void )

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

Parameters
N/A

Returns

  • A PAN ID.


Definition at line 335 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

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.

Parameters
N/AresultLocation

Definition at line 341 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

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.

Parameters
N/Aindex

The index of an endpoint (as distinct from its endpoint number). This 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.


Definition at line 411 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberGetEndpointDescription#

bool emberGetEndpointDescription (uint8_t endpoint, EmberEndpointDescription * result)

Retrieves the endpoint description for the given endpoint.

Parameters
N/Aendpoint

The endpoint whose description is to be returned.

N/Aresult

A pointer to the location to which to copy the endpoint description.

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.


Definition at line 428 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

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.

Parameters
N/Aendpoint

The endpoint from which the cluster ID is to be read.

N/AlistId

The list from which the cluster ID is to be read.

N/AlistIndex

The index of the desired cluster ID in the list. This value must be less than the length of the list. The length can be found in the EmberEndpointDescription for this 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.


Definition at line 449 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberIsNodeIdValid#

bool emberIsNodeIdValid (EmberNodeId nodeId)

Determines whether nodeId is valid.

Parameters
N/AnodeId

A node ID.

Returns

  • True if nodeId is valid, false otherwise.


Definition at line 460 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

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.

Parameters
N/Aeui64

The EUI64 of the node to look up.

Returns


Definition at line 474 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

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.

Parameters
N/AnodeId

The short ID of the node to look up.

N/Aeui64Return

The EUI64 of the node is copied here if it is known.

Returns


Definition at line 488 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

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.

Parameters
N/Atype

Type of the event.

N/Ainfo

could map to:

  1. data: For transmission events, the number of retries used. For most other events, this parameter is unused and is set to zero.

  2. phyIndex: use for mac specific counters specifying if they belong to sub-Ghz or 2.4 GHz.

  3. destinationNodeId: identifying which connection/destinationId a specific counter refers to.

  4. Any combination of the parameters above.

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.


Definition at line 509 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberCounterRequiresPhyIndex#

bool emberCounterRequiresPhyIndex (EmberCounterType type)
Parameters
N/Atype

Definition at line 510 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberCounterRequiresDestinationNodeId#

bool emberCounterRequiresDestinationNodeId (EmberCounterType type)
Parameters
N/Atype

Definition at line 511 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberStackTokenChangedHandler#

void emberStackTokenChangedHandler (uint16_t tokenAddress)

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

Parameters
N/AtokenAddress

The address of the stack token that has changed.


Definition at line 518 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberRtosIdleHandler#

bool emberRtosIdleHandler (uint32_t * idleTimeMs)

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

Parameters
N/AidleTimeMs

The time in millisecond the stack is allowed to idle.

Returns

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


Definition at line 527 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberRtosStackWakeupIsrHandler#

void emberRtosStackWakeupIsrHandler (void )

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

Parameters
N/A

Definition at line 531 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

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

Parameters
N/Aindex

The index of a neighbor table entry.

N/Aresult

A pointer to the location to which to copy the neighbor table entry.

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.


Definition at line 548 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberSetRoutingShortcutThreshold#

EmberStatus emberSetRoutingShortcutThreshold (uint8_t costThresh)

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

Parameters
N/AcostThresh

the routing shortcut value that should be used 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.


Definition at line 559 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberGetRoutingShortcutThreshold#

uint8_t emberGetRoutingShortcutThreshold (void )

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

Parameters
N/A

Returns

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


Definition at line 567 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberSetInitialNeighborOutgoingCost#

EmberStatus emberSetInitialNeighborOutgoingCost (uint8_t cost)

Sets neighbor's initial outgoing link cost.

Parameters
N/Acost

The new default cost.

Returns


Definition at line 576 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberGetInitialNeighborOutgoingCost#

uint8_t emberGetInitialNeighborOutgoingCost (void )

Gets neighbor's initial outgoing link cost.

Parameters
N/A

Returns

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


Definition at line 583 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberResetRejoiningNeighborsFC#

void emberResetRejoiningNeighborsFC (bool reset)

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

Parameters
N/Areset

True or False.

Returns

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


Definition at line 591 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberIsResetRejoiningNeighborsFCEnabled#

bool emberIsResetRejoiningNeighborsFCEnabled (void )

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

Parameters
N/A

Returns

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


Definition at line 599 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

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.

Parameters
N/AnodeEui64

The neighbor or child EUI to search.

N/AreturnFrameCounter

The frame counter variable to fill in.

Returns

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


Definition at line 609 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

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

Parameters
N/Aindex

The index of a route table entry.

N/Aresult

A pointer to the location to which to copy the route table entry.

Returns


Definition at line 625 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberStackProfile#

uint8_t emberStackProfile (void )

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

Parameters
N/A

Returns

  • The stack profile.


Definition at line 632 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberSecurityLevel#

uint8_t emberSecurityLevel (void )

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

Parameters
N/A

Returns

  • The security level.


Definition at line 639 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberTreeDepth#

uint8_t emberTreeDepth (void )

Returns the depth of the node in the network.

Parameters
N/A

Returns

  • The current depth.


Definition at line 646 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberNeighborCount#

uint8_t emberNeighborCount (void )

Returns the number of active entries in the neighbor table.

Parameters
N/A

Returns

  • The number of active entries in the neighbor table.


Definition at line 652 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberRouteTableSize#

uint8_t emberRouteTableSize (void )

Returns the size of the route table.

Parameters
N/A

Returns

  • The size of the route table.


Definition at line 658 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberNextZigbeeSequenceNumber#

uint8_t emberNextZigbeeSequenceNumber (void )

Increments and returns the Zigbee sequence number.

Parameters
N/A

Returns

  • The next Zigbee sequence number.


Definition at line 698 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

emberGetMaxNwkRetries#

uint8_t emberGetMaxNwkRetries (void )

Get max number of NWK retries.

Parameters
N/A

Returns the maximum number of NWK retries that will be attempted

Returns

  • uint8_t Max NWK retries


Definition at line 706 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/stack-info.h

Macro Definition Documentation#

EMBER_MAJOR_VERSION#

#define EMBER_MAJOR_VERSION
Value:
6

Definition at line 34 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/config/config.h

EMBER_MINOR_VERSION#

#define EMBER_MINOR_VERSION
Value:
9

Definition at line 35 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/config/config.h

EMBER_PATCH_VERSION#

#define EMBER_PATCH_VERSION
Value:
0

Definition at line 36 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/config/config.h

EMBER_SPECIAL_VERSION#

#define EMBER_SPECIAL_VERSION
Value:
0

Definition at line 37 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/config/config.h

EMBER_BUILD_NUMBER#

#define EMBER_BUILD_NUMBER
Value:
0

Definition at line 40 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/config/config.h

EMBER_FULL_VERSION#

#define EMBER_FULL_VERSION
Value:
( ((uint16_t)EMBER_MAJOR_VERSION << 12) \
| ((uint16_t)EMBER_MINOR_VERSION << 8) \
| ((uint16_t)EMBER_PATCH_VERSION << 4) \
| ((uint16_t)EMBER_SPECIAL_VERSION))

Definition at line 41 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/config/config.h

EMBER_VERSION_TYPE#

#define EMBER_VERSION_TYPE
Value:
EMBER_VERSION_TYPE_GA

Definition at line 46 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/config/config.h

SOFTWARE_VERSION#

#define SOFTWARE_VERSION
Value:
EMBER_FULL_VERSION

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


Definition at line 51 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/config/config.h