FBox 的MQTT - FLEXEM€¦ · MQTT 网页客户端为例，登录MQTT 网页客户端，可...

FBox 的 MQTT 使用说明上海繁易信息科技股份有限公司

2019.05

技术热线：4008-033-022 官方网站：www.flexem.com

上海繁易信息科技股份有限公司 Shanghai Flexem Technology Co., Ltd.

一点一滴，推动设备智能化/ 1

目录一、配置云服务 ................................................................................................................................................... 1 二、FBox 的订阅与发布主题 ............................................................................................................................. 4

2.1 发布主题 ............................................................................................................................................... 5 2.1.1 实时数据 .................................................................................................................................... 5 2.1.2 发布盒子相关状态或信息 ........................................................................................................ 7 2.1.3 发布条目信息列表 .................................................................................................................... 8 2.1.4 发布主题列表 .......................................................................................................................... 10

2.2 订阅主题 ............................................................................................................................................. 12 2.2.1 设置监控点 .............................................................................................................................. 12 2.2.2 暂停数据推送 .......................................................................................................................... 13 2.2.3 重启盒子 .................................................................................................................................. 13 2.2.4 立即让盒子发布监控点 .......................................................................................................... 14 2.2.5 设置监控点条目发布周期 ...................................................................................................... 14 2.2.6 设置单个或多个监控点条目发布周期................................................................................... 15 2.2.7 获取盒子相关状态或信息 ...................................................................................................... 16



Shanghai Flexem Technology Co., Ltd.

上海繁易信息科技股份有限公司

一、配置云服务

我们的产品的是 FBox，也叫盒子，网关，在下文中会统一简称盒子。 1、在 FlexManager 的“远程下载-->设备管理—>网络 PLC”中创建 MQTT 连接设备，如图设置：

在此处添加的设备中，IP 地址和端口是忽略的，在下一步配置云服务中设置 IP 地址（服务地址）

和端口号。 2、然后在“远程下载-->设备管理-->云服务”中配置 MQTT 推送的服务器地址、端口号、设备 ID、

登录用户名与密码等信息。





云服务：繁易 MQTT，指定的 MQTT 服务协议 Keep alive：心跳包时间，单位：s 服务地址：MQTT 推送的服务器地址设备 ID：用于指定盒子的设备 ID（比如盒子序列号，或者用户自定义的 ID）加密：启用加密，支持盒子与 MQTT 服务器使用 TLS（SSL）进行通讯离线缓存方式：允许在 MQTT 离线的状态下，将推送的消息缓存到 SD 卡或 U 盘，如果不需要缓

存，选择“无” 客户端证书：若启用了 TLS 加密，方可启用客户端证书。该证书为盒子使用服务器证书：若启用了 TLS 加密，方可启用服务器证书。该证书为 MQTT 服务器所使用的证书。

若盒子需要双向加密，可启用该项，否则不需要启用主题：支持自定义主题前缀，若不自定义，则默认使用这个前缀：Topic/flexem/fbox/。以盒子序列号 222218030009 为例，重启的主题为：Topic/flexem/fbox/222218030009/system/Reboot，若自定义的前缀为：office/room1/,则重启的主题为：office/room1/222218030009/system/Reboot 注意：自定义主题必须以“/”结尾，若自定义主题前有/，则订阅主题是也要加上对应的/。用户验证：是盒子登录 MQTT 服务器所需要的用户信息验证同步报警、同步监控点：若是首次使用 MQTT 服务，添加监控点或报警条目后，需要点击“同步

报警”或者“同步监控点”才能使添加的条目推送 MQTT 生效；若不是首次需要点击“同步报警”

或者“同步监控点”后，再重启设备才能使添加的条目推送 MQTT 生效。如果不使用报警，可以

不进行同步报警。注意： FBox 在使用 MQTT 来推送数据时，需要在报警记录内引用一个 mqtt-connect 的变量。设置完报

警条目之后需要在云服务配置窗口点击同步报警点。如下图所示。





3、验证 MQTT 服务器与客户端是否连通，在数据监控中添加地址类型为“mqtt_connect”的监控

点，数值为 1 时，就代表连通，如果值为 0，代表没有连通，需要去检查前两个步骤的配置是否

有错误。





二、FBox 的订阅与发布主题

MQTT 服务端与盒子客户端连通后，现以 MQTT 网页客户端为例，登录 MQTT 网页客户端，可

以进行订阅和发布主题。在 MQTT 客户端可以查看设备的主题 Topic 列表，FLEXEM MQTT 的主

题（以下简称 Topic）均以 json 格式传输。查看设备的主题列表如图：（以盒子 222218030009 为

例）

