Skip to content

Commit 7619ab4

Browse files
committed
Minor docs update
Adding initial UF2 page & minor changes to existing files.
1 parent 7ee2dee commit 7619ab4

File tree

4 files changed

+107
-3
lines changed

4 files changed

+107
-3
lines changed

docs/introduction.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,23 @@
22

33

44

5-
The IoT RedBoard - RP2350
5+
The IoT RedBoard - RP2350 combines the RP2350 microcontroller with the Raspberry Pi Radio Module 2 to provide a powerful and versatile wireless development platform in the Arduino R4 form factor. In this guide we'll cover how to connect the IoT RedBoard - RP2350 to a computer and how to progam it three development environments: Raspberry Pi Pico SDK, MicroPython, or Arduino.
6+
7+
This guide uses just the hardware present on the IoT RedBoard - RP2350 so in order to follow along with this tutorial you'll only need the following items:
8+
9+
* [IoT RedBoard - RP2350]()
10+
* [USB-C Cable]()
11+
12+
## Major Topics Covered
13+
14+
This document contains three main sections: **Quickstart Guide**, **Hardware** and **Software**.
15+
16+
The Quickstart Guide assumes a working knowledge of how to use a development board and the required software to program them for your project's needs. It covers a quick assembly and then jumps right into getting the necessary software packages installed to start uploading code in just a few short minutes. The document finishes with simple examples for each development environment showing how to set up and use the RM2 wireless chip to connect to a WiFi network.
17+
18+
The Hardware page provides a detailed overview of the IoT RedBoard - RP2350 along with all the major components included on the board. Refer to this page for information on things like the RP2350, LEDs, pinout and solder jumpers.
19+
20+
The Software pages are split into each supported development environment along with a page that goes into detail on what the UF2 bootloader is and how to use it on the IoT RedBoard - RP2350. Each software page gives instructions on how to download install its respective development environment, any necessary support packages including board definitions and, where necessary, library packages, and includes a couple simple examples to ensure everything is working properly.
21+
22+
## Resources and Support Documentation
23+
24+
You'll find the board design files (KiCad files & schematic), relevant documentation (datasheets, white papers, etc.) and other helpful links in the **Resources**. Lastly, the **Support** section includes a Troubleshooting page that includes any helpful tips specific to this board as well as information on how to receive technical support from SparkFun.

docs/quickstart.md

Lines changed: 61 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22

33

4-
Welcome to the SparkFun IoT RedBoard - RP2350 Quick Start Guide. This streamlined version of our standard Hookup Guides assumes a working knowledge of how to use a development board and the required software to program them for your project's needs. It covers a quick assembly and then jumps right into getting the necessary software packages installed to start uploading code in just a few short minutes. The guide finishes with simple examples for each development environment showing how to set up and use the RM2 wireless chip to connect to a WiFi network.
4+
Welcome to the SparkFun IoT RedBoard - RP2350 Quick Start Guide. This streamlined version of our standard Hookup Guides assumes a working knowledge of how to use a development board and the required software to program them for your project's needs. It covers a quick assembly and then jumps right into getting the necessary software packages installed to start uploading code in just a few short minutes. The document finishes with simple examples for each development environment showing how to set up and use the RM2 wireless chip to connect to a WiFi network.
55

66
If you're not familiar with using development boards or the development environments covered in this guide, refer to the Hardware & Software sections for a detailed overview of the board along with instructions on setting up and programming the IoT RedBoard - RP2350.
77

@@ -50,7 +50,66 @@ The IoT RedBoard - RP2350 is supported in **version needed - ML** of the Pico SD
5050

