如何在鸿蒙系统中移植Paho-MQTT实现MQTT协议

系统
本节主要讲如何在鸿蒙系统中通过移植第3方软件包 paho mqtt去实现MQTT协议功能,最后会给出测试验证。为后续的物联网项目打好基础。

[[356033]]

想了解更多内容,请访问:

51CTO和华为官方合作共建的鸿蒙技术社区

https://harmonyos.51cto.com/#zz

 MQTT 是当前最主流的物联网通信协议,需要物联网云平台,例如华为云、阿里云、移动OneNET都支持mqtt。而Hi3861则是一款专为IoT应用场景打造的芯片。本节主要讲如何在鸿蒙系统中通过移植第3方软件包 paho mqtt去实现MQTT协议功能,最后会给出测试验证。为后续的物联网项目打好基础。

友情预告,本节内容较多,源码也贴出来了,大家最好先看一遍,然后再操作一次。

相关源码已经打包上传,顺便上传了一个测试OK的固件,大家可以直接下载附件直接测试。解压后会得到5个压缩包,继续解压即可。


3.9.1 MQTT介绍

MQTT 全称为 Message Queuing Telemetry Transport(消息队列遥测传输)是一种基于发布/订阅范式的二进制“轻量级”消息协议,由IB公司发布。针对于网络受限和嵌入式设备而设计的一种数据传输协议。MQTT最大优点在于,可以以极少的代码和有限的带宽,为连接远程设备提供实时可靠的消息服务。作为一种低开销、低带宽占用的即时通讯协议,使其在物联网、小型设备、移动应用等方面有较广泛的应用。MQTT模型如图所示。

更多MQTT协议的介绍见这篇文章: MQTT 协议开发入门


3.9.2 移植 paho mqtt软件包

1. 下载paho mqtt软件包,添加到鸿蒙代码中

paho mqtt-c 是基于C语言实现的MQTT客户端,非常适合用在嵌入式设备上。首先下载源码:

https://github.com/eclipse/paho.mqtt.embedded-c

下载之后解压,会得到这么一个文件夹:


我们在鸿蒙系统源码的 third_party 文件夹下创建一个 pahomqtt 文件夹,然后把解压后的所有文件都拷贝到 pahomqtt 文件夹下,目录结构大致如下:


