新增协议脚本设备

请求参数

Header 参数

Ithings-Project-Id

string

可选

默认值:

Ithings-Token

string

可选

默认值:

app-code

string

可选

默认值:

device-id

string

可选

用户正在使用的设备ID(小程序,ios,安卓的设备ID)

Body 参数application/json

string

可选

triggerSrc

integer <int64>

可选

product:1 device:2

productID

string

可选

deviceName

string

可选

scriptID

integer <int64>

可选

priority

integer <int64>

执行优先级

可选

status

integer <int64>

状态:是否启用

可选

createdTime

integer <int64>

创建时间

可选

script

object (ProtocolScript)

可选

string

可选

name

string

可选

desc

string

可选

triggerDir

integer <int64>

可选

1:up 2:down

triggerTimer

integer <int64>

可选

收到前处理1:before 2:after

triggerHandle

string

可选

对应 mqtt topic的第一个 thing ota config 等等

triggerType

string

可选

操作类型从topic中提取物模型下就是 property属性 event事件 action行为

script

string

脚本内容

可选

status

integer <int64>

状态:是否启用

可选

createdTime

integer <int64>

创建时间

可选

product

object (ProductInfo)

可选

createdTime

string

创建时间只读

可选

productID

string

产品id 只读

可选

productName

string

产品名称

可选

productImg

string

产品图片

可选

isUpdateProductImg

boolean

可选

只有这个参数为true的时候才会更新产品图片,传参为产品图片的file path

authMode

integer <int64>

可选

认证方式:1:账密认证,2:秘钥认证

<= 2

deviceType

integer <int64>

可选

设备类型:1:直连设备,2:网关,3:子设备,4:监控设备

<= 4

deviceSchemaMode

integer <int64>

可选

设备物模型模式:1:手动创建,2:设备自动创建 3: 设备自动创建及上报无定义自动创建 4: 设备自动创建及上报无定义自动创建(数字类型只使用浮点)

<= 4

categoryID

integer <int64>

产品品类

可选

netType

integer <int64>

可选

通讯方式:1:其他,2:wi-fi,3:2G/3G/4G,4:5G,5:BLE,6:LoRaWAN,7:wifi+ble,8:有线网,9:4G+BLE

<= 10

protocolCode

string

可选

协议code,默认urMqtt,设备下发只会发送给主协议 urMqtt,urHttp,wumei,aliyun,huaweiyun,tuya

subProtocolCode

string

可选

子协议,主协议和子协议传输类型必须不相同, 设备控制下发只会发送给主协议, 当设备是音视频设备但是控制协议需要单独走的时候就可以把主协议定义为普通协议,子协议定义为音视频协议,这样就能实现音视频走音视频协议,控制走子协议

autoRegister

integer <int64>

可选

动态注册:1:关闭,2:打开,3:打开并自动创建设备

<= 3

secret

string

可选

动态注册产品秘钥只读

trialTime

string

可选

试用时间(单位为天,为0不限制)

desc

string

描述

可选

tags

array[object (Tag) {2}]

设备tag

可选

schemaAlias

object

可选

设备物模型别名,如果是结构体类型则key为xxx.xxx

isOnline

integer <int64>

可选

在线状态 1离线 2在线只读

<= 2

firstLogin

string

激活时间只读

可选

firstBind

string

可选

lastBind

string

最后绑定时间只读

可选

lastLogin

string

最后上线时间只读

可选

expTime

string

到期时间

可选

logLevel

integer <int64>

可选

日志级别:1)关闭 2)错误 3)告警 4)信息 5)调试读写

<= 5

rssi

integer <int64>

信号强度

可选

createdTime

string

创建时间只读

可选

status

integer <int64>

可选

设备状态 1-未激活，2-在线，3-离线 4-异常(频繁上下线,告警中)

isEnable

integer <int64>

是否启用

可选

withProperties

object

可选

获取的属性列表,如果不传withProperty,则不会返回

protocolConf

array[object (Tag) {2}]

协议配置

可选

subProtocolConf

array[object (Tag) {2}]

子协议配置

可选

profiles

object

可选

owner

object (UserCore)

可选

ratedPower

integer <int64>

可选

netType

integer <int64>

可选

通讯方式:1:其他,2:wi-fi,3:2G/3G/4G,4:5G,5:BLE,6:LoRaWAN,7:wifi+ble,8:有线网,9:4G+BLE

<= 10

needConfirmVersion

string

待确认升级的版本

可选

userID

string

可选

lastIp

string

最后登录的ip地址

可选

sort

integer <int64>

排序

可选

desc

string

可选

distributor

object (IDPath)

可选

gateway

