Skip to content

Commit d635855

Browse files
committed
Docs update
Adding board files, common img & updating software sections.
1 parent 6b39335 commit d635855

File tree

11 files changed

+77
-4
lines changed

11 files changed

+77
-4
lines changed

.github/workflows/mkdocs.yml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Run mkdocs
2+
on:
3+
push:
4+
branches:
5+
- main
6+
7+
permissions:
8+
contents: write
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout repository
14+
uses: actions/checkout@v3
15+
16+
- name: Set up Python runtime
17+
uses: actions/setup-python@v4
18+
with:
19+
python-version: 3.x
20+
21+
- name: Install Python dependencies
22+
run: pip install mkdocs-monorepo-plugin mkdocs-redirects mkdocs-with-pdf weasyprint mkdocs-git-authors-plugin mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2
23+
24+
# - name: Install Chrome
25+
# run: sudo apt install google-chrome-stable
26+
27+
# - run: pip uninstall -y beautifulsoup4
28+
# - run: pip install beautifulsoup4==4.9.3
29+
30+
- name: Set up build cache
31+
uses: actions/cache@v2
32+
with:
33+
key: ${{ github.ref }}
34+
path: .cache
35+
36+
- name: Install Insiders build
37+
env:
38+
GH_TOKEN: ${{ secrets.GH_TOKEN }}
39+
run: pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
40+
- run: mkdocs gh-deploy --force

docs/arduino_example.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
icon: simple/arduino
3+
---
4+
15
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.
26

37
## Example 1 - Blink & Hello World
@@ -8,4 +12,8 @@ This basic example blinks the blue STAT LED on the board and also prints out "He
812

913
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).
1014

11-
With either setting, <code>Serial1</code> is available and refers to the UART1 bus (default pins are 4 and 5).
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 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.
26.4 KB
Loading
150 KB
Binary file not shown.
264 KB
Binary file not shown.
59 KB
Loading
148 KB
Loading

docs/assets/img/sfe_logo_sm.png

5.41 KB
Loading

docs/assets/img/sfe_logo_sq.png

14.5 KB
Loading

docs/hardware_overview.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,4 +123,8 @@ There are nine solder jumpers on the Thing Plus - ESP32-C6 labeled <b>I<sup>2</s
123123

124124
## Board Dimensions
125125

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).
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).
127+
128+
<figure markdown>
129+
[![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")
130+
</figure>

0 commit comments

Comments
 (0)