Skip to content

Commit 7601249

Browse files
committed
update all links
1 parent 2179036 commit 7601249

File tree

10 files changed

+42
-39
lines changed

10 files changed

+42
-39
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Networking code and data synchronizing is **automatically done**, so just focus
3838

3939
Compatibility with the Arduino Cloud is divided into two categories:
4040
- **Cloud Editor Support** - you can program **any** official Arduino board in the cloud editor. The editor also supports a large amount of third party boards.
41-
- **IoT Cloud Support** - board with a radio module (e.g. Wi-Fi®) are supported. ESP32 based boards are also supported.
41+
- **IoT Support** - board with a radio module (e.g. Wi-Fi®) are supported. ESP32 based boards are also supported.
4242

4343
For more information and list of supported boards, see the links below:
4444
- [Wi-Fi®](/arduino-cloud/hardware/wifi)

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

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

8-
The default option for programming your board to connect to the Arduino IoT Cloud is by using the **Arduino / C++ language**. The configuration and connection between your board and the IoT 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 **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.
99

10-
Whenever you create a [Thing](https://docscontentprivate-karlsoderbycloudv2.gatsbyjs.io/arduino-cloud/cloud-interface/things) in the IoT Cloud, you automatically start generating a set of files that will handle the configurations, credentials & connection:
10+
Whenever you create a [Thing](https://docscontentprivate-karlsoderbycloudv2.gatsbyjs.io/arduino-cloud/cloud-interface/things) in the Arduino Cloud, you automatically start generating a set of files that will handle the configurations, credentials & connection:
1111
- `<sketchname>.ino` - your main sketch file,
1212
- `thingProperties.h` - your main configuration file,
1313
- `arduino_secrets.h` - your credentials file (for API key, Wi-Fi network etc.)
1414

15-
In this guide, we will take a look at how you can connect to the IoT Cloud using the Arduino / C++ programming language.
16-
1715
***If you want to find out more about what the Arduino Cloud service can do, go to the [overview](https://docscontentprivate-karlsoderbycloudv2.gatsbyjs.io/arduino-cloud/guides/overview) section.***
1816

1917
## Requirements
@@ -23,19 +21,19 @@ In this guide, we will take a look at how you can connect to the IoT Cloud using
2321

2422
## Setup
2523

26-
In this section, we will go through the steps necessary to connect your Arduino board to the IoT Cloud. To follow these steps, please make sure you have a [registered Arduino account](https://login.arduino.cc/login), and that you have access to the [Arduino Cloud](app.arduino.cc).
24+
In this section, we will go through the steps necessary to connect your Arduino board to the Arduino Cloud. To follow these steps, please make sure you have a [registered Arduino account](https://login.arduino.cc/login), and that you have access to the [Arduino Cloud](app.arduino.cc).
2725

2826
### Configure Device
2927

30-
First navigate to [IoT Cloud](app.arduino.cc), and click on the **Devices** tab. Here you can see all your devices, and configure a new one. Depending on what type of board you have, the configuration will vary.
28+
First navigate to [Arduino Cloud](app.arduino.cc), and click on the **Devices** tab. Here you can see all your devices, and configure a new one. Depending on what type of board you have, the configuration will vary.
3129

32-
***For more details, see the [documentation for IoT Cloud devices](https://docscontentprivate-karlsoderbycloudv2.gatsbyjs.io/arduino-cloud/hardware/devices).***
30+
***For more details, see the [documentation for devices](https://docscontentprivate-karlsoderbycloudv2.gatsbyjs.io/arduino-cloud/hardware/devices).***
3331

3432
### Configure Thing
3533

3634
Next, navigate to the **Things** tab. Here you will see a list of your Things, and a button to create a new one. When you create a new Thing, you will open up a new configuration space.
3735

38-
![Arduino IoT Cloud Thing Interface](assets/thing-config.png)
36+
![Arduino Cloud Thing Interface](assets/thing-config.png)
3937

4038
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](https://docscontentprivate-karlsoderbycloudv2.gatsbyjs.io/arduino-cloud/cloud-interface/sketches#iot-sketches).
4139

@@ -45,7 +43,7 @@ A "Thing" is a virtual twin of your hardware, and it is here that we create vari
4543

4644
All the above configurations have now been generated into a set of files that can be accessed in the **Sketch** tab.
4745

48-
***For more details, see the [documentation for IoT Cloud Things](https://docscontentprivate-karlsoderbycloudv2.gatsbyjs.io/arduino-cloud/cloud-interface/things).***
46+
***For more details, see the [documentation for Things](https://docscontentprivate-karlsoderbycloudv2.gatsbyjs.io/arduino-cloud/cloud-interface/things).***
4947

5048
### Complete Sketch
5149

@@ -110,6 +108,4 @@ To control the state of the `test` variable, we can setup a **dashboard** and a
110108
2. Click on the edit button at the top left, then on the **"Add"** button. Select the Thing you want to associate it with, and then click on **"Create Widgets"**.
111109
3. A switch widget will have generated, which is now linked to your board. Flicking it should control the state of the LED (on/off).
112110

113-
![Controlling built-in LED via a switch widget.]()
114-
115-
***You can find more details in the [Arduino IoT Cloud dashboards documentation](https://docscontentprivate-karlsoderbycloudv2.gatsbyjs.io/arduino-cloud/cloud-interface/dashboard-widgets).***
111+
***You can find more details in the [dashboards documentation](https://docscontentprivate-karlsoderbycloudv2.gatsbyjs.io/arduino-cloud/cloud-interface/dashboard-widgets).***
Binary file not shown.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ libraries:
1212

1313
## Introduction
1414

15-
This tutorial guides you on how to use the MicroPython library to connect your Arduino device to the Arduino IoT Cloud.
15+
This tutorial guides you on how to use the MicroPython library to connect your Arduino device to the Arduino Cloud.
1616

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

1.82 MB
Loading

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

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ LoRaWAN® boards also have crypto chip on board, but connects to the Arduino Clo
5050

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

53-
ESP32/ESP8266 based boards typically don't have an onboard crypto chip, and is configured via a **Secret Key** generated during the configuration.
53+
ESP32/ESP8266 based boards typically don't have an onboard crypto chip. Instead when configuring a device, a **[secret key](#secret-key--device-id)** is generated, that can together with the **device ID** be used to securely connect to the Arduino Cloud.
5454

5555
There are currently two official ESP32 based Arduino boards:
5656
- [Arduino UNO R4 WiFi](https://store.arduino.cc/products/uno-r4-wifi)
@@ -62,7 +62,7 @@ You can also configure a wide range of third party ESP32/ESP8266 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** 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 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.
6666

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

@@ -72,6 +72,13 @@ Check the guides below for getting started with each of the programming language
7272
- [Connect to Arduino Cloud (Python)](/arduino-cloud/guides/python)
7373
- [Connect to Arduino Cloud (MicroPython)](/arduino-cloud/guides/micropython)
7474

75+
## Secret Key & Device ID
76+
77+
When configuring ESP32/ESP8266 and Manual Devices, you generate a **Device ID** and a **Secret Key**. This is the final step of the configuration of your device.
78+
79+
![Your Device ID / Secret Key.](assets/device-key.png)
80+
81+
Make sure to download or store this information somewhere, as you cannot retrieve the Secret Key after this step.
7582

7683
## Device Information
7784

content/arduino-cloud/07.api/03.c-library/c-library.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
title: Arduino / C++ Library
3-
description:
3+
description: The ArduinoIoTCloud library allows you to connect to the Arduino Cloud using Arduino/C++.
44
author: Karl Söderby
55
tags: [C++, Arduino]
66
---
77

8-
The default Arduino / C++ library for the Arduino Cloud is the [ArduinoIoTCloud]() library. This library depends on the [Arduino_ConnectionHandler]() library which provides connection via various wireless protocols (Wi-Fi®, LoRaWAN®, NB-IoT, GSM, Ethernet).
8+
The default Arduino / C++ library for the Arduino Cloud is the [ArduinoIoTCloud](https://github.com/arduino-libraries/ArduinoIoTCloud) library. This library depends on the [Arduino_ConnectionHandler](https://github.com/arduino-libraries/Arduino_ConnectionHandler) library which provides connection via various wireless protocols (Wi-Fi®, LoRaWAN®, NB-IoT, GSM, Ethernet).
99

10-
The library is integrated into the Arduino Cloud platform, where [Automatic Sketch Generation]() converts your Thing configurations into a set files that relies on aforementioned libraries.
10+
The library is integrated into the Arduino Cloud platform, where [Automatic Sketch Generation](https://docscontentprivate-karlsoderbycloudv2.gatsbyjs.io/arduino-cloud/cloud-interface/sketches#iot-sketches) converts your Thing configurations into a set files that relies on aforementioned libraries.
1111

1212
The **ArduinoIoTCloud** library supports either connection via **TCP/IP** or **LoRaWAN®**. Depending on the device you compile for, the library automatically chooses the right configuration.
1313

@@ -28,13 +28,13 @@ When connecting via [TCP/IP](https://en.wikipedia.org/wiki/Internet_protocol_sui
2828

2929
### LoRaWAN®
3030

31-
When connecting via LoRaWAN®, data is sent via [The Things Network](), which is integrated with the Arduino Cloud. This support is enabled in the following files:
31+
When connecting via LoRaWAN®, data is sent via [The Things Network](https://www.thethingsnetwork.org/), which is integrated with the Arduino Cloud. This support is enabled in the following files:
3232
- [ArduinoIoTCloudLPWAN.cpp](https://github.com/arduino-libraries/ArduinoIoTCloud/blob/master/src/ArduinoIoTCloudLPWAN.cpp)
3333
- [ArduinoIoTCloudLPWAN.h](https://github.com/arduino-libraries/ArduinoIoTCloud/blob/master/src/ArduinoIoTCloudLPWAN.h)
3434

3535
## Library API Docs
3636

37-
The documentation lives in the [ArduinoIoTCloud]() library documentation page. Here you will find all public methods that are available.
37+
The documentation lives in the [ArduinoIoTCloud](https://github.com/arduino-libraries/ArduinoIoTCloud) library documentation page. Here you will find all public methods that are available.
3838

3939
Most of its functions are already pre-configured in your sketch files, so for most use cases you will not need to explore the API. Functions for connecting to, and syncing data with the Arduino Cloud is handled automatically, and will be generated into your sketch files in the web environment.
4040

content/arduino-cloud/07.api/04.python/python.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ tags: [Python, Arduino Cloud]
77

88
The Python Client for connecting to the Arduino Cloud is known as the [Arduino IoT Cloud Python Client](https://github.com/arduino/arduino-iot-cloud-py) library. This library is implemented to support MicroPython, CircuitPython as well as regular Python running on your personal computer / Linux machine (like Raspberry Pi).
99

10-
Connection via this client is achieved by registering a [manual device](), i.e. a virtual device that is not associated with an Arduino hardware board. This virtual device can connect through a simple username/password (Device ID, Secret Key) which is generated in the Arduino Cloud when configuring a device.
10+
Connection via this client is achieved by registering a [manual device](https://docscontentprivate-karlsoderbycloudv2.gatsbyjs.io/arduino-cloud/hardware/devices#manual-devices), i.e. a virtual device that is not associated with an Arduino hardware board. This virtual device can connect through a simple username/password (Device ID, Secret Key) which is generated in the Arduino Cloud when configuring a device.
1111

1212
## GitHub
1313

@@ -16,11 +16,11 @@ To view the source code and report issues, follow the links below to the GitHub
1616

1717
## Installation
1818

19-
You can install this client either directly on your board running MicroPython
19+
You can install this client either directly on your board running **MicroPython**, or on any computer using **Python**.
2020

2121
### MicroPython
2222

23-
To install the client on a board running MicroPython, you can check out the [MicroPython Installation Guide](). Options to directly download the library to the board via Wi-Fi® or via USB is available, using [mip](https://docs.micropython.org/en/latest/reference/packages.html).
23+
To install the client on a board running MicroPython, you can check out the [MicroPython Installation Guide](https://docscontentprivate-karlsoderbycloudv2.gatsbyjs.io/arduino-cloud/guides/micropython). Options to directly download the library to the board via Wi-Fi® or via USB is available, using [mip](https://docs.micropython.org/en/latest/reference/packages.html).
2424

2525
### Python
2626

@@ -32,7 +32,7 @@ pip install arduino-iot-cloud
3232

3333
Project description, release history and more information about this package can be found [here](https://pypi.org/project/arduino-iot-cloud/).
3434

35-
***Need help setting up? Check out the [Python Installation Guide](), which has ready made examples that will help you get started.***
35+
***Need help setting up? Check out the [Python Installation Guide](https://docscontentprivate-karlsoderbycloudv2.gatsbyjs.io/arduino-cloud/guides/python), which has ready made examples that will help you get started.***
3636

3737
## Variable Synchronisation
3838

@@ -42,4 +42,4 @@ Variable synchronisation is a feature of the Arduino Cloud that allows you to sy
4242

4343
With this feature, you can very easily integrate your existing Python, MicroPython or JavaScript projects with your Arduino projects.
4444

45-
***Read more in the [Variable Synchronisation]() section.***
45+
***Read more in the [Variable Synchronisation](https://docscontentprivate-karlsoderbycloudv2.gatsbyjs.io/arduino-cloud/cloud-interface/variables#variable-synchronisation) section.***

content/arduino-cloud/07.api/05.javascript/javascript.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ tags: [JavaScript, Arduino Cloud]
77

88
This library provides interaction with the Arduino IoT Cloud MQTT broker and can be used both from the browser and Node.js.
99

10-
Connection via this library is achieved by registering a [manual device](), i.e. a virtual device that is not associated with an Arduino hardware board. This virtual device can connect through a simple username/password (Device ID, Secret Key) which is generated in the Arduino Cloud when configuring a device.
10+
Connection via this library is achieved by registering a [manual device](https://docscontentprivate-karlsoderbycloudv2.gatsbyjs.io/arduino-cloud/hardware/devices#manual-devices), i.e. a virtual device that is not associated with an Arduino hardware board. This virtual device can connect through a simple username/password (Device ID, Secret Key) which is generated in the Arduino Cloud when configuring a device.
1111

12-
This library requires a version of [Node.js]() to be installed on your machine.
12+
This library requires a version of [Node.js](https://nodejs.org/en/download/current) to be installed on your machine.
1313

1414
## GitHub
1515

@@ -18,7 +18,7 @@ To view the source code and report issues, follow the links below to the GitHub
1818

1919
## Requirements
2020

21-
- [Node.js]()
21+
- [Node.js](https://nodejs.org/en/download/current)
2222

2323
## Installation
2424

@@ -34,7 +34,7 @@ $ npm install arduino-iot-js
3434
$ yarn add arduino-iot-js
3535
```
3636

37-
***Check out the [JavaScript Setup guide]() for more information and a detailed step by step tutorial.***
37+
***Check out the [JavaScript Setup guide](https://docscontentprivate-karlsoderbycloudv2.gatsbyjs.io/arduino-cloud/guides/javascript) for more information and a detailed step by step tutorial.***
3838

3939
## Connection Methods
4040

@@ -45,7 +45,7 @@ There are three available methods for connection:
4545

4646
### Device Credentials
4747

48-
Device credentials is the easiest method. These credentials are generated when [configuring a manual device]() in the Arduino Cloud, and works like a username/password. The example below uses device credentials:
48+
[Device credentials](https://docscontentprivate-karlsoderbycloudv2.gatsbyjs.io/arduino-cloud/hardware/devices#secret-key--device-id) is the easiest method. These credentials are generated when configuring a manual device in the Arduino Cloud, and works like a username/password. The example below uses device credentials:
4949

5050
```js
5151
//JavaScript code
@@ -71,7 +71,7 @@ const { ArduinoIoTCloud } = require('arduino-iot-js');
7171

7272
### API Key
7373

74-
You can also connect using an API key generated from the [Arduino Cloud API Key Section](), a method that is almost identical to Device Credentials, but where you also need to specify your Thing ID. This is available in the metadata section of your Thing.
74+
You can also connect using an API key generated from the [Arduino Cloud API Key Section](app.arduino.cc/api-keys), a method that is almost identical to Device Credentials, but where you also need to specify your Thing ID. This is available in the metadata section of your Thing.
7575

7676
```js
7777
import { ArduinoIoTCloud } from 'arduino-iot-js';

0 commit comments

Comments
 (0)