Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
58 commits
Select commit Hold shift + click to select a range
3fe9c04
New Structure
karlsoderby Oct 11, 2023
3e95026
Python guide
karlsoderby Oct 11, 2023
841b16d
Javascript article
karlsoderby Oct 11, 2023
b142ddf
node red, alexa
karlsoderby Oct 12, 2023
cbe446c
devices draft
karlsoderby Oct 12, 2023
e198d85
add wifi article
karlsoderby Oct 13, 2023
3644475
change name lora
karlsoderby Oct 13, 2023
aebccab
add ethernet + celliular
karlsoderby Oct 13, 2023
1016e4b
cloud configuration
karlsoderby Oct 18, 2023
241c5d3
web editor move
karlsoderby Oct 18, 2023
49fa843
rename folder
karlsoderby Oct 19, 2023
a549f41
Update things.md
karlsoderby Oct 19, 2023
2691909
hardware/guides
karlsoderby Oct 25, 2023
6dcc87e
cloud interface section
karlsoderby Oct 26, 2023
1bfbe4c
add category md files
karlsoderby Oct 26, 2023
2bb108b
Update software.md
karlsoderby Oct 26, 2023
4becf18
API js, python, c++
karlsoderby Oct 30, 2023
5fd49dc
Update cloud-relay-control.md
karlsoderby Oct 31, 2023
02eae40
Update Schedule Feature
Hannes7eicher Oct 31, 2023
f987577
fix data type
Hannes7eicher Oct 31, 2023
cc675a8
Update Device to Device
Hannes7eicher Oct 31, 2023
c375dd6
fix asset name
Hannes7eicher Oct 31, 2023
ff7c310
Update OTA
Hannes7eicher Oct 31, 2023
bd77903
Update Share Dashboard
Hannes7eicher Oct 31, 2023
5bdb039
fix asset links
Hannes7eicher Nov 1, 2023
0929c0f
Update Historical Data
Hannes7eicher Nov 1, 2023
bd93753
fix asset link
Hannes7eicher Nov 1, 2023
ea41e48
Update Webhooks
Hannes7eicher Nov 1, 2023
53ba99b
cloud relay
karlsoderby Nov 1, 2023
1f9392e
cloud relay
karlsoderby Nov 2, 2023
044c2b9
update micropython tutorial
karlsoderby Nov 2, 2023
2179036
link fixes until cloud interface
karlsoderby Nov 2, 2023
7601249
update all links
karlsoderby Nov 3, 2023
9c6f027
link update (remove preview)
karlsoderby Nov 3, 2023
91ac5e5
Update Modbus
Hannes7eicher Nov 6, 2023
488068b
fix typos
Hannes7eicher Nov 6, 2023
519d3ad
Update IoT Cloud > Arduino Cloud
karlsoderby Nov 6, 2023
b63075a
Merge pull request #565 from arduino/Hannes7eicher/Cloud-Feature-Tuto…
karlsoderby Nov 6, 2023
f3b442e
Update feature articles
karlsoderby Nov 6, 2023
87811f1
rename guide folder + move folders
karlsoderby Nov 6, 2023
01160c9
update device guides
karlsoderby Nov 6, 2023
a07de23
Update devices.md
karlsoderby Nov 6, 2023
0cd3908
Enhancements
jacobhylen Nov 7, 2023
0d9fc0f
review
Hannes7eicher Nov 7, 2023
ddb8b3e
Update iot-remote-app.md
jacobhylen Nov 7, 2023
06d108f
Merge pull request #568 from arduino/Hannes7eicher/Hardware-Deivces-S…
Hannes7eicher Nov 7, 2023
6a94205
Merge pull request #569 from arduino/jacobhylen/cloudv2-iotremoteapp
karlsoderby Nov 7, 2023
484f999
Update content/arduino-cloud/01.guides/00.overview/overview.md
karlsoderby Nov 7, 2023
d0b5573
Update content/arduino-cloud/01.guides/00.overview/overview.md
karlsoderby Nov 7, 2023
6df1c22
Update content/arduino-cloud/01.guides/02.arduino-c/arduino-c.md
karlsoderby Nov 7, 2023
81300b4
Merge pull request #567 from arduino/jacobhylen/cloud-docs-changes
karlsoderby Nov 7, 2023
0f8a59b
review
Hannes7eicher Nov 8, 2023
1ffc58e
Merge pull request #571 from arduino/Hannes7eicher/Cloud-Interface-Re…
Hannes7eicher Nov 8, 2023
7241bbe
add esp32 and move folders
karlsoderby Nov 9, 2023
4106b0c
remove old esp32 tutorial
karlsoderby Nov 9, 2023
4834ed2
Update Callbacks & Events
karlsoderby Nov 9, 2023
e5970ae
Update IoT Cloud naming
karlsoderby Nov 9, 2023
d2a5a72
remove incomplete statement
karlsoderby Nov 15, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

