NodeMCU文档中文翻译 6 MQTT模块

最新推荐文章于 2025-09-10 08:55:33 发布
转载 最新推荐文章于 2025-09-10 08:55:33 发布 · 1.2k 阅读 · 2
文章标签：

#mqtt #文档详解 #函数详解 #api

本文详细介绍了一个遵循MQTT 3.1.1协议的客户端库，包括客户端的创建、连接、发布消息、订阅主题等核心功能及其使用方法。

一、译文 

MQTT客户端支持Mqtt3.1.1协议，要确保你的MQTT服务器配置正确并支持3.1.1版本。此Mqtt模块并不兼容3.1版本之前的MQTT服务器。

mqtt.Client() 创建一个MQTT客户端.
mqtt.client:close() 关闭与服务器之间的连接.
mqtt.client:connect() 根据主机名、端口号和安全配置连接服务器.
mqtt.client:lwt() 创建遗嘱 (可选).
mqtt.client:on() 为事件创建回调函数.
mqtt.client:publish() 发送一条消息.
mqtt.client:subscribe() 订阅一个或多个主题.
mqtt.client:unsubscribe() 取消订阅一个或多个主题.

1、mqtt.Client()

创建一个MQTT客户端。

语法(PS:中括号内为可选参数)

mqtt.Client(clientid, keepalive[, username, password, cleansession])

参数

  • clientid 客户端id
  • keepalive 心跳秒数
  • username 用户名
  • password 密码
  • cleansession 清除session  0/1 表示 否/是

返回

Mqtt客户端

示例代码

[javascript]  view plain  copy
  1. -- 初始化无需登陆的客户端, 心跳时间 120秒  
  2. m = mqtt.Client("clientid", 120)  
  3.   
  4. -- 初始化需要登陆的客户端, 心跳时间 120秒  
  5. m = mqtt.Client("clientid", 120, "user", "password")  
  6.   
  7. -- 创建遗嘱(可选)  
  8. -- 服务器将会发送一条 qos = 0, retain = 0, 内容为"offline"的消息到"/lwt"主题，如果没收到客户端发送的心跳数据包(掉线)   
  9. m:lwt("/lwt", "offline", 0, 0)  
  10.   
  11. m:on("connect", function(client) print ("connected") end) --连接到服务器触发事件  
  12. m:on("offline", function(client) print ("offline") end) --掉线触发事件  
  13.   
  14. -- 收到消息时触发事件  
  15. m:on("message", function(client, topic, data)   
  16.   print(topic .. ":" )   
  17.   if data ~= nil then  
  18.     print(data)  
  19.   end  
  20. end)  
  21.   
  22. -- 对于 TLS: m:connect("192.168.11.118", secure-port, 1)  
  23. m:connect("192.168.11.118", 1883, 0, function(client) print("connected") end,   
  24.                                      function(client, reason) print("failed reason: "..reason) end)  
  25.   
  26. -- 确保subscribe/publish方法在连接上服务器后再调用，在实际应用中是把他们放在connect回调函数里或者确定连接成功  
  27.   
  28. -- 订阅/topic主题、服务质量为0  
  29. m:subscribe("/topic",0, function(client) print("subscribe success") end)  
  30. -- 发送一条信息 data = hello, QoS = 0, retain = 0  
  31. m:publish("/topic","hello",0,0, function(client) print("sent") end)  
  32.   
  33. m:close();  
  34. -- 你可以再次调用 m:connect 连接函数  

2、mqtt.client:close()

关闭与服务器的连接

语法   mqtt:close()
参数  无

返回 成功true，失败false

3、mqtt.client:connect()

根据主机名、端口号和安全配置连接服务器。
语法
  mqtt:connect(host[, port[, secure[, autoreconnect]]][, function(client)[, function(client, reason)]])
