Skip to content

Commit 6dcc87e

Browse files
committed
cloud interface section
1 parent 2691909 commit 6dcc87e

34 files changed

+84
-42
lines changed
Loading
Loading
Loading

content/arduino-cloud/03.cloud-interface/01.things/things.md

+54-20
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,18 @@ In the Thing interface you can:
1919

2020
The Thing interface is designed for ease-of-use, and only has a few sections, which we will now go through.
2121

22-
![Thing Interface]()
22+
![Thing Interface](assets/thing-interface.png)
2323

24-
### Device
24+
- **1. Cloud Variables** - create variables that synchronize between a device and the Arduino Cloud.
25+
- **2. Devices** - configure a device that will be associated with your Thing.
26+
- **3. Network** - network credentials, e.g. Wi-Fi® network/password.
27+
- **4. Setup** - the main configuration space tab.
28+
- **5. Sketch** - access the sketch associated with your Thing.
29+
- **6. Metadata** - metadata such as tags, timezone and Thing ID.
2530

26-
In the device section you can select either a previously configured device, or configure a new one. Associating a device means your device and Thing are now linked indefinitely, until you decide to detach them.
27-
28-
The status of your device is also displayed in this section (online/offline).
29-
30-
***For more details on how to configure a device, check out the [Devices]() section. The available types and links to individual guides are found there.***
31+
Below you will find more details on each of the sections.
3132

32-
### Variables
33+
## Variables
3334

3435
The variables section is where you create **"Cloud Variables"**, a variable that exist in the Arduino Cloud as well as on your board/setup, and are synchronised continuously. You can configure a variable to be:
3536
- **Read/Write** - you can interact with the variable from a dashboard,
@@ -51,27 +52,46 @@ Variables of the same type can also be synchronised across all devices. This is
5152

5253
***All variables are listed out in the [Variables]() section. See [Variable Synchronization]() for linking together your devices' variables.***
5354

54-
### Network
55+
## Device
56+
57+
In the device section you can select either a previously configured device, or configure a new one. Associating a device means your device and Thing are now linked indefinitely, until you decide to detach them.
58+
59+
You can connect one of the following devices:
60+
- [Arduino Wi-Fi® devices]() - official Arduino devices with a Wi-Fi® enabled module.
61+
- [Arduino LoRaWAN® devices]() - official Arduino devices with a LoRaWAN® module.
62+
- [Third party ESP32/ESP8266 devices]() - third party devices with an ESP32/ESP8266 SoC.
63+
- [Manual devices]() - a virtual device using MicroPython, Python or JavaScript. These devices do not have a sketch associated.
64+
65+
The status of your device is also displayed in this section (online/offline).
66+
67+
***For more details on how to configure a device, check out the [Devices]() section. The available types and links to individual guides are found there.***
68+
69+
## Network
5570

5671
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 for e.g. LoRaWAN® & cellular. The network details are securely stored.
5772

58-
![Network configuration.]()
73+
![Network configuration.](assets/network-creds.png)
5974

6075
The credentials entered are automatically included in your sketch (see automatic sketch generation just below).
6176

62-
## Automatic Sketch Generation
77+
## Sketch
6378

64-
Things based on Arduino / C++ (the default way) benefits from **automatic sketch generation**. Whenever any configuration is done in your Thing, the changes are reflected in your sketch files.
79+
The sketch tab contains a built-in editor where you can edit, compile and upload sketches to your devices.
6580

66-
For example:
67-
- Associating a Wi-Fi board will automatically update the connection method,
68-
- creating a variable will add it to your `thingProperties.h` file,
69-
- creating a variable with **read/write** permission will also add a callback function at the bottom of your sketch. This will trigger anytime the value changes.
70-
- changing your network credentials will update the `arduino_secrets.h` file.
81+
![Built-in editor.](assets/built-in-editor.png)
7182

72-
This is implemented so that the connection and synchronisation between the board and cloud is handled automatically, meaning you do not need to do any networking code when using the Arduino / C++ language.
83+
- **1. Verify / Upload** - compile and upload code to your devices.
84+
- **2. Connected devices** - connected devices will appear here.
85+
- **3. Open full editor** - opens the full Cloud Editor.
86+
- **4. Serial Monitor** - view serial data from your device.
87+
- **5. Auto Indentation** - auto indents your code.
88+
- **6. Notifications** - whenever you change something in your Thing, a notification will appear here with the changes made.
89+
90+
This editor is a mirror of the [Cloud Editor](), which you can access via the **"Open Full Editor"** button.
7391

