Skip to content

Commit 64f3874

Browse files
committed
Fix errors
1 parent 6b5c2af commit 64f3874

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

README.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ Now the platform is in public beta, feedback is welcome.
2424
## ArduinoIoTCloud library
2525

2626
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.
2828

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.
3030

3131
- `CloudSerial` it's similar to [Serial](https://www.arduino.cc/reference/en/language/functions/communication/serial/), but used in combination with the cloud.
3232

@@ -50,22 +50,20 @@ The library is divided into various classes:
5050

5151
### ArduinoIoTCloud
5252

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
5454

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
5656

5757
- `disconnect()` stops the MQTT Client
5858

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)`.
6060

6161
- `connected()` simply returns the current status of the MQTT connection.
6262

6363
- `reconnect(Client&)` clean up existing MQTT connection, create a new one and initialize it by calling `connect()`
6464

65-
- `writeProperties(const byte data[], int length)` writes message to the MQTT Broker
66-
6765
- `setThingId(String const thing_id)` sets the *THING_ID*
6866

6967
- `getThingId()` returns the *THING_ID*
7068

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

Comments
 (0)