Skip to content

Commit 001bc28

Browse files
author
devpossible
committed
feat(docs): enhance panel and theme documentation with new entries
1 parent 75e352f commit 001bc28

8 files changed

Lines changed: 415 additions & 17 deletions

File tree

CLAUDE.md

Lines changed: 70 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -193,29 +193,93 @@ The `test` command renders panels to JPEG files without requiring an LCD device.
193193

194194
## Available Panel Types
195195

196+
For complete panel documentation with screenshots, see `docs/panels/README.md`.
197+
198+
### System Monitoring Panels
199+
196200
| Panel Type | Description |
197201
|------------|-------------|
202+
| `basic-info` | Hostname, OS, uptime summary |
203+
| `basic-usage-text` | Basic system usage as text |
198204
| `cpu-info` | CPU model and specifications |
205+
| `cpu-status` | CPU dashboard with usage bar, temperature, sparkline |
199206
| `cpu-usage-text` | CPU usage as text |
200207
| `cpu-usage-graphic` | CPU usage with visual bars |
201-
| `cpu-widget` | CPU info using responsive HTML widgets (new) |
202-
| `ram-info` | RAM specifications |
203-
| `ram-usage-text` | RAM usage as text |
204-
| `ram-usage-graphic` | RAM usage with visual bars |
208+
| `cpu-thermal-graphic` | CPU temperature gauge |
205209
| `gpu-info` | GPU model and specifications |
206210
| `gpu-usage-text` | GPU usage as text |
207211
| `gpu-usage-graphic` | GPU usage with visual bars |
208-
| `basic-info` | Hostname, OS, uptime summary |
209-
| `basic-usage-text` | Basic system usage as text |
212+
| `gpu-thermal-graphic` | GPU temperature gauge |
213+
| `ram-info` | RAM specifications |
214+
| `ram-usage-text` | RAM usage as text |
215+
| `ram-usage-graphic` | RAM usage with visual bars |
216+
| `system-thermal-graphic` | Combined CPU/GPU temperature display |
210217
| `network-info` | Network interfaces (smart layout, 1-4 widgets) |
218+
219+
### Proxmox Panels
220+
221+
| Panel Type | Description |
222+
|------------|-------------|
211223
| `proxmox-summary` | Proxmox cluster overview |
212224
| `proxmox-vms` | Proxmox VM/Container list |
225+
226+
### Media Panels
227+
228+
| Panel Type | Description |
229+
|------------|-------------|
213230
| `animated-gif:<path\|url>` | Animated GIF from file or URL |
214231
| `image-sequence:<folder>` | Folder of numbered images as animation |
215232
| `video:<path\|url>` | Video file, URL, or YouTube link |
216233
| `html:<path>` | Local HTML file rendered as web page |
217234
| `web:<url>` | Live website rendered from URL |
218235

236+
### Screensaver Panels
237+
238+
| Panel Type | Description |
239+
|------------|-------------|
240+
| `screensaver` | Random screensaver or cycle through all |
241+
| `clock` | Analog clock with smooth second hand |
242+
| `plasma` | Classic demoscene plasma effect |
243+
| `matrix-rain` | Digital rain effect (The Matrix) |
244+
| `starfield` | Classic starfield warp effect |
245+
| `warp-tunnel` | Flying through colorful warp tunnel |
246+
| `fire` | Classic demoscene fire effect |
247+
| `pipes` | 3D pipes growing in random directions |
248+
| `mystify` | Bouncing connected polygons with trails |
249+
| `bubbles` | Floating translucent bubbles |
250+
| `rain` | Falling raindrops with splash effects |
251+
| `noise` | TV static / white noise effect |
252+
| `spiral` | Hypnotic rotating spiral pattern |
253+
| `game-of-life` | Conway's cellular automaton |
254+
| `asteroids` | Asteroids game simulation |
255+
| `falling-blocks` | Tetris-style falling blocks |
256+
| `missile-command` | Defend cities from missiles |
257+
| `bouncing-logo` | DVD screensaver style bouncing text |
258+
259+
## Available Themes
260+
261+
For complete theme documentation, see `docs/themes/README.md`.
262+
263+
| Theme | Category | Description |
264+
|-------|----------|-------------|
265+
| `cyberpunk` | Gamer | Neon cyan/magenta, glow effects (default) |
266+
| `rgb-gaming` | Gamer | Vibrant rainbow, bold colors |
267+
| `executive` | Corporate | Dark blue/gold, professional |
268+
| `clean` | Corporate | Light mode, minimal |
269+
270+
### Theme Usage
271+
272+
```bash
273+
# Set default theme
274+
lcdpossible config set-theme cyberpunk
275+
276+
# List available themes
277+
lcdpossible config list-themes
278+
279+
# Per-panel theme override
280+
lcdpossible show cpu-info|@theme=executive
281+
```
282+
219283
### Media Panel Examples
220284

