Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updating readme for S3 board #32

Merged
merged 1 commit into from
Jan 29, 2025
Merged

updating readme for S3 board #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ If you can't see the video, you can watch it [here](https://youtu.be/sL6wH5F_ERE

- Vscode and [PlatformIO](https://platformio.org/install/ide?install=vscode) plugin: For firmware burning
- Starmoon API key: Login to [Starmoon](https://www.starmoon.app/login) and go to settings page to get your API key
- Clone the repository: `git clone https://github.com/StarmoonAI/Starmoon.git`

2. Hardware list (Tax and shipping rates may vary by region)
- [Seeed Studio Xiao ESP32S3](https://www.aliexpress.us/item/1005007341749305.html)
Expand All @@ -75,7 +76,7 @@ If you can't see the video, you can watch it [here](https://youtu.be/sL6wH5F_ERE
| **Component** | **Seeed Studio XIAO ESP32S3** | **ESP32-S3** |
| -------------------------- | ----------------------------- | ------------ |
| **I2S Input (Microphone)** | | |
| SD | D0 | GPIO 13 |
| SD | D0 | GPIO 14 |
| WS | D1 | GPIO 1 |
| SCK | D2 | GPIO 4 |
| **I2S Output (Speaker)** | | |
Expand Down
34 changes: 24 additions & 10 deletions firmware/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,21 @@ This firmware turns your Seed Studio XIAO ESP32-S3 (or general ESP32 WROOM Dev m

<!-- ### For Seeed Studio XIAO ESP32S3 -->

| **Component** | **Seeed Studio XIAO ESP32S3** | **General ESP32 Dev Board** |
| **Component** | **Seeed Studio XIAO ESP32S3** | **ESP32-S3 Dev Board** |
| -------------------------- | ----------------------------- | --------------------------- |
| **I2S Input (Microphone)** | | |
| SD | D9 | GPIO 13 |
| WS | D7 | GPIO 5 |
| SCK | GD8 | GPIO 18 |
| SD | D9 | GPIO 14 |
| WS | D7 | GPIO 4 |
| SCK | D8 | GPIO 1 |
| **I2S Output (Speaker)** | | |
| WS | D0 | GPIO 32 |
| BCK | D1 | GPIO 33 |
| DATA | D2 | GPIO 25 |
| WS | D0 | GPIO 5 |
| BCK | D1 | GPIO 6 |
| DATA | D2 | GPIO 7 |
| SD (shutdown) | D3 | N/A |
| **Others** | | |
| LED | D4 | GPIO 2 |
| Button | D5 | GPIO 26 |
| Single LED | D4 | Any GPIO
| RGB LED | x | GPIO 13, 8, and 9 |
| Button | D5 | GPIO 2 |

<!--
I2S Input (Microphone)
Expand Down Expand Up @@ -102,7 +103,20 @@ This firmware turns your Seed Studio XIAO ESP32-S3 (or general ESP32 WROOM Dev m
gilmaimon/ArduinoWebsockets @ ^0.5.3
bblanchon/ArduinoJson @ ^7.1.0
```


- For ESP32-S3 Dev Board
```ini
[env:esp32-s3-devkitm-1]
platform = espressif32
board = esp32-s3-devkitm-1
framework = arduino
monitor_speed = 115200
lib_deps =
https://github.com/tzapu/WiFiManager.git
gilmaimon/ArduinoWebsockets @ ^0.5.3
bblanchon/ArduinoJson @ ^7.1.0
```

5. Update the WebSocket server details in the code:

- Find the following lines in the code and update them with your information:
Expand Down
25 changes: 16 additions & 9 deletions firmware/platformio.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@
; Please visit documentation for the other options and examples
; https://docs.platformio.org/page/projectconf.html

[env:seeed_xiao_esp32s3]
platform = espressif32
board = seeed_xiao_esp32s3
framework = arduino
monitor_speed = 115200

; [env:esp32-s3-devkitm-1]
; [env:seeed_xiao_esp32s3]
; platform = espressif32
; board = esp32-s3-devkitm-1
; board = seeed_xiao_esp32s3
; framework = arduino
; monitor_speed = 115200

[env:esp32-s3-devkitm-1]
platform = espressif32
board = esp32-s3-devkitm-1
framework = arduino
monitor_speed = 115200

; [env:upesy_wroom]
; platform = espressif32
; board = upesy_wroom
Expand All @@ -36,12 +36,19 @@ lib_deps =
; lib_deps = https://github.com/pschatzmann/arduino-audio-tools.git
; upload_protocol = esptool
; upload_port = /dev/ttyUSB*
board_build.arduino.memory_type = qio_opi
board_build.flash_mode = qio
board_build.prsam_type = opi
board_upload.flash_size = 16MB
board_upload.maximum_size = 16777216
board_build.extra_flags =
-DBOARD_HAS_PSRAM
monitor_filters =
esp32_exception_decoder
time
build_flags =
-D CORE_DEBUG_LEVEL=0
; -D BOARD_HAS_PSRAM=1`
-D BOARD_HAS_PSRAM=1
board_build.partitions = partition.csv
; board_build.flash_mode = dio
; board_build.arduino.memory_type = opi_qspi
4 changes: 2 additions & 2 deletions firmware/src/Config.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ extern int16_t sBuffer[];

// ----------------- Pin Definitions -----------------
// Define which board you are using (uncomment one)
// #define USE_NORMAL_ESP32_S3
#define USE_XIAO_ESP32_DEVKIT
#define USE_NORMAL_ESP32_S3
// #define USE_XIAO_ESP32_DEVKIT
// #define USE_XIAO_ESP32
// #define USE_NORMAL_ESP32
// #define USE_ESP32_S3_WHITE_CASE
Expand Down