# 下发设备命令

# API

对某个设备下发命令。为了照顾HTTP协议,下发命令内容将采用不同的数据格式,但服务器会按指定格式下发相关内容,设备端正常接收即可,具体请参考Body参数章节。

请求路径 Request
POST /devices/{deviceKey}/commands DeviceCommandSendRequest

命令下发数据最大大小为: 4Kb

# 授权

当前API可使用授权类型与具体的授权参数请参考下表(多个授权类型可任选一个)。了解更多请查看平台鉴权

授权类型 授权参数 封装授权参数(调用HanCloudsClient提供的方法来封装)
用户 userKey / authKey / authSecret putUserAuthParams()方法
产品 productKey / cmdKey / cmdSecret putProductAuthParams()方法
设备 deviceKey / cmdToken putDeviceAuthParams()方法
项目 projectKey / projectAuthKey / projectAuthSecret putProjectAuthParams()方法

# 路径参数

参数名 类型 是否必须 说明
deviceKey String 设备唯一Key

# Query参数

参数名 类型 是否必须 说明
dataType Integer 命令数据类型
validTime Integer 默认值:0,命令有效的时间,秒为单位,最多60天

# Body参数

Body直接为要下发的命令数据,根据命令类型不同,下发命令格式有所不同。

数据类型 入参格式 命令下发格式 说明
int string int(大端4字节) 如果入参字符串非整形或整形值超过4字节表示长度将报错
double string double(大端8字节) 如果入参字符串非双精度或双精度值超过8字节表示长度将报错
string string string 直接下发
json string string 直接下发
bin string(base64) bin 入参使用base64格式传递二进制信息,服务器将解码后下发给设备

# Body示例

dGhpcyBpcyBhIGV4YW1wbGU=

# 返回示例

返回值为commandId字符串。

7afd080dbb4948d6aedcaf265c9e8fb5