Skip to content

Commit 81300b4

Browse files
authored
Merge pull request #567 from arduino/jacobhylen/cloud-docs-changes
Cloudv2 Guides docs review
2 parents 6a94205 + 6df1c22 commit 81300b4

File tree

5 files changed

+33
-20
lines changed

5 files changed

+33
-20
lines changed

content/arduino-cloud/01.guides/00.overview/overview.md

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

8-
The [Arduino Cloud](app.arduino.cc) is a platform for developing Arduino projects and connecting them to the world. It supports secure connections with boards via [Wi-Fi®](/arduino-cloud/hardware/wifi), [LoRa®](/arduino-cloud/hardware/lora), [Ethernet](/arduino-cloud/hardware/ethernet) and [Cellular (GSM/NB-IoT)](/arduino-cloud/hardware/cellular).
8+
The [Arduino Cloud](app.arduino.cc) is a platform for developing Arduino projects and connecting them to the world. It supports secure connections with boards via [Wi-Fi®](/arduino-cloud/hardware/wifi), [LoRa®](/arduino-cloud/hardware/lora), [Ethernet](/arduino-cloud/hardware/ethernet) and [Cellular (GSM/NB-IoT)](/arduino-cloud/hardware/cellular), and lets you create a system for sending any variable information you can think of from one board to another within minutes of unboxing them.
99

1010
The Arduino Cloud platform includes:
1111
- an **Integrated Development Environment (IDE)** for programming your boards,
@@ -16,7 +16,11 @@ The Arduino Cloud platform includes:
1616
Very simply explained, with the Arduino Cloud you can:
1717
1. Create a program for an Arduino based on a brilliant idea you just hatched.
1818
2. Upload the program to your board and synchronize any data you want to (most commonly through Wi-Fi®).
19-
3. Create a dashboard with a set of widgets to control and monitor your board.
19+
3. Create a dashboard with a set of widgets to control and monitor your data.
20+
21+
Developing a sketch made for the Arduino Cloud is almost just like developing any other sketch. You have your setup, and loop just like normal. But you are also able to select variables to be automatically synced to the Arduino Cloud.
22+
23+
Once a variable is synced to the Arduino Cloud you can access it from any of your other devices connected to the Arduino Cloud.
2024

2125
Once you have setup your project, this is how you could interact & monitor it.
2226

@@ -64,7 +68,7 @@ Anything in the Arduino Cloud can be accessed via the left action bar. In the li
6468
- **Templates** - templates are ready-made project that will automatically configure your device, Thing,
6569
- **Integrations** - third party services that are integrated with the Arduino Cloud.
6670

67-
## Get Started with Arduino Cloud
71+
## A Walkthrough the Arduino Cloud
6872

6973
Setting up a project in the Arduino Cloud is easy, and can be done through a few simple steps summarized in this section.
7074

@@ -78,7 +82,7 @@ By default, you will have a **free plan**, which can be upgraded to a number of
7882

7983
### 2. Configure a Device
8084

81-
First you will need to connect your board to your computer, and configure your device at [app.arduino.cc/devices](app.arduino.cc/devices).
85+
First you will need to connect your board to your computer, and configure your device in the [Devices](app.arduino.cc/devices) tab.
8286

8387
![Devices in the Arduino Cloud.](assets/device.png)
8488

@@ -94,7 +98,7 @@ After configuring a device, we can create a Thing, which is the **virtual twin**
9498

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

97-
When working with your IoT projects, consider this the "main space" for configurations, as you can access your sketche from here as well.
101+
When working with your IoT projects, consider this the "main space" for configurations, as you can access your sketches from here as well.
98102

99103
***Learn more in the documentation for [Arduino Cloud Things](/arduino-cloud/cloud-interface/things).***
100104

content/arduino-cloud/01.guides/01.cloud-editor/getting-started-cloud-editor.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ author: 'Karl Söderby'
55
---
66

77

8-
The Cloud Editor is a great choice for working with your Arduino board. It stores all of your sketches online, requires no installation of cores and includes most of the popular libraries.
8+
The Cloud Editor is a great choice for working with your Arduino board. It stores all of your sketches online, doesn't require you to install board packages and includes most of the popular libraries, while letting you upload your own if you need to.
99

