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 by passing the data to the function emberAfIsOtaImageIdValid().

void

Set the Zigbee stack task to ready when running on an OS.

bool
emberAfEndpointEnableDisable(uint8_t endpoint, bool enable)

Enable/disable endpoints.

bool

Determine if an endpoint at the specified index is enabled or disabled.

bool
emberAfIsThisDataTypeAStringType(EmberAfAttributeType dataType)

Return true if a given ZCL data type is a string type.

bool
emberAfIsStringAttributeType(EmberAfAttributeType attributeType)

Return true if the given attribute type is a string.

bool
emberAfIsLongStringAttributeType(EmberAfAttributeType attributeType)

Return true if the given attribute type is a long string.

uint8_t

Increment the ZCL sequence number and return the value.

uint8_t

Retrieve the last sequence number that was used.

int8_t
emberAfCompareValues(uint8_t *val1, uint8_t *val2, uint8_t len, bool signedNumber)

Compare two values of known length as integers.Simple integer comparison function. Signed integer comparison are supported for numbers with length of 4 (bytes) or less. The integers are in native endianness.

void
emberAfGetEui64(EmberEUI64 returnEui64)

Populate the passed EUI64 with the local EUI64 MAC address.

EmberNodeId

Return the node ID of the local node.

EmberStatus
emberAfGenerateRandomKey(EmberKeyData *result)

Generate a random key (link, network, or master).

EmberPanId

Return the PAN ID of the local node.

uint8_t

Return the radioChannel of the current network.

uint8_t

Return true if the cluster is in the manufacturer-specific range.

uint8_t

Return true if the cluster is in the manufacturer-specific range.

EmberNetworkStatus

Return the current network state. This call caches the results on the host to prevent frequent EZSP transactions.

EmberStatus
emberAfGetNetworkParameters(EmberNodeType *nodeType, EmberNetworkParameters *parameters)

Return the current network parameters.

EmberStatus
emberAfGetNodeType(EmberNodeType *nodeType)

Return the current node type.

EmberStatus
emberAfPermitJoin(uint8_t duration, bool broadcastMgmtPermitJoin)

Enable local permit join and optionally broadcast 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.

EmberStatus
emberAfBroadcastPermitJoin(uint8_t duration)

Enable local permit join and broadcast 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.

#define

Indicate a new image verification is taking place.

#define

Indicate the continuation of an image verification already in progress.

#define

The mask applied by emberAfNextSequence when generating ZCL sequence numbers.

#define

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.

#define

Return true if the cluster is in the manufacturer-specific range.

#define

Return true if the cluster is in the manufacturer-specific range.

#define

Return true if the cluster is in the manufacturer-specific range.

#define

Return true if the cluster is in the manufacturer-specific range.

#define

Return true if the cluster is in the manufacturer-specific range.

#define

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 by passing the data to the function emberAfIsOtaImageIdValid().


Definition at line 954 of file app/framework/include/af.h

sl_zigbee_common_rtos_wakeup_stack_task#

void sl_zigbee_common_rtos_wakeup_stack_task (void )

Set the Zigbee stack task to ready when running on an OS.

Parameters
N/A

Definition at line 925 of file app/framework/include/af.h

emberAfEndpointEnableDisable#

bool emberAfEndpointEnableDisable (uint8_t endpoint, bool enable)

Enable/disable endpoints.

Parameters
N/Aendpoint
N/Aenable

Definition at line 930 of file app/framework/include/af.h

emberAfEndpointIndexIsEnabled#

bool emberAfEndpointIndexIsEnabled (uint8_t index)

Determine if an endpoint at the specified index is enabled or disabled.

Parameters
N/Aindex

Definition at line 935 of file app/framework/include/af.h

emberAfIsThisDataTypeAStringType#

bool emberAfIsThisDataTypeAStringType (EmberAfAttributeType dataType)

Return true if a given ZCL data type is a string type.

Parameters
N/AdataType

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.


Definition at line 966 of file app/framework/include/af.h

emberAfIsStringAttributeType#

bool emberAfIsStringAttributeType (EmberAfAttributeType attributeType)

Return true if the given attribute type is a string.

Parameters
N/AattributeType

Definition at line 969 of file app/framework/include/af.h

emberAfIsLongStringAttributeType#

bool emberAfIsLongStringAttributeType (EmberAfAttributeType attributeType)

Return true if the given attribute type is a long string.

Parameters
N/AattributeType

Definition at line 972 of file app/framework/include/af.h

emberAfNextSequence#

uint8_t emberAfNextSequence (void )

Increment the ZCL sequence number and return the value.

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


Definition at line 997 of file app/framework/include/af.h

emberAfGetLastSequenceNumber#

uint8_t emberAfGetLastSequenceNumber (void )

Retrieve the last sequence number that was used.

Parameters
N/A

Definition at line 1003 of file app/framework/include/af.h

emberAfCompareValues#

int8_t emberAfCompareValues (uint8_t * val1, uint8_t * val2, uint8_t len, bool signedNumber)

Compare two values of known length as integers.Simple integer comparison function. Signed integer comparison are supported for numbers with length of 4 (bytes) or less. The integers are in native endianness.

Parameters
N/Aval1
N/Aval2
N/Alen
N/AsignedNumber

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.


Definition at line 1018 of file app/framework/include/af.h

emberAfGetEui64#

void emberAfGetEui64 (EmberEUI64 returnEui64)

Populate the passed EUI64 with the local EUI64 MAC address.

Parameters
N/AreturnEui64

Definition at line 1023 of file app/framework/include/af.h

emberAfGetNodeId#

