The master include file for the Ember ApplicationFramework API.

License#

Copyright 2018 Silicon Laboratories Inc. www.silabs.com

The licensor of this software is Silicon Laboratories Inc. Your use of this software is governed by the terms of Silicon Labs Master Software License Agreement (MSLA) available at www.silabs.com/about-us/legal/master-software-license-agreement. This software is distributed to you in Source Code format and is governed by the sections of the MSLA applicable to Source Code.

/***************************************************************************/
#ifndef SILABS_AF_API
#define SILABS_AF_API

// Micro and compiler-specific typedefs and macros
#include PLATFORM_HEADER

#ifndef CONFIGURATION_HEADER
  #define CONFIGURATION_HEADER "app/framework/util/config.h"
#endif
#include CONFIGURATION_HEADER

// The ZCL Long String type data type takes first 2 bytes as the length
// And the sl_zigbee_af_read_attribute takes an uint8_t as the output length.
// So, it is important to ensure the largest value is less than the 253.
// NOTE : SL_MIN is not used instead following MIN is created using macro comparison.
//        because, SL_MIN for GCC expands to creating variable of same type using __typeof__,
//        assigning the supplied values and comparing, which causes a gcc error
//        "error: variable length array declaration not allowed at file scope" for unit tests
//        where ATTRIBUTE_MAX_DATA_SIZE used in definition local arrays for attribute
//        inside a function.
#define MIN(a, b) ((a) > (b) ? (b) : (a))
#define ATTRIBUTE_MAX_DATA_SIZE MIN(ATTRIBUTE_LARGEST, 253)

#ifdef EZSP_HOST
// Includes needed for ember related functions for the EZSP host
  #include "stack/include/error.h"
  #include "stack/include/ember-types.h"
  #include "stack/include/ember-random-api.h"
  #include "app/util/ezsp/ezsp-protocol.h"
  #include "app/util/ezsp/ezsp.h"
  #include "app/util/ezsp/ezsp-utils.h"
  #include "app/util/ezsp/serial-interface.h"
#else
// Includes needed for ember related functions for the SoC
  #include "stack/include/ember.h"
#endif // EZSP_HOST

#include "hal/hal.h"
#include "event_queue/event-queue.h"
#include "stack/include/error.h"
#include "af-types.h"
#include "app/framework/util/print.h"
#include "app/framework/util/time-util.h"

#ifdef SL_COMPONENT_CATALOG_PRESENT
#include "sl_component_catalog.h"

#ifdef SL_CATALOG_ZIGBEE_ZCL_FRAMEWORK_CORE_PRESENT
#include "zcl-framework-core-config.h"
#endif // SL_CATALOG_ZIGBEE_ZCL_FRAMEWORK_CORE_PRESENT

#ifdef SL_CATALOG_ZIGBEE_TEST_HARNESS_Z3_PRESENT
extern void emberAfPluginTestHarnessZ3BeaconSendEventHandler(sl_zigbee_event_t * event);
extern void emberAfPluginTestHarnessZ3OpenNetworkEventHandler(sl_zigbee_event_t * event);
extern void emberAfPluginTestHarnessZ3ResetKeyEventHandler(sl_zigbee_event_t * event);
extern void emberAfPluginTestHarnessZ3ZdoSendEventHandler(sl_zigbee_event_t * event);
extern void emberAfPluginTestHarnessZ3ZllStuffEventHandler(sl_zigbee_event_t * event);
extern void emberAfPluginTestHarnessZ3ResetEventHandler(sl_zigbee_event_t * event);
#endif //SL_CATALOG_ZIGBEE_TEST_HARNESS_Z3_PRESENT

#endif // SL_COMPONENT_CATALOG_PRESENT

#ifdef SL_CATALOG_CLI_PRESENT
#include "sl_cli.h"
#define SL_CLI_COMMAND_ARG sl_cli_command_arg_t * arguments
#else // !SL_CATALOG_CLI_PRESENT
#define SL_CLI_COMMAND_ARG void
#endif // SL_CATALOG_CLI_PRESENT

#if defined(SL_CATALOG_ZIGBEE_DEBUG_PRINT_PRESENT) && !defined(EMBER_SCRIPTED_TEST)
#include "sl_zigbee_debug_print.h"
#endif // SL_CATALOG_ZIGBEE_DEBUG_PRINT_PRESENT

#include "serial/serial.h"
#include "sl_endianness.h"
// Temporary fix for UC_ALPHA_2, see EMZIGBEE-6782
#include "plugin-component-mappings.h"
#include "af-storage.h"

#include "zap-command.h"
#include "zap-id.h"
#include "zap-print.h"
#include "zap-enabled-incoming-commands.h"
#include "zap-type.h"
#include "app/framework/common/zigbee_app_framework_common.h"

#include "app/framework/util/util.h"
#include "app/framework/util/global-callback.h"
#include "app/framework/util/global-other-callback.h"
#include "app/framework/service-function/sl_service_function.h"

#include "app/framework/util/zcl-debug-print.h"

#include "app/framework/util/client-api.h"

#include "app/util/serial/sl_zigbee_command_interpreter.h"

extern uint8_t ascii_lut[];
// @{

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

#ifdef DOXYGEN_SHOULD_SKIP_THIS
bool emberAfContainsAttribute(uint8_t endpoint,
                              EmberAfClusterId clusterId,
                              EmberAfAttributeId attributeId,
                              uint8_t mask,
                              uint16_t manufacturerCode);
#else
  #define emberAfContainsAttribute(endpoint, clusterId, attributeId, mask, manufacturerCode) \
  (emberAfLocateAttributeMetadata(endpoint, clusterId, attributeId, mask, manufacturerCode) != NULL)
#endif

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

bool emberAfContainsCluster(uint8_t endpoint, EmberAfClusterId clusterId);

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

bool emberAfContainsServer(uint8_t endpoint, EmberAfClusterId clusterId);

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

bool emberAfContainsClient(uint8_t endpoint, EmberAfClusterId clusterId);

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

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

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

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

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

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

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

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

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

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

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

uint8_t emberAfGetDataSize(uint8_t dataType);

uint8_t emberAfGetOpenNetworkDurationSec(void);

#define emberAfClusterIsManufacturerSpecific(cluster) ((cluster)->clusterId >= 0xFC00u)

#define emberAfAttributeIsReadOnly(metadata) (((metadata)->mask & ATTRIBUTE_MASK_WRITABLE) == 0)

#define emberAfAttributeIsClient(metadata) (((metadata)->mask & ATTRIBUTE_MASK_CLIENT) != 0)

#define emberAfAttributeIsTokenized(metadata) (metadata != NULL && (((metadata)->mask & ATTRIBUTE_MASK_TOKENIZE) != 0))

#define emberAfAttributeIsExternal(metadata) (((metadata)->mask & ATTRIBUTE_MASK_EXTERNAL_STORAGE) != 0)

#define emberAfAttributeIsSingleton(metadata) (((metadata)->mask & ATTRIBUTE_MASK_SINGLETON) != 0)

#define emberAfAttributeIsManufacturerSpecific(metadata) (((metadata)->mask & ATTRIBUTE_MASK_MANUFACTURER_SPECIFIC) != 0)

#define emberAfAttributeSize(metadata) ((metadata)->size)

#if !defined(DOXYGEN_SHOULD_SKIP_THIS)
// master array of all defined endpoints
extern EmberAfDefinedEndpoint sli_zigbee_af_endpoints[];

#ifdef SL_CATALOG_ZIGBEE_TEST_HARNESS_Z3_PRESENT
// Master array of all zigbee PRO networks - not 'const', since the
// node type may be changed at run-time.
extern sli_zigbee_af_zigbee_pro_network sli_zigbee_af_zigbee_pro_networks[];

// The current zigbee PRO network or NULL.
extern sli_zigbee_af_zigbee_pro_network *sli_zigbee_af_current_zigbee_pro_network;
#else
// Master array of all Zigbee PRO networks.
extern const sli_zigbee_af_zigbee_pro_network sli_zigbee_af_zigbee_pro_networks[];

// The current Zigbee PRO network or NULL.
extern const sli_zigbee_af_zigbee_pro_network *sli_zigbee_af_current_zigbee_pro_network;
#endif
// True if the current network is a Zigbee PRO network.
#define sli_zigbee_af_pro_is_current_network() (sli_zigbee_af_current_zigbee_pro_network != NULL)
#endif

uint8_t emberAfEndpointFromIndex(uint8_t index);

uint8_t emberAfIndexFromEndpoint(uint8_t endpoint);

uint8_t emberAfIndexFromEndpointIncludingDisabledEndpoints(uint8_t endpoint);