参数
  • host 主机名, 域名或 IP (字符串)
  • port 服务器端口(数字), 默认1883
  • secure 0/1 表示 false/true, 默认 0. 详情查看文档 net module.
  • autoreconnect 0/1表示 false/true,默认 0 (断线是否重连)
  • function(client) 连接服务器成功时的回调函数
  • function(client, reason) 连接服务器失败时的回调函数
返回 
成功 true，失败 false
连接失败时的错误代码
常量 值 描述
mqtt.CONN_FAIL_SERVER_NOT_FOUND -5 未找到服务器(或没开端口)
mqtt.CONN_FAIL_NOT_A_CONNACK_MSG -4 返回消息回应不是Mqtt协议
mqtt.CONN_FAIL_DNS -3 DNS错误
mqtt.CONN_FAIL_TIMEOUT_RECEIVING -2 等待响应超时
mqtt.CONN_FAIL_TIMEOUT_SENDING -1 尝试发送连接消息超时
mqtt.CONNACK_ACCEPTED 0 没有错误. 注意: 这不会触发错误回调函数.
mqtt.CONNACK_REFUSED_PROTOCOL_VER 1 服务器MQTT版本不是3.1.1.
mqtt.CONNACK_REFUSED_ID_REJECTED 2 ClientID被服务器拒绝. (查看mqtt.Client())
mqtt.CONNACK_REFUSED_SERVER_UNAVAILABLE 3 服务不可用.
mqtt.CONNACK_REFUSED_BAD_USER_OR_PASS 4 用户名或密码错误.
mqtt.CONNACK_REFUSED_NOT_AUTHORIZED 5 用户名没经过认证.

4、mqtt.client:lwt()

创建遗嘱(可选)，服务器将会发送一条 qos = 0, retain = 0, 内容为"offline"的消息到"/lwt"主题，如果没收到客户端发送的心跳数据包(掉线)。
语法
mqtt:lwt(topic, message[, qos[, retain]])
参数
  • topic 将要发送遗嘱消息的主题 (字符串)
  • message 遗嘱消息, (缓存 或 字符串)
  • qos 消息质量, 默认 0
  • retain 保留标志, 默认 0
返回 空

5、mqtt.client:on()

为事件创建回调函数.
语法
mqtt:on(event, function(client[, topic[, message]]))
参数
  • event 可以是 "connect", "message" 或者 "offline"
  • function(client[, topic[, message]]) 回调函数。第一个参数为client、如果事件为 "message"，那么第二个、第三个参数分别是主题和接收到的消息
返回 空

6、mqtt.client:publish()

发送一条消息.
语法
mqtt:publish(topic, payload, qos, retain[, function(client)])
参数
  • topic 要发送消息的主题 (字符串)
  • message 消息, (缓存 或 字符串)
  • qos 消息质量
  • retain 消息保留标志
  • function(client) 可选的回调函数。当消息发送成功(服务器传来PUBACK响应)则触发该事件。注意:当多次调用publish() 函数，所有的发送指令将会调用最后定义的回调函数。
返回 
成功 true，失败 false

7、mqtt.client:subscribe()

订阅一个或多个主题.
语法
mqtt:subscribe(topic, qos[, function(client)]) 或   mqtt:subscribe(table[, function(client)])
参数
  • topic 主题 (字符串)
  • qos 订阅的消息质量, 默认 0
  • table 要订阅的'topic, qos'数组对
  • function(client) 订阅成功时的可选回调函数.注意:当多次调用subscribe() 函数，所有的订阅指令将会调用最后定义的回调函数。
返回 
成功 true，失败 false
示例代码
[javascript]  view plain  copy
  1. -- 订阅/topic主题、服务质量为0  
  2. m:subscribe("/topic",0, function(conn) print("subscribe success") end)  
  3.   
  4. -- 或者订阅多个主题 (topic/0, qos = 0; topic/1, qos = 1; topic2 , qos = 2)  
  5. m:subscribe({["topic/0"]=0,["topic/1"]=1,topic2=2}, function(conn) print("subscribe success") end)  