74-
***Please note that if you are using an offline environment, [Arduino IDE](), changes will only be made in the cloud environment and will manually need to be adjusted. If you plan on using the offline IDE, you make use of the [sketch synchronisation]() feature that allows you to push/pull your cloud sketches from the offline IDE.***
92+
The editor includes all cores for official Arduino boards, and over 6000+ libraries. Many boards also supports **Over-the-air (OTA)** uploads, which is enabled after your first upload via USB.
93+
94+
***For more information on the editor, check out the [Getting Started with Cloud Editor]() tutorial.***
7595

7696
## Metadata
7797

@@ -96,4 +116,18 @@ This is particularly important when using the [scheduler]() feature to trigger e
96116
### Tags
97117

98118
Tags are used to organize and filter your Things. In a setup with many devices across different locations, this can be particularly useful. When creating a tag, you have two fields:
99-
- **Key** -
119+
- **Key** -
120+
121+
## Automatic Sketch Generation
122+
123+
Things based on Arduino / C++ (the default way) benefits from **automatic sketch generation**. Whenever any configuration is done in your Thing, the changes are reflected in your sketch files.
124+
125+
For example:
126+
- Associating a Wi-Fi board will automatically update the connection method,
127+
- creating a variable will add it to your `thingProperties.h` file,
128+
- creating a variable with **read/write** permission will also add a callback function at the bottom of your sketch. This will trigger anytime the value changes.
129+
- changing your network credentials will update the `arduino_secrets.h` file.
130+
131+
This is implemented so that the connection and synchronisation between the board and cloud is handled automatically, meaning you do not need to do any networking code when using the Arduino / C++ language.
132+
133+
***Please note that if you are using an offline environment, [Arduino IDE](), changes will only be made in the cloud environment and will manually need to be adjusted. If you plan on using the offline IDE, you make use of the [sketch synchronisation]() feature that allows you to push/pull your cloud sketches from the offline IDE.***
Loading
Loading
Loading

content/arduino-cloud/03.cloud-interface/03.dashboard-widgets/dashboard-widgets.md

+18-9
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ difficulty: beginner
88

