You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/arduino-cloud/01.guides/04.micropython/content.md
+92-1
Original file line number
Diff line number
Diff line change
@@ -134,7 +134,98 @@ For more options on how to install libraries on your board, check out our [Insta
134
134
135
135
## Programming the Board
136
136
137
-
Here is the example code to copy and paste into your program. It connects your device to Arduino Cloud over Wi-Fi®.
137
+
### Cloud Connection
138
+
There are two main methods to create this connection `async` and `sync`.
139
+
140
+
#### Async (Default)
141
+
This is the method currently implemented by default with the Cloud. Asynchronous operations allow tasks to run independently of the main program flow. Functions can start and continue without waiting for other tasks to finish. This non-blocking behavior is achieved using techniques like callbacks, coroutines, or the async and await keywords in MicroPython.
142
+
143
+
Asynchronous functions are particularly useful for handling network communication, as they enable the boards to perform other operations (like reading sensors or updating outputs) while waiting for data from the Arduino Cloud.
144
+
145
+
146
+
**Code example:**
147
+
```python
148
+
from secrets importDEVICE_ID
149
+
from secrets importSECRET_KEY
150
+
151
+
# Switch callback, toggles the LED.
152
+
defon_switch_changed(client, value):
153
+
# Note the client object passed to this function can be used to access
154
+
# and modify any registered cloud object. The following line updates
155
+
# the LED value.
156
+
client["led"] = value
157
+
158
+
# 1. Create a client object, which is used to connect to the IoT cloud and link local
159
+
# objects to cloud objects. Note a username and password can be used for basic authentication
160
+
# on both CPython and MicroPython. For more advanced authentication methods, please see the examples.
# The LED object is updated in the switch's on_write callback.
170
+
client.register("led", value=None)
171
+
172
+
# 3. Start the Arduino cloud client.
173
+
client.start()
174
+
```
175
+
176
+
Remember that our `secrets.py` file should look like:
177
+
```python
178
+
WIFI_SSID=""# WiFi network SSID (for MicroPython)
179
+
WIFI_PASS=""# WiFi network key (for MicroPython)
180
+
DEVICE_ID=""# Provided by Arduino cloud when creating a device.
181
+
SECRET_KEY=""# Provided by Arduino cloud when creating a device.
182
+
```
183
+
184
+
#### Sync
185
+
In synchronous operations, tasks are executed one after another in a sequential manner. Each function call waits for the previous one to complete before starting. This approach is straightforward and easier to implement but can cause delays if a task takes a long time to finish, as it blocks the execution of subsequent code. In the context of network communication with the Arduino Cloud, synchronous functions may lead to unresponsiveness during data transmission or reception.
186
+
187
+
Alternatively, you can select the synchronous method by passing sync_mode=True when creating the client object and calling client.update() periodically after connecting.
188
+
189
+
Code example:
190
+
```python
191
+
from secrets importDEVICE_ID
192
+
from secrets importSECRET_KEY
193
+
194
+
# Switch callback, toggles the LED.
195
+
defon_switch_changed(client, value):
196
+
# Note the client object passed to this function can be used to access
197
+
# and modify any registered cloud object. The following line updates
198
+
# the LED value.
199
+
client["led"] = value
200
+
201
+
# 1. Create a client object, which is used to connect to the IoT cloud and link local
202
+
# objects to cloud objects. Note a username and password can be used for basic authentication
203
+
# on both CPython and MicroPython. For more advanced authentication methods, please see the examples.
# The LED object is updated in the switch's on_write callback.
213
+
client.register("led", value=None)
214
+
215
+
# In synchronous mode, this function returns immediately after connecting to the cloud.
216
+
client.start()
217
+
218
+
# Update the client periodically.
219
+
whileTrue:
220
+
client.update()
221
+
time.sleep(0.100)
222
+
```
223
+
224
+
`secrets.py` file should look the same on both implementations.
225
+
226
+
### Project example
227
+
228
+
Here is the example code to copy and paste into your program. It connects your device to Arduino Cloud over Wi-Fi® and toggles the LED of the board using the Arduino Cloud dashboard.
Triggers react to certain conditions inside your Arduino Cloud Thing, such as a boolean being true, or a string being assigned a value. As soon as a set condition is met a notification gets triggered and sent to you. This is useful when you monitor data and you need to know about any change as soon as it happens. This could be anything from different values in environmental monitoring or security-related information such as movement detection.
9
9
10
+
Triggers can also be used to detect **device status**, where you can configure to send an email / push notification whenever a device goes online/offline.
11
+
10
12
Triggers can be set up for any of your existing projects, and are found in the [cloud home section](https://cloud.arduino.cc/home/).
11
13
12
14
## Hardware & Software Needed
@@ -16,8 +18,6 @@ Triggers can be set up for any of your existing projects, and are found in the [
16
18
17
19
***In this tutorial, we use the [Nano 33 IoT](https://store.arduino.cc/products/arduino-nano-33-iot). This is not a requirement, you can use any Arduino Cloud-compatible board for this tutorial.***
18
20
19
-
## Setup & Configuration
20
-
21
21
## Limitations
22
22
23
23
Currently, the only variables supported by the trigger feature are:
Copy file name to clipboardExpand all lines: content/arduino-cloud/04.cloud-editor/embedding-create-iframes/embedding-create-iframes.md
+57-23
Original file line number
Diff line number
Diff line change
@@ -1,25 +1,26 @@
1
1
---
2
-
title: 'Embedding your sketches into an HTML page'
3
-
description: 'Learn about different methods when embedding your sketches in a website.'
4
-
author: 'Karl Söderby'
2
+
title: 'Embed & Share Sketches'
3
+
description: 'Learn about sharing your sketches and different methods to embed your sketches in a website.'
4
+
author: 'Karl Söderby, Hannes Siebeneicher'
5
5
---
6
6
7
7
The Cloud Editor is a great tool for creating and uploading programs while also collecting all of your sketches in one place. Another great feature is embedding them as iframes, such as articles, blogposts or journals.
8
8
9
-
To embed an iframe is very easy, and we just need to copy and paste a link from our sketch in the Cloud Editor. But we can also do a series of modifications to that iframe, and in this tutorial we will take a look at how to do that.
9
+
Embedding an iframe is easy. Simply copy and paste the link from your sketch in the Cloud Editor. But we can also do a series of modifications to that iframe, and in this tutorial we will take a look at how to do that.
10
10
11
11
## Let's start
12
12
13
-
First of all, we need to navigate to the [Cloud Editor](https://create.arduino.cc/editor). If we do not have an account, we can register one with just a few simple steps.
13
+
First of all, we need to navigate to the [Cloud Editor](https://app.arduino.cc/sketches). If we do not have an account, we can register one with just a few simple steps.
14
14
15
15
Then, we need to have a code. In this tutorial, we are just going to use the good old **blink** example. When we have our sketch ready, click on the **share** button next to the serial monitor tool. This will open up a new window, that will have two fields: **link** and **embed**. Copy the embed field.
This iframe can now simply be embedded in a HTML page, and it will look like this:
@@ -32,44 +33,73 @@ But there are many ways we can modify the iframe to look different. So let's tak
32
33
33
34
First up is the easiest: making a simple snippet. This removes the other information, such as sketch name and author, and simply presents a good looking snippet!
34
35
35
-
To do this, we just need to add the following code to the end of the URL:
36
+
To do this, we need to change `view-mode=` from `embed` to`snippet` at the end of the URL:
You can highlight as many lines as you want, and it is easily configurable. For example, if we want to highlight line 1, 3 and 5-8, we simply need to add the following to the URL:
69
+
You can highlight as many lines as you want, and it is easily configurable. For example, if we want to highlight line 4 and 6-9, we simply need to add the following to the URL:
70
70
71
71
```
72
-
&snippet#L1,L3,L5-L8
72
+
&highlight=L4,L6-L9
73
+
```
74
+
75
+
## Scope
76
+
77
+
It's also possible to only show specific lines by adding the `scope` parameter, like this:
And then using the class `arduino-sketch-iframe` in your HTML element.
133
+
And then using the class `arduino-sketch-iframe` in your `HTML element`.
134
+
135
+
## Share your Code
136
+
137
+
If you want to share you're code with others can you do so by following the same steps as above, but instead of clicking on "Embed in HTML code:" you click on "Link to share:"
104
138
105
-
## Summary
139
+
106
140
107
-
There are several cool ways of working with iframes from the Cloud Editor, and it is a really easy process that requires very little coding.
141
+
This link will direct others to a preview of our code where they can copy it or directly add it to their sketchbook.
108
142
109
-
The Cloud Editor helps you keep track on all of your sketches, and with the iframes, including your projects on other pages has never been easier.
143
+
***Note: If you want to learn how to keep sensitive data in your code safe, read [Store Sensitive Data in Sketches](/arduino-cloud/cloud-editor/share-your-sketches/).***
0 commit comments