已经订阅的主题，都会在这个地方展示出来。在 MQTT 客户端“Websocket”菜单中进行订阅、发布主题。注意填写内容大小写。

2.1 发布主题在 MQTT 客户端的订阅处填写这些主题，就会接收到盒子发布的相应的信息。（以盒子





222218030009 为例，且主题没有自定义，默认是：Topic/flexem/fbox/）

2.1.1 实时数据

该主题是盒子主动发布的主题，根据默认的发布周期（10s）进行发布，在 MQTT 客户端订阅

此主题可以接收到盒子条目的推送。例：盒子中有监控点，在 MQTT 客户端订阅该主题，会接收到盒子中推送的监控点内容：

主题 Topic/flexem/fbox/{盒子序列号}/system/MonitorData （例：Topic/flexem/fbox/222218030009/system/MonitorData）

类型发布内容 {

"time":"2018-4-26 17:33:16", "Data":[{"name":"Temp","value","124"},

{"name":"mqtt_connect","value","1"}, {"name":"bit","value","0"}, {"name":"single","value","45.500473"} ]

} "Time":条目监控点推送时间 "name":监控点名称 "value":监控点的值在盒子客户端（FlexManager）中可以查看盒子中添加的监控点：

在“Subscribe-->Topic”填写主题：Topic/flexem/fbox/222218030009/system/MonitorData，点击

“Subscribe”，MQTT 客户端订阅的主题会展示在右侧列表中，接收到的信息在右下方的

“Messages received”列表中，按默认的发布周期接收信息。





如果要取消订阅该主题，在订阅的主题列表中取消该主题就行了。

2.1.2 发布盒子相关状态或信息

当盒子收到一些获取相关信息或状态主题时，则需要以该主题进行发布。MQTT 客户端订阅该

主题后，就会获取盒子的相关信息。主题 Topic/flexem/fbox/222218030009/system/Status 类型发布内容 {

状态类型：状态值 }

状态：Pause {"Pause":"Enable"} 或者{"Pause":"Disable"} 是否处于暂停状态：MDataPubCycle

{"MDataPubCycle":10} 监控点发布周期值

注意：盒子不会主动发布该主题，当盒子收到主题为

Topic/flexem/fbox/222218030009/system/GetInfo，内容为 Pause 或者 MDataPubCycle 时，才会发布

盒子相关状态或信息，MQTT 客户端订阅该主题会收到相应的信息。在“Subscribe-->Topic”填写主题：Topic/flexem/fbox/222218030009/system/Status，点击“Subscribe”订阅该主题。在“Messages-->Topic”填写主题：Topic/flexem/fbox/222218030009/system/GetInfo，在“Messages-->Messages”填写点的内容“Pause”，会获取盒子是否处于暂停推送条目状态，填写

内容“MDataPubCycle”，会获取盒子监控点发布周期值。





2.1.3 发布条目信息列表

在 MQTT 客户端订阅该主题后，就会获取盒子中的监控点信息。

注意：盒子不会主动发布该主题，当盒子收到获取盒子信息主题为 Topic/flexem/fbox/222218030009/system/GetInfo 并且内容为 Taglist 时，表示要获取盒子的条目信息列表，这时盒子才会以 Topic/flexem/fbox/222218030009/system/Taglist 进行发布。

主题 Topic/flexem/fbox/222218030009/system/Taglist 类型发布内容 {"Version":1,

"list":[{"name":"Temp"}, {"name":"mqtt_connect"}, {"name":"bit"}, {"name":"single"}

] }





在“Subscribe-->Topic”填写主题：Topic/flexem/fbox/222218030009/system/Taglist，点击“Subscribe”订阅该主题。在“Messages-->Topic”填写发布主题：Topic/flexem/fbox/222218030009/system/GetInfo，在“Messages-->Messages”填写点的内容“Taglist”，会获取盒子中所有的监控点条目。

2.1.4 发布主题列表

主题列表为系统默认主题，在 MQTT 客户端订阅该主题后，可以获取该设备支持的主题列表。其

中 sub 表示该主题是盒子订阅的主题，pub 表示盒子可发布的主题。主题 Topic/flexem/fbox/222218030009/system/Topiclist 类型发布内容 {

"topicVer": 1, "topicList": [ { "topicname": "WriteData", "type": "sub"}, { "topicname": "GetInfo", "type": "sub"},

{ "topicname": "Reboot", "type": "sub"}, { "topicname": "Pause", "type": "sub"}, { "topicname": "MDataPubCycle", "type": "sub"}, { "topicname": "MonitorData", "type": "pub"},





"topicname": "Status", "type": "pub"}, { "topicname": "Taglist", "type": "pub"}, "topicname": "Topiclist", "type": "pub"} ]}

