Skip to content

[PXCT-1221] Cloud - Updated information about network credentials #2574

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
4 changes: 3 additions & 1 deletion content/arduino-cloud/01.guides/00.overview/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,10 +92,12 @@ The configurations varies between boards, but everything is covered in the insta

### 3. Create a Thing

After configuring a device, we can create a Thing, which is the **virtual twin** of your board. Here we configure network details, select device we want to associate and create the variables that we want to synchronize.
After configuring a device, we can create a Thing, which is the **virtual twin** of your board. Here we can select the device to associate and create the variables that we want to synchronize with.

![Things in the Arduino Cloud.](assets/thing.png)

To configure network details go to the [devices page](https://app.arduino.cc/devices), select your device and set the network credentials.

Variables we create will be used in the sketch, and will keep synchronizing as long as the board is connected to the Cloud.

When working with your IoT projects, consider this the "main space" for configurations, as you can access your sketches from here as well.
Expand Down
8 changes: 5 additions & 3 deletions content/arduino-cloud/01.guides/02.arduino-c/arduino-c.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The default option for programming your board to connect to the Arduino Cloud is
Whenever you create a [Thing](/arduino-cloud/cloud-interface/things) in the Arduino Cloud, you automatically start generating a set of files that will handle the configurations, credentials & connection:
- `<sketchname>.ino` - your main sketch file,
- `thingProperties.h` - your main configuration file,
- `arduino_secrets.h` - your credentials file (for API key, Wi-Fi network etc.)
- `arduino_secrets.h` - your credentials file (for API key, Wi-Fi network etc.), if the board is using provisioning version 1.0. If the board is using version 2.0 the credentials are stored on the board. To find out more about this read [here](https://docs.arduino.cc/arduino-cloud/hardware/device-provisioning/).

***If you want to find out more about what the Arduino Cloud service can do, go to the [overview](/arduino-cloud/guides/overview) section.***

Expand Down Expand Up @@ -47,8 +47,10 @@ Next, navigate to the **Things** tab. Here you will see a list of your Things, a
A "Thing" is a virtual twin of your hardware, and it is here that we create variables that we want to synchronize between the Cloud and board. Any changes we make here will be reflected in an [automatically generated sketch](/arduino-cloud/cloud-interface/sketches#iot-sketches).

1. First, let's attach the device we want to use, by clicking the **"Select Device"** button in the **"Associated Devices"** section to the right.
2. let's create a new variable, call it `test`, and select it to be a `boolean` type and with a **read/write** permission.
3. finally, configure your network in the **Network** section. Here you will enter your Wi-Fi® credentials, and if you are using an ESP32 based board, you need to enter the secret key here.
2. Let's create a new variable, call it `test`, and select it to be a `boolean` type and with a **read/write** permission.

3. Finally, configure your network in the **Network** section on the device page. Here you will enter your Wi-Fi® credentials, and if you are using an ESP32 based board, you need to enter the secret key here.


![Enter network credentials.](assets/esp32-only.png)

Expand Down
6 changes: 4 additions & 2 deletions content/arduino-cloud/01.guides/03.esp32/esp32.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,10 @@ Next, navigate to the **Things** tab. Here you will see a list of your Things, a
A "Thing" is a virtual twin of your hardware, and it is here that we create variables that we want to synchronize between the Cloud and board. Any changes we make here will be reflected in an [automatically generated sketch](/arduino-cloud/cloud-interface/sketches#iot-sketches).

1. First, let's attach the device we want to use, by clicking the **"Select Device"** button in the **"Associated Devices"** section to the right.
2. let's create a new variable, call it `test`, and select it to be a `boolean` type and with a **read/write** permission.
3. finally, configure your network in the **Network** section. Here you will enter your Wi-Fi® credentials, and your **Secret Key**, obtained when configuring your device.
2. Let's create a new variable, call it `test`, and select it to be a `boolean` type and with a **read/write** permission.

3. Finally, configure your network in the **Network** section on the device page. Here you will enter your Wi-Fi® credentials, and your **Secret Key**, obtained when configuring your device.


![Enter network credentials.](assets/esp32-only.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ The Thing we will create for this example is quite simple. It is a sketch to rea
Follow the steps below to set up the Thing:

- Go to the Arduino Cloud -> Thing -> Create a Thing
- Add your Device and your Network credentials
- Add your Device and your Network credentials, which can be changed on the device page
- Add an integer Variable, with the name humidity, and set permissions to Read Only
- Go to the **"Sketch"** tab and replace the code with the code below:

Expand Down
2 changes: 1 addition & 1 deletion content/arduino-cloud/02.hardware/01.devices/devices.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Wi-Fi® devices connect to the Arduino Cloud via a local network and are suitabl

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.

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.
Wi-Fi devices require you to enter valid credentials for the Wi-Fi network you attempt to connect to. This is done in the Device configuration.

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ The file cannot be edited in the Arduino Cloud as it is in sync with the platfor

### Secret File

The "Secret" File contains your secret credentials, such as Wi-Fi® network SSID/PASS or device secret key.
The "Secret" File contains your secret credentials, such as Wi-Fi® network SSID/PASS or device secret key, if the board is using provisioning version 1.0. If the board is using version 2.0 the credentials are stored on the board. To find out more about this read [here](https://docs.arduino.cc/arduino-cloud/hardware/device-provisioning/).

This file will be visible as a "Secret" tab in the Cloud Editor and is named `arduino_secrets.h`, which is not visible on the Cloud platform.

Expand Down
13 changes: 6 additions & 7 deletions content/arduino-cloud/03.cloud-interface/01.things/things.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,8 @@ author: Karl Söderby
The communication between IoT devices and the Arduino Cloud is handled through something called **Things**. Things are a virtual twin of your hardware/setup, where you perform a lot of the configurations for your projects.

In the Thing interface you can:
- Create Cloud variables that can be synced across devices,
- select the main device you want to associate with,
- enter network credentials (such as Wi-Fi network/password),
- create Cloud variables that can be synced across devices,
- select the main device you want to associate with
- edit & upload sketches to your board,
- set webhooks that trigger whenever data changes,
- edit the timezone.
Expand All @@ -23,7 +22,7 @@ The Thing interface is designed for ease-of-use and only has a few sections, whi

- **1. Cloud Variables** - create variables that synchronize between a device and the Arduino Cloud.
- **2. Devices** - configure a device that will be associated with your Thing.
- **3. Network** - network credentials, e.g. Wi-Fi® network/password.
- **3. Network** - to add your Wi-Fi® network/password go to Device page.
- **4. Setup** - the main configuration space tab.
- **5. Sketch** - access the sketch associated with your Thing.
- **6. Metadata** - metadata such as tags, timezone and Thing ID.
Expand Down Expand Up @@ -68,12 +67,12 @@ The status of your device is also displayed in this section (online/offline).

## Network

***This option has been moved to the [Devices](/arduino-cloud/hardware/devices) section on the specific device page.***

In the network section, you configure the credentials for your network, such as your Wi-Fi® network, secret key (for ESP32 boards) and other credentials e.g. LoRa®-based networks & cellular. The network details are securely stored.

![Network configuration.](assets/network-creds.png)

The credentials entered are automatically included in your sketch (see [automatic sketch generation](#automatic-sketch-generation)).

## Sketch

The sketch tab will open the Cloud Editor where you can edit, compile and upload sketches to your devices.
Expand Down Expand Up @@ -128,7 +127,7 @@ For example:
- Associating a Wi-Fi board will automatically update the connection method.
- Creating a variable will add it to your `thingProperties.h` file.
- Creating a variable with **read/write** permission will also add a callback function at the bottom of your sketch. This will trigger any time the value changes.
- Changing your network credentials will update the `arduino_secrets.h` file.
- Changing your network credentials will update the `arduino_secrets.h` file, if you are using provisioning version 1.0, for more information read [here](https://docs.arduino.cc/arduino-cloud/hardware/device-provisioning/).

This is implemented so that the connection and synchronization between the board and Cloud is handled automatically, meaning you do not need to do any networking code when using the Arduino / C++ language.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ In order for our job to go off at the right time, we need to set the **time zone

### Network Credentials

To connect your device to the Arduino Cloud, you need to enter your network credentials in the "network" section.
To connect your device to the Arduino Cloud, you need to enter your network credentials in the "network" section on the device page.

***Note that this only applies to Wi-Fi enabled boards.***

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Linking a webhook to a Thing is a quite simple process, follow the steps below t

![Create Variable](./assets/webhooks-01.png)

**4.** Add your **Device**, and configure your **Network** from the right side menu.
**4.** Add your **Device**, and configure your **Network**.

**5.** In the same menu to the right, click "**Configure**" under the "**Data Forwarding (Webhook)**" menu.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ arduino-cloud-cli device delete-tags --id <deviceID> --keys <key0>,<key1>

- `arduino-cloud-cli things`

**Things** in the Arduino Cloud is the virtual twin of your hardware device. In a Thing, you create variables, attach device and add network credentials.
**Things** in the Arduino Cloud is the virtual twin of your hardware device. In a Thing, you create variables and attach a device.

With `arduino-cloud-cli` you can:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ To configure a device, navigate to the [app.arduino.cc/devices](https://app.ardu

1. Create a new Thing, by clicking on the **"Create Thing"** button.
2. Click on the **"Select Device"** in the **"Associated Devices"** section of your Thing. Your previously configured device will appear from the list.
3. In the network section, enter your network credentials.
3. If you want to change the network credentials go to the [device page](https://app.arduino.cc/devices).

***Learn more about Things in the [Things documentation](/arduino-cloud/cloud-interface/things).***

Expand Down
Empty file.
Loading