Skip to content

Commit 06d108f

Browse files
Merge pull request #568 from arduino/Hannes7eicher/Hardware-Deivces-Section-Review
[MKC-1295] Cloud Re-Work Hardware & Devices Review
2 parents a07de23 + 0d9fc0f commit 06d108f

File tree

5 files changed

+79
-65
lines changed

5 files changed

+79
-65
lines changed

content/arduino-cloud/02.hardware/01.devices/devices.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ tags: [Arduino Cloud, Devices]
55
author: Karl Söderby
66
---
77

8-
The Arduino Cloud supports a range of official and third party boards which are handled in the **"Devices"** tab. Devices are considered the "virtual twin" of your physical boards.
8+
The Arduino Cloud supports a range of official and third-party boards which are handled in the **"Devices"** tab. Devices are considered the "virtual twin" of your physical boards.
99

1010
Currently, the following device types are supported:
1111
- Wi-Fi® with encryption through on-board crypto chip
@@ -17,7 +17,7 @@ Currently, the following device types are supported:
1717

1818
## Configure a Device
1919

20-
Configuring a device in the Arduino Cloud is done through a wizard. There are three main options available:
20+
Configuring a device in the Arduino Cloud is done through an installation wizard. There are three main options available:
2121
- Wi-Fi® board with crypto chip (automatic configuration of API key)
2222
- ESP32/ESP8266 (manual configuration of API key)
2323
- Python, MicroPython, JavaScript (manual configuration of API key)
@@ -32,21 +32,21 @@ Depending on what type of device you choose, the installation wizard will differ
3232

3333
### Official Wi-Fi® Boards
3434

35-
Wi-Fi® devices connect to the Arduino Cloud via a local network, and is suitable for short-range connectivity projects.
35+
Wi-Fi® devices connect to the Arduino Cloud via a local network and are suitable for short-range connectivity projects.
3636

3737
Most Wi-Fi® supported Arduino boards have a crypto chip that enables secure communication. This chip is configured during setup and enables secure communication for the board without having to enter any API keys in the code.
3838

39-
Wi-Fi devices requires you to enter valid credentials for the Wi-Fi network you attempt to connect to. This is done in the Thing configuration.
39+
Wi-Fi devices require you to enter valid credentials for the Wi-Fi network you attempt to connect to. This is done in the Thing configuration.
4040

41-
***Read more and see list of all compatible Wi-Fi® boards in the [Arduino Cloud Wi-Fi documentation](/arduino-cloud/hardware/wifi).***
41+
***Read more and see the list of all compatible Wi-Fi® boards in the [Arduino Cloud Wi-Fi documentation](/arduino-cloud/hardware/wifi).***
4242

4343
### Official LoRaWAN® Boards
4444

45-
LoRaWAN® boards also have crypto chip on board, but connects to the Arduino Cloud through nearby LoRaWAN® gateways. LoRaWAN® devices are designed to use minimal power and transmit over longer ranges, hence the name:
46-
- **LoRa®** - long range technology used for transmission of data using minimal amount of power for long distances.
45+
LoRaWAN® boards also have a crypto chip on board but connect to the Arduino Cloud through nearby LoRaWAN® gateways. LoRaWAN® devices are designed to use minimal power and transmit over longer ranges, hence the name:
46+
- **LoRa®** - long-range technology used for transmission of data using minimal amounts of power for long distances.
4747
- **LoRaWAN®** - a network of gateways connected to the Internet that can receive and send data to LoRa® devices.
4848

49-
***Read more and see list of all compatible LoRa® boards in the [Arduino Cloud LoRaWAN® documentation](/arduino-cloud/hardware/lora).***
49+
***Read more and see the list of all compatible LoRa® boards in the [Arduino Cloud LoRaWAN® documentation](/arduino-cloud/hardware/lora).***
5050

5151
### ESP32 / ESP8266 (Wi-Fi®)
5252