uint8_t emberAfFindClusterClientEndpointIndex(uint8_t endpoint, EmberAfClusterId clusterId);

uint8_t emberAfFindClusterServerEndpointIndex(uint8_t endpoint, EmberAfClusterId clusterId);

#define emberAfProfileIdFromIndex(index) (sli_zigbee_af_endpoints[(index)].profileId)

#define emberAfDeviceIdFromIndex(index) (sli_zigbee_af_endpoints[(index)].deviceId)

#define emberAfDeviceVersionFromIndex(index) (sli_zigbee_af_endpoints[(index)].deviceVersion)

#define emberAfNetworkIndexFromEndpointIndex(index) (sli_zigbee_af_endpoints[(index)].networkIndex)

uint8_t emberAfNetworkIndexFromEndpoint(uint8_t endpoint);

#define emberAfPrimaryProfileId()       emberAfProfileIdFromIndex(0)

#define emberAfPrimaryEndpoint() (sli_zigbee_af_endpoints[0].endpoint)

uint8_t emberAfEndpointCount(void);

uint8_t emberAfFixedEndpointCount(void);

#if (EMBER_AF_PLUGIN_ZCL_CLUSTER_ENABLE_DISABLE_RUN_TIME == 1)
#if !defined(EMBER_TEST)
bool emberAfClusterEnableDisable(uint8_t endpoint,
                                 EmberAfClusterId clusterId,
                                 EmberAfClusterMask mask,
                                 bool enable);

bool emberAfIsClusterEnabled(uint8_t endpoint,
                             EmberAfClusterId clusterId,
                             EmberAfClusterMask mask);
#endif 
#endif //EMBER_AF_PLUGIN_ZCL_CLUSTER_ENABLE_DISABLE_RUN_TIME

#ifndef DOXYGEN_SHOULD_SKIP_THIS
enum {
  EMBER_AF_DATA_TYPE_ANALOG     = 0,
  EMBER_AF_DATA_TYPE_DISCRETE   = 1,
  EMBER_AF_DATA_TYPE_NONE       = 2
};
#endif //DOXYGEN_SHOULD_SKIP_THIS

uint8_t emberAfGetAttributeAnalogOrDiscreteType(uint8_t dataType);

bool emberAfIsTypeSigned(EmberAfAttributeType dataType);

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

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

uint16_t emberAfGetInt16u(const uint8_t* message, uint16_t currentIndex, uint16_t msgLen);
uint8_t* emberAfGetString(uint8_t* message, uint16_t currentIndex, uint16_t msgLen);
uint8_t* emberAfGetLongString(uint8_t* message, uint16_t currentIndex, uint16_t msgLen);
/*
 * @brief Extract a ZCL Date from the message buffer and returns it
 * in the given destination. Returns the number of bytes copied.
 */
uint8_t emberAfGetDate(uint8_t* message, uint16_t currentIndex, uint16_t msgLen, EmberAfDate *destination);

#define emberAfGetInt8u(message, currentIndex, msgLen) message[currentIndex]

#define emberAfCopyInt8u(data, index, x) (data[index] = (x))
void emberAfCopyInt16u(uint8_t *data, uint16_t index, uint16_t x);
void emberAfCopyInt24u(uint8_t *data, uint16_t index, uint32_t x);
void emberAfCopyInt32u(uint8_t *data, uint16_t index, uint32_t x);
/*
 * @brief Copy a ZCL string type into a buffer.  The size
 * parameter should indicate the maximum number of characters to copy to the
 * destination buffer not including the length byte.
 */
void emberAfCopyString(uint8_t *dest, uint8_t *src, uint8_t size);
/*
 * @brief Copy a ZCL long string into a buffer.  The size
 * parameter should indicate the maximum number of characters to copy to the
 * destination buffer not including the length bytes.
 */
void emberAfCopyLongString(uint8_t *dest, uint8_t *src, uint16_t size);
/*
 * @brief Determine the length of a Zigbee Cluster Library string
 *   (where the first byte is assumed to be the length).
 */
uint8_t emberAfStringLength(const uint8_t *buffer);
/*
 * @brief Determine the length of a Zigbee Cluster Library long string.
 *   (where the first two bytes are assumed to be the length).
 */
uint16_t emberAfLongStringLength(const uint8_t *buffer);

/*
 * @brief Determine the size of a Zigbee Cluster Library
 * attribute value.
 *
 * The attribute could be non-string, string, or long string. For strings,
 * the size includes the length of the string plus the number of the string's
 * length prefix byte(s).
 *
 * Additionally, checks that the resulting size does not exceed the
 * specified buffer size.
 *
 * @param dataType Zigbee data type
 * @param buffer pointer to a buffer containing a string value
 * @param bufferSize size of the buffer
 *
 * @return 0 if dataType is unrecognized or data size exceeds buffer size
 *.        nonzero for valid data size
 */
uint16_t emberAfAttributeValueSize(EmberAfAttributeType dataType,
                                   const uint8_t *buffer,
                                   const uint16_t bufferSize);
 // end of name API // end of attribute-storage

// @{

bool emberAfIsDeviceEnabled(uint8_t endpoint);

bool emberAfIsDeviceIdentifying(uint8_t endpoint);

void emberAfSetDeviceEnabled(uint8_t endpoint, bool enabled);
 // end of name API // end of device-control

// @{

void sl_zigbee_common_rtos_wakeup_stack_task(void);

bool emberAfEndpointEnableDisable(uint8_t endpoint, bool enable);

bool emberAfEndpointIndexIsEnabled(uint8_t index);

#define EMBER_AF_NEW_IMAGE_VERIFICATION true

#define EMBER_AF_CONTINUE_IMAGE_VERIFY  false

extern const EmberAfOtaImageId emberAfInvalidImageId;

bool emberAfIsThisDataTypeAStringType(EmberAfAttributeType dataType);

bool emberAfIsStringAttributeType(EmberAfAttributeType attributeType);

bool emberAfIsLongStringAttributeType(EmberAfAttributeType attributeType);

#define EMBER_AF_ZCL_SEQUENCE_MASK 0x7Fu

#define EMBER_AF_MESSAGE_TAG_MASK 0x7Fu

uint8_t emberAfNextSequence(void);

uint8_t emberAfGetLastSequenceNumber(void);

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

void emberAfGetEui64(EmberEUI64 returnEui64);

#ifdef EZSP_HOST
// Normally this is provided by the stack code, but on the host
// it is provided by the application code.
void emberReverseMemCopy(uint8_t* dest, const uint8_t* src, uint16_t length);
#endif // EZSP_HOST

EmberNodeId emberAfGetNodeId(void);

#if defined(DOXYGEN_SHOULD_SKIP_THIS) || defined(EZSP_HOST)
EmberStatus emberAfGenerateRandomKey(EmberKeyData *result);
#else
  #define emberAfGenerateRandomKey(result) emberGenerateRandomKey(result)
#endif

EmberPanId emberAfGetPanId(void);

uint8_t emberAfGetRadioChannel(void);

/*
 * @brief Return a binding index that matches the current incoming message, if
 * known.
 */
uint8_t emberAfGetBindingIndex(void);

/*
 * @brief Return an address index that matches the current incoming message,
 * if known.
 */
uint8_t emberAfGetAddressIndex(void);

EmberNetworkStatus emberAfNetworkState(void);

EmberStatus emberAfGetNetworkParameters(EmberNodeType *nodeType,
                                        EmberNetworkParameters *parameters);

EmberStatus emberAfGetNodeType(EmberNodeType *nodeType);

#define EMBER_AF_REJOIN_DUE_TO_END_DEVICE_MOVE            0xA0u
#define EMBER_AF_REJOIN_DUE_TO_TC_KEEPALIVE_FAILURE       0xA1u
#define EMBER_AF_REJOIN_DUE_TO_CLI_COMMAND                0xA2u
#define EMBER_AF_REJOIN_DUE_TO_WWAH_CONNECTIVITY_MANAGER  0xA3u

#define EMBER_AF_REJOIN_FIRST_REASON                EMBER_AF_REJOIN_DUE_TO_END_DEVICE_MOVE
#define EMBER_AF_REJOIN_LAST_REASON                 EMBER_AF_REJOIN_DUE_TO_END_DEVICE_MOVE

EmberStatus emberAfPermitJoin(uint8_t duration,
                              bool broadcastMgmtPermitJoin);

#ifdef DOXYGEN_SHOULD_SKIP_THIS
EmberStatus emberAfBroadcastPermitJoin(uint8_t duration);
#else
  #define emberAfBroadcastPermitJoin(duration) \
  emberAfPermitJoin((duration), true)
#endif
 // end of name API // end of miscellaneous

// @{

