ZCL OTA
Zigbee Cluster Library (ZCL) ota upgrade cluster usage definition for ESP Zigbee SDK.
Header File
Macros
-
ESP_ZB_ZCL_OTA_UPGRADE_SERVER_DEF_VALUE
Default value for UpgradeServerID attribute.
-
ESP_ZB_ZCL_OTA_UPGRADE_FILE_OFFSET_DEF_VALUE
Default value for FileOffset attribute.
-
ESP_ZB_ZCL_OTA_UPGRADE_FILE_VERSION_DEF_VALUE
Default value for CurrentFileVersion attribute.
-
ESP_ZB_ZCL_OTA_UPGRADE_STACK_VERSION_DEF_VALUE
Default value for CurrentZigbeeStackVersion attribute.
-
ESP_ZB_ZCL_OTA_UPGRADE_DOWNLOADED_FILE_VERSION_DEF_VALUE
Default value for DownloadedFileVersion attribute.
-
ESP_ZB_ZCL_OTA_UPGRADE_DOWNLOADED_STACK_DEF_VALUE
Default value for DownloadedZigbeeStackVersion attribute.
-
ESP_ZB_OTA_UPGRADE_MANUFACTURER_CODE_DEF_VALUE
Default value for ManufacturerCode attribute.
-
ESP_ZB_OTA_UPGRADE_IMAGE_TYPE_DEF_VALUE
Default value for ImageType attribute.
-
ESP_ZB_OTA_UPGRADE_MANUFACTURER_SPECIFIC_IMAGE_TYPE_MIN_VALUE
Manufacturer Specific minimun value for ImageType attribute.
-
ESP_ZB_OTA_UPGRADE_MANUFACTURER_SPECIFIC_IMAGE_TYPE_MAX_VALUE
Manufacturer Specific maximum value for ImageType attribute.
-
ESP_ZB_OTA_UPGRADE_CLI_SECURITY_CREDENTIALS_IMAGE_TYPE_VALUE
Client Security credentials value for ImageType attribute.
-
ESP_ZB_OTA_UPGRADE_CLI_CONFIG_IMAGE_TYPE_VALUE
Client Configuration value for ImageType attribute.
-
ESP_ZB_OTA_UPGRADE_SERVER_LOG_IMAGE_TYPE_VALUE
Server Log value for ImageType attribute.
-
ESP_ZB_OTA_UPGRADE_PICTURE_IMAGE_TYPE_VALUE
Picture value for ImageType attribute.
-
ESP_ZB_OTA_UPGRADE_WILD_CARD_IMAGE_TYPE_VALUE
Wild card value for ImageType attribute.
-
ESP_ZB_ZCL_OTA_UPGRADE_IMAGE_STATUS_DEF_VALUE
Default value for ImageUpgradeStatus attribute.
-
ESP_ZB_OTA_UPGRADE_MIN_BLOCK_PERIOD_DEF_VALUE
Default value for MinimumBlockPeriod attribute.
-
ESP_ZB_ZCL_OTA_UPGRADE_IMAGE_STAMP_DEF_VALUE
Maximum value for ImageStamp attribute.
-
ESP_ZB_ZCL_OTA_UPGRADE_SERVER_ENDPOINT_DEF_VALUE
Default value for OTA server endpoint custom attribute.
-
ESP_ZB_ZCL_OTA_UPGRADE_SERVER_ADDR_DEF_VALUE
Default value for OTA server addr custom attribute.
-
ESP_ZB_ZCL_OTA_UPGRADE_QUERY_TIMER_COUNT_DEF
Default Frequency request server about new upgrade file (minutes)
Type Definitions
-
typedef enum esp_zb_zcl_ota_upgrade_file_header_fc_e esp_zb_zcl_ota_upgrade_file_header_fc_t
OTA File header - fc fields bitmasks.
Enumerations
-
enum esp_zb_zcl_ota_upgrade_attr_t
OTA upgrade cluster attribute identifiers.
Values:
-
enumerator ESP_ZB_ZCL_ATTR_OTA_UPGRADE_SERVER_ID
Indicates the address of the upgrade server
-
enumerator ESP_ZB_ZCL_ATTR_OTA_UPGRADE_FILE_OFFSET_ID
Indicates the the current location in the OTA upgrade image
-
enumerator ESP_ZB_ZCL_ATTR_OTA_UPGRADE_FILE_VERSION_ID
Indicates the file version of the running firmware image on the device
-
enumerator ESP_ZB_ZCL_ATTR_OTA_UPGRADE_STACK_VERSION_ID
Brief CurrentZigbeeStackVersion attribute
-
enumerator ESP_ZB_ZCL_ATTR_OTA_UPGRADE_DOWNLOADED_FILE_VERSION_ID
Indicates the file version of the downloaded image on the device
-
enumerator ESP_ZB_ZCL_ATTR_OTA_UPGRADE_DOWNLOADED_STACK_VERSION_ID
Brief DownloadedZigbeeStackVersion attribute
-
enumerator ESP_ZB_ZCL_ATTR_OTA_UPGRADE_IMAGE_STATUS_ID
Indicates the image upgrade status of the client device
-
enumerator ESP_ZB_ZCL_ATTR_OTA_UPGRADE_MANUFACTURE_ID
Indicates the value for the manufacturer of the device
-
enumerator ESP_ZB_ZCL_ATTR_OTA_UPGRADE_IMAGE_TYPE_ID
Indicates the the image type of the file that the client is currently downloading
-
enumerator ESP_ZB_ZCL_ATTR_OTA_UPGRADE_MIN_BLOCK_REQUE_ID
Indicates the delay between Image Block Request commands in milliseconds
-
enumerator ESP_ZB_ZCL_ATTR_OTA_UPGRADE_IMAGE_STAMP_ID
Brief Image Stamp attribute
-
enumerator ESP_ZB_ZCL_ATTR_OTA_UPGRADE_UPGRADE_ACTIVATION_POLICY_ID
Indicates what behavior the client device supports for activating a fully downloaded but not installed upgrade image
-
enumerator ESP_ZB_ZCL_ATTR_OTA_UPGRADE_UPGRADE_TIMEOUT_POLICY_ID
Indicates what behavior the client device supports for activating a fully downloaded image when the OTA server cannot be reached
-
enumerator ESP_ZB_ZCL_ATTR_OTA_UPGRADE_SERVER_ENDPOINT_ID
Brief OTA server endpoint custom attribute
-
enumerator ESP_ZB_ZCL_ATTR_OTA_UPGRADE_SERVER_ADDR_ID
Brief OTA server addr custom attribute
-
enumerator ESP_ZB_ZCL_ATTR_OTA_UPGRADE_CLIENT_DATA_ID
Brief OTA client data attribute, its type can refer to esp_zb_zcl_ota_upgrade_client_variable_t
-
enumerator ESP_ZB_ZCL_ATTR_OTA_UPGRADE_SERVER_DATA_ID
Brief OTA server data attribute, its type can refer to esp_zb_zcl_ota_upgrade_server_variable_t
-
enumerator ESP_ZB_ZCL_ATTR_OTA_UPGRADE_SERVER_ID
-
enum esp_zb_zcl_ota_upgrade_status_t
Possible statuses of OTA upgrade.
Values:
-
enumerator ESP_ZB_ZCL_OTA_UPGRADE_STATUS_START
Starts OTA upgrade
-
enumerator ESP_ZB_ZCL_OTA_UPGRADE_STATUS_APPLY
Checks for manufacturer, image type etc are ok last step before actual upgrade
-
enumerator ESP_ZB_ZCL_OTA_UPGRADE_STATUS_RECEIVE
Process image block
-
enumerator ESP_ZB_ZCL_OTA_UPGRADE_STATUS_FINISH
OTA upgrade completed
-
enumerator ESP_ZB_ZCL_OTA_UPGRADE_STATUS_ABORT
OTA upgrade aborted
-
enumerator ESP_ZB_ZCL_OTA_UPGRADE_STATUS_CHECK
Downloading is finished, do additional checks if needed etc before upgrade end request
-
enumerator ESP_ZB_ZCL_OTA_UPGRADE_STATUS_OK
OTA upgrade end response is ok
-
enumerator ESP_ZB_ZCL_OTA_UPGRADE_STATUS_ERROR
OTA upgrade return error code
-
enumerator ESP_ZB_ZCL_OTA_UPGRADE_IMAGE_STATUS_NORMAL
Accepted new image
-
enumerator ESP_ZB_ZCL_OTA_UPGRADE_STATUS_BUSY
Another download is in progress, deny new image
-
enumerator ESP_ZB_ZCL_OTA_UPGRADE_STATUS_SERVER_NOT_FOUND
Notify an application that OTA Upgrade server not found
-
enumerator ESP_ZB_ZCL_OTA_UPGRADE_STATUS_START
-
enum esp_zb_ota_upgrade_server_status_t
The status of OTA upgrade server.
Values:
-
enumerator ESP_ZB_ZCL_OTA_UPGRADE_SERVER_STARTED
Start OTA
-
enumerator ESP_ZB_ZCL_OTA_UPGRADE_SERVER_ABORTED
Abort OTA
-
enumerator ESP_ZB_ZCL_OTA_UPGRADE_SERVER_END
End OTA
-
enumerator ESP_ZB_ZCL_OTA_UPGRADE_SERVER_STARTED
-
enum esp_zb_zcl_ota_upgrade_file_header_fc_e
OTA File header - fc fields bitmasks.
Values:
-
enumerator ESP_ZB_ZCL_OTA_UPGRADE_FILE_HEADER_FC_CREDENTIAL_VER
Indicate that the Security Credential Version field will be included.
-
enumerator ESP_ZB_ZCL_OTA_UPGRADE_FILE_HEADER_FC_DEVICE_SPECIFIC
Indicate that the Device Specific field will be included.
-
enumerator ESP_ZB_ZCL_OTA_UPGRADE_FILE_HEADER_FC_HW_VER
Indicate that the Hardware Versions Present field will be included.
-
enumerator ESP_ZB_ZCL_OTA_UPGRADE_FILE_HEADER_FC_CREDENTIAL_VER