Stack Information#

emberSetTxPowerMode#

EmberStatus emberSetTxPowerMode (uint16_t txPowerMode)

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

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

Returns

• The current TX power mode.

emberSetNodeId#

EmberStatus emberSetNodeId (EmberNodeId nodeId)

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

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

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.

emberSetLongUpTime#

void emberSetLongUpTime (bool hasLongUpTime)

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

emberSetHubConnectivity#

void emberSetHubConnectivity (bool connected)

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

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)

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.

emberStackProfileId#

const uint8_t emberStackProfileId[]

The application must provide a definition for this variable.

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 )

Return the current join status.

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

Returns

• An EmberNetworkStatus value indicating the current join status.

emberStackIsUp#

bool emberStackIsUp (void )

Indicate whether the stack is currently up.

Returns true if the stack is joined to a network and ready to send and receive messages. This reflects only the state of the local node; 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)

Write node data to the stack token.

Returns

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

emberMsToNextStackEvent#

uint32_t emberMsToNextStackEvent (void )

Check when the next stack event is scheduled to run.

Returns

• Returns the number of milliseconds before the next stack event is scheduled to run.

emberSetPowerDescriptor#

void emberSetPowerDescriptor (uint16_t descriptor)

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.

emberGetEui64#

EmberEUI64 emberGetEui64 (void )

Return the EUI64 ID of the local node.

Returns

• The 64-bit ID.

emberIsLocalEui64#

bool emberIsLocalEui64 (EmberEUI64 eui64)

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

Returns

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

emberGetNodeId#

EmberNodeId emberGetNodeId (void )

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

Returns

• The 16-bit ID.

emberRadioGetNodeId#

EmberNodeId emberRadioGetNodeId (void )

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

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

emberSetMaximumIncomingTransferSize#

void emberSetMaximumIncomingTransferSize (uint16_t size)

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

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

Set the descriptor capability field of the node.

emberGetNetworkParameters#

EmberStatus emberGetNetworkParameters (EmberNetworkParameters * parameters)

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

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

Returns

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