物模型与配置模板介绍

本文档描述了什么是物模型，以及物模型的格式与结构。

物模型

背景信息: A 物模型是一种标准化数据模型，用于定义星纵开放平台中设备的特性、功能和行为。物模型提供了一种结构化的方式来表示设备信息，包括设备的定义、功能和数据。

格式: 物模型的格式为 JSON。

结构

星纵开放平台的物模型包括版本、属性、事件和服务，具体参考以下示例：

{
    "data": {
        "version": "v1.0",    // 物模型版本。
        "properties": [    // 设备状态与基础信息。
            {
                "id": "",    
                "name": "",           
                "accessMode": "",     // 属性的访问模式。
                "hidden": true,    // 是否显示该属性。
                "dataSpec": {}    // 该属性的详细信息（数据定义）。
            }
        ],
        "events": [    // 设备向星纵开放平台上报的数据。            {
                "id": "",                
                "name": "",
                "type": "",
                "hidden": false,
                "outputs": []    // 报警事件数据。
            }
        ],
        "services": [    // 可在此设备上调用的服务。
            {
                "id": "",
                "name": "",
                "callType": "",    // 该服务调用的类型。
                "hidden": false,
                "inputs": [],    // 调用该服务时的下行数据。
                "outputs": []    // 调用该服务时上行的数据。
            }
        ]
    }
}

描述


参数	描述
`version`	物模型版本。
`properties`	属性是设备可以读取或写入的特征或属性，根据访问模式，属性分为以下几类： Read-only: 无法更改的静态数据或值，描述设备的状态或信息。例如，设备的SN (序列号) 或版本号 Write-only: 可配置参数，代表可以配置的设备参数。例如，传感器的上报周期。注：可以通过 API 修改Write-only属性的值来更新设备的设置。 Read/write: 参数不仅描述设备信息，而且可以修改。例如，智能插座的开或关。注：可以通过 API 修改Read/write属性的值来更新设备的设置。
`events`	事件是指当特定事件发生时，设备向星纵开放平台上报的数据。例如，人员统计传感器设置为越线报告，当传感器检测到有人越线时，会将相关数据报告给星纵开放平台。
`services`	服务是指可以在设备上执行的操作。它表示可以调用以与设备交互的方法或操作。例如，重启设备、查询设备的历史数据等。注：可以通过 API 调用该服务。

配置模板

介绍: 配置模板概述了可在星纵开放平台上配置的可访问网络的设备的所有设置。你可以使用默认配置模板使用设备的标准配置，或创建自定义配置模板根据需要更新设置，然后将它们应用到你的设备。

格式: 配置模板格式为 JSON。

结构

配置模板由版本和密钥对列表构成，具体参考以下示例：

{
    "version": "v1.0",    // 配置模板版本。
    "values": [    
        {
            "key": "********",    // 配置密钥。
            "value": 1     
        },
        {
            "key": "*********",
            "value": 0
        },
        ..........
    ]
}