Skip to content

Commit 4939caf

Browse files
committed
Docs Update and review
Final photos added and initial content functionality review/edits.
1 parent 9b01a51 commit 4939caf

10 files changed

+87
-31
lines changed

docs/arduino_example.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,14 @@ icon: simple/arduino
44

55
Now that we've installed the espressif boards package in Arduino, it's time to upload our first sketch to make sure everything is working properly.
66

7-
## Example 1 - Blink & Hello World
7+
## Status LED Cycle
8+
89

9-
This basic example blinks the blue STAT LED on the board and also prints out "Hello World" over the USB serial connection. Copy the code below into a blank sketch or download the example from the [GitHub Repository]().
1010

1111
!!! note "USB CDC On Boot Settings"
1212

1313
Take note of the option labeled "USB CDC on Boot" when selecting the Board from the Tools menu. This option sets the serial outputs and defines their label for use in code. The SparkFun variants default to Enable USB CDC on boot which sets both <code>Serial</code> and <code>Serial0</code> as available serial ports. In this configuration, <code>Serial</code> corresponds to the direct USB/Serial converter on the chip (and the USB-C interface) and <code>Serial0</code> corresponds to the UART0 bus (default pins are 16 and 17).
1414

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

17-
Select the board (SparkFun ESP32-C6 Thing Plus) and Port and click "Upload". After uploading you should see the STAT LED on the board blinking every second.
18-
19-
Now that we've installed the espressif boards package in Arduino, it's time to upload our first sketch to make sure everything is working properly.
17+
Select the board (SparkFun Pocket Dev ESP32-C6 or ESP32-C6 Module until the Thing Plus is added to the boards package) and Port and click "Upload". After uploading you should see the STAT LED on the board cycling through colors.
466 KB
Loading
490 KB
Loading
420 KB
Loading
317 KB
Loading
32.7 KB
Loading

docs/hardware_assembly.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
1+
---
2+
icon: material/cog
3+
---
4+
15
Now that we're familiar with the hardware on this Thing Plus board, it's time to connect it to our computer or battery power.
26

37
## Basic USB Assembly
48

59
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 move on to the Software Setup section.
610