#define EMBER_AF_CLIENT_CLUSTER_TICK true

#define EMBER_AF_SERVER_CLUSTER_TICK false

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

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

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

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

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

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

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

EmberStatus sl_zigbee_zcl_deactivate_client_tick(uint8_t endpoint,
                                                 EmberAfClusterId clusterId);

EmberStatus sl_zigbee_zcl_deactivate_server_tick(uint8_t endpoint,
                                                 EmberAfClusterId clusterId);

#define emberAfGetCurrentSleepControl() \
  emberAfGetCurrentSleepControlCallback()

#define  emberAfSetDefaultSleepControl(x) \
  emberAfSetDefaultSleepControlCallback(x)

#define emberAfGetDefaultSleepControl() \
  emberAfGetDefaultSleepControlCallback()

#if !defined(DOXYGEN_SHOULD_SKIP_THIS)
#define emberAfAddToCurrentAppTasks(x) \
  emberAfAddToCurrentAppTasksCallback(x)

#define emberAfRemoveFromCurrentAppTasks(x) \
  emberAfRemoveFromCurrentAppTasksCallback(x)

#define emberAfCurrentAppTasks() emberAfGetCurrentAppTasksCallback()
#endif // !DOXYGEN_SHOULD_SKIP_THIS
 // end of name API // end of sleep-control

// @{

EmberStatus emberAfSendResponse(void);

EmberStatus emberAfSendResponseWithCallback(EmberAfMessageSentFunction callback);

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

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

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

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

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

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

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

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

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

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

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

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

EmberStatus emberAfSendCommandUnicastToBindings(void);

EmberStatus emberAfSendCommandUnicastToBindingsWithCallback(EmberAfMessageSentFunction callback);

EmberStatus emberAfSendCommandMulticast(EmberMulticastId multicastId);

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

EmberStatus emberAfSendCommandMulticastWithCallback(EmberMulticastId multicastId,
                                                    EmberAfMessageSentFunction callback);

EmberStatus emberAfSendCommandMulticastToBindings(void);
EmberStatus emberAfSendCommandUnicast(EmberOutgoingMessageType type,
                                      uint16_t indexOrDestination);

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

EmberStatus emberAfSendCommandBroadcast(EmberNodeId destination);

EmberStatus emberAfSendCommandBroadcastWithCallback(EmberNodeId destination,
                                                    EmberAfMessageSentFunction callback);

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

EmberStatus emberAfSendCommandBroadcastWithAlias(EmberNodeId destination,
                                                 EmberNodeId alias,
                                                 uint8_t sequence);
EmberStatus emberAfSendCommandInterPan(EmberPanId panId,
                                       const EmberEUI64 destinationLongId,
                                       EmberNodeId destinationShortId,
                                       EmberMulticastId multicastId,
                                       EmberAfProfileId profileId);

EmberStatus emberAfSendDefaultResponse(const EmberAfClusterCommand *cmd,
                                       EmberAfStatus status);

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

EmberStatus emberAfSendImmediateDefaultResponse(EmberAfStatus status);

EmberStatus emberAfSendImmediateDefaultResponseWithCallback(EmberAfStatus status,
                                                            EmberAfMessageSentFunction callback);

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

EmberApsFrame *emberAfGetCommandApsFrame(void);

void emberAfSetCommandEndpoints(uint8_t sourceEndpoint, uint8_t destinationEndpoint);

#define EMBER_AF_CLIENT_CLUSTER_DISCOVERY false

#define EMBER_AF_SERVER_CLUSTER_DISCOVERY true

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

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

EmberStatus emberAfFindIeeeAddress(EmberNodeId shortAddress,
                                   EmberAfServiceDiscoveryCallback *callback);

EmberStatus emberAfFindNodeId(EmberEUI64 longAddress,
                              EmberAfServiceDiscoveryCallback *callback);

EmberStatus emberAfFindActiveEndpoints(EmberNodeId target,
                                       EmberAfServiceDiscoveryCallback *callback);

uint8_t emberAfAddAddressTableEntry(EmberEUI64 longId, EmberNodeId shortId);

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

EmberStatus emberAfRemoveAddressTableEntry(uint8_t index);

#if !defined(DOXYGEN_SHOULD_SKIP_THIS)
#define emberAfCurrentCommand() (sli_zigbee_af_current_command)
extern EmberAfClusterCommand *sli_zigbee_af_current_command;
#endif

#define emberAfCurrentEndpoint() (emberAfCurrentCommand()->apsFrame->destinationEndpoint)

#ifdef DOXYGEN_SHOULD_SKIP_THIS
EmberStatus emberAfInitiateKeyEstablishment(EmberNodeId nodeId, uint8_t endpoint);

EmberStatus emberAfInitiateInterPanKeyEstablishment(EmberPanId panId,
                                                    const EmberEUI64 eui64);

bool emberAfPerformingKeyEstablishment(void);

EmberStatus emberAfInitiatePartnerLinkKeyExchange(EmberNodeId target,
                                                  uint8_t endpoint,
                                                  EmberAfPartnerLinkKeyExchangeCallback *callback);
#else
  #define emberAfInitiateKeyEstablishment(nodeId, endpoint) \
  emberAfInitiateKeyEstablishmentCallback(nodeId, endpoint)
  #define emberAfInitiateInterPanKeyEstablishment(panId, eui64) \
  emberAfInitiateInterPanKeyEstablishmentCallback(panId, eui64)
  #define emberAfPerformingKeyEstablishment() \
  emberAfPerformingKeyEstablishmentCallback()
  #define emberAfInitiatePartnerLinkKeyExchange(target, endpoint, callback) \
  emberAfInitiatePartnerLinkKeyExchangeCallback(target, endpoint, callback)
#endif

bool emberAfIsCurrentSecurityProfileSmartEnergy(void);
 // end of name API // end of messaging

// @{

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);
 // end of name API // end of zcl_commands

// Frame control fields (8 bits total)
// Bits 0 and 1 are Frame Type Sub-field
#define ZCL_FRAME_CONTROL_FRAME_TYPE_MASK     (BIT(0) | BIT(1))
#define ZCL_CLUSTER_SPECIFIC_COMMAND          BIT(0)
#define ZCL_PROFILE_WIDE_COMMAND              0u
#define ZCL_GLOBAL_COMMAND                    (ZCL_PROFILE_WIDE_COMMAND)
// Bit 2 is Manufacturer Specific Sub-field
#define ZCL_MANUFACTURER_SPECIFIC_MASK        BIT(2)
// Bit 3 is Direction Sub-field
#define ZCL_FRAME_CONTROL_DIRECTION_MASK      BIT(3)
#define ZCL_FRAME_CONTROL_SERVER_TO_CLIENT    BIT(3)
#define ZCL_FRAME_CONTROL_CLIENT_TO_SERVER    0u
// Bit 4 is Disable Default Response Sub-field
#define ZCL_DISABLE_DEFAULT_RESPONSE_MASK     BIT(4)
// Bits 5 to 7 are reserved

#define ZCL_DIRECTION_CLIENT_TO_SERVER 0u
#define ZCL_DIRECTION_SERVER_TO_CLIENT 1u

// Packet must be at least 3 bytes for ZCL overhead.
//   Frame Control (1-byte)
//   Sequence Number (1-byte)
//   Command Id (1-byte)
#define EMBER_AF_ZCL_OVERHEAD                       3
#define EMBER_AF_ZCL_MANUFACTURER_SPECIFIC_OVERHEAD 5

// Permitted values for emberAfSetFormAndJoinMode
#define FIND_AND_JOIN_MODE_ALLOW_2_4_GHZ        BIT(0)
#define FIND_AND_JOIN_MODE_ALLOW_SUB_GHZ        BIT(1)
#define FIND_AND_JOIN_MODE_ALLOW_BOTH           (FIND_AND_JOIN_MODE_ALLOW_2_4_GHZ | FIND_AND_JOIN_MODE_ALLOW_SUB_GHZ)
 // end of zcl-macros

// @{

EmberStatus emberAfFormNetwork(EmberNetworkParameters *parameters);

EmberStatus emberAfJoinNetwork(EmberNetworkParameters *parameters);

#ifdef DOXYGEN_SHOULD_SKIP_THIS
EmberStatus emberAfFindUnusedPanIdAndForm(void);
EmberStatus emberAfStartSearchForJoinableNetwork(void);
#else
  #define emberAfFindUnusedPanIdAndForm()        emberAfFindUnusedPanIdAndFormCallback()
  #define emberAfStartSearchForJoinableNetwork() emberAfStartSearchForJoinableNetworkCallback()
#endif

