Messaging#
API for the Messaging functionality in the Application Framework.
Messaging description.
This group describes the CLI commands for the Messaging cluster. Listed below is a description of the cluster: This cluster provides an interface for passing text messages between SE devices.
API#
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.
Send ZCL response with attached message sent callback.
Send multicast.
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.
Send Multicast with alias with attached message sent callback.
Send multicast with attached message sent callback.
Send broadcast.
Send broadcast with attached message sent callback.
Send broadcast with alias with attached message sent callback.
Send unicast.
Send unicast with attached message sent callback.
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.
emberAfSendUnicastToBindings with attached message sent callback.
Send interpan message.
Send end device binding request.
Send the command prepared with emberAfFill.... macro.
emberAfSendCommandUnicastToBindings with attached message sent callback.
Send the command prepared with emberAfFill.... macro.
Send the command prepared with emberAfFill.... macro.
emberAfSendCommandMulticast with attached message sent callback.
Send the command prepared with emberAfFill.... macro.
Send the command prepared with emberAfFill.... macro.
emberAfSendCommandUnicast with attached message sent callback.
Send the command prepared with emberAfFill.... macro.
emberAfSendCommandBroadcast with attached message sent callback.
emberAfSendCommandBroadcast from alias with attached message sent callback.
Send the command prepared with emberAfFill.... macro.
Send the command prepared with emberAfFill.... macro.
Send a default response to a cluster command.
emberAfSendDefaultResponse with attached message sent callback.
Send a default response to a cluster command using the current command.
emberAfSendImmediateDefaultResponse with attached message sent callback.
Return the maximum size of the payload that the Application Support sub-layer will accept for the given message type, destination, and APS frame.
Access to client API APS frame.
Set the source and destination endpoints in the client API APS frame.
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.
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.
Initiate a discovery for the IEEE address of the specified node ID. This will send a unicast sent to the target node ID.
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).
Initiate an Active Endpoint request ZDO message to the target node ID.
Add an entry for a remote device to the address table.
Add an entry for a remote device to the address table at a specific location.
Remove a specific entry from the address table.
Initiate key establishment with a remote node. emberAfKeyEstablishmentCallback will be called as events occur and when key establishment completes.
Initiate key establishment with a remote node on a different PAN. emberAfInterPanKeyEstablishmentCallback will be called as events occur and when key establishment completes.
Indicate whether the device is in the process of performing key establishment.
Initiate partner link key exchange with a remote node.
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.
Friendly define for use in discovering client clusters with emberAfFindDevicesByProfileAndCluster().
Friendly define for use in discovering server clusters with emberAfFindDevicesByProfileAndCluster().
Return the current endpoint that is being served.
Macros#
zcl msg disp [messageId:4] [messageControl:1] [startTime:4] [durationInMinutes:2] [message:-1] [optionalExtendedMessageControl:1]
zcl msg cancel [messageId:4] [messageControl:1]
zcl msg disp-protd [messageId:4] [messageControl:1] [startTime:4] [durationInMinutes:2] [message:-1] [optionalExtendedMessageControl:1]
zcl msg x-all [implementationDateTime:4]
zcl msg get
zcl msg confirm [messageId:4] [confirmationTime:4] [messageConfirmationControl:1] [messageResponse:-1]
zcl msg get-msg-x [earliestImplementationTime:4]
API Documentation#
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.
N/A |
NOTE: This will overwrite the ZCL sequence number of the message to use the LAST received sequence number.
1424
of file app/framework/include/af.h
emberAfSendResponseWithCallback#
EmberStatus emberAfSendResponseWithCallback (EmberAfMessageSentFunction callback)
Send ZCL response with attached message sent callback.
N/A | callback |
1429
of file app/framework/include/af.h
emberAfSendMulticast#
EmberStatus emberAfSendMulticast (EmberMulticastId multicastId, EmberApsFrame * apsFrame, uint16_t messageLength, uint8_t * message)
Send multicast.
N/A | multicastId | |
N/A | apsFrame | |
N/A | messageLength | |
N/A | message |
1434
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.
N/A | apsFrame | |
N/A | messageLength | |
N/A | message |
1446
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.
N/A | multicastId | |
N/A | apsFrame | |
N/A | messageLength | |
N/A | message | |
N/A | alias | |
N/A | sequence | |
N/A | callback |
1453
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.
N/A | multicastId | |
N/A | apsFrame | |
N/A | messageLength | |
N/A | message | |
N/A | callback |
1464
of file app/framework/include/af.h
emberAfSendBroadcast#
EmberStatus emberAfSendBroadcast (EmberNodeId destination, EmberApsFrame * apsFrame, uint16_t messageLength, uint8_t * message)
Send broadcast.
N/A | destination | |
N/A | apsFrame | |
N/A | messageLength | |
N/A | message |
1473
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.
N/A | destination | |
N/A | apsFrame | |
N/A | messageLength | |
N/A | message | |
N/A | callback |
1481
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.
N/A | destination | |
N/A | apsFrame | |
N/A | messageLength | |
N/A | message | |
N/A | alias | |
N/A | sequence | |
N/A | callback |
1490
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.
N/A | type | |
N/A | indexOrDestination | |
N/A | apsFrame | |
N/A | messageLength | |
N/A | message |
1501
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.
N/A | type | |
N/A | indexOrDestination | |
N/A | apsFrame | |
N/A | messageLength | |
N/A | message | |
N/A | callback |
1510
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.
N/A | apsFrame | |
N/A | messageLength | |
N/A | message |
1523
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.
N/A | apsFrame | |
N/A | messageLength | |
N/A | message | |
N/A | callback |
1530
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.
N/A | panId | |
N/A | destinationLongId | |
N/A | destinationShortId | |
N/A | multicastId | |
N/A | clusterId | |
N/A | profileId | |
N/A | messageLength | |
N/A | messageBytes |
1538
of file app/framework/include/af.h
emberAfSendEndDeviceBind#
EmberStatus emberAfSendEndDeviceBind (uint8_t endpoint)
Send end device binding request.
N/A | endpoint |
1550
of file app/framework/include/af.h
emberAfSendCommandUnicastToBindings#
EmberStatus emberAfSendCommandUnicastToBindings (void )
Send the command prepared with emberAfFill.... macro.
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.
1562
of file app/framework/include/af.h
emberAfSendCommandUnicastToBindingsWithCallback#
EmberStatus emberAfSendCommandUnicastToBindingsWithCallback (EmberAfMessageSentFunction callback)
emberAfSendCommandUnicastToBindings with attached message sent callback.
N/A | callback |
1567
of file app/framework/include/af.h
emberAfSendCommandMulticast#
EmberStatus emberAfSendCommandMulticast (EmberMulticastId multicastId)
Send the command prepared with emberAfFill.... macro.
N/A | multicastId |
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.
1576
of file app/framework/include/af.h
emberAfSendCommandMulticastWithAlias#
EmberStatus emberAfSendCommandMulticastWithAlias (EmberMulticastId multicastId, EmberNodeId alias, uint8_t sequence)
Send the command prepared with emberAfFill.... macro.
N/A | multicastId | |
N/A | alias | |
N/A | sequence |
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.
1585
of file app/framework/include/af.h
emberAfSendCommandMulticastWithCallback#
EmberStatus emberAfSendCommandMulticastWithCallback (EmberMulticastId multicastId, EmberAfMessageSentFunction callback)
emberAfSendCommandMulticast with attached message sent callback.
N/A | multicastId | |
N/A | callback |
1590
of file app/framework/include/af.h
emberAfSendCommandMulticastToBindings#
EmberStatus emberAfSendCommandMulticastToBindings (void )
Send the command prepared with emberAfFill.... macro.
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.
1603
of file app/framework/include/af.h
emberAfSendCommandUnicast#
EmberStatus emberAfSendCommandUnicast (EmberOutgoingMessageType type, uint16_t indexOrDestination)
Send the command prepared with emberAfFill.... macro.
N/A | type | |
N/A | indexOrDestination |
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.
1611
of file app/framework/include/af.h
emberAfSendCommandUnicastWithCallback#
EmberStatus emberAfSendCommandUnicastWithCallback (EmberOutgoingMessageType type, uint16_t indexOrDestination, EmberAfMessageSentFunction callback)
emberAfSendCommandUnicast with attached message sent callback.
N/A | type | |
N/A | indexOrDestination | |
N/A | callback |
1617
of file app/framework/include/af.h
emberAfSendCommandBroadcast#
EmberStatus emberAfSendCommandBroadcast (EmberNodeId destination)
Send the command prepared with emberAfFill.... macro.
N/A | destination |
This function is used to send a command that was previously prepared using the emberAfFill... macros from the client command API.
1627
of file app/framework/include/af.h
emberAfSendCommandBroadcastWithCallback#
EmberStatus emberAfSendCommandBroadcastWithCallback (EmberNodeId destination, EmberAfMessageSentFunction callback)
emberAfSendCommandBroadcast with attached message sent callback.
N/A | destination | |
N/A | callback |
1632
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.
N/A | destination | |
N/A | alias | |
N/A | sequence | |
N/A | callback |
1638
of file app/framework/include/af.h
emberAfSendCommandBroadcastWithAlias#
EmberStatus emberAfSendCommandBroadcastWithAlias (EmberNodeId destination, EmberNodeId alias, uint8_t sequence)
Send the command prepared with emberAfFill.... macro.
N/A | destination | |
N/A | alias | |
N/A | sequence |
This function is used to send a command that was previously prepared using the emberAfFill... macros from the client command API.
1649
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.
N/A | panId | |
N/A | destinationLongId | |
N/A | destinationShortId | |
N/A | multicastId | |
N/A | profileId |
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.
1662
of file app/framework/include/af.h
emberAfSendDefaultResponse#
EmberStatus emberAfSendDefaultResponse (const EmberAfClusterCommand * cmd, EmberAfStatus status)
Send a default response to a cluster command.
N/A | cmd | The cluster command to which to respond. |
N/A | status | 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.
1679
of file app/framework/include/af.h
emberAfSendDefaultResponseWithCallback#
EmberStatus emberAfSendDefaultResponseWithCallback (const EmberAfClusterCommand * cmd, EmberAfStatus status, EmberAfMessageSentFunction callback)
emberAfSendDefaultResponse with attached message sent callback.
N/A | cmd | |
N/A | status | |
N/A | callback |
1685
of file app/framework/include/af.h
emberAfSendImmediateDefaultResponse#
EmberStatus emberAfSendImmediateDefaultResponse (EmberAfStatus status)
Send a default response to a cluster command using the current command.
N/A | status | 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.
1700
of file app/framework/include/af.h
emberAfSendImmediateDefaultResponseWithCallback#
EmberStatus emberAfSendImmediateDefaultResponseWithCallback (EmberAfStatus status, EmberAfMessageSentFunction callback)
emberAfSendImmediateDefaultResponse with attached message sent callback.
N/A | status | |
N/A | callback |
1705
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.
N/A | type | The outgoing message type. |
N/A | indexOrDestination | 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/A | apsFrame | 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.
1724
of file app/framework/include/af.h
emberAfGetCommandApsFrame#
EmberApsFrame * emberAfGetCommandApsFrame (void )
Access to client API APS frame.
N/A |
1731
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.
N/A | sourceEndpoint | |
N/A | destinationEndpoint |
1736
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.
N/A | target | The destination node ID for the discovery; either a specific node's ID or EMBER_RX_ON_WHEN_IDLE_BROADCAST_ADDRESS. |
N/A | profileId | The application profile for the cluster being discovered. |
N/A | clusterId | The cluster being discovered. |
N/A | serverCluster | 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/A | callback | 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.
1775
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.
N/A | target | The destination node ID for the discovery. This should be a specific node's ID and should not be a broadcast address. |
N/A | targetEndpoint | The endpoint to target with the discovery process. |
N/A | callback | 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.
1795
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.
N/A | shortAddress | |
N/A | callback |
1804
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).
N/A | longAddress | |
N/A | callback |
1812
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.
N/A | target | |
N/A | callback |
1818
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.
N/A | longId | The EUI64 of the remote device. |
N/A | shortId | 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).
1839
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.
N/A | index | The index of the address table entry. |
N/A | longId | The EUI64 of the remote device. |
N/A | shortId | 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.
1861
of file app/framework/include/af.h
emberAfRemoveAddressTableEntry#
EmberStatus emberAfRemoveAddressTableEntry (uint8_t index)
Remove a specific entry from the address table.
N/A | index | 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.
1877
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.
N/A | nodeId | The node ID of the remote device. |
N/A | endpoint | The endpoint on the remote device. |
Returns
::EMBER_SUCCESS if key establishment was initiated successfully
1908
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.
N/A | panId | The PAN ID of the remote device. |
N/A | eui64 | The EUI64 of the remote device. |
Returns
::EMBER_SUCCESS if key establishment was initiated successfully
1918
of file app/framework/include/af.h
emberAfPerformingKeyEstablishment#
bool emberAfPerformingKeyEstablishment (void )
Indicate whether the device is in the process of performing key establishment.
N/A |
Returns
::true if key establishment is in progress.
1926
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.
N/A | target | The node ID of the remote device. |
N/A | endpoint | The key establishment endpoint of the remote device. |
N/A | callback | 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.
1938
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.
N/A |
1957
of file app/framework/include/af.h
EMBER_AF_CLIENT_CLUSTER_DISCOVERY#
#define EMBER_AF_CLIENT_CLUSTER_DISCOVERYValue:
false
Friendly define for use in discovering client clusters with emberAfFindDevicesByProfileAndCluster().
1742
of file app/framework/include/af.h
EMBER_AF_SERVER_CLUSTER_DISCOVERY#
#define EMBER_AF_SERVER_CLUSTER_DISCOVERYValue:
true
Friendly define for use in discovering server clusters with emberAfFindDevicesByProfileAndCluster().
1748
of file app/framework/include/af.h
emberAfCurrentEndpoint#
#define emberAfCurrentEndpointValue:
()
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.
1897
of file app/framework/include/af.h
Macro Definition Documentation#
EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_DISP#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_DISP
zcl msg disp [messageId:4] [messageControl:1] [startTime:4] [durationInMinutes:2] [message:-1] [optionalExtendedMessageControl:1]
Command description for DisplayMessage
messageId - INT32U
messageControl - MessagingControlMask [BITMAP8]
startTime - UTC_TIME
durationInMinutes - INT16U
message - CHAR_STRING
optionalExtendedMessageControl - MessagingExtendedControlMask [BITMAP8]
1413
of file app/framework/test/headers/cli.doc
EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_CANCEL#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_CANCEL
zcl msg cancel [messageId:4] [messageControl:1]
The CancelMessage command provides the ability to cancel the sending or acceptance of previously sent messages.
messageId - INT32U
messageControl - MessagingControlMask [BITMAP8]
1420
of file app/framework/test/headers/cli.doc
EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_DISP_PROTD#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_DISP_PROTD
zcl msg disp-protd [messageId:4] [messageControl:1] [startTime:4] [durationInMinutes:2] [message:-1] [optionalExtendedMessageControl:1]
The DisplayProtected Message command is for use with messages that are protected by a password or PIN.
messageId - INT32U
messageControl - MessagingControlMask [BITMAP8]
startTime - UTC_TIME
durationInMinutes - INT16U
message - CHAR_STRING
optionalExtendedMessageControl - MessagingExtendedControlMask [BITMAP8]
1431
of file app/framework/test/headers/cli.doc
EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_X_ALL#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_X_ALL
zcl msg x-all [implementationDateTime:4]
The CancelAllMessages command indicates to a client device that it should cancel all display messages currently held by it.
implementationDateTime - UTC_TIME
1437
of file app/framework/test/headers/cli.doc
EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_GET#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_GET
zcl msg get
Command description for GetLastMessage
1442
of file app/framework/test/headers/cli.doc
EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_CONFIRM#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_CONFIRM
zcl msg confirm [messageId:4] [confirmationTime:4] [messageConfirmationControl:1] [messageResponse:-1]
The Message Confirmation command provides an indication that a Utility Customer has acknowledged and/or accepted the contents of a previously sent message. Enhanced Message Confirmation commands shall contain an answer of 'NO', 'YES' and/or a message confirmation string.
messageId - INT32U
confirmationTime - UTC_TIME
messageConfirmationControl - BITMAP8
messageResponse - OCTET_STRING
1451
of file app/framework/test/headers/cli.doc
EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_GET_MSG_X#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_GET_MSG_X
zcl msg get-msg-x [earliestImplementationTime:4]
This command initiates the return of the first (and maybe only) Cancel All Messages command held on the associated server, and which has an implementation time equal to or later than the value indicated in the payload.
earliestImplementationTime - UTC_TIME
1457
of file app/framework/test/headers/cli.doc