下一步,我们在pahomqtt 文件夹下面新建BUILD.gn文件,用来构建编译。其内容如下:

  1. # Copyright (c) 2020 Huawei Device Co., Ltd. 
  2.  
  3. # Licensed under the Apache License, Version 2.0 (the "License"); 
  4.  
  5. # you may not use this file except in compliance with the License. 
  6.  
  7. # You may obtain a copy of the License at 
  8.  
  9.  
  10. # http://www.apache.org/licenses/LICENSE-2.0 
  11.  
  12.  
  13. # Unless required by applicable law or agreed to in writing, software 
  14.  
  15. # distributed under the License is distributed on an "AS IS" BASIS, 
  16.  
  17. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
  18.  
  19. # See the License for the specific language governing permissions and 
  20.  
  21. # limitations under the License. 
  22.  
  23. import("//build/lite/config/component/lite_component.gni"
  24.  
  25. import("//build/lite/ndk/ndk.gni"
  26.  
  27. config("pahomqtt_config") { 
  28.  
  29. include_dirs = [ 
  30.  
  31. "MQTTPacket/src"
  32.  
  33. "MQTTPacket/samples"
  34.  
  35. "//vendor/hisi/hi3861/hi3861/third_party/lwip_sack/include"
  36.  
  37. "//kernel/liteos_m/components/cmsis/2.0"
  38.  
  39.  
  40.  
  41. pahomqtt_sources = [ 
  42.  
  43. "MQTTPacket/samples/transport.c"
  44.  
  45. "MQTTPacket/src/MQTTConnectClient.c"
  46.  
  47. "MQTTPacket/src/MQTTConnectServer.c"
  48.  
  49. "MQTTPacket/src/MQTTDeserializePublish.c"
  50.  
  51. "MQTTPacket/src/MQTTFormat.c"
  52.  
  53. "MQTTPacket/src/MQTTPacket.c"
  54.  
  55. "MQTTPacket/src/MQTTSerializePublish.c"
  56.  
  57. "MQTTPacket/src/MQTTSubscribeClient.c"
  58.  
  59. "MQTTPacket/src/MQTTSubscribeServer.c"
  60.  
  61. "MQTTPacket/src/MQTTUnsubscribeClient.c"
  62.  
  63. "MQTTPacket/src/MQTTUnsubscribeServer.c"
  64.  
  65.  
  66. lite_library("pahomqtt_static") { 
  67.  
  68. target_type = "static_library" 
  69.  
  70. sources = pahomqtt_sources 
  71.  
  72. public_configs = [ ":pahomqtt_config" ] 
  73.  
  74.  
  75. lite_library("pahomqtt_shared") { 
  76.  
  77. target_type = "shared_library" 
  78.  
  79. sources = pahomqtt_sources 
  80.  
  81. public_configs = [ ":pahomqtt_config" ] 
  82.  
  83.  
  84. ndk_lib("pahomqtt_ndk") { 
  85.  
  86. if (board_name != "hi3861v100") { 
  87.  
  88. lib_extension = ".so" 
  89.  
  90. deps = [ 
  91.  
  92. ":pahomqtt_shared" 
  93.  
  94.  
  95. else { 
  96.  
  97. deps = [ 
  98.  
  99. ":pahomqtt_static" 
  100.  
  101.  
  102.  
  103. head_files = [ 
  104.  
  105. "//third_party/pahomqtt" 
  106.  
  107.  

 2. 让hi3861编译的时候,编译 paho mqtt 软件包

打开vendor\hisi\hi3861\hi3861\BUILD.gn 文件,在lite_component("sdk") 中增加 "//third_party/pahomqtt:pahomqtt_static",

修改后文件内容如下:

 完成以上修改后,就可以开始编译了,然而很不幸的。。。你会发现好多编译报错。

不过没事,我们来一个一个解决。

3. 移植,修改编译报错

打开 third_party\pahomqtt\MQTTPacket\samples\transport.c 文件,这个文件也是我们主要移植的文件,我们需要实现 socket相关的操作,包括发送、接收数据。其实移植就3步。

(1)首先我们导入几个头文件

  1. #include "lwip/ip_addr.h" 
  2.  
  3. #include "lwip/netifapi.h" 
  4.  
  5. #include "lwip/sockets.h" 

 (2)其次修改 transport_sendPacketBuffer 函数,内容修改后如下:

  1. int transport_sendPacketBuffer(int sock, unsigned char* buf, int buflen) 
  2.  
  3.  
  4. int rc = 0; 
  5.  
  6. rc = send(sock, buf, buflen, 0); 
  7.  
  8. return rc; 
  9.  

 (3)后面编译的时候会报错说 close 函数不存在,我们修改 transport_close 函数,修改后内容如下:

  1. int transport_close(int sock) 
  2.  
  3.  
  4. int rc; 
  5.  
  6. rc = shutdown(sock, SHUT_WR); 
  7.  
  8. rc = recv(sock, NULL, (size_t)0, 0); 
  9.  
  10. rc = lwip_close(sock); 
  11.  
  12. return rc; 
  13.  

 (4)修改完 transport.c 文件后,大家编译的时候估计会遇到很多编译错误,都是某个局部变量未使用那种,大家可以修改就行。

类似于这样的,提示 buflen 未使用的错误,大家只需要在代码中随便写个buflen = buflen ; 即可。

 3.9.3 编写测试代码

测试代码比较好写。主要是3个文件,内容我都贴出来了:

 (1)BUILD.gn文件内容:

  1. # Copyright (c) 2020 Huawei Device Co., Ltd. 
  2.  
  3. # Licensed under the Apache License, Version 2.0 (the "License"); 
  4.  
  5. # you may not use this file except in compliance with the License. 
  6.  
  7. # You may obtain a copy of the License at 
  8.  
  9.  
  10. # http://www.apache.org/licenses/LICENSE-2.0 
  11.  
  12.  
  13. # Unless required by applicable law or agreed to in writing, software 
  14.  
  15. # distributed under the License is distributed on an "AS IS" BASIS, 
  16.  
  17. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
  18.  
  19. # See the License for the specific language governing permissions and 
  20.  
  21. # limitations under the License. 
  22.  
  23. static_library("mqtt_test_at") { 
  24.  
  25. sources = [ 
  26.  
  27. "mqtt_test.c"
  28.  
  29. "at_entry.c" 
  30.  
  31.  
  32. include_dirs = [ 
  33.  
  34. "//utils/native/lite/include"
  35.  
  36. "//kernel/liteos_m/components/cmsis/2.0"
  37.  
  38. "//base/iot_hardware/interfaces/kits/wifiiot_lite"
  39.  
  40. "//vendor/hisi/hi3861/hi3861/third_party/lwip_sack/include"
  41.  
  42. "//foundation/communication/interfaces/kits/wifi_lite/wifiservice"
  43.  
  44. "//third_party/pahomqtt/MQTTPacket/src"
  45.  
  46. "//third_party/pahomqtt/MQTTPacket/samples"
  47.  
  48. "//vendor\hisi\hi3861\hi3861\components\at\src" 
  49.  
  50.  

 (2)at_entry.c文件主要是注册了一个AT指令,后面大家可以使用 AT+MQTTTEST 指令来测试MQTT功能。代码内容如下:

  1. #include 
  2.  
  3. #include 
  4.  
  5. #include "ohos_init.h" 
  6.  
  7. #include "cmsis_os2.h" 
  8.  
  9. #include 
  10.  
  11. #include 
  12.  
  13. #include 
  14.  
  15. #include "hi_wifi_api.h" 
  16.  
  17. #include "mqtt_test.h" 
  18.  
  19. void mqtt_test_thread(void * argv) 
  20.  
  21.  
  22. argv = argv; 
  23.  
  24. mqtt_test(); 
  25.  
  26.  
  27. hi_u32 at_exe_mqtt_test_cmd(void) 
  28.  
  29.  
  30. osThreadAttr_t attr; 
  31.  
  32. attr.name = "wifi_config_thread"
  33.  
  34. attr.attr_bits = 0U; 
  35.  
  36. attr.cb_mem = NULL
  37.  
  38. attr.cb_size = 0U; 
  39.  
  40. attr.stack_mem = NULL
  41.  
  42. attr.stack_size = 4096; 
  43.  
  44. attr.priority = 36; 
  45.  
  46. if (osThreadNew((osThreadFunc_t)mqtt_test_thread, NULL, &attr) == NULL) { 
  47.  
  48. printf("[LedExample] Falied to create LedTask!\n"); 
  49.  
  50.  
  51. AT_RESPONSE_OK; 
  52.  
  53. return HI_ERR_SUCCESS; 
  54.  
  55.  
  56. const at_cmd_func g_at_mqtt_func_tbl[] = { 
  57.  
  58. {"+MQTTTEST", 9, HI_NULL, HI_NULL, HI_NULL, (at_call_back_func)at_exe_mqtt_test_cmd}, 
  59.  
  60. }; 
  61.  
  62. void AtExampleEntry(void) 
  63.  
  64.  
  65. hi_at_register_cmd(g_at_mqtt_func_tbl, sizeof(g_at_mqtt_func_tbl)/sizeof(g_at_mqtt_func_tbl[0])); 
  66.  
  67.  
  68. SYS_RUN(AtExampleEntry); 

 (3)mqtt_test.c 文件则是编写了一个简单的MQTT测试代码

具体代码讲解,后面会重新开一篇。其中测试用的mqtt服务器是我自己的服务器:106.13.62.194

大家也可以改成自己的,也可以直接用我个人的mqtt服务器。

  1. #include 
  2.  
  3. #include 
  4.  
  5. #include "ohos_init.h" 
  6.  
  7. #include "cmsis_os2.h" 
  8.  
  9. #include 
  10.  
  11. #include "hi_wifi_api.h" 
  12.  
  13. //#include "wifi_sta.h" 
  14.  
  15. #include "lwip/ip_addr.h" 
  16.  
  17. #include "lwip/netifapi.h" 
  18.  
  19. #include "lwip/sockets.h" 
  20.  
  21. #include "MQTTPacket.h" 
  22.  
  23. #include "transport.h" 
  24.  
  25. int toStop = 0; 
  26.  
  27. int mqtt_connect(void) 
  28.  
  29.  
  30. MQTTPacket_connectData data = MQTTPacket_connectData_initializer; 
  31.  
  32. int rc = 0; 
  33.  
  34. int mysock = 0; 
  35.  
  36. unsigned char buf[200]; 
  37.  
  38. int buflen = sizeof(buf); 
  39.  
  40. int msgid = 1; 
  41.  
  42. MQTTString topicString = MQTTString_initializer; 
  43.  
  44. int req_qos = 0; 
  45.  
  46. char* payload = "hello HarmonyOS"
  47.  
  48. int payloadlen = strlen(payload); 
  49.  
  50. int len = 0; 
  51.  
  52. char *host = "106.13.62.194"
  53.  
  54. //char *host = "192.168.1.102"
  55.  
  56. int port = 1883; 
  57.  
  58. mysock = transport_open(host, port); 
  59.  
  60. if(mysock < 0) 
  61.  
  62. return mysock; 
  63.  
  64. printf("Sending to hostname %s port %d\n", host, port); 
  65.  
  66. data.clientID.cstring = "me"
  67.  
  68. data.keepAliveInterval = 20; 
  69.  
  70. data.cleansession = 1; 
  71.  
  72. data.username.cstring = "testuser"
  73.  
  74. data.password.cstring = "testpassword"
  75.  
  76. len = MQTTSerialize_connect(buf, buflen, &data); 
  77.  
  78. rc = transport_sendPacketBuffer(mysock, buf, len); 
  79.  
  80. /* wait for connack */ 
  81.  
  82. if (MQTTPacket_read(buf, buflen, transport_getdata) == CONNACK) 
  83.  
  84.  
  85. unsigned char sessionPresent, connack_rc; 
  86.  
  87. if (MQTTDeserialize_connack(&sessionPresent, &connack_rc, buf, buflen) != 1 || connack_rc != 0) 
  88.  
  89.  
  90. printf("Unable to connect, return code %d\n", connack_rc); 
  91.  
  92. goto exit; 
  93.  
  94.  
  95.  
  96. else 
  97.  
  98. goto exit; 
  99.  
  100. /* subscribe */ 
  101.  
  102. topicString.cstring = "substopic"
  103.  
  104. len = MQTTSerialize_subscribe(buf, buflen, 0, msgid, 1, &topicString, &req_qos); 
  105.  
  106. rc = transport_sendPacketBuffer(mysock, buf, len); 
  107.  
  108. if (MQTTPacket_read(buf, buflen, transport_getdata) == SUBACK) /* wait for suback */ 
  109.  
  110.  
  111. unsigned short submsgid; 
  112.  
  113. int subcount; 
  114.  
  115. int granted_qos; 
  116.  
  117. rc = MQTTDeserialize_suback(&submsgid, 1, &subcount, &granted_qos, buf, buflen); 
  118.  
  119. if (granted_qos != 0) 
  120.  
  121.  
  122. printf("granted qos != 0, %d\n", granted_qos); 
  123.  
  124. goto exit; 
  125.  
  126.  
  127.  
  128. else 
  129.  
  130. goto exit; 
  131.  
  132. /* loop getting msgs on subscribed topic */ 
  133.  
  134. topicString.cstring = "pubtopic"
  135.  
  136. while (!toStop) 
  137.  
  138.  
  139. /* transport_getdata() has a built-in 1 second timeout, 
  140.  
  141. your mileage will vary */ 
  142.  
  143. if (MQTTPacket_read(buf, buflen, transport_getdata) == PUBLISH) 
  144.  
  145.  
  146. unsigned char dup; 
  147.  
  148. int qos; 
  149.  
  150. unsigned char retained; 
  151.  
  152. unsigned short msgid; 
  153.  
  154. int payloadlen_in; 
  155.  
  156. unsigned char* payload_in; 
  157.  
  158. int rc; 
  159.  
  160. MQTTString receivedTopic; 
  161.  
  162. rc = MQTTDeserialize_publish(&dup, &qos, &retained, &msgid, &receivedTopic, 
  163.  
  164. &payload_in, &payloadlen_in, buf, buflen); 
  165.  
  166. printf("message arrived %.*s\n", payloadlen_in, payload_in); 
  167.  
  168. rc = rc; 
  169.  
  170.  
  171. printf("publishing reading\n"); 
  172.  
  173. len = MQTTSerialize_publish(buf, buflen, 0, 0, 0, 0, topicString, (unsigned char*)payload, payloadlen); 
  174.  
  175. rc = transport_sendPacketBuffer(mysock, buf, len); 
  176.  
  177.  
  178. printf("disconnecting\n"); 
  179.  
  180. len = MQTTSerialize_disconnect(buf, buflen); 
  181.  
  182. rc = transport_sendPacketBuffer(mysock, buf, len); 
  183.  
  184. exit: 
  185.  
  186. transport_close(mysock); 
  187.  
  188. rc = rc; 
  189.  
  190. return 0; 
  191.  
  192.  
  193. void mqtt_test(void) 
  194.  
  195.  
  196. mqtt_connect(); 
  197.  

 mqtt_test.h文件内容:

  1. #ifndef __MQTT_TEST_H__ 
  2.  
  3. #define __MQTT_TEST_H__ 
  4.  
  5. void mqtt_test(void); 
  6.  
  7. #endif /* __MQTT_TEST_H__ */ 

 到这里就完成了代码部分,可以开始编译了。

3.9.4 MQTT实验

这里我们需要先下载一个 Windows电脑端的 MQTT客户端,这样我们就可以用电脑订阅开发板的MQTT主题信息了。

电脑版的mqtt客户端下载链接: https://repo.eclipse.org/content/repositories/paho-releases/org/eclipse/paho/org.eclipse.paho.ui.app/1.1.1/

我们选择这一个: 

 弄完后打开软件,按图操作: 

 

操作完后,我们把编译后程序烧写到开发板,输入如下串口指令,让开发板连接上网络,因为MQTT功能需要网络支持。输入如下串口指令:

AT+STARTSTA 开启STA模式

AT+CONN="12-203",,2,"07686582488" 连接到路由器,注意wifi热点名和密码用自己的

AT+DHCP=wlan0,1 获取IP地址

AT+IFCFG 打印查看IP地址

串口指令的应答应该如下:

 

成功连接上路由器后,请确保路由器是可以上网的。

然后我们输入我们的 MQTT测试的AT指令: AT+MQTTTEST

应该可以看到如下打印:


此时我们去查看 我们电脑端的MQTT客户端软件,可以看到右边已经有接收MQTT信息了,主题未 pubtopic,消息内容为 hello HarmonyOS ! ,说明实验成功。


3.9.5 总结

这一次的内容比较多,其中总结起来就4步:

(1)添加第三方软件包 paho mqtt,关于如何添加第3方软件包,我之前有一篇文章已经讲了。

可以参考:如何往鸿蒙系统源码中添加第三方软件包

(2)移植 paho mqtt

(3)编写测试代码,这里我们用的是注册AT指令的方式,方便大家使用AT指令测试。

(4)测试,这里用电脑装mqtt客户端程序,去验证。

想了解更多内容,请访问:

51CTO和华为官方合作共建的鸿蒙技术社区

https://harmonyos.51cto.com/#zz

 

责任编辑:jianghua 来源: 鸿蒙社区
相关推荐

2020-11-18 11:36:35

鸿蒙系统

2020-11-17 08:59:28

MQTT

2022-02-09 19:45:41

MQTTOpenHarmon鸿蒙

2018-08-17 06:13:16

物联网协议MQTTMQTT-SN

2022-09-26 11:30:40

MQTT协议客户端协议

2022-05-17 11:06:52

车联网通信协议MQTT

2020-11-24 09:52:22

MQTT

2022-02-25 07:34:36

MQTT协议RabbitMQ

2022-06-27 10:41:45

MQTT物联网协议

2023-03-20 16:16:40

MQTT传输协议

2024-03-26 11:52:13

2023-09-24 23:18:50

2023-09-07 14:59:42

物联网MQTTCoAP

2023-03-13 15:27:48

2021-07-05 22:22:24

协议MQTT

2021-08-04 10:22:27

鸿蒙HarmonyOS应用

2020-10-27 10:00:26

鸿蒙开发板物联网

2016-11-28 14:40:00

MQTT消息协议

2022-08-30 21:47:03

MQTT ProtoOthers

2020-11-19 10:25:24

MQTT
点赞
收藏

51CTO技术栈公众号