基于STM32实现MQTT

最近一个项目中要用到MQTT或者CoAP，比较了两个的优缺点后。最后选择了MQTT，由于是第一次接触这个协议，在学习中遇到了不少的坑，所以分享出来。第一次写博客，有错勿怪。

1、MQTT协议

    MQTT（Message Queuing Telemetry Transport，消息队列遥测传输协议），是一种基于发布/订阅（publish/subscribe）模式的"轻量级"通讯协议，该协议构建于TCP/IP协议上，由IBM在1999年发布。MQTT最大优点在于，可以以极少的代码和有限的带宽，为连接远程设备提供实时可靠的消息服务。作为一种低开销、低带宽占用的即时通讯协议，使其在物联网、小型设备、移动应用等方面有较广泛的应用。

   协议详情： MQTT Version 3.1.1（英文版）

                    （中文版）

2、STM32实现的自我理解

   既然是一个协议，所以有一个基本的物理网络层就可以实现

   将就手上的一个ESP8266无线wifi串口模块，一个STM32的板子。也就可以完成MQTT的测试了。

   一般来说在协议中扮演的是一个客户端。主要的工作就是连接服务器、订阅消息、发送消息几个功能。最开始我在网上找了MQTT的客户端代码包，打开一看就蒙了。太多、太杂了，完全大于了我们的需求。所以我自己通过抓包对着协议写了一个数据包生成代码。

3、测试前准备

   MQTT服务器：我用的是Apollo Console(账号默认为：admin 密码默认:password 后面连接时要用)

   MQTT客户端： 通信猫。

   具体怎么用大家百度。。。

4、代码实现

4.1、固定报头 Fixed header

类型：

标志位：

根据这个可以写一个生成固定头的函数

1. #define MQTT_TypeCONNECT 1//请求连接

2. #define MQTT_TypeCONNACK 2//请求应答

3. #define MQTT_TypePUBLISH 3//发布消息

4. #define MQTT_TypePUBACK 4//发布应答

5. #define MQTT_TypePUBREC 5//发布已接收，保证传递1

6. #define MQTT_TypePUBREL 6//发布释放，保证传递2

7. #define MQTT_TypePUBCOMP 7//发布完成，保证传递3

8. #define MQTT_TypeSUBSCRIBE         8//订阅请求

9. #define MQTT_TypeSUBACK 9//订阅应答

10. #define MQTT_TypeUNSUBSCRIBE                 10//取消订阅

11. #define MQTT_TypeUNSUBACK 11//取消订阅应答

12. #define MQTT_TypePINGREQ 12//ping请求

13. #define MQTT_TypePINGRESP 13//ping响应

14. #define MQTT_TypeDISCONNECT                 14//断开连接

15. unsigned char GetDataFixedHead(unsigned char MesType,unsigned char DupFlag,unsigned char QosLevel,unsigned char Retain)

16. {

17. unsigned char dat = 0;

18. dat = (MesType & 0x0f) << 4;

19. dat |= (DupFlag & 0x01) << 3;

20. dat |= (QosLevel & 0x03) << 1;

21. dat |= (Retain & 0x01);

22. return dat;

23. }

 

4.2、连接

连接时抓的包的：

根据协议分析

 

固定报头 Fixed header

也就是数据包前两个10 21

后面是可变头：协议名、协议级别、连接标志、清除会话、遗嘱标志、遗嘱、遗嘱保留、用户名标志、密码标志、保持连接。

然后是有效载荷：客户端标识符、遗嘱主题、遗嘱消息、用户名、密码。

1. #define MQTT_StaCleanSession 1 //清理会话

2. #define MQTT_StaWillFlag 0 //遗嘱标志

3. #define MQTT_StaWillQoS 0 //遗嘱QoS连接标志的第4和第3位。

4. #define MQTT_StaWillRetain 0 //遗嘱保留

5. #define MQTT_StaUserNameFlag 1 //用户名标志 User Name Flag

6. #define MQTT_StaPasswordFlag 1 //密码标志 Password Flag

7. #define MQTT_KeepAlive         60       //心跳包秒数

8. #define MQTT_ClientIdentifier         "test"                          //客户端标识符 Client Identifier

9. #define MQTT_WillTopic "" //遗嘱主题 Will Topic

10. #define MQTT_WillMessage "" //遗嘱消息 Will Message

11. #define MQTT_UserName "admin" //用户名 User Name

12. #define MQTT_Password "password" //密码 Password

13. void GetDataConnet(unsigned char *buff)//获取连接的数据包正确连接返回20 02 00 00

