Merge branch 'main' into content/micropython/micropython-revamp

Author: karlsoderby

.github/workflows/deploy-production.yml

@@ -43,7 +43,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
         with:
-          fetch-depth: 1
+          fetch-depth: "0"
 
       - name: Cleanup runner disk
         uses: ./.github/actions/cleanup-disk # Cleanup machine before starting the build
@@ -66,6 +66,7 @@ jobs:
       - name: Copy Static Files
         run: |
           mkdir -p static/resources/schematics static/resources/pinouts static/resources/models
+          find ./content/hardware -type f -name "*-schematics.pdf" -exec cp {} ./static/resources/schematics/ \;
           find ./content/hardware -type f -name "*-full-pinout.pdf" -exec cp {} ./static/resources/pinouts/ \;
           find ./content/hardware -type f -name "*-pinout.png" -exec cp {} ./static/resources/pinouts/ \;
           find ./content/hardware -type f -name "*-step.zip" -exec cp {} ./static/resources/models/ \;

.github/workflows/deploy-staging.yml

@@ -43,7 +43,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
         with:
-          fetch-depth: 1
+          fetch-depth: "0"
 
       - name: Cleanup runner disk
         uses: ./.github/actions/cleanup-disk # Cleanup machine before starting the build
@@ -66,6 +66,7 @@ jobs:
       - name: Copy Static Files
         run: |
           mkdir -p static/resources/schematics static/resources/pinouts static/resources/models
+          find ./content/hardware -type f -name "*-schematics.pdf" -exec cp {} ./static/resources/schematics/ \;
           find ./content/hardware -type f -name "*-full-pinout.pdf" -exec cp {} ./static/resources/pinouts/ \;
           find ./content/hardware -type f -name "*-pinout.png" -exec cp {} ./static/resources/pinouts/ \;
           find ./content/hardware -type f -name "*-step.zip" -exec cp {} ./static/resources/models/ \;

.gitignore

@@ -8,6 +8,8 @@ public
 src
 .DS_Store
 .vscode/settings.json
+.vscode/ltex.hiddenFalsePositives.en-US.txt
+.vscode/ltex.dictionary.en-US.txt
 content/en
 content/de
 content/pt

.vscode/ltex.dictionary.en-US.txt

@@ -0,0 +1 @@
+Opta

content/_dev-test/essentials.md

@@ -0,0 +1,3 @@
+---
+productsLibrariesMap: []
+---

content/arduino-cloud/01.guides/04.micropython/content.md

@@ -134,7 +134,98 @@ For more options on how to install libraries on your board, check out our [Insta
 
 ## Programming the Board
 
-Here is the example code to copy and paste into your program. It connects your device to Arduino Cloud over Wi-Fi®.
+### Cloud Connection
+There are two main methods to create this connection `async` and `sync`.
+
+#### Async (Default)
+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. 
+
+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.
+
+
+**Code example:**
+```python
+from secrets import DEVICE_ID
+from secrets import SECRET_KEY
+
+# Switch callback, toggles the LED.
+def on_switch_changed(client, value):
+    # Note the client object passed to this function can be used to access
+    # and modify any registered cloud object. The following line updates
+    # the LED value.
+    client["led"] = value
+
+# 1. Create a client object, which is used to connect to the IoT cloud and link local
+# objects to cloud objects. Note a username and password can be used for basic authentication
+# on both CPython and MicroPython. For more advanced authentication methods, please see the examples.
+client = ArduinoCloudClient(device_id=DEVICE_ID, username=DEVICE_ID, password=SECRET_KEY)
+
+# 2. Register cloud objects.
+# Note: The following objects must be created first in the dashboard and linked to the device.
+# When the switch is toggled from the dashboard, the on_switch_changed function is called with
+# the client object and new value args.
+client.register("sw1", value=None, on_write=on_switch_changed)
+
+# The LED object is updated in the switch's on_write callback.
+client.register("led", value=None)
+
+# 3. Start the Arduino cloud client.
+client.start()
+```
+
+Remember that our `secrets.py` file should look like:
+```python
+WIFI_SSID  = ""  # WiFi network SSID (for MicroPython)
+WIFI_PASS  = ""  # WiFi network key  (for MicroPython)
+DEVICE_ID  = "" # Provided by Arduino cloud when creating a device.
+SECRET_KEY = "" # Provided by Arduino cloud when creating a device.
+```
+
+#### Sync
+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.
+
+Alternatively, you can select the synchronous method by passing sync_mode=True when creating the client object and calling client.update() periodically after connecting.
+
+Code example:
+```python
+from secrets import DEVICE_ID
+from secrets import SECRET_KEY
+
+# Switch callback, toggles the LED.
+def on_switch_changed(client, value):
+    # Note the client object passed to this function can be used to access
+    # and modify any registered cloud object. The following line updates
+    # the LED value.
+    client["led"] = value
+
+# 1. Create a client object, which is used to connect to the IoT cloud and link local
+# objects to cloud objects. Note a username and password can be used for basic authentication
+# on both CPython and MicroPython. For more advanced authentication methods, please see the examples.
+client = ArduinoCloudClient(device_id=DEVICE_ID, username=DEVICE_ID, password=SECRET_KEY, sync_mode=True)
+
+# 2. Register cloud objects.
+# Note: The following objects must be created first in the dashboard and linked to the device.
+# When the switch is toggled from the dashboard, the on_switch_changed function is called with
+# the client object and new value args.
+client.register("sw1", value=None, on_write=on_switch_changed)
+
+# The LED object is updated in the switch's on_write callback.
+client.register("led", value=None)
+
+# In synchronous mode, this function returns immediately after connecting to the cloud.
+client.start()
+
+# Update the client periodically.
+while True:
+    client.update()
+    time.sleep(0.100)
+```
+
+`secrets.py` file should look the same on both implementations.
+
+### Project example
+
+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.
 
 
 ```python

content/arduino-cloud/03.cloud-interface/04.triggers/triggers.md

@@ -7,6 +7,8 @@ tags: [Arduino Cloud, Triggers, Cloud Notification]
 
 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.
 
+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.
+
 Triggers can be set up for any of your existing projects, and are found in the [cloud home section](https://cloud.arduino.cc/home/).
 
 ## Hardware & Software Needed
@@ -16,8 +18,6 @@ Triggers can be set up for any of your existing projects, and are found in the [
 
 ***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.***
 
-## Setup & Configuration
-
 ## Limitations
 
 Currently, the only variables supported by the trigger feature are: