物解析IOT Parser

    PullRule

    字段 类型 说明
    uuid String 全局唯一ID
    parserObjectUuid String 解析项目id
    deviceUuid String 子设备的id
    functionCode Int 操作码: 1,2,3,4
    startAddress Int 起始地址[0, 65535]
    length Int 请求数据长度[1, 65536]
    pullInterval Int 轮询间隔(秒)
    status ENUM [ERROR, ACTIVE, DELETED]
    createTime DateTime 创建记录的时间
    updateTime DateTime 最后修改记录的时间

    筛选

    接口描述

    相对URI HTTP 方式
    /v1/pull-rule GET

    输入

    名称 类型 是否必选 默认值 含义
    parserObjectUuid String N null 筛选条件之一,解析项目id
    deviceUuid String N null 筛选条件之一,子设备id
    status ENUM N null 筛选条件之一,状态
    withDevice Boolean N false 如果添加会多返回一个device字段 "device":{ "slaveId": Int, "code": String, "address": String , "description": String }

    输出

    200: 成功

    输出一个Device的List

    其他: 失败

    请求示例

    GET /v1/pull-rule

    输出示例

    {  
        "totalCount": 1,  
        "result": [  
            {  
                "functionCode": 3,  
                "length": 3,  
                "createTime": "2017-03-07T17:05:40Z",  
                "status": "ACTIVE",  
                "parserObjectUuid": "cc6904fd-d6ef-4bbb-9b78-36b243627cb7",  
                "updateTime": "2017-03-07T17:05:40Z",  
                "pullInterval": 1,  
                "startAddress": 9,  
                "deviceUuid": "d6cf5a60-cc0d-45b6-bb4c-3a2a1829279e",  
                "uuid": "0feb2135-2646-4519-86c8-ca88e412e0b7"  
            }  
        ],  
        "order": "asc",  
        "orderBy": "createTime",  
        "pageSize": 50,  
        "pageNo": 1  
    }

    获取

    接口描述

    相对URI HTTP 方式
    /v1/pull-rule/: pullRuleUuid GET

    输入

    名称 类型 是否必选 默认值 含义
    withDevice Boolean N false 如果添加会多返回一个device字段 "device":{ "slaveId": Int, "code": String, "address": String , "description": String }
    pullRuleUuid String Y 轮询规则id

    输出

    200: 成功

    输出一个这个uuid对应的pullrule

    其他: 失败

    请求示例

    GET /v1/pull-rule/766c1880-bfd4-449a-9304-84192ae5851e?withDevice=true

    输出示例

    {  
        "functionCode": 3,  
        "length": 8,  
        "device": {  
            "slaveId": 218,  
            "code": "cbaf6cf7-896c-4a76-9f77-2797c2db1d00\_1488906401944",  
            "address": "/dev/TTYUsb1",  
            "description": "device for cbaf6cf7-896c-4a76-9f77-2797c2db1d00"  
        },  
        "createTime": "2017-03-07T17:06:42Z",  
        "status": "ACTIVE",  
        "parserObjectUuid": "c39bc78b-5093-41bb-b1a4-9ee3cae47ca2",  
        "updateTime": "2017-03-07T17:06:42Z",  
        "pullInterval": 5,  
        "startAddress": 5,  
        "deviceUuid": "6ebafd28-a078-44aa-aae3-ebb9774f127a",  
        "uuid": "766c1880-bfd4-449a-9304-84192ae5851e"  
    }

    创建

    接口描述

    相对URI HTTP 方式
    /v1/pull-rule POST

    输入

    名称 类型 是否必选 默认值 参数位置 说明
    parserObjectUuid String Y body json 解析项目id
    deviceUuids List[String] Y body json 子设备id列表
    fucntionCode Int Y body json 操作码[1,2,3,4]
    startAddress Int Y body json 起始地址
    length Int Y body json 请求数据长度
    pullInterval Int Y body json 轮询间隔(秒)

    输出

    201: 成功

    输出创建成功的pull rule

    其他: 失败

    请求示例

    {
        "parserObjectUuid":"227d290c-ddd1-446d-a9e3-e4841afe8535",
        "deviceUuids":[
            "842b91c9-f66f-455b-a57e-5ddc4dc2edc2"
        ],
        "functionCode":1,
        "startAddress":27,
        "length":1,
        "pullInterval":3
    }

    输出示例

    {  
        "functionCode": 1,  
        "length": 1,  
        "createTime": "2017-03-07T17:06:42Z",  
        "status": "ACTIVE",  
        "parserObjectUuid": "227d290c-ddd1-446d-a9e3-e4841afe8535",  
        "updateTime": "2017-03-07T17:06:42Z",  
        "pullInterval": 3,  
        "startAddress": 27,  
        "deviceUuid": "842b91c9-f66f-455b-a57e-5ddc4dc2edc2",  
        "uuid": "766c1880-bfd4-449a-9304-84192ae5851e"  
    }

    更新

    接口描述

    相对URI HTTP 方式
    /v1/pull-rule/:pullRuleUuid PUT

    输入

    不能所有字段都为空

    名称 类型 是否必选 默认值 参数位置 说明
    pullInterval Int N body json 轮询间隔

    输出

    201:

    输出修改成功后的pull rule

    其他: 失败

    请求示例

    {
        "pullInterval":3
    }

    删除

    接口描述

    相对URI HTTP 方式
    /v1/pull-rule/:pullRuleUuid DELETE

    输入

    名称 类型 是否必选 默认值 含义
    pullRuleUuid String Y 轮询规则id

    输出

    204: 成功

    其他: 失败

    请求示例

    DELETE /v1/pull-rule/766c1880-bfd4-449a-9304-84192ae5851e
    上一篇
    ParserObject
    下一篇
    DataDescription