7-
**Photo showing USB connection**
11+
<figure markdown>
12+
[![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")
13+
</figure>
814

915
!!! note
1016
Your computer may not recognize the board as a known USB device if you have not installed the espressif boards package in Arduino and/or installed the espressif IDF.
@@ -13,6 +19,8 @@ Basic assembly of the Thing Plus ESP32-C only requires a USB-C cable connecting
1319

1420
If you prefer a battery-powered application, plug a single-cell LiPo battery into the 2-pin JST connector on the underside of the board like the photo below. Remember, the MCP73831 only charges the battery when V_USB has voltage present either from the USB-C connector or through the V_USB PTH pin.
1521

16-
**Photo showing battery connection**
22+
<figure markdown>
23+
[![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")
24+
</figure>
1725

1826
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.

docs/hardware_overview.md

Lines changed: 38 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1+
---
2+
icon: material/cog
3+
---
4+
15
Let's take a closer look at the ESP32-C6 WROOM1 module and other hardware present on this Thing Plus board.
26

37
## ESP32-C6 WROOM1 Module
48

59
The ESP32-C6 WROOM1 module from espressif combines a powerful RISC-5 processor with a wireless stack compatible with most common wireless protocols.
610

711
<figure markdown>
8-
[![Photo highlighting ESP32-C6 module.](./assets/img/Thing_Plus_C6-Module.jpg){ width="600"}](./assets/ "Click to enlarge")
12+
[![Photo highlighting ESP32-C6 module.](./assets/img/Thing_Plus_C6-Module.jpg){ width="600"}](./assets/img/Thing_Plus_C6-Module.jpg "Click to enlarge")
913
</figure>
1014

1115
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.
@@ -14,42 +18,42 @@ The module features a wide range of peripheral options including SPI, UART, LPUA
1418

1519
The ESP32-C6 has 16 MB Flash memory along with 512 KB SRAM (high power)/ 16 KB SRAM (low power). The module uses pin strapping to configure boot mode parameters. The board defaults to standard mode (GPIO 9 internal pull-up, all other strapping pins floating) but it can be set to other parameters by performing the following pin strapping:
1620

17-
* SDIO Sampling and Driving Clock Edge - MTMS & MTDI
18-
* Chip Boot Mode - GPIO8 & GPIO9
19-
* ROM Code Printing to UART - GPIO8
20-
* JTAG Signal Source - GPIO15
21+
* SDIO Sampling and Driving Clock Edge - MTMS & MTDI
22+
* Chip Boot Mode - GPIO8 & GPIO9
23+
* ROM Code Printing to UART - GPIO8
24+
* JTAG Signal Source - GPIO15
2125

2226
## Power Components
2327

2428
The Thing Plus ESP32-C6 includes several options for powering including USB-C, LiPo battery with on-board battery charging and monitoring circuits as well as direct power inputs.
2529

2630
<figure markdown>
27-
[![Photo highlighting power components/pins.](./assets/img/Thing_Plus_C6-Power.jpg){ width="600"}](./assets/ "Click to enlarge")
31+
[![Photo highlighting power components/pins.](./assets/img/Thing_Plus_C6-Power.jpg){ width="600"}](./assets/img/Thing_Plus_C6-Power.jpg "Click to enlarge")
2832
</figure>
2933

3034
### USB-C Connector
3135

3236
The USB-C connector on the board acts as the primary serial interface for the ESP32-C6 module as well as a power input. It connects directly to the ESP32-C6's USB serial converter. 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>500mA@3.3V</b>.
3337

34-
### 2-JST Connector, Battery Charger, & Fuel Gauge
38+
### 2-Pin JST Connector, Battery Charger, & Fuel Gauge
3539

36-
The board has a 2-pin JST connector to connect a single-cell Lithium Ion (LiPo) battery for battery-powered applications. It also has an MCP73831 battery charger to charge an attached battery and a MAX17048 fuel gauge to monitor battery voltage levels. The charge rate is set to <b>214mA@3.3V</b>. The MCP73831 receives power from the V_USB line so it only is powered when <b>5V</b> is provided either over USB or the V_USB PTH pin. If applying voltage directly to the V_USB pin make sure it does not exceed <b>5.5V</b>.
40+
The board has a 2-pin JST connector to connect a single-cell Lithium Ion (LiPo) battery for battery-powered applications. It also has an MCP73831 battery charger to charge an attached battery and a MAX17048 fuel gauge to monitor battery voltage levels over I<sup>2</sup>C. The charge rate is set to <b>214mA@3.3V</b>. The MCP73831 receives power from the V_USB line so it only is powered when <b>5V</b> is provided either over USB or the V_USB PTH pin. If applying voltage directly to the V_USB pin make sure it does not exceed <b>5.5V</b>.
3741

3842
## Pinout & Qwiic Connector
3943

4044
<figure markdown>
41-
[![Photo highlighting through-hole pinouts.](./assets/img/Thing_Plus_C6-PTHs.jpg){ width="600"}](./assets/ "Click to enlarge")
45+
[![Photo highlighting through-hole pinouts.](./assets/img/Thing_Plus_C6-PTHs.jpg){ width="600"}](./assets/img/Thing_Plus_C6-PTHs.jpg "Click to enlarge")
4246
</figure>
4347

4448
### PTH Headers
4549

4650
The Thing Plus routes 23 of the ESP32-C6's GPIO pins to a pair of 0.1"-spaced headers on either side of the board. This includes all seven of the 12-bit ADC-capable pins, one UART, one I<sup>2</sup>C bus (SDA/SCL), one SPI interface (POCI/PICO/SCK), and seven GPIO pins. Some of the GPIO connect to specific functions on the board by default through solder jumpers listed below:
4751

48-
* IO18 - CS
49-
* IO22 - SD Detect
50-
* IO11 - MAX17038 Alert
51-
* IO23 - WS2812 STAT LED Data In
52-
* IO15 - Low Power control
52+
* IO18 - CS
53+
* IO22 - SD Detect
54+
* IO11 - MAX17038 Alert
55+
* IO23 - WS2812 STAT LED Data In
56+
* IO15 - Low Power control
5357

5458
### Qwiic Connector
5559

@@ -60,23 +64,39 @@ There's a Qwiic connector on the board tied to the ESP32-C6's Low Power I<sup>2<
6064
There are two buttons on the board labeled <b>RESET</b> and <b>BOOT</b>. The RESET button is tied to the ESP32-C6's Enable (EN) pin and resets the module when pressed. The BOOT button puts the ESP32-C6 into bootloader mode when held down during power on or reset.
6165

6266
<figure markdown>
63-
[![Photo highlighting solder jumpers.](./assets/img/Thing_Plus_C6-Buttons.jpg){ width="600"}](./assets/ "Click to enlarge")
67+
[![Photo highlighting buttons.](./assets/img/Thing_Plus_C6-Buttons.jpg){ width="600"}](./assets/img/Thing_Plus_C6-Buttons.jpg "Click to enlarge")
68+
</figure>
69+
70+
## &micro;SD Card Slot
71+
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.
73+
74+
<figure markdown>
75+
[![Photo highlighting microSD card slot](./assets/img/Thing_Plus_C6-SD.jpg){ width="600"}](./assets/img/Thing_Plus_C6-SD.jpg "Click to enlarge")
6476
</figure>
6577

78+
The slot connects the SD card's communication interface to the ESP32-C6's SPI interface using the following pins:
79+
80+
* SD Serial Data Out: IO21/POCI
81+
* SD Serial Data In: IO20/PICO
82+
* SD Serial Clock: IO19/SCK
83+
* SD Chip Select: IO18/CS
84+
* SD Detect: IO22/SD_DET
85+
6686
## LEDs
6787

6888
This Thing Plus has three LEDs labeled <b>PWR</b>, <b>CHG</b>, and <b>STAT</b>. The red Power (PWR) LED indicates whenever the <b>3.3V</b> circuit is powered. The yellow Charge (CHG) LED indicates whenever the MCP73831 is charging a connected LiPo battery. The WS2812 RGB Status (STAT) LED connects the LED's Data In signal to IO23.
6989

7090
<figure markdown>
71-
[![Photo highlighting solder jumpers.](./assets/img/Thing_Plus_C6-LEDs.jpg){ width="600"}](./assets/ "Click to enlarge")
91+
[![Photo highlighting solder jumpers.](./assets/img/Thing_Plus_C6-LEDs.jpg){ width="600"}](./assets/img/Thing_Plus_C6-LEDs.jpg "Click to enlarge")
7292
</figure>
7393

7494
## Solder Jumpers
7595

7696
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:
7797

7898
<figure markdown>
79-
[![Photo highlighting solder jumpers.](./assets/img/Thing_Plus_C6-Jumpers.jpg){ width="600"}](./assets/ "Click to enlarge")
99+
[![Photo highlighting solder jumpers.](./assets/img/Thing_Plus_C6-Jumpers.jpg){ width="600"}](./assets/img/Thing_Plus_C6-Jumpers.jpg "Click to enlarge")
80100
</figure>
81101

82102
<table>
@@ -107,7 +127,7 @@ There are nine solder jumpers on the Thing Plus - ESP32-C6 labeled <b>I<sup>2</s
107127
<td>MEAS</td>
108128
<td>CLOSED</td>
109129
<td>Completes the input voltage circuit from V_USB & V_Batt to the 3.3V regulator</td>
110-
<td>Open to interrupt the circuit to measure current consumed by the board with a [digital multimeter](https://learn.sparkfun.com/tutorials/how-to-use-a-multimeter#measuring-current)</td>
130+
<td>Open to interrupt the circuit to measure current consumed by the board with a <a href="https://learn.sparkfun.com/tutorials/how-to-use-a-multimeter#measuring-current">digital multimeter</a></td>
111131
</tr>
112132
<tr>
113133
<td>LP</td>

docs/introduction.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,34 @@
1-
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).
1+
---
2+
icon: material/book-open-page-variant
3+
---
4+
5+
<div class="grid cards desc" markdown>
6+
7+
- <a href="https://www.sparkfun.com/products/23618">
8+
**SparkFun LTE Stick - LARA-R6**<br>
9+
**SKU:** DEV-22924
10+
11+
---
12+
13+
<figure markdown>
14+
![Product Thumbnail](https://cdn.sparkfun.com/r/600-600/assets/parts/2/3/0/8/5/DEV-22924-Thing-Plus-ESP32-C6-Feature.jpg)
15+
</figure></a>
16+
17+
18+
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).
20+
21+
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.
22+
23+
<center>
24+
[Purchase from SparkFun :fontawesome-solid-cart-plus:{ .heart }](https://www.sparkfun.com/products/22924){ .md-button .md-button--primary }
25+
</center>
26+
27+
</div>
228

329
## Required Materials
430

5-
To follow along with this guide you will need a 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 dev board to your computer:
632

733
<div class="grid cards" markdown>
834

@@ -198,7 +224,7 @@ We designed this board for integration into SparkFun's Qwiic connect system. Cl
198224
<table>
199225
<tr>
200226
<td>
201-
<div style="text-align: center"><a href="https://www.sparkfun.com/qwiic"><img src="../assets/images/Qwiic-registered-updated.png" alt="Qwiic Connect System" title="Click to learn more about the Qwiic Connect System!"></a></div>
227+
<div style="text-align: center"><a href="https://www.sparkfun.com/qwiic"><img src="../assets/img/Qwiic-registered-updated.png" alt="Qwiic Connect System" title="Click to learn more about the Qwiic Connect System!"></a></div>
202228
</td>
203229
</tr>
204230
<tr>

docs/software_setup.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,21 @@ With the ESP32-C6 Thing Plus connected to our computer, it's time to set up the
1010
## Installing espressif Arduino Boards
1111

1212
!!! important
13-
As of this board's release, espressif is currently working on an update to v3.0.0 for their boards manager with support for the ESP32-C6 development boards including the Qwiic Pocket Development Board - ESP32-C6. This release is in alpha phase at the moment so installing this package requires a few extra steps. Open the preferences menu by navigating to <b>File</b> > <b>Preferences</b>. Look at the bottom of the Prefences menu for "Additional boards manager URLS" and then copy this JSON link into that field:
13+
As of this board's release, espressif is currently working on an update to v3.0.0 for their Arduino boards package to include the Thing Plus - ESP32-C6 as a board variant (among other updates). Unfortunately, as of this writing, this version does <i>not</i> include the Thing Plus ESP32-C6 and is also in alpha phase at the moment so installing this package requires a few extra steps. Open the preferences menu by navigating to <b>File</b> > <b>Preferences</b>. Look at the bottom of the Prefences menu for "Additional boards manager URLS" and then copy this JSON link into that field:
1414
https://espressif.github.io/arduino-esp32/package_esp32_dev_index.json
1515

1616
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 but when it completes, you can select "ESP32-C6 dev module" as the board to upload code to the Qwiic Pocket Development Board. We'll keep an eye out for the full release of v3.0.0 and update this page once it is out.
1717

18-
The espressif ESP32 Arduino Boards package includes the Thing Plus - ESP32-C6. Install it by opening the Boards Manager tab on the left side of the IDE, then search for "espressif ESP32" and install the latest version of the ESP32 boards package as the screenshot below shows. This assumes the use of Arduino 2.x. Legacy users (Arduino 1.8x and previous) can find the Boards Manager tool in File/Tools/Boards Manager.
18+
The espressif ESP32 Arduino Boards package should soon include the Thing Plus - ESP32-C6 though as of this writing it is not included. In the meantime, users can get most of the Install it by opening the Boards Manager tab on the left side of the IDE, then search for "espressif ESP32" and install the latest version of the ESP32 boards package as the screenshot below shows. This assumes the use of Arduino 2.x. Legacy users (Arduino 1.8x and previous) can find the Boards Manager tool in File/Tools/Boards Manager.
1919

2020
<figure markdown>
21-
[![ESP32 Boards manager install.](./assets/img/espressif_arduino_boards.jpg){ width="400"}](./assets/images/espressif_arduino_boards.jpg "Click to enlarge")
21+
[![ESP32 Boards manager install.](./assets/img/espressif_arduino_boards.jpg){ width="600"}](./assets/img/espressif_arduino_boards.jpg "Click to enlarge")
2222
</figure>
2323

24+
## Addressable LED Library
25+
26+
27+
2428
## espressif IDF
2529

2630
Users who prefer to use espressif's development toolkit, espressif IDF, can get started by following their instructions [here](https://www.espressif.com/en/products/sdks/esp-idf) and ESP32-C6 specific documentation [here](https://docs.espressif.com/projects/esp-idf/en/stable/esp32c6/index.html).

0 commit comments

Comments
 (0)