10-
Getting started with the Web Editor is quick & easy, and in this tutorial, we will walk you through the necessary steps so you can use it with your Arduino board.
10+
Getting started with the Cloud Editor is quick & easy, and in this tutorial, we will walk you through the necessary steps so you can use it with your Arduino board.
1111

1212
This tutorial works with **all** official Arduino boards.
1313

14-
***Note: The cloud editor is previously known as the "Create Editor", or "Web Editor".***
14+
***Note: The Cloud Editor is previously known as the "Create Editor", or "Web Editor".***
1515

1616
## Goals
1717

@@ -24,18 +24,18 @@ In this tutorial, we will achieve the following:
2424

2525
## Hardware & Software Needed
2626

27-
- [Arduino Web Editor](https://create.arduino.cc/editor)
27+
- [Arduino Cloud Editor](https://create.arduino.cc/editor)
2828
- [Create Agent](https://create.arduino.cc/getting-started/plugin/welcome)
2929
- Arduino board
3030
- USB cable (different depending on the board you are using).
3131

3232
## Setting up the Cloud Editor
3333

34-
We will now go through the necessary steps to get your Arduino board working with the Web Editor.
34+
We will now go through the necessary steps to get your Arduino board working with the Cloud Editor.
3535

3636
### Create an Account
3737

38-
The first step is to create an account. This is done by navigating to login.arduino.cc/login. Here, you can either manually create an account, or login using for example Google.
38+
The first step is to create an account. This is done by navigating to the [Log-in page](login.arduino.cc/login). Here, you can either manually create an account, or log in using for example Google.
3939

4040
![Log in to your Arduino account.](assets/WebEditorInstall_1.png)
4141

@@ -45,13 +45,15 @@ Once you have created and activated your account, we need to install the **Creat
4545

4646
![Installing.](assets/WebEditorInstall_2.png)
4747

48+
The Create Agent is a piece of software that runs on your computer, and acts as a bridge between your board and your browser. Without it, the browser is not able to see what board you have connected to your computer, or upload code to it.
49+
4850
Follow the instructions at this page to complete the installation. You will need to download the Create Agent in this process, and install it locally on your machine.
4951

5052
When we are done, we should see this screen:
5153

5254
![Agent successfully installed.](assets/WebEditorInstall_3.png)
5355

54-
Congratulations, you now have the necessary tools to start using the Web Editor.
56+
Congratulations, you now have the necessary tools to start using the Cloud Editor.
5557

5658
> You can find the Arduino Create Agent files by following the path that relates to your operative system:
5759
>
@@ -63,11 +65,11 @@ Congratulations, you now have the necessary tools to start using the Web Editor.
6365
6466
## Upload a Program
6567

66-
Now, let's take a look at how the Web Editor works, by uploading a simple example to the board. First, we need to navigate to the Web Editor, by either [clicking this link](https://create.arduino.cc/editor) or clicking the menu at the top right corner, following the image below:
68+
Now, let's take a look at how the Cloud Editor works, by uploading a simple example to the board. First, we need to navigate to the Cloud Editor, by either [clicking this link](https://create.arduino.cc/editor) or clicking the menu at the top right corner, following the image below:
6769

68-
![Clicking on the Web Editor button.](assets/WebEditorInstall_4.png)
70+
![Clicking on the Cloud Editor button.](assets/WebEditorInstall_4.png)
6971

70-
Once you are in the Web Editor, you can see any board that you have connected to the computer. In this case, we have a **Arduino MKR WiFi 1010** at port **COM29** connected. Yours may look differently. This means that the board is recognized and the Create Agent is working.
72+
Once you are in the Cloud Editor, you can see any board that you have connected to the computer. In this case, we have a **Arduino MKR WiFi 1010** at port **COM29** connected. Yours may look differently. This means that the board is recognized and the Create Agent is working.
7173

7274
![Check if connected boards can be found.](assets/WebEditorInstall_5.png)
7375

@@ -85,4 +87,4 @@ Once it is uploaded, there should be a message in the bottom of the editor sayin
8587
Success. Saved on your online Sketchbook and done uploading Blink.
8688
```
8789

88-
If we look at the board we uploaded the code to, we should see the onboard LED blink with an interval of 1 second. This means that you have successfully used the Web Editor to upload a code to your board.
90+
If we look at the board we uploaded the code to, we should see the onboard LED blink with an interval of 1 second. This means that you have successfully used the Cloud Editor to upload a code to your board.

content/arduino-cloud/01.guides/02.arduino-c/arduino-c.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
---
22
title: 'Arduino / C++'
3-
description: 'Get started with the Arduino Cloud using the Arduino / C++ programming language.'
3+
description: 'Get started with the Arduino Cloud using the C++ programming language.'
44
tags: [Arduino Cloud, Setup]
55
author: 'Karl Söderby'
66
---
77

8-
The default option for programming your board to connect to the Arduino Cloud is by using the **Arduino / C++ language**. The configuration and connection between your board and the Arduino Cloud is supported by the [ArduinoIoTCloud library](https://github.com/arduino-libraries/ArduinoIoTCloud) & [Arduino_ConnectionHandler](https://github.com/arduino-libraries/Arduino_ConnectionHandler) libraries.
8+
The default option for programming your board to connect to the Arduino Cloud is by using the **C++ language**. The configuration and connection between your board and the Arduino Cloud is supported by the [ArduinoIoTCloud library](https://github.com/arduino-libraries/ArduinoIoTCloud) & [Arduino_ConnectionHandler](https://github.com/arduino-libraries/Arduino_ConnectionHandler) libraries.
9+
10+
***When programming in C++, you can use the Arduino API (which is also known as the Arduino Language). To learn more about the Arduino API, check out the [language reference](https://www.arduino.cc/reference/en/).***
911

1012
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:
1113
- `<sketchname>.ino` - your main sketch file,

content/arduino-cloud/01.guides/03.micropython/content.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ This tutorial guides you on how to use the MicroPython library to connect your A
1717

1818
It requires your board to have a version of MicroPython installed, which is covered in [this article](/micropython/basics/board-installation).
1919

20+
To find our full MicroPython documentation, head over to the [MicroPython Docs](/micropython) page.
21+
2022
## Goals
2123

2224
The goals of this tutorial are:
@@ -128,6 +130,8 @@ $ mpremote connect id:335B34603532 mip install github:arduino/arduino-iot-cloud-
128130
This will install the library and all required dependencies on the board.
129131
Another option is to manually copy the files from the library's [repository](https://github.com/arduino/arduino-iot-cloud-py/tree/main/src/arduino_iot_cloud) to the board's file system. It's good practice to put those files into a folder called `lib` to have the files organized neatly.
130132

133+
For more options on how to install libraries on your board, check out our [Installing Modules Guide](/micropython/basics/installing-modules).
134+
131135
## Programming the Board
132136

133137
Here is the example code to copy and paste into your sketch. It connects your device

content/arduino-cloud/01.guides/04.python/python.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,10 @@ libraries:
1111
url: https://github.com/arduino/arduino-iot-cloud-py
1212
---
1313

14+
***It is recommended to have some experience with the Python environment before reading this guide. However, installation and setup is covered in the [Python Setup](#python-setup) section.***
15+
1416
The [Arduino IoT Cloud Python Client](https://pypi.org/project/arduino-iot-cloud/) is a library that allows you to interact with the Arduino Cloud via MQTT. It supports basic authentication using the **device ID** as well as **secret key** that is obtained from the Arduino Cloud when configuring a manual device.
1517

16-
***It is recommended to have some experience with the Python environment before reading this guide. However, installation and setup is covered in the [Python Setup](#python-setup) section.***
1718

1819
## Overview
1920

@@ -32,7 +33,7 @@ To follow this guide, make sure to have:
3233
- [Arduino IoT Python Client](https://pypi.org/project/arduino-iot-client/) installed.
3334
- A code editor (we recommend [VSCode](https://code.visualstudio.com/) with the Python extension installed).
3435

35-
***The experience with Python and the **pip**** package **manager** varies depending** on your computer and operating system. Python needs to be in your PATH to use the Arduino IoT Cloud Python client.***
36+
***The experience with Python and the pip package manager varies depending on your computer and operating system. Python needs to be in your PATH to use the Arduino IoT Cloud Python client.***
3637

3738
## Cloud Setup
3839

0 commit comments

Comments
 (0)