Commander1024/ESP32_Serial_Swiss_Army_Knife
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add GPL-3.0 license and document hardware wiring

Browse Source
This commit is contained in:
Commander1024
2026-08-21 13:02:18 +02:00
parent 9fe4ac75fd
commit 146dfe51a7
3 changed files with 775 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8
View File
@@ -11,6 +11,10 @@ Universal wireless serial adaptor firmware for the ESP32-S3.
The initial smoke-test firmware continuously sweeps the onboard addressable RGB LED through the color wheel at reduced brightness. The official ESP32-S3-DevKitC-1 v1.0 uses GPIO48 for the LED data signal, while official v1.1 boards use GPIO38. Compatible boards and clones may vary.
## Hardware wiring
See [`wiring.md`](wiring.md) for hardware-specific wiring profiles. The initial profile covers the ESP32-S3-DevKitC-1 N16R8 and the Adafruit MAX3243 full-pinout RS-232 breakout.
## Build
```sh
@@ -35,3 +39,7 @@ Sweeping the onboard RGB LED on GPIO48
```
If the firmware runs but the RGB LED remains dark, verify the board revision. The project defaults to GPIO48, commonly used by DevKitC-compatible boards and official v1.0 boards. For an official v1.1 board — or another board wired that way — change `RGB_LED_GPIO` in `platformio.ini` from `48` to `38`, rebuild, and upload again.
## License
This project is licensed under the [GNU General Public License version 3 only](LICENSE) (`GPL-3.0-only`). This is compatible with using the GPLv3 releases of wolfSSL and wolfSSH later. Third-party components remain subject to their respective licenses.