8、mqtt.client:unsubscribe()

取消订阅一个或多个主题.
语法
mqtt:unsubscribe(topic[, function(client)]) 或   mqtt:unsubscribe(table[, function(client)])
参数
  • topic 主题 (字符串)
  • table 要取消订阅的'topic, qos'数组对
  • function(client) 取消订阅成功时的可选回调函数.注意:当多次调用unsubscribe() 函数，所有的取消订阅指令将会调用最后定义的回调函数。
返回 
成功 true，失败 false
示例代码
[javascript]  view plain  copy
  1. -- 取消订阅主题  
  2. m:unsubscribe("/topic", function(conn) print("unsubscribe success") end)  
  3.   
  4. -- 或者取消订阅多个主题 (topic/0; topic/1; topic2)  
  5. m:unsubscribe({["topic/0"]=0,["topic/1"]=0,topic2="anything"}, function(conn) print("unsubscribe success") end)  


MQTT Module

Since Origin / Contributor Maintainer Source
2015-01-23 Stephen Robinson, Tuan PM Vowstar mqtt.c

The client adheres to version 3.1.1 of the MQTT protocol. Make sure that your broker supports and is correctly configured for version 3.1.1. The client is backwards incompatible with brokers running MQTT 3.1.

mqtt.Client() Creates a MQTT client.
mqtt.client:close() Closes connection to the broker.
mqtt.client:connect() Connects to the broker specified by the given host, port, and secure options.
mqtt.client:lwt() Setup Last Will and Testament (optional).
mqtt.client:on() Registers a callback function for an event.
mqtt.client:publish() Publishes a message.
mqtt.client:subscribe() Subscribes to one or several topics.
mqtt.client:unsubscribe() Unsubscribes from one or several topics.

mqtt.Client()

Creates a MQTT client.

Syntax

mqtt.Client(clientid, keepalive[, username, password, cleansession])

Parameters
  • clientid client ID
  • keepalive keepalive seconds
  • username user name
  • password user password
  • cleansession 0/1 for false/true
Returns

MQTT client

Example
-- init mqtt client without logins, keepalive timer 120s
m = mqtt.Client("clientid", 120)

-- init mqtt client with logins, keepalive timer 120sec
m = mqtt.Client("clientid", 120, "user", "password")

-- setup Last Will and Testament (optional)
-- Broker will publish a message with qos = 0, retain = 0, data = "offline" 
-- to topic "/lwt" if client don't send keepalive packet
m:lwt("/lwt", "offline", 0, 0)

m:on("connect", function(client) print ("connected") end)
m:on("offline", function(client) print ("offline") end)

-- on publish message receive event
m:on("message", function(client, topic, data) 
  print(topic .. ":" ) 
  if data ~= nil then
    print(data)
  end
end)

-- for TLS: m:connect("192.168.11.118", secure-port, 1)
m:connect("192.168.11.118", 1883, 0, function(client) print("connected") end, 
                                     function(client, reason) print("failed reason: "..reason) end)

-- Calling subscribe/publish only makes sense once the connection
-- was successfully established. In a real-world application you want
-- move those into the 'connect' callback or make otherwise sure the 
-- connection was established.

-- subscribe topic with qos = 0
m:subscribe("/topic",0, function(client) print("subscribe success") end)
-- publish a message with data = hello, QoS = 0, retain = 0
m:publish("/topic","hello",0,0, function(client) print("sent") end)

m:close();
-- you can call m:connect again

MQTT Client

mqtt.client:close()

Closes connection to the broker.

Syntax

mqtt:close()

Parameters

none

Returns

true on success, false otherwise

mqtt.client:connect()

Connects to the broker specified by the given host, port, and secure options.

Syntax

mqtt:connect(host[, port[, secure[, autoreconnect]]][, function(client)[, function(client, reason)]])

