一、对象说明
本文档说明主要面向开发者,开发者需要在物联网平台创建产品后,为产品定义相应的物模型。创建产品操作流程可参考创建产品文档。
二、概述
物联网平台支持为产品定义物模型,将实际设备抽象成由属性、服务、事件所组成的数据模型,指导南向设备的接入。产品创建完成后,您可以为它定义物模型,产品下的设备将可以按照所属产品的物模型内容来进行接入。
三、操作步骤
1、登录物联云平台。
2、您可以通过设备中心>产品管理进入产品列表,选择需要定义物模型的产品,进入其产品详情页面;
3、在左侧导航栏,通过物模型子菜单,可查看此产品的物模型信息。
4、产品物模型的定义分为两种情况:
- 可使用物联云平台提供的标准物模型来为产品定义物模型:
(1)点击【匹配物模型】按钮,进入匹配物模型页面;
(2)选择物模型后,点击【确定】即可完成产品物模型的定义。
- 也可通过自定义属性,服务和事件来自定义产品物模型:
自定义属性:
(1)在属性页签中,点击【自定义属性】按钮,打开自定义属性弹窗;
(2)填写自定义属性表单内容,完成产品物模型定义。
字段 | 说明 |
---|---|
索引 | 物联云平台提供给设备厂商对接开发时使用的属性标识。索引为0和正整数,取值范围为0-255个字符。 |
字段名 | 物模型中,属性的唯一标识。字段名为数字,字母,下划线,美元符号,且不能以数字开头,字符长度为1-32个字符。 |
属性名称(中) | 属性的中文名称。属性名称(中)为文本类型,字符长度为1-32个字符。 |
属性名称(英) | 属性的英文名称。属性名称(英)为文本类型,字符长度为1-64个字符(可选)。 |
数据类型 | 设备上报数据至物联云平台后的属性数据类型。数据类型为单选项,选项有:布尔类型、单字节(无符号)、16位短整型(有符号)、32位整型(有符号)、浮点、字符串、16位短整型(无符号)、32位整型(无符号)、Double类型、日期类型、64位长整型、枚举、数组。 |
取值范围 | 数据类型为数字类型时展示,规定属性上报的数字取值范围。 |
单位 | 数据类型为数字类型时展示,定义属性上报的数字单位符号,便于明确数据意义。 |
枚举项 | 用于定义设备上报属性中枚举相应的值,并可对该值添加补充描述(必填)。 |
读写状态 | 规定设备属性的读写状态。 |
元素类型 | 当数据类型为数组时展示此项,用于确定数组中的数据类型。该项为单选项,选项有字节类型、短整型、整型、长整型、字符串、单精度浮点、双精度浮点、布尔类型。 |
描述(中)(英) | 对属性的补充描述。 |
自定义服务:
(1)在服务页签中,点击【添加服务】按钮,打开自定义服务弹窗;
(2)填写自定义服务表单内容,完成产品物模型定义。
字段 | 说明 |
---|---|
服务名 | 物模型中,服务的唯一标识。服务名为数字,字母,下划线,美元符号,且不能以数字开头,字符长度为1-32个字符。 |
服务名称(中) | 服务的中文名称,为文本类型,长度为1-32个字符。 |
服务名称(英) | 服务的英文名称,为数字,字母类型,长度为1-32个字符。 |
输入参数 | 调用服务时,服务的输入参数定义,具体定义内容如下。 |
输出参数 | 调用服务后,服务的输出参数定义,具体定义内容如下。 |
错误码描述 | 调用服务发生的错误码定义即错误码含义描述,具体内容如下。 |
描述(中)(英) | 服务的中英文补充描述。 |
输入参数:
字段 | 说明 |
---|---|
参数名 | 设备服务中,输入参数的唯一标识。参数名为数字,字母,下划线,美元符号,且不能以数字开头,字符长度为1-32个字符。 |
名称(中) | 参数的中文名称。属性名称(中)为文本类型,字符长度为1-32个字符。 |
名称(英) | 参数的英文名称。属性名称(英)为文本类型,字符长度为1-64个字符(可选)。 |
数据类型 | 设备服务输入参数的数据类型。数据类型为单选项,选项有:布尔类型、单字节(无符号)、16位短整型(有符号)、32位整型(有符号)、浮点、字符串、16位短整型(无符号)、32位整型(无符号)、Double类型、日期类型、64位长整型、枚举、数组。 |
取值范围 | 数据类型为数字类型时展示,规定输入参数的数字取值范围。 |
单位 | 数据类型为数字类型时展示,定义输入参数的数字单位符号,便于明确数据意义。 |
枚举项 | 用于定义设备服务中输入参数数据枚举相应的值,并可对该值添加补充描述(必填)。 |
是否必填 | 服务输入参数是否为必填,为单选项,选项有:是、否。 |
元素类型 | 当数据类型为数组时展示此项,用于确定数组中的数据类型。该项为单选项,选项有字节类型、短整型、整型、长整型、字符串、单精度浮点、双精度浮点、布尔类型。 |
描述(中)(英) | 对输入参数的补充描述。 |
输出参数:
字段 | 说明 |
---|---|
参数名 | 设备服务中,输出参数的唯一标识。参数名为数字,字母,下划线,美元符号,且不能以数字开头,字符长度为1-32个字符。 |
名称(中) | 参数的中文名称。属性名称(中)为文本类型,字符长度为1-32个字符。 |
名称(英) | 参数的英文名称。属性名称(英)为文本类型,字符长度为1-64个字符(可选)。 |
数据类型 | 设备服务输出参数的数据类型。数据类型为单选项,选项有:布尔类型、单字节(无符号)、16位短整型(有符号)、32位整型(有符号)、浮点、字符串、16位短整型(无符号)、32位整型(无符号)、Double类型、日期类型、64位长整型、枚举、数组。 |
取值范围 | 数据类型为数字类型时展示,规定输出参数的数字取值范围。 |
单位 | 数据类型为数字类型时展示,定义输出参数的数字单位符号,便于明确数据意义。 |
枚举项 | 用于定义设备服务输出参数数据中枚举相应的值,并可对该值添加补充描述(必填)。 |
是否必填 | 服务输出参数是否为必填,为单选项,选项有:是、否。 |
元素类型 | 当数据类型为数组时展示此项,用于确定数组中的数据类型。该项为单选项,选项有字节类型、短整型、整型、长整型、字符串、单精度浮点、双精度浮点、布尔类型。 |
描述(中)(英) | 对输出参数的补充描述。 |
错误码描述:
字段 | 说明 |
---|---|
错误码 | 定义调用设备服务时发生错误的错误情况编码。只允许输入数字,字母,下划线,并限制输入长度为1-32位字符长度。 |
错误码描述 | 对定义的错误码的补充描述,便于明确错误码对应的错误情况。 |
自定义事件:
(1)在事件页签中,点击【添加事件】按钮,打开自定义事件弹窗;
(2)填写自定义事件表单内容,完成产品物模型定义。
字段 | 说明 |
---|---|
字段 | 说明 |
事件名 | 事件的名称,事件的唯一标识。字段名为数字,字母,下划线,美元符号,且不能以数字开头,字符长度为1-32个字符。 |
事件名称(中) | 事件的中文名称。事件名称(中)为文本类型,字符长度为1-32个字符。 |
事件名称(英) | 事件的英文名称。事件名称(英)为文本类型,字符长度为1-64个字符(可选)。 |
添加参数 | 添加事件的参数时,事件的输入参数定义,具体定义内容如下。 |
描述(中)(英) | 对事件的补充描述。 |
添加参数:
字段 | 说明 |
---|---|
参数名 | 设备事件中,输入参数的唯一标识。参数名为数字,字母,下划线,美元符号,且不能以数字开头,字符长度为1-32个字符。 |
名称(中) | 参数的中文名称。事件参数名称(中)为文本类型,字符长度为1-32个字符。 |
名称(英) | 参数的英文名称。事件参数名称(英)为文本类型,字符长度为1-64个字符(可选)。 |
数据类型 | 设备事件输入参数的数据类型。数据类型为单选项,选项有:布尔类型、单字节(无符号)、16位短整型(有符号)、32位整型(有符号)、浮点、字符串、16位短整型(无符号)、32位整型(无符号)、Double类型、日期类型、64位长整型、枚举、数组。 |
是否必填 | 事件输入参数是否为必填,为单选项,选项有:是、否。 |
描述(中)(英) | 对输入参数的补充描述。 |
四、后续操作
- 创建产品并为产品定义好物模型之后,在设备接入流程中,您接下来可以在产品下创建设备,创建设备详细操作见设备注册文档,其中举例了创建设备的几种方式。