Miscellaneous#

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.

emberAfEndpointEnableDisable#

bool emberAfEndpointEnableDisable (uint8_t endpoint, bool enable)

Enable/disable endpoints.

emberAfEndpointIndexIsEnabled#

bool emberAfEndpointIndexIsEnabled (uint8_t index)

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

emberAfIsThisDataTypeAStringType#

bool emberAfIsThisDataTypeAStringType (EmberAfAttributeType dataType)

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

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.

emberAfIsLongStringAttributeType#

bool emberAfIsLongStringAttributeType (EmberAfAttributeType attributeType)

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

emberAfNextSequence#

uint8_t emberAfNextSequence (void)

Increment the ZCL sequence number and returns the value.

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.

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.

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.

emberAfGetNodeId#

EmberNodeId emberAfGetNodeId (void)

Return the node ID of the local node.

emberAfGenerateRandomKey#

EmberStatus emberAfGenerateRandomKey (EmberKeyData *result)

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

emberAfGetPanId#

EmberPanId emberAfGetPanId (void)

Return the PAN ID of the local node.

emberAfGetRadioChannel#

uint8_t emberAfGetRadioChannel (void)

Return the radioChannel of the current network.

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.

emberAfGetAddressIndex#

uint8_t emberAfGetAddressIndex (void)

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

emberAfNetworkState#

EmberNetworkStatus emberAfNetworkState (void)

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

emberAfGetNetworkParameters#

EmberStatus emberAfGetNetworkParameters (EmberNodeType *nodeType, EmberNetworkParameters *parameters)

Return the current network parameters.

emberAfGetNodeType#

EmberStatus emberAfGetNodeType (EmberNodeType *nodeType)

Returns the current node type.

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.

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.

Returns

• status of whether or not permit join was enabled.

EMBER_AF_NEW_IMAGE_VERIFICATION#

#define EMBER_AF_NEW_IMAGE_VERIFICATION

true

Indicate a new image verification is taking place.

EMBER_AF_CONTINUE_IMAGE_VERIFY#

#define EMBER_AF_CONTINUE_IMAGE_VERIFY

false

Indicate the continuation of an image verification already in progress.

EMBER_AF_ZCL_SEQUENCE_MASK#

#define EMBER_AF_ZCL_SEQUENCE_MASK

0x7Fu

The mask applied by emberAfNextSequence when generating ZCL sequence numbers.

EMBER_AF_MESSAGE_TAG_MASK#

#define EMBER_AF_MESSAGE_TAG_MASK

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.

EMBER_AF_REJOIN_DUE_TO_END_DEVICE_MOVE#

#define EMBER_AF_REJOIN_DUE_TO_END_DEVICE_MOVE

(cluster)

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

EMBER_AF_REJOIN_DUE_TO_TC_KEEPALIVE_FAILURE#

#define EMBER_AF_REJOIN_DUE_TO_TC_KEEPALIVE_FAILURE

(cluster)

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

EMBER_AF_REJOIN_DUE_TO_CLI_COMMAND#

#define EMBER_AF_REJOIN_DUE_TO_CLI_COMMAND

(cluster)

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

EMBER_AF_REJOIN_DUE_TO_WWAH_CONNECTIVITY_MANAGER#

#define EMBER_AF_REJOIN_DUE_TO_WWAH_CONNECTIVITY_MANAGER

(cluster)

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

EMBER_AF_REJOIN_FIRST_REASON#

#define EMBER_AF_REJOIN_FIRST_REASON

(cluster)

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

EMBER_AF_REJOIN_LAST_REASON#

#define EMBER_AF_REJOIN_LAST_REASON

(cluster)

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