NodeMCU文档中文翻译 6 MQTT模块

最新推荐文章于 2022-09-30 10:59:28 发布
最新推荐文章于 2022-09-30 10:59:28 发布
阅读量207 收藏
点赞数
文章标签： 运维
原文链接：http://www.cnblogs.com/leytton/p/8253271.html
版权

【本文出处:http://blog.csdn.net/leytton/article/details/72454287】

一、译文 

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客户端

示例代码

-- 初始化无需登陆的客户端, 心跳时间 120秒
m = mqtt.Client("clientid", 120)

-- 初始化需要登陆的客户端, 心跳时间 120秒
m = mqtt.Client("clientid", 120, "user", "password")

-- 创建遗嘱(可选)
-- 服务器将会发送一条 qos = 0, retain = 0, 内容为"offline"的消息到"/lwt"主题，如果没收到客户端发送的心跳数据包(掉线) 
m:lwt("/lwt", "offline", 0, 0)

m:on("connect", function(client) print ("connected") end) --连接到服务器触发事件
m:on("offline", function(client) print ("offline") end) --掉线触发事件

-- 收到消息时触发事件
m:on("message", function(client, topic, data) 
  print(topic .. ":" ) 
  if data ~= nil then
    print(data)
  end
end)

-- 对于 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)

-- 确保subscribe/publish方法在连接上服务器后再调用，在实际应用中是把他们放在connect回调函数里或者确定连接成功

-- 订阅/topic主题、服务质量为0
m:subscribe("/topic",0, function(client) print("subscribe success") end)
-- 发送一条信息 data = hello, QoS = 0, retain = 0
m:publish("/topic","hello",0,0, function(client) print("sent") end)

m:close();
-- 你可以再次调用 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
示例代码 
-- 订阅/topic主题、服务质量为0
m:subscribe("/topic",0, function(conn) print("subscribe success") end)

-- 或者订阅多个主题 (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)

8、mqtt.client:unsubscribe()

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

-- 或者取消订阅多个主题 (topic/0; topic/1; topic2)
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)


转载于:https://www.cnblogs.com/leytton/p/8253271.html

