Skip to content

Commit 9270081

Browse files
committed
Merge branch 'main' into karlsoderby/lang-ref-compressed
2 parents 6b8f46a + 2d7cd9c commit 9270081

File tree

68 files changed

+519
-89
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+519
-89
lines changed

content/arduino-cloud/01.guides/07.node-red/nodered-intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ The final step is connecting the **DHT11 humidity sensor** to our Arduino MKR Wi
181181

182182
Use the steps below to use Node-RED with the Arduino Cloud:
183183

184-
**1.** Go to the [API keys section](https://app.arduino.cc/home/api-keys), and create a new API key.
184+
**1.** Go to the [API keys section](https://app.arduino.cc/api-keys), and create a new API key.
185185

186186
**2.** Save the Client ID and Client Secret in a safe document
187187

content/arduino-cloud/07.api/01.api-overview/api-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The main goal of the Application API is to allow you to create and manage IoT re
1313

1414
The core of those APIs is organized around [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer). Our API has predictable resource-oriented URLs, accepts [form-encoded](https://en.wikipedia.org/wiki/POST_(HTTP)#Use_for_submitting_web_forms) request bodies, returns [JSON-encoded](http://www.json.org/) responses, and uses standard HTTP response codes, authentication, and verbs.
1515

16-
You can use those APIs, both directly calling our HTTP endpoints or using our clients that wrap those calls into easy-to-use abstractions like objects and functions. We have Applications API clients available in `javascript`, `golang`, and `python`. To use the Application API, you need to create an **API Key** in the [API Keys](https://cloud.arduino.cc/home/api-keys) section.
16+
You can use those APIs, both directly calling our HTTP endpoints or using our clients that wrap those calls into easy-to-use abstractions like objects and functions. We have Applications API clients available in `javascript`, `golang`, and `python`. To use the Application API, you need to create an **API Key** in the [API Keys](https://cloud.arduino.cc/api-keys) section.
1717

1818
With this API, you can:
1919
- Build an automated script to create your things, in bulk

content/arduino-cloud/07.api/02.arduino-iot-api/arduino-iot-api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@ To authenticate, you will need to generate a `clientId` and `clientSecret`. This
4747

4848
**1.** Log in to your [Arduino account](https://cloud.arduino.cc/home/).
4949

50-
**2.** Navigate to the [Arduino Cloud home page](https://cloud.arduino.cc/home/).
50+
**2.** Navigate to the [API Keys page](https://app.arduino.cc/api-keys).
5151

52-
**3.** Click **"API keys"** at the bottom left corner, and then click **"CREATE API KEY"**. Name it, and save it as a PDF. You will **not** be able to see `clientSecret` again.
52+
**3.** Click **"CREATE API KEY"**. Name it, and save it as a PDF. You will **not** be able to see `clientSecret` again.
5353

5454
![API Keys in the Arduino Cloud](assets/api-keys.png)
5555

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Each command has a set of **subcommands** which we will be exploring in this gui
7373

7474
- `arduino-cloud-cli credentials`
7575

76-
***Get your API key from the [Arduino Cloud home page](https://cloud.arduino.cc/home/) (bottom left corner of the page)***
76+
***Get your API key from the [Arduino Cloud API Keys page](https://app.arduino.cc/api-keys)***
7777

7878
To authenticate with the Arduino Cloud, we will need to first set our credentials, using our `clientId` and `clientSecret` which is obtained from the Arduino Cloud API keys section.
7979

Loading
Loading
Loading
Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
---
2+
title: 'Arduino UNO R4 Minima OPAMP'
3+
description: 'Learn how to use the built-in Operational Amplifier in the UNO R4 Minima'
4+
tags:
5+
- OPAMP
6+
author: 'Maximilian Gerhardt, Hannes Siebeneicher'
7+
hardware:
8+
- hardware/02.hero/boards/uno-r4-minima
9+
software:
10+
- web-editor
11+
- ide-v1
12+
- ide-v2
13+
---
14+
15+
In this tutorial, you will learn how to use the built-in operational amplifier (OPAMP) featured on the [Arduino UNO R4 Minima](https://store.arduino.cc/products/uno-r4-minima). Operational amplifiers are very versatile and can be used to e.g. mirror an electrical signal or amplify it.
16+
17+
## Goals
18+
19+
In this article, you will learn:
20+
- about the OPAMP feature onboard the UNO R4 Minima,
21+
- about the basics of the OPAMP library,
22+
- how to mirror a voltage signal,
23+
- how to amplify a voltage signal.
24+
25+
## Hardware & Software Needed
26+
To follow along with this article, you will need the following hardware:
27+
28+
- [Arduino UNO R4 Minima](https://store.arduino.cc/uno-r4-minima)
29+
- resistors
30+
- Jumper wires
31+
32+
33+
## Operational Amplifier (OPAMP)
34+
35+
An OPAMP is a versatile and widely used electronic component that belongs to the class of analog integrated circuits. Its primary function is to amplify voltage signals but they are very versatile and can be used to:
36+
37+
- mirror an input voltage to its output,
38+
- amplify a small analog voltage to its output pin, the UNO R4's output voltage range is 0 to ~4.7 V,
39+
- compare two input voltages and give a binary "higher" or "lower" output,
40+
- integrate and differentiate signals.
41+
42+
## Voltage Follower
43+
44+
The simplest way to test the OPAMP is to configure it as a voltage follower by connecting A2 to A3. In this setup, the voltage at A3 should mimic the voltage applied to A1. For instance, if you connect A1 to the ground (GND), the OPAMP output at A3 should also be at the ground potential. Similarly, if you connect A1 to 3.3 V, the output at A3 should be approximately 3.3 V.
45+
46+
## Circuit
47+
48+
![Voltage Follower Circuit](./assets/circuitFollowerMinima.png)
49+
50+
## Voltage Amplifier
51+
52+
***Caution: When amplifying the voltage of a battery using an operational amplifier, you should be aware of potential risks. The amplification process can lead to a high current draw, essentially placing a significant load on the battery, which may result in overheating, damage, or even pose a security risk. To mitigate this risk, you may for example add a resistor in series with the battery.***
53+
54+
A voltage amplifier, as the name suggests, amplifies the voltage. A simple 2x amplifier can be built using e.g. two `10k` resistors. Connect one resistor between "minus" and GND. Then use the second resistor to connect the output and "minus" together. A circuit diagram [can be seen below](#circuit). Any signal input at "plus" will now appear with double the amplitude at the output pin. Of course, the input signal and the Arduino board should share the same `GND`.
55+
56+
***The amplified output signal should not go above ~4.7 V, otherwise clipping will appear and you can damage the board***
57+
58+
Below is a capture of an oscilloscope in which an approx. 2 V square wave (green, channel 2) is amplified to a 4 V square wave (yellow, channel 1) with the circuit shown below. The input signal was generated by a function generation (and shared GND was connected).
59+
60+
![Oscilloscope measurements](./assets/amp_screenshot.png)
61+
62+
But let's say you want to amplify the voltage signal 4x instead of 2x. The amplification of an OPAMP mainly depends on the chosen resistor values. Take a look at the formula below:
63+
64+
![Calculate resistor value](./assets/calc.png)
65+
66+
**Av** = Amplified Voltage (V)
67+
68+
**R1** = Resistor connected to Ground (Ω)
69+
70+
**R2** = Feedback resistor (Ω)
71+
72+
We know we want to amplify the voltage times four so:
73+
74+
**Av** = 4 V
75+
76+
Now, we need to figure out what resistors to choose. Because we only can solve for one unknown value we choose a predefined value for one of the resistors, e.g. 10k Ω for R1.
77+
78+
**R1** = 10k Ω
79+
80+
Your formula should now look like this:
81+
82+
![Add values to the formula](./assets/numCalc.png)
83+
84+
That leaves R2 as the only unknown variable. Now, Subtract one from both sides and multiply by ten, which leaves us with:
85+
86+
**R2 = 30k Ω**
87+
88+
## Circuit
89+
90+
![Voltage 2x Amplifier Circuit](./assets/circuitAmplifierMinima.png)
91+
92+
***Read more about an amplifier circuit [here](https://www.electronics-tutorials.ws/opamp/opamp_3.html).***
93+
94+
## Code
95+
96+
To start up the opamp, simply include the library and call `OPAMP.begin(speed)`. As the optional `speed` argument to this function, can choose either `OPAMP_SPEED_LOWSPEED` as the low-speed (lower power) mode or `OPAMP_SPEED_HIGHSPEED` as the high-speed, high-power mode.
97+
98+
```arduino
99+
#include <OPAMP.h>
100+
101+
void setup () {
102+
OPAMP.begin(OPAMP_SPEED_HIGHSPEED);
103+
}
104+
105+
void loop() {}
106+
107+
```
Loading
Loading
Loading
Loading
Loading
Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
---
2+
title: 'Arduino UNO R4 WiFi OPAMP'
3+
description: 'Learn how to use the built-in Operational Amplifier in the UNO R4 WiFi'
4+
tags:
5+
- OPAMP
6+
author: 'Maximilian Gerhardt, Hannes Siebeneicher'
7+
hardware:
8+
- hardware/02.hero/boards/uno-r4-wifi
9+
software:
10+
- web-editor
11+
- ide-v1
12+
- ide-v2
13+
---
14+
15+
In this tutorial, you will learn how to use the built-in operational amplifier (OPAMP) featured on the [Arduino UNO R4 WiFi](https://store.arduino.cc/products/uno-r4-wifi). Operational amplifiers are very versatile and can be used to e.g. mirror an electrical signal or amplify it.
16+
17+
## Goals
18+
19+
In this article, you will learn:
20+
- about the OPAMP feature onboard the UNO R4 WiFi,
21+
- about the basics of the OPAMP library,
22+
- how to mirror a voltage signal,
23+
- how to amplify a voltage signal.
24+
25+
## Hardware & Software Needed
26+
To follow along with this article, you will need the following hardware:
27+
28+
- [Arduino UNO R4 WiFi](https://store.arduino.cc/uno-r4-wifi)
29+
- resistors
30+
- Jumper wires
31+
32+
33+
## Operational Amplifier (OPAMP)
34+
35+
An OPAMP is a versatile and widely used electronic component that belongs to the class of analog integrated circuits. Its primary function is to amplify voltage signals but they are very versatile and can be used to:
36+
37+
- mirror an input voltage to its output,
38+
- amplify a small analog voltage to its output pin, the UNO R4's output voltage range is 0 to ~4.7 V,
39+
- compare two input voltages and give a binary "higher" or "lower" output,
40+
- integrate and differentiate signals.
41+
42+
## Voltage Follower
43+
44+
The simplest way to test the OPAMP is to configure it as a voltage follower by connecting A2 to A3. In this setup, the voltage at A3 should mimic the voltage applied to A1. For instance, if you connect A1 to the ground (GND), the OPAMP output at A3 should also be at the ground potential. Similarly, if you connect A1 to 3.3 V, the output at A3 should be approximately 3.3 V.
45+
46+
## Circuit
47+
48+
![Voltage Follower Circuit](./assets/circuitFollowerWiFi.png)
49+
50+
## Voltage Amplifier
51+
52+
***Caution: When amplifying the voltage of a battery using an operational amplifier, you should be aware of potential risks. The amplification process can lead to a high current draw, essentially placing a significant load on the battery, which may result in overheating, damage, or even pose a security risk. To mitigate this risk, you may for example add a resistor in series with the battery.***
53+
54+
A voltage amplifier, as the name suggests, amplifies the voltage. A simple 2x amplifier can be built using e.g. two `10k` resistors. Connect one resistor between "minus" and GND. Then use the second resistor to connect the output and "minus" together. A circuit diagram [can be seen below](#circuit). Any signal input at "plus" will now appear with double the amplitude at the output pin. Of course, the input signal and the Arduino board should share the same `GND`.
55+
56+
***The amplified output signal should not go above ~4.7 V, otherwise clipping will appear and you can damage the board***
57+
58+
Below is a capture of an oscilloscope in which an approx. 2 V square wave (green, channel 2) is amplified to a 4 V square wave (yellow, channel 1) with the circuit shown below. The input signal was generated by a function generation (and shared GND was connected).
59+
60+
![Oscilloscope measurements](./assets/amp_screenshot.png)
61+
62+
But let's say you want to amplify the voltage signal 4x instead of 2x. The amplification of an OPAMP mainly depends on the chosen resistor values. Take a look at the formula below:
63+
64+
![Calculate resistor value](./assets/calc.png)
65+
66+
**Av** = Amplified Voltage (V)
67+
68+
**R1** = Resistor connected to Ground (Ω)
69+
70+
**R2** = Feedback resistor (Ω)
71+
72+
We know we want to amplify the voltage times four so:
73+
74+
**Av** = 4 V
75+
76+
Now, we need to figure out what resistors to choose. Because we only can solve for one unknown value we choose a predefined value for one of the resistors, e.g. 10k Ω for R1.
77+
78+
**R1** = 10k Ω
79+
80+
Your formula should now look like this:
81+
82+
![Add values to the formula](./assets/numCalc.png)
83+
84+
That leaves R2 as the only unknown variable. Now, Subtract one from both sides and multiply by ten, which leaves us with:
85+
86+
**R2 = 30k Ω**
87+
88+
## Circuit
89+
90+
![Voltage 2x Amplifier Circuit](./assets/circuitAmplifierWiFi.png)
91+
92+
***Read more about an amplifier circuit [here](https://www.electronics-tutorials.ws/opamp/opamp_3.html).***
93+
94+
## Code
95+
96+
To start up the opamp, simply include the library and call `OPAMP.begin(speed)`. As the optional `speed` argument to this function, can choose either `OPAMP_SPEED_LOWSPEED` as the low-speed (lower power) mode or `OPAMP_SPEED_HIGHSPEED` as the high-speed, high-power mode.
97+
98+
```arduino
99+
#include <OPAMP.h>
100+
101+
void setup () {
102+
OPAMP.begin(OPAMP_SPEED_HIGHSPEED);
103+
}
104+
105+
void loop() {}
106+
107+
```
Binary file not shown.

content/hardware/04.pro/boards/portenta-c33/tutorials/user-manual/content.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -921,7 +921,7 @@ First, the necessary libraries are included:
921921
- The `WiFiC3.h` and `WiFiClient.h` are included at the start, those libraries contains the functionalities required to communicate via Wi-Fi®.
922922
- The SSID and password for the Wi-Fi® network are defined.
923923

924-
Then, the server is defined ( "www.google.com" in this case) and the Wi-Fi® client object is created to manage the connection to the server.
924+
Then, the server is defined ( `www.google.com` in this case) and the Wi-Fi® client object is created to manage the connection to the server.
925925

926926
Next, in the `setup()` function:
927927

@@ -1059,7 +1059,7 @@ First, the necessary libraries are included:
10591059
- The `EthernetC33` library which contains the functionality required to communicate via Ethernet is included in the beginning.
10601060

10611061

1062-
Then, the server is defined, which is "www.google.com" in this case:
1062+
Then, the server is defined, which is `www.google.com` in this case:
10631063

10641064
- The static IP address which will be used if the DHCP fails to assign an IP address is set.
10651065

Binary file not shown.

content/hardware/04.pro/boards/portenta-x8/tutorials/07.custom-container/content.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ In this tutorial, we will create a simple container and upload it to the Arduino
2424
- [Portenta X8](https://store.arduino.cc/portenta-x8)
2525
- ADB: [Check how to connect to your Portenta X8](https://docs.arduino.cc/tutorials/portenta-x8/user-manual#out-of-the-box-experience)
2626
- USB-C® cable (either USB-C® to USB-A or USB-C® to USB-C®)
27-
- Arduino Pro Cloud Subscription [Learn more about the Pro Cloud](https://www.arduino.cc/pro/hardware/product/portenta-x8#pro-cloud)
27+
- Arduino Pro Cloud Subscription [Learn more about the Pro Cloud](https://cloud.arduino.cc/)
2828
- [Arduino IDE 1.8.10+](https://www.arduino.cc/en/software), [Arduino IDE 2](https://www.arduino.cc/en/software), or [Arduino Web Editor](https://create.arduino.cc/editor)
2929

3030
## Instructions

content/hardware/04.pro/shields/portenta-vision-shield/tutorials/ethernet-with-ide/content.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Next you can look at some of the code in the example sketch.
6868

6969
Now let's take a look at some important parts of the code.
7070

71-
The sketch will make the board connect to a website. This line in the code decides what website it connects to. The example uses "www.google.com", but feel free to change it and experiment with different websites.
71+
The sketch will make the board connect to a website. This line in the code decides what website it connects to. The example uses `www.google.com`, but feel free to change it and experiment with different websites.
7272

7373
```arduino
7474
char server[] = "www.google.com";

content/hardware/04.pro/shields/portenta-vision-shield/tutorials/ethernet-with-openmv/content.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ First you are making use of some micropython libraries, [network](http://docs.mi
6060
import network, usocket
6161
```
6262

63-
The script will make the board connect to a website and set a port for later use. This line in the code decides what website it connects to. The example uses "www.google.com", but feel free to change it and experiment with different websites.
63+
The script will make the board connect to a website and set a port for later use. This line in the code decides what website it connects to. The example uses `www.google.com`, but feel free to change it and experiment with different websites.
6464

6565
```arduino
6666
PORT = 80

content/hardware/06.nicla/boards/nicla-sense-me/product.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
---
22
title: Nicla Sense ME
33
url_shop: https://store.arduino.cc/products/nicla-sense-me
4-
url_guide: /software/ide-v1/tutorials/getting-started/cores/arduino-mbed_nicla
4+
url_guide: /tutorials/nicla-sense-me/cheat-sheet
5+
primary_button_url: /tutorials/nicla-sense-me/getting-started
6+
primary_button_title: Get Started
7+
secondary_button_url: /tutorials/nicla-sense-me/cheat-sheet
8+
secondary_button_title: Cheat Sheet
59
core: arduino:mbed_nicla
610
certifications: [CE, FCC, UKCA, WEEE, RoHS, IC, MIC, RCM]
711
productCode: '043'

content/hardware/06.nicla/boards/nicla-sense-me/tutorials/cheat-sheet/cheat-sheet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -731,7 +731,7 @@ Use the sensor IDs from the section "Sensor IDs" to enable and configure the des
731731

732732
The BHI260AP sensor runs a customizable firmware based on the BSX Sensor Fusion library. It provides a complete 9-axis fusion solution, which combines the measurements from 3-axis gyroscope, 3-axis geomagnetic sensor and a 3-axis accelerometer, to provide a robust absolute orientation vector. The algorithm fuses the sensor raw data from the accelerometer, geomagnetic sensor and gyroscope in an intelligent way to improve each sensor’s output.
733733

734-
Go to this [site](https://www.bosch-sensortec.com/software-tools/software/sensor-fusion-software/) or take a look at the BHI260AP's [datasheet](https://www.bosch-sensortec.com/media/boschsensortec/downloads/datasheets/bst-bhi260ap-ds000.pdf) for more information.
734+
Go to this [site](https://www.bosch-sensortec.com/software-tools/software/sensor-fusion-software-bsx/) or take a look at the BHI260AP's [datasheet](https://www.bosch-sensortec.com/media/boschsensortec/downloads/datasheets/bst-bhi260ap-ds000.pdf) for more information.
735735

736736
## Communication
737737

Binary file not shown.

content/hardware/06.nicla/boards/nicla-vision/product.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
title: Nicla Vision
33
url_shop: https://store.arduino.cc/products/nicla-vision
44
url_guide: /tutorials/nicla-vision/getting-started
5+
primary_button_url: /tutorials/nicla-vision/getting-started
6+
primary_button_title: Get Started
57
core: arduino:mbed_nicla
68
certifications: [CE, UKCA]
79
productCode: '120'

content/hardware/06.nicla/boards/nicla-vision/tutorials/getting-started/content.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,9 @@ While using the Nicla Vision with OpenMV, the RGB LED of the board can be used t
7373

7474
🟢 **Blinking Green:** Your Nicla Vision onboard bootloader is running. The onboard bootloader runs for a few seconds when your Nicla Vision is powered via USB to allow OpenMV IDE to reprogram your Nicla Vision.
7575

76-
🔵 **Blinking Blue:** Your Nicla Vision is running the default [main.py](http://main.py/) script onboard.
76+
🔵 **Blinking Blue:** Your Nicla Vision is running the default `main.py` script onboard.
7777

78-
If you overwrite the [main.py](http://main.py/) script on your Nicla Vision, then it will run whatever code you loaded on it instead.
78+
If you overwrite the `main.py` script on your Nicla Vision, then it will run whatever code you loaded on it instead.
7979

8080
***If the LED is blinking blue but OpenMV IDE cannot connect to your Nicla Vision, please make sure you are connecting your Nicla Vision to your PC with a USB cable that supplies both data and power.***
8181

content/hardware/06.nicla/boards/nicla-voice/product.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
title: Nicla Voice
33
url_shop: https://store.arduino.cc/nicla-voice
44
url_guide: /tutorials/nicla-voice/user-manual
5+
primary_button_url: /tutorials/nicla-voice/user-manual
6+
primary_button_title: User Manual
7+
secondary_button_url: /tutorials/nicla-voice/ei-intruder-detector
8+
secondary_button_title: Audio ML Guide
59
core: arduino:mbed_voice
610
productCode: 'ABX00061'
711
certifications: [CE, UKCA]

content/hardware/06.nicla/family.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
22
title: Nicla Family
33
description: Our smallest footprint packed with advanced features.
4+
businessUnit: pro
45
---

0 commit comments

Comments
 (0)