MicroPython content

content/micropython/01.basics/01.overview/overview.md

@@ -0,0 +1,30 @@
+---
+title: Overview
+description: An introduction to Arduino and MicroPython
+author: Francesca Sanfilippo
+micropython_type: basics
+---
+
+MicroPython is an implementation of the Python programming language, and includes some of the standard Python libraries. It is designed to run on microcontrollers with constrained environments.
+
+In this sequence of guides, you will among other things, learn how to:
+- Install MicroPython on your Arduino board,
+- Install an editor with support for MicroPython,
+- How to make basic scripts that can for example blink an LED, read an analog pin and print things to the terminal (REPL).
+
+You do not need any prior knowledge in either programming with Arduino or MicroPython, but it is recommended to know the basics of Python.
+
+What you need to do it is have a Compatible Board and a Code Editor. You can choose between two alternatives:
+- **Arduino Lab for MicroPython:** an experimental editor from Arduino, designed for simpler projects.
+- **OpenMV:** an editor for  more complex projects, such as computer vision.
+
+## Python vs C/C++.
+
+If you are experienced with Arduino programming in C and C++ a lot of the presented topics will look familiar to you.
+There's a big difference between how we program an Arduino board with the Arduino IDE, using the Arduino programming language (based on C++), and how we program it using MicroPython. 
+- The “Arduino way” requires compiling the sketch before uploading it to your board. The previous code running is replaced by the new one.
+- The “MicroPython way” does not require compiling, as you will have MicroPython installed on the actual board. Code is instead run through an interpreter, line by line.
+
+## Python vs MicroPython
+
+MicroPython was created to work under constrained conditions, like a small environment. The main difference between Python and MicroPython is that MicroPython does not have the full standard Python language, it is only a subset of it.

content/micropython/01.basics/02.board-installation/board-installation.md

