License#

emberAfClusterIsManufacturerSpecific#

#define emberAfClusterIsManufacturerSpecific

(cluster)

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

emberAfAttributeIsReadOnly#

#define emberAfAttributeIsReadOnly

(metadata)

Return true if the attribute is read only.

emberAfAttributeIsClient#

#define emberAfAttributeIsClient

(metadata)

Return true if this is a client attribute and false if if it is a server attribute.

emberAfAttributeIsTokenized#

#define emberAfAttributeIsTokenized

(metadata)

Return true if the attribute is saved to a token.

emberAfAttributeIsExternal#

#define emberAfAttributeIsExternal

(metadata)

Return true if the attribute is saved in external storage.

emberAfAttributeIsSingleton#

#define emberAfAttributeIsSingleton

(metadata)

Return true if the attribute is a singleton.

emberAfAttributeIsManufacturerSpecific#

#define emberAfAttributeIsManufacturerSpecific

(metadata)

Return true if the attribute is manufacturer specific.

emberAfAttributeSize#

#define emberAfAttributeSize

(metadata)

Return the size of attribute in bytes.

emberAfProfileIdFromIndex#

#define emberAfProfileIdFromIndex

(index)

Take an index of an endpoint and return the profile ID for it.

emberAfDeviceIdFromIndex#

#define emberAfDeviceIdFromIndex

(index)

Take an index of an endpoint and return the device ID for it.

emberAfDeviceVersionFromIndex#

#define emberAfDeviceVersionFromIndex

(index)

Take an index of an endpoint and return the device version for it.

emberAfNetworkIndexFromEndpointIndex#

#define emberAfNetworkIndexFromEndpointIndex

(index)

Take an index of an endpoint and return the network index for it.

emberAfPrimaryProfileId#

#define emberAfPrimaryProfileId

()

Return the primary profile ID.

Primary profile is the profile of a primary endpoint as defined in AppBuilder.

emberAfPrimaryEndpoint#

#define emberAfPrimaryEndpoint

()

Return the primary endpoint.

emberAfGetInt8u#

#define emberAfGetInt8u

(message, currentIndex, msgLen)

Extract a single byte out of the message.

emberAfCopyInt8u#

#define emberAfCopyInt8u

(data, index, x)

Copy a uint8_t from variable into buffer.

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.

EMBER_AF_CLIENT_CLUSTER_TICK#

#define EMBER_AF_CLIENT_CLUSTER_TICK

true

Friendly define for use in the scheduling or canceling client events with sl_zigbee_zcl_schedule_cluster_tick() and sl_zigbee_zcl_deactivate_cluster_tick().

EMBER_AF_SERVER_CLUSTER_TICK#

#define EMBER_AF_SERVER_CLUSTER_TICK

false

Friendly define for use in the scheduling or canceling server events with sl_zigbee_zcl_schedule_cluster_tick() and sl_zigbee_zcl_deactivate_cluster_tick().

emberAfGetCurrentSleepControl#

#define emberAfGetCurrentSleepControl

()

Retrieve the most restrictive sleep control value for all scheduled events. This function is used by emberAfOkToNap and emberAfOkToHibernate to makes sure that there are no events scheduled, which will keep the device from hibernating or napping.

Returns

• The most restrictive sleep control value for all scheduled events or the value returned by emberAfGetDefaultSleepControl() if no events are currently scheduled. The default sleep control value is initialized to EMBER_AF_OK_TO_HIBERNATE but can be changed at any time using the emberAfSetDefaultSleepControl() function.

emberAfSetDefaultSleepControl#

#define emberAfSetDefaultSleepControl

(x)

Set the default sleep control value against which all scheduled event sleep control values will be evaluated. This can be used to keep a device awake for an extended period of time by setting the default to EMBER_AF_STAY_AWAKE and then resetting the value to EMBER_AF_OK_TO_HIBERNATE once the wake period is complete.

emberAfGetDefaultSleepControl#

#define emberAfGetDefaultSleepControl

()

Retrieve the default sleep control against which all event sleep control values are evaluated. The default sleep control value is initialized to EMBER_AF_OK_TO_HIBERNATE but can be changed by the application at any time using the emberAfSetDefaultSleepControl() function.

Returns

• The current default sleep control value.

EMBER_AF_CLIENT_CLUSTER_DISCOVERY#

#define EMBER_AF_CLIENT_CLUSTER_DISCOVERY

false

Friendly define for use in discovering client clusters with emberAfFindDevicesByProfileAndCluster().

EMBER_AF_SERVER_CLUSTER_DISCOVERY#

#define EMBER_AF_SERVER_CLUSTER_DISCOVERY

true

Friendly define for use in discovering server clusters with emberAfFindDevicesByProfileAndCluster().

emberAfCurrentEndpoint#

#define emberAfCurrentEndpoint

()

Return the current endpoint that is being served.

The purpose of this macro is mostly to access endpoint that is being served in the command callbacks.

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

emberAfLocateAttributeMetadata#

EmberAfAttributeMetadata* emberAfLocateAttributeMetadata (uint8_t endpoint, EmberAfClusterId clusterId, EmberAfAttributeId attributeId, uint8_t mask, uint16_t manufacturerCode)

Locate attribute metadata.

This function returns a pointer to the attribute metadata structure or NULL if attribute is not found.

Returns

• Returns pointer to the attribute metadata location.

emberAfContainsAttribute#

bool emberAfContainsAttribute (uint8_t endpoint, EmberAfClusterId clusterId, EmberAfAttributeId attributeId, uint8_t mask, uint16_t manufacturerCode)

Return true if the attribute exists.

emberAfContainsClusterWithMfgCode#

bool emberAfContainsClusterWithMfgCode (uint8_t endpoint, EmberAfClusterId clusterId, uint16_t manufacturerCode)

Return true if an endpoint contains a cluster, checking for mfg code.

This function returns true regardless of whether the endpoint contains server, client or both. For standard libraries (when ClusterId < FC00), the manufacturerCode is ignored.

emberAfContainsCluster#

