Miscellaneous#
API for the Miscellaneous functionality in the Application Framework.
Miscellaneous description.
API#
This variable defines an invalid image ID. It is used to determine if a returned EmberAfOtaImageId is valid or not. This is done by passing the data to the function emberAfIsOtaImageIdValid().
When running on an OS, this API sets the Zigbee stack task to ready.
Enable/disable endpoints.
Determine if an endpoint at the specified index is enabled or disabled.
Return true if a given ZCL data type is a string type.
Return true if the given attribute type is a string.
Return true if the given attribute type is a long string.
Increment the ZCL sequence number and returns the value.
Retrieve the last sequence number that was used.
Simple integer comparison function. Compares two values of a known length as integers. Signed integer comparison are supported for numbers with length of 4 (bytes) or less. The integers are in native endianness.
Populate the passed EUI64 with the local EUI64 MAC address.
Return the node ID of the local node.
Generate a random key (link, network, or master).
Return the PAN ID of the local node.
Return the radioChannel of the current network.
Return true if the cluster is in the manufacturer-specific range.
Return true if the cluster is in the manufacturer-specific range.
Return the current network state. This call caches the results on the host to prevent frequent EZSP transactions.
Return the current network parameters.
Returns the current node type.
Enable local permit join and optionally broadcasts the ZDO Mgmt_Permit_Join_req message. This API can be called from any device type and still return EMBER_SUCCESS. If the API is called from an end device, the permit association bit will just be left off.
Enable local permit join and broadcasts the ZDO Mgmt_Permit_Join_req message. This API can be called from any device type and still return EMBER_SUCCESS. If the API is called from an end device, the permit association bit will just be left off.
Indicate a new image verification is taking place.
Indicate the continuation of an image verification already in progress.
The mask applied by emberAfNextSequence when generating ZCL sequence numbers.
The mask applied to generated message tags used by the framework when sending messages via EZSP. Customers who call ezspSend functions directly must use message tags outside this mask.
Return true if the cluster is in the manufacturer-specific range.
Return true if the cluster is in the manufacturer-specific range.
Return true if the cluster is in the manufacturer-specific range.
Return true if the cluster is in the manufacturer-specific range.
Return true if the cluster is in the manufacturer-specific range.
Return true if the cluster is in the manufacturer-specific range.
API Documentation#
emberAfInvalidImageId#
const EmberAfOtaImageId emberAfInvalidImageId
This variable defines an invalid image ID. It is used to determine if a returned EmberAfOtaImageId is valid or not. This is done by passing the data to the function emberAfIsOtaImageIdValid().
sl_zigbee_common_rtos_wakeup_stack_task#
void sl_zigbee_common_rtos_wakeup_stack_task (void )
When running on an OS, this API sets the Zigbee stack task to ready.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
emberAfEndpointEnableDisable#
bool emberAfEndpointEnableDisable (uint8_t endpoint, bool enable)
Enable/disable endpoints.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | |
| bool | N/A | enable |
emberAfEndpointIndexIsEnabled#
bool emberAfEndpointIndexIsEnabled (uint8_t index)
Determine if an endpoint at the specified index is enabled or disabled.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | index |
emberAfIsThisDataTypeAStringType#
bool emberAfIsThisDataTypeAStringType (EmberAfAttributeType dataType)
Return true if a given ZCL data type is a string type.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberAfAttributeType | N/A | dataType |
Use this function to perform a different memory operation on a certain attribute because it is a string type. Since ZCL strings carry length as the first byte(s), it is often required to treat them differently than regular data types.
Returns
true if data type is a string.
emberAfIsStringAttributeType#
bool emberAfIsStringAttributeType (EmberAfAttributeType attributeType)
Return true if the given attribute type is a string.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberAfAttributeType | N/A | attributeType |
emberAfIsLongStringAttributeType#
bool emberAfIsLongStringAttributeType (EmberAfAttributeType attributeType)
Return true if the given attribute type is a long string.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberAfAttributeType | N/A | attributeType |
emberAfNextSequence#
uint8_t emberAfNextSequence (void )
Increment the ZCL sequence number and returns the value.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
ZCL messages have sequence numbers so that they can be matched up with other messages in the transaction. To avoid conflicts with sequence numbers generated independently by the application, this API returns sequence numbers with the high bit clear. If the application generates its own sequence numbers, it should use numbers with the high bit set.
Returns
The next ZCL sequence number.
emberAfGetLastSequenceNumber#
uint8_t emberAfGetLastSequenceNumber (void )
Retrieve the last sequence number that was used.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
emberAfCompareValues#
int8_t emberAfCompareValues (uint8_t * val1, uint8_t * val2, uint8_t len, bool signedNumber)
Simple integer comparison function. Compares two values of a known length as integers. Signed integer comparison are supported for numbers with length of 4 (bytes) or less. The integers are in native endianness.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t * | N/A | val1 | |
| uint8_t * | N/A | val2 | |
| uint8_t | N/A | len | |
| bool | N/A | signedNumber |
Returns
-1, if val1 is smaller 0, if they are the same or if two negative numbers with length greater than 4 is being compared 1, if val2 is smaller.
emberAfGetEui64#
void emberAfGetEui64 (EmberEUI64 returnEui64)
Populate the passed EUI64 with the local EUI64 MAC address.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberEUI64 | N/A | returnEui64 |
emberAfGetNodeId#
EmberNodeId emberAfGetNodeId (void )
Return the node ID of the local node.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
emberAfGenerateRandomKey#
EmberStatus emberAfGenerateRandomKey (EmberKeyData * result)
Generate a random key (link, network, or master).
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberKeyData * | N/A | result |
emberAfGetPanId#
EmberPanId emberAfGetPanId (void )
Return the PAN ID of the local node.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
emberAfGetRadioChannel#
uint8_t emberAfGetRadioChannel (void )
Return the radioChannel of the current network.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Get this node's radio channel for the current network.
emberAfGetBindingIndex#
uint8_t emberAfGetBindingIndex (void )
Return true if the cluster is in the manufacturer-specific range.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A | EmberAfCluster* to consider |
emberAfGetAddressIndex#
uint8_t emberAfGetAddressIndex (void )
Return true if the cluster is in the manufacturer-specific range.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A | EmberAfCluster* to consider |
emberAfNetworkState#
EmberNetworkStatus emberAfNetworkState (void )
Return the current network state. This call caches the results on the host to prevent frequent EZSP transactions.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
emberAfGetNetworkParameters#
EmberStatus emberAfGetNetworkParameters (EmberNodeType * nodeType, EmberNetworkParameters * parameters)
Return the current network parameters.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberNodeType * | N/A | nodeType | |
| EmberNetworkParameters * | N/A | parameters |
emberAfGetNodeType#
EmberStatus emberAfGetNodeType (EmberNodeType * nodeType)
Returns the current node type.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberNodeType * | N/A | nodeType |
emberAfPermitJoin#
EmberStatus emberAfPermitJoin (uint8_t duration, bool broadcastMgmtPermitJoin)
Enable local permit join and optionally broadcasts the ZDO Mgmt_Permit_Join_req message. This API can be called from any device type and still return EMBER_SUCCESS. If the API is called from an end device, the permit association bit will just be left off.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | duration | The duration that the permit join bit will remain on and other devices will be able to join the current network. |
| bool | N/A | broadcastMgmtPermitJoin | whether or not to broadcast the ZDO Mgmt_Permit_Join_req message. |
Returns
status of whether or not permit join was enabled.
emberAfBroadcastPermitJoin#
EmberStatus emberAfBroadcastPermitJoin (uint8_t duration)
Enable local permit join and broadcasts the ZDO Mgmt_Permit_Join_req message. This API can be called from any device type and still return EMBER_SUCCESS. If the API is called from an end device, the permit association bit will just be left off.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | duration | The duration that the permit join bit will remain on and other devices will be able to join the current network. |
Returns
status of whether or not permit join was enabled.