@@ -0,0 +1,220 @@
+---
+title: Board Installation
+description: A list of Arduino boards compatible with MicroPython and how to install them.
+author: Francesca Sanfilippo, Karl Söderby & Jacob Hylén
+micropython_type: basics
+featured: micropython
+hero_image: "./hero-banner.png"
+---
+
+So what do you need to start your first project with MicroPython and Arduino? First, you will need a compatible board. In this page, you will find the compatible boards, with instructions on how to install them.
+
+In order to understand which board is more suitable to your project, you can visit the documentation of each board.
+
+## Nano 33 BLE & Nano 33 BLE Sense
+
+- [Nano 33 BLE documentation](/hardware/nano-ble).
+- [Nano 33 BLE Sense documentation.](/hardware/nano-ble-sense)
+- [Nano 33 BLE Sense Rev2 documentation.](/hardware/nano-ble-sense-rev2)
+
+![Nano 33 BLE.](assets/ble.png)
+
+The process for flashing the firmware on the Nano 33 BLE requires to first update the bootloader and SoftDevice. Once this is done you can flash the MicroPython firmware to your board.
+
+This process requires a version of the [Arduino IDE](https://www.arduino.cc/en/main/software) installed, which is explained in the next step.
+
+**Step 1: Installing the Core**
+
+Start by making sure that you have the respective core installed. Open the **Arduino IDE** (not Arduino Lab for MicroPython) and navigate to the boards manager. Search for your board (Nano 33 BLE), and make sure you have the latest version of the core installed. More detailed information about this step can be found [here](/software/ide-v2/tutorials/ide-v2-board-manager).
+
+![Board manager](assets/boardmanager.png)
+
+This is not only needed to upload the next sketch, but you're also going to dive into the core files themselves to find a specific tool in an upcoming step.
+
+**Step 2: Update Bootloader**
+
+In the Nano 33 BLE core is an example sketch that you will use to update the bootloader and SoftDevice of your board. Go back to the Arduino IDE and navigate to `File > Examples > Nano33BLE_System > Nano33_updateBLandSoftDevice` and open the sketch.
+
+![Example sketch](assets/examplesketch.png)
+
+Upload the sketch to your board. Beware! the bootloader is not updated just yet! Once the sketch is uploaded, you can interface with your board through the serial monitor to actually update the bootloader.
+
+In the Serial monitor, you are asked to confirm that you want to update the bootloader. In the message text box in the top of the serial monitor, write a **"y"** and press enter to send it to your board. 
+
+You can now watch as the bootloader update process progresses, **do not disconnect or reset your board during this process** or you could brick your board.
+
+Once this bar completes, you will be prompted with another choice. This time it asks if you want to update the SoftDevice on your board. Repeat the process of sending a **"y"** to the board, and watch the progress of this too.
+
+When this bar fills and the SoftDevice update completes, the board will restart, and you've successfully made it through the procedure. 
+
+***Note: An important thing to do at this point which is easily forgotten is to close the serial monitor, we will need to use the serial port for other things very soon and if you leave the monitor open it will be busy and won't be able to receive any new interactions.***
+
+**Step 3: Download Firmware**
+
+Now you will need to find the specific firmware that you need to flash to your board. You can find the available firmware on the [MicroPython](/micropython) Documentation site. 
+
+Download the `.bin` file that corresponds to the board you have. 
+
+Now you will need to dive into the core files you downloaded in the first step to find a command line tool that is included called BOSSAC. This process will be different for you depending on if you're on a Windows or MacOS computer.
+
+
+**Step 4a: Flash Firmware (Windows)**
+
+>Instructions for MacOS are available just below this section.
+
+The file you will is named `bossac.exe` and can be found in the following directory:
+
+```
+C:\Users\[your-username]\AppData\Local\Arduino15\staging\packages\bossac-1.9.1-arduino2-windows.tar.gz\bossac-1.9.1-arduino2-windows.tar\bin\` 
+```
+
+One you've found the file, extract it from the `.tar` archive and copy it somewhere else, your desktop for example. 
+
+Open a command terminal and start typing in `start`, now drag and drop the bossac.exe file you've found into the terminal, and press enter.
+
+If successful, another command terminal window should open in which you are able to execute the command that will flash your board with the MicroPython firmware.
+
+Execute the following command, but replace the port with the name of the port where your board is connected, and the firmware file with the directory where you have placed the firmware you downloaded previously:
+
+```
+bossac -e -w --offset=0x16000 --port=[port] -i -d -U -R [firmware]
+```
+
+Don't disconnect or power off your board during this part of the process, watch the progress of flashing the firmware to your board. Once complete, you're all set and you're ready to start programming the board in MicroPython.
+
+Go to the Arduino Lab MicroPython IDE and press connect in the top left, choose the port, and you are now ready to program your Nano 33 BLE.
+
+**Step 4b: Flash Firmware (MacOS)**
+
+The file you will need to access is called `bossac` and can be found in the following directory: 
+
+```
+Users/[your-user]/Library/Arduino15/packages/arduino/tools/bossac/1.9.1-arduino2
+```
+
+***Note: The `"Library"` directory is hidden, press `Shift + Command + . ` to reveal hidden directories.***
+
+Open a terminal window and drag and drop the `bossac` file into the terminal window.
+
+Now, you should be able to execute the command that will flash your board with the MicroPython firmware.
+
+Execute the following command, but replace the port with the name of the port where your board is connected, and the firmware file with the directory where you have placed the firmware you downloaded previously:
+
+```
+bossac -e -w --offset=0x16000 --port=[port] -i -d -U -R [firmware]
+```
+
+Again, don't disconnect or power off your board during this part of the process, watch the progress of flashing the firmware to your board. Once complete, you're all set and you're ready to start programming the board in MicroPython.
+
+Go to the Arduino Lab MicroPython IDE and press connect in the top left, choose the port, and you are now ready to program your Nano 33 BLE!
+
+## Nano RP2040 Connect
+
+- [Arduino Nano RP2040 Documentation](https://docs.arduino.cc/hardware/nano-rp2040-connect)
+
+![Nano RP2040 Connect.](assets/nano-rp2040.png)
+
+To program your Nano RP2040 Connect board with MicroPython, follow the instructions below. The installation for Nano RP2040 Connect requires no additional software tools for installation.
+
+Follow the steps below to install MicroPython on the Nano RP2040 Connect board.
+
+1. Download the `.uf2` firmware file from the [MicroPython](/micropython) page.
+2. Connect the `REC` pin to `GND` (they are placed next to each other) and press the reset button. This exposes the board's file system to your computer.
+3. Drag and drop the firmware file onto the boards flash storage which shows up as an external storage device on your computer
+4. Go to the Arduino Lab MicroPython IDE and press connect in the top left, choose the port.
+
+Congratulations, you are now ready to program your Nano RP2040 Connect with MicroPython.
+
+## GIGA R1 WiFi
+
+- [Arduino GIGA R1 WiFi documentation](/hardware/giga-r1-wifi)
+
+![GIGA R1 WiFi.](assets/giga-r1-wifi.png)
+
+The installation instructions for the **GIGA R1 WiFi** is identical to the **Portenta H7** instructions found just below. 
+
+You will however need a different firmware, which you can download from the link below:
+
+- [Download GIGA R1 WiFi MicroPython firmware (dfu)](/resources/firmware/GIGAR1_MP_FW.dfu)
+
+***The GIGA R1 WiFi and Portenta H7 boards are based on the same microcontroller, [STM32H747XI](static/resources/datasheets/stm32h747xi.pdf) and therefore share the same installation instructions.***
+
+## Portenta H7
+
+- [Arduino Portenta H7 Documentation](https://docs.arduino.cc/hardware/portenta-h7)
+
+![Portenta H7.](assets/portenta.png)
+
+To install MicroPython on the Portenta H7 you will first need to install the corresponding core which also installs the required command line tool, called `dfu-util`.  
+
+This tool can be used to directly flash a binary to your board, in this case, a MicroPython build. 
+
+***The instructions below uses the `dfu-util` that is bundled with the Arduino IDE. You can also obtain the `dfu-util` directly, through the [dfu-util home page](https://dfu-util.sourceforge.net/) or via package management systems such as [Homebrew](https://formulae.brew.sh/formula/dfu-util) (MacOS / Linux).***
+
+**Step 1: Install Arduino IDE**
+
+First, download and install the [Arduino IDE](https://arduino.cc/en/software) for your operating system.
+
+Open the Arduino IDE (not Arduino Lab for MicroPython) and navigate to the boards manager. Search for "Portenta H7", and make sure you have the latest version of the core installed.
+
+![Installing the Portenta core](assets/boardmanager-portenta.png)
+
+**Step 2: Download Firmware**
+
+Now you will need to find the specific firmware that you need to flash to your board. You can find the available firmware on the [MicroPython with Arduino](https://docs.arduino.cc/micropython/) home page. The firmware is available as a `.dfu` file for the Portenta H7.
+
+In the next step you will be diving into the core files you downloaded in the first step to find a command line tool called **dfu-util**. This process is differs depending on if you're on a Windows or MacOS computer. MacOS instructions are available further below.
+
+**Step 3a: Install Firmware (Windows)**
+
+To flash your board, you will need a file named `dfu-util.exe`. This is found in your following directory:
+
+```     
+C:\Users\<your-username>\AppData\Local\Arduino15\staging\packages\dfu-util-0.10.0-arduino1-windows.tar.bz2\dfu-util-0.10.0-arduino1-windows.tar\windows\ 
+```
+
+One you've found the file, extract it from the .tar archive and copy it somewhere else, your desktop for example. 
+
+Open a command terminal and start typing in `start`, now drag and drop the dfu-util.exe file you've found into the terminal, and press enter.
+
+If successful, another command terminal window should open in which you are able to execute the command that will flash your board with the MicroPython firmware.
+
+Double tap the reset button on your board to put it in DFU mode, and execute the following command, but replace the path of the firmware file with the directory where you have placed the firmware you downloaded previously:
+
+```
+dfu-util -a 0 -d 0x2341:0x035b -D <firmware>.dfu
+```
+
+Again, don't disconnect or power off your board during this part of the process, watch the progress of flashing the firmware to your board.
+
+You should now see **two** progress bars appear in one after the other. The first one is showing the progress of erasing the firmware that was previously on the board, and the second one is showing the progress of flashing the new firmware. 
+
+Once complete, you're all set and you're ready to start programming the board in MicroPython.
+
+Go to the Arduino Lab MicroPython IDE and press connect in the top left, choose the port, and code away!
+
+**Step 3b: Install Firmware (MacOS)**
+
+The file you will need to access is named `dfu-util` and can be found in the following directory: 
+
+```
+Users/[your-username]/Library/Arduino15/packages/arduino/tools/dfu-util/0.10.0-arduino1/dfu-util
+```
+
+***Note: The `"Library"` directory is hidden, press `Shift + Command + . ` to reveal hidden directories.*** 
+
+Open a terminal window and drag and drop the dfu-util file into the terminal window.
+
+Now, you should be able to execute the command that will flash your board with the MicroPython firmware.
+
+Double tap the reset button on your board to put it in DFU mode, and execute the following command, but replace the path of the firmware file with the directory where you have placed the firmware you downloaded previously:
+
+```
+dfu-util -a 0 -d 0x2341:0x035b -D <firmware>.dfu
+```
+
+Do not disconnect your board during this part of the process, watch the progress of flashing the firmware to your board. 
+
+Once complete, you're all set and you're ready to start programming the board in MicroPython.
+
+Go to the Arduino Lab MicroPython IDE and press connect in the top left corner, choose the port and you are ready to load scripts to your board.

content/micropython/01.basics/03.code-editors/code-editors.md

@@ -0,0 +1,30 @@
+---
+title: Code Editors
+description: Explore the available code editors for programming your Arduino board with MicroPython
+author: Francesca Sanfilippo & Karl Söderby
+micropython_type: basics
+featured: micropython
+hero_image: "./hero-banner.png"
+---
+
+To write and load scripts to your board, you will also need a Code Editor. In this page, you will find two alternatives:
+- **Arduino Lab for MicroPython:** an experimental editor from Arduino, designed for simpler projects.
+- **OpenMV:** an editor for  more complex projects, such as computer vision.
+
+## Arduino Lab for MicroPython
+
+Arduino Lab for MicroPython is a software that supports programming Arduino boards with MicroPython. Through the customized editor, we can install MicroPython, and upload scripts directly to the board.  The editor is able to manage the files and you can see what is uploaded on the board and vice versa.
+
+![Arduino Lab for MicroPython](assets/mpylabs-ss.png)
+
+- [Download Arduino Lab for MicroPython](https://labs.arduino.cc/en/labs/micropython).
+
+## OpenMV Editor
+
+OpenMV is a platform that supports programming Arduino boards with MicroPython. Through the OpenMV editor, we can install MicroPython and upload scripts directly to the board. There's also a number of examples available directly in the editor.
+
+![OpenMV editor.](assets/openmv-ss.png)
+
+- [Download OpenMV](https://openmv.io/pages/download).
+
+***You can also check out the full list of examples in the [OpenMV's GitHub repository](https://github.com/openmv/openmv/tree/master/scripts/examples/10-Arduino-Boards).***