bool emberAfContainsCluster (uint8_t endpoint, EmberAfClusterId clusterId)

Return true if the endpoint contains the ZCL cluster with specified ID.

This function returns true regardless of whether the endpoint contains server, client or both in the Zigbee Cluster Library. This wraps emberAfContainsClusterWithMfgCode with manufacturerCode = EMBER_AF_NULL_MANUFACTURER_CODE If this function is used with a manufacturer specific clusterId, it returns the first cluster that it finds in the Cluster table. It does not return any other clusters that share that ID.

emberAfContainsServerWithMfgCode#

bool emberAfContainsServerWithMfgCode (uint8_t endpoint, EmberAfClusterId clusterId, uint16_t manufacturerCode)

Return true if the endpoint has a cluster server, checking for the mfg code.

This function returns true if the endpoint contains server of a given cluster. For standard libraries (when ClusterId < FC00), the manufacturerCode is ignored.

emberAfContainsServer#

bool emberAfContainsServer (uint8_t endpoint, EmberAfClusterId clusterId)

Return true if the endpoint contains the ZCL server with a specified ID.

This function returns true if the endpoint contains server of a given cluster. This wraps emberAfContainsServer with manufacturerCode = EMBER_AF_NULL_MANUFACTURER_CODE If this function is used with a manufacturer specific clusterId, it returns the first cluster that it finds in the Cluster table. It does not return any other clusters that share that ID.

emberAfContainsClientWithMfgCode#

bool emberAfContainsClientWithMfgCode (uint8_t endpoint, EmberAfClusterId clusterId, uint16_t manufacturerCode)

Return true if the endpoint contains the cluster client.

This function returns true if the endpoint contains client of a given cluster. For standard library clusters (when ClusterId < FC00), the manufacturerCode is ignored.

emberAfContainsClient#

bool emberAfContainsClient (uint8_t endpoint, EmberAfClusterId clusterId)

Return true if the endpoint contains the ZCL client with a specified ID.

This function returns true if the endpoint contains client of a given cluster. It wraps emberAfContainsClient with manufacturerCode = EMBER_AF_NULL_MANUFACTURER_CODE If this function is used with a manufacturer-specific clusterId, it returns the first cluster that it finds in the Cluster table. It does not return any other clusters that share that ID.

emberAfWriteAttribute#

EmberAfStatus emberAfWriteAttribute (uint8_t endpoint, EmberAfClusterId cluster, EmberAfAttributeId attributeID, uint8_t mask, uint8_t * dataPtr, EmberAfAttributeType dataType)

Write an attribute performing all checks.

This function attempts to write the attribute value from the provided pointer. It only checks that the attribute exists. If it does, it writes the value into the attribute table for the given attribute.

This function does not check if the attribute is writable since the read only / writable characteristic of an attribute only pertains to external devices writing over the air. Because this function is called locally, it assumes that the device knows what it is doing and has permission to perform the given operation.

See Also

• emberAfWriteClientAttribute, emberAfWriteServerAttribute, emberAfWriteManufacturerSpecificClientAttribute, emberAfWriteManufacturerSpecificServerAttribute

emberAfWriteServerAttribute#

EmberAfStatus emberAfWriteServerAttribute (uint8_t endpoint, EmberAfClusterId cluster, EmberAfAttributeId attributeID, uint8_t * dataPtr, EmberAfAttributeType dataType)

Write a cluster server attribute.

This function is the same as emberAfWriteAttribute except that it saves having to pass the cluster mask. This is useful for code saving because the write attribute is used frequently throughout the framework

See Also

• emberAfWriteClientAttribute, emberAfWriteManufacturerSpecificClientAttribute, emberAfWriteManufacturerSpecificServerAttribute

emberAfWriteClientAttribute#

EmberAfStatus emberAfWriteClientAttribute (uint8_t endpoint, EmberAfClusterId cluster, EmberAfAttributeId attributeID, uint8_t * dataPtr, EmberAfAttributeType dataType)

Write a cluster client attribute.

This function is the same as emberAfWriteAttribute except that it saves having to pass the cluster mask. This is useful for code saving because the write attribute is used frequently throughout the framework.

See Also

• emberAfWriteServerAttribute, emberAfWriteManufacturerSpecificClientAttribute, emberAfWriteManufacturerSpecificServerAttribute

emberAfWriteManufacturerSpecificServerAttribute#

EmberAfStatus emberAfWriteManufacturerSpecificServerAttribute (uint8_t endpoint, EmberAfClusterId cluster, EmberAfAttributeId attributeID, uint16_t manufacturerCode, uint8_t * dataPtr, EmberAfAttributeType dataType)

Write a manufacturer-specific server attribute.

This function is the same as emberAfWriteAttribute except that it saves having to pass the cluster mask and allows passing a manufacturer code. This is useful for code saving because the write attribute is used frequently throughout the framework.

See Also

• emberAfWriteClientAttribute, emberAfWriteServerAttribute, emberAfWriteManufacturerSpecificClientAttribute

emberAfWriteManufacturerSpecificClientAttribute#

EmberAfStatus emberAfWriteManufacturerSpecificClientAttribute (uint8_t endpoint, EmberAfClusterId cluster, EmberAfAttributeId attributeID, uint16_t manufacturerCode, uint8_t * dataPtr, EmberAfAttributeType dataType)

Write a manufacturer-specific client attribute.

This function is the same as emberAfWriteAttribute except that it saves having to pass the cluster mask and allows passing of a manufacturer code. This is useful for code saving because the write attribute is used frequently throughout the framework.

See Also

• emberAfWriteClientAttribute, emberAfWriteServerAttribute, emberAfWriteManufacturerSpecificServerAttribute

emberAfVerifyAttributeWrite#

EmberAfStatus emberAfVerifyAttributeWrite (uint8_t endpoint, EmberAfClusterId cluster, EmberAfAttributeId attributeID, uint8_t mask, uint16_t manufacturerCode, uint8_t * dataPtr, EmberAfAttributeType dataType)

Test the success of attribute write.

