Skip to content

Commit 49c560d

Browse files
committed
Adds WLED app
1 parent 2b6e88a commit 49c560d

File tree

2 files changed

+73
-0
lines changed

2 files changed

+73
-0
lines changed

public/images/apps/wled_icon.png

990 Bytes
Loading

src/content/apps/wled.mdx

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
---
2+
title: "WLED"
3+
description: "Controller for a WLED device: power, color presets, effects, brightness, live WiFi/device status, resilient error handling."
4+
icon: "/images/apps/wled_icon.png" # Placeholder; replace with actual icon asset if added
5+
category: "utility"
6+
preloaded: false
7+
customizable: true
8+
fileLocation: "/apps/wled"
9+
---
10+
11+
# WLED
12+
13+
Controller for a WLED device (e.g. Octolamp). Manage power, colors, effects, brightness, and inspect live WiFi / device status directly from the badge.
14+
15+
## Features
16+
17+
- **Status Monitor**: Real‑time WiFi + WLED connectivity with clear state messages
18+
- **Power Toggle**: Immediate on/off control with confirmation
19+
- **Color Presets**: 10 presets (WHITE, RED, GREEN, BLUE, YELLOW, CYAN, MAGENTA, ORANGE, PURPLE, PINK)
20+
- **Effect Picker**: Popular WLED effects (SOLID, BLINK, BREATHE, RAINBOW, RAINBOW CYCLE, SCAN, FLOW, PACIFICA, SUNRISE)
21+
- **Brightness Control**: 0–100% slider (maps to 0–255 raw value)
22+
23+
## Controls
24+
25+
### Status View
26+
- **A**: Enter Control Menu (when WLED reachable)
27+
- **B**: Refresh status (retry WiFi / device)
28+
- **C**: Skip pending WLED queries (continue without device)
29+
- **UP / DOWN**: (no action in status view)
30+
- **HOME**: Exit to launcher
31+
32+
### Control Menu
33+
- **UP / DOWN**: Navigate items
34+
- **A**: Select item
35+
- **HOME**: Back to launcher
36+
37+
### Pickers (Color / Effect / Brightness)
38+
- **UP / DOWN**: Cycle options / adjust level
39+
- **A**: Apply selection
40+
- **HOME**: Exit to launcher
41+
42+
## Install
43+
44+
1. Copy the `badge/apps/wled/` folder from [`badger/home`](https://github.com/badger/home/tree/main/badge/apps/wled).
45+
2. Paste into `/apps/wled/` on the BADGER drive in USB disk mode.
46+
3. Eject badge, reboot, launch WLED from menu.
47+
48+
## File Layout
49+
50+
```
51+
/apps/wled/
52+
├── __init__.py # Main app: UI modes, HTTP requests, parsing, rendering
53+
├── README.md # Detailed usage + troubleshooting (upstream)
54+
└── icon.png # Optional launcher icon (replace placeholder path above)
55+
```
56+
57+
## Configuration (`/secrets.py`)
58+
59+
Add required variables to the root-level `secrets.py`:
60+
61+
```python
62+
# WiFi credentials (required)
63+
WIFI_SSID = "YourNetworkName"
64+
WIFI_PASSWORD = "YourNetworkPassword"
65+
66+
# WLED device IP (required)
67+
WLED_IP = "192.168.1.100" # Replace with your device's IP
68+
```
69+
70+
## Source
71+
72+
View the complete source code on GitHub:
73+
- [WLED controller app](https://github.com/badger/home/blob/main/badge/apps/wled/__init__.py)

0 commit comments

Comments
 (0)