Application Framework Types Reference#

EmberAfSecurityProfile#

EmberAfSecurityProfile

EmberAfServiceDiscoveryStatus#

EmberAfServiceDiscoveryStatus

This is an enum used to indicate the result of the service discovery. Unicast discoveries are completed as soon as a response is received. Broadcast discoveries wait a period of time for multiple responses to be received.

EmberAfEventPollControl#

EmberAfEventPollControl

This is an enum used to control how the device will poll for a given active cluster-related event. When the event is scheduled, the application can pass a poll control value which will be stored along with the event. The processor is only allowed to poll according to the most restrictive value for all active event. For instance, if two events are active, one with EMBER_AF_LONG_POLL and the other with EMBER_AF_SHORT_POLL, then the processor will short poll until the second event is deactivated.

EmberAfEventSleepControl#

EmberAfEventSleepControl

This is an enum used to control how the device will sleep for a given active cluster related event. When the event is scheduled, the scheduling code can pass a sleep control value which will be stored along with the event. The processor is only allowed to sleep according to the most restrictive sleep control value for any active event. For instance, if two events are active, one with EMBER_AF_OK_TO_HIBERNATE and the other with EMBER_AF_OK_TO_NAP, then the processor will only be allowed to nap until the second event is deactivated.

EmberAfApplicationTask#

EmberAfApplicationTask

An enum used to track the tasks that the Application framework cares about. These are intended to be tasks that should keep the device out of hibernation like an application level request / response. If the response does not come in as a data ack, then the application will need to stay out of hibernation to wait and poll for it.

Of course some tasks do not necessarily have a response. For instance, a ZDO request may or may not have a response. In this case, the application framework cannot rely on the fact that a response will come in to end the wake cycle, so the Application framework must timeout the wake cycle if no expected response is received or no other event can be relied upon to end the wake cycle.

Tasks of this type should be added to the wake timeout mask by calling emberAfSetWakeTimeoutBitmaskCallback so that they can be governed by a timeout instead of a request / response

the current tasks bitmask is an uint32_t bitmask used to track which tasks are active at any given time. The bottom 16 bits, values 0x01 - 0x8000 are reserved for Ember's use. The top 16 bits are reserved for the customer, values 0x10000 - 0x80000000

EmberAfPluginPriceCppAuth#

EmberAfPluginPriceCppAuth

Specifies CPP Authorization values.

EmberAfPluginTunnelingClientStatus#

EmberAfPluginTunnelingClientStatus

@0#

@0

The list of options possible for the image block request/response.

EmberAfOtaStorageStatus#

EmberAfOtaStorageStatus

This status contains the success or error code of an OTA storage device operation.

@1#

@1

This status contains the success or error code of an OTA download operation.

EmberAfKeyEstablishmentNotifyMessage#

EmberAfKeyEstablishmentNotifyMessage

EmberAfImageVerifyStatus#

EmberAfImageVerifyStatus

This enumeration is used to indicate the state of an OTA bootload image undergoing verification. This is used both for cryptographic verification and manufacturer specific verification.

EmberAfCbkeKeyEstablishmentSuite#

EmberAfCbkeKeyEstablishmentSuite

CBKE Library types.

EmberAfDeviceManagementPasswordType#

EmberAfDeviceManagementPasswordType

EmberAfDeviceManagementChangePendingFlags#

EmberAfDeviceManagementChangePendingFlags

EmberAfDeviceDiscoveryStatus#

EmberAfDeviceDiscoveryStatus

EmberAfProfileId#

typedef uint16_t EmberAfProfileId

Type for referring to zigbee application profile id.

EmberAfAttributeId#

typedef uint16_t EmberAfAttributeId

Type for referring to ZCL attribute id.

EmberAfClusterId#

typedef uint16_t EmberAfClusterId

Type for referring to ZCL cluster id.

EmberAfAttributeType#

typedef uint8_t EmberAfAttributeType

Type for referring to ZCL attribute type.

EmberAfClusterMask#

typedef uint8_t EmberAfClusterMask

Type for the cluster mask.

EmberAfAttributeMask#

typedef uint8_t EmberAfAttributeMask

Type for the attribute mask.

EmberAfGenericClusterFunction#

typedef void(* EmberAfGenericClusterFunction) (void) )(void)

Generic function type, used for either of the cluster function.

This type is used for the array of the cluster functions, and should always be cast into one of the specific functions before being called.

EmberAfDifferenceType#

typedef uint32_t EmberAfDifferenceType

This type is used to compare two ZCL attribute values. The size of this data type depends on the platform.

EmberAfInterpanMessageType#

typedef uint8_t EmberAfInterpanMessageType

Interpan Message type: unicast, broadcast, or multicast.

EmberAfInterpanOptions#

typedef uint16_t EmberAfInterpanOptions

The options for sending/receiving interpan messages.

EmberAfAllowedInterpanOptions#

typedef uint8_t EmberAfAllowedInterpanOptions

The options for what interpan messages are allowed.

EmberAfTcLinkKeyRequestPolicy#

