Data Structures | |
struct | zb_zcl_ota_upgrade_file_header_s |
Structure representsation of OTA File Header, see OTA spec 6.3.2. More... | |
struct | zb_zcl_ota_upgrade_file_header_optional_s |
struct | zb_zcl_ota_upgrade_sub_element_s |
Structure representsation of OTA File Sub-element, see OTA spec 6.3.3. More... | |
struct | zb_zcl_ota_upgrade_ecdsa_s |
Structure representsation of OTA ECDSA Signature, see OTA spec 6.3.5. More... | |
struct | zb_zcl_ota_upgrade_ecdsa_signing_s |
Structure representsation of OTA ECDSA Signature, see OTA spec 6.3.6. More... | |
struct | zb_zcl_ota_upgrade_ecdsa_certificate_s |
Structure representsation of OTA ECDSA Certificate, see OTA spec 6.3.7. More... | |
struct | zb_zcl_ota_upgrade_server_insert_file_s |
Structure representsation of Data for insert OTA file to upgrade mechanizm. More... | |
struct | zb_zcl_ota_upgrade_server_remove_file_s |
Structure representsation of Data for insert OTA file to upgrade mechanizm. More... | |
struct | zb_zcl_ota_upgrade_data_s |
Structure representsation of OTA file on server side. More... | |
struct | zb_zcl_ota_upgrade_server_variable_s |
Structure representsation of server side variables. More... | |
struct | zb_zcl_ota_upgrade_srv_query_img_param_s |
struct | zb_zcl_ota_upgrade_srv_upgrade_end_param_s |
struct | zb_zcl_ota_upgrade_client_variable_s |
Structure representsation of client side variables. More... | |
struct | zb_zcl_ota_upgrade_query_next_image_s |
Structure representsation of Query Next Image Request command payload. More... | |
struct | zb_zcl_ota_upgrade_image_block_s |
Structure representsation of Image Block Request command payload. More... | |
struct | zb_zcl_ota_upgrade_image_page_s |
Structure representsation of Image Page Request command payload. More... | |
struct | zb_zcl_ota_upgrade_upgrade_end_s |
Structure representsation of Upgrade End Request command payload. More... | |
struct | zb_zcl_ota_upgrade_query_specific_file_s |
Structure representsation of Query Specific File Request command payload. More... | |
struct | zb_zcl_ota_upgrade_image_notify_s |
Structure representsation of Image Notify response command payload. More... | |
struct | zb_zcl_ota_upgrade_query_next_image_res_s |
Structure representsation of Query Next Image Response command payload. More... | |
struct | zb_zcl_ota_upgrade_image_block_res_s |
Structure representsation of Image Block Response command payload. More... | |
struct | zb_zcl_ota_upgrade_upgrade_end_res_s |
Structure representsation of Upgrade End Response command payload. More... | |
struct | zb_zcl_ota_upgrade_query_specific_file_res_s |
Structure representsation of Query Specific File Response command payload. More... | |
struct | zb_zcl_ota_upgrade_value_param_s |
Declare User Application about upgrade status. More... | |
Typedefs | |
typedef struct zb_zcl_ota_upgrade_value_param_s | zb_zcl_ota_upgrade_value_param_t |
Declare User Application about upgrade status. | |
Enumerations | |
enum | zb_zcl_ota_upgrade_status_e { ZB_ZCL_OTA_UPGRADE_STATUS_START, ZB_ZCL_OTA_UPGRADE_STATUS_APPLY, ZB_ZCL_OTA_UPGRADE_STATUS_RECEIVE, ZB_ZCL_OTA_UPGRADE_STATUS_FINISH, ZB_ZCL_OTA_UPGRADE_STATUS_ABORT, ZB_ZCL_OTA_UPGRADE_STATUS_CHECK, ZB_ZCL_OTA_UPGRADE_STATUS_OK, ZB_ZCL_OTA_UPGRADE_STATUS_ERROR, ZB_ZCL_OTA_UPGRADE_STATUS_REQUIRE_MORE_IMAGE, ZB_ZCL_OTA_UPGRADE_STATUS_BUSY } |
Possible statuses of OTA upgrade. | |
Functions | |
zb_void_t | zcl_ota_abort (zb_uint8_t endpoint, zb_uint8_t param) |
Abort OTA Upgrade process. More... | |
OTA File Header format | |
Hook on Write attribute send Check-in if change Check-in interval & Check-in remain time > new check-in interval Structures for representation OTA File Header | |
enum | zb_zcl_ota_upgrade_file_header_fc_e { ZB_ZCL_OTA_UPGRADE_FILE_HEADER_FC_CREDENTIAL_VER = 1 << 0, ZB_ZCL_OTA_UPGRADE_FILE_HEADER_FC_DEVICE_SPECIFIC = 1 << 1, ZB_ZCL_OTA_UPGRADE_FILE_HEADER_FC_HW_VER = 1 << 2 } |
OTA File header - fc fields structure. More... | |
enum | zb_zcl_ota_upgrade_file_header_image_type_e { ZB_ZCL_OTA_UPGRADE_FILE_HEADER_IMAGE_MANUF_SPEC_MAX = 0xffbf, ZB_ZCL_OTA_UPGRADE_FILE_HEADER_IMAGE_SECURITY_CRED = 0xffc0, ZB_ZCL_OTA_UPGRADE_FILE_HEADER_IMAGE_CONFIG = 0xffc1, ZB_ZCL_OTA_UPGRADE_FILE_HEADER_IMAGE_LOG = 0xffc2, ZB_ZCL_OTA_UPGRADE_FILE_HEADER_IMAGE_WILD_CARD = 0xffff } |
OTA File header - Image Type Values. More... | |
enum | zb_zcl_ota_upgrade_file_header_stack_version_e { ZB_ZCL_OTA_UPGRADE_FILE_HEADER_STACK_2006 = 0x0000, ZB_ZCL_OTA_UPGRADE_FILE_HEADER_STACK_2007 = 0x0001, ZB_ZCL_OTA_UPGRADE_FILE_HEADER_STACK_PRO = 0x0002, ZB_ZCL_OTA_UPGRADE_FILE_HEADER_STACK_IP = 0x0003 } |
OTA File header - Zigbee Stack version. More... | |
enum | zb_zcl_ota_upgrade_file_header_security_version_e { ZB_ZCL_OTA_UPGRADE_FILE_HEADER_SECURITY_VER_SE1_0 = 0x00, ZB_ZCL_OTA_UPGRADE_FILE_HEADER_SECURITY_VER_SE1_1 = 0x01, ZB_ZCL_OTA_UPGRADE_FILE_HEADER_SECURITY_VER_SE2_0 = 0x02 } |
OTA File header - Security Credential Version. More... | |
typedef struct zb_zcl_ota_upgrade_file_header_s | zb_zcl_ota_upgrade_file_header_t |
Structure representsation of OTA File Header, see OTA spec 6.3.2. | |
typedef struct zb_zcl_ota_upgrade_file_header_optional_s | zb_zcl_ota_upgrade_file_header_optional_t |
#define | ZB_ZCL_OTA_UPGRADE_FILE_HEADER_FILE_ID 0x0BEEF11E |
Default OTA Upgrade File Identifier, see spec 6.3.2.1. | |
#define | ZB_ZCL_OTA_UPGRADE_FILE_HEADER_FILE_VERSION 0x0100 |
Default OTA Upgrade File Version, see spec 6.3.2.2. | |
#define | ZB_ZCL_OTA_UPGRADE_FILE_HEADER_MANUFACTURE_CODE_WILD_CARD 0xffff |
Special Manufacturer Code, see spec 6.3.2.5. | |
#define | ZB_ZCL_OTA_UPGRADE_FILE_GET_APP_RELEASE(ver) (((ver) >>24) & 0xff) |
OTA Upgrade File Version, App release, see spec 6.3.2.7. | |
#define | ZB_ZCL_OTA_UPGRADE_FILE_GET_APP_BUILD(ver) (((ver) >>16) & 0xff) |
OTA Upgrade File Version, App build, see spec 6.3.2.7. | |
#define | ZB_ZCL_OTA_UPGRADE_FILE_GET_STACK_RELEASE(ver) (((ver) >>8) & 0xff) |
OTA Upgrade File Version, Stack release, see spec 6.3.2.7. | |
#define | ZB_ZCL_OTA_UPGRADE_FILE_GET_STACK_BUILD(ver) ((ver) & 0xff) |
OTA Upgrade File Version, Stack build, see spec 6.3.2.7. | |
#define | ZB_ZCL_OTA_UPGRADE_FILE_MAKE_VERSION(app_rel, app_build, stack_rel, stack_build) ((app_rel) << 24 | (app_build) << 16 | (stack_rel) << 8 | (stack_build)) |
OTA Upgrade File Version, make file verston, see spec 6.3.2.7. | |
#define | ZB_ZCL_OTA_UPGRADE_VERSION_CMP_WITHOUT_STACK(ver1, ver2) ( ((ver1) & 0xffff0000) != ((ver2) & 0xffff0000) ) |
Compare version with stack ver is any. | |
#define | ZB_ZCL_OTA_UPGRADE_VERSION_CMP_WITH_STACK_RELEASE_EQUAL(ver1, ver2) |
Compare version with stack release are equal. More... | |
#define | ZB_ZCL_OTA_UPGRADE_VERSION_CMP_WITH_STACK(ver1, ver2) |
Compare version with stack release are equal and stack build no less. More... | |
#define | ZB_ZCL_OTA_UPGRADE_FILE_GET_HW_VERSION(ver) (((ver) >>8) & 0xff) |
OTA Upgrade HW Version Get Version, see spec 6.3.2.13. | |
#define | ZB_ZCL_OTA_UPGRADE_FILE_GET_HW_REVISION(ver) ((ver) & 0xff) |
OTA Upgrade HW Version Get Revision, see spec 6.3.2.13. | |
#define | ZB_ZCL_OTA_UPGRADE_FILE_MAKE_HW_VERSION(ver, rev) ((ver) << 8 | (rev)) |
OTA Upgrade Make HW Version, see spec 6.3.2.13. | |
#define | ZB_ZCL_OTA_UPGRADE_FILE_HW_VERSION_DEF_VALUE 0xffff |
Default value of OTA Upgrade HW Version. | |
#define | ZB_ZCL_OTA_UPGRADE_FILE_DEST_ADDRESS_DEF_VALUE { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff } |
Default value of OTA Upgrade destanation address. | |
OTA File Sub-elementformat | |
enum | zb_zcl_ota_upgrade_sub_element_tags_e { ZB_ZCL_OTA_UPGRADE_FILE_TAG_UPGRADE_IMAGE = 0x0000, ZB_ZCL_OTA_UPGRADE_FILE_TAG_ECDSA = 0x0001, ZB_ZCL_OTA_UPGRADE_FILE_TAG_ECDSA_CERT = 0x0002, ZB_ZCL_OTA_UPGRADE_FILE_TAG_MANUF_MIN = 0xf000, ZB_ZCL_OTA_UPGRADE_FILE_TAG_MANUF_MAX = 0xffff } |
OTA File header - Tag Identifiers. More... | |
typedef struct zb_zcl_ota_upgrade_sub_element_s | zb_zcl_ota_upgrade_sub_element_t |
Structure representsation of OTA File Sub-element, see OTA spec 6.3.3. | |
typedef struct zb_zcl_ota_upgrade_ecdsa_s | zb_zcl_ota_upgrade_ecdsa_t |
Structure representsation of OTA ECDSA Signature, see OTA spec 6.3.5. | |
typedef struct zb_zcl_ota_upgrade_ecdsa_signing_s | zb_zcl_ota_upgrade_ecdsa_signing_t |
Structure representsation of OTA ECDSA Signature, see OTA spec 6.3.6. | |
typedef struct zb_zcl_ota_upgrade_ecdsa_certificate_s | zb_zcl_ota_upgrade_ecdsa_ertificate_t |
Structure representsation of OTA ECDSA Certificate, see OTA spec 6.3.7. | |
#define | ZB_ZCL_OTA_UPGRADE_ECDSA_TAG_ID 0x0001 |
Special Manufacturer Code, see spec 6.3.5. | |
#define | ZB_ZCL_OTA_UPGRADE_ECDSA_LENGTH 0x00000032 |
Special Manufacturer Code, see spec 6.3.5. | |
#define | ZB_ZCL_OTA_UPGRADE_ECDSA_SIGNING_TAG_ID 0x0002 |
Special Manufacturer Code, see spec 6.3.6. | |
#define | ZB_ZCL_OTA_UPGRADE_ECDSA_SIGNING_LENGTH 0x00000030 |
Special Manufacturer Code, see spec 6.3.6. | |
#define | ZB_ZCL_OTA_UPGRADE_ECDSA_CERTIFICATE_TAG_ID 0x0003 |
Special Manufacturer Code, see spec 6.3.7. | |
#define | ZB_ZCL_OTA_UPGRADE_ECDSA_CERTIFICATE_LENGTH 0x00000010 |
Special Manufacturer Code, see spec 6.3.7. | |
OTA Upgrade cluster attributes | |
enum | zb_zcl_ota_upgrade_attr_e { ZB_ZCL_ATTR_OTA_UPGRADE_SERVER_ID = 0x0000, ZB_ZCL_ATTR_OTA_UPGRADE_FILE_OFFSET_ID = 0x0001, ZB_ZCL_ATTR_OTA_UPGRADE_FILE_VERSION_ID = 0x0002, ZB_ZCL_ATTR_OTA_UPGRADE_STACK_VERSION_ID = 0x0003, ZB_ZCL_ATTR_OTA_UPGRADE_DOWNLOADED_FILE_VERSION_ID = 0x0004, ZB_ZCL_ATTR_OTA_UPGRADE_DOWNLOADED_STACK_VERSION_ID = 0x0005, ZB_ZCL_ATTR_OTA_UPGRADE_IMAGE_STATUS_ID = 0x0006, ZB_ZCL_ATTR_OTA_UPGRADE_MANUFACTURE_ID = 0x0007, ZB_ZCL_ATTR_OTA_UPGRADE_IMAGE_TYPE_ID = 0x0008, ZB_ZCL_ATTR_OTA_UPGRADE_MIN_BLOCK_REQUE_ID = 0x0009, ZB_ZCL_ATTR_OTA_UPGRADE_IMAGE_STAMP_ID = 0x000a, ZB_ZCL_ATTR_OTA_UPGRADE_UPGRADE_ACTIVATION_POLICY_ID = 0x000b, ZB_ZCL_ATTR_OTA_UPGRADE_UPGRADE_TIMEOUT_POLICY_ID = 0x000c, ZB_ZCL_ATTR_OTA_UPGRADE_SERVER_ENDPOINT_ID = 0xfff3, ZB_ZCL_ATTR_OTA_UPGRADE_SERVER_ADDR_ID = 0xfff2, ZB_ZCL_ATTR_OTA_UPGRADE_CLIENT_DATA_ID = 0xfff1, ZB_ZCL_ATTR_OTA_UPGRADE_SERVER_DATA_ID = 0xfff0 } |
OTA Upgrade cluster attribute identifiers. More... | |
enum | zb_zcl_ota_upgrade_image_status_e { ZB_ZCL_OTA_UPGRADE_IMAGE_STATUS_NORMAL = 0x00, ZB_ZCL_OTA_UPGRADE_IMAGE_STATUS_DOWNLOADING = 0x01, ZB_ZCL_OTA_UPGRADE_IMAGE_STATUS_DOWNLOADED = 0x02, ZB_ZCL_OTA_UPGRADE_IMAGE_STATUS_WAITING_UPGRADE = 0x03, ZB_ZCL_OTA_UPGRADE_IMAGE_STATUS_COUNT_DOWN = 0x04, ZB_ZCL_OTA_UPGRADE_IMAGE_STATUS_WAIT_FOR_MORE = 0x05 } |
OTA Image Upgrade Status Attribute Values. More... | |
typedef zb_uint8_t *(* | zb_zcl_ota_upgrade_next_data_ind_t )(zb_uint8_t index, zb_uint32_t offset, zb_uint8_t size) |
Callback function for send next data portion. More... | |
typedef struct zb_zcl_ota_upgrade_server_insert_file_s | zb_zcl_ota_upgrade_server_insert_file_t |
Structure representsation of Data for insert OTA file to upgrade mechanizm. | |
typedef struct zb_zcl_ota_upgrade_server_remove_file_s | zb_zcl_ota_upgrade_server_remove_file_t |
Structure representsation of Data for insert OTA file to upgrade mechanizm. | |
typedef struct zb_zcl_ota_upgrade_data_s | zb_zcl_ota_upgrade_data_t |
Structure representsation of OTA file on server side. | |
typedef struct zb_zcl_ota_upgrade_server_variable_s | zb_zcl_ota_upgrade_server_variable_t |
Structure representsation of server side variables. | |
typedef struct zb_zcl_ota_upgrade_srv_query_img_param_s | zb_zcl_ota_upgrade_srv_query_img_param_t |
typedef struct zb_zcl_ota_upgrade_srv_upgrade_end_param_s | zb_zcl_ota_upgrade_srv_upgrade_end_param_t |
typedef struct zb_zcl_ota_upgrade_client_variable_s | zb_zcl_ota_upgrade_client_variable_t |
Structure representsation of client side variables. | |
zb_void_t | zb_zcl_ota_upgrade_init_server (zb_uint8_t endpoint, zb_zcl_ota_upgrade_next_data_ind_t next_data_ind_cb) |
Initialize OTA Upgrade cluster - server part For server clear custom data and registry next data indication. More... | |
zb_ret_t | zb_zcl_ota_upgrade_insert_file (zb_uint8_t param) |
Insert upgrade OTA file into Server upgrade table. More... | |
zb_ret_t | zb_zcl_ota_upgrade_remove_file (zb_uint8_t param) |
Remove upgrade file from Server upgrade table. More... | |
zb_void_t | zb_zcl_ota_upgrade_init_client (zb_uint8_t param) |
Initialize OTA Upgrade cluster - client part For server clear custom data For client initiate search Upgrade server. More... | |
zb_void_t | zb_zcl_ota_upgrade_stop_client (void) |
Stop process OTA Upgrade / OTA query new images Client stop shedule OTA command & clear OTA status. | |
zb_void_t | zb_zcl_ota_upgrade_resume_client (zb_uint8_t param, zb_uint8_t upgrade_status) |
Resume process OTA Upgrade if it was previously suspended by the application. More... | |
zb_void_t | zb_zcl_ota_upgrade_set_query_interval (zb_uint8_t endpoint, zb_uint16_t interval) |
Set Freqency request server about new upgrade file (minutes) More... | |
zb_void_t | zb_zcl_ota_upgrade_file_upgraded (zb_uint8_t endpoint) |
Clear attribute after upgrade. More... | |
#define | ZB_ZCL_OTA_UPGRADE_QUERY_IMAGE_BLOCK_DATA_SIZE_MAX 64 |
Maximum size data for Query Image Block Request. | |
#define | ZB_ZCL_OTA_UPGRADE_INSERT_FILE(buf, ep, i, file, upgrade_tm) |
#define | ZB_ZCL_OTA_UPGRADE_REMOVE_FILE(buf, ep, i) |
#define | ZB_ZCL_OTA_UPGRADE_DATA_SIZE_DEF_VALUE 0xff |
Default value for DataSize, OTA spec. | |
#define | ZB_ZCL_OTA_UPGRADE_QUERY_JITTER_MIN_VALUE 0x01 |
Minimum value for QueryJitter, OTA spec. | |
#define | ZB_ZCL_OTA_UPGRADE_QUERY_JITTER_MAX_VALUE 0x64 |
Maximum value for QueryJitter, OTA spec. | |
#define | ZB_ZCL_OTA_UPGRADE_QUERY_JITTER_DEF_VALUE 0x32 |
Default value for QueryJitter, OTA spec. | |
#define | ZB_ZCL_OTA_UPGRADE_CURRENT_TIME_DEF_VALUE 0xffffffff |
Default value for currentTime, OTA spec. | |
#define | ZB_ZCL_OTA_UPGRADE_UPGRADE_TIME_DEF_VALUE 0xffffffff |
Default value for UpgradeTime, OTA spec. | |
#define | ZB_ZCL_OTA_UPGRADE_SERVER_DEF_VALUE { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff } |
Default value for UpgradeServerID attribute, OTA spec 6.7.1. | |
#define | ZB_ZCL_OTA_UPGRADE_FILE_OFFSET_DEF_VALUE 0xffffffff |
Default value for FileOffset attribute, OTA spec 6.7.2. | |
#define | ZB_ZCL_OTA_UPGRADE_FILE_VERSION_DEF_VALUE 0xffffffff |
Default value for CurrentFileVersion attribute, OTA spec 6.7.3. | |
#define | ZB_ZCL_OTA_UPGRADE_STACK_VERSION_DEF_VALUE 0xffff |
Default value for CurrentZigbeeStackVersion attribute, OTA spec 6.7.4. | |
#define | ZB_ZCL_OTA_UPGRADE_DOWNLOADED_FILE_VERSION_DEF_VALUE 0xffffffff |
Default value for DownloadedFileVersion attribute, OTA spec 6.7.5. | |
#define | ZB_ZCL_OTA_UPGRADE_DOWNLOADED_STACK_DEF_VALUE 0xffff |
Default value for DownloadedZigbeeStackVersion attribute, OTA spec 6.7.6. | |
#define | ZB_ZCL_OTA_UPGRADE_IMAGE_STATUS_DEF_VALUE 0x00 |
Default value for ImageUpgradeStatus attribute, OTA spec 6.7.7. | |
#define | ZB_ZCL_OTA_UPGRADE_IMAGE_STAMP_MIN_VALUE 0x0256 |
Maximum value for MinimumBlockReque attribute, OTA spec 6.7.11. | |
#define | ZB_ZCL_OTA_UPGRADE_QUERY_TIMER_COUNT_DEF (24*60) |
Default Freqency request server about new upgrade file (minutes) | |
#define | ZB_ZCL_OTA_UPGRADE_QUERY_TIMER_INTERVAL 60l * ZB_TIME_ONE_SECOND |
Timer interval for Query timer. | |
#define | ZB_ZCL_OTA_UPGRADE_MAX_INTERVAL 60 |
Maximum value of nextImageQuery interval. | |
#define | ZB_ZCL_OTA_UPGRADE_RESEND_BUFFER_DELAY ZB_TIME_ONE_SECOND * 45 |
Resend buffer delay. | |
#define | ZB_ZCL_DECLARE_OTA_UPGRADE_ATTRIB_LIST(attr_list,upgrade_server, file_offset, file_version, stack_version, downloaded_file_ver,downloaded_stack_ver, image_status, manufacturer, image_type, min_block_reque, image_stamp,server_addr, server_ep, hardware_version, max_data_size, query_timer) |
Declare attribute list for OTA Upgrade cluster - client side. More... | |
#define | ZB_ZCL_DECLARE_OTA_UPGRADE_ATTRIB_LIST_SERVER(attr_list,query_jitter, current_time, length) |
Declare attribute list for OTA Upgrade cluster - server side. More... | |
OTA Upgrade cluster commands | |
enum | zb_zcl_ota_upgrade_cmd_e { ZB_ZCL_CMD_OTA_UPGRADE_QUERY_NEXT_IMAGE_ID = 0x01, ZB_ZCL_CMD_OTA_UPGRADE_IMAGE_BLOCK_ID = 0x03, ZB_ZCL_CMD_OTA_UPGRADE_IMAGE_PAGE_ID = 0x04, ZB_ZCL_CMD_OTA_UPGRADE_UPGRADE_END_ID = 0x06, ZB_ZCL_CMD_OTA_UPGRADE_QUERY_SPECIFIC_FILE_ID = 0x08 } |
OTA Upgrade cluster client to server command identifiers. More... | |
enum | zb_zcl_ota_upgrade_resp_cmd_e { ZB_ZCL_CMD_OTA_UPGRADE_IMAGE_NOTIFY_ID = 0x00, ZB_ZCL_CMD_OTA_UPGRADE_QUERY_NEXT_IMAGE_RESP_ID = 0x02, ZB_ZCL_CMD_OTA_UPGRADE_IMAGE_BLOCK_RESP_ID = 0x05, ZB_ZCL_CMD_OTA_UPGRADE_UPGRADE_END_RESP_ID = 0x07, ZB_ZCL_CMD_OTA_UPGRADE_QUERY_SPECIFIC_FILE_RESP_ID = 0x09 } |
OTA Upgrade cluster server to client command identifiers. More... | |
enum | zb_zcl_ota_upgrade_query_next_image_fc_e { ZB_ZCL_OTA_UPGRADE_QUERY_NEXT_IMAGE_HW_VERSION = 1 << 0 } |
OTA Image Upgrade Status Attribute Values. More... | |
enum | zb_zcl_ota_upgrade_image_block_fc_e { ZB_ZCL_OTA_UPGRADE_QUERY_IMAGE_BLOCK_IEEE_PRESENT = 1 << 0, ZB_ZCL_OTA_UPGRADE_QUERY_IMAGE_BLOCK_DELAY_PRESENT = 1 << 1 } |
OTA Image Upgrade Status Attribute Values. More... | |
enum | zb_zcl_ota_upgrade_image_page_fc_e { ZB_ZCL_OTA_UPGRADE_QUERY_IMAGE_PAGE_IEEE_PRESENT = 1 << 0 } |
OTA Image Upgrade Status Attribute Values. More... | |
enum | zb_zcl_ota_upgrade_image_notify_payload_type_e { ZB_ZCL_OTA_UPGRADE_IMAGE_NOTIFY_PAYLOAD_JITTER = 0x00, ZB_ZCL_OTA_UPGRADE_IMAGE_NOTIFY_PAYLOAD_JITTER_CODE = 0x01, ZB_ZCL_OTA_UPGRADE_IMAGE_NOTIFY_PAYLOAD_JITTER_CODE_IMAGE = 0x02, ZB_ZCL_OTA_UPGRADE_IMAGE_NOTIFY_PAYLOAD_JITTER_CODE_IMAGE_VER = 0x03 } |
OTA Image Upgrade Status Attribute Values. More... | |
typedef struct zb_zcl_ota_upgrade_query_next_image_s | zb_zcl_ota_upgrade_query_next_image_t |
Structure representsation of Query Next Image Request command payload. More... | |
typedef struct zb_zcl_ota_upgrade_image_block_s | zb_zcl_ota_upgrade_image_block_t |
Structure representsation of Image Block Request command payload. More... | |
typedef struct zb_zcl_ota_upgrade_image_page_s | zb_zcl_ota_upgrade_image_page_t |
Structure representsation of Image Page Request command payload. More... | |
typedef struct zb_zcl_ota_upgrade_upgrade_end_s | zb_zcl_ota_upgrade_upgrade_end_t |
Structure representsation of Upgrade End Request command payload. More... | |
typedef struct zb_zcl_ota_upgrade_query_specific_file_s | zb_zcl_ota_upgrade_query_specific_file_t |
Structure representsation of Query Specific File Request command payload. More... | |
typedef struct zb_zcl_ota_upgrade_image_notify_s | zb_zcl_ota_upgrade_image_notify_t |
Structure representsation of Image Notify response command payload. More... | |
typedef struct zb_zcl_ota_upgrade_query_next_image_res_s | zb_zcl_ota_upgrade_query_next_image_res_t |
Structure representsation of Query Next Image Response command payload. More... | |
typedef struct zb_zcl_ota_upgrade_image_block_res_s | zb_zcl_ota_upgrade_image_block_res_t |
Structure representsation of Image Block Response command payload. More... | |
typedef struct zb_zcl_ota_upgrade_upgrade_end_res_s | zb_zcl_ota_upgrade_upgrade_end_res_t |
Structure representsation of Upgrade End Response command payload. More... | |
typedef struct zb_zcl_ota_upgrade_query_specific_file_res_s | zb_zcl_ota_upgrade_query_specific_file_res_t |
Structure representsation of Query Specific File Response command payload. More... | |
#define | ZB_ZCL_OTA_UPGRADE_SEND_QUERY_NEXT_IMAGE_REQ(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb,fc, manufacturer, image_type, file_version, hw_version) |
Send "Query Next Image Request" command, see OTA spec 6.10.4. More... | |
#define | ZB_ZCL_OTA_UPGRADE_GET_QUERY_NEXT_IMAGE_REQ(data_ptr, buffer, status) |
Macro for getting "Query Next Image Request" command, see OTA spec 6.10.4. More... | |
#define | ZB_ZCL_OTA_UPGRADE_SEND_IMAGE_BLOCK_REQ(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb,fc, manufacturer, image_type, file_version, file_offset, data_size_max, node_addr, block_delay, current_delay) |
Send "Image Block Request" command, see OTA spec 6.10.6. More... | |
#define | ZB_ZCL_OTA_UPGRADE_GET_IMAGE_BLOCK_REQ(data_ptr, buffer, status) |
Macro for getting "Image Block Request" command, see OTA spec 6.10.6. More... | |
#define | ZB_ZCL_OTA_UPGRADE_SEND_IMAGE_PAGE_REQ(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb,fc, manufacturer, image_type, file_version, file_offset, data_size_max, page_size, response_spacing, node_addr) |
Send "Image Page Request" command, see OTA spec 6.10.7. More... | |
#define | ZB_ZCL_OTA_UPGRADE_GET_IMAGE_PAGE_REQ(data_ptr, buffer, status) |
Macro for getting "Image Page Request" command, see OTA spec 6.10.7. More... | |
#define | ZB_ZCL_OTA_UPGRADE_SEND_UPGRADE_END_REQ(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb,status, manufacturer, image_type, file_version) |
OTA Image Upgrade Status Attribute Values. More... | |
#define | ZB_ZCL_OTA_UPGRADE_GET_UPGRADE_END_REQ(data_ptr, buffer, status_) |
Macro for getting "Upgrade End Request" command, see OTA spec 6.10.9. More... | |
#define | ZB_ZCL_OTA_UPGRADE_SEND_QUERY_SPECIFIC_FILE_REQ(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb,node_addr, manufacturer, image_type, file_version, stack_version) |
Send "Query Specific File Request" command, see OTA spec 6.10.11. More... | |
#define | ZB_ZCL_OTA_UPGRADE_GET_QUERY_SPECIFIC_FILE_REQ(data_ptr, buffer, status) |
Macro for getting "Query Specific File Request" command, see OTA spec 6.10.11. More... | |
#define | ZB_ZCL_OTA_UPGRADE_SEND_IMAGE_NOTIFY_REQ(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb,payload_type, query_jitter, manufacturer, image_type, file_version) |
Send Image Notify command, see OTA spec 6.10.3. More... | |
#define | ZB_ZCL_OTA_UPGRADE_GET_IMAGE_NOTIFY_REQ(data_ptr, buffer, status) |
#define | ZB_ZCL_OTA_UPGRADE_SEND_QUERY_NEXT_IMAGE_RES(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, seq,status, manufacturer, image_type, file_version, image_size) |
Send Query Next Image Response command, see OTA spec 6.10.5. More... | |
#define | ZB_ZCL_OTA_UPGRADE_GET_QUERY_NEXT_IMAGE_RES(data_ptr, buffer, status_) |
Macro for getting Query Next Image Response command, see OTA spec 6.10.5. More... | |
#define | ZB_ZCL_OTA_UPGRADE_SEND_IMAGE_BLOCK_SUCCESS_RES(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, seq,manufacturer, image_type, file_version, file_offset, data_size, image_data) |
Send Image Block Response command - success status, see OTA spec 6.10.8. More... | |
#define | ZB_ZCL_OTA_UPGRADE_SEND_IMAGE_BLOCK_WAIT_FOR_DATA_RES(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, seq,current_time, request_time, delay) |
Send Image Block Response command - wait for data status, see OTA spec 6.10.8. More... | |
#define | ZB_ZCL_OTA_UPGRADE_SEND_IMAGE_BLOCK_ABORT_RES(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, seq) |
Send Image Block Response command - abort status, see OTA spec 6.10.8. More... | |
#define | ZB_ZCL_OTA_UPGRADE_GET_IMAGE_BLOCK_RES(data_ptr, buffer, status_) |
Macro for getting Image Block Response command, see OTA spec 6.10.8. More... | |
#define | ZB_ZCL_OTA_UPGRADE_SEND_UPGRADE_END_RES(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, seq,manufacturer, image_type, file_version, current_time, upgrade_time) |
Send Upgrade End Response command, see OTA spec 6.10.10. More... | |
#define | ZB_ZCL_OTA_UPGRADE_GET_UPGRADE_END_RES(data_ptr, buffer, status_) |
Macro for getting Upgrade End Response command, see OTA spec 6.10.10. More... | |
#define | ZB_ZCL_OTA_UPGRADE_SEND_QUERY_SPECIFIC_FILE_RES(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, seq,status, manufacturer, image_type, file_version, image_size) |
Send Query Specific File Response command, see OTA spec 6.10.12. More... | |
#define | ZB_ZCL_OTA_UPGRADE_GET_QUERY_SPECIFIC_FILE_RES(data_ptr, buffer, status_) |
Macro for getting Query Specific File Response command, see OTA spec 6.10.12. More... | |
All commands in the cluster have only request form, and carry no payload.
#define ZB_ZCL_DECLARE_OTA_UPGRADE_ATTRIB_LIST | ( | attr_list, | |
upgrade_server, | |||
file_offset, | |||
file_version, | |||
stack_version, | |||
downloaded_file_ver, | |||
downloaded_stack_ver, | |||
image_status, | |||
manufacturer, | |||
image_type, | |||
min_block_reque, | |||
image_stamp, | |||
server_addr, | |||
server_ep, | |||
hardware_version, | |||
max_data_size, | |||
query_timer | |||
) |
Declare attribute list for OTA Upgrade cluster - client side.
endcond
attr_list | - attribure 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 |
#define ZB_ZCL_DECLARE_OTA_UPGRADE_ATTRIB_LIST_SERVER | ( | attr_list, | |
query_jitter, | |||
current_time, | |||
length | |||
) |
Declare attribute list for OTA Upgrade cluster - server side.
attr_list | - attribure 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 |
#define ZB_ZCL_OTA_UPGRADE_GET_IMAGE_BLOCK_REQ | ( | data_ptr, | |
buffer, | |||
status | |||
) |
Macro for getting "Image Block Request" command, see OTA spec 6.10.6.
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). |
#define ZB_ZCL_OTA_UPGRADE_GET_IMAGE_BLOCK_RES | ( | data_ptr, | |
buffer, | |||
status_ | |||
) |
Macro for getting Image Block Response command, see OTA spec 6.10.8.
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 place`s in buffer, payload saves pointer to data only!
#define ZB_ZCL_OTA_UPGRADE_GET_IMAGE_NOTIFY_REQ | ( | data_ptr, | |
buffer, | |||
status | |||
) |
#define ZB_ZCL_OTA_UPGRADE_GET_IMAGE_PAGE_REQ | ( | data_ptr, | |
buffer, | |||
status | |||
) |
Macro for getting "Image Page Request" command, see OTA spec 6.10.7.
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). |
#define ZB_ZCL_OTA_UPGRADE_GET_QUERY_NEXT_IMAGE_REQ | ( | data_ptr, | |
buffer, | |||
status | |||
) |
Macro for getting "Query Next Image Request" command, see OTA spec 6.10.4.
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). |
#define ZB_ZCL_OTA_UPGRADE_GET_QUERY_NEXT_IMAGE_RES | ( | data_ptr, | |
buffer, | |||
status_ | |||
) |
Macro for getting Query Next Image Response command, see OTA spec 6.10.5.
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). |
#define ZB_ZCL_OTA_UPGRADE_GET_QUERY_SPECIFIC_FILE_REQ | ( | data_ptr, | |
buffer, | |||
status | |||
) |
Macro for getting "Query Specific File Request" command, see OTA spec 6.10.11.
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). |
#define ZB_ZCL_OTA_UPGRADE_GET_QUERY_SPECIFIC_FILE_RES | ( | data_ptr, | |
buffer, | |||
status_ | |||
) |
Macro for getting Query Specific File Response command, see OTA spec 6.10.12.
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). |
#define ZB_ZCL_OTA_UPGRADE_GET_UPGRADE_END_REQ | ( | data_ptr, | |
buffer, | |||
status_ | |||
) |
Macro for getting "Upgrade End Request" command, see OTA spec 6.10.9.
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). |
#define ZB_ZCL_OTA_UPGRADE_GET_UPGRADE_END_RES | ( | data_ptr, | |
buffer, | |||
status_ | |||
) |
Macro for getting Upgrade End Response command, see OTA spec 6.10.10.
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). |
#define ZB_ZCL_OTA_UPGRADE_INSERT_FILE | ( | buf, | |
ep, | |||
i, | |||
file, | |||
upgrade_tm | |||
) |
#define ZB_ZCL_OTA_UPGRADE_REMOVE_FILE | ( | buf, | |
ep, | |||
i | |||
) |
#define ZB_ZCL_OTA_UPGRADE_SEND_IMAGE_BLOCK_ABORT_RES | ( | buffer, | |
addr, | |||
dst_addr_mode, | |||
dst_ep, | |||
ep, | |||
prfl_id, | |||
seq | |||
) |
Send Image Block Response command - abort status, see OTA spec 6.10.8.
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 |
#define ZB_ZCL_OTA_UPGRADE_SEND_IMAGE_BLOCK_REQ | ( | buffer, | |
addr, | |||
dst_addr_mode, | |||
dst_ep, | |||
ep, | |||
prfl_id, | |||
def_resp, | |||
cb, | |||
fc, | |||
manufacturer, | |||
image_type, | |||
file_version, | |||
file_offset, | |||
data_size_max, | |||
node_addr, | |||
block_delay, | |||
current_delay | |||
) |
Send "Image Block Request" command, see OTA spec 6.10.6.
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) |
#define ZB_ZCL_OTA_UPGRADE_SEND_IMAGE_BLOCK_SUCCESS_RES | ( | buffer, | |
addr, | |||
dst_addr_mode, | |||
dst_ep, | |||
ep, | |||
prfl_id, | |||
seq, | |||
manufacturer, | |||
image_type, | |||
file_version, | |||
file_offset, | |||
data_size, | |||
image_data | |||
) |
Send Image Block Response command - success status, see OTA spec 6.10.8.
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 |
#define ZB_ZCL_OTA_UPGRADE_SEND_IMAGE_BLOCK_WAIT_FOR_DATA_RES | ( | buffer, | |
addr, | |||
dst_addr_mode, | |||
dst_ep, | |||
ep, | |||
prfl_id, | |||
seq, | |||
current_time, | |||
request_time, | |||
delay | |||
) |
Send Image Block Response command - wait for data status, see OTA spec 6.10.8.
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 |
#define ZB_ZCL_OTA_UPGRADE_SEND_IMAGE_NOTIFY_REQ | ( | buffer, | |
addr, | |||
dst_addr_mode, | |||
dst_ep, | |||
ep, | |||
prfl_id, | |||
def_resp, | |||
cb, | |||
payload_type, | |||
query_jitter, | |||
manufacturer, | |||
image_type, | |||
file_version | |||
) |
Send Image Notify command, see OTA spec 6.10.3.
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 |
#define ZB_ZCL_OTA_UPGRADE_SEND_IMAGE_PAGE_REQ | ( | buffer, | |
addr, | |||
dst_addr_mode, | |||
dst_ep, | |||
ep, | |||
prfl_id, | |||
def_resp, | |||
cb, | |||
fc, | |||
manufacturer, | |||
image_type, | |||
file_version, | |||
file_offset, | |||
data_size_max, | |||
page_size, | |||
response_spacing, | |||
node_addr | |||
) |
Send "Image Page Request" command, see OTA spec 6.10.7.
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 |
#define ZB_ZCL_OTA_UPGRADE_SEND_QUERY_NEXT_IMAGE_REQ | ( | buffer, | |
addr, | |||
dst_addr_mode, | |||
dst_ep, | |||
ep, | |||
prfl_id, | |||
def_resp, | |||
cb, | |||
fc, | |||
manufacturer, | |||
image_type, | |||
file_version, | |||
hw_version | |||
) |
Send "Query Next Image Request" command, see OTA spec 6.10.4.
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 |
#define ZB_ZCL_OTA_UPGRADE_SEND_QUERY_NEXT_IMAGE_RES | ( | buffer, | |
addr, | |||
dst_addr_mode, | |||
dst_ep, | |||
ep, | |||
prfl_id, | |||
seq, | |||
status, | |||
manufacturer, | |||
image_type, | |||
file_version, | |||
image_size | |||
) |
Send Query Next Image Response command, see OTA spec 6.10.5.
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 zb_zcl_status_e |
manufacturer | - Manufacturer code |
image_type | - Image type |
file_version | - File version |
image_size | - Image size |
#define ZB_ZCL_OTA_UPGRADE_SEND_QUERY_SPECIFIC_FILE_REQ | ( | buffer, | |
addr, | |||
dst_addr_mode, | |||
dst_ep, | |||
ep, | |||
prfl_id, | |||
def_resp, | |||
cb, | |||
node_addr, | |||
manufacturer, | |||
image_type, | |||
file_version, | |||
stack_version | |||
) |
Send "Query Specific File Request" command, see OTA spec 6.10.11.
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 |
#define ZB_ZCL_OTA_UPGRADE_SEND_QUERY_SPECIFIC_FILE_RES | ( | buffer, | |
addr, | |||
dst_addr_mode, | |||
dst_ep, | |||
ep, | |||
prfl_id, | |||
seq, | |||
status, | |||
manufacturer, | |||
image_type, | |||
file_version, | |||
image_size | |||
) |
Send Query Specific File Response command, see OTA spec 6.10.12.
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 zb_zcl_status_e |
manufacturer | - Manufacturer code |
image_type | - Image type |
file_version | - File version |
image_size | - Image size |
#define ZB_ZCL_OTA_UPGRADE_SEND_UPGRADE_END_REQ | ( | buffer, | |
addr, | |||
dst_addr_mode, | |||
dst_ep, | |||
ep, | |||
prfl_id, | |||
def_resp, | |||
cb, | |||
status, | |||
manufacturer, | |||
image_type, | |||
file_version | |||
) |
OTA Image Upgrade Status Attribute Values.
Send "Upgrade End Request" command, see OTA spec 6.10.9
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 zb_zcl_status_e |
manufacturer | - Manufacturer code |
image_type | - Image type |
file_version | - File version |
#define ZB_ZCL_OTA_UPGRADE_SEND_UPGRADE_END_RES | ( | buffer, | |
addr, | |||
dst_addr_mode, | |||
dst_ep, | |||
ep, | |||
prfl_id, | |||
seq, | |||
manufacturer, | |||
image_type, | |||
file_version, | |||
current_time, | |||
upgrade_time | |||
) |
Send Upgrade End Response command, see OTA spec 6.10.10.
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 |
#define ZB_ZCL_OTA_UPGRADE_VERSION_CMP_WITH_STACK | ( | ver1, | |
ver2 | |||
) |
Compare version with stack release are equal and stack build no less.
#define ZB_ZCL_OTA_UPGRADE_VERSION_CMP_WITH_STACK_RELEASE_EQUAL | ( | ver1, | |
ver2 | |||
) |
Compare version with stack release are equal.
Optional parts of the OTA file header (commented out in the standard ZCL header)
Structure representsation of Image Block Response command payload.
typedef struct zb_zcl_ota_upgrade_image_block_s zb_zcl_ota_upgrade_image_block_t |
Structure representsation of Image Block Request command payload.
Structure representsation of Image Notify response command payload.
typedef struct zb_zcl_ota_upgrade_image_page_s zb_zcl_ota_upgrade_image_page_t |
Structure representsation of Image Page Request command payload.
typedef zb_uint8_t*(* zb_zcl_ota_upgrade_next_data_ind_t)(zb_uint8_t index, zb_uint32_t offset, zb_uint8_t size) |
Callback function for send next data portion.
Structure representsation of Query Next Image Response command payload.
Structure representsation of Query Next Image Request command payload.
typedef struct zb_zcl_ota_upgrade_query_specific_file_res_s zb_zcl_ota_upgrade_query_specific_file_res_t |
Structure representsation of Query Specific File Response command payload.
Structure representsation of Query Specific File Request command payload.
Structure representsation of Upgrade End Response command payload.
typedef struct zb_zcl_ota_upgrade_upgrade_end_s zb_zcl_ota_upgrade_upgrade_end_t |
Structure representsation of Upgrade End Request command payload.
OTA Upgrade cluster attribute identifiers.
OTA Upgrade cluster client to server command identifiers.
OTA File header - fc fields structure.
OTA File header - Image Type Values.
OTA File header - Zigbee Stack version.
OTA Image Upgrade Status Attribute Values.
OTA Image Upgrade Status Attribute Values.
OTA Upgrade cluster server to client command identifiers.
OTA File header - Tag Identifiers.
zb_void_t zb_zcl_ota_upgrade_file_upgraded | ( | zb_uint8_t | endpoint | ) |
Clear attribute after upgrade.
endpoint | - endpoint |
note: after coll this command OTA file may be remove from memory
zb_void_t zb_zcl_ota_upgrade_init_client | ( | zb_uint8_t | param | ) |
Initialize OTA Upgrade cluster - client part For server clear custom data For client initiate search Upgrade server.
param | - empty buffer |
zb_void_t zb_zcl_ota_upgrade_init_server | ( | zb_uint8_t | endpoint, |
zb_zcl_ota_upgrade_next_data_ind_t | next_data_ind_cb | ||
) |
Initialize OTA Upgrade cluster - server part For server clear custom data and registry next data indication.
endpoint | - destination endpoint |
next_data_ind_cb | - callback to be called on received image block For client initiate search Upgrade server |
zb_ret_t zb_zcl_ota_upgrade_insert_file | ( | zb_uint8_t | param | ) |
Insert upgrade OTA file into Server upgrade table.
param | - buffer with zb_zcl_ota_upgrade_server_insert_file_s structure |
note: OTA file must saved in memory until call 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.
param | - buffer with zb_zcl_ota_upgrade_server_remove_file_s structure |
note: after coll this command OTA file may be remove from memory
zb_void_t zb_zcl_ota_upgrade_resume_client | ( | zb_uint8_t | param, |
zb_uint8_t | upgrade_status | ||
) |
Resume process OTA Upgrade if it was previously suspended by the application.
param | - buffer to be resumed |
upgrade_status | - application upgrade status |
zb_void_t zb_zcl_ota_upgrade_set_query_interval | ( | zb_uint8_t | endpoint, |
zb_uint16_t | interval | ||
) |
Set Freqency request server about new upgrade file (minutes)
endpoint | - endpoint of the OTA cluster |
interval | - new interval value (in minutes) |
zb_void_t zcl_ota_abort | ( | zb_uint8_t | endpoint, |
zb_uint8_t | param | ||
) |
Abort OTA Upgrade process.
endpoint | - endpoint for OTA Upgrade |
param | - buffer to be aborted |