使用ROMA Connect集成设备
概述
ROMA Connect支持使用MQTT标准协议连接设备,快速、简单地实现设备在云端管理。
本章节通过完成一个模拟设备接入ROMA Connect的配置样例,帮助您快速熟悉使用ROMA Connect集成设备的过程。
使用ROMA Connect集成设备的步骤如下所示:
- ROMA Connect实例已绑定弹性IP,且本地PC所在网络与弹性IP的网络互通。
- 已在本地PC下载MQTTX客户端并安装。
- 在当前ROMA Connect实例上完成一个消息集成Topic的创建,具体请参考创建消息Topic。
步骤一:定义产品
产品即设备模型,通过定义产品来确定设备的功能属性集合。每个设备都有一个归属的产品。
- 创建集成应用。
- 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。
- 在左侧的导航栏选择“集成应用”,单击页面右上角的“创建集成应用”。
- 在创建集成应用弹窗中填写集成应用的“名称”,然后单击“确认”。
- 创建产品。
- 在左侧的导航栏选择“设备集成 LINK > 产品管理”,单击页面右上角的“创建产品”。
- 在创建产品弹窗中配置产品相关信息,完成后单击“确认”。
表1 产品配置 参数
配置说明
产品类型
本配置样例中的设备为直连设备,此处选择“普通产品”。
协议类型
本配置样例中选择MQTT协议类型。
集成应用
选择1中创建的集成应用。
产品模板
本配置样例中未使用产品模板,此处不设置。
产品名称
填写产品的名称,本配置样例中自定义即可。
厂商名称
填写实际使用设备的厂商名字,本配置样例中自定义即可。
厂商ID
填写实际使用设备的厂商ID,本配置样例中自定义即可。
产品型号
填写实际使用设备的产品型号,本配置样例中自定义即可。
设备类型
选择接入设备的类型,本配置样例中选择默认的“Default Type”。
模型版本
填写设备的模型版本,本配置样例中自定义即可。
描述
填写产品的描述信息。
- 为产品添加物模型服务。
- 在“产品管理”页面的“产品”页签下,单击2中创建的产品名称,进入产品详情页面。
- 在“物模型”页签下,单击“创建物模型服务”。
- 在“创建物模型服务”弹窗中配置物模型服务相关信息,完成后单击“确认”。
- 为物模型服务添加属性。
- 在“物模型”页签下的左侧选择3中添加的物模型服务。
- 在右侧物模型服务详情页的“属性”页签下,单击“创建属性”。
- 在新增属性弹窗中配置属性相关信息,完成后单击“确认”。
- 为物模型服务添加命令。
- 在右侧物模型服务详情页的“命令”页签下,单击“创建命令”。
- 在创建命令弹窗中配置命令相关信息,完成后单击“确认”。
- 在命令列表中找到刚创建的命令,单击命令名称左侧的“”展开命令字段列表。
- 单击“创建下发命令字段”。
- 在新增下发命令字段弹窗中配置命令字段相关信息,完成后单击“确认”。
表5 命令字段信息配置 参数
配置说明
字段名称
填写命令字段的名称,此处填写为“status”。
数据类型
选择命令字段的数据类型,此处选择“String”。
是否必填
下发的命令中是否必须携带该字段,保持默认必填。
描述
填写字段的描述信息。
数据长度上限
命令字段值的最大长度,此处填写为“32”。
枚举值
命令字段的枚举值,此处填写为“on,off”,表示打开或关闭设备。
步骤二:注册设备
通过在ROMA Connect注册设备,为设备在ROMA Connect内分配唯一的ID和密钥,使设备可以接入到ROMA Connect。
- 在左侧的导航栏选择“设备集成 LINK > 设备管理”,单击页面右上角的“创建设备”。
- 在创建设备弹窗中填写设备相关配置信息,完成后单击“确认”。
- 在“设备管理”界面,单击已创建的设备设备名称,进入设备详情页,可在“Topic列表”页签查看设备的Topic信息。
步骤三:配置数据转发
ROMA Connect不会直接存储设备上报的数据,您需要配置数据转发规则,把设备数据转发到其他服务进行存储。此处以数据转发到ROMA Connect的消息集成MQS为例进行说明。
- 在左侧的导航栏选择“设备集成 LINK > 规则引擎”,单击页面右上角的“创建规则”。
- 在创建规则弹窗中填写规则相关配置信息,完成后单击“确认”。
图1 创建规则
表7 规则配置 参数
配置说明
规则名称
填写规则的名称,本配置样例中自定义即可。
集成应用
选择1中创建的集成应用。
规则描述
填写规则的描述信息。
状态
是否启用该规则,保持默认开启。
- 在规则列表中单击2中创建的规则名称,进入规则详情页面。
- 在“数据源端”下单击“创建数据源端”,设置数据源端相关配置,然后单击“保存”。
图2 数据源端配置
- 在“数据目的端”下单击“创建数据目的端”,设置数据目的端相关配置,然后单击“保存”,完成数据转发规则的配置。
图3 数据目的端配置
表9 数据目的端配置 参数
配置说明
数据目的端
本配置样例中把数据转发到ROMA Connect的消息集成MQS,此处选择“ROMA MQS”。
连接地址
选择当前ROMA Connect实例的消息集成 MQS内网连接地址,您可以在ROMA Connect实例控制台的“实例信息”页面中查看得到。
Topic名称
选择准备工作中所创建的ROMA Connect消息集成Topic。
用户名
仅当ROMA Connect实例的“MQS SASL_SSL”已开启时需要配置。
填写“Topic名称”中Topic所属集成应用的Key。
密码
仅当ROMA Connect实例的“MQS SASL_SSL”已开启时需要配置。
填写“Topic名称”中Topic所属集成应用的Secret。
步骤四:调试设备
设备可以通过集成MQTTX客户端或SDK接入ROMA Connect。为简单起见,此处在本地PC使用MQTTX客户端模拟设备接入ROMA Connect,并向ROMA Connect发送消息。
- 获取设备的接入信息。
在“设备管理”页面的设备列表中,查看并记录步骤二:注册设备中已创建设备的“MQTT连接地址”、“客户端ID”、“用户名”和“密码”信息。
图4 设备接入信息
- 打开本地安装的MQTTX客户端,单击客户端上的新增连接图标。
图5 MQTTX客户端
- 在连接属性编辑页面中填写连接属性相关配置信息,完成后单击“Connect”。
图6 连接属性配置
- 单击“Connect”,接入ROMA Connect。
若接入成功,则MQTTX客户端左上角的连接状态显示为绿色。同时,在ROMA Connect实例控制台的“设备集成 LINK > 设备管理”页面中,可以看到设备的“状态”为“在线”。
图7 设备在线
- 设备上报数据到ROMA Connect。
- 在MQTTX客户端中单击步骤3已创建的连接,填写设备Topic和要发送的消息内容,完成后单击,向ROMA Connect发送消息。
- 在“Topic”输入框中填写设备发送消息的Topic,格式为:{产品标识}/out/{设备标识}。您可以在ROMA Connect实例控制台的“设备集成 LINK > 设备管理”页面,单击设备名称进入详情页,在“Topic列表”中查看设备的Topic。
- 在下方的消息输入框中填写Json格式的消息内容。
图8 设备发送消息
- 在ROMA Connect实例控制台选择“消息集成MQS > 消息查询”,进入消息查询页面。
- 单击“高级搜索”展开高级搜索框。
- 输入搜索条件,然后单击“搜索”,查询客户端发送的消息记录。
- “Topic名称”选择步骤三:配置数据转发中创建的消息Topic。
- “查询方式”选择“按生产时间查询”,并选择设备向ROMA Connect发送消息的时间段。
- 单击消息记录后的“消息内容”,查看设备上报消息中的“data”字段的值,确认是否与MQTTX客户端发送的内容一致。
图9 查看消息内容
- 在MQTTX客户端中单击步骤3已创建的连接,填写设备Topic和要发送的消息内容,完成后单击,向ROMA Connect发送消息。
- 设备接收ROMA Connect下发的命令。
- 在MQTTX客户端单击步骤3已创建的连接,单击“New Subscription”,填写设备命令下发请求发送的Topic,格式为:/v1/devices/{设备标识}/command,然后单击“Confirm”,订阅设备命令下发的消息。
您可以在ROMA Connect实例控制台的“设备集成 LINK > 设备管理”页面,单击设备名称进入详情页,在“Topic列表”中查看设备的Topic。
图10 订阅设备消息
- 在ROMA Connect实例控制台选择“设备集成 LINK > 设备管理”,单击设备右侧的“更多 > 命令下发”。
- 在命令下发弹窗中设置要下发的命令,完成后单击“确认”,下发命令。
图11 命令下发
- 在MQTTX客户端的“Received”页签可以看到ROMA Connect向设备下发的命令消息,确认消息中的“cmd”和“paras”字段的值是否与ROMA Connect控制台下发的命令一致。
图12 设备接收消息
- 在MQTTX客户端单击步骤3已创建的连接,单击“New Subscription”,填写设备命令下发请求发送的Topic,格式为:/v1/devices/{设备标识}/command,然后单击“Confirm”,订阅设备命令下发的消息。