221285
```bash
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# CPU Status
2+
3+
**Panel ID:** `cpu-status`
4+
**Category:** CPU
5+
**Plugin:** LCDPossible Core Panels
6+
**Live Data:** Yes
7+
**Animated:** No
8+
9+
CPU status panel with comprehensive metrics display including usage bar, temperature gauge, and per-core usage sparkline.
10+
11+
## Overview
12+
13+
The cpu-status panel provides a comprehensive CPU monitoring view using the WidgetPanel system. It displays CPU metrics through HTML/CSS web components in a responsive 12-column grid layout, making it suitable for at-a-glance monitoring from 3-6 feet viewing distance.
14+
15+
## Screenshot
16+
17+
![CPU Status](cpu-status.jpg)
18+
19+
## Widgets Displayed
20+
21+
The panel dynamically arranges widgets based on available sensor data:
22+
23+
| Widget | Span | Description |
24+
|--------|------|-------------|
25+
| CPU Name | 4 cols | Model name (e.g., "AMD Ryzen 9 5900X") |
26+
| Usage Bar | 8 cols | Overall CPU usage percentage with progress bar |
27+
| Temperature Gauge | 3 cols | CPU temperature with circular gauge (if available) |
28+
| Stats Info List | 4-6 cols | Frequency, power consumption, core count |
29+
| Core Usage Sparkline | 5-6 cols | Per-core usage visualization (if available) |
30+
31+
## Data Requirements
32+
33+
- CPU model name
34+
- Overall usage percentage
35+
- Temperature (optional, requires sensors)
36+
- Frequency in MHz (optional)
37+
- Power consumption in watts (optional)
38+
- Per-core usage array (optional)
39+
40+
Requires LibreHardwareMonitor for Windows sensor data.
41+
42+
## Dependencies
43+
44+
- LibreHardwareMonitorLib (Windows)
45+
- PuppeteerSharp (headless browser)
46+
47+
## Examples
48+
49+
### Display CPU status panel
50+
51+
```bash
52+
lcdpossible show cpu-status
53+
```
54+
55+
### Display with executive theme
56+
57+
```bash
58+
lcdpossible show cpu-status|@theme=executive
59+
```
60+
61+
### Display for 30 seconds
62+
63+
```bash
64+
lcdpossible show cpu-status|@duration=30
65+
```
66+
67+
## Profile Usage
68+
69+
### Add to Profile
70+
71+
```bash
72+
# Add panel to default profile
73+
lcdpossible profile append-panel cpu-status
74+
75+
# Add with custom duration and theme
76+
lcdpossible profile append-panel "cpu-status|@duration=30|@theme=cyberpunk"
77+
```
78+
79+
### Quick Show
80+
81+
```bash
82+
# Display panel immediately
83+
lcdpossible show cpu-status
84+
```
85+
86+
## Comparison with Other CPU Panels
87+
88+
| Panel | Style | Best For |
89+
|-------|-------|----------|
90+
| `cpu-info` | Info cards | Detailed specifications |
91+
| `cpu-status` | Dashboard | At-a-glance monitoring |
92+
| `cpu-usage-graphic` | Bar charts | Usage breakdown |
93+
| `cpu-usage-text` | Large text | Simple usage display |
94+
| `cpu-thermal-graphic` | Thermometer | Temperature focus |
95+
96+
---
97+
98+
*Generated by [LCDPossible](https://github.com/DevPossible/LCDPossible)*

docs/panels/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,17 @@
22

33
This directory contains documentation and screenshots for all available display panels.
44

5+
**Related Documentation:**
6+
- [Themes](../themes/README.md) - Available color themes and customization
7+
58
## Panel Categories
69

710
### CPU
811

912
| Panel | Description | Plugin |
1013
|-------|-------------|--------|
1114
| [CPU Info](core/panels/cpu-info/cpu-info.md) | Detailed CPU information including model, usage, temperature, frequency, and power | core |
15+
| [CPU Status](core/panels/cpu-status/cpu-status.md) | CPU dashboard with usage bar, temperature gauge, and per-core sparkline | core |
1216
| [CPU Usage Graphic](core/panels/cpu-usage-graphic/cpu-usage-graphic.md) | CPU usage with graphical bars including per-core breakdown | core |
1317
| [CPU Usage Text](core/panels/cpu-usage-text/cpu-usage-text.md) | CPU usage displayed as large text percentage | core |
1418

0 commit comments

Comments
 (0)