"topicVer"：主题版本号 "topicList"：设备支持的主题列表，sub 表示该主题是盒子订阅的主题，pub 表示盒子可发布的主

题所有主题的前缀都是默认的 Topic/flexem/fbox/222218030009/system/。因此只需要回复最后一级即

可。注意：盒子不会主动发布该主题，同理，当盒子收到获取盒子信息主题 Topic/flexem/fbox/222218030009/system/GetInfo 并且内容为 Topiclist 时，表示要获取盒子的条目信息列表，这时盒子才会以 Topic/flexem/fbox/222218030009/system/Topiclist 进行发布。在“Subscribe-->Topic”填写主题：Topic/flexem/fbox/222218030009/system/Topiclist，点击“Subscribe”订阅该主题。在“Messages-->Topic”填写发布主题：Topic/flexem/fbox/222218030009/system/GetInfo，在“Messages-->Messages”填写点的内容“Topiclist”，会获取设备持支的主题列表。

2.2 订阅主题以下几个主题为盒子订阅主题，在 MQTT 客户端的发布主题处填写这些主题，盒子才可以订阅接





收到这些信息。（以盒子 222218030009 为例，且主题没有自定义，默认是：Topic/flexem/fbox/）

2.2.1 设置监控点

设置监控点会控制盒子进行监控点的写入操作，目前 FLEXEM MQTT 的写入操作只支持一次写

入一条变量值。例：盒子中有名称为“Temp”的监控点，在 MQTT 客户端修改其值为 30：

"Version":10：主题的版本号 "name":需要修改的监控点名称 "value":需要修改监控点的值在“Messages-->Topic”填写主题：Topic/flexem/fbox/222218030009/system/WriteData，在“Messages-->Messages”填写修改监控点的内容，点击发送“send”，盒子收到该主题后，并进行写值操作。

注意：在登记条目的时候，切勿使用相同 name 的条目 MQTT 不支持字符串条目

主题 Topic/flexem/fbox/222218030009/system/WriteData

类型订阅

内容 {"Version":10, "Data":[ {"name":"Temp","value":"30"} ]}





2.2.2 暂停数据推送

服务器可以暂停 MQTT 的实时数据的发布。也可以通过此主题打开取消暂停实时数据的发布。

"Enable"：表示暂停当前所有实时数据的发布 "Disable"：表示取消暂停，实时数据继续发布在“Messages-->Topic”填写主题：Topic/flexem/fbox/222218030009/system/Pause，在“Messages-->Messages”中填写"Enable" 或者 "Disable"，盒子接收到主题，根据内容会“暂停”或者“取消

暂停”监控条目的推送。以暂停推送条目为例：

注意：不支持对单个条目的暂停推送

2.2.3 重启盒子

盒子收到该主题后，会立即进行重启，此时 MQTT 服务器应主动断开现有链接，释放已经订

阅的主题。盒子重启登录后，会重新注册设备，获取列表等。主题 Topic/flexem/fbox/222218030009/system/Reboot 类型订阅内容 "True"（内容可以为空）

在“Messages-->Topic”填写主题：Topic/flexem/fbox/222218030009/system/Reboot，在“Messages-->Messages”中填写“True”（可以为空），盒子收到该命令后，会立即进行重启。

主题 Topic/flexem/fbox/222218030009/system/Pause 类型订阅内容 "Enable" 或者 "Disable"





注意：如果 MQTT 客户端多次发布该主题，则在盒子再次登录的时候，MQTT 服务器仍会再继续

发送没有传输完成的报文。比如：MQTT 客户端连续发送了 10 次重启命令。盒子收到一次重启命令后，立即重启，此时 MQTT 服务器仍记录还有 9 次重启命令未传达，在下次盒子启动后，MQTT 将继续发送。

2.2.4 立即让盒子发布监控点

盒子收到该主题后，则立即发布 Topic/flexem/fbox/222218030009/system/MonitorData 主题，内

容为当前要采集的条目的值主题 Topic/flexem/fbox/222218030009/system/MDataPubNow 类型订阅内容任意内容，可以为空如果设置的监控条目周期比较长，但又想立即获取监控条目，客户端可发布该主题，当 FBox

收到该主题后，会以 Topic/flexem/fbox/222218030009/system/MonitorData 主题进行发布监控条目。先在“Subscribe-->Topic”填写主题：Topic/flexem/fbox/222218030009/system/MonitorData，获取盒

子的监控点，便于观察修改发布周期后监控点的发送。在“Messages-->Topic”填写主题：Topic/flexem/fbox/222218030009/system/MDataPubNow，点击发

