Skip to content

Commit

Permalink
Go Live Updates
Browse files Browse the repository at this point in the history
Adding code snippets, stylesheet & contribute/file issue files.
  • Loading branch information
SFEMark committed Mar 28, 2024
1 parent 70faa69 commit 2ceed3f
Show file tree
Hide file tree
Showing 5 changed files with 622 additions and 1 deletion.
18 changes: 18 additions & 0 deletions docs/arduino_example.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,21 @@ This does require some manual definition/setup for pins in the code which the ex

This example uses the FastLED library to cycle the RGB LED on the Thing Plus through a rainbow. Open the code from your downloaded copy of the GitHub repository or copy the code below into a blank sketch. Make sure the FastLED Library is installed, select the board (ESP32S3 Dev Module) and the Port, and click the "Upload" button.

??? "RGB LED Example"
```

--8<-- "https://raw.githubusercontent.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3/main/Firmware/RGB_LED/RGB_LED.ino"
```

## I<sup>2</sup>C Scanner Power Control

This example shows how to toggle the peripheral power voltage supply on and off as well as scan for any I<sup>2</sup>C devices connected to the I<sup>2</sup>C bus/Qwiic connector. After uploading, open the [serial monitor](https://learn.sparkfun.com/tutorials/terminal-basics/arduino-serial-monitor-windows-mac-linux) with the baud set to **115200** and you should see a serial printout of the Fuel Gauge at 0x32 as well as any other devices connected to the Qwiic connector like the screenshot below shows. If you have a Qwiic board plugged in you should see the power LED on it blinking every second as the bus is powered on and off.

??? "I2C Scanner Power Control Example"
```

--8<-- "https://raw.githubusercontent.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3/main/Firmware/I2C_Scanner_PowerControl/I2C_Scanner_PowerControl.ino"
```

<figure markdown>
[![Serial printout of I2C scan.](./assets/img/I2C_Scanner_Output.jpg){ width="600"}](./assets/img/I2C_Scanner_Output.jpg "Click to enlarge")
Expand All @@ -64,9 +73,18 @@ The SD Card Detect example is a simple example that monitors the card detect pin

After uploading, you can open the serial monitor with the baud set to **115200** and it should print out either "Card Inserted" or "No SD Card" depending on whether or not a &micro;SD card is present.

??? "SD Card Detect Example"
```

--8<-- "https://raw.githubusercontent.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3/main/Firmware/SD_Card_Detect/SD_Card_Detect.ino"
```

## PSRAM Test

This example demonstrates how to enable and use PSRAM for RAM requests above a 1,000 byte threshold. The setup initializes PSRAM and prints out whether or not this was successful and then prints out available PSRAM space.

??? "PSRAM Test Example"
```

--8<-- "https://raw.githubusercontent.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3/main/Firmware/PSRAM_Test/PSRAM_Test.ino"
```
36 changes: 36 additions & 0 deletions docs/github/contribute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Help Improve the Experience!
Spot an improvement opportunity? Feel free to contribute to our open-source design and documentation. <a href="https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/issues-pr/sparkfun/SparkFun_Thing_Plus_ESP32-S3.svg" /></a>

## Enhance our Documentation
All of this documentation can be modified by you! Please help us make it better.

* These pages are contained in the [`docs` folder](https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3/tree/main/docs) of the [SparkFun Thing Plus - ESP32-S3](https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3) repository.

### Submit a Correction
1. Fork this repo
2. Add your corrections or improvements to the markdown file
3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
* Once received, the documentation specialist will automatically be notified.
* We will review your suggested improvements to make sure they are correct and fit within our documentation standards.

## Upgrade our Hardware Design
All of our designs are open-source! Please help us make it better.

* Our board design files are contained in the [`Hardware` folder](https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3/tree/main/Hardware) of the [SparkFun Thing Plus - ESP32-S3](https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3) repository.

### Submit a Design Improvement
1. Fork this repo
2. Add your design modifications
3. File a pull request with your changes, and enjoy making the world a better place.
* Once received, the engineer in charge of the original design will automatically be notified.
* We will review your suggested upgrades, if they are within our board design standards and meet our product design requirements, we will flag these changes for our next board revision.

!!! note
Please note, that even if your suggestion is accepted, these changes may not be immediate. We may have to cycle through our current product inventory first.

## Contributors
Let's provide some recognition to those who have contributed to this project!

![GitHub Contributors Image](https://contrib.rocks/image?repo=sparkfun/SparkFun_Thing_Plus_ESP32-S3)
<br>
<a href="https://github.com/sparkfun/SparkFun_Qwiic_CO2_Sensor_SCD4X/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/issues-pr/sparkfun/SparkFun_Thing_Plus_ESP32-S3.svg" /></a>
50 changes: 50 additions & 0 deletions docs/github/file_issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Did we make a mistake?

Spot something wrong? Please let us know. <a href="https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3" alt="Issues"><img src="https://img.shields.io/github/issues/sparkfun/SparkFun_Thing_Plus_ESP32-S3.svg" /></a>

!!! attention
This is not where customers should seek assistance on a product. If you require technical assistance or have questions about a product that is not working as expected, please head over to the [SparkFun Technical Assistance](https://www.sparkfun.com/technical_assistance) page for some initial troubleshooting.
<center>
[SparkFun Technical Assistance Page](https://www.sparkfun.com/technical_assistance){ .md-button .md-button--primary }
</center>

If you can't find what you need there, the [SparkFun Forums](https://forum.sparkfun.com/index.php) is a great place to search product forums and ask questions.

!!! info "Account Registration Required"
If this is your first visit to our forum, you'll need to create a [Forum Account](https://forum.sparkfun.com/ucp.php?mode=register) to search product forums and post questions.

## Discrepancies in the Documentation

All of this documentation can be modified by you! Please help us make it better.

* The documentation files for these pages are contained in the [`docs` folder](https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3/tree/main/docs) of the [SparkFun Thing Plus - ESP32-S3](https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3) repository.

### Spot something wrong?
If a section of the documentation is incorrect, please [open an issue](https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3/issues) and let us know.

### Do you have a suggested correction?
1. With a GitHub account, fork this repo
2. Add your correction(s) or improvement(s) to the markdown file(s)
3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
* Once received, the documentation specialist will automatically be notified.
* We will review your suggested improvement(s) to make sure they are correct and fit within our documentation standards.

## Problems in the Hardware Design

All of our designs are open-source! Please help us make it better.

* Our board design files are contained in the [`Hardware` folder](https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3/tree/main/Hardware) of the [SparkFun Thing Plus - ESP32-S3](https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3) repository.

### Does something not make sense?
If part of the design is confusing, please [open an issue](https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3/issues) and let us know.

### Did we forget to include an important function of the board?
* Please keep in mind that we may intentionally exclude certain functions of the board to meet our product design requirements. *(For example, our Qwiic Micro boards are intended to fit on a small board layout and only use I<sup>2</sup>C communication; therefore, we may not have the SPI and interrupt pins available for users.)*
* If part of the board's functionality is missing, please [open an issue](https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3/issues) and file a feature request.

### Do you wish to contribute directly to improving the board design?
1. With a GitHub account, Fork this repo
2. Add your design improvement(s)
3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
* Once received, the engineer in charge of the original design will automatically be notified.
* We will review your suggested improvement(s), if they are within our board design standards and meet our product design requirements, we will flag these changes for our next board revision. *(Please note, that even if your suggestion is accepted, these changes may not be immediate. We may have to cycle through our current product inventory first.)*
Loading

0 comments on commit 2ceed3f

Please sign in to comment.