Skip to content

Commit af46b9a

Browse files
committed
update links
Update links and remove some sections. - removed board examples reference to wifi / BT section as they do not exist yet
1 parent f80da05 commit af46b9a

File tree

19 files changed

+50
-81
lines changed

19 files changed

+50
-81
lines changed

content/micropython/00.first-steps/00.intro-micropython/intro-micropython.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ MicroPython is a lightweight implementation of Python 3 designed to run on micro
1212

1313
![MicroPython with Arduino](assets/micropython-arduino.png)
1414

15-
When using MicroPython on Arduino boards, the software is first installed on your Arduino. This allows the board to interpret and run Python code. Once MicroPython is installed on your board (don't worry, we'll cover this [here]()), you can start writing and executing Python scripts instantly.
15+
When using MicroPython on Arduino boards, the software is first installed on your Arduino. This allows the board to interpret and run Python code. Once MicroPython is installed on your board (don't worry, we'll cover this [here](/micropython/first-steps/install-guide)), you can start writing and executing Python scripts instantly.
1616

1717
Unlike traditional development approaches, where you compile code and then flash it to the board, with MicroPython you write Python scripts and run them instantly on your Arduino. This makes the development process much faster and more interactive.
1818

@@ -38,7 +38,7 @@ The MicroPython installation includes several key components:
3838

3939
## How to Program for MicroPython
4040

