Skip to content

Commit fe54323

Browse files
committed
Update arduino-cloud-cli.md
1 parent 98b12f8 commit fe54323

File tree

1 file changed

+23
-6
lines changed

1 file changed

+23
-6
lines changed

content/arduino-cloud/01.getting-started/07.arduino-cloud-cli/arduino-cloud-cli.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@ title: 'Arduino Cloud CLI'
33
difficulty: advanced
44
description: 'Get started with the Arduino Cloud CLI, a tool for the automation and mass-deployment of devices.'
55
tags:
6+
- Arduino IoT Cloud
67
- Arduino Cloud CLI
78
- Automation
8-
- Arduino PRO
9-
author: 'Karl Söderby'
9+
- OTA
10+
author: 'Karl Söderby, Paolo Calao'
1011
---
1112

1213
## Introduction
@@ -25,9 +26,10 @@ This tool was primarily designed to reduce time spent duplicating projects in th
2526
An example of a workflow using this tool can be:
2627

2728
1. Create your application using the Arduino IoT Cloud web interface. Here you can configure your device, create variables, enter network credentials, edit your sketch and deploy your first project.
28-
2. With the **Arduino Cloud CLI**, extract a template from your project, and create a configuration that specifies what devices to target.
29-
3. Upload the same template (sketches) to all devices.
30-
4. Whenever an update is required for a fleet of devices, you can use the OTA mass-upload tool to update all of your devices at once, without being connected to your computer.
29+
2. With the **Arduino Cloud CLI**, extract templates of Things and dashboards you want to replicate.
30+
3. Provision a device with the `device create` command and setup a Thing and dashboard using the templates previously extracted.
31+
4. Download the sketch related to the Thing you extracted, and upload it to the device you created. This can also be done via the Arduino IoT Cloud.
32+
5. Whenever an update is required for a fleet of devices, you can use the OTA mass-upload tool to update all of your devices at once, without being connected to your computer.
3133

3234
![Performing mass upload.](assets/mass-upload.png)
3335

@@ -427,4 +429,19 @@ You can also compile a file through any version of the Arduino IDE (not online).
427429
- In the IDE, with your sketch open, navigate to **Sketch > Export Compiled Binary**. In your sketch folder, a new folder called `build` will appear. The binary needed is located inside of this folder.
428430
- To navigate to your sketch folder, navigate to **Sketch > Show Sketch Folder**. You will see the `<sketchname>.bin` file, which is the file we can use to perform OTA.
429431

430-
![Compile binaries using Arduino IDE](assets/export-ide.png)
432+
![Compile binaries using Arduino IDE](assets/export-ide.png)
433+
434+
## Summary
435+
436+
The Arduino Cloud CLI is a tool that can primarly be used to extract a template from a single Thing or dashboard, and deploy it to several devices. It is also a tool for managing your fleet of devices, such as providing mass OTA uploads (such as firmware updates).
437+
438+
It is intended to be used as a supplementary tool for the [Arduino IoT Cloud](https://cloud.arduino.cc/home/) web interface, but can well be used as a standalone tool to manage your devices, Things properties and dashboards.
439+
440+
The Arduino Cloud CLI can also be well combined with the [Arduino CLI](https://arduino.github.io/arduino-cli), a separate tool that brings the functionality of the Arduino IDE to your choice of terminal.
441+
442+
To recap, this tool can be used to:
443+
- Extract templates from your existing Things & dashboards previously created in the Arduino IoT Cloud.
444+
- Perform the same actions as the Arduino IoT Cloud but from a terminal (like creating/deleting devices, Things and linking them).
445+
- List all available components from the cloud (like `thing list`).
446+
- Tag your devices & Things with the `--tags <key0>=<value0>` command.
447+

0 commit comments

Comments
 (0)