送，就可以立即得到盒子监控点数据。

2.2.5 设置监控点条目发布周期

允许通过主题交互形式设置监控点的发布周期。





主题 Topic/flexem/fbox/222218030009/system/MDataPubCycle 类型订阅内容 5

在 MQTT 客户端发布该主题，当盒子收到该主题及内容时，表示要设置监控条目发布周期为 5S。当设置为 0 时，恢复默认 10S。（单位：S）先在“Subscribe-->Topic”填写主题：Topic/flexem/fbox/222218030009/system/MonitorData，获取盒

子的监控点，便于观察修改发布周期后监控点的发送。在“Messages-->Topic”填写主题：Topic/flexem/fbox/222218030009/system/MDataPubCycle，在

“Messages-->Messages”中填写“5”（修改的发布周期，单位：S），盒子收到该命令后，就会立

即修改监控点的发布周期

2.2.6 设置单个或多个监控点条目发布周期

在 MQTT 客户端发布该主题，设置的单个或多个监控点就会按照设置的发布周期进行发布，

如果没有使用该主题设置过的监控条目周期，会使用默认周期或者使用 MDataPubCycle 设置的周

期。当设置为 0 时，监控条目使用全局的发布周期。

主题 Topic/flexem/fbox/222218030009/system/MDPCS 类型订阅内容 cycle:周期 num:该次设

置的数量 item:后面是

条目

{"cycle":10, "num":3, "item": [ "ItemName1", "ItemName2", "ItemName3" ] }

"cycle":修改的发布周期时间，单位：s "num":设置修改的监控点的数量 "item":监控点条目的名称先在“Subscribe-->Topic”填写主题：Topic/flexem/fbox/222218030009/system/MonitorData，获取盒

子的监控点，便于观察修改发布周期后监控点的发送。





在“Messages-->Topic”填写主题：Topic/flexem/fbox/222218030009/system/MDPCS，在“Messages-->Messages”中填写对应的内容，盒子接收到该主题后，会改变设置的监控点的推

送周期。

2.2.7 获取盒子相关状态或信息

当盒子收到不同的获取信息后，以指定的主题发布。这个主题在前文中均有用到。主题 Topic/flexem/fbox/222218030009/system/GetInfo 类型订阅

Taglist 获取当前条目列表 Topiclist 获取当前盒子的主题（订阅和可发布） Pause 获取当前盒子的暂停状态（是否处于暂停） MDataPubCycle 获取当前盒子监控条目的推送周期

1)Taglist Topic/flexem/fbox/300216080083/system/GetInfo Taglist 当盒子收到该主题和内容后，则发布 Topic/flexem/fbox/222218030009/system/Taglist 主题，内容为： { "Version":1, "list":[{"name":"Temp"},

{"name":"mqtt_connect"}, {"name":"bit"}, {"name":"single"} ]

}





2）Topiclist 获取当前盒子的主题 Topic/flexem/fbox/300216080083/system/GetInfo Topiclist 当盒子收到该主题和内容后，则发布 Topic/flexem/fbox/222218030009/system/Topiclist 主题，内容

为 {"topicVer": 1, "topicList": [ {"topicname": "WriteData","type": "sub"},

{"topicname": "GetInfo","type": "sub"}, {"topicname": "Reboot","type": "sub"}, {"topicname": "Pause","type": "sub"}, {"topicname": "MDataPubCycle","type": "sub"}, {"topicname": "MonitorData","type": "pub"}, {"topicname": "Status","type": "pub"}, {"topicname": "Taglist","type": "pub"}, {"topicname": "Topiclist","type": "pub"},

]} 所有主题的前缀都是默认的 Topic/flexem/fbox/222218030009/system/，因此只需要回复最后一级即

可。





3）Pause 获取当前盒子的暂停状态（是否处于暂停） Topic/flexem/fbox/222218030009/system/GetInfo Pause 当盒子收到该主题及内容时，则发布 Topic/flexem/fbox/222218030009/system/Status 主题，内容为 {"Pause":"Enable"} 或者{"Pause":"Disable"}

4）MDataPubCycle 获取当前盒子监控条目的推送周期 Topic/flexem/fbox/222218030009/system/GetInfo MDataPubCycle 当盒子收到该主题及内容时，则发布 Topic/flexem/fbox/222218030009/system/Status 主题，内容为： {"MDataPubCycle ":10}

FBox 的MQTT - FLEXEM€¦ · MQTT 网页客户端为例，登录MQTT 网页客户端，可...

Documents

Transcript of FBox 的MQTT - FLEXEM€¦ · MQTT 网页客户端为例，登录MQTT 网页客户端，可...