This function returns success if the attribute write is successful. It does not actually write anything, just validates for read-only and data-type.

emberAfReadAttribute#

EmberAfStatus emberAfReadAttribute (uint8_t endpoint, EmberAfClusterId cluster, EmberAfAttributeId attributeID, uint8_t mask, uint8_t * dataPtr, uint8_t readLength, EmberAfAttributeType * dataType)

Read the attribute value performing all the checks.

This function attempts to read the attribute and store it into the pointer. It also reads the data type. Both dataPtr and dataType may be NULL, signifying that either value or type is not desired.

See Also

• emberAfReadClientAttribute, emberAfReadServerAttribute, emberAfReadManufacturerSpecificClientAttribute, emberAfReadManufacturerSpecificServerAttribute

emberAfReadServerAttribute#

EmberAfStatus emberAfReadServerAttribute (uint8_t endpoint, EmberAfClusterId cluster, EmberAfAttributeId attributeID, uint8_t * dataPtr, uint8_t readLength)

Read the server attribute value performing all the checks.

This function attempts to read the attribute and store it into the pointer. It also reads the data type. Both dataPtr and dataType may be NULL, signifying that either value or type is not desired.

See Also

• emberAfReadClientAttribute, emberAfReadManufacturerSpecificClientAttribute, emberAfReadManufacturerSpecificServerAttribute

emberAfReadClientAttribute#

EmberAfStatus emberAfReadClientAttribute (uint8_t endpoint, EmberAfClusterId cluster, EmberAfAttributeId attributeID, uint8_t * dataPtr, uint8_t readLength)

Read the client attribute value, performing all the checks.

This function attempts to read the attribute and store it into the pointer. It also reads the data type. Both dataPtr and dataType may be NULL, signifying that either value or type is not desired.

See Also

• emberAfReadServerAttribute, emberAfReadManufacturerSpecificClientAttribute, emberAfReadManufacturerSpecificServerAttribute

emberAfReadManufacturerSpecificServerAttribute#

EmberAfStatus emberAfReadManufacturerSpecificServerAttribute (uint8_t endpoint, EmberAfClusterId cluster, EmberAfAttributeId attributeID, uint16_t manufacturerCode, uint8_t * dataPtr, uint8_t readLength)

Read the manufacturer-specific server attribute value, performing all checks.

This function attempts to read the attribute and store it into the pointer. It also reads the data type. Both dataPtr and dataType may be NULL, signifying that either value or type is not desired.

See Also

• emberAfReadClientAttribute, emberAfReadServerAttribute, emberAfReadManufacturerSpecificClientAttribute

emberAfReadManufacturerSpecificClientAttribute#

EmberAfStatus emberAfReadManufacturerSpecificClientAttribute (uint8_t endpoint, EmberAfClusterId cluster, EmberAfAttributeId attributeID, uint16_t manufacturerCode, uint8_t * dataPtr, uint8_t readLength)

Read the manufacturer-specific client attribute value, performing all checks.

This function attempts to read the attribute and store it into the pointer. It also reads the data type. Both dataPtr and dataType may be NULL, signifying that either value or type is not desired.

See Also

• emberAfReadClientAttribute, emberAfReadServerAttribute, emberAfReadManufacturerSpecificServerAttribute

emberAfGetDataSize#

uint8_t emberAfGetDataSize (uint8_t dataType)

Return the size of the ZCL data in bytes.

Returns

• Size in bytes or 0 if invalid data type

emberAfGetOpenNetworkDurationSec#

uint8_t emberAfGetOpenNetworkDurationSec (void )

Return the number of seconds the network remains open.

Returns

• A return value of 0 indicates that the network is closed.

emberAfEndpointFromIndex#

uint8_t emberAfEndpointFromIndex (uint8_t index)

Take an index of an endpoint and return the Zigbee endpoint.

Returns

• Zigbee endpoint.

emberAfIndexFromEndpoint#

uint8_t emberAfIndexFromEndpoint (uint8_t endpoint)

Return the index of a given endpoint.

Returns

• Index of a Zigbee endpoint.

emberAfIndexFromEndpointIncludingDisabledEndpoints#

uint8_t emberAfIndexFromEndpointIncludingDisabledEndpoints (uint8_t endpoint)

Return the index of a given endpoint. It does not ignore disabled endpoints.

Returns

• Index of a Zigbee endpoint.

emberAfFindClusterClientEndpointIndex#

uint8_t emberAfFindClusterClientEndpointIndex (uint8_t endpoint, EmberAfClusterId clusterId)

Return the endpoint index within a given cluster (Client-side), looking only for standard clusters.

Returns

• Index of a Zigbee endpoint.

emberAfFindClusterServerEndpointIndex#

uint8_t emberAfFindClusterServerEndpointIndex (uint8_t endpoint, EmberAfClusterId clusterId)

Return the endpoint index within a given cluster (Server-side), looking only for standard clusters.

Returns

• Index of a Zigbee endpoint.

emberAfNetworkIndexFromEndpoint#

uint8_t emberAfNetworkIndexFromEndpoint (uint8_t endpoint)

Return the network index of a given endpoint.

Returns

• Network index of a Zigbee endpoint.

emberAfEndpointCount#

uint8_t emberAfEndpointCount (void )

Return the total number of endpoints (dynamic and pre-compiled).

emberAfFixedEndpointCount#

uint8_t emberAfFixedEndpointCount (void )

Return the number of pre-compiled endpoints.

emberAfGetAttributeAnalogOrDiscreteType#

uint8_t emberAfGetAttributeAnalogOrDiscreteType (uint8_t dataType)

Return the type of the attribute, either ANALOG, DISCRETE, or NONE.

emberAfIsTypeSigned#

bool emberAfIsTypeSigned (EmberAfAttributeType dataType)

Return true if type is signed, false otherwise.

emberAfGetInt32u#

uint32_t emberAfGetInt32u (const uint8_t * message, uint16_t currentIndex, uint16_t msgLen)

Extract a 32-bit integer from the message buffer.

emberAfGetInt24u#

