物解析IOT Parser

    Device

    字段 类型 说明
    uuid String 全局唯一ID
    code String 设备名称。同一个gateway下唯一
    description String 设备描述
    gatewayUuid String 网关id
    gatewayCode String 冗余字段。与gatewayUuid对应的gateway的code字段保持一致
    slaveId Int 用于modbus。只能从1-247(包括1和237)中取值且同一个gateway下唯一
    address String 用于子设备的ip:port, 或者串口地址(eg: /dev/pts/6)
    mode ENUM [ TCP/RTU ]。默认值TCP
    baud Int 波特率,仅用于RTU模式
    databits Int 数据位长,[7-8], 默认值8, 仅用于RTU模式
    stopbits Int 停止位长,[1,2], 默认值1, 仅用于RTU模式
    parity ENUM 校验方式, [NONE/EVEN/ODD],默认值NONE,仅用于RTU模式
    state ENUM [ENABLED, DISABLED]
    status ENUM [ERROR, ACTIVE, DELETED]
    createTime DateTime 创建记录的时间
    updateTime DateTime 最后修改记录的时间

    筛选

    接口描述

    相对URI HTTP 方式
    /v1/devicece GET

    输入

    名称 类型 是否必选 默认值 含义
    gatewayUuid String N null 网关id
    state ENUM N null [ENABLED, DISABLED]

    输出

    200: 成功

    输出一个Device的List

    其他: 失败

    请求示例

    GET /v1/devicece

    输出示例

    {  
        "totalCount": 1,  
        "result": [  
            {  
                "databits": 8,  
                "baud": 300,  
                "address": "127.0.0.1:502",  
                "gatewayUuid": "08d95c37-bc72-44cd-8e93-8d94ff52a934",  
                "state": "ENABLED",  
                "description": "",  
                "code": "subdevice",  
                "mode": "TCP",  
                "createTime": "2017-02-04T08:16:11Z",  
                "parity": "NONE",  
                "status": "ACTIVE",  
                "slaveId": 1,  
                "stopbits": 1,  
                "updateTime": "2017-02-04T08:16:11Z",  
                "gatewayCode": "jwangateway",  
                "uuid": "8603dbc2-3fdc-4683-bfc5-dc18ed50adcf"  
            }  
        ],  
        "order": "desc",  
        "orderBy": "createTime",  
        "pageSize": 5,  
        "pageNo": 1  
    }

    获取

    接口描述

    相对URI HTTP 方式
    /v1/device/:deviceUuid GET

    输入

    名称 类型 是否必选 默认值 含义
    deviceUuid String Y 子设备id

    输出

    200: 成功

    输出一个这个uuid对应的device

    其他: 失败

    请求示例

    GET /v1/devicece/8603dbc2-3fdc-4683-bfc5-dc18ed50adcf

    输出示例

    {  
        "databits": 8,  
        "baud": 300,  
        "address": "127.0.0.1:502",  
        "gatewayUuid": "08d95c37-bc72-44cd-8e93-8d94ff52a934",  
        "state": "ENABLED",  
        "description": "",  
        "code": "subdevice",  
        "mode": "TCP",  
        "createTime": "2017-02-04T08:16:11Z",  
        "parity": "NONE",  
        "status": "ACTIVE",  
        "slaveId": 1,  
        "stopbits": 1,  
        "updateTime": "2017-02-04T08:16:11Z",  
        "gatewayCode": "jwangateway",  
        "uuid": "8603dbc2-3fdc-4683-bfc5-dc18ed50adcf"  
    }

    创建

    接口描述

    相对URI HTTP 方式
    /v1/device POST

    输入

    名称 类型 是否必选 默认值 参数位置 说明
    code String Y body json 子设备名称(同一网关下唯一)
    description String N "" body json 子设备描述
    gatewayUuid String Y body json 所属网关id
    slaveId Int Y body json MODBUS从站号[1-247]
    address String Y body json 地址, 对于TCP模式:ip:port, 如192.168.0.2:502 对于RTU模式:是串口号,如/dev/USBtty1
    mode ENUM N TCP body json TCP, RTU
    baud Int N 9600 body json 波特率,仅对RTU有意义
    databits Int N 8 body json 数据位,仅对RTU有意义
    stopbits Int N 1 body json 停止位,仅对RTU有意义
    parity ENUM N NONE body json 校验,NONE/EVEN/ODD, 仅对RTU有意义

    输出

    201: 成功

    输出创建成功的device

    其他: 失败

    请求示例

    {  
        "databits": 8,  
        "baud": 300,  
        "address": "127.0.0.1:502",  
        "gatewayUuid": "08d95c37-bc72-44cd-8e93-8d94ff52a934",  
        "description": "",  
        "code": "subdevice",  
        "mode": "TCP",  
        "parity": "NONE",  
        "slaveId": 1,  
        "stopbits": 1,  
    }

    输出示例

    {  
        "databits": 8,  
        "baud": 300,  
        "address": "127.0.0.1:502",  
        "gatewayUuid": "08d95c37-bc72-44cd-8e93-8d94ff52a934",  
        "state": "ENABLED",  
        "description": "",  
        "code": "subdevice",  
        "mode": "TCP",  
        "createTime": "2017-02-04T08:16:11Z",  
        "parity": "NONE",  
        "status": "ACTIVE",  
        "slaveId": 1,  
        "stopbits": 1,  
        "updateTime": "2017-02-04T08:16:11Z",  
        "gatewayCode": "jwangateway",  
        "uuid": "8603dbc2-3fdc-4683-bfc5-dc18ed50adcf"  
    }

    更新

    接口描述

    相对URI HTTP 方式
    /v1/device/:deviceUuid PUT

    输入

    不能所有字段都为空

    名称 类型 是否必选 默认值 参数位置 说明
    description String N body json 描述
    slaveId Int N body json modbus 从站号
    address String N body json 地址
    state ENUM N body json 状态,[ENABLED, DISABLED]
    mode ENUM N body json TCP,RTU
    baud Int N body json 波特率
    databits Int N body json 数据位
    stopbits Int N body json 停止位
    parity ENUM N body json 奇偶校验

    输出

    201: 成功

    输出更新成功后的device

    其他: 失败

    请求示例

    {
        "description":"",
        "gatewayUuid":"08d95c37-bc72-44cd-8e93-8d94ff52a934",
        "slaveId":1,
        "address":"127.0.0.1:502",
        "mode":"TCP",
        "baud":300,
        "databits":8,
        "stopbits":1,
        "parity":"NONE"
    }

    输出示例

    {
        "databits":8,
        "baud":300,
        "address":"127.0.0.1:502",
        "gatewayUuid":"08d95c37-bc72-44cd-8e93-8d94ff52a934",
        "state":"ENABLED",
        "description":"",
        "code":"subdevice",
        "mode":"TCP",
        "createTime":"2017-02-04T08:16:11Z",
        "parity":"NONE",
        "status":"ACTIVE",
        "slaveId":1,
        "stopbits":1,
        "updateTime":"2017-02-04T08:16:11Z",
        "gatewayCode":"jwangateway",
        "uuid":"8603dbc2-3fdc-4683-bfc5-dc18ed50adcf"
    }

    删除

    接口描述

    相对URI HTTP 方式
    /v1/device/:deviceUuid DELETE

    输入

    名称 类型 是否必选 默认值 含义
    deviceUuid String Y 子设备id

    输出

    204: 成功

    其他: 失败

    请求示例

    DELETE /v1/device/8603dbc2-3fdc-4683-bfc5-dc18ed50adcf
    上一篇
    Gateway
    下一篇
    ParserObject