Skip to content

Commit a817618

Browse files
SFEMarkSFEMark
committed
Initial Docs commit
Adding background files & first draft of documentation markdown files.
1 parent eda37e2 commit a817618

File tree

14 files changed

+978
-0
lines changed

14 files changed

+978
-0
lines changed

‎docs/arduino_example.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
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.
2+
3+
## Example 1 - Blink & Hello World
4+
5+
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]().
6+
7+
!!! note "USB CDC On Boot Settings"
8+
9+
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).
10+
11+
With either setting, <code>Serial1</code> is available and refers to the UART1 bus (default pins are 4 and 5).

‎docs/hardware_assembly.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
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.
2+
3+
## Basic USB Assembly
4+
5+
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.
6+
7+
**Photo showing USB connection**
8+
9+
!!! note
10+
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.
11+
12+
## Battery Assembly
13+
14+
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.
15+
16+
**Photo showing battery connection**
17+
18+
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: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
Let's take a closer look at the ESP32-C6 WROOM1 module and other hardware present on this Thing Plus board.
2+
3+
## ESP32-C6 WROOM1 Module
4+
5+
The ESP32-C6 WROOM1 module from espressif combines a powerful RISC-5 processor with a wireless stack compatible with most common wireless protocols.
6+
7+
**Photo highlighting ESP32-C6**
8+
9+
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.
10+
11+
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.
12+
13+
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:
14+
15+
* SDIO Sampling and Driving Clock Edge - MTMS & MTDI
16+
* Chip Boot Mode - GPIO8 & GPIO9
17+
* ROM Code Printing to UART - GPIO8
18+
* JTAG Signal Source - GPIO15
19+
20+
## Power Components
21+
22+
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.
23+
24+
**Photo highlighting power components**
25+
26+
### USB-C Connector
27+
28+
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>.
29+
30+
### 2-JST Connector, Battery Charger, & Fuel Gauge
31+
32+
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>.
33+
34+
## Pinout & Qwiic Connector
35+
36+
### PTH Headers
37+
38+
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:
39+
40+
* IO18 - CS
41+
* IO22 - SD Detect
42+
* IO11 - MAX17038 Alert
43+
* IO23 - WS2812 STAT LED Data In
44+
* IO15 - Low Power control
45+
46+
### Qwiic Connector
47+
48+
There's a Qwiic connector on the board tied to the ESP32-C6's Low Power I<sup>2</sup>C bus (I/O pins 6 and 7) for easy integration into SparkFun's Qwiic ecosystem. The Qwiic connector provides connections for SDA, SCL, 3.3V, and Ground.
49+
50+
## Buttons
51+
52+
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.
53+
54+
## LEDs
55+
56+
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.
57+
58+
## Solder Jumpers
59+
60+
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:
61+
62+
<table>
63+
<tr>
64+
<th>Label</th>
65+
<th>Default State</th>
66+
<th>Function</th>
67+
<th>Notes</th>
68+
</tr>
69+
<tr>
70+
<td>I<sup>2</sup>C</td>
71+
<td>CLOSED</td>
72+
<td>Three-way jumper pulls the SDA/SCL lines to <b>3.3V</b> through a pair of <b>2.2k&ohm;</b> resistors</td>
73+
<td>Open completely to disable pullups on I<sup>2</sup>C bus if needed</td>
74+
</tr>
75+
<tr>
76+
<td>ALRT</td>
77+
<td>CLOSED</td>
78+
<td>Ties the MAX17048's alert pin to IO11 for battery voltage monitoring</td>
79+
<td>Open to isolate IO11 from the MAX17048's alert pin</td>
80+
<tr>
81+
<td>SD_DET</td>
82+
<td>CLOSED</td>
83+
<td>Connects the &micro;SD card's card detection pin to IO19</td>
84+
<td></td>
85+
</tr>
86+
<tr>
87+
<td>MEAS</td>
88+
<td>CLOSED</td>
89+
<td>Completes the input voltage circuit from V_USB & V_Batt to the 3.3V regulator</td>
90+
<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>
91+
</tr>
92+
<tr>
93+
<td>LP</td>
94+
<td>See Note</td>
95+
<td>Enables/disables low power control for the ESP32-C6</td>
96+
<td>Three-way jumper. Defaults to disabled (connects to Ground). Adjust to IO15 side to enable low power control</td>
97+
</tr>
98+
<tr>
99+
<td>SHLD</td>
100+
<td>CLOSED</td>
101+
<td>Ties the USB-C shield pin to the ground plane</td>
102+
<td>Open to isolate USB-C shield pin from the board's ground plane</td>
103+
</tr>
104+
<tr>
105+
<td>RGB</td>
106+
<td>Open</td>
107+
<td>Connects WS2812 data out (DO) signal to the No Connect/AREF PTH pin</td>
108+
<td>Open to isolate DO signal from the No Connect/AREF PTH pin to chain with other WS2812 LEDs</td>
109+
</tr>
110+
<tr>
111+
<td>CHG</td>
112+
<td>CLOSED</td>
113+
<td>Completes Charge LED circuit</td>
114+
<td>Open to disable Charge LED</td>
115+
</tr>
116+
<tr>
117+
<td>PWR</td>
118+
<td>CLOSED</td>
119+
<td>Completes the Power LED circuit</td>
120+
<td>Open to disable the Power LED</td>
121+
</tr>
122+
</table>
123+
124+
## Board Dimensions
125+
126+
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).

0 commit comments

Comments
 (0)