uint32_t emberAfGetInt24u (const uint8_t * message, uint16_t currentIndex, uint16_t msgLen)

Extract a 24-bit integer from the message buffer.

emberAfGetInt16u#

uint16_t emberAfGetInt16u (const uint8_t * message, uint16_t currentIndex, uint16_t msgLen)

Extract a 16-bit integer from the message buffer.

emberAfGetString#

uint8_t* emberAfGetString (uint8_t * message, uint16_t currentIndex, uint16_t msgLen)

Extract a ZCL string from the message buffer.

emberAfGetLongString#

uint8_t* emberAfGetLongString (uint8_t * message, uint16_t currentIndex, uint16_t msgLen)

Extract a ZCL long string from the message buffer.

emberAfGetDate#

uint8_t emberAfGetDate (uint8_t * message, uint16_t currentIndex, uint16_t msgLen, EmberAfDate * destination)

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

emberAfCopyInt16u#

void emberAfCopyInt16u (uint8_t * data, uint16_t index, uint16_t x)

Copy a uint16_t value into a buffer.

emberAfCopyInt24u#

void emberAfCopyInt24u (uint8_t * data, uint16_t index, uint32_t x)

Copy a uint24_t value into a buffer.

emberAfCopyInt32u#

void emberAfCopyInt32u (uint8_t * data, uint16_t index, uint32_t x)

Copy a uint32_t value into a buffer.

emberAfCopyString#

void emberAfCopyString (uint8_t * dest, uint8_t * src, uint8_t size)

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

emberAfCopyLongString#

void emberAfCopyLongString (uint8_t * dest, uint8_t * src, uint16_t size)

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

emberAfStringLength#

uint8_t emberAfStringLength (const uint8_t * buffer)

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

emberAfLongStringLength#

uint16_t emberAfLongStringLength (const uint8_t * buffer)

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

emberAfAttributeValueSize#

uint16_t emberAfAttributeValueSize (EmberAfAttributeType dataType, const uint8_t * buffer, const uint16_t bufferSize)

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

emberAfIsDeviceEnabled#

bool emberAfIsDeviceEnabled (uint8_t endpoint)

Check whether the endpoint is enabled.

This function returns true if device at a given endpoint is enabled. At startup, all endpoints are enabled.

emberAfIsDeviceIdentifying#

bool emberAfIsDeviceIdentifying (uint8_t endpoint)

Check whether the endpoint is identifying.

This function returns true if the device at a given endpoint is identifying.

emberAfSetDeviceEnabled#

void emberAfSetDeviceEnabled (uint8_t endpoint, bool enabled)

Enable or disable an endpoint.

By calling this function, you turn off all processing of incoming traffic for a given endpoint.

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.

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

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.

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.

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)

Return the current node type.

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.

Returns

• status of whether or not permit join was enabled.

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.

Returns

• status of whether or not permit join was enabled.

sl_zigbee_zcl_schedule_tick_extended#

EmberStatus sl_zigbee_zcl_schedule_tick_extended (uint8_t endpoint, EmberAfClusterId clusterId, bool isClient, uint32_t delayMs, EmberAfEventPollControl pollControl, EmberAfEventSleepControl sleepControl)

Schedule a cluster-related event inside the application framework's event mechanism. This function provides a wrapper for the Ember stack event mechanism which allows the cluster code to access its events by their endpoint, cluster ID, and client/server identity. The passed poll and sleep controls allow the cluster to indicate whether it needs to long or short poll and whether it needs to stay awake or if it can sleep.

Returns

• EMBER_SUCCESS if the event was scheduled or an error otherwise.

sl_zigbee_zcl_schedule_cluster_tick#

EmberStatus sl_zigbee_zcl_schedule_cluster_tick (uint8_t endpoint, EmberAfClusterId clusterId, bool isClient, uint32_t delayMs, EmberAfEventSleepControl sleepControl)

Schedule a cluster-related event inside the application framework's event mechanism. This function is a wrapper for ::emberAfScheduleTickExtended. The cluster on the given endpoint will be set to long poll if sleepControl is set to EMBER_AF_OK_TO_HIBERNATE or will be set to short poll otherwise. It will stay awake if sleepControl is EMBER_AF_STAY_AWAKE and will sleep otherwise.

Returns

• EMBER_SUCCESS if the event was scheduled or an error otherwise.

sl_zigbee_zcl_schedule_client_tick_extended#

EmberStatus sl_zigbee_zcl_schedule_client_tick_extended (uint8_t endpoint, EmberAfClusterId clusterId, uint32_t delayMs, EmberAfEventPollControl pollControl, EmberAfEventSleepControl sleepControl)

Schedule a cluster client event. This function is a wrapper for sl_zigbee_zcl_schedule_tick_extended.

Returns

• EMBER_SUCCESS if the event was scheduled or an error otherwise.

sl_zigbee_zcl_schedule_client_tick#

EmberStatus sl_zigbee_zcl_schedule_client_tick (uint8_t endpoint, EmberAfClusterId clusterId, uint32_t delayMs)

Schedule a cluster client event. This function is a wrapper for sl_zigbee_zcl_schedule_client_tick_extended. It indicates that the cluster client on the given endpoint can long poll and can sleep.

Returns

• EMBER_SUCCESS if the event was scheduled or an error otherwise.

sl_zigbee_zcl_schedule_server_tick_extended#

EmberStatus sl_zigbee_zcl_schedule_server_tick_extended (uint8_t endpoint, EmberAfClusterId clusterId, uint32_t delayMs, EmberAfEventPollControl pollControl, EmberAfEventSleepControl sleepControl)

Schedule a cluster server event. This function is a wrapper for sl_zigbee_zcl_schedule_tick_extended.

Returns

• EMBER_SUCCESS if the event was scheduled or an error otherwise.

sl_zigbee_zcl_schedule_server_tick#

EmberStatus sl_zigbee_zcl_schedule_server_tick (uint8_t endpoint, EmberAfClusterId clusterId, uint32_t delayMs)

