ZCL IP#

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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)

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)

Retrieve incoming device discovery update.

Returns

• sl_status_t status code

EM_AF_ZCL_IP_VERSION#

#define EM_AF_ZCL_IP_VERSION

0x01

EM_AF_ZCL_IP_HEADER_INDEX#

#define EM_AF_ZCL_IP_HEADER_INDEX

0

EM_AF_ZCL_IP_PACKET_LENGTH_INDEX#

#define EM_AF_ZCL_IP_PACKET_LENGTH_INDEX

2

EM_AF_ZCL_IP_COMMAND_ID_INDEX#

#define EM_AF_ZCL_IP_COMMAND_ID_INDEX

4

EM_AF_ZCL_IP_COMMAND_ID_FIELD_LENGTH#

#define EM_AF_ZCL_IP_COMMAND_ID_FIELD_LENGTH

2

EM_AF_ZCL_IP_MINIMUM_PACKET_SIZE#

#define EM_AF_ZCL_IP_MINIMUM_PACKET_SIZE

(EM_AF_ZCL_IP_COMMAND_ID_INDEX + EM_AF_ZCL_IP_COMMAND_ID_FIELD_LENGTH)

EM_AF_ZCL_IP_KEEPALIVE_PACKET_ID#

#define EM_AF_ZCL_IP_KEEPALIVE_PACKET_ID

0x0000

EM_AF_ZCL_IP_COMMAND_ZCL_PROXY_PACKET_ID#

#define EM_AF_ZCL_IP_COMMAND_ZCL_PROXY_PACKET_ID

0x0001

EM_AF_ZCL_IP_CONFIGURE_REMOTE_CLUSTERS_ID#

#define EM_AF_ZCL_IP_CONFIGURE_REMOTE_CLUSTERS_ID

0x0002

EM_AF_ZCL_IP_ADD_DEVICE_ID#

#define EM_AF_ZCL_IP_ADD_DEVICE_ID

0x0003

EM_AF_ZCL_IP_CONFIGURE_REMOTE_BINDING_ID#

#define EM_AF_ZCL_IP_CONFIGURE_REMOTE_BINDING_ID

0x0004

EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_ID#

#define EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_ID

0x0005

EM_AF_ZCL_IP_UNIX_TIME_INDEX#

#define EM_AF_ZCL_IP_UNIX_TIME_INDEX

6

EM_AF_ZCL_IP_KEEPALIVE_DELAY_SECONDS_INDEX#

#define EM_AF_ZCL_IP_KEEPALIVE_DELAY_SECONDS_INDEX

10

EM_AF_ZCL_IP_KEEPALIVE_DELAY_SECONDS_SIZE#

#define EM_AF_ZCL_IP_KEEPALIVE_DELAY_SECONDS_SIZE

4

EM_AF_ZCL_IP_KEEPALIVE_PACKET_SIZE#

#define EM_AF_ZCL_IP_KEEPALIVE_PACKET_SIZE

(EM_AF_ZCL_IP_KEEPALIVE_DELAY_SECONDS_INDEX + EM_AF_ZCL_IP_KEEPALIVE_DELAY_SECONDS_SIZE)

EM_AF_ZCL_IP_CLUSTER_ID_INDEX#

#define EM_AF_ZCL_IP_CLUSTER_ID_INDEX

6

EM_AF_ZCL_IP_PROFILE_ID_INDEX#

#define EM_AF_ZCL_IP_PROFILE_ID_INDEX

8

EM_AF_ZCL_IP_SOURCE_EP_INDEX#

#define EM_AF_ZCL_IP_SOURCE_EP_INDEX

10

EM_AF_ZCL_IP_DEST_EP_INDEX#

#define EM_AF_ZCL_IP_DEST_EP_INDEX

11

EM_AF_ZCL_IP_EUI64_INDEX#

#define EM_AF_ZCL_IP_EUI64_INDEX

12