Parameters
  • host host, domain or IP (string)
  • port broker port (number), default 1883
  • secure 0/1 for false/true, default 0. Take note of constraints documented in the net module.
  • autoreconnect 0/1 for false/true, default 0
  • function(client) callback function for when the connection was established
  • function(client, reason) callback function for when the connection could not be established
Returns

true on success, false otherwise

Connection failure callback reason codes:
Constant Value Description
mqtt.CONN_FAIL_SERVER_NOT_FOUND -5 There is no broker listening at the specified IP Address and Port
mqtt.CONN_FAIL_NOT_A_CONNACK_MSG -4 The response from the broker was not a CONNACK as required by the protocol
mqtt.CONN_FAIL_DNS -3 DNS Lookup failed
mqtt.CONN_FAIL_TIMEOUT_RECEIVING -2 Timeout waiting for a CONNACK from the broker
mqtt.CONN_FAIL_TIMEOUT_SENDING -1 Timeout trying to send the Connect message
mqtt.CONNACK_ACCEPTED 0 No errors. Note: This will not trigger a failure callback.
mqtt.CONNACK_REFUSED_PROTOCOL_VER 1 The broker is not a 3.1.1 MQTT broker.
mqtt.CONNACK_REFUSED_ID_REJECTED 2 The specified ClientID was rejected by the broker. (Seemqtt.Client())
mqtt.CONNACK_REFUSED_SERVER_UNAVAILABLE 3 The server is unavailable.
mqtt.CONNACK_REFUSED_BAD_USER_OR_PASS 4 The broker refused the specified username or password.
mqtt.CONNACK_REFUSED_NOT_AUTHORIZED 5 The username is not authorized.

mqtt.client:lwt()

Setup Last Will and Testament (optional). A broker will publish a message with qos = 0, retain = 0, data = "offline" to topic "/lwt" if client does not send keepalive packet.

Syntax

mqtt:lwt(topic, message[, qos[, retain]])

Parameters
  • topic the topic to publish to (string)
  • message the message to publish, (buffer or string)
  • qos QoS level, default 0
  • retain retain flag, default 0
Returns

nil

mqtt.client:on()

Registers a callback function for an event.

Syntax

mqtt:on(event, function(client[, topic[, message]]))

Parameters
  • event can be "connect", "message" or "offline"
  • function(client[, topic[, message]]) callback function. The first parameter is the client. If event is "message", the 2nd and 3rd param are received topic and message (strings).
Returns

nil

mqtt.client:publish()

Publishes a message.

Syntax

mqtt:publish(topic, payload, qos, retain[, function(client)])

Parameters
  • topic the topic to publish to (topic string)
  • message the message to publish, (buffer or string)
  • qos QoS level
  • retain retain flag
  • function(client) optional callback fired when PUBACK received. NOTE: When calling publish() more than once, the last callback function defined will be called for ALL publish commands.
Returns

true on success, false otherwise

mqtt.client:subscribe()

Subscribes to one or several topics.

Syntax

mqtt:subscribe(topic, qos[, function(client)]) mqtt:subscribe(table[, function(client)])

Parameters
  • topic a topic string
  • qos QoS subscription level, default 0
  • table array of 'topic, qos' pairs to subscribe to
  • function(client) optional callback fired when subscription(s) succeeded. NOTE: When calling subscribe() more than once, the last callback function defined will be called for ALL subscribe commands.
Returns

true on success, false otherwise

Example
-- subscribe topic with qos = 0
m:subscribe("/topic",0, function(conn) print("subscribe success") end)

-- or subscribe multiple topic (topic/0, qos = 0; topic/1, qos = 1; topic2 , qos = 2)
m:subscribe({["topic/0"]=0,["topic/1"]=1,topic2=2}, function(conn) print("subscribe success") end)

mqtt.client:unsubscribe()

Unsubscribes from one or several topics.

Syntax

mqtt:unsubscribe(topic[, function(client)]) mqtt:unsubscribe(table[, function(client)])