14. {

15. unsigned int i,len,lennum = 0;

16. unsigned char *msg;

17. buff[0] = GetDataFixedHead(MQTT_TypeCONNECT,0,0,0);

18. buff[2] = 0x00;

19. buff[3] = 0x04;

20. buff[4] = 'M';

21. buff[5] = 'Q';

22. buff[6] = 'T';

23. buff[7] = 'T';

24. buff[8] = 0x04;//协议级别 Protocol Level

25. buff[9] = 0 | (MQTT_StaCleanSession << 1) | (MQTT_StaWillFlag << 1)

26.     | (MQTT_StaWillQoS << 3) | (MQTT_StaWillRetain << 5)

27.     | (MQTT_StaPasswordFlag << 6) |(MQTT_StaUserNameFlag << 7);//连接标志

28. buff[10] = MQTT_KeepAlive >> 8;

29. buff[11] = MQTT_KeepAlive;

30. len = strlen(MQTT_ClientIdentifier);

31. buff[12] = len >> 8;

32. buff[13] = len;

33. msg = MQTT_ClientIdentifier;

34. for(i = 0;i<len;i++)

35. {

36. buff[14+i] = msg[i];

37. }

38. lennum += len;

39. if(MQTT_StaWillFlag)

40. {

41. len = strlen(MQTT_WillTopic);

42. buff[13 + lennum + 1] = len >> 8;

43. buff[13 + lennum + 2] = len;

44. lennum += 2;

45. msg = MQTT_WillTopic;

46. for(i = 0;i<len;i++)

47. {

48. buff[14+lennum+i] = msg[i];

49. }

50. lennum += len;

51. len = strlen(MQTT_WillMessage);

52. buff[12] = len >> 8;

53. buff[13] = len;

54. lennum += 2;

55. msg = MQTT_WillMessage;

56. for(i = 0;i<len;i++)

57. {

58. buff[14+lennum+i] = msg[i];

59. }

60. lennum += len;

61. }

62. if(MQTT_StaUserNameFlag)

63. {

64. len = strlen(MQTT_UserName);

65. buff[13 + lennum + 1] = len >> 8;

66. buff[13 + lennum + 2] = len;

67. lennum += 2;

68. msg = MQTT_UserName;

69. for(i = 0;i<len;i++)

70. {

71. buff[14+lennum+i] = msg[i];

72. }

73. lennum += len;

74.  

75. }

76. if(MQTT_StaPasswordFlag)

77. {

78. len = strlen(MQTT_Password);

79. buff[13 + lennum + 1] = len >> 8;

80. buff[13 + lennum + 2] = len;

81. lennum += 2;

82. msg = MQTT_Password;

83. for(i = 0;i<len;i++)

84. {

85. buff[14+lennum+i] = msg[i];

86. }

87. lennum += len;

88. }

89. buff[1] = 13 + lennum - 1;//最后计算长度

90. }

4.3、订阅主题

订阅a/b时抓的包：

1. /**********************

2. 订阅主题的数据包

3. Num:主题序号 (每次连接从1开始)

4. RequestedQoS:服务质量要求0,1或2

5. **********************/

6. void GetDataSUBSCRIBE(unsigned char *buff,const char *dat,unsigned int Num,unsigned char RequestedQoS)

7. {

8. unsigned int i,len = 0,lennum = 0;

9. buff[0] = 0x82;

10. len = strlen(dat);

11. buff[2] = Num>>8;

12. buff[3] = Num;

13. buff[4] = len>>8;

14. buff[5] = len;

15. for(i = 0;i<len;i++)

16. {

17. buff[6+i] = dat[i];

18. }

19. lennum = len;

20. buff[6 + lennum ] = RequestedQoS;

21. buff[1] = lennum + 5;

22. }

4.4、发布信息

固定报头：

发送a/c主题信息为123时抓的包：

1. /**************************************

2. buff：数据包数组

3. dup ：重发标志

4. qos ：服务质量等级

5. retain：保留标志

6. topic:主题如“a/c”

7. msg:消息

8. ************************************/

9. void GetDataPUBLISH(unsigned char *buff,unsigned char dup, unsigned char qos,unsigned char retain,const char *topic ,const char *msg)

10. {   

11.         unsigned int i,len=0,lennum=0;

12. buff[0] = GetDataFixedHead(MQTT_TypePUBLISH,dup,qos,retain);

13. len = strlen(topic);

14. buff[2] = len>>8;

15. buff[3] = len;

16. for(i = 0;i<len;i++)

17. {

18. buff[4+i] = topic[i];

19. }

20. lennum = len;

21. len = strlen(msg);

22. for(i = 0;i<len;i++)

23. {

24. buff[4+i+lennum] = msg[i];

25. }

26. lennum += len;

27. buff[1] = lennum + 2;

28. }

