You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-8
Original file line number
Diff line number
Diff line change
@@ -24,9 +24,9 @@ Now the platform is in public beta, feedback is welcome.
24
24
## ArduinoIoTCloud library
25
25
26
26
The library is divided into various classes:
27
-
-`ConnectionManager` which is responsable for the connection to the Internet and to the Arduino IoT Cloud through `WiFiConnectionManager` or `GSMConnectionManager`. The selection is done using the type of board used.
27
+
-`ConnectionManager` which is responsable for the connection to the Internet through `WiFiConnectionManager` or `GSMConnectionManager`. The selection is done using the type of board used.
28
28
29
-
-`ArduinoIoTCloud` it's the leading class. It's responsible for the connection to the MQTT Broker.
29
+
-`ArduinoIoTCloud` it's the leading class. It's responsible for the connection to the MQTT Broker and to the Arduino IoT Cloud.
30
30
31
31
-`CloudSerial` it's similar to [Serial](https://www.arduino.cc/reference/en/language/functions/communication/serial/), but used in combination with the cloud.
32
32
@@ -50,22 +50,20 @@ The library is divided into various classes:
50
50
51
51
### ArduinoIoTCloud
52
52
53
-
- The `int begin(ConnectionManager *connection = ArduinoIoTPreferredConnection, String brokerAddress = "mqtts-sa.iot.arduino.cc")` function is used to initialize the connection to MQTT broker and to the cloud.
53
+
- The `begin(ConnectionManager *connection = ArduinoIoTPreferredConnection, String brokerAddress = "mqtts-sa.iot.arduino.cc")` function is used to initialize the connection to the Arduino IoT Cloud through MQTT
54
54
55
-
- The `connect()` function is used to connect to the MQTT broker and to the cloud
55
+
- The `connect()` function is used to connect to the MQTT broker
56
56
57
57
-`disconnect()` stops the MQTT Client
58
58
59
-
- The `update()` function checks the connnection with the MQTT broker, retrieve data from it and pushes back data using `writeProperties()`. `update()` is called periodically in the loop of .ino file.
59
+
- The `update()` function is called periodically in the loop of `.ino` file. It checks the connnection with the MQTT broker, retrieve data from the Cloud and pushes back data using function `writeProperties(const byte data[], int length)`.
60
60
61
61
-`connected()` simply returns the current status of the MQTT connection.
62
62
63
63
-`reconnect(Client&)` clean up existing MQTT connection, create a new one and initialize it by calling `connect()`
64
64
65
-
-`writeProperties(const byte data[], int length)` writes message to the MQTT Broker
66
-
67
65
-`setThingId(String const thing_id)` sets the *THING_ID*
68
66
69
67
-`getThingId()` returns the *THING_ID*
70
68
71
-
-`connectionCheck()` function is like `check()` from *ConnectionManager*. Uses a finite state machine and it's responsible for the connection to MQTT and the Cloud. It also uses *debugMessage* from *ConnectionManager* to print debug messages
69
+
-`connectionCheck()` function is like `check()` from *ConnectionManager*. Uses a finite state machine and it's responsible for the connection to Arduino IoT Cloud. It also uses *debugMessage* from *ConnectionManager* to print debug messages.
0 commit comments