object (DeviceInfo)

可选

area

object (AreaInfo)

可选

groups

array[object (GroupCore) {4}]

所在分组信息

可选

示例

{
  "id": "string",
  "triggerSrc": 0,
  "productID": "string",
  "deviceName": "string",
  "scriptID": 0,
  "priority": 0,
  "status": 0,
  "createdTime": 0,
  "script": {
    "id": "string",
    "name": "string",
    "desc": "string",
    "triggerDir": 0,
    "triggerTimer": 0,
    "triggerHandle": "string",
    "triggerType": "string",
    "script": "string",
    "status": 0,
    "createdTime": 0
  },
  "product": {
    "createdTime": "string",
    "productID": "string",
    "productName": "string",
    "productImg": "string",
    "isUpdateProductImg": true,
    "authMode": 2,
    "deviceType": 4,
    "deviceSchemaMode": 4,
    "categoryID": 0,
    "netType": 10,
    "protocolCode": "string",
    "subProtocolCode": "string",
    "autoRegister": 3,
    "secret": "string",
    "trialTime": "string",
    "desc": "string",
    "tags": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "sceneMode": "string",
    "status": 0,
    "bindLevel": 0,
    "protocolConf": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "subProtocolConf": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "protocol": {
      "id": 0,
      "name": "string",
      "code": "string",
      "type": "string",
      "transProtocol": "string",
      "desc": "string",
      "endpoints": [
        "string"
      ],
      "etcdKey": "string",
      "isEnableSyncProduct": 0,
      "isEnableSyncDevice": 0,
      "configFields": [
        {
          "id": 0,
          "group": "string",
          "key": "string",
          "label": "string",
          "isRequired": true,
          "sort": 0
        }
      ],
      "configInfos": [
        {
          "id": 0,
          "config": {},
          "desc": "string"
        }
      ],
      "productFields": [
        {
          "id": 0,
          "group": "string",
          "key": "string",
          "label": "string",
          "isRequired": true,
          "sort": 0
        }
      ],
      "deviceFields": [
        {
          "id": 0,
          "group": "string",
          "key": "string",
          "label": "string",
          "isRequired": true,
          "sort": 0
        }
      ]
    },
    "category": {
      "id": 0,
      "parentID": 0,
      "idPath": [
        0
      ],
      "name": "string",
      "desc": "string",
      "headImg": "string",
      "isUpdateHeadImg": true,
      "isLeaf": 0,
      "deviceCount": 0,
      "children": [
        {}
      ]
    },
    "config": {
      "productID": "string",
      "devInit": {
        "tenantCode": "string",
        "projectID": "string",
        "areaID": "string",
        "deptID": "string"
      }
    },
    "customUi": {}
  },
  "device": {
    "id": 0,
    "tenantCode": "string",
    "productID": "string",
    "projectID": "string",
    "productName": "string",
    "deviceType": 0,
    "productImg": "string",
    "areaID": "string",
    "deviceName": "string",
    "deviceAlias": "string",
    "secret": "string",
    "cert": "string",
    "imei": "string",
    "mac": "string",
    "categoryID": 0,
    "version": "string",
    "hardInfo": "string",
    "softInfo": "string",
    "mobileOperator": 10,
    "phone": "string",
    "iccid": "string",
    "position": {
      "longitude": 180,
      "latitude": 90
    },
    "address": "string",
    "adcode": "string",
    "tags": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "schemaAlias": {},
    "isOnline": 2,
    "firstLogin": "string",
    "firstBind": "string",
    "lastBind": "string",
    "lastLogin": "string",
    "expTime": "string",
    "logLevel": 5,
    "rssi": 0,
    "createdTime": "string",
    "status": 0,
    "isEnable": 0,
    "withProperties": {},
    "protocolConf": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "subProtocolConf": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "profiles": {},
    "owner": {
      "userID": "string",
      "userName": "string",
      "email": "string",
      "phone": "string",
      "lastIP": "string",
      "regIP": "string",
      "nickName": "string",
      "headImg": "string",
      "createdTime": "string"
    },
    "ratedPower": 0,
    "netType": 10,
    "needConfirmVersion": "string",
    "userID": "string",
    "lastIp": "string",
    "sort": 0,
    "desc": "string",
    "distributor": {
      "id": 0,
      "idPath": "string"
    },
    "gateway": {},
    "area": {
      "projectID": "string",
      "areaID": "string",
      "areaName": "string"
    },
    "groups": [
      {
        "id": 0,
        "parentID": 0,
        "name": "string",
        "purpose": "string"
      }
    ]
  }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

A successful response.

新增协议脚本设备

请求参数

示例代码

返回响应