发 帖  
原厂入驻New
[经验]

【HarmonyOS HiSpark Wi-Fi IoT套件】如何在鸿蒙系统中移植 Paho-MQTT 实现MQTT协议

2020-11-3 17:41:46  234 Hispark开发套件 Hi3861
分享
2
本帖最后由 l_xy 于 2020-11-3 17:45 编辑

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. <pre class="language-markup"><code># Copyright (c) 2020 Huawei Device Co., Ltd.
  2. # Licensed under the Apache License, Version 2.0 (the "License");
  3. # you may not use this file except in compliance with the License.
  4. # You may obtain a copy of the License at
  5. #
  6. #     http://www.apache.org/licenses/LICENSE-2.0
  7. #
  8. # Unless required by applicable law or agreed to in writing, software
  9. # distributed under the License is distributed on an "AS IS" BASIS,
  10. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11. # See the License for the specIFic language governing permissions and
  12. # limitations under the License.

  13. import("//build/lite/config/component/lite_component.gni")
  14. import("//build/lite/ndk/ndk.gni")

  15. config("pahomqtt_config") {
  16.     include_dirs = [
  17.         "MQTTPacket/src",
  18.         "MQTTPacket/samples",
  19.         "//vendor/hisi/hi3861/hi3861/third_party/lwip_sack/include",
  20.         "//kernel/liteos_m/components/cmsis/2.0",
  21.     ]
  22. }


  23. pahomqtt_sources = [
  24. "MQTTPacket/samples/transport.c",
  25. "MQTTPacket/src/MQTTConnectClient.c",
  26. "MQTTPacket/src/MQTTConnectServer.c",
  27. "MQTTPacket/src/MQTTDeserializePublish.c",
  28. "MQTTPacket/src/MQTTFormat.c",
  29. "MQTTPacket/src/MQTTPacket.c",
  30. "MQTTPacket/src/MQTTSerializePublish.c",
  31. "MQTTPacket/src/MQTTSubscribeClient.c",
  32. "MQTTPacket/src/MQTTSubscribeServer.c",
  33. "MQTTPacket/src/MQTTUnsubscribeClient.c",
  34. "MQTTPacket/src/MQTTUnsubscribeServer.c",
  35. ]


  36. lite_library("pahomqtt_static") {
  37.     target_type = "static_library"
  38.     sources = pahomqtt_sources
  39.     public_configs = [ ":pahomqtt_config" ]
  40. }

  41. lite_library("pahomqtt_shared") {
  42.     target_type = "shared_library"
  43.     sources = pahomqtt_sources
  44.     public_configs = [ ":pahomqtt_config" ]
  45. }

  46. ndk_lib("pahomqtt_ndk") {
  47.     if (board_name != "hi3861v100") {
  48.         lib_extension = ".so"
  49.         deps = [
  50.             ":pahomqtt_shared"
  51.         ]
  52.     } else {
  53.         deps = [
  54.             ":pahomqtt_static"
  55.         ]
  56.     }
  57.     head_files = [
  58.         "//third_party/pahomqtt"
  59.     ]
  60. }</code></pre><p> </p>
复制代码

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. #include "lwip/netifapi.h"

  3. #include "lwip/sockets.h"
复制代码


(2)其次修改 transport_sendPacketBuffer 函数,内容修改后如下:
  1. int transport_sendPacketBuffer(int sock, unsigned char* buf, int buflen)
  2. {
  3.         int rc = 0;
  4.         rc = send(sock, buf, buflen, 0);
  5.         return rc;
  6. }
复制代码


(3)后面编译的时候会报错说 close 函数不存在,我们修改 transport_close 函数,修改后内容如下:
  1. int transport_close(int sock)
  2. {
  3. int rc;

  4.         rc = shutdown(sock, SHUT_WR);
  5.         rc = recv(sock, NULL, (size_t)0, 0);
  6.         rc = lwip_close(sock);

  7.         return rc;
  8. }
复制代码


(4)修改完 transport.c 文件后,大家编译的时候估计会遇到很多编译错误,都是某个局部变量未使用那种,大家可以修改就行。
类似于这样的,提示 buflen 未使用的错误,大家只需要在代码中随便写个buflen = buflen ; 即可。


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


