物模型以JSON格式表达,简称为TSL(Thing Specification Language)。本文提供物模型的JSON字段说明。

您可以在产品的功能定义页面,单击查看物模型,查看JSON格式的TSL。

物模型的JSON字段说明如下:

{
    "schema": "物的TSL描述schema",
    "link": "云端系统级URI,用来调用服务/订阅事件。",
    "profile": {
        "productKey": "产品ProductKey"
    },
    "properties": [
        {
            "identifier": "属性唯一标识符(产品下唯一)",
            "name": "属性名称",
            "accessMode": "属性读写类型:只读(r)或读写(rw)。",
            "required": "是否是标准功能的必选属性",
            "dataType": {
                "type": "属性类型: int(原生)、float(原生)、double(原生)、text(原生)、date(String类型UTC毫秒)、bool(0或1的int类型)、enum(int类型)、struct(结构体类型,可包含前面6种类型)、array(数组类型,支持int/double/float/text)",
                "specs": {
                    "min": "参数最小值(int、float、double类型特有)",
                    "max": "参数最大值(int、float、double类型特有)",
                    "unit": "属性单位",
                    "unitName": "单位名称",
                    "size": "数组大小,默认最大128(数组特有)。",
                    "step": "步长,字符串类型。",
                    "item": {
                        "type": "数组元素的类型"
                    }
                }
            }
        }
    ],
    "events": [
        {
            "identifier": "事件唯一标识符(产品下唯一,其中post是默认生成的属性上报事件。)",
            "name": "事件名称",
            "desc": "事件描述",
            "type": "事件类型(info、alert、error)",
            "required": "是否是标准功能的必选事件",
            "callType": "async(异步调用)或sync(同步调用)",
            "outputData": [
                {
                    "identifier": "参数唯一标识符",
                    "name": "参数名称",
                    "dataType": {
                        "type": "属性类型: int(原生)、float(原生)、double(原生)、text(原生)、date(String类型UTC毫秒)、bool(0或1的int类型)、enum(int类型)、struct(结构体类型,可包含前面6种类型)、array(数组类型,支持int/double/float/text)",
                        "specs": {
                            "min": "参数最小值(int、float、double类型特有)",
                            "max": "参数最大值(int、float、double类型特有)",
                            "unit": "属性单位",
                            "unitName": "单位名称",
                            "size": "数组大小,默认最大128(数组特有)。",
                            "step": "步长,字符串类型。",
                            "item": {
                                "type": "数组元素的类型"
                            }
                        }
                    }
                }
            ],
            "method": "事件对应的方法名称(根据identifier生成)"
        }
    ],
    "services": [
        {
            "identifier": "服务唯一标识符(产品下唯一,其中set/get是根据属性的accessMode默认生成的服务。)",
            "name": "服务名称",
            "desc": "服务描述",
            "required": "是否是标准功能的必选服务",
            "callType": "async(异步调用)或sync(同步调用)",
            "inputData": [
                {
                    "identifier": "入参唯一标识符",
                    "name": "入参名称",
                    "dataType": {
                        "type": "属性类型: int(原生)、float(原生)、double(原生)、text(原生)、date(String类型UTC毫秒)、bool(0或1的int类型)、enum(int类型)、struct(结构体类型,可包含前面6种类型)、array(数组类型,支持int/double/float/text)",
                        "specs": {
                            "min": "参数最小值(int、float、double类型特有)",
                            "max": "参数最大值(int、float、double类型特有)",
                            "unit": "属性单位",
                            "unitName": "单位名称",
                            "size": "数组大小,默认最大128(数组特有)。",
                            "step": "步长,字符串类型。",
                            "item": {
                                "type": "数组元素的类型"
                            }
                        }
                    }
                }
            ],
            "outputData": [
                {
                    "identifier": "出参唯一标识符",
                    "name": "出参名称",
                    "dataType": {
                        "type": "属性类型: int(原生)、float(原生)、double(原生)、text(原生)、date(String类型UTC毫秒)、bool(0或1的int类型)、enum(int类型)、struct(结构体类型,可包含前面6种类型)、array(数组类型,支持int/double/float/text)",
                        "specs": {
                            "min": "参数最小值(int、float、double类型特有)",
                            "max": "参数最大值(int、float、 double类型特有)",
                            "unit": "属性单位",
                            "unitName": "单位名称",
                            "size": "数组大小,默认最大128(数组特有)。",
                            "step": "步长,字符串类型。",
                            "item": {
                                "type": "数组元素的类型(数组特有)"
                            }
                        }
                    }
                }
            ],
            "method": "服务对应的方法名称(根据identifier生成)"
        }
    ]
}

若该产品是设备,且接入网关协议为Modbus、OPC UA或自定义时,可查看物模型扩展配置。

Modbus协议产品的扩展配置示例如下:

{
  "profile": {
    "productKey": "产品ProductKey"
  },
  "properties": [
    {
      "identifier": "属性唯一标识符(产品下唯一)",
      "operateType": "(线圈状态/输入状态/保持寄存器/输入寄存器: coilStatus/inputStatus/holdingRegister/inputRegister)",
      "registerAddress": "寄存器地址",
      "originalDataType": {
        "type": "属性类型:int16、uint16、int32、uint32、int64、uint64、float、double、string、customized data(按大端顺序返回hex data)",
        "specs": {
          "registerCount": "寄存器的数据个数, string和customized data特有。",
          "swap16": "把寄存器内16位数据的前后8个bits互换(byte1byte2 -> byte2byte10),除string和customized data外,其他数据类型特有。",
          "reverseRegister": "把原始数据32位数据的bits互换(byte1byte2byte3byte4 ->byte3byte4byte1byte2),除string和customized data外,其他数据类型特有。"
        }
      },
      "scaling": "缩放因子",
      "pollingTime": "采集间隔,单位是ms。",
      "trigger": "数据的上报方式,目前有按时上报:1和变更上报:2。"
    }
  ]
}