ZCL IP#
API and Callbacks for the ZCL IP Component.
This component provides functionality to encapsulate and extract ZCL packets over IP to a remote Internet-connected host.
API#
Generate the outgoing proxy packet.
Generate the outgoing keep alive.
Retrieve incoming encapsulated ZCL proxy packet.
Retrieve incoming keepalive.
Retrieve incoming configure remote clusters.
Generate outgoing configure remote cluster.
Generate outgoing add device.
Generate outgoing configure remote binding.
Generate outgoing device discovery update.
Get packet length.
Get received packet pointer.
Get received packet command ID.
Get received proxy packet eui64 pointer.
Retrieved incoming add device.
Macros#
API Documentation#
sl_zigbee_af_zcl_ip_generate_outgoing_proxy_packet#
sl_status_t sl_zigbee_af_zcl_ip_generate_outgoing_proxy_packet (sl_zigbee_aps_frame_t * apsFrame, sl_802154_short_addr_t nodeId, sl_802154_long_addr_t eui64, uint8_t * zclMessageBuffer, uint16_t zclMessageBufferLength)
Generate the outgoing proxy packet.
Type | Direction | Argument Name | Description |
---|---|---|---|
sl_zigbee_aps_frame_t * | N/A | apsFrame | |
sl_802154_short_addr_t | N/A | nodeId | |
sl_802154_long_addr_t | N/A | eui64 | |
uint8_t * | N/A | zclMessageBuffer | |
uint16_t | N/A | zclMessageBufferLength |
Returns
sl_status_t status code
sl_zigbee_af_zcl_ip_generate_outgoing_keepalive#
sl_status_t sl_zigbee_af_zcl_ip_generate_outgoing_keepalive (uint32_t unixTime, uint32_t nextKeepaliveDelaySeconds)
Generate the outgoing keep alive.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint32_t | N/A | unixTime | |
uint32_t | N/A | nextKeepaliveDelaySeconds |
Returns
sl_status_t status code
sl_zigbee_af_zcl_ip_retrieve_incoming_encapsulated_zcl_proxy_packet#
sl_status_t sl_zigbee_af_zcl_ip_retrieve_incoming_encapsulated_zcl_proxy_packet (sl_zigbee_af_cluster_command_t * returnCmd, sl_802154_long_addr_t returnEui64)
Retrieve incoming encapsulated ZCL proxy packet.
Type | Direction | Argument Name | Description |
---|---|---|---|
sl_zigbee_af_cluster_command_t * | N/A | returnCmd | |
sl_802154_long_addr_t | N/A | returnEui64 |
Returns
sl_status_t status code
sl_zigbee_af_zcl_ip_retrieve_incoming_keepalive#
sl_status_t sl_zigbee_af_zcl_ip_retrieve_incoming_keepalive (uint32_t * unixTimeSinceEpoch, uint32_t * nextKeepaliveDelaySeconds)
Retrieve incoming keepalive.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint32_t * | N/A | unixTimeSinceEpoch | |
uint32_t * | N/A | nextKeepaliveDelaySeconds |
Returns
sl_status_t status code
sl_zigbee_af_zcl_ip_retrieve_incoming_configure_remote_clusters#
sl_status_t sl_zigbee_af_zcl_ip_retrieve_incoming_configure_remote_clusters (sl_zigbee_af_remote_cluster_struct_t * returnData, uint16_t maxCount, uint16_t * returnedCount)
Retrieve incoming configure remote clusters.
Type | Direction | Argument Name | Description |
---|---|---|---|
sl_zigbee_af_remote_cluster_struct_t * | N/A | returnData | struct for remote cluster data |
uint16_t | N/A | maxCount | |
uint16_t * | N/A | returnedCount |
Returns
sl_status_t status code
sl_zigbee_af_zcl_ip_generate_outgoing_configure_remote_cluster#
sl_status_t sl_zigbee_af_zcl_ip_generate_outgoing_configure_remote_cluster (uint16_t count, const sl_zigbee_af_remote_cluster_struct_t * records)
Generate outgoing configure remote cluster.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint16_t | N/A | count | |
const sl_zigbee_af_remote_cluster_struct_t * | N/A | records | struct for remote cluster data |
Returns
sl_status_t status code
sl_zigbee_af_zcl_ip_generate_outgoing_add_device#
sl_status_t sl_zigbee_af_zcl_ip_generate_outgoing_add_device (sl_802154_long_addr_t newDeviceEui64, const sl_zigbee_key_data_t * newDeviceKeyData)
Generate outgoing add device.
Type | Direction | Argument Name | Description |
---|---|---|---|
sl_802154_long_addr_t | N/A | newDeviceEui64 | |
const sl_zigbee_key_data_t * | N/A | newDeviceKeyData |
Returns
sl_status_t status code
sl_zigbee_af_zcl_ip_generate_outgoing_configure_remote_binding#
sl_status_t sl_zigbee_af_zcl_ip_generate_outgoing_configure_remote_binding (sl_802154_long_addr_t targetEUI64, uint8_t sourceEndpoint, uint8_t destEndpoint, uint16_t clusterId, sl_802154_long_addr_t destEUI64, sl_802154_long_addr_t sourceEUI64)
Generate outgoing configure remote binding.
Type | Direction | Argument Name | Description |
---|---|---|---|
sl_802154_long_addr_t | N/A | targetEUI64 | |
uint8_t | N/A | sourceEndpoint | |
uint8_t | N/A | destEndpoint | |
uint16_t | N/A | clusterId | |
sl_802154_long_addr_t | N/A | destEUI64 | |
sl_802154_long_addr_t | N/A | sourceEUI64 |
Returns
sl_status_t status code
sl_zigbee_af_zcl_ip_generate_outgoing_device_discovery_update#
sl_status_t sl_zigbee_af_zcl_ip_generate_outgoing_device_discovery_update (const sl_zigbee_af_device_info_t * device)
Generate outgoing device discovery update.
Type | Direction | Argument Name | Description |
---|---|---|---|
const sl_zigbee_af_device_info_t * | N/A | device | Pointer to device info struct |
Returns
sl_status_t status code
sl_zigbee_af_zcl_ip_get_packet_length#
uint16_t sl_zigbee_af_zcl_ip_get_packet_length (const uint8_t * zclIpPacket)
Get packet length.
Type | Direction | Argument Name | Description |
---|---|---|---|
const uint8_t * | N/A | zclIpPacket |
Returns
uint16_t packet length
sl_zigbee_af_zcl_ip_get_received_packet_pointer#
uint8_t * sl_zigbee_af_zcl_ip_get_received_packet_pointer (void )
Get received packet pointer.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
Returns
uint8_t* pointer to the received packet
sl_zigbee_af_zcl_ip_get_received_packet_command_id#
uint16_t sl_zigbee_af_zcl_ip_get_received_packet_command_id (void )
Get received packet command ID.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
Returns
uint16_t command ID
sl_zigbee_af_zcl_ip_get_received_proxy_packet_eui64_pointer#
uint8_t * sl_zigbee_af_zcl_ip_get_received_proxy_packet_eui64_pointer (void )
Get received proxy packet eui64 pointer.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
Returns
uint8_t eui64 packet pointer
sl_zigbee_af_zcl_ip_retrieve_incoming_add_device#
sl_status_t sl_zigbee_af_zcl_ip_retrieve_incoming_add_device (sl_802154_long_addr_t newDeviceEui64, sl_zigbee_key_data_t * newDeviceKeyData)
Retrieved incoming add device.
Type | Direction | Argument Name | Description |
---|---|---|---|
sl_802154_long_addr_t | N/A | newDeviceEui64 | |
sl_zigbee_key_data_t * | N/A | newDeviceKeyData |
Returns
sl_status_t status code
sl_zigbee_af_zcl_ip_retrieve_incoming_configure_remote_binding#
sl_status_t sl_zigbee_af_zcl_ip_retrieve_incoming_configure_remote_binding (sl_zigbee_af_remote_binding_struct_t * returnData)
Type | Direction | Argument Name | Description |
---|---|---|---|
sl_zigbee_af_remote_binding_struct_t * | N/A | returnData | Pointer to the remote binding struct |
Retrieve incoming configure remote binding.
Returns
sl_status_t status code
sl_zigbee_af_zcl_ip_retrieve_incoming_device_discovery_update#
sl_status_t sl_zigbee_af_zcl_ip_retrieve_incoming_device_discovery_update (sl_zigbee_af_device_info_t * device)
Type | Direction | Argument Name | Description |
---|---|---|---|
sl_zigbee_af_device_info_t * | N/A | device | pointer to the device info struct |
Retrieve incoming device discovery update.
Returns
sl_status_t status code