Parameters
  • topic a topic string
  • table array of 'topic, anything' pairs to unsubscribe from
  • function(client) optional callback fired when unsubscription(s) succeeded. NOTE: When calling unsubscribe() more than once, the last callback function defined will be called for ALL unsubscribe commands.
Returns

true on success, false otherwise

Example
-- unsubscribe topic
m:unsubscribe("/topic", function(conn) print("unsubscribe success") end)

-- or unsubscribe multiple topic (topic/0; topic/1; topic2)
m:unsubscribe({["topic/0"]=0,["topic/1"]=0,topic2="anything"}, function(conn) print("unsubscribe success") end)
nodemcu Arduino mqtt控制板载灯
Mung_bean_Rana的专栏
04-19 3647
ESP8266 代码编写 需要 ESP8266WiFi 和 PubSubClient ，还有ArduinoJson库，ESP8266WiFi 库能够将 ESP8266 连接到 Wi-Fi 网络，PubSubClient 库能使 ESP8266 连接到 MQTT 服务器发布消息及订阅主题，ArduinoJson来处理json。 #include <ESP8266WiFi.h> #include <PubSubClient.h> #include <ArduinoJson.
NodeMcu Api说明文档（中文版）
07-05
NodeMCU,是一个开源的物联网平台。 它使用Lua脚本语言编程。该平台基于eLua开源项目,底层使用ESP8266 sdk 0.9.5版本。该平台使用了很多开源项目, 例如 lua-cjson, spiffs. NodeMCU包含了可以运行在esp8266Wi-FiSoC芯片之上的固件,以及基于ESP-12模组的硬件
NodeMCU 通过MQTT 连接阿里云物联网
热门推荐
weixin_43368807的博客
10-09 1万+
NodeMCU 通过MQTT 连接阿里云物联网 1.NodeMCU固件的选择及刷入ESP8266 1123
STM32之wifi模块与MQTT模块详解
m0_74186706的博客
09-10 1069
广泛用于物联网设备联网通信的传输协议，基于 TCP/IP 实现MQTT 区分客户端和服务器，本地 STM32 + ESP8266 + MQTT 支持，可以认为是 MQTT 的客户端，同时云平台 (ThingsCloud Onenet Aliyun) 物联网平台可以认为是 MQTT 服务器。MQTT 协议中，重点内容是【服务器连接】【订阅主题】【发布消息】服务器连接：当前 MQTT 客户端链接对应的 MQTT 服务器。
NodeMcuAPI中文手册
11-09
包含以下node、file、wifi、timer、GPIO、PWM、net模块
物联网与嵌入式系统-NodeMCU-WiFi模块-MQTT通信协议-WebSocket实时数据传输-基于ESP8266芯片的单片机数据采集与远程监控系统-通过Web界面实现四通道传.zip
最新发布
09-12
NodeMCU作为一款流行的物联网硬件开发平台，结合ESP8266芯片，提供了无线通信的功能，它能够通过WiFi模块实现设备与互联网的连接。ESP8266芯片因其内置的Wi-Fi功能和成本效益高而广泛应用于物联网项目中。 MQTT...
NodeMCU-API中文说明
12-06
NodeMCU API中文说明是针对不熟悉英文文档的用户特别准备的资源，帮助他们更好地理解和应用NodeMCU。 1. **NodeMCU硬件基础**：NodeMCU的核心是ESP-12模组，该模组包含一个ESP8266系统级芯片(SOC)，具备Wi-Fi功能和...
Fairylights:Lua代码使用运行Nodemcu固件的ESP8266通过MQTT无线打开和关闭小灯
05-24
在本文中，我们将深入探讨如何使用Lua编程语言和NodeMCU固件，通过MQTT协议在ESP8266微控制器上实现“仙女灯”的无线控制。NodeMCU是一款基于ESP8266芯片的开源硬件平台，它允许开发者通过Lua脚本进行编程，轻松实现...
nodemcu Arduino mqtt控制板载灯 示例
04-19
【标题】"nodemcu Arduino mqtt控制板载灯 示例"主要涵盖了使用NodeMCU开发板，结合Arduino编程环境，以及MQTT（Message Queuing Telemetry Transport）协议来远程控制板载LED灯的操作。NodeMCU是一款基于ESP8266...
NodeMCU-API中文说明 .pdf
03-15
这份《NodeMCU-API中文说明》文档详细列出了Version 0.9.5（发布于2015年2月13日）的API中文使用说明，内容覆盖了从基础的GPIO操作到复杂网络通信的各种函数和方法。 ### NodeMCU模块概览 NodeMCU提供了以下主要...
NodeMCU连接MQTT服务器，APP远程查看数据并控制LED、蜂鸣器和继电器
05-06
NodeMCU连接MQTT服务器，APP远程查看数据并控制LED、蜂鸣器和继电器。压缩文件内含word详细操作步骤！！！
【MQTT学习】NODEMCU(ESP8266-12F)的AT指令
01-06
官方AT固件烧录方法参考 ESP8266-12F烧录V1.7以上版本AT固件的方法 模块设置 AT—Tests AT Startup 命令 AT 返回 OK AT+RST—复位模块 命令 AT+RST 返回 OK AT+RESTORE—恢复出厂设置 命令 AT+RESTORE 响应 OK ATE—AT 命令回显 关闭回显 ATE0 打开回显 ATE1 AT+UART_CUR—当前UART设置，不保存到Flash 查询 AT+UART_CUR? 设置 AT+UART_CUR=,,,, 参数说明 : UART baud rate : data bits 5: 5-bit da
NodeMcuAPI手册
11-29
NodeMcuAPI手册
NodeMcu Api说明文档(英文原版)
07-05
NodeMCU,是一个开源的物联网平台。 它使用Lua脚本语言编程。该平台基于eLua开源项目,底层使用ESP8266 sdk 0.9.5版本。该平台使用了很多开源项目, 例如 lua-cjson, spiffs. NodeMCU包含了可以运行在esp8266Wi-FiSoC芯片之上的固件,以及基于ESP-12模组的硬件。
nodemcu通过MQTT协议进行通讯
blinkdr的博客
03-18 1万+
nodemcu介绍nodemcu是一款开源快速硬件原型平台，包括固件和开发板，用几行简单的Lua脚本就能开发物联网应用。特点包括开源，交互式，可编程，低成本，简单，智能，WI-FI硬件。 最新版的nodemcu开发板是基于ESP-12E的，具有GPIO、PWM、I2C、1-Wire、ADC等功能。实物图 新版引脚图 更对关于nodemcu的介绍可以参考其中文官网，或者其在Github上的地址。
NodeMCU快速开发
weixin_34088598的博客
12-06 922
2019独角兽企业重金招聘Python工程师标准>>> ...
使用nodeMCU平台mqtt协议实现物联网通信
newchenxf的专栏
10-10 1万+
nodeMCU是物联网硬件模块，要联网，要发信息，就用mqtt协议走起来。怎么走，请看本文咯
nodemcu通过mqtt实现实时通信
wangzhe12311的博客
04-24 2625
1.windows下服务器的搭建 我选择了比较简单的emqx服务器，参考了大佬的博文 https://blog.csdn.net/Mr_robot_strange/article/details/103881635?ops_request_misc=%257B%2522request%255Fid%2522%253A%2522165076262116782350930112%2522%252C%2522scm%2522%253A%252220140713.130102334..%2522%257D&am
D1 迷你版 NodeMcu Lua WIFI 和mqtt云平台
05-13
需要查阅NodeMCU的文档，找到mqtt库的使用方法。 现在，我需要将这些信息整合成一个步骤指南。首先初始化WiFi，然后连接到MQTT服务器，确保client id唯一，并处理订阅和发布。可能需要示例代码，使用Lua的mqtt...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值