5151
The IoT RedBoard - RP2350 has Beta releases of MicroPython firmware available [here](https://github.com/sparkfun/micropython/releases). Download and install the MicroPython firmware onto your IoT RedBoard - RP2350, open your preferred Python IDE (or CLI) and copy the code below into it:
5252

53-
**Insert example code -ML**
53+
**Code to Note**:
54+
LED control. Values are (R,G,B) 0-255. This sets the LED to full Red.
55+
``` py
56+
led[0] = (255, 0, 0)
57+
led.write()
58+
```
59+
WiFi network connection. Enter values for network ID and password.
60+
61+
```py
62+
wlan = network.WLAN(network.STA_IF)
63+
wlan.active(True)
64+
wlan.connect('WIFI_NETWORK', 'WIFI_PASSWORD')
65+
```
66+
67+
``` py
68+
import network
69+
import urequests
70+
import time
71+
import neopixel
72+
import machine
73+
74+
# Set up the NeoPixel LED
75+
pin = machine.Pin("NEOPIXEL")
76+
led = neopixel.NeoPixel(pin, 1)
77+
78+
# Set the LED to red while connecting to WiFi
79+
led[0] = (255, 0, 0)
80+
led.write()
81+
82+
# Connect to a WiFi network
83+
wlan = network.WLAN(network.STA_IF)
84+
wlan.active(True)
85+
wlan.connect('WIFI_NETWORK', 'WIFI_PASSWORD')
86+
87+
# Wait for the connection to complete
88+
print("Waiting for connection...")
89+
while not wlan.isconnected():
90+
time.sleep(1)
91+
print('.', sep='', end='', )
92+
print('Connected!')
93+
94+
# Set the LED to blue while downloading data
95+
led[0] = (0, 0, 255)
96+
led.write()
97+
98+
# Download the list of astronauts currently in space
99+
print('Downloading list of astronauts currently in space...')
100+
astronauts = urequests.get("https://corquaid.github.io/international-space-station-APIs/JSON/people-in-space.json").json()
101+
102+
# Print the number of astronauts and their names
103+
number = astronauts['number']
104+
print('There are', number, 'astronauts in space.')
105+
for i in range(number):
106+
print(i+1, astronauts['people'][i]['name'])
107+
108+
# Set the LED to green to indicate success
109+
led[0] = (0, 255, 0)
110+
led.write()
111+
112+
```
54113

55114

56115

docs/uf2.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
2+
3+
4+
5+
The IoT RedBoard - RP2350 uses a UF2 bootloader for easy flashing/uploading of code to the board. The UF2 bootloader causes the board to show up on your computer as a USB storage device and does <b>not</b> require any drivers for Windows, Mac OSX, and Linux! This bootloader is used for uploading in both the Pico SDK and MicroPython development environments so let's take a brief look at how to enter bootload mode.
6+
7+
## What is UF2?
8+
9+
UF2 stands for USB Flashing Format, which was developed by Microsoft for PXT (now known as MakeCode) for flashing microcontrollers over the Mass Storage Class (MSC), just like a removable flash drive. The file format is unique, so unfortunately, you cannot simply drag and drop a compiled binary or hex file onto the board. Instead, the format of the file has extra information to tell the processor where the data goes, in addition to the data itself. For more information about UF2, you can read more from the [MakeCode blog](https://makecode.com/blog/one-chip-to-flash-them-all), as well as the [UF2 file format specification](https://github.com/Microsoft/uf2).
10+
11+
## Entering the Bootloader
12+
13+
Putting the IoT RedBoard - RP2350 into bootloader mode only requires a couple of presses of the BOOT and RESET buttons. Start by pressing and holding the BOOT button down:
14+
15+
<figure markdown>
16+
[![Pressing the BOOT button.](./assets/img/Thing_Plus_RP2350-uF2_BOOT.jpg){ width="600"}](./assets/img/Thing_Plus_RP2350-uF2_BOOT.jpg "Click to enlarge")
17+
</figure>
18+
19+
Next, press and release the RESET button while still holding down the BOOT button:
20+
21+
<figure markdown>
22+
[![Photo highlighting RP2350.](./assets/img/Thing_Plus_RP2350-uF2_RESET.jpg){ width="600"}](./assets/img/Thing_Plus_RP2350-uF2_RESET.jpg "Click to enlarge")
23+
</figure>
24+
25+
Finally, release the BOOT button and the board should be in bootloader mode and appear on your computer as a USB storage device called "RP2350".

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -278,6 +278,7 @@ nav:
278278
- Hardware Overview: hardware_overview.md
279279
- Hardware Assembly: hardware_assembly.md
280280
- Software:
281+
- UF2 Bootloader: uf2.md
281282
- Pico SDK: picosdk.md
282283
- MicroPython: micropython.md
283284
- Arduino: arduino.md

0 commit comments

Comments
 (0)