com.aliyun.alink.dm.api

接口 IOta

所有已知实现类:

OtaImpl

public interface IOta

设备 OTA 接口

嵌套类概要

嵌套类

限定符和类型	接口和说明
static class	IOta.OtaConfig
static interface	IOta.OtaListener
static interface	IOta.OtaResult

字段概要

字段

限定符和类型	字段和说明
static int	ERROR_HTTP_EXCEPTION
static int	ERROR_MQTT_EXCEPTION
static int	ERROR_SAVE_OTA_EXCEPTION
static int	NO_ERROR
static int	STEP_DOWNLOAD
static int	STEP_RCVD_OTA
static int	STEP_REPORT_VERSION
static int	STEP_SUBSCRIBE

方法概要

限定符和类型	方法和说明
void	activeRetry()
void	enableContinuousDownload(java.lang.Boolean enable) 打开断点续传功能，默认该功能关闭
void	reportModuleProgress(int step, java.lang.String module, java.lang.String desc, ResultCallback<java.lang.String> cb) 设备上报自定义模块的ota进度
void	reportModuleVersion(java.lang.String version, java.lang.String module, ResultCallback<java.lang.String> cb) 上报自定义模块的版本号
void	reportProgress(int step, java.lang.String desc, ResultCallback<java.lang.String> cb) 设备上报默认模块的ota进度
void	reportVersion(java.lang.String version, ResultCallback<java.lang.String> cb) 上报默认模块的版本号
int	setHttpRecvTimeoutInS(int timeout) 设置断点续传过程中http接口在因没有数据而阻塞住时的超时等待时间，并非整个文件的下载超时时间
int	setRetryParams(int retryCnt, int retryIntervalInS) 设置断点续传的重试次数，以及两次重试之间的间隔
void	subOtaTopics() 订阅ota有关的topic
void	tryGetOtaFirmware(java.lang.String moduleName) 设备主动获取固件
void	tryStartOta(IOta.OtaConfig config, IOta.OtaListener listener) 启动ota，无论是否涉及多模块只要调用一次即可
void	tryStopOta() 停止OTA任务

字段详细资料

STEP_REPORT_VERSION

static final int STEP_REPORT_VERSION

另请参阅:

常量字段值

STEP_SUBSCRIBE

static final int STEP_SUBSCRIBE

另请参阅:

常量字段值

STEP_RCVD_OTA

static final int STEP_RCVD_OTA

另请参阅:

常量字段值

STEP_DOWNLOAD

static final int STEP_DOWNLOAD

另请参阅:

常量字段值

NO_ERROR

static final int NO_ERROR

另请参阅:

常量字段值

ERROR_MQTT_EXCEPTION

static final int ERROR_MQTT_EXCEPTION

另请参阅:

常量字段值

ERROR_HTTP_EXCEPTION

static final int ERROR_HTTP_EXCEPTION

另请参阅:

常量字段值

ERROR_SAVE_OTA_EXCEPTION

static final int ERROR_SAVE_OTA_EXCEPTION

另请参阅:

常量字段值

方法详细资料

tryStartOta

void tryStartOta(IOta.OtaConfig config,
                 IOta.OtaListener listener)

启动ota，无论是否涉及多模块只要调用一次即可

参数:

config - ota的配置

listener - ota下载过程中的回调

tryStopOta

void tryStopOta()

停止OTA任务

subOtaTopics

void subOtaTopics()

订阅ota有关的topic

reportVersion

void reportVersion(java.lang.String version,
                   ResultCallback<java.lang.String> cb)

上报默认模块的版本号

参数:

version - 默认模块的版本号

cb - 回调

reportModuleVersion

void reportModuleVersion(java.lang.String version,
                         java.lang.String module,
                         ResultCallback<java.lang.String> cb)

上报自定义模块的版本号

参数:

version - 自定义模块的版本号

module - 自定义模块的名称

cb - 回调

tryGetOtaFirmware

void tryGetOtaFirmware(java.lang.String moduleName)

设备主动获取固件

参数:

moduleName - 模块的名称。如果是默认模块，就填写"default"

reportProgress

void reportProgress(int step,
                    java.lang.String desc,
                    ResultCallback<java.lang.String> cb)

设备上报默认模块的ota进度

参数:

step - 百分比

desc - 文字描述

cb - 发送回调

reportModuleProgress

void reportModuleProgress(int step,
                          java.lang.String module,
                          java.lang.String desc,
                          ResultCallback<java.lang.String> cb)

设备上报自定义模块的ota进度

参数:

step - 百分比

module - 自定义模块的名称

desc - 文字描述

cb - 发送回调

setHttpRecvTimeoutInS

int setHttpRecvTimeoutInS(int timeout)

设置断点续传过程中http接口在因没有数据而阻塞住时的超时等待时间，并非整个文件的下载超时时间

返回:

int

setRetryParams

int setRetryParams(int retryCnt,
                   int retryIntervalInS)

设置断点续传的重试次数，以及两次重试之间的间隔

参数:

retryCnt - 重试的次数，默认为24 * 60

retryIntervalInS - 两次重试之间的间隔，默认为 60s

activeRetry

void activeRetry()

enableContinuousDownload

void enableContinuousDownload(java.lang.Boolean enable)

打开断点续传功能，默认该功能关闭

参数:

enable - 开关的状态