Schedule a cluster server event. This function is a wrapper for sl_zigbee_zcl_schedule_server_tick_extended. It indicates that the cluster server on the given endpoint can long poll and can sleep.

Returns

• EMBER_SUCCESS if the event was scheduled or an error otherwise.

sl_zigbee_zcl_deactivate_cluster_tick#

EmberStatus sl_zigbee_zcl_deactivate_cluster_tick (uint8_t endpoint, EmberAfClusterId clusterId, bool isClient)

Deactivate a cluster-related event. This function provides a wrapper for the Ember stack's event mechanism, which allows an event to be accessed by its endpoint, cluster ID, and client/server identity.

Returns

• EMBER_SUCCESS if the event was deactivated or an error otherwise.

sl_zigbee_zcl_deactivate_client_tick#

EmberStatus sl_zigbee_zcl_deactivate_client_tick (uint8_t endpoint, EmberAfClusterId clusterId)

Deactivate a cluster client event. This function is a wrapper for sl_zigbee_zcl_deactivate_cluster_tick.

Returns

• EMBER_SUCCESS if the event was deactivated or an error otherwise.

sl_zigbee_zcl_deactivate_server_tick#

EmberStatus sl_zigbee_zcl_deactivate_server_tick (uint8_t endpoint, EmberAfClusterId clusterId)

Deactivate a cluster server event. This function is a wrapper for sl_zigbee_zcl_deactivate_cluster_tick.

Returns

• EMBER_SUCCESS if the event was deactivated or an error otherwise.

emberAfSendResponse#

EmberStatus emberAfSendResponse (void )

Send a ZCL response, based on the information that is currently in the outgoing buffer. It is expected that a complete ZCL message is present, including header. The application may use this method directly from within the message handling function and associated callbacks. However, this will result in the response being sent before the APS ACK is sent, which is not ideal.

NOTE: This will overwrite the ZCL sequence number of the message to use the LAST received sequence number.

emberAfSendResponseWithCallback#

EmberStatus emberAfSendResponseWithCallback (EmberAfMessageSentFunction callback)

Send ZCL response with attached message sent callback.

emberAfSendMulticast#

EmberStatus emberAfSendMulticast (EmberMulticastId multicastId, EmberApsFrame * apsFrame, uint16_t messageLength, uint8_t * message)

Send multicast.

emberAfSendMulticastToBindings#

EmberStatus emberAfSendMulticastToBindings (EmberApsFrame * apsFrame, uint16_t messageLength, uint8_t * message)

Multicast the message to the group in the binding table that match the cluster and source endpoint in the APS frame. Note: if the binding table contains many matching entries, calling this API cause a significant amount of network traffic. Care should be taken when considering the effects of broadcasts in a network.

emberAfSendMulticastWithAliasWithCallback#

EmberStatus emberAfSendMulticastWithAliasWithCallback (EmberMulticastId multicastId, EmberApsFrame * apsFrame, uint16_t messageLength, uint8_t * message, EmberNodeId alias, uint8_t sequence, EmberAfMessageSentFunction callback)

Send Multicast with alias with attached message sent callback.

emberAfSendMulticastWithCallback#

EmberStatus emberAfSendMulticastWithCallback (EmberMulticastId multicastId, EmberApsFrame * apsFrame, uint16_t messageLength, uint8_t * message, EmberAfMessageSentFunction callback)

Send multicast with attached message sent callback.

emberAfSendBroadcast#

EmberStatus emberAfSendBroadcast (EmberNodeId destination, EmberApsFrame * apsFrame, uint16_t messageLength, uint8_t * message)

Send broadcast.

emberAfSendBroadcastWithCallback#

EmberStatus emberAfSendBroadcastWithCallback (EmberNodeId destination, EmberApsFrame * apsFrame, uint16_t messageLength, uint8_t * message, EmberAfMessageSentFunction callback)

Send broadcast with attached message sent callback.

emberAfSendBroadcastWithAliasWithCallback#

EmberStatus emberAfSendBroadcastWithAliasWithCallback (EmberNodeId destination, EmberApsFrame * apsFrame, uint16_t messageLength, uint8_t * message, EmberNodeId alias, uint8_t sequence, EmberAfMessageSentFunction callback)

Send broadcast with alias with attached message sent callback.

emberAfSendUnicast#

EmberStatus emberAfSendUnicast (EmberOutgoingMessageType type, uint16_t indexOrDestination, EmberApsFrame * apsFrame, uint16_t messageLength, uint8_t * message)

Send unicast.

emberAfSendUnicastWithCallback#

EmberStatus emberAfSendUnicastWithCallback (EmberOutgoingMessageType type, uint16_t indexOrDestination, EmberApsFrame * apsFrame, uint16_t messageLength, uint8_t * message, EmberAfMessageSentFunction callback)

Send unicast with attached message sent callback.

emberAfSendUnicastToBindings#

EmberStatus emberAfSendUnicastToBindings (EmberApsFrame * apsFrame, uint16_t messageLength, uint8_t * message)

Unicast the message to each remote node in the binding table that matches the cluster and source endpoint in the APS frame. Note: if the binding table contains many matching entries, calling this API cause a significant amount of network traffic.

emberAfSendUnicastToBindingsWithCallback#

EmberStatus emberAfSendUnicastToBindingsWithCallback (EmberApsFrame * apsFrame, uint16_t messageLength, uint8_t * message, EmberAfMessageSentFunction callback)

emberAfSendUnicastToBindings with attached message sent callback.

emberAfSendInterPan#

EmberStatus emberAfSendInterPan (EmberPanId panId, const EmberEUI64 destinationLongId, EmberNodeId destinationShortId, EmberMulticastId multicastId, EmberAfClusterId clusterId, EmberAfProfileId profileId, uint16_t messageLength, uint8_t * messageBytes)

Send interpan message.

emberAfSendEndDeviceBind#

EmberStatus emberAfSendEndDeviceBind (uint8_t endpoint)

Send end device binding request.

emberAfSendCommandUnicastToBindings#