weixin_30832351
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
MQTT Version 3.1.1中英文翻译对照文档.pdf
11-04
我们为您提供了一份完整的MQTT协议文档中英文翻译对照表，方便大家快速学习和理解MQTT协议。这份翻译对照表包含了MQTT协议的核心概念、消息格式、主题结构、连接和会话管理、QoS服务质量等级、订户离线消息处理以及...
非线性方程-概念应用及解法
鱼七
10-04 1万+
非线性方程-概念应用及解法
各种数论定理
ACMer_ZP的博客
07-27 1070
小技巧 当算某个数的阶乘或者算很大的次方的时候，可以将数字转换为10^n的进制表示方法（比如1000进制或者10000进制），这样出来点的数字和原答案是一样的，只不过在一个数组的一个元素中多存了几位。约数个数定理 首先，n可以分解质因数：n=p1^a1×p2^a2×p3^a3*…*pk^ak, 由约数定义可知p1^a1的约数有:p1^0, p1^1, p1^2……p1^a1 ，共（a1+1）个
学习中医中
人生如旅
05-05 495
歧黄智康：学中医养生，10万经方，1000+名家医案，智能解方，各类中医知识，自己开发学习用，欢迎交流。 使用意见建议，功能改进，请留言。
MySQL可以存放的数据类型
heyLarry的博客
12-12 5018
MySQL数据库中常用字段类型： 整数型：TINYINT，SMALLINT，INT，BIGINT 小数型：FLOAT，DOUBLE，DECIMAL(M,D) 字符型：CHAR，VARCHAR 日期型：DATETIME ，DATE，TIMESTAMP 备注型：TINYTEXT ，TEXT ，LONGTEXT  有些整数类型以及他们最多所能拥有的数字位我们必须有
NodeMCU-API 中文完整版 word 版本
qq_35653974的博客
09-30 1559
NodeMCU-API 中文完整版 word 版本
nodemcu-lua-mqtt:物联网和 MQTT 世界中 Nodemcu (ESP8266) 的 Lua 脚本
06-16
nodemcu-lua-mqtt Nodemcu 的 Lua 脚本主要用于测试 MQTT 协议和 CoAP（计划在 Nodemcu 未来发布 Lua 之后）。 请随意使用以在 Nodemcu 平台上快速启动您的 MQTT 原型设计。 我为 Nodemcu 和 Lua 使用以下工具：关于...
基于MQTT和nodeMCU的音乐弹奏APP【100010341】
01-04
本大作业是基于MQTT协议的手机客户端控制NodeMcu模块的一个小钢琴的实现。 基本上能够实现控制，通讯功能，由于其他同学做出的各种监测温湿度，灯泡控制的比较多，所以我在上学期大作业的基础上进行了衍生，做到了...
NodeMCU（arduino编程）+阿里云平台实现MQTT收发
09-01
该代码有完整详细的中文注释，可以配合我的博客https://blog.csdn.net/qq_43010516/article/details/126648100 对代码进行修改，需要修改的地方只有4处，代码中也分别进行了标注，怎样设置阿里云平台和进行可视化...
基于“Kube”NodeMCU/DHT22 的 MQTT 温度/湿度家庭自动化多传感器与本地 OLED 显示屏的自述文件/图
07-14
C++ Thingiverse 项目代码（Kube - 基于 NodeMCU/DHT22 的 MQTT 温度/湿度传感器，带有本地 OLED 显示屏） 零件清单 更多详情、使用方法，请下载后细读README.md文件
NodeMcu Api说明文档（中文版）
07-05
NodeMCU,是一个开源的物联网平台。 它使用Lua脚本语言编程。该平台基于eLua开源项目,底层使用ESP8266 sdk 0.9.5版本。该平台使用了很多开源项目, 例如 lua-cjson, spiffs. NodeMCU包含了可以运行在esp8266Wi-FiSoC芯片之上的固件,以及基于ESP-12模组的硬件
在CSDN设置“关注博主即可阅读全文”方法增加粉丝量超简单
qq_55433305的博客
09-11 5419
打开文章，需要关注博主方可继续阅读的
[学习应用]设置R语言在启动时自动加载常用包（packages）或函数（function）
gtxing的博客
10-05 6960
最近阅读《R in Action》这本书，了解到可以设置R语言自启动环境，实在是太实用了，于是把在工作中常用的package和function放到Rprofile.site文件的自定义函数，重新启动R即可实现。比如你常用data.table、RMySQL这两个扩展包和已自定义好的函数read_report，设置如下： 第一步：安装目录找到Rprofile.site这个文件，我的是在“D:\R\et
最新进展！单细胞数据显示ACE2在鼻腔、肾脏、睾丸均有分布！
悟道西方
02-24 6360
继上期发表的利用单细胞公共数据对新冠受体ACE2的研究进展后，利用单细胞研究ACE2在不同组织器官中的分布如火如荼的展开，下面介绍最新发表的两篇文献。 A novel coronavirus (2019-nCoV) was first identified in Wuhan, Hubei Province, and then spreads to the other Provinces of ...
php,js 怎样表示正负无穷大
buyue
06-10 2562
正无穷大:1.7976931348623157E+10308 负无穷大: - (1.7976931348623157E+10308) ，也可以使用log(0)表示
聚光灯效应和旁观者效应
jin的专栏
05-07 371
聚光灯效应 人们总认为大家的注意力会集中在自己身上，如进入教室总以为大家全都在看自己，导致很紧张，事实是只有少部分人抬头看你了。 可以置换角度即你作为观察者，其实对进门的人也只是好奇看一眼而已，并没有持续聚焦。 克服聚光灯效应就是让自己无需有额外思想负担，表现的就像平时一样，说起来容易做起来难。只需要大家了解这个点，这样能缓解紧张情绪。 标题旁观者效应，又称责任扩散效应 举个例子，有人中暑了，围观者越来越多，施救的人却寥寥无几，包括打120，因为大家都认为这么多人围观肯定有人会打120，所以遇到突发情况，围
6.15：题目及答案解析
思念十年后
07-03 795
1、一项目经理被他的项目的各种问题折磨得狼狈不堪。他想找出问题的根源，以决定把注意力放在哪儿。该项目经理最应该使用下列哪项工具？ A、帕雷托图 B、冲突解决技巧 C、鱼骨图 D、趋势分析 参考答案：C。解析：题目是已知问题，需要找问题的原因，使用鱼骨图，如果是已知原因，需要找主要原因则选帕累托图。帕雷托图（选项 A）能帮助项目经理决定着眼的问题，但是不能找出问题的根源。虽然项目遇到了麻烦，但是也用不着冲突解决技巧（选项 B），因为实际上问题还没确认呢。趋势分析（选项 D）不解决根源，它更多的.
中国疫情发展趋势分析预测（python实现）
热门推荐
野马
03-06 3万+
中国疫情发展趋势预测 笔者使用的增长模型预测中国疫情发展趋势，使用了3种增长模型进行了预测，这里只贴出利用逻辑斯蒂增长模型的代码。 logistic增长的曲线也称为s型曲线。下图左图为曲线数量，右图为增长速率。 逻辑斯蒂增长模型，又叫阻滞增长模型, 逻辑斯蒂曲线通常分为5个时期： 开始期，由于种群个体数很少，密度增长缓慢，又称潜伏期。 加速期，随个体数增加，密度增长加...
HTTP协议之缓存控制:no-cache/must-revalidate/no-store
样young的博客
09-05 1万+
本文转自：http://hyj1254.iteye.com/blog/1165387 客户端从服务器请求数据需要经历如下基本步骤:         1、如果请求命中本地缓存则从本地缓存中获取一个对应资源的"copy"；         2、检查这个"copy"是否fresh,是则直接返回，否则继续向服务器转发请求。         3、服务器接收到请求，然后判断资源是否变更，是则返回新内容，否...
esp8266nodemcu如何连接onenet的mqtt服务器
最新发布
05-01
要连接OneNet的MQTT服务器，需要使用ESP8266 NodeMCU的MQTT客户端库。以下是连接OneNet MQTT服务器的基本步骤： 1. 在OneNet平台上创建设备和数据流，获取设备ID和API密钥。 2. 下载和安装ESP8266 NodeMCU的MQTT...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值