4.5、心跳请求

客户端发送PINGREQ报文给服务端的。

用于：

    在没有任何其它控制报文从客户端发给服务的时，告知服务端客户端还活着。

    请求服务端发送 响应确认它还活着。

    使用网络以确认网络连接没有断开。

心跳请求抓的包：

可以看到就是发了一个C0 00

而服务器返回一个    d0 00

5、总结

    文中就讲了几个非常重要的请求格式。esp8266连接tcp服务器后就可以发送生成的数据包，就可以实现MQTT的功能。

    代码我已经测试过完全可用。

下面给完整的代码：

mqtt.h

1. #ifndef __MQTT_H

2. #define __MQTT_H

3. #include "sys.h"

4. #include <string.h>

5. #define MQTT_TypeCONNECT 1//请求连接

6. #define MQTT_TypeCONNACK 2//请求应答

7. #define MQTT_TypePUBLISH 3//发布消息

8. #define MQTT_TypePUBACK 4//发布应答

9. #define MQTT_TypePUBREC 5//发布已接收，保证传递1

10. #define MQTT_TypePUBREL 6//发布释放，保证传递2

11. #define MQTT_TypePUBCOMP 7//发布完成，保证传递3

12. #define MQTT_TypeSUBSCRIBE 8//订阅请求

13. #define MQTT_TypeSUBACK 9//订阅应答

14. #define MQTT_TypeUNSUBSCRIBE 10//取消订阅

15. #define MQTT_TypeUNSUBACK 11//取消订阅应答

16. #define MQTT_TypePINGREQ 12//ping请求

17. #define MQTT_TypePINGRESP 13//ping响应

18. #define MQTT_TypeDISCONNECT 14//断开连接

19.  

20. #define MQTT_StaCleanSession 1 //清理会话

21. #define MQTT_StaWillFlag 0 //遗嘱标志

22. #define MQTT_StaWillQoS 0 //遗嘱QoS连接标志的第4和第3位。

23. #define MQTT_StaWillRetain 0 //遗嘱保留

24. #define MQTT_StaUserNameFlag 1 //用户名标志 User Name Flag

25. #define MQTT_StaPasswordFlag 1 //密码标志 Password Flag

26. #define MQTT_KeepAlive 60

27. #define MQTT_ClientIdentifier "Tan1" //客户端标识符 Client Identifier

28. #define MQTT_WillTopic "" //遗嘱主题 Will Topic

29. #define MQTT_WillMessage "" //遗嘱消息 Will Message

30. #define MQTT_UserName "admin" //用户名 User Name

31. #define MQTT_Password "password" //密码 Password

32.  

33. unsigned char GetDataFixedHead(unsigned char MesType,unsigned char DupFlag,unsigned char QosLevel,unsigned char Retain);

34. void GetDataPUBLISH(unsigned char *buff,unsigned char dup, unsigned char qos,unsigned char retain,const char *topic ,const char *msg);//获取发布消息的数据包

35. void GetDataSUBSCRIBE(unsigned char *buff,const char *dat,unsigned int Num,unsigned char RequestedQoS);//订阅主题的数据包 Num:主题序号 RequestedQoS:服务质量要求0,1或2

36. void GetDataDisConnet(unsigned char *buff);//获取断开连接的数据包

37. void GetDataConnet(unsigned char *buff);//获取连接的数据包正确连接返回20 02 00 00

38. void GetDataPINGREQ(unsigned char *buff);//心跳请求的数据包成功返回d0 00

39. #endif

mqtt.c

1. #include "mqtt.h"

2.  

3. unsigned char GetDataFixedHead(unsigned char MesType,unsigned char DupFlag,unsigned char QosLevel,unsigned char Retain)

4. {

5. unsigned char dat = 0;

6. dat = (MesType & 0x0f) << 4;

7. dat |= (DupFlag & 0x01) << 3;

8. dat |= (QosLevel & 0x03) << 1;

9. dat |= (Retain & 0x01);

10. return dat;

11. }

12. void GetDataConnet(unsigned char *buff)//获取连接的数据包正确连接返回20 02 00 00

