FOTA API

更新时间：2024-11-20 08:51:32

API 列表

函数名称	功能描述
cat1_mcu_fota_inform_hook	MCU 固件开始升级通知函数原型
cat1_mcu_fota_process_hook	MCU 固件数据接收处理函数原型
cat1_mcu_fota_notify_hook	MCU 固件传输完成通知函数原型
tuya_cat1_register_mcu_fota_inform_hook	注册 MCU 固件升级开始通知函数
tuya_cat1_register_mcu_fota_process_hook	注册 MCU 固件升级数据接收函数
tuya_cat1_register_mcu_fota_notify_hook	MCU 固件传输完成后，将调用注册的通知函数

API 说明

cat1_mcu_fota_inform_hook

定义	说明
函数原型	typedef void (cat1_mcu_fota_inform_hook)(UINT_T fileSize, const CHAR_T version, const CHAR_T* fwHMAC)
功能说明	MCU 固件开始升级通知函数原型
参数	`fileSize`：固件大小 `fileSize`：固件大小 `fwHMAC`：固件HAMC校验
返回值	无

cat1_mcu_fota_process_hook

定义	说明
函数原型	typedef void (cat1_mcu_fota_process_hook)(UINT_T offset, const BYTE_T data, UINT_T len)
功能说明	MCU 固件数据接收处理函数原型
参数	`offset`：数据起始字节在固件中的偏移 `data`：固件数据 `len`：固件数据长度
返回值	无

cat1_mcu_fota_notify_hook

定义	说明
函数原型	typedef void (*cat1_mcu_fota_notify_hook)(INT_T result)
功能说明	mcu 固件传输完成通知函数原型
注意	该函数在固件升级数据接收完成后调用，调用该函数只代表固件从云端传输至设备完成，并不意味着升级成功，用户需要在函数中实现将固件写入 MCU Flash
参数	`result`：固件传输结果，`OPRT_OK` 表示传输成功，其它表示传输失败
返回值	无

tuya_cat1_register_mcu_fota_inform_hook

定义	说明
函数原型	int tuya_cat1_register_mcu_fota_inform_hook(cat1_mcu_fota_inform_hook hook)
功能说明	注册MCU固件升级开始通知函数
注意	升级过程中不允许调用该函数，否则可能引起空指针异常。注册传入空指针，可以取消原注册函数。 MCU 固件开始升级时，将调用注册的通知函数。
参数	`hook`：MCU 升级开始通知函数
返回值	`0`：注册成功

tuya_cat1_register_mcu_fota_process_hook

定义	说明
函数原型	int tuya_cat1_register_mcu_fota_process_hook(cat1_mcu_fota_process_hook hook)
功能说明	注册 MCU 固件升级数据接收函数
注意	升级过程中不允许调用该函数，否则可能引起空指针异常。注册传入空指针，可以取消原注册函数。开始接收 MCU 固件升级数据时，将调用注册的接收处理函数。
参数	`hook`：MCU 固件升级数据接收函数
返回值	`0`：注册成功

tuya_cat1_register_mcu_fota_notify_hook

定义	说明
函数原型	int tuya_cat1_register_mcu_fota_notify_hook(cat1_mcu_fota_notify_hook hook)
功能说明	该函数在固件升级数据接收完成后调用，调用该函数只代表固件从云端传输至设备完成，并不意味着升级成功，用户需要在函数中实现将固件写入 MCU Flash
注意	升级过程中不允许调用该函数，否则可能引起空指针异常。注册传入空指针，可以取消原注册函数。开始接收 MCU 固件传输完成后，将调用注册的通知函数。
参数	`hook`：MCU 固件传输完成通知函数
返回值	`0`：注册成功