Skip to content

Commit 48674f4

Browse files
per1234umbynos
andauthored
Apply suggestions from code review
Co-Authored-By: umbynos <[email protected]>
1 parent 37081bb commit 48674f4

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,39 @@
11
# ArduinoIoTCloud
22

33
This library allows to connect to the Arduino IoT Cloud service. It provides a ConnectionManager to handle connection/disconnection, property-change updates and events callbacks.
4-
The supported boards are MKRGSM, MKR1000 (Wifi101) and MKR 1010 (WifiNINA).
4+
The supported boards are MKRGSM, MKR1000 (WiFi101) and MKR 1010 (WiFiNINA).
55

66
## Arduino IoT Cloud
77

8-
[Arduino IoT Cloud](https://create.arduino.cc/iot/things) is a service which allows connecting the cloud to the world around you. [Here](https://www.arduino.cc/en/IoT/HomePage) an introduction.
9-
Now the platform is in public beta, feedbacks are welcome.
8+
[Arduino IoT Cloud](https://create.arduino.cc/iot/things) is a service which allows connecting the cloud to the world around you. [Here](https://www.arduino.cc/en/IoT/HomePage) is an introduction.
9+
Now the platform is in public beta, feedback is welcome.
1010

1111

1212
### Arduino IoT Cloud Components
1313

14-
- **Devices**: Physical objects like a hardware board (e.g. MKR WiFi 1010). This is the hardware which runs the software, read sensors, controls actuators and comunicates with the Arduino IoT Cloud.
14+
- **Devices**: Physical objects like a hardware board (e.g. MKR WiFi 1010). This is the hardware which runs the software, reads sensors, controls actuators and communicates with the Arduino IoT Cloud.
1515

1616
- **Things**: Logical representation of a connected object. They represent the inherent properties of the object, with as little reference to the actual hardware used to implement them. Each thing is represented by a collection of properties (e.g., temperature, light).
1717

1818
- **Properties**: Qualities defining the characteristics of a system. A property can be something like a read-only (RO) setting to indicate the Arduino IoT Cloud can read the data, but cannot change the value of the property. A property might be designed as read and write (RW) if the Arduino IoT Cloud can also remotely change the property’s value and send an event notification to the device.
1919

20-
- **Events**: When something happens the Arduino IoT Cloud is aware of it thanks to application messages. For example, it might be informed by a face-recognition application that someone is at a door, or it has received a request from another app that a light be turned on.
20+
- **Events**: When something happens the Arduino IoT Cloud is aware of it thanks to application messages. For example, it might be informed by a face-recognition application that someone is at a door, or it has received a request from another app that a light be turned on.
2121

22-
- **Software**: It's quickly autogenerated automatically by the Arduino IoT Cloud when setting up a new thing: in this way everything that you need it's almost done and ready. The connection to the cloud it's already made possible by this library. You have only to implement the callbacks linked to the properties.
22+
- **Software**: It's quickly autogenerated automatically by the Arduino IoT Cloud when setting up a new thing: in this way, almost everything that you need is done and ready. The connection to the cloud is handled by this library. You have only to implement the callbacks linked to the properties.
2323

2424
## ArduinoIoTCloud library
2525

26-
The library is divided in 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.
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.
2828

29-
- `ArduinoIoTCloud` it's the leading class. It's responsable for the connection to the MQTT Broker.
29+
- `ArduinoIoTCloud` it's the leading class. It's responsible for the connection to the MQTT Broker.
3030

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

3333
### ConnectionManager
3434
[todo]
3535

3636
### ArduinoIoTCloud
3737
[todo]
3838
### CloudSerial
39-
[todo]
39+
[todo]

0 commit comments

Comments
 (0)