Skip to content

Commit 783ddf4

Browse files
pennampennam
authored
Merge pull request #332 from per1234/fix-spell-check
Fix spell check failures and typos
2 parents 5b2ae62 + 292e1b1 commit 783ddf4

File tree

19 files changed

+40
-40
lines changed

19 files changed

+40
-40
lines changed

‎.codespellrc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# See: https://github.com/codespell-project/codespell#using-a-config-file
22
[codespell]
33
# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
4-
ignore-words-list = alocation,wan
4+
ignore-words-list = alocation,bu,wan
55
check-filenames =
66
check-hidden =
7-
skip = ./.git,./extras/test/external,./src/cbor/lib/tinycbor
7+
skip = ./.git,./extras/test/external,./src/cbor/lib/tinycbor,./src/tls/bearssl

‎README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ void onLedChange() {
6969

7070
### FAQ
7171
#### Watchdog
72-
This [1.0.0](https://github.com/arduino-libraries/ArduinoIoTCloud/releases/tag/1.0.0) release of this library adds watchdog functionality to all ATSAMD21G18 based cloud connected boards. A watchdog is simply an electronic timer counting down from a preset start value which, upon reaching zero, triggers a reset of the microcontroller. It can be used to automatically recover from temporary hardware faults or unrecoverable software errors. In order to avoid the watchdog from reaching zero the countdown timer needs to be regularly re-set to its start value. This is happening within `ArduinoCloud.update()` which is periodically called at the start of the `loop()` function. Although the watchdog is automatically enabled it can be disabled by setting the second parameter of `ArduinoCloud.begin(...)` to `false`:
72+
The [1.0.0](https://github.com/arduino-libraries/ArduinoIoTCloud/releases/tag/1.0.0) release of this library adds watchdog functionality to all ATSAMD21G18 based cloud connected boards. A watchdog is simply an electronic timer counting down from a preset start value which, upon reaching zero, triggers a reset of the microcontroller. It can be used to automatically recover from temporary hardware faults or unrecoverable software errors. In order to avoid the watchdog from reaching zero the countdown timer needs to be regularly re-set to its start value. This is happening within `ArduinoCloud.update()` which is periodically called at the start of the `loop()` function. Although the watchdog is automatically enabled it can be disabled by setting the second parameter of `ArduinoCloud.begin(...)` to `false`:
7373
```C++
7474
ArduinoCloud.begin(ArduinoIoTPreferredConnection, false).
7575
```
@@ -78,14 +78,14 @@ ArduinoCloud.begin(ArduinoIoTPreferredConnection, false).
7878
```
7979
ArduinoIoTCloudTCP::handle_SubscribeMqttTopics could not subscribe to /a/t/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/e/i
8080
```
81-
In this case either the device has not been associated with the thing within the Arduino IoT Cloud GUI configuration or there's a typo in the thing id.
81+
In this case either the device has not been associated with the thing within the Arduino IoT Cloud GUI configuration or there's a typo in the thing ID.
8282

8383
#### OTA
8484
OTA is supported by the following boards:
8585
[`MKR WiFi 1010`](https://store.arduino.cc/arduino-mkr-wifi-1010), [`Nano 33 IoT`](https://store.arduino.cc/arduino-nano-33-iot), [`Portenta H7`](https://store.arduino.cc/portenta-h7), [`Nano RP2040 Connect`](https://store.arduino.cc/products/arduino-nano-rp2040-connect), [`Nicla Vision`](https://store.arduino.cc/products/nicla-vision)
8686

8787
#### ESP Boards
88-
Support for ESP boards is obtained through third-party core with some differences and limitations compared to Arduino boards.
88+
Support for ESP boards is obtained through a third-party core with some differences and limitations compared to Arduino boards.
8989

9090
- **Authentication scheme**: Board authentication is done through `DEVICE_LOGIN_NAME` and `DEVICE_KEY`, both values are included in the `thingProperties.h` file.
9191
- **RTC**: RTC support is not included thus each `ArduinoCould.update()` call will lead to an NTP request introducing delay in your `loop()` function. The scheduler widget will not work correctly if connection is lost after configuration.

‎examples/ArduinoIoTCloud-Advanced/ArduinoIoTCloud-Advanced.ino

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
44
This sketch is compatible with:
55
- MKR 1000
6-
- MKR WIFI 1010
6+
- MKR WiFi 1010
77
- MKR GSM 1400
88
- MKR NB 1500
99
- MKR WAN 1300/1310
1010
- Nano 33 IoT
11-
- ESP 8266
11+
- ESP8266
1212
*/
1313

1414
#include "arduino_secrets.h"

‎examples/ArduinoIoTCloud-Basic/ArduinoIoTCloud-Basic.ino

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,17 @@
77
88
IMPORTANT:
99
This sketch works with WiFi, GSM, NB and Lora enabled boards supported by Arduino IoT Cloud.
10-
On a LoRa board, if it is configuered as a class A device (default and preferred option), values from Cloud dashboard are received
10+
On a LoRa board, if it is configured as a class A device (default and preferred option), values from Cloud dashboard are received
1111
only after a value is sent to Cloud.
1212
1313
This sketch is compatible with:
1414
- MKR 1000
15-
- MKR WIFI 1010
15+
- MKR WiFi 1010
1616
- MKR GSM 1400
1717
- MKR NB 1500
1818
- MKR WAN 1300/1310
1919
- Nano 33 IoT
20-
- ESP 8266
20+
- ESP8266
2121
*/
2222

2323
#include "arduino_secrets.h"

‎examples/ArduinoIoTCloud-Callbacks/ArduinoIoTCloud-Callbacks.ino

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,17 @@
1919
2020
IMPORTANT:
2121
This sketch works with WiFi, GSM, NB and Lora enabled boards supported by Arduino IoT Cloud.
22-
On a LoRa board, if it is configuered as a class A device (default and preferred option), values from Cloud dashboard are received
22+
On a LoRa board, if it is configured as a class A device (default and preferred option), values from Cloud dashboard are received
2323
only after a value is sent to Cloud.
2424
2525
This sketch is compatible with:
2626
- MKR 1000
27-
- MKR WIFI 1010
27+
- MKR WiFi 1010
2828
- MKR GSM 1400
2929
- MKR NB 1500
3030
- MKR WAN 1300/1310
3131
- Nano 33 IoT
32-
- ESP 8266
32+
- ESP8266
3333
*/
3434

3535
#include "arduino_secrets.h"

‎examples/ArduinoIoTCloud-DeferredOTA/ArduinoIoTCloud-DeferredOTA.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
* ask_user_via_serial callback will read user input from serial to apply or postpone OTA update
1111
1212
This sketch is compatible with:
13-
- MKR WIFI 1010
13+
- MKR WiFi 1010
1414
- Nano 33 IoT
1515
- Portenta
1616
- Nano RP2040

‎examples/ArduinoIoTCloud-Schedule/ArduinoIoTCloud-Schedule.ino

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
44
This sketch is compatible with the following boards:
55
- MKR 1000
6-
- MKR WIFI 1010
6+
- MKR WiFi 1010
77
- MKR GSM 1400
88
- MKR NB 1500
99
- Nano 33 IoT
10-
- ESP 8266
10+
- ESP8266
1111
*/
1212

1313
#include "arduino_secrets.h"

‎examples/utility/ArduinoIoTCloud_Travis_CI/ArduinoIoTCloud_Travis_CI.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/*
22
This sketch is used in combination with Travis CI to check if
3-
unintentional breaking changes are made to the used facing
3+
unintentional breaking changes are made to the user facing
44
Arduino IoT Cloud API.
55
66
This sketch is compatible with:

‎examples/utility/Provisioning/Provisioning.ino

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ void setup() {
5151
while (1);
5252
}
5353

54-
String deviceId = promptAndReadLine("Please enter the device id: ");
54+
String deviceId = promptAndReadLine("Please enter the device ID: ");
5555
Certificate.setSubjectCommonName(deviceId);
5656

5757
if (!Crypto.buildCSR(Certificate, CryptoSlot::Key, true)) {
@@ -88,7 +88,7 @@ void setup() {
8888
hexStringToBytes(signature, signatureBytes, sizeof(signatureBytes));
8989

9090
if (!Crypto.writeDeviceId(deviceId, CryptoSlot::DeviceId)) {
91-
Serial.println("Error storing device id!");
91+
Serial.println("Error storing device ID!");
9292
while (1);
9393
}
9494

‎extras/test/src/test_CloudLocation.cpp

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
TEST CODE
1515
**************************************************************************************/
1616

17-
SCENARIO("Tesing cloud type 'Location' Ctor", "[Location::Location]")
17+
SCENARIO("Testing cloud type 'Location' Ctor", "[Location::Location]")
1818
{
1919
WHEN("A Location(1.0f, 2.0f) is being instantiated")
2020
{
@@ -30,7 +30,7 @@ SCENARIO("Tesing cloud type 'Location' Ctor", "[Location::Location]")
3030

3131
/**************************************************************************************/
3232

33-
SCENARIO("Tesing cloud type 'Location' assignment operator", "[Location::operator =]")
33+
SCENARIO("Testing cloud type 'Location' assignment operator", "[Location::operator =]")
3434
{
3535
Location loc1(1.0f, 2.0f),
3636
loc2(3.0f, 4.0f);
@@ -47,7 +47,7 @@ SCENARIO("Tesing cloud type 'Location' assignment operator", "[Location::operato
4747

4848
/**************************************************************************************/
4949

50-
SCENARIO("Tesing cloud type 'Location' operator -", "[Location::operator -]")
50+
SCENARIO("Testing cloud type 'Location' operator -", "[Location::operator -]")
5151
{
5252
Location loc1(1.0f, 2.0f),
5353
loc2(3.0f, 4.0f);
@@ -64,7 +64,7 @@ SCENARIO("Tesing cloud type 'Location' operator -", "[Location::operator -]")
6464

6565
/**************************************************************************************/
6666

67-
SCENARIO("Tesing cloud type 'Location' comparison operator ==", "[Location::operator ==]")
67+
SCENARIO("Testing cloud type 'Location' comparison operator ==", "[Location::operator ==]")
6868
{
6969
Location loc1(1.0f, 2.0f),
7070
loc2(3.0f, 4.0f),
@@ -87,7 +87,7 @@ SCENARIO("Tesing cloud type 'Location' comparison operator ==", "[Location::oper
8787

8888
/**************************************************************************************/
8989

90-
SCENARIO("Tesing cloud type 'Location' comparison operator !=", "[Location::operator !=]")
90+
SCENARIO("Testing cloud type 'Location' comparison operator !=", "[Location::operator !=]")
9191
{
9292
Location loc1(1.0f, 2.0f),
9393
loc2(3.0f, 4.0f),
@@ -110,7 +110,7 @@ SCENARIO("Tesing cloud type 'Location' comparison operator !=", "[Location::oper
110110

111111
/**************************************************************************************/
112112

113-
SCENARIO("Tesing cloud type 'Location' function distance for calculating euclidean 2d distance between two points", "[Location::distance]")
113+
SCENARIO("Testing cloud type 'Location' function distance for calculating Euclidean 2d distance between two points", "[Location::distance]")
114114
{
115115
Location loc1(0.0f, 0.0f),
116116
loc2(1.0f, 1.0f);

‎extras/test/src/test_CloudSchedule.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ unsigned long TimeService::getLocalTime() {return time_now;}
2828
TEST CODE
2929
**************************************************************************************/
3030

31-
SCENARIO("Tesing cloud type 'Schedule' Ctor", "[Schedule::Schedule]")
31+
SCENARIO("Testing cloud type 'Schedule' Ctor", "[Schedule::Schedule]")
3232
{
3333
WHEN("A Schedule(0,0,0,0) is being instantiated")
3434
{

‎extras/test/src/test_publishOnChange.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
TEST CODE
1515
**************************************************************************************/
1616

17-
SCENARIO("A Arduino cloud property is published on value change", "[ArduinoCloudThing::publishOnChange]")
17+
SCENARIO("An Arduino cloud property is published on value change", "[ArduinoCloudThing::publishOnChange]")
1818
{
1919
PropertyContainer property_container;
2020

‎extras/test/src/test_publishOnChangeRateLimit.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
TEST CODE
1515
**************************************************************************************/
1616

17-
SCENARIO("A Arduino cloud property is published on value change but the update rate is limited", "[ArduinoCloudThing::publishOnChange]")
17+
SCENARIO("An Arduino cloud property is published on value change but the update rate is limited", "[ArduinoCloudThing::publishOnChange]")
1818
{
1919
PropertyContainer property_container;
2020

‎extras/test/src/test_readOnly.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
TEST CODE
1818
**************************************************************************************/
1919

20-
SCENARIO("A Arduino cloud property is marked 'read only'", "[ArduinoCloudThing::decode]")
20+
SCENARIO("An Arduino cloud property is marked 'read only'", "[ArduinoCloudThing::decode]")
2121
{
2222
PropertyContainer property_container;
2323

‎extras/test/src/test_writeOnly.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
TEST CODE
1818
**************************************************************************************/
1919

20-
SCENARIO("A Arduino cloud property is marked 'write only'", "[ArduinoCloudThing::encode]")
20+
SCENARIO("An Arduino cloud property is marked 'write only'", "[ArduinoCloudThing::encode]")
2121
{
2222
PropertyContainer property_container;
2323

‎library.properties

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ name=ArduinoIoTCloud
22
version=1.7.0
33
author=Arduino
44
maintainer=Arduino <[email protected]>
5-
sentence=This library allows to connect to the Arduino IoT Cloud service.
6-
paragraph=It provides a ConnectionManager to handle connection/disconnection, property-change updates and events callbacks. The supported boards are MKRGSM, MKR1000 and WiFi101.
5+
sentence=This library allows connecting to the Arduino IoT Cloud service.
6+
paragraph=It provides a ConnectionManager to handle connection/disconnection, property-change updates and events callbacks. The supported boards are MKR GSM, MKR1000 and WiFi101.
77
category=Communication
88
url=https://github.com/arduino-libraries/ArduinoIoTCloud
99
architectures=mbed,samd,esp8266,mbed_nano,mbed_portenta,mbed_nicla,esp32

‎src/ArduinoIoTCloudTCP.cpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -344,8 +344,8 @@ void ArduinoIoTCloudTCP::update()
344344
}
345345
_state = next_state;
346346

347-
/* This watchdog feed is actually needed only by the RP2040 CONNECT cause its
348-
* maximum watchdog window is 8389ms; despite this we feed it for all
347+
/* This watchdog feed is actually needed only by the RP2040 Connect because its
348+
* maximum watchdog window is 8389 ms; despite this we feed it for all
349349
* supported ARCH to keep code aligned.
350350
*/
351351
#if defined (ARDUINO_ARCH_SAMD) || defined (ARDUINO_ARCH_MBED)
@@ -488,7 +488,7 @@ ArduinoIoTCloudTCP::State ArduinoIoTCloudTCP::handle_CheckDeviceConfig()
488488

489489
if(_deviceSubscribedToThing == true)
490490
{
491-
/* Unsubscribe from old things topics and go on with a new subsctiption */
491+
/* Unsubscribe from old things topics and go on with a new subscription */
492492
_mqttClient.unsubscribe(_shadowTopicIn);
493493
_mqttClient.unsubscribe(_dataTopicIn);
494494
_deviceSubscribedToThing = false;
@@ -570,7 +570,7 @@ ArduinoIoTCloudTCP::State ArduinoIoTCloudTCP::handle_SubscribeThingTopics()
570570
execCloudEventCallback(ArduinoIoTCloudEvent::CONNECT);
571571
_deviceSubscribedToThing = true;
572572

573-
/*Add retry wait time otherwise we are trying to reconnect every 250ms...*/
573+
/*Add retry wait time otherwise we are trying to reconnect every 250 ms...*/
574574
return State::RequestLastValues;
575575
}
576576

‎src/cbor/CBOREncoder.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ CBOREncoder::EncoderState CBOREncoder::handle_OutOfMemory(PropertyContainerEncod
138138
CBOREncoder::EncoderState CBOREncoder::handle_SkipProperty(PropertyContainerEncoder & propertyEncoder)
139139
{
140140
/* Better to skip this property otherwise we will stay blocked here. This happens only with a message property
141-
* that not fits into the CBOR buffer
141+
* that doesn't fit into the CBOR buffer
142142
*/
143143
propertyEncoder.current_property_index++;
144144
if(propertyEncoder.current_property_index >= propertyEncoder.property_container.size())
@@ -182,7 +182,7 @@ CBOREncoder::EncoderState CBOREncoder::handle_FinishAppend(PropertyContainerEnco
182182
/* Restore property message limit to CBOR_ENCODER_NO_PROPERTIES_LIMIT */
183183
propertyEncoder.property_limit_active = false;
184184

185-
/* The append process has been successful, so we don't need to terty to send this properties set. Cleanup _has_been_appended_but_not_sended flag */
185+
/* The append process has been successful, so we don't need to try to send this properties set. Cleanup _has_been_appended_but_not_sended flag */
186186
PropertyContainer::iterator iter = propertyEncoder.property_container.begin();
187187
std::advance(iter, propertyEncoder.current_property_index);
188188
int num_appended_properties = 0;
@@ -197,7 +197,7 @@ CBOREncoder::EncoderState CBOREncoder::handle_FinishAppend(PropertyContainerEnco
197197
num_appended_properties++;
198198
}
199199

200-
/* Advance property index for the nex message */
200+
/* Advance property index for the next message */
201201
propertyEncoder.current_property_index += propertyEncoder.checked_property_count;
202202

203203
if(propertyEncoder.current_property_index >= propertyEncoder.property_container.size())

‎src/utility/ota/OTA-samd.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ int samd_onOTARequest(char const * ota_url)
4747

4848
watchdog_reset();
4949

50-
/* Trigger direct download to nina module. */
50+
/* Trigger direct download to NINA module. */
5151
uint8_t nina_ota_err_code = 0;
5252
if (!WiFiStorage.downloadOTA(ota_url, &nina_ota_err_code))
5353
{

0 commit comments

Comments
 (0)