99
Dashboards in the [Arduino Cloud](https://cloud.arduino.cc/home/) are used to easily monitor & control your Arduino boards from a web interface. Dashboards are not linked to one specific Thing or device, you can control all of them through one single dashboard.
1010

11-
Dashboards are composed of [widgets](), which are directly linked to a variable. Whenever that variable updates, so does the widget.
11+
Dashboards are composed of [widgets](#widgets), which are directly linked to a variable. Whenever that variable updates, so does the widget.
1212

1313
## Dashboards
1414

@@ -20,29 +20,38 @@ Dashboards are not tied to one Thing, or one device, and it can be used to contr
2020

2121
***Deleting dashboards / widgets does not impact the functionality of your Thing & device. This means that you can safely edit your dashboards & widgets while your device is streaming data. It does however remove the historical data of that Widget.***
2222

23-
### IoT Remote App
23+
## IoT Remote App
2424

2525
The [IoT Remote App]() is a mobile version of your dashboards, that can be downloaded through:
2626
- [Google Play Store](https://play.google.com/store/apps/details?id=cc.arduino.cloudiot&hl=en&gl=US)
2727
- [Apple App store](https://apps.apple.com/us/app/arduino-iot-cloud-remote/id1514358431)
2828

2929
***For more information, visit the [IoT Remote App docs]().***
3030

31-
### Edit / View Modes
31+
## Edit / View Modes
3232

3333
Dashboards have two modes, **edit** and **view**. When configuring the dashboard, you will be using the edit mode.
3434

35-
While in edit mode, you can create widgets, link them to variables, and move widgets around and lock them in place. Widgets can be be scaled and customized to your liking. A switch widget can for example be adjusted from a 1x1 to 5x5 size.
35+
In both modes, you can also click the **Mobile Layout** icon, to see how the widgets will be viewed on your [IoT Remote App]().
3636

37-
![Scaling widgets.](assets/)
37+
![Edit / View modes and mobile layout.](assets/edit-view-mobile.png)
3838

39-
In both modes, you can also click the **Mobile Layout** icon, to see how the widgets will be viewed on your [IoT Remote App]()
39+
While in **edit mode**, you can create widgets, link them to variables, and move widgets around and lock them in place. Widgets can be be scaled and customized to your liking. A switch widget can for example be adjusted from a 1x1 to 5x5 size.
4040

41-
### Sharing Dashboards
41+
![Scaling widgets.](assets/scaling.png)
42+
43+
44+
In the **viewing** mode you can only monitor/interact with your widgets.
45+
46+
## Sharing Dashboards
47+
48+
You can share your live dashboards with other people, allowing them to monitor and interact with your devices. Note that you need a [maker plan]() to use this feature.
49+
50+
![Share your dashboards.](assets/share-dashboard.png)
51+
52+
***Read more at [Sharing Dashboards in the Arduino Cloud]().***
4253

43-
It is possible to share your live dashboards with other people. To do so, please refer to the guide in the link below:
4454

45-
- [Sharing Dashboards in the Arduino IoT Cloud](/cloud/iot-cloud/tutorials/sharing-dashboards)
4655

4756
## Widgets
4857

content/arduino-cloud/03.cloud-interface/05.templates/templates.md

Whitespace-only changes.
Loading
Loading
Loading
Loading

content/arduino-cloud/05.iot-remote-app/05.iot-remote-app/iot-remote-app.md renamed to content/arduino-cloud/05.iot-remote-app/01.iot-remote-app/iot-remote-app.md

+12-13
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: Arduino IoT Cloud Remote App
2+
title: IoT Remote App
33
description: Learn how to set up the IoT Cloud Remote app to control & monitor your dashboards and access your phone's sensor data.
44
author: Karl Söderby
5-
tags: [IoT Cloud, Remote App, Phone Data]
5+
tags: [Arduino Cloud, Remote App, Phone Data]
66
---
77

8-
The **Arduino IoT Cloud Remote** phone application lets you control and monitor all of your dashboards in the [Arduino IoT Cloud](https://create.arduino.cc/iot/). With the app, you can also access your phone's internal sensors such as GPS data, light sensor, IMU and more (depending on what phone you have).
8+
The **Arduino IoT Cloud Remote** phone application lets you control and monitor all of your dashboards in the [Arduino IoT Cloud](app.arduino.cc). With the app, you can also access your phone's internal sensors such as GPS data, light sensor, IMU and more (depending on what phone you have).
99

1010
The phone's sensor data is automatically stored in cloud variables, which you can also synchronize with other Things. This means your phone can become a part of your IoT system, acting as another node in your network.
1111

@@ -29,9 +29,14 @@ After installing the app, you will need to log in to your Arduino account. If yo
2929

3030
After you login, you will discover all of your dashboards (if you have any), in the main menu.
3131

32-
![Dashboards in the Arduino IoT Remote app.](assets/remote-app-overview.png)
32+
![Dashboards in the Arduino IoT Remote app.](assets/overview.png)
33+
34+
## Themes
35+
36+
You can change between the default (light) to the dark theme, by navigating to **Settings > App theme**.
37+
38+
![Change theme (light/dark)](assets/app-theme.png)
3339

34-
## App Overview
3540

3641
## Access Phone Sensor Data
3742

@@ -50,7 +55,7 @@ Upon completion, head over to the new dashboard, that should contain your name +
5055

5156
***When setting up your phone as a device, a Thing with a similar name is created in the Arduino IoT Cloud. It can not be programmed as a regular device.***
5257

53-
## Background Mode
58+
### Background Mode
5459

5560
Now that you've got access to your phone's data, you can also enable the **background mode**. This will allow your phone to continue streaming data to the cloud, even though the app is not being used.
5661

@@ -70,10 +75,4 @@ Head over to the [Arduino IoT Cloud - Things](https://create.arduino.cc/iot/thin
7075

7176
![Synchronizing variables.](assets/remote-app-cloud-variables.png)
7277

73-
Simply described, this allows you to use your phone as an input for a number of different applications. For example, the `Compass` variable can be used to control the angle of a servo motor on another device. You can read more about how to synchronize these variables in the [Use Sensor Data From Your Phone](/arduino-cloud/tutorials/iot-remote-phone-sensors) tutorial, that includes a practical example.
74-
75-
## Summary
76-
77-
The IoT Remote App is great for you to manage all of your devices via your smart phone. Check in on your plants, water them remotely, or manage your smart light system in your house, all from one app.
78-
79-
With the phone in background mode, you also enable your smart phone to become one of the devices in your network.
78+
Simply described, this allows you to use your phone as an input for a number of different applications. For example, the `Compass` variable can be used to control the angle of a servo motor on another device. You can read more about how to synchronize these variables in the [Use Sensor Data From Your Phone](/arduino-cloud/tutorials/iot-remote-phone-sensors) tutorial, that includes a practical example.

0 commit comments

Comments
 (0)