Skip to content

Commit 63ced8e

Browse files
committed
Initial docs commit
Adding background files for GH pages along with initial documentation page content.
1 parent 20813f8 commit 63ced8e

24 files changed

+1388
-0
lines changed

docs/arduino.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
icon: simple/arduino
3+
---
4+
5+
!!! attention
6+
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).
7+
8+
## Arduino-Pico Boards
9+
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:
11+
12+
<code>
13+
https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json
14+
</code>
15+
16+
Click "OK" to close this menu then navigate to the Boards Manager tool and search for "pico" and download the latest release of "Raspberry Pi Pico" (4.2.1 or later).
17+
18+
<figure markdown>
19+
[![Screenshot of board manager tool searching for pico.](./assets/img/arduino_boards.jpg){ width="600"}](./assets/img/arduino_boards.jpg "Click to enlarge")
20+
</figure>
21+
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
140 KB
Loading
315 KB
Loading
308 KB
Loading
308 KB
Loading

docs/github/contribute.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Contribute: Make an Augmentation!
2+
Spot an improvement opportunity? Feel free to contribute to our open-source design and documentation. <a href="https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/issues-pr/sparkfun/SparkFun_Pro_Micro_RP2350.svg" /></a>
3+
4+
## :material-file-document-multiple:&nbsp;Improve our Documentation
5+
All of this documentation can be modified by you! Please help us make it better.
6+
7+
* These pages are contained in the [`docs` folder](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/tree/main/docs) of the [<Official Product Name> repository](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350).
8+
9+
<!-- ### :material-source-pull:&nbsp;Submit a Correction -->
10+
### Submit a Correction
11+
12+
1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/fork).
13+
2. Add your corrections or improvements to the markdown file.
14+
3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
15+
* Once received, the documentation specialist will automatically be notified.
16+
* We will review your suggested improvements to make sure they are correct and fit within our documentation standards.
17+
18+
## :material-cog:&nbsp;Improve our Hardware Design
19+
All of our designs are open-source! Please help us make it better.
20+
21+
* Our board design files are contained in the [`Hardware` folder](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/tree/main/Hardware) of the [<Official Product Name> repository](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350).
22+
23+
<!-- ### :material-source-pull:&nbsp;Submit a Design Enhancement -->
24+
### Submit a Design Enhancement
25+
26+
1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/fork).
27+
2. Add your design augmentation(s)
28+
3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
29+
1. Once received, the engineer in charge of the original design will automatically be notified.
30+
2. We will review your suggested improvement(s) to verify that they are within our board design standards and meet our product design requirements.
31+
3. If approved, we will flag these changes for our next board revision. Congrats! 🍻
32+
33+
!!! info
34+
Even if your suggestion is accepted, these changes may not be immediately available for purchase. We may have to cycle through our current product inventory first.
35+
36+
## Contributors&nbsp;:clap:
37+
Let's provide some recognition to the contributors for this project!
38+
39+
![GitHub Contributors Image](https://contrib.rocks/image?repo=sparkfun/SparkFun_Pro_Micro_RP2350)
40+
<br>
41+
<a href="https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/contributors/sparkfun/SparkFun_Pro_Micro_RP2350.svg" /></a>

docs/github/file_issue.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Did we make a mistake?
2+
3+
Spot something wrong? Please let us know. <a href="https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/issues" alt="Issues"><img src="https://img.shields.io/github/issues/sparkfun/SparkFun_Pro_Micro_RP2350.svg" /></a>
4+
5+
<!-- Technical Assistance Box -->
6+
!!! warning "Need Help?"
7+
If you need technical assistance or more information on a product that is not working as you expected, we recommend heading on over to the [SparkFun Technical Assistance](https://www.sparkfun.com/technical_assistanc) page for some initial troubleshooting. This **Submit Issues** page is not where users should seek assistance.
8+
9+
<center>
10+
[SparkFun Technical Assistance Page](https://www.sparkfun.com/technical_assistance){ .md-button .md-button--primary }
11+
</center>
12+
13+
If you can't find what you need there, the [SparkFun Forums](https://forum.sparkfun.com/index.php) is a great place to search the product forums and ask questions.
14+
15+
!!! info "Account Registration Required"
16+
For your first visit to our forum, you'll need to create a [Forum Account](https://forum.sparkfun.com/ucp.php?mode=register) to post questions.
17+
18+
19+
## Discrepancies in the Documentation
20+
21+
All of our documentation can be modified by you! Please help us make it better.
22+
23+
* The documentation files for these pages are contained in the [`docs` folder](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/tree/main/docs) of the [<Official Product Name> repository](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350).
24+
25+
### 🔍 Spot something wrong?
26+
27+
If a section of the documentation is incorrect, please [open an issue](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/issues) and let us know.
28+
29+
### Do you have a suggested correction?
30+
31+
1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/fork).
32+
2. Add your correction(s) or improvement(s) to the markdown file(s)
33+
3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
34+
* Once received, the documentation specialist will automatically be notified.
35+
* We will review your suggested improvement(s) to make sure they are correct and fit within our documentation standards.
36+
37+
## Problems in the Hardware Design
38+
39+
All of our designs are open-source! Please help us make it better.
40+
41+
* Our board design files are contained in the [`Hardware` folder](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/tree/main/Hardware) of the [<Official Product Name> repository](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350).
42+
43+
### Does something not make sense? 🤔
44+
45+
If part of the design is confusing, please [open an issue](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/issues) and let us know.
46+
47+
### Did we forget to include an important function of the board? 🤦
48+
49+
If part of the board's functionality is missing, please [open an issue](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/issues) and file a feature request.
50+
51+
!!! tip "Design Considerations"
52+
Please keep in mind that we may intentionally exclude certain functions of the board to meet our product design requirements.
53+
54+
* *For example, our Qwiic Micro boards are intended to fit on a small board layout and only use I<sup>2</sup>C communication; therefore, we may not have the SPI and interrupt pins available for users.*
55+
56+
57+
### Do you wish to contribute directly to improving the board design?
58+
59+
1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/fork).
60+
2. Add your design augmentation(s)
61+
3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
62+
1. Once received, the engineer in charge of the original design will automatically be notified.
63+
2. We will review your suggested improvement(s) to verify that they are within our board design standards and meet our product design requirements.
64+
3. If approved, we will flag these changes for our next board revision. Congrats! 🍻
65+
66+
!!! info
67+
Even if your suggestion is accepted, these changes may not be immediately available for purchase. We may have to cycle through our current product inventory first.

docs/hardware_assembly.md

Whitespace-only changes.

docs/hardware_overview.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
icon: material/cog
3+
---
4+
5+
This document gives a detailed overview of the RedBoard IoT - RP2350 and all components present on the board.
6+
7+
## RP2350 Microcontroller
8+
9+
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.
10+
11+
This internal configuration allows users to customize the chip to use a pair their preferred architecture (ARM or Hazard3) or to use one of each! The RP2350 includes 520kB of on-chip SRAM in ten independent banks, 8kB of one-time-programmable (OTP) storage and this board also includes PSRAM connected to the chip's QSPI bus. The RP2350 also has a bevy of security features including optional boot signing with protected OTP storage for the boot decryption key, global bus filtering (based on either Arm or RISC-V security and privilege levels) and more.
12+
13+
The RedBoard IoT - RP2350 uses the "A" version of the microcontroller which has 30 5V-tolerant GPIO with 4 analog inputs and also includes the following peripheral options:
14+
15+
* 2x UART
16+
* 2x SPI
17+
* 2x I<sup>2</sup>C
18+
* 24 PWM
19+
* USB 1.1 Controller
20+
* 12 PIO State Machines
21+
* 1x High-Speed Transmit (HSTX) Peripheral for DVI/DSI support
22+
23+
For complete information on the RP2350, refer to the [datasheet](./assets/component_documentation/rp2350-datasheet.pdf).
24+
25+
## Memory
26+
27+
### W25Q128 Flash
28+
29+
The W25Q128 Flash IC adds 16MB of storage space on the RedBoard IoT. This connects to the RP2350 over QSPI.
30+
31+
### PSRAM
32+
33+
The board also includes an 8MB PSRAM IC for dynamic storage. This also connects to the RP2350 over QSPI. PSRAM support is included in the SparkFun MicroPython "early release" firmware found later in this guide and on the product page, but is not natively supported in the Pico SDK as of release. Refer to the Arducam Demo section of this guide for information on how to enable and set up PSRAM using the Pico SDK.
34+
35+
For a complete overview of the PSRAM IC, refer to the [datasheet](./assets/component_documentation/APS6404L_3SQR_Datasheet.pdf).
36+
37+
### &micro;SD Card Slot
38+
39+
The board has a &micro;SD card slot that connects to the RP2350's SPI bus for even more storage. Make sure the SPI are **LOW** when the &micro;SD card is **unpowered**. Setting these pins **HIGH** can damage the GPIO pins. The connector is a fricton-fit connector so no "clicking" and "unclicking" is necessary. Just plug it in nice and snug.
40+
41+
## Raspberry Pi RM2 Radio Module
42+
43+
The Raspberry Pi RM2 (radio module 2) is built around the same chipset as the previous Raspberry Pi radio module found on boards like the Pico W. The module features both WiFi 4 (802.11n) 2.4GHz and Bluetooth<sup>&trade;</sup> 5.2 with support for Low Energy (Central and Peripheral) and Classic.
44+
45+
The RM2 communicates with the RP2350 over SPI and we've designed this board to use the same pins for the radio module as official Raspberry Pi boards (Pico W and Pico 2 W), making it easy to use the radio module without having to adjust anything from those development boards. The RedBoard IoT routes the module's GPIO0 pin to a blue STAT LED to allow users to create a visual indicator of the status of the module. We added this STAT LED connected to the same pin used on the Pico W to make code for that compatible with the RedBoard IoT - RP2350.
46+
47+
## Power
48+
49+
The RedBoard IoT - RP2350 includes several options for powering including USB-C, LiPo battery with on-board battery charging and monitoring circuits as well as direct power inputs.
50+
51+
### USB-C
52+
53+
The USB-C connector on the board acts as the primary serial interface for the RP2350 as well as a power input. The <b>5V</b> USB input voltage is regulated down to <b>3.3V</b> through a voltage regulator with a max current of <b>[email protected]</b>.
54+
55+
### Barrel Jack
56+
57+
The barrel jack connector on this board accepts a supply voltage between <b>7V</b> and <b>15V</b>. This supply voltage includes a <b>16V/2.5A/5A</b> fuse.
58+
59+
### LiPo Power & Charging
60+
61+
The IoT RedBoard - RP2350 can also be powered with a single cell lithium battery through a 2-pin JST connector. The board also includes a MCP73831 LiPo charge IC as part of a charging circuit for a connected battery. The charge rate is set to <b>455mA</b> and is powered either via USB, barrel jack or dedicated pin.
62+
63+
It also has a MAX17048 battery fuel gauge to monitor a connected battery's voltage level. The fuel gauge communicates with the RP2350 over I<sup>2</sup>C.
64+
65+
## Pinout
66+
67+
### R3 Footprint Female Headers
68+
69+
### HSTX Connector
70+
71+
### RP2350 Debug Connector
72+
73+
## LEDs
74+
75+
This board has four LEDs labeled <b>STAT/25</b>, <b>CHG</b>, <b>WRL</b>, <b>PWR</b> and <b>RGB/IO3</b>.
76+
77+
## Buttons
78+
79+
There are three push buttons on the board labeled <b>RESET</b>, <b>USER/36</b> and <b>BOOT</b>.
80+
81+
## Solder Jumpers

docs/javascript/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
javascript directory
2+
====================
3+
This folder should contain the files for the custom javascript that is enabled in the product documentation

0 commit comments

Comments
 (0)