EM_AF_ZCL_IP_APS_OPTIONS_INDEX#

#define EM_AF_ZCL_IP_APS_OPTIONS_INDEX

20

EM_AF_ZCL_IP_ZCL_LENGTH_INDEX#

#define EM_AF_ZCL_IP_ZCL_LENGTH_INDEX

22

EM_AF_ZCL_IP_ZCL_PAYLOAD_INDEX#

#define EM_AF_ZCL_IP_ZCL_PAYLOAD_INDEX

24

EM_AF_ZCL_IP_PROXY_PACKET_MINIMUM_SIZE#

#define EM_AF_ZCL_IP_PROXY_PACKET_MINIMUM_SIZE

(EM_AF_ZCL_IP_ZCL_PAYLOAD_INDEX)

EM_AF_ZCL_IP_CONFIGURE_REMOTE_CLUSTERS_COUNT_INDEX#

#define EM_AF_ZCL_IP_CONFIGURE_REMOTE_CLUSTERS_COUNT_INDEX

6

EM_AF_ZCL_IP_CONFIGURE_REMOTE_CLUSTERS_RECORD_START_INDEX#

#define EM_AF_ZCL_IP_CONFIGURE_REMOTE_CLUSTERS_RECORD_START_INDEX

8

EM_AF_ZCL_IP_CONFIGURE_REMOTE_CLUSTERS_COMMAND_OVERHEAD#

#define EM_AF_ZCL_IP_CONFIGURE_REMOTE_CLUSTERS_COMMAND_OVERHEAD

2

EM_AF_ZCL_IP_CONFIGURE_REMOTE_CLUSTERS_RECORD_CLUSTER_OFFSET#

#define EM_AF_ZCL_IP_CONFIGURE_REMOTE_CLUSTERS_RECORD_CLUSTER_OFFSET

0

EM_AF_ZCL_IP_CONFIGURE_REMOTE_CLUSTERS_RECORD_PROFILE_OFFSET#

#define EM_AF_ZCL_IP_CONFIGURE_REMOTE_CLUSTERS_RECORD_PROFILE_OFFSET

2

EM_AF_ZCL_IP_CONFIGURE_REMOTE_CLUSTERS_RECORD_DEVICE_ID_OFFSET#

#define EM_AF_ZCL_IP_CONFIGURE_REMOTE_CLUSTERS_RECORD_DEVICE_ID_OFFSET

4

EM_AF_ZCL_IP_CONFIGURE_REMOTE_CLUSTERS_RECORD_ENDPOINT_OFFSET#

#define EM_AF_ZCL_IP_CONFIGURE_REMOTE_CLUSTERS_RECORD_ENDPOINT_OFFSET

6

EM_AF_ZCL_IP_CONFIGURE_REMOTE_CLUSTERS_RECORD_TYPE_OFFSET#

#define EM_AF_ZCL_IP_CONFIGURE_REMOTE_CLUSTERS_RECORD_TYPE_OFFSET

7

EM_AF_ZCL_IP_CONFIGURE_REMOTE_CLUSTERS_RECORD_TYPE_OFFSET_LENGTH#

#define EM_AF_ZCL_IP_CONFIGURE_REMOTE_CLUSTERS_RECORD_TYPE_OFFSET_LENGTH

2

EM_AF_ZCL_IP_CONFIGURE_REMOTE_CLUSTERS_RECORD_LENGTH#

#define EM_AF_ZCL_IP_CONFIGURE_REMOTE_CLUSTERS_RECORD_LENGTH

EM_AF_ZCL_IP_ADD_DEVICE_EUI64_INDEX#

#define EM_AF_ZCL_IP_ADD_DEVICE_EUI64_INDEX

6

EM_AF_ZCL_IP_ADD_DEVICE_LINK_KEY_INDEX#

#define EM_AF_ZCL_IP_ADD_DEVICE_LINK_KEY_INDEX

14

EM_AF_ZCL_IP_ADD_DEVICE_COMMAND_LENGTH#

