Skip to content

Commit cc2eb9b

Browse files
committed
Docs Review
Final review updates. Switching to updated "Print View" option for single page.
1 parent 61de7c3 commit cc2eb9b

11 files changed

+105
-41
lines changed

docs/arduino_example.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Now that we've installed the espressif boards package in Arduino, it's time to u
66

77
## Blink RGB Example
88

9-
The ESP32 core includes an example for cycling an RGB LED like the one found on this Thing Plus so long as the board variant defines it as `RGB_BUILTIN` (which ours does). Navigate to the example by going to **File** > **Examples** > **ESP32** > **GPIO** > **BlinkRGB** like the screenshot below shows:
9+
The ESP32 core includes integrated code support for easily controlling a WS2812 LED and an example demonstrating how to cycle an RGB LED like the one found on this Thing Plus so long as the board variant defines it as `RGB_BUILTIN`. The Thing Plus ESP32-C6 does define IO23 as `RBG_BUILTIN` so this example and all other code calling for the built-in RGB LED works for this board. Open the example by navigating to **File** > **Examples** > **ESP32** > **GPIO** > **BlinkRGB** like the screenshot below shows:
1010

1111
<figure markdown>
1212
[![Screenshot of selecing the Blink RGB example.](./assets/img/BlinkRGB_example.jpg){ width="600"}](./assets/img/BlinkRGB_example.jpg "Click to enlarge.")

docs/hardware_assembly.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Now that we're familiar with the hardware on this Thing Plus board, it's time to
66

77
## Basic USB Assembly
88

9-
Basic assembly of the Thing Plus ESP32-C only requires a USB-C cable connecting the board to a computer. Just plug the cable into the USB-C connector like the photo below shows and you should see the RGB LED cycling through rainbow colors. From here, we can move on to installing the espressif boards package in Arduino and uploading code.
9+
Basic assembly of the Thing Plus ESP32-C only requires a USB-C cable connecting the board to a computer. Just plug the cable into the USB-C connector like the photo below shows and you should see the RGB LED cycling through rainbow colors with the pre-loaded test code. From here, we can move on to installing the espressif boards package in Arduino and uploading code.
1010

1111
<figure markdown>
1212
[![Photo of simple USB assembly.](./assets/img/Thing_Plus_C6-USB_Assembly.jpg){ width="600"}](./assets/img/Thing_Plus_C6-USB_Assembly.jpg "Click to enlarge")
@@ -23,4 +23,20 @@ If you prefer a battery-powered application, plug a single-cell LiPo battery int
2323
[![Photo of battery assembly.](./assets/img/Thing_Plus_C6-Battery_Assembly.jpg){ width="600"}](./assets/img/Thing_Plus_C6-Battery_Assembly.jpg "Click to enlarge")
2424
</figure>
2525