13. {

14. unsigned int i,len,lennum = 0;

15. unsigned char *msg;

16. buff[0] = GetDataFixedHead(MQTT_TypeCONNECT,0,0,0);

17. buff[2] = 0x00;

18. buff[3] = 0x04;

19. buff[4] = 'M';

20. buff[5] = 'Q';

21. buff[6] = 'T';

22. buff[7] = 'T';

23. buff[8] = 0x04;//协议级别 Protocol Level

24. buff[9] = 0 | (MQTT_StaCleanSession << 1) | (MQTT_StaWillFlag << 1)

25. | (MQTT_StaWillQoS << 3) | (MQTT_StaWillRetain << 5)

26. | (MQTT_StaPasswordFlag << 6) |(MQTT_StaUserNameFlag << 7);//连接标志

27. buff[10] = MQTT_KeepAlive >> 8;

28. buff[11] = MQTT_KeepAlive;

29. len = strlen(MQTT_ClientIdentifier);

30. buff[12] = len >> 8;

31. buff[13] = len;

32. msg = MQTT_ClientIdentifier;

33. for(i = 0;i<len;i++)

34. {

35. buff[14+i] = msg[i];

36. }

37. lennum += len;

38. if(MQTT_StaWillFlag)

39. {

40. len = strlen(MQTT_WillTopic);

41. buff[13 + lennum + 1] = len >> 8;

42. buff[13 + lennum + 2] = len;

43. lennum += 2;

44. msg = MQTT_WillTopic;

45. for(i = 0;i<len;i++)

46. {

47. buff[14+lennum+i] = msg[i];

48. }

49. lennum += len;

50. len = strlen(MQTT_WillMessage);

51. buff[12] = len >> 8;

52. buff[13] = len;

53. lennum += 2;

54. msg = MQTT_WillMessage;

55. for(i = 0;i<len;i++)

56. {

57. buff[14+lennum+i] = msg[i];

58. }

59. lennum += len;

60. }

61. if(MQTT_StaUserNameFlag)

62. {

63. len = strlen(MQTT_UserName);

64. buff[13 + lennum + 1] = len >> 8;

65. buff[13 + lennum + 2] = len;

66. lennum += 2;

67. msg = MQTT_UserName;

68. for(i = 0;i<len;i++)

69. {

70. buff[14+lennum+i] = msg[i];

71. }

72. lennum += len;

73.  

74. }

75. if(MQTT_StaPasswordFlag)

76. {

77. len = strlen(MQTT_Password);

78. buff[13 + lennum + 1] = len >> 8;

79. buff[13 + lennum + 2] = len;

80. lennum += 2;

81. msg = MQTT_Password;

82. for(i = 0;i<len;i++)

83. {

84. buff[14+lennum+i] = msg[i];

85. }

86. lennum += len;

87. }

88. buff[1] = 13 + lennum - 1;

89. }

90. void GetDataDisConnet(unsigned char *buff)//获取断开连接的数据包

91. {

92. buff[0] = 0xe0;

93. buff[1] = 0;

94. }

95. void GetDataPINGREQ(unsigned char *buff)//心跳请求的数据包成功返回d0 00

96. {

97. buff[0] = 0xc0;

98. buff[1] = 0;

99. }

100. /*

101. 成功返回90 0x 00 Num RequestedQoS

102. */

103. void GetDataSUBSCRIBE(unsigned char *buff,const char *dat,unsigned int Num,unsigned char RequestedQoS)//订阅主题的数据包 Num:主题序号 RequestedQoS:服务质量要求0,1或2

104. {

105. unsigned int i,len = 0,lennum = 0;

106. buff[0] = 0x82;

107. len = strlen(dat);

108. buff[2] = Num>>8;

109. buff[3] = Num;

110. buff[4] = len>>8;

111. buff[5] = len;

112. for(i = 0;i<len;i++)

113. {

114. buff[6+i] = dat[i];

115. }

116. lennum = len;

117. buff[6 + lennum ] = RequestedQoS;

118. buff[1] = lennum + 5;

119. }

120. void GetDataPUBLISH(unsigned char *buff,unsigned char dup, unsigned char qos,unsigned char retain,const char *topic ,const char *msg)//获取发布消息的数据包

121. {

122. unsigned int i,len=0,lennum=0;

123. buff[0] = GetDataFixedHead(MQTT_TypePUBLISH,dup,qos,retain);

124. len = strlen(topic);

125. buff[2] = len>>8;

126. buff[3] = len;

127. for(i = 0;i<len;i++)

128. {

129. buff[4+i] = topic[i];

130. }

131. lennum = len;

132. len = strlen(msg);

133. for(i = 0;i<len;i++)

134. {

135. buff[4+i+lennum] = msg[i];

136. }

137. lennum += len;

138. buff[1] = lennum + 2;

139. }