#define EM_AF_ZCL_IP_ADD_DEVICE_COMMAND_LENGTH

30

EM_AF_ZCL_IP_CONFIGURE_REMOTE_BINDING_COMMAND_TARGET_EUI_OFFSET#

#define EM_AF_ZCL_IP_CONFIGURE_REMOTE_BINDING_COMMAND_TARGET_EUI_OFFSET

6

EM_AF_ZCL_IP_CONFIGURE_REMOTE_BINDING_COMMAND_SOURCE_ENDPOINT_OFFSET#

#define EM_AF_ZCL_IP_CONFIGURE_REMOTE_BINDING_COMMAND_SOURCE_ENDPOINT_OFFSET

14

EM_AF_ZCL_IP_CONFIGURE_REMOTE_BINDING_COMMAND_DEST_ENDPOINT_OFFSET#

#define EM_AF_ZCL_IP_CONFIGURE_REMOTE_BINDING_COMMAND_DEST_ENDPOINT_OFFSET

15

EM_AF_ZCL_IP_CONFIGURE_REMOTE_BINDING_COMMAND_CLUSTER_ID_OFFSET#

#define EM_AF_ZCL_IP_CONFIGURE_REMOTE_BINDING_COMMAND_CLUSTER_ID_OFFSET

16

EM_AF_ZCL_IP_CONFIGURE_REMOTE_BINDING_COMMAND_DEST_EUI_OFFSET#

#define EM_AF_ZCL_IP_CONFIGURE_REMOTE_BINDING_COMMAND_DEST_EUI_OFFSET

18

EM_AF_ZCL_IP_CONFIGURE_REMOTE_BINDING_COMMAND_SOURCE_EUI_OFFSET#

#define EM_AF_ZCL_IP_CONFIGURE_REMOTE_BINDING_COMMAND_SOURCE_EUI_OFFSET

26

EM_AF_ZCL_IP_CONFIGURE_REMOTE_BINDING_COMMAND_LENGTH#

#define EM_AF_ZCL_IP_CONFIGURE_REMOTE_BINDING_COMMAND_LENGTH

34

EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_COMMAND_EUI64_INDEX#

#define EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_COMMAND_EUI64_INDEX

6

EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_COMMAND_STATUS_INDEX#

#define EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_COMMAND_STATUS_INDEX

14

EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_COMMAND_CAPABILITIES_INDEX#

#define EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_COMMAND_CAPABILITIES_INDEX

15

EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_COMMAND_ENDPOINT_COUNT_INDEX#

#define EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_COMMAND_ENDPOINT_COUNT_INDEX

16

EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_COMMAND_ENDPOINT_INFO_INDEX#

#define EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_COMMAND_ENDPOINT_INFO_INDEX

17

EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_COMMAND_ENDPOINT_OFFSET#

#define EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_COMMAND_ENDPOINT_OFFSET

0

EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_COMMAND_PROFILE_ID_OFFSET#

#define EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_COMMAND_PROFILE_ID_OFFSET

1

EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_COMMAND_DEVICE_ID_OFFSET#

#define EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_COMMAND_DEVICE_ID_OFFSET

3

EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_COMMAND_CLUSTER_COUNT_OFFSET#

#define EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_COMMAND_CLUSTER_COUNT_OFFSET

5

EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_COMMAND_CLUSTER_ID_OFFSET#

#define EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_COMMAND_CLUSTER_ID_OFFSET

6

EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_COMMAND_ENDPOINT_INFO_MIN_LENGTH#

#define EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_COMMAND_ENDPOINT_INFO_MIN_LENGTH

EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_COMMAND_CLUSTER_ID_OFFSET

EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_COMMAND_MIN_LENGTH#

#define EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_COMMAND_MIN_LENGTH

EM_AF_ZCL_IP_DEVICE_DISCOVERY_UPDATE_COMMAND_ENDPOINT_INFO_INDEX