Skip to content

Commit 7ee2dee

Browse files
committed
Docs Update
Minor docs update for Quickstart & other sections.
1 parent 63ced8e commit 7ee2dee

File tree

8 files changed

+82
-68
lines changed

8 files changed

+82
-68
lines changed

docs/arduino.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ icon: simple/arduino
77

88
## Arduino-Pico Boards
99

10-
The SparkFun RedBoard IoT - RP2350 is supported on the Arduino IDE in the [Arduino-Pico](https://github.com/earlephilhower/arduino-pico) boards package. To install the package, open the Preferences menu by navigating to <b>File</b> > <b>Preferences</b>. Look at the bottom of the Preferences menu for "Additional boards manager URLS" and then copy this JSON link into that field:
10+
The SparkFun IoT RedBoard - RP2350 is supported on the Arduino IDE in the [Arduino-Pico](https://github.com/earlephilhower/arduino-pico) boards package. To install the package, open the Preferences menu by navigating to <b>File</b> > <b>Preferences</b>. Look at the bottom of the Preferences menu for "Additional boards manager URLS" and then copy this JSON link into that field:
1111

1212
<code>
1313
https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json
260 KB
Loading
257 KB
Loading

docs/hardware_overview.md

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ icon: material/cog
44

55
This document gives a detailed overview of the RedBoard IoT - RP2350 and all components present on the board.
66

7+
## IoT RedBoard - RP2350 Overview
8+
9+
The IoT RedBoard - RP2350 is packed with hardware aimed at helping users get the most out of the RP2350. This includes multiple power inputs like USB-C and a 2-pin JST connector, Qwiic connector, standard R3 female headers, several status LEDs and also a couple specialized headers for the RP2350's high-speed transmit (HSTX) pins and its debug pins. The photo below highlights all the major components on this board that we'll cover in this Hardware Overview.
10+
11+
<center>
12+
[![Photo highlighting major components on the IoT RedBoard - RP2350](./assets/img/SparkFun_IoT_RedBoard-RP2350-Labels.jpg){ width="600"}](./assets/img/SparkFun_IoT_RedBoard-RP2350-Labels.jpg "Click to enlarge")
13+
</center>
14+
715
## RP2350 Microcontroller
816

917
The RP2350 from Raspberry Pi packs a whole lot of computing punch in a tiny package. The RP2350 is a unique dual-core microcontroller that has <i>four</i> internal processors (two Arm Cortex-M33 and two Hazard3 RISC-V processors @150 MHz), though you can only select any two of these four to run at the same time.
@@ -68,14 +76,44 @@ It also has a MAX17048 battery fuel gauge to monitor a connected battery's volta
6876

6977
### HSTX Connector
7078

79+
80+
7181
### RP2350 Debug Connector
7282

83+
We've also included a dedicated 1mm 3-pin connector tied to the RP2350's debug pins (SWDIO, SWCK & Ground). Users can plug a [debug cable (link needed - ML)]() to this connector. These pins are also connected to a 0.1"-spaced PTH header right next to it for those who prefer a different connection type.
84+
7385
## LEDs
7486

7587
This board has four LEDs labeled <b>STAT/25</b>, <b>CHG</b>, <b>WRL</b>, <b>PWR</b> and <b>RGB/IO3</b>.
7688

89+
**Photo highlighting LEDs - ML**
90+
91+
The list below outlines the color and functionality of the LEDs on the IoT RedBoard - RP235.
92+
93+
* <b>STAT/25</b> - Blue LED tied to the RP2350's IO25. User-programmable status LED.
94+
* <b>CHG</b> - Yellow LED connects to the MCP73831 LiPo charge IC to indicate when an attached battery is being charged.
95+
* <b>WRL</b> - Blue LED tied to IO0 on the RM2. User-programmable status LED.
96+
* <b>PWR</b> - Red LED tied to <b>3.3V</b> power circuit.
97+
* <b>RGB/IO3</b> - WS2812 RGB LED tied to the RP2350's IO3. User-progammable RGB LED.
98+
7799
## Buttons
78100

79101
There are three push buttons on the board labeled <b>RESET</b>, <b>USER/36</b> and <b>BOOT</b>.
80102

81-
## Solder Jumpers
103+
**Photo highlighting buttons - ML**
104+
105+
The <b>RESET</b> button connects to the RP2350's RUN pin and resets the RP2350 when pressed. The <b>USER/36</b> button connects to IO36 on the RP2350 and can act as a physical input to trigger an event in code. The <b>BOOT</b> button
106+
107+
## Solder Jumpers
108+
109+
The IoT RedBoard - RP2350 has five solder jumpers labeled <b>PWR</b>, <b>LP</b>, <b>SHLD</b>, <b>I2C</b> and <b>BYP</b>.
110+
111+
**Photo highlighting solder jumpers - ML**
112+
113+
The list below outlines the solder jumpers functionality, default state and any notes about their behavior.
114+
115+
* <b>PWR</b> - Completes the Power LED circuit. CLOSED by default. Open to disable the power LED to help conserve power.
116+
* <b>LP</b> - Pulls the RP9080 3.3V regulator's enable (EN) pin HIGH (3.3V) to power the peripheral (3.3V_P) power circuit. CLOSED by default. While enabled, this provides power to the &micro;SD card and RGB LED. Open to disable the peripheral power circuit.
117+
* <b>SHLD</b> - Nets the USB-C Shield pin to the board's ground plane. CLOSED by default. Open to isolate the shield pin from the board's ground.
118+
* <b>I2C</b> - Three-way jumper pulls the I<sup>2</sup>C pins (IO4/SDA and IO5/SCL) to <b>3.3V</b> through a pair of <b>2.2k&ohm;</b> resistors. CLOSED by default. Open the jumper to disable the pullups on these pins.
119+
* <b>BYP</b> - Fuse bypass jumper. OPEN by default. Close to bypass the fuse on the VIN input.

docs/introduction.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
2+
3+
4+
5+
The IoT RedBoard - RP2350

docs/micropython.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,20 @@
44

55
## Setup
66

7-
MicroPython is an application of the Python 3 language that runs on microcontrollers like the RedBoard IoT - RP2350 that allows you to easily interact with the board directly over a USB serial interface through either a command line interface or your preferred Python IDE such as [Thonny](https://thonny.org/). We'll do a quick overview of how to download MicroPython firmware on to the RedBoard IoT - RP2350 but for a complete overview of using MicroPython with this and other RP2350 boards, head over to Raspberry Pi's documentation by clicking the button below:
7+
MicroPython is an application of the Python 3 language that runs on microcontrollers like the IoT RedBoard - RP2350 that allows you to easily interact with the board directly over a USB serial interface through either a command line interface or your preferred Python IDE such as [Thonny](https://thonny.org/). We'll do a quick overview of how to download MicroPython firmware on to the RedBoard IoT - RP2350 but for a complete overview of using MicroPython with this and other RP2350 boards, head over to Raspberry Pi's documentation by clicking the button below:
88

99
<center>
1010
[Raspberry Pi MicroPython Docs](https://www.raspberrypi.com/documentation/microcontrollers/micropython.html){ .md-button .md-button--primary}
1111
</center>
1212

1313
## UF2 Firmware
1414

15-
As of this writing, we're waiting on the next release of MicroPython to include UF2 files for the RedBoard IoT - RP2350 so to get users started before then, we have Beta releases of MicroPython firmware available [here](https://github.com/sparkfun/micropython/releases) or by clicking the button below:
15+
As of this writing, we're waiting on the next release of MicroPython to include UF2 files for the IoT RedBoard - RP2350 so to get users started before then, we have Beta releases of MicroPython firmware available [here](https://github.com/sparkfun/micropython/releases) or by clicking the button below:
1616

1717
<center>
1818
[SparkFun MicroPython Beta Releases](https://github.com/sparkfun/micropython/releases){ .md-button .md-button--primary}
1919
</center>
2020

21-
Simply download the latest release and then put the RedBoard IoT - RP2350 into UF2 bootloader mode and open the location the board appeared as a USB storage device (it should appear as "RP2350"). Next, simply drag and drop the UF2 file into the RP2350 folder and the board should reboot. After the board reboots, open up your preferred MicroPython IDE (or command line interface) and you can start interacting with your RedBoard IoT. Read on to the MicroPython examples section for a few quick examples to make sure everything is working properly.
21+
Simply download the latest release and then put the IoT RedBoard - RP2350 into UF2 bootloader mode and open the location the board appeared as a USB storage device (it should appear as "RP2350"). Next, simply drag and drop the UF2 file into the RP2350 folder and the board should reboot. After the board reboots, open up your preferred MicroPython IDE (or command line interface) and you can start interacting with your RedBoard IoT. Read on to the MicroPython examples section for a few quick examples to make sure everything is working properly.
2222

2323
## Examples

docs/quickstart.md

Lines changed: 19 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,23 @@
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.
45

5-
<div class="grid cards desc" markdown>
6+
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.
67

7-
- <a href="https://www.sparkfun.com/products/iot-redboard-rp2350.html">
8-
**SparkFun IoT RedBoard - RP2350**<br>
9-
**SKU:** WRL-27708
10-
11-
---
12-
13-
<figre markdown>
14-
![Product Thumbnail](./assets/img/SparkFun_IoT_RedBoard-RP2350.jpg)
15-
</figure></a>
16-
17-
<center>
18-
<article class="video_desc">
19-
<iframe src="https://www.youtube.com/embed/umC06onaavo?si=j9rEibxVvqwawaoB" title="Product Showcase: SparkFun Thing Plus - RP2350" frameborder="0" allow="accelerometer; autoplay; clipboard-write;encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
20-
</article>
21-
</center>
22-
23-
- 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.
24-
<br>
25-
<br>
26-
If you're not familiar with using development boards or the development environments covered in this guide, refer to the Hardware & Software tabs above for a detailed overview of the board along with instructions on programming the IoT RedBoard - RP2350.
27-
28-
</div>
298

309
## Basic Assembly
3110

3211
Start by plugging the IoT RedBoard - RP2350 into your computer using a USB-C connector.
3312

3413
<figure markdown>
35-
[![Photo showing RedBoard IoT - RP2350 connected over USB-C](./assets/img/SparkFun_IoT_RedBoard-RP2350.jpg){ width="600"}](./assets/img/SparkFun_IoT_RedBoard-RP2350.jpg "Click to enlarge")
14+
[![Photo showing RedBoard IoT - RP2350 connected over USB-C](./assets/img/SparkFun_IoT_RedBoard-RP2350.jpg){ width="600" }](./assets/img/SparkFun_IoT_RedBoard-RP2350.jpg "Click to enlarge")
3615
</figure>
3716

38-
## Software Setup
39-
40-
Next up we'll cover how to upload to the IoT RedBoard - RP2350 using preferred development environment(s). If you're using any peripherals (Qwiic boards, shields, etc.) connect those now or after installing the board packages. Make sure to install any software packages or libraries for any connected peripherals.
41-
42-
### Raspberry Pi Pico SDK
43-
44-
The IoT RedBoard - RP2350 is supported in **version needed - ML** of the Pico SDK. Upload to it by selecting `sparkfun_redboard_rp2350`.
45-
46-
### MicroPython
47-
48-
The IoT RedBoard - RP2350 has Beta releases of MicroPython firmware available [here](https://github.com/sparkfun/micropython/releases) or by clicking the button below:
4917

50-
<center>
51-
[SparkFun MicroPython Beta Releases](https://github.com/sparkfun/micropython/releases){ .md-button .md-button--primary}
52-
</center>
18+
## Software Examples
5319

54-
Put the IoT RedBoard in bootloader mode by pressing and holding the RESET button while pressing and releasing the BOOT button. Once in bootloader mode, navigate to the RedBoard's drive location and copy the UF2 file into the drive.
55-
56-
### Arduino IDE
57-
58-
The IoT RedBoard - RP2350 board definition is included in the [Arduino-Pico](https://github.com/earlephilhower/arduino-pico) boards package. Make sure to install or update to the latest Arduino-Pico release and select `SparkFun IoT RedBoard - RP2350` as your board.
59-
60-
## Code Examples
20+
Next up we'll cover how to upload to the IoT RedBoard - RP2350 using preferred development environment(s). If you're using any peripherals (Qwiic boards, shields, etc.) connect those now or after installing the necessary software and board packages.
6121

6222
The following examples all complete the same task of connecting the IoT RedBoard - RP2350 to a WiFi network and pinging a site. They also include a visual indicator of the connection status using the RGB LED on the board like the photos below show:
6323

@@ -79,16 +39,25 @@ The following examples all complete the same task of connecting the IoT RedBoard
7939
</figure>
8040
</div>
8141

82-
Before running the examples, adjust the template values called <code>WIFI_NETWORK</code> and <code>WIFI_PASSWORD</code> with your WiFi network ID and password.
42+
### Raspberry Pi Pico SDK
8343

84-
### Pico SDK
44+
The IoT RedBoard - RP2350 is supported in **version needed - ML** of the Pico SDK. The Pico SDK works great in [Microsoft VS Code](https://code.visualstudio.com/) with the [Pico SDK Extension](https://marketplace.visualstudio.com/items?itemName=raspberry-pi.raspberry-pi-pico). Upload to the board by selecting `sparkfun_redboard_rp2350`.
8545

8646
**Insert example code - ML**
8747

48+
8849
### MicroPython
8950

90-
**Insert example code - ML**
51+
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:
52+
53+
**Insert example code -ML**
54+
55+
56+
57+
### Arduino IDE
58+
59+
The IoT RedBoard - RP2350 board definition is included in the [Arduino-Pico](https://github.com/earlephilhower/arduino-pico) boards package. Install or update to the latest Arduino-Pico release and select `SparkFun IoT RedBoard - RP2350` as your board. This example also uses the [Neopixel Arduino library]((https://github.com/adafruit/Adafruit_NeoPixel)) to control the WS2812 RGB LED.
9160

92-
### Arduino
61+
## Going Further
9362

94-
**Insert example code - ML**
63+
If you're looking for more detailed information on the design and components on this IoT Redboard, read on to the Hardware section below. Similarly, the Software tab includes detailed instructions on installing and using all supported development environments along with a few more examples for each IDE. Finally, the Resources section includes the board design files and datasheets for major components on the board.

mkdocs.yml

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -271,16 +271,18 @@ extra_javascript:
271271

272272
# Configures webpage navigation
273273
nav:
274-
- Quick Start Guide: quickstart.md
275-
- Hardware:
276-
- Hardware Overview: hardware_overview.md
277-
- Hardware Assembly: hardware_assembly.md
278-
- Software:
279-
- Pico SDK: picosdk.md
280-
- MicroPython: micropython.md
281-
- Arduino: arduino.md
282-
- Resources: resources.md
283-
- Support:
284-
- Troubleshooting: troubleshooting.md
285-
- Submit Issues: github/file_issue.md
286-
- Contribute: github/contribute.md
274+
- Hookup Guide:
275+
- Introduction: introduction.md
276+
- Quick Start: quickstart.md
277+
- Hardware:
278+
- Hardware Overview: hardware_overview.md
279+
- Hardware Assembly: hardware_assembly.md
280+
- Software:
281+
- Pico SDK: picosdk.md
282+
- MicroPython: micropython.md
283+
- Arduino: arduino.md
284+
- Resources: resources.md
285+
- Support:
286+
- Troubleshooting: troubleshooting.md
287+
- Submit Issues: github/file_issue.md
288+
- Contribute: github/contribute.md

0 commit comments

Comments
 (0)