MirrorSave
/
nodemcu-firmware
mirror of https://github.com/nodemcu/nodemcu-firmware.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add autoconnect option for publish() and update optional parameters

This commit is contained in:
Arnim Läuger 2016-01-26 22:55:33 +01:00
parent 2f9b51bf14
commit 3124a0e6a8
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/en/modules/mqtt.md
View File

@ -78,12 +78,13 @@ none
Connects to the broker specified by the given host, port, and secure options. Connects to the broker specified by the given host, port, and secure options.
#### Syntax #### Syntax
`mqtt:connect(host, port, secure, function(client))` `mqtt:connect(host[, port[, secure[, autoreconnect]]][, function(client)])`
#### Parameters #### Parameters
- `host` host, domain or IP (string) - `host` host, domain or IP (string)
- `port` broker port (number) - `port` broker port (number), default 1883
- `secure` 0/1 for `false`/`true`, default 0. [As per #539](https://github.com/nodemcu/nodemcu-firmware/issues/539#issuecomment-170298120) secure connections use TLS 1.2. - `secure` 0/1 for `false`/`true`, default 0. [As per #539](https://github.com/nodemcu/nodemcu-firmware/issues/539#issuecomment-170298120) secure connections use TLS 1.2.
- `autoreconnect` 0/1 for `false`/`true`, default 0
- `function(client)` call back function for when the connection was established - `function(client)` call back function for when the connection was established
#### Returns #### Returns
@ -94,7 +95,7 @@ Connects to the broker specified by the given host, port, and secure options.
Setup [Last Will and Testament](http://www.hivemq.com/blog/mqtt-essentials-part-9-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. Setup [Last Will and Testament](http://www.hivemq.com/blog/mqtt-essentials-part-9-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 #### Syntax
`mqtt:lwt(topic, message, qos, retain)` `mqtt:lwt(topic, message[, qos[, retain]])`
#### Parameters #### Parameters
- `topic` the topic to publish to (string) - `topic` the topic to publish to (string)
@ -124,14 +125,14 @@ Registers a callback function for an event.
Publishes a message. Publishes a message.
#### Syntax #### Syntax
`mqtt:publish(topic, payload, qos, retain, function(client))` `mqtt:publish(topic, payload, qos, retain[, function(client)])`
#### Parameters #### Parameters
- `topic` the topic to publish to ([topic string](http://www.hivemq.com/blog/mqtt-essentials-part-5-mqtt-topics-best-practices)) - `topic` the topic to publish to ([topic string](http://www.hivemq.com/blog/mqtt-essentials-part-5-mqtt-topics-best-practices))
- `message` the message to publish, (buffer or string) - `message` the message to publish, (buffer or string)
- `qos` QoS level, default 0 - `qos` QoS level
- `retain` retain flag, default 0 - `retain` retain flag
- `function(client)` callback fired when PUBACK received - `function(client)` optional callback fired when PUBACK received
#### Returns #### Returns
`nil` `nil`
@ -141,12 +142,12 @@ Publishes a message.
Subscribes to one or several topics. Subscribes to one or several topics.
#### Syntax #### Syntax
`mqtt:subscribe(topic, qos, function(client, topic, message))` `mqtt:subscribe(topic, qos[, function(client, topic, message)])`
#### Parameters #### Parameters
- `topic` a [topic string](http://www.hivemq.com/blog/mqtt-essentials-part-5-mqtt-topics-best-practices) - `topic` a [topic string](http://www.hivemq.com/blog/mqtt-essentials-part-5-mqtt-topics-best-practices)
- `qos` QoS subscription level, default 0 - `qos` QoS subscription level, default 0
- `function(client, topic, message)` callback fired when message received - `function(client, topic, message)` optional callback fired when message received
#### Returns #### Returns
`nil` `nil`