EmberStatus emberAfPushNetworkIndex(uint8_t networkIndex);
EmberStatus emberAfPushCallbackNetworkIndex(void);
EmberStatus emberAfPushEndpointNetworkIndex(uint8_t endpoint);
EmberStatus emberAfPopNetworkIndex(void);
uint8_t emberAfPrimaryEndpointForNetworkIndex(uint8_t networkIndex);
uint8_t emberAfPrimaryEndpointForCurrentNetworkIndex(void);

#if !defined(DOXYGEN_SHOULD_SKIP_THIS)
EmberStatus sli_zigbee_af_initializeNetworkIndexStack(void);
void sli_zigbee_af_assert_network_index_stack_is_empty(void);
#endif
 // end of API // end of network-utility-functions

#if !defined(DOXYGEN_SHOULD_SKIP_THIS)
  #if defined(EMBER_TEST)
    #define EMBER_TEST_ASSERT(x) assert(x)
  #else
    #define EMBER_TEST_ASSERT(x)
  #endif
#endif

// Note:  This is a #define for now but could be a real function call in the future.
#define emberAfMaxPowerLevel() (3)

#if !defined(DOXYGEN_SHOULD_SKIP_THIS)
// This macro used to be generated by AppBuilder, defining it disables legacy CLI commands.
// Legacy CLI is no longer supported and will eventually be cleaned up (see EMZIGBEE-868),
// until then define this statically.
#define EMBER_AF_GENERATE_CLI
#endif // !DOXYGEN_SHOULD_SKIP_THIS

#endif // SILABS_AF_API

API#

#define

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

#define

Return true if the attribute is read only.

#define

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

#define

Return true if the attribute is saved to a token.

#define

Return true if the attribute is saved in external storage.

#define

Return true if the attribute is a singleton.

#define

Return true if the attribute is manufacturer specific.

#define

Return the size of attribute in bytes.

#define

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

#define

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

#define

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

#define

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

#define

Return the primary profile ID.

#define

Return the primary endpoint.

#define
emberAfGetInt8u (message, currentIndex, msgLen)

Extract a single byte out of the message.

#define
emberAfCopyInt8u (data, index, x)

Copy a uint8_t from variable into buffer.

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

#define

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

#define

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

#define

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.

#define

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.

#define

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.

#define

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

#define

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

#define

Return the current endpoint that is being served.

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(uint8_t endpoint, EmberAfClusterId clusterId, EmberAfAttributeId attributeId, uint8_t mask, uint16_t manufacturerCode)

Locate attribute metadata.

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

Return true if the attribute exists.

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

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

bool
emberAfContainsCluster(uint8_t endpoint, EmberAfClusterId clusterId)

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

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

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

bool
emberAfContainsServer(uint8_t endpoint, EmberAfClusterId clusterId)

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

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

Return true if the endpoint contains the cluster client.

bool
emberAfContainsClient(uint8_t endpoint, EmberAfClusterId clusterId)

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

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

Write an attribute performing all checks.

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

Write a cluster server attribute.

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

Write a cluster client attribute.

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

Write a manufacturer-specific server attribute.

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

Write a manufacturer-specific client attribute.

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.

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.

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

Read the server attribute value performing all the checks.

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

Read the client attribute value, performing all the checks.

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.

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.

uint8_t
emberAfGetDataSize(uint8_t dataType)

Return the size of the ZCL data in bytes.

uint8_t

Return the number of seconds the network remains open.

uint8_t

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

uint8_t
emberAfIndexFromEndpoint(uint8_t endpoint)
uint8_t
emberAfFindClusterClientEndpointIndex(uint8_t endpoint, EmberAfClusterId clusterId)
uint8_t
emberAfFindClusterServerEndpointIndex(uint8_t endpoint, EmberAfClusterId clusterId)
uint8_t

Return the network index of a given endpoint.

uint8_t

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

uint8_t

Return the number of pre-compiled endpoints.

uint8_t

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

bool
emberAfIsTypeSigned(EmberAfAttributeType dataType)

Return true if type is signed, false otherwise.

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

Extract a 32-bit integer from the message buffer.

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

Extract a 24-bit integer from the message buffer.

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

Extract a 16-bit integer from the message buffer.

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

Extract a ZCL string from the message buffer.

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

Extract a ZCL long string from the message buffer.

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.

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

Copy a uint16_t value into a buffer.

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

Copy a uint24_t value into a buffer.

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

Copy a uint32_t value into a buffer.

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

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

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

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

uint8_t
emberAfStringLength(const uint8_t *buffer)

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

uint16_t
emberAfLongStringLength(const uint8_t *buffer)

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

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

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

bool
emberAfIsDeviceEnabled(uint8_t endpoint)

Check whether the endpoint is enabled.

bool
emberAfIsDeviceIdentifying(uint8_t endpoint)

Check whether the endpoint is identifying.

void
emberAfSetDeviceEnabled(uint8_t endpoint, bool enabled)

Enable or disable an endpoint.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

EmberStatus

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.

EmberStatus
emberAfSendResponseWithCallback(EmberAfMessageSentFunction callback)

Send ZCL response with attached message sent callback.

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

Send multicast.

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.

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.

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

Send multicast with attached message sent callback.

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

Send broadcast.

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

Send broadcast with attached message sent callback.

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.

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

Send unicast.

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

Send unicast with attached message sent callback.

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.

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

emberAfSendUnicastToBindings with attached message sent callback.

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

Send interpan message.

EmberStatus

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

EmberStatus
emberAfSendCommandUnicastToBindingsWithCallback(EmberAfMessageSentFunction callback)

emberAfSendCommandUnicastToBindings with attached message sent callback.

EmberStatus
emberAfSendCommandMulticast(EmberMulticastId multicastId)

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

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

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

EmberStatus
emberAfSendCommandMulticastWithCallback(EmberMulticastId multicastId, EmberAfMessageSentFunction callback)

emberAfSendCommandMulticast with attached message sent callback.

EmberStatus

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

EmberStatus
emberAfSendCommandUnicast(EmberOutgoingMessageType type, uint16_t indexOrDestination)

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

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

emberAfSendCommandUnicast with attached message sent callback.

EmberStatus
emberAfSendCommandBroadcast(EmberNodeId destination)

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

EmberStatus
emberAfSendCommandBroadcastWithCallback(EmberNodeId destination, EmberAfMessageSentFunction callback)

emberAfSendCommandBroadcast with attached message sent callback.

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

emberAfSendCommandBroadcast from alias with attached message sent callback.

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

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

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

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

EmberStatus
emberAfSendDefaultResponse(const EmberAfClusterCommand *cmd, EmberAfStatus status)

Send a default response to a cluster command.

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

emberAfSendDefaultResponse with attached message sent callback.

EmberStatus

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

EmberStatus
emberAfSendImmediateDefaultResponseWithCallback(EmberAfStatus status, EmberAfMessageSentFunction callback)

emberAfSendImmediateDefaultResponse with attached message sent callback.

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.

EmberApsFrame *

Access to client API APS frame.

void
emberAfSetCommandEndpoints(uint8_t sourceEndpoint, uint8_t destinationEndpoint)

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

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.

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.

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.

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

EmberStatus
emberAfFindActiveEndpoints(EmberNodeId target, EmberAfServiceDiscoveryCallback *callback)

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

uint8_t
emberAfAddAddressTableEntry(EmberEUI64 longId, EmberNodeId shortId)

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

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

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

EmberStatus

Remove a specific entry from the address table.

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.

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.

bool

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

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

Initiate partner link key exchange with a remote node.

bool

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(uint16_t cluster_id, uint16_t manufacturer_id, uint8_t direction, sl_service_function_t service_function)

Runtime subscription to specific incoming ZCL commands.

EmberStatus
emberAfFormNetwork(EmberNetworkParameters *parameters)

Form a new network using the specified network parameters.

EmberStatus
emberAfJoinNetwork(EmberNetworkParameters *parameters)

Associate with the network using the specified network parameters.

EmberStatus

Find an unused PAN ID and form a new network.

EmberStatus

Find a joinable network and join it.

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.

EmberStatus

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.

EmberStatus

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.

EmberStatus

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.

uint8_t

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

uint8_t

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

Macros#

#define
CONFIGURATION_HEADER "app/framework/util/config.h"
#define
MIN (a, b)
#define
ATTRIBUTE_MAX_DATA_SIZE MIN(ATTRIBUTE_LARGEST, 253)
#define
#define
#define
ZCL_GLOBAL_COMMAND (ZCL_PROFILE_WIDE_COMMAND)
#define
FIND_AND_JOIN_MODE_ALLOW_BOTH (FIND_AND_JOIN_MODE_ALLOW_2_4_GHZ | FIND_AND_JOIN_MODE_ALLOW_SUB_GHZ)
#define

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