typedef EmberTcLinkKeyRequestPolicy EmberAfTcLinkKeyRequestPolicy

EmberAfAppLinkKeyRequestPolicy#

typedef EmberAppLinkKeyRequestPolicy EmberAfAppLinkKeyRequestPolicy

EmberAfPluginEsiManagementBitmask#

typedef uint8_t EmberAfPluginEsiManagementBitmask

Bitmask data type for storing one bit of information for each ESI in the ESI table.

EmberAfServiceDiscoveryCallback#

typedef void() EmberAfServiceDiscoveryCallback(const EmberAfServiceDiscoveryResult *result) (const EmberAfServiceDiscoveryResult *result)

This defines a callback where a code element or cluster can be informed as to the result of a service discovery they have requested. For each match, the callback is fired with all the resulting matches from that source. If the discovery was unicast to a specific device, then the callback will only be fired once with either MATCH_FOUND or COMPLETE (no matches found). If the discovery is broadcast then multiple callbacks may be fired with EMBER_AF_BROADCAST_SERVICE_DISCOVERY_RESPONSE_RECEIVED. After a couple seconds the callback will then be fired with EMBER_AF_BROADCAST_SERVICE_DISCOVERY_COMPLETE_WITH_RESPONSE or EMBER_AF_BROADCAST_SERVICE_DISCOVERY_COMPLETE_WITH_EMPTY_RESPONSE as the result.

EmberAfPartnerLinkKeyExchangeCallback#

typedef void() EmberAfPartnerLinkKeyExchangeCallback(bool success) (bool success)

This defines a callback where a code element or cluster can be informed as to the result of a request to initiate a partner link key exchange. The callback will be triggered with success equal to true if the exchange completed successfully.

EmberAfNetworkEventHandler#

typedef void(* EmberAfNetworkEventHandler) (void) )(void)

Type for referring to the handler for network events.

EmberAfEndpointEventHandler#

typedef void(* EmberAfEndpointEventHandler) (uint8_t endpoint) )(uint8_t endpoint)

Type for referring to the handler for endpoint events.

EmberAfImageBlockRequestOptions#

typedef uint8_t EmberAfImageBlockRequestOptions

EmberAfOtaDownloadResult#

typedef uint8_t EmberAfOtaDownloadResult

EmberAfTickFunction#

typedef void(* EmberAfTickFunction) (uint8_t endpoint) )(uint8_t endpoint)

Type for referring to the tick callback for cluster.

Tick function will be called once for each tick for each endpoint in the cluster. The rate of tick is determined by the metadata of the cluster.

EmberAfInitFunction#

typedef void(* EmberAfInitFunction) (uint8_t endpoint) )(uint8_t endpoint)

Type for referring to the init callback for cluster.

Init function is called when the application starts up, once for each cluster/endpoint combination.

EmberAfClusterAttributeChangedCallback#

typedef void(* EmberAfClusterAttributeChangedCallback) (uint8_t endpoint, EmberAfAttributeId attributeId) )(uint8_t endpoint, EmberAfAttributeId attributeId)

Type for referring to the attribute changed callback function.

This function is called just after an attribute changes.

EmberAfManufacturerSpecificClusterAttributeChangedCallback#

typedef void(* EmberAfManufacturerSpecificClusterAttributeChangedCallback) (uint8_t endpoint, EmberAfAttributeId attributeId, uint16_t manufacturerCode) )(uint8_t endpoint, EmberAfAttributeId attributeId, uint16_t manufacturerCode)

Type for referring to the manufacturer specific attribute changed callback function.

This function is called just after a manufacturer specific attribute changes.

EmberAfClusterPreAttributeChangedCallback#

typedef EmberAfStatus(* EmberAfClusterPreAttributeChangedCallback) (uint8_t endpoint, EmberAfAttributeId attributeId, EmberAfAttributeType attributeType, uint8_t size, uint8_t *value) )(uint8_t endpoint, EmberAfAttributeId attributeId, EmberAfAttributeType attributeType, uint8_t size, uint8_t *value)

Type for referring to the pre-attribute changed callback function.

This function is called before an attribute changes.

EmberAfDefaultResponseFunction#

typedef void(* EmberAfDefaultResponseFunction) (uint8_t endpoint, uint8_t commandId, EmberAfStatus status) )(uint8_t endpoint, uint8_t commandId, EmberAfStatus status)

Type for referring to the default response callback function.

This function is called when default response is received, before the global callback. Global callback is called immediately afterwards.

EmberAfMessageSentFunction#

typedef void(* EmberAfMessageSentFunction) (EmberOutgoingMessageType type, uint16_t indexOrDestination, EmberApsFrame *apsFrame, uint16_t msgLen, uint8_t *message, EmberStatus status) )(EmberOutgoingMessageType type, uint16_t indexOrDestination, EmberApsFrame *apsFrame, uint16_t msgLen, uint8_t *message, EmberStatus status)

Type for referring to the message sent callback function.

This function is called when a message is sent.

EmberAfRemoteClusterType#

typedef uint16_t EmberAfRemoteClusterType

Zigbee Internet Client/Server Remote Cluster Types.