联犀-things

协议脚本调试

POST

/api/v1/things/protocol/script/debug

things/protocol/scriptthingsProtocolScript

请求参数

Header 参数

Ithings-Project-Id

string

可选

默认值:

Ithings-Token

string

可选

默认值:

app-code

string

可选

默认值:

device-id

string

可选

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

Body 参数application/json

triggerDir

integer <int64>

必需

1:up 2:down

triggerTimer

integer <int64>

必需

收到前处理1:before 2:after

script

string

脚本内容

必需

req

object (PublishMsg)

必需

handle

string

可选

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

type

string

可选

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

payload

string

可选

timestamp

string

毫秒时间戳

可选

productID

string

可选

deviceName

string

可选

explain

string

内部使用的拓展字段

可选

protocolCode

string

可选

如果有该字段则回复的时候也会带上该字段

resp

object (PublishMsg)

可选

示例

{
    "triggerDir": 0,
    "triggerTimer": 0,
    "script": "string",
    "req": {
        "handle": "string",
        "type": "string",
        "payload": "string",
        "timestamp": "string",
        "productID": "string",
        "deviceName": "string",
        "explain": "string",
        "protocolCode": "string"
    },
    "resp": {
        "handle": "string",
        "type": "string",
        "payload": "string",
        "timestamp": "string",
        "productID": "string",
        "deviceName": "string",
        "explain": "string",
        "protocolCode": "string"
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v1/things/protocol/script/debug' \
--header 'Ithings-Project-Id: {{Ithings-Project-Id}}' \
--header 'Ithings-Token: {{iThings-token}}' \
--header 'app-code: {{appCode}}' \
--header 'device-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "triggerDir": 0,
    "triggerTimer": 0,
    "script": "string",
    "req": {
        "handle": "string",
        "type": "string",
        "payload": "string",
        "timestamp": "string",
        "productID": "string",
        "deviceName": "string",
        "explain": "string",
        "protocolCode": "string"
    },
    "resp": {
        "handle": "string",
        "type": "string",
        "payload": "string",
        "timestamp": "string",
        "productID": "string",
        "deviceName": "string",
        "explain": "string",
        "protocolCode": "string"
    }
}'

返回响应

🟢200成功

application/json

A successful response.

Body

code

integer

返回code

可选

默认值:

200

msg

string

返回的消息

可选

data

object (ProtocolScriptDebugResp)

可选

out

object (PublishMsg)

必需

logs

array[string]

必需

示例

{
    "code": "200",
    "msg": "string",
    "data": {
        "out": {
            "handle": "string",
            "type": "string",
            "payload": "string",
            "timestamp": "string",
            "productID": "string",
            "deviceName": "string",
            "explain": "string",
            "protocolCode": "string"
        },
        "logs": [
            "string"
        ]
    }
}

新增协议脚本

删除协议脚本