文档更新中~

为产品添加物模型的功能定义，即单个添加属性、事件和行为。本文介绍如何在AIoT开发者平台控制台定义物模型。

前置条件

  • 您的账号具备相应功能菜单的权限，并至少拥有一个产品的授权。
  • 您的设备已对接 物模型服务。

使用说明

  • 产品处于 “未上线 / 开发中” 状态才能编辑物模型。
  • 为了方便设备端调试，编辑后即对当前产品下所有设备生效，设备上报数据时将根据 TSL 进行物模型数据校验
  • 为了设备端调试时不影响应用层，仅设备端调试完成并发布草稿版本后，应用层（eg：APP）才能获取到该版本TSL。
  • 为防止设备与应用受影响，物模型TSL必须向下兼容，因此在草稿版本发布后，新版本仅支持 增量变更。

添加自定义功能

  1. 登录 设备平台。

  2. 进入 产品管理 > 产品开发 > 查看详情，找到 物模型定义 页签。

  3. 点击 编辑草稿，则可编辑草稿版本。

  1. 点击 添加自定义功能，就可以为当前版本物模型添加自定义属性、事件和行为。

  • 属性：在 添加自定义功能 对话框，选择功能类型为 属性。设置参数完成后，单击 确认。属性参数设置说明如下表。
参数 说明
功能名称 属性的名称，例如开关。同一产品下功能名称不能重复。
标识符 属性的唯一标识符，在产品中具有唯一性。即JSON格式中的identifier的值，作为设备上报该属性数据的Key，云端根据该标识符校验是否接收数据。
nid 属性标识符的整型描述，在产品中具有唯一性，用于对内存敏感、报文压缩的产品。
数据类型 int32：32位整型。需定义取值范围、步长和单位符号。
float：单精度浮点型。需定义取值范围、步长和单位符号。
enum：枚举型。定义枚举项的参数值和参数描述，例如：1表示加热模式、2表示制冷模式。
bool：布尔型。采用0或1来定义布尔值，例如：0表示关、1表示开。
string：字符串。需定义字符串的数据长度，最长支持2048字节。
timestamp：时间戳。格式为String类型的UTC时间戳，单位：毫秒。
struct：JSON对象。定义一个JSON结构体，新增JSON参数项，例如：定义灯的颜色是由Red、Green、Blue三个参数组成的结构体，不支持结构体嵌套，JSON对象上限为限制100个。
array：数组。需声明数组内的元素类型、数组元素个数。元素类型可选择int32、float、string，需确保同一个数组元素类型相同。元素个数，限制1~512个。
取值范围 数据类型为int32、float时，可设置属性值的取值范围。
步长 属性值变化的最小粒度。数据类型为int32、float时，可根据您的业务需要设置步长。
例如：为温度计产品定义温度属性时，将数据类型设置为int32，步长为2，单位为℃，取值范围0~100。即温度每变化两度，设备上报温度值，例如：0℃、2℃、4℃、6℃、8℃等。
单位 单位可选择为无，或根据实际情况选择。
读写类型 读写权限录入规范如下：
读、上报：云端可以从设备获取该属性、但无法修改设备端当前属性。例如扫地机器人的电池电量；
读、写、上报：云端可以从设备获取该属性、可以修改设备端当前属性、设备端会上报该属性。例如开关功能；
写、上报：云端可以修改当前属性，设备端会上报该属性；
上报：当前属性只支持从设备端主动上报，例如错误码、溢水事件等；
写：云端可以修改当前属性，但设备端不会响应；
备注 输入文字，对该功能进行说明或备注。长度限制为300个字符。
  • 事件：在 添加自定义功能 对话框，选择功能类型为 事件。设置参数完成后，单击 确认。事件参数设置说明如下表。
参数 说明
功能名称 属性的名称，例如开关。同一产品下功能名称不能重复。
标识符 属性的唯一标识符，在产品中具有唯一性。即JSON格式中的identifier的值，作为设备上报该属性数据的Key，云端根据该标识符校验是否接收数据。
事件类型 您可以针对不同的事件类型进行业务逻辑处理和统计分析。
信息：指设备上报的一般性通知，例如：完成某项任务。
告警：设备运行过程中主动上报的突发或异常情况，告警类信息，优先级高。
故障：设备运行过程中主动上报的突发或异常情况，故障类信息，优先级高。
输出参数 该事件的出参。单击增加参数，在弹下拉框中选择一个某个属性出参。例如：将已定义的属性电压作为出参，则设备上报该故障事件时，将携带当前设备的电压值，用于进一步判断故障原因。
一个事件最多支持定义50个出参。
备注 输入文字，对该功能进行说明或备注。长度限制为300个字符。
  • 行为：在 添加自定义功能 对话框，选择功能类型为 行为。设置参数完成后，单击 确认。行为参数设置说明如下表。
参数 说明
功能名称 属性的名称，例如开关。同一产品下功能名称不能重复。
标识符 属性的唯一标识符，在产品中具有唯一性。即JSON格式中的identifier的值，作为设备上报该属性数据的Key，云端根据该标识符校验是否接收数据。
调用方式 异步：服务为异步调用时，云端执行调用后直接返回结果，不会等待设备的回复消息。
同步：服务为同步调用时，云端会等待设备回复；若设备没有回复，则调用超时。
输入参数 设置该行为的入参。单击增加参数，在下拉框中选择某个属性作为入参。一个行为最多支持定义20个入参。

例如：在定义自动喷灌服务功能时，将已定义的属性喷灌时间和喷灌量作为自动喷灌服务的入参，则调用该参数时传入这两个参数，喷灌设备将按照设定的喷灌时间和喷灌量自动进行精准灌溉。
输出参数 设置该行为的出参。单击增加参数，在下拉框中选择某个属性作为出参。

例如：将已定义的属性电压作为出参，则设备上报该故障事件时，将携带当前设备的电压值，用于进一步判断故障原因。
一个行为最多支持定义20个出参。
备注 输入文字，对该功能进行说明或备注。长度限制为300个字符。

复用物模型

在AIoT开发者平台控制台，您可以通过复制物模型来批量添加属性、事件和行为，即将其他产品中已编辑好的物模型JSON文件或其他产品的物模型导入为当前产品的物模型。此处介绍复制物模型功能的操作步骤。

  1. 登录 云鲸AIoT开发者平台。

  2. 进入 产品管理 > 产品开发 > 产品详情，找到 物模型定义 页签。

  3. 在草稿版本中，点击 复用物模型 功能，选择要复制的 源产品 及 物模型版本，勾选要复制的功能定义并点击 确定 即可。

下载物模型TSL

为方便您导出TSL文件写入设备/应用程序内，平台提供了一键下载物模型TSL的功能。

  1. 登录 云鲸AIoT开发者平台。

  2. 进入 产品管理 > 产品开发 > 产品详情，找到 物模型 页签。

  3. 点击 下载物模型 按钮即可。

物模型JSON结构说明，详见 物模型TSL字段说明。

 创建时间：2023-05-09 16:54
最后编辑：陈勇琦  更新时间：2024-10-18 16:29