1. MIX.IOT.2018.F.14.02-APIP-API

1.1. 请求地址

HOST:http://xxx.com/path/(具体以系统部署地址为准) 请求地址:HOST +下文接口中的url

1.2. 请求说明

固定传参

在 http header 中传入参数,该参数来源于用户登录后获得到的验证信息,用于鉴权

参考

Authorization: Bearer d6nAGWraBuRY4wkEo7KLK4d3N53A4i5gMnj1iiCZQujZS783WE1SfHNkBFjkns85

1.3. 响应说明

所有响应都提供了遵循如下响应规则,在后面的响应说明中不再做出说明

状态码说明:

code 含义
500 错误
200 执行成功

1.4. 功能描述

反向控制,控制设备运行状态

url /api/apip/apip_push
http方法 post

说明:url地址为:线上部署地址+url地址

如:http://admin.demo.mixiot.top/api/apip/apip_push

1.4.1. 请求参数:默认

参数名称 数据类型 描述 是否必选
i_type string 选择反向控制对象: ”equipment”:表示控制对象为设备; “adapter”:表示控制对象为适配器。 必选
command json 以下说明command与codebase的关联性 必选

1.4.2. 示例说明

admin配置codebase如下

admin配置codebase
Image - admin配置codebase

配置信息如下:

[
["Start", "Start Remote Control", "远程启动", "2", "L1_3_9", "1\|2\|4\|8",
"远程启动\|远程停机\|加载\|卸载","PEA"],
["ChangeTemp", "change temperature", "调整温度", "2", "L1_23_56", "\$Temp",
"请输入温度值","P"]
]
  • 根据以上配置案例列举对应的apip请求参数

  • 设备反向控制请求格式(pro里面一般只针对设备做反向控制操作)

Post请求参数内容:

  1. 远程启动控制:
{
    "i_type": "equipment",
    "command": {
        "equipment_id": "设备id",
        "aprus_id": "适配器id",
        "param": ["Start ", "1 "],
        "platform": "P"
    }
}
  1. 远程停机控制:
{
    "i_type": "equipment",
    "command": {
        "equipment_id": "设备id",
        "aprus_id": "适配器id",
        "param": "[\\"Stop\\",\\"2\\"]",
        "platform": "P"
    }
}
  1. 加载控制:
{
    "i_type": "equipment",
    "command": {
        "equipment_id": "设备id",
        "param": "[\\"Load\\",\\"4\\"]",
        "aprus_id": "适配器id",
        "platform": "P"
    }
}
  1. 卸载控制:
{
    "i_type": "equipment",
    "command": {
        "equipment_id": "设备id",
        "param": "[\\"Unload\\",\\"8\\"]",
        "aprus_id": "适配器id",
        "platform": "P"
    }
}
  1. 调整温度控制(这里表示温度控制在23度):
{
    "i_type": "equipment",
    "command": {
        "equipment_id": "设备id",
        "param": "[\\"ChangeTemp\\",\\"23\\"]",
        "aprus_id": "适配器id",
        "platform": "P"
    }
}

对应的codebase:["ChangeTemp", "change temperature", "调整温度", "2", "L1_23_56", "$Temp"]

第六个参数带有$符号,表示该控制需要传递变量的值,即以上控制23就是$Temp变量的值。

不传递值,控制将报错!

  1. 适配器反向控制请求格式(一般admin里面对适配器做升级等操作,codebase不存在该配置也能做该操作)

默认适配器有两个默认操作:

  1. 重启:
{
"i_type": "adapter",
    "command": {
        "aprus_id": "适配器id",
        "param": "[\\"Reboot\\"]"
    }
}
  1. 升级(对应):

平台配置版本号位置

平台配置版本号位置
Image - 平台配置版本号位置
{
    "i_type": "adapter",
    "command": {
        "aprus_id": "适配器id",
        "param": "[\\"Upgrade\\",\\"LUA\\"]"
    }
}

手动升级如果适配器的版本等于或者高于平台配置的版本,则不会进行升级!

LUA所属位置可以是这些选项:"LUA","REMOSU","MCU"

以上是LUA版本升级

1.4.3. 应答参数

code 含义
500 错误
200 执行成功

message: 提示信息

例子:

1、请求错误:

{
    "code": 500,
    "msg": "错误请求"
}

2、请求成功:

{
    "code": 200,
    "msg": "请求成功!"
}
© Mixlinker all right reserved,powered by Gitbook文件修订时间: 2018-12-28 10:48:30

results matching ""

    No results matching ""