Skip to content

Commit 7a2e301

Browse files
committed
Docs Initial Review
Initial review of docs update. Minor edits to existing .md files & adding board files to assets folder.
1 parent 391a567 commit 7a2e301

12 files changed

+24
-55
lines changed

docs/arduino.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
icon: simple/arduino
3-
---
4-
51
!!! attention
62
If this is your first time using Arduino, please read through our tutorial on [installing the Arduino IDE](https://learn.sparkfun.com/tutorials/installing-arduino-ide). If you have not installed an Arduino library before, we recommend you check out our [installation guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library).
73

@@ -19,6 +15,4 @@ Click "OK" to close this menu then navigate to the Boards Manager tool and searc
1915
[![Screenshot of board manager tool searching for pico.](./assets/img/arduino_boards.jpg){ width="600"}](./assets/img/arduino_boards.jpg "Click to enlarge")
2016
</figure>
2117

22-
For more information on using the Arduino-Pico boards package, check out their [documentation page](https://arduino-pico.readthedocs.io/en/latest/index.html).
23-
24-
## Examples
18+
For more information on using the Arduino-Pico boards package, check out their [documentation page](https://arduino-pico.readthedocs.io/en/latest/index.html). Head over to the Quick Start guide for an Arduino example demonstrating how to connect to a WiFi network, download data from a site and control the RGB LED.
139 KB
Loading
Binary file not shown.
856 KB
Binary file not shown.

docs/hardware_assembly.md

Whitespace-only changes.

docs/hardware_overview.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
icon: material/cog
3-
---
4-
51
This document gives a detailed overview of the RedBoard IoT - RP2350 and all components present on the board.
62

73
## IoT RedBoard - RP2350 Overview

docs/introduction.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,22 @@
1-
2-
1+
![SparkFun IoT RedBoard - RP2350)](docs/assets/img/iot-redboard-rp2350-gh-banner.png "SparkFun IoT RedBoard - RP2350")
32

43

54
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.
65

76
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:
87

9-
* [IoT RedBoard - RP2350]()
10-
* [USB-C Cable]()
8+
* [IoT RedBoard - RP2350](https://www.sparkfun.com/sparkfun-iot-redboard-rp2350.html)
9+
* [USB-C Cable](https://www.sparkfun.com/usb-a-to-usb-c-cable-1m-usb-2-0-flexible-silicone.html)
1110

12-
## Major Topics Covered
11+
## Topics Covered
1312

1413
This document contains three main sections: **Quickstart Guide**, **Hardware** and **Software**.
1514

1615
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.
1716

18-
. 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
19-
2017
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.
2118

22-
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.
19+
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.
2320

2421
## Resources and Support Documentation
2522

docs/micropython.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
2-
3-
4-
51
## Setup
62

73
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:
@@ -12,12 +8,10 @@ MicroPython is an application of the Python 3 language that runs on microcontrol
128

139
## UF2 Firmware
1410

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:
11+
The SparkFun IoT RedBoard - RP2350 is available in the main release of MicroPython [here](https://micropython.org/download/). Search for "SparkFun IoT RedBoard - RP2350" on the MicroPython downloads page for the correct firmware. This release does **not** include PSRAM support. 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:
1612

1713
<center>
1814
[SparkFun MicroPython Beta Releases](https://github.com/sparkfun/micropython/releases){ .md-button .md-button--primary}
1915
</center>
2016

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.
22-
23-
## Examples
17+
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, 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. Head over to the Quick Start guide for an example project that shows how to connect the board to a WiFi network, download data from a website and control the RGB LED.

docs/picosdk.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
2-
3-
4-
5-
## Raspberry Pi Pico SDK
1+
## Pico SDK Setup & Documentation
62

73
The Pico C SDK is a C/C++ development kit for Raspberry Pi microcontrollers including the RP2350. Click on the links below for complete documentation on installing and using the SDK.
84

@@ -16,6 +12,4 @@ The Pico C SDK is a C/C++ development kit for Raspberry Pi microcontrollers incl
1612

1713
### RedBoard IoT - RP2350 Board Definition
1814

19-
When using the Pico SDK, make sure to use v2.1 or later and select `sparkfun_thingplus_rp2350` for the board. We recommend using [Microsoft VS Code](https://code.visualstudio.com/) with the [Pico SDK Extension](https://marketplace.visualstudio.com/items?itemName=raspberry-pi.raspberry-pi-pico).
20-
21-
## Examples
15+
When using the Pico SDK, make sure to use v2.1 or later and select `sparkfun_iotredboard_rp2350` for the board. We recommend using [Microsoft VS Code](https://code.visualstudio.com/) with the [Pico SDK Extension](https://marketplace.visualstudio.com/items?itemName=raspberry-pi.raspberry-pi-pico).

docs/quickstart.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1+
Welcome to the SparkFun IoT RedBoard - RP2350 Quick Start Guide showing how to set up and use the RM2 wireless chip to connect to a WiFi network, request and download data on the number and names of astronauts currently on the International Space Station.
12

2-
3-
4-
5-
Welcome to the SparkFun IoT RedBoard - RP2350 Quick Start Guide showing how to set up and use the RM2 wireless chip to connect to a WiFi network, request and download data on the number and names of astronauts currently on the International Space Station. 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.
3+
If you're not familiar with using development boards or the development environments covered in this guide, refer to the [Hardware](./hardware_overview.md) & [Software](./uf2.md) sections for a detailed overview of the board along with instructions on setting up and programming the IoT RedBoard - RP2350.
64

75
## Basic Assembly
86

0 commit comments

Comments
 (0)