EmberNodeId emberAfGetNodeId (void )

Return the node ID of the local node.

Parameters
N/A

Definition at line 1034 of file app/framework/include/af.h

emberAfGenerateRandomKey#

EmberStatus emberAfGenerateRandomKey (EmberKeyData * result)

Generate a random key (link, network, or master).

Parameters
N/Aresult

Definition at line 1040 of file app/framework/include/af.h

emberAfGetPanId#

EmberPanId emberAfGetPanId (void )

Return the PAN ID of the local node.

Parameters
N/A

Definition at line 1048 of file app/framework/include/af.h

emberAfGetRadioChannel#

uint8_t emberAfGetRadioChannel (void )

Return the radioChannel of the current network.

Parameters
N/A

Definition at line 1053 of file app/framework/include/af.h

emberAfGetBindingIndex#

uint8_t emberAfGetBindingIndex (void )

Return true if the cluster is in the manufacturer-specific range.

Parameters
N/A

EmberAfCluster* to consider


Definition at line 1059 of file app/framework/include/af.h

emberAfGetAddressIndex#

uint8_t emberAfGetAddressIndex (void )

Return true if the cluster is in the manufacturer-specific range.

Parameters
N/A

EmberAfCluster* to consider


Definition at line 1065 of file app/framework/include/af.h

emberAfNetworkState#

EmberNetworkStatus emberAfNetworkState (void )

Return the current network state. This call caches the results on the host to prevent frequent EZSP transactions.

Parameters
N/A

Definition at line 1071 of file app/framework/include/af.h

emberAfGetNetworkParameters#

EmberStatus emberAfGetNetworkParameters (EmberNodeType * nodeType, EmberNetworkParameters * parameters)

Return the current network parameters.

Parameters
N/AnodeType
N/Aparameters

Definition at line 1076 of file app/framework/include/af.h

emberAfGetNodeType#

EmberStatus emberAfGetNodeType (EmberNodeType * nodeType)

Return the current node type.

Parameters
N/AnodeType

Definition at line 1082 of file app/framework/include/af.h

emberAfPermitJoin#

EmberStatus emberAfPermitJoin (uint8_t duration, bool broadcastMgmtPermitJoin)

Enable local permit join and optionally broadcast 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.

Parameters
N/Aduration

The duration that the permit join bit will remain on and other devices will be able to join the current network.

N/AbroadcastMgmtPermitJoin

whether or not to broadcast the ZDO Mgmt_Permit_Join_req message.

Returns

  • status of whether or not permit join was enabled.


Definition at line 1107 of file app/framework/include/af.h

emberAfBroadcastPermitJoin#

EmberStatus emberAfBroadcastPermitJoin (uint8_t duration)

Enable local permit join and broadcast 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.

Parameters
N/Aduration

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.


Definition at line 1122 of file app/framework/include/af.h

EMBER_AF_NEW_IMAGE_VERIFICATION#

#define EMBER_AF_NEW_IMAGE_VERIFICATION
Value:
true

Indicate a new image verification is taking place.


Definition at line 940 of file app/framework/include/af.h

EMBER_AF_CONTINUE_IMAGE_VERIFY#

#define EMBER_AF_CONTINUE_IMAGE_VERIFY
Value:
false

Indicate the continuation of an image verification already in progress.


Definition at line 946 of file app/framework/include/af.h

EMBER_AF_ZCL_SEQUENCE_MASK#

#define EMBER_AF_ZCL_SEQUENCE_MASK
Value:
0x7Fu

The mask applied by emberAfNextSequence when generating ZCL sequence numbers.


Definition at line 978 of file app/framework/include/af.h

EMBER_AF_MESSAGE_TAG_MASK#

#define EMBER_AF_MESSAGE_TAG_MASK
Value:
0x7Fu

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.


Definition at line 984 of file app/framework/include/af.h

EMBER_AF_REJOIN_DUE_TO_END_DEVICE_MOVE#

#define EMBER_AF_REJOIN_DUE_TO_END_DEVICE_MOVE
Value:
(cluster)

Return true if the cluster is in the manufacturer-specific range.


Definition at line 1086 of file app/framework/include/af.h

EMBER_AF_REJOIN_DUE_TO_TC_KEEPALIVE_FAILURE#

#define EMBER_AF_REJOIN_DUE_TO_TC_KEEPALIVE_FAILURE
Value:
(cluster)

Return true if the cluster is in the manufacturer-specific range.


Definition at line 1087 of file app/framework/include/af.h

EMBER_AF_REJOIN_DUE_TO_CLI_COMMAND#

#define EMBER_AF_REJOIN_DUE_TO_CLI_COMMAND
Value:
(cluster)

Return true if the cluster is in the manufacturer-specific range.


Definition at line 1088 of file app/framework/include/af.h

EMBER_AF_REJOIN_DUE_TO_WWAH_CONNECTIVITY_MANAGER#

#define EMBER_AF_REJOIN_DUE_TO_WWAH_CONNECTIVITY_MANAGER
Value:
(cluster)

Return true if the cluster is in the manufacturer-specific range.


Definition at line 1089 of file app/framework/include/af.h

EMBER_AF_REJOIN_FIRST_REASON#

#define EMBER_AF_REJOIN_FIRST_REASON
Value:
(cluster)

Return true if the cluster is in the manufacturer-specific range.


Definition at line 1091 of file app/framework/include/af.h

EMBER_AF_REJOIN_LAST_REASON#

#define EMBER_AF_REJOIN_LAST_REASON
Value:
(cluster)

Return true if the cluster is in the manufacturer-specific range.


Definition at line 1092 of file app/framework/include/af.h