This file was deleted.

Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.

This file was deleted.

Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.

This file was deleted.

Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
3 changes: 0 additions & 3 deletions content/arduino-cloud/01.getting-started/getting-started.md

This file was deleted.

150 changes: 150 additions & 0 deletions content/arduino-cloud/01.guides/00.overview/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
---
title: 'Getting Started with Arduino Cloud'
description: 'Get started with the Arduino Cloud, an online platform that makes it easy for you to code, deploy and monitor IoT projects.'
tags: [Arduino Cloud, Getting Started]
author: 'Karl Söderby'
---

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.

The Arduino Cloud platform includes:
- an **Integrated Development Environment (IDE)** for programming your boards,
- a **cloud backend service** for synchronizing data from Arduino boards, but also from [Python](/arduino-cloud/guides/python) & [JavaScript](/arduino-cloud/guides/javascript) clients,
- a **graphical tool (dashboard)** for controlling and monitoring your board (as well as an [mobile app](/arduino-cloud/iot-remote-app/getting-started)).
- [REST API](/arduino-cloud/api/arduino-iot-api) and [command line tools](/arduino-cloud/arduino-cloud-cli/getting-started) for larger scale automations.

Very simply explained, with the Arduino Cloud you can:
1. Create a program for an Arduino based on a brilliant idea you just hatched.
2. Upload the program to your board and synchronize any data you want to (most commonly through Wi-Fi®).
3. Create a dashboard with a set of widgets to control and monitor your data.

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.

Once a variable is synced to the Arduino Cloud you can access it from any of your other devices connected to the Arduino Cloud.

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

For example, turning ON / OFF a light connected to a device would work like this:

![Interacting with your device](assets/overview-interaction.png)

And if you want to read the value of a sensor connected to your device, it would work like this:

![Monitoring your device.](assets/overview-monitor.png)

Networking code and data synchronizing is **automatically done**, so just focus on the project, and let the Arduino Cloud handle the rest.

***This document will help you get familiar with the [Arduino Cloud](app.arduino.cc) service, and once you've got a good hang of it, you can explore the [rest of the documentation](/arduino-cloud/).***

## Compatible Boards

***Throughout the documentation, we will often refer to a "board" as a "device". A board is your physical hardware or virtual setup (Python/JS), and a "device" is how it is configured in the cloud.***

Compatibility with the Arduino Cloud is divided into two categories:
- **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.
- **IoT Support** - board with a radio module (e.g. Wi-Fi®) are supported. ESP32 based boards are also supported.

For more information and list of supported boards, see the links below:
- [Wi-Fi®](/arduino-cloud/hardware/wifi)
- [LoRa®](/arduino-cloud/hardware/lora)
- [Ethernet](/arduino-cloud/hardware/ethernet)
- [Cellular (GSM/NB-IoT)](/arduino-cloud/hardware/cellular).