41-
Programming in MicroPython involves writing Python scripts in a text editor and then running them on your board. For this, we can use the [Arduino Lab for MicroPython]().
41+
Programming in MicroPython involves writing Python scripts in a text editor and then running them on your board. For this, we can use the [Arduino Lab for MicroPython](https://labs.arduino.cc/en/labs/micropython).
4242

4343
When writing MicroPython code, it's essential to think in terms of **modularity**. A good practice is to break down your code into smaller, reusable modules rather than writing everything in one large file. This approach makes it easier to manage and maintain code, especially for larger projects.
4444

content/micropython/00.first-steps/01.install-guide/installing-micropython.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,6 @@ By following these steps, you should be able to successfully install MicroPython
113113
### Next Steps
114114

115115
This tutorial is **Part Two** of the **"First Steps"** series. We recommend you following the next tutorial that will allow you to control the Arduino board's LED.
116-
- [First Steps - Part Three]()
116+
- [First Steps - My First Script](/micropython/first-steps/first-script)
117117

118118

content/micropython/00.first-steps/02.first-script/first-script.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,13 @@ MicroPython is officially supported on several Arduino boards. Here’s a list o
4141

4242
## Board and Editor Setup
4343

44-
1. Open the [Arduino Lab for MicroPython]() application.
44+
1. Open the [Arduino Lab for MicroPython](https://labs.arduino.cc/en/labs/micropython) application.
4545
2. Plug the Arduino board into the computer using a USB cable.
4646
![Connect board to computer.](assets/usb-comp.png)
4747
3. Press the connection button on the top left corner of the window. The connected Arduino board should appear (by its port name), and we can click it:
4848
![Connect to the board in the editor.](assets/select-board-ide.png)
4949

50-
***Need help installing MicroPython on your board? Visit the [MicroPython installation guide]().***
50+
***Need help installing MicroPython on your board? Visit the [MicroPython installation guide](/micropython/first-steps/install-guide).***
5151

5252
## First Script (LED Blink)
5353

content/micropython/01.basics/00.digital-io/digital-io.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -60,13 +60,13 @@ In this guide, we will be using some additional electronic components:
6060

6161
## Board and Editor Setup
6262

63-
1. Open the [Arduino Lab for MicroPython]() application.
63+
1. Open the [Arduino Lab for MicroPython](https://labs.arduino.cc/en/labs/micropython) application.
6464
2. Plug the Arduino board into the computer using a USB cable.
6565
![Connect board to computer.](assets/usb-comp.png)
6666
3. Press the connection button on the top left corner of the window. The connected Arduino board should appear (by its port name), and we can click it:
6767
![Connect to the board in the editor.](assets/select-board-ide.png)
6868

69-
***Need help installing MicroPython on your board? Visit the [MicroPython installation guide]().***
69+
***Need help installing MicroPython on your board? Visit the [MicroPython installation guide](/micropython/first-steps/install-guide).***
7070

7171
## Digital Outputs
7272

content/micropython/01.basics/01.analog-io/analog-io.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -52,13 +52,13 @@ In this guide, we will be using some additional electronic components:
5252

5353
## Board and Editor Setup
5454

55-
1. Open the [Arduino Lab for MicroPython]() application.
55+
1. Open the [Arduino Lab for MicroPython](https://labs.arduino.cc/en/labs/micropython) application.
5656
2. Plug the Arduino board into the computer using a USB cable.
5757
![Connect board to computer.](assets/usb-comp.png)
5858
3. Press the connection button on the top left corner of the window. The connected Arduino board should appear (by its port name), and we can click it:
5959
![Connect to the board in the editor.](assets/select-board-ide.png)
6060

61-
***Need help installing MicroPython on your board? Visit the [MicroPython installation guide]().***
61+
***Need help installing MicroPython on your board? Visit the [MicroPython installation guide](/micropython/first-steps/install-guide).***
6262

6363
## Analog Inputs
6464

content/micropython/01.basics/02.loops/loops.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,13 @@ MicroPython is officially supported on several Arduino boards. Here’s a list o
4141

4242
## Board and Editor Setup
4343

44-
1. Open the [Arduino Lab for MicroPython]() application.
44+
1. Open the [Arduino Lab for MicroPython](https://labs.arduino.cc/en/labs/micropython) application.
4545
2. Plug the Arduino board into the computer using a USB cable.
4646
![Connect board to computer.](assets/usb-comp.png)
4747
3. Press the connection button on the top left corner of the window. The connected Arduino board should appear (by its port name), and we can click it:
4848
![Connect to the board in the editor.](assets/select-board-ide.png)
4949

50-
***Need help installing MicroPython on your board? Visit the [MicroPython installation guide]().***
50+
***Need help installing MicroPython on your board? Visit the [MicroPython installation guide](/micropython/first-steps/install-guide).***
5151

5252
## Loop Structures in MicroPython
5353

content/micropython/01.basics/03.data-logger/data-logger.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Data logging using MicroPython is a great feature, as we can use the board's fil
99

1010
In this tutorial, we will create a `.csv` file, make some readings from an analog pin, and store the data in the file. The file can then be accessed via the Arduino Lab for MicroPython editor.
1111

12-
***To learn more about the MicroPython file system, visit [this article]().***
12+
***To learn more about the MicroPython file system, visit [this article](/micropython/environment/file-system).***
1313

1414
## Requirements
1515

@@ -43,13 +43,13 @@ MicroPython is officially supported on several Arduino boards. Here’s a list o
4343

4444
## Board and Editor Setup
4545

46-
1. Open the [Arduino Lab for MicroPython]() application.
46+
1. Open the [Arduino Lab for MicroPython](https://labs.arduino.cc/en/labs/micropython) application.
4747
2. Plug the Arduino board into the computer using a USB cable.
4848
![Connect board to computer.](assets/usb-comp.png)
4949
3. Press the connection button on the top left corner of the window. The connected Arduino board should appear (by its port name), and we can click it:
5050
![Connect to the board in the editor.](assets/select-board-ide.png)
5151

52-
***Need help installing MicroPython on your board? Visit the [MicroPython installation guide]().***
52+
***Need help installing MicroPython on your board? Visit the [MicroPython installation guide](/micropython/first-steps/install-guide).***
5353

5454
## Data Logger Example
5555

content/micropython/02.environment/00.online-editor/online-editor.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@ description: 'The Arduino Lab for MicroPython is an online code editor for writi
44
author: 'Karl Söderby'
55
---
66

7-
The [Arduino Lab for MicroPython](https://lab-micropython.arduino.cc/) is an online code editor that allows you to load MicroPython scripts to your Arduino board. This editor is part of the [Arduino Cloud](), and is free to use for everyone.
7+
The [Arduino Lab for MicroPython](https://lab-micropython.arduino.cc/) is an online code editor that allows you to load MicroPython scripts to your Arduino board. This editor is part of the [Arduino Cloud](https://app.arduino.cc/), and is free to use for everyone.
88

99
In this tutorial, we will take a look at how we can access it, and test it out by writing a simple script.
1010

11-
***Note that this tutorial does not go in depth on how the Arduino Lab for MicroPython works. For more details, you can visit the [guide to the Arduino Lab for MicroPython]().***
11+
***Note that this tutorial does not go in depth on how the Arduino Lab for MicroPython works. For more details, you can visit the [guide to the Arduino Lab for MicroPython](/micropython/environment/code-editor).***
1212

1313
## Requirements
1414

1515
- **Google Chrome, Opera, Edge** - these are the currently supported browsers.
16-
- [Arduino Cloud account registered]()
17-
- [A MicroPython compatible board]()
16+
- [Arduino Cloud account registered](https://login.arduino.cc/login)
17+
- [A MicroPython compatible board](/micropython/first-steps/install-guide/#micropython-compatible-arduino-boards)
1818

1919
## Setting Up
2020

21-
***To follow these steps, you will need to have MicroPython installed on your board. Haven't done this yet? Don't worry, check out the [Installing MicroPython]() guide.***
21+
***To follow these steps, you will need to have MicroPython installed on your board. Haven't done this yet? Don't worry, check out the [Installing MicroPython](/micropython/environment/code-editor) guide.***
2222

2323
Setting up the online environment is quick and easy. Follow the steps below to achieve it:
2424

content/micropython/02.environment/01.code-editor/code-editor.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ Arduino Lab for MicroPython includes a user-friendly code editor that helps us w
99

1010
## Requirements
1111

12-
- [Arduino Lab for MicroPython]()
12+
- [Arduino Lab for MicroPython](https://labs.arduino.cc/en/labs/micropython)
1313
- **MicroPython compatible board** (not required for using the editor, but for running any code).
1414

15-
***Note that the Arduino Lab for MicroPython is now also available online, as part of the Arduino Cloud platform. You will find it here: [Arduino Cloud - Arduino Lab for MicroPython]().***
15+
***Note that the Arduino Lab for MicroPython is now also available online, as part of the Arduino Cloud platform. You will find it here: [Arduino Cloud - Arduino Lab for MicroPython](/micropython/environment/code-editor).***
1616

1717
## Arduino Labs for MicroPython
1818

@@ -47,14 +47,14 @@ Managing files in the Arduino Lab for MicroPython is straightforward and allows
4747

4848
![Managing files in Arduino Lab for MicroPython](assets/IDEFileManager.png)
4949

50-
***For a detailed tutorial on using the file system, please refer to the [File System Tutorial]().***
50+
***For a detailed tutorial on using the file system, please refer to the [File System Tutorial](/micropython/environment/file-system).***
5151

5252
### REPL
5353

5454
The REPL can be found by expanding the terminal. Here you can interact with the terminal. The buttons allow for basic features like copy and pasting as the shortcuts like ```CTRL+C will´´´ not work on this window.
5555

5656
![The REPL.](assets/consoleTerminal.png)
57-
***For a detailed tutorial on using the file system, please refer to the [File System Tutorial]().***
57+
***For a detailed tutorial on using the file system, please refer to the [File System Tutorial](/micropython/environment/file-system).***
5858

5959
## Code Editor
6060

content/micropython/02.environment/02.file-system/file-system.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ This runs from main.py # executed from main.py
7373
This runs from my_new_script #executed from my_new_script
7474
```
7575

76-
Essentially, this is how [modules]() work. You import a module, and use a function from that module.
76+
Essentially, this is how [modules](/micropython/environment/modules) work. You import a module, and use a function from that module.
7777

7878
![Import code from a script.](assets/ImportScript.png)
7979

content/micropython/02.environment/03.modules/modules.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ In this example, `time.sleep()` introduces a delay. Built-in modules like `time`
3838

3939
## External Modules
4040

41-
Some modules aren’t included with the default MicroPython installation and need to be installed separately. External modules, often provided by the community or specific hardware packages, extend MicroPython’s functionality. For example, the [Modulino library]() is an external module that provides tools for working with Arduino Modulinos.
41+
Some modules aren’t included with the default MicroPython installation and need to be installed separately. External modules, often provided by the community or specific hardware packages, extend MicroPython’s functionality. For example, the [Modulino library](https://github.com/arduino/arduino-modulino-mpy) is an external module that provides tools for working with Arduino Modulinos.
4242

4343
To demonstrate how to use external modules, we’ll go through the steps to install the Modulino package on an Arduino board.
4444

@@ -51,7 +51,7 @@ Before we can install external modules, we need to have MicroPython running on o
5151
- Press the "Refresh" button if the board does not appear.
5252
- Click "**Install MicroPython**" and wait for the installation to complete.
5353

54-
***For more details, visit the [MicroPython installation guide]()***
54+
***For more details, visit the [MicroPython installation guide](/micropython/first-steps/install-guide)***
5555

5656
### Step 2: Install the Modulino Package
5757

content/micropython/02.environment/05.repl/repl.md

-4
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,6 @@ When writing `name` in the REPL, (after `name = "Pedro"`), we should get:
4646
'Pedro'
4747
```
4848

49-
![TODO: GIF showing step by step so people understand to run each individually]()
50-
5149
## Example: Perform a Calculation in the REPL
5250

5351
Now let's create a REPL session that performs a calculation, by adding two numbers together:
@@ -59,8 +57,6 @@ Now let's create a REPL session that performs a calculation, by adding two numbe
5957
8
6058
```
6159

62-
![TODO: GIF showing step by step so people understand to run each individually]()
63-
6460
In this REPL session, we:
6561

6662
- Defined variables by setting `a` to `5` and `b` to `3`.

content/micropython/03.language/01.reference/reference.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1336,7 +1336,7 @@ print("Hello World!")
13361336

13371337
`while True:`
13381338

1339-
A loop is not required in a MicroPython script, but is required in order to run a script continuously on the board. To have a loop in a program, we need to use a [while loop]().
1339+
A loop is not required in a MicroPython script, but is required in order to run a script continuously on the board. To have a loop in a program, we need to use a [while loop](/micropython/basics/loops/#while-loops).
13401340

13411341
**Example:**
13421342

content/micropython/04.board-examples/giga-r1-wifi/giga-r1-wifi.md

+7-25
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
22
title: GIGA R1 WiFi
33
description: Learn how to use specific features on the GIGA R1 WiFi using MicroPython
4+
author: Pedro Sousa Lima
45
---
6+
57
![GIGA R1 WiFi](./assets/giga-r1.png)
68

79
In this guide, you will find information specific to the [GIGA R1 WiFi board](https://store.arduino.cc/products/giga-r1-wifi), such as supported serial protocols, built-in peripherals, and how to access the wireless features.
@@ -26,16 +28,6 @@ The GIGA R1 WiFi has several board-specific features that we can access through
2628
- **Wireless Connectivity**: Supports both **Wi-Fi®** and **Bluetooth®** using the integrated Murata 1DX module.
2729
- **High-speed Connectivity**: Includes a USB-C® connector, high-speed UART, and CAN bus support.
2830

29-
30-
## Wireless Connectivity
31-
32-
The GIGA R1 WiFi features a Murata 1DX module that provides both **Wi-Fi®** and **Bluetooth®** connectivity. To find examples, please visit the links below:
33-
34-
- **[MicroPython - Bluetooth® documentation]()**
35-
- **[MicroPython - Wi-Fi® documentation]()**
36-
37-
38-
3931
## Dual-Core Programming
4032

4133
The GIGA R1 WiFi supports dual-core programming, where the Cortex-M7 and Cortex-M4 cores can execute separate tasks simultaneously. Below is an example of how to run MicroPython on one core while offloading specific tasks to the other:
@@ -60,9 +52,7 @@ def main_task():
6052
main_task()
6153
```
6254

63-
> **Note**: Dual-core programming is an advanced topic and requires proper synchronization to avoid resource conflicts.
64-
65-
55+
**Note**: Dual-core programming is an advanced topic and requires proper synchronization to avoid resource conflicts.
6656

6757
## RGB LED
6858

@@ -140,20 +130,21 @@ ch.pulse_width_percent(25) # 25% duty cycle
140130

141131
The **msgpackrpc** library provides the same functionality as the Arduino RPC library for MicroPython, allowing seamless communication between the two cores (M7 and M4) on the GIGA R1 WiFi. This library enables binding of local functions or objects, starting the M4 core, and invoking remote calls from Python scripts.
142132

143-
#### Key Features:
133+
### Key Features:
144134
- **Dual-Core Support**: Execute tasks on the M4 core while the main MicroPython code runs on the M7 core.
145135
- **Ease of Use**: The library is built-in and enabled by default in compatible Arduino boards, starting with MicroPython release v1.23.
146136
- **No External Dependencies**: The library is included in the MicroPython firmware and does not require additional installations.
147137

148138

149-
#### Restrictions:
139+
### Restrictions:
140+
150141
While powerful, the **msgpackrpc** library has some limitations:
151142
1. Arduino sketches can only run on the **M4 core**.
152143
2. **SDRAM-based firmware** is not supported.
153144
3. **Flash-based firmware** must use a 1.5MB M7 + 0.5MB M4 flash partitioning scheme.
154145

155146

156-
#### Example
147+
### Example
157148

158149
Here’s how to bind a function on the M7 core and call it from the M4 core:
159150

@@ -189,15 +180,6 @@ print(result) # Outputs: Hello from M7!
189180

190181
For a detailed explanation of the RPC library, including advanced use cases and configuration, visit the [RPC Library with MicroPython guide](https://docs.arduino.cc/tutorials/giga-r1-wifi/giga-dual-core/#using-the-rpc-library-with-micropython).
191182

192-
193-
## Additional Features
194-
195-
The GIGA R1 WiFi includes other features that can be explored:
196-
197-
- **Analog Pins**: Use `ADC` to read analog values from sensors.
198-
- **PWM**: Use `PWM` for pulse-width modulation to control motors or LEDs.
199-
200-
201183
## Summary
202184

203185
The GIGA R1 WiFi is a robust microcontroller packed with advanced features for embedded programming with MicroPython. From dual-core programming to high-speed connectivity and wireless communication, this guide provides the essentials to get started with this powerful board.

content/micropython/04.board-examples/nano-ble-sense/nano-ble-sense.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@ author: Karl Söderby
66

77
![Nano BLE Sense](assets/ble-sense.png)
88

9-
In this guide, you will find information specific to the [Nano BLE Sense board](), such as supported serial protocols and built-in sensors that can be accessed.
9+
In this guide, you will find information specific to the [Nano BLE Sense board](https://store.arduino.cc/products/nano-33-ble-sense-rev2), such as supported serial protocols and built-in sensors that can be accessed.
1010

1111
For installation instructions, please visit the link below.
12-
- [Installing MicroPython]()
12+
- [Installing MicroPython](/micropython/first-steps/install-guide)
1313

1414
## Pinout
1515

1616
The pinout for the Nano BLE Sense can be found in the image below.
1717

1818
![Nano BLE Sense Pinout](assets/ABX00031-pinout.png)
1919

20-
***For more details on this product, visit the [hardware product page](/hardware/nano-rp2040-connect/).***
20+
***For more details on this product, visit the [hardware product page](/hardware/nano-33-ble-sense-rev2/).***
2121

2222
## Board Specific Features
2323

@@ -297,7 +297,7 @@ devices = i2c.scan()
297297
print("I2C devices found:", devices)
298298
```
299299

300-
***Read more about I2C in [this article]().***
300+
***Read more about I2C in [this article](/micropython/communication/i2c).***
301301

302302
### UART
303303

@@ -315,7 +315,7 @@ data = uart.read()
315315
print("Received:", data)
316316
```
317317

318-
***Read more about SPI in [this article]().***
318+
***Read more about SPI in [this article](/micropython/communication/spi).***
319319

320320
### SPI
321321

@@ -336,4 +336,4 @@ spi = SPI(1, baudrate=1000000, polarity=0, phase=0, sck=Pin(18), mosi=Pin(23), m
336336
print("SPI initialized")
337337
```
338338

339-
***Read more about UART in [this article]().***
339+
***Read more about UART in [this article](/micropython/communication/uart).***

0 commit comments

Comments
 (0)