1. 描述
创建设备。
2. 调用场景
开发者登录超级控制台后,可以以God角色创建自己的设备。设备创建目前只能由God进行。
3. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | AddDev | |
Url | https://api.xdua.com/devp | |
Method | POST | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | ADD | |
XduaApiColor | X | 只有持有神设备,才可以创建设备 |
XduaApiAudience | ConsoleX | 只有devp_id为ConsoleX的设备,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 设备直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 需要登录 |
XduaApiRole | God | 目前地球号只允许God添加设备,未来这个功能会让给一个专门维护设备和设备录入的角色。 |
XduaApiResource | devp | |
XduaApiKparam | pkey | 在阿里云物联网平台创建的设备的ProductKey |
XduaApiAction | CreateDev | |
XduaApiRule | CreateDev | |
XduaApiAstates | 0 | 所有的资源都要确认state是0 |
XduaApiEnable | true | 接口使能 |
4. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
devp_id | body | String | 是 | 无 | TeStTeSt |
设备从属的产品ID |
unid | body | String | 是 | 无 | "BTMC.AC2D3F7894A3" | BTMC. 代表Bluetooth Mac Address,当设备上传的数据是以蓝牙通讯云端的,必须用BTMC |
^ | ^ | ^ | ^ | ^ | "WFMC.AC2D3F7894A3" | WFMC. 代表Wifi Mac Address,当设备时以Wifi 通讯云端的 |
^ | ^ | ^ | ^ | ^ | "IMEI.861410042482884" | IMEI. 代表imei,当设备以NBIOT通讯时 |
^ | ^ | ^ | ^ | ^ | "VIRT.*" | VIRT. 代表Virtual,虚拟,是地球号内部编码。特殊场合采用,例如虚拟网关才会用这个编号。 |
snid | body | String | 是 | 无 | "100034" | 从设备包装盒,表面,印刷痕迹能够方便找到的用于区分的序列号。一般设备上会用这个作为他们内部跟踪产品的编号。如果是MAC地址,那就填MAC地址。 |
name | body | String | 是 | 无 | "电池口坏了的温度计" | 仅仅用来标志,是地球号员工对每个设备的标志。 |
5. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 创建的设备ID |
6. 错误码
错误码来自于error字段,通用错误码参考地球号通用错误码
7. SDK调用
const XduaClient = require('lovearth-xdua-browser-sdk')
const xduaClient = await XduaClient({
LOGIN_TOKEN:"eyJhbGciOi...",//开发者在地球号开发者网站创建的登录令牌
})
/*----------------------------
* 运行如下代码
* 下面的代码是直接可以运行的
*--------------------------*/
const add_params = {
devp_id:"TeStTeSt",
unid:"BTMC.AC2D3F7894A3",//mac地址,imei号等
snid:"C789X", //序列号,一些可读的序列号
name:"测试设备", //添加时的名字,可以乱写
}
let res = await xduaClient.addDev(add_params)
if(res.error == 0){
console.log("测试成功");
}else{
console.log("测试失败");
console.log(res);
}
文档还没有实现
```
{% sample lang="php" -%}
文档还没有实现
```bash