***You can also create something called [manual devices](/arduino-cloud/hardware/devices#manual-devices), which allows you to create a virtual instance directly on your computer using JavaScript, Python or MicroPython.***

## Overview

![The Arduino Cloud home page.](assets/home.png)

Anything in the Arduino Cloud can be accessed via the left action bar. In the list below, some with links to a documentation pages.

- **[Sketches](/arduino-cloud/cloud-interface/sketches)** - your sketches (programs) are stored here, divided into either a "normal" or "cloud" sketch.
- **[Devices](/arduino-cloud/hardware/devices)** - here you can configure your Arduino boards, ESP32 devices, manual devices (Python, JavaScript and more).
- **[Things](/arduino-cloud/cloud-interface/things)** - a Thing is a project configuration, where you select device, create variables to synchronize, and enter credentials.
- **[Dashboards](/arduino-cloud/cloud-interface/dashboard-widgets)** - dashboards are used to monitor & control your board through widgets. There's also a [mobile version](/arduino-cloud/iot-remote-app/getting-started) available to view your dashboards from a smartphone.
- **[Triggers](/arduino-cloud/cloud-interface/triggers)** - triggers can be used to send emails and push notifications based on a value change of a variable.
- **Resources** - helpful links and resources. You might have found this article here.
- **Courses** - tailored content for specific products and kits connected to the Arduino Cloud.
- **Templates** - templates are ready-made project that will automatically configure your device, Thing,
- **Integrations** - third party services that are integrated with the Arduino Cloud.

## A Walkthrough the Arduino Cloud

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

### 1. Create an Account

To use the Arduino Cloud, you will need an Arduino account, which you can register [here](https://login.arduino.cc/login).

By default, you will have a **free plan**, which can be upgraded to a number of affordable plans starting at 1.99$ a month.

***Read more about [Arduino Cloud plans](https://cloud.arduino.cc/plans)***

### 2. Configure a Device

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

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

The configurations varies between boards, but everything is covered in the installation wizard.

***Learn more in the documentation for [Arduino Cloud Devices](/arduino-cloud/hardware/devices).***

### 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.

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

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.

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

### 4. Write a Sketch

Once you have done the above configurations, you can move on to **create a program/sketch**. This is where *you* decide what you want to create, and what data you want sent to the cloud.

![A sketch in the Arduino Cloud.](assets/editor.png)

When your program is ready, upload it to your board. If your board supports [Over-the-air (OTA)](/arduino-cloud/features/ota-getting-started) uploads, you can from now on upload without your board being connected to your computer!

***Learn more in the documentation for [Arduino Cloud sketches](/arduino-cloud/cloud-interface/sketches).***

### 5. Create a Dashboard

A dashboard allows you to interact with your device from a web interface or mobile app. A dashboard is composed of **widgets**, which you can link to a variable in your Thing.

![Dashboards in the Arduino Cloud.](assets/dashboard.png)

Choose from switches, sliders, RGB picker, message box, gauges and much more to create dashboards. Dashboards are not linked to a specific Thing/device, meaning you can control many different boards from the same dashboard.

Some widgets can be linked to multiple variables, for example the [Advanced Chart](/arduino-cloud/cloud-interface/dashboard-widgets#advanced-chart) widget can graph up to 4 variables from different boards simultaneously!

***Learn more in the documentation for [Arduino Cloud dashboards](/arduino-cloud/cloud-interface/dashboard-widgets).***

### 6. Track Your Project

Once you done all configurations, created a program & dashboard, you can sit back and monitor & interact with your project from the web interface or the mobile app.

![Arduino Cloud Dashboard & IoT Remote App](assets/dashboard-app.png)

## Guides

We recommend checking out the following guides to get started with various coding frameworks:
- [Arduino / C++ setup (default setup)](arduino-cloud/guides/arduino-c) - the default installation using the built-in code editor and an Arduino / ESP32 board.
- [Python setup](/arduino-cloud/guides/python) - set up of a manual device to run on a PC / Linux system such as Raspberry Pi.
- [MicroPython setup](/arduino-cloud/guides/micropython) - setup of MicroPython on a select number of supported boards.
- [JavaScript / node.js setup](/arduino-cloud/guides/javascript) - setup of JavaScript using node.js, perfect for integrating your front-end projects with the Arduino Cloud.

## Features

Make sure to explore the various features of the Arduino Cloud through the links below:
- [**Data Monitoring**](/arduino-cloud/application-notes/cloud-environmental-data) - learn how to easily monitor environmental sensor values through a dashboard.
- [**Variable Synchronisation**](/arduino-cloud/features/thing-to-thing) - variable synchronisation allows you to sync variables across devices, enabling communication between devices with minimal coding.
- [**Scheduler**](/arduino-cloud/features/cloud-scheduler) - schedule jobs to go on/off for a specific amount of time (seconds, minutes, hours).
- [**Over-The-Air (OTA) Uploads**](/arduino-cloud/features/ota-getting-started) - upload code to devices not connected to your computer.
- [**Webhooks**](/arduino-cloud/features/webhooks) - integrate your project with another service, such as IFTTT.
- [**Amazon Alexa Support**](/arduino-cloud/guides/alexa) - make your project voice controlled with the Amazon Alexa integration.
- [**Dashboard Sharing**](/arduino-cloud/features/sharing-dashboards) - share your data with other people around the world.
Loading