Skip to content

Commit 74b44d6

Browse files
committed
Docs Update
Example code and software setup update. Adding RGB example and reworking boards package install instructions.
1 parent 4939caf commit 74b44d6

File tree

5 files changed

+16
-12
lines changed

5 files changed

+16
-12
lines changed

docs/arduino_example.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,18 @@ 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-
## Status LED Cycle
7+
## 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:
910

11+
<figure markdown>
12+
[![Screenshot of selecing the Blink RGB example.](./assets/img/BlinkRGB_example.jpg){ width="600"}](./assets/img/BlinkRGB_example.jpg "Click to enlarge.")
13+
</figure>
14+
15+
Select the board (SparkFun ESP32-C6 Qwiic Pocket or ESP32-C6 Dev Module until the Thing Plus is added to the espressif boards package) and Port and click "Upload". After uploading you should see the STAT LED on the board turn on full white, turn off, and then cycle through red, green, and blue repeatedly.
1016

1117
!!! note "USB CDC On Boot Settings"
1218

1319
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).
1420

15-
With either setting, <code>Serial1</code> is available and refers to the UART1 bus (default pins are 4 and 5).
16-
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.
21+
With either setting, <code>Serial1</code> is available and refers to the UART1 bus (default pins are 4 and 5).
156 KB
Loading
172 KB
Loading

docs/hardware_assembly.md

Lines changed: 1 addition & 1 deletion
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 move on to the Software Setup section.
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.
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")

docs/software_setup.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,20 @@ 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 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:
14-
https://espressif.github.io/arduino-esp32/package_esp32_dev_index.json
13+
14+
As of this writing, the Thing Plus ESP32-C6 is awaiting approval to be included in the alpha version of the ESP32 boards package (3.0.0-alpha2 currently) so it is *not* included in the alpha install but we're hoping it gets added very soon. We'll keep an eye out for the next update (whether it be to alpha or a full release of v3.0.0) and update this page once it is out.
15+
16+
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:
1517

16-
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.
18+
https://espressif.github.io/arduino-esp32/package_esp32_dev_index.json
1719

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.
20+
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.
1921

2022
<figure markdown>
2123
[![ESP32 Boards manager install.](./assets/img/espressif_arduino_boards.jpg){ width="600"}](./assets/img/espressif_arduino_boards.jpg "Click to enlarge")
2224
</figure>
2325

24-
## Addressable LED Library
25-
26-
26+
As mentioned above, the espressif ESP32 Arduino Boards package should soon include the Thing Plus - ESP32-C6. In the meantime, users can get most of the functionality from this board by selecting either the "SparkFun ESP32-C6 Qwiic Pocket" or the "ESP32C6 Dev Module". The Qwiic Pocket will have things like the Qwiic/I<sup>2</sup>C bus tied to the same pins as the Thing Plus.
2727

2828
## espressif IDF
2929

0 commit comments

Comments
 (0)