Skip to content
Open
Show file tree
Hide file tree
Changes from 6 commits
Commits
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
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

104 changes: 104 additions & 0 deletions usermods/FSEQ/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
### Configure PlatformIO

Add the following configuration to your `platformio_override.ini` (or `platformio.ini`) to enable the necessary build flags and define the usermod:

```ini
[env:esp32dev_V4]
build_flags =
-D WLED_DEBUG
-D WLED_USE_SD_SPI
-D USERMOD_FSEQ
-std=gnu++17
-I wled00/src/dependencies/json























# SD & FSEQ Usermod for WLED

This usermod adds support for playing FSEQ files from an SD card and provides a web interface for managing SD files and FSEQ playback. Follow the instructions below to install and use this usermod.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Consider adding hardware requirements section.

The introduction should specify the required hardware setup, particularly the SD card module specifications and wiring details.

Add a new section after the introduction:

## Hardware Requirements

* ESP32 board (tested with...)
* SD card module (SPI)
* SD card (FAT32 formatted)

### Wiring

| SD Card Module | ESP32     |
|---------------|-----------|
| CS            | GPIO5     |
| SCK           | GPIO18    |
| MOSI          | GPIO23    |
| MISO          | GPIO19    |
| VCC           | 3.3V      |
| GND           | GND       |

---

## Installation

### 1. Modify `usermods_list.cpp`

Add the following lines to register the FSEQ usermod. Make sure that you **do not** include any conflicting modules (e.g. `usermod_sd_card.h`):

```cpp
#ifdef USERMOD_FSEQ
#include "../usermods/FSEQ/usermod_fseq.h"
#endif

#ifdef USERMOD_FSEQ
UsermodManager::add(new UsermodFseq());
#endif

// #include "../usermods/sd_card/usermod_sd_card.h"


### 2. Configure PlatformIO

Add the following configuration to your platformio_override.ini (or platformio.ini) to enable the necessary build flags and define the usermod:


[env:esp32dev_V4]
build_flags =
-D WLED_DEBUG
-D WLED_USE_SD_SPI
-D WLED_PIN_SCK=18 ; CLK
-D WLED_PIN_MISO=19 ; Data Out (POCI)
-D WLED_PIN_MOSI=23 ; Data In (PICO)
-D WLED_PIN_SS=5 ; Chip Select (CS)
-D USERMOD_FSEQ
-std=gnu++17



### 3. Update the WLED Web Interface

To integrate the new FSEQ functionality into the WLED UI, add a new button in your index.htm file. For example, insert the following button into the navigation area:

<!-- New button for SD & FSEQ Manager -->
<button onclick="window.location.href=getURL('/sd/ui');">
<i class="icons">&#xe0d2;</i>
<p class="tab-label">Fseq</p>
</button>


This button will take you to the SD & FSEQ Manager interface.



###Usage
• Web Interface:
Access the SD & FSEQ Manager by clicking the Fseq button in the main UI. The interface allows you to view, upload, and delete SD card files as well as control FSEQ playback.
• File Management:
The SD file manager displays all files on the SD card. You can upload new files via the provided form and delete files using the red “Delete” button.
• FSEQ Playback:
Once an FSEQ file is loaded, the usermod will play the sequence on the LED strip. Use the provided web interface to start and stop playback.





Loading