EmberStatus emberAfSendCommandUnicastToBindings (void )

Send the command prepared with emberAfFill.... macro.

This function is used to send a command that was previously prepared using the emberAfFill... macros from the client command API. It will be sent as unicast to each remote node in the binding table that matches the cluster and source endpoint in the APS frame. Note: if the binding table contains many matching entries, calling this API cause a significant amount of network traffic.

emberAfSendCommandUnicastToBindingsWithCallback#

EmberStatus emberAfSendCommandUnicastToBindingsWithCallback (EmberAfMessageSentFunction callback)

emberAfSendCommandUnicastToBindings with attached message sent callback.

emberAfSendCommandMulticast#

EmberStatus emberAfSendCommandMulticast (EmberMulticastId multicastId)

Send the command prepared with emberAfFill.... macro.

This function is used to send a command that was previously prepared using the emberAfFill... macros from the client command API. It will be sent as multicast.

emberAfSendCommandMulticastWithAlias#

EmberStatus emberAfSendCommandMulticastWithAlias (EmberMulticastId multicastId, EmberNodeId alias, uint8_t sequence)

Send the command prepared with emberAfFill.... macro.

This function is used to send a command that was previously prepared using the emberAfFill... macros from the client command API. It will be sent as multicast.

emberAfSendCommandMulticastWithCallback#

EmberStatus emberAfSendCommandMulticastWithCallback (EmberMulticastId multicastId, EmberAfMessageSentFunction callback)

emberAfSendCommandMulticast with attached message sent callback.

emberAfSendCommandMulticastToBindings#

EmberStatus emberAfSendCommandMulticastToBindings (void )

Send the command prepared with emberAfFill.... macro.

This function is used to send a command that was previously prepared using the emberAfFill... macros from the client command API. It will be sent as multicast to the group specified in the binding table that matches the cluster and source endpoint in the APS frame. Note: if the binding table contains many matching entries, calling this API cause a significant amount of network traffic.

emberAfSendCommandUnicast#

EmberStatus emberAfSendCommandUnicast (EmberOutgoingMessageType type, uint16_t indexOrDestination)

Send the command prepared with emberAfFill.... macro.

This function is used to send a command that was previously prepared using the emberAfFill... macros from the client command API. It will be sent as unicast.

emberAfSendCommandUnicastWithCallback#

EmberStatus emberAfSendCommandUnicastWithCallback (EmberOutgoingMessageType type, uint16_t indexOrDestination, EmberAfMessageSentFunction callback)

emberAfSendCommandUnicast with attached message sent callback.

emberAfSendCommandBroadcast#

EmberStatus emberAfSendCommandBroadcast (EmberNodeId destination)

Send the command prepared with emberAfFill.... macro.

This function is used to send a command that was previously prepared using the emberAfFill... macros from the client command API.

emberAfSendCommandBroadcastWithCallback#

EmberStatus emberAfSendCommandBroadcastWithCallback (EmberNodeId destination, EmberAfMessageSentFunction callback)

emberAfSendCommandBroadcast with attached message sent callback.

emberAfSendCommandBroadcastWithAliasWithCallback#

EmberStatus emberAfSendCommandBroadcastWithAliasWithCallback (EmberNodeId destination, EmberNodeId alias, uint8_t sequence, EmberAfMessageSentFunction callback)

emberAfSendCommandBroadcast from alias with attached message sent callback.

emberAfSendCommandBroadcastWithAlias#

EmberStatus emberAfSendCommandBroadcastWithAlias (EmberNodeId destination, EmberNodeId alias, uint8_t sequence)

Send the command prepared with emberAfFill.... macro.

This function is used to send a command that was previously prepared using the emberAfFill... macros from the client command API.

emberAfSendCommandInterPan#

EmberStatus emberAfSendCommandInterPan (EmberPanId panId, const EmberEUI64 destinationLongId, EmberNodeId destinationShortId, EmberMulticastId multicastId, EmberAfProfileId profileId)

Send the command prepared with emberAfFill.... macro.

This function is used to send a command that was previously prepared using the emberAfFill... macros from the client command API. It will be sent via inter-PAN. If destinationLongId is not NULL, the message will be sent to that long address using long addressing mode; otherwise, the message will be sent to destinationShortId using short address mode. IF multicastId is not zero, the message will be sent using multicast mode.

emberAfSendDefaultResponse#

EmberStatus emberAfSendDefaultResponse (const EmberAfClusterCommand * cmd, EmberAfStatus status)

Send a default response to a cluster command.

This function is used to prepare and send a default response to a cluster command.

Returns

• An ::EmberStatus value that indicates the success or failure of sending the response.

emberAfSendDefaultResponseWithCallback#

EmberStatus emberAfSendDefaultResponseWithCallback (const EmberAfClusterCommand * cmd, EmberAfStatus status, EmberAfMessageSentFunction callback)

emberAfSendDefaultResponse with attached message sent callback.

emberAfSendImmediateDefaultResponse#

EmberStatus emberAfSendImmediateDefaultResponse (EmberAfStatus status)

Send a default response to a cluster command using the current command.

This function is used to prepare and send a default response to a cluster command.

Returns

• An ::EmberStatus value that indicates the success or failure of sending the response.

emberAfSendImmediateDefaultResponseWithCallback#

EmberStatus emberAfSendImmediateDefaultResponseWithCallback (EmberAfStatus status, EmberAfMessageSentFunction callback)

emberAfSendImmediateDefaultResponse with attached message sent callback.

emberAfMaximumApsPayloadLength#

uint8_t emberAfMaximumApsPayloadLength (EmberOutgoingMessageType type, uint16_t indexOrDestination, EmberApsFrame * apsFrame)

Return the maximum size of the payload that the Application Support sub-layer will accept for the given message type, destination, and APS frame.

The size depends on multiple factors, including the security level in use and additional information added to the message to support the various options.

Returns

• The maximum APS payload length for the given message.

emberAfGetCommandApsFrame#

EmberApsFrame* emberAfGetCommandApsFrame (void )

Access to client API APS frame.

