Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
68d03ea260 | ||
|
|
a55504c0af | ||
|
|
bd17fad578 | ||
|
|
7d5044c315 | ||
|
|
c696270182 | ||
|
|
a11c59698a | ||
|
|
149f1daa1e | ||
|
|
68d5540985 | ||
|
|
72b443d541 | ||
|
|
c5f5e25150 | ||
|
|
278d757de0 | ||
|
|
6b47599c4a | ||
|
|
87ff97d006 | ||
|
|
4ab0c871c8 | ||
|
|
013a2663e5 | ||
|
|
af96c6ffd6 | ||
|
|
923611b836 | ||
|
|
dabe7f05bc | ||
|
|
21c0cfa22d | ||
|
|
05e7c43b27 | ||
|
|
2ffc57cf40 | ||
|
|
aab0e9ade0 | ||
|
|
978a03b42d | ||
|
|
bd9f461f70 | ||
|
|
3b93024993 | ||
|
|
85d321cf33 | ||
|
|
63a233f3ed | ||
|
|
7a9d01342a | ||
|
|
9b2f02681d | ||
|
|
7a6bad29fe | ||
|
|
bea00448d3 | ||
|
|
deaa3d7a98 | ||
|
|
cbb8ec41e8 | ||
|
|
c6ce332d49 | ||
|
|
8e5f66501a | ||
|
|
639e1c3a93 | ||
|
|
6096a22c3d | ||
|
|
fefc2d44a2 | ||
|
|
d297dd6217 | ||
|
|
974d7ea57a | ||
|
|
ab0cfd2362 | ||
|
|
d22d0a3754 | ||
|
|
5beef0aa01 | ||
|
|
cf28a8c0d5 | ||
|
|
a06682981c | ||
|
|
bc027c921d | ||
|
|
e0bd7088fa | ||
|
|
313e35a98f | ||
|
|
122e6d6863 | ||
|
|
d488e8a2ad | ||
|
|
b9dcbb5152 | ||
|
|
f27fd260f7 | ||
|
|
eedf680a8c | ||
|
|
ac3a15bfaa | ||
|
|
4961697251 | ||
|
|
cac9644b6d | ||
|
|
f96fdd9f24 | ||
|
|
35c540d0e0 | ||
|
|
7603909c59 | ||
|
|
34b186125a | ||
|
|
ea95f37d73 | ||
|
|
0c7d03a476 | ||
|
|
321a87f734 | ||
|
|
9930bd33b1 | ||
|
|
713539e491 | ||
|
|
327e87f735 | ||
|
|
b5426da2a7 | ||
|
|
302ab1da4f | ||
|
|
9cd2bd14ce | ||
|
|
53ee184bc5 | ||
|
|
e00d75bbb5 | ||
|
|
33f76b4895 | ||
|
|
c6b79e11d5 | ||
|
|
d941c91f24 | ||
|
|
054ad78d7b | ||
|
|
05b3fa56cb | ||
|
|
44d1a08db4 | ||
|
|
6a4644007d | ||
|
|
1c4d5c5271 | ||
|
|
dbb53da31d | ||
|
|
452afacd12 | ||
|
|
3b45a75f75 | ||
|
|
1a0f1c8015 | ||
|
|
b361866679 | ||
|
|
ceb4c4105f | ||
|
|
e9af18cdf1 | ||
|
|
5e6c40ad55 | ||
|
|
d6bd1ee215 | ||
|
|
acaf8a248e | ||
|
|
db9585cea9 | ||
|
|
65e3e8319b | ||
|
|
4ef3f8cad5 | ||
|
|
338bdc44cb | ||
|
|
73c00140df | ||
|
|
68a38c39f7 | ||
|
|
941291561a | ||
|
|
39ccdcf00d | ||
|
|
781224591f | ||
|
|
601fedb9b4 | ||
|
|
6812dfe7a6 | ||
|
|
efe6b1fe23 | ||
|
|
5ea2acd897 | ||
|
|
68a0fe1182 | ||
|
|
7afc2c0670 | ||
|
|
ee4149dc49 | ||
|
|
5ddf8b1aea | ||
|
|
35df06b8e1 | ||
|
|
77e9eba294 | ||
|
|
6eccb74415 | ||
|
|
2c2fca2219 | ||
|
|
640a4c1706 | ||
|
|
81a022dbe8 | ||
|
|
48ff624a85 | ||
|
|
31ed854d4e | ||
|
|
442638dd2c | ||
|
|
8391832c90 | ||
|
|
c8737d1a6c | ||
|
|
28a374485f | ||
|
|
fa92bfbdd8 | ||
|
|
f3e7c639ba | ||
|
|
f718305886 | ||
|
|
f0dc094cd6 | ||
|
|
178dfb0c2a | ||
|
|
76c5bf5781 | ||
|
|
feee1dffde | ||
|
|
f05c357d57 | ||
|
|
fe5c1d0d5e | ||
|
|
3e50fa5b1d | ||
|
|
8ae82321ce | ||
|
|
eb143c44fa | ||
|
|
275fed402e | ||
|
|
38a9c1ed1b | ||
|
|
23f0176c18 | ||
|
|
9465fcda6e | ||
|
|
976c10c4ac | ||
|
|
b92ff3dfbd | ||
|
|
4c4efd614a | ||
|
|
14b6a0c6a3 | ||
|
|
c2763d6447 | ||
|
|
1f0de9b354 | ||
|
|
ed90654bf2 | ||
|
|
302235a357 | ||
|
|
636d0e181c | ||
|
|
963c4d3b91 | ||
|
|
22c495ea7c | ||
|
|
5b0ad5ab71 | ||
|
|
bc8568604a | ||
|
|
878f339fb3 | ||
|
|
51616f1bc4 | ||
|
|
82370a0253 | ||
|
|
3975940cff | ||
|
|
158e07c82b | ||
|
|
9a72adbde1 | ||
|
|
9d3bc55c18 | ||
|
|
df3cf9bb56 | ||
|
|
448a15c1e6 | ||
|
|
b99be88cec | ||
|
|
4a9fc2df3a | ||
|
|
d207e7c6dd | ||
|
|
7e98fa9bd8 | ||
|
|
0d5510d8f7 | ||
|
|
18fecd3cda | ||
|
|
1c3269c0f3 | ||
|
|
ea61331d46 | ||
|
|
8fb2800495 | ||
|
|
8912501604 | ||
|
|
68c4259370 | ||
|
|
7f5c7399fb | ||
|
|
14c50f316e | ||
|
|
ddd300a117 | ||
|
|
7524747e44 | ||
|
|
10d70d911a | ||
|
|
a8c85dd015 | ||
|
|
0203c5c1b5 | ||
|
|
384ed096ff | ||
|
|
f9de9fa29e |
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
exclude_paths:
|
||||||
|
- "plugin-repos/**"
|
||||||
|
- "plugins/**"
|
||||||
|
- "assets/**"
|
||||||
|
- "test/**"
|
||||||
|
- "scripts/debug/**"
|
||||||
@@ -43,39 +43,48 @@ cp ../../.cursor/plugin_templates/*.template .
|
|||||||
2. **Using dev_plugin_setup.sh**:
|
2. **Using dev_plugin_setup.sh**:
|
||||||
```bash
|
```bash
|
||||||
# Link from GitHub
|
# Link from GitHub
|
||||||
./dev_plugin_setup.sh link-github my-plugin
|
./scripts/dev/dev_plugin_setup.sh link-github my-plugin
|
||||||
|
|
||||||
# Link local repo
|
# Link local repo
|
||||||
./dev_plugin_setup.sh link my-plugin /path/to/repo
|
./scripts/dev/dev_plugin_setup.sh link my-plugin /path/to/repo
|
||||||
```
|
```
|
||||||
|
|
||||||
### Running Plugins
|
### Running the Display
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Emulator (development)
|
# Emulator mode (development, no hardware required)
|
||||||
python run.py --emulator
|
python3 run.py --emulator
|
||||||
|
# (equivalent: EMULATOR=true python3 run.py)
|
||||||
|
|
||||||
# Hardware (production)
|
# Hardware (production, requires the rpi-rgb-led-matrix submodule built)
|
||||||
python run.py
|
python3 run.py
|
||||||
|
|
||||||
# As service
|
# As a systemd service
|
||||||
sudo systemctl start ledmatrix
|
sudo systemctl start ledmatrix
|
||||||
|
|
||||||
|
# Dev preview server (renders plugins to a browser without running run.py)
|
||||||
|
python3 scripts/dev_server.py # then open http://localhost:5001
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The `-e`/`--emulator` CLI flag is defined in `run.py:19-20` and
|
||||||
|
sets `os.environ["EMULATOR"] = "true"` before any display imports,
|
||||||
|
which `src/display_manager.py:2` then reads to switch between the
|
||||||
|
hardware and emulator backends.
|
||||||
|
|
||||||
### Managing Plugins
|
### Managing Plugins
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# List plugins
|
# List plugins
|
||||||
./dev_plugin_setup.sh list
|
./scripts/dev/dev_plugin_setup.sh list
|
||||||
|
|
||||||
# Check status
|
# Check status
|
||||||
./dev_plugin_setup.sh status
|
./scripts/dev/dev_plugin_setup.sh status
|
||||||
|
|
||||||
# Update plugin(s)
|
# Update plugin(s)
|
||||||
./dev_plugin_setup.sh update [plugin-name]
|
./scripts/dev/dev_plugin_setup.sh update [plugin-name]
|
||||||
|
|
||||||
# Unlink plugin
|
# Unlink plugin
|
||||||
./dev_plugin_setup.sh unlink <plugin-name>
|
./scripts/dev/dev_plugin_setup.sh unlink <plugin-name>
|
||||||
```
|
```
|
||||||
|
|
||||||
## Using These Files with Cursor
|
## Using These Files with Cursor
|
||||||
@@ -118,9 +127,13 @@ Refer to `plugins_guide.md` for:
|
|||||||
- **Plugin System**: `src/plugin_system/`
|
- **Plugin System**: `src/plugin_system/`
|
||||||
- **Base Plugin**: `src/plugin_system/base_plugin.py`
|
- **Base Plugin**: `src/plugin_system/base_plugin.py`
|
||||||
- **Plugin Manager**: `src/plugin_system/plugin_manager.py`
|
- **Plugin Manager**: `src/plugin_system/plugin_manager.py`
|
||||||
- **Example Plugins**: `plugins/hockey-scoreboard/`, `plugins/football-scoreboard/`
|
- **Example Plugins**: see the
|
||||||
|
[`ledmatrix-plugins`](https://github.com/ChuckBuilds/ledmatrix-plugins)
|
||||||
|
repo for canonical sources (e.g. `plugins/hockey-scoreboard/`,
|
||||||
|
`plugins/football-scoreboard/`). Installed plugins land in
|
||||||
|
`plugin-repos/` (default) or `plugins/` (dev fallback).
|
||||||
- **Architecture Docs**: `docs/PLUGIN_ARCHITECTURE_SPEC.md`
|
- **Architecture Docs**: `docs/PLUGIN_ARCHITECTURE_SPEC.md`
|
||||||
- **Development Setup**: `dev_plugin_setup.sh`
|
- **Development Setup**: `scripts/dev/dev_plugin_setup.sh`
|
||||||
|
|
||||||
## Getting Help
|
## Getting Help
|
||||||
|
|
||||||
|
|||||||
@@ -156,20 +156,34 @@ def _fetch_data(self):
|
|||||||
|
|
||||||
### Adding Image Rendering
|
### Adding Image Rendering
|
||||||
|
|
||||||
|
There is no `draw_image()` helper on `DisplayManager`. To render an
|
||||||
|
image, paste it directly onto the underlying PIL `Image`
|
||||||
|
(`display_manager.image`) and then call `update_display()`:
|
||||||
|
|
||||||
```python
|
```python
|
||||||
def _render_content(self):
|
def _render_content(self):
|
||||||
# Load and render image
|
# Load and paste image onto the display canvas
|
||||||
image = Image.open("assets/logo.png")
|
image = Image.open("assets/logo.png").convert("RGB")
|
||||||
self.display_manager.draw_image(image, x=0, y=0)
|
self.display_manager.image.paste(image, (0, 0))
|
||||||
|
|
||||||
# Draw text overlay
|
# Draw text overlay
|
||||||
self.display_manager.draw_text(
|
self.display_manager.draw_text(
|
||||||
"Text",
|
"Text",
|
||||||
x=10, y=20,
|
x=10, y=20,
|
||||||
color=(255, 255, 255)
|
color=(255, 255, 255)
|
||||||
)
|
)
|
||||||
|
|
||||||
|
self.display_manager.update_display()
|
||||||
```
|
```
|
||||||
|
|
||||||
|
For transparency, paste with a mask:
|
||||||
|
|
||||||
|
```python
|
||||||
|
icon = Image.open("assets/icon.png").convert("RGBA")
|
||||||
|
self.display_manager.image.paste(icon, (5, 5), icon)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
### Adding Live Priority
|
### Adding Live Priority
|
||||||
|
|
||||||
1. Enable in config:
|
1. Enable in config:
|
||||||
|
|||||||
@@ -53,13 +53,13 @@ This method is best for plugins stored in separate Git repositories.
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Link a plugin from GitHub (auto-detects URL)
|
# Link a plugin from GitHub (auto-detects URL)
|
||||||
./dev_plugin_setup.sh link-github <plugin-name>
|
./scripts/dev/dev_plugin_setup.sh link-github <plugin-name>
|
||||||
|
|
||||||
# Example: Link hockey-scoreboard plugin
|
# Example: Link hockey-scoreboard plugin
|
||||||
./dev_plugin_setup.sh link-github hockey-scoreboard
|
./scripts/dev/dev_plugin_setup.sh link-github hockey-scoreboard
|
||||||
|
|
||||||
# With custom URL
|
# With custom URL
|
||||||
./dev_plugin_setup.sh link-github <plugin-name> https://github.com/user/repo.git
|
./scripts/dev/dev_plugin_setup.sh link-github <plugin-name> https://github.com/user/repo.git
|
||||||
```
|
```
|
||||||
|
|
||||||
The script will:
|
The script will:
|
||||||
@@ -71,10 +71,10 @@ The script will:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Link a local plugin repository
|
# Link a local plugin repository
|
||||||
./dev_plugin_setup.sh link <plugin-name> <path-to-repo>
|
./scripts/dev/dev_plugin_setup.sh link <plugin-name> <path-to-repo>
|
||||||
|
|
||||||
# Example: Link a local plugin
|
# Example: Link a local plugin
|
||||||
./dev_plugin_setup.sh link my-plugin ../ledmatrix-my-plugin
|
./scripts/dev/dev_plugin_setup.sh link my-plugin ../ledmatrix-my-plugin
|
||||||
```
|
```
|
||||||
|
|
||||||
### Method 2: Manual Plugin Creation
|
### Method 2: Manual Plugin Creation
|
||||||
@@ -321,7 +321,8 @@ Each plugin has its own section in `config/config.json`:
|
|||||||
|
|
||||||
### Secrets Management
|
### Secrets Management
|
||||||
|
|
||||||
Store sensitive data (API keys, tokens) in `config/config_secrets.json`:
|
Store sensitive data (API keys, tokens) in `config/config_secrets.json`
|
||||||
|
under the same plugin id you use in `config/config.json`:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@@ -331,19 +332,21 @@ Store sensitive data (API keys, tokens) in `config/config_secrets.json`:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Reference secrets in main config:
|
At load time, the config manager deep-merges `config_secrets.json` into
|
||||||
|
the main config (verified at `src/config_manager.py:162-172`). So in
|
||||||
|
your plugin's code:
|
||||||
|
|
||||||
```json
|
```python
|
||||||
{
|
class MyPlugin(BasePlugin):
|
||||||
"my-plugin": {
|
def __init__(self, plugin_id, config, display_manager, cache_manager, plugin_manager):
|
||||||
"enabled": true,
|
super().__init__(plugin_id, config, display_manager, cache_manager, plugin_manager)
|
||||||
"config_secrets": {
|
self.api_key = config.get("api_key") # already merged from secrets
|
||||||
"api_key": "my-plugin.api_key"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
There is no separate `config_secrets` reference field — just put the
|
||||||
|
secret value under the same plugin namespace and read it from the
|
||||||
|
merged config.
|
||||||
|
|
||||||
### Plugin Discovery
|
### Plugin Discovery
|
||||||
|
|
||||||
Plugins are automatically discovered when:
|
Plugins are automatically discovered when:
|
||||||
@@ -355,7 +358,7 @@ Check discovered plugins:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Using dev_plugin_setup.sh
|
# Using dev_plugin_setup.sh
|
||||||
./dev_plugin_setup.sh list
|
./scripts/dev/dev_plugin_setup.sh list
|
||||||
|
|
||||||
# Output shows:
|
# Output shows:
|
||||||
# ✓ plugin-name (symlink)
|
# ✓ plugin-name (symlink)
|
||||||
@@ -368,7 +371,7 @@ Check discovered plugins:
|
|||||||
Check plugin status and git information:
|
Check plugin status and git information:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./dev_plugin_setup.sh status
|
./scripts/dev/dev_plugin_setup.sh status
|
||||||
|
|
||||||
# Output shows:
|
# Output shows:
|
||||||
# ✓ plugin-name
|
# ✓ plugin-name
|
||||||
@@ -391,13 +394,19 @@ cd ledmatrix-my-plugin
|
|||||||
|
|
||||||
# Link to LEDMatrix project
|
# Link to LEDMatrix project
|
||||||
cd /path/to/LEDMatrix
|
cd /path/to/LEDMatrix
|
||||||
./dev_plugin_setup.sh link my-plugin ../ledmatrix-my-plugin
|
./scripts/dev/dev_plugin_setup.sh link my-plugin ../ledmatrix-my-plugin
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. Development Cycle
|
### 2. Development Cycle
|
||||||
|
|
||||||
1. **Edit plugin code** in linked repository
|
1. **Edit plugin code** in linked repository
|
||||||
2. **Test with emulator**: `python run.py --emulator`
|
2. **Test with the dev preview server**:
|
||||||
|
`python3 scripts/dev_server.py` (then open `http://localhost:5001`).
|
||||||
|
Or run the full display in emulator mode with
|
||||||
|
`python3 run.py --emulator` (or equivalently
|
||||||
|
`EMULATOR=true python3 run.py`). The `-e`/`--emulator` CLI flag is
|
||||||
|
defined in `run.py:19-20` and sets the same `EMULATOR` environment
|
||||||
|
variable internally.
|
||||||
3. **Check logs** for errors or warnings
|
3. **Check logs** for errors or warnings
|
||||||
4. **Update configuration** in `config/config.json` if needed
|
4. **Update configuration** in `config/config.json` if needed
|
||||||
5. **Iterate** until plugin works correctly
|
5. **Iterate** until plugin works correctly
|
||||||
@@ -406,30 +415,30 @@ cd /path/to/LEDMatrix
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Deploy to Raspberry Pi
|
# Deploy to Raspberry Pi
|
||||||
rsync -avz plugins/my-plugin/ pi@raspberrypi:/path/to/LEDMatrix/plugins/my-plugin/
|
rsync -avz plugins/my-plugin/ ledpi@your-pi-ip:/path/to/LEDMatrix/plugins/my-plugin/
|
||||||
|
|
||||||
# Or if using git, pull on Pi
|
# Or if using git, pull on Pi
|
||||||
ssh pi@raspberrypi "cd /path/to/LEDMatrix/plugins/my-plugin && git pull"
|
ssh ledpi@your-pi-ip "cd /path/to/LEDMatrix/plugins/my-plugin && git pull"
|
||||||
|
|
||||||
# Restart service
|
# Restart service
|
||||||
ssh pi@raspberrypi "sudo systemctl restart ledmatrix"
|
ssh ledpi@your-pi-ip "sudo systemctl restart ledmatrix"
|
||||||
```
|
```
|
||||||
|
|
||||||
### 4. Updating Plugins
|
### 4. Updating Plugins
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Update single plugin from git
|
# Update single plugin from git
|
||||||
./dev_plugin_setup.sh update my-plugin
|
./scripts/dev/dev_plugin_setup.sh update my-plugin
|
||||||
|
|
||||||
# Update all linked plugins
|
# Update all linked plugins
|
||||||
./dev_plugin_setup.sh update
|
./scripts/dev/dev_plugin_setup.sh update
|
||||||
```
|
```
|
||||||
|
|
||||||
### 5. Unlinking Plugins
|
### 5. Unlinking Plugins
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Remove symlink (preserves repository)
|
# Remove symlink (preserves repository)
|
||||||
./dev_plugin_setup.sh unlink my-plugin
|
./scripts/dev/dev_plugin_setup.sh unlink my-plugin
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -625,8 +634,8 @@ python run.py --emulator
|
|||||||
**Solutions**:
|
**Solutions**:
|
||||||
1. Check symlink: `ls -la plugins/my-plugin`
|
1. Check symlink: `ls -la plugins/my-plugin`
|
||||||
2. Verify target exists: `readlink -f plugins/my-plugin`
|
2. Verify target exists: `readlink -f plugins/my-plugin`
|
||||||
3. Update plugin: `./dev_plugin_setup.sh update my-plugin`
|
3. Update plugin: `./scripts/dev/dev_plugin_setup.sh update my-plugin`
|
||||||
4. Re-link plugin if needed: `./dev_plugin_setup.sh unlink my-plugin && ./dev_plugin_setup.sh link my-plugin <path>`
|
4. Re-link plugin if needed: `./scripts/dev/dev_plugin_setup.sh unlink my-plugin && ./scripts/dev/dev_plugin_setup.sh link my-plugin <path>`
|
||||||
5. Check git status: `cd plugins/my-plugin && git status`
|
5. Check git status: `cd plugins/my-plugin && git status`
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -697,22 +706,22 @@ python run.py --emulator
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Link plugin from GitHub
|
# Link plugin from GitHub
|
||||||
./dev_plugin_setup.sh link-github <name>
|
./scripts/dev/dev_plugin_setup.sh link-github <name>
|
||||||
|
|
||||||
# Link local plugin
|
# Link local plugin
|
||||||
./dev_plugin_setup.sh link <name> <path>
|
./scripts/dev/dev_plugin_setup.sh link <name> <path>
|
||||||
|
|
||||||
# List all plugins
|
# List all plugins
|
||||||
./dev_plugin_setup.sh list
|
./scripts/dev/dev_plugin_setup.sh list
|
||||||
|
|
||||||
# Check plugin status
|
# Check plugin status
|
||||||
./dev_plugin_setup.sh status
|
./scripts/dev/dev_plugin_setup.sh status
|
||||||
|
|
||||||
# Update plugin(s)
|
# Update plugin(s)
|
||||||
./dev_plugin_setup.sh update [name]
|
./scripts/dev/dev_plugin_setup.sh update [name]
|
||||||
|
|
||||||
# Unlink plugin
|
# Unlink plugin
|
||||||
./dev_plugin_setup.sh unlink <name>
|
./scripts/dev/dev_plugin_setup.sh unlink <name>
|
||||||
|
|
||||||
# Run with emulator
|
# Run with emulator
|
||||||
python run.py --emulator
|
python run.py --emulator
|
||||||
|
|||||||
@@ -2,7 +2,31 @@
|
|||||||
|
|
||||||
## Plugin System Overview
|
## Plugin System Overview
|
||||||
|
|
||||||
The LEDMatrix project uses a plugin-based architecture. All display functionality (except core calendar) is implemented as plugins that are dynamically loaded from the `plugins/` directory.
|
The LEDMatrix project uses a plugin-based architecture. All display
|
||||||
|
functionality (except core calendar) is implemented as plugins that are
|
||||||
|
dynamically loaded from the directory configured by
|
||||||
|
`plugin_system.plugins_directory` in `config.json` — the default is
|
||||||
|
`plugin-repos/` (per `config/config.template.json:130`).
|
||||||
|
|
||||||
|
> **Fallback note (scoped):** `PluginManager.discover_plugins()`
|
||||||
|
> (`src/plugin_system/plugin_manager.py:154`) only scans the
|
||||||
|
> configured directory — there is no fallback to `plugins/` in the
|
||||||
|
> main discovery path. A fallback to `plugins/` does exist in two
|
||||||
|
> narrower places:
|
||||||
|
> - `store_manager.py:1700-1718` — store operations (install/update/
|
||||||
|
> uninstall) check `plugins/` if the plugin isn't found in the
|
||||||
|
> configured directory, so plugin-store flows work even when your
|
||||||
|
> dev symlinks live in `plugins/`.
|
||||||
|
> - `schema_manager.py:70-80` — `get_schema_path()` probes both
|
||||||
|
> `plugins/` and `plugin-repos/` for `config_schema.json` so the
|
||||||
|
> web UI form generation finds the schema regardless of where the
|
||||||
|
> plugin lives.
|
||||||
|
>
|
||||||
|
> The dev workflow in `scripts/dev/dev_plugin_setup.sh` creates
|
||||||
|
> symlinks under `plugins/`, which is why the store and schema
|
||||||
|
> fallbacks exist. For day-to-day development, set
|
||||||
|
> `plugin_system.plugins_directory` to `plugins` so the main
|
||||||
|
> discovery path picks up your symlinks.
|
||||||
|
|
||||||
## Plugin Structure
|
## Plugin Structure
|
||||||
|
|
||||||
@@ -27,14 +51,15 @@ The LEDMatrix project uses a plugin-based architecture. All display functionalit
|
|||||||
**Option A: Use dev_plugin_setup.sh (Recommended)**
|
**Option A: Use dev_plugin_setup.sh (Recommended)**
|
||||||
```bash
|
```bash
|
||||||
# Link from GitHub
|
# Link from GitHub
|
||||||
./dev_plugin_setup.sh link-github <plugin-name>
|
./scripts/dev/dev_plugin_setup.sh link-github <plugin-name>
|
||||||
|
|
||||||
# Link local repository
|
# Link local repository
|
||||||
./dev_plugin_setup.sh link <plugin-name> <path-to-repo>
|
./scripts/dev/dev_plugin_setup.sh link <plugin-name> <path-to-repo>
|
||||||
```
|
```
|
||||||
|
|
||||||
**Option B: Manual Setup**
|
**Option B: Manual Setup**
|
||||||
1. Create directory in `plugins/<plugin-id>/`
|
1. Create directory in `plugin-repos/<plugin-id>/` (or `plugins/<plugin-id>/`
|
||||||
|
if you're using the dev fallback location)
|
||||||
2. Add `manifest.json` with required fields
|
2. Add `manifest.json` with required fields
|
||||||
3. Create `manager.py` with plugin class
|
3. Create `manager.py` with plugin class
|
||||||
4. Add `config_schema.json` for configuration
|
4. Add `config_schema.json` for configuration
|
||||||
@@ -63,7 +88,13 @@ Plugins are configured in `config/config.json`:
|
|||||||
### 3. Testing Plugins
|
### 3. Testing Plugins
|
||||||
|
|
||||||
**On Development Machine:**
|
**On Development Machine:**
|
||||||
- Use emulator: `python run.py --emulator` or `./run_emulator.sh`
|
- Run the dev preview server: `python3 scripts/dev_server.py` (then
|
||||||
|
open `http://localhost:5001`) — renders plugins in the browser
|
||||||
|
without running the full display loop
|
||||||
|
- Or run the full display in emulator mode:
|
||||||
|
`python3 run.py --emulator` (or equivalently
|
||||||
|
`EMULATOR=true python3 run.py`, or `./scripts/dev/run_emulator.sh`).
|
||||||
|
The `-e`/`--emulator` CLI flag is defined in `run.py:19-20`.
|
||||||
- Test plugin loading: Check logs for plugin discovery and loading
|
- Test plugin loading: Check logs for plugin discovery and loading
|
||||||
- Validate configuration: Ensure config matches `config_schema.json`
|
- Validate configuration: Ensure config matches `config_schema.json`
|
||||||
|
|
||||||
@@ -75,15 +106,22 @@ Plugins are configured in `config/config.json`:
|
|||||||
### 4. Plugin Development Best Practices
|
### 4. Plugin Development Best Practices
|
||||||
|
|
||||||
**Code Organization:**
|
**Code Organization:**
|
||||||
- Keep plugin code in `plugins/<plugin-id>/`
|
- Keep plugin code in `plugin-repos/<plugin-id>/` (or its dev-time
|
||||||
|
symlink in `plugins/<plugin-id>/`)
|
||||||
- Use shared assets from `assets/` directory when possible
|
- Use shared assets from `assets/` directory when possible
|
||||||
- Follow existing plugin patterns (see `plugins/hockey-scoreboard/` as reference)
|
- Follow existing plugin patterns — canonical sources live in the
|
||||||
|
[`ledmatrix-plugins`](https://github.com/ChuckBuilds/ledmatrix-plugins)
|
||||||
|
repo (`plugins/hockey-scoreboard/`, `plugins/football-scoreboard/`,
|
||||||
|
`plugins/clock-simple/`, etc.)
|
||||||
- Place shared utilities in `src/common/` if reusable across plugins
|
- Place shared utilities in `src/common/` if reusable across plugins
|
||||||
|
|
||||||
**Configuration Management:**
|
**Configuration Management:**
|
||||||
- Use `config_schema.json` for validation
|
- Use `config_schema.json` for validation
|
||||||
- Store secrets in `config/config_secrets.json` (not in main config)
|
- Store secrets in `config/config_secrets.json` under the same plugin
|
||||||
- Reference secrets via `config_secrets` key in main config
|
id namespace as the main config — they're deep-merged into the main
|
||||||
|
config at load time (`src/config_manager.py:162-172`), so plugin
|
||||||
|
code reads them directly from `config.get(...)` like any other key
|
||||||
|
- There is no separate `config_secrets` reference field
|
||||||
- Validate all required fields in `validate_config()`
|
- Validate all required fields in `validate_config()`
|
||||||
|
|
||||||
**Error Handling:**
|
**Error Handling:**
|
||||||
@@ -138,18 +176,32 @@ Located in: `src/display_manager.py`
|
|||||||
|
|
||||||
**Key Methods:**
|
**Key Methods:**
|
||||||
- `clear()`: Clear the display
|
- `clear()`: Clear the display
|
||||||
- `draw_text(text, x, y, color, font)`: Draw text
|
- `draw_text(text, x, y, color, font, small_font, centered)`: Draw text
|
||||||
- `draw_image(image, x, y)`: Draw PIL Image
|
- `update_display()`: Push the buffer to the physical display
|
||||||
- `update_display()`: Update physical display
|
- `draw_weather_icon(condition, x, y, size)`: Draw a weather icon
|
||||||
- `width`, `height`: Display dimensions
|
- `width`, `height`: Display dimensions
|
||||||
|
|
||||||
|
**Image rendering**: there is no `draw_image()` helper. Paste directly
|
||||||
|
onto the underlying PIL Image:
|
||||||
|
```python
|
||||||
|
self.display_manager.image.paste(pil_image, (x, y))
|
||||||
|
self.display_manager.update_display()
|
||||||
|
```
|
||||||
|
For transparency, paste with a mask: `image.paste(rgba, (x, y), rgba)`.
|
||||||
|
|
||||||
### Cache Manager
|
### Cache Manager
|
||||||
Located in: `src/cache_manager.py`
|
Located in: `src/cache_manager.py`
|
||||||
|
|
||||||
**Key Methods:**
|
**Key Methods:**
|
||||||
- `get(key, max_age=None)`: Get cached value
|
- `get(key, max_age=300)`: Get cached value (returns None if missing/stale)
|
||||||
- `set(key, value, ttl=None)`: Cache a value
|
- `set(key, value, ttl=None)`: Cache a value
|
||||||
- `delete(key)`: Remove cached value
|
- `delete(key)` / `clear_cache(key=None)`: Remove a single cache entry,
|
||||||
|
or (for `clear_cache` with no argument) every cached entry. `delete`
|
||||||
|
is an alias for `clear_cache(key)`.
|
||||||
|
- `get_cached_data_with_strategy(key, data_type)`: Cache get with
|
||||||
|
data-type-aware TTL strategy
|
||||||
|
- `get_background_cached_data(key, sport_key)`: Cache get for the
|
||||||
|
background-fetch service path
|
||||||
|
|
||||||
## Plugin Manifest Schema
|
## Plugin Manifest Schema
|
||||||
|
|
||||||
|
|||||||
@@ -1,38 +1,84 @@
|
|||||||
---
|
---
|
||||||
name: Bug report
|
name: Bug report
|
||||||
about: Create a report to help us improve
|
about: Report a problem with LEDMatrix
|
||||||
title: ''
|
title: ''
|
||||||
labels: ''
|
labels: bug
|
||||||
assignees: ''
|
assignees: ''
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Describe the bug**
|
<!--
|
||||||
A clear and concise description of what the bug is.
|
Before filing: please check existing issues to see if this is already
|
||||||
|
reported. For security issues, see SECURITY.md and report privately.
|
||||||
|
-->
|
||||||
|
|
||||||
**To Reproduce**
|
## Describe the bug
|
||||||
Steps to reproduce the behavior:
|
|
||||||
1. Go to '...'
|
|
||||||
2. Click on '....'
|
|
||||||
3. Scroll down to '....'
|
|
||||||
4. See error
|
|
||||||
|
|
||||||
**Expected behavior**
|
<!-- A clear and concise description of what the bug is. -->
|
||||||
A clear and concise description of what you expected to happen.
|
|
||||||
|
|
||||||
**Screenshots**
|
## Steps to reproduce
|
||||||
If applicable, add screenshots to help explain your problem.
|
|
||||||
|
|
||||||
**Desktop (please complete the following information):**
|
1.
|
||||||
- OS: [e.g. iOS]
|
2.
|
||||||
- Browser [e.g. chrome, safari]
|
3.
|
||||||
- Version [e.g. 22]
|
|
||||||
|
|
||||||
**Smartphone (please complete the following information):**
|
## Expected behavior
|
||||||
- Device: [e.g. iPhone6]
|
|
||||||
- OS: [e.g. iOS8.1]
|
|
||||||
- Browser [e.g. stock browser, safari]
|
|
||||||
- Version [e.g. 22]
|
|
||||||
|
|
||||||
**Additional context**
|
<!-- What you expected to happen. -->
|
||||||
Add any other context about the problem here.
|
|
||||||
|
## Actual behavior
|
||||||
|
|
||||||
|
<!-- What actually happened. Include any error messages. -->
|
||||||
|
|
||||||
|
## Hardware
|
||||||
|
|
||||||
|
- **Raspberry Pi model**: <!-- e.g. Pi 3B+, Pi 4 8GB, Pi Zero 2W -->
|
||||||
|
- **OS / kernel**: <!-- output of `cat /etc/os-release` and `uname -a` -->
|
||||||
|
- **LED matrix panels**: <!-- e.g. 2x Adafruit 64x32, 1x Waveshare 96x48 -->
|
||||||
|
- **HAT / Bonnet**: <!-- e.g. Adafruit RGB Matrix Bonnet, Electrodragon HAT -->
|
||||||
|
- **PWM jumper mod soldered?**: <!-- yes / no -->
|
||||||
|
- **Display chain**: <!-- chain_length × parallel, e.g. "2x1" -->
|
||||||
|
|
||||||
|
## LEDMatrix version
|
||||||
|
|
||||||
|
<!-- Run `git rev-parse HEAD` in the LEDMatrix directory, or paste the
|
||||||
|
release tag if you installed from a release. -->
|
||||||
|
|
||||||
|
```
|
||||||
|
git commit:
|
||||||
|
```
|
||||||
|
|
||||||
|
## Plugin involved (if any)
|
||||||
|
|
||||||
|
- **Plugin id**:
|
||||||
|
- **Plugin version** (from `manifest.json`):
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
<!-- Paste the relevant section from config/config.json. Redact any
|
||||||
|
API keys before pasting. For display issues, the `display.hardware`
|
||||||
|
block is most relevant. For plugin issues, paste that plugin's section. -->
|
||||||
|
|
||||||
|
```json
|
||||||
|
```
|
||||||
|
|
||||||
|
## Logs
|
||||||
|
|
||||||
|
<!-- The first 50 lines of the relevant log are usually enough. Run:
|
||||||
|
sudo journalctl -u ledmatrix -n 100 --no-pager
|
||||||
|
or for the web service:
|
||||||
|
sudo journalctl -u ledmatrix-web -n 100 --no-pager
|
||||||
|
-->
|
||||||
|
|
||||||
|
```
|
||||||
|
```
|
||||||
|
|
||||||
|
## Screenshots / video (optional)
|
||||||
|
|
||||||
|
<!-- A photo of the actual display, or a screenshot of the web UI,
|
||||||
|
helps a lot for visual issues. -->
|
||||||
|
|
||||||
|
## Additional context
|
||||||
|
|
||||||
|
<!-- Anything else that might be relevant: when did this start happening,
|
||||||
|
what's different about your setup, what have you already tried, etc. -->
|
||||||
|
|||||||
@@ -0,0 +1,62 @@
|
|||||||
|
# Pull Request
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
<!-- 1-3 sentences describing what this PR does and why. -->
|
||||||
|
|
||||||
|
## Type of change
|
||||||
|
|
||||||
|
<!-- Check all that apply. -->
|
||||||
|
|
||||||
|
- [ ] Bug fix
|
||||||
|
- [ ] New feature
|
||||||
|
- [ ] Documentation
|
||||||
|
- [ ] Refactor (no functional change)
|
||||||
|
- [ ] Build / CI
|
||||||
|
- [ ] Plugin work (link to the plugin)
|
||||||
|
|
||||||
|
## Related issues
|
||||||
|
|
||||||
|
<!-- "Fixes #123" or "Refs #123". Use "Fixes" for bug PRs so the issue
|
||||||
|
auto-closes when this merges. -->
|
||||||
|
|
||||||
|
## Test plan
|
||||||
|
|
||||||
|
<!-- How did you test this? Check all that apply. Add details for any
|
||||||
|
checked box. -->
|
||||||
|
|
||||||
|
- [ ] Ran on a real Raspberry Pi with hardware
|
||||||
|
- [ ] Ran in emulator mode (`EMULATOR=true python3 run.py`)
|
||||||
|
- [ ] Ran the dev preview server (`scripts/dev_server.py`)
|
||||||
|
- [ ] Ran the test suite (`pytest`)
|
||||||
|
- [ ] Manually verified the affected code path in the web UI
|
||||||
|
- [ ] N/A — documentation-only change
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
- [ ] I updated `README.md` if user-facing behavior changed
|
||||||
|
- [ ] I updated the relevant doc in `docs/` if developer behavior changed
|
||||||
|
- [ ] I added/updated docstrings on new public functions
|
||||||
|
- [ ] N/A — no docs needed
|
||||||
|
|
||||||
|
## Plugin compatibility
|
||||||
|
|
||||||
|
<!-- For changes to BasePlugin, the plugin loader, the web UI, or the
|
||||||
|
config schema. -->
|
||||||
|
|
||||||
|
- [ ] No plugin breakage expected
|
||||||
|
- [ ] Some plugins will need updates — listed below
|
||||||
|
- [ ] N/A — change doesn't touch the plugin system
|
||||||
|
|
||||||
|
## Checklist
|
||||||
|
|
||||||
|
- [ ] My commits follow the message convention in `CONTRIBUTING.md`
|
||||||
|
- [ ] I read `CONTRIBUTING.md` and `CODE_OF_CONDUCT.md`
|
||||||
|
- [ ] I've not committed any secrets or hardcoded API keys
|
||||||
|
- [ ] If this adds a new config key, the form in the web UI was
|
||||||
|
verified (the form is generated from `config_schema.json`)
|
||||||
|
|
||||||
|
## Notes for reviewer
|
||||||
|
|
||||||
|
<!-- Anything reviewers should know — gotchas, things you weren't
|
||||||
|
sure about, decisions you'd like a second opinion on. -->
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
name: Claude Code Review
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
types: [opened, synchronize, ready_for_review, reopened]
|
||||||
|
# Optional: Only run on specific file changes
|
||||||
|
# paths:
|
||||||
|
# - "src/**/*.ts"
|
||||||
|
# - "src/**/*.tsx"
|
||||||
|
# - "src/**/*.js"
|
||||||
|
# - "src/**/*.jsx"
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
claude-review:
|
||||||
|
# Optional: Filter by PR author
|
||||||
|
# if: |
|
||||||
|
# github.event.pull_request.user.login == 'external-contributor' ||
|
||||||
|
# github.event.pull_request.user.login == 'new-developer' ||
|
||||||
|
# github.event.pull_request.author_association == 'FIRST_TIME_CONTRIBUTOR'
|
||||||
|
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
pull-requests: read
|
||||||
|
issues: read
|
||||||
|
id-token: write
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout repository
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 1
|
||||||
|
|
||||||
|
- name: Run Claude Code Review
|
||||||
|
id: claude-review
|
||||||
|
uses: anthropics/claude-code-action@v1
|
||||||
|
with:
|
||||||
|
claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
|
||||||
|
plugin_marketplaces: 'https://github.com/anthropics/claude-code.git'
|
||||||
|
plugins: 'code-review@claude-code-plugins'
|
||||||
|
prompt: '/code-review:code-review ${{ github.repository }}/pull/${{ github.event.pull_request.number }}'
|
||||||
|
# See https://github.com/anthropics/claude-code-action/blob/main/docs/usage.md
|
||||||
|
# or https://code.claude.com/docs/en/cli-reference for available options
|
||||||
|
|
||||||
@@ -0,0 +1,50 @@
|
|||||||
|
name: Claude Code
|
||||||
|
|
||||||
|
on:
|
||||||
|
issue_comment:
|
||||||
|
types: [created]
|
||||||
|
pull_request_review_comment:
|
||||||
|
types: [created]
|
||||||
|
issues:
|
||||||
|
types: [opened, assigned]
|
||||||
|
pull_request_review:
|
||||||
|
types: [submitted]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
claude:
|
||||||
|
if: |
|
||||||
|
(github.event_name == 'issue_comment' && contains(github.event.comment.body, '@claude')) ||
|
||||||
|
(github.event_name == 'pull_request_review_comment' && contains(github.event.comment.body, '@claude')) ||
|
||||||
|
(github.event_name == 'pull_request_review' && contains(github.event.review.body, '@claude')) ||
|
||||||
|
(github.event_name == 'issues' && (contains(github.event.issue.body, '@claude') || contains(github.event.issue.title, '@claude')))
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
pull-requests: read
|
||||||
|
issues: read
|
||||||
|
id-token: write
|
||||||
|
actions: read # Required for Claude to read CI results on PRs
|
||||||
|
steps:
|
||||||
|
- name: Checkout repository
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 1
|
||||||
|
|
||||||
|
- name: Run Claude Code
|
||||||
|
id: claude
|
||||||
|
uses: anthropics/claude-code-action@v1
|
||||||
|
with:
|
||||||
|
claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
|
||||||
|
|
||||||
|
# This is an optional setting that allows Claude to read CI results on PRs
|
||||||
|
additional_permissions: |
|
||||||
|
actions: read
|
||||||
|
|
||||||
|
# Optional: Give a custom prompt to Claude. If this is not specified, Claude will perform the instructions specified in the comment that tagged it.
|
||||||
|
# prompt: 'Update the pull request description to include a summary of changes.'
|
||||||
|
|
||||||
|
# Optional: Add claude_args to customize behavior and configuration
|
||||||
|
# See https://github.com/anthropics/claude-code-action/blob/main/docs/usage.md
|
||||||
|
# or https://code.claude.com/docs/en/cli-reference for available options
|
||||||
|
# claude_args: '--allowed-tools Bash(gh pr *)'
|
||||||
|
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
name: Tests
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
push:
|
||||||
|
branches: [main]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
plugin-safety:
|
||||||
|
name: Plugin safety harness + unit tests
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
|
with:
|
||||||
|
persist-credentials: false
|
||||||
|
|
||||||
|
- uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
|
||||||
|
with:
|
||||||
|
python-version: "3.12"
|
||||||
|
cache: pip
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: |
|
||||||
|
python -m pip install --upgrade pip
|
||||||
|
pip install -r requirements.txt -r requirements-test.txt
|
||||||
|
pip install RGBMatrixEmulator
|
||||||
|
|
||||||
|
- name: Run harness + visual rendering tests
|
||||||
|
run: |
|
||||||
|
pytest --no-cov \
|
||||||
|
test/plugins/test_harness.py \
|
||||||
|
test/plugins/test_visual_rendering.py \
|
||||||
|
test/plugins/test_plugin_matrix.py
|
||||||
@@ -8,6 +8,7 @@ config/config_secrets.json
|
|||||||
config/config.json
|
config/config.json
|
||||||
config/config.json.backup
|
config/config.json.backup
|
||||||
config/wifi_config.json
|
config/wifi_config.json
|
||||||
|
config/uninstalled_plugins.json
|
||||||
credentials.json
|
credentials.json
|
||||||
token.pickle
|
token.pickle
|
||||||
|
|
||||||
@@ -40,3 +41,10 @@ htmlcov/
|
|||||||
# See docs/MULTI_ROOT_WORKSPACE_SETUP.md for details
|
# See docs/MULTI_ROOT_WORKSPACE_SETUP.md for details
|
||||||
plugins/*
|
plugins/*
|
||||||
!plugins/.gitkeep
|
!plugins/.gitkeep
|
||||||
|
|
||||||
|
# Binary files and backups
|
||||||
|
bin/pixlet/
|
||||||
|
config/backups/
|
||||||
|
|
||||||
|
# Starlark apps runtime storage (installed .star files and cached renders)
|
||||||
|
/starlark-apps/
|
||||||
|
|||||||
@@ -1,66 +1,4 @@
|
|||||||
[submodule "plugins/odds-ticker"]
|
|
||||||
path = plugins/odds-ticker
|
|
||||||
url = https://github.com/ChuckBuilds/ledmatrix-odds-ticker.git
|
|
||||||
[submodule "plugins/clock-simple"]
|
|
||||||
path = plugins/clock-simple
|
|
||||||
url = https://github.com/ChuckBuilds/ledmatrix-clock-simple.git
|
|
||||||
[submodule "plugins/text-display"]
|
|
||||||
path = plugins/text-display
|
|
||||||
url = https://github.com/ChuckBuilds/ledmatrix-text-display.git
|
|
||||||
[submodule "rpi-rgb-led-matrix-master"]
|
[submodule "rpi-rgb-led-matrix-master"]
|
||||||
path = rpi-rgb-led-matrix-master
|
path = rpi-rgb-led-matrix-master
|
||||||
url = https://github.com/hzeller/rpi-rgb-led-matrix.git
|
url = https://github.com/hzeller/rpi-rgb-led-matrix.git
|
||||||
[submodule "plugins/basketball-scoreboard"]
|
branch = master
|
||||||
path = plugins/basketball-scoreboard
|
|
||||||
url = https://github.com/ChuckBuilds/ledmatrix-basketball-scoreboard.git
|
|
||||||
[submodule "plugins/soccer-scoreboard"]
|
|
||||||
path = plugins/soccer-scoreboard
|
|
||||||
url = https://github.com/ChuckBuilds/ledmatrix-soccer-scoreboard.git
|
|
||||||
[submodule "plugins/calendar"]
|
|
||||||
path = plugins/calendar
|
|
||||||
url = https://github.com/ChuckBuilds/ledmatrix-calendar.git
|
|
||||||
[submodule "plugins/mqtt-notifications"]
|
|
||||||
path = plugins/mqtt-notifications
|
|
||||||
url = https://github.com/ChuckBuilds/ledmatrix-mqtt-notifications.git
|
|
||||||
[submodule "plugins/olympics-countdown"]
|
|
||||||
path = plugins/olympics-countdown
|
|
||||||
url = https://github.com/ChuckBuilds/ledmatrix-olympics-countdown.git
|
|
||||||
[submodule "plugins/ledmatrix-stocks"]
|
|
||||||
path = plugins/ledmatrix-stocks
|
|
||||||
url = https://github.com/ChuckBuilds/ledmatrix-stocks.git
|
|
||||||
[submodule "plugins/ledmatrix-music"]
|
|
||||||
path = plugins/ledmatrix-music
|
|
||||||
url = https://github.com/ChuckBuilds/ledmatrix-music.git
|
|
||||||
[submodule "plugins/static-image"]
|
|
||||||
path = plugins/static-image
|
|
||||||
url = https://github.com/ChuckBuilds/ledmatrix-static-image.git
|
|
||||||
[submodule "plugins/football-scoreboard"]
|
|
||||||
path = plugins/football-scoreboard
|
|
||||||
url = https://github.com/ChuckBuilds/ledmatrix-football-scoreboard.git
|
|
||||||
[submodule "plugins/hockey-scoreboard"]
|
|
||||||
path = plugins/hockey-scoreboard
|
|
||||||
url = https://github.com/ChuckBuilds/ledmatrix-hockey-scoreboard.git
|
|
||||||
[submodule "plugins/baseball-scoreboard"]
|
|
||||||
path = plugins/baseball-scoreboard
|
|
||||||
url = https://github.com/ChuckBuilds/ledmatrix-baseball-scoreboard.git
|
|
||||||
[submodule "plugins/christmas-countdown"]
|
|
||||||
path = plugins/christmas-countdown
|
|
||||||
url = https://github.com/ChuckBuilds/ledmatrix-christmas-countdown.git
|
|
||||||
[submodule "plugins/ledmatrix-flights"]
|
|
||||||
path = plugins/ledmatrix-flights
|
|
||||||
url = https://github.com/ChuckBuilds/ledmatrix-flights.git
|
|
||||||
[submodule "plugins/ledmatrix-leaderboard"]
|
|
||||||
path = plugins/ledmatrix-leaderboard
|
|
||||||
url = https://github.com/ChuckBuilds/ledmatrix-leaderboard.git
|
|
||||||
[submodule "plugins/ledmatrix-weather"]
|
|
||||||
path = plugins/ledmatrix-weather
|
|
||||||
url = https://github.com/ChuckBuilds/ledmatrix-weather.git
|
|
||||||
[submodule "plugins/ledmatrix-news"]
|
|
||||||
path = plugins/ledmatrix-news
|
|
||||||
url = https://github.com/ChuckBuilds/ledmatrix-news.git
|
|
||||||
[submodule "plugins/ledmatrix-of-the-day"]
|
|
||||||
path = plugins/ledmatrix-of-the-day
|
|
||||||
url = https://github.com/ChuckBuilds/ledmatrix-of-the-day.git
|
|
||||||
[submodule "plugins/youtube-stats"]
|
|
||||||
path = plugins/youtube-stats
|
|
||||||
url = https://github.com/ChuckBuilds/ledmatrix-youtube-stats.git
|
|
||||||
|
|||||||
@@ -0,0 +1,64 @@
|
|||||||
|
# Pre-commit hooks for LEDMatrix
|
||||||
|
# Install: pip install pre-commit && pre-commit install
|
||||||
|
# Run manually: pre-commit run --all-files
|
||||||
|
|
||||||
|
repos:
|
||||||
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||||
|
rev: v4.5.0
|
||||||
|
hooks:
|
||||||
|
- id: trailing-whitespace
|
||||||
|
- id: end-of-file-fixer
|
||||||
|
- id: check-yaml
|
||||||
|
- id: check-json
|
||||||
|
- id: check-added-large-files
|
||||||
|
args: ['--maxkb=1000']
|
||||||
|
- id: check-merge-conflict
|
||||||
|
|
||||||
|
- repo: https://github.com/PyCQA/flake8
|
||||||
|
rev: 7.0.0
|
||||||
|
hooks:
|
||||||
|
- id: flake8
|
||||||
|
args: ['--select=E9,F63,F7,F82,B', '--ignore=E501']
|
||||||
|
additional_dependencies: [flake8-bugbear]
|
||||||
|
|
||||||
|
- repo: local
|
||||||
|
hooks:
|
||||||
|
- id: no-bare-except
|
||||||
|
name: Check for bare except clauses
|
||||||
|
entry: bash -c 'if grep -rn "except:\s*pass" src/; then echo "Found bare except:pass - please handle exceptions properly"; exit 1; fi'
|
||||||
|
language: system
|
||||||
|
types: [python]
|
||||||
|
pass_filenames: false
|
||||||
|
|
||||||
|
- id: no-hardcoded-paths
|
||||||
|
name: Check for hardcoded user paths
|
||||||
|
entry: bash -c 'if grep -rn "/home/chuck/" src/; then echo "Found hardcoded user paths - please use relative paths or config"; exit 1; fi'
|
||||||
|
language: system
|
||||||
|
types: [python]
|
||||||
|
pass_filenames: false
|
||||||
|
|
||||||
|
- repo: https://github.com/pre-commit/mirrors-mypy
|
||||||
|
rev: v1.8.0
|
||||||
|
hooks:
|
||||||
|
- id: mypy
|
||||||
|
additional_dependencies: [types-requests, types-pytz]
|
||||||
|
args: [--ignore-missing-imports, --no-error-summary]
|
||||||
|
pass_filenames: false
|
||||||
|
files: ^src/
|
||||||
|
|
||||||
|
- repo: https://github.com/PyCQA/bandit
|
||||||
|
rev: 1.8.3
|
||||||
|
hooks:
|
||||||
|
- id: bandit
|
||||||
|
args:
|
||||||
|
- '-r'
|
||||||
|
- '-ll'
|
||||||
|
- '-c'
|
||||||
|
- 'bandit.yaml'
|
||||||
|
- '-x'
|
||||||
|
- './tests,./test,./venv,./.venv,./scripts/prove_security.py,./rpi-rgb-led-matrix-master'
|
||||||
|
|
||||||
|
- repo: https://github.com/gitleaks/gitleaks
|
||||||
|
rev: v8.24.3
|
||||||
|
hooks:
|
||||||
|
- id: gitleaks
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
# LEDMatrix
|
||||||
|
|
||||||
|
## Project Structure
|
||||||
|
- `src/plugin_system/` — Plugin loader, manager, store manager, base plugin class
|
||||||
|
- `web_interface/` — Flask web UI (blueprints, templates, static JS)
|
||||||
|
- `config/config.json` — User plugin configuration (persists across plugin reinstalls)
|
||||||
|
- `plugin-repos/` — **Default** plugin install directory used by the
|
||||||
|
Plugin Store, set by `plugin_system.plugins_directory` in
|
||||||
|
`config.json` (default per `config/config.template.json:130`).
|
||||||
|
Not gitignored.
|
||||||
|
- `plugins/` — Legacy/dev plugin location. Gitignored (`plugins/*`).
|
||||||
|
Used by `scripts/dev/dev_plugin_setup.sh` for symlinks. The plugin
|
||||||
|
loader falls back to it when something isn't found in `plugin-repos/`
|
||||||
|
(`src/plugin_system/schema_manager.py:77`).
|
||||||
|
|
||||||
|
## Plugin System
|
||||||
|
- Plugins inherit from `BasePlugin` in `src/plugin_system/base_plugin.py`
|
||||||
|
- Required abstract methods: `update()`, `display(force_clear=False)`
|
||||||
|
- Each plugin needs: `manifest.json`, `config_schema.json`, `manager.py`, `requirements.txt`
|
||||||
|
- Plugin instantiation args: `plugin_id, config, display_manager, cache_manager, plugin_manager`
|
||||||
|
- Config schemas use JSON Schema Draft-7
|
||||||
|
- Display dimensions: always read dynamically from `self.display_manager.matrix.width/height`
|
||||||
|
|
||||||
|
## Plugin Store Architecture
|
||||||
|
- Official plugins live in the `ledmatrix-plugins` monorepo (not individual repos)
|
||||||
|
- Plugin repo naming convention: `ledmatrix-<plugin-id>` (e.g., `ledmatrix-football-scoreboard`)
|
||||||
|
- `plugins.json` registry at `https://raw.githubusercontent.com/ChuckBuilds/ledmatrix-plugins/main/plugins.json`
|
||||||
|
- Store manager (`src/plugin_system/store_manager.py`) handles install/update/uninstall
|
||||||
|
- Monorepo plugins are installed via ZIP extraction (no `.git` directory)
|
||||||
|
- Update detection for monorepo plugins uses version comparison (manifest version vs registry latest_version)
|
||||||
|
- Plugin configs stored in `config/config.json`, NOT in plugin directories — safe across reinstalls
|
||||||
|
- Third-party plugins can use their own repo URL with empty `plugin_path`
|
||||||
|
|
||||||
|
## Common Pitfalls
|
||||||
|
- paho-mqtt 2.x needs `callback_api_version=mqtt.CallbackAPIVersion.VERSION1` for v1 compat
|
||||||
|
- BasePlugin uses `get_logger()` from `src.logging_config`, not standard `logging.getLogger()`
|
||||||
|
- When modifying a plugin in the monorepo, you MUST bump `version` in its `manifest.json` and run `python update_registry.py` — otherwise users won't receive the update
|
||||||
@@ -0,0 +1,137 @@
|
|||||||
|
# Contributor Covenant Code of Conduct
|
||||||
|
|
||||||
|
## Our Pledge
|
||||||
|
|
||||||
|
We as members, contributors, and leaders pledge to make participation in our
|
||||||
|
community a harassment-free experience for everyone, regardless of age, body
|
||||||
|
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||||
|
identity and expression, level of experience, education, socio-economic status,
|
||||||
|
nationality, personal appearance, race, religion, or sexual identity
|
||||||
|
and orientation.
|
||||||
|
|
||||||
|
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||||
|
diverse, inclusive, and healthy community.
|
||||||
|
|
||||||
|
## Our Standards
|
||||||
|
|
||||||
|
Examples of behavior that contributes to a positive environment for our
|
||||||
|
community include:
|
||||||
|
|
||||||
|
* Demonstrating empathy and kindness toward other people
|
||||||
|
* Being respectful of differing opinions, viewpoints, and experiences
|
||||||
|
* Giving and gracefully accepting constructive feedback
|
||||||
|
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||||
|
and learning from the experience
|
||||||
|
* Focusing on what is best not just for us as individuals, but for the
|
||||||
|
overall community
|
||||||
|
|
||||||
|
Examples of unacceptable behavior include:
|
||||||
|
|
||||||
|
* The use of sexualized language or imagery, and sexual attention or
|
||||||
|
advances of any kind
|
||||||
|
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||||
|
* Public or private harassment
|
||||||
|
* Publishing others' private information, such as a physical or email
|
||||||
|
address, without their explicit permission
|
||||||
|
* Other conduct which could reasonably be considered inappropriate in a
|
||||||
|
professional setting
|
||||||
|
|
||||||
|
## Enforcement Responsibilities
|
||||||
|
|
||||||
|
Community leaders are responsible for clarifying and enforcing our standards of
|
||||||
|
acceptable behavior and will take appropriate and fair corrective action in
|
||||||
|
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||||
|
or harmful.
|
||||||
|
|
||||||
|
Community leaders have the right and responsibility to remove, edit, or reject
|
||||||
|
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||||
|
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||||
|
decisions when appropriate.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
This Code of Conduct applies within all community spaces, and also applies when
|
||||||
|
an individual is officially representing the community in public spaces.
|
||||||
|
Examples of representing our community include using an official email address,
|
||||||
|
posting via an official social media account, or acting as an appointed
|
||||||
|
representative at an online or offline event.
|
||||||
|
|
||||||
|
This includes the LEDMatrix Discord server, GitHub repositories owned by
|
||||||
|
ChuckBuilds, and any other forums hosted by or affiliated with the project.
|
||||||
|
|
||||||
|
## Enforcement
|
||||||
|
|
||||||
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||||
|
reported to the community leaders responsible for enforcement on the
|
||||||
|
[LEDMatrix Discord](https://discord.gg/uW36dVAtcT) (DM a moderator or
|
||||||
|
ChuckBuilds directly) or by opening a private GitHub Security Advisory if
|
||||||
|
the issue involves account safety. All complaints will be reviewed and
|
||||||
|
investigated promptly and fairly.
|
||||||
|
|
||||||
|
All community leaders are obligated to respect the privacy and security of the
|
||||||
|
reporter of any incident.
|
||||||
|
|
||||||
|
## Enforcement Guidelines
|
||||||
|
|
||||||
|
Community leaders will follow these Community Impact Guidelines in determining
|
||||||
|
the consequences for any action they deem in violation of this Code of Conduct:
|
||||||
|
|
||||||
|
### 1. Correction
|
||||||
|
|
||||||
|
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||||
|
unprofessional or unwelcome in the community.
|
||||||
|
|
||||||
|
**Consequence**: A private, written warning from community leaders, providing
|
||||||
|
clarity around the nature of the violation and an explanation of why the
|
||||||
|
behavior was inappropriate. A public apology may be requested.
|
||||||
|
|
||||||
|
### 2. Warning
|
||||||
|
|
||||||
|
**Community Impact**: A violation through a single incident or series
|
||||||
|
of actions.
|
||||||
|
|
||||||
|
**Consequence**: A warning with consequences for continued behavior. No
|
||||||
|
interaction with the people involved, including unsolicited interaction with
|
||||||
|
those enforcing the Code of Conduct, for a specified period of time. This
|
||||||
|
includes avoiding interactions in community spaces as well as external channels
|
||||||
|
like social media. Violating these terms may lead to a temporary or
|
||||||
|
permanent ban.
|
||||||
|
|
||||||
|
### 3. Temporary Ban
|
||||||
|
|
||||||
|
**Community Impact**: A serious violation of community standards, including
|
||||||
|
sustained inappropriate behavior.
|
||||||
|
|
||||||
|
**Consequence**: A temporary ban from any sort of interaction or public
|
||||||
|
communication with the community for a specified period of time. No public or
|
||||||
|
private interaction with the people involved, including unsolicited interaction
|
||||||
|
with those enforcing the Code of Conduct, is allowed during this period.
|
||||||
|
Violating these terms may lead to a permanent ban.
|
||||||
|
|
||||||
|
### 4. Permanent Ban
|
||||||
|
|
||||||
|
**Community Impact**: Demonstrating a pattern of violation of community
|
||||||
|
standards, including sustained inappropriate behavior, harassment of an
|
||||||
|
individual, or aggression toward or disparagement of classes of individuals.
|
||||||
|
|
||||||
|
**Consequence**: A permanent ban from any sort of public interaction within
|
||||||
|
the community.
|
||||||
|
|
||||||
|
## Attribution
|
||||||
|
|
||||||
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||||
|
version 2.1, available at
|
||||||
|
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
||||||
|
|
||||||
|
Community Impact Guidelines were inspired by
|
||||||
|
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
||||||
|
|
||||||
|
For answers to common questions about this code of conduct, see the FAQ at
|
||||||
|
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
|
||||||
|
at [https://www.contributor-covenant.org/translations][translations].
|
||||||
|
|
||||||
|
[homepage]: https://www.contributor-covenant.org
|
||||||
|
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
||||||
|
[Mozilla CoC]: https://github.com/mozilla/diversity
|
||||||
|
[FAQ]: https://www.contributor-covenant.org/faq
|
||||||
|
[translations]: https://www.contributor-covenant.org/translations
|
||||||
@@ -0,0 +1,113 @@
|
|||||||
|
# Contributing to LEDMatrix
|
||||||
|
|
||||||
|
Thanks for considering a contribution! LEDMatrix is built with help from
|
||||||
|
the community and we welcome bug reports, plugins, documentation
|
||||||
|
improvements, and code changes.
|
||||||
|
|
||||||
|
## Quick links
|
||||||
|
|
||||||
|
- **Bugs / feature requests**: open an issue using one of the templates
|
||||||
|
in [`.github/ISSUE_TEMPLATE/`](.github/ISSUE_TEMPLATE/).
|
||||||
|
- **Real-time discussion**: the
|
||||||
|
[LEDMatrix Discord](https://discord.gg/uW36dVAtcT).
|
||||||
|
- **Plugin development**:
|
||||||
|
[`docs/PLUGIN_DEVELOPMENT_GUIDE.md`](docs/PLUGIN_DEVELOPMENT_GUIDE.md)
|
||||||
|
and the [`ledmatrix-plugins`](https://github.com/ChuckBuilds/ledmatrix-plugins)
|
||||||
|
repository.
|
||||||
|
- **Security issues**: see [`SECURITY.md`](SECURITY.md). Please don't
|
||||||
|
open public issues for vulnerabilities.
|
||||||
|
|
||||||
|
## Setting up a development environment
|
||||||
|
|
||||||
|
1. Clone with submodules:
|
||||||
|
```bash
|
||||||
|
git clone --recurse-submodules https://github.com/ChuckBuilds/LEDMatrix.git
|
||||||
|
cd LEDMatrix
|
||||||
|
```
|
||||||
|
2. For development without hardware, run the dev preview server:
|
||||||
|
```bash
|
||||||
|
python3 scripts/dev_server.py
|
||||||
|
# then open http://localhost:5001
|
||||||
|
```
|
||||||
|
See [`docs/DEV_PREVIEW.md`](docs/DEV_PREVIEW.md) for details.
|
||||||
|
3. To run the full display in emulator mode:
|
||||||
|
```bash
|
||||||
|
EMULATOR=true python3 run.py
|
||||||
|
```
|
||||||
|
4. To target real hardware on a Raspberry Pi, follow the install
|
||||||
|
instructions in the root [`README.md`](README.md).
|
||||||
|
|
||||||
|
## Running the tests
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install -r requirements.txt
|
||||||
|
pytest
|
||||||
|
```
|
||||||
|
|
||||||
|
See [`docs/HOW_TO_RUN_TESTS.md`](docs/HOW_TO_RUN_TESTS.md) for details
|
||||||
|
on test markers, the per-plugin tests, and the web-interface
|
||||||
|
integration tests.
|
||||||
|
|
||||||
|
## Submitting changes
|
||||||
|
|
||||||
|
1. **Open an issue first** for non-trivial changes. This avoids
|
||||||
|
wasted work on PRs that don't fit the project direction.
|
||||||
|
2. **Create a topic branch** off `main`:
|
||||||
|
`feat/<short-description>`, `fix/<short-description>`,
|
||||||
|
`docs/<short-description>`.
|
||||||
|
3. **Keep PRs focused.** One conceptual change per PR. If you find
|
||||||
|
adjacent bugs while working, fix them in a separate PR.
|
||||||
|
4. **Follow the existing code style.** Python code uses standard
|
||||||
|
`black`/`ruff` conventions; HTML/JS in `web_interface/` follows the
|
||||||
|
patterns already in `templates/v3/` and `static/v3/`.
|
||||||
|
5. **Update documentation** alongside code changes. If you add a
|
||||||
|
config key, document it in the relevant `*.md` file (or, for
|
||||||
|
plugins, in `config_schema.json` so the form is auto-generated).
|
||||||
|
6. **Run the tests** locally before opening the PR.
|
||||||
|
7. **Use the PR template** — `.github/PULL_REQUEST_TEMPLATE.md` will
|
||||||
|
prompt you for what we need.
|
||||||
|
|
||||||
|
## Commit message convention
|
||||||
|
|
||||||
|
Conventional Commits is encouraged but not strictly enforced:
|
||||||
|
|
||||||
|
- `feat: add NHL playoff bracket display`
|
||||||
|
- `fix(plugin-loader): handle missing class_name in manifest`
|
||||||
|
- `docs: correct web UI port in TROUBLESHOOTING.md`
|
||||||
|
- `refactor(cache): consolidate strategy lookup`
|
||||||
|
|
||||||
|
Keep the subject under 72 characters; put the why in the body.
|
||||||
|
|
||||||
|
## Contributing a plugin
|
||||||
|
|
||||||
|
LEDMatrix plugins live in their own repository:
|
||||||
|
[`ledmatrix-plugins`](https://github.com/ChuckBuilds/ledmatrix-plugins).
|
||||||
|
Plugin contributions go through that repo's
|
||||||
|
[`SUBMISSION.md`](https://github.com/ChuckBuilds/ledmatrix-plugins/blob/main/SUBMISSION.md)
|
||||||
|
process. The
|
||||||
|
[`hello-world` plugin](https://github.com/ChuckBuilds/ledmatrix-plugins/tree/main/plugins/hello-world)
|
||||||
|
is the canonical starter template.
|
||||||
|
|
||||||
|
## Reviewing pull requests
|
||||||
|
|
||||||
|
Maintainer review is by [@ChuckBuilds](https://github.com/ChuckBuilds).
|
||||||
|
Community review is welcome on any open PR — leave constructive
|
||||||
|
comments, test on your hardware if applicable, and call out anything
|
||||||
|
unclear.
|
||||||
|
|
||||||
|
## Code of conduct
|
||||||
|
|
||||||
|
This project follows the [Contributor Covenant](CODE_OF_CONDUCT.md). By
|
||||||
|
participating you agree to abide by its terms.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
LEDMatrix is licensed under the [GNU General Public License v3.0 or
|
||||||
|
later](LICENSE). By submitting a contribution you agree to license it
|
||||||
|
under the same terms (the standard "inbound = outbound" rule that
|
||||||
|
GitHub applies by default).
|
||||||
|
|
||||||
|
LEDMatrix builds on
|
||||||
|
[`rpi-rgb-led-matrix`](https://github.com/hzeller/rpi-rgb-led-matrix),
|
||||||
|
which is GPL-2.0-or-later. The "or later" clause makes it compatible
|
||||||
|
with GPL-3.0 distribution.
|
||||||
@@ -4,89 +4,9 @@
|
|||||||
"path": ".",
|
"path": ".",
|
||||||
"name": "LEDMatrix (Main)"
|
"name": "LEDMatrix (Main)"
|
||||||
},
|
},
|
||||||
{
|
|
||||||
"path": "../ledmatrix-odds-ticker",
|
|
||||||
"name": "Odds Ticker"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"path": "../ledmatrix-clock-simple",
|
|
||||||
"name": "Clock Simple"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"path": "../ledmatrix-text-display",
|
|
||||||
"name": "Text Display"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"path": "../ledmatrix-basketball-scoreboard",
|
|
||||||
"name": "Basketball Scoreboard"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"path": "../ledmatrix-soccer-scoreboard",
|
|
||||||
"name": "Soccer Scoreboard"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"path": "../ledmatrix-calendar",
|
|
||||||
"name": "Calendar"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"path": "../ledmatrix-olympics-countdown",
|
|
||||||
"name": "Olympics Countdown"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"path": "../ledmatrix-stocks",
|
|
||||||
"name": "Stocks"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"path": "../ledmatrix-music",
|
|
||||||
"name": "Music"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"path": "../ledmatrix-static-image",
|
|
||||||
"name": "Static Image"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"path": "../ledmatrix-football-scoreboard",
|
|
||||||
"name": "Football Scoreboard"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"path": "../ledmatrix-hockey-scoreboard",
|
|
||||||
"name": "Hockey Scoreboard"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"path": "../ledmatrix-baseball-scoreboard",
|
|
||||||
"name": "Baseball Scoreboard"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"path": "../ledmatrix-christmas-countdown",
|
|
||||||
"name": "Christmas Countdown"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"path": "../ledmatrix-flights",
|
|
||||||
"name": "Flights"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"path": "../ledmatrix-leaderboard",
|
|
||||||
"name": "Leaderboard"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"path": "../ledmatrix-weather",
|
|
||||||
"name": "Weather"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"path": "../ledmatrix-news",
|
|
||||||
"name": "News"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"path": "../ledmatrix-of-the-day",
|
|
||||||
"name": "Of The Day"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"path": "../ledmatrix-youtube-stats",
|
|
||||||
"name": "YouTube Stats"
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"path": "../ledmatrix-plugins",
|
"path": "../ledmatrix-plugins",
|
||||||
"name": "Plugin Registry"
|
"name": "Plugins (Monorepo)"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"settings": {
|
"settings": {
|
||||||
|
|||||||
@@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
@@ -1,4 +1,10 @@
|
|||||||
# LEDMatrix
|
# LEDMatrix
|
||||||
|
[](LICENSE)
|
||||||
|
[](https://discord.gg/RdrC37rEag)
|
||||||
|
[](https://github.com/ChuckBuilds/ledmatrix)
|
||||||
|
[](https://app.codacy.com/gh/ChuckBuilds/LEDMatrix/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
|
||||||
|
|
||||||
|
|
||||||
## Welcome to LEDMatrix!
|
## Welcome to LEDMatrix!
|
||||||
Welcome to the LEDMatrix Project! This open-source project enables you to run an information-rich display on a Raspberry Pi connected to an LED RGB Matrix panel. Whether you want to see your calendar, weather forecasts, sports scores, stock prices, or any other information at a glance, LEDMatrix brings it all together.
|
Welcome to the LEDMatrix Project! This open-source project enables you to run an information-rich display on a Raspberry Pi connected to an LED RGB Matrix panel. Whether you want to see your calendar, weather forecasts, sports scores, stock prices, or any other information at a glance, LEDMatrix brings it all together.
|
||||||
|
|
||||||
@@ -14,8 +20,12 @@ I'm very new to all of this and am *heavily* relying on AI development tools to
|
|||||||
I'm trying to be open to constructive criticism and support, as long as it's a realistic ask and aligns with my priorities on this project. If you have ideas for improvements, find bugs, or want to add features to the base project, please don't hesitate to reach out on Discord or submit a pull request. Similarly, if you want to develop a plugin of your own, please do so! I'd love to see what you create.
|
I'm trying to be open to constructive criticism and support, as long as it's a realistic ask and aligns with my priorities on this project. If you have ideas for improvements, find bugs, or want to add features to the base project, please don't hesitate to reach out on Discord or submit a pull request. Similarly, if you want to develop a plugin of your own, please do so! I'd love to see what you create.
|
||||||
|
|
||||||
|
|
||||||
|
### Installing the LEDMatrix project on a pi video:
|
||||||
|
[](https://www.youtube.com/watch?v=bkT0f1tZI0Y)
|
||||||
|
|
||||||
### Setup video and feature walkthrough on Youtube (Outdated but still useful) :
|
### Setup video and feature walkthrough on Youtube (Outdated but still useful) :
|
||||||
[](https://www.youtube.com/watch?v=_HaqfJy1Y54)
|
[](https://www.youtube.com/watch?v=_HaqfJy1Y54)
|
||||||
|
|
||||||
|
|
||||||
-----------------------------------------------------------------------------------
|
-----------------------------------------------------------------------------------
|
||||||
### Connect with ChuckBuilds
|
### Connect with ChuckBuilds
|
||||||
@@ -23,7 +33,7 @@ I'm trying to be open to constructive criticism and support, as long as it's a r
|
|||||||
- Show support on Youtube: https://www.youtube.com/@ChuckBuilds
|
- Show support on Youtube: https://www.youtube.com/@ChuckBuilds
|
||||||
- Check out the write-up on my website: https://www.chuck-builds.com/led-matrix/
|
- Check out the write-up on my website: https://www.chuck-builds.com/led-matrix/
|
||||||
- Stay in touch on Instagram: https://www.instagram.com/ChuckBuilds/
|
- Stay in touch on Instagram: https://www.instagram.com/ChuckBuilds/
|
||||||
- Want to chat? Reach out on the ChuckBuilds Discord: https://discord.com/invite/uW36dVAtcT
|
- Want to chat? Reach out on the LEDMatrix Discord: [https://discord.com/invite/uW36dVAtcT](https://discord.gg/dfFwsasa6W)
|
||||||
- Feeling Generous? Consider sponsoring this project or sending a donation (these AI credits aren't cheap!)
|
- Feeling Generous? Consider sponsoring this project or sending a donation (these AI credits aren't cheap!)
|
||||||
|
|
||||||
-----------------------------------------------------------------------------------
|
-----------------------------------------------------------------------------------
|
||||||
@@ -122,10 +132,15 @@ The system supports live, recent, and upcoming game information for multiple spo
|
|||||||
| This project can be finnicky! RGB LED Matrix displays are not built the same or to a high-quality standard. We have seen many displays arrive dead or partially working in our discord. Please purchase from a reputable vendor. |
|
| This project can be finnicky! RGB LED Matrix displays are not built the same or to a high-quality standard. We have seen many displays arrive dead or partially working in our discord. Please purchase from a reputable vendor. |
|
||||||
|
|
||||||
### Raspberry Pi
|
### Raspberry Pi
|
||||||
- Raspberry Pi Zero's don't have enough processing power for this project and the Pi 5 is unsupported due to new GPIO output.
|
- Raspberry Pi Zero's don't have enough processing power for this project.
|
||||||
- **Raspberry Pi 3B or 4 (NOT RPi 5!)**
|
- **Raspberry Pi 3B, 4, or 5**
|
||||||
[Amazon Affiliate Link – Raspberry Pi 4 4GB RAM](https://amzn.to/4dJixuX)
|
[Amazon Affiliate Link – Raspberry Pi 4 4GB RAM](https://amzn.to/4dJixuX)
|
||||||
[Amazon Affiliate Link – Raspberry Pi 4 8GB RAM](https://amzn.to/4qbqY7F)
|
[Amazon Affiliate Link – Raspberry Pi 4 8GB RAM](https://amzn.to/4qbqY7F)
|
||||||
|
- **Pi 5 users**: the installer automatically detects Pi 5 and builds the `rpi-rgb-led-matrix` library with RP1 support. If you previously installed on a Pi 4 and migrated the SD card, or if you see `mmap` errors in the logs, force a fresh library build:
|
||||||
|
```bash
|
||||||
|
sudo RPI_RGB_FORCE_REBUILD=1 ./first_time_install.sh
|
||||||
|
```
|
||||||
|
- Pi 5 config: leave `rp1_rio` at `0` (PIO mode, default) and set `gpio_slowdown` to `1` or `2`.
|
||||||
|
|
||||||
|
|
||||||
### RGB Matrix Bonnet / HAT
|
### RGB Matrix Bonnet / HAT
|
||||||
@@ -138,7 +153,7 @@ The system supports live, recent, and upcoming game information for multiple spo
|
|||||||
(2x in a horizontal chain is recommended)
|
(2x in a horizontal chain is recommended)
|
||||||
- [Adafruit 64×32](https://www.adafruit.com/product/2278) – designed for 128×32 but works with dynamic scaling on many displays (pixel pitch is user preference)
|
- [Adafruit 64×32](https://www.adafruit.com/product/2278) – designed for 128×32 but works with dynamic scaling on many displays (pixel pitch is user preference)
|
||||||
- [Waveshare 64×32](https://amzn.to/3Kw55jK) - Does not require E addressable pad
|
- [Waveshare 64×32](https://amzn.to/3Kw55jK) - Does not require E addressable pad
|
||||||
- [Waveshare 92×46](https://amzn.to/4bydNcv) – higher resolution, requires soldering the **E addressable pad** on the [Adafruit RGB Bonnet](https://www.adafruit.com/product/3211) to “8” **OR** toggling the DIP switch on the Adafruit Triple LED Matrix Bonnet *(no soldering required!)*
|
- [Waveshare 96×48](https://amzn.to/4bydNcv) – higher resolution, requires soldering the **E addressable pad** on the [Adafruit RGB Bonnet](https://www.adafruit.com/product/3211) to “8” **OR** toggling the DIP switch on the Adafruit Triple LED Matrix Bonnet *(no soldering required!)*
|
||||||
> Amazon Affiliate Link – ChuckBuilds receives a small commission on purchases
|
> Amazon Affiliate Link – ChuckBuilds receives a small commission on purchases
|
||||||
|
|
||||||
### Power Supply
|
### Power Supply
|
||||||
@@ -152,7 +167,7 @@ The system supports live, recent, and upcoming game information for multiple spo
|
|||||||

|

|
||||||
|
|
||||||
## Possibly required depending on the display you are using.
|
## Possibly required depending on the display you are using.
|
||||||
- Some LED Matrix displays require an "E" addressable line to draw the display properly. The [64x32 Adafruit display](https://www.adafruit.com/product/2278) does NOT require the E addressable line, however the [92x46 Waveshare display](https://amzn.to/4pQdezE) DOES require the "E" Addressable line.
|
- Some LED Matrix displays require an "E" addressable line to draw the display properly. The [64x32 Adafruit display](https://www.adafruit.com/product/2278) does NOT require the E addressable line, however the [96x48 Waveshare display](https://amzn.to/4pQdezE) DOES require the "E" Addressable line.
|
||||||
- Various ways to enable this depending on your Bonnet / HAT.
|
- Various ways to enable this depending on your Bonnet / HAT.
|
||||||
|
|
||||||
Your display will look like it is "sort of" working but still messed up.
|
Your display will look like it is "sort of" working but still messed up.
|
||||||
@@ -577,7 +592,7 @@ These settings control runtime behavior and GPIO timing:
|
|||||||
- **Critical setting**: Must match your Raspberry Pi model for stability
|
- **Critical setting**: Must match your Raspberry Pi model for stability
|
||||||
- **Raspberry Pi 3**: Use 3
|
- **Raspberry Pi 3**: Use 3
|
||||||
- **Raspberry Pi 4**: Use 4
|
- **Raspberry Pi 4**: Use 4
|
||||||
- **Raspberry Pi 5**: Use 5 (or higher if needed)
|
- **Raspberry Pi 5**: Use 1–2 in PIO mode (`rp1_rio: 0`, the default); start with `1` and increase if you see flickering
|
||||||
- **Raspberry Pi Zero/1**: Use 1-2
|
- **Raspberry Pi Zero/1**: Use 1-2
|
||||||
- Incorrect values can cause display corruption, flickering, or system instability
|
- Incorrect values can cause display corruption, flickering, or system instability
|
||||||
- If you experience issues, try adjusting this value up or down by 1
|
- If you experience issues, try adjusting this value up or down by 1
|
||||||
@@ -778,14 +793,18 @@ The LEDMatrix system includes Web Interface that runs on port 5000 and provides
|
|||||||
|
|
||||||
### Installing the Web Interface Service
|
### Installing the Web Interface Service
|
||||||
|
|
||||||
|
> The first-time installer (`first_time_install.sh`) already installs the
|
||||||
|
> web service. The steps below only apply if you need to (re)install it
|
||||||
|
> manually.
|
||||||
|
|
||||||
1. Make the install script executable:
|
1. Make the install script executable:
|
||||||
```bash
|
```bash
|
||||||
chmod +x install_web_service.sh
|
chmod +x scripts/install/install_web_service.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Run the install script with sudo:
|
2. Run the install script with sudo:
|
||||||
```bash
|
```bash
|
||||||
sudo ./install_web_service.sh
|
sudo ./scripts/install/install_web_service.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
The script will:
|
The script will:
|
||||||
@@ -870,3 +889,27 @@ sudo systemctl enable ledmatrix-web.service
|
|||||||
|
|
||||||
|
|
||||||
### If you've read this far — thanks!
|
### If you've read this far — thanks!
|
||||||
|
|
||||||
|
-----------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
LEDMatrix is licensed under the
|
||||||
|
[GNU General Public License v3.0 or later](LICENSE).
|
||||||
|
|
||||||
|
LEDMatrix builds on
|
||||||
|
[`rpi-rgb-led-matrix`](https://github.com/hzeller/rpi-rgb-led-matrix),
|
||||||
|
which is GPL-2.0-or-later. The "or later" clause makes it compatible
|
||||||
|
with GPL-3.0 distribution.
|
||||||
|
|
||||||
|
Plugin contributions in
|
||||||
|
[`ledmatrix-plugins`](https://github.com/ChuckBuilds/ledmatrix-plugins)
|
||||||
|
are also GPL-3.0-or-later unless individual plugins specify otherwise.
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, the PR
|
||||||
|
flow, and how to add a plugin. Bug reports and feature requests go in
|
||||||
|
the [issue tracker](https://github.com/ChuckBuilds/LEDMatrix/issues).
|
||||||
|
Security issues should be reported privately per
|
||||||
|
[SECURITY.md](SECURITY.md).
|
||||||
|
|||||||
@@ -0,0 +1,86 @@
|
|||||||
|
# Security Policy
|
||||||
|
|
||||||
|
## Reporting a vulnerability
|
||||||
|
|
||||||
|
If you've found a security issue in LEDMatrix, **please don't open a
|
||||||
|
public GitHub issue**. Disclose it privately so we can fix it before it's
|
||||||
|
exploited.
|
||||||
|
|
||||||
|
### How to report
|
||||||
|
|
||||||
|
Use one of these channels, in order of preference:
|
||||||
|
|
||||||
|
1. **GitHub Security Advisories** (preferred). On the LEDMatrix repo,
|
||||||
|
go to **Security → Advisories → Report a vulnerability**. This
|
||||||
|
creates a private discussion thread visible only to you and the
|
||||||
|
maintainer.
|
||||||
|
- Direct link: <https://github.com/ChuckBuilds/LEDMatrix/security/advisories/new>
|
||||||
|
2. **Discord DM**. Send a direct message to a moderator on the
|
||||||
|
[LEDMatrix Discord](https://discord.gg/uW36dVAtcT). Don't post in
|
||||||
|
public channels.
|
||||||
|
|
||||||
|
Please include:
|
||||||
|
|
||||||
|
- A description of the issue
|
||||||
|
- The version / commit hash you're testing against
|
||||||
|
- Steps to reproduce, ideally a minimal proof of concept
|
||||||
|
- The impact you can demonstrate
|
||||||
|
- Any suggested mitigation
|
||||||
|
|
||||||
|
### What to expect
|
||||||
|
|
||||||
|
- An acknowledgement within a few days (this is a hobby project, not
|
||||||
|
a 24/7 ops team).
|
||||||
|
- A discussion of the issue's severity and a plan for the fix.
|
||||||
|
- Credit in the release notes when the fix ships, unless you'd
|
||||||
|
prefer to remain anonymous.
|
||||||
|
- For high-severity issues affecting active deployments, we'll
|
||||||
|
coordinate disclosure timing with you.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
In scope for this policy:
|
||||||
|
|
||||||
|
- The LEDMatrix display controller, web interface, and plugin loader
|
||||||
|
in this repository
|
||||||
|
- The official plugins in
|
||||||
|
[`ledmatrix-plugins`](https://github.com/ChuckBuilds/ledmatrix-plugins)
|
||||||
|
- Installation scripts and systemd unit files
|
||||||
|
|
||||||
|
Out of scope (please report upstream):
|
||||||
|
|
||||||
|
- Vulnerabilities in `rpi-rgb-led-matrix` itself —
|
||||||
|
report to <https://github.com/hzeller/rpi-rgb-led-matrix>
|
||||||
|
- Vulnerabilities in Python packages we depend on — report to the
|
||||||
|
upstream package maintainer
|
||||||
|
- Issues in third-party plugins not in `ledmatrix-plugins` — report
|
||||||
|
to that plugin's repository
|
||||||
|
|
||||||
|
## Known security model
|
||||||
|
|
||||||
|
LEDMatrix is designed for trusted local networks. Several limitations
|
||||||
|
are intentional rather than vulnerabilities:
|
||||||
|
|
||||||
|
- **No web UI authentication.** The web interface assumes the network
|
||||||
|
it's running on is trusted. Don't expose port 5000 to the internet.
|
||||||
|
- **Plugins run unsandboxed.** Installed plugins execute in the same
|
||||||
|
Python process as the display loop with full file-system and
|
||||||
|
network access. Review plugin code (especially third-party plugins
|
||||||
|
from arbitrary GitHub URLs) before installing. The Plugin Store
|
||||||
|
marks community plugins as **Custom** to highlight this.
|
||||||
|
- **The display service runs as root** for hardware GPIO access. This
|
||||||
|
is required by `rpi-rgb-led-matrix`.
|
||||||
|
- **`config_secrets.json` is plaintext.** API keys and tokens are
|
||||||
|
stored unencrypted on the Pi. Lock down filesystem permissions on
|
||||||
|
the config directory if this matters for your deployment.
|
||||||
|
|
||||||
|
These are documented as known limitations rather than bugs. If you
|
||||||
|
have ideas for improving them while keeping the project usable on a
|
||||||
|
Pi, open a discussion — we're interested.
|
||||||
|
|
||||||
|
## Supported versions
|
||||||
|
|
||||||
|
LEDMatrix is rolling-release on `main`. Security fixes land on `main`
|
||||||
|
and become available the next time users run **Update Code** from the
|
||||||
|
web UI's Overview tab (which does a `git pull`). There are no LTS
|
||||||
|
branches.
|
||||||
@@ -0,0 +1,42 @@
|
|||||||
|
The identity of the designer(s) of the original ASCII repertoire and
|
||||||
|
the later Latin-1 extension of the misc-fixed BDF fonts appears to
|
||||||
|
have been lost in history. (It is likely that many of these 7-bit
|
||||||
|
ASCII fonts were created in the early or mid 1980s as part of MIT's
|
||||||
|
Project Athena, or at its industrial partner, DEC.)
|
||||||
|
|
||||||
|
In 1997, Markus Kuhn at the University of Cambridge Computer
|
||||||
|
Laboratory initiated and headed a project to extend the misc-fixed BDF
|
||||||
|
fonts to as large a subset of Unicode/ISO 10646 as is feasible for
|
||||||
|
each of the available font sizes, as part of a wider effort to
|
||||||
|
encourage users of POSIX systems to migrate from ISO 8859 to UTF-8.
|
||||||
|
|
||||||
|
Robert Brady <rwb197@ecs.soton.ac.uk> and Birger Langkjer
|
||||||
|
<birger.langkjer@image.dk> contributed thousands of glyphs and made
|
||||||
|
very substantial contributions and improvements on almost all fonts.
|
||||||
|
Constantine Stathopoulos <cstath@irismedia.gr> contributed all the
|
||||||
|
Greek characters. Markus Kuhn <http://www.cl.cam.ac.uk/~mgk25/> did
|
||||||
|
most 6x13 glyphs and the italic fonts and provided many more glyphs,
|
||||||
|
coordination, and quality assurance for the other fonts. Mark Leisher
|
||||||
|
<mleisher@crl.nmsu.edu> contributed to 6x13 Armenian, Georgian, the
|
||||||
|
first version of Latin Extended Block A and some Cyrillic. Serge V.
|
||||||
|
Vakulenko <vak@crox.net.kiae.su> donated the original Cyrillic glyphs
|
||||||
|
from his 6x13 ISO 8859-5 font. Nozomi Ytow <nozomi@biol.tsukuba.ac.jp>
|
||||||
|
contributed 6x13 halfwidth Katakana. Henning Brunzel
|
||||||
|
<hbrunzel@meta-systems.de> contributed glyphs to 10x20.bdf. Theppitak
|
||||||
|
Karoonboonyanan <thep@linux.thai.net> contributed Thai for 7x13,
|
||||||
|
7x13B, 7x13O, 7x14, 7x14B, 8x13, 8x13B, 8x13O, 9x15, 9x15B, and 10x20.
|
||||||
|
Karl Koehler <koehler@or.uni-bonn.de> contributed Arabic to 9x15,
|
||||||
|
9x15B, and 10x20 and Roozbeh Pournader <roozbeh@sharif.ac.ir> and
|
||||||
|
Behdad Esfahbod revised and extended Arabic in 10x20. Raphael Finkel
|
||||||
|
<raphael@cs.uky.edu> revised Hebrew/Yiddish in 10x20. Jungshik Shin
|
||||||
|
<jshin@pantheon.yale.edu> prepared 18x18ko.bdf. Won-kyu Park
|
||||||
|
<wkpark@chem.skku.ac.kr> prepared the Hangul glyphs used in 12x13ja.
|
||||||
|
Janne V. Kujala <jvk@iki.fi> contributed 4x6. Daniel Yacob
|
||||||
|
<perl@geez.org> revised some Ethiopic glyphs. Ted Zlatanov
|
||||||
|
<tzz@lifelogs.com> did some 7x14. Mikael Öhman <micketeer@gmail.com>
|
||||||
|
worked on 6x12.
|
||||||
|
|
||||||
|
The fonts are still maintained by Markus Kuhn and the original
|
||||||
|
distribution can be found at:
|
||||||
|
|
||||||
|
http://www.cl.cam.ac.uk/~mgk25/ucs-fonts.html
|
||||||
@@ -0,0 +1,369 @@
|
|||||||
|
|
||||||
|
Unicode versions of the X11 "misc-fixed-*" fonts
|
||||||
|
------------------------------------------------
|
||||||
|
|
||||||
|
Markus Kuhn <http://www.cl.cam.ac.uk/~mgk25/> -- 2008-04-21
|
||||||
|
|
||||||
|
|
||||||
|
This package contains the X Window System bitmap fonts
|
||||||
|
|
||||||
|
-Misc-Fixed-*-*-*--*-*-*-*-C-*-ISO10646-1
|
||||||
|
|
||||||
|
These are Unicode (ISO 10646-1) extensions of the classic ISO 8859-1
|
||||||
|
X11 terminal fonts that are widely used with many X11 applications
|
||||||
|
such as xterm, emacs, etc.
|
||||||
|
|
||||||
|
COVERAGE
|
||||||
|
--------
|
||||||
|
|
||||||
|
None of these fonts covers Unicode completely. Complete coverage
|
||||||
|
simply would not make much sense here. Unicode 5.1 contains over
|
||||||
|
100000 characters, and the large majority of them are
|
||||||
|
Chinese/Japanese/Korean Han ideographs (~70000) and Korean Hangul
|
||||||
|
Syllables (~11000) that cannot adequately be displayed in the small
|
||||||
|
pixel sizes of the fixed fonts. Similarly, Arabic characters are
|
||||||
|
difficult to fit nicely together with European characters into the
|
||||||
|
fixed character cells and X11 lacks the ligature substitution
|
||||||
|
mechanisms required for using Indic scripts.
|
||||||
|
|
||||||
|
Therefore these fonts primarily attempt to cover Unicode subsets that
|
||||||
|
fit together with European scripts. This includes the Latin, Greek,
|
||||||
|
Cyrillic, Armenian, Georgian, and Hebrew scripts, plus a lot of
|
||||||
|
linguistic, technical and mathematical symbols. Some of the fixed
|
||||||
|
fonts now also cover Arabic, Thai, Ethiopian, halfwidth Katakana, and
|
||||||
|
some other non-European scripts.
|
||||||
|
|
||||||
|
We have defined 3 different target character repertoires (ISO 10646-1
|
||||||
|
subsets) that the various fonts were checked against for minimal
|
||||||
|
guaranteed coverage:
|
||||||
|
|
||||||
|
TARGET1 617 characters
|
||||||
|
Covers all characters of ISO 8859 part 1-5,7-10,13-16,
|
||||||
|
CEN MES-1, ISO 6937, Microsoft CP1251/CP1252, DEC VT100
|
||||||
|
graphics symbols, and the replacement and default
|
||||||
|
character. It is intended for small bold, italic, and
|
||||||
|
proportional fonts, for which adding block graphics
|
||||||
|
characters would make little sense. This repertoire
|
||||||
|
covers the following ISO 10646-1:2000 collections
|
||||||
|
completely: 1-3, 8, 12.
|
||||||
|
|
||||||
|
TARGET2 886 characters
|
||||||
|
Adds to TARGET1 the characters of the Adobe/Microsoft
|
||||||
|
Windows Glyph List 4 (WGL4), plus a selected set of
|
||||||
|
mathematical characters (covering most of ISO 31-11
|
||||||
|
high-school level math symbols) and some combining
|
||||||
|
characters. It is intended to be covered by all normal
|
||||||
|
"fixed" fonts and covers all European IBM, Microsoft, and
|
||||||
|
Macintosh character sets. This repertoire covers the
|
||||||
|
following ISO 10646-1:2000 (including Amd 1:2002)
|
||||||
|
collections completely: 1-3, 8, 12, 33, 45.
|
||||||
|
|
||||||
|
TARGET3 3282 characters
|
||||||
|
|
||||||
|
Adds to TARGET2 all characters of all European scripts
|
||||||
|
(Latin, Greek, Cyrillic, Armenian, Georgian), all
|
||||||
|
phonetic alphabet symbols, many mathematical symbols
|
||||||
|
(including all those available in LaTeX), all typographic
|
||||||
|
punctuation, all box-drawing characters, control code
|
||||||
|
pictures, graphical shapes and some more that you would
|
||||||
|
expect in a very comprehensive Unicode 4.0 font for
|
||||||
|
European users. It is intended for some of the more
|
||||||
|
useful and more widely used normal "fixed" fonts. This
|
||||||
|
repertoire is, with two exceptions, a superset of all
|
||||||
|
graphical characters in CEN MES-3A and covers the
|
||||||
|
following ISO 10646-1:2000 (including Amd 1:2002)
|
||||||
|
collections completely: 1-12, 27, 30-31, 32 (only
|
||||||
|
graphical characters), 33-42, 44-47, 63, 65, 70 (only
|
||||||
|
graphical characters).
|
||||||
|
|
||||||
|
[The two MES-3A characters deliberately omitted are the
|
||||||
|
angle bracket characters U+2329 and U+232A. ISO and CEN
|
||||||
|
appears to have included these into collection 40 and
|
||||||
|
MES-3A by accident, because there they are the only
|
||||||
|
characters in the Unicode EastAsianWidth "wide" class.]
|
||||||
|
|
||||||
|
CURRENT STATUS:
|
||||||
|
|
||||||
|
6x13.bdf 8x13.bdf 9x15.bdf 9x18.bdf 10x20.bdf:
|
||||||
|
|
||||||
|
Complete (TARGET3 reached and checked)
|
||||||
|
|
||||||
|
5x7.bdf 5x8.bdf 6x9.bdf 6x10.bdf 6x12.bdf 7x13.bdf 7x14.bdf clR6x12.bdf:
|
||||||
|
|
||||||
|
Complete (TARGET2 reached and checked)
|
||||||
|
|
||||||
|
6x13B.bdf 7x13B.bdf 7x14B.bdf 8x13B.bdf 9x15B.bdf 9x18B.bdf:
|
||||||
|
|
||||||
|
Complete (TARGET1 reached and checked)
|
||||||
|
|
||||||
|
6x13O.bdf 7x13O.bdf 8x13O.bdf
|
||||||
|
|
||||||
|
Complete (TARGET1 minus Hebrew and block graphics)
|
||||||
|
|
||||||
|
[None of the above fonts contains any character that has in Unicode
|
||||||
|
the East Asian Width Property "W" or "F" assigned. This way, the
|
||||||
|
desired combination of "half-width" and "full-width" glyphs can be
|
||||||
|
achieved easily. Most font mechanisms display a character that is not
|
||||||
|
covered in a font by using a glyph from another font that appears
|
||||||
|
later in a priority list, which can be arranged to be a "full-width"
|
||||||
|
font.]
|
||||||
|
|
||||||
|
The supplement package
|
||||||
|
|
||||||
|
http://www.cl.cam.ac.uk/~mgk25/download/ucs-fonts-asian.tar.gz
|
||||||
|
|
||||||
|
contains the following additional square fonts with Han characters for
|
||||||
|
East Asian users:
|
||||||
|
|
||||||
|
12x13ja.bdf:
|
||||||
|
|
||||||
|
Covers TARGET2, JIS X 0208, Hangul, and a few more. This font is
|
||||||
|
primarily intended to provide Japanese full-width Hiragana,
|
||||||
|
Katakana, and Kanji for applications that take the remaining
|
||||||
|
("halfwidth") characters from 6x13.bdf. The Greek lowercase
|
||||||
|
characters in it are still a bit ugly and will need some work.
|
||||||
|
|
||||||
|
18x18ja.bdf:
|
||||||
|
|
||||||
|
Covers all JIS X 0208, JIS X 0212, GB 2312-80, KS X 1001:1992,
|
||||||
|
ISO 8859-1,2,3,4,5,7,9,10,15, CP437, CP850 and CP1252 characters,
|
||||||
|
plus a few more, where priority was given to Japanese han style
|
||||||
|
variants. This font should have everything needed to cover the
|
||||||
|
full ISO-2022-JP-2 (RFC 1554) repertoire. This font is primarily
|
||||||
|
intended to provide Japanese full-width Hiragana, Katakana, and
|
||||||
|
Kanji for applications that take the remaining ("halfwidth")
|
||||||
|
characters from 9x18.bdf.
|
||||||
|
|
||||||
|
18x18ko.bdf:
|
||||||
|
|
||||||
|
Covers the same repertoire as 18x18ja plus full coverage of all
|
||||||
|
Hangul syllables and priority was given to Hanja glyphs in the
|
||||||
|
unified CJK area as they are used for writing Korean.
|
||||||
|
|
||||||
|
The 9x18 and 6x12 fonts are recommended for use with overstriking
|
||||||
|
combining characters.
|
||||||
|
|
||||||
|
Bug reports, suggestions for improvement, and especially contributed
|
||||||
|
extensions are very welcome!
|
||||||
|
|
||||||
|
INSTALLATION
|
||||||
|
------------
|
||||||
|
|
||||||
|
You install the fonts under Unix roughly like this (details depending
|
||||||
|
on your system of course):
|
||||||
|
|
||||||
|
System-wide installation (root access required):
|
||||||
|
|
||||||
|
cd submission/
|
||||||
|
make
|
||||||
|
su
|
||||||
|
mv -b *.pcf.gz /usr/lib/X11/fonts/misc/
|
||||||
|
cd /usr/lib/X11/fonts/misc/
|
||||||
|
mkfontdir
|
||||||
|
xset fp rehash
|
||||||
|
|
||||||
|
Alternative: Installation in your private user directory:
|
||||||
|
|
||||||
|
cd submission/
|
||||||
|
make
|
||||||
|
mkdir -p ~/local/lib/X11/fonts/
|
||||||
|
mv *.pcf.gz ~/local/lib/X11/fonts/
|
||||||
|
cd ~/local/lib/X11/fonts/
|
||||||
|
mkfontdir
|
||||||
|
xset +fp ~/local/lib/X11/fonts (put this last line also in ~/.xinitrc)
|
||||||
|
|
||||||
|
Now you can have a look at say the 6x13 font with the command
|
||||||
|
|
||||||
|
xfd -fn '-misc-fixed-medium-r-semicondensed--13-120-75-75-c-60-iso10646-1'
|
||||||
|
|
||||||
|
If you want to have short names for the Unicode fonts, you can also
|
||||||
|
append the fonts.alias file to that in the directory where you install
|
||||||
|
the fonts, call "mkfontdir" and "xset fp rehash" again, and then you
|
||||||
|
can also write
|
||||||
|
|
||||||
|
xfd -fn 6x13U
|
||||||
|
|
||||||
|
Note: If you use an old version of xfontsel, you might notice that it
|
||||||
|
treats every font that contains characters >0x00ff as a Japanese JIS
|
||||||
|
font and therefore selects inappropriate sample characters for display
|
||||||
|
of ISO 10646-1 fonts. An updated xfontsel version with this bug fixed
|
||||||
|
comes with XFree86 4.0 / X11R6.8 or newer.
|
||||||
|
|
||||||
|
If you use the Exceed X server on Microsoft Windows, then you will
|
||||||
|
have to convert the BDF files into Microsoft FON files using the
|
||||||
|
"Compile Fonts" function of Exceed xconfig. See the file exceed.txt
|
||||||
|
for more information.
|
||||||
|
|
||||||
|
There is one significant efficiency problem that X11R6 has with the
|
||||||
|
sparsely populated ISO10646-1 fonts. X11 transmits and allocates 12
|
||||||
|
bytes with the XFontStruct data structure for the difference between
|
||||||
|
the lowest and the highest code value found in a font, no matter
|
||||||
|
whether the code positions in between are used for characters or not.
|
||||||
|
Even a tiny font that contains only two glyphs at positions 0x0000 and
|
||||||
|
0xfffd causes 12 bytes * 65534 codes = 786 kbytes to be requested and
|
||||||
|
stored by the client. Since all the ISO10646-1 BDF files provided in
|
||||||
|
this package contain characters in the U+00xx (ASCII) and U+ffxx
|
||||||
|
(ligatures, etc.) range, all of them would result in 786 kbyte large
|
||||||
|
XCharStruct arrays in the per_char array of the corresponding
|
||||||
|
XFontStruct (even for CharCell fonts!) when loaded by an X client.
|
||||||
|
Until this problem is fixed by extending the X11 font protocol and
|
||||||
|
implementation, non-CJK ISO10646-1 fonts that lack the (anyway not
|
||||||
|
very interesting) characters above U+31FF seem to be the best
|
||||||
|
compromise. The bdftruncate.pl program in this package can be used to
|
||||||
|
deactivate any glyphs above a threshold code value in BDF files. This
|
||||||
|
way, we get relatively memory-economic ISO10646-1 fonts that cause
|
||||||
|
"only" 150 kbyte large XCharStruct arrays to be allocated. The
|
||||||
|
deactivated glyphs are still present in the BDF files, but with an
|
||||||
|
encoding value of -1 that causes them to be ignored.
|
||||||
|
|
||||||
|
The ISO10646-1 fonts can not only be used directly by Unicode aware
|
||||||
|
software, they can also be used to create any 8-bit font. The
|
||||||
|
ucs2any.pl Perl script converts a ISO10646-1 BDF font into a BDF font
|
||||||
|
file with some different encoding. For instance the command
|
||||||
|
|
||||||
|
perl ucs2any.pl 6x13.bdf MAPPINGS/8859-7.TXT ISO8859-7
|
||||||
|
|
||||||
|
will generate the file 6x13-ISO8859-7.bdf according to the 8859-7.TXT
|
||||||
|
Latin/Greek mapping table, which available from
|
||||||
|
<ftp://ftp.unicode.org/Public/MAPPINGS/>. [The shell script
|
||||||
|
./map_fonts automatically generates a subdirectory derived-fonts/ with
|
||||||
|
many *.bdf and *.pcf.gz 8-bit versions of all the
|
||||||
|
-misc-fixed-*-iso10646-1 fonts.]
|
||||||
|
|
||||||
|
When you do a "make" in the submission/ subdirectory as suggested in
|
||||||
|
the installation instructions above, this will generate exactly the
|
||||||
|
set of fonts that have been submitted to the XFree86 project for
|
||||||
|
inclusion into XFree86 4.0. These consists of all the ISO10646-1 fonts
|
||||||
|
processed with "bdftruncate.pl U+3200" plus a selected set of derived
|
||||||
|
8-bit fonts generated with ucs2any.pl.
|
||||||
|
|
||||||
|
Every font comes with a *.repertoire-utf8 file that lists all the
|
||||||
|
characters in this font.
|
||||||
|
|
||||||
|
|
||||||
|
CONTRIBUTING
|
||||||
|
------------
|
||||||
|
|
||||||
|
If you want to help me in extending or improving the fonts, or if you
|
||||||
|
want to start your own ISO 10646-1 font project, you will have to edit
|
||||||
|
BDF font files. This is most comfortably done with the gbdfed font
|
||||||
|
editor (version 1.3 or higher), which is available from
|
||||||
|
|
||||||
|
http://crl.nmsu.edu/~mleisher/gbdfed.html
|
||||||
|
|
||||||
|
Once you are familiar with gbdfed, you will notice that it is no
|
||||||
|
problem to design up to 100 nice characters per hour (even more if
|
||||||
|
only placing accents is involved).
|
||||||
|
|
||||||
|
Information about other X11 font tools and Unicode fonts for X11 in
|
||||||
|
general can be found on
|
||||||
|
|
||||||
|
http://www.cl.cam.ac.uk/~mgk25/ucs-fonts.html
|
||||||
|
|
||||||
|
The latest version of this package is available from
|
||||||
|
|
||||||
|
http://www.cl.cam.ac.uk/~mgk25/download/ucs-fonts.tar.gz
|
||||||
|
|
||||||
|
If you want to contribute, then get the very latest version of this
|
||||||
|
package, check which glyphs are still missing or inappropriate for
|
||||||
|
your needs, and send me whatever you had the time to add and fix. Just
|
||||||
|
email me the extended BDF-files back, or even better, send me a patch
|
||||||
|
file of what you changed. The best way of preparing a patch file is
|
||||||
|
|
||||||
|
./touch_id newfile.bdf
|
||||||
|
diff -d -u -F STARTCHAR oldfile.bdf newfile.bdf >file.diff
|
||||||
|
|
||||||
|
which ensures that the patch file preserves information about which
|
||||||
|
exact version you worked on and what character each "hunk" changes.
|
||||||
|
|
||||||
|
I will try to update this packet on a daily basis. By sending me
|
||||||
|
extensions to these fonts, you agree that the resulting improved font
|
||||||
|
files will remain in the public domain for everyone's free use. Always
|
||||||
|
make sure to load the very latest version of the package immediately
|
||||||
|
before your start, and send me your results as soon as you are done,
|
||||||
|
in order to avoid revision overlaps with other contributors.
|
||||||
|
|
||||||
|
Please try to be careful with the glyphs you generate:
|
||||||
|
|
||||||
|
- Always look first at existing similar characters in order to
|
||||||
|
preserve a consistent look and feel for the entire font and
|
||||||
|
within the font family. For block graphics characters and geometric
|
||||||
|
symbols, take care of correct alignment.
|
||||||
|
|
||||||
|
- Read issues.txt, which contains some design hints for certain
|
||||||
|
characters.
|
||||||
|
|
||||||
|
- All characters of CharCell (C) fonts must strictly fit into
|
||||||
|
the pixel matrix and absolutely no out-of-box ink is allowed.
|
||||||
|
|
||||||
|
- The character cells will be displayed directly next to each other,
|
||||||
|
without any additional pixels in between. Therefore, always make
|
||||||
|
sure that at least the rightmost pixel column remains white, as
|
||||||
|
otherwise letters will stick together, except of course for
|
||||||
|
characters -- like Arabic or block graphics -- that are supposed to
|
||||||
|
stick together.
|
||||||
|
|
||||||
|
- Place accents as low as possible on the Latin characters.
|
||||||
|
|
||||||
|
- Try to keep the shape of accents consistent among each other and
|
||||||
|
with the combining characters in the U+03xx range.
|
||||||
|
|
||||||
|
- Use gbdfed only to edit the BDF file directly and do not import
|
||||||
|
the font that you want to edit from the X server. Use gbdfed 1.3
|
||||||
|
or higher.
|
||||||
|
|
||||||
|
- The glyph names should be the Adobe names for Unicode characters
|
||||||
|
defined at
|
||||||
|
|
||||||
|
http://www.adobe.com/devnet/opentype/archives/glyph.html
|
||||||
|
|
||||||
|
which gbdfed can set automatically. To make the Edit/Rename Glyphs/
|
||||||
|
Adobe Names function work, you have to download the file
|
||||||
|
|
||||||
|
http://www.adobe.com/devnet/opentype/archives/glyphlist.txt
|
||||||
|
|
||||||
|
and configure its location either in Edit/Preferences/Editing Options/
|
||||||
|
Adobe Glyph List, or as "adobe_name_file" in "~/.gbdfed".
|
||||||
|
|
||||||
|
- Be careful to not change the FONTBOUNDINGBOX box accidentally in
|
||||||
|
a patch.
|
||||||
|
|
||||||
|
You should have a copy of the ISO 10646 standard
|
||||||
|
|
||||||
|
ISO/IEC 10646:2003, Information technology -- Universal
|
||||||
|
Multiple-Octet Coded Character Set (UCS),
|
||||||
|
International Organization for Standardization, Geneva, 2003.
|
||||||
|
http://standards.iso.org/ittf/PubliclyAvailableStandards/
|
||||||
|
|
||||||
|
and/or the Unicode 5.0 book:
|
||||||
|
|
||||||
|
The Unicode Consortium: The Unicode Standard, Version 5.0,
|
||||||
|
Reading, MA, Addison-Wesley, 2006,
|
||||||
|
ISBN 9780321480910.
|
||||||
|
http://www.amazon.com/exec/obidos/ASIN/0321480910/mgk25
|
||||||
|
|
||||||
|
All these fonts are from time to time resubmitted to the X.Org
|
||||||
|
project, XFree86 (they have been in there since XFree86 4.0), and to
|
||||||
|
other X server developers for inclusion into their normal X11
|
||||||
|
distributions.
|
||||||
|
|
||||||
|
Starting with XFree86 4.0, xterm has included UTF-8 support. This
|
||||||
|
version is also available from
|
||||||
|
|
||||||
|
http://dickey.his.com/xterm/xterm.html
|
||||||
|
|
||||||
|
Please make the developer of your favourite software aware of the
|
||||||
|
UTF-8 definition in RFC 2279 and of the existence of this font
|
||||||
|
collection. For more information on how to use UTF-8, please check out
|
||||||
|
|
||||||
|
http://www.cl.cam.ac.uk/~mgk25/unicode.html
|
||||||
|
ftp://ftp.ilog.fr/pub/Users/haible/utf8/Unicode-HOWTO.html
|
||||||
|
|
||||||
|
where you will also find information on joining the
|
||||||
|
linux-utf8@nl.linux.org mailing list.
|
||||||
|
|
||||||
|
A number of UTF-8 example text files can be found in the examples/
|
||||||
|
subdirectory or on
|
||||||
|
|
||||||
|
http://www.cl.cam.ac.uk/~mgk25/ucs/examples/
|
||||||
|
|
||||||
@@ -0,0 +1,72 @@
|
|||||||
|
## Provided fonts
|
||||||
|
These are BDF fonts, a simple bitmap font-format that can be created
|
||||||
|
by many font tools. Given that these are bitmap fonts, they will look good on
|
||||||
|
very low resolution screens such as the LED displays.
|
||||||
|
|
||||||
|
Fonts in this directory (except tom-thumb.bdf) are public domain (see the [README](./README)) and
|
||||||
|
help you to get started with the font support in the API or the `text-util`
|
||||||
|
from the utils/ directory.
|
||||||
|
|
||||||
|
Tom-Thumb.bdf is included in this directory under [MIT license](http://vt100.tarunz.org/LICENSE). Tom-thumb.bdf was created by [@robey](http://twitter.com/robey) and originally published at https://robey.lag.net/2010/01/23/tiny-monospace-font.html
|
||||||
|
|
||||||
|
The texgyre-27.bdf font was created using the [otf2bdf] tool from the TeX Gyre font.
|
||||||
|
```bash
|
||||||
|
otf2bdf -v -o texgyre-27.bdf -r 72 -p 27 texgyreadventor-regular.otf
|
||||||
|
```
|
||||||
|
|
||||||
|
## Create your own
|
||||||
|
|
||||||
|
Fonts are in a human-readable and editable `*.bdf` format, but unless you
|
||||||
|
like reading and writing pixels in hex, generating them is probably easier :)
|
||||||
|
|
||||||
|
You can use any font-editor to generate a BDF font or use the conversion
|
||||||
|
tool [otf2bdf] to create one from some other font format.
|
||||||
|
|
||||||
|
Here is an example how you could create a 30-pixel high BDF font from some
|
||||||
|
TrueType font:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
otf2bdf -v -o myfont.bdf -r 72 -p 30 /path/to/font-Bold.ttf
|
||||||
|
```
|
||||||
|
|
||||||
|
## Getting otf2bdf
|
||||||
|
|
||||||
|
Installing the tool should be fairly straightforward.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo apt-get install otf2bdf
|
||||||
|
```
|
||||||
|
|
||||||
|
## Compiling otf2bdf
|
||||||
|
|
||||||
|
If you like to compile otf2bdf, you might notice that the configure script
|
||||||
|
uses some old way of getting the freetype configuration. There does not seem
|
||||||
|
to be much activity on the mature code, so let's patch that first:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo apt-get install -y libfreetype6-dev pkg-config autoconf
|
||||||
|
git clone https://github.com/jirutka/otf2bdf.git # check it out
|
||||||
|
cd otf2bdf
|
||||||
|
patch -p1 <<"EOF"
|
||||||
|
--- a/configure.in
|
||||||
|
+++ b/configure.in
|
||||||
|
@@ -5,8 +5,8 @@ AC_INIT(otf2bdf.c)
|
||||||
|
AC_PROG_CC
|
||||||
|
|
||||||
|
OLDLIBS=$LIBS
|
||||||
|
-LIBS="$LIBS `freetype-config --libs`"
|
||||||
|
-CPPFLAGS="$CPPFLAGS `freetype-config --cflags`"
|
||||||
|
+LIBS="$LIBS `pkg-config freetype2 --libs`"
|
||||||
|
+CPPFLAGS="$CPPFLAGS `pkg-config freetype2 --cflags`"
|
||||||
|
AC_CHECK_LIB(freetype, FT_Init_FreeType, LIBS="$LIBS -lfreetype",[
|
||||||
|
AC_MSG_ERROR([Can't find Freetype library! Compile FreeType first.])])
|
||||||
|
AC_SUBST(LIBS)
|
||||||
|
EOF
|
||||||
|
|
||||||
|
autoconf # rebuild configure script
|
||||||
|
./configure # run configure
|
||||||
|
make # build the software
|
||||||
|
sudo make install # install it
|
||||||
|
```
|
||||||
|
|
||||||
|
[otf2bdf]: https://github.com/jirutka/otf2bdf
|
||||||
|
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 102 KiB |
|
Before Width: | Height: | Size: 90 KiB After Width: | Height: | Size: 111 KiB |
|
Before Width: | Height: | Size: 76 KiB After Width: | Height: | Size: 96 KiB |
|
Before Width: | Height: | Size: 52 KiB After Width: | Height: | Size: 109 KiB |
|
Before Width: | Height: | Size: 43 KiB After Width: | Height: | Size: 98 KiB |
|
Before Width: | Height: | Size: 46 KiB After Width: | Height: | Size: 93 KiB |
|
Before Width: | Height: | Size: 69 KiB After Width: | Height: | Size: 120 KiB |
|
Before Width: | Height: | Size: 46 KiB After Width: | Height: | Size: 55 KiB |
|
Before Width: | Height: | Size: 77 KiB After Width: | Height: | Size: 66 KiB |
|
Before Width: | Height: | Size: 40 KiB After Width: | Height: | Size: 70 KiB |
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 58 KiB |
|
Before Width: | Height: | Size: 90 KiB After Width: | Height: | Size: 105 KiB |
|
Before Width: | Height: | Size: 27 KiB After Width: | Height: | Size: 50 KiB |
|
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 87 KiB |
|
Before Width: | Height: | Size: 68 KiB After Width: | Height: | Size: 25 KiB |
|
Before Width: | Height: | Size: 96 KiB After Width: | Height: | Size: 140 KiB |
|
Before Width: | Height: | Size: 91 KiB After Width: | Height: | Size: 102 KiB |
|
Before Width: | Height: | Size: 153 KiB After Width: | Height: | Size: 64 KiB |
|
Before Width: | Height: | Size: 89 KiB After Width: | Height: | Size: 91 KiB |
|
Before Width: | Height: | Size: 101 KiB After Width: | Height: | Size: 54 KiB |
|
Before Width: | Height: | Size: 55 KiB After Width: | Height: | Size: 60 KiB |
|
Before Width: | Height: | Size: 9.8 KiB After Width: | Height: | Size: 29 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 30 KiB |
|
Before Width: | Height: | Size: 103 KiB After Width: | Height: | Size: 126 KiB |
|
Before Width: | Height: | Size: 94 KiB After Width: | Height: | Size: 54 KiB |
|
Before Width: | Height: | Size: 92 KiB After Width: | Height: | Size: 93 KiB |
|
Before Width: | Height: | Size: 59 KiB After Width: | Height: | Size: 60 KiB |
|
Before Width: | Height: | Size: 80 KiB After Width: | Height: | Size: 41 KiB |
|
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 77 KiB |
|
Before Width: | Height: | Size: 111 KiB After Width: | Height: | Size: 140 KiB |
|
After Width: | Height: | Size: 476 B |
|
After Width: | Height: | Size: 459 B |
|
After Width: | Height: | Size: 545 B |
|
After Width: | Height: | Size: 496 B |
|
After Width: | Height: | Size: 561 B |
|
After Width: | Height: | Size: 538 B |
|
After Width: | Height: | Size: 521 B |
|
Before Width: | Height: | Size: 105 KiB After Width: | Height: | Size: 657 KiB |
@@ -1,52 +1,96 @@
|
|||||||
{
|
{
|
||||||
"web_display_autostart": true,
|
"web_display_autostart": true,
|
||||||
"schedule": {
|
"schedule": {
|
||||||
"enabled": true,
|
"enabled": false,
|
||||||
"mode": "per-day",
|
"mode": "per-day",
|
||||||
"start_time": "07:00",
|
"start_time": "07:00",
|
||||||
"end_time": "23:00",
|
"end_time": "23:00",
|
||||||
"days": {
|
"days": {
|
||||||
"monday": {
|
"monday": {
|
||||||
"enabled": true,
|
"enabled": false,
|
||||||
"start_time": "07:00",
|
"start_time": "07:00",
|
||||||
"end_time": "23:00"
|
"end_time": "23:00"
|
||||||
},
|
},
|
||||||
"tuesday": {
|
"tuesday": {
|
||||||
"enabled": true,
|
"enabled": false,
|
||||||
"start_time": "07:00",
|
"start_time": "07:00",
|
||||||
"end_time": "23:00"
|
"end_time": "23:00"
|
||||||
},
|
},
|
||||||
"wednesday": {
|
"wednesday": {
|
||||||
"enabled": true,
|
"enabled": false,
|
||||||
"start_time": "07:00",
|
"start_time": "07:00",
|
||||||
"end_time": "23:00"
|
"end_time": "23:00"
|
||||||
},
|
},
|
||||||
"thursday": {
|
"thursday": {
|
||||||
"enabled": true,
|
"enabled": false,
|
||||||
"start_time": "07:00",
|
"start_time": "07:00",
|
||||||
"end_time": "23:00"
|
"end_time": "23:00"
|
||||||
},
|
},
|
||||||
"friday": {
|
"friday": {
|
||||||
"enabled": true,
|
"enabled": false,
|
||||||
"start_time": "07:00",
|
"start_time": "07:00",
|
||||||
"end_time": "23:00"
|
"end_time": "23:00"
|
||||||
},
|
},
|
||||||
"saturday": {
|
"saturday": {
|
||||||
"enabled": true,
|
"enabled": false,
|
||||||
"start_time": "07:00",
|
"start_time": "07:00",
|
||||||
"end_time": "23:00"
|
"end_time": "23:00"
|
||||||
},
|
},
|
||||||
"sunday": {
|
"sunday": {
|
||||||
"enabled": true,
|
"enabled": false,
|
||||||
"start_time": "07:00",
|
"start_time": "07:00",
|
||||||
"end_time": "23:00"
|
"end_time": "23:00"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"timezone": "America/Chicago",
|
"dim_schedule": {
|
||||||
|
"enabled": false,
|
||||||
|
"dim_brightness": 30,
|
||||||
|
"mode": "global",
|
||||||
|
"start_time": "20:00",
|
||||||
|
"end_time": "07:00",
|
||||||
|
"days": {
|
||||||
|
"monday": {
|
||||||
|
"enabled": false,
|
||||||
|
"start_time": "20:00",
|
||||||
|
"end_time": "07:00"
|
||||||
|
},
|
||||||
|
"tuesday": {
|
||||||
|
"enabled": false,
|
||||||
|
"start_time": "20:00",
|
||||||
|
"end_time": "07:00"
|
||||||
|
},
|
||||||
|
"wednesday": {
|
||||||
|
"enabled": false,
|
||||||
|
"start_time": "20:00",
|
||||||
|
"end_time": "07:00"
|
||||||
|
},
|
||||||
|
"thursday": {
|
||||||
|
"enabled": false,
|
||||||
|
"start_time": "20:00",
|
||||||
|
"end_time": "07:00"
|
||||||
|
},
|
||||||
|
"friday": {
|
||||||
|
"enabled": false,
|
||||||
|
"start_time": "20:00",
|
||||||
|
"end_time": "07:00"
|
||||||
|
},
|
||||||
|
"saturday": {
|
||||||
|
"enabled": false,
|
||||||
|
"start_time": "20:00",
|
||||||
|
"end_time": "07:00"
|
||||||
|
},
|
||||||
|
"sunday": {
|
||||||
|
"enabled": false,
|
||||||
|
"start_time": "20:00",
|
||||||
|
"end_time": "07:00"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"timezone": "America/New_York",
|
||||||
"location": {
|
"location": {
|
||||||
"city": "Dallas",
|
"city": "Tampa",
|
||||||
"state": "Texas",
|
"state": "Florida",
|
||||||
"country": "US"
|
"country": "US"
|
||||||
},
|
},
|
||||||
"display": {
|
"display": {
|
||||||
@@ -64,15 +108,34 @@
|
|||||||
"disable_hardware_pulsing": false,
|
"disable_hardware_pulsing": false,
|
||||||
"inverse_colors": false,
|
"inverse_colors": false,
|
||||||
"show_refresh_rate": false,
|
"show_refresh_rate": false,
|
||||||
|
"led_rgb_sequence": "RGB",
|
||||||
"limit_refresh_rate_hz": 100
|
"limit_refresh_rate_hz": 100
|
||||||
},
|
},
|
||||||
"runtime": {
|
"runtime": {
|
||||||
"gpio_slowdown": 3
|
"gpio_slowdown": 3,
|
||||||
|
"rp1_rio": 0
|
||||||
},
|
},
|
||||||
"display_durations": {
|
"double_sided": {
|
||||||
"calendar": 30
|
"enabled": false,
|
||||||
|
"copies": 2,
|
||||||
|
"axis": "horizontal"
|
||||||
},
|
},
|
||||||
"use_short_date_format": true
|
"display_durations": {},
|
||||||
|
"use_short_date_format": true,
|
||||||
|
"vegas_scroll": {
|
||||||
|
"enabled": false,
|
||||||
|
"scroll_speed": 50,
|
||||||
|
"separator_width": 32,
|
||||||
|
"plugin_order": [],
|
||||||
|
"excluded_plugins": [],
|
||||||
|
"target_fps": 125,
|
||||||
|
"buffer_ahead": 2
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"sync": {
|
||||||
|
"role": "standalone",
|
||||||
|
"port": 5765,
|
||||||
|
"follower_position": "left"
|
||||||
},
|
},
|
||||||
"plugin_system": {
|
"plugin_system": {
|
||||||
"plugins_directory": "plugin-repos",
|
"plugins_directory": "plugin-repos",
|
||||||
|
|||||||
@@ -1,17 +1,9 @@
|
|||||||
{
|
{
|
||||||
"weather": {
|
|
||||||
"api_key": "YOUR_OPENWEATHERMAP_API_KEY"
|
|
||||||
},
|
|
||||||
"youtube": {
|
"youtube": {
|
||||||
"api_key": "YOUR_YOUTUBE_API_KEY",
|
"api_key": "YOUR_YOUTUBE_API_KEY",
|
||||||
"channel_id": "YOUR_YOUTUBE_CHANNEL_ID"
|
"channel_id": "YOUR_YOUTUBE_CHANNEL_ID"
|
||||||
},
|
},
|
||||||
"music": {
|
|
||||||
"SPOTIFY_CLIENT_ID": "YOUR_SPOTIFY_CLIENT_ID_HERE",
|
|
||||||
"SPOTIFY_CLIENT_SECRET": "YOUR_SPOTIFY_CLIENT_SECRET_HERE",
|
|
||||||
"SPOTIFY_REDIRECT_URI": "http://127.0.0.1:8888/callback"
|
|
||||||
},
|
|
||||||
"github": {
|
"github": {
|
||||||
"api_token": "YOUR_GITHUB_PERSONAL_ACCESS_TOKEN"
|
"api_token": "YOUR_GITHUB_PERSONAL_ACCESS_TOKEN"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,234 @@
|
|||||||
|
# Adaptive Layout & Font Scaling
|
||||||
|
|
||||||
|
`src/adaptive_layout.py` lets a plugin render legibly on **any** panel size
|
||||||
|
(64x32, 128x32, 96x48, 128x64, 256x64, ...) without hand-tuned per-display
|
||||||
|
layouts. It is **opt-in**: nothing changes for plugins that don't use it.
|
||||||
|
|
||||||
|
It generalizes three patterns proven in the plugin ecosystem:
|
||||||
|
|
||||||
|
| Pattern | Origin | Core API |
|
||||||
|
|---|---|---|
|
||||||
|
| Geometry scale factor vs. a design size | f1-scoreboard | `ctx.px(base)` / `ctx.scale` |
|
||||||
|
| Breakpoint tiers | masters-tournament | `ctx.tier` / `ctx.by_tier({...})` |
|
||||||
|
| "Largest crisp font that fits" ladder | baseball-scoreboard | `ctx.fit_text(...)` and friends |
|
||||||
|
|
||||||
|
## Quick start
|
||||||
|
|
||||||
|
Every `BasePlugin` has a lazy `self.layout` (a `LayoutContext` for the
|
||||||
|
current logical display size, rebuilt automatically if the size changes)
|
||||||
|
and a one-liner `self.draw_fit(...)`:
|
||||||
|
|
||||||
|
```python
|
||||||
|
def display(self, force_clear=False):
|
||||||
|
from src.adaptive_layout import LADDER_ARCADE
|
||||||
|
|
||||||
|
b = self.layout.bounds.inset(1) # Region(0,0,W,H) minus 1px margin
|
||||||
|
rows = b.split_v(3, 1, 1, gap=1) # 3/5 for time, 1/5 each for the rest
|
||||||
|
|
||||||
|
self.draw_fit(self.time_str, rows[0], ladder=LADDER_ARCADE)
|
||||||
|
self.draw_fit(self.weekday, rows[1]) # default LADDER_GRID
|
||||||
|
self.draw_fit(self.date_str, rows[2])
|
||||||
|
self.display_manager.update_display()
|
||||||
|
```
|
||||||
|
|
||||||
|
On 128x64 the time renders at press_start 24px; on 64x32 it steps down to
|
||||||
|
8px. The rows partition the height, so bands can never overlap — no more
|
||||||
|
`y = height - 7` magic numbers.
|
||||||
|
|
||||||
|
## Region — rect algebra
|
||||||
|
|
||||||
|
`Region(x, y, w, h)` is a frozen dataclass. All carving clamps to
|
||||||
|
non-negative dimensions, so degenerate panels behave.
|
||||||
|
|
||||||
|
- Carving: `inset(dx, dy)`, `top_band(h)`, `bottom_band(h)`,
|
||||||
|
`middle(top_h, bottom_h)`, `left_col(w)`, `right_col(w)`,
|
||||||
|
`split_h(*weights, gap=0)`, `split_v(*weights, gap=0)`
|
||||||
|
- Placement: `align_xy(w, h, align, valign)`, `center_xy(w, h)`,
|
||||||
|
`contains(w, h)`, `.center`, `.right`, `.bottom`
|
||||||
|
|
||||||
|
Scoreboard-style layout:
|
||||||
|
|
||||||
|
```python
|
||||||
|
b = self.layout.bounds
|
||||||
|
status = b.top_band(self.layout.px(7))
|
||||||
|
detail = b.bottom_band(self.layout.px(7))
|
||||||
|
score_area = b.middle(status.h, detail.h)
|
||||||
|
away_slot, home_slot = b.left_col(b.h), b.right_col(b.h)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Font ladders — discrete, never fractional
|
||||||
|
|
||||||
|
Pixel fonts (BDF, PressStart2P) only look right at native/integer sizes, so
|
||||||
|
fonts are never scaled continuously. A `FontLadder` is an ordered tuple of
|
||||||
|
`FontStep(family, size_px)` rungs, largest first; fitting walks down until
|
||||||
|
the measured text fits.
|
||||||
|
|
||||||
|
- `LADDER_GRID` (default): X11 BDFs at native sizes — 10x20 → 9x18 → 9x15 →
|
||||||
|
8x13 → 7x13 → 6x13 → 6x12 → 6x10 → 6x9 → 5x8 → 5x7 → 4x6 → tom-thumb.
|
||||||
|
Body text, labels, multi-row content.
|
||||||
|
- `LADDER_ARCADE`: PressStart2P at 32/24/16/8 (integer multiples of its 8px
|
||||||
|
grid). Headline text: clocks, scores.
|
||||||
|
|
||||||
|
Custom ladders are just tuples — e.g. to add your plugin's registered font
|
||||||
|
on top: `(FontStep("myplugin::digits", 16),) + LADDER_GRID`.
|
||||||
|
|
||||||
|
## LayoutContext
|
||||||
|
|
||||||
|
Built per (width, height); exposes facts and fit queries:
|
||||||
|
|
||||||
|
- `bounds`, `width`, `height`, `aspect`
|
||||||
|
- `tier` by height (`xs`≤16, `sm`≤32, `md`≤48, `lg`≤64, `xl`) and
|
||||||
|
`width_tier` (`narrow`≤64, `normal`≤128, `wide`≤256, `ultrawide`)
|
||||||
|
- `is_wide_short` — aspect ≥ 2.5 and height ≤ 32 (the classic 128x32 shape)
|
||||||
|
- `scale` — `min(w/design_w, h/design_h)` vs. your manifest's
|
||||||
|
`display.design_size` (default 128x32). **Geometry only** — gaps, icon
|
||||||
|
and logo sizes via `px(base, minimum, maximum)`; fonts use ladders.
|
||||||
|
- `by_tier({"sm": 10, "lg": 18})` — value for the nearest defined tier
|
||||||
|
at-or-below the panel's tier.
|
||||||
|
- `fit_text(text, box, ladder, ellipsis=True)` → `FitResult` — largest rung
|
||||||
|
that fits; ellipsizes as a last resort. Cached per (text, box, ladder).
|
||||||
|
- `fit_text_proportional(text, box, base_size_px, ladder, ellipsis=True, scale=None)` —
|
||||||
|
rung closest to (not exceeding) `base_size_px * scale`, still capped to
|
||||||
|
what fits the box. Use this instead of `fit_text` when several
|
||||||
|
independently-fitted elements need to stay visually harmonious as the
|
||||||
|
panel grows — `fit_text` maximizes *each one* within its own region,
|
||||||
|
which can make one element (e.g. a score with a generous box) balloon
|
||||||
|
out of proportion to a neighbor that scales by geometry (e.g. logos
|
||||||
|
sized via `px()`), even though each individual pick is "correct" in
|
||||||
|
isolation. `base_size_px` is normally the element's existing classic/
|
||||||
|
fixed font size. `scale` defaults to `self.scale` (the conservative
|
||||||
|
min-of-both-axes factor `px()` uses); pass an axis-specific value when
|
||||||
|
the surrounding composition already scales that way — e.g. a scoreboard
|
||||||
|
whose logo slots track height alone (`min(height, width // 2)`) should
|
||||||
|
size its text by `height / design_height` too, or the text reads as
|
||||||
|
under-scaled next to bigger logos on a panel that only grew taller.
|
||||||
|
- `fit_lines(lines, box, ladder, spacing)` — every line fits the width and
|
||||||
|
the stack fits the height (measures the actual strings).
|
||||||
|
- `font_for_rows(rows, box_h, ladder)` — largest rung whose line height
|
||||||
|
fits `rows` rows.
|
||||||
|
|
||||||
|
`FitResult` carries the ready-to-use `font` (drops straight into
|
||||||
|
`display_manager.draw_text(font=...)`), the possibly-ellipsized `text`,
|
||||||
|
ink `width`/`height`, `baseline`, `y_offset`, `line_height`, and `fits`.
|
||||||
|
|
||||||
|
## Adaptive images
|
||||||
|
|
||||||
|
`src/adaptive_images.py` is the image counterpart to `fit_text`, exposed as
|
||||||
|
`self.layout.fit_image(...)` (cached per panel size) and the one-liner
|
||||||
|
`self.draw_image(...)`:
|
||||||
|
|
||||||
|
```python
|
||||||
|
# Team logo: trim its transparent padding, fill the slot height (the
|
||||||
|
# football/hockey pattern), cached across frames by a stable key
|
||||||
|
self.draw_image(logo, regs.away_slot, mode="fill_height",
|
||||||
|
crop_to_ink=True, cache_key=f"logo:{abbr}")
|
||||||
|
|
||||||
|
# Album art: cover-crop a square, faces kept by the top anchor
|
||||||
|
self.draw_image(art, row.art, mode="cover", anchor="top")
|
||||||
|
|
||||||
|
# Pixel flags / sprite icons: NEAREST keeps hard edges
|
||||||
|
from src.adaptive_images import RESAMPLE_NEAREST
|
||||||
|
self.draw_image(flag, box, resample=RESAMPLE_NEAREST)
|
||||||
|
```
|
||||||
|
|
||||||
|
Modes: `contain` (letterbox, default), `cover` (crop-to-fill),
|
||||||
|
`fill_height` (logo-style), `stretch`. Unlike PIL's `thumbnail()`
|
||||||
|
(downscale-only — why imagery stays tiny on big panels) fitting **upscales
|
||||||
|
by default**; pass `upscale=False` for the legacy behavior. Results are
|
||||||
|
cached per (image, box size, options) with a bounded LRU — always pass a
|
||||||
|
stable `cache_key` (e.g. `"logo:KC"`) for images you reload. The module
|
||||||
|
also exports the Pillow-compat `RESAMPLE_LANCZOS`/`RESAMPLE_NEAREST`
|
||||||
|
constants so plugins can drop their local shims.
|
||||||
|
|
||||||
|
## Composite layouts
|
||||||
|
|
||||||
|
Pre-carved Region arrangements for the layouts plugins keep rebuilding:
|
||||||
|
|
||||||
|
```python
|
||||||
|
from src.adaptive_layout import scoreboard_regions, media_row
|
||||||
|
|
||||||
|
regs = scoreboard_regions(self.layout.bounds, ctx=self.layout)
|
||||||
|
# regs.away_slot / home_slot — logo slots (logo_slot = min(H, W // 2),
|
||||||
|
# capped so a center reserve always exists —
|
||||||
|
# see below)
|
||||||
|
# regs.status_band — top band (replaces the magic y = 1)
|
||||||
|
# regs.score_area — center gap, plus a controlled bleed into
|
||||||
|
# each logo slot (replaces y = H//2 - 3)
|
||||||
|
# regs.detail_band — bottom band (replaces y = H - 7)
|
||||||
|
# regs.bottom_left / bottom_right — record/timeout corners
|
||||||
|
|
||||||
|
row = media_row(self.layout.bounds, ctx=self.layout) # art left, text right
|
||||||
|
```
|
||||||
|
|
||||||
|
Both work on the full panel or on a scroll-mode card Region. They return
|
||||||
|
Regions and never draw — compose them with `draw_fit`/`draw_image`.
|
||||||
|
|
||||||
|
**`scoreboard_regions`'s center reserve.** The raw `logo_slot = min(H, W//2)`
|
||||||
|
formula has a blind spot: at exactly 2:1 aspect ratio (width = 2×height —
|
||||||
|
two, four, or more square modules stacked into a taller panel, e.g.
|
||||||
|
96x48, 128x64, 256x128) the two logo slots mathematically claim the
|
||||||
|
*entire* width, leaving zero pixels for a center column no matter how
|
||||||
|
big the panel gets. Wide panels (the 128x32 design baseline, 192x48,
|
||||||
|
256x32) never hit this, since height is already the tighter constraint
|
||||||
|
there. Two parameters fix it without any plugin-side code:
|
||||||
|
`min_center_fraction`/`min_center_design_px` guarantee a real minimum
|
||||||
|
center reserve at any aspect ratio, and `score_bleed_fraction` lets the
|
||||||
|
score's *fit box* extend a controlled amount into each logo slot — the
|
||||||
|
same way a real broadcast scoreboard's numbers cross slightly into the
|
||||||
|
team marks flanking them — so a short score string never has to truncate
|
||||||
|
even on the tightest aspect ratios. All three have sane defaults; override
|
||||||
|
them per call if a plugin's card proportions genuinely differ.
|
||||||
|
|
||||||
|
## Preserving user customization
|
||||||
|
|
||||||
|
Adaptive layout supplies *defaults*; explicit user configuration wins:
|
||||||
|
|
||||||
|
- **User-set fonts win.** If the plugin's config has an explicit
|
||||||
|
`font`/`font_size` for an element, load it as before and skip the ladder —
|
||||||
|
fit only when the user hasn't overridden (see the football-scoreboard
|
||||||
|
`_resolve_element_fit` pattern).
|
||||||
|
- **Offsets apply on top.** `customization.layout.<element>.{x_offset,y_offset}`
|
||||||
|
style knobs translate the *computed* region as a final step:
|
||||||
|
`region.offset(user_dx, user_dy)`. `draw_image(..., offset=(dx, dy))`
|
||||||
|
does the same for images.
|
||||||
|
- **Colors pass through.** `draw_fit`/`draw_fitted_text` take explicit
|
||||||
|
`color=` params; adaptive mode never repaints semantic or user-chosen
|
||||||
|
colors.
|
||||||
|
|
||||||
|
## Manifest declaration
|
||||||
|
|
||||||
|
Declare the size your layout was authored against so `ctx.scale` means
|
||||||
|
something:
|
||||||
|
|
||||||
|
```json
|
||||||
|
"display": { "design_size": { "width": 128, "height": 32 } }
|
||||||
|
```
|
||||||
|
|
||||||
|
Also available under `requires.display_size`: `min_width`, `min_height`,
|
||||||
|
`max_width`, `max_height`.
|
||||||
|
|
||||||
|
## Performance notes (Pi)
|
||||||
|
|
||||||
|
Fit queries are cached, so cost is O(unique strings). For per-second text
|
||||||
|
(clocks, live scores), fit on a **shape placeholder** and reuse the font:
|
||||||
|
|
||||||
|
```python
|
||||||
|
fit = self.layout.fit_text("00:00", box, ladder=LADDER_ARCADE) # cached once
|
||||||
|
self.display_manager.draw_text(current_time, font=fit.font, ...)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Testing across sizes
|
||||||
|
|
||||||
|
The harness already renders every plugin at a spread of sizes (now
|
||||||
|
including 96x48):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python scripts/check_plugin.py <plugin-dir> --sizes 64x32,128x32,96x48,128x64,256x64
|
||||||
|
python scripts/render_plugin.py <plugin-dir> --width 96 --height 48
|
||||||
|
```
|
||||||
|
|
||||||
|
`BoundsCheckingDisplayManager` flags right/bottom overflow and now records
|
||||||
|
mediated draw calls with negative coordinates in
|
||||||
|
`negative_coordinate_calls` (raw-PIL draws remain uncovered).
|
||||||
|
|
||||||
|
Reference migration: the **text-display** plugin's `font_mode: "auto"`.
|
||||||
@@ -2,6 +2,12 @@
|
|||||||
|
|
||||||
Advanced patterns, examples, and best practices for developing LEDMatrix plugins.
|
Advanced patterns, examples, and best practices for developing LEDMatrix plugins.
|
||||||
|
|
||||||
|
> **Adaptive layout:** for plugins that should render legibly on any panel
|
||||||
|
> size (fonts that grow on big panels, layouts that degrade gracefully on
|
||||||
|
> small ones), use the adaptive layout system — `self.layout`, `draw_fit`,
|
||||||
|
> `draw_image`, `scoreboard_regions` — documented in
|
||||||
|
> [ADAPTIVE_LAYOUT.md](ADAPTIVE_LAYOUT.md).
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
- [Using Weather Icons](#using-weather-icons)
|
- [Using Weather Icons](#using-weather-icons)
|
||||||
|
|||||||
@@ -0,0 +1,316 @@
|
|||||||
|
# Configuration Debugging Guide
|
||||||
|
|
||||||
|
This guide helps troubleshoot configuration issues in LEDMatrix.
|
||||||
|
|
||||||
|
## Configuration Files
|
||||||
|
|
||||||
|
### Main Files
|
||||||
|
|
||||||
|
| File | Purpose |
|
||||||
|
|------|---------|
|
||||||
|
| `config/config.json` | Main configuration |
|
||||||
|
| `config/config_secrets.json` | API keys and sensitive data |
|
||||||
|
| `config/config.template.json` | Template for new installations |
|
||||||
|
|
||||||
|
### Plugin Configuration
|
||||||
|
|
||||||
|
Each plugin's configuration is a top-level key in `config.json`:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"football-scoreboard": {
|
||||||
|
"enabled": true,
|
||||||
|
"display_duration": 30,
|
||||||
|
"nfl": {
|
||||||
|
"enabled": true,
|
||||||
|
"live_priority": false
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"odds-ticker": {
|
||||||
|
"enabled": true,
|
||||||
|
"display_duration": 15
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Schema Validation
|
||||||
|
|
||||||
|
Plugins define their configuration schema in `config_schema.json`. This enables:
|
||||||
|
- Automatic default value population
|
||||||
|
- Configuration validation
|
||||||
|
- Web UI form generation
|
||||||
|
|
||||||
|
### Missing Schema Warning
|
||||||
|
|
||||||
|
If a plugin doesn't have `config_schema.json`, you'll see:
|
||||||
|
|
||||||
|
```
|
||||||
|
WARNING - Plugin 'my-plugin' has no config_schema.json - configuration will not be validated.
|
||||||
|
```
|
||||||
|
|
||||||
|
**Fix**: Add a `config_schema.json` to your plugin directory.
|
||||||
|
|
||||||
|
### Schema Example
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"enabled": {
|
||||||
|
"type": "boolean",
|
||||||
|
"default": true,
|
||||||
|
"description": "Enable or disable this plugin"
|
||||||
|
},
|
||||||
|
"display_duration": {
|
||||||
|
"type": "number",
|
||||||
|
"default": 15,
|
||||||
|
"minimum": 1,
|
||||||
|
"description": "How long to display in seconds"
|
||||||
|
},
|
||||||
|
"api_key": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "API key for data access"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": ["api_key"]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Common Configuration Issues
|
||||||
|
|
||||||
|
### 1. Type Mismatches
|
||||||
|
|
||||||
|
**Problem**: String value where number expected
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"display_duration": "30" // Wrong: string
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Fix**: Use correct types
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"display_duration": 30 // Correct: number
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Logged Warning**:
|
||||||
|
```
|
||||||
|
WARNING - Config display_duration has invalid string value '30', using default 15.0
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. Missing Required Fields
|
||||||
|
|
||||||
|
**Problem**: Required field not in config
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"football-scoreboard": {
|
||||||
|
"enabled": true
|
||||||
|
// Missing api_key which is required
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Logged Error**:
|
||||||
|
```
|
||||||
|
ERROR - Plugin football-scoreboard configuration validation failed: 'api_key' is a required property
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. Invalid Nested Objects
|
||||||
|
|
||||||
|
**Problem**: Wrong structure for nested config
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"football-scoreboard": {
|
||||||
|
"nfl": "enabled" // Wrong: should be object
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Fix**: Use correct structure
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"football-scoreboard": {
|
||||||
|
"nfl": {
|
||||||
|
"enabled": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 4. Invalid JSON Syntax
|
||||||
|
|
||||||
|
**Problem**: Malformed JSON
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"plugin": {
|
||||||
|
"enabled": true, // Trailing comma
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Fix**: Remove trailing commas, ensure valid JSON
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"plugin": {
|
||||||
|
"enabled": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Tip**: Validate JSON at https://jsonlint.com/
|
||||||
|
|
||||||
|
## Debugging Configuration Loading
|
||||||
|
|
||||||
|
### Enable Debug Logging
|
||||||
|
|
||||||
|
Set environment variable:
|
||||||
|
```bash
|
||||||
|
export LEDMATRIX_DEBUG=1
|
||||||
|
python run.py
|
||||||
|
```
|
||||||
|
|
||||||
|
### Check Merged Configuration
|
||||||
|
|
||||||
|
The configuration is merged with schema defaults. To see the final merged config:
|
||||||
|
|
||||||
|
1. Enable debug logging
|
||||||
|
2. Look for log entries like:
|
||||||
|
```
|
||||||
|
DEBUG - Merged config with schema defaults for football-scoreboard
|
||||||
|
```
|
||||||
|
|
||||||
|
### Configuration Load Order
|
||||||
|
|
||||||
|
1. Load `config.json`
|
||||||
|
2. Load `config_secrets.json`
|
||||||
|
3. Merge secrets into main config
|
||||||
|
4. For each plugin:
|
||||||
|
- Load plugin's `config_schema.json`
|
||||||
|
- Extract default values from schema
|
||||||
|
- Merge user config with defaults
|
||||||
|
- Validate merged config against schema
|
||||||
|
|
||||||
|
## Web Interface Issues
|
||||||
|
|
||||||
|
### Changes Not Saving
|
||||||
|
|
||||||
|
1. Check file permissions on `config/` directory
|
||||||
|
2. Check disk space
|
||||||
|
3. Look for errors in browser console
|
||||||
|
4. Check server logs for save errors
|
||||||
|
|
||||||
|
### Form Fields Not Appearing
|
||||||
|
|
||||||
|
1. Plugin may not have `config_schema.json`
|
||||||
|
2. Schema may have syntax errors
|
||||||
|
3. Check browser console for JavaScript errors
|
||||||
|
|
||||||
|
### Checkboxes Not Working
|
||||||
|
|
||||||
|
Boolean values from checkboxes should be actual booleans, not strings:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"enabled": true, // Correct
|
||||||
|
"enabled": "true" // Wrong
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Config Key Collision Detection
|
||||||
|
|
||||||
|
LEDMatrix detects potential config key conflicts:
|
||||||
|
|
||||||
|
### Reserved Keys
|
||||||
|
|
||||||
|
These plugin IDs will trigger a warning:
|
||||||
|
- `display`, `schedule`, `timezone`, `plugin_system`
|
||||||
|
- `display_modes`, `system`, `hardware`, `debug`
|
||||||
|
- `log_level`, `emulator`, `web_interface`
|
||||||
|
|
||||||
|
**Warning**:
|
||||||
|
```
|
||||||
|
WARNING - Plugin ID 'display' conflicts with reserved config key.
|
||||||
|
```
|
||||||
|
|
||||||
|
### Case Collisions
|
||||||
|
|
||||||
|
Plugin IDs that differ only in case:
|
||||||
|
```
|
||||||
|
WARNING - Plugin ID 'Football-Scoreboard' may conflict with 'football-scoreboard' on case-insensitive file systems.
|
||||||
|
```
|
||||||
|
|
||||||
|
## Checking Configuration via API
|
||||||
|
|
||||||
|
The API blueprint mounts at `/api/v3` (`web_interface/app.py:144`).
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Get full main config (includes all plugin sections)
|
||||||
|
curl http://localhost:5000/api/v3/config/main
|
||||||
|
|
||||||
|
# Save updated main config
|
||||||
|
curl -X POST http://localhost:5000/api/v3/config/main \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d @new-config.json
|
||||||
|
|
||||||
|
# Get config schema for a specific plugin
|
||||||
|
curl "http://localhost:5000/api/v3/plugins/schema?plugin_id=football-scoreboard"
|
||||||
|
|
||||||
|
# Get a single plugin's current config
|
||||||
|
curl "http://localhost:5000/api/v3/plugins/config?plugin_id=football-scoreboard"
|
||||||
|
```
|
||||||
|
|
||||||
|
> There is no dedicated `/config/plugin/<id>` or `/config/validate`
|
||||||
|
> endpoint — config validation runs server-side automatically when you
|
||||||
|
> POST to `/config/main` or `/plugins/config`. See
|
||||||
|
> [REST_API_REFERENCE.md](REST_API_REFERENCE.md) for the full list.
|
||||||
|
|
||||||
|
## Backup and Recovery
|
||||||
|
|
||||||
|
### Manual Backup
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cp config/config.json config/config.backup.json
|
||||||
|
```
|
||||||
|
|
||||||
|
### Automatic Backups
|
||||||
|
|
||||||
|
LEDMatrix creates backups before saves:
|
||||||
|
- Location: `config/backups/`
|
||||||
|
- Format: `config_YYYYMMDD_HHMMSS.json`
|
||||||
|
|
||||||
|
### Recovery
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# List backups
|
||||||
|
ls -la config/backups/
|
||||||
|
|
||||||
|
# Restore from backup
|
||||||
|
cp config/backups/config_20240115_120000.json config/config.json
|
||||||
|
```
|
||||||
|
|
||||||
|
## Troubleshooting Checklist
|
||||||
|
|
||||||
|
- [ ] JSON syntax is valid (no trailing commas, quotes correct)
|
||||||
|
- [ ] Data types match schema (numbers are numbers, not strings)
|
||||||
|
- [ ] Required fields are present
|
||||||
|
- [ ] Nested objects have correct structure
|
||||||
|
- [ ] File permissions allow read/write
|
||||||
|
- [ ] No reserved config key collisions
|
||||||
|
- [ ] Plugin has `config_schema.json` for validation
|
||||||
|
|
||||||
|
## Getting Help
|
||||||
|
|
||||||
|
1. Check logs: `tail -f logs/ledmatrix.log`
|
||||||
|
2. Enable debug: `LEDMATRIX_DEBUG=1`
|
||||||
|
3. Check error dashboard: `/api/v3/errors/summary`
|
||||||
|
4. Validate JSON: https://jsonlint.com/
|
||||||
|
5. File an issue: https://github.com/ChuckBuilds/LEDMatrix/issues
|
||||||
@@ -48,6 +48,12 @@ display_manager.draw_text("Centered", centered=True) # Auto-center
|
|||||||
width = display_manager.get_text_width("Text", font)
|
width = display_manager.get_text_width("Text", font)
|
||||||
height = display_manager.get_font_height(font)
|
height = display_manager.get_font_height(font)
|
||||||
|
|
||||||
|
# Adaptive layout (recommended for multi-size support — text and images
|
||||||
|
# that scale to any panel; see docs/ADAPTIVE_LAYOUT.md)
|
||||||
|
rows = self.layout.bounds.inset(1).split_v(3, 1, gap=1)
|
||||||
|
self.draw_fit("12:34", rows[0]) # largest crisp font that fits
|
||||||
|
self.draw_image(logo, rows[1], mode="fill_height", crop_to_ink=True)
|
||||||
|
|
||||||
# Weather icons
|
# Weather icons
|
||||||
display_manager.draw_weather_icon("rain", x=10, y=10, size=16)
|
display_manager.draw_weather_icon("rain", x=10, y=10, size=16)
|
||||||
|
|
||||||
@@ -62,7 +68,7 @@ display_manager.defer_update(lambda: self.update_cache(), priority=0)
|
|||||||
# Basic caching
|
# Basic caching
|
||||||
cached = cache_manager.get("key", max_age=3600)
|
cached = cache_manager.get("key", max_age=3600)
|
||||||
cache_manager.set("key", data)
|
cache_manager.set("key", data)
|
||||||
cache_manager.delete("key")
|
cache_manager.delete("key") # alias for clear_cache(key)
|
||||||
|
|
||||||
# Advanced caching
|
# Advanced caching
|
||||||
data = cache_manager.get_cached_data_with_strategy("key", data_type="weather")
|
data = cache_manager.get_cached_data_with_strategy("key", data_type="weather")
|
||||||
|
|||||||
@@ -141,19 +141,27 @@ stage('Checkout') {
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Plugin Submodules
|
## Plugins
|
||||||
|
|
||||||
Plugin submodules are located in the `plugins/` directory and are managed similarly:
|
Plugins are **not** git submodules of this repository. The plugins
|
||||||
|
directory (configured by `plugin_system.plugins_directory` in
|
||||||
|
`config/config.json`, default `plugin-repos/`) is populated at install
|
||||||
|
time by the plugin loader as users install plugins from the Plugin Store
|
||||||
|
or from a GitHub URL via the web interface. Plugin source lives in a
|
||||||
|
separate repository:
|
||||||
|
[ChuckBuilds/ledmatrix-plugins](https://github.com/ChuckBuilds/ledmatrix-plugins).
|
||||||
|
|
||||||
**Initialize all plugin submodules:**
|
To work on a plugin locally without going through the Plugin Store, clone
|
||||||
```bash
|
that repo and symlink (or copy) the plugin directory into your configured
|
||||||
git submodule update --init --recursive plugins/
|
plugins directory — by default `plugin-repos/<plugin-id>/`. The plugin
|
||||||
```
|
loader will pick it up on the next display restart. The directory name
|
||||||
|
must match the plugin's `id` in `manifest.json`.
|
||||||
|
|
||||||
**Initialize a specific plugin:**
|
For more information, see:
|
||||||
```bash
|
|
||||||
git submodule update --init --recursive plugins/hockey-scoreboard
|
|
||||||
```
|
|
||||||
|
|
||||||
For more information about plugins, see the [Plugin Development Guide](.cursor/plugins_guide.md) and [Plugin Architecture Specification](docs/PLUGIN_ARCHITECTURE_SPEC.md).
|
|
||||||
|
|
||||||
|
- [PLUGIN_DEVELOPMENT_GUIDE.md](PLUGIN_DEVELOPMENT_GUIDE.md) — end-to-end
|
||||||
|
plugin development workflow
|
||||||
|
- [PLUGIN_ARCHITECTURE_SPEC.md](PLUGIN_ARCHITECTURE_SPEC.md) — plugin system
|
||||||
|
specification
|
||||||
|
- [DEV_PREVIEW.md](DEV_PREVIEW.md) — preview plugins on a desktop without a
|
||||||
|
Pi
|
||||||
|
|||||||
@@ -0,0 +1,172 @@
|
|||||||
|
# Dev Preview & Visual Testing
|
||||||
|
|
||||||
|
Tools for rapid plugin development without deploying to the RPi.
|
||||||
|
|
||||||
|
## Dev Preview Server
|
||||||
|
|
||||||
|
Interactive web UI for tweaking plugin configs and seeing the rendered display in real time.
|
||||||
|
|
||||||
|
The size inputs have a preset dropdown with the harness's standard panel
|
||||||
|
sizes, and the **All Sizes** button renders the current config at every
|
||||||
|
harness size in a side-by-side gallery (`POST /api/render-matrix`) — the
|
||||||
|
quickest way to eyeball adaptive-layout behavior across panels
|
||||||
|
(see [ADAPTIVE_LAYOUT.md](ADAPTIVE_LAYOUT.md)).
|
||||||
|
|
||||||
|
### Quick Start
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python scripts/dev_server.py
|
||||||
|
# Opens at http://localhost:5001
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python scripts/dev_server.py --port 8080 # Custom port
|
||||||
|
python scripts/dev_server.py --extra-dir /path/to/custom-plugin # 3rd party plugins
|
||||||
|
python scripts/dev_server.py --debug # Flask debug mode
|
||||||
|
```
|
||||||
|
|
||||||
|
### Workflow
|
||||||
|
|
||||||
|
1. Select a plugin from the dropdown (auto-discovers from `plugins/` and `plugin-repos/`)
|
||||||
|
2. The config form auto-generates from the plugin's `config_schema.json`
|
||||||
|
3. Tweak any config value — the display preview updates automatically
|
||||||
|
4. Toggle "Auto" off for plugins with slow `update()` calls, then click "Render" manually
|
||||||
|
5. Use the zoom slider to scale the tiny display (128x32) up for detailed inspection
|
||||||
|
6. Toggle the grid overlay to see individual pixel boundaries
|
||||||
|
|
||||||
|
### Mock Data for API-dependent Plugins
|
||||||
|
|
||||||
|
Many plugins fetch data from APIs (sports scores, weather, stocks). To render these locally, expand "Mock Data" and paste a JSON object with cache keys the plugin expects.
|
||||||
|
|
||||||
|
To find the cache keys a plugin uses, search its `manager.py` for `self.cache_manager.set(` calls.
|
||||||
|
|
||||||
|
Example for a sports plugin:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"football_scores": {
|
||||||
|
"games": [
|
||||||
|
{"home": "Eagles", "away": "Chiefs", "home_score": 24, "away_score": 21, "status": "Final"}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## CLI Render Script
|
||||||
|
|
||||||
|
Render any plugin to a PNG image from the command line. Useful for AI-assisted development and scripted workflows.
|
||||||
|
|
||||||
|
### Usage
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Basic — renders with default config
|
||||||
|
python scripts/render_plugin.py --plugin hello-world --output /tmp/hello.png
|
||||||
|
|
||||||
|
# Custom config
|
||||||
|
python scripts/render_plugin.py --plugin clock-simple \
|
||||||
|
--config '{"timezone":"America/New_York","time_format":"12h"}' \
|
||||||
|
--output /tmp/clock.png
|
||||||
|
|
||||||
|
# Different display dimensions
|
||||||
|
python scripts/render_plugin.py --plugin hello-world --width 64 --height 32 --output /tmp/small.png
|
||||||
|
|
||||||
|
# 3rd party plugin from a custom directory
|
||||||
|
python scripts/render_plugin.py --plugin my-plugin --plugin-dir /path/to/repo --output /tmp/my.png
|
||||||
|
|
||||||
|
# With mock API data
|
||||||
|
python scripts/render_plugin.py --plugin football-scoreboard \
|
||||||
|
--mock-data /tmp/mock_scores.json \
|
||||||
|
--output /tmp/football.png
|
||||||
|
```
|
||||||
|
|
||||||
|
### Using with Claude Code / AI
|
||||||
|
|
||||||
|
Claude can run the render script, then read the output PNG (Claude is multimodal and can see images). This enables a visual feedback loop:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
Claude → bash: python scripts/render_plugin.py --plugin hello-world --output /tmp/render.png
|
||||||
|
Claude → Read /tmp/render.png ← Claude sees the actual rendered display
|
||||||
|
Claude → (makes code changes based on what it sees)
|
||||||
|
Claude → bash: python scripts/render_plugin.py --plugin hello-world --output /tmp/render2.png
|
||||||
|
Claude → Read /tmp/render2.png ← verifies the visual change
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## VisualTestDisplayManager (for test suites)
|
||||||
|
|
||||||
|
A display manager that renders real pixels for use in pytest, without requiring hardware.
|
||||||
|
|
||||||
|
### Basic Usage
|
||||||
|
|
||||||
|
```python
|
||||||
|
from src.plugin_system.testing import VisualTestDisplayManager, MockCacheManager, MockPluginManager
|
||||||
|
|
||||||
|
def test_my_plugin_renders_title():
|
||||||
|
display = VisualTestDisplayManager(width=128, height=32)
|
||||||
|
cache = MockCacheManager()
|
||||||
|
pm = MockPluginManager()
|
||||||
|
|
||||||
|
plugin = MyPlugin(
|
||||||
|
plugin_id='my-plugin',
|
||||||
|
config={'enabled': True, 'title': 'Hello'},
|
||||||
|
display_manager=display,
|
||||||
|
cache_manager=cache,
|
||||||
|
plugin_manager=pm
|
||||||
|
)
|
||||||
|
|
||||||
|
plugin.update()
|
||||||
|
plugin.display(force_clear=True)
|
||||||
|
|
||||||
|
# Verify pixels were drawn (not just that methods were called)
|
||||||
|
pixels = list(display.image.getdata())
|
||||||
|
assert any(p != (0, 0, 0) for p in pixels), "Display should not be blank"
|
||||||
|
|
||||||
|
# Save snapshot for manual inspection
|
||||||
|
display.save_snapshot('/tmp/test_my_plugin.png')
|
||||||
|
```
|
||||||
|
|
||||||
|
### Pytest Fixture
|
||||||
|
|
||||||
|
A `visual_display_manager` fixture is available in plugin tests:
|
||||||
|
|
||||||
|
```python
|
||||||
|
def test_rendering(visual_display_manager):
|
||||||
|
visual_display_manager.draw_text("Test", x=10, y=10, color=(255, 255, 255))
|
||||||
|
assert visual_display_manager.width == 128
|
||||||
|
pixels = list(visual_display_manager.image.getdata())
|
||||||
|
assert any(p != (0, 0, 0) for p in pixels)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Key Differences from MockDisplayManager
|
||||||
|
|
||||||
|
| Feature | MockDisplayManager | VisualTestDisplayManager |
|
||||||
|
|---------|-------------------|--------------------------|
|
||||||
|
| Renders pixels | No (logs calls only) | Yes (real PIL rendering) |
|
||||||
|
| Loads fonts | No | Yes (same fonts as production) |
|
||||||
|
| Save to PNG | No | Yes (`save_snapshot()`) |
|
||||||
|
| Call tracking | Yes | Yes (backwards compatible) |
|
||||||
|
| Use case | Unit tests (method call assertions) | Visual tests, dev preview |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Plugin Test Runner
|
||||||
|
|
||||||
|
The test runner auto-detects `plugin-repos/` for monorepo development:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Auto-detect (tries plugins/ then plugin-repos/)
|
||||||
|
python scripts/run_plugin_tests.py
|
||||||
|
|
||||||
|
# Test specific plugin
|
||||||
|
python scripts/run_plugin_tests.py --plugin clock-simple
|
||||||
|
|
||||||
|
# Explicit directory
|
||||||
|
python scripts/run_plugin_tests.py --plugins-dir plugin-repos/
|
||||||
|
|
||||||
|
# With coverage
|
||||||
|
python scripts/run_plugin_tests.py --coverage --verbose
|
||||||
|
```
|
||||||
@@ -32,10 +32,15 @@ The LEDMatrix emulator allows you to run and test LEDMatrix displays on your com
|
|||||||
### 1. Clone the Repository
|
### 1. Clone the Repository
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/your-username/LEDMatrix.git
|
git clone --recurse-submodules https://github.com/ChuckBuilds/LEDMatrix.git
|
||||||
cd LEDMatrix
|
cd LEDMatrix
|
||||||
```
|
```
|
||||||
|
|
||||||
|
> The emulator does **not** require building the
|
||||||
|
> `rpi-rgb-led-matrix-master` submodule (it uses `RGBMatrixEmulator`
|
||||||
|
> instead), so `--recurse-submodules` is optional here. Run it anyway if
|
||||||
|
> you also want to test the real-hardware code path.
|
||||||
|
|
||||||
### 2. Install Emulator Dependencies
|
### 2. Install Emulator Dependencies
|
||||||
|
|
||||||
Install the emulator-specific requirements:
|
Install the emulator-specific requirements:
|
||||||
@@ -58,12 +63,13 @@ pip install -r requirements.txt
|
|||||||
|
|
||||||
### 1. Emulator Configuration File
|
### 1. Emulator Configuration File
|
||||||
|
|
||||||
The emulator uses `emulator_config.json` for configuration. Here's the default configuration:
|
The emulator uses `emulator_config.json` for configuration. Here's the
|
||||||
|
default configuration as it ships in the repo:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"pixel_outline": 0,
|
"pixel_outline": 0,
|
||||||
"pixel_size": 16,
|
"pixel_size": 5,
|
||||||
"pixel_style": "square",
|
"pixel_style": "square",
|
||||||
"pixel_glow": 6,
|
"pixel_glow": 6,
|
||||||
"display_adapter": "pygame",
|
"display_adapter": "pygame",
|
||||||
@@ -90,7 +96,7 @@ The emulator uses `emulator_config.json` for configuration. Here's the default c
|
|||||||
| Option | Description | Default | Values |
|
| Option | Description | Default | Values |
|
||||||
|--------|-------------|---------|--------|
|
|--------|-------------|---------|--------|
|
||||||
| `pixel_outline` | Pixel border thickness | 0 | 0-5 |
|
| `pixel_outline` | Pixel border thickness | 0 | 0-5 |
|
||||||
| `pixel_size` | Size of each pixel | 16 | 8-64 |
|
| `pixel_size` | Size of each pixel | 5 | 1-64 (8–16 is typical for testing) |
|
||||||
| `pixel_style` | Pixel shape | "square" | "square", "circle" |
|
| `pixel_style` | Pixel shape | "square" | "square", "circle" |
|
||||||
| `pixel_glow` | Glow effect intensity | 6 | 0-20 |
|
| `pixel_glow` | Glow effect intensity | 6 | 0-20 |
|
||||||
| `display_adapter` | Display backend | "pygame" | "pygame", "browser" |
|
| `display_adapter` | Display backend | "pygame" | "pygame", "browser" |
|
||||||
|
|||||||
@@ -1,5 +1,12 @@
|
|||||||
# FontManager Usage Guide
|
# FontManager Usage Guide
|
||||||
|
|
||||||
|
> **Picking a size automatically:** if you want the *largest font that fits
|
||||||
|
> a given area* rather than a fixed size, use the adaptive layout system's
|
||||||
|
> font ladders, which resolve through this FontManager. `BasePlugin`
|
||||||
|
> subclasses get this as `self.layout.fit_text(...)`; other code can build
|
||||||
|
> a `LayoutContext(width, height, font_manager)` directly — see
|
||||||
|
> [ADAPTIVE_LAYOUT.md](ADAPTIVE_LAYOUT.md).
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
The enhanced FontManager provides comprehensive font management for the LEDMatrix application with support for:
|
The enhanced FontManager provides comprehensive font management for the LEDMatrix application with support for:
|
||||||
@@ -138,6 +145,27 @@ font = self.font_manager.resolve_font(
|
|||||||
|
|
||||||
## For Plugin Developers
|
## For Plugin Developers
|
||||||
|
|
||||||
|
> **Note**: plugins that ship their own fonts via a `"fonts"` block
|
||||||
|
> in `manifest.json` are registered automatically during plugin load
|
||||||
|
> (`src/plugin_system/plugin_manager.py` calls
|
||||||
|
> `FontManager.register_plugin_fonts()`). The `plugin://…` source
|
||||||
|
> URIs documented below are resolved relative to the plugin's
|
||||||
|
> install directory.
|
||||||
|
>
|
||||||
|
> The **Fonts** tab in the web UI that lists detected
|
||||||
|
> manager-registered fonts is still a **placeholder
|
||||||
|
> implementation** — fonts that managers register through
|
||||||
|
> `register_manager_font()` do not yet appear there. The
|
||||||
|
> programmatic per-element override workflow described in
|
||||||
|
> [Manual Font Overrides](#manual-font-overrides) below
|
||||||
|
> (`set_override()` / `remove_override()` / the
|
||||||
|
> `config/font_overrides.json` store) **does** work today and is
|
||||||
|
> the supported way to override a font for an element until the
|
||||||
|
> Fonts tab is wired up. If you can't wait and need a workaround
|
||||||
|
> right now, you can also just load the font directly with PIL
|
||||||
|
> (or `freetype-py` for BDF) inside your plugin's `manager.py`
|
||||||
|
> and skip the override system entirely.
|
||||||
|
|
||||||
### Plugin Font Registration
|
### Plugin Font Registration
|
||||||
|
|
||||||
In your plugin's `manifest.json`:
|
In your plugin's `manifest.json`:
|
||||||
@@ -359,5 +387,8 @@ self.font = self.font_manager.resolve_font(
|
|||||||
|
|
||||||
## Example: Complete Manager Implementation
|
## Example: Complete Manager Implementation
|
||||||
|
|
||||||
See `test/font_manager_example.py` for a complete working example.
|
For a working example of the font manager API in use, see
|
||||||
|
`src/font_manager.py` itself and the bundled scoreboard base classes
|
||||||
|
in `src/base_classes/` (e.g., `hockey.py`, `football.py`) which
|
||||||
|
register and resolve fonts via the patterns documented above.
|
||||||
|
|
||||||
@@ -0,0 +1,337 @@
|
|||||||
|
# Getting Started with LEDMatrix
|
||||||
|
|
||||||
|
## Welcome
|
||||||
|
|
||||||
|
This guide will help you set up your LEDMatrix display for the first time and get it running in under 30 minutes.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
**Hardware:**
|
||||||
|
- Raspberry Pi (3, 4, or 5 recommended)
|
||||||
|
- RGB LED Matrix panel (32x64 or 64x64)
|
||||||
|
- Adafruit RGB Matrix HAT or similar
|
||||||
|
- Power supply (5V, 4A minimum recommended)
|
||||||
|
- MicroSD card (16GB minimum)
|
||||||
|
|
||||||
|
**Network:**
|
||||||
|
- WiFi network (or Ethernet cable)
|
||||||
|
- Computer with web browser on same network
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Quick Start (5 Minutes)
|
||||||
|
|
||||||
|
### 1. First Boot
|
||||||
|
|
||||||
|
1. Insert the MicroSD card with LEDMatrix installed
|
||||||
|
2. Connect the LED matrix to your Raspberry Pi
|
||||||
|
3. Plug in the power supply
|
||||||
|
4. Wait for the Pi to boot (about 60 seconds)
|
||||||
|
|
||||||
|
**Expected Behavior:**
|
||||||
|
- LED matrix will light up
|
||||||
|
- Display will show default plugins (clock, weather, etc.)
|
||||||
|
- Pi creates WiFi network "LEDMatrix-Setup" if not connected
|
||||||
|
|
||||||
|
### 2. Connect to WiFi
|
||||||
|
|
||||||
|
**If you see "LEDMatrix-Setup" WiFi network:**
|
||||||
|
1. Connect your device to "LEDMatrix-Setup" (open network, no password)
|
||||||
|
2. Open browser to: `http://192.168.4.1:5000`
|
||||||
|
3. Navigate to the WiFi tab
|
||||||
|
4. Click "Scan" to find your WiFi network
|
||||||
|
5. Select your network, enter password
|
||||||
|
6. Click "Connect"
|
||||||
|
7. Wait for connection (LED matrix will show confirmation)
|
||||||
|
|
||||||
|
**If already connected to WiFi:**
|
||||||
|
1. Find your Pi's IP address (check your router, or run `hostname -I` on the Pi)
|
||||||
|
2. Open browser to: `http://your-pi-ip:5000`
|
||||||
|
|
||||||
|
### 3. Access the Web Interface
|
||||||
|
|
||||||
|
Once connected, access the web interface:
|
||||||
|
|
||||||
|
```
|
||||||
|
http://your-pi-ip:5000
|
||||||
|
```
|
||||||
|
|
||||||
|
You should see:
|
||||||
|
- Overview tab with system stats
|
||||||
|
- Live display preview
|
||||||
|
- Quick action buttons
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Initial Configuration (15 Minutes)
|
||||||
|
|
||||||
|
### Step 1: Configure Display Hardware
|
||||||
|
|
||||||
|
1. Open the **Display** tab
|
||||||
|
2. Set your matrix configuration:
|
||||||
|
- **Rows**: 32 or 64 (match your hardware)
|
||||||
|
- **Columns**: commonly 64 or 96; the web UI accepts any integer
|
||||||
|
in the 16–128 range, but 64 and 96 are the values the bundled
|
||||||
|
panel hardware ships with
|
||||||
|
- **Chain Length**: Number of panels chained horizontally
|
||||||
|
- **Hardware Mapping**: usually `adafruit-hat-pwm` (with the PWM jumper
|
||||||
|
mod) or `adafruit-hat` (without). See the root README for the full list.
|
||||||
|
- **Brightness**: 70–90 is fine for indoor use
|
||||||
|
3. Click **Save**
|
||||||
|
4. From the **Overview** tab, click **Restart Display Service** to apply
|
||||||
|
|
||||||
|
**Tip:** if the display shows garbage or nothing, the most common culprits
|
||||||
|
are an incorrect `hardware_mapping`, a `gpio_slowdown` value that doesn't
|
||||||
|
match your Pi model, or panels needing the E-line mod. See
|
||||||
|
[TROUBLESHOOTING.md](TROUBLESHOOTING.md).
|
||||||
|
|
||||||
|
### Step 2: Set Timezone and Location
|
||||||
|
|
||||||
|
1. Open the **General** tab
|
||||||
|
2. Set your timezone (e.g., `America/New_York`) and location
|
||||||
|
3. Click **Save**
|
||||||
|
|
||||||
|
Correct timezone ensures accurate time display, and location is used by
|
||||||
|
weather and other location-aware plugins.
|
||||||
|
|
||||||
|
### Step 3: Install Plugins
|
||||||
|
|
||||||
|
1. Open the **Plugin Manager** tab
|
||||||
|
2. Scroll to the **Plugin Store** section to browse available plugins
|
||||||
|
3. Click **Install** on the plugins you want
|
||||||
|
4. Wait for installation to finish — installed plugins appear in the
|
||||||
|
**Installed Plugins** section above and get their own tab in the second
|
||||||
|
nav row
|
||||||
|
5. Toggle the plugin to enabled
|
||||||
|
6. From **Overview**, click **Restart Display Service**
|
||||||
|
|
||||||
|
You can also install community plugins straight from a GitHub URL using the
|
||||||
|
**Install from GitHub** section further down the same tab — see
|
||||||
|
[PLUGIN_STORE_GUIDE.md](PLUGIN_STORE_GUIDE.md) for details.
|
||||||
|
|
||||||
|
### Step 4: Configure Plugins
|
||||||
|
|
||||||
|
1. Each installed plugin gets its own tab in the second navigation row
|
||||||
|
2. Open that plugin's tab to edit its settings (favorite teams, API keys,
|
||||||
|
update intervals, display duration, etc.)
|
||||||
|
3. Click **Save**
|
||||||
|
4. Restart the display service from **Overview** so the new settings take
|
||||||
|
effect
|
||||||
|
|
||||||
|
**Example: Weather Plugin**
|
||||||
|
- Set your location (city, state, country)
|
||||||
|
- Add an API key from OpenWeatherMap (free signup) to
|
||||||
|
`config/config_secrets.json` or directly in the plugin's config screen
|
||||||
|
- Set the update interval (300 seconds is reasonable)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Testing Your Display
|
||||||
|
|
||||||
|
### Run a single plugin on demand
|
||||||
|
|
||||||
|
The fastest way to verify a plugin works without waiting for the rotation:
|
||||||
|
|
||||||
|
1. Open the plugin's tab (second nav row)
|
||||||
|
2. Scroll to **On-Demand Controls**
|
||||||
|
3. Click **Run On-Demand** — the plugin runs immediately even if disabled
|
||||||
|
4. Click **Stop On-Demand** to return to the normal rotation
|
||||||
|
|
||||||
|
### Check the live preview and logs
|
||||||
|
|
||||||
|
- The **Overview** tab shows a **Live Display Preview** that mirrors what's
|
||||||
|
on the matrix in real time — handy for debugging without looking at the
|
||||||
|
panel.
|
||||||
|
- The **Logs** tab streams the display and web service logs. Look for
|
||||||
|
`ERROR` lines if something isn't working; normal operation just shows
|
||||||
|
`INFO` messages about plugin rotation.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Common First-Time Issues
|
||||||
|
|
||||||
|
### Display Not Showing Anything
|
||||||
|
|
||||||
|
**Check:**
|
||||||
|
1. Power supply connected and adequate (5V, 4A minimum)
|
||||||
|
2. LED matrix connected to the bonnet/HAT correctly
|
||||||
|
3. Display service running: `sudo systemctl status ledmatrix`
|
||||||
|
4. Hardware configuration matches your matrix (rows/cols/chain length)
|
||||||
|
|
||||||
|
**Fix:**
|
||||||
|
1. Restart from the **Overview** tab → **Restart Display Service**
|
||||||
|
2. Or via SSH: `sudo systemctl restart ledmatrix`
|
||||||
|
|
||||||
|
### Web Interface Won't Load
|
||||||
|
|
||||||
|
**Check:**
|
||||||
|
1. Pi is connected to network: `ping your-pi-ip`
|
||||||
|
2. Web service running: `sudo systemctl status ledmatrix-web`
|
||||||
|
3. Correct port: the web UI listens on `:5000`
|
||||||
|
4. Firewall not blocking port 5000
|
||||||
|
|
||||||
|
**Fix:**
|
||||||
|
1. Restart web service: `sudo systemctl restart ledmatrix-web`
|
||||||
|
2. Check logs: `sudo journalctl -u ledmatrix-web -n 50`
|
||||||
|
|
||||||
|
### Plugins Not Showing
|
||||||
|
|
||||||
|
**Check:**
|
||||||
|
1. Plugin is enabled (toggle on the **Plugin Manager** tab)
|
||||||
|
2. Display service was restarted after enabling
|
||||||
|
3. Plugin's display duration is non-zero
|
||||||
|
4. No errors in the **Logs** tab for that plugin
|
||||||
|
|
||||||
|
**Fix:**
|
||||||
|
1. Enable the plugin from **Plugin Manager**
|
||||||
|
2. Click **Restart Display Service** on **Overview**
|
||||||
|
3. Check the **Logs** tab for plugin-specific errors
|
||||||
|
|
||||||
|
### Weather Plugin Shows "No Data"
|
||||||
|
|
||||||
|
**Check:**
|
||||||
|
1. API key configured (OpenWeatherMap)
|
||||||
|
2. Location is correct (city, state, country)
|
||||||
|
3. Internet connection working
|
||||||
|
|
||||||
|
**Fix:**
|
||||||
|
1. Sign up at openweathermap.org (free)
|
||||||
|
2. Add API key to config_secrets.json or plugin config
|
||||||
|
3. Restart display
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Next Steps
|
||||||
|
|
||||||
|
### Customize Your Display
|
||||||
|
|
||||||
|
**Adjust display durations:**
|
||||||
|
- Each plugin's tab has a **Display Duration (seconds)** field — set how
|
||||||
|
long that plugin stays on screen each rotation.
|
||||||
|
|
||||||
|
**Organize plugin order:**
|
||||||
|
- Use the **Plugin Manager** tab to enable/disable plugins. The display
|
||||||
|
cycles through enabled plugins in the order they appear.
|
||||||
|
|
||||||
|
**Add more plugins:**
|
||||||
|
- Check the **Plugin Store** section of **Plugin Manager** for new plugins.
|
||||||
|
- Install community plugins straight from a GitHub URL via
|
||||||
|
**Install from GitHub** on the same tab.
|
||||||
|
|
||||||
|
### Enable Advanced Features
|
||||||
|
|
||||||
|
**Vegas Scroll Mode:**
|
||||||
|
- Continuous scrolling ticker display
|
||||||
|
- See [ADVANCED_FEATURES.md](ADVANCED_FEATURES.md) for details
|
||||||
|
|
||||||
|
**On-Demand Display:**
|
||||||
|
- Manually trigger specific plugins
|
||||||
|
- Pin important information
|
||||||
|
- See [ADVANCED_FEATURES.md](ADVANCED_FEATURES.md) for details
|
||||||
|
|
||||||
|
**Background Services:**
|
||||||
|
- Non-blocking data fetching
|
||||||
|
- Faster plugin rotation
|
||||||
|
- See [ADVANCED_FEATURES.md](ADVANCED_FEATURES.md) for details
|
||||||
|
|
||||||
|
### Explore Documentation
|
||||||
|
|
||||||
|
- [WEB_INTERFACE_GUIDE.md](WEB_INTERFACE_GUIDE.md) - Complete web interface guide
|
||||||
|
- [WIFI_NETWORK_SETUP.md](WIFI_NETWORK_SETUP.md) - WiFi configuration details
|
||||||
|
- [PLUGIN_STORE_GUIDE.md](PLUGIN_STORE_GUIDE.md) - Installing and managing plugins
|
||||||
|
- [TROUBLESHOOTING.md](TROUBLESHOOTING.md) - Solving common issues
|
||||||
|
- [ADVANCED_FEATURES.md](ADVANCED_FEATURES.md) - Advanced functionality
|
||||||
|
|
||||||
|
### Join the Community
|
||||||
|
|
||||||
|
- Report issues on GitHub
|
||||||
|
- Share your custom plugins
|
||||||
|
- Help others in discussions
|
||||||
|
- Contribute improvements
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Quick Reference
|
||||||
|
|
||||||
|
### Service Commands
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Check status
|
||||||
|
sudo systemctl status ledmatrix
|
||||||
|
sudo systemctl status ledmatrix-web
|
||||||
|
|
||||||
|
# Restart services
|
||||||
|
sudo systemctl restart ledmatrix
|
||||||
|
sudo systemctl restart ledmatrix-web
|
||||||
|
|
||||||
|
# View logs
|
||||||
|
sudo journalctl -u ledmatrix -f
|
||||||
|
sudo journalctl -u ledmatrix-web -f
|
||||||
|
```
|
||||||
|
|
||||||
|
### File Locations
|
||||||
|
|
||||||
|
```
|
||||||
|
/home/ledpi/LEDMatrix/
|
||||||
|
├── config/
|
||||||
|
│ ├── config.json # Main configuration
|
||||||
|
│ ├── config_secrets.json # API keys and secrets
|
||||||
|
│ └── wifi_config.json # WiFi settings
|
||||||
|
├── plugin-repos/ # Installed plugins (default location)
|
||||||
|
├── cache/ # Cached data
|
||||||
|
└── web_interface/ # Web interface files
|
||||||
|
```
|
||||||
|
|
||||||
|
> The plugin install location is configurable via
|
||||||
|
> `plugin_system.plugins_directory` in `config.json`. The default is
|
||||||
|
> `plugin-repos/`. Plugin discovery (`PluginManager.discover_plugins()`)
|
||||||
|
> only scans the configured directory — it does not fall back to
|
||||||
|
> `plugins/`. However, the Plugin Store install/update path and the
|
||||||
|
> web UI's schema loader do also probe `plugins/` so the dev symlinks
|
||||||
|
> created by `scripts/dev/dev_plugin_setup.sh` keep working.
|
||||||
|
|
||||||
|
### Web Interface
|
||||||
|
|
||||||
|
```
|
||||||
|
Main Interface: http://your-pi-ip:5000
|
||||||
|
|
||||||
|
System tabs:
|
||||||
|
- Overview System stats, live preview, quick actions
|
||||||
|
- General Timezone, location, plugin-system settings
|
||||||
|
- WiFi Network selection and AP-mode setup
|
||||||
|
- Schedule Power and dim schedules
|
||||||
|
- Display Matrix hardware configuration
|
||||||
|
- Config Editor Raw config.json editor
|
||||||
|
- Fonts Upload and manage fonts
|
||||||
|
- Logs Real-time log viewing
|
||||||
|
- Cache Cached data inspection and cleanup
|
||||||
|
- Operation History Recent service operations
|
||||||
|
|
||||||
|
Plugin tabs (second row):
|
||||||
|
- Plugin Manager Browse the Plugin Store, install/enable plugins
|
||||||
|
- <plugin-id> One tab per installed plugin for its config
|
||||||
|
```
|
||||||
|
|
||||||
|
### WiFi Access Point
|
||||||
|
|
||||||
|
```
|
||||||
|
Network Name: LEDMatrix-Setup
|
||||||
|
Password: (none - open network)
|
||||||
|
URL when connected: http://192.168.4.1:5000
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Congratulations!
|
||||||
|
|
||||||
|
Your LEDMatrix display is now set up and running. Explore the web interface, try different plugins, and customize it to your liking.
|
||||||
|
|
||||||
|
**Need Help?**
|
||||||
|
- Check [TROUBLESHOOTING.md](TROUBLESHOOTING.md)
|
||||||
|
- Review detailed guides for specific features
|
||||||
|
- Report issues on GitHub
|
||||||
|
- Ask questions in community discussions
|
||||||
|
|
||||||
|
Enjoy your LED matrix display!
|
||||||
@@ -13,7 +13,7 @@ Make sure you have the testing packages installed:
|
|||||||
pip install -r requirements.txt
|
pip install -r requirements.txt
|
||||||
|
|
||||||
# Or install just the test dependencies
|
# Or install just the test dependencies
|
||||||
pip install pytest pytest-cov pytest-mock pytest-timeout
|
pip install pytest pytest-cov pytest-mock
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. Set Environment Variables
|
### 2. Set Environment Variables
|
||||||
@@ -85,8 +85,14 @@ pytest -m slow
|
|||||||
# Run all tests in the test directory
|
# Run all tests in the test directory
|
||||||
pytest test/
|
pytest test/
|
||||||
|
|
||||||
# Run all integration tests
|
# Run plugin tests only
|
||||||
pytest test/integration/
|
pytest test/plugins/
|
||||||
|
|
||||||
|
# Run web interface tests only
|
||||||
|
pytest test/web_interface/
|
||||||
|
|
||||||
|
# Run web interface integration tests
|
||||||
|
pytest test/web_interface/integration/
|
||||||
```
|
```
|
||||||
|
|
||||||
## Understanding Test Output
|
## Understanding Test Output
|
||||||
@@ -231,20 +237,41 @@ pytest --maxfail=3
|
|||||||
|
|
||||||
```
|
```
|
||||||
test/
|
test/
|
||||||
├── conftest.py # Shared fixtures and configuration
|
├── conftest.py # Shared fixtures and configuration
|
||||||
├── test_display_controller.py # Display controller tests
|
├── test_display_controller.py # Display controller tests
|
||||||
├── test_plugin_system.py # Plugin system tests
|
├── test_display_manager.py # Display manager tests
|
||||||
├── test_display_manager.py # Display manager tests
|
├── test_plugin_system.py # Plugin system tests
|
||||||
├── test_config_service.py # Config service tests
|
├── test_plugin_loader.py # Plugin discovery/loading tests
|
||||||
├── test_cache_manager.py # Cache manager tests
|
├── test_plugin_loading_failures.py # Plugin failure-mode tests
|
||||||
├── test_font_manager.py # Font manager tests
|
├── test_cache_manager.py # Cache manager tests
|
||||||
├── test_error_handling.py # Error handling tests
|
├── test_config_manager.py # Config manager tests
|
||||||
├── test_config_manager.py # Config manager tests
|
├── test_config_service.py # Config service tests
|
||||||
├── integration/ # Integration tests
|
├── test_config_validation_edge_cases.py # Config edge cases
|
||||||
│ ├── test_e2e.py # End-to-end tests
|
├── test_font_manager.py # Font manager tests
|
||||||
│ └── test_plugin_integration.py # Plugin integration tests
|
├── test_layout_manager.py # Layout manager tests
|
||||||
├── test_error_scenarios.py # Error scenario tests
|
├── test_text_helper.py # Text helper tests
|
||||||
└── test_edge_cases.py # Edge case tests
|
├── test_error_handling.py # Error handling tests
|
||||||
|
├── test_error_aggregator.py # Error aggregation tests
|
||||||
|
├── test_schema_manager.py # Schema manager tests
|
||||||
|
├── test_web_api.py # Web API tests
|
||||||
|
├── test_nba_*.py # NBA-specific test suites
|
||||||
|
├── plugins/ # Per-plugin test suites
|
||||||
|
│ ├── test_clock_simple.py
|
||||||
|
│ ├── test_calendar.py
|
||||||
|
│ ├── test_basketball_scoreboard.py
|
||||||
|
│ ├── test_soccer_scoreboard.py
|
||||||
|
│ ├── test_odds_ticker.py
|
||||||
|
│ ├── test_text_display.py
|
||||||
|
│ ├── test_visual_rendering.py
|
||||||
|
│ └── test_plugin_base.py
|
||||||
|
└── web_interface/
|
||||||
|
├── test_config_manager_atomic.py
|
||||||
|
├── test_state_reconciliation.py
|
||||||
|
├── test_plugin_operation_queue.py
|
||||||
|
├── test_dedup_unique_arrays.py
|
||||||
|
└── integration/ # Web interface integration tests
|
||||||
|
├── test_config_flows.py
|
||||||
|
└── test_plugin_operations.py
|
||||||
```
|
```
|
||||||
|
|
||||||
### Test Categories
|
### Test Categories
|
||||||
@@ -309,11 +336,15 @@ pytest --cov=src --cov-report=html
|
|||||||
|
|
||||||
## Continuous Integration
|
## Continuous Integration
|
||||||
|
|
||||||
Tests are configured to run automatically in CI/CD. The GitHub Actions workflow (`.github/workflows/tests.yml`) runs:
|
The repo runs
|
||||||
|
[`.github/workflows/security-audit.yml`](../.github/workflows/security-audit.yml)
|
||||||
- All tests on multiple Python versions (3.10, 3.11, 3.12)
|
(bandit + semgrep) on every push. A pytest CI workflow at
|
||||||
- Coverage reporting
|
`.github/workflows/tests.yml` is queued to land alongside this
|
||||||
- Uploads coverage to Codecov (if configured)
|
PR ([ChuckBuilds/LEDMatrix#307](https://github.com/ChuckBuilds/LEDMatrix/pull/307));
|
||||||
|
the workflow file itself was held back from that PR because the
|
||||||
|
push token lacked the GitHub `workflow` scope, so it needs to be
|
||||||
|
committed separately by a maintainer. Once it's in, this section
|
||||||
|
will be updated to describe what the job runs.
|
||||||
|
|
||||||
## Best Practices
|
## Best Practices
|
||||||
|
|
||||||
|
|||||||
@@ -88,8 +88,8 @@ If you encounter issues during migration:
|
|||||||
|
|
||||||
1. Check the [README.md](README.md) for current installation and usage instructions
|
1. Check the [README.md](README.md) for current installation and usage instructions
|
||||||
2. Review script README files:
|
2. Review script README files:
|
||||||
- `scripts/install/README.md` - Installation scripts documentation
|
- [`scripts/install/README.md`](../scripts/install/README.md) - Installation scripts documentation
|
||||||
- `scripts/fix_perms/README.md` (if exists) - Permission scripts documentation
|
- [`scripts/fix_perms/README.md`](../scripts/fix_perms/README.md) - Permission scripts documentation
|
||||||
3. Check system logs: `journalctl -u ledmatrix -f` or `journalctl -u ledmatrix-web -f`
|
3. Check system logs: `journalctl -u ledmatrix -f` or `journalctl -u ledmatrix-web -f`
|
||||||
4. Review the troubleshooting section in the main README
|
4. Review the troubleshooting section in the main README
|
||||||
|
|
||||||
|
|||||||
@@ -2,6 +2,11 @@
|
|||||||
|
|
||||||
Complete API reference for plugin developers. This document describes all methods and properties available to plugins through the Display Manager, Cache Manager, and Plugin Manager.
|
Complete API reference for plugin developers. This document describes all methods and properties available to plugins through the Display Manager, Cache Manager, and Plugin Manager.
|
||||||
|
|
||||||
|
> **Adaptive layout:** every `BasePlugin` also exposes `self.layout`,
|
||||||
|
> `self.draw_fit(text, region)` and `self.draw_image(img, region, ...)` —
|
||||||
|
> the recommended way to render text and images that scale to any panel
|
||||||
|
> size. See [ADAPTIVE_LAYOUT.md](ADAPTIVE_LAYOUT.md).
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
- [BasePlugin](#baseplugin)
|
- [BasePlugin](#baseplugin)
|
||||||
@@ -114,6 +119,95 @@ Get display duration for this plugin. Can be overridden for dynamic durations.
|
|||||||
|
|
||||||
Return plugin info for display in web UI. Override to provide additional state information.
|
Return plugin info for display in web UI. Override to provide additional state information.
|
||||||
|
|
||||||
|
### Dynamic-duration hooks
|
||||||
|
|
||||||
|
Plugins that render multi-step content (e.g. cycling through several games)
|
||||||
|
can extend their display time until they've shown everything. To opt in,
|
||||||
|
either set `dynamic_duration.enabled: true` in the plugin's config or
|
||||||
|
override `supports_dynamic_duration()`.
|
||||||
|
|
||||||
|
#### `supports_dynamic_duration() -> bool`
|
||||||
|
|
||||||
|
Return `True` if this plugin should use dynamic durations. Default reads
|
||||||
|
`config["dynamic_duration"]["enabled"]`.
|
||||||
|
|
||||||
|
#### `get_dynamic_duration_cap() -> Optional[float]`
|
||||||
|
|
||||||
|
Maximum number of seconds the controller will keep this plugin on screen
|
||||||
|
in dynamic mode. Default reads
|
||||||
|
`config["dynamic_duration"]["max_duration_seconds"]`.
|
||||||
|
|
||||||
|
#### `is_cycle_complete() -> bool`
|
||||||
|
|
||||||
|
Override this to return `True` only after the plugin has rendered all of
|
||||||
|
its content for the current rotation. Default returns `True` immediately,
|
||||||
|
which means a single `display()` call counts as a full cycle.
|
||||||
|
|
||||||
|
#### `reset_cycle_state() -> None`
|
||||||
|
|
||||||
|
Called by the controller before each new dynamic-duration session. Reset
|
||||||
|
internal counters/iterators here.
|
||||||
|
|
||||||
|
### Live priority hooks
|
||||||
|
|
||||||
|
Live priority lets a plugin temporarily take over the rotation when it has
|
||||||
|
urgent content (live games, breaking news). Enable by setting
|
||||||
|
`live_priority: true` in the plugin's config and overriding
|
||||||
|
`has_live_content()`.
|
||||||
|
|
||||||
|
#### `has_live_priority() -> bool`
|
||||||
|
|
||||||
|
Whether live priority is enabled in config (default reads
|
||||||
|
`config["live_priority"]`).
|
||||||
|
|
||||||
|
#### `has_live_content() -> bool`
|
||||||
|
|
||||||
|
Override to return `True` when the plugin currently has urgent content.
|
||||||
|
Default returns `False`.
|
||||||
|
|
||||||
|
#### `get_live_modes() -> List[str]`
|
||||||
|
|
||||||
|
List of display modes to show during a live takeover. Default returns the
|
||||||
|
plugin's `display_modes` from its manifest.
|
||||||
|
|
||||||
|
### Vegas scroll hooks
|
||||||
|
|
||||||
|
Vegas mode shows multiple plugins as a single continuous scroll instead of
|
||||||
|
rotating one at a time. Plugins control how their content appears via
|
||||||
|
these hooks. See [ADVANCED_FEATURES.md](ADVANCED_FEATURES.md) for the user
|
||||||
|
side of Vegas mode.
|
||||||
|
|
||||||
|
#### `get_vegas_content() -> Optional[PIL.Image | List[PIL.Image] | None]`
|
||||||
|
|
||||||
|
Return content to inject into the scroll. Multi-item plugins (sports,
|
||||||
|
odds, news) should return a *list* of PIL Images so each item scrolls
|
||||||
|
independently. Static plugins (clock, weather) can return a single image.
|
||||||
|
Returning `None` falls back to capturing whatever `display()` produces.
|
||||||
|
|
||||||
|
#### `get_vegas_content_type() -> str`
|
||||||
|
|
||||||
|
`'multi'`, `'static'`, or `'none'`. Affects how Vegas mode treats the
|
||||||
|
plugin. Default `'static'`.
|
||||||
|
|
||||||
|
#### `get_vegas_display_mode() -> VegasDisplayMode`
|
||||||
|
|
||||||
|
Returns one of `VegasDisplayMode.SCROLL`, `FIXED_SEGMENT`, or `STATIC`.
|
||||||
|
Read from `config["vegas_mode"]` or override directly.
|
||||||
|
|
||||||
|
#### `get_supported_vegas_modes() -> List[VegasDisplayMode]`
|
||||||
|
|
||||||
|
The set of Vegas modes this plugin can render. Used by the UI to populate
|
||||||
|
the mode selector for this plugin.
|
||||||
|
|
||||||
|
#### `get_vegas_segment_width() -> Optional[int]`
|
||||||
|
|
||||||
|
For `FIXED_SEGMENT` plugins, the width in pixels of the segment they
|
||||||
|
occupy in the scroll. `None` lets the controller pick a default.
|
||||||
|
|
||||||
|
> The full source for `BasePlugin` lives in
|
||||||
|
> `src/plugin_system/base_plugin.py`. If a method here disagrees with the
|
||||||
|
> source, the source wins — please open an issue or PR to fix the doc.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Display Manager
|
## Display Manager
|
||||||
@@ -228,23 +322,31 @@ date_str = self.display_manager.format_date_with_ordinal(datetime.now())
|
|||||||
|
|
||||||
### Image Rendering
|
### Image Rendering
|
||||||
|
|
||||||
#### `draw_image(image: PIL.Image, x: int, y: int) -> None`
|
The display manager doesn't provide a dedicated `draw_image()` method.
|
||||||
|
Instead, plugins paste directly onto the underlying PIL Image
|
||||||
|
(`display_manager.image`), then call `update_display()` to push the buffer
|
||||||
|
to the matrix.
|
||||||
|
|
||||||
Draw a PIL Image object on the canvas.
|
|
||||||
|
|
||||||
**Parameters**:
|
|
||||||
- `image`: PIL Image object
|
|
||||||
- `x` (int): X position (left edge)
|
|
||||||
- `y` (int): Y position (top edge)
|
|
||||||
|
|
||||||
**Example**:
|
|
||||||
```python
|
```python
|
||||||
from PIL import Image
|
from PIL import Image
|
||||||
logo = Image.open("assets/logo.png")
|
|
||||||
self.display_manager.draw_image(logo, x=10, y=10)
|
logo = Image.open("assets/logo.png").convert("RGB")
|
||||||
|
self.display_manager.image.paste(logo, (10, 10))
|
||||||
self.display_manager.update_display()
|
self.display_manager.update_display()
|
||||||
```
|
```
|
||||||
|
|
||||||
|
For transparency support, paste using a mask:
|
||||||
|
|
||||||
|
```python
|
||||||
|
icon = Image.open("assets/icon.png").convert("RGBA")
|
||||||
|
self.display_manager.image.paste(icon, (5, 5), icon)
|
||||||
|
self.display_manager.update_display()
|
||||||
|
```
|
||||||
|
|
||||||
|
This is the same pattern the bundled scoreboard base classes
|
||||||
|
(`src/base_classes/baseball.py`, `basketball.py`, `football.py`,
|
||||||
|
`hockey.py`) use, so it's the canonical way to render arbitrary images.
|
||||||
|
|
||||||
### Weather Icons
|
### Weather Icons
|
||||||
|
|
||||||
#### `draw_weather_icon(condition: str, x: int, y: int, size: int = 16) -> None`
|
#### `draw_weather_icon(condition: str, x: int, y: int, size: int = 16) -> None`
|
||||||
@@ -440,12 +542,23 @@ self.cache_manager.set("weather_data", {
|
|||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
#### `delete(key: str) -> None`
|
#### `clear_cache(key: Optional[str] = None) -> None`
|
||||||
|
|
||||||
Remove a specific cache entry.
|
Remove a specific cache entry, or all cache entries when called without
|
||||||
|
arguments.
|
||||||
|
|
||||||
**Parameters**:
|
**Parameters**:
|
||||||
- `key` (str): Cache key to delete
|
- `key` (str, optional): Cache key to delete. If omitted, every cached
|
||||||
|
entry (memory + disk) is cleared.
|
||||||
|
|
||||||
|
**Example**:
|
||||||
|
```python
|
||||||
|
# Drop one stale entry
|
||||||
|
self.cache_manager.clear_cache("weather_data")
|
||||||
|
|
||||||
|
# Nuke everything (rare — typically only used by maintenance tooling)
|
||||||
|
self.cache_manager.clear_cache()
|
||||||
|
```
|
||||||
|
|
||||||
### Advanced Methods
|
### Advanced Methods
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,24 @@
|
|||||||
# LEDMatrix Plugin Architecture Specification
|
# LEDMatrix Plugin Architecture Specification
|
||||||
|
|
||||||
|
> **Historical design document.** This spec was written *before* the
|
||||||
|
> plugin system was built. Most of it is still architecturally
|
||||||
|
> accurate, but specific details have drifted from the shipped
|
||||||
|
> implementation:
|
||||||
|
>
|
||||||
|
> - Code paths reference `web_interface_v2.py`; the current web UI is
|
||||||
|
> `web_interface/app.py` with v3 Blueprint-based templates.
|
||||||
|
> - The example Flask routes use `/api/plugins/*`; the real API
|
||||||
|
> blueprint is mounted at `/api/v3` (`web_interface/app.py:144`).
|
||||||
|
> - The default plugin location is `plugin-repos/` (configurable via
|
||||||
|
> `plugin_system.plugins_directory`), not `./plugins/`.
|
||||||
|
> - The "Migration Strategy" and "Implementation Roadmap" sections
|
||||||
|
> describe work that has now shipped.
|
||||||
|
>
|
||||||
|
> For the current system, see:
|
||||||
|
> [PLUGIN_DEVELOPMENT_GUIDE.md](PLUGIN_DEVELOPMENT_GUIDE.md),
|
||||||
|
> [PLUGIN_API_REFERENCE.md](PLUGIN_API_REFERENCE.md), and
|
||||||
|
> [REST_API_REFERENCE.md](REST_API_REFERENCE.md).
|
||||||
|
|
||||||
## Executive Summary
|
## Executive Summary
|
||||||
|
|
||||||
This document outlines the transformation of the LEDMatrix project into a modular, plugin-based architecture that enables user-created displays. The goal is to create a flexible, extensible system similar to Home Assistant Community Store (HACS) where users can discover, install, and manage custom display managers from GitHub repositories.
|
This document outlines the transformation of the LEDMatrix project into a modular, plugin-based architecture that enables user-created displays. The goal is to create a flexible, extensible system similar to Home Assistant Community Store (HACS) where users can discover, install, and manage custom display managers from GitHub repositories.
|
||||||
@@ -9,22 +28,22 @@ This document outlines the transformation of the LEDMatrix project into a modula
|
|||||||
1. **Gradual Migration**: Existing managers remain in core while new plugin infrastructure is built
|
1. **Gradual Migration**: Existing managers remain in core while new plugin infrastructure is built
|
||||||
2. **Migration Required**: Breaking changes with migration tools provided
|
2. **Migration Required**: Breaking changes with migration tools provided
|
||||||
3. **GitHub-Based Store**: Simple discovery system, packages served from GitHub repos
|
3. **GitHub-Based Store**: Simple discovery system, packages served from GitHub repos
|
||||||
4. **Plugin Location**: `./plugins/` directory in project root
|
4. **Plugin Location**: `./plugins/` directory in project root *(actual default is now `plugin-repos/`)*
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
1. [Current Architecture Analysis](#current-architecture-analysis)
|
1. [Current Architecture Analysis](#1-current-architecture-analysis)
|
||||||
2. [Plugin System Design](#plugin-system-design)
|
2. [Plugin System Design](#2-plugin-system-design)
|
||||||
3. [Plugin Store & Discovery](#plugin-store--discovery)
|
3. [Plugin Store & Discovery](#3-plugin-store--discovery)
|
||||||
4. [Web UI Transformation](#web-ui-transformation)
|
4. [Web UI Transformation](#4-web-ui-transformation)
|
||||||
5. [Migration Strategy](#migration-strategy)
|
5. [Migration Strategy](#5-migration-strategy)
|
||||||
6. [Plugin Developer Guidelines](#plugin-developer-guidelines)
|
6. [Plugin Developer Guidelines](#6-plugin-developer-guidelines)
|
||||||
7. [Technical Implementation Details](#technical-implementation-details)
|
7. [Technical Implementation Details](#7-technical-implementation-details)
|
||||||
8. [Best Practices & Standards](#best-practices--standards)
|
8. [Best Practices & Standards](#8-best-practices--standards)
|
||||||
9. [Security Considerations](#security-considerations)
|
9. [Security Considerations](#9-security-considerations)
|
||||||
10. [Implementation Roadmap](#implementation-roadmap)
|
10. [Implementation Roadmap](#10-implementation-roadmap)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -184,37 +184,45 @@ plugin-repos/
|
|||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
|
"id": "my-plugin",
|
||||||
"name": "My Plugin",
|
"name": "My Plugin",
|
||||||
"version": "1.0.0",
|
"version": "1.0.0",
|
||||||
"description": "Plugin description",
|
"description": "Plugin description",
|
||||||
"author": "Your Name",
|
"author": "Your Name",
|
||||||
|
"entry_point": "manager.py",
|
||||||
|
"class_name": "MyPlugin",
|
||||||
"display_modes": ["my_plugin"],
|
"display_modes": ["my_plugin"],
|
||||||
"config_schema": {
|
"config_schema": "config_schema.json"
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"enabled": {"type": "boolean", "default": false},
|
|
||||||
"update_interval": {"type": "integer", "default": 3600}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The required fields the plugin loader will check for are `id`,
|
||||||
|
`name`, `version`, `class_name`, and `display_modes`. `entry_point`
|
||||||
|
defaults to `manager.py` if omitted. `config_schema` must be a
|
||||||
|
**file path** (relative to the plugin directory) — the schema itself
|
||||||
|
lives in a separate JSON file, not inline in the manifest. The
|
||||||
|
`class_name` value must match the actual class defined in the entry
|
||||||
|
point file **exactly** (case-sensitive, no spaces); otherwise the
|
||||||
|
loader fails with `AttributeError` at load time.
|
||||||
|
|
||||||
### Plugin Manager Class
|
### Plugin Manager Class
|
||||||
|
|
||||||
```python
|
```python
|
||||||
from src.plugin_system.base_plugin import BasePlugin
|
from src.plugin_system.base_plugin import BasePlugin
|
||||||
|
|
||||||
class MyPluginManager(BasePlugin):
|
class MyPlugin(BasePlugin):
|
||||||
def __init__(self, config, display_manager, cache_manager, font_manager):
|
def __init__(self, plugin_id, config, display_manager, cache_manager, plugin_manager):
|
||||||
super().__init__(config, display_manager, cache_manager, font_manager)
|
super().__init__(plugin_id, config, display_manager, cache_manager, plugin_manager)
|
||||||
self.enabled = config.get('enabled', False)
|
# self.config, self.display_manager, self.cache_manager,
|
||||||
|
# self.plugin_manager, self.logger, and self.enabled are
|
||||||
|
# all set up by BasePlugin.__init__.
|
||||||
|
|
||||||
def update(self):
|
def update(self):
|
||||||
"""Update plugin data"""
|
"""Fetch/update data. Called based on update_interval."""
|
||||||
pass
|
pass
|
||||||
|
|
||||||
def display(self, force_clear=False):
|
def display(self, force_clear=False):
|
||||||
"""Display plugin content"""
|
"""Render plugin content to the LED matrix."""
|
||||||
pass
|
pass
|
||||||
|
|
||||||
def get_duration(self):
|
def get_duration(self):
|
||||||
|
|||||||