@@ -56,17 +56,17 @@ There are currently two official ESP32 based Arduino boards:
5656
- [Arduino UNO R4 WiFi](https://store.arduino.cc/products/uno-r4-wifi)
5757
- [Arduino Nano ESP32](https://store.arduino.cc/products/nano-esp32)
5858

59-
You can also configure a wide range of third party ESP32/ESP8266 boards.
59+
You can also configure a wide range of third-party ESP32/ESP8266 boards.
6060

61-
***Read more and see list of all compatible ESP32/ESP8266 boards in the [Arduino Cloud ESP32/ESP8266 documentation](/arduino-cloud/hardware/wifi#configure-esp-boards).***
61+
***Read more and see the list of all compatible ESP32/ESP8266 boards in the [Arduino Cloud ESP32/ESP8266 documentation](/arduino-cloud/hardware/wifi#configure-esp-boards).***
6262

6363
### Manual Devices
6464

65-
Manual devices are designed for interfacing with JavaScript, Python & MicroPython, and can for example run on an Raspberry Pi, but also on any . Creating a manual device generates a **[secret key](#secret-key--device-id)** that can together with the **device ID** be used to securely connect to the Arduino Cloud.
65+
Manual devices are designed for interfacing with JavaScript, Python & MicroPython, and can for example run on a Raspberry Pi, but also on any. Creating a manual device generates a **[secret key](#secret-key--device-id)** that can together with the **device ID** be used to securely connect to the Arduino Cloud.
6666

6767
***Note that manual devices do not have a sketch associated.***
6868

69-
Check the guides below for getting started with each of the programming languages:
69+
Check the guides below to get started with each of the programming languages:
7070

7171
- [Connect to Arduino Cloud (JavaScript)](/arduino-cloud/guides/javascript)
7272
- [Connect to Arduino Cloud (Python)](/arduino-cloud/guides/python)
@@ -80,6 +80,8 @@ When configuring ESP32/ESP8266 and Manual Devices, you generate a **Device ID**
8080

8181
Make sure to download or store this information somewhere, as you cannot retrieve the Secret Key after this step.
8282

83+
***If you lose your Secret Key or forget to download and store your information you will need to remove and set up the device again.***
84+
8385
## Device Information
8486

8587
A device's information can be accessed directly in the Arduino Cloud under **"Devices"**. Depending on the type, the information will differ.
@@ -90,14 +92,13 @@ A device's information can be accessed directly in the Arduino Cloud under **"De
9092
- **FQBN** - fully qualified board name, used for compilation for a specific board, e.g. `arduino:samd:mkrwifi1010`.
9193
- **Serial Number** - when configuring an official board, the serial number will be registered.
9294
- **Connectivity Module Firmware** - for Wi-Fi® boards only, the current firmware on the board's radio module.
93-
- **Thing** - Thing associated with device.
95+
- **Thing** - Thing associated with a device.
9496
- **Status** - status of the device, online/offline.
95-
- **Last Activity** - timestamp of last synchronisation.
97+
- **Last Activity** - timestamp of the last synchronization.
9698
- **Added** - timestamp of date device was added to the Arduino Cloud.
9799

98100
## Connection Handler
99101

100-
All hardware devices connecting to the Arduino Cloud uses the following libraries:
102+
All hardware devices connecting to the Arduino Cloud use the following libraries:
101103
- [ArduinoIoTCloud](https://github.com/arduino-libraries/ArduinoIoTCloud) - main library for Arduino Cloud, including methods for sending and receiving data, handling callbacks etc. Either via TCP/IP or LPWAN.
102104
- [Arduino_ConnectionHandler](https://github.com/arduino-libraries/Arduino_ConnectionHandler) - library for handling connection methods to the Arduino Cloud (Wi-Fi®, LoRaWAN®, Ethernet, NB-IoT, GSM).
103-

content/arduino-cloud/02.hardware/02.wifi/wifi.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ tags: [Arduino Cloud, Wi-Fi, ESP32]
55
author: Karl Söderby
66
---
77

8-
A number of official Arduino boards supports connection to the Arduino Cloud via Wi-Fi®. Some boards also have an onboard crypto chip that stores the credentials automatically when configuring the device.
8+
A number of official Arduino boards support a connection to the Arduino Cloud via Wi-Fi®. Some boards also have an onboard crypto chip that stores the credentials automatically when configuring the device.
99

1010
There are currently two ways of configuring a Wi-Fi® board:
11-
- By configuring an onboard crypto chip (available for a number of official Arduino boards only),
12-
- through a Secret Key / API key (ESP32/ESP8266 based boards\*)
11+
- By configuring an onboard crypto chip (available for a number of official Arduino boards only).
12+
- Through a Secret Key / API key (ESP32/ESP8266 based boards\*).
1313

14-
***\*Note that the [UNO R4 WiFi](https://store.arduino.cc/products/uno-r4-wifi) and [Nano ESP32](https://store.arduino.cc/products/nano-esp32) boards uses this method.***
14+
***\*Note that the [UNO R4 WiFi](https://store.arduino.cc/products/uno-r4-wifi) and [Nano ESP32](https://store.arduino.cc/products/nano-esp32) boards use this method.***
1515

1616
## Supported Boards
1717

@@ -31,33 +31,33 @@ The following boards connect to the Arduino Cloud via Wi-Fi®, using the onboard
3131
- [Portenta H7 Lite Connected](https://store.arduino.cc/products/portenta-h7-lite-connected)
3232
- [Portenta Machine Control](https://store.arduino.cc/products/arduino-portenta-machine-control)
3333
- [Nicla Vision](https://store.arduino.cc/products/nicla-vision)
34-
- [Opta](https://docs.arduino.cc/hardware/opta).
34+
- [Opta](https://store.arduino.cc/products/opta-wifi)
3535

3636
### Setup a Wi-Fi® Board
3737

3838
To configure a Wi-Fi® board in the Arduino Cloud, follow the steps below:
3939

4040
**1.** Connect your board to your computer.
4141

42-
**2.** Go to [Arduino Cloud](app.arduino.cc), and navigate to the **"Devices"** section. Click on the **"Add Device"** button and then select the **"Arduino Board"**. After a while, your board will be visible, and you can click on the **"Configure"** button.
42+
**2.** Go to [Arduino Cloud](https://app.arduino.cc), and navigate to the **"Devices"** section. Click on the **"Add Device"** button and then select the **"Arduino Board"**. After a while, your board will be visible, and you can click on the **"Configure"** button.
4343

4444
![Board show up.](assets/wifi.png)
4545

46-
**3.** Allow some time for the configuration, as a sketch is being uploaded to your board as well as a configuration of your crypto chip is ongoing.
46+
**3.** Allow some time for the configuration, as a sketch is being uploaded to your board and your crypto chip is configured.
4747

48-
Your board is now configured and ready to be used in the Arduino Cloud.
48+
Once done, your board is configured and ready to be used in the Arduino Cloud.
4949

5050
After setting up a device, you can check out the official [Getting Started (Arduino / C++)](/arduino-cloud/guides/arduino-c) guide. This will guide you to successfully send data between your board and Arduino Cloud.
5151

5252
## Configure ESP Boards
5353

5454
ESP32 / ESP8266 based boards connect to the Arduino Cloud via a **secret key**, generated during device configuration.
5555

56-
There is a large number of ESP32/ESP8266 supported boards, which you select from a drop down menu.
56+
There is a large number of ESP32/ESP8266 supported boards, which you select from a drop-down menu.
5757

5858
![Range of ESP32 boards.](assets/esp32-supported-boards.png)
5959

60-
***If you do not find your board in the list, you can select also select the ESP32 model (e.g. `ESP32S3 Dev Module`).***
60+
***If you don't find your board in the list, just select the ESP32 model (e.g. `ESP32S3 Dev Module`).***
6161

6262
The following official boards have an ESP32 as main/co-processor and connect using a secret key as well.
6363

@@ -70,11 +70,13 @@ To configure an ESP32 board in the Arduino Cloud, follow the steps below:
7070

7171
**1.** Connect your board to your computer.
7272

73-
**2.** Go to [Arduino Cloud](app.arduino.cc), and navigate to the **"Devices"** section. Click on the **"Add Device"** button and then select the **"Third Party Board"**.
73+
**2.** Go to [Arduino Cloud](https://app.arduino.cc), and navigate to the **"Devices"** section. Click on the **"Add Device"** button and then select the **"Third Party Board"**.
7474

7575
![Select "Third Party Device"](assets/esp32.png)
7676

77-
**3.** Select your board type, and give your board a name. When finished, you will generate a **secrey key** and **device ID**. You can download or manually store your credentials somewhere, but the secret key can **not be retrieved** after you close the window.
77+
**3.** Select your board type, and give your board a name. When finished, you will generate a **secret key** and **device ID**. You can download or manually store your credentials somewhere, but the secret key can **not be retrieved** after you close the window.
78+
79+
***If you lose your Secret Key or forget to download and store your information you will need to remove and set up the device again.***
7880

7981
![Secret / Device Key.](assets/device-key.png)
8082

@@ -101,4 +103,4 @@ The following ESP32 boards have been tested and verified to support OTA:
101103

102104
## Supported Frequencies
103105

104-
All official Arduino boards currently only supports the 2.4GHz frequency band for transmitting data.
106+
All official Arduino boards currently only support the 2.4GHz frequency band for transmitting data.

0 commit comments

Comments
 (0)