Changes for page 01 Lua Functions

Last modified by Theodore Xu on 2023/10/26 10:51

From 5.8 to 5.9 From 5.10 to 5.11

From version 5.9

edited by Stone Wu
on 2022/07/12 09:26

Change comment: There is no comment for this version

To version 5.10

edited by Stone Wu
on 2022/07/12 09:30

Change comment: (Autosaved)

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -752,12 +752,10 @@
  **QoS value:**
--0: Only push messages once, messages may be lost or duplicated. It can be used for environmental sensor data, it doesn't matter if lose a record, because there will be a second push message soon. This method is mainly used for normal APP push, but if the user smart device is not connected when the message is pushed, the message will be discarded, and the smart device will not be received when it is networked again.
++* 0: Only push messages once, messages may be lost or duplicated. It can be used for environmental sensor data, it doesn't matter if lose a record, because there will be a second push message soon. This method is mainly used for normal APP push, but if the user smart device is not connected when the message is pushed, the message will be discarded, and the smart device will not be received when it is networked again.
++* 1: The message is delivered at least once, but the message may be delivered repeatedly.
++* 2: The message was delivered exactly once. This level can be used in a billing system. In a billing system, repeated or missing messages can lead to incorrect results. This highest quality message push service can also be used for instant messaging APP pushes, ensuring that users only receive messages once.
--1: The message is delivered at least once, but the message may be delivered repeatedly.
--
--2: The message was delivered exactly once. This level can be used in a billing system. In a billing system, repeated or missing messages can lead to incorrect results. This highest quality message push service can also be used for instant messaging APP pushes, ensuring that users only receive messages once.
--
  **Retain flag:**
 : not reserved;
@@ -765,13 +765,11 @@
 : reserved
  (((
--== **4.1 mqtt.create(string serverurl, string clientid)** ==
++== **mqtt.create(string serverurl, string clientid)** ==
  )))
--**Function:**
++**Function:** Create an MQTT object
--Create an MQTT object
--
  **Parameters:**
  //serverurl //Server url
@@ -793,17 +793,13 @@
  Failed: multi
  (((
--== **4.2 mqtt.close(mqtt obj)** ==
++== **mqtt.close(mqtt obj)** ==
  )))
--**Function:**
++**Function:** Close the specified MQTT object (if the connected server will be disconnected automatically)
--Close the specified MQTT object (if the connected server will be disconnected automatically)
++**Parameters: **//Obj //is the objeced returned by mqtt.create
--**Parameters:**
--
--//Obj //is the objeced returned by mqtt.create
--
  **Return：**
  Succeed: true
@@ -811,32 +811,25 @@
  Failed: multi
  (((
--== **4.3 mqtt:connect(table conn[, table lwt, table cart])** ==
++== **mqtt:connect(table conn[, table lwt, table cart])** ==
  )))
--**Function:**
++**Function:**Establish a connection to the server
--Establish a connection to the server
--
  **Parameters:**
  //conn //is a Lua table and needs to contain the following fields
--//string conn.username//, user name
++* //string conn.username//, user name
++* //string conn.password//, password
++* //number [conn.netway=0]//, networking method, if set error number will use Ethernet method
++** 0: Ethernet
++** 1: WIFI
++** 2: 4G
++** 3: 2G
++* //number [conn.keepalive=60]//, keep connected heartbeat interval, in seconds
++* //number [conn.cleansession=1]//, empty the session as described below:
--//string conn.password//, password
--
--//number [conn.netway=0]//, networking method, if set error number will use Ethernet method
--
--* 0: Ethernet
--* 1: WIFI
--* 2: 4G
--* 3: 2G
--
--//number [conn.keepalive=60]//, keep connected heartbeat interval, in seconds
--
--//number [conn.cleansession=1]//, empty the session as described below:
--
  This function is used to control the behavior when connecting and disconnecting, and the client and server will retain the session information. This information is used to guarantee "at least once" and "accurately once" delivery, as well as the subject of the client subscription, the user can choose to keep or ignore the session message, set as follows:
  * 1 (Empty): If a session exists and is 1, the previous session messages on the client and server are emptied.
@@ -844,14 +844,11 @@
  //lwt// (Last Will and Testament) is a Lua table and needs to contain the following fields
--//string lwt.topic//, topic
++* //string lwt.topic//, topic
++* //string lwt.message//, message
++* //number [lwt.qos=0]//, qos value
++* //number [lwt.retain=0]//, retain flag
--//string lwt.message//, message
--
--//number [lwt.qos=0]//, qos value
--
--//number [lwt.retain=0]//, retain flag
--
  **Return：**
  Succeed: true
@@ -859,17 +859,13 @@
  Failed: multi
  (((
--== **4.4 mqtt:disconnect([number timeout])** ==
++== **mqtt:disconnect([number timeout])** ==
  )))
--**Function:**
++**Function:** Disconnect from the MQTT server
--Disconnect from the MQTT server
++**Parameters: **//[timeout=10000] //Disconnect waiting timeout, in milliseconds
--**Parameters:**
--
--//[timeout=10000] //Disconnect waiting timeout, in milliseconds
--
  **Return：**
  Succeed: true
@@ -877,17 +877,13 @@
  Failed: multi
  (((
--== **4.5 mqtt:isconnected()** ==
++== **mqtt:isconnected()** ==
  )))
--**Function:**
++**Function:** Test whether or not a client is currently connected to the MQTT server
--Test whether or not a client is currently connected to the MQTT server
++**Parameters:** None
--**Parameters:**
--
--None
--
  **Return：**
  Succeed: true ~-~-Connected
@@ -895,13 +895,11 @@
  Failed: false ~-~- Unconnected and other unknowns
  (((
--== **4.6 mqtt:subscribe(string topic, number qos)** ==
++== **mqtt:subscribe(string topic, number qos)** ==
  )))
--**Function:**
++**Function: **Subscribe to the topic (before the subscription, the user must first call the connect method to connect to the server)
--Subscribe to the topic (before the subscription, the user must first call the connect method to connect to the server)
--
  **Parameters:**
  //topic//, topic name
@@ -915,13 +915,11 @@
  Failed: multi
  (((
--== **4.7 mqtt:unsubscribe(string topic)** ==
++== **mqtt:unsubscribe(string topic)** ==
  )))
--**Function:**
++**Function:** Unsubscribe topic
--Unsubscribe topic
--
  **Parameters:**
  //topic//, topic name
@@ -933,13 +933,11 @@
  Failed: multi
  (((
--== **4.8 mqtt:publish(string topic, string message, number qos, number retain[, number timeout])** ==
++== **mqtt:publish(string topic, string message, number qos, number retain[, number timeout])** ==
  )))
--**Function:**
++**Function:** Publish message
--Publish message
--
  **Parameters:**
  //topic//, topic name
@@ -959,17 +959,13 @@
  Failed: multi
  (((
--== **4.9 mqtt:close()** ==
++== **mqtt:close()** ==
  )))
--**Function:**
++**Function:** Close the mqtt object (the connection to the server will be automatically disconnected)
--Close the mqtt object (the connection to the server will be automatically disconnected)
++**Parameters:** None
--**Parameters:**
--
--None
--
  **Return：**
  Succeed: true
@@ -977,13 +977,11 @@
  Failed: multi
  (((
--== **4.10 mqtt:on(string method, function callback)** ==
++== **mqtt:on(string method, function callback)** ==
  )))
--**Function:**
++**Function:** Register event callback function
--Register event callback function
--
  **Parameters:**
  //method//, It can be message/arrived/offline, these 3 types of events

Changes for page 01 Lua Functions

Summary

Details

Navigation

Table of Contents