Skip to content
Open
Show file tree
Hide file tree
Changes from all 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
20 changes: 20 additions & 0 deletions fs_data/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# fs_data (PlatformIO data_dir)

This folder is used as a minimal PlatformIO filesystem payload (`data_dir`) for builds that use `buildfs/uploadfs`.

## Why it exists
In some setups (e.g. ESP32 4MB flash with smaller FS partitions), building a filesystem image from the default `wled00/data` content can exceed the available FS size and fail with errors like:
- `SPIFFS_write error: File system is full`

To avoid that, `fs_data` contains only small config placeholders (e.g. `cfg.json`, `presets.json`) so filesystem builds remain reproducible on limited partitions.

## What to put here
- `cfg.json` (optional, can be `{}`)
- `presets.json` (optional, can be `{}`)
- `wsec.json` (optional) — **do not commit secrets** (WiFi credentials). Keep it empty (`{}`) or manage locally.

## How it is used
Typically enabled via `platformio_override.ini`, e.g.:
- `data_dir = ${PROJECT_DIR}/fs_data`

This keeps upstream files untouched while allowing local/CI builds to succeed.
1 change: 1 addition & 0 deletions fs_data/cfg.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
1 change: 1 addition & 0 deletions fs_data/presets.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
1 change: 1 addition & 0 deletions fs_data/wsec.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
8 changes: 8 additions & 0 deletions platformio_override.ini.olaf.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
; copy to platformio_override.ini (local override, ignored by git)

[platformio]
default_envs = esp32_4MB_V4_M

[env]
build_flags =
-D WLED_RELEASE_NAME=\"WLEDMM-OLAF\"