Skip to content

远程配置

通过Jie IOT开发者平台提供的远程配置功能,开发人员可在不用重启设备或中断设备运行的情况下,在线远程更新设备的系统参数、网络参数等配置信息。

本文档介绍设备主动请求远程配置信息和平台推送配置信息的 Topic 及数据格式定义。

功能说明

平台远程配置功能支持:

开启或关闭产品的远程配置。 在线编辑配置文件,并管理版本。 从平台推送配置文件,批量更新设备配置信息。 设备主动请求更新配置信息。

远程配置获取

设备发送消息

设备主动请求获取产品下最新版本的配置文件。

接口主题
MQTTthings/up/${tenantId}/${productKey}/${deviceKey}/ext/config/get
json
{
    "msgId":"45lkj3551234",
    "time":1626197189638,
    "method": "ext/config/get",
    "data":{
        "bizType":"PRODUCT_FILE"
    }
}

参数说明

参数类型说明必选备注
${tenantId}string租户 ID云平台分配的租户ID。
${productKey}string产品 ID属性上报的来源设备所属产品 Key。
${deviceKey}string设备 ID属性上报的来源设备 Key。
msgIdstring消息 ID总长度不超过 32 位的字符,请求和响应消息通过该值建立应答关系。
timenumber消息时间戳消息发送时的 Unix 时间戳,10 位秒级或 13 位毫秒级。
dataobject请求参数集合对象请求参数集合对象。
data.bizTypestring业务类型目前支持产品维度远程文件配置,取值:PRODUCT_FILE。

设备接收消息

设备请求云端获取最新版本配置文件,云端响应返回最新版本配置文件的 URL。

接口主题
MQTTthings/down/${tenantId}/${productKey}/${deviceKey}/ext/config/get_reply
json
{
    "msgId":"45lkj3551234",
    "time":1626197189638,
    "method": "ext/config/get_reply",
    "code":0,
	"data":{
        "bizType":"PRODUCT_FILE",
        "pid":"5k8h97qska6pf",
        "fileName": "xjzl_000004d6n7_1.json",
        "url":"http://config.xiujiezhilian.com/deivce/config/1.json",
        "httpsUrl":"https://config.xiujiezhilian.com/deivce/config/v1.json",
        "size": 5165,
        "hmac": "54081B1FD727F2F6533178B7FC18B144",
        "version": "1", 
        "md5": "74ea6d75f6487049b61a2aa24da2"  
    }
}

参数说明

参数类型说明必选备注
${tenantId}string租户 ID云平台分配的租户ID。
${productKey}string产品 ID属性上报的来源设备所属产品 Key。
${deviceKey}string设备 ID属性上报的来源设备 Key。
msgIdstring消息 ID总长度不超过 32 位的字符,请求和响应消息通过该值建立应答关系。
timenumber消息时间戳消息发送时的 Unix 时间戳,10 位秒级或 13 位毫秒级。
codenumber响应状态码0 代表成功,默认值。非 0 代表失败。
dataobject响应参数集合对象响应参数集合对象。
data.bizTypestring业务类型目前支持产品维度远程文件配置,取值:PRODUCT_FILE。
data.pidstring产品 Key产品 Key。
data.urlstring下载地址下载地址。
data.httpsUrlstringhttps下载地址下载地址。
data.sizenumber文件大小大小。
data.md5string文件 MD5MD5。
data.hmacstring文件 HMAC 值HMAC 值,通过 productKey 作为秘钥,通过 sha256_HMAC 计算得到。
data.versionstring版本版本

远程配置下发

远程配置下发指令

接口主题
MQTTthings/down/${tenantId}/${productKey}/${deviceKey}/ext/config/update
json
{
    "msgId":"45lkj3551234",
    "time":1626197189638,
    "method": "ext/config/update",
	"data":{
        "bizType":"PRODUCT_FILE",
        "pid":"5k8h97qska6pf",
        "fileName": "xjzl_000004d6n7_1.json",
        "url":"http://config.xiujiezhilian.com/deivce/config/1.json",
        "httpsUrl":"https://config.xiujiezhilian.com/deivce/config/v1.json",
        "size": 5165,
        "hmac": "54081B1FD727F2F6533178B7FC18B144",
        "version": "1", 
        "md5": "74ea6d75f6487049b61a2aa24da2"  
    }
}

参数说明

参数类型说明必选备注
${tenantId}string租户 ID云平台分配的租户ID。
${productKey}string产品 ID属性上报的来源设备所属产品 Key。
${deviceKey}string设备 ID属性上报的来源设备 Key。
msgIdstring消息 ID总长度不超过 32 位的字符,请求和响应消息通过该值建立应答关系。
timenumber消息时间戳消息发送时的 Unix 时间戳,10 位秒级或 13 位毫秒级。
dataobject响应参数集合对象响应参数集合对象。
data.bizTypestring业务类型目前支持产品维度远程文件配置,取值:PRODUCT_FILE。
data.pidstring产品 Key产品 Key。
data.urlstring下载地址下载地址。
data.httpsUrlstringhttps下载地址下载地址。
data.sizenumber文件大小大小。
data.md5string文件 MD5MD5。
data.hmacstring文件 HMAC 值HMAC 值,通过 productKey 作为秘钥,通过 sha256_HMAC 计算得到。
data.versionstring版本版本

远程配置下发回复

接口主题
MQTTthings/up/${tenantId}/${productKey}/${deviceKey}/ext/config/update_reply
json
{
    "msgId":"45lkj3551234",
    "time":1626197189638,
    "method": "ext/config/update_reply",
    "code":0,
    "data":{
        "bizType":"PRODUCT_FILE",
        "pid":"5k8h97qska6pf",
        "fileName": "xjzl_000004d6n7_1.json",
        "version": "1"
    }
}

参数说明

参数类型说明必选备注
${tenantId}string租户 ID云平台分配的租户ID。
${productKey}string产品 ID属性上报的来源设备所属产品 Key。
${deviceKey}string设备 ID属性上报的来源设备 Key。
msgIdstring消息 ID总长度不超过 32 位的字符,请求和响应消息通过该值建立应答关系。
timenumber消息时间戳消息发送时的 Unix 时间戳,10 位秒级或 13 位毫秒级。
codenumber响应状态码0 代表成功,默认值。非 0 代表失败。
dataobject请求参数集合对象请求参数集合对象。
data.bizTypestring业务类型目前支持产品维度远程文件配置,取值:PRODUCT_FILE。