emberAfSetCommandEndpoints#

void emberAfSetCommandEndpoints (uint8_t sourceEndpoint, uint8_t destinationEndpoint)

Set the source and destination endpoints in the client API APS frame.

emberAfFindDevicesByProfileAndCluster#

EmberStatus emberAfFindDevicesByProfileAndCluster (EmberNodeId target, EmberAfProfileId profileId, EmberAfClusterId clusterId, bool serverCluster, EmberAfServiceDiscoveryCallback * callback)

Find devices in the network with endpoints matching a given profile ID and cluster ID in their descriptors. Target may either be a specific device, or the broadcast address EMBER_RX_ON_WHEN_IDLE_BROADCAST_ADDRESS.

This function initiates a service discovery. Received responses are returned by executing the callback function passed in. For unicast discoveries, the callback will be executed only once. Either the target will return a result or a timeout will occur. For broadcast discoveries, the callback may be called multiple times and after a period of time the discovery will be finished with a final call to the callback.

emberAfFindClustersByDeviceAndEndpoint#

EmberStatus emberAfFindClustersByDeviceAndEndpoint (EmberNodeId target, uint8_t targetEndpoint, EmberAfServiceDiscoveryCallback * callback)

Find all of the given in and out clusters implemented on a devices given endpoint. Target should only be the short address of a specific device.

This function initiates a single service discovery and the response is passed back to the passed callback.

emberAfFindIeeeAddress#

EmberStatus emberAfFindIeeeAddress (EmberNodeId shortAddress, EmberAfServiceDiscoveryCallback * callback)

Initiate a discovery for the IEEE address of the specified node ID. This will send a unicast sent to the target node ID.

emberAfFindNodeId#

EmberStatus emberAfFindNodeId (EmberEUI64 longAddress, EmberAfServiceDiscoveryCallback * callback)

Initiate a discovery for the short ID of the specified long address. This will send a broadcast to all RX-on-when-idle devices (non-sleepies).

emberAfFindActiveEndpoints#

EmberStatus emberAfFindActiveEndpoints (EmberNodeId target, EmberAfServiceDiscoveryCallback * callback)

Initiate an Active Endpoint request ZDO message to the target node ID.

emberAfAddAddressTableEntry#

uint8_t emberAfAddAddressTableEntry (EmberEUI64 longId, EmberNodeId shortId)

Add an entry for a remote device to the address table.

If the EUI64 already exists in the address table, the index of the existing entry will be returned. Otherwise, a new entry will be created and the new new index will be returned. The framework will remember how many times the returned index has been referenced. When the address table entry is no longer needed, the application should remove its reference by calling emberAfRemoveAddressTableEntry.

Returns

• The index of the address table entry for this remove device or ::EMBER_NULL_ADDRESS_TABLE_INDEX if an error occurred (e.g., the address table is full).

emberAfSetAddressTableEntry#

EmberStatus emberAfSetAddressTableEntry (uint8_t index, EmberEUI64 longId, EmberNodeId shortId)

Add an entry for a remote device to the address table at a specific location.

The framework will remember how many times an address table index has been referenced through emberAfAddAddressTableEntry. If the reference count for the index passed to this function is not zero, the entry will be not changed. When the address table entry is no longer needed, the application should remove its reference by calling emberAfRemoveAddressTableEntry.

Returns

• ::EMBER_SUCCESS if the address table entry was successfully set, ::EMBER_ADDRESS_TABLE_ENTRY_IS_ACTIVE if any messages are being sent using the existing entry at that index or the entry is still referenced in the framework, or ::EMBER_ADDRESS_TABLE_INDEX_OUT_OF_RANGE if the index is out of range.

emberAfRemoveAddressTableEntry#

EmberStatus emberAfRemoveAddressTableEntry (uint8_t index)

Remove a specific entry from the address table.

The framework will remember how many times an address table index has been referenced through emberAfAddAddressTableEntry and emberAfSetAddressTableEntry. The address table entry at this index will not actually be removed until its reference count reaches zero.

Returns

• ::EMBER_SUCCESS if the address table entry was successfully removed or ::EMBER_ADDRESS_TABLE_INDEX_OUT_OF_RANGE if the index is out of range.

emberAfInitiateKeyEstablishment#

EmberStatus emberAfInitiateKeyEstablishment (EmberNodeId nodeId, uint8_t endpoint)

Initiate key establishment with a remote node. emberAfKeyEstablishmentCallback will be called as events occur and when key establishment completes.

Returns

• ::EMBER_SUCCESS if key establishment was initiated successfully

emberAfInitiateInterPanKeyEstablishment#

EmberStatus emberAfInitiateInterPanKeyEstablishment (EmberPanId panId, const EmberEUI64 eui64)

Initiate key establishment with a remote node on a different PAN. emberAfInterPanKeyEstablishmentCallback will be called as events occur and when key establishment completes.

Returns

• ::EMBER_SUCCESS if key establishment was initiated successfully

emberAfPerformingKeyEstablishment#

bool emberAfPerformingKeyEstablishment (void )

Indicate whether the device is in the process of performing key establishment.

Returns

• ::true if key establishment is in progress.

emberAfInitiatePartnerLinkKeyExchange#

EmberStatus emberAfInitiatePartnerLinkKeyExchange (EmberNodeId target, uint8_t endpoint, EmberAfPartnerLinkKeyExchangeCallback * callback)

Initiate partner link key exchange with a remote node.

Returns

• ::EMBER_SUCCESS if the partner link key exchange was initiated successfully.

emberAfIsCurrentSecurityProfileSmartEnergy#

bool emberAfIsCurrentSecurityProfileSmartEnergy (void )

Use this function to determine if the security profile of the current network was set to Smart Energy. The security profile is configured in AppBuilder. @ return true if the security profile is Smart Energy or false otherwise.

sl_zigbee_subscribe_to_zcl_commands#

sl_status_t sl_zigbee_subscribe_to_zcl_commands (uint16_t cluster_id, uint16_t manufacturer_id, uint8_t direction, sl_service_function_t service_function)