(1)BUILD.gn文件内容:
  1. # Copyright (c) 2020 Huawei Device Co., Ltd.
  2. # Licensed under the Apache License, Version 2.0 (the "License");
  3. # you may not use this file except in compliance with the License.
  4. # You may obtain a copy of the License at
  5. #
  6. #     http://www.apache.org/licenses/LICENSE-2.0
  7. #
  8. # Unless required by applicable law or agreed to in writing, software
  9. # distributed under the License is distributed on an "AS IS" BASIS,
  10. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11. # See the License for the specific language governing permissions and
  12. # limitations under the License.

  13. static_library("mqtt_test_at") {
  14.     sources = [
  15.         "mqtt_test.c",
  16.         "at_entry.c"
  17.     ]

  18.     include_dirs = [
  19.         "//utils/native/lite/include",
  20.         "//kernel/liteos_m/components/cmsis/2.0",
  21.         "//base/iot_hardware/inteRFaces/kits/wifiiot_lite",
  22.         "//vendor/hisi/hi3861/hi3861/third_party/lwip_sack/include",
  23.         "//foundation/communication/interfaces/kits/wifi_lite/wifiservice",
  24.         "//third_party/pahomqtt/MQTTPacket/src",
  25.         "//third_party/pahomqtt/MQTTPacket/samples",
  26.         "//vendor\hisi\hi3861\hi3861\components\at\src"
  27.     ]
  28. }
复制代码


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

  2. #include <unistd.h>

  3. #include "ohos_init.h"
  4. #include "cmsis_os2.h"

  5. #include <unistd.h>

  6. #include <at.h>
  7. #include <hi_at.h>

  8. #include "hi_wifi_api.h"


  9. #include "mqtt_test.h"


  10. void mqtt_test_thread(void * argv)
  11. {
  12.     argv = argv;

  13.     mqtt_test();

  14. }

  15. hi_u32 at_exe_mqtt_test_cmd(void)
  16. {
  17.     osThreadAttr_t attr;

  18.     attr.name = "wifi_config_thread";
  19.     attr.attr_bits = 0U;
  20.     attr.cb_mem = NULL;
  21.     attr.cb_size = 0U;
  22.     attr.stack_mem = NULL;
  23.     attr.stack_size = 4096;
  24.     attr.priority = 36;

  25.     if (osThreadNew((osThreadFunc_t)mqtt_test_thread, NULL, &attr) == NULL) {
  26.         printf("[LEDExample] Falied to create LedTask!\n");
  27.     }

  28.     AT_RESPONSE_OK;
  29.     return HI_ERR_SUCCESS;
  30. }

  31. const at_cmd_func g_at_mqtt_func_tbl[] = {
  32.     {"+MQTTTEST", 9, HI_NULL, HI_NULL, HI_NULL, (at_call_back_func)at_exe_mqtt_test_cmd},
  33. };

  34. void AtExampleEntry(void)
  35. {
  36.     hi_at_register_cmd(g_at_mqtt_func_tbl, sizeof(g_at_mqtt_func_tbl)/sizeof(g_at_mqtt_func_tbl[0]));
  37. }

  38. SYS_RUN(AtExampleEntry);
复制代码