Variables#

uint8_t

API Documentation#

emberAfClusterIsManufacturerSpecific#

#define emberAfClusterIsManufacturerSpecific
Value:
(cluster)

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


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

emberAfAttributeIsReadOnly#

#define emberAfAttributeIsReadOnly
Value:
(metadata)

Return true if the attribute is read only.


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

emberAfAttributeIsClient#

#define emberAfAttributeIsClient
Value:
(metadata)

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


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

emberAfAttributeIsTokenized#

#define emberAfAttributeIsTokenized
Value:
(metadata)

Return true if the attribute is saved to a token.


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

emberAfAttributeIsExternal#

#define emberAfAttributeIsExternal
Value:
(metadata)

Return true if the attribute is saved in external storage.


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

emberAfAttributeIsSingleton#

#define emberAfAttributeIsSingleton
Value:
(metadata)

Return true if the attribute is a singleton.


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

emberAfAttributeIsManufacturerSpecific#

#define emberAfAttributeIsManufacturerSpecific
Value:
(metadata)

Return true if the attribute is manufacturer specific.


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

emberAfAttributeSize#

#define emberAfAttributeSize
Value:
(metadata)

Return the size of attribute in bytes.


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

emberAfProfileIdFromIndex#

#define emberAfProfileIdFromIndex
Value:
(index)

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


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

emberAfDeviceIdFromIndex#

#define emberAfDeviceIdFromIndex
Value:
(index)

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


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

emberAfDeviceVersionFromIndex#

#define emberAfDeviceVersionFromIndex
Value:
(index)

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


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

emberAfNetworkIndexFromEndpointIndex#

#define emberAfNetworkIndexFromEndpointIndex
Value:
(index)

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


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

emberAfPrimaryProfileId#

#define emberAfPrimaryProfileId
Value:
()

Return the primary profile ID.

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


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

emberAfPrimaryEndpoint#

#define emberAfPrimaryEndpoint
Value:
()

Return the primary endpoint.


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

emberAfGetInt8u#

#define emberAfGetInt8u
Value:
(message, currentIndex, msgLen)

Extract a single byte out of the message.


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

emberAfCopyInt8u#

#define emberAfCopyInt8u
Value:
(data, index, x)

Copy a uint8_t from variable into buffer.


Definition at line 813 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 961 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 967 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 999 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 1005 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 1107 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 1108 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 1109 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 1110 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 1112 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 1113 of file app/framework/include/af.h

EMBER_AF_CLIENT_CLUSTER_TICK#

#define EMBER_AF_CLIENT_CLUSTER_TICK
Value:
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().


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

EMBER_AF_SERVER_CLUSTER_TICK#

#define EMBER_AF_SERVER_CLUSTER_TICK
Value:
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().


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

emberAfGetCurrentSleepControl#

#define emberAfGetCurrentSleepControl
Value:
()

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.


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

emberAfSetDefaultSleepControl#

