批量添加物模型

物模型包括属性、事件和服务。您可通过导入物模型来快速批量添加属性、事件和服务,即将已编辑好的物模型JSON文件或其他产品的物模型导入为当前产品的物模型。本文介绍批量导入物模型功能的操作步骤。

前提条件

已创建产品。具体操作,请参见创建产品

使用说明

  • MQTT型实例下不支持物模型功能,无法添加物模型。

  • 导入物模型后,会覆盖该产品原有的功能定义。请谨慎使用。

  • 接入网关协议为Modbus、OPC UA、ZigBee和BLE的网关子设备类型产品,不支持导入物模型。

  • 如果产品已发布,不能新增或编辑物模型。如需新增或编辑物模型,需先撤销产品发布。

  • 如果导入其他产品的物模型,产品的所属品类必须相同。

  • 产品属于标准品类时,不支持修改标准功能的功能类型标识符数据类型,不支持删除必选的标准功能。

添加物模型功能

  1. 登录物联网平台控制台

  2. 在控制台左上方,选择物联网平台所在地域。

  3. 实例概览页签的全部环境下,找到对应的实例,单击实例卡片。

  4. 在左侧导航栏中,选择设备管理 > 产品

  5. 产品页面的产品列表中,单击产品对应操作列的查看

  6. 在产品详情页面,单击功能定义页签,然后单击前往编辑草稿

  7. 单击快速导入,然后在弹出的对话框中导入物模型。

    导入物模型

    支持两种批量添加方法。

    • 拷贝产品页签,选择物模型源产品和物模型版本,然后单击确定

      源产品对应版本的默认模块和自定义模块物模型都会导入。您可在功能定义编辑草稿页面,单击模块下功能对应的编辑按钮,修改该功能定义。

    • 导入物模型页签,上传物模型单个JSON文件或多个JSON文件的ZIP压缩包文件。

      物模型文件编写和打包要求,请参见什么是物模型

      说明

      如果文件不符合要求,上传后会提示校验失败。您需根据提示,排查并修正文件后,重新上传。排查方法,请参见批量导入物模型,TSL检验失败怎么办?

    • 物模型导入中时,编辑草稿页面不可再对物模型模块和物模型功能执行添加、编辑、删除和发布操作。

    • 物模型导入失败时,页面会提示失败原因,您可根据提示修正问题后,重新导入物模型。

    • 物模型导入成功后,会直接覆盖该产品下原有的默认模块和自定义模块的物模型。

发布物模型

重要

物模型发布后,才会正式生效。

  1. 单击功能定义编辑草稿页面左下方的发布上线。控制台页面会弹出发布物模型上线?对话框。

  2. 可选:单击添加发布备注,输入版本号和版本描述。

    参数

    说明

    版本号

    设置当前物模型版本号。后期可根据版本号管理物模型。

    版本号支持英文字母、数字和英文句号(.),长度限制1~16个字符。

    版本描述

    描述当前版本物模型。支持中文汉字、英文字母、日文、数字和特殊符号。长度限制为100个字符。一个中文汉字算一个字符;一个日文算一个字符。

  3. 如果存在已上线的版本,则需要进行比对,确认新版本的修改点。

    单击比对结果,在比对结果对话框中查看修改点。确认无误后,单击确认查阅,回到发布物模型上线对话框,自动选中“确认已查看当前版本与线上版本的比对结果”前的复选框。

    如果不需要比对,您可直接手动选中“确认已查看当前版本与线上版本的比对结果”前的复选框。

  4. 单击确定,完成物模型的发布。

    发布物模型成功后,会直接返回产品详情页面的功能定义页签,您可看到当前物模型的版本号和上线时间。

    image.png

执行结果

物模型发布后,物联网平台为该产品生成正式版本的物模型。在产品详情页面的功能定义页签下,您可以:

  • 单击物模型TSL,查看JSON格式的物模型TSL。

  • 单击生成设备端代码,下载物联网平台根据您定义的功能生成的设备端代码,用于设备端物模型功能开发。

重要

仅华东2(上海)地域的旧版公共实例支持生成设备端代码。实例说明,请参见公共实例

相关API

API

描述

UpdateThingModel

更新指定产品物模型中的单个功能,支持更新物模型扩展描述。

QueryThingModel

查看指定产品的物模型中的功能定义详情。

CopyThingModel

复制指定产品的物模型到目标产品。

PublishThingModel

发布指定产品的物模型。

ImportThingModelTsl

为指定产品导入物模型TSL,暂不支持扩展描述配置。

QueryThingModelPublished

查看指定产品的已发布物模型中的功能定义详情。

后续操作

产品下设备上报的物模型数据默认会自动写入热数据存储空间,您可根据实际业务需要,停止部分或全部物模型的热数据存储服务。具体内容,请参见关闭或开启物模型数据存储

相关文档