(3)mqtt_test.c 文件则是编写了一个简单的MQTT测试代码
,具体代码讲解,后面会重新开一篇。其中测试用的mqtt服务器是我自己的服务器:106.13.62.194
大家也可以改成自己的,也可以直接用我个人的mqtt服务器。

  1. #include <stdio.h>

  2. #include <unistd.h>

  3. #include "ohos_init.h"
  4. #include "cmsis_os2.h"

  5. #include <unistd.h>
  6. #include "hi_wifi_api.h"
  7. //#include "wifi_sta.h"
  8. #include "lwip/ip_addr.h"
  9. #include "lwip/netifapi.h"

  10. #include "lwip/sockets.h"

  11. #include "MQTTPacket.h"
  12. #include "transport.h"

  13. int toStop = 0;

  14. int mqtt_connect(void)
  15. {
  16.         MQTTPacket_connectData data = MQTTPacket_connectData_initializer;
  17.         int rc = 0;
  18.         int mysock = 0;
  19.         unsigned char buf[200];
  20.         int buflen = sizeof(buf);
  21.         int msgid = 1;
  22.         MQTTString topicString = MQTTString_initializer;
  23.         int req_qos = 0;
  24.         char* payload = "hello HarmonyOS";
  25.         int payloadlen = strlen(payload);
  26.         int len = 0;
  27.         char *host = "106.13.62.194";
  28.     //char *host = "192.168.1.102";
  29.         int port = 1883;


  30.         mysock = transport_open(host, port);
  31.         if(mysock < 0)
  32.                 return mysock;

  33.         printf("Sending to hostname %s port %d\n", host, port);

  34.         data.clientID.cstring = "me";
  35.         data.keepAliveInterval = 20;
  36.         data.cleansession = 1;
  37.         data.username.cstring = "testuser";
  38.         data.password.cstring = "testpassword";

  39.         len = MQTTSerialize_connect(buf, buflen, &data);
  40.         rc = transport_sendPacketBuffer(mysock, buf, len);

  41.         /* wait for connack */
  42.         if (MQTTPacket_read(buf, buflen, transport_getdata) == CONNACK)
  43.         {
  44.                 unsigned char sessionPresent, connack_rc;

  45.                 if (MQTTDeserialize_connack(&sessionPresent, &connack_rc, buf, buflen) != 1 || connack_rc != 0)
  46.                 {
  47.                         printf("Unable to connect, return code %d\n", connack_rc);
  48.                         goto exit;
  49.                 }
  50.         }
  51.         else
  52.                 goto exit;

  53.         /* subscribe */
  54.         topicString.cstring = "substopic";
  55.         len = MQTTSerialize_subscribe(buf, buflen, 0, msgid, 1, &topicString, &req_qos);
  56.         rc = transport_sendPacketBuffer(mysock, buf, len);
  57.         if (MQTTPacket_read(buf, buflen, transport_getdata) == SUBACK)         /* wait for suback */
  58.         {
  59.                 unsigned short submsgid;
  60.                 int subcount;
  61.                 int granted_qos;

  62.                 rc = MQTTDeserialize_suback(&submsgid, 1, &subcount, &granted_qos, buf, buflen);
  63.                 if (granted_qos != 0)
  64.                 {
  65.                         printf("granted qos != 0, %d\n", granted_qos);
  66.                         goto exit;
  67.                 }
  68.         }
  69.         else
  70.                 goto exit;

  71.         /* loop getting msgs on subscribed topic */
  72.         topicString.cstring = "pubtopic";
  73.         while (!toStop)
  74.         {
  75.                 /* transport_getdata() has a built-in 1 second timeout,
  76.                 your mileage will vary */
  77.                 if (MQTTPacket_read(buf, buflen, transport_getdata) == PUBLISH)
  78.                 {
  79.                         unsigned char dup;
  80.                         int qos;
  81.                         unsigned char retained;
  82.                         unsigned short msgid;
  83.                         int payloadlen_in;
  84.                         unsigned char* payload_in;
  85.                         int rc;
  86.                         MQTTString receivedTopic;
  87.                         rc = MQTTDeserialize_publish(&dup, &qos, &retained, &msgid, &receivedTopic,
  88.                                         &payload_in, &payloadlen_in, buf, buflen);
  89.                         printf("message arrived %.*s\n", payloadlen_in, payload_in);

  90.             rc = rc;
  91.         }

  92.                 printf("publishing reading\n");
  93.                 len = MQTTSerialize_publish(buf, buflen, 0, 0, 0, 0, topicString, (unsigned char*)payload, payloadlen);
  94.         rc = transport_sendPacketBuffer(mysock, buf, len);
  95.         }

  96.         printf("disconnecting\n");
  97.         len = MQTTSerialize_disconnect(buf, buflen);
  98.         rc = transport_sendPacketBuffer(mysock, buf, len);
  99. exit:
  100.         transport_close(mysock);

  101.     rc = rc;

  102.         return 0;
  103. }


  104. void mqtt_test(void)
  105. {
  106.     mqtt_connect();
  107. }
复制代码



mqtt_test.h文件内容:
  1. #ifndef __MQTT_TEST_H__
  2. #define __MQTT_TEST_H__

  3. void mqtt_test(void);

  4. #endif /* __MQTT_TEST_H__ */
复制代码


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

3.9.4 MQTT实验
这里我们需要先下载一个 Windows电脑端的 MQTT客户端,这样我们就可以用电脑订阅开发板的MQTT主题信息了。
电脑版的mqtt客户端下载链接: https://repo.eclipse.org/content ... .paho.ui.app/1.1.1/
我们选择这一个:


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


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

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

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

  4. 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客户端程序,去验证。
相关源代码和软件.rar (25.01 MB, 下载次数: 4)


原创:连老师
文章来自51CTO社区

jf_23561857 2020-11-3 23:35:26
感谢分享,很实用的帖子
回复

举报

只有小组成员才能发言,加入小组>>

1099个成员聚集在这个小组

加入小组

创建小组步骤

关闭

站长推荐 上一条 /9 下一条

快速回复 返回顶部 返回列表