README.md
1@page mqtt mqtt
2
3[更正文档](https://gitee.com/alios-things/mqtt/edit/master/README.md)      [贡献说明](https://help.aliyun.com/document_detail/302301.html)
4
5# 概述
6
7MQTT（Message Queuing Telemetry Transport，消息队列遥测传输协议），是一种基于发布/订阅（publish/subscribe）模式的“轻量级”通讯协议，该协议构建于 TCP/IP 协议上，由 IBM 在1999年发布。MQTT 最大优点在于，可以以极少的代码和有限的带宽，为连接远程设备提供实时可靠的消息服务。作为一种低开销、低带宽占用的即时通讯协议，使其在物联网、小型设备、移动应用等方面有较广泛的应用。
8
9MQTT 是一个基于客户端-服务器的消息发布/订阅传输协议。MQTT 协议是轻量、简单、开放和易于实现的，这些特点使它适用范围非常广泛。在很多情况下，包括受限的环境中，如：机器与机器（M2M）通信和物联网（IoT）。其在，通过卫星链路通信传感器、偶尔拨号的医疗设备、智能家居、及一些小型化设备中已广泛使用。
10
11Paho MQTT 是 Eclipse 实现的基于 MQTT 协议的客户端，本软件包是在 Eclipse paho-mqtt 源码包的基础上设计的一套 MQTT 客户端程序。
12
13该组件支持以下功能：
14- MQTT Connect
15- MQTT Subscribe
16- MQTT Publish
17- 可连接阿里云物联网平台
18
19## 版权信息
20> Eclipse Distribution License v1.0
21
22## 目录结构
23```tree
24├── MQTTClient-C
25│ ├── MQTTClient.c
26│ ├── MQTTClient.h
27│ ├── MQTTLinux.c
28│ └── MQTTLinux.h
29├── MQTTPacket
30│ ├── MQTTConnectClient.c
31│ ├── MQTTConnect.h
32│ ├── MQTTConnectServer.c
33│ ├── MQTTDeserializePublish.c
34│ ├── MQTTFormat.c
35│ ├── MQTTFormat.h
36│ ├── MQTTPacket.c
37│ ├── MQTTPacket.h
38│ ├── MQTTPublish.h
39│ ├── MQTTSerializePublish.c
40│ ├── MQTTSubscribeClient.c
41│ ├── MQTTSubscribe.h
42│ ├── MQTTSubscribeServer.c
43│ ├── MQTTUnsubscribeClient.c
44│ ├── MQTTUnsubscribe.h
45│ ├── MQTTUnsubscribeServer.c
46│ └── StackTrace.h
47├── example
48│ ├── aiot_mqtt_sign.c #连接阿里云物联网平台需要加签
49│ └── mqtt_example.c # 示例代码
50├── package.yaml # 编译配置文件
51└─── README.md
52```
53
54## 依赖组件
55* osal_aos
56* mbedtls
57
58# 常用配置
59http的常用配置在文件**package.yaml内**
60> CONFIG_AIOT_SIGN ：是否开启阿里云物联网平台加签
61```yaml
62CONFIG_AIOT_SIGN: 1
63```
64
65> MQTT_PORT ： MQTT默认端口
66```C
67#ifndef MQTT_PORT
68#define MQTT_PORT 443
69#endif
70```
71
72# API说明
73
74## MQTT初始化
75```C
76DLLExport void MQTTClientInit(MQTTClient* client, Network* network, unsigned int command_timeout_ms,
77 unsigned char* sendbuf, size_t sendbuf_size, unsigned char* readbuf, size_t readbuf_size);
78```
79|args |description|
80|:----- |:----|
81|client |MQTT client上下文|
82|network |网络对象|
83|command_timeout_ms |超时时间|
84
85## MQTT连接请求
86```C
87DLLExport int MQTTConnect(MQTTClient* client, MQTTPacket_connectData* options);
88```
89|args |description|
90|:----- |:----|
91|client |MQTT client上下文|
92|options |MQTT连接选项|
93
94## MQTT发布主题
95```C
96DLLExport int MQTTPublish(MQTTClient* client, const char* topic, MQTTMessage* message);
97```
98|args |description|
99|:----- |:----|
100|client |MQTT client上下文|
101|topic |MQTT发布的主题|
102|message |MQTT发布的消息主体|
103
104## MQTT订阅主题
105```C
106DLLExport int MQTTSubscribe(MQTTClient* client, const char* topicFilter, enum QoS, messageHandler);
107```
108|args |description|
109|:----- |:----|
110|client |MQTT client上下文|
111|topicFilter |MQTT订阅的主题|
112|messageHandler |MQTT消息处理句柄|
113
114## MQTT取消订阅主题
115```C
116DLLExport int MQTTUnsubscribe(MQTTClient* client, const char* topicFilter);
117```
118|args |description|
119|:----- |:----|
120|client |MQTT client上下文|
121|topicFilter |MQTT订阅的主题|
122
123## MQTT断开连接请求
124```C
125DLLExport int MQTTDisconnect(MQTTClient* client);
126```
127|args |description|
128|:----- |:----|
129|client |MQTT client上下文|
130
131## MQTT等待响应
132```C
133DLLExport int MQTTYield(MQTTClient* client, int time);
134```
135|args |description|
136|:----- |:----|
137|client |MQTT client上下文|
138|time |等待时间|
139
140## MQTT是否处于连接状态
141```C
142DLLExport int MQTTIsConnected(MQTTClient* client);
143```
144|args |description|
145|:----- |:----|
146|client |MQTT client上下文|
147
148
149# 使用示例
150组件使用示例相关的代码下载、编译和固件烧录均依赖AliOS Things配套的开发工具，所以首先需要参考[《AliOS Things集成开发环境使用说明之搭建开发环境》](https://help.aliyun.com/document_detail/302378.html)，下载安装。
151待开发环境搭建完成后，可以按照以下步骤进行示例的测试。
152
153## 步骤1 创建或打开工程
154
155**打开已有工程**
156
157如果用于测试的案例工程已存在，可参考[《AliOS Things集成开发环境使用说明之打开工程》](https://help.aliyun.com/document_detail/302381.html)打开已有工程。
158
159**创建新的工程**
160
161组件的示例代码可以通过编译链接到AliOS Things的任意案例（solution）来运行，这里选择helloworld_demo案例。helloworld_demo案例相关的源代码下载可参考[《AliOS Things集成开发环境使用说明之创建工程》](https://help.aliyun.com/document_detail/302379.html)。
162
163## 步骤2 添加组件
164
165案例下载完成后，需要在helloworld_demo组件的package.yaml中添加对组件的依赖：
166
167```yaml
168depends:
169 - netmgr: master # helloworld_demo中引入netmgr组件，用于WiFi联网
170 - mqtt: master # helloworld_demo中引入mqtt组件
171```
172
173## 步骤3 下载组件
174
175在已安装了 的开发环境工具栏中，选择Terminal -> New Terminal启动终端，并且默认工作路径为当前工程的workspace，此时在终端命令行中输入：
176
177```shell
178
179aos install mqtt
180
181```
182
183上述命令执行成功后，组件源码则被下载到了./components/mqtt路径中。
184
185## 步骤4 添加示例
186在mqtt组件的package.yaml中添加[example示例代码](https://gitee.com/alios-things/mqtt/tree/master/example)：
187
188```yaml
189source_file:
190 - "src/*.c"
191 - "example/*.c" # 增加示例代码
192```
193
194## 步骤5 编译固件
195
196在示例代码已经添加至组件的配置文件，并且helloworld_demo已添加了对该组件的依赖后，就可以编译helloworld_demo案例来生成固件了，具体编译方法可参考[《AliOS Things集成开发环境使用说明之编译固件》](https://help.aliyun.com/document_detail/302384.html)。
197
198## 步骤6 烧录固件
199
200helloworld_demo案例的固件生成后，可参考[《AliOS Things集成开发环境使用说明之烧录固件》](https://help.aliyun.com/document_detail/302383.html)来烧录固件。
201
202## 步骤7 打开串口
203
204固件烧录完成后，可以通过串口查看示例的运行结果，打开串口的具体方法可参考[《AliOS Things集成开发环境使用说明之查看日志》](https://help.aliyun.com/document_detail/302382.html)。
205
206当串口终端打开成功后，可在串口中输入help来查看已添加的测试命令。
207
208## 步骤8 测试示例
209
210> CLI命令行输入初始化netmgr命令：
211```sh
212netmgr_example
213```
214> CLI命令行输入联网命令（ssid和password换成自己的）：
215```sh
216netmgr -t wifi -c ssid password
217```
218> 然后，CLI命令行输入：
219```sh
220mqtt_example
221```
222
223**关键日志**
224> CLI日志：
225```sh
226Network Connect success!
227Mqtt Connect success!
228Mqtt Subscribe success, topic:xxxx!
229```
230
231# FAQ
232
233