Runtime subscription to specific incoming ZCL commands.

Returns

• A sl_status_t value of:

  • SL_STATUS_OK - If the subscription was successful.

  • SL_STATUS_INVALID_PARAMETER - If one or more passed parameters are invalid.

  • SL_STATUS_ALLOCATION_FAILED - If the system failed to allocate the necessary data structures.

emberAfFormNetwork#

EmberStatus emberAfFormNetwork (EmberNetworkParameters * parameters)

Form a new network using the specified network parameters.

Returns

• An ::EmberStatus value that indicates either the successful formation of the new network or the reason that the network formation failed.

emberAfJoinNetwork#

EmberStatus emberAfJoinNetwork (EmberNetworkParameters * parameters)

Associate with the network using the specified network parameters.

Returns

• An ::EmberStatus value that indicates either that the association process began successfully or the reason for failure.

emberAfFindUnusedPanIdAndForm#

EmberStatus emberAfFindUnusedPanIdAndForm (void )

Find an unused PAN ID and form a new network.

Returns

• An ::EmberStatus value that indicates either the process begin successfully or the reason for failure.

emberAfStartSearchForJoinableNetwork#

EmberStatus emberAfStartSearchForJoinableNetwork (void )

Find a joinable network and join it.

Returns

• An ::EmberStatus value that indicates either the process begin successfully or the reason for failure.

emberAfPushNetworkIndex#

EmberStatus emberAfPushNetworkIndex (uint8_t networkIndex)

Set the current network to that of the given index and add it to the stack of networks maintained by the framework. Every call to this API must be paired with a subsequent call to emberAfPopNetworkIndex.

emberAfPushCallbackNetworkIndex#

EmberStatus emberAfPushCallbackNetworkIndex (void )

Set the current network to the callback network and adds it to the stack of networks maintained by the framework. Every call to this API must be paired with a subsequent call to emberAfPopNetworkIndex.

emberAfPushEndpointNetworkIndex#

EmberStatus emberAfPushEndpointNetworkIndex (uint8_t endpoint)

Set the current network to that of the given endpoint and adds it to the stack of networks maintained by the framework. Every call to this API must be paired with a subsequent call to emberAfPopNetworkIndex.

emberAfPopNetworkIndex#

EmberStatus emberAfPopNetworkIndex (void )

Remove the topmost network from the stack of networks maintained by the framework and sets the current network to the new topmost network. Every call to this API must be paired with a prior call to emberAfPushNetworkIndex, emberAfPushCallbackNetworkIndex, or emberAfPushEndpointNetworkIndex.

emberAfPrimaryEndpointForNetworkIndex#

uint8_t emberAfPrimaryEndpointForNetworkIndex (uint8_t networkIndex)

Return the primary endpoint of the given network index or 0xFF if no endpoints belong to the network.emberAfStatus.

emberAfPrimaryEndpointForCurrentNetworkIndex#

uint8_t emberAfPrimaryEndpointForCurrentNetworkIndex (void )

Return the primary endpoint of the current network index or 0xFF if no endpoints belong to the current network.

CONFIGURATION_HEADER#

#define CONFIGURATION_HEADER

"app/framework/util/config.h"

ZCL_FRAME_CONTROL_FRAME_TYPE_MASK#

#define ZCL_FRAME_CONTROL_FRAME_TYPE_MASK

(BIT(0) | BIT(1))

ZCL_CLUSTER_SPECIFIC_COMMAND#

#define ZCL_CLUSTER_SPECIFIC_COMMAND

BIT(0)

ZCL_PROFILE_WIDE_COMMAND#

#define ZCL_PROFILE_WIDE_COMMAND

0u

ZCL_GLOBAL_COMMAND#

#define ZCL_GLOBAL_COMMAND

(ZCL_PROFILE_WIDE_COMMAND)

ZCL_MANUFACTURER_SPECIFIC_MASK#

#define ZCL_MANUFACTURER_SPECIFIC_MASK

BIT(2)

ZCL_FRAME_CONTROL_DIRECTION_MASK#

#define ZCL_FRAME_CONTROL_DIRECTION_MASK

BIT(3)

ZCL_FRAME_CONTROL_SERVER_TO_CLIENT#

#define ZCL_FRAME_CONTROL_SERVER_TO_CLIENT

BIT(3)

ZCL_FRAME_CONTROL_CLIENT_TO_SERVER#

#define ZCL_FRAME_CONTROL_CLIENT_TO_SERVER

0u

ZCL_DISABLE_DEFAULT_RESPONSE_MASK#

#define ZCL_DISABLE_DEFAULT_RESPONSE_MASK

BIT(4)

ZCL_DIRECTION_CLIENT_TO_SERVER#

#define ZCL_DIRECTION_CLIENT_TO_SERVER

0u

ZCL_DIRECTION_SERVER_TO_CLIENT#

#define ZCL_DIRECTION_SERVER_TO_CLIENT

1u

EMBER_AF_ZCL_OVERHEAD#

#define EMBER_AF_ZCL_OVERHEAD

3

EMBER_AF_ZCL_MANUFACTURER_SPECIFIC_OVERHEAD#

#define EMBER_AF_ZCL_MANUFACTURER_SPECIFIC_OVERHEAD

5

FIND_AND_JOIN_MODE_ALLOW_2_4_GHZ#

#define FIND_AND_JOIN_MODE_ALLOW_2_4_GHZ

BIT(0)

FIND_AND_JOIN_MODE_ALLOW_SUB_GHZ#

#define FIND_AND_JOIN_MODE_ALLOW_SUB_GHZ

BIT(1)

FIND_AND_JOIN_MODE_ALLOW_BOTH#

#define FIND_AND_JOIN_MODE_ALLOW_BOTH

(FIND_AND_JOIN_MODE_ALLOW_2_4_GHZ | FIND_AND_JOIN_MODE_ALLOW_SUB_GHZ)

emberAfMaxPowerLevel#

#define emberAfMaxPowerLevel

()

The maximum power level that can be used by the chip.