ZCL OTA Upgrade cluster

zb_zcl_ota_upgrade_client_variable_t client_var_##attr_list =                                     \
  {0, query_timer, 1, hardware_version, max_data_size, 0, 0};                                       \
  ZB_ZCL_START_DECLARE_ATTRIB_LIST_CLUSTER_REVISION(attr_list, ZB_ZCL_OTA_UPGRADE)                  \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_OTA_UPGRADE_SERVER_ID                  , (upgrade_server))       \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_OTA_UPGRADE_FILE_OFFSET_ID             , (file_offset))          \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_OTA_UPGRADE_FILE_VERSION_ID            , (file_version))         \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_OTA_UPGRADE_STACK_VERSION_ID           , (stack_version))        \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_OTA_UPGRADE_DOWNLOADED_FILE_VERSION_ID , (downloaded_file_ver))  \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_OTA_UPGRADE_DOWNLOADED_STACK_VERSION_ID, (downloaded_stack_ver)) \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_OTA_UPGRADE_IMAGE_STATUS_ID            , (image_status))         \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_OTA_UPGRADE_MANUFACTURE_ID             , (manufacturer))         \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_OTA_UPGRADE_IMAGE_TYPE_ID              , (image_type))           \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_OTA_UPGRADE_MIN_BLOCK_REQUE_ID         , (min_block_reque))      \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_OTA_UPGRADE_IMAGE_STAMP_ID             , (image_stamp))          \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_OTA_UPGRADE_SERVER_ADDR_ID             , (server_addr))          \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_OTA_UPGRADE_SERVER_ENDPOINT_ID         , (server_ep))            \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_OTA_UPGRADE_CLIENT_DATA_ID,         &(client_var_##attr_list))   \
   ZB_ZCL_FINISH_DECLARE_ATTRIB_LIST
ZB_ZCL_ATTR_OTA_UPGRADE_STACK_VERSION_ID
CurrentZigbeeStackVersion attribute, ZCL8 specification, subsection 11.10.4. 
Definition: zb_zcl_ota_upgrade.h:560
ZB_ZCL_ATTR_OTA_UPGRADE_SERVER_ID
UpgradeServerID attribute, ZCL8 specification, subsection 11.10.1. 
Definition: zb_zcl_ota_upgrade.h:554
ZB_ZCL_ATTR_OTA_UPGRADE_DOWNLOADED_STACK_VERSION_ID
DownloadedZigbeeStackVersion attribute, ZCL8 specification, subsection 11.10.6. 
Definition: zb_zcl_ota_upgrade.h:564
ZB_ZCL_ATTR_OTA_UPGRADE_SERVER_ENDPOINT_ID
OTA server endpoint custom attribute. 
Definition: zb_zcl_ota_upgrade.h:586
ZB_ZCL_ATTR_OTA_UPGRADE_IMAGE_STATUS_ID
ImageUpgradeStatus attribute, ZCL8 specification, subsection 11.10.7. 
Definition: zb_zcl_ota_upgrade.h:566
ZB_ZCL_ATTR_OTA_UPGRADE_SERVER_ADDR_ID
OTA server addr custom attribute. 
Definition: zb_zcl_ota_upgrade.h:588
ZB_ZCL_ATTR_OTA_UPGRADE_FILE_OFFSET_ID
FileOffset attribute, ZCL8 specification, subsection 11.10.2. 
Definition: zb_zcl_ota_upgrade.h:556
ZB_ZCL_ATTR_OTA_UPGRADE_IMAGE_STAMP_ID
Image Stamp attribute, ZCL8 specification, subsection 11.10.11. 
Definition: zb_zcl_ota_upgrade.h:574
zb_zcl_ota_upgrade_client_variable_s
Structure representation of client side variables. 
Definition: zb_zcl_ota_upgrade.h:534
ZB_ZCL_ATTR_OTA_UPGRADE_MIN_BLOCK_REQUE_ID
MinimumBlockPeriod attribute, ZCL8 specification, subsection 11.10.10. 
Definition: zb_zcl_ota_upgrade.h:572
ZB_ZCL_ATTR_OTA_UPGRADE_DOWNLOADED_FILE_VERSION_ID
DownloadedFileVersion attribute, ZCL8 specification, subsection 11.10.5. 
Definition: zb_zcl_ota_upgrade.h:562
ZB_ZCL_ATTR_OTA_UPGRADE_MANUFACTURE_ID
Manufacturer ID attribute, ZCL8 specification, subsection 11.10.8. 
Definition: zb_zcl_ota_upgrade.h:568
ZB_ZCL_ATTR_OTA_UPGRADE_CLIENT_DATA_ID
DownloadedFileSize custom attribute. 
Definition: zb_zcl_ota_upgrade.h:590
ZB_ZCL_ATTR_OTA_UPGRADE_FILE_VERSION_ID
CurrentFileVersion attribute, ZCL8 specification, subsection 11.10.3. 
Definition: zb_zcl_ota_upgrade.h:558
ZB_ZCL_ATTR_OTA_UPGRADE_IMAGE_TYPE_ID
Image Type ID attribute, ZCL8 specification, subsection 11.10.9. 
Definition: zb_zcl_ota_upgrade.h:570

Declare attribute list for OTA Upgrade cluster - client side.

endcond

Parameters

attr_list	- attribute list name
upgrade_server	- pointer to variable to store UpgradeServerID attribute
file_offset	- pointer to variable to store FileOffset attribute
file_version	- pointer to variable to store CurrentFileVersion attribute
stack_version	- pointer to variable to store CurrentZigbeeStackVersion attribute
downloaded_file_ver	- pointer to variable to store DownloadedFileVersion attribute
downloaded_stack_ver	- pointer to variable to store DownloadedZigbeeStackVersion attribute
image_status	- pointer to variable to store ImageUpgradeStatus attribute
manufacturer	- pointer to variable to store Manufacturer ID attribute
image_type	- pointer to variable to store Image Type ID attribute
min_block_reque	- pointer to variable to store MinimumBlockReque attribute
image_stamp	- pointer to variable to store Image Stamp attribute
server_addr	- server short address
server_ep	- server endpoint
hardware_version	- (const) hardware version
max_data_size	- (const) maximum data size Query Block Image commands
query_timer	- (const) query timer count

zb_zcl_ota_upgrade_data_t table_##attr_list[length];                                    \
  zb_zcl_ota_upgrade_server_variable_t server_var_##attr_list =  {                        \
    query_jitter, /* 0, 0,*/ current_time, /*ZB_ZCL_OTA_UPGRADE_UPGRADE_TIME_DEF_VALUE,*/ \
    length, table_##attr_list };                                                          \
  ZB_ZCL_START_DECLARE_ATTRIB_LIST_CLUSTER_REVISION(attr_list, ZB_ZCL_OTA_UPGRADE)        \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_OTA_UPGRADE_SERVER_DATA_ID, &(server_var_##attr_list)) \
  ZB_ZCL_FINISH_DECLARE_ATTRIB_LIST
ZB_ZCL_ATTR_OTA_UPGRADE_SERVER_DATA_ID
Server variables- see OTA spec 6.8 and Custom data. 
Definition: zb_zcl_ota_upgrade.h:593
zb_zcl_ota_upgrade_data_s
Structure representation of OTA file on server side. 
Definition: zb_zcl_ota_upgrade.h:413

Declare attribute list for OTA Upgrade cluster - server side.

Parameters

attr_list	- attribute list name
query_jitter	- (8bit) pointer to variable to store QueryJitter value
current_time	- (32bit) pointer to variable to store CurrentTime
length	- (const) length of server table with upgrade image data

{                                                                         \
  zb_zcl_ota_upgrade_image_block_t *src_ptr =                             \
       (zb_zcl_ota_upgrade_image_block_t*)zb_buf_begin((buffer));         \
                                                                          \
  if (zb_buf_len((buffer)) < sizeof(zb_zcl_ota_upgrade_image_block_t) -   \
      ( !(src_ptr->fc & ZB_ZCL_OTA_UPGRADE_QUERY_IMAGE_BLOCK_IEEE_PRESENT) ? sizeof(zb_ieee_addr_t) : 0) -    \
      ( !(src_ptr->fc & ZB_ZCL_OTA_UPGRADE_QUERY_IMAGE_BLOCK_DELAY_PRESENT) ? sizeof(zb_uint16_t) : 0) )      \
  {                                                                       \
   (status) = ZB_ZCL_PARSE_STATUS_FAILURE;                                \
  }                                                                       \
  else                                                                    \
  {                                                                       \
    (status) = ZB_ZCL_PARSE_STATUS_SUCCESS;                               \
    (data_ptr)->fc = src_ptr->fc;                                         \
    ZB_HTOLE16(&((data_ptr)->manufacturer), &(src_ptr->manufacturer));    \
    ZB_HTOLE16(&((data_ptr)->image_type), &(src_ptr->image_type));        \
    ZB_HTOLE32(&((data_ptr)->file_version), &(src_ptr->file_version));    \
    ZB_HTOLE32(&((data_ptr)->file_offset), &(src_ptr->file_offset));      \
    (data_ptr)->data_size_max = src_ptr->data_size_max;                   \
    if( src_ptr->fc & ZB_ZCL_OTA_UPGRADE_QUERY_IMAGE_BLOCK_IEEE_PRESENT)  \
    {                                                                     \
      ZB_IEEE_ADDR_COPY((data_ptr)->node_addr, (src_ptr)->node_addr);     \
    }                                                                     \
    if( src_ptr->fc & ZB_ZCL_OTA_UPGRADE_QUERY_IMAGE_BLOCK_DELAY_PRESENT) \
    {                                                                     \
      ZB_HTOLE16(&((data_ptr)->block_delay), &(src_ptr->block_delay));    \
    }                                                                     \
  }                                                                       \
}
zb_ieee_addr_t
zb_64bit_addr_t zb_ieee_addr_t
Long (64-bit) device address. 
Definition: zb_types.h:536
ZB_ZCL_PARSE_STATUS_FAILURE
Definition: zb_zcl_common.h:348
zb_uint16_t
unsigned short zb_uint16_t
Project-local 2-byte unsigned int type. 
Definition: zb_types.h:159
ZB_ZCL_OTA_UPGRADE_QUERY_IMAGE_BLOCK_IEEE_PRESENT
Request node&#39;s IEEE address Present. 
Definition: zb_zcl_ota_upgrade.h:1028
zb_zcl_ota_upgrade_image_block_s
Structure representation of Image Block Request command payload. 
Definition: zb_zcl_ota_upgrade.h:1008
ZB_ZCL_PARSE_STATUS_SUCCESS
Definition: zb_zcl_common.h:347
zb_buf_begin
#define zb_buf_begin(buf)
Definition: zboss_api_buf.h:362
ZB_ZCL_OTA_UPGRADE_QUERY_IMAGE_BLOCK_DELAY_PRESENT
BlockRequestDelay present. 
Definition: zb_zcl_ota_upgrade.h:1030
zb_buf_len
#define zb_buf_len(buf)
Definition: zboss_api_buf.h:380

Macro for getting "Image Block Request" command, see ZCL8 specification, subsection 11.13.6.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zcl_ota_upgrade_image_block_s.
buffer	containing the packet (by pointer).
status	- variable to put parse status to (see zb_zcl_parse_status_t).

Macro for getting Image Block Response command, see ZCL8 specification, subsection 11.13.8.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zcl_ota_upgrade_image_block_res_s.
buffer	containing the packet (by pointer).
status_	- variable to put parse status to (see zb_zcl_parse_status_t).

Note

File data is placed in buffer, payload saves pointer to data only!

{                                                                         \
  if (zb_buf_len((buffer)) <= sizeof(zb_uint8_t))  \
  {                                                                       \
   (status) = ZB_ZCL_PARSE_STATUS_FAILURE;                                \
  }                                                                       \
  else                                                                    \
  {                                                                       \
    zb_zcl_ota_upgrade_image_notify_t *src_ptr =                          \
         (zb_zcl_ota_upgrade_image_notify_t*)zb_buf_begin((buffer));      \
    (status) = ZB_ZCL_PARSE_STATUS_SUCCESS;                               \
    (data_ptr)->payload_type = src_ptr->payload_type;                     \
    (data_ptr)->query_jitter = src_ptr->query_jitter;                     \
    switch ( src_ptr->payload_type )                                      \
    {                                                                     \
      case 0x03:                                                          \
        ZB_HTOLE32(&((data_ptr)->file_version), &(src_ptr->file_version));\
        /* FALLTHROUGH */                                                 \
      case 0x02:                                                          \
        ZB_HTOLE16(&((data_ptr)->image_type), &(src_ptr->image_type));    \
        /* FALLTHROUGH */                                                 \
      case 0x01:                                                          \
        ZB_HTOLE16(&((data_ptr)->manufacturer), &(src_ptr->manufacturer));\
        /* FALLTHROUGH */                                                 \
      default:                                                            \
        break;                                                            \
    }                                                                     \
  }                                                                       \
}
ZB_ZCL_PARSE_STATUS_FAILURE
Definition: zb_zcl_common.h:348
zb_zcl_ota_upgrade_image_notify_s
Structure representation of Image Notify response command payload. 
Definition: zb_zcl_ota_upgrade.h:1373
ZB_ZCL_PARSE_STATUS_SUCCESS
Definition: zb_zcl_common.h:347
zb_buf_begin
#define zb_buf_begin(buf)
Definition: zboss_api_buf.h:362
zb_uint8_t
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type. 
Definition: zb_types.h:155
zb_buf_len
#define zb_buf_len(buf)
Definition: zboss_api_buf.h:380

{                                                                         \
  zb_zcl_ota_upgrade_image_page_t *src_ptr =                              \
       (zb_zcl_ota_upgrade_image_page_t*)zb_buf_begin((buffer));          \
                                                                          \
  if (zb_buf_len((buffer)) < sizeof(zb_zcl_ota_upgrade_image_page_t) -    \
      ((src_ptr->fc & ZB_ZCL_OTA_UPGRADE_QUERY_IMAGE_PAGE_IEEE_PRESENT) ? sizeof(zb_ieee_addr_t) : 0) )      \
  {                                                                       \
   (status) = ZB_ZCL_PARSE_STATUS_FAILURE;                                \
  }                                                                       \
  else                                                                    \
  {                                                                       \
    (status) = ZB_ZCL_PARSE_STATUS_SUCCESS;                               \
    (data_ptr)->fc = src_ptr->fc;                                         \
    ZB_HTOLE16(&((data_ptr)->manufacturer), &(src_ptr->manufacturer));    \
    ZB_HTOLE16(&((data_ptr)->image_type), &(src_ptr->image_type));        \
    ZB_HTOLE32(&((data_ptr)->file_version), &(src_ptr->file_version));    \
    ZB_HTOLE32(&((data_ptr)->file_offset), &(src_ptr->file_offset));      \
    (data_ptr)->data_size_max = src_ptr->data_size_max;                   \
    ZB_HTOLE16(&((data_ptr)->page_size), &(src_ptr->page_size));          \
    ZB_HTOLE16(&((data_ptr)->response_spacing), &(src_ptr->response_spacing));    \
    if( src_ptr->fc & ZB_ZCL_OTA_UPGRADE_QUERY_IMAGE_PAGE_IEEE_PRESENT)   \
    {                                                                     \
      ZB_IEEE_ADDR_COPY((data_ptr)->node_addr, (src_ptr)->node_addr);     \
    }                                                                     \
  }                                                                       \
}
zb_ieee_addr_t
zb_64bit_addr_t zb_ieee_addr_t
Long (64-bit) device address. 
Definition: zb_types.h:536
ZB_ZCL_PARSE_STATUS_FAILURE
Definition: zb_zcl_common.h:348
ZB_ZCL_PARSE_STATUS_SUCCESS
Definition: zb_zcl_common.h:347
ZB_ZCL_OTA_UPGRADE_QUERY_IMAGE_PAGE_IEEE_PRESENT
Request node&#39;s IEEE address Present. 
Definition: zb_zcl_ota_upgrade.h:1144
zb_buf_begin
#define zb_buf_begin(buf)
Definition: zboss_api_buf.h:362
zb_zcl_ota_upgrade_image_page_s
Structure representation of Image Page Request command payload. 
Definition: zb_zcl_ota_upgrade.h:1123
zb_buf_len
#define zb_buf_len(buf)
Definition: zboss_api_buf.h:380

Macro for getting "Image Page Request" command, see ZCL8 specification, subsection 11.13.7.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zcl_ota_upgrade_image_page_s.
buffer	containing the packet (by pointer).
status	- variable to put parse status to (see zb_zcl_parse_status_t).

Macro for getting "Query Next Image Request" command, see ZCL8 specification, subsection 11.13.4.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zcl_ota_upgrade_query_next_image_s.
buffer	containing the packet (by pointer).
status	- variable to put parse status to (see zb_zcl_parse_status_t).

{                                                                             \
  zb_zcl_ota_upgrade_query_next_image_res_t *src_ptr =                        \
       (zb_zcl_ota_upgrade_query_next_image_res_t*)zb_buf_begin((buffer));    \
                                                                              \
  if (zb_buf_len((buffer)) < ( (src_ptr->status)==ZB_ZCL_STATUS_SUCCESS ?     \
     sizeof(zb_zcl_ota_upgrade_query_next_image_res_t) : sizeof(zb_uint8_t))) \
  {                                                                           \
    (status_) = ZB_ZCL_PARSE_STATUS_FAILURE;                                  \
    TRACE_MSG(TRACE_ZLL1, "ERROR: buf_len %i", (FMT__H, zb_buf_len((buffer)))); \
  }                                                                           \
  else                                                                        \
  {                                                                           \
    (status_) = ZB_ZCL_PARSE_STATUS_SUCCESS;                                  \
    (data_ptr)->status = src_ptr->status;                                     \
    if( src_ptr->status == ZB_ZCL_STATUS_SUCCESS)                             \
    {                                                                         \
      ZB_HTOLE16(&((data_ptr)->manufacturer), &(src_ptr->manufacturer));      \
      ZB_HTOLE16(&((data_ptr)->image_type), &(src_ptr->image_type));          \
      ZB_HTOLE32(&((data_ptr)->file_version), &(src_ptr->file_version));      \
      ZB_HTOLE32(&((data_ptr)->image_size), &(src_ptr->image_size));          \
    }                                                                         \
  }                                                                           \
}
ZB_ZCL_PARSE_STATUS_FAILURE
Definition: zb_zcl_common.h:348
ZB_ZCL_STATUS_SUCCESS
#define ZB_ZCL_STATUS_SUCCESS
Definition: zb_zcl_common.h:365
zb_zcl_ota_upgrade_query_next_image_res_s
Structure representation of Query Next Image Response command payload. 
Definition: zb_zcl_ota_upgrade.h:1471
ZB_ZCL_PARSE_STATUS_SUCCESS
Definition: zb_zcl_common.h:347
zb_buf_begin
#define zb_buf_begin(buf)
Definition: zboss_api_buf.h:362
zb_uint8_t
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type. 
Definition: zb_types.h:155
zb_buf_len
#define zb_buf_len(buf)
Definition: zboss_api_buf.h:380

Macro for getting Query Next Image Response command, see ZCL8 specification, subsection 11.13.5.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zcl_ota_upgrade_query_next_image_res_s.
buffer	containing the packet (by pointer).
status_	- variable to put parse status to (see zb_zcl_parse_status_t).

{                                                                         \
  if (zb_buf_len((buffer)) < sizeof(zb_zcl_ota_upgrade_query_specific_file_t) )   \
  {                                                                       \
   (status) = ZB_ZCL_PARSE_STATUS_FAILURE;                                \
  }                                                                       \
  else                                                                    \
  {                                                                       \
    zb_zcl_ota_upgrade_query_specific_file_t *src_ptr =                   \
       (zb_zcl_ota_upgrade_query_specific_file_t*)zb_buf_begin((buffer)); \
    (status) = ZB_ZCL_PARSE_STATUS_SUCCESS;                               \
    ZB_IEEE_ADDR_COPY((data_ptr)->node_addr, (src_ptr)->node_addr);       \
    ZB_HTOLE16(&((data_ptr)->manufacturer), &(src_ptr->manufacturer));    \
    ZB_HTOLE16(&((data_ptr)->image_type), &(src_ptr->image_type));        \
    ZB_HTOLE32(&((data_ptr)->file_version), &(src_ptr->file_version));    \
    ZB_HTOLE16(&((data_ptr)->stack_version), &(src_ptr->stack_version));  \
  }                                                                       \
}
zb_zcl_ota_upgrade_query_specific_file_s
Structure representation of Query Specific File Request command payload. 
Definition: zb_zcl_ota_upgrade.h:1299
ZB_ZCL_PARSE_STATUS_FAILURE
Definition: zb_zcl_common.h:348
ZB_ZCL_PARSE_STATUS_SUCCESS
Definition: zb_zcl_common.h:347
zb_buf_begin
#define zb_buf_begin(buf)
Definition: zboss_api_buf.h:362
zb_buf_len
#define zb_buf_len(buf)
Definition: zboss_api_buf.h:380

Macro for getting "Query Specific File Request" command, see ZCL8 specification, subsection 11.13.10.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zcl_ota_upgrade_query_specific_file_s.
buffer	containing the packet (by pointer).
status	- variable to put parse status to (see zb_zcl_parse_status_t).

{                                                                                   \
  zb_zcl_ota_upgrade_query_specific_file_res_t *src_ptr =                           \
       (zb_zcl_ota_upgrade_query_specific_file_res_t*)zb_buf_begin((buffer));       \
  if (zb_buf_len((buffer)) < ( (src_ptr->status)==ZB_ZCL_STATUS_SUCCESS ?           \
      sizeof(zb_zcl_ota_upgrade_query_specific_file_res_t) : sizeof(zb_uint8_t) ) ) \
  {                                                                                 \
    (status_) = ZB_ZCL_PARSE_STATUS_FAILURE;                                  \
  }                                                                           \
  else                                                                        \
  {                                                                           \
    (status_) = ZB_ZCL_PARSE_STATUS_SUCCESS;                                  \
    (data_ptr)->status = src_ptr->status;                                     \
    if( src_ptr->status == ZB_ZCL_STATUS_SUCCESS)                             \
    {                                                                         \
      ZB_HTOLE32(&((data_ptr)->manufacturer), &(src_ptr->manufacturer));      \
      ZB_HTOLE32(&((data_ptr)->image_type), &(src_ptr->image_type));          \
      ZB_HTOLE32(&((data_ptr)->file_version), &(src_ptr->file_version));      \
      ZB_HTOLE32(&((data_ptr)->image_size), &(src_ptr->image_size));          \
    }                                                                         \
  }                                                                           \
}
ZB_ZCL_PARSE_STATUS_FAILURE
Definition: zb_zcl_common.h:348
zb_zcl_ota_upgrade_query_specific_file_res_s
Structure representation of Query Specific File Response command payload. 
Definition: zb_zcl_ota_upgrade.h:1805
ZB_ZCL_STATUS_SUCCESS
#define ZB_ZCL_STATUS_SUCCESS
Definition: zb_zcl_common.h:365
ZB_ZCL_PARSE_STATUS_SUCCESS
Definition: zb_zcl_common.h:347
zb_buf_begin
#define zb_buf_begin(buf)
Definition: zboss_api_buf.h:362
zb_uint8_t
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type. 
Definition: zb_types.h:155
zb_buf_len
#define zb_buf_len(buf)
Definition: zboss_api_buf.h:380

Macro for getting Query Specific File Response command, see ZCL8 specification, subsection 11.13.11.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zcl_ota_upgrade_query_specific_file_res_s.
buffer	containing the packet (by pointer).
status_	- variable to put parse status to (see zb_zcl_parse_status_t).

{                                                                         \
  zb_zcl_ota_upgrade_upgrade_end_t *src_ptr =                             \
       (zb_zcl_ota_upgrade_upgrade_end_t*)zb_buf_begin((buffer));         \
                                                                          \
  if (zb_buf_len((buffer)) < sizeof(zb_zcl_ota_upgrade_upgrade_end_t) )   \
  {                                                                       \
   (status_) = ZB_ZCL_PARSE_STATUS_FAILURE;                               \
  }                                                                       \
  else                                                                    \
  {                                                                       \
    (status_) = ZB_ZCL_PARSE_STATUS_SUCCESS;                              \
    (data_ptr)->status = src_ptr->status;                                 \
    ZB_HTOLE16(&((data_ptr)->manufacturer), &(src_ptr->manufacturer));    \
    ZB_HTOLE16(&((data_ptr)->image_type), &(src_ptr->image_type));        \
    ZB_HTOLE32(&((data_ptr)->file_version), &(src_ptr->file_version));    \
  }                                                                       \
}
ZB_ZCL_PARSE_STATUS_FAILURE
Definition: zb_zcl_common.h:348
zb_zcl_ota_upgrade_upgrade_end_s
Structure representation of Upgrade End Request command payload. 
Definition: zb_zcl_ota_upgrade.h:1229
ZB_ZCL_PARSE_STATUS_SUCCESS
Definition: zb_zcl_common.h:347
zb_buf_begin
#define zb_buf_begin(buf)
Definition: zboss_api_buf.h:362
zb_buf_len
#define zb_buf_len(buf)
Definition: zboss_api_buf.h:380

Macro for getting "Upgrade End Request" command, see ZCL8 specification, subsection 11.13.9.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zcl_ota_upgrade_upgrade_end_s.
buffer	containing the packet (by pointer).
status_	- variable to put parse status to (see zb_zcl_parse_status_t).

{                                                                             \
  if (zb_buf_len((buffer)) < sizeof(zb_zcl_ota_upgrade_upgrade_end_res_t) )   \
  {                                                                           \
    (status_) = ZB_ZCL_PARSE_STATUS_FAILURE;                                  \
  }                                                                           \
  else                                                                        \
  {                                                                           \
    zb_zcl_ota_upgrade_upgrade_end_res_t *src_ptr =                           \
         (zb_zcl_ota_upgrade_upgrade_end_res_t*)zb_buf_begin((buffer));       \
    (status_) = ZB_ZCL_PARSE_STATUS_SUCCESS;                                  \
    ZB_HTOLE16(&((data_ptr)->manufacturer), &(src_ptr->manufacturer));        \
    ZB_HTOLE16(&((data_ptr)->image_type), &(src_ptr->image_type));            \
    ZB_HTOLE32(&((data_ptr)->file_version), &(src_ptr->file_version));        \
    ZB_HTOLE32(&((data_ptr)->current_time), &(src_ptr->current_time));        \
    ZB_HTOLE32(&((data_ptr)->upgrade_time), &(src_ptr->upgrade_time));        \
  }                                                                           \
}
ZB_ZCL_PARSE_STATUS_FAILURE
Definition: zb_zcl_common.h:348
ZB_ZCL_PARSE_STATUS_SUCCESS
Definition: zb_zcl_common.h:347
zb_buf_begin
#define zb_buf_begin(buf)
Definition: zboss_api_buf.h:362
zb_zcl_ota_upgrade_upgrade_end_res_s
Structure representation of Upgrade End Response command payload. 
Definition: zb_zcl_ota_upgrade.h:1732
zb_buf_len
#define zb_buf_len(buf)
Definition: zboss_api_buf.h:380

Macro for getting Upgrade End Response command, see ZCL8 specification, subsection 11.13.9.6.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zcl_ota_upgrade_upgrade_end_res_s.
buffer	containing the packet (by pointer).
status_	- variable to put parse status to (see zb_zcl_parse_status_t).

{                                                                       \
  zb_zcl_ota_upgrade_server_insert_file_t *file_data =                  \
    ZB_BUF_GET_PARAM(buf, zb_zcl_ota_upgrade_server_insert_file_t);     \
  file_data->endpoint = (ep);                                           \
  file_data->index = (i);                                               \
  file_data->ota_file = (file);                                         \
  file_data->upgrade_time = (upgrade_tm);                               \
  file_data->notify_on = (notify);                                      \
  (ret_code) = zb_zcl_ota_upgrade_insert_file(buf);                     \
}
zb_zcl_ota_upgrade_insert_file
zb_ret_t zb_zcl_ota_upgrade_insert_file(zb_uint8_t param)
Insert upgrade OTA file into Server upgrade table. 
zb_zcl_ota_upgrade_server_insert_file_s
Structure representation of Data for insert OTA file to upgrade mechanism. 
Definition: zb_zcl_ota_upgrade.h:352

{                                                                   \
  zb_zcl_ota_upgrade_server_remove_file_t *file_data =              \
    ZB_BUF_GET_PARAM(buf, zb_zcl_ota_upgrade_server_remove_file_t); \
  file_data->endpoint = (ep);                                       \
  file_data->index = (i);                                           \
  (ret_code) = zb_zcl_ota_upgrade_remove_file(buf);                 \
}
zb_zcl_ota_upgrade_server_remove_file_s
Structure representation of Data for insert OTA file to upgrade mechanism. 
Definition: zb_zcl_ota_upgrade.h:386
zb_zcl_ota_upgrade_remove_file
zb_ret_t zb_zcl_ota_upgrade_remove_file(zb_uint8_t param)
Remove upgrade file from Server upgrade table. 

{                                                                   \
  zb_uint8_t* ptr = ZB_ZCL_START_PACKET(buffer);                    \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(ptr);         \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER(ptr, seq,                         \
      ZB_ZCL_CMD_OTA_UPGRADE_IMAGE_BLOCK_RESP_ID);                  \
  ZB_ZCL_PACKET_PUT_DATA8(ptr, ZB_ZCL_STATUS_ABORT);                \
  ZB_ZCL_FINISH_PACKET((buffer), ptr)                              \
  ZB_ZCL_SEND_COMMAND_SHORT(                                        \
      buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id,             \
      ZB_ZCL_CLUSTER_ID_OTA_UPGRADE, NULL);                         \
}
ZB_ZCL_CMD_OTA_UPGRADE_IMAGE_BLOCK_RESP_ID
Definition: zb_zcl_ota_upgrade.h:870
ZB_ZCL_START_PACKET
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array. 
Definition: zb_zcl_common.h:1523
ZB_ZCL_CLUSTER_ID_OTA_UPGRADE
#define ZB_ZCL_CLUSTER_ID_OTA_UPGRADE
Definition: zb_zcl_common.h:247
ZB_ZCL_STATUS_ABORT
#define ZB_ZCL_STATUS_ABORT
Definition: zb_zcl_common.h:393

Send Image Block Response command - abort status, see ZCL8 specification, subsection 11.13.8.

Parameters

buffer	- to put packet to
addr	- address to send packet to
dst_addr_mode	- addressing mode
dst_ep	- destination endpoint
ep	- sending endpoint
prfl_id	- profile identifier
seq	- sequence

{                                                                           \
  zb_uint8_t* ptr = ZB_ZCL_START_PACKET_REQ(buffer)                            \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL(ptr, (def_resp))     \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER_REQ(ptr, ZB_ZCL_GET_SEQ_NUM(),                \
      ZB_ZCL_CMD_OTA_UPGRADE_IMAGE_BLOCK_ID);                               \
  ZB_ZCL_PACKET_PUT_DATA8(ptr, (fc));                                       \
  ZB_ZCL_PACKET_PUT_2DATA16_VAL(ptr, (manufacturer), (image_type));                        \
  ZB_ZCL_PACKET_PUT_2DATA32_VAL(ptr, (file_version), (file_offset));                        \
  ZB_ZCL_PACKET_PUT_DATA8(ptr, (data_size_max));                            \
  if( (fc) & ZB_ZCL_OTA_UPGRADE_QUERY_IMAGE_BLOCK_IEEE_PRESENT)             \
  {                                                                         \
    ZB_ZCL_PACKET_PUT_DATA_IEEE(ptr, (node_addr));                          \
  }                                                                         \
  if( (fc) & ZB_ZCL_OTA_UPGRADE_QUERY_IMAGE_BLOCK_DELAY_PRESENT)            \
  {                                                                         \
    ZB_ZCL_PACKET_PUT_DATA16_VAL(ptr, (block_delay));                       \
  }                                                                         \
  ZB_ZCL_FINISH_PACKET_O((buffer), ptr)                                      \
  ZB_ZCL_SEND_COMMAND_SHORT_SCHEDULE(                                 \
      buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id,                     \
      ZB_ZCL_CLUSTER_ID_OTA_UPGRADE, cb,                                    \
      current_delay);                                                       \
}
ZB_ZCL_GET_SEQ_NUM
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame. 
Definition: zb_zcl_common.h:1443
ZB_ZCL_OTA_UPGRADE_QUERY_IMAGE_BLOCK_IEEE_PRESENT
Request node's IEEE address Present. 
Definition: zb_zcl_ota_upgrade.h:1028
ZB_ZCL_CLUSTER_ID_OTA_UPGRADE
#define ZB_ZCL_CLUSTER_ID_OTA_UPGRADE
Definition: zb_zcl_common.h:247
ZB_ZCL_CMD_OTA_UPGRADE_IMAGE_BLOCK_ID
Definition: zb_zcl_ota_upgrade.h:857
ZB_ZCL_OTA_UPGRADE_QUERY_IMAGE_BLOCK_DELAY_PRESENT
BlockRequestDelay present. 
Definition: zb_zcl_ota_upgrade.h:1030

Send "Image Block Request" command, see ZCL8 specification, subsection 11.13.6.

Parameters

buffer	to put packet to
addr	- address to send packet to
dst_addr_mode	- addressing mode
dst_ep	- destination endpoint
ep	- sending endpoint
prfl_id	- profile identifier
def_resp	- enable/disable default response
cb	- callback
fc	- Field Control, see zb_zcl_ota_upgrade_image_block_fc_e
manufacturer	- Manufacturer code
image_type	- Image type
file_version	- File version
file_offset	- File offset
data_size_max	- Maximum data size
node_addr	- Request node address
block_delay	- BlockRequestDelay
current_delay	- Delay current send (millisec)

{                                                                   \
  zb_uint8_t* ptr = ZB_ZCL_START_PACKET(buffer);                    \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(ptr);         \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER(ptr, seq,                         \
      ZB_ZCL_CMD_OTA_UPGRADE_IMAGE_BLOCK_RESP_ID);                  \
  ZB_ZCL_PACKET_PUT_DATA8(ptr, ZB_ZCL_STATUS_SUCCESS);              \
  ZB_ZCL_PACKET_PUT_2DATA16_VAL(ptr, (manufacturer), (image_type)); \
  ZB_ZCL_PACKET_PUT_2DATA32_VAL(ptr, (file_version), (file_offset));                \
  ZB_ZCL_PACKET_PUT_DATA8(ptr, (data_size));                        \
  ZB_ASSERT(image_data != NULL);                                    \
  ZB_ZCL_PACKET_PUT_DATA_N(ptr, (image_data), (data_size));         \
  ZB_ZCL_FINISH_PACKET((buffer), ptr)                              \
  ZB_ZCL_SEND_COMMAND_SHORT(                                        \
      buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id,             \
      ZB_ZCL_CLUSTER_ID_OTA_UPGRADE, NULL);                         \
}
ZB_ZCL_CMD_OTA_UPGRADE_IMAGE_BLOCK_RESP_ID
Definition: zb_zcl_ota_upgrade.h:870
ZB_ZCL_START_PACKET
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array. 
Definition: zb_zcl_common.h:1523
ZB_ZCL_CLUSTER_ID_OTA_UPGRADE
#define ZB_ZCL_CLUSTER_ID_OTA_UPGRADE
Definition: zb_zcl_common.h:247
ZB_ZCL_STATUS_SUCCESS
#define ZB_ZCL_STATUS_SUCCESS
Definition: zb_zcl_common.h:365

Send Image Block Response command - success status, see ZCL8 specification, subsection 11.13.8.

Parameters

buffer	- to put packet to
addr	- address to send packet to
dst_addr_mode	- addressing mode
dst_ep	- destination endpoint
ep	- sending endpoint
prfl_id	- profile identifier
seq	- sequence
manufacturer	- Manufacturer code
image_type	- Image type
file_version	- File version
file_offset	- File offset
data_size	- data size
image_data	- image data

{                                                                   \
  zb_uint8_t* ptr = ZB_ZCL_START_PACKET(buffer);                    \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(ptr);         \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER(ptr, seq,                         \
      ZB_ZCL_CMD_OTA_UPGRADE_IMAGE_BLOCK_RESP_ID);                  \
  ZB_ZCL_PACKET_PUT_DATA8(ptr, ZB_ZCL_STATUS_WAIT_FOR_DATA);        \
  ZB_ZCL_PACKET_PUT_2DATA32_VAL(ptr, (current_time), (request_time));                \
  ZB_ZCL_PACKET_PUT_DATA16_VAL(ptr, (delay));                       \
  ZB_ZCL_FINISH_PACKET((buffer), ptr)                              \
  ZB_ZCL_SEND_COMMAND_SHORT(                                        \
      buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id,             \
      ZB_ZCL_CLUSTER_ID_OTA_UPGRADE, NULL);                         \
}
ZB_ZCL_CMD_OTA_UPGRADE_IMAGE_BLOCK_RESP_ID
Definition: zb_zcl_ota_upgrade.h:870
ZB_ZCL_START_PACKET
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array. 
Definition: zb_zcl_common.h:1523
ZB_ZCL_CLUSTER_ID_OTA_UPGRADE
#define ZB_ZCL_CLUSTER_ID_OTA_UPGRADE
Definition: zb_zcl_common.h:247
ZB_ZCL_STATUS_WAIT_FOR_DATA
#define ZB_ZCL_STATUS_WAIT_FOR_DATA
Definition: zb_zcl_common.h:395

Send Image Block Response command - wait for data status, see ZCL8 specification, subsection 11.13.8.

Parameters

buffer	- to put packet to
addr	- address to send packet to
dst_addr_mode	- addressing mode
dst_ep	- destination endpoint
ep	- sending endpoint
prfl_id	- profile identifier
seq	- sequence
current_time	- Current time
request_time	- Request time
delay	- BlockRequestDelay

{                                                                           \
  zb_uint8_t* ptr = ZB_ZCL_START_PACKET(buffer);                            \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL_A(                \
    ptr, ZB_ZCL_FRAME_DIRECTION_TO_CLI,                                 \
    ZB_ZCL_NOT_MANUFACTURER_SPECIFIC, (def_resp));                      \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER(ptr, ZB_ZCL_GET_SEQ_NUM(),                \
                                  ZB_ZCL_CMD_OTA_UPGRADE_IMAGE_NOTIFY_ID); \
  ZB_ZCL_PACKET_PUT_DATA8(ptr, (payload_type));                             \
  ZB_ZCL_PACKET_PUT_DATA8(ptr, (query_jitter));                             \
  ZB_ZCL_PACKET_PUT_2DATA16_VAL(ptr, (manufacturer), (image_type));     \
  ZB_ZCL_PACKET_PUT_DATA32_VAL(ptr, (file_version));                        \
  ZB_ZCL_FINISH_PACKET((buffer), ptr)                                       \
  ZB_ZCL_SEND_COMMAND_SHORT(                                                \
      buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id,                     \
      ZB_ZCL_CLUSTER_ID_OTA_UPGRADE, cb);                                   \
}
ZB_ZCL_GET_SEQ_NUM
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame. 
Definition: zb_zcl_common.h:1443
ZB_ZCL_START_PACKET
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array. 
Definition: zb_zcl_common.h:1523
ZB_ZCL_CLUSTER_ID_OTA_UPGRADE
#define ZB_ZCL_CLUSTER_ID_OTA_UPGRADE
Definition: zb_zcl_common.h:247
ZB_ZCL_CMD_OTA_UPGRADE_IMAGE_NOTIFY_ID
Definition: zb_zcl_ota_upgrade.h:868
ZB_ZCL_FRAME_DIRECTION_TO_CLI
#define ZB_ZCL_FRAME_DIRECTION_TO_CLI
Definition: zb_zcl_common.h:1053
ZB_ZCL_NOT_MANUFACTURER_SPECIFIC
#define ZB_ZCL_NOT_MANUFACTURER_SPECIFIC
Definition: zb_zcl_common.h:1006

Send Image Notify command, see ZCL8 specification, subsection 11.13.3.

Parameters

buffer	- to put packet to
addr	- address to send packet to
dst_addr_mode	- addressing mode
dst_ep	- destination endpoint
ep	- sending endpoint
prfl_id	- profile identifier
def_resp	- enable/disable default response
cb	- callback for getting command send status
payload_type	- Payload type
query_jitter	- Query jitter
manufacturer	- Manufacturer code
image_type	- Image type
file_version	- File version

{                                                                           \
  zb_uint8_t* ptr = ZB_ZCL_START_PACKET_REQ(buffer)                            \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL(ptr, (def_resp))     \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER_REQ(ptr, ZB_ZCL_GET_SEQ_NUM(),                \
      ZB_ZCL_CMD_OTA_UPGRADE_IMAGE_PAGE_ID);                                \
  ZB_ZCL_PACKET_PUT_DATA8(ptr, (fc));                                       \
  ZB_ZCL_PACKET_PUT_2DATA16_VAL(ptr, (manufacturer), (image_type));                        \
  ZB_ZCL_PACKET_PUT_2DATA32_VAL(ptr, (file_version), (file_offset));                        \
  ZB_ZCL_PACKET_PUT_DATA8(ptr, (data_size_max));                            \
  ZB_ZCL_PACKET_PUT_2DATA16_VAL(ptr, (page_size), (response_spacing));                           \
  if( (fc) & ZB_ZCL_OTA_UPGRADE_QUERY_IMAGE_PAGE_IEEE_PRESENT)              \
  {                                                                         \
    ZB_ZCL_PACKET_PUT_DATA_IEEE(ptr, (node_addr));                          \
  }                                                                         \
  ZB_ZCL_FINISH_PACKET((buffer), ptr)                                      \
  ZB_ZCL_SEND_COMMAND_SHORT(                                                \
      buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id,                     \
      ZB_ZCL_CLUSTER_ID_OTA_UPGRADE, cb);                                   \
}
ZB_ZCL_GET_SEQ_NUM
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame. 
Definition: zb_zcl_common.h:1443
ZB_ZCL_CLUSTER_ID_OTA_UPGRADE
#define ZB_ZCL_CLUSTER_ID_OTA_UPGRADE
Definition: zb_zcl_common.h:247
ZB_ZCL_CMD_OTA_UPGRADE_IMAGE_PAGE_ID
Definition: zb_zcl_ota_upgrade.h:858
ZB_ZCL_OTA_UPGRADE_QUERY_IMAGE_PAGE_IEEE_PRESENT
Request node's IEEE address Present. 
Definition: zb_zcl_ota_upgrade.h:1144

Send "Image Page Request" command, see ZCL8 specification, subsection 11.13.7.

Parameters

buffer	to put packet to
addr	- address to send packet to
dst_addr_mode	- addressing mode
dst_ep	- destination endpoint
ep	- sending endpoint
prfl_id	- profile identifier
def_resp	- enable/disable default response
cb	- callback
fc	- Field Control, see zb_zcl_ota_upgrade_image_page_fc_e
manufacturer	- Manufacturer code
image_type	- Image type
file_version	- File version
file_offset	- File offset
data_size_max	- Maximum data size
page_size	- Page size
response_spacing	- Response Spacing
node_addr	- Request node address

{                                                                           \
  zb_uint8_t* ptr = ZB_ZCL_START_PACKET_REQ(buffer)                         \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL(ptr, (def_resp))      \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER_REQ(ptr, ZB_ZCL_GET_SEQ_NUM(),            \
      ZB_ZCL_CMD_OTA_UPGRADE_QUERY_NEXT_IMAGE_ID);                          \
  ZB_ZCL_PACKET_PUT_DATA8(ptr, (fc));                                       \
  ZB_ZCL_PACKET_PUT_2DATA16_VAL(ptr, (manufacturer), (image_type));         \
  ZB_ZCL_PACKET_PUT_DATA32_VAL(ptr, (file_version));                        \
  if( (fc) & ZB_ZCL_OTA_UPGRADE_QUERY_NEXT_IMAGE_HW_VERSION )               \
  {                                                                         \
    ZB_ZCL_PACKET_PUT_DATA16_VAL(ptr, (hw_version));                        \
  }                                                                         \
  ZB_ZCL_FINISH_N_SEND_PACKET_NEW((buffer), ptr, addr, dst_addr_mode,       \
    dst_ep, ep, prfl_id, ZB_ZCL_CLUSTER_ID_OTA_UPGRADE, cb, aps_secured,    \
    ZB_FALSE, 0);                                                           \
}
ZB_ZCL_GET_SEQ_NUM
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame. 
Definition: zb_zcl_common.h:1443
ZB_ZCL_CMD_OTA_UPGRADE_QUERY_NEXT_IMAGE_ID
Definition: zb_zcl_ota_upgrade.h:856
ZB_ZCL_CLUSTER_ID_OTA_UPGRADE
#define ZB_ZCL_CLUSTER_ID_OTA_UPGRADE
Definition: zb_zcl_common.h:247
ZB_FALSE
#define ZB_FALSE
Definition: zb_types.h:356
ZB_ZCL_OTA_UPGRADE_QUERY_NEXT_IMAGE_HW_VERSION
Hardware Version Present. 
Definition: zb_zcl_ota_upgrade.h:924

Send "Query Next Image Request" command, see ZCL8 specification, subsection 11.13.4.

Parameters

buffer	to put packet to
addr	- address to send packet to
dst_addr_mode	- addressing mode
dst_ep	- destination endpoint
ep	- sending endpoint
prfl_id	- profile identifier
def_resp	- enable/disable default response
cb	- callback
fc	- Field Control, see zb_zcl_ota_upgrade_image_notify_payload_type_e
manufacturer	- Manufacturer code
image_type	- Image type
file_version	- File version
hw_version	- Hardware version
aps_secured	- APS security

{                                                                   \
  zb_uint8_t* ptr = ZB_ZCL_START_PACKET(buffer);                    \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(ptr);         \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER(ptr, seq,                         \
      ZB_ZCL_CMD_OTA_UPGRADE_QUERY_NEXT_IMAGE_RESP_ID);             \
  ZB_ZCL_PACKET_PUT_DATA8(ptr, (status));                           \
  if( (status) == ZB_ZCL_STATUS_SUCCESS)                            \
  {                                                                 \
    ZB_ZCL_PACKET_PUT_2DATA16_VAL(ptr, (manufacturer), (image_type));   \
    ZB_ZCL_PACKET_PUT_2DATA32_VAL(ptr, (file_version), (image_size));              \
  }                                                                 \
  ZB_ZCL_FINISH_PACKET((buffer), ptr)                              \
  ZB_ZCL_SEND_COMMAND_SHORT(                                        \
      buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id,             \
      ZB_ZCL_CLUSTER_ID_OTA_UPGRADE, NULL);                         \
}
ZB_ZCL_START_PACKET
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array. 
Definition: zb_zcl_common.h:1523
ZB_ZCL_CLUSTER_ID_OTA_UPGRADE
#define ZB_ZCL_CLUSTER_ID_OTA_UPGRADE
Definition: zb_zcl_common.h:247
ZB_ZCL_STATUS_SUCCESS
#define ZB_ZCL_STATUS_SUCCESS
Definition: zb_zcl_common.h:365
ZB_ZCL_CMD_OTA_UPGRADE_QUERY_NEXT_IMAGE_RESP_ID
Definition: zb_zcl_ota_upgrade.h:869

Send Query Next Image Response command, see ZCL8 specification, subsection 11.13.5.

Parameters

buffer	- to put packet to
addr	- address to send packet to
dst_addr_mode	- addressing mode
dst_ep	- destination endpoint
ep	- sending endpoint
prfl_id	- profile identifier
seq	- sequence
status	- Status, see zcl_status
manufacturer	- Manufacturer code
image_type	- Image type
file_version	- File version
image_size	- Image size

{                                                                           \
  zb_uint8_t* ptr = ZB_ZCL_START_PACKET_REQ(buffer)                            \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL(ptr, (def_resp))     \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER_REQ(ptr, ZB_ZCL_GET_SEQ_NUM(),                \
      ZB_ZCL_CMD_OTA_UPGRADE_QUERY_SPECIFIC_FILE_ID);                       \
  ZB_ZCL_PACKET_PUT_DATA_IEEE(ptr, (node_addr));                            \
  ZB_ZCL_PACKET_PUT_2DATA16_VAL(ptr, (manufacturer), (image_type));                        \
  ZB_ZCL_PACKET_PUT_DATA32_VAL(ptr, (file_version));                        \
  ZB_ZCL_PACKET_PUT_DATA16_VAL(ptr, (stack_version));                       \
  ZB_ZCL_FINISH_PACKET((buffer), ptr)                                      \
  ZB_ZCL_SEND_COMMAND_SHORT(                                                \
      buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id,                     \
      ZB_ZCL_CLUSTER_ID_OTA_UPGRADE, cb);                                   \
}
ZB_ZCL_GET_SEQ_NUM
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame. 
Definition: zb_zcl_common.h:1443
ZB_ZCL_CMD_OTA_UPGRADE_QUERY_SPECIFIC_FILE_ID
Definition: zb_zcl_ota_upgrade.h:860
ZB_ZCL_CLUSTER_ID_OTA_UPGRADE
#define ZB_ZCL_CLUSTER_ID_OTA_UPGRADE
Definition: zb_zcl_common.h:247

Send "Query Specific File Request" command, see ZCL8 specification, subsection 11.13.10.

Parameters

buffer	to put packet to
addr	- address to send packet to
dst_addr_mode	- addressing mode
dst_ep	- destination endpoint
ep	- sending endpoint
prfl_id	- profile identifier
def_resp	- enable/disable default response
cb	- callback
node_addr	- Node address
manufacturer	- Manufacturer code
image_type	- Image type
file_version	- File version
stack_version	- Zigbee stack version

{                                                                   \
  zb_uint8_t* ptr = ZB_ZCL_START_PACKET(buffer);                    \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(ptr);         \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER(ptr, seq,                         \
      ZB_ZCL_CMD_OTA_UPGRADE_QUERY_SPECIFIC_FILE_RESP_ID);          \
  ZB_ZCL_PACKET_PUT_DATA8(ptr, (status));                           \
  if( (status) == ZB_ZCL_STATUS_SUCCESS)                            \
  {                                                                 \
    ZB_ZCL_PACKET_PUT_2DATA16_VAL(ptr, (manufacturer), (image_type));   \
    ZB_ZCL_PACKET_PUT_2DATA32_VAL(ptr, (file_version), (image_size));              \
  }                                                                 \
  ZB_ZCL_FINISH_PACKET((buffer), ptr)                              \
  ZB_ZCL_SEND_COMMAND_SHORT(                                        \
      buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id,             \
      ZB_ZCL_CLUSTER_ID_OTA_UPGRADE, NULL);                         \
}
ZB_ZCL_CMD_OTA_UPGRADE_QUERY_SPECIFIC_FILE_RESP_ID
Definition: zb_zcl_ota_upgrade.h:872
ZB_ZCL_START_PACKET
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array. 
Definition: zb_zcl_common.h:1523
ZB_ZCL_CLUSTER_ID_OTA_UPGRADE
#define ZB_ZCL_CLUSTER_ID_OTA_UPGRADE
Definition: zb_zcl_common.h:247
ZB_ZCL_STATUS_SUCCESS
#define ZB_ZCL_STATUS_SUCCESS
Definition: zb_zcl_common.h:365

Send Query Specific File Response command, see ZCL8 specification, subsection 11.13.11.

Parameters

buffer	- to put packet to
addr	- address to send packet to
dst_addr_mode	- addressing mode
dst_ep	- destination endpoint
ep	- sending endpoint
prfl_id	- profile identifier
seq	- sequence
status	- Status, see zcl_status
manufacturer	- Manufacturer code
image_type	- Image type
file_version	- File version
image_size	- Image size

{                                                                           \
  zb_uint8_t* ptr = ZB_ZCL_START_PACKET_REQ(buffer)                            \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL(ptr, (def_resp))     \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER_REQ(ptr, ZB_ZCL_GET_SEQ_NUM(),                \
      ZB_ZCL_CMD_OTA_UPGRADE_UPGRADE_END_ID);                               \
  ZB_ZCL_PACKET_PUT_DATA8(ptr, (status));                                   \
  ZB_ZCL_PACKET_PUT_2DATA16_VAL(ptr, (manufacturer), (image_type));                  \
  ZB_ZCL_PACKET_PUT_DATA32_VAL(ptr, (file_version));                        \
  ZB_ZCL_FINISH_PACKET((buffer), ptr)                                      \
  ZB_ZCL_SEND_COMMAND_SHORT(                                                \
      buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id,                     \
      ZB_ZCL_CLUSTER_ID_OTA_UPGRADE, cb);                                   \
}
ZB_ZCL_GET_SEQ_NUM
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame. 
Definition: zb_zcl_common.h:1443
ZB_ZCL_CLUSTER_ID_OTA_UPGRADE
#define ZB_ZCL_CLUSTER_ID_OTA_UPGRADE
Definition: zb_zcl_common.h:247
ZB_ZCL_CMD_OTA_UPGRADE_UPGRADE_END_ID
Definition: zb_zcl_ota_upgrade.h:859

Send "Upgrade End Request" command, see ZCL8 specification, subsection 11.13.9.

Parameters

buffer	to put packet to
addr	- address to send packet to
dst_addr_mode	- addressing mode
dst_ep	- destination endpoint
ep	- sending endpoint
prfl_id	- profile identifier
def_resp	- enable/disable default response
cb	- callback
status	- Status, see zcl_status
manufacturer	- Manufacturer code
image_type	- Image type
file_version	- File version

{                                                                   \
  zb_uint8_t* ptr = ZB_ZCL_START_PACKET(buffer);                    \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(ptr);         \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER(ptr, seq,                         \
      ZB_ZCL_CMD_OTA_UPGRADE_UPGRADE_END_RESP_ID);                  \
  ZB_ZCL_PACKET_PUT_2DATA16_VAL(ptr, (manufacturer), (image_type));  \
  ZB_ZCL_PACKET_PUT_2DATA32_VAL(ptr, (file_version), (current_time));                \
  ZB_ZCL_PACKET_PUT_DATA32_VAL(ptr, (upgrade_time));                \
  ZB_ZCL_FINISH_PACKET((buffer), ptr)                              \
  ZB_ZCL_SEND_COMMAND_SHORT(                                        \
      buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id,             \
      ZB_ZCL_CLUSTER_ID_OTA_UPGRADE, NULL);                         \
}
ZB_ZCL_START_PACKET
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array. 
Definition: zb_zcl_common.h:1523
ZB_ZCL_CLUSTER_ID_OTA_UPGRADE
#define ZB_ZCL_CLUSTER_ID_OTA_UPGRADE
Definition: zb_zcl_common.h:247
ZB_ZCL_CMD_OTA_UPGRADE_UPGRADE_END_RESP_ID
Definition: zb_zcl_ota_upgrade.h:871

Send Upgrade End Response command, see ZCL8 specification, subsection 11.13.9.6.

Parameters

buffer	- to put packet to
addr	- address to send packet to
dst_addr_mode	- addressing mode
dst_ep	- destination endpoint
ep	- sending endpoint
prfl_id	- profile identifier
seq	- sequence
manufacturer	- Manufacturer code
image_type	- Image type
file_version	- File version
current_time	- Current time
upgrade_time	- Upgrade time

Optional parts of the OTA file header See ZCL8 specification, subsection 11.4.2, Table 11-2. OTA Header Fields

Structure representation of Image Block Response command payload.

See also

ZCL8 specification, subsection 11.13.8.1

Structure representation of Image Block Request command payload.

See also

ZCL8 specification, subsection 11.13.6.1

Structure representation of Image Notify response command payload.

See also

ZCL8 specification, subsection 11.13.3.1

Structure representation of Image Page Request command payload.

See also

ZCL8 specification, subsection 11.13.7

Callback function for send next data portion.

Structure representation of Query Next Image Response command payload.

See also

ZCL8 specification, subsection 11.13.5.1

Structure representation of Query Next Image Request command payload.

See also

ZCL8 specification, subsection 11.13.4

Structure representation of Query Specific File Response command payload.

See also

ZCL8 specification, subsection 11.13.11.1

Structure representation of Query Specific File Request command payload.

See also

ZCL8 specification, subsection 11.13.10

Structure representation of Upgrade End Response command payload.

See also

ZCL8 specification, subsection 11.13.9.6.1

Structure representation of Upgrade End Request command payload.

See also

ZCL8 specification, subsection 11.13.9

OTA Upgrade cluster attribute identifiers.

See also

ZCL8 specification, subsection 11.10, Table 11-10. Attributes of OTA Upgrade Cluster

OTA Upgrade cluster client to server command identifiers.

See also

ZCL8 spec, Table 11-16

OTA File header - fc fields structure.

See also

ZCL8 specification, subsection 11.4.2.4, Table 11-3. OTA Header Field Control Bitmask

OTA File header - Image Type Values.

See also

ZCL8 specification, subsection 11.4.2.6, Table 11-4. Image Type Values

OTA File header - Security Credential Version.

See also

ZCL8 specification, subsection 11.4.2.11

OTA File header - Zigbee Stack version.

See also

ZCL8 specification, subsection 11.4.2.8

OTA Image Upgrade Status Attribute Values.

See also

ZCL8 specification, subsection 11.13.6.2.1

OTA Image Upgrade Status Attribute Values.

See also

ZCL8 specification, subsection 11.13.3.2.1

OTA Image Upgrade Status Attribute Values.

See also

ZCL8 specification, subsection 11.13.7.2.1

OTA Image Upgrade Status Attribute Values.

See also

ZCL8 specification, subsection 11.10.7

OTA Image Upgrade Status Attribute Values.

See also

ZCL8 specification, subsection 11.13.4.2.1

OTA Upgrade cluster server to client command identifiers.

See also

ZCL8 spec, Table 11-16

OTA File header - Tag Identifiers.

See also

ZCL8 specification, subsection 11.4.4

Clear attribute after upgrade.

Parameters

endpoint

- endpoint

Note

After calling this command OTA file may be removed from memory

Initialize OTA Upgrade cluster - client part For server clear custom data For client initiate search Upgrade server.

Parameters

param

- empty buffer

Initialize OTA Upgrade cluster - server part For server clear custom data and registry next data indication.

Parameters

endpoint	- destination endpoint
next_data_ind_cb	- callback to be called on received image block For client initiate search Upgrade server

Insert upgrade OTA file into Server upgrade table.

Parameters

param

- buffer with zb_zcl_ota_upgrade_server_insert_file_s structure

Note

Takes buffer ownership.

OTA file must be saved in memory until call zb_zcl_ota_upgrade_remove_file

Remove upgrade file from Server upgrade table.

Parameters

param

- buffer with zb_zcl_ota_upgrade_server_remove_file_s structure

Note

Takes buffer ownership.

After calling this command OTA file may be removed from memory

Resume process OTA Upgrade if it was previously suspended by the application.

Parameters

param	- buffer to be resumed
upgrade_status	- application upgrade status

See also

zb_zcl_ota_upgrade_status_e

Set Frequency request server about new upgrade file (minutes)

Parameters

endpoint	- endpoint of the OTA cluster
interval	- new interval value (in minutes)

Start OTA Upgrade client with pre-defined OTA Upgrade Server attributes (without Service Discovery)

Parameters

server_ep	- OTA Upgrade server endpoint
server_addr	- OTA Upgrade server short address

Returns

RET_OK on success or RET_ERROR on error

Abort OTA Upgrade process.

Parameters

endpoint	- endpoint for OTA Upgrade
param	- buffer to be aborted