#define emberAfSetDefaultSleepControl
Value:
(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.


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

emberAfGetDefaultSleepControl#

#define emberAfGetDefaultSleepControl
Value:
()

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.


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

EMBER_AF_CLIENT_CLUSTER_DISCOVERY#

#define EMBER_AF_CLIENT_CLUSTER_DISCOVERY
Value:
false

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


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

EMBER_AF_SERVER_CLUSTER_DISCOVERY#

#define EMBER_AF_SERVER_CLUSTER_DISCOVERY
Value:
true

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


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

emberAfCurrentEndpoint#

#define emberAfCurrentEndpoint
Value:
()

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.


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

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 975 of file app/framework/include/af.h

emberAfLocateAttributeMetadata#

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

Locate attribute metadata.

Parameters
N/Aendpoint

Zigbee endpoint number.

N/AclusterId

Cluster ID of the sought cluster.

N/AattributeId

Attribute ID of the sought attribute.

N/Amask

CLUSTER_MASK_SERVER or CLUSTER_MASK_CLIENT

N/AmanufacturerCode

Manufacturer code of the sough attribute.

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.


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

emberAfContainsAttribute#

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

Return true if the attribute exists.

Parameters
N/Aendpoint
N/AclusterId
N/AattributeId
N/Amask
N/AmanufacturerCode

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

emberAfContainsClusterWithMfgCode#

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

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

Parameters
N/Aendpoint

Zigbee endpoint number.

N/AclusterId

Cluster ID of the sought cluster.

N/AmanufacturerCode

Manufacturer code of the sought endpoint.

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


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

emberAfContainsCluster#

bool emberAfContainsCluster (uint8_t endpoint, EmberAfClusterId clusterId)

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

Parameters
N/Aendpoint

Zigbee endpoint number.

N/AclusterId

Cluster ID of the sought cluster.

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.


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

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.

Parameters
N/Aendpoint

Zigbee endpoint number.

N/AclusterId

Cluster ID of the sought cluster.

N/AmanufacturerCode

Manufacturer code of the sought cluster.

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


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

emberAfContainsServer#

bool emberAfContainsServer (uint8_t endpoint, EmberAfClusterId clusterId)

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

Parameters
N/Aendpoint

Zigbee endpoint number.

N/AclusterId

Cluster ID of the sought cluster.

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.


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

emberAfContainsClientWithMfgCode#

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

Return true if the endpoint contains the cluster client.

Parameters
N/Aendpoint

Zigbee endpoint number.

N/AclusterId

Cluster ID of the sought cluster.

N/AmanufacturerCode

Manufacturer code of the sought cluster.

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


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

emberAfContainsClient#

bool emberAfContainsClient (uint8_t endpoint, EmberAfClusterId clusterId)

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

Parameters
N/Aendpoint

Zigbee endpoint number.

N/AclusterId

Cluster ID of the sought cluster.

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.


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

emberAfWriteAttribute#

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

Write an attribute performing all checks.

Parameters
N/Aendpoint

Zigbee endpoint number.

N/Acluster

Cluster ID of the sought cluster.

N/AattributeID

Attribute ID of the sought attribute.

N/Amask

CLUSTER_MASK_SERVER or CLUSTER_MASK_CLIENT.

N/AdataPtr

Pointer to the ZCL attribute.

N/AdataType

ZCL attribute type.

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


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

emberAfWriteServerAttribute#

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

Write a cluster server attribute.

Parameters
N/Aendpoint

Zigbee endpoint number.

N/Acluster

Cluster ID of the sought cluster.

N/AattributeID

Attribute ID of the sought attribute.

N/AdataPtr

Pointer to the ZCL attribute.

N/AdataType

ZCL attribute type.

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


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

emberAfWriteClientAttribute#

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

Write a cluster client attribute.

Parameters
N/Aendpoint

Zigbee endpoint number.

N/Acluster

Cluster ID of the sought cluster.

N/AattributeID

Attribute ID of the sought attribute.

N/AdataPtr

Pointer to the ZCL attribute.

N/AdataType

ZCL attribute type.

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


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

emberAfWriteManufacturerSpecificServerAttribute#

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

Write a manufacturer-specific server attribute.

Parameters
N/Aendpoint

Zigbee endpoint number.

N/Acluster

Cluster ID of the sought cluster.

N/AattributeID

Attribute ID of the sought attribute.

N/AmanufacturerCode

Manufacturer code of the sought cluster.

N/AdataPtr

Pointer to the ZCL attribute.

N/AdataType

ZCL attribute type.

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


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

emberAfWriteManufacturerSpecificClientAttribute#

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

Write a manufacturer-specific client attribute.

Parameters
N/Aendpoint

Zigbee endpoint number.

N/Acluster

Cluster ID of the sought cluster.

N/AattributeID

Attribute ID of the sought attribute.

N/AmanufacturerCode

Manufacturer code of the sought cluster.

N/AdataPtr

Pointer to the ZCL attribute.

N/AdataType

ZCL attribute type.

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


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

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.

Parameters
N/Aendpoint

Zigbee endpoint number

N/Acluster

Cluster ID of the sought cluster.

N/AattributeID

Attribute ID of the sought attribute.

N/Amask

CLUSTER_MASK_SERVER or CLUSTER_MASK_CLIENT

N/AmanufacturerCode

Location where attribute will be written from.

N/AdataPtr

ZCL attribute type.

N/AdataType

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


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

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.

Parameters
N/Aendpoint

Zigbee endpoint number

N/Acluster

Cluster ID of the sought cluster.

N/AattributeID

Attribute ID of the sought attribute.

N/Amask

CLUSTER_MASK_SERVER or CLUSTER_MASK_CLIENT

N/AdataPtr

Pointer to the ZCL attribute.

N/AreadLength

Length of the attribute to be read.

N/AdataType

ZCL attribute type.

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


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

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.

Parameters
N/Aendpoint

Zigbee endpoint number

N/Acluster

Cluster ID of the sought cluster.

N/AattributeID

Attribute ID of the sought attribute.

N/AdataPtr

Pointer to the server attribute.

N/AreadLength

Length of the attribute to be read.

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


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

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.

Parameters
N/Aendpoint

Zigbee endpoint number

N/Acluster

Cluster ID of the sought cluster.

N/AattributeID

Attribute ID of the sought attribute.

N/AdataPtr

Pointer to the client attribute.

N/AreadLength

Length of the attribute to be read.

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


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

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.

Parameters
N/Aendpoint

Zigbee endpoint number

N/Acluster

Cluster ID of the sought cluster.

N/AattributeID

Attribute ID of the sought attribute.

N/AmanufacturerCode

Manufacturer code of the sought cluster.

N/AdataPtr

Pointer to the server attribute.

N/AreadLength

Length of the attribute to be read.

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


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

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.

Parameters
N/Aendpoint

Zigbee endpoint number

N/Acluster

Cluster ID of the sought cluster.

N/AattributeID

Attribute ID of the sought attribute.

N/AmanufacturerCode

Manufacturer code of the sought cluster.

N/AdataPtr

Pointer to the server attribute.

N/AreadLength

Length of the attribute to be read.

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


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

emberAfGetDataSize#

uint8_t emberAfGetDataSize (uint8_t dataType)

Return the size of the ZCL data in bytes.

Parameters
N/AdataType

ZCL data type

Returns

  • Size in bytes or 0 if invalid data type


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

emberAfGetOpenNetworkDurationSec#

uint8_t emberAfGetOpenNetworkDurationSec (void )

Return the number of seconds the network remains open.

Parameters
N/A

Returns

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


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

emberAfEndpointFromIndex#

uint8_t emberAfEndpointFromIndex (uint8_t index)

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

Parameters
N/Aindex

Index of an endpoint.

Returns

  • Zigbee endpoint.


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

emberAfIndexFromEndpoint#

uint8_t emberAfIndexFromEndpoint (uint8_t endpoint)
Parameters
N/Aendpoint

Zigbee endpoint.

Return the index of a given endpoint.

Returns

  • Index of a Zigbee endpoint.


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

emberAfIndexFromEndpointIncludingDisabledEndpoints#

uint8_t emberAfIndexFromEndpointIncludingDisabledEndpoints (uint8_t endpoint)
Parameters
N/Aendpoint

Zigbee endpoint.

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

Returns

  • Index of a Zigbee endpoint.


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

emberAfFindClusterClientEndpointIndex#

uint8_t emberAfFindClusterClientEndpointIndex (uint8_t endpoint, EmberAfClusterId clusterId)
Parameters
N/Aendpoint

Zigbee endpoint.

N/AclusterId

Cluster ID of a sought cluster.

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

Returns

  • Index of a Zigbee endpoint.


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

emberAfFindClusterServerEndpointIndex#

uint8_t emberAfFindClusterServerEndpointIndex (uint8_t endpoint, EmberAfClusterId clusterId)
Parameters
N/Aendpoint

Zigbee endpoint.

N/AclusterId

Cluster ID of a sought cluster.

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

Returns

  • Index of a Zigbee endpoint.


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

emberAfNetworkIndexFromEndpoint#

uint8_t emberAfNetworkIndexFromEndpoint (uint8_t endpoint)

Return the network index of a given endpoint.

Parameters
N/Aendpoint

Zigbee endpoint.

Returns

  • Network index of a Zigbee endpoint.


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

emberAfEndpointCount#

uint8_t emberAfEndpointCount (void )

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

Parameters
N/A

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

emberAfFixedEndpointCount#

uint8_t emberAfFixedEndpointCount (void )

Return the number of pre-compiled endpoints.

Parameters
N/A

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

emberAfGetAttributeAnalogOrDiscreteType#

uint8_t emberAfGetAttributeAnalogOrDiscreteType (uint8_t dataType)

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

Parameters
N/AdataType

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

emberAfIsTypeSigned#

bool emberAfIsTypeSigned (EmberAfAttributeType dataType)

Return true if type is signed, false otherwise.

Parameters
N/AdataType

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

emberAfGetInt32u#

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

Extract a 32-bit integer from the message buffer.

Parameters
N/Amessage
N/AcurrentIndex
N/AmsgLen

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

emberAfGetInt24u#

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

Extract a 24-bit integer from the message buffer.

Parameters
N/Amessage
N/AcurrentIndex
N/AmsgLen

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

emberAfGetInt16u#

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

Extract a 16-bit integer from the message buffer.

Parameters
N/Amessage
N/AcurrentIndex
N/AmsgLen

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

emberAfGetString#

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

Extract a ZCL string from the message buffer.

Parameters
N/Amessage
N/AcurrentIndex
N/AmsgLen

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

emberAfGetLongString#

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

Extract a ZCL long string from the message buffer.

Parameters
N/Amessage
N/AcurrentIndex
N/AmsgLen

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

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.

Parameters
N/Amessage

EmberAfCluster* to consider

N/AcurrentIndex
N/AmsgLen
N/Adestination

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

emberAfCopyInt16u#

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

Copy a uint16_t value into a buffer.

Parameters
N/Adata
N/Aindex
N/Ax

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

emberAfCopyInt24u#

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

Copy a uint24_t value into a buffer.

Parameters
N/Adata
N/Aindex
N/Ax

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

emberAfCopyInt32u#

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

Copy a uint32_t value into a buffer.

Parameters
N/Adata
N/Aindex
N/Ax

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

emberAfCopyString#

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

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

Parameters
N/Adest

EmberAfCluster* to consider

N/Asrc
N/Asize

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

emberAfCopyLongString#

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

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

Parameters
N/Adest

EmberAfCluster* to consider

N/Asrc
N/Asize

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

emberAfStringLength#

uint8_t emberAfStringLength (const uint8_t * buffer)

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

Parameters
N/Abuffer

EmberAfCluster* to consider


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

emberAfLongStringLength#

uint16_t emberAfLongStringLength (const uint8_t * buffer)

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

Parameters
N/Abuffer

EmberAfCluster* to consider


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

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.

Parameters
N/AdataType

EmberAfCluster* to consider

N/Abuffer
N/AbufferSize

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

emberAfIsDeviceEnabled#

bool emberAfIsDeviceEnabled (uint8_t endpoint)

Check whether the endpoint is enabled.

Parameters
N/Aendpoint

Zigbee endpoint number

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


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

emberAfIsDeviceIdentifying#

bool emberAfIsDeviceIdentifying (uint8_t endpoint)

Check whether the endpoint is identifying.

Parameters
N/Aendpoint

Zigbee endpoint number

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


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

emberAfSetDeviceEnabled#

void emberAfSetDeviceEnabled (uint8_t endpoint, bool enabled)

Enable or disable an endpoint.

Parameters
N/Aendpoint

Zigbee endpoint number

N/Aenabled

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


Definition at line 920 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 946 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 951 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 956 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 987 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 990 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 993 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 1018 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 1024 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 1039 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 1044 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 1055 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 1061 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 1069 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 1074 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 1080 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 1086 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 1092 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 1097 of file app/framework/include/af.h

emberAfGetNodeType#

EmberStatus emberAfGetNodeType (EmberNodeType * nodeType)

Return the current node type.

Parameters
N/AnodeType

Definition at line 1103 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 1128 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 1143 of file app/framework/include/af.h

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.

Parameters
N/Aendpoint

The endpoint of the event to be scheduled.

N/AclusterId

The cluster id of the event to be scheduled.

N/AisClient

EMBER_AF_CLIENT_CLUSTER_TICK if the event to be scheduled is associated with a client cluster or EMBER_AF_SERVER_CLUSTER_TICK otherwise.

N/AdelayMs

The number of milliseconds until the event should be called.

N/ApollControl

EMBER_AF_SHORT_POLL if the cluster needs to short poll or EMBER_AF_LONG_POLL otherwise.

N/AsleepControl

EMBER_AF_STAY_AWAKE if the cluster needs to stay awake or EMBER_AF_OK_TO_SLEEP otherwise.

Returns

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


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

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.

Parameters
N/Aendpoint

The endpoint of the event to be scheduled.

N/AclusterId

The cluster id of the event to be scheduled.

N/AisClient

EMBER_AF_CLIENT_CLUSTER_TICK if the event to be scheduled is associated with a client cluster or EMBER_AF_SERVER_CLUSTER_TICK otherwise.

N/AdelayMs

The number of milliseconds until the event should be called.

N/AsleepControl

the priority of the event, what the processor should be allowed to do in terms of sleeping while the event is active.

Returns

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


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

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.

Parameters
N/Aendpoint

The endpoint of the event to be scheduled

N/AclusterId

The cluster id of the event to be scheduled

N/AdelayMs

The number of milliseconds until the event should be called.

N/ApollControl

EMBER_AF_SHORT_POLL if the cluster needs to short poll or EMBER_AF_LONG_POLL otherwise.

N/AsleepControl

EMBER_AF_STAY_AWAKE if the cluster needs to stay awake or EMBER_AF_OK_TO_SLEEP otherwise.

Returns

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


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

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.

Parameters
N/Aendpoint

The endpoint of the event to be scheduled.

N/AclusterId

The cluster id of the event to be scheduled.

N/AdelayMs

The number of milliseconds until the event should be called.

Returns

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


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

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.

Parameters
N/Aendpoint

The endpoint of the event to be scheduled.

N/AclusterId

The cluster id of the event to be scheduled.

N/AdelayMs

The number of milliseconds until the event should be called.

N/ApollControl

EMBER_AF_SHORT_POLL if the cluster needs to short poll or EMBER_AF_LONG_POLL otherwise.

N/AsleepControl

EMBER_AF_STAY_AWAKE if the cluster needs to stay awake or EMBER_AF_OK_TO_SLEEP otherwise.

Returns

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


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

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.

Parameters
N/Aendpoint

The endpoint of the event to be scheduled

N/AclusterId

The cluster id of the event to be scheduled.

N/AdelayMs

The number of milliseconds until the event should be called.

Returns

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


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

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.

Parameters
N/Aendpoint

The endpoint of the event to be deactivated.

N/AclusterId

The cluster id of the event to be deactivated.

N/AisClient

EMBER_AF_CLIENT_CLUSTER_TICK if the event to be deactivated is a client cluster EMBER_AF_SERVER_CLUSTER_TICK otherwise.

Returns

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


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

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.

Parameters
N/Aendpoint

The endpoint of the event to be deactivated.

N/AclusterId

The cluster id of the event to be deactivated.

Returns

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


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

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.

Parameters
N/Aendpoint

The endpoint of the event to be deactivated.

N/AclusterId

The cluster ID of the event to be deactivated.

Returns

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


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

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.

Parameters
N/A

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


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

emberAfSendResponseWithCallback#

EmberStatus emberAfSendResponseWithCallback (EmberAfMessageSentFunction callback)

Send ZCL response with attached message sent callback.

Parameters
N/Acallback

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

emberAfSendMulticast#

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

Send multicast.

Parameters
N/AmulticastId
N/AapsFrame
N/AmessageLength
N/Amessage

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

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.

Parameters
N/AapsFrame
N/AmessageLength
N/Amessage

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

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.

Parameters
N/AmulticastId
N/AapsFrame
N/AmessageLength
N/Amessage
N/Aalias
N/Asequence
N/Acallback

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

emberAfSendMulticastWithCallback#

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

Send multicast with attached message sent callback.

Parameters
N/AmulticastId
N/AapsFrame
N/AmessageLength
N/Amessage
N/Acallback

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

emberAfSendBroadcast#

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

Send broadcast.

Parameters
N/Adestination
N/AapsFrame
N/AmessageLength
N/Amessage

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

emberAfSendBroadcastWithCallback#

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

Send broadcast with attached message sent callback.

Parameters
N/Adestination
N/AapsFrame
N/AmessageLength
N/Amessage
N/Acallback

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

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.

Parameters
N/Adestination
N/AapsFrame
N/AmessageLength
N/Amessage
N/Aalias
N/Asequence
N/Acallback

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

emberAfSendUnicast#

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

Send unicast.

Parameters
N/Atype
N/AindexOrDestination
N/AapsFrame
N/AmessageLength
N/Amessage

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

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.

Parameters
N/Atype
N/AindexOrDestination
N/AapsFrame
N/AmessageLength
N/Amessage
N/Acallback

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

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.

Parameters
N/AapsFrame
N/AmessageLength
N/Amessage

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

emberAfSendUnicastToBindingsWithCallback#

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

emberAfSendUnicastToBindings with attached message sent callback.

Parameters
N/AapsFrame
N/AmessageLength
N/Amessage
N/Acallback

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

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.

Parameters
N/ApanId
N/AdestinationLongId
N/AdestinationShortId
N/AmulticastId
N/AclusterId
N/AprofileId
N/AmessageLength
N/AmessageBytes

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

emberAfSendCommandUnicastToBindings#

EmberStatus emberAfSendCommandUnicastToBindings (void )

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

Parameters
N/A

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.


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

emberAfSendCommandUnicastToBindingsWithCallback#

EmberStatus emberAfSendCommandUnicastToBindingsWithCallback (EmberAfMessageSentFunction callback)

emberAfSendCommandUnicastToBindings with attached message sent callback.

Parameters
N/Acallback

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

emberAfSendCommandMulticast#

EmberStatus emberAfSendCommandMulticast (EmberMulticastId multicastId)

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

Parameters
N/AmulticastId

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.


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

emberAfSendCommandMulticastWithAlias#

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

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

Parameters
N/AmulticastId
N/Aalias
N/Asequence

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.


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

emberAfSendCommandMulticastWithCallback#

EmberStatus emberAfSendCommandMulticastWithCallback (EmberMulticastId multicastId, EmberAfMessageSentFunction callback)

emberAfSendCommandMulticast with attached message sent callback.

Parameters
N/AmulticastId
N/Acallback

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

emberAfSendCommandMulticastToBindings#

EmberStatus emberAfSendCommandMulticastToBindings (void )

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

Parameters
N/A

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.


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

emberAfSendCommandUnicast#

EmberStatus emberAfSendCommandUnicast (EmberOutgoingMessageType type, uint16_t indexOrDestination)

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

Parameters
N/Atype
N/AindexOrDestination

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.


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

emberAfSendCommandUnicastWithCallback#

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

emberAfSendCommandUnicast with attached message sent callback.

Parameters
N/Atype
N/AindexOrDestination
N/Acallback

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

emberAfSendCommandBroadcast#

EmberStatus emberAfSendCommandBroadcast (EmberNodeId destination)

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

Parameters
N/Adestination

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


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

emberAfSendCommandBroadcastWithCallback#

EmberStatus emberAfSendCommandBroadcastWithCallback (EmberNodeId destination, EmberAfMessageSentFunction callback)

emberAfSendCommandBroadcast with attached message sent callback.

Parameters
N/Adestination
N/Acallback

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

emberAfSendCommandBroadcastWithAliasWithCallback#

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

emberAfSendCommandBroadcast from alias with attached message sent callback.

Parameters
N/Adestination
N/Aalias
N/Asequence
N/Acallback

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

emberAfSendCommandBroadcastWithAlias#

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

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

Parameters
N/Adestination
N/Aalias
N/Asequence

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


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

emberAfSendCommandInterPan#

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

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

Parameters
N/ApanId
N/AdestinationLongId
N/AdestinationShortId
N/AmulticastId
N/AprofileId

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.


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

emberAfSendDefaultResponse#

EmberStatus emberAfSendDefaultResponse (const EmberAfClusterCommand * cmd, EmberAfStatus status)

Send a default response to a cluster command.

Parameters
N/Acmd

The cluster command to which to respond.

N/Astatus

Status code for the default response 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.


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

emberAfSendDefaultResponseWithCallback#

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

emberAfSendDefaultResponse with attached message sent callback.

Parameters
N/Acmd
N/Astatus
N/Acallback

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

emberAfSendImmediateDefaultResponse#

EmberStatus emberAfSendImmediateDefaultResponse (EmberAfStatus status)

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

Parameters
N/Astatus

Status code for the default response 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.


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

emberAfSendImmediateDefaultResponseWithCallback#

EmberStatus emberAfSendImmediateDefaultResponseWithCallback (EmberAfStatus status, EmberAfMessageSentFunction callback)

emberAfSendImmediateDefaultResponse with attached message sent callback.

Parameters
N/Astatus
N/Acallback

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

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.

Parameters
N/Atype

The outgoing message type.

N/AindexOrDestination

Depending on the message type, this is either the EmberNodeId of the destination, an index into the address table, an index into the binding table, the multicast identifier, or a broadcast address.

N/AapsFrame

The APS frame for the message.

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.


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

emberAfGetCommandApsFrame#

EmberApsFrame * emberAfGetCommandApsFrame (void )

Access to client API APS frame.

Parameters
N/A

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

emberAfSetCommandEndpoints#

void emberAfSetCommandEndpoints (uint8_t sourceEndpoint, uint8_t destinationEndpoint)

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

Parameters
N/AsourceEndpoint
N/AdestinationEndpoint

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

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.

Parameters
N/Atarget

The destination node ID for the discovery; either a specific node's ID or EMBER_RX_ON_WHEN_IDLE_BROADCAST_ADDRESS.

N/AprofileId

The application profile for the cluster being discovered.

N/AclusterId

The cluster being discovered.

N/AserverCluster

EMBER_AF_SERVER_CLUSTER_DISCOVERY (true) if discovering servers for the target cluster; EMBER_AF_CLIENT_CLUSTER_DISCOVERY (false) if discovering clients for that cluster.

N/Acallback

Function pointer for the callback function triggered when a match is discovered. (For broadcast discoveries, this is called once per matching node, even if a node has multiple matching endpoints.)

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.


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

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.

Parameters
N/Atarget

The destination node ID for the discovery. This should be a specific node's ID and should not be a broadcast address.

N/AtargetEndpoint

The endpoint to target with the discovery process.

N/Acallback

Function pointer for the callback function triggered when the discovery is returned.

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


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

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.

Parameters
N/AshortAddress
N/Acallback

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

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

Parameters
N/AlongAddress
N/Acallback

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

emberAfFindActiveEndpoints#

EmberStatus emberAfFindActiveEndpoints (EmberNodeId target, EmberAfServiceDiscoveryCallback * callback)

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

Parameters
N/Atarget
N/Acallback

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

emberAfAddAddressTableEntry#

uint8_t emberAfAddAddressTableEntry (EmberEUI64 longId, EmberNodeId shortId)

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

Parameters
N/AlongId

The EUI64 of the remote device.

N/AshortId

The node ID of the remote device or ::EMBER_UNKNOWN_NODE_ID if the node ID is currently unknown.

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


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

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.

Parameters
N/Aindex

The index of the address table entry.

N/AlongId

The EUI64 of the remote device.

N/AshortId

The node id of the remote device or ::EMBER_UNKNOWN_NODE_ID if the node id is currently unknown.

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.


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

emberAfRemoveAddressTableEntry#

EmberStatus emberAfRemoveAddressTableEntry (uint8_t index)

Remove a specific entry from the address table.

Parameters
N/Aindex

The index of the address table entry.

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.


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

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.

Parameters
N/AnodeId

The node ID of the remote device.

N/Aendpoint

The endpoint on the remote device.

Returns

  • ::EMBER_SUCCESS if key establishment was initiated successfully


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

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.

Parameters
N/ApanId

The PAN ID of the remote device.

N/Aeui64

The EUI64 of the remote device.

Returns

  • ::EMBER_SUCCESS if key establishment was initiated successfully


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

emberAfPerformingKeyEstablishment#

bool emberAfPerformingKeyEstablishment (void )

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

Parameters
N/A

Returns

  • ::true if key establishment is in progress.


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

emberAfInitiatePartnerLinkKeyExchange#

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

Initiate partner link key exchange with a remote node.

Parameters
N/Atarget

The node ID of the remote device.

N/Aendpoint

The key establishment endpoint of the remote device.

N/Acallback

The callback that should be called when the partner link key exchange completes.

Returns

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


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

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.

Parameters
N/A

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

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.

Parameters
N/Acluster_id

The cluster ID of the ZCL messages to subscribe to.

N/Amanufacturer_id

The manufacturer ID if any. If not set, a value of 0xFFFF should be passed in.

N/Adirection

A value of ZCL_DIRECTION_CLIENT_TO_SERVER or ZCL_DIRECTION_SERVER_TO_CLIENT specifying the side (client or server) of the ZCL messages to subscribe to.

N/Aservice_function

A sl_service_function_t function pointer specifying the function to be invoked when an incoming ZCL command matches the criteria specified in this API.

Returns


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

emberAfFormNetwork#

EmberStatus emberAfFormNetwork (EmberNetworkParameters * parameters)

Form a new network using the specified network parameters.

Parameters
N/Aparameters

Specification of the new network.

Returns

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


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

emberAfJoinNetwork#

EmberStatus emberAfJoinNetwork (EmberNetworkParameters * parameters)

Associate with the network using the specified network parameters.

Parameters
N/Aparameters

Specification of the network with which the node should associate.

Returns

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


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

emberAfFindUnusedPanIdAndForm#

EmberStatus emberAfFindUnusedPanIdAndForm (void )

Find an unused PAN ID and form a new network.

Parameters
N/A

Returns

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


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

emberAfStartSearchForJoinableNetwork#

EmberStatus emberAfStartSearchForJoinableNetwork (void )

Find a joinable network and join it.

Parameters
N/A

Returns

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


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

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.

Parameters
N/AnetworkIndex

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

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.

Parameters
N/A

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

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.

Parameters
N/Aendpoint

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

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.

Parameters
N/A

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

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.

Parameters
N/AnetworkIndex

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

emberAfPrimaryEndpointForCurrentNetworkIndex#

uint8_t emberAfPrimaryEndpointForCurrentNetworkIndex (void )

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

Parameters
N/A

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

Macro Definition Documentation#

CONFIGURATION_HEADER#

#define CONFIGURATION_HEADER
Value:
"app/framework/util/config.h"

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

MIN#

#define MIN
Value:
(a, b)

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

ATTRIBUTE_MAX_DATA_SIZE#

#define ATTRIBUTE_MAX_DATA_SIZE
Value:
MIN(ATTRIBUTE_LARGEST, 253)

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

SL_CLI_COMMAND_ARG#

#define SL_CLI_COMMAND_ARG
Value:
void

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

ZCL_FRAME_CONTROL_FRAME_TYPE_MASK#

#define ZCL_FRAME_CONTROL_FRAME_TYPE_MASK
Value:
(BIT(0) | BIT(1))

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

ZCL_CLUSTER_SPECIFIC_COMMAND#

#define ZCL_CLUSTER_SPECIFIC_COMMAND
Value:
BIT(0)

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

ZCL_PROFILE_WIDE_COMMAND#

#define ZCL_PROFILE_WIDE_COMMAND
Value:
0u

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

ZCL_GLOBAL_COMMAND#

#define ZCL_GLOBAL_COMMAND
Value:
(ZCL_PROFILE_WIDE_COMMAND)

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

ZCL_MANUFACTURER_SPECIFIC_MASK#

#define ZCL_MANUFACTURER_SPECIFIC_MASK
Value:
BIT(2)

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

ZCL_FRAME_CONTROL_DIRECTION_MASK#

#define ZCL_FRAME_CONTROL_DIRECTION_MASK
Value:
BIT(3)

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

ZCL_FRAME_CONTROL_SERVER_TO_CLIENT#

#define ZCL_FRAME_CONTROL_SERVER_TO_CLIENT
Value:
BIT(3)

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

ZCL_FRAME_CONTROL_CLIENT_TO_SERVER#

#define ZCL_FRAME_CONTROL_CLIENT_TO_SERVER
Value:
0u

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

ZCL_DISABLE_DEFAULT_RESPONSE_MASK#

#define ZCL_DISABLE_DEFAULT_RESPONSE_MASK
Value:
BIT(4)

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

ZCL_DIRECTION_CLIENT_TO_SERVER#

#define ZCL_DIRECTION_CLIENT_TO_SERVER
Value:
0u

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

ZCL_DIRECTION_SERVER_TO_CLIENT#

#define ZCL_DIRECTION_SERVER_TO_CLIENT
Value:
1u

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

EMBER_AF_ZCL_OVERHEAD#

#define EMBER_AF_ZCL_OVERHEAD
Value:
3

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

EMBER_AF_ZCL_MANUFACTURER_SPECIFIC_OVERHEAD#

#define EMBER_AF_ZCL_MANUFACTURER_SPECIFIC_OVERHEAD
Value:
5

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

FIND_AND_JOIN_MODE_ALLOW_2_4_GHZ#

#define FIND_AND_JOIN_MODE_ALLOW_2_4_GHZ
Value:
BIT(0)

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

FIND_AND_JOIN_MODE_ALLOW_SUB_GHZ#

#define FIND_AND_JOIN_MODE_ALLOW_SUB_GHZ
Value:
BIT(1)

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

FIND_AND_JOIN_MODE_ALLOW_BOTH#

#define FIND_AND_JOIN_MODE_ALLOW_BOTH
Value:
(FIND_AND_JOIN_MODE_ALLOW_2_4_GHZ | FIND_AND_JOIN_MODE_ALLOW_SUB_GHZ)

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

emberAfMaxPowerLevel#

#define emberAfMaxPowerLevel
Value:
()

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


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

Variable Documentation#

ascii_lut#

uint8_t ascii_lut[]

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