物解析IOT Parser

    DataDescription

    字段 类型 说明
    uuid String 全局唯一ID
    parserObjectUuid String 解析项目id
    bit String 不可以>=length
    length ENUM [ 1,8,16,32 ]
    address Int 对应的MODBUS设备地址,例如40001,00002
    name String 名称
    kind ENUM [ INT, BOOL, REAL, INT32, REAL32 ]
    unit String 单位
    rh Double 上限
    rl Double 下限
    formula String 计算公式(通过x引用modbus数据)
    user_properties JSON 用户自定义属性,以JSON格式标示,eg: {"myprop":"thisisvalue", "myprop1":"val2"}
    state ENUM [ENABLED, DISABLED]
    status ENUM [ERROR, ACTIVE, DELETED]
    createTime DateTime 创建记录的时间
    updateTime DateTime 最后修改记录的时间

    筛选

    接口描述

    相对URI HTTP 方式
    /v1/data-description GET

    输入

    名称 类型 是否必选 默认值 含义
    parserObjectUuid String N null 解析项目id
    state ENUM N null [ENABLED, DISABLED]
    addressStart Int N -1 address以什么开头。可能取值:-1,0,1,3,4。(-1和不填一样)

    输出

    200: 成功

    输出一个data description的List

    其他: 失败

    请求示例

    GET /v1/data-description

    示例输出

    {  
        "orderBy": "createTime",  
        "order": "desc",  
        "pageNo": 1,  
        "pageSize": 10,  
        "result": [  
            {  
                "formula": "x+4",  
                "user_properties": {},  
                "rl": 0,  
                "address": "40004",  
                "abbreviation": "",  
                "state": "ENABLED",  
                "kind": "INT",  
                "length": 16,  
                "rh": 1,  
                "bit": -1,  
                "name": "overwrite",  
                "createTime": "2016-11-17T07:37:32Z",  
                "status": "ACTIVE",  
                "parserObjectUuid": "b838bb59-8f5a-4e2a-aa1e-a3694425c46c",  
                "updateTime": "2016-11-17T07:37:32Z",  
                "unit": "a",  
                "uuid": "7ea063dd-5fca-4fad-b38b-726066eca276"  
            },  
            {  
                "formula": "",  
                "user_properties": {},  
                "rl": 0,  
                "address": "40003",  
                "abbreviation": "",  
                "state": "ENABLED",  
                "kind": "INT",  
                "length": 16,  
                "rh": 1,  
                "bit": -1,  
                "name": "asdfa",  
                "createTime": "2016-11-17T01:50:32Z",  
                "status": "ACTIVE",  
                "parserObjectUuid": "b838bb59-8f5a-4e2a-aa1e-a3694425c46c",  
                "updateTime": "2016-11-17T01:50:32Z",  
                "unit": "",  
                "uuid": "df68b7dd-7920-4cbd-a9c2-57c19642c278"  
            }  
        ],  
        "totalCount": 2  
    }

    获取

    接口描述

    相对URI HTTP 方式
    /v1/data-description/<data-description-uuid> GET

    输入

    名称 类型 是否必选 默认值 含义
    dataDescriptionUuid String Y 解析设置id

    输出

    200: 成功

    输出一个这个uuid对应的data description

    其他: 失败

    请求示例

    GET /v1/data-description/7ea063dd-5fca-4fad-b38b-726066eca276

    输出示例

    {  
        "formula": "x+4",  
        "user_properties": {},  
        "rl": 0,  
        "address": "40004",  
        "abbreviation": "",  
        "state": "ENABLED",  
        "kind": "INT",  
        "length": 16,  
        "rh": 1,  
        "bit": -1,  
        "name": "overwrite",  
        "createTime": "2016-11-17T07:37:32Z",  
        "status": "ACTIVE",  
        "parserObjectUuid": "b838bb59-8f5a-4e2a-aa1e-a3694425c46c",  
        "updateTime": "2016-11-17T07:37:32Z",  
        "unit": "a",  
        "uuid": "7ea063dd-5fca-4fad-b38b-726066eca276"  
    }

    创建

    接口描述

    相对URI HTTP 方式
    /v1/data-description POST

    输入

    名称 类型 是否必选 默认值 参数位置 说明
    parserObjectUuid String Y body json 解析项目id
    bit int N -1 body json 不能大于length
    length ENUM Y body json 数据长度
    address Int Y body json modbus地址
    name String Y body json 数据名称
    kind ENUM Y body json [ INT, BOOL, REAL, INT32, REAL32
    unit ENUM N "" body json 单位
    rh Double N 1.0 body json 量程上限
    rl Double N 0.0 body json 量程下限

    输出

    名称 类型 是否必选 默认值 参数位置 说明
    formula String N "" body json 计算公式
    user_properties JSON 自定义字段

    输出

    201: 成功

    输出创建成功的data description

    其他: 失败

    请求示例

    {
        "address":"40001",
        "bit": -1,
        "name":"testname",
        "rh": 1,
        "rl": 0,
        "kind":"INT",
        "length":16,
        "unit":"a",
        "formula":"x\*100",
        "parserObjectUuid":"1ca804a8-80ce-4882-846e-ba8dc733136a",
        "user_properties":{
            "分组":"温度",
            "prop2":""
        }
    }

    输出示例

    {
        "formula":"x\*100",
        "user_properties":{
            "分组":"温度",
            "prop2":""
        } 
        "rl": 0,  
        "address": "40001",  
        "abbreviation": "",  
        "state": "ENABLED",  
        "kind": "INT",  
        "length": 16,  
        "rh": 1,  
        "bit": -1,  
        "name": "testname",  
        "createTime": "2016-11-17T07:37:32Z",  
        "status": "ACTIVE",  
        "parserObjectUuid":"1ca804a8-80ce-4882-846e-ba8dc733136a",
        "updateTime": "2016-11-17T07:37:32Z",  
        "unit": "a",  
        "uuid": "7ea063dd-5fca-4fad-b38b-726066eca276"  
    }

    更新

    接口描述

    相对URI HTTP 方式
    /v1/data-description/<data-description-uuid> PUT

    输入

    不能所有字段都为空

    名称 类型 是否必选 默认值 参数位置 说明
    state ENUM N body json [ENABLED, DISABLED]
    bit int 数据位
    length ENUM 长度
    address int MODBUS数据地址
    name String 名字
    kind ENUM 数据类型
    unit String "" 单位
    rh Double 1 量程上限
    rl Double 0 量程下限
    formula String "" 计算公式
    user_properties JSON 自定义属性

    输出

    201: 成功

    输出创建成功的data description

    其他: 失败

    请求示例

    {
        "state":"ENABLED"
    }

    输出示例

    {
        "formula":"x\*100",
        "user_properties":{
            "分组":"温度",
            "prop2":""
        } 
        "rl": 0,  
        "address": "40001",  
        "abbreviation": "",  
        "state": "ENABLED",  
        "kind": "INT",  
        "length": 16,  
        "rh": 1,  
        "bit": -1,  
        "name": "testname",  
        "createTime": "2016-11-17T07:37:32Z",  
        "status": "ACTIVE",  
        "parserObjectUuid":"1ca804a8-80ce-4882-846e-ba8dc733136a",
        "updateTime": "2016-11-17T09:05:24Z",  
        "unit": "a",  
        "uuid": "7ea063dd-5fca-4fad-b38b-726066eca276"  
    }

    删除

    接口描述

    相对URI HTTP 方式
    /v1/data-description/<data-description-uuid> DELETE

    输入

    名称 类型 是否必选 默认值 含义
    dataDescriptionUuid String Y 解析设置id

    输出

    204: 成功

    其他: 失败

    请求示例

    DELETE /v1/data-description/7ea063dd-5fca-4fad-b38b-726066eca276
    一篇
    PullRule
    一篇
    Action