26-
For tips on the proper use of a LiPo battery and the 2-pin JST connector, please read through our [Single Cell LiPo Battery Care](https://learn.sparkfun.com/tutorials/single-cell-lipo-battery-care) tutorial.
26+
For tips on the proper use of a LiPo battery and the 2-pin JST connector, please read through our [Single Cell LiPo Battery Care](https://learn.sparkfun.com/tutorials/single-cell-lipo-battery-care) tutorial.
27+
28+
## Soldered Assembly
29+
30+
Those who prefer a traditional soldered assembly should solder wires or header pins to the PTH header on the side of the board. If you're not familiar with through-hole soldering or would like a refresher, take a look at our Through-Hole Soldering Tutorial:
31+
32+
<div class="grid cards" markdown align="center">
33+
34+
- <a href="https://learn.sparkfun.com/tutorials/5">
35+
<figure markdown>
36+
![How to Solder: Through-Hole Soldering](https://cdn.sparkfun.com/c/264-148/assets/e/3/9/9/4/51d9fbe1ce395f7a2a000000.jpg)
37+
</figure>
38+
</a>
39+
<a href="https://learn.sparkfun.com/tutorials/5">**How to Solder: Through-Hole Soldering**
40+
</a>
41+
42+
</div>

docs/hardware_overview.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The ESP32-C6 WROOM1 module from espressif combines a powerful RISC-5 processor w
1212
[![Photo highlighting ESP32-C6 module.](./assets/img/Thing_Plus_C6-Module.jpg){ width="600"}](./assets/img/Thing_Plus_C6-Module.jpg "Click to enlarge")
1313
</figure>
1414

15-
This development board uses the WROOM1 version of the C6 module which has slightly more computing power in exchange for lesser power efficiency. The ESP32-C6 features a 32-bit RISC-V single-core processor with an integrated wireless stack. The wireless stack is compatible with 2.4 GHz WiFi 6, Bluetooth<sup>&reg;</sup> 5.3, Zigbee and Thread (802.15.4) and uses an on-board PCB antenna.
15+
This development board uses the WROOM1 version of the C6 module which has slightly more computing power in exchange for lesser power efficiency. The ESP32-C6 is built around a 32-bit RISC-V single-core processor with an integrated wireless stack. The wireless stack is compatible with 2.4 GHz WiFi 6, Bluetooth<sup>&reg;</sup> 5.3, Zigbee and Thread (802.15.4) and uses an on-board PCB antenna.
1616

1717
The module features a wide range of peripheral options including SPI, UART, LPUART, I<sup>2</sup>C, I<sup>2</sup>S, LED PWM, USB Serial/JTAG controller, ADC and more. Many of these peripherals can be mapped to any GPIO pin though some are tied to specific pins. This Thing Plus breaks out 21 pins from the module to a pair of 0.1"-spaced PTH headers.
1818

@@ -41,6 +41,8 @@ The board has a 2-pin JST connector to connect a single-cell Lithium Ion (LiPo)
4141

4242
## Pinout & Qwiic Connector
4343

44+
Next up let's take a look at the Thing Plus pinout and Qwiic connector on this board.
45+
4446
<figure markdown>
4547
[![Photo highlighting through-hole pinouts.](./assets/img/Thing_Plus_C6-PTHs.jpg){ width="600"}](./assets/img/Thing_Plus_C6-PTHs.jpg "Click to enlarge")
4648
</figure>
@@ -69,7 +71,7 @@ There are two buttons on the board labeled <b>RESET</b> and <b>BOOT</b>. The RES
6971

7072
## &micro;SD Card Slot
7173

72-
This board also has a friction-fit &micro;SD card slot for users who need some more programming space on the Thing Plus - ESP32-C6.
74+
This board also has a friction-fit &micro;SD card slot for users who need more storage space on the Thing Plus - ESP32-C6.
7375

7476
<figure markdown>
7577
[![Photo highlighting microSD card slot](./assets/img/Thing_Plus_C6-SD.jpg){ width="600"}](./assets/img/Thing_Plus_C6-SD.jpg "Click to enlarge")
@@ -91,6 +93,9 @@ This Thing Plus has three LEDs labeled <b>PWR</b>, <b>CHG</b>, and <b>STAT</b>.
9193
[![Photo highlighting solder jumpers.](./assets/img/Thing_Plus_C6-LEDs.jpg){ width="600"}](./assets/img/Thing_Plus_C6-LEDs.jpg "Click to enlarge")
9294
</figure>
9395

96+
!!! note "RGB LED"
97+
The board definition for the Thing Plus - ESP32-C6 sets IO23 to use espressif's `RGB_BUILTIN` code support. This automatically includes the necessary code to control an RGB LED easily when calling `RGB_BUILTIN`. Unfortunately, this means the RGB PTH pin (IO23) can run into code conflicts when users attempt to use it for another purpose. If you *really* need IO23 for something other than the RGB LED, you may need to modify the board definition files in the ESP32 Arduino boards package. Modifying these files is beyond the scope of this tutorial and is not supported by SparkFun.
98+
9499
## Solder Jumpers
95100

96101
There are nine solder jumpers on the Thing Plus - ESP32-C6 labeled <b>I<sup>2</sup>C</b>, <b>ALRT</b>, <b>SD_DET</b>, <b>MEAS</b>, <b>LP</b>, <b>SHLD</b>, <b>RGB</b>, <b>CHG</b>, and <b>PWR</b>. The table below outlines the jumpers' labels, default state, function, and any notes regarding their use:
@@ -116,12 +121,12 @@ There are nine solder jumpers on the Thing Plus - ESP32-C6 labeled <b>I<sup>2</s
116121
<td>ALRT</td>
117122
<td>CLOSED</td>
118123
<td>Ties the MAX17048's alert pin to IO11 for battery voltage monitoring</td>
119-
<td>Open to isolate IO11 from the MAX17048's alert pin</td>
124+
<td>Open to isolate IO11 from the MAX17048's alert pin if IO11 is needed for other uses</td>
120125
<tr>
121126
<td>SD_DET</td>
122127
<td>CLOSED</td>
123128
<td>Connects the &micro;SD card's card detection pin to IO19</td>
124-
<td></td>
129+
<td>Open to disable &micro;SD card detection or if IO19 is needed for other uses</td>
125130
</tr>
126131
<tr>
127132
<td>MEAS</td>
@@ -163,7 +168,7 @@ There are nine solder jumpers on the Thing Plus - ESP32-C6 labeled <b>I<sup>2</s
163168

164169
## Board Dimensions
165170

166-
This board matches the Thing Plus footprint and measures 2.30" x 0.90" (58.42mm x 22.86mm) with four mounting holes that fit a [4-40 screw](https://www.sparkfun.com/products/10453).
171+
This board matches the Thing Plus footprint and measures 2.30" x 0.90" (58.42mm x 22.86mm) with four mounting holes that fit a [4-40 screw](https://www.sparkfun.com/products/10453) though the top two mounting holes are obstructed by the ESP32-C6 module.
167172

168173
<figure markdown>
169174
[![Board dimensions.](./assets/board_files/Thing_Plus_ESP32_C6-Dimensions.png){ width="600"}](./assets/board_files/Thing_Plus_ESP32_C6-Dimensions.png "Click to enlarge")

docs/introduction.md

Lines changed: 35 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ icon: material/book-open-page-variant
44

55
<div class="grid cards desc" markdown>
66

7-
- <a href="https://www.sparkfun.com/products/23618">
8-
**SparkFun LTE Stick - LARA-R6**<br>
7+
- <a href="https://www.sparkfun.com/products/22924">
8+
**SparkFun Thing Plus - ESP32-C6**<br>
99
**SKU:** DEV-22924
1010

1111
---
@@ -16,7 +16,7 @@ icon: material/book-open-page-variant
1616

1717

1818

19-
- The SparkFun Thing Plus - ESP32-C6 adds a powerful wireless development option to SparkFun's popular Thing Plus footprint. This Thing Plus board features the ESP32-C6 WROOM-1-N16 module from espressif<sup>&trade;</sup>. It includes a LiPo battery charger and fuel gauge, &micro;SD card slot, an addressable LED and more. The Thing Plus footprint is Feather-compatible and breaks out all of the ESP32-C6's 23 GPIO pins to 0.1"-spaced PTH headers. The board also has a USB-C connector for primary power and programming, 2-pin JST connector for a LiPo battery, and a Qwiic connector to integrate it into SparkFun's [Qwiic ecosystem](https://www.sparkfun.com/qwiic).
19+
- The SparkFun Thing Plus - ESP32-C6 adds a powerful wireless development option to SparkFun's popular Thing Plus footprint. This Thing Plus board features the ESP32-C6 WROOM-1-N16 module from espressif<sup>&trade;</sup>. It includes a LiPo battery charger and fuel gauge to charge and monitor a battery connected to the on-bard 2-pin JST connector, &microSD card slot, an addressable LED and more. The board breaks out all of the ESP32-C6's 23 GPIO pins to a pair of 0.1"-spaced PTH headers on either side of the board. The board also has a USB-C connector for primary power and programming and a Qwiic connector to integrate it into SparkFun's [Qwiic ecosystem](https://www.sparkfun.com/qwiic).
2020

2121
The ESP32-C6 SoC is built around a RISC-V single-core processor with 16 MB flash memory with an integrated wireless stack. The wireless stack supports 2.4 GHz WiFi 6, Bluetooth<sup>&reg;</sup> 5.3, Zigbee and Thread (802.15.4) and uses an on-board PCB antenna. The ESP32-C6 includes a wide range of peripheral options including SPI, UART, LPUART, I<sup>2</sup>C, I<sup>2</sup>S, LED PWM, USB Serial/JTAG controller, ADC and more. Many of these peripherals can be mapped to any GPIO pin though some are tied to specific pins.
2222

@@ -28,7 +28,7 @@ icon: material/book-open-page-variant
2828

2929
## Required Materials
3030

31-
To follow along with this guide you will need at least one USB-C cable to connect the dev board to your computer:
31+
To follow along with this guide you will need at least one USB-C cable to connect the Thing Plus to your computer:
3232

3333
<div class="grid cards" markdown>
3434

@@ -47,7 +47,7 @@ To follow along with this guide you will need at least one USB-C cable to connec
4747
- <a href="https://www.sparkfun.com/products/15424">
4848

4949
<figure markdown>
50-
![Reversible USB A to C Cable - 2m](https://cdn.sparkfun.com//assets/parts/1/7/4/8/7/18158-SparkFun_RedBoard_Plus-01.jpg)
50+
![Reversible USB A to C Cable - 2m](https://cdn.sparkfun.com/r/455-455/assets/parts/1/3/9/8/3/15424-Reversible_USB_A_to_C_Cable_-_2m-01.jpg)
5151
</figure>
5252
</a>
5353
---
@@ -61,18 +61,6 @@ You may also want to get a Qwiic cable or kit to connect the Thing Plus - ESP32-
6161

6262
<div class="grid cards" markdown>
6363

64-
- <a href="https://www.sparkfun.com/products/17259">
65-
66-
<figure markdown>
67-
![Flexible Qwiic Cable - 100mm](https://cdn.sparkfun.com//assets/parts/1/6/2/4/6/17259-Flexible_Qwiic_Cable_-_100mm-01.jpg)
68-
</figure>
69-
</a>
70-
---
71-
<a href="https://www.sparkfun.com/products/17259">
72-
**Flexible Qwiic Cable - 100mm**<br>
73-
PRT-17259
74-
</a>
75-
7664
- <a href="https://www.sparkfun.com/products/17260">
7765

7866
<figure markdown>
@@ -107,11 +95,24 @@ You may also want to get a Qwiic cable or kit to connect the Thing Plus - ESP32-
10795
<a href="https://www.sparkfun.com/products/17261">**Flexible Qwiic Cable - Female Jumper (4-pin)**<br>
10896
CAB-17261
10997
</a>
98+
99+
- <a href="https://www.sparkfun.com/products/15081">
100+
101+
<figure markdown>
102+
![SparkFun Qwiic Cable Kit](https://cdn.sparkfun.com/r/455-455/assets/parts/1/3/4/3/1/15081-_01.jpg)
103+
</figure>
104+
</a>
105+
---
106+
<a href="https://www.sparkfun.com/products/15081">
107+
**SparkFun Qwiic Cable Kit**<br>
108+
PRT-15081
109+
</a>
110+
110111
</div>
111112

112113
## Optional Materials
113114

114-
The Thing Plus - ESP32-C6 includes a 2-pin JST connector and integrated charging circuit for an attached single-cell LiPo battery. Below are a few options for batteries we recommend for battery-powered applications:
115+
The Thing Plus - ESP32-C6 includes a 2-pin JST connector and integrated charging circuit for an attached single-cell LiPo battery. Below are a few options we recommend for battery-powered applications:
115116

116117
<div class="grid cards" markdown align="center">
117118

@@ -171,25 +172,25 @@ If you prefer a soldered connection or want to modify the solder jumpers on this
171172
- <a href="https://www.sparkfun.com/products/116">
172173

173174
<figure markdown>
174-
![Break Away Headers - Straight](https://cdn.sparkfun.com//assets/parts/1/0/6/00116-02-L.jpg)
175+
![SparkFun Qwiic Shield for Thing Plus](https://cdn.sparkfun.com/r/455-455/assets/parts/1/5/6/9/7/16790-SparkFun_Qwiic_Shield_for_Thing_Plus-05.jpg)
175176
</figure>
176177
</a>
177178
---
178-
<a href="https://www.sparkfun.com/products/116">
179-
**Break Away Headers - Straight**<br>
180-
PRT-00116
179+
<a href="https://www.sparkfun.com/products/16790">
180+
**SparkFun Qwiic Shield for Thing Plus**<br>
181+
DEV-16790
181182
</a>
182183

183184
- <a href="https://www.sparkfun.com/products/9507">
184185

185186
<figure markdown>
186-
![Soldering Iron - 30W (USE, 110V)](https://cdn.sparkfun.com//assets/parts/3/2/4/3/09507-01.jpg)
187+
![PINECIL - Smart Mini Portable Soldering Iron](https://cdn.sparkfun.com/r/455-455/assets/parts/2/4/2/7/0/23913-Pinecil-Smart-Mini-Portable-Soldering-Feature3.jpg)
187188
</figure>
188189
</a>
189190
---
190-
<a href="https://www.sparkfun.com/products/9507">
191-
**Soldering Iron - 30W (USE, 110V)**<br>
192-
TOL-09507
191+
<a href="https://www.sparkfun.com/products/23913">
192+
**PINECIL - Smart Mini Portable Soldering Iron**<br>
193+
TOL-23913
193194
</a>
194195

195196
- <a href="https://www.sparkfun.com/products/9200">
@@ -285,6 +286,14 @@ Before getting started with this Hookup Guide, you may want to read through the
285286
<a href="https://learn.sparkfun.com/tutorials/112">**Serial Terminal Basics**
286287
</a>
287288

289+
- <a href="https://learn.sparkfun.com/tutorials/1107">
290+
<figure markdown>
291+
![SparkFun Qwiic Shield for Thing Plus Hookup Guide](https://cdn.sparkfun.com/assets/learn_tutorials/1/1/0/7/Thing_Plus_Qwiic_Shield_Hookup_Guide-01.jpg)
292+
</figure>
293+
</a>
294+
<a href="https://learn.sparkfun.com/tutorials/1107">**SparkFun Qwiic Shield for Thing Plus Hookup Guide**
295+
</a>
296+
288297
- <a href="https://learn.sparkfun.com/tutorials/664">
289298
<figure markdown>
290299
![How to Work with Jumper Pads and PCB Traces](https://cdn.sparkfun.com/c/264-148/assets/learn_tutorials/6/6/4/PCB_TraceCutLumenati.jpg)

docs/print_view.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
hide:
3+
- navigation
4+
- toc
5+
icon: fontawesome/solid/scroll
6+
---
7+
8+
# Introduction
9+
--8<-- "./docs/introduction.md:5"
10+
11+
# Hardware Overview
12+
--8<-- "./docs/hardware_overview.md:5"
13+
14+
# Hardware Assembly
15+
--8<-- "./docs/hardware_assembly.md:5"
16+
17+
## Software Setup
18+
--8<-- "./docs/software_setup.md:5"
19+
20+
## Arduino Examples
21+
--8<-- "./docs/arduino_example.md"
22+
23+
# Troubleshooting Tips
24+
--8<-- "./docs/troubleshooting.md:5"
25+
26+
# Resources:
27+
--8<-- "./docs/resources.md"

docs/software_setup.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ With the ESP32-C6 Thing Plus connected to our computer, it's time to set up the
1515

1616
To install the ESP32 boards 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:
1717

18-
https://espressif.github.io/arduino-esp32/package_esp32_dev_index.json
18+
<code>
19+
https://espressif.github.io/arduino-esp32/package_esp32_dev_index.json
20+
</code>
1921

2022
Click "Ok" and then open the *Boards Manager* tool, search for "espressif ESP32" and install the latest alpha release (3.0.0-alpha2 or later). This install process may take some time so feel free to step away while it downloads and installs.
2123

docs/troubleshooting.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ Take note of the option labeled "USB CDC on Boot" when selecting the Board from
44

55
With either setting, <code>Serial1</code> is available and refers to the UART1 bus (default pins are 4 and 5).
66

7+
## RGB LED Pin
8+
9+
The board definition for the Thing Plus - ESP32-C6 sets IO23 to use espressif's `RGB_BUILTIN` code support. This automatically includes the necessary code to control an RGB LED easily when calling `RGB_BUILTIN`. Unfortunately, this means the RGB PTH pin (IO23) can run into code conflicts when users attempt to use it for another purpose. If you *really* need IO23 for something other than the RGB LED, you may need to modify the board definition files in the ESP32 Arduino boards package. Modifying these files is beyond the scope of this tutorial and is not supported by SparkFun.
10+
711
## General Troubleshooting
812

913
!!! warning "Need Help?"

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ nav:
203203
- Software Setup:
204204
- Arduino Setup: software_setup.md
205205
- Arduino Example: arduino_example.md
206-
- Resources: resources_and_going_further.md
206+
- Resources: resources.md
207207
- Support:
208208
- Troubleshooting: troubleshooting.md
209209
- Submit Issues: github/file_issue.md

overrides/main.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<!-- Adds file-eye icon to view hookup guide as a single page -->
66
{% if "single_page.md" %}
7-
<a href="/SparkFun_Thing_Plus_ESP32_C6/single_page" title="View Guide as Single-Page" class="md-content__button md-icon">
7+
<a href="/SparkFun_Thing_Plus_ESP32_C6/print_view" title="View Guide as Single-Page" class="md-content__button md-icon">
88
{% include ".icons/material/file-eye-outline.svg" %}
99
<!-- .icons/fontawesome/solid/scroll.svg -->
1010
</a>

overrides/partials/nav.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,10 @@
6969

7070
<!-- Add Hard Copies to NAV menu -->
7171
<li class="md-nav__item">
72-
<a href="/SparkFun_Thing_Plus_ESP32_C6/hard_copy/" class="md-nav__link">
72+
<a href="/SparkFun_Thing_Plus_ESP32_C6/print_view/" class="md-nav__link">
7373
<span class="md-ellipsis">
74-
Hard Copies&nbsp;{% include ".icons/material/book-open-variant.svg" %}
74+
🖨️ Print View
75+
<!-- Hard Copies&nbsp;{% include ".icons/material/book-open-variant.svg" %} -->
7576
</span>
7677
</a>
7778
</li>

overrides/partials/tabs.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@
3434
{% if "hard_copy.md" %}
3535
<ul class="md-tabs__list" style="float: right;">
3636
<li class="md-tabs__item">
37-
<a href="/SparkFun_Thing_Plus_ESP32_C6/hard_copy/" class="md-tabs__link">
38-
Hard Copies 🖨️
37+
<a href="/SparkFun_Thing_Plus_ESP32_C6/print_view/" class="md-tabs__link">
38+
🖨️ Print View
3939
</a>
4040
</li>
4141
</ul>

0 commit comments

Comments
 (0)