Compare commits
122 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 1ada5ac334 | |||
| e18d56c838 | |||
| 7728aecb4f | |||
| e28ab5a956 | |||
| 1e395fd09e | |||
| ffee156c17 | |||
| 02e2ea37f3 | |||
| fdc9201660 | |||
| 5686ae5468 | |||
| 9960f15a1b | |||
| 397a53ed1c | |||
| 1c1bbe2551 | |||
| 68040173c6 | |||
| 4bf3fe65db | |||
| 34db5de8c3 | |||
| 0be3f833df | |||
| 4b2e8fc5ec | |||
| 487259a96d | |||
| fd62db1720 | |||
| 669ae20824 | |||
| 6de61b965e | |||
| 12b40e6071 | |||
| 498854f04d | |||
| 15cfb821d3 | |||
| 2e51f46dfd | |||
| 05cf121666 | |||
| d505388f0e | |||
| 6aeda935f1 | |||
| a5effba553 | |||
| b83a72e63f | |||
| 0d840adfca | |||
| 1f959932c1 | |||
| 10eb24b2ce | |||
| 66b85b0175 | |||
| bc42604045 | |||
| 3645216669 | |||
| 85da2e538d | |||
| e4d24a02da | |||
| bb3a316e35 | |||
| 49c35a2ea0 | |||
| ef1f9eade2 | |||
| 8bdcc17799 | |||
| f591e258f7 | |||
| f6486f9b34 | |||
| 48dbdb90e9 | |||
| 003517247f | |||
| 888f8fd16e | |||
| ea7ee88490 | |||
| d38021f061 | |||
| 507e1385a6 | |||
| 907bdaf043 | |||
| 0dd8d430b9 | |||
| fd46c51dba | |||
| ddae5719cf | |||
| 898912f8b1 | |||
| 45d12b2811 | |||
| 826e680f37 | |||
| 737fd72b73 | |||
| 3fe66d80cb | |||
| f03cb303c3 | |||
| 9ff83bd6ca | |||
| d6cc80074d | |||
| 06273ba2bc | |||
| 628c6b2f0d | |||
| 2f15fbb752 | |||
| c1aa2ebec5 | |||
| 3b8f00e3f9 | |||
| 05f73eedf9 | |||
| 9f3f346543 | |||
| 98fb61d932 | |||
| 5fec8db901 | |||
| 97dae2cd62 | |||
| 29bdacf69a | |||
| 563cbac88c | |||
| e24f9d33cc | |||
| e4bf58da19 | |||
| f1b0f0eab2 | |||
| 17684afba1 | |||
| 0e3ae78de7 | |||
| 7736bc6f58 | |||
| 390d2b472c | |||
| cc87fba0dd | |||
| 426484adf8 | |||
| 2f31680823 | |||
| 31c6c3abb2 | |||
| 887131d4af | |||
| 8f9d490063 | |||
| ede627b4ac | |||
| 4b65005823 | |||
| 8f1140abad | |||
| 337984c618 | |||
| 530316c2c3 | |||
| 6e4c1b6642 | |||
| ee4fa81376 | |||
| f184ef0afb | |||
| ad84b60ae4 | |||
| cdf7d94652 | |||
| 09792a9a05 | |||
| 75ca487be1 | |||
| e65dcb41f4 | |||
| 6a07a6b1a2 | |||
| 0f5850ef80 | |||
| a79f4bf73c | |||
| ced72fc864 | |||
| 49ddabbc36 | |||
| a026f0b349 | |||
| 5ef6ac1317 | |||
| 0980cf4dde | |||
| fdac26b9d9 | |||
| 816a27db73 | |||
| 797b806972 | |||
| 9d4a534ec6 | |||
| 51eebf21d5 | |||
| 9067db2639 | |||
| 233b463ac3 | |||
| de13f44f24 | |||
| 1c9acc5afb | |||
| a56569b02f | |||
| ccf4406349 | |||
| 8aa3a323d6 | |||
| 8e109f32b9 | |||
| 033c1f6a92 |
@@ -54,6 +54,17 @@ jobs:
|
|||||||
echo "is_release=$IS_RELEASE" >> "$GITHUB_OUTPUT"
|
echo "is_release=$IS_RELEASE" >> "$GITHUB_OUTPUT"
|
||||||
echo "Build label: $LABEL (release=$IS_RELEASE)"
|
echo "Build label: $LABEL (release=$IS_RELEASE)"
|
||||||
|
|
||||||
|
- name: Guard release tag against missing keystore
|
||||||
|
# Release tags MUST produce a release-signed APK, otherwise existing
|
||||||
|
# installs can't upgrade (signature mismatch). Fail loudly instead
|
||||||
|
# of silently falling back to the debug signing config.
|
||||||
|
# Runs before JDK/Python/SDK/NDK setup so a misconfigured release
|
||||||
|
# tag fails in seconds instead of after several minutes of setup.
|
||||||
|
if: ${{ steps.label.outputs.is_release == 'true' && env.ANDROID_KEYSTORE_BASE64 == '' }}
|
||||||
|
run: |
|
||||||
|
echo "::error::Release tag ${{ gitea.ref_name }} requires ANDROID_KEYSTORE_BASE64 (plus KEYSTORE_PASSWORD, KEY_ALIAS, KEY_PASSWORD) to be configured in Gitea → Settings → Secrets."
|
||||||
|
exit 1
|
||||||
|
|
||||||
- name: Setup JDK ${{ env.JAVA_VERSION }}
|
- name: Setup JDK ${{ env.JAVA_VERSION }}
|
||||||
uses: actions/setup-java@v4
|
uses: actions/setup-java@v4
|
||||||
with:
|
with:
|
||||||
@@ -122,15 +133,6 @@ jobs:
|
|||||||
echo "path=$(pwd)/android/keystore/release.jks" >> "$GITHUB_OUTPUT"
|
echo "path=$(pwd)/android/keystore/release.jks" >> "$GITHUB_OUTPUT"
|
||||||
echo "present=true" >> "$GITHUB_OUTPUT"
|
echo "present=true" >> "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
- name: Guard release tag against missing keystore
|
|
||||||
# Release tags MUST produce a release-signed APK, otherwise existing
|
|
||||||
# installs can't upgrade (signature mismatch). Fail loudly instead
|
|
||||||
# of silently falling back to the debug signing config.
|
|
||||||
if: ${{ steps.label.outputs.is_release == 'true' && steps.keystore.outputs.present != 'true' }}
|
|
||||||
run: |
|
|
||||||
echo "::error::Release tag ${{ gitea.ref_name }} requires ANDROID_KEYSTORE_BASE64 (plus KEYSTORE_PASSWORD, KEY_ALIAS, KEY_PASSWORD) to be configured in Gitea → Settings → Secrets."
|
|
||||||
exit 1
|
|
||||||
|
|
||||||
- name: Build APK
|
- name: Build APK
|
||||||
working-directory: android
|
working-directory: android
|
||||||
env:
|
env:
|
||||||
|
|||||||
@@ -98,6 +98,9 @@ jobs:
|
|||||||
print(json.dumps('\n\n'.join(sections)))
|
print(json.dumps('\n\n'.join(sections)))
|
||||||
")
|
")
|
||||||
|
|
||||||
|
# Created as draft so the release isn't user-visible until every
|
||||||
|
# build job has attached its assets. The publish-release job at
|
||||||
|
# the end of the workflow flips draft=false once all builds pass.
|
||||||
RELEASE=$(curl -s -X POST "$BASE_URL/releases" \
|
RELEASE=$(curl -s -X POST "$BASE_URL/releases" \
|
||||||
-H "Authorization: token $GITEA_TOKEN" \
|
-H "Authorization: token $GITEA_TOKEN" \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
@@ -105,7 +108,7 @@ jobs:
|
|||||||
\"tag_name\": \"$TAG\",
|
\"tag_name\": \"$TAG\",
|
||||||
\"name\": \"LedGrab $TAG\",
|
\"name\": \"LedGrab $TAG\",
|
||||||
\"body\": $BODY_JSON,
|
\"body\": $BODY_JSON,
|
||||||
\"draft\": false,
|
\"draft\": true,
|
||||||
\"prerelease\": $IS_PRE
|
\"prerelease\": $IS_PRE
|
||||||
}")
|
}")
|
||||||
|
|
||||||
@@ -350,3 +353,25 @@ jobs:
|
|||||||
if ! echo "$TAG" | grep -qE '(alpha|beta|rc)'; then
|
if ! echo "$TAG" | grep -qE '(alpha|beta|rc)'; then
|
||||||
docker push "$REGISTRY:latest"
|
docker push "$REGISTRY:latest"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
# ── Publish the release (flip draft=false) ─────────────────
|
||||||
|
# Runs only after every build job succeeded so users never see a
|
||||||
|
# release that's missing artifacts or sha256 sidecars (the in-app
|
||||||
|
# updater refuses to install without them).
|
||||||
|
publish-release:
|
||||||
|
needs: [create-release, build-windows, build-linux, build-docker]
|
||||||
|
if: github.event_name == 'push' && success()
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Promote draft release to published
|
||||||
|
env:
|
||||||
|
GITEA_TOKEN: ${{ secrets.DEPLOY_TOKEN }}
|
||||||
|
run: |
|
||||||
|
RELEASE_ID="${{ needs.create-release.outputs.release_id }}"
|
||||||
|
BASE_URL="${{ gitea.server_url }}/api/v1/repos/${{ gitea.repository }}"
|
||||||
|
|
||||||
|
curl -s -X PATCH "$BASE_URL/releases/$RELEASE_ID" \
|
||||||
|
-H "Authorization: token $GITEA_TOKEN" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d '{"draft": false}'
|
||||||
|
echo "Published release $RELEASE_ID"
|
||||||
|
|||||||
@@ -5,9 +5,15 @@ on:
|
|||||||
branches: [master]
|
branches: [master]
|
||||||
pull_request:
|
pull_request:
|
||||||
branches: [master]
|
branches: [master]
|
||||||
|
# Allow manual runs (e.g. to validate after a release commit was skipped).
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
test:
|
test:
|
||||||
|
# Skip release-publishing commits — version bumps don't affect lint/tests
|
||||||
|
# and the release.yml pipeline is already running. PRs and manual dispatch
|
||||||
|
# always run.
|
||||||
|
if: ${{ github.event_name != 'push' || !startsWith(github.event.head_commit.message, 'chore: release') }}
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
|
|||||||
@@ -95,3 +95,8 @@ tmp/
|
|||||||
# OS
|
# OS
|
||||||
Thumbs.db
|
Thumbs.db
|
||||||
.DS_Store
|
.DS_Store
|
||||||
|
# Added by code-review-graph
|
||||||
|
.code-review-graph/
|
||||||
|
|
||||||
|
# vex semantic-search embedding cache (auto-downloaded on first --semantic run)
|
||||||
|
.fastembed_cache/
|
||||||
|
|||||||
@@ -0,0 +1,12 @@
|
|||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"code-review-graph": {
|
||||||
|
"command": "uvx",
|
||||||
|
"args": [
|
||||||
|
"code-review-graph",
|
||||||
|
"serve"
|
||||||
|
],
|
||||||
|
"type": "stdio"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -6,7 +6,10 @@ repos:
|
|||||||
args: [--line-length=100, --target-version=py311]
|
args: [--line-length=100, --target-version=py311]
|
||||||
|
|
||||||
- repo: https://github.com/astral-sh/ruff-pre-commit
|
- repo: https://github.com/astral-sh/ruff-pre-commit
|
||||||
rev: v0.8.0
|
# Bumped from v0.8.0 so the hook recognises UP045
|
||||||
|
# (non-pep604-annotation-optional), which the v0.13+ ruff split off
|
||||||
|
# from UP007. Pyproject.toml extend-selects both rules.
|
||||||
|
rev: v0.15.12
|
||||||
hooks:
|
hooks:
|
||||||
- id: ruff
|
- id: ruff
|
||||||
args: [--line-length=100, --target-version=py311]
|
args: [--line-length=100, --target-version=py311]
|
||||||
|
|||||||
@@ -0,0 +1,24 @@
|
|||||||
|
# vex configuration — https://github.com/tenatarika/vex
|
||||||
|
#
|
||||||
|
# Place this file in your project root as .vex.toml
|
||||||
|
|
||||||
|
# Glob patterns to exclude from indexing (gitignore syntax, on top of .gitignore)
|
||||||
|
# exclude = [
|
||||||
|
# "vendor/**",
|
||||||
|
# "node_modules/**",
|
||||||
|
# "*.generated.go",
|
||||||
|
# "dist/**",
|
||||||
|
# ]
|
||||||
|
|
||||||
|
# Default output format: "text", "json", or "compact"
|
||||||
|
# format = "text"
|
||||||
|
|
||||||
|
# Enable semantic embeddings by default (slower indexing, enables meaning-based search)
|
||||||
|
semantic = true
|
||||||
|
|
||||||
|
# Automatically run `vex update` before search if the index is stale
|
||||||
|
auto_update = true
|
||||||
|
|
||||||
|
# Embedder used for semantic indexing. Known IDs: minilm-l6-v2 (default).
|
||||||
|
# Changing the embedder requires a full reindex.
|
||||||
|
# embedder = "minilm-l6-v2"
|
||||||
@@ -0,0 +1,428 @@
|
|||||||
|
# LedGrab Architecture Audit — Remaining Items
|
||||||
|
|
||||||
|
Roadmap for the architecture-audit refactor sprint that started 2026-05-22.
|
||||||
|
This file lists every audit finding that is **not yet addressed**; the ones
|
||||||
|
already landed in commits `563cbac..2f15fbb` are summarised below for
|
||||||
|
context.
|
||||||
|
|
||||||
|
## Already done (10 commits)
|
||||||
|
|
||||||
|
| Commit | Findings addressed |
|
||||||
|
|---|---|
|
||||||
|
| `563cbac` | C2, C11, C1 (parallel-change only), C3, C4, C6, C7-streams |
|
||||||
|
| `29bdacf` | C5 (HA/Z2M swap helper; full ABC deferred) |
|
||||||
|
| `97dae2c` | H1 |
|
||||||
|
| `5fec8db` | M4 |
|
||||||
|
| `98fb61d` | H2 |
|
||||||
|
| `9f3f346` | M5 |
|
||||||
|
| `05f73ee` | H6 (bindable extraction only) |
|
||||||
|
| `3b8f00e` + `c1aa2eb` | C7 store-side |
|
||||||
|
| `2f15fbb` | H3 |
|
||||||
|
| _uncommitted (2026-05-27 autonomous pass)_ | H6-rest, H8, M7 (foundation + 3 reference files) |
|
||||||
|
|
||||||
|
All commits have ≥1 code-review subagent pass with HIGH findings fixed
|
||||||
|
before commit. Tests pass on each commit; ruff clean; tsc + bundle build
|
||||||
|
clean for the frontend commit.
|
||||||
|
|
||||||
|
The two CRITICAL **data-safety** items (C2 silent CSS fallback, C11
|
||||||
|
string-replace JSON migration) are fixed. The two CRITICAL
|
||||||
|
**parallel-change** problems for color-strip + value-source dispatch are
|
||||||
|
fixed. The two HIGH dispatch problems (H1 effects, H2 rules) are fixed.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Remaining backend items
|
||||||
|
|
||||||
|
### HIGH
|
||||||
|
|
||||||
|
#### H4 — `Device.__init__` 40+ params mixing per-type fields
|
||||||
|
|
||||||
|
**File:** `server/src/ledgrab/storage/device_store.py:46-150`
|
||||||
|
|
||||||
|
The `Device` dataclass constructor accepts ~40 parameters that mix common
|
||||||
|
fields with DMX-only / DDP-only / Hue-only / Yeelight-only / Wiz-only /
|
||||||
|
LIFX-only / Govee-only / Nanoleaf-only / SPI-only / Chroma-only /
|
||||||
|
GameSense-only fields. Setting `hue_username` on a WLED device is
|
||||||
|
silently ignored.
|
||||||
|
|
||||||
|
**Approach:** introduce per-device-type config dataclasses
|
||||||
|
(`DmxConfig`, `HueConfig`, `DdpConfig`, …) and make `Device.config` a
|
||||||
|
discriminated union. Per-type validation moves to the config classes.
|
||||||
|
Wire migration: every existing device row needs to be re-parsed; use the
|
||||||
|
versioned `MigrationRunner` introduced in Phase 1.2.
|
||||||
|
|
||||||
|
**Risk:** medium-high. Touches:
|
||||||
|
- `storage/device_store.py` — Device dataclass, `from_dict`, `to_dict`,
|
||||||
|
`create_device`, `update_device`
|
||||||
|
- `api/schemas/devices.py` — Pydantic schemas
|
||||||
|
- `api/routes/devices.py` — request validation
|
||||||
|
- `core/devices/*` — every provider reads device fields
|
||||||
|
- A new migration to translate flat fields → nested `config`
|
||||||
|
|
||||||
|
**Estimated scope:** ~1500 LOC diff, 1-2 dedicated sessions.
|
||||||
|
|
||||||
|
#### H5 — `WledTargetProcessor` god class (32 methods, 5 responsibilities)
|
||||||
|
|
||||||
|
**File:** `server/src/ledgrab/core/processing/wled_target_processor.py` (1238 LOC)
|
||||||
|
|
||||||
|
Conflates:
|
||||||
|
1. Device connectivity (probe, liveness, reconnect)
|
||||||
|
2. FPS negotiation (adaptive_fps, keepalive_interval, state_check_interval)
|
||||||
|
3. LED resampling (`_fit_to_device` — 60 lines of numpy)
|
||||||
|
4. Preview WebSocket fanout (`_preview_clients`, `_broadcast_led_preview`)
|
||||||
|
5. Metrics emission (`get_state`, `get_metrics`)
|
||||||
|
|
||||||
|
**Approach:** extract `WledDeviceConnector`, `WledPixelSender`,
|
||||||
|
`TargetFitProcessor`, `TargetPreviewBroadcaster`, `TargetMetricsCollector`.
|
||||||
|
`WledTargetProcessor` becomes an orchestrator that composes them.
|
||||||
|
|
||||||
|
**Risk:** HIGHEST in the audit. This class drives physical LED hardware
|
||||||
|
in production. A regression caught at runtime (in the user's living
|
||||||
|
room) is the expensive failure mode. Needs manual verification with at
|
||||||
|
least one real WLED device after the refactor.
|
||||||
|
|
||||||
|
**Coupled with:** C5 (HA/Z2M shared the same shape; should extract a
|
||||||
|
common `BaseTargetProcessor` ABC at the same time so all three
|
||||||
|
processors share lifecycle / preview / metrics code).
|
||||||
|
|
||||||
|
**Estimated scope:** ~2000 LOC diff, 2-3 dedicated sessions, with manual
|
||||||
|
device testing after each.
|
||||||
|
|
||||||
|
#### H7 — `device-discovery.ts` 1745 LOC
|
||||||
|
|
||||||
|
Frontend mirror of H4. The `onDeviceTypeChanged` handler has a giant
|
||||||
|
switch with 15+ device kinds and 15+ `_showXxxFields` / `_buildXxxItems`
|
||||||
|
helpers. Adding a device type requires editing 5 separate frontend hooks.
|
||||||
|
|
||||||
|
**Approach:** mirror the H4 backend redesign — once the storage layer
|
||||||
|
has per-type config objects, the frontend can have a per-type field-set
|
||||||
|
registry. Best done **after** H4 lands so the schemas drive the
|
||||||
|
registry.
|
||||||
|
|
||||||
|
**Estimated scope:** 1-2 sessions; coupled to H4.
|
||||||
|
|
||||||
|
#### H8 — `automations.ts` 1410 LOC — ✅ DONE (uncommitted, 2026-05-27)
|
||||||
|
|
||||||
|
Frontend mirror of H2 (rule polymorphism). Already addressed on the
|
||||||
|
backend in `98fb61d`; the frontend dispatch on `RuleType` was
|
||||||
|
hand-rolled.
|
||||||
|
|
||||||
|
**Done:** the two remaining hand-rolled dispatch ladders were converted
|
||||||
|
to registries keyed by `RuleType`, alongside the pre-existing
|
||||||
|
`RULE_CHIP_RENDERERS`:
|
||||||
|
- `RULE_FIELD_RENDERERS` — the `renderFields` if/elif ladder was
|
||||||
|
extracted into module-level `_renderXxxFields(container, data)`
|
||||||
|
functions (they only ever closed over `container`); the in-row
|
||||||
|
`renderFields` is now a 3-line dispatcher.
|
||||||
|
- `RULE_COLLECTORS` — the `getAutomationEditorRules` if/elif ladder
|
||||||
|
became per-type collectors; the loop is now a registry lookup.
|
||||||
|
- All three registries are typed `Record<RuleType, …>` (compile-time
|
||||||
|
exhaustiveness) and an import-time `_assertRuleHandlerCoverage()`
|
||||||
|
logs loudly if any registry drifts from `RULE_TYPE_KEYS`. (Frontend
|
||||||
|
logs rather than throws — a thrown error at import would brick the
|
||||||
|
whole bundle, not just the editor — the one intentional divergence
|
||||||
|
from the backend's raising `_assert_rule_handler_coverage`.)
|
||||||
|
|
||||||
|
Adding a new rule type now means: one entry in `RULE_TYPE_KEYS`,
|
||||||
|
`RULE_TYPE_ICONS`, and each of the three registries — and tsc + the
|
||||||
|
coverage check flag any omission.
|
||||||
|
|
||||||
|
Verified: tsc + bundle build clean; typescript-reviewer APPROVE (the
|
||||||
|
extracted renderer bodies are byte-identical to the originals; no stray
|
||||||
|
closure captures; http_poll widget-stash + HA entity loading preserved).
|
||||||
|
|
||||||
|
### MEDIUM
|
||||||
|
|
||||||
|
#### M1 — `ProcessorManager.add_target` shotgun (11 args, WLED-leak)
|
||||||
|
|
||||||
|
**File:** `server/src/ledgrab/core/processing/processor_manager.py:396`
|
||||||
|
|
||||||
|
Method is named generically (`add_target`) but accepts `protocol="ddp"`
|
||||||
|
and `keepalive_interval` — WLED-only fields. HA and Z2M have sibling
|
||||||
|
methods with their own bespoke params.
|
||||||
|
|
||||||
|
**Approach:** extract a `TargetFactory` (per-kind builders, similar to
|
||||||
|
`value_source_factories.py` from Phase 7). Couple with H5/C5 work.
|
||||||
|
|
||||||
|
#### M2 — `TargetContext` god-bag
|
||||||
|
|
||||||
|
**File:** `server/src/ledgrab/core/processing/processor_manager.py`
|
||||||
|
|
||||||
|
`@dataclass TargetContext` exposes ~8 attributes (device_store,
|
||||||
|
color_strip_stream_manager, value_stream_manager, metrics_history,
|
||||||
|
mqtt_manager, ha_manager, …). Processors silently depend on whichever
|
||||||
|
fields they read. Tests have to construct a huge mock context.
|
||||||
|
|
||||||
|
**Approach:** make per-processor explicit dependency injection. Couple
|
||||||
|
with H5 work.
|
||||||
|
|
||||||
|
#### M3 — Validation duplicated across layers
|
||||||
|
|
||||||
|
Field-level constraints (composite nesting depth, name uniqueness, span
|
||||||
|
ranges) are enforced in route + schema + store. Adding a new constraint
|
||||||
|
means editing 3 places.
|
||||||
|
|
||||||
|
**Approach:** move all validation to the model/schema layer (Pydantic
|
||||||
|
validators + dataclass `__post_init__`). Routes trust the schema; store
|
||||||
|
trusts the model.
|
||||||
|
|
||||||
|
**Risk:** moderate — cross-cutting; needs careful review of which layer
|
||||||
|
currently owns which constraint.
|
||||||
|
|
||||||
|
#### M6 — `ws_stream.py` mixed concerns (699 LOC)
|
||||||
|
|
||||||
|
**File:** `server/src/ledgrab/api/routes/color_strip_sources/ws_stream.py`
|
||||||
|
|
||||||
|
The worst part (stream-creation dispatch) was fixed in Phase 2.1 — it
|
||||||
|
now calls `color_strip_kinds.build_stream(source, deps)`. The remaining
|
||||||
|
699 lines mix config parsing + WebSocket lifecycle + frame loop. Could
|
||||||
|
extract the frame loop into a separate `PreviewFrameLoop` class.
|
||||||
|
|
||||||
|
**Estimated scope:** half a session. Low impact since the parallel-change
|
||||||
|
problem is already fixed.
|
||||||
|
|
||||||
|
#### M7 — No shared frontend API client — 🟡 FOUNDATION DONE (uncommitted, 2026-05-27)
|
||||||
|
|
||||||
|
**File:** every `static/js/features/*.ts`
|
||||||
|
|
||||||
|
`fetchWithAuth(...)` + bespoke error-unwrapping is copy-pasted in every
|
||||||
|
feature's save / load function. ~45 files, ~243 call sites.
|
||||||
|
|
||||||
|
**Done:** `static/js/core/api-client.ts` now provides typed
|
||||||
|
`apiGet` / `apiPost` / `apiPut` / `apiPatch` / `apiDelete` that wrap
|
||||||
|
`fetchWithAuth` (so auth, 401-relogin, retry, timeout, and the offline
|
||||||
|
toast are unchanged) and collapse the repeated
|
||||||
|
`if (!resp.ok) { detail || HTTP <status> } … resp.json()` dance into one
|
||||||
|
call returning a typed body and throwing `ApiError` on failure. The
|
||||||
|
`detail` unwrap is hardened to join FastAPI validation arrays instead of
|
||||||
|
stringifying to `[object Object]`. **35 feature/core files migrated**
|
||||||
|
(covers GET/POST/PUT/DELETE, typed response bodies, custom i18n error
|
||||||
|
messages, silent-failure GETs, bulk `Promise.allSettled` deletes,
|
||||||
|
inline-error saves, array-`detail` joins, fire-and-forget POSTs, and
|
||||||
|
local catch handling) — reviewer-approved for behaviour parity across
|
||||||
|
the riskier divergences. Migrated files include the integration sources
|
||||||
|
(weather / HA / MQTT / HTTP), the template families (capture / audio /
|
||||||
|
audio-processing / pattern), the scene-preset CRUD, the simple-CRUD
|
||||||
|
entity files (sync-clocks / audio-sources / game-integration /
|
||||||
|
gradient / displays / device-discovery), the light-target editors
|
||||||
|
(z2m / ha), the preferences modules (dashboard-layout / card-modes /
|
||||||
|
notifications-watcher), the calibration editors (simple + advanced),
|
||||||
|
the entire `automations.ts` and `devices.ts` CRUD surfaces, and several
|
||||||
|
core utilities (`api-client.ts` itself, `cache.ts`, `command-palette.ts`,
|
||||||
|
`graph-connections.ts`, `tag-input.ts`, `process-picker.ts`,
|
||||||
|
`perf-charts.ts`, `icon-picker.ts`, `update.ts`, `integrations.ts`).
|
||||||
|
|
||||||
|
Also added **14 new locale keys** (en / ru / zh) so the fallback
|
||||||
|
messages the migration surfaces — `pattern.error.save_failed`,
|
||||||
|
`audio_processing.error.save_failed`, `audio_template.error.save_failed`,
|
||||||
|
`audio_template.error.load_failed`, `templates.error.save_failed`,
|
||||||
|
`templates.error.load_failed`, `gradient.error.save_failed`,
|
||||||
|
`target.error.load_failed`, `device.error.load_failed`,
|
||||||
|
`automations.error.{load,save,delete,toggle}_failed`, plus
|
||||||
|
`gradient.error.delete_failed` for ru/zh — are translated instead of
|
||||||
|
hardcoded English. A scan confirms **no `errorMessage: '<English>'`
|
||||||
|
strings remain** in the migrated diff.
|
||||||
|
|
||||||
|
**Remaining:** 9 feature files (~94 call sites). All but one are the
|
||||||
|
big god-modules whose migration is best done as part of their C8/C9/C10
|
||||||
|
splits: `streams.ts` (18), `settings.ts` (18), `targets.ts` (16),
|
||||||
|
`dashboard.ts` (15), `color-strips/index.ts` (8), `graph-editor.ts` (7),
|
||||||
|
`assets.ts` (6 — also blocked by multipart upload + blob download paths
|
||||||
|
that legitimately bypass the JSON client), and `value-sources.ts` (5).
|
||||||
|
The lone leaf file still on `fetchWithAuth` is `pairing-flow.ts` (1) —
|
||||||
|
its branching on raw `Response.status` codes (200 / 409 / 4xx) doesn't
|
||||||
|
fit the api-client contract, so it stays on raw fetch by design.
|
||||||
|
Migration is mechanical but **not** a blind find/replace — each site
|
||||||
|
carries its own localised error key that must be preserved as the
|
||||||
|
`errorMessage` option, and binary/multipart endpoints (e.g.
|
||||||
|
`assets.ts` file upload / blob download) must stay on raw
|
||||||
|
`fetchWithAuth` (the client is JSON-only). Each migrated file ideally
|
||||||
|
gets manual UI smoke-testing. **Behaviour note:** migrated GET sites now
|
||||||
|
prefer the server's `detail` over the generic localised fallback when
|
||||||
|
present — matching what the write paths already did; intended, but
|
||||||
|
user-visible.
|
||||||
|
|
||||||
|
#### M8 — Global `_cached*` `let` vars
|
||||||
|
|
||||||
|
Mutable module-level state mutated from multiple feature modules. No
|
||||||
|
subscription model — features manually `invalidate()` after CRUD.
|
||||||
|
|
||||||
|
**Approach:** introduce a reactive cache (EventEmitter pattern or a tiny
|
||||||
|
store like Nano Stores). Couple with M7 (the API client can drive cache
|
||||||
|
invalidation on write).
|
||||||
|
|
||||||
|
#### M9 — `dashboard.ts` 1421 LOC
|
||||||
|
|
||||||
|
Frontend god-module orchestrating + rendering device / target / CSS
|
||||||
|
cards. Couple with C8/C9/C10 frontend split work.
|
||||||
|
|
||||||
|
#### M10 — Duplicate frontend modal classes
|
||||||
|
|
||||||
|
`ValueSourceModal`, `StreamEditorModal`, `TargetEditorModal`,
|
||||||
|
`AddDeviceModal`, etc. each reimplement pristine-check / undo / focus
|
||||||
|
management.
|
||||||
|
|
||||||
|
**Approach:** introduce a `FormModal<T>` base class.
|
||||||
|
|
||||||
|
#### M11 — Hardcoded `_getSectionForSource` / `_getTabForSource`
|
||||||
|
|
||||||
|
Routing tables duplicated across multiple feature files (streams.ts,
|
||||||
|
value-sources.ts). Adding a new stream type requires hunting strings.
|
||||||
|
|
||||||
|
**Approach:** single routing registry keyed by source_type.
|
||||||
|
|
||||||
|
#### M12 — Late imports masking cycles
|
||||||
|
|
||||||
|
Partially addressed by the kind registries (Phase 2.1, 2.2). Some
|
||||||
|
late-imports still exist in `value_stream.py`, `audio_stream.py`, the
|
||||||
|
target processors. Resolving them requires restructuring module layout
|
||||||
|
to break the circular dependencies.
|
||||||
|
|
||||||
|
**Estimated scope:** small follow-up after H5.
|
||||||
|
|
||||||
|
### LOW
|
||||||
|
|
||||||
|
#### L1 — `(src as any).field` casts in `value-sources.ts`
|
||||||
|
|
||||||
|
Discriminated unions aren't narrowed properly. Couple with C8 frontend
|
||||||
|
split.
|
||||||
|
|
||||||
|
#### L2 — Mutable state without locks
|
||||||
|
|
||||||
|
`_preview_clients`, `_last_preview_data`, `_color_stream`,
|
||||||
|
`_css_stream` are mutated from multiple async tasks without explicit
|
||||||
|
locks. Production has not exhibited issues but the contract is fragile.
|
||||||
|
|
||||||
|
**Approach:** add explicit `asyncio.Lock` per processor. Couple with H5.
|
||||||
|
|
||||||
|
#### L3 — `Calibration.validate()` raises instead of returning result
|
||||||
|
|
||||||
|
**File:** `server/src/ledgrab/core/capture/calibration.py:164`
|
||||||
|
|
||||||
|
All 4 call sites currently rely on the raise; converting to
|
||||||
|
`ValidationResult` would force every caller to check a return value
|
||||||
|
without adding safety. **Recommendation:** skip — current design is
|
||||||
|
appropriate.
|
||||||
|
|
||||||
|
#### L4 — `_SOURCE_TYPE_MAP` is module-private
|
||||||
|
|
||||||
|
No public `GET /api/v1/source-types` discovery endpoint. Frontend
|
||||||
|
hardcodes the list of source types in `types.ts`.
|
||||||
|
|
||||||
|
**Approach:** add a discovery route + matching frontend fetch. Couple
|
||||||
|
with H6 frontend split (since `types.ts` is involved).
|
||||||
|
|
||||||
|
#### L5 — `AudioValueStream` implicit state machine
|
||||||
|
|
||||||
|
**File:** `server/src/ledgrab/core/processing/value_stream.py:169-383`
|
||||||
|
|
||||||
|
`get_value()` can be called before `start()`; transitions are implicit.
|
||||||
|
**Approach:** explicit State pattern. Low value (production callers
|
||||||
|
always start before reading).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Remaining frontend items (all)
|
||||||
|
|
||||||
|
### CRITICAL
|
||||||
|
|
||||||
|
- **C8** — `value-sources.ts` 1972 LOC (4 god-functions, type-dispatch ladders)
|
||||||
|
- **C9** — `graph-editor.ts` 2707 LOC (layout + interaction + state + WS sync + …)
|
||||||
|
- **C10** — `streams.ts` 2341 LOC (picture / audio / template kitchen-sink)
|
||||||
|
|
||||||
|
### Other frontend (severity in main list above)
|
||||||
|
|
||||||
|
- **H6 rest** — ✅ DONE (uncommitted, 2026-05-27): `types.ts` (1140 LOC)
|
||||||
|
split into 18 per-entity files under `types/` (joining the existing
|
||||||
|
`bindable.ts`); `types.ts` is now a ~200-line pure re-export barrel, so
|
||||||
|
every `import { … } from '../types.ts'` still resolves. Reviewer
|
||||||
|
confirmed all 102 exported symbols preserved, none renamed.
|
||||||
|
- **H7** — `device-discovery.ts` 1745 LOC (couple with H4)
|
||||||
|
- **H8** — `automations.ts` 1410 LOC (mirror H2)
|
||||||
|
- **M7** — shared API client
|
||||||
|
- **M8** — reactive cache
|
||||||
|
- **M9** — `dashboard.ts` 1421 LOC
|
||||||
|
- **M10** — `FormModal<T>` base
|
||||||
|
- **M11** — routing registry
|
||||||
|
- **L1** — narrowing the discriminated unions
|
||||||
|
|
||||||
|
The frontend remainder is **multi-day work** even when broken up by
|
||||||
|
finding. Recommended approach: a dedicated frontend sprint with the
|
||||||
|
typescript-reviewer agent + manual UI testing for each god-module
|
||||||
|
split. Order:
|
||||||
|
|
||||||
|
1. Finish `types.ts` split (H6) — pure organisation, low risk, unblocks
|
||||||
|
the rest
|
||||||
|
2. Introduce API client (M7) — every feature file gains a cleaner shape
|
||||||
|
3. Split `value-sources.ts` (C8) — uses the API client + per-type
|
||||||
|
registry pattern
|
||||||
|
4. Split `streams.ts` (C10)
|
||||||
|
5. Split `graph-editor.ts` (C9) — needs the most care; the file owns
|
||||||
|
the entire visual editor
|
||||||
|
6. Polish: `dashboard.ts` (M9), `device-discovery.ts` (H7),
|
||||||
|
`automations.ts` (H8), `FormModal` (M10), routing registry (M11),
|
||||||
|
reactive cache (M8), narrowing (L1)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Recommended ordering for future sessions
|
||||||
|
|
||||||
|
### Session A — Frontend sprint (multi-day)
|
||||||
|
|
||||||
|
Address H6-rest, C8, C9, C10, H7, H8, M7-M11, L1. See order above.
|
||||||
|
Critical to have typescript-reviewer feedback + manual UI testing after
|
||||||
|
each split.
|
||||||
|
|
||||||
|
> **Progress (2026-05-27, uncommitted):** steps 1 & 2 of the order above
|
||||||
|
> are done — H6-rest (`types.ts` split) and M7-foundation (`api-client.ts`
|
||||||
|
> + 3 reference migrations). H8 (automations registry) also landed. Still
|
||||||
|
> open: C8, C9, C10, H7, the remaining ~40 M7 file migrations, M8-M11, L1.
|
||||||
|
> Next per the order: introduce the API client everywhere (finish M7),
|
||||||
|
> then split `value-sources.ts` (C8).
|
||||||
|
|
||||||
|
### Session B — Device redesign (1-2 sessions)
|
||||||
|
|
||||||
|
Address H4 alone. Touches device storage + provider classes; needs a
|
||||||
|
data migration. Once H4 lands, H7 frontend mirror can follow.
|
||||||
|
|
||||||
|
### Session C — BaseTargetProcessor ABC (2-3 sessions)
|
||||||
|
|
||||||
|
Address C5 (full) + H5 + M1 + M2 + L2 together. Highest risk in the
|
||||||
|
audit because it drives physical LED hardware. Each step needs manual
|
||||||
|
verification with a real device.
|
||||||
|
|
||||||
|
### Session D — Polish (half a session)
|
||||||
|
|
||||||
|
Address M3, M6 (remainder), M12 (remainder), L3 (decision: skip), L4,
|
||||||
|
L5.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Pattern reference for new contributors
|
||||||
|
|
||||||
|
Three registry-pattern templates that already exist in the codebase and
|
||||||
|
should be the model for the remaining dispatch ladders:
|
||||||
|
|
||||||
|
1. **Class-level handler dict + import-time coverage assertion**
|
||||||
|
- `core/processing/effect_stream.py::_RENDERERS`
|
||||||
|
(`@_effect_renderer` decorator + `@_collect_effect_renderers`
|
||||||
|
class decorator)
|
||||||
|
- `core/automations/automation_engine.py::AutomationEngine._RULE_HANDLERS`
|
||||||
|
(module-level binding after class definition)
|
||||||
|
- `api/routes/output_targets.py::_TARGET_RESPONSE_BUILDERS`
|
||||||
|
(response-shape dispatch keyed by storage class)
|
||||||
|
|
||||||
|
2. **Per-type free functions + dependency-bag dataclass**
|
||||||
|
- `core/processing/color_strip_kinds.py` (`StreamDeps` + `STREAM_BUILDERS`)
|
||||||
|
- `core/processing/value_kinds.py` (`ValueStreamDeps` + `STREAM_BUILDERS`)
|
||||||
|
- `storage/value_source_factories.py` (`CREATE_BUILDERS` + `UPDATE_APPLIERS`)
|
||||||
|
|
||||||
|
3. **Versioned migration runner**
|
||||||
|
- `storage/data_migrations.py` (`MigrationRunner` + `DataMigration` ABC)
|
||||||
|
- Used for any storage rename / field-shape change in the future.
|
||||||
|
- Audit-table contract: atomic transaction covers
|
||||||
|
applied-check + apply + record, so partial-failure cannot leave
|
||||||
|
data rewritten but unrecorded.
|
||||||
|
|
||||||
|
Adding a new feature that touches dispatch should reach for one of
|
||||||
|
these three patterns before writing a fresh if/elif chain.
|
||||||
@@ -55,10 +55,6 @@ The Android app (`android/app/build.gradle.kts`) installs the server package wit
|
|||||||
| [Gitea Python CI/CD Guide](https://git.dolgolyov-family.by/alexei.dolgolyov/claude-code-facts/src/branch/main/gitea-python-ci-cd.md) | Reusable CI/CD patterns: Gitea Actions, cross-build, NSIS, Docker |
|
| [Gitea Python CI/CD Guide](https://git.dolgolyov-family.by/alexei.dolgolyov/claude-code-facts/src/branch/main/gitea-python-ci-cd.md) | Reusable CI/CD patterns: Gitea Actions, cross-build, NSIS, Docker |
|
||||||
| [server/CLAUDE.md](server/CLAUDE.md) | Backend architecture, API patterns, common tasks |
|
| [server/CLAUDE.md](server/CLAUDE.md) | Backend architecture, API patterns, common tasks |
|
||||||
|
|
||||||
## Task Tracking via TODO.md
|
|
||||||
|
|
||||||
Use `TODO.md` in the project root as the primary task tracker. **Do NOT use the TodoWrite tool** — all progress tracking goes through `TODO.md`.
|
|
||||||
|
|
||||||
## Documentation Lookup
|
## Documentation Lookup
|
||||||
|
|
||||||
**Use context7 MCP tools for library/framework documentation lookups** (FastAPI, OpenCV, Pydantic, yt-dlp, etc.) instead of relying on potentially outdated training data.
|
**Use context7 MCP tools for library/framework documentation lookups** (FastAPI, OpenCV, Pydantic, yt-dlp, etc.) instead of relying on potentially outdated training data.
|
||||||
@@ -104,3 +100,42 @@ Do NOT commit code that fails linting or tests. Fix the issues first.
|
|||||||
- Follow existing code style and patterns
|
- Follow existing code style and patterns
|
||||||
- Update documentation when changing behavior
|
- Update documentation when changing behavior
|
||||||
- Never make commits or pushes without explicit user approval
|
- Never make commits or pushes without explicit user approval
|
||||||
|
|
||||||
|
<!-- code-review-graph MCP tools -->
|
||||||
|
## MCP Tools: code-review-graph
|
||||||
|
|
||||||
|
**IMPORTANT: This project has a knowledge graph. ALWAYS use the
|
||||||
|
code-review-graph MCP tools BEFORE using Grep/Glob/Read to explore
|
||||||
|
the codebase.** The graph is faster, cheaper (fewer tokens), and gives
|
||||||
|
you structural context (callers, dependents, test coverage) that file
|
||||||
|
scanning cannot.
|
||||||
|
|
||||||
|
### When to use graph tools FIRST
|
||||||
|
|
||||||
|
- **Exploring code**: `semantic_search_nodes` or `query_graph` instead of Grep
|
||||||
|
- **Understanding impact**: `get_impact_radius` instead of manually tracing imports
|
||||||
|
- **Code review**: `detect_changes` + `get_review_context` instead of reading entire files
|
||||||
|
- **Finding relationships**: `query_graph` with callers_of/callees_of/imports_of/tests_for
|
||||||
|
- **Architecture questions**: `get_architecture_overview` + `list_communities`
|
||||||
|
|
||||||
|
Fall back to Grep/Glob/Read **only** when the graph doesn't cover what you need.
|
||||||
|
|
||||||
|
### Key Tools
|
||||||
|
|
||||||
|
| Tool | Use when |
|
||||||
|
|------|----------|
|
||||||
|
| `detect_changes` | Reviewing code changes — gives risk-scored analysis |
|
||||||
|
| `get_review_context` | Need source snippets for review — token-efficient |
|
||||||
|
| `get_impact_radius` | Understanding blast radius of a change |
|
||||||
|
| `get_affected_flows` | Finding which execution paths are impacted |
|
||||||
|
| `query_graph` | Tracing callers, callees, imports, tests, dependencies |
|
||||||
|
| `semantic_search_nodes` | Finding functions/classes by name or keyword |
|
||||||
|
| `get_architecture_overview` | Understanding high-level codebase structure |
|
||||||
|
| `refactor_tool` | Planning renames, finding dead code |
|
||||||
|
|
||||||
|
### Workflow
|
||||||
|
|
||||||
|
1. The graph auto-updates on file changes (via hooks).
|
||||||
|
2. Use `detect_changes` for code review.
|
||||||
|
3. Use `get_affected_flows` to understand impact.
|
||||||
|
4. Use `query_graph` pattern="tests_for" to check coverage.
|
||||||
|
|||||||
@@ -1,36 +1,58 @@
|
|||||||
# LED Grab
|
# LED Grab
|
||||||
|
|
||||||
Ambient lighting system that captures screen content and drives LED strips in real time. Supports WLED, Adalight, AmbileD, and DDP devices with audio-reactive effects, pattern generation, and automated profile switching.
|
Ambient lighting system that captures screen content and drives LED strips and smart lights in real time. Supports a wide range of devices — WLED, DDP, Adalight, smart bulbs, PC peripherals, Bluetooth strips, and more — with audio-reactive effects, pattern generation, and condition-based automation.
|
||||||
|
|
||||||
|
**Free and open source.** LedGrab is released under the [MIT license](LICENSE) — free to use, modify, and self-host, with no accounts, telemetry, or cloud dependency. Everything runs locally on your own machine and network.
|
||||||
|
|
||||||
## What It Does
|
## What It Does
|
||||||
|
|
||||||
The server captures pixels from a screen (or Android device via ADB), extracts border colors, applies post-processing filters, and streams the result to LED strips at up to 60 fps. A built-in web dashboard provides device management, calibration, live LED preview, and real-time metrics — no external UI required.
|
The server captures pixels from a screen (or from a connected Android phone via ADB), extracts border colors, applies a post-processing filter pipeline, and streams the result to your LED devices at up to 60 fps. A built-in web dashboard provides device management, calibration, a visual wiring editor, live LED preview, and real-time metrics — no external UI required.
|
||||||
|
|
||||||
A Home Assistant integration exposes devices as entities for smart home automation.
|
A separate Home Assistant integration exposes devices as entities for smart-home automation.
|
||||||
|
|
||||||
|
## Screenshots
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
*Dashboard — live system performance, integrations, automations, and scene presets at a glance.*
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
*Channels — start, stop, and monitor each source-to-device pipeline with live FPS.*
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
*Live preview — inspect the processed capture output in real time before it reaches the LEDs.*
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
### Screen Capture
|
### Screen Capture
|
||||||
|
|
||||||
- Multi-monitor support with per-target display selection
|
- Multi-monitor support with per-target display selection
|
||||||
- 6 capture engine backends — MSS (cross-platform), DXCam, BetterCam, Windows Graphics Capture (Windows), Scrcpy (Android via ADB), Camera/Webcam (OpenCV)
|
- Capture engine backends: MSS (cross-platform), DXCam, BetterCam, Windows Graphics Capture (Windows only), and Camera/Webcam (OpenCV)
|
||||||
|
- Capture from a connected Android phone's screen via scrcpy (ADB) — the device is a *source*; LedGrab itself runs on your desktop
|
||||||
- Configurable capture regions, FPS, and border width
|
- Configurable capture regions, FPS, and border width
|
||||||
- Capture templates for reusable configurations
|
- Reusable capture templates
|
||||||
|
|
||||||
### LED Device Support
|
### LED Device Support
|
||||||
|
|
||||||
- WLED (HTTP/UDP) with mDNS auto-discovery
|
LedGrab speaks many protocols, so a single setup can drive everything from a DIY strip to off-the-shelf smart bulbs:
|
||||||
- Adalight (serial) — Arduino-compatible LED controllers
|
|
||||||
- AmbileD (serial)
|

|
||||||
- DDP (Distributed Display Protocol, UDP)
|
|
||||||
- OpenRGB — PC peripherals (keyboard, mouse, RAM, fans, LED strips)
|
- **Network LED controllers** — WLED (HTTP/UDP, with mDNS auto-discovery), DDP (Pixelblaze, ESPixelStick, Falcon), Open Pixel Control (OPC), Art-Net / sACN (E1.31), ESP-NOW, and generic WebSocket streaming
|
||||||
- Serial port auto-detection and baud rate configuration
|
- **Serial / direct hardware** — Adalight (Arduino-compatible), AmbiLED, SPI-attached strips (e.g. WS2812B), and USB HID controllers
|
||||||
|
- **Smart bulbs & panels** — Philips Hue (Entertainment API), Nanoleaf, Yeelight, WiZ, LIFX, and Govee (Wi-Fi LAN)
|
||||||
|
- **Bluetooth LE strips** — SP110E, Triones / HappyLighting, Zengge, and Govee BLE
|
||||||
|
- **PC peripherals** — OpenRGB, Razer Chroma, and SteelSeries GameSense (keyboards, mice, RAM, fans, etc.)
|
||||||
|
- **Device groups** — combine multiple devices into one logical target
|
||||||
|
- Serial port auto-detection and baud-rate configuration
|
||||||
|
|
||||||
### Color Processing
|
### Color Processing
|
||||||
|
|
||||||
- Post-processing filter pipeline: brightness, gamma, saturation, color correction, auto-crop, frame interpolation, pixelation, flip
|
- Post-processing filter pipeline: brightness, gamma, saturation, color correction, auto-crop, frame interpolation, pixelation, flip, and more
|
||||||
- Reusable post-processing templates
|
- Reusable post-processing templates
|
||||||
- Color strip sources: audio-reactive, pattern generator, composite layering, audio-to-color mapping
|
- Color strip sources: audio-reactive, pattern generator, gradients, composite layering, and audio-to-color mapping
|
||||||
- Pattern templates with customizable effects
|
- Pattern templates with customizable effects
|
||||||
|
|
||||||
### Audio Integration
|
### Audio Integration
|
||||||
@@ -38,17 +60,20 @@ A Home Assistant integration exposes devices as entities for smart home automati
|
|||||||
- Multichannel audio capture from any system device (input or loopback)
|
- Multichannel audio capture from any system device (input or loopback)
|
||||||
- WASAPI engine on Windows, Sounddevice (PortAudio) engine on Linux/macOS
|
- WASAPI engine on Windows, Sounddevice (PortAudio) engine on Linux/macOS
|
||||||
- Per-channel mono extraction
|
- Per-channel mono extraction
|
||||||
- Audio-reactive color strip sources driven by frequency analysis
|
- Audio filter / processing pipeline feeding audio-reactive color sources driven by frequency analysis
|
||||||
|
|
||||||
### Automation
|
### Automation
|
||||||
|
|
||||||
- Profile engine with condition-based switching (time of day, active window, etc.)
|
- Automations engine with condition-based rules — switch targets, scenes, or brightness by time of day, active window/process, MQTT, webhooks, or game events
|
||||||
- Dynamic brightness value sources (schedule-based, scene-aware)
|
- Scene presets for one-click lighting changes
|
||||||
- Key Colors (KC) targets with live WebSocket color streaming
|
- Dynamic value sources for brightness and other parameters (schedule-based, weather-based, scene-aware)
|
||||||
|
- Weather sources, clock sync, webhooks, and inbound/outbound HTTP endpoints
|
||||||
|
- Game integration adapters (e.g. League of Legends)
|
||||||
|
|
||||||
### Dashboard
|
### Dashboard
|
||||||
|
|
||||||
- Web UI at `http://localhost:8080` — no installation needed on the client side
|
- Web UI at `http://localhost:8080` — nothing to install on the client side
|
||||||
|
- Visual node-graph editor for wiring sources → processing → targets
|
||||||
- Progressive Web App (PWA) — installable on phones and tablets with offline caching
|
- Progressive Web App (PWA) — installable on phones and tablets with offline caching
|
||||||
- Responsive mobile layout with bottom tab navigation
|
- Responsive mobile layout with bottom tab navigation
|
||||||
- Device management with auto-discovery wizard
|
- Device management with auto-discovery wizard
|
||||||
@@ -59,32 +84,57 @@ A Home Assistant integration exposes devices as entities for smart home automati
|
|||||||
|
|
||||||
### Home Assistant Integration
|
### Home Assistant Integration
|
||||||
|
|
||||||
- HACS-compatible custom component
|
- HACS-compatible custom component (separate repository)
|
||||||
- Light, switch, sensor, and number entities per device
|
- Light, switch, sensor, and number entities per device
|
||||||
- Real-time metrics via data coordinator
|
- Real-time metrics via a data coordinator
|
||||||
- WebSocket-based live LED preview in HA
|
- WebSocket-based live LED preview in HA
|
||||||
|
|
||||||
|
## Platforms
|
||||||
|
|
||||||
|
LedGrab runs as a desktop / server application:
|
||||||
|
|
||||||
|
| Platform | Status | Notes |
|
||||||
|
| -------- | ------ | ----- |
|
||||||
|
| Windows | ✅ Supported | Installer (`.exe`) and portable ZIP; all capture/audio backends |
|
||||||
|
| Linux | ✅ Supported | Tarball and Docker image; X11 capture (Wayland in-container capture not supported) |
|
||||||
|
| macOS | ✅ Supported | Runs from source / Docker; MSS capture |
|
||||||
|
| Docker | ✅ Supported | Multi-arch container image |
|
||||||
|
| Android (TV) | ⚠️ Experimental | An on-device Android-TV build exists (APK attached to releases) but is emulator-verified only and **not officially supported** |
|
||||||
|
|
||||||
|
> **There is no production Android app.** Android phones are only supported as a *capture source* (via scrcpy/ADB) from a desktop host. The on-device Android-TV build is experimental.
|
||||||
|
|
||||||
|
### Feature support by OS
|
||||||
|
|
||||||
|
| Feature | Windows | Linux / macOS | Android TV (experimental) |
|
||||||
|
| ------- | ------- | ------------- | ------------------------- |
|
||||||
|
| Screen capture | DXCam, BetterCam, WGC, MSS | MSS | MediaProjection; root `screenrecord` (rooted devices) |
|
||||||
|
| Webcam capture | OpenCV (DirectShow) | OpenCV (V4L2) | Camera2 (on-demand, while capture is running) |
|
||||||
|
| Audio capture | WASAPI, Sounddevice | Sounddevice (PulseAudio/PipeWire) | AudioPlaybackCapture (API 29+) |
|
||||||
|
| GPU monitoring | NVIDIA (nvidia-ml-py) | NVIDIA (nvidia-ml-py) | — (CPU/RAM/battery/thermal via `/proc`) |
|
||||||
|
| Capture from Android phone | scrcpy (ADB) | scrcpy (ADB) | — (captures its own screen instead) |
|
||||||
|
| Notification capture | WinRT | dbus (Linux) | NotificationListenerService |
|
||||||
|
| Monitor names | Friendly names (WMI) | Generic ("Display 0") | Single built-in display |
|
||||||
|
| LED transports | Network, USB-serial, BLE | Network, USB-serial, BLE | Network, USB-serial (Android driver), BLE (Android bridge) |
|
||||||
|
| Automation: window/process conditions | Supported | Partial | Foreground-app condition (UsageStatsManager) |
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
- Python 3.11+ (or Docker)
|
- Python 3.11+ (or Docker)
|
||||||
- A supported LED device on the local network or connected via USB
|
- A supported LED device on the local network, connected via USB/serial, or reachable over Bluetooth
|
||||||
- Windows, Linux, or macOS — all core features work cross-platform
|
- Windows, Linux, or macOS
|
||||||
|
|
||||||
### Platform Notes
|
|
||||||
|
|
||||||
| Feature | Windows | Linux / macOS |
|
|
||||||
| ------- | ------- | ------------- |
|
|
||||||
| Screen capture | DXCam, BetterCam, WGC, MSS | MSS |
|
|
||||||
| Webcam capture | OpenCV (DirectShow) | OpenCV (V4L2) |
|
|
||||||
| Audio capture | WASAPI, Sounddevice | Sounddevice (PulseAudio/PipeWire) |
|
|
||||||
| GPU monitoring | NVIDIA (pynvml) | NVIDIA (pynvml) |
|
|
||||||
| Android capture | Scrcpy (ADB) | Scrcpy (ADB) |
|
|
||||||
| Monitor names | Friendly names (WMI) | Generic ("Display 0") |
|
|
||||||
| Profile conditions | Process/window detection | Not yet implemented |
|
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
### Docker (recommended)
|
### Prebuilt downloads
|
||||||
|
|
||||||
|
Grab a ready-to-run build from the [Releases page](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/releases):
|
||||||
|
|
||||||
|
- **Windows** — `LedGrab-<version>-setup.exe` (installer, no admin required) or `LedGrab-<version>-win-x64.zip` (portable)
|
||||||
|
- **Linux** — `LedGrab-<version>-linux-x64.tar.gz`
|
||||||
|
- **Docker** — see below
|
||||||
|
- **Android TV** — `.apk` (experimental, see [Platforms](#platforms))
|
||||||
|
|
||||||
|
### Docker (recommended for servers)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab.git
|
git clone https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab.git
|
||||||
@@ -115,11 +165,11 @@ export PYTHONPATH=$(pwd)/src # Linux/Mac
|
|||||||
uvicorn ledgrab.main:app --host 0.0.0.0 --port 8080
|
uvicorn ledgrab.main:app --host 0.0.0.0 --port 8080
|
||||||
```
|
```
|
||||||
|
|
||||||
Open **http://localhost:8080** to access the dashboard.
|
Open <http://localhost:8080> to access the dashboard.
|
||||||
|
|
||||||
> **Important:** The default API key is `development-key-change-in-production`. Change it before exposing the server outside localhost. See [INSTALLATION.md](INSTALLATION.md) for details.
|
> **Network access:** By default, LedGrab allows anonymous access only from `localhost`. Any request from another machine on your LAN is rejected unless you configure an API key (`auth.api_keys`). Set a key before exposing the server on your network — see [INSTALLATION.md](INSTALLATION.md).
|
||||||
|
|
||||||
See [INSTALLATION.md](INSTALLATION.md) for the full installation guide, including configuration, Docker manual builds, and Home Assistant setup.
|
See [INSTALLATION.md](INSTALLATION.md) for the full installation guide, including configuration, Docker manual builds, and CORS setup.
|
||||||
|
|
||||||
## Demo Mode
|
## Demo Mode
|
||||||
|
|
||||||
@@ -133,50 +183,9 @@ docker compose run -e LEDGRAB_DEMO=true server
|
|||||||
|
|
||||||
# Python
|
# Python
|
||||||
LEDGRAB_DEMO=true uvicorn ledgrab.main:app --host 0.0.0.0 --port 8081
|
LEDGRAB_DEMO=true uvicorn ledgrab.main:app --host 0.0.0.0 --port 8081
|
||||||
|
|
||||||
# Windows (installed app)
|
|
||||||
set LEDGRAB_DEMO=true
|
|
||||||
LedGrab.bat
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Demo mode uses port **8081**, config file `config/demo_config.yaml`, and stores data in `data/demo/` (separate from production data). It can run alongside the main server.
|
Demo mode uses port **8081**, config file `config/demo_config.yaml`, and stores data under `data/demo/` (separate from production data). It can run alongside the main server.
|
||||||
|
|
||||||
## Architecture
|
|
||||||
|
|
||||||
```text
|
|
||||||
ledgrab/
|
|
||||||
├── server/ # Python FastAPI backend
|
|
||||||
│ ├── src/ledgrab/
|
|
||||||
│ │ ├── main.py # Application entry point
|
|
||||||
│ │ ├── config.py # YAML + env var configuration
|
|
||||||
│ │ ├── api/
|
|
||||||
│ │ │ ├── routes/ # REST + WebSocket endpoints
|
|
||||||
│ │ │ └── schemas/ # Pydantic request/response models
|
|
||||||
│ │ ├── core/
|
|
||||||
│ │ │ ├── capture/ # Screen capture, calibration, pixel processing
|
|
||||||
│ │ │ ├── capture_engines/ # MSS, DXCam, BetterCam, WGC, Scrcpy, Camera backends
|
|
||||||
│ │ │ ├── devices/ # WLED, Adalight, AmbileD, DDP, OpenRGB clients
|
|
||||||
│ │ │ ├── audio/ # Audio capture engines
|
|
||||||
│ │ │ ├── filters/ # Post-processing filter pipeline
|
|
||||||
│ │ │ ├── processing/ # Stream orchestration and target processors
|
|
||||||
│ │ │ └── profiles/ # Condition-based profile automation
|
|
||||||
│ │ ├── storage/ # JSON-based persistence layer
|
|
||||||
│ │ ├── static/ # Web dashboard (vanilla JS, CSS, HTML)
|
|
||||||
│ │ │ ├── js/core/ # API client, state, i18n, modals, events
|
|
||||||
│ │ │ ├── js/features/ # Feature modules (devices, streams, targets, etc.)
|
|
||||||
│ │ │ ├── css/ # Stylesheets
|
|
||||||
│ │ │ └── locales/ # en.json, ru.json, zh.json
|
|
||||||
│ │ └── utils/ # Logging, monitor detection
|
|
||||||
│ ├── config/ # default_config.yaml
|
|
||||||
│ ├── tests/ # pytest suite
|
|
||||||
│ ├── Dockerfile
|
|
||||||
│ └── docker-compose.yml
|
|
||||||
├── docs/
|
|
||||||
│ ├── API.md # REST API reference
|
|
||||||
│ └── CALIBRATION.md # LED calibration guide
|
|
||||||
├── INSTALLATION.md
|
|
||||||
└── LICENSE # MIT
|
|
||||||
```
|
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
@@ -187,14 +196,15 @@ server:
|
|||||||
host: "0.0.0.0"
|
host: "0.0.0.0"
|
||||||
port: 8080
|
port: 8080
|
||||||
log_level: "INFO"
|
log_level: "INFO"
|
||||||
|
cors_origins:
|
||||||
|
- "http://localhost:8080"
|
||||||
|
|
||||||
auth:
|
auth:
|
||||||
api_keys:
|
# Empty (default) → loopback-only anonymous access; LAN requests are rejected.
|
||||||
dev: "development-key-change-in-production"
|
# Add a key to enable LAN/remote access (generate one with: openssl rand -hex 32).
|
||||||
|
api_keys: {}
|
||||||
storage:
|
# api_keys:
|
||||||
devices_file: "data/devices.json"
|
# dev: "your-secret-key-here"
|
||||||
templates_file: "data/capture_templates.json"
|
|
||||||
|
|
||||||
logging:
|
logging:
|
||||||
format: "json"
|
format: "json"
|
||||||
@@ -202,25 +212,26 @@ logging:
|
|||||||
max_size_mb: 100
|
max_size_mb: 100
|
||||||
```
|
```
|
||||||
|
|
||||||
Environment variable override example: `LEDGRAB_SERVER__PORT=9090`.
|
- Application data is stored in a SQLite database (`data/ledgrab.db` by default). Set `LEDGRAB_DATA_DIR` to relocate the data root (database + assets).
|
||||||
|
- Environment variable override example: `LEDGRAB_SERVER__PORT=9090`.
|
||||||
|
|
||||||
|
See [INSTALLATION.md](INSTALLATION.md) and [`server/.env.example`](server/.env.example) for the full configuration reference.
|
||||||
|
|
||||||
## API
|
## API
|
||||||
|
|
||||||
The server exposes a REST API (with Swagger docs at `/docs`) covering:
|
The server exposes a REST API (with interactive Swagger docs at `/docs`) plus WebSocket endpoints. Resources include:
|
||||||
|
|
||||||
- **Devices** — CRUD, discovery, validation, state, metrics
|
- **Devices** — CRUD, discovery, validation, state, metrics
|
||||||
- **Capture Templates** — Screen capture configurations
|
- **Capture Templates** & **Picture Sources** — screen capture configuration and stream definitions
|
||||||
- **Picture Sources** — Screen capture stream definitions
|
- **Output Targets** — LED target management, start/stop processing, live color stream
|
||||||
- **Picture Targets** — LED target management, start/stop processing
|
- **Post-Processing Templates** — filter pipeline configurations
|
||||||
- **Post-Processing Templates** — Filter pipeline configurations
|
- **Color Strip Sources**, **Pattern Templates**, **Gradients** — color generation
|
||||||
- **Color Strip Sources** — Audio, pattern, composite, mapped sources
|
- **Audio Sources / Templates / Filters** — audio capture and reactive processing
|
||||||
- **Audio Sources** — Multichannel and mono audio device configuration
|
- **Value Sources**, **Weather Sources**, **Scene Presets** — dynamic parameters and presets
|
||||||
- **Pattern Templates** — Effect pattern definitions
|
- **Automations**, **Webhooks**, **HTTP Endpoints**, **Game Integration** — triggers and rules
|
||||||
- **Value Sources** — Dynamic brightness/value providers
|
- **MQTT** & **Home Assistant** — broker sources and HA integration
|
||||||
- **Key Colors Targets** — KC targets with WebSocket live color stream
|
|
||||||
- **Profiles** — Condition-based automation profiles
|
|
||||||
|
|
||||||
All endpoints require API key authentication via `X-API-Key` header or `?token=` query parameter.
|
Authentication uses a Bearer token (`Authorization: Bearer <api-key>`) when API keys are configured; loopback requests are anonymous by default. WebSocket connections authenticate via a first-message handshake.
|
||||||
|
|
||||||
See [docs/API.md](docs/API.md) for the full reference.
|
See [docs/API.md](docs/API.md) for the full reference.
|
||||||
|
|
||||||
@@ -253,16 +264,16 @@ ruff check src/ tests/
|
|||||||
Optional extras:
|
Optional extras:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip install -e ".[perf]" # High-performance capture engines (Windows)
|
pip install -e ".[perf]" # High-performance capture engines (Windows: DXCam, BetterCam, WGC)
|
||||||
pip install -e ".[camera]" # Webcam capture via OpenCV
|
pip install -e ".[notifications]" # OS notification capture (WinRT / dbus)
|
||||||
|
pip install -e ".[scrcpy]" # Capture from an Android phone via scrcpy
|
||||||
|
pip install -e ".[ble]" # Bluetooth LE LED controllers (desktop only)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Contributions are welcome. LedGrab is MIT-licensed, so you're free to fork, modify, and self-host. Please open an issue or pull request on the [repository](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab).
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
MIT — see [LICENSE](LICENSE).
|
MIT — see [LICENSE](LICENSE). Free and open source.
|
||||||
|
|
||||||
## Acknowledgments
|
|
||||||
|
|
||||||
- [WLED](https://github.com/Aircoookie/WLED) — LED control firmware
|
|
||||||
- [FastAPI](https://fastapi.tiangolo.com/) — Python web framework
|
|
||||||
- [MSS](https://python-mss.readthedocs.io/) — Cross-platform screen capture
|
|
||||||
|
|||||||
+38
-29
@@ -1,45 +1,54 @@
|
|||||||
## v0.5.0 (2026-04-25)
|
## v0.8.1 (2026-05-28)
|
||||||
|
|
||||||
This release ships the **Lumenworks studio-console** — a top-to-bottom WebUI redesign — plus a customizable per-account dashboard, a server-shutdown control, and a handful of dark/light/narrow-screen polish fixes.
|
### User-facing changes
|
||||||
|
|
||||||
### Features
|
#### Features
|
||||||
- **Lumenworks studio-console WebUI redesign** — new visual language across the entire WebUI: studio-console layout, refined typography, accent system, and motion. ([539e431](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/539e431))
|
|
||||||
- Extend the Lumenworks treatment to the **Inputs**, **Integrations**, and **Graph** tabs so the redesign is consistent across all top-level views. ([b43e1cf](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/b43e1cf))
|
|
||||||
- **Per-account customizable dashboard** with a slide-in configuration panel — each user can pick their own widget layout, persisted per account. ([56853b7](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/56853b7))
|
|
||||||
- Dashboard polish: richer performance strip, transport-bar controls, and additional readouts on the main view. ([e5a2af9](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/e5a2af9))
|
|
||||||
- Item-card restyle with hover-driven performance tooltips and a configurable FPS ceiling. ([70c95d1](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/70c95d1))
|
|
||||||
- **Live card-color picker** — pick a custom color per card and see it apply instantly; default preset now uses the base palette. Monotonic uptime ticker no longer jitters on clock adjustments. ([e0ff40f](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/e0ff40f))
|
|
||||||
- **Server shutdown action** exposed in the WebUI, backed by a public `cancel_task` lifecycle method so long-running tasks unwind cleanly. ([3f80ef2](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/3f80ef2))
|
|
||||||
|
|
||||||
### Bug Fixes
|
##### Multi-broker MQTT devices
|
||||||
- Channel stripe on item cards now only paints when the card has a custom color or is running — no more stray accents on idle defaults. ([b1ee3c3](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/b1ee3c3))
|
|
||||||
- Cards render correctly on pure black and pure white backgrounds, and are decoupled from the animated background so they stay legible regardless of the bg-anim setting. ([dd415e2](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/dd415e2))
|
- The device editor now shows an MQTT **broker picker** for `device_type=mqtt` (in both the add-device and device-settings modals), wired into load / save / validate / dirty-check / clone. An empty selection means "first available broker"
|
||||||
- Single-row header layout and readable sidebar labels at narrow widths — fixes wrapping and label truncation on smaller windows. ([2bae304](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/2bae304))
|
- `mqtt_source_id` is now threaded end-to-end through `DeviceCreate` / `DeviceUpdate` / `DeviceResponse` and the device routes; the referenced broker is validated on create **and** update ([a5effba](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/a5effba))
|
||||||
|
|
||||||
|
##### Schema-driven wiring-graph editor
|
||||||
|
|
||||||
|
- The visual graph editor now renders ports and edges generically from a backend-served schema (`GET /api/v1/graph/schema`) instead of hard-coding the connectable-field topology in two places — so client and server can no longer drift
|
||||||
|
- New `GET /api/v1/graph` returns the full nodes + edges + validation topology, and `GET /api/v1/graph/dependents/{kind}/{id}` reports what references an entity ([a5effba](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/a5effba))
|
||||||
|
|
||||||
|
##### Aggregated snapshot endpoint
|
||||||
|
|
||||||
|
- New `GET /api/v1/snapshot` returns all output targets (with processing state + metrics), devices (with brightness), the source / preset / clock lists, and the system block in a **single response** — collapsing the Home Assistant integration's previous ~2N+M request fan-out into one round trip
|
||||||
|
- `?include=` fetches only a subset of sections, and an excluded section also skips its server-side work (e.g. cold-cache hardware brightness probes or the blocking NVML performance query) ([a5effba](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/a5effba))
|
||||||
|
|
||||||
|
#### Bug Fixes
|
||||||
|
|
||||||
|
- **Graceful shutdown no longer hangs:** uvicorn's graceful-shutdown wait is now bounded (`GRACEFUL_SHUTDOWN_TIMEOUT`, shared by the desktop, Android, and demo launchers). A lingering events WebSocket (which the browser auto-reconnects) used to keep connections from draining, so the lifespan shutdown never ran — leaving LED targets lit and blocking process exit. Ctrl+C / OS shutdown with the UI open now reliably stops targets and checkpoints the DB ([a5effba](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/a5effba))
|
||||||
|
- **Device update error codes:** `update_device` no longer masks an intentional 4xx (e.g. an unknown `mqtt_source_id` or failed group validation) as a generic 500 ([a5effba](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/a5effba))
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Development / Internal
|
### Development / Internal
|
||||||
|
|
||||||
#### Chores
|
#### Backend
|
||||||
- Harden test isolation, add `.gitignore` rule for stale `src/data/`, and mark the shutdown action done in the task tracker. ([80f01d4](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/80f01d4))
|
|
||||||
|
- **Wiring-graph schema engine** (`api/graph_schema.py`): a pure, unit-tested module that is the single source of truth for which reference fields connect which entity kinds; builds the topology and performs dependency lookup plus cycle / dangling-reference detection without booting the app or any store. The route layer only gathers serialized entities and delegates ([a5effba](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/a5effba))
|
||||||
|
- **Structured access log:** a new middleware emits one structured line per request, attributing it to the authenticated token's friendly label (the key name, **never** the secret) so traffic can be traced to a client (e.g. `homeassistant` vs `android`). uvicorn's own access log is disabled to avoid duplicate lines ([a5effba](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/a5effba))
|
||||||
|
- Shared `validate_mqtt_source_exists` (`_mqtt_validation.py`) deduplicates the MQTT-source existence check between the device and output-target routes ([a5effba](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/a5effba))
|
||||||
|
|
||||||
|
#### Frontend
|
||||||
|
|
||||||
|
- Service-worker refresh for the new bundle ([a5effba](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/a5effba))
|
||||||
|
|
||||||
|
#### Tests
|
||||||
|
|
||||||
|
- New suites: graph routes + schema engine, snapshot routes, access-log middleware, `mqtt_source_id` device regressions, and the bounded-shutdown entrypoint. Full suite: **1614 passing** ([a5effba](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/a5effba))
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>All Commits</summary>
|
<summary>All Commits (1)</summary>
|
||||||
|
|
||||||
| Hash | Message | Author |
|
| Hash | Message | Author |
|
||||||
|------|---------|--------|
|
| ---- | ------- | ------ |
|
||||||
| [80f01d4](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/80f01d4) | chore: harden test isolation, gitignore stale src/data, mark shutdown action done | alexei.dolgolyov |
|
| [a5effba](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/a5effba) | feat: aggregated snapshot + wiring-graph APIs, MQTT device brokers | alexei.dolgolyov |
|
||||||
| [b1ee3c3](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/b1ee3c3) | fix(ui): channel stripe paints only on custom-color or running cards | alexei.dolgolyov |
|
|
||||||
| [e0ff40f](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/e0ff40f) | feat(ui): live card-color picker, monotonic uptime ticker tweaks, default preset uses base palette | alexei.dolgolyov |
|
|
||||||
| [3f80ef2](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/3f80ef2) | feat: server shutdown action with public cancel_task lifecycle method | alexei.dolgolyov |
|
|
||||||
| [2bae304](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/2bae304) | fix(ui): single-row header + readable sidebar labels at narrow widths | alexei.dolgolyov |
|
|
||||||
| [dd415e2](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/dd415e2) | fix(ui): cards on pure black/white, decoupled from bg-anim | alexei.dolgolyov |
|
|
||||||
| [b43e1cf](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/b43e1cf) | feat(ui): Lumenworks treatment for Inputs / Integrations / Graph tabs | alexei.dolgolyov |
|
|
||||||
| [56853b7](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/56853b7) | feat(dashboard): per-account customizable dashboard with slide-in panel | alexei.dolgolyov |
|
|
||||||
| [70c95d1](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/70c95d1) | feat(ui): item-card restyle, perf hover tooltips, FPS ceiling | alexei.dolgolyov |
|
|
||||||
| [e5a2af9](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/e5a2af9) | feat(ui): dashboard polish, richer perf strip, transport-bar controls | alexei.dolgolyov |
|
|
||||||
| [539e431](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab/commit/539e431) | feat(ui): Lumenworks studio-console WebUI redesign | alexei.dolgolyov |
|
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|||||||
@@ -0,0 +1,249 @@
|
|||||||
|
# Dashboard Reconciliation — Review Notes
|
||||||
|
|
||||||
|
*Captured 2026-05-26. Session focused on dashboard + perf-card flicker and per-poll re-rendering.*
|
||||||
|
|
||||||
|
*Updated 2026-05-27 — widened the audit beyond the two poll timers and found a **second driver** (server push) plus the **highest-blast-radius site** (`entity-events.ts`). Added §3.5, corrected the "out of scope" reasoning in §5, and confirmed the decision: **commit to the Lit migration**. Implementation deferred — this is still a planning doc, not a spec.*
|
||||||
|
|
||||||
|
This is a thinking-aloud document for whoever picks up reconciliation work next (likely me). It captures the bug class, what's already shipped, what's still latent, the decision ladder we walked through, and the recommendation we landed on. It is **not** a spec — treat any code shown as illustrative.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 1. The bug class in one sentence
|
||||||
|
|
||||||
|
> Every place a data-driven render — a poll timer **or** a server-pushed `server:*` event — writes `el.innerHTML = ...`, the existing DOM is torn down — even when the new HTML equals the old — which restarts CSS animations, drops focus, skips transitions, and burns wasted DOM mutation cycles.
|
||||||
|
|
||||||
|
The symptom only becomes visually loud when the destroyed subtree contains a CSS keyframe animation (e.g. the pulsing `.perf-patches-empty-dot`). Everywhere else the cost is silent: lost transitions, broken focus, wasted layout work. The bug is **load-bearing in the architecture**, not in any single call site — that's why we keep coming back to it.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 2. What landed in commit `f6486f9` (this session)
|
||||||
|
|
||||||
|
Tactical work — solves the worst cases, does not change the architecture.
|
||||||
|
|
||||||
|
### `server/src/ledgrab/static/js/features/dashboard.ts`
|
||||||
|
- Collapsed the two fast-path branches into one. Fast path runs when `structureUnchanged && !forceFullRender` regardless of `running.length`. Previously, **zero running targets meant every poll rebuilt the entire dashboard** even when nothing changed.
|
||||||
|
- `_lastSyncClockIds` no longer fingerprints `is_running` — pausing/resuming a clock no longer tears down every card. `_updateSyncClocksInPlace` already handles the toggle.
|
||||||
|
- `_updateAutomationsInPlace` now called from the unified fast path. Automation badges were silently going stale on the fast path.
|
||||||
|
- `_initFpsCharts` rewritten diff-based: only destroy charts for ids that left or whose canvas was detached by a DOM swap; only create for new ids; only fetch `/api/metrics/history` when there are genuinely new ids needing seed data.
|
||||||
|
- Sync-clock pause/resume/reset callers + `server:automation_state_changed` SSE handler now use `loadDashboard()` (no force) — `forceFullRender` is now actually load-bearing, meaning "settings changed, full rebuild required."
|
||||||
|
|
||||||
|
### `server/src/ledgrab/static/js/features/perf-charts.ts`
|
||||||
|
- `_renderChartSvg` no longer rewrites `innerHTML` per poll. The SVG skeleton (ref line + sys area/line + app line) is built once via `_ensureSparkNodes` and mutated thereafter. WeakMap cache (`_sparkNodeCache`) keyed by host element avoids the per-tick `querySelector` cost.
|
||||||
|
- Hidden cards (env-disabled GPU/Temp) skip render entirely.
|
||||||
|
- `_fetchPerformance` switched to `fetchWithAuth`.
|
||||||
|
- Hardcoded English strings replaced with `t()` calls. New keys: `perf.no_captures`, `perf.captures_count.{one,few,many,other}`, `perf.ratio_of_requested`, `perf.total_count`, `perf.skipped_per_sec`, `perf.tip.now`, `perf.tip.ago` (en/ru/zh).
|
||||||
|
- Tooltip reads `dashboardPollInterval` per mousemove tick (was captured at bind time).
|
||||||
|
- Dead `<defs><linearGradient>` block removed.
|
||||||
|
- `updateTotalCaptureFpsActual` now delegates to `_paintCaptureFpsActualValue` — single code path.
|
||||||
|
- `updateActivePatches` / `updateDevices` skip the `innerHTML` write when content signature hasn't changed. This is the direct fix for the "READY TO LAUNCH flickers every update" report — the empty-state dot's CSS pulse no longer resets.
|
||||||
|
- Two missing semicolons in `_seedAggregateHistories` (ASI was saving us).
|
||||||
|
|
||||||
|
### Reviewer findings addressed (typescript-reviewer pass)
|
||||||
|
- **HIGH:** `_metricLabel` was looking up `dashboard.perf.${key}` but the FPS family uses `dashboard.perf.total_fps`, `total_capture_fps`, `total_capture_fps_actual`. Tooltip would have shouted `FPS` / `CAPTURE_FPS` / `CAPTURE_FPS_ACTUAL`. Fixed via explicit `METRIC_LABEL_KEYS` map.
|
||||||
|
- **HIGH:** `_ensureSparkNodes` silently coerced `null` children to non-null when the SVG existed but a child was missing. Hardened to validate all four children and rebuild if any are missing.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 3. Hot spots still latent
|
||||||
|
|
||||||
|
These are the call sites where `innerHTML` is still written every poll. None are flickering today (no CSS animations on their inner elements), but every one is the same bug shape and will bite the next time someone adds a keyframe / transition / focus target inside.
|
||||||
|
|
||||||
|
### `perf-charts.ts`
|
||||||
|
|
||||||
|
| Line | Site | Fires per poll? | Notes |
|
||||||
|
|------|------|-----------------|-------|
|
||||||
|
| 462 | `updateActivePatches` → `listEl.innerHTML` | yes | guarded by signature compare (✓) |
|
||||||
|
| 493 | `updateTotalFps` → `valEl.innerHTML` | yes | FPS value, no inner animation |
|
||||||
|
| 526 | `updateTotalCaptureFps` → `valEl.innerHTML` | yes | same |
|
||||||
|
| 638 | `_paintNetworkValue` → `valEl.innerHTML` | yes | bytes/s value |
|
||||||
|
| 655 | `_paintDeviceLatencyValue` → `valEl.innerHTML` (no-devices hint) | yes | hint span |
|
||||||
|
| 657 | `_paintDeviceLatencyValue` → `valEl.innerHTML` (offline hint) | yes | hint span |
|
||||||
|
| 660 | `_paintDeviceLatencyValue` → `valEl.innerHTML` (ms value) | yes | value |
|
||||||
|
| 676 | `_paintSendTimingValue` → `valEl.innerHTML` (idle hint) | yes | hint span |
|
||||||
|
| 679 | `_paintSendTimingValue` → `valEl.innerHTML` (ms value) | yes | value |
|
||||||
|
| 738 | `_paintErrorsValue` → `valEl.innerHTML` | yes | rate value |
|
||||||
|
| 806 | `updateDevices` → `dotsEl.innerHTML` | yes | guarded by signature compare (✓) |
|
||||||
|
| 1086 | `_renderValuePair` → `mainEl.innerHTML = appVal` | yes | dual sys/app value |
|
||||||
|
| 1088 | `_renderValuePair` → `mainEl.innerHTML = sysVal` | yes | dual sys/app value |
|
||||||
|
| 1094 | `_renderValuePair` → `tagEl.innerHTML` (App tag) | mode='both' only | App tag in `both` mode |
|
||||||
|
| 1181 | `_applyPerfDataToDom` temp hint | only when cpu_temp_hint_key changes | rare |
|
||||||
|
| 1449 | `_paintFpsValue` | seed only | once per init |
|
||||||
|
| 1456 | `_paintCaptureFpsValue` | seed only | once per init |
|
||||||
|
| 1463 | `_paintCaptureFpsActualValue` (no-captures hint) | yes via live updater | now goes through painter |
|
||||||
|
| 1469 | `_paintCaptureFpsActualValue` (value) | yes via live updater | same |
|
||||||
|
| 1499 | `_paintErrorsValue` (duplicate of 738) | seed only | once per init |
|
||||||
|
| 1823 | tooltip `tip.innerHTML` | per mousemove | rate-limited by hover only |
|
||||||
|
|
||||||
|
### `dashboard.ts`
|
||||||
|
|
||||||
|
| Line | Site | Fires per poll? | Notes |
|
||||||
|
|------|------|-----------------|-------|
|
||||||
|
| 275 | `_updateRunningMetrics` → `fpsEl.innerHTML` | per running target | live FPS pill — visible churn |
|
||||||
|
| 293 | `_updateRunningMetrics` → `labelEl.innerHTML` (errors label) | per running target | rebuilt each poll |
|
||||||
|
| 340 | `_updateAutomationsInPlace` → `btn.innerHTML` | only on enable/disable change | low frequency |
|
||||||
|
| 366 | `_updateSyncClocksInPlace` → `btn.innerHTML` | per poll for every clock | wasteful |
|
||||||
|
| 975 | `loadDashboard` first-load → `container.innerHTML` | once per init | fine |
|
||||||
|
| 989 | `loadDashboard` slow path → `dynamic.innerHTML = dynamicHtml` | only when slow path fires | the **big** swap, scoped already |
|
||||||
|
| 1010 | `loadDashboard` error path | rare | fine |
|
||||||
|
| 1416 | `subscribeDashboardLayout` clear | rare | fine |
|
||||||
|
|
||||||
|
### What this list tells us
|
||||||
|
|
||||||
|
- The remaining innerHTML writes are **per-cell value updates** that paint formatted spans (`{value}<span class="perf-fps-unit">fps</span>`). Each rewrite destroys two text nodes + a span every poll across ~10 cells. Not flickering today; will flicker the moment anyone adds an animation to `.perf-fps-unit` or `.perf-fps-ceiling`.
|
||||||
|
- The pattern can be killed without architectural change by splitting these into a stable structure (number text node + static unit span) and only updating `textContent` of the number. That's what L3 / Lit would force naturally.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 3.5 Beyond dashboard/perf — push-driven reconciliation
|
||||||
|
|
||||||
|
*Added 2026-05-27. The §3 audit was scoped to the two poll timers we were debugging. Widening the `\.innerHTML\s*=` search showed the bug class has a **second driver** and lives outside dashboard/perf too.*
|
||||||
|
|
||||||
|
### Two drivers, not one
|
||||||
|
|
||||||
|
The teardown is triggered by anything that re-renders **without user intent**:
|
||||||
|
|
||||||
|
- **Poll timers** (`setInterval`) — what §2/§3 covered (`dashboard.ts` `_uptimeTimer` + main refresh, `perf-charts.ts` `_pollTimer`).
|
||||||
|
- **Server-pushed `server:*` events** — `core/events-ws.ts` turns each WS message into a `server:*` CustomEvent; feature modules listen and re-render through the *same* `innerHTML` paths.
|
||||||
|
|
||||||
|
So the one-line bug class in §1 reads "poll- **or** push-driven," not just poll.
|
||||||
|
|
||||||
|
### Genuinely-affected sites outside dashboard/perf
|
||||||
|
|
||||||
|
| Site | Driver | Shape | Notes |
|
||||||
|
| ---- | ------ | ----- | ----- |
|
||||||
|
| `core/entity-events.ts` `_invalidateAndReload` | push (`server:entity_changed`, `server:device_health_changed`) | full-**tab** rebuild via `loadTargetsTab` / `loadPictureSources` / `loadAutomations` / `loadIntegrations` | **highest blast radius.** A single pushed entity change tears down and rebuilds an entire tab — losing scroll, focus, open inline editors, restarting card-enter animations. |
|
||||||
|
| `features/game-integration.ts` event feed (`_eventMonitorTimer`) | poll (2 s) | `feed.innerHTML = events.slice(0,20).map(...)` | full 20-item list rebuild every 2 s while the panel is open. |
|
||||||
|
| `features/game-integration.ts` connection test (`_connectionTestTimer`) | poll | `panel.innerHTML = …` per tick | transient, low frequency. |
|
||||||
|
|
||||||
|
`entity-events.ts` already has the **L1 floor applied by hand**: a 600 ms debounce plus a diff check (`oldData === newData`, then length + `id` + `updated_at` compare) that skips the reload when nothing changed. That kills the *no-op* case — but a **real** change still does the full-tab teardown. This is exactly the §4-L1 limitation ("still tears down when content *does* differ"), live across the whole app.
|
||||||
|
|
||||||
|
### Counter-examples that already do it right
|
||||||
|
|
||||||
|
Two poll loops never flicker because they mutate `textContent` on a **stable structure** instead of rewriting `innerHTML`:
|
||||||
|
|
||||||
|
- `core/api.ts` `loadServerInfo` (connection-check poll) — `versionEl.textContent` / `statusEl.textContent`.
|
||||||
|
- `features/color-strips/test.ts` FPS sampler (1 s) — `valueEl.textContent` / `avgEl.textContent`.
|
||||||
|
|
||||||
|
These are live proof that "stable structure + mutate text node" is the fix — i.e. what L3 / Lit force by construction.
|
||||||
|
|
||||||
|
### What this changes about the plan
|
||||||
|
|
||||||
|
The §4 ladder was reasoned entirely around **per-cell** rendering, because that was the visible flicker. The push-driven finding surfaces a second, qualitatively different problem:
|
||||||
|
|
||||||
|
- **Problem A — cell value churn:** every poll, one value span. Loud only with animations. *Mostly fixed in `f6486f9`.* → wants `setText` / skip-if-unchanged.
|
||||||
|
- **Problem B — list/tab teardown:** on change/push, an entire list or tab. Loses scroll/focus/open editors. *Unaddressed.* `entity-events.ts` and the game feed are Problem B. → wants **keyed list reconciliation**.
|
||||||
|
|
||||||
|
Problem B is a **list-level** concern, not a cell-level one. In Lit terms it maps to a keyed `repeat()` directive over the tab/list body — the dashboard-card work in Phase 2 already needs this, but `entity-events.ts` needs it for tabs that §5 used to list as "out of scope." This does **not** change the chosen direction (Lit); it adds `entity-events.ts` as a first-class, high-priority target.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 4. Decision ladder
|
||||||
|
|
||||||
|
Walked through with the user 2026-05-26. Captured here so we don't re-litigate.
|
||||||
|
|
||||||
|
### L1 — drop-in `setInnerHtmlIfChanged` helper
|
||||||
|
- **Shape:** `WeakMap<Element, string>` cache; replace every `el.innerHTML = x` with `setInnerHtmlIfChanged(el, x)`.
|
||||||
|
- **Wins:** stops the no-change rewrites globally; zero behavior risk; ~30 call-site changes.
|
||||||
|
- **Misses:** still tears down DOM when content *does* differ (e.g. FPS row values change every tick); doesn't preserve focus/transition state inside a list.
|
||||||
|
- **Verdict:** floor, not ceiling. Worth doing for cells that don't get migrated to L3/Lit.
|
||||||
|
|
||||||
|
### L2 — lint guard
|
||||||
|
- **Shape:** pre-commit script greps `\.innerHTML\s*=` in `static/js/` outside an allowlist, fails the commit.
|
||||||
|
- **Wins:** keeps the discipline; cheap.
|
||||||
|
- **Misses:** only useful as a pair with L1+; bare guard with no helper makes contributors angry.
|
||||||
|
- **Verdict:** pair with whatever helper we land on.
|
||||||
|
|
||||||
|
### L3 — hand-rolled cell-component pattern
|
||||||
|
- **Shape:** `defineCell({ html, refs, mount, update, unmount })` + `reconcileList(host, items, binding)` + `setText/setClass/setAttr` mutators. ~150–300 lines of runtime.
|
||||||
|
- **Wins:** correct by construction; no dependencies; explicit about what mutates; composes with existing customize panel / color picker.
|
||||||
|
- **Misses:** we own the abstraction — it grows over time as we need transitions, async data, focus, devtools, error boundaries. Death by a thousand features.
|
||||||
|
- **Verdict:** second-best. Strong contender if zero-deps is a hard constraint.
|
||||||
|
|
||||||
|
### Lit migration of polling modules — **recommended**
|
||||||
|
- **Shape:** convert each perf cell + each dashboard card cell to a Lit web component. Use `html\`<span>${value}</span>\`` tagged-template + targeted diff. ~5KB gzip added to bundle, no new build step (esbuild handles it).
|
||||||
|
- **Wins:** solves the bug class by design; maintained by Google + community; web-components-based so no framework lock-in; composes with vanilla DOM trivially; mental model is close to current template-string idiom; non-polling code can stay vanilla forever.
|
||||||
|
- **Misses:** introduces a dependency; contributors learn one more thing; rare edge cases (`@html`-equivalent exists and reintroduces the bug if misused).
|
||||||
|
- **Verdict:** best ceiling-to-cost ratio for a small team. Recommended.
|
||||||
|
|
||||||
|
### Full framework rewrite (React / Vue / Solid)
|
||||||
|
- **Verdict:** overkill. The bug class lives in polling paths; the rest of the app is fine. Spending the migration budget on rebuilding IconSelect / EntitySelect / modals / customize panel / graph editor — none of which are broken — is a bad trade.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 5. Recommendation
|
||||||
|
|
||||||
|
**Lit for the polling-heavy modules.**
|
||||||
|
|
||||||
|
Migration plan:
|
||||||
|
|
||||||
|
### Phase 0 — spike (2-hour time-box)
|
||||||
|
- Convert `patches` cell to a Lit component, end to end.
|
||||||
|
- Verify it plays nicely with: color picker integration, customize panel layout reorder, `rerenderPerfGrid` reconciliation, `setPerfMode` toggle, hidden-by-env state, the spark tooltip handler.
|
||||||
|
- If any of those break in an unfixable way → pivot to L3.
|
||||||
|
- If they work → commit to the migration.
|
||||||
|
|
||||||
|
### Phase 1 — perf-charts cells
|
||||||
|
1. `patches` (already spiked)
|
||||||
|
2. `devices`
|
||||||
|
3. `fps` / `capture_fps` / `capture_fps_actual` (share a sparkline base class)
|
||||||
|
4. `cpu` / `ram` / `gpu` / `temp` (share `_sparkCardHtml` template family)
|
||||||
|
5. `network` / `device_latency` / `send_timing` / `errors`
|
||||||
|
|
||||||
|
Each is its own PR, dashboard stays working at every step. `renderPerfSection` becomes a registry of Lit components; `rerenderPerfGrid` becomes "reorder existing elements in the grid" (which it mostly already does).
|
||||||
|
|
||||||
|
### Phase 2 — dashboard card cells
|
||||||
|
6. Output target cards (running variant — biggest payoff, has live FPS + uptime + errors)
|
||||||
|
7. Output target cards (stopped variant)
|
||||||
|
8. Sync clock cards
|
||||||
|
9. Automation cards
|
||||||
|
10. Integration (HA / MQTT) cards
|
||||||
|
|
||||||
|
These get bigger wins from the migration because they have nested mutable state (FPS pill, errors cell, health dot, action button) that's currently rebuilt per poll via the `_updateRunningMetrics` path.
|
||||||
|
|
||||||
|
### Highest-impact: `entity-events.ts` tab reconciliation (sequence early)
|
||||||
|
|
||||||
|
`entity-events.ts` (§3.5) is the single highest-blast-radius site and is **not** on the dashboard — it re-renders the Targets / Integrations / Automations tabs on server push. Whether or not those tabs' cells become Lit components, the loader path (`loadTargetsTab` / `loadIntegrations` / `loadAutomations`) should switch from a full `innerHTML` rebuild to a **keyed list reconcile** (a Lit `repeat()` over the tab body). This preserves scroll / focus / open inline editors across pushes. If the goal is "biggest UX win first" rather than "lowest-risk first," sequence this ahead of Phase 2.
|
||||||
|
|
||||||
|
### Phase 3 — stopgap helper for the rest
|
||||||
|
Add `setInnerHtmlIfChanged` and apply to any remaining vanilla polling sites we don't plan to migrate. Add the L2 lint guard at this point — by now everything that polls is either Lit-managed or uses the helper.
|
||||||
|
|
||||||
|
### Out of scope (deliberately) — with one correction (2026-05-27)
|
||||||
|
|
||||||
|
- Targets tab, automations editor, integrations, scene presets — these render on-demand, **but they are ALSO re-rendered on server push** via `entity-events.ts` (see §3.5). The original claim that "the bug class doesn't bite them" was **wrong**: a pushed `server:entity_changed` does a full-tab `innerHTML` teardown. The *editor / on-demand views* can stay vanilla, but the **list/tab render that entity-events triggers needs reconciliation** (a keyed list diff) regardless of whether those cells become Lit components. Treat the entity-events reload path as **in-scope** — it is the highest-blast-radius Problem B site.
|
||||||
|
- Color strips editor, graph editor, settings — genuinely on-demand, no push re-render path, stay vanilla.
|
||||||
|
- Transport bar cells (CPU/Mem chip in the top bar) — read from the same perf payload, can be migrated opportunistically but not urgent.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 6. Open questions to settle before committing
|
||||||
|
|
||||||
|
These came up during the discussion and weren't resolved:
|
||||||
|
|
||||||
|
1. **Bundle-size budget.** Is +5KB acceptable? Current bundle is 2.7MB so this is noise — but worth confirming there isn't a strict cap (e.g. for slow networks / Android Chaquopy embed).
|
||||||
|
2. **Contributor model.** If the project will grow to multiple contributors, Lit's smaller community vs React's is a recruiting tradeoff. Currently solo-ish, so probably moot.
|
||||||
|
3. **Android TV target.** Chaquopy embed serves the same bundle. Lit works fine in any modern browser — Android TV WebView is Chromium-based. Should be a no-op but verify in Phase 0 spike.
|
||||||
|
4. **Long-term framework intent.** If there's a chance we ever migrate to React/Vue/Solid for the rest of the app, doing Lit now is *not* lock-in (web components are standard), but it does add a second mental model. Probably fine; just naming the tradeoff.
|
||||||
|
5. **Customize panel.** The drag-reorder code in `dashboard-customize.ts` mutates `.dashboard-section` DOM directly. Lit components reorder cleanly via `moveBefore` / `insertBefore` since they're just elements, but the dnd library needs to treat them as opaque drag handles. Phase 0 spike should confirm.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 7. Pointers
|
||||||
|
|
||||||
|
- Source files most relevant:
|
||||||
|
- `server/src/ledgrab/static/js/features/dashboard.ts`
|
||||||
|
- `server/src/ledgrab/static/js/features/perf-charts.ts`
|
||||||
|
- `server/src/ledgrab/static/js/features/dashboard-layout.ts` (cell ordering + visibility)
|
||||||
|
- `server/src/ledgrab/static/js/features/dashboard-customize.ts` (drag-reorder UI)
|
||||||
|
- `server/src/ledgrab/static/js/core/card-modes.ts` (mode toggle that hangs off section headers)
|
||||||
|
- `server/src/ledgrab/static/js/core/entity-events.ts` (push-driven tab reloads — §3.5, highest blast radius)
|
||||||
|
- `server/src/ledgrab/static/js/core/events-ws.ts` (WS → `server:*` CustomEvent dispatch)
|
||||||
|
- `server/src/ledgrab/static/js/features/game-integration.ts` (2 s event-feed list rebuild — §3.5)
|
||||||
|
- Most recent reconciliation commit: `f6486f9`.
|
||||||
|
- Related skill files in `~/.claude/skills/`: `frontend-patterns`, `documentation-lookup` (for Lit docs via Context7).
|
||||||
|
- Locale convention: `perf.*` for cross-card primitives, `dashboard.perf.*` for cell titles.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 8. If this doc gets stale
|
||||||
|
|
||||||
|
If you read this and the perf cells are already Lit components — delete this file. If you read this and there's a new flicker / focus / transition bug nobody can explain — search for `\.innerHTML\s*=` in `static/js/features/` **and `static/js/core/`** (`entity-events` lives in core) and you've probably found it. For *state loss on a server event* (scroll jump, focus drop, an inline editor closing itself), look at the `server:*` listeners in `core/entity-events.ts` first.
|
||||||
+180
@@ -0,0 +1,180 @@
|
|||||||
|
# Production Review — Remaining Items
|
||||||
|
|
||||||
|
Output of the multi-agent production review (security / Python / TypeScript /
|
||||||
|
performance / architecture / code-quality). Each entry below is something
|
||||||
|
the original audit flagged and the autonomous hardening pass deliberately
|
||||||
|
did **not** address — either because it needs design input, profiling
|
||||||
|
validation, or a multi-day refactor that should land in its own session.
|
||||||
|
|
||||||
|
The hardening pass landed everything else: see git log between `master` and
|
||||||
|
the head of the review branch for the applied changes (URL-scheme +
|
||||||
|
malicious-input rejection, IconSelect XSS escape, MiniSelect for forbidden
|
||||||
|
plain `<select>`s, WebSocket Origin allow-list, /docs auth-gate, security
|
||||||
|
headers middleware, streaming upload size caps, fire-and-forget task
|
||||||
|
tracking + drain resilience in MQTT runtime, discovery_watcher task
|
||||||
|
tracking, asyncio.gather return_exceptions, secret_box encryption for MQTT
|
||||||
|
/ Hue / Govee credentials with auto-migration, SSRF-validated update
|
||||||
|
redirects, single source of truth for IP classification in
|
||||||
|
`utils/net_classify.py`, allowlist + parity test for inbound WS events,
|
||||||
|
typed `Window` globals, and more).
|
||||||
|
|
||||||
|
## Items completed in the follow-up autonomous pass (2026-05-23)
|
||||||
|
|
||||||
|
- [x] **devices.py PATCH-without-url processor desync** — `update_device`
|
||||||
|
now falls back to `existing.url` so a rename / icon-only edit
|
||||||
|
always tells the processor the current address.
|
||||||
|
- [x] **WLED scheme integration test** on `/api/v1/devices` — covers
|
||||||
|
bare IPv4 (`http://`), public hostname (`https://`), and trailing-slash
|
||||||
|
normalisation; lives in `tests/api/routes/test_devices_routes.py`.
|
||||||
|
- [x] **IPv6 regression test** — `tests/test_url_scheme.py` now pins
|
||||||
|
public IPv6 → `https://`, ULA → `http://`, and documents the
|
||||||
|
Python-`ipaddress` documentation-prefix classification quirk.
|
||||||
|
- [x] **IconSelect XSS audit + defence-in-depth** — every caller
|
||||||
|
audited (all feed `icon` from constants or lookup tables); added
|
||||||
|
`sanitiseIcon` that rejects `<script>`, `javascript:`, `on*=`,
|
||||||
|
`<iframe>`, `<embed>`, `<object>` and warns to the console.
|
||||||
|
- [x] **`Optional[T]` → `T | None` (PEP 604)** — 55 sites cleaned via
|
||||||
|
`ruff --fix UP007`. The remaining `Union[…]` aliases for
|
||||||
|
pixel/colour/device-config typing converted by hand. `UP007` now
|
||||||
|
lives in `pyproject.toml` so the rule fires on new code.
|
||||||
|
- [x] **Hot-path magic numbers → named constants** — `processed_stream`
|
||||||
|
gains `_FILTER_RECHECK_EVERY_N_FRAMES`; `wled_target_processor`
|
||||||
|
gains `_SKIP_REPOLL_SLEEP_SECONDS`, `_DIAGNOSTICS_REPORT_INTERVAL_SECONDS`,
|
||||||
|
`_CSPT_RECHECK_EVERY_N_ITERATIONS`.
|
||||||
|
- [x] **`api/auth.py` `except Exception` tightening** — every WS send /
|
||||||
|
close site is now `except _WS_SEND_BENIGN_EXC` (a narrow tuple of
|
||||||
|
WebSocketDisconnect / RuntimeError / ConnectionError / OSError).
|
||||||
|
The auth-receive path catches the same set plus a final
|
||||||
|
`logger.exception` catch-all for observability on truly unexpected
|
||||||
|
shapes.
|
||||||
|
- [x] **`(window as any)` cleanup** — 59 static-property accesses
|
||||||
|
migrated to typed `window.<name>` against `global-types.d.ts`. The
|
||||||
|
remaining 7 sites use dynamic string indexing (`window[fnName]`)
|
||||||
|
and intentionally keep the cast (documented in the typedef file).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Architecture refactors (multi-day — own session)
|
||||||
|
|
||||||
|
- [ ] **Split `core/processing/value_stream.py`** (1856 LOC, 14 stream classes)
|
||||||
|
into a `value_streams/` package. Each value-stream type gets its own
|
||||||
|
file ≤300 LOC; `manager.py` holds `ValueStreamManager`.
|
||||||
|
- [ ] **Split `storage/color_strip_source.py`** (1841 LOC, 18 source kinds)
|
||||||
|
into a `color_strip_sources/` package mirroring `value_streams/`.
|
||||||
|
- [ ] **Frontend file splits** — `graph-editor.ts` (2707), `streams.ts`
|
||||||
|
(2335), `value-sources.ts` (1889), `types.ts` (1062). Highest-churn
|
||||||
|
modules; mixed UI / state / network responsibilities.
|
||||||
|
- [ ] **Layering reversal**: introduce a neutral `domain/` package and move
|
||||||
|
shared DTOs (`FilterInstance`, `CalibrationConfig`, etc.) into it so
|
||||||
|
`storage/` no longer imports `core/`. Eliminates 7+ layering
|
||||||
|
violations and the lazy-import hacks used to break the resulting
|
||||||
|
circulars.
|
||||||
|
- [ ] **`main.py` boot refactor** — extract import-time side effects into
|
||||||
|
`bootstrap.py` + `create_app()` factory. `lifespan()` becomes the
|
||||||
|
single place that wires stores and managers.
|
||||||
|
- [ ] **DI consolidation** — replace `api/dependencies.py` getter sprawl
|
||||||
|
(30+ `get_*()` functions reading a process-global `_deps` dict) with
|
||||||
|
a single typed `get_container()` dependency. Makes test-overrides
|
||||||
|
trivial; ban direct getter calls in handler bodies.
|
||||||
|
- [ ] **Exception hierarchy** — define `ledgrab/errors.py` (`LedGrabError`,
|
||||||
|
`NotFoundError`, `ValidationError`, `RemoteUnavailableError`,
|
||||||
|
`SSRFBlockedError`). Move HTTP translation into a FastAPI exception
|
||||||
|
handler. Stop raising `HTTPException` from `utils/safe_source.py`.
|
||||||
|
- [ ] **Lazy-import audit** — 289 in-function `from ledgrab.*` imports.
|
||||||
|
Specifically `core/processing/daylight_settings.py` imports
|
||||||
|
`api.dependencies` (core → api inversion). Pass the database in via
|
||||||
|
the constructor instead of service-locator lookup.
|
||||||
|
|
||||||
|
## Performance (profile before applying)
|
||||||
|
|
||||||
|
- [ ] **`composite_stream.py` blend modes** — pre-allocate scratch buffers
|
||||||
|
in `_blend_override / overlay / hard_light / soft_light / difference
|
||||||
|
/ exclusion`. Each currently allocates per frame (`mul`, `scr`,
|
||||||
|
`blended`, `np.where(...)`). At 100 LEDs × 30 fps × N layers this
|
||||||
|
adds up.
|
||||||
|
- [ ] **`mapped_stream` / `composite_stream` zone resize** — replace the
|
||||||
|
per-channel `np.interp` calls with a cached `floor/ceil/frac` LUT
|
||||||
|
(same trick as `wled_target_processor._fit_to_device`) or a single
|
||||||
|
`cv2.resize` call on the (N,3) array. `np.interp` allocates a new
|
||||||
|
`float64` array per channel per frame even on cache-hit.
|
||||||
|
- [ ] **`processed_stream._processing_loop`** — add ping-pong output
|
||||||
|
buffers and pass them as `out=` to filter `process_strip()` calls.
|
||||||
|
Today every filter that returns a fresh allocation costs us a copy
|
||||||
|
per frame. Also: the loop uses `time.sleep` instead of an
|
||||||
|
event-driven wait on the input stream — input updates faster than
|
||||||
|
30 fps see up to `frame_time` of latency.
|
||||||
|
- [ ] **`mqtt_client.py` `send_pixels`** — add a binary publish path (or
|
||||||
|
at minimum cache the outer dict skeleton). Today every frame
|
||||||
|
`pixels.tolist()` + `json.dumps` for ~300 LEDs × 30 fps × N devices.
|
||||||
|
- [ ] **Frontend `static/js/features/color-strips/test.ts`** — cache
|
||||||
|
`ImageData` per canvas (`canvas._imageData`); only re-create on
|
||||||
|
dimension change; use a `Uint32Array` view to copy pixels in one
|
||||||
|
loop instead of the per-pixel JS loop. Border-overlay rebuild on
|
||||||
|
every frame should also be debounced to dimension changes only.
|
||||||
|
- [ ] **`ws_stream.py` composite branch** — pre-allocate a `bytearray`
|
||||||
|
sized to the largest frame and write into slices instead of
|
||||||
|
`b"".join(tobytes()) per layer` every iteration. Same anti-pattern
|
||||||
|
in `wled_target_processor._broadcast_led_preview`.
|
||||||
|
- [ ] **Preview broadcast slow-client guard** — `asyncio.gather` over
|
||||||
|
preview clients waits for the slowest. Move to `asyncio.wait` with a
|
||||||
|
timeout and drop slow clients, or fire-and-forget with a
|
||||||
|
`ws.application_state` filter.
|
||||||
|
|
||||||
|
## Security (deferred — non-trivial or design-sensitive)
|
||||||
|
|
||||||
|
- [ ] **Content-Security-Policy header** — would need careful tuning
|
||||||
|
because the UI uses inline event handlers / Jinja templates.
|
||||||
|
Mis-set CSP would break the app silently. Defer until templates can
|
||||||
|
move to event-delegated handlers, then add a strict policy.
|
||||||
|
- [x] **`api/auth.py` exception specificity** — done in the 2026-05-23
|
||||||
|
pass; see top of file.
|
||||||
|
- [ ] **Hue bridge cert pinning** — `httpx.AsyncClient(verify=False)` for
|
||||||
|
Hue bridge (self-signed cert by design). Should record the
|
||||||
|
certificate fingerprint at pairing time and pin it on subsequent
|
||||||
|
requests; otherwise an on-path attacker can MITM the bridge.
|
||||||
|
|
||||||
|
## Mechanical / code-quality (low risk, high line-count)
|
||||||
|
|
||||||
|
- [ ] **i18n parity** — confirmed **328** keys missing in `ru.json` and
|
||||||
|
**325** missing in `zh.json` against the canonical English file.
|
||||||
|
Translation work — needs a native speaker, not a machine-translation
|
||||||
|
pass. Run `py scripts/diff_locale_keys.py` (or copy the diff block
|
||||||
|
out of the 2026-05-23 pass log) to get the exact key list.
|
||||||
|
- [x] **`Optional[T]` → `T | None`** — done; `UP007` now enforced via
|
||||||
|
`pyproject.toml` so the rule prevents regressions.
|
||||||
|
- [ ] **Hot-path `logger.error(f"...")` → `logger.error("... %s", e)`**
|
||||||
|
lazy-eval — 658 sites flagged by `ruff --select G004`. Deferred
|
||||||
|
because it is genuinely cosmetic at ERROR level (always emitted)
|
||||||
|
and the cumulative cost is negligible. Worth doing if/when ruff
|
||||||
|
gains a safe autofix, or as a Codemod in a dedicated session.
|
||||||
|
- [x] **Remaining `(window as any)` sites** — 59 migrated to typed
|
||||||
|
`window.<name>` access; the 7 surviving sites use dynamic string
|
||||||
|
indexing and are documented as the legitimate exception.
|
||||||
|
- [x] **Magic numbers → named constants** — done; see `processed_stream`
|
||||||
|
and `wled_target_processor` constants at the top of each module.
|
||||||
|
- [ ] **Standardise `from __future__ import annotations`** — partially
|
||||||
|
mooted by the UP007 cleanup. Files that previously relied on
|
||||||
|
`Optional`/`Union` no longer need the future import; the few that
|
||||||
|
already use `__future__` keep it for forward-reference convenience.
|
||||||
|
A blanket policy would still help — leave as a stylistic followup.
|
||||||
|
|
||||||
|
## Test gaps
|
||||||
|
|
||||||
|
- [x] **Route-level integration test** for the WLED scheme inference —
|
||||||
|
done; covers create + update in `tests/api/routes/test_devices_routes.py::TestWLEDSchemeInference`.
|
||||||
|
- [x] **IPv6 public address regression** — done; pinned in
|
||||||
|
`tests/test_url_scheme.py` for both bracketless and bracketed forms.
|
||||||
|
|
||||||
|
## Pre-existing issues surfaced during the audit (not in our diff)
|
||||||
|
|
||||||
|
These were flagged by the auditors but predate the review session — kept
|
||||||
|
here as a future-work backlog:
|
||||||
|
|
||||||
|
- [x] **`icon-select.ts:_buildGrid` `item.icon` is interpolated raw** —
|
||||||
|
audited; all callers pass project-owned literals or table-lookup
|
||||||
|
results. Added a runtime sanitiser as defence-in-depth.
|
||||||
|
- [x] **`devices.py` `manager.update_device_info(device_url=update_data.url)`**
|
||||||
|
None-on-PATCH path — fixed; now falls back to `existing.url`.
|
||||||
|
- [ ] **`asyncio.gather` over uncapped client lists** in preview broadcasts
|
||||||
|
— slow clients block the loop. Already noted under Performance
|
||||||
|
above; pre-existing.
|
||||||
@@ -1,5 +1,462 @@
|
|||||||
# LedGrab TODO
|
# LedGrab TODO
|
||||||
|
|
||||||
|
## HTTP polling automation trigger
|
||||||
|
|
||||||
|
Goal: a new automation trigger that periodically polls an HTTP endpoint
|
||||||
|
and activates a scene when the response matches a condition. Split into
|
||||||
|
three single-responsibility entities so the endpoint can be reused
|
||||||
|
beyond automations (e.g. as a value-source driving brightness/color):
|
||||||
|
|
||||||
|
- `HTTPEndpoint` (storage/http_endpoint.py) — connection definition:
|
||||||
|
URL + auth + headers + timeout. NO polling cadence; NO extraction.
|
||||||
|
- `HTTPValueSource` (storage/value_source.py, source_type='http') —
|
||||||
|
references an endpoint + owns json_path + interval + min/max + EMA
|
||||||
|
smoothing. Backed by `HTTPValueStream` (core/processing/value_stream.py)
|
||||||
|
which lives under the existing `ValueStreamManager` (ref-counted,
|
||||||
|
one poll task per unique value source).
|
||||||
|
- `HTTPPollRule` (storage/automation.py) — thin: `{value_source_id,
|
||||||
|
operator, value}`. Reads `stream.get_raw_value()` from the value
|
||||||
|
source and compares with `_apply_operator`.
|
||||||
|
|
||||||
|
Pivoted from a 2-entity shape mid-build (was: HTTPSource+rule with
|
||||||
|
interval+json_path mushed). The 3-entity shape mirrors HA's pattern
|
||||||
|
(HomeAssistantSource → HAEntityValueSource → rule).
|
||||||
|
|
||||||
|
### Phase 1 — endpoint + value source + thin rule (backend) ✅
|
||||||
|
|
||||||
|
- [x] `storage/http_endpoint.py` — `HTTPEndpoint` dataclass with
|
||||||
|
secret_box auth_token encryption + `__post_init__` plaintext
|
||||||
|
invariant. NO `default_interval_s` (moved to value source).
|
||||||
|
- [x] `storage/http_endpoint_store.py` — `HTTPEndpointStore` with
|
||||||
|
`_migrate_plaintext_tokens()`. ID prefix `htep_`.
|
||||||
|
- [x] `storage/database.py` — `"http_endpoints"` in `_ENTITY_TABLES`
|
||||||
|
(replaces the old `"http_sources"`).
|
||||||
|
- [x] `storage/value_source.py` — added `HTTPValueSource` alongside
|
||||||
|
`HAEntityValueSource` (endpoint_id, json_path, interval_s,
|
||||||
|
min/max, smoothing). Registered in `_VALUE_SOURCE_MAP`.
|
||||||
|
- [x] `storage/value_source_store.py` — CRUD branch for `source_type =
|
||||||
|
"http"` + new kwargs on create/update.
|
||||||
|
- [x] `core/processing/value_stream.py` — `HTTPValueStream` with poll
|
||||||
|
task + `get_value()` (normalized 0-1) + `get_raw_value()` (raw
|
||||||
|
extracted value). Dispatched in `ValueStreamManager._create_stream`.
|
||||||
|
Manager now takes `http_endpoint_store` so the stream can resolve
|
||||||
|
endpoints at fetch time.
|
||||||
|
|
||||||
|
### Phase 2 — rule + engine wiring ✅
|
||||||
|
|
||||||
|
- [x] `storage/automation.py` — `HTTPPollRule` is now thin: just
|
||||||
|
`{value_source_id, operator, value}` (no http_source_id, no
|
||||||
|
json_path on the rule). Legacy keys silently dropped on load.
|
||||||
|
- [x] `core/automations/automation_engine.py` — drops the standalone
|
||||||
|
http_poll_manager; takes `value_stream_manager`. Engine
|
||||||
|
`_sync_value_stream_refs` acquires/releases value streams for
|
||||||
|
every enabled HTTPPollRule, mirroring the HA/MQTT sync pattern.
|
||||||
|
`_evaluate_http_poll` reads `stream.get_raw_value()` and applies
|
||||||
|
the operator. `_apply_operator` kept at module top.
|
||||||
|
- [x] `api/schemas/automations.py` — RuleSchema fields are now
|
||||||
|
`value_source_id + operator + value` (dropped http_source_id +
|
||||||
|
json_path).
|
||||||
|
- [x] `api/routes/automations.py` — `http_poll` factory updated.
|
||||||
|
|
||||||
|
### Phase 3 — CRUD endpoints + wiring ✅
|
||||||
|
|
||||||
|
- [x] `api/schemas/http_endpoints.py` — Create/Update/Response/List/Test
|
||||||
|
(no interval field; that's on the value source).
|
||||||
|
- [x] `api/routes/http_endpoints.py` — full CRUD + `/test` +
|
||||||
|
plaintext-http-token warning.
|
||||||
|
- [x] `api/schemas/value_sources.py` — `HTTPValueSource{Create,Update,Response}`
|
||||||
|
added to the discriminated unions.
|
||||||
|
- [x] `api/routes/value_sources.py` — `_RESPONSE_MAP` entry for
|
||||||
|
`HTTPValueSource`.
|
||||||
|
- [x] `api/__init__.py` — `http_endpoints_router` registered.
|
||||||
|
- [x] `api/dependencies.py` — `get_http_endpoint_store` (dropped the
|
||||||
|
http_poll_manager getter).
|
||||||
|
- [x] `main.py` — instantiate `HTTPEndpointStore`, pass it through
|
||||||
|
`ProcessorDependencies`, wire `value_stream_manager` +
|
||||||
|
`value_source_store` into `AutomationEngine`.
|
||||||
|
- [x] `core/processing/processor_manager.py` — `ProcessorDependencies`
|
||||||
|
gains `http_endpoint_store`; threaded into `ValueStreamManager`.
|
||||||
|
|
||||||
|
### Phase 4 — tests ✅
|
||||||
|
|
||||||
|
- [x] `tests/storage/test_http_endpoint_store.py` — 14 tests (CRUD +
|
||||||
|
auth_token encryption + headers + case-insensitive Authorization).
|
||||||
|
- [x] `tests/core/test_automation_engine.py` — `TestApplyOperator` +
|
||||||
|
`TestHTTPPollRuleEvaluation` (new shape: mock ValueStreamManager
|
||||||
|
with `_streams` dict) + `TestSyncValueStreamRefs` (acquire /
|
||||||
|
release / disabled-ignored) + `TestHTTPValueStreamExtraction`
|
||||||
|
(`_extract_simple_path` now lives in value_stream.py).
|
||||||
|
- [x] `tests/api/routes/test_http_endpoints_routes.py` — CRUD shape, no
|
||||||
|
auth_token leak in responses, schema-layer method allowlist,
|
||||||
|
CRLF / invalid header rejection, `/test` endpoint, LAN policy.
|
||||||
|
- [x] Removed: `tests/core/test_http_poll_manager.py` (manager deleted —
|
||||||
|
polling now lives inside `HTTPValueStream`).
|
||||||
|
- [x] Full suite: 1426 passed, ruff clean.
|
||||||
|
|
||||||
|
### Phase 5 — frontend ✅
|
||||||
|
|
||||||
|
- [x] `static/js/features/http-endpoints.ts` (new, ~540 LOC) — endpoint
|
||||||
|
CRUD, modal subclass with dirty-check, headers row editor, test
|
||||||
|
result rendering, card builder, event delegation. Mirrors
|
||||||
|
`home-assistant-sources.ts`.
|
||||||
|
- [x] `templates/modals/http-endpoint-editor.html` (new) — sectioned
|
||||||
|
rack-panel modal (Identity / Request / Headers / Notes) with
|
||||||
|
IconSelect method picker, password-toggle on auth token, inline
|
||||||
|
Test button + result block.
|
||||||
|
- [x] `static/js/features/value-sources.ts` — added `http` branch with
|
||||||
|
EntitySelect over `httpEndpointsCache`, edit-data/defaults,
|
||||||
|
`onValueSourceTypeChange` section toggle, save-payload assembly
|
||||||
|
+ required-field validation.
|
||||||
|
- [x] `templates/modals/value-source-editor.html` — new
|
||||||
|
`#value-source-http-section` with endpoint picker + json_path +
|
||||||
|
interval + min/max + smoothing.
|
||||||
|
- [x] `static/js/features/automations.ts` — `http_poll` rule type with
|
||||||
|
operator IconSelect + value-source EntitySelect; hides Value
|
||||||
|
field when operator is `exists`.
|
||||||
|
- [x] `static/js/features/integrations.ts` — `csHTTPEndpoints` section,
|
||||||
|
tree/tab entry, render + reconcile + delegation paths.
|
||||||
|
- [x] `static/js/types.ts` — `HTTPEndpoint`, `HTTPMethod`,
|
||||||
|
`HTTPEndpointListResponse`, `HTTPTestRequest/Response`,
|
||||||
|
`HTTPValueSource`, `HTTPPollOperator`; extended `RuleType` +
|
||||||
|
`AutomationRule`.
|
||||||
|
- [x] `static/js/core/state.ts` — `httpEndpointsCache` (`/http/endpoints`).
|
||||||
|
- [x] `static/js/core/icons.ts` — `http: P.globe` in
|
||||||
|
`_valueSourceTypeIcons`.
|
||||||
|
- [x] `templates/index.html` — includes
|
||||||
|
`modals/http-endpoint-editor.html`.
|
||||||
|
- [x] Locales: 77 new keys per file in `en.json` / `ru.json` /
|
||||||
|
`zh.json` (parity confirmed).
|
||||||
|
- [x] Verification: `npx tsc --noEmit` clean; `npm run build` clean
|
||||||
|
(app.bundle.css 366.6kb, app.bundle.js 2.7mb).
|
||||||
|
|
||||||
|
### Follow-ups (out of scope for initial PR)
|
||||||
|
|
||||||
|
- [ ] **Global concurrency cap / minimum interval.** Each
|
||||||
|
`HTTPValueStream` runs its own task at `interval_s` (min 1s); no
|
||||||
|
project-wide cap. Reviewer flagged: pick a min (e.g. 5s) + max
|
||||||
|
active runtimes (e.g. 32) + shared `httpx.AsyncClient` with
|
||||||
|
`limits=httpx.Limits(max_connections=N)`.
|
||||||
|
- [ ] **DNS-rebinding hardening.** `safe_request_bounded` validates
|
||||||
|
the URL hostname's resolved IPs once; httpx independently
|
||||||
|
re-resolves. The window is short but not zero. True fix: pin
|
||||||
|
to the validated IP + set Host header (and SNI for HTTPS). This
|
||||||
|
affects every outbound caller (`safe_fetch`, weather, image
|
||||||
|
sources) — handle as a project-wide hardening, not local to
|
||||||
|
this feature.
|
||||||
|
- [ ] **`delete_http_endpoint` orphan refs.** When an admin deletes an
|
||||||
|
endpoint referenced by N value sources, the value-stream task
|
||||||
|
keeps polling until its source is also deleted. Same shape as
|
||||||
|
the MQTT defect — fix both together (refuse-with-409 when in
|
||||||
|
use, or cascade value-source deletion).
|
||||||
|
- [ ] **Per-endpoint `connected` / last-poll status on the response**
|
||||||
|
(frontend agent flagged). `HTTPEndpointResponse` has no live
|
||||||
|
status, unlike HA/MQTT sources. Card LEDs default to "on".
|
||||||
|
Could aggregate `last_status_code` / `last_error` from all
|
||||||
|
`HTTPValueStream` instances referencing the endpoint and surface
|
||||||
|
on `GET /http/endpoints/{id}`.
|
||||||
|
- [x] **Per-endpoint live `/test` after save** — added `POST
|
||||||
|
/http/endpoints/{id}/test` (runs stored config server-side so the
|
||||||
|
auth token never round-trips) and wired a flask-icon test action
|
||||||
|
on the endpoint card (toasts the result). Custom-headers section
|
||||||
|
and inline test-result UI in the editor modal also restyled to
|
||||||
|
match the `.group-child-row` and result-card vocabulary.
|
||||||
|
- [ ] **Dedicated icon for HTTP value source / endpoint** (frontend
|
||||||
|
agent flagged). Both use `P.globe` — visually fine in practice
|
||||||
|
but adding a `cable`/`webhook` glyph in `icon-paths.ts` would
|
||||||
|
improve differentiation.
|
||||||
|
|
||||||
|
## Multi-broker MQTT refactor
|
||||||
|
|
||||||
|
Goal: drop the global `MQTTService` / `MQTTConfig`. Every MQTT consumer
|
||||||
|
references an `MQTTSource.id`; `MQTTManager` is the only entry point.
|
||||||
|
`MQTTManager` + `MQTTRuntime` already exist — the job is to migrate every
|
||||||
|
caller off the legacy path, then delete it.
|
||||||
|
|
||||||
|
### Phase 1 — `mqtt_source_id` on Z2M target
|
||||||
|
|
||||||
|
- [x] Field on `Z2MLightOutputTarget` storage dataclass (+ to/from_dict)
|
||||||
|
- [x] Field on Z2M create/update/response schemas
|
||||||
|
- [x] Validate referenced `MQTTSource` exists at create/update
|
||||||
|
- [x] Thread through `output_target_store.create_z2m_light_target` + update
|
||||||
|
- [x] Thread through `ProcessorManager.add_z2m_light_target`
|
||||||
|
- [x] Thread through `Z2MLightTargetProcessor` constructor
|
||||||
|
|
||||||
|
### Phase 2 — Z2M processor uses `MQTTManager`
|
||||||
|
|
||||||
|
- [x] Replace `_mqtt_service` with `_mqtt_runtime` acquired from manager
|
||||||
|
- [x] `start()` acquire / `stop()` release
|
||||||
|
- [x] `_publish_payload` → `self._mqtt_runtime.publish(...)`
|
||||||
|
- [x] `turn_off_lights` borrow-pattern via manager (mirror HA-light)
|
||||||
|
- [x] Add `mqtt_manager` to `ProcessorDependencies` / `TargetContext`
|
||||||
|
|
||||||
|
### Phase 3 — Z2M editor UI
|
||||||
|
|
||||||
|
- [x] Add MQTT broker `EntitySelect` in Routing
|
||||||
|
- [x] Reuse `mqttSourcesCache`
|
||||||
|
- [x] Wire `mqtt_source_id` into edit-load + save payload + validation
|
||||||
|
|
||||||
|
### Phase 4 — DIY MQTT device (`MQTTLEDClient`)
|
||||||
|
|
||||||
|
- [x] `mqtt_source_id` field on `Device` storage
|
||||||
|
- [x] Field on `device_config.MQTTConfig`
|
||||||
|
- [x] `MQTTLEDClient` acquires runtime in `connect()`, releases in `close()`
|
||||||
|
- [x] Provider threads `mqtt_manager` via `ProviderDeps`
|
||||||
|
- [x] Device editor: MQTT source picker shown for `device_type=mqtt`. Turned
|
||||||
|
out the API layer was *also* missing it (the TODO's "backend accepts the
|
||||||
|
field" was wrong — `mqtt_source_id` lived in `device_store` +
|
||||||
|
`device_config.MQTTConfig` but was dropped by `DeviceCreate/Update/Response`
|
||||||
|
and the routes). Added: schema fields + route threading + referenced-source
|
||||||
|
validation (`_validate_mqtt_source_exists`, mirrors output_targets) +
|
||||||
|
`except HTTPException: raise` guard in `update_device` (it was masking its
|
||||||
|
own 4xx as 500). Frontend: broker `EntitySelect` (reusing `mqttSourcesCache`)
|
||||||
|
in both the add-device (`device-discovery.ts`) and settings
|
||||||
|
(`devices.ts`) modals — shown for `device_type=mqtt`, wired into
|
||||||
|
load/save/validate/dirty-check/clone. Empty = "first available broker".
|
||||||
|
4 regression tests in `test_devices_routes.py::TestMqttSourceId`; full
|
||||||
|
suite 1567 passing; en/ru/zh keys added.
|
||||||
|
|
||||||
|
### Phase 5 — `AutomationEngine`
|
||||||
|
|
||||||
|
- [x] Drop `mqtt_service` ctor parameter
|
||||||
|
- [x] Drop legacy fallback in `_evaluate_mqtt` (rule must reference a source)
|
||||||
|
|
||||||
|
### Phase 6 — `api/routes/system.py`
|
||||||
|
|
||||||
|
- [x] Replace integration status with `mqtt_manager.get_all_sources_status()`
|
||||||
|
- [x] Update frontend dashboard payload (MQTT widget now expects a list of
|
||||||
|
sources instead of a single `enabled`/`connected` pair — surface in UI).
|
||||||
|
Done: `dashboard.ts` `_renderMQTTIntegrationCard` renders one card per
|
||||||
|
`mqttStatus.connections` entry; `_updateIntegrationsInPlace` iterates the
|
||||||
|
list.
|
||||||
|
|
||||||
|
### Phase 7 — Startup migration
|
||||||
|
|
||||||
|
- [x] Seed a "Default Broker" `MQTTSource` if legacy YAML / env had a
|
||||||
|
broker configured and the store is empty (`core.mqtt.legacy_migration`)
|
||||||
|
- [x] Deprecation warning logged on migration; YAML/env no longer read after
|
||||||
|
|
||||||
|
### Phase 8 — Remove legacy
|
||||||
|
|
||||||
|
- [x] Delete `core/mqtt/mqtt_service.py`
|
||||||
|
- [x] Delete `set_mqtt_service` / `get_mqtt_service` (mqtt_client.py)
|
||||||
|
- [x] Remove `MQTTService` from `main.py`
|
||||||
|
- [x] Remove `MQTTConfig` + `resolve_mqtt_password` from `config.py`
|
||||||
|
- [x] Remove `mqtt: MQTTConfig` from `Config` (with `extra="ignore"` so legacy
|
||||||
|
YAML still loads)
|
||||||
|
|
||||||
|
### Phase 9 — Verification
|
||||||
|
|
||||||
|
- [x] `pytest tests/ --no-cov -q` clean (973 passing; removed obsolete
|
||||||
|
`test_default_mqtt_disabled`)
|
||||||
|
- [x] `ruff check src/` clean
|
||||||
|
- [x] `tsc --noEmit` + `npm run build`
|
||||||
|
- [ ] Smoke test: Z2M target on a configured MQTT Source publishes to broker
|
||||||
|
(manual)
|
||||||
|
|
||||||
|
## Refactor: typed output-target factories + auto-registry
|
||||||
|
|
||||||
|
Replaced `target_type` string elif chains in `OutputTargetStore` and
|
||||||
|
`OutputTarget.from_dict` with: (1) `__init_subclass__` registry for
|
||||||
|
deserialization, (2) per-type typed `create_*_target` /
|
||||||
|
`update_*_target` methods called directly from the route layer's
|
||||||
|
`match data:` dispatch. API contract unchanged, no DB migration.
|
||||||
|
|
||||||
|
### Phase 1 — Registry on `OutputTarget`
|
||||||
|
|
||||||
|
- [x] Added `_registry` + `_type_key` ClassVars + `__init_subclass__(*, type_key)`
|
||||||
|
- [x] Rewrote `OutputTarget.from_dict` to dispatch via registry
|
||||||
|
- [x] Declared `type_key="led"` / `"ha_light"` / `"z2m_light"` on the three subclasses
|
||||||
|
|
||||||
|
### Phase 2 — Typed `create_*_target` methods
|
||||||
|
|
||||||
|
- [x] Extracted `_resolve_brightness`, `_resolve_transition`, `_check_unique_name`,
|
||||||
|
`_new_id_and_now`, `_finalize` helpers on the store
|
||||||
|
- [x] Added `create_wled_target` / `create_ha_light_target` / `create_z2m_light_target`
|
||||||
|
with per-type defaults (transition 0.5/0.3, update_rate 2.0/5.0) baked into
|
||||||
|
their signatures
|
||||||
|
|
||||||
|
### Phase 3 — Typed `update_*_target` methods
|
||||||
|
|
||||||
|
- [x] Added `update_wled_target` / `update_ha_light_target` / `update_z2m_light_target`
|
||||||
|
with `_begin_update` / `_commit_update` helpers
|
||||||
|
- [x] Each typed update method validates the target's class before mutating
|
||||||
|
|
||||||
|
### Phase 4 — Route migration
|
||||||
|
|
||||||
|
- [x] `create_target` route uses `match data:` to call typed store methods —
|
||||||
|
no more `getattr(data, "x", default)` pyramid
|
||||||
|
- [x] `update_target` route uses `match data:` and computes `settings_changed` /
|
||||||
|
`css_changed` / `brightness_changed` per-arm from typed fields
|
||||||
|
- [x] Helpers `_build_ha_mappings`, `_build_z2m_mappings`,
|
||||||
|
`_validate_device_exists`, `_resolve_effective_color_vs_id` extracted
|
||||||
|
|
||||||
|
### Phase 5 — Decision: keep both shims
|
||||||
|
|
||||||
|
After grepping for callers, `src/ledgrab/core/scenes/scene_activator.py:90`
|
||||||
|
calls `target_store.update_target(target_id, **changed)` with a dynamically
|
||||||
|
built dict — it legitimately doesn't know the target's type at the call site.
|
||||||
|
The shims are now ~30-line dispatchers that route to typed methods (no more
|
||||||
|
inline construction elif chains), so the original anti-pattern is gone while
|
||||||
|
the generic API remains available for "don't-know-the-type" callers like the
|
||||||
|
scene activator. Tests continue to use the shorthand `create_target("A", "led")`
|
||||||
|
form without churn.
|
||||||
|
|
||||||
|
### Phase 6 — Verify
|
||||||
|
|
||||||
|
- [x] `ruff check` clean on all modified files
|
||||||
|
- [x] `py -3.13 -m pytest tests/ --no-cov -q` — 974 passed (was 974 before)
|
||||||
|
- [ ] Manual smoke test in UI: create/edit/delete each of the three target types
|
||||||
|
|
||||||
|
## Custom card icons — extend to all card types
|
||||||
|
|
||||||
|
Migrate the existing icon-plate work (devices, LED targets, HA-light targets)
|
||||||
|
to all remaining card types. ~17 entity types. Branch: `feat/icons-everywhere`.
|
||||||
|
|
||||||
|
### Foundation
|
||||||
|
|
||||||
|
- [x] Refactor `icon-picker.ts` — replace hardcoded 2-entry `_adapters`
|
||||||
|
record with a `Map<EntityType, EntityTypeAdapter>` and expose
|
||||||
|
`registerIconEntityType()` for feature modules to register their
|
||||||
|
own. Added `makeSimpleIconAdapter()` helper that reduces a
|
||||||
|
registration to ~6 lines.
|
||||||
|
- [x] Generalised `bodyExtras` for discriminated routes (output-targets
|
||||||
|
`target_type` etc.) — now keyed off id, adapter does its own
|
||||||
|
lookup.
|
||||||
|
- [x] `_onDocumentClick` accepts any registered type instead of
|
||||||
|
hardcoded device/target check.
|
||||||
|
- [x] Locale entity-type labels added to en/ru/zh for 18 new types
|
||||||
|
(picture_source, audio_source, weather_source, value_source,
|
||||||
|
mqtt_source, ha_source, automation, scene_preset, sync_clock,
|
||||||
|
game_integration, audio_processing_template, pattern_template,
|
||||||
|
capture_template, pp_template, cspt, audio_template, gradient,
|
||||||
|
color_strip_source, asset).
|
||||||
|
|
||||||
|
### Backend (storage + schemas + routes per entity)
|
||||||
|
|
||||||
|
Recipe: add `icon: str = ""` + `icon_color: str = ""` to dataclass,
|
||||||
|
emit-when-truthy in `to_dict`, default `""` in `from_dict`; add 3
|
||||||
|
`Optional[str]` Field defs to Create/Response/Update schemas; thread
|
||||||
|
`getattr(entity, "icon", "") or ""` into the response builder.
|
||||||
|
SQLite JSON-blob storage means **no migration required**.
|
||||||
|
|
||||||
|
- [x] Integrations (6): weather_sources, value_sources, mqtt_source,
|
||||||
|
home_assistant_source, sync_clocks, game_integration
|
||||||
|
- [x] Streams (10): picture_source, audio_source, audio_template,
|
||||||
|
audio_processing_template, pattern_template, postprocessing_template,
|
||||||
|
color_strip_processing_template, color_strip_source, gradient,
|
||||||
|
capture_template (`storage/template.py` — was missed by initial pass)
|
||||||
|
- [x] Other (3): automation, scene_preset, asset
|
||||||
|
|
||||||
|
### Frontend (per feature module)
|
||||||
|
|
||||||
|
For each card render call:
|
||||||
|
|
||||||
|
- Use the new `core/card-icon.ts` helper:
|
||||||
|
`...makeCardIconFields('<type>', entity.id, entity)` spread into the
|
||||||
|
mod-card head — computes `iconHtml`/`iconColor`/`iconAttrs` in one go.
|
||||||
|
- Register the entity type in the feature module via
|
||||||
|
`registerIconEntityType('<type>', makeSimpleIconAdapter({ … }))`.
|
||||||
|
|
||||||
|
Modules wired:
|
||||||
|
|
||||||
|
- [x] streams.ts (7 cards: picture, capture, pp, cspt, audio source,
|
||||||
|
audio template, gradient — built-in gradients skip the plate)
|
||||||
|
- [x] automations.ts
|
||||||
|
- [x] scene-presets.ts
|
||||||
|
- [x] sync-clocks.ts
|
||||||
|
- [x] weather-sources.ts
|
||||||
|
- [x] value-sources.ts (bodyExtras propagates `source_type`)
|
||||||
|
- [x] mqtt-sources.ts
|
||||||
|
- [x] home-assistant-sources.ts
|
||||||
|
- [x] game-integration.ts
|
||||||
|
- [x] audio-processing-templates.ts
|
||||||
|
- [x] assets.ts
|
||||||
|
- [x] color-strips/cards.ts (bodyExtras propagates `source_type`)
|
||||||
|
- [WONTDO] pattern-templates.ts — uses legacy `wrapCard({content, actions})`
|
||||||
|
string API, not the mod-card system. Migration would be a separate
|
||||||
|
effort and the cards are tiny (name + rect count) so the value is low.
|
||||||
|
|
||||||
|
### Discriminated routes
|
||||||
|
|
||||||
|
Adapters provide `bodyExtras` to inject the discriminator field on PUT
|
||||||
|
so the Pydantic discriminated-union route validators don't reject the
|
||||||
|
icon-only update:
|
||||||
|
|
||||||
|
- output-targets → `target_type` (already wired before)
|
||||||
|
- color-strip-sources → `source_type`
|
||||||
|
- audio-sources → `source_type`
|
||||||
|
- value-sources → `source_type`
|
||||||
|
- picture-sources → `stream_type`
|
||||||
|
|
||||||
|
### Verification
|
||||||
|
|
||||||
|
- [x] `cd server && ruff check src/ tests/` clean
|
||||||
|
- [x] `cd server && npx tsc --noEmit` clean
|
||||||
|
- [x] `cd server && npm run build` produces 2.6 MB bundle
|
||||||
|
- [x] `cd server && py -3.13 -m pytest tests/ --no-cov -q` — 949 passed
|
||||||
|
- [ ] Manual: open picker on each card type, confirm save persists,
|
||||||
|
confirm channel-color preview matches the live card
|
||||||
|
|
||||||
|
## Device Event Notifications
|
||||||
|
|
||||||
|
Notify the user when LED devices come online/go offline (configured targets), and when new
|
||||||
|
WLED/serial devices are discovered or disappear from the LAN/USB. Each event class has a
|
||||||
|
configurable channel: `none` | `snack` | `os` | `both`. OS channel uses Web Notifications
|
||||||
|
(works in any browser tab and in the PWA shell — no platform-specific Python).
|
||||||
|
|
||||||
|
Branch: `feat/device-event-notifications`. Default ON.
|
||||||
|
|
||||||
|
### Backend
|
||||||
|
|
||||||
|
- [x] `core/devices/discovery_watcher.py` — long-running mDNS browser
|
||||||
|
(`AsyncServiceBrowser` kept alive for the process lifetime) + 10 s serial-port
|
||||||
|
poller. Fires `device_discovered`/`device_lost` via `processor_manager.fire_event`,
|
||||||
|
suppresses events for URLs already in `device_store`. Seeded ports do NOT generate
|
||||||
|
startup-time toasts.
|
||||||
|
- [x] Wired into `lifespan` (`main.py`). Gated by `notification_preferences.
|
||||||
|
background_discovery_enabled`. Default True. Stops before health monitor stop.
|
||||||
|
- [x] `api/schemas/preferences.py` — `NotificationPreferences` Pydantic v2 model with
|
||||||
|
the 4-event channel matrix, `background_discovery_enabled`, `startup_grace_sec`
|
||||||
|
(0..300), `flap_debounce_sec` (0..60).
|
||||||
|
- [x] `api/routes/preferences.py` — `GET/PUT /api/v1/preferences/notifications`,
|
||||||
|
persisted under `db.set_setting("notification_preferences", …)`. Corrupt stored
|
||||||
|
values fall back to defaults instead of 500.
|
||||||
|
- [x] Reuses existing `device_health_changed` event from `device_health.py` (already
|
||||||
|
fires online/offline transitions on the same event bus).
|
||||||
|
- [x] Tests: 7 in `tests/test_preferences_notifications_api.py`, 6 in
|
||||||
|
`tests/test_discovery_watcher.py`. Full pytest suite still 899 passing.
|
||||||
|
|
||||||
|
### Frontend
|
||||||
|
|
||||||
|
- [x] `js/features/notifications-watcher.ts` — listens to the three `server:*` DOM
|
||||||
|
events. Applies user prefs. Pipeline: startup grace → flap debounce → bulk
|
||||||
|
coalesce (≥3 events / 800 ms collapse to one summary).
|
||||||
|
- [x] Web Notification permission requested from the Settings → Notifications panel
|
||||||
|
via a user-gesture button. State chip reflects granted/denied/default.
|
||||||
|
- [x] Settings panel — new "Notifications" subtab between Backup and Appearance.
|
||||||
|
4 IconSelects (`none`/`snack`/`os`/`both`) + background-discovery toggle +
|
||||||
|
permission row + Test-notification button.
|
||||||
|
- [x] i18n: `settings.notifications.*` and `notifications.*` keys in en/ru/zh.
|
||||||
|
|
||||||
|
### Verification (notifications)
|
||||||
|
|
||||||
|
- [x] `npx tsc --noEmit` clean, `npm run build` produces 2.5 MB bundle.
|
||||||
|
- [x] `ruff check src/ tests/` clean. 899/899 pytest pass.
|
||||||
|
- [x] App import smoke-test (`from ledgrab.main import app`) loads 233 routes
|
||||||
|
without errors.
|
||||||
|
- [ ] Real-hardware test pending — verify on user's network:
|
||||||
|
(1) plug a fresh WLED in → snack toast appears, (2) configure it → next
|
||||||
|
offline transition fires both snack + OS toast, (3) Background-discovery
|
||||||
|
toggle off → no more discovered/lost events.
|
||||||
|
|
||||||
|
### Out of scope for v1
|
||||||
|
|
||||||
|
- Per-device-type granularity (we ship one matrix per event-type, no device-type split)
|
||||||
|
- Per-device mute list (deferred — user can globally toggle off if noisy)
|
||||||
|
- Native OS toast via Windows winrt API (Web Notifications cover the use case;
|
||||||
|
also avoids the `os_notification_listener` feedback loop)
|
||||||
|
- Notification history panel — could land later as the reserved `alerts` dashboard cell
|
||||||
|
|
||||||
## Server shutdown action
|
## Server shutdown action
|
||||||
|
|
||||||
Let user choose what happens to LED targets on server shutdown.
|
Let user choose what happens to LED targets on server shutdown.
|
||||||
@@ -374,9 +831,285 @@ Beyond the `/proc`-based AndroidMetricsProvider that's now in place:
|
|||||||
|
|
||||||
## Refactor: Per-Provider Device Configs
|
## Refactor: Per-Provider Device Configs
|
||||||
|
|
||||||
Replace flat `DeviceInfo` + `**kwargs` provider contract with a discriminated union of typed per-provider config dataclasses. Full plan: [docs/plans/device-typed-configs.md](docs/plans/device-typed-configs.md).
|
Replace flat `DeviceInfo` + `**kwargs` provider contract with a discriminated union of typed per-provider config dataclasses.
|
||||||
|
|
||||||
- [x] Phase 1 — `DeviceConfig` hierarchy + `Device.to_config()` (non-breaking, additive only)
|
- [x] Phase 1 — `DeviceConfig` hierarchy + `Device.to_config()` (non-breaking, additive only)
|
||||||
- [x] Phases 2+3 — narrow `LEDDeviceProvider.create_client` to typed configs; migrate 3 call sites; delete `DeviceInfo` + `_get_device_info` + `_DEVICE_FIELD_DEFAULTS` (single PR)
|
- [x] Phases 2+3 — narrow `LEDDeviceProvider.create_client` to typed configs; migrate 3 call sites; delete `DeviceInfo` + `_get_device_info` + `_DEVICE_FIELD_DEFAULTS` (single PR)
|
||||||
- [x] Phase 4 — migrate `tests/test_group_device.py` to `GroupConfig`/`ProviderDeps`; remove legacy `GroupLEDClient` init path; 47-test config suite with 100% coverage on `device_config.py`
|
- [x] Phase 4 — migrate `tests/test_group_device.py` to `GroupConfig`/`ProviderDeps`; remove legacy `GroupLEDClient` init path; 47-test config suite with 100% coverage on `device_config.py`
|
||||||
- [ ] Phase 5 (separate PR, optional) — Pydantic v2 discriminated union in `api/schemas/devices.py`; scope frontend POST/PATCH payloads by `device_type`
|
- [ ] Phase 5 (separate PR, optional) — Pydantic v2 discriminated union in `api/schemas/devices.py`; scope frontend POST/PATCH payloads by `device_type`
|
||||||
|
|
||||||
|
## Expand device support (Phase 1: open protocols)
|
||||||
|
|
||||||
|
Branch: `feat/expand-device-support`.
|
||||||
|
|
||||||
|
Goal: maximize the universe of LED controllers LedGrab can drive by adding aggregator + open-protocol providers in roughly-this order. Each driver follows the established `LEDDeviceProvider` + `*Config` + tests pattern.
|
||||||
|
|
||||||
|
### Phase 1.1 — Standalone DDP target ✅ shipped (commit `8f1140a`)
|
||||||
|
|
||||||
|
DDP packet layer (previously WLED-internal) promoted to a first-class device
|
||||||
|
type. Pixelblaze, ESPixelStick, xLights/Falcon endpoints, and generic DDP
|
||||||
|
receivers are now drivable directly without WLED in the path.
|
||||||
|
|
||||||
|
### Phase 1.2 — Yeelight LAN
|
||||||
|
|
||||||
|
Xiaomi/Yeelight bulbs, port 55443 TCP JSON. Direct protocol (no
|
||||||
|
`python-yeelight` dependency — implementation is ~200 lines).
|
||||||
|
|
||||||
|
- [x] `YeelightConfig` dataclass with `yeelight_min_interval_ms` rate limit
|
||||||
|
- [x] `YeelightClient` in `core/devices/yeelight_client.py` — TCP JSON-RPC,
|
||||||
|
averaging single-pixel adapter, client-side rate gate
|
||||||
|
- [x] SSDP-style discovery (Yeelight's variant on `239.255.255.250:1982`)
|
||||||
|
- [x] `YeelightDeviceProvider` with validate/health/discover
|
||||||
|
- [x] Storage + API schemas + route handler wiring
|
||||||
|
- [x] 34 unit tests (URL parsing, RGB packing, averaging, rate limit, SSDP
|
||||||
|
parsing, provider validate/discover, Device.to_config round-trip)
|
||||||
|
- [ ] Frontend: Yeelight in device-type picker + edit form (spawned to a
|
||||||
|
`frontend-design` subagent)
|
||||||
|
- [ ] Locale strings (en/ru/zh)
|
||||||
|
- [ ] Music mode (~60 Hz updates via reverse-TCP) — follow-up, current
|
||||||
|
MVP caps at ~2 Hz via the client-side rate gate
|
||||||
|
|
||||||
|
### Phase 1.3 — WiZ Connected
|
||||||
|
|
||||||
|
Philips' UDP-local budget tier. Port 38899 JSON UDP.
|
||||||
|
|
||||||
|
- [x] `WiZConfig` + `WiZClient` + `WiZDeviceProvider`
|
||||||
|
- [x] UDP broadcast discovery on 255.255.255.255:38899 with the standard
|
||||||
|
`registration` envelope; replies parsed for IP+MAC.
|
||||||
|
- [x] Sync `send_pixels_fast` for the hot loop (UDP is fire-and-forget,
|
||||||
|
no async needed). 50 ms default min interval → ~20 Hz cap.
|
||||||
|
- [x] Health check sends `getPilot` and waits for any reply.
|
||||||
|
- [x] Storage + API schemas + route handler wiring
|
||||||
|
- [x] 36 unit tests
|
||||||
|
- [ ] Frontend: WiZ in device-type picker + edit form
|
||||||
|
- [ ] Locale strings (en/ru/zh)
|
||||||
|
|
||||||
|
### Phase 2 — Unified discovery + pairing UX layer
|
||||||
|
|
||||||
|
After phase 1 the codebase will have 3 fresh examples of "ping the LAN, listen for replies, present a list". Factor that out into a generic discovery scaffold + a "first-run pairing" UX component before adding Tuya/Govee/etc., which each need a one-time pairing dance.
|
||||||
|
|
||||||
|
- [WONTDO] Generic `NetworkDiscoveryService` — the existing
|
||||||
|
`/api/v1/devices/discover` route already runs all providers in parallel
|
||||||
|
via `asyncio.gather(return_exceptions=True)`. Extracting it would not
|
||||||
|
unlock anything; revisit only if discovery cadence/dedup becomes a
|
||||||
|
real complaint.
|
||||||
|
- [WONTDO] Unified scan UI — already exists; one "Scan network" button
|
||||||
|
triggers the cross-provider fan-out.
|
||||||
|
- [x] **Reusable pair-device scaffold** (the actually-needed piece).
|
||||||
|
Backend: `LEDDeviceProvider.pair_device(url)` abstract method with
|
||||||
|
`PairingNotReady` sentinel; `POST /api/v1/devices/pair` endpoint
|
||||||
|
with status-code mapping (200/400/409/422/502); 8 route tests
|
||||||
|
covering every outcome. Frontend: `templates/modals/pair-device.html`
|
||||||
|
five-state modal (idle / pairing / not-ready / success / failed)
|
||||||
|
with a 30-second SVG progress ring; reusable
|
||||||
|
`static/js/features/pairing-flow.ts` exposing
|
||||||
|
`runPairingFlow({deviceType, url}) → Promise<{fields}>` with
|
||||||
|
`PairingCancelled` sentinel; locale strings in en/ru/zh. No driver
|
||||||
|
uses it yet — Nanoleaf will be the first concrete consumer.
|
||||||
|
|
||||||
|
### Phase 3 — Big aggregator unlocks
|
||||||
|
|
||||||
|
- [ ] ESPHome native API (`aioesphomeapi`)
|
||||||
|
- [ ] Tuya Local (`tinytuya`) — biggest single market unlock; needs the pairing UX from Phase 2
|
||||||
|
- [ ] Matter over IP (forward-looking)
|
||||||
|
- [ ] Hyperion JSON downstream
|
||||||
|
|
||||||
|
### Phase 4 — Major consumer brands
|
||||||
|
|
||||||
|
- [x] **LIFX LAN** — UDP binary protocol on port 56700; RGB→HSBK 16-bit
|
||||||
|
conversion; broadcast discovery via GetService/StateService probe;
|
||||||
|
47 unit tests. Single-pixel adapter shape, identical to WiZ
|
||||||
|
structurally. Frontend wired via subagent.
|
||||||
|
- [x] **Govee LAN API** — UDP JSON on port 4003 (control) + 4002
|
||||||
|
(responses) + 4001 (multicast discovery on 239.255.255.250).
|
||||||
|
Single-pixel `colorwc` command with `colorTemInKelvin=0` for RGB
|
||||||
|
mode. **Per-device "LAN Control" toggle required in Govee Home
|
||||||
|
app.** 40 unit tests. Frontend wired via subagent.
|
||||||
|
- [x] **Nanoleaf OpenAPI** — Light Panels / Canvas / Shapes / Lines /
|
||||||
|
Elements via HTTP REST on port 16021. **First concrete user of
|
||||||
|
the pairing-UX scaffold from Phase 2.** mDNS discovery via
|
||||||
|
`_nanoleafapi._tcp`. Single-pixel adapter (averaged strip → HSB
|
||||||
|
`PUT /state`). Auth token encrypted at rest via `_enc`/`_dec`.
|
||||||
|
42 unit tests covering URL parsing, RGB→HSB conversion, pairing
|
||||||
|
handshake (200/403/500/missing-token/transport-error), state
|
||||||
|
mutations, brightness clamping, Device.to_config round-trip
|
||||||
|
including encrypted-token roundtrip.
|
||||||
|
- [ ] Twinkly — multi-pixel + login flow; deferred
|
||||||
|
- [WONTDO] Mi-Light / MiBoxer UDP gateway — the recommended path for
|
||||||
|
modern Mi-Light deployments is `esp8266_milight_hub` firmware → MQTT,
|
||||||
|
which LedGrab already supports through the existing MQTT device target
|
||||||
|
(commit `530316c`). Native V6 driver would be ~400 lines + finicky
|
||||||
|
session protocol + custom 1-byte hue table; the marginal benefit over
|
||||||
|
the MQTT path is small. Revisit if a user complaint surfaces.
|
||||||
|
|
||||||
|
### Phase 5 — Open pixel protocols (cheap completionism)
|
||||||
|
|
||||||
|
- [x] **OPC (Open Pixel Control)** — TCP, port 7890, 4-byte header
|
||||||
|
`[channel][cmd][len_hi][len_lo]` + RGB body. Channel 0 broadcasts.
|
||||||
|
Single-pixel-strip protocol, no discovery, no pairing. 36 unit
|
||||||
|
tests. Fadecandy + xLights + hobbyist receivers reachable.
|
||||||
|
- [ ] TPM2.net
|
||||||
|
|
||||||
|
### Phase 6 — PC gaming RGB completion
|
||||||
|
|
||||||
|
- [ ] Corsair iCUE SDK
|
||||||
|
- [ ] Logitech LIGHTSYNC
|
||||||
|
- [ ] ASUS Aura SDK
|
||||||
|
|
||||||
|
### Phase 7 — Proprietary USB HID ambient kits
|
||||||
|
|
||||||
|
- [ ] Generic HID-ambient framework + VID/PID registry
|
||||||
|
- [ ] First reverse-engineered target (probably Govee Immersion / DreamView)
|
||||||
|
|
||||||
|
### Cleanup + verification
|
||||||
|
|
||||||
|
- [x] **`_average_color` extraction** (commit `cc87fba`). Six identical
|
||||||
|
copies (Yeelight / WiZ / LIFX / Govee / Nanoleaf / BLE) collapsed
|
||||||
|
into `core/devices/pixel_reduce.average_color`. Net -76 lines.
|
||||||
|
Hue is out by design — its Entertainment API addresses up to seven
|
||||||
|
lights individually.
|
||||||
|
- [x] **Pre-merge verification pass.** 1358 pytest tests pass; ruff
|
||||||
|
clean across all device modules and tests; black clean against
|
||||||
|
the pre-commit-pinned 24.10.0; `npx tsc --noEmit` clean; bundle
|
||||||
|
compiles.
|
||||||
|
- [x] **Pre-merge code review (subagent)** — surfaced 2 CRITICAL +
|
||||||
|
4 HIGH + 3 MEDIUM + 3 LOW findings.
|
||||||
|
- [x] **All review findings fixed** (commits `7736bc6` + `0e3ae78`):
|
||||||
|
- CRITICAL #1: missing `url_scheme.py` / `net_classify.py`
|
||||||
|
committed (4 files / 557 lines).
|
||||||
|
- CRITICAL #2: `update_device` no longer re-encrypts secrets in
|
||||||
|
memory via the `to_dict()` round-trip (uses `vars()` directly).
|
||||||
|
- HIGH #3: `nanoleaf_token` / `hue_username` / `hue_client_key`
|
||||||
|
stripped from `DeviceResponse`; replaced with paired-flag
|
||||||
|
booleans. Frontend updated.
|
||||||
|
- HIGH #4: `validate_lan_host()` rejects literal public IPs at
|
||||||
|
each driver's `validate_device` + `pair_device`.
|
||||||
|
- HIGH #5: `_dec()` failures clear the field and log, not crash
|
||||||
|
the row.
|
||||||
|
- HIGH #6: update route now rstrip's URL for all device types.
|
||||||
|
- MEDIUM #7: Govee discovery serialized via `asyncio.Lock`.
|
||||||
|
- MEDIUM #8: Nanoleaf mDNS browser cleanup moved to `finally`.
|
||||||
|
- MEDIUM #9: pair endpoint sanitizes URL userinfo in logs.
|
||||||
|
- LOW: Nanoleaf `.port` property added; pair-then-create E2E test
|
||||||
|
added.
|
||||||
|
- Tests: 1379 pass (+21 regression tests).
|
||||||
|
|
||||||
|
## Graph editor — "full control of wiring via graph" (in progress)
|
||||||
|
|
||||||
|
Goal: make the visual graph a first-class wiring control surface, not just a
|
||||||
|
viewer. Driven by the ULTRA-DEEP review (findings A1–A5, B1–B6, C1–C6, D1–D6).
|
||||||
|
|
||||||
|
### Done (NOT yet committed — awaiting review/commit)
|
||||||
|
|
||||||
|
- [x] **A1** Undo/redo wired to connect/detach/move (was dead code); inverse ops
|
||||||
|
throw on failure so the stack can't silently desync.
|
||||||
|
- [x] **A2** Manual node layout persists to `localStorage` (`graph_node_positions`),
|
||||||
|
cleared on relayout.
|
||||||
|
- [x] **A3** Scene-preset disambiguation — deactivation scene now reachable via a
|
||||||
|
field picker (was always picking the first match).
|
||||||
|
- [x] **B6** Edge field labels (revealed on zoom ≥ 0.9).
|
||||||
|
- [x] **C3** Health overlay — broken refs (referrer exists, target missing),
|
||||||
|
dependency cycles, orphans; node warning badges + an issues toolbar button.
|
||||||
|
- [x] **D1** `GET /api/v1/graph/schema` — authoritative connectable-field registry
|
||||||
|
(`api/graph_schema.py`, pure + unit-tested).
|
||||||
|
- [x] **D2** `GET /api/v1/graph` (nodes+edges+validation) and
|
||||||
|
`GET /api/v1/graph/dependents/{kind}/{id}`.
|
||||||
|
- [x] **D4** `POST /api/v1/graph/validate-connection` — existence + source-kind +
|
||||||
|
cycle pre-flight; frontend validates before every write (fails open if the
|
||||||
|
endpoint is unreachable). List/double-nested fields rejected.
|
||||||
|
- [x] **B2** Drop-on-node connect — empty top-level slots are now wireable (drop a
|
||||||
|
source onto any compatible node body, not just an existing port).
|
||||||
|
- [x] **C4** Overwrite-occupied-slot confirm + delete-with-dependents warning
|
||||||
|
(single delete only; bulk keeps the batch confirm).
|
||||||
|
- [x] **D5** Create-and-connect — drag a port onto empty canvas → pick a compatible
|
||||||
|
new entity kind → it's created and auto-wired (kind-scoped watcher).
|
||||||
|
- [x] **D6 (read-only half)** "Export graph (JSON)" toolbar action.
|
||||||
|
- [x] Custom per-entity `icon` + `icon_color` now render on graph nodes (parity
|
||||||
|
with custom node colours; fallback to kind/subtype glyph).
|
||||||
|
- [x] **B1** Edit single-level **BindableFloat** value slots from the graph
|
||||||
|
(`brightness`, `smoothing`, `intensity`, `scale`, `speed`, … on
|
||||||
|
color_strip_source; `brightness`/`transition` on output_target). Subtype-safe
|
||||||
|
(only offers slots the target entity actually has). Writes the partial
|
||||||
|
`{ <slot>: { source_id } }` payload → backend `Bindable*.apply_update` merges,
|
||||||
|
preserving the static value. Verified data-safe (no `from_raw`/value-reset path).
|
||||||
|
- [x] Render the two functional value-source references `buildGraph` was missing —
|
||||||
|
`value_source.value_source_id` (gradient_map → inner value source) and
|
||||||
|
`value_source.color_strip_source_id` (css_extract → strip). Both are runtime-
|
||||||
|
resolved and already drag-editable; now visible/detachable in the graph.
|
||||||
|
- [x] **B4 foundation:** backend schema now authoritative about graph-editability
|
||||||
|
(`is_editable()` + `editable` flag in `/graph/schema`); `validate-connection`
|
||||||
|
hardened to reject non-editable fields (colour/list/double-nested), not just lists.
|
||||||
|
- [x] **B4 drift guard + gap fixes:** `checkSchemaDrift()` (graph-connections.ts) warns
|
||||||
|
once if the frontend `CONNECTION_MAP` editable set diverges from `/graph/schema`
|
||||||
|
(the automated "10-step checklist"). Surfacing it found 3 real gaps; fixed 2:
|
||||||
|
`color_strip_source.input_source_id` + `processing_template_id` are now drag-editable
|
||||||
|
(processed-strip wiring; `apply_update` is partial-safe). The 3rd —
|
||||||
|
`device.default_css_processing_template_id` — is intentionally NOT drag-editable
|
||||||
|
(the device PUT route isn't partial-safe; a one-field PUT could null the URL) and is
|
||||||
|
in the drift-check exclude set. Also broadened `_availableMatches` to hide any slot
|
||||||
|
the target entity doesn't expose (subtype-accurate; refs are always-emitted so empty
|
||||||
|
slots stay wireable). Review also caught a **dead `output_target.picture_source_id`
|
||||||
|
slot** (no output target stores it — not a field/schema, never emitted) — removed
|
||||||
|
from both registries + `buildGraph`.
|
||||||
|
- [x] **Comprehensive review pass (4 subagents: backend/frontend-core/orchestrator/security).**
|
||||||
|
Findings fixed:
|
||||||
|
- **CRITICAL (security):** `GET /api/v1/graph` leaked plaintext **webhook tokens**
|
||||||
|
(`asdict` recursed `Automation.rules[].token`, an auth-equivalent secret). Fixed with
|
||||||
|
**field-projection** — `serialize_entity_for_graph()` / `graph_field_roots()` project
|
||||||
|
each entity to only `{id, name, subtype, reference-roots}`; secrets can't survive.
|
||||||
|
Added a structural regression test asserting no projection root is secret-bearing for
|
||||||
|
any kind (drift-proof boundary) + a token-drop test.
|
||||||
|
- MEDIUM: added missing `value_source.clock_id` (AnimatedColorValueSource → sync_clock)
|
||||||
|
to the backend registry for topology/dependents completeness (drift-excluded on the
|
||||||
|
frontend — value-source PUT needs a `source_type` discriminator, so it's editor-only).
|
||||||
|
- MEDIUM/LOW: `CSS.escape` on the markIssues id selector; grouped/clarified
|
||||||
|
`_DRIFT_EXCLUDE`; fixed the stale `_availableMatches` JSDoc; documented the
|
||||||
|
`checkSchemaDrift` forward-reference. Orchestrator + frontend-core + security: APPROVE.
|
||||||
|
- Verification: `npm --prefix server run typecheck` + `run build` clean; ruff clean;
|
||||||
|
graph backend tests 35 pass; full backend suite green. ~8 code-review passes,
|
||||||
|
all CRITICAL/HIGH findings fixed.
|
||||||
|
|
||||||
|
### Left to do (deferred)
|
||||||
|
|
||||||
|
- [x] **BindableColor slots** — CHECKED, decision: keep read-only (won't fix).
|
||||||
|
Value sources are scalar-only (`ValueStream.get_value() -> float`) and every
|
||||||
|
colour consumer (`color_strip/single.py`, `effect_stream.py`) reads the static
|
||||||
|
RGB via `bcolor()`, ignoring `source_id`. So a value_source cannot drive a
|
||||||
|
colour — wiring `color`/`color_peak`/… would be a dead binding. Documented in
|
||||||
|
`api/graph_schema.py` next to the BindableColor entries. (Would only become
|
||||||
|
viable if a colour-producing value-source type is added.)
|
||||||
|
- [~] **B4 — delete the frontend `CONNECTION_MAP` duplication.**
|
||||||
|
- [x] **Foundation done:** the backend schema now carries an authoritative
|
||||||
|
`editable` flag per field (`is_editable()` in `api/graph_schema.py`, mirroring
|
||||||
|
the frontend `_isEditable`: top-level refs + single-level BindableFloat slots;
|
||||||
|
NOT colour/list/double-nested). `validate-connection` is hardened to reject any
|
||||||
|
non-editable field (was list-only). `editable` is surfaced in `/graph/schema`.
|
||||||
|
- [ ] **Remaining (the refactor):** frontend fetches `/graph/schema` on load and
|
||||||
|
derives connection metadata + edges from it (port the `extract_refs` dot-path/list
|
||||||
|
grammar to TS), keeping only a tiny `kind → {endpoint, cache}` write-routing table;
|
||||||
|
then delete the field-level `CONNECTION_MAP` + the `buildGraph` edge loops
|
||||||
|
(graph-connections.ts / graph-layout.ts). Removes the 10-step sync checklist in
|
||||||
|
`contexts/graph-editor.md`. **A backend apply-write endpoint is NOT required** —
|
||||||
|
keep the proven per-entity PUT. Risk: regressing drag-connect/bindable; keep a
|
||||||
|
dev drift-check (frontend editable set vs `/graph/schema`) during the transition.
|
||||||
|
Note: frontend `CONNECTION_MAP` also has inert `ha_source_id`/`gradient_id` entries
|
||||||
|
(no graph node kind) — drop them, the backend schema already omits them.
|
||||||
|
- [ ] **D6 — blueprint import/instantiate.** Export exists; the apply half (serialize
|
||||||
|
a selected subgraph's topology + entities, re-import with id remapping, conflict
|
||||||
|
handling) is large and data-integrity-sensitive (see Data Migration Policy in
|
||||||
|
CLAUDE.md). Scope as its own feature.
|
||||||
|
- [ ] **List-slot editing** (composite `layers[]`, mapped `zones[]`, scene preset
|
||||||
|
`targets[]`) — needs an element index in the write + validate paths
|
||||||
|
(`validate_connection` currently rejects list fields). Edit via entity modal
|
||||||
|
for now.
|
||||||
|
|
||||||
|
### Notes / decisions
|
||||||
|
|
||||||
|
- The backend `CONNECTION_SCHEMA` (`api/graph_schema.py`) is the authoritative
|
||||||
|
superset; it already declares the bindable + list + value_source-chain edges. The
|
||||||
|
frontend `CONNECTION_MAP` still owns write-routing (endpoint/cache) — that's the
|
||||||
|
only reason it survives (see B4).
|
||||||
|
- Bindable edges render dashed (`.graph-edge-nested`) but ARE editable — the dashed
|
||||||
|
style intentionally distinguishes value bindings from structural edges.
|
||||||
|
- `validate-connection` and `dependents` fail **open/safe** on the frontend so the
|
||||||
|
graph keeps working against an older server without these endpoints.
|
||||||
|
|||||||
@@ -30,23 +30,39 @@ val ledgrabVersionCode: Int = run {
|
|||||||
|
|
||||||
android {
|
android {
|
||||||
namespace = "com.ledgrab.android"
|
namespace = "com.ledgrab.android"
|
||||||
compileSdk = 34
|
// SDK 35 (Android 15) — required for Play Store from Aug 2025 onward.
|
||||||
|
compileSdk = 35
|
||||||
|
|
||||||
defaultConfig {
|
defaultConfig {
|
||||||
applicationId = "com.ledgrab.android"
|
applicationId = "com.ledgrab.android"
|
||||||
minSdk = 24 // Android 7.0 — covers nearly all TV boxes
|
minSdk = 24 // Android 7.0 — covers nearly all TV boxes
|
||||||
targetSdk = 34
|
targetSdk = 35
|
||||||
// Derived from git commit count (or ANDROID_VERSION_CODE env var
|
// Derived from git commit count (or ANDROID_VERSION_CODE env var
|
||||||
// in CI). See ledgrabVersionCode above. Was stuck at 1 before —
|
// in CI). See ledgrabVersionCode above. Was stuck at 1 before —
|
||||||
// sideload updates silently refused to install.
|
// sideload updates silently refused to install.
|
||||||
versionCode = ledgrabVersionCode
|
versionCode = ledgrabVersionCode
|
||||||
versionName = "0.5.0"
|
versionName = "0.8.1"
|
||||||
|
|
||||||
|
// ABI selection. Detect armeabi-v7a wheel presence and opt the
|
||||||
|
// ABI in only when the matching pydantic-core wheel is on disk —
|
||||||
|
// otherwise Chaquopy would fail the build searching for it. The
|
||||||
|
// build script (build-scripts/build-pydantic-core.sh) is the
|
||||||
|
// source of truth for which ABIs we *can* ship.
|
||||||
|
val v7Wheel = file("$rootDir/wheels").listFiles().orEmpty()
|
||||||
|
.any { it.name.startsWith("pydantic_core-") && it.name.contains("armeabi_v7a") }
|
||||||
|
val ledgrabAbis = buildList {
|
||||||
|
add("arm64-v8a")
|
||||||
|
add("x86_64")
|
||||||
|
add("x86")
|
||||||
|
if (v7Wheel) add("armeabi-v7a")
|
||||||
|
}
|
||||||
ndk {
|
ndk {
|
||||||
// All three ABIs: arm64-v8a (real TV hardware), x86_64 (modern
|
// arm64-v8a is the primary target (real TV hardware).
|
||||||
// emulators), x86 (legacy emulators). Wheels in android/wheels/
|
// x86_64/x86 cover emulators.
|
||||||
// must be kept in sync — see build-scripts/build-pydantic-core.sh.
|
// armeabi-v7a is opt-in: many pre-2018 Mecool/X96/H96 TV boxes
|
||||||
abiFilters += listOf("arm64-v8a", "x86_64", "x86")
|
// still ship 32-bit ARMv7 — when a wheel exists in wheels/ we
|
||||||
|
// automatically include the ABI in builds.
|
||||||
|
abiFilters += ledgrabAbis
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -54,9 +70,12 @@ android {
|
|||||||
// Each split contains only one native ABI's shared libraries + wheels.
|
// Each split contains only one native ABI's shared libraries + wheels.
|
||||||
splits {
|
splits {
|
||||||
abi {
|
abi {
|
||||||
|
val v7Wheel = file("$rootDir/wheels").listFiles().orEmpty()
|
||||||
|
.any { it.name.startsWith("pydantic_core-") && it.name.contains("armeabi_v7a") }
|
||||||
isEnable = true
|
isEnable = true
|
||||||
reset()
|
reset()
|
||||||
include("arm64-v8a", "x86_64", "x86")
|
include("arm64-v8a", "x86_64", "x86")
|
||||||
|
if (v7Wheel) include("armeabi-v7a")
|
||||||
isUniversalApk = true // also produce a fat APK for sideloading
|
isUniversalApk = true // also produce a fat APK for sideloading
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -96,10 +115,21 @@ android {
|
|||||||
getDefaultProguardFile("proguard-android-optimize.txt"),
|
getDefaultProguardFile("proguard-android-optimize.txt"),
|
||||||
"proguard-rules.pro",
|
"proguard-rules.pro",
|
||||||
)
|
)
|
||||||
signingConfig = if (hasCiSigning) {
|
// Refuse to silently sign release APKs with the debug
|
||||||
signingConfigs.getByName("release")
|
// keystore — that's how a debug-signed release accidentally
|
||||||
} else {
|
// ships. CI must provide all four signing env vars. If a
|
||||||
signingConfigs.getByName("debug")
|
// local "release" build is genuinely intended for testing,
|
||||||
|
// set ANDROID_ALLOW_DEBUG_SIGNED_RELEASE=1 to opt out.
|
||||||
|
val allowDebugSigned =
|
||||||
|
System.getenv("ANDROID_ALLOW_DEBUG_SIGNED_RELEASE") == "1"
|
||||||
|
signingConfig = when {
|
||||||
|
hasCiSigning -> signingConfigs.getByName("release")
|
||||||
|
allowDebugSigned -> signingConfigs.getByName("debug")
|
||||||
|
else -> throw GradleException(
|
||||||
|
"Release builds require signing env vars " +
|
||||||
|
"(ANDROID_KEYSTORE_PATH/PASSWORD, ANDROID_KEY_ALIAS/PASSWORD). " +
|
||||||
|
"Set ANDROID_ALLOW_DEBUG_SIGNED_RELEASE=1 to force a debug-signed release."
|
||||||
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -175,6 +205,9 @@ dependencies {
|
|||||||
implementation("androidx.lifecycle:lifecycle-service:2.8.7")
|
implementation("androidx.lifecycle:lifecycle-service:2.8.7")
|
||||||
implementation("androidx.lifecycle:lifecycle-runtime-ktx:2.8.7")
|
implementation("androidx.lifecycle:lifecycle-runtime-ktx:2.8.7")
|
||||||
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-android:1.8.1")
|
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-android:1.8.1")
|
||||||
|
// SplashScreen API — keeps a friendly logo on screen while Chaquopy
|
||||||
|
// unpacks the Python stdlib on first launch (can take 1-3s).
|
||||||
|
implementation("androidx.core:core-splashscreen:1.0.1")
|
||||||
// QR code generation for displaying server URL on TV
|
// QR code generation for displaying server URL on TV
|
||||||
implementation("com.google.zxing:core:3.5.3")
|
implementation("com.google.zxing:core:3.5.3")
|
||||||
// USB-serial drivers (CH340, CP2102, FTDI, Prolific, CDC-ACM) for
|
// USB-serial drivers (CH340, CP2102, FTDI, Prolific, CDC-ACM) for
|
||||||
|
|||||||
@@ -26,13 +26,57 @@
|
|||||||
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
|
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
|
||||||
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
|
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
|
||||||
|
|
||||||
<!-- MediaProjection requires a foreground service -->
|
<!-- Foreground service permissions.
|
||||||
|
FOREGROUND_SERVICE_MEDIA_PROJECTION: required on API 34+ for the
|
||||||
|
MediaProjection capture path.
|
||||||
|
FOREGROUND_SERVICE_SPECIAL_USE: required on API 34+ for the root
|
||||||
|
screenrecord capture path (it doesn't use MediaProjection).
|
||||||
|
Both are declared because the service may run in either mode. -->
|
||||||
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
|
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
|
||||||
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PROJECTION" />
|
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PROJECTION" />
|
||||||
|
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_SPECIAL_USE" />
|
||||||
|
<!-- FOREGROUND_SERVICE_CAMERA (API 34+): required to keep camera access while
|
||||||
|
the app is backgrounded during on-device webcam capture. The service is
|
||||||
|
promoted with the `camera` FGS type ONLY when CAMERA is already granted
|
||||||
|
(see CaptureService.onStartCommand) — unlike audio playback capture (which
|
||||||
|
rides the MediaProjection token under the mediaProjection type), the camera
|
||||||
|
has no such coupling and needs its own FGS type to survive backgrounding. -->
|
||||||
|
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_CAMERA" />
|
||||||
|
|
||||||
<!-- POST_NOTIFICATIONS for Android 13+ foreground service notification -->
|
<!-- POST_NOTIFICATIONS for Android 13+ foreground service notification -->
|
||||||
<uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
|
<uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
|
||||||
|
|
||||||
|
<!-- RECORD_AUDIO for on-device system-playback capture (AudioPlaybackCapture,
|
||||||
|
API 29+) feeding audio-reactive lighting. Runtime "dangerous" permission,
|
||||||
|
requested in MainActivity; capture degrades gracefully when denied.
|
||||||
|
Playback capture runs under the existing mediaProjection FGS type, so no
|
||||||
|
FOREGROUND_SERVICE_MICROPHONE / microphone FGS type is needed (that would
|
||||||
|
only be required if the mic-fallback path ran inside the service). -->
|
||||||
|
<uses-permission android:name="android.permission.RECORD_AUDIO" />
|
||||||
|
|
||||||
|
<!-- CAMERA for on-device webcam capture (Camera2). Runtime "dangerous"
|
||||||
|
permission, requested in MainActivity gated on FEATURE_CAMERA_ANY so
|
||||||
|
camera-less TV boxes never see the prompt; capture degrades gracefully
|
||||||
|
when denied. The camera is opened ON DEMAND (only while a camera
|
||||||
|
capture source is active). To keep capturing after the app is
|
||||||
|
backgrounded, the service is promoted with the `camera` FGS type
|
||||||
|
(FOREGROUND_SERVICE_CAMERA above) — but only when CAMERA is already
|
||||||
|
granted, so a camera-less / not-yet-granted box never risks a failed
|
||||||
|
service start. -->
|
||||||
|
<uses-permission android:name="android.permission.CAMERA" />
|
||||||
|
|
||||||
|
<!-- PACKAGE_USAGE_STATS — read the foreground app for the "Application"
|
||||||
|
automation rule (foreground app -> activate scene) via UsageStatsManager.
|
||||||
|
A special-access permission: it can't be granted at runtime; the user
|
||||||
|
toggles it under Settings > Usage access (opened from MainActivity).
|
||||||
|
tools:ignore="ProtectedPermissions" silences the build warning that this
|
||||||
|
is a system/signature-level permission — it is honoured as a user-grantable
|
||||||
|
special access. NO QUERY_ALL_PACKAGES is needed: matching only compares the
|
||||||
|
foreground package NAME, and the app picker uses LauncherApps. -->
|
||||||
|
<uses-permission
|
||||||
|
android:name="android.permission.PACKAGE_USAGE_STATS"
|
||||||
|
tools:ignore="ProtectedPermissions" />
|
||||||
|
|
||||||
<!-- Autostart on boot — BootReceiver spawns CaptureService in root
|
<!-- Autostart on boot — BootReceiver spawns CaptureService in root
|
||||||
mode so capture resumes without the user touching the remote. -->
|
mode so capture resumes without the user touching the remote. -->
|
||||||
<uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />
|
<uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />
|
||||||
@@ -57,30 +101,70 @@
|
|||||||
android:name="android.hardware.usb.host"
|
android:name="android.hardware.usb.host"
|
||||||
android:required="false" />
|
android:required="false" />
|
||||||
|
|
||||||
|
<!-- Camera hardware — for on-device webcam capture. required=false so
|
||||||
|
camera-less TV boxes (the common case) still install; the camera
|
||||||
|
engine simply reports no displays on such devices. camera.any covers
|
||||||
|
built-in (front/back) and external/USB-UVC cameras the platform
|
||||||
|
routes through Camera2. -->
|
||||||
|
<uses-feature
|
||||||
|
android:name="android.hardware.camera.any"
|
||||||
|
android:required="false" />
|
||||||
|
|
||||||
<application
|
<application
|
||||||
android:name=".LedGrabApp"
|
android:name=".LedGrabApp"
|
||||||
android:allowBackup="false"
|
android:allowBackup="false"
|
||||||
|
android:enableOnBackInvokedCallback="true"
|
||||||
android:icon="@mipmap/ic_launcher"
|
android:icon="@mipmap/ic_launcher"
|
||||||
android:label="@string/app_name"
|
android:label="@string/app_name"
|
||||||
android:banner="@drawable/ic_launcher"
|
android:banner="@drawable/banner_tv"
|
||||||
android:networkSecurityConfig="@xml/network_security_config"
|
android:networkSecurityConfig="@xml/network_security_config"
|
||||||
android:theme="@style/Theme.LedGrab">
|
android:theme="@style/Theme.LedGrab">
|
||||||
|
|
||||||
<!-- TV launcher activity -->
|
<!-- TV launcher activity. Boots through the SplashScreen theme so
|
||||||
|
the (sometimes multi-second) Chaquopy stdlib unpack doesn't
|
||||||
|
show as a black screen on first launch. -->
|
||||||
<activity
|
<activity
|
||||||
android:name=".MainActivity"
|
android:name=".MainActivity"
|
||||||
android:exported="true">
|
android:exported="true"
|
||||||
|
android:theme="@style/Theme.LedGrab.Splash">
|
||||||
<intent-filter>
|
<intent-filter>
|
||||||
<action android:name="android.intent.action.MAIN" />
|
<action android:name="android.intent.action.MAIN" />
|
||||||
<category android:name="android.intent.category.LEANBACK_LAUNCHER" />
|
<category android:name="android.intent.category.LEANBACK_LAUNCHER" />
|
||||||
</intent-filter>
|
</intent-filter>
|
||||||
</activity>
|
</activity>
|
||||||
|
|
||||||
<!-- Foreground service for screen capture + Python server -->
|
<!-- Foreground service for screen capture + Python server.
|
||||||
|
Declares BOTH mediaProjection AND specialUse: only one is
|
||||||
|
active at a time but Android needs to see the union of
|
||||||
|
possible types up-front so it doesn't kill the service when
|
||||||
|
we promote it with a different type at runtime.
|
||||||
|
FOREGROUND_SERVICE_TYPE_SPECIAL_USE on API 34+ requires the
|
||||||
|
PROPERTY_SPECIAL_USE_FGS_SUBTYPE rationale below. -->
|
||||||
<service
|
<service
|
||||||
android:name=".CaptureService"
|
android:name=".CaptureService"
|
||||||
android:foregroundServiceType="mediaProjection"
|
android:foregroundServiceType="mediaProjection|specialUse|camera"
|
||||||
android:exported="false" />
|
android:exported="false">
|
||||||
|
<property
|
||||||
|
android:name="android.app.PROPERTY_SPECIAL_USE_FGS_SUBTYPE"
|
||||||
|
android:value="Root-mode screen capture for ambient LED sync. Uses /system/bin/screenrecord on rooted devices to avoid MediaProjection's persistent capture indicator overlay, which is required for the always-on ambient-lighting use case." />
|
||||||
|
</service>
|
||||||
|
|
||||||
|
<!-- Notification capture — a NotificationListenerService bound by
|
||||||
|
system_server. exported="true" is REQUIRED here (the system binds
|
||||||
|
it cross-process) and intentionally diverges from CaptureService
|
||||||
|
(exported="false"); access is gated by the system-held
|
||||||
|
BIND_NOTIFICATION_LISTENER_SERVICE permission, so no new
|
||||||
|
<uses-permission> is needed. The user grants access via
|
||||||
|
Settings > Notification access (opened from MainActivity). -->
|
||||||
|
<service
|
||||||
|
android:name=".LedGrabNotificationListener"
|
||||||
|
android:label="@string/notification_listener_label"
|
||||||
|
android:exported="true"
|
||||||
|
android:permission="android.permission.BIND_NOTIFICATION_LISTENER_SERVICE">
|
||||||
|
<intent-filter>
|
||||||
|
<action android:name="android.service.notification.NotificationListenerService" />
|
||||||
|
</intent-filter>
|
||||||
|
</service>
|
||||||
|
|
||||||
<!-- Autostart — fires on device boot (and package replace).
|
<!-- Autostart — fires on device boot (and package replace).
|
||||||
On rooted devices, launches CaptureService directly so capture
|
On rooted devices, launches CaptureService directly so capture
|
||||||
|
|||||||
@@ -0,0 +1,98 @@
|
|||||||
|
package com.ledgrab.android
|
||||||
|
|
||||||
|
import android.content.Context
|
||||||
|
import android.util.Log
|
||||||
|
import java.security.SecureRandom
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Persists the per-install API key for the embedded FastAPI server.
|
||||||
|
*
|
||||||
|
* The server's auth gate ([ledgrab.api.auth]) requires a Bearer token
|
||||||
|
* for any non-loopback request when ``auth.api_keys`` is configured.
|
||||||
|
* Without a key, LAN clients (phone, laptop) get 401 — which is the
|
||||||
|
* server's secure default but breaks the QR-scan workflow.
|
||||||
|
*
|
||||||
|
* This class generates one key per install (random 32-byte → 64-char
|
||||||
|
* hex), persists it to SharedPreferences, and exposes it to:
|
||||||
|
* - [PythonBridge] which sets ``LEDGRAB_AUTH__API_KEYS=android:<key>``
|
||||||
|
* before uvicorn starts.
|
||||||
|
* - [MainActivity] which embeds the key as a URL fragment
|
||||||
|
* (``http://ip:port/#k=<key>``) in the QR. Fragments are never sent
|
||||||
|
* to the server in HTTP requests, so the key doesn't appear in
|
||||||
|
* access logs.
|
||||||
|
*/
|
||||||
|
class ApiKeyManager(context: Context) {
|
||||||
|
|
||||||
|
private val prefs = context.applicationContext
|
||||||
|
.getSharedPreferences(PREFS_NAME, Context.MODE_PRIVATE)
|
||||||
|
|
||||||
|
// Once we've materialised a key in this process, cache it so
|
||||||
|
// subsequent reads don't hit prefs and don't risk re-checking
|
||||||
|
// length under contention.
|
||||||
|
@Volatile private var cached: String? = null
|
||||||
|
private val lock = Any()
|
||||||
|
|
||||||
|
/** Persistent random API key, generated lazily on first access. */
|
||||||
|
val apiKey: String
|
||||||
|
get() = getOrCreateKey()
|
||||||
|
|
||||||
|
/** Force a new key. Useful if a user thinks the QR was photographed. */
|
||||||
|
fun rotate(): String {
|
||||||
|
synchronized(lock) {
|
||||||
|
val next = generateKey()
|
||||||
|
// apply() is fine for rotation — by definition the user
|
||||||
|
// initiated this and will see the new QR; the worst case
|
||||||
|
// on crash is they need to re-rotate.
|
||||||
|
prefs.edit().putString(KEY_API_KEY, next).apply()
|
||||||
|
cached = next
|
||||||
|
Log.i(TAG, "Rotated API key")
|
||||||
|
return next
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun getOrCreateKey(): String {
|
||||||
|
cached?.let { return it }
|
||||||
|
synchronized(lock) {
|
||||||
|
// Double-checked under the lock.
|
||||||
|
cached?.let { return it }
|
||||||
|
val existing = prefs.getString(KEY_API_KEY, null)
|
||||||
|
if (existing != null && existing.length >= MIN_KEY_LENGTH) {
|
||||||
|
cached = existing
|
||||||
|
return existing
|
||||||
|
}
|
||||||
|
val generated = generateKey()
|
||||||
|
// commit() (synchronous disk write) on the FIRST write so
|
||||||
|
// the key is durable before MainActivity encodes it into a
|
||||||
|
// QR. If the process is killed between QR display and the
|
||||||
|
// async write landing, the user's phone would scan a key
|
||||||
|
// the server never learned about. Subsequent rotates can
|
||||||
|
// safely use apply().
|
||||||
|
prefs.edit().putString(KEY_API_KEY, generated).commit()
|
||||||
|
cached = generated
|
||||||
|
Log.i(TAG, "Generated new API key (length=${generated.length})")
|
||||||
|
return generated
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun generateKey(): String {
|
||||||
|
val bytes = ByteArray(KEY_BYTES)
|
||||||
|
SecureRandom().nextBytes(bytes)
|
||||||
|
// Hex-encode so the key survives copy/paste, URL fragments, env
|
||||||
|
// vars, and YAML config without escaping concerns. Mask to 0xff
|
||||||
|
// first — Kotlin's Byte is signed, and `%02x` on a negative
|
||||||
|
// Byte sign-extends to an 8-char hex string ("ffffffff" instead
|
||||||
|
// of "ff"), which would produce an invalid key.
|
||||||
|
return bytes.joinToString("") { "%02x".format(it.toInt() and 0xff) }
|
||||||
|
}
|
||||||
|
|
||||||
|
companion object {
|
||||||
|
private const val TAG = "ApiKeyManager"
|
||||||
|
private const val PREFS_NAME = "ledgrab_auth"
|
||||||
|
private const val KEY_API_KEY = "api_key"
|
||||||
|
private const val KEY_BYTES = 32
|
||||||
|
private const val MIN_KEY_LENGTH = 32
|
||||||
|
|
||||||
|
/** Label used as the LEDGRAB_AUTH__API_KEYS map key. */
|
||||||
|
const val LABEL = "android"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,234 @@
|
|||||||
|
package com.ledgrab.android
|
||||||
|
|
||||||
|
import android.annotation.SuppressLint
|
||||||
|
import android.media.AudioAttributes
|
||||||
|
import android.media.AudioFormat
|
||||||
|
import android.media.AudioPlaybackCaptureConfiguration
|
||||||
|
import android.media.AudioRecord
|
||||||
|
import android.media.MediaRecorder
|
||||||
|
import android.media.projection.MediaProjection
|
||||||
|
import android.os.Build
|
||||||
|
import android.util.Log
|
||||||
|
import java.nio.ByteBuffer
|
||||||
|
import java.nio.ByteOrder
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Captures audio with [AudioRecord] and pushes interleaved float32 PCM to
|
||||||
|
* the LedGrab Python server via [PythonBridge], where the
|
||||||
|
* `android_audio_engine` feeds it into the unchanged audio-analysis
|
||||||
|
* pipeline.
|
||||||
|
*
|
||||||
|
* Two sources:
|
||||||
|
* - [start] — system playback capture via `AudioPlaybackCapture` (API 29+),
|
||||||
|
* reusing the same [MediaProjection] token the app already holds for
|
||||||
|
* screen capture. This is the primary path on the consent flow.
|
||||||
|
* - [startMic] — microphone fallback (`AudioSource.MIC`) for paths with no
|
||||||
|
* MediaProjection (root mode) or API < 29.
|
||||||
|
*
|
||||||
|
* Mirrors [ScreenCapture]'s shape: a dedicated capture thread, a single
|
||||||
|
* reusable cross-JNI buffer (no per-block allocation → no GC churn on
|
||||||
|
* low-end TV boxes), and graceful teardown in [stop].
|
||||||
|
*
|
||||||
|
* The capture format is negotiated by [AudioRecord]; the **actual**
|
||||||
|
* channel count and sample rate are read back and forwarded to
|
||||||
|
* `configureAudio` so the Python analyzer's interleaving matches the bytes
|
||||||
|
* we push (e.g. a stereo request that the device satisfies as mono).
|
||||||
|
*/
|
||||||
|
class AudioCapture(
|
||||||
|
private val projection: MediaProjection?,
|
||||||
|
private val bridge: PythonBridge,
|
||||||
|
private val sampleRate: Int = 48000,
|
||||||
|
private val channels: Int = 2,
|
||||||
|
private val chunkFrames: Int = 1024,
|
||||||
|
) {
|
||||||
|
companion object {
|
||||||
|
private const val TAG = "AudioCapture"
|
||||||
|
private const val BYTES_PER_FLOAT = 4
|
||||||
|
}
|
||||||
|
|
||||||
|
private var audioRecord: AudioRecord? = null
|
||||||
|
private var captureThread: Thread? = null
|
||||||
|
@Volatile private var running = false
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Start system playback capture (API 29+). Requires the app to hold
|
||||||
|
* RECORD_AUDIO and a valid [projection]. Returns true if capture began.
|
||||||
|
*/
|
||||||
|
@SuppressLint("MissingPermission")
|
||||||
|
fun start(): Boolean {
|
||||||
|
if (running) return true
|
||||||
|
if (Build.VERSION.SDK_INT < Build.VERSION_CODES.Q) {
|
||||||
|
Log.i(TAG, "Playback capture needs API 29+; skipping (have ${Build.VERSION.SDK_INT})")
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
val proj = projection
|
||||||
|
if (proj == null) {
|
||||||
|
Log.i(TAG, "No MediaProjection; playback capture unavailable")
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
val config = AudioPlaybackCaptureConfiguration.Builder(proj)
|
||||||
|
.addMatchingUsage(AudioAttributes.USAGE_MEDIA)
|
||||||
|
.addMatchingUsage(AudioAttributes.USAGE_GAME)
|
||||||
|
.addMatchingUsage(AudioAttributes.USAGE_UNKNOWN)
|
||||||
|
.build()
|
||||||
|
|
||||||
|
val record = try {
|
||||||
|
AudioRecord.Builder()
|
||||||
|
.setAudioFormat(audioFormat())
|
||||||
|
.setBufferSizeInBytes(bufferBytes())
|
||||||
|
.setAudioPlaybackCaptureConfig(config)
|
||||||
|
.build()
|
||||||
|
} catch (e: Exception) {
|
||||||
|
Log.e(TAG, "Failed to build playback AudioRecord: ${e.message}")
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return begin(record, "playback")
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Start microphone capture (fallback). Works on API 24+ and needs no
|
||||||
|
* MediaProjection. Requires RECORD_AUDIO. Returns true if capture began.
|
||||||
|
*
|
||||||
|
* ⚠️ SECURITY/POLICY: currently UNWIRED (no caller). Microphone capture is
|
||||||
|
* a materially different posture than playback capture — it records real
|
||||||
|
* room audio (bystander voices). Before wiring this into [CaptureService]:
|
||||||
|
* - add FOREGROUND_SERVICE_MICROPHONE permission + the `microphone` FGS
|
||||||
|
* type (on API 34+ the service is killed without it), and
|
||||||
|
* - add the Play Store privacy disclosure for microphone use,
|
||||||
|
* - re-trigger a security review.
|
||||||
|
* Do NOT call this from inside the foreground service without the above.
|
||||||
|
*/
|
||||||
|
@SuppressLint("MissingPermission")
|
||||||
|
fun startMic(): Boolean {
|
||||||
|
if (running) return true
|
||||||
|
val record = try {
|
||||||
|
AudioRecord.Builder()
|
||||||
|
.setAudioSource(MediaRecorder.AudioSource.MIC)
|
||||||
|
.setAudioFormat(audioFormat())
|
||||||
|
.setBufferSizeInBytes(bufferBytes())
|
||||||
|
.build()
|
||||||
|
} catch (e: Exception) {
|
||||||
|
Log.e(TAG, "Failed to build mic AudioRecord: ${e.message}")
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return begin(record, "mic")
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Stop capturing and release all resources. Idempotent. */
|
||||||
|
fun stop() {
|
||||||
|
running = false
|
||||||
|
// AudioRecord.stop() unblocks a pending READ_BLOCKING read within
|
||||||
|
// milliseconds, so the loop sees running=false and returns well inside
|
||||||
|
// the 500ms join window — release() below won't race a live read.
|
||||||
|
// (Mirrors ScreenCapture's bounded join.)
|
||||||
|
runCatching { audioRecord?.stop() }
|
||||||
|
captureThread?.let { runCatching { it.join(500) } }
|
||||||
|
captureThread = null
|
||||||
|
runCatching { audioRecord?.release() }
|
||||||
|
audioRecord = null
|
||||||
|
runCatching { bridge.shutdownAudio() }
|
||||||
|
Log.i(TAG, "Audio capture stopped")
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── internals ──────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
private fun begin(record: AudioRecord, mode: String): Boolean {
|
||||||
|
if (record.state != AudioRecord.STATE_INITIALIZED) {
|
||||||
|
Log.e(TAG, "AudioRecord ($mode) failed to initialize")
|
||||||
|
runCatching { record.release() }
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
val actualChannels = record.channelCount.coerceAtLeast(1)
|
||||||
|
val actualRate = record.sampleRate
|
||||||
|
|
||||||
|
// Confirm recording actually started before reporting success —
|
||||||
|
// startRecording() can throw (exclusive-capture contention) or
|
||||||
|
// leave the record in a non-recording state, in which case read()
|
||||||
|
// would only ever return errors.
|
||||||
|
val started = runCatching { record.startRecording() }.isSuccess &&
|
||||||
|
record.recordingState == AudioRecord.RECORDSTATE_RECORDING
|
||||||
|
if (!started) {
|
||||||
|
Log.e(TAG, "AudioRecord ($mode) failed to start recording")
|
||||||
|
runCatching { record.release() }
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Recording confirmed — tell Python the real negotiated format
|
||||||
|
// before frames flow, so the analyzer's channel/sample-rate match
|
||||||
|
// the interleaving we push.
|
||||||
|
bridge.configureAudio(actualRate, actualChannels, chunkFrames)
|
||||||
|
|
||||||
|
audioRecord = record
|
||||||
|
running = true
|
||||||
|
captureThread = Thread(
|
||||||
|
{ captureLoop(record, actualChannels) },
|
||||||
|
"LedGrab-AudioCapture",
|
||||||
|
).also { it.start() }
|
||||||
|
Log.i(TAG, "Audio capture started ($mode, sr=$actualRate ch=$actualChannels chunk=$chunkFrames)")
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Blocking read loop. Accumulates into fixed `chunkFrames * channels`
|
||||||
|
* float blocks and pushes only COMPLETE blocks — [AudioRecord.read]
|
||||||
|
* returns a variable count, so partial reads are stitched here rather
|
||||||
|
* than handed to Python as ragged chunks (the analyzer requires
|
||||||
|
* whole-frame, ≤ chunk-size blocks).
|
||||||
|
*/
|
||||||
|
private fun captureLoop(record: AudioRecord, actualChannels: Int) {
|
||||||
|
val blockFloats = chunkFrames * actualChannels
|
||||||
|
val floatBuf = FloatArray(blockFloats)
|
||||||
|
// Reusable little-endian byte buffer — Python copies on push, so the
|
||||||
|
// same backing array is safe to overwrite next block. Default
|
||||||
|
// ByteBuffer order is BIG_ENDIAN, which would corrupt every sample;
|
||||||
|
// LITTLE_ENDIAN matches numpy's native float32 on all Android ABIs.
|
||||||
|
val byteBuf = ByteArray(blockFloats * BYTES_PER_FLOAT)
|
||||||
|
val floatView = ByteBuffer.wrap(byteBuf).order(ByteOrder.LITTLE_ENDIAN).asFloatBuffer()
|
||||||
|
|
||||||
|
var filled = 0
|
||||||
|
while (running) {
|
||||||
|
val n = record.read(floatBuf, filled, blockFloats - filled, AudioRecord.READ_BLOCKING)
|
||||||
|
if (n < 0) {
|
||||||
|
if (running) {
|
||||||
|
// A negative read (e.g. ERROR_DEAD_OBJECT after an audio-route
|
||||||
|
// change, ERROR_INVALID_OPERATION) means this AudioRecord is
|
||||||
|
// finished. Deactivate the Python engine so is_available() stops
|
||||||
|
// advertising a dead stream and the audio-reactive consumer isn't
|
||||||
|
// left polling an empty queue forever. We're on the capture thread,
|
||||||
|
// so we can't call stop() (it would self-join) — just flip running
|
||||||
|
// and shut the engine down; onDestroy's stop() releases the record.
|
||||||
|
Log.w(TAG, "AudioRecord.read error: $n — stopping audio capture")
|
||||||
|
running = false
|
||||||
|
runCatching { bridge.shutdownAudio() }
|
||||||
|
}
|
||||||
|
break
|
||||||
|
}
|
||||||
|
filled += n
|
||||||
|
if (filled < blockFloats) continue
|
||||||
|
|
||||||
|
floatView.clear()
|
||||||
|
floatView.put(floatBuf, 0, blockFloats)
|
||||||
|
bridge.pushAudio(byteBuf)
|
||||||
|
filled = 0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun channelMask(): Int =
|
||||||
|
if (channels >= 2) AudioFormat.CHANNEL_IN_STEREO else AudioFormat.CHANNEL_IN_MONO
|
||||||
|
|
||||||
|
private fun audioFormat(): AudioFormat =
|
||||||
|
AudioFormat.Builder()
|
||||||
|
.setEncoding(AudioFormat.ENCODING_PCM_FLOAT)
|
||||||
|
.setSampleRate(sampleRate)
|
||||||
|
.setChannelMask(channelMask())
|
||||||
|
.build()
|
||||||
|
|
||||||
|
private fun bufferBytes(): Int {
|
||||||
|
val minBuf = AudioRecord.getMinBufferSize(sampleRate, channelMask(), AudioFormat.ENCODING_PCM_FLOAT)
|
||||||
|
// A few blocks of headroom so a slow consumer doesn't overrun the
|
||||||
|
// hardware buffer between reads.
|
||||||
|
val want = chunkFrames * channels * BYTES_PER_FLOAT * 4
|
||||||
|
return if (minBuf > 0) maxOf(minBuf, want) else want
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,411 @@
|
|||||||
|
package com.ledgrab.android
|
||||||
|
|
||||||
|
import android.Manifest
|
||||||
|
import android.annotation.SuppressLint
|
||||||
|
import android.content.Context
|
||||||
|
import android.content.pm.PackageManager
|
||||||
|
import android.graphics.ImageFormat
|
||||||
|
import android.hardware.camera2.CameraCaptureSession
|
||||||
|
import android.hardware.camera2.CameraCharacteristics
|
||||||
|
import android.hardware.camera2.CameraDevice
|
||||||
|
import android.hardware.camera2.CameraManager
|
||||||
|
import android.media.Image
|
||||||
|
import android.media.ImageReader
|
||||||
|
import android.os.Handler
|
||||||
|
import android.os.HandlerThread
|
||||||
|
import android.os.SystemClock
|
||||||
|
import android.util.Log
|
||||||
|
import android.util.Size
|
||||||
|
import android.view.Surface
|
||||||
|
import com.chaquo.python.PyObject
|
||||||
|
import com.chaquo.python.Python
|
||||||
|
import kotlin.coroutines.resume
|
||||||
|
import kotlin.coroutines.resumeWithException
|
||||||
|
import kotlinx.coroutines.runBlocking
|
||||||
|
import kotlinx.coroutines.suspendCancellableCoroutine
|
||||||
|
import kotlinx.coroutines.withTimeout
|
||||||
|
import org.json.JSONArray
|
||||||
|
import org.json.JSONObject
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Android camera bridge exposed to the Python server via Chaquopy.
|
||||||
|
*
|
||||||
|
* Wraps the Camera2 API into synchronous, blocking calls that can be
|
||||||
|
* invoked from a Python thread (Chaquopy proxy threads are real OS
|
||||||
|
* threads). The physical camera is opened **on demand** — Python's
|
||||||
|
* `android_camera_engine` calls [startCamera] when a capture stream
|
||||||
|
* initializes and [stopCamera] when it cleans up, so the camera-in-use
|
||||||
|
* indicator and battery cost are limited to actual use.
|
||||||
|
*
|
||||||
|
* Each captured frame is converted YUV_420_888 → RGB and pushed to the
|
||||||
|
* Python engine's `push_frame`, mirroring how [ScreenCapture] feeds
|
||||||
|
* `mediaprojection_engine`. Camera2 callbacks run on a private
|
||||||
|
* [HandlerThread] so they never touch the main looper.
|
||||||
|
*
|
||||||
|
* Python callers access the singleton via
|
||||||
|
* `jclass("com.ledgrab.android.CameraBridge").INSTANCE` — see
|
||||||
|
* `server/src/ledgrab/core/capture_engines/android_camera_engine.py`.
|
||||||
|
*/
|
||||||
|
object CameraBridge {
|
||||||
|
private const val TAG = "CameraBridge"
|
||||||
|
private const val ENGINE_MODULE = "ledgrab.core.capture_engines.android_camera_engine"
|
||||||
|
private const val OPEN_TIMEOUT_MS = 8_000L
|
||||||
|
private const val MAX_IMAGES = 2
|
||||||
|
private const val TARGET_FPS = 20
|
||||||
|
// "auto" capture size — balanced for ambient LED sampling (the LED
|
||||||
|
// pipeline downscales anyway), kept modest so the per-frame YUV→RGB
|
||||||
|
// conversion stays cheap on low-end TV boxes.
|
||||||
|
private const val DEFAULT_W = 1280
|
||||||
|
private const val DEFAULT_H = 720
|
||||||
|
private const val BYTES_PER_RGB = 3
|
||||||
|
|
||||||
|
@Volatile private var appContext: Context? = null
|
||||||
|
|
||||||
|
// Dedicated looper thread so Camera2 callbacks don't land on main.
|
||||||
|
private val camThread = HandlerThread("LedGrab-Camera").also { it.start() }
|
||||||
|
private val camHandler = Handler(camThread.looper)
|
||||||
|
|
||||||
|
// Active session state — guarded by [lock]. One camera at a time.
|
||||||
|
private val lock = Any()
|
||||||
|
private var cameraDevice: CameraDevice? = null
|
||||||
|
private var captureSession: CameraCaptureSession? = null
|
||||||
|
private var imageReader: ImageReader? = null
|
||||||
|
@Volatile private var running = false
|
||||||
|
private var activeIndex = -1
|
||||||
|
|
||||||
|
// Cached Python engine module handle for the per-frame push fast path.
|
||||||
|
@Volatile private var engineModule: PyObject? = null
|
||||||
|
|
||||||
|
// Reusable conversion buffers — sized once per session (output size is
|
||||||
|
// fixed for the session), reused to avoid per-frame GC churn on TV boxes.
|
||||||
|
private var rgbBuffer: ByteArray? = null
|
||||||
|
private var yBuf: ByteArray? = null
|
||||||
|
private var uBuf: ByteArray? = null
|
||||||
|
private var vBuf: ByteArray? = null
|
||||||
|
|
||||||
|
// Monotonic frame pacing (mirrors ScreenCapture's accumulator).
|
||||||
|
private val frameIntervalNanos = 1_000_000_000L / TARGET_FPS.coerceAtLeast(1)
|
||||||
|
private var nextFrameNanos = 0L
|
||||||
|
|
||||||
|
/** Called once from [LedGrabApp.onCreate] to bind the application context. */
|
||||||
|
@JvmStatic
|
||||||
|
fun init(context: Context) {
|
||||||
|
appContext = context.applicationContext
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Enumerate cameras as a JSON array string the Python engine parses:
|
||||||
|
* `[{"index":0,"name":"Back camera","facing":"back","cameraId":"0"}, ...]`
|
||||||
|
*
|
||||||
|
* Indices are stable (positional in [CameraManager.cameraIdList]) so
|
||||||
|
* Python's `display_index` maps 1:1 to [startCamera]'s `index`.
|
||||||
|
* Enumeration needs no CAMERA permission. Returns `[]` on any error.
|
||||||
|
*/
|
||||||
|
@JvmStatic
|
||||||
|
fun listCameras(): String {
|
||||||
|
val arr = JSONArray()
|
||||||
|
val ctx = appContext
|
||||||
|
if (ctx == null) {
|
||||||
|
Log.w(TAG, "listCameras: context not bound (init not called)")
|
||||||
|
return arr.toString()
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
val mgr = ctx.getSystemService(Context.CAMERA_SERVICE) as CameraManager
|
||||||
|
mgr.cameraIdList.forEachIndexed { idx, id ->
|
||||||
|
val facing = facingOf(mgr, id)
|
||||||
|
val name = when (facing) {
|
||||||
|
"front" -> "Front camera"
|
||||||
|
"back" -> "Back camera"
|
||||||
|
"external" -> "External camera $idx"
|
||||||
|
else -> "Camera $idx"
|
||||||
|
}
|
||||||
|
arr.put(
|
||||||
|
JSONObject()
|
||||||
|
.put("index", idx)
|
||||||
|
.put("name", name)
|
||||||
|
.put("facing", facing)
|
||||||
|
.put("cameraId", id),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
} catch (e: Exception) {
|
||||||
|
Log.w(TAG, "listCameras failed: ${e.message}")
|
||||||
|
}
|
||||||
|
return arr.toString()
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Open camera [index] and start streaming RGB frames to Python.
|
||||||
|
* Blocks until the capture session is configured (or fails/times out).
|
||||||
|
*
|
||||||
|
* Returns false — without throwing across the JNI boundary — when the
|
||||||
|
* CAMERA permission is missing, the index is out of range, or the
|
||||||
|
* device/session fails to configure. Closes any previously-open camera
|
||||||
|
* first (one active at a time).
|
||||||
|
*/
|
||||||
|
@SuppressLint("MissingPermission")
|
||||||
|
@JvmStatic
|
||||||
|
fun startCamera(index: Int, width: Int, height: Int): Boolean {
|
||||||
|
synchronized(lock) {
|
||||||
|
closeLocked()
|
||||||
|
|
||||||
|
val ctx = appContext ?: run {
|
||||||
|
Log.w(TAG, "startCamera: context not bound")
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
if (ctx.checkSelfPermission(Manifest.permission.CAMERA)
|
||||||
|
!= PackageManager.PERMISSION_GRANTED
|
||||||
|
) {
|
||||||
|
Log.w(TAG, "startCamera: CAMERA permission not granted")
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
val mgr = ctx.getSystemService(Context.CAMERA_SERVICE) as CameraManager
|
||||||
|
val ids = try {
|
||||||
|
mgr.cameraIdList
|
||||||
|
} catch (e: Exception) {
|
||||||
|
Log.w(TAG, "startCamera: cameraIdList failed: ${e.message}")
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
if (index < 0 || index >= ids.size) {
|
||||||
|
Log.w(TAG, "startCamera: index $index out of range (${ids.size} cameras)")
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
val cameraId = ids[index]
|
||||||
|
val size = chooseSize(mgr, cameraId, width, height) ?: run {
|
||||||
|
Log.w(TAG, "startCamera: no YUV output sizes for camera $index")
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
val reader = ImageReader.newInstance(
|
||||||
|
size.width, size.height, ImageFormat.YUV_420_888, MAX_IMAGES,
|
||||||
|
)
|
||||||
|
// Size the conversion buffers once for this session.
|
||||||
|
rgbBuffer = ByteArray(size.width * size.height * BYTES_PER_RGB)
|
||||||
|
yBuf = null; uBuf = null; vBuf = null
|
||||||
|
nextFrameNanos = SystemClock.elapsedRealtimeNanos()
|
||||||
|
reader.setOnImageAvailableListener({ r -> onFrame(r) }, camHandler)
|
||||||
|
|
||||||
|
return try {
|
||||||
|
runBlocking {
|
||||||
|
withTimeout(OPEN_TIMEOUT_MS) {
|
||||||
|
// Publish each resource to its field as soon as it exists so
|
||||||
|
// closeLocked() (in the catch) can release it if a LATER step
|
||||||
|
// throws. Assigning only after setRepeatingRequest succeeds
|
||||||
|
// would orphan the opened CameraDevice on a createSession /
|
||||||
|
// setRepeatingRequest failure (camera stuck on; subsequent
|
||||||
|
// opens fail with CAMERA_IN_USE).
|
||||||
|
imageReader = reader
|
||||||
|
val device = openCamera(mgr, cameraId)
|
||||||
|
cameraDevice = device
|
||||||
|
val session = createSession(device, reader.surface)
|
||||||
|
captureSession = session
|
||||||
|
val request = device.createCaptureRequest(CameraDevice.TEMPLATE_PREVIEW)
|
||||||
|
.apply { addTarget(reader.surface) }
|
||||||
|
.build()
|
||||||
|
session.setRepeatingRequest(request, null, camHandler)
|
||||||
|
activeIndex = index
|
||||||
|
running = true
|
||||||
|
Log.i(TAG, "Camera $index opened (${size.width}x${size.height} @ ${TARGET_FPS}fps)")
|
||||||
|
true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (e: Exception) {
|
||||||
|
Log.e(TAG, "startCamera($index) failed: ${e.message}")
|
||||||
|
// imageReader/cameraDevice/captureSession are now whatever got
|
||||||
|
// assigned before the failure — closeLocked releases each exactly
|
||||||
|
// once (idempotent, runCatching-wrapped).
|
||||||
|
closeLocked()
|
||||||
|
false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Stop streaming and release the camera. Idempotent; safe if not started. */
|
||||||
|
@JvmStatic
|
||||||
|
fun stopCamera() {
|
||||||
|
synchronized(lock) { closeLocked() }
|
||||||
|
Log.i(TAG, "Camera stopped")
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── internals ────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
private fun facingOf(mgr: CameraManager, id: String): String =
|
||||||
|
when (mgr.getCameraCharacteristics(id).get(CameraCharacteristics.LENS_FACING)) {
|
||||||
|
CameraCharacteristics.LENS_FACING_FRONT -> "front"
|
||||||
|
CameraCharacteristics.LENS_FACING_BACK -> "back"
|
||||||
|
CameraCharacteristics.LENS_FACING_EXTERNAL -> "external"
|
||||||
|
else -> "unknown"
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Pick the supported YUV size closest in area to the request (or the
|
||||||
|
* balanced default for `auto`/0). */
|
||||||
|
private fun chooseSize(mgr: CameraManager, cameraId: String, reqW: Int, reqH: Int): Size? {
|
||||||
|
val map = mgr.getCameraCharacteristics(cameraId)
|
||||||
|
.get(CameraCharacteristics.SCALER_STREAM_CONFIGURATION_MAP) ?: return null
|
||||||
|
val sizes = map.getOutputSizes(ImageFormat.YUV_420_888)
|
||||||
|
if (sizes == null || sizes.isEmpty()) return null
|
||||||
|
val targetArea = (if (reqW > 0) reqW else DEFAULT_W).toLong() *
|
||||||
|
(if (reqH > 0) reqH else DEFAULT_H)
|
||||||
|
return sizes.minByOrNull { kotlin.math.abs(it.width.toLong() * it.height - targetArea) }
|
||||||
|
}
|
||||||
|
|
||||||
|
@SuppressLint("MissingPermission")
|
||||||
|
private suspend fun openCamera(mgr: CameraManager, cameraId: String): CameraDevice =
|
||||||
|
suspendCancellableCoroutine { cont ->
|
||||||
|
mgr.openCamera(cameraId, object : CameraDevice.StateCallback() {
|
||||||
|
override fun onOpened(device: CameraDevice) {
|
||||||
|
if (cont.isActive) cont.resume(device) else device.close()
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun onDisconnected(device: CameraDevice) {
|
||||||
|
device.close()
|
||||||
|
if (cont.isActive) cont.resumeWithException(IllegalStateException("camera disconnected"))
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun onError(device: CameraDevice, error: Int) {
|
||||||
|
device.close()
|
||||||
|
if (cont.isActive) cont.resumeWithException(IllegalStateException("camera error $error"))
|
||||||
|
}
|
||||||
|
}, camHandler)
|
||||||
|
}
|
||||||
|
|
||||||
|
@Suppress("DEPRECATION")
|
||||||
|
private suspend fun createSession(device: CameraDevice, surface: Surface): CameraCaptureSession =
|
||||||
|
suspendCancellableCoroutine { cont ->
|
||||||
|
// createCaptureSession(List, callback, handler) is deprecated at
|
||||||
|
// API 30 but is the correct API down to minSdk 24 (the
|
||||||
|
// SessionConfiguration overload is API 28+).
|
||||||
|
device.createCaptureSession(
|
||||||
|
listOf(surface),
|
||||||
|
object : CameraCaptureSession.StateCallback() {
|
||||||
|
override fun onConfigured(session: CameraCaptureSession) {
|
||||||
|
if (cont.isActive) cont.resume(session)
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun onConfigureFailed(session: CameraCaptureSession) {
|
||||||
|
if (cont.isActive) cont.resumeWithException(IllegalStateException("session configure failed"))
|
||||||
|
}
|
||||||
|
},
|
||||||
|
camHandler,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
/** ImageReader callback — paced, converts YUV→RGB, pushes to Python. */
|
||||||
|
private fun onFrame(reader: ImageReader) {
|
||||||
|
if (!running) {
|
||||||
|
runCatching { reader.acquireLatestImage()?.close() }
|
||||||
|
return
|
||||||
|
}
|
||||||
|
val now = SystemClock.elapsedRealtimeNanos()
|
||||||
|
if (now < nextFrameNanos) {
|
||||||
|
runCatching { reader.acquireLatestImage()?.close() }
|
||||||
|
return
|
||||||
|
}
|
||||||
|
val image = runCatching { reader.acquireLatestImage() }.getOrNull() ?: return
|
||||||
|
try {
|
||||||
|
val w = image.width
|
||||||
|
val h = image.height
|
||||||
|
val out = ensureRgbBuffer(w * h * BYTES_PER_RGB)
|
||||||
|
yuv420ToRgb(image, out, w, h)
|
||||||
|
pushFrame(out, w, h)
|
||||||
|
nextFrameNanos += frameIntervalNanos
|
||||||
|
if (now - nextFrameNanos > frameIntervalNanos * 4) {
|
||||||
|
nextFrameNanos = now + frameIntervalNanos
|
||||||
|
}
|
||||||
|
} catch (e: Exception) {
|
||||||
|
Log.w(TAG, "frame processing error: ${e.message}")
|
||||||
|
} finally {
|
||||||
|
runCatching { image.close() }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun ensureRgbBuffer(size: Int): ByteArray {
|
||||||
|
val buf = rgbBuffer
|
||||||
|
if (buf != null && buf.size == size) return buf
|
||||||
|
return ByteArray(size).also { rgbBuffer = it }
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Stride-aware YUV_420_888 → packed RGB (3 bytes/px) using BT.601
|
||||||
|
* fixed-point coefficients. Handles both planar and semi-planar
|
||||||
|
* (NV21-like, pixelStride 2) chroma layouts via the plane strides.
|
||||||
|
*/
|
||||||
|
private fun yuv420ToRgb(image: Image, out: ByteArray, width: Int, height: Int) {
|
||||||
|
val planes = image.planes
|
||||||
|
val yPlane = planes[0]
|
||||||
|
val uPlane = planes[1]
|
||||||
|
val vPlane = planes[2]
|
||||||
|
|
||||||
|
val yRowStride = yPlane.rowStride
|
||||||
|
val yPixStride = yPlane.pixelStride
|
||||||
|
val uRowStride = uPlane.rowStride
|
||||||
|
val uPixStride = uPlane.pixelStride
|
||||||
|
val vRowStride = vPlane.rowStride
|
||||||
|
val vPixStride = vPlane.pixelStride
|
||||||
|
|
||||||
|
// Copy each plane to a reusable array for fast indexed access
|
||||||
|
// (ByteBuffer absolute-get per pixel is far slower).
|
||||||
|
val yByteBuf = yPlane.buffer
|
||||||
|
val uByteBuf = uPlane.buffer
|
||||||
|
val vByteBuf = vPlane.buffer
|
||||||
|
val yArr = ensurePlane(yBuf, yByteBuf.remaining()).also { yBuf = it }
|
||||||
|
val uArr = ensurePlane(uBuf, uByteBuf.remaining()).also { uBuf = it }
|
||||||
|
val vArr = ensurePlane(vBuf, vByteBuf.remaining()).also { vBuf = it }
|
||||||
|
yByteBuf.get(yArr, 0, yArr.size)
|
||||||
|
uByteBuf.get(uArr, 0, uArr.size)
|
||||||
|
vByteBuf.get(vArr, 0, vArr.size)
|
||||||
|
|
||||||
|
var o = 0
|
||||||
|
for (row in 0 until height) {
|
||||||
|
val yRowBase = row * yRowStride
|
||||||
|
val uvRow = row shr 1
|
||||||
|
val uRowBase = uvRow * uRowStride
|
||||||
|
val vRowBase = uvRow * vRowStride
|
||||||
|
for (col in 0 until width) {
|
||||||
|
val y = (yArr[yRowBase + col * yPixStride].toInt() and 0xFF)
|
||||||
|
val uvCol = col shr 1
|
||||||
|
val u = (uArr[uRowBase + uvCol * uPixStride].toInt() and 0xFF) - 128
|
||||||
|
val v = (vArr[vRowBase + uvCol * vPixStride].toInt() and 0xFF) - 128
|
||||||
|
// BT.601 full-range, fixed-point (<<16).
|
||||||
|
var r = y + ((91881 * v) shr 16)
|
||||||
|
var g = y - ((22554 * u + 46802 * v) shr 16)
|
||||||
|
var b = y + ((116130 * u) shr 16)
|
||||||
|
if (r < 0) r = 0 else if (r > 255) r = 255
|
||||||
|
if (g < 0) g = 0 else if (g > 255) g = 255
|
||||||
|
if (b < 0) b = 0 else if (b > 255) b = 255
|
||||||
|
out[o++] = r.toByte()
|
||||||
|
out[o++] = g.toByte()
|
||||||
|
out[o++] = b.toByte()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Return [cached] if it already fits [n] bytes, else a fresh array. */
|
||||||
|
private fun ensurePlane(cached: ByteArray?, n: Int): ByteArray =
|
||||||
|
if (cached != null && cached.size == n) cached else ByteArray(n)
|
||||||
|
|
||||||
|
private fun pushFrame(rgb: ByteArray, width: Int, height: Int) {
|
||||||
|
val module = engineModule ?: runCatching {
|
||||||
|
Python.getInstance().getModule(ENGINE_MODULE)
|
||||||
|
}.getOrNull()?.also { engineModule = it } ?: return
|
||||||
|
try {
|
||||||
|
module.callAttr("push_frame", rgb, width, height)
|
||||||
|
} catch (e: Exception) {
|
||||||
|
Log.w(TAG, "push_frame failed: ${e.message}")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Tear down the active session. Caller holds [lock]. */
|
||||||
|
private fun closeLocked() {
|
||||||
|
running = false
|
||||||
|
activeIndex = -1
|
||||||
|
runCatching { imageReader?.setOnImageAvailableListener(null, null) }
|
||||||
|
runCatching { captureSession?.stopRepeating() }
|
||||||
|
runCatching { captureSession?.close() }
|
||||||
|
captureSession = null
|
||||||
|
runCatching { cameraDevice?.close() }
|
||||||
|
cameraDevice = null
|
||||||
|
runCatching { imageReader?.close() }
|
||||||
|
imageReader = null
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -4,9 +4,12 @@ import android.app.Notification
|
|||||||
import android.app.NotificationChannel
|
import android.app.NotificationChannel
|
||||||
import android.app.NotificationManager
|
import android.app.NotificationManager
|
||||||
import android.app.PendingIntent
|
import android.app.PendingIntent
|
||||||
|
import android.Manifest
|
||||||
import android.app.Service
|
import android.app.Service
|
||||||
import android.content.Context
|
import android.content.Context
|
||||||
import android.content.Intent
|
import android.content.Intent
|
||||||
|
import android.content.pm.PackageManager
|
||||||
|
import android.content.pm.ServiceInfo
|
||||||
import android.media.projection.MediaProjection
|
import android.media.projection.MediaProjection
|
||||||
import android.media.projection.MediaProjectionManager
|
import android.media.projection.MediaProjectionManager
|
||||||
import android.os.Build
|
import android.os.Build
|
||||||
@@ -15,6 +18,7 @@ import android.util.DisplayMetrics
|
|||||||
import android.util.Log
|
import android.util.Log
|
||||||
import android.view.WindowManager
|
import android.view.WindowManager
|
||||||
import androidx.core.app.NotificationCompat
|
import androidx.core.app.NotificationCompat
|
||||||
|
import androidx.core.app.ServiceCompat
|
||||||
import kotlinx.coroutines.CoroutineScope
|
import kotlinx.coroutines.CoroutineScope
|
||||||
import kotlinx.coroutines.Dispatchers
|
import kotlinx.coroutines.Dispatchers
|
||||||
import kotlinx.coroutines.Job
|
import kotlinx.coroutines.Job
|
||||||
@@ -26,7 +30,13 @@ import kotlinx.coroutines.launch
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Foreground service that runs the Python LedGrab server and captures
|
* Foreground service that runs the Python LedGrab server and captures
|
||||||
* the screen via MediaProjection.
|
* the screen via MediaProjection or root screenrecord.
|
||||||
|
*
|
||||||
|
* On Android 14+ the foreground-service "type" must match the work
|
||||||
|
* being done. We promote the service with the correct type (mediaProjection
|
||||||
|
* for the consent path, specialUse for the root path) instead of
|
||||||
|
* declaring a single fixed type in the manifest — the manifest now
|
||||||
|
* declares the *union* so promotion at runtime is permitted.
|
||||||
*/
|
*/
|
||||||
class CaptureService : Service() {
|
class CaptureService : Service() {
|
||||||
|
|
||||||
@@ -77,6 +87,7 @@ class CaptureService : Service() {
|
|||||||
private var bridge: PythonBridge? = null
|
private var bridge: PythonBridge? = null
|
||||||
private var screenCapture: ScreenCapture? = null
|
private var screenCapture: ScreenCapture? = null
|
||||||
private var rootCapture: RootScreenrecord? = null
|
private var rootCapture: RootScreenrecord? = null
|
||||||
|
private var audioCapture: AudioCapture? = null
|
||||||
private var mediaProjection: MediaProjection? = null
|
private var mediaProjection: MediaProjection? = null
|
||||||
|
|
||||||
// Service-scoped coroutine scope for the root-capture watchdog.
|
// Service-scoped coroutine scope for the root-capture watchdog.
|
||||||
@@ -92,15 +103,47 @@ class CaptureService : Service() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
override fun onStartCommand(intent: Intent?, flags: Int, startId: Int): Int {
|
override fun onStartCommand(intent: Intent?, flags: Int, startId: Int): Int {
|
||||||
// CRITICAL: startForeground must be called IMMEDIATELY —
|
val useRoot = intent?.getBooleanExtra(EXTRA_USE_ROOT, false) ?: false
|
||||||
// before any other work, especially before getMediaProjection().
|
|
||||||
val localIp = NetworkUtils.getLocalIpAddress(this) ?: "unknown"
|
// CRITICAL: startForeground must be called IMMEDIATELY — before
|
||||||
|
// any other work, especially before getMediaProjection(). The
|
||||||
|
// service type must match the work; pass it explicitly via
|
||||||
|
// ServiceCompat so we stay compatible back to API 24.
|
||||||
|
val localIp = NetworkUtils.getLocalIpAddress(this) ?: "—"
|
||||||
val url = "http://$localIp:$SERVER_PORT"
|
val url = "http://$localIp:$SERVER_PORT"
|
||||||
try {
|
try {
|
||||||
startForeground(NOTIFICATION_ID, buildNotification(url))
|
val type = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.UPSIDE_DOWN_CAKE) {
|
||||||
|
var t = if (useRoot) {
|
||||||
|
ServiceInfo.FOREGROUND_SERVICE_TYPE_SPECIAL_USE
|
||||||
|
} else {
|
||||||
|
ServiceInfo.FOREGROUND_SERVICE_TYPE_MEDIA_PROJECTION
|
||||||
|
}
|
||||||
|
// On-demand webcam capture opens the camera from this service.
|
||||||
|
// To retain camera access once the app is backgrounded (the
|
||||||
|
// always-on ambient-lighting case), API 34+ requires the camera
|
||||||
|
// FGS type. Add it ONLY when CAMERA is already granted — promoting
|
||||||
|
// with the camera type without the runtime permission throws and
|
||||||
|
// would kill the whole service on the (common) camera-less or
|
||||||
|
// not-yet-granted box. If CAMERA is granted later, it takes effect
|
||||||
|
// on the next Start (matches the audio/permission UX).
|
||||||
|
if (checkSelfPermission(Manifest.permission.CAMERA) ==
|
||||||
|
PackageManager.PERMISSION_GRANTED
|
||||||
|
) {
|
||||||
|
t = t or ServiceInfo.FOREGROUND_SERVICE_TYPE_CAMERA
|
||||||
|
}
|
||||||
|
t
|
||||||
|
} else {
|
||||||
|
0
|
||||||
|
}
|
||||||
|
ServiceCompat.startForeground(
|
||||||
|
this,
|
||||||
|
NOTIFICATION_ID,
|
||||||
|
buildNotification(url),
|
||||||
|
type,
|
||||||
|
)
|
||||||
} catch (e: Exception) {
|
} catch (e: Exception) {
|
||||||
// Most common cause: missing foregroundServiceType permission
|
// Most common cause: missing foregroundServiceType permission
|
||||||
// or denied POST_NOTIFICATIONS on API 34+.
|
// or denied POST_NOTIFICATIONS on API 33+.
|
||||||
Log.e(TAG, "startForeground failed — service cannot run", e)
|
Log.e(TAG, "startForeground failed — service cannot run", e)
|
||||||
stopSelf()
|
stopSelf()
|
||||||
return START_NOT_STICKY
|
return START_NOT_STICKY
|
||||||
@@ -109,8 +152,6 @@ class CaptureService : Service() {
|
|||||||
// otherwise `isRunning=true` sticks forever when startForeground throws.
|
// otherwise `isRunning=true` sticks forever when startForeground throws.
|
||||||
isRunning = true
|
isRunning = true
|
||||||
|
|
||||||
val useRoot = intent?.getBooleanExtra(EXTRA_USE_ROOT, false) ?: false
|
|
||||||
|
|
||||||
if (intent == null && !useRoot) {
|
if (intent == null && !useRoot) {
|
||||||
// MediaProjection mode can't recover from a redelivery —
|
// MediaProjection mode can't recover from a redelivery —
|
||||||
// the consent token in the original intent is single-use.
|
// the consent token in the original intent is single-use.
|
||||||
@@ -140,10 +181,13 @@ class CaptureService : Service() {
|
|||||||
return if (useRoot) START_REDELIVER_INTENT else START_NOT_STICKY
|
return if (useRoot) START_REDELIVER_INTENT else START_NOT_STICKY
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private fun apiKey(): String? =
|
||||||
|
(application as? LedGrabApp)?.apiKeyManager?.apiKey
|
||||||
|
|
||||||
private fun startRootCapture(url: String) {
|
private fun startRootCapture(url: String) {
|
||||||
val newBridge = PythonBridge(this).also { b ->
|
val newBridge = PythonBridge(this).also { b ->
|
||||||
b.configureRootCapture(CAPTURE_WIDTH, CAPTURE_HEIGHT)
|
b.configureRootCapture(CAPTURE_WIDTH, CAPTURE_HEIGHT)
|
||||||
b.startServer(SERVER_PORT)
|
b.startServer(SERVER_PORT, apiKey())
|
||||||
}
|
}
|
||||||
bridge = newBridge
|
bridge = newBridge
|
||||||
|
|
||||||
@@ -167,12 +211,21 @@ class CaptureService : Service() {
|
|||||||
* Replace the active root pipeline with a fresh instance, reusing
|
* Replace the active root pipeline with a fresh instance, reusing
|
||||||
* the existing Python bridge (no server restart). Returns true if
|
* the existing Python bridge (no server restart). Returns true if
|
||||||
* the new pipeline launched, false otherwise.
|
* the new pipeline launched, false otherwise.
|
||||||
|
*
|
||||||
|
* Synchronized so a concurrent onDestroy() either (a) sees the old
|
||||||
|
* instance and stops it then null-out, or (b) sees the new instance
|
||||||
|
* and stops it. There is no window where a fresh instance can be
|
||||||
|
* orphaned with no one holding a reference to it.
|
||||||
*/
|
*/
|
||||||
|
@Synchronized
|
||||||
private fun restartRootPipeline(): Boolean {
|
private fun restartRootPipeline(): Boolean {
|
||||||
val currentBridge = bridge ?: return false
|
val currentBridge = bridge ?: return false
|
||||||
val old = rootCapture
|
// Tear down the old instance first so we don't run two
|
||||||
rootCapture = null
|
// screenrecord processes simultaneously fighting for the GPU.
|
||||||
runCatching { old?.stop() }
|
rootCapture?.let { old ->
|
||||||
|
rootCapture = null
|
||||||
|
runCatching { old.stop() }
|
||||||
|
}
|
||||||
|
|
||||||
val next = RootScreenrecord(
|
val next = RootScreenrecord(
|
||||||
bridge = currentBridge,
|
bridge = currentBridge,
|
||||||
@@ -180,11 +233,21 @@ class CaptureService : Service() {
|
|||||||
height = CAPTURE_HEIGHT,
|
height = CAPTURE_HEIGHT,
|
||||||
fps = CAPTURE_FPS,
|
fps = CAPTURE_FPS,
|
||||||
)
|
)
|
||||||
|
// Publish BEFORE start() — if onDestroy fires after this
|
||||||
|
// assignment but before start() completes, the field is non-null
|
||||||
|
// and onDestroy will stop() it properly. start() is idempotent
|
||||||
|
// enough (running=true, then resource construction) that being
|
||||||
|
// raced by stop() at most produces a brief partial-init that
|
||||||
|
// the next stop() call cleans up.
|
||||||
|
rootCapture = next
|
||||||
if (!next.start()) {
|
if (!next.start()) {
|
||||||
Log.e(TAG, "Root capture failed to restart")
|
Log.e(TAG, "Root capture failed to restart")
|
||||||
|
// start() already called stop() on itself on the failure
|
||||||
|
// path — but null out the field so the watchdog/onDestroy
|
||||||
|
// don't try to stop it again.
|
||||||
|
rootCapture = null
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
rootCapture = next
|
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -212,7 +275,7 @@ class CaptureService : Service() {
|
|||||||
"Root capture stalled (no new frames in ${WATCHDOG_CHECK_MS}ms); " +
|
"Root capture stalled (no new frames in ${WATCHDOG_CHECK_MS}ms); " +
|
||||||
"restart attempt $restartAttempts/$WATCHDOG_MAX_RESTARTS",
|
"restart attempt $restartAttempts/$WATCHDOG_MAX_RESTARTS",
|
||||||
)
|
)
|
||||||
if (restartAttempts > WATCHDOG_MAX_RESTARTS) {
|
if (restartAttempts >= WATCHDOG_MAX_RESTARTS) {
|
||||||
Log.e(TAG, "Watchdog gave up after $WATCHDOG_MAX_RESTARTS restarts")
|
Log.e(TAG, "Watchdog gave up after $WATCHDOG_MAX_RESTARTS restarts")
|
||||||
stopSelf()
|
stopSelf()
|
||||||
return@launch
|
return@launch
|
||||||
@@ -263,7 +326,6 @@ class CaptureService : Service() {
|
|||||||
val bounds = windowMetrics.bounds
|
val bounds = windowMetrics.bounds
|
||||||
widthPixels = bounds.width()
|
widthPixels = bounds.width()
|
||||||
heightPixels = bounds.height()
|
heightPixels = bounds.height()
|
||||||
// densityDpi is still needed for VirtualDisplay; read from resources.
|
|
||||||
densityDpi = resources.displayMetrics.densityDpi
|
densityDpi = resources.displayMetrics.densityDpi
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
@@ -276,7 +338,7 @@ class CaptureService : Service() {
|
|||||||
|
|
||||||
val newBridge = PythonBridge(this).also { b ->
|
val newBridge = PythonBridge(this).also { b ->
|
||||||
b.configureCapture(CAPTURE_WIDTH, CAPTURE_HEIGHT)
|
b.configureCapture(CAPTURE_WIDTH, CAPTURE_HEIGHT)
|
||||||
b.startServer(SERVER_PORT)
|
b.startServer(SERVER_PORT, apiKey())
|
||||||
}
|
}
|
||||||
bridge = newBridge
|
bridge = newBridge
|
||||||
|
|
||||||
@@ -293,6 +355,25 @@ class CaptureService : Service() {
|
|||||||
onProjectionStopped = { stopSelf() },
|
onProjectionStopped = { stopSelf() },
|
||||||
).also { it.start() }
|
).also { it.start() }
|
||||||
|
|
||||||
|
// Reuse the same projection to capture system playback audio so
|
||||||
|
// audio-reactive lighting works on-device (API 29+, RECORD_AUDIO
|
||||||
|
// granted). Best-effort: screen capture and the server keep running
|
||||||
|
// if audio is unavailable. Started AFTER ScreenCapture so the
|
||||||
|
// projection's callback is already registered.
|
||||||
|
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q &&
|
||||||
|
checkSelfPermission(Manifest.permission.RECORD_AUDIO) ==
|
||||||
|
PackageManager.PERMISSION_GRANTED
|
||||||
|
) {
|
||||||
|
audioCapture = AudioCapture(projection, newBridge).also { ac ->
|
||||||
|
if (!ac.start()) {
|
||||||
|
Log.i(TAG, "Playback audio capture unavailable — continuing without audio")
|
||||||
|
audioCapture = null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
Log.i(TAG, "RECORD_AUDIO not granted or API < 29 — audio-reactive capture disabled")
|
||||||
|
}
|
||||||
|
|
||||||
Log.i(TAG, "LedGrab service started (MediaProjection) — web UI at $url")
|
Log.i(TAG, "LedGrab service started (MediaProjection) — web UI at $url")
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -306,6 +387,10 @@ class CaptureService : Service() {
|
|||||||
screenCapture?.stop()
|
screenCapture?.stop()
|
||||||
screenCapture = null
|
screenCapture = null
|
||||||
|
|
||||||
|
// Stop audio before the server: stop() calls bridge.shutdownAudio().
|
||||||
|
audioCapture?.stop()
|
||||||
|
audioCapture = null
|
||||||
|
|
||||||
rootCapture?.stop()
|
rootCapture?.stop()
|
||||||
rootCapture = null
|
rootCapture = null
|
||||||
|
|
||||||
@@ -323,10 +408,10 @@ class CaptureService : Service() {
|
|||||||
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
|
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
|
||||||
val channel = NotificationChannel(
|
val channel = NotificationChannel(
|
||||||
CHANNEL_ID,
|
CHANNEL_ID,
|
||||||
"LedGrab Screen Capture",
|
getString(R.string.notification_channel_name),
|
||||||
NotificationManager.IMPORTANCE_LOW,
|
NotificationManager.IMPORTANCE_LOW,
|
||||||
).apply {
|
).apply {
|
||||||
description = "Shows while LedGrab is capturing the screen"
|
description = getString(R.string.notification_channel_description)
|
||||||
}
|
}
|
||||||
val manager = getSystemService(NotificationManager::class.java)
|
val manager = getSystemService(NotificationManager::class.java)
|
||||||
manager.createNotificationChannel(channel)
|
manager.createNotificationChannel(channel)
|
||||||
@@ -343,9 +428,14 @@ class CaptureService : Service() {
|
|||||||
PendingIntent.FLAG_IMMUTABLE,
|
PendingIntent.FLAG_IMMUTABLE,
|
||||||
)
|
)
|
||||||
return NotificationCompat.Builder(this, CHANNEL_ID)
|
return NotificationCompat.Builder(this, CHANNEL_ID)
|
||||||
.setContentTitle("LedGrab Running")
|
.setContentTitle(getString(R.string.notification_title))
|
||||||
.setContentText("Web UI: $url")
|
.setContentText(getString(R.string.notification_text, url))
|
||||||
.setSmallIcon(R.drawable.ic_launcher)
|
// ic_notification is a monochrome 24dp vector — status-bar
|
||||||
|
// icons must be white-on-transparent or they render as a
|
||||||
|
// gray blob on Android 5+.
|
||||||
|
.setSmallIcon(R.drawable.ic_notification)
|
||||||
|
.setColor(0xFF64FFDA.toInt())
|
||||||
|
.setColorized(true)
|
||||||
.setContentIntent(tapIntent)
|
.setContentIntent(tapIntent)
|
||||||
.setOngoing(true)
|
.setOngoing(true)
|
||||||
.build()
|
.build()
|
||||||
|
|||||||
@@ -0,0 +1,154 @@
|
|||||||
|
package com.ledgrab.android
|
||||||
|
|
||||||
|
import android.app.AppOpsManager
|
||||||
|
import android.app.usage.UsageEvents
|
||||||
|
import android.app.usage.UsageStatsManager
|
||||||
|
import android.content.Context
|
||||||
|
import android.content.pm.LauncherApps
|
||||||
|
import android.os.Build
|
||||||
|
import android.os.Process
|
||||||
|
import android.util.Log
|
||||||
|
import org.json.JSONArray
|
||||||
|
import org.json.JSONObject
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Foreground-app + installed-app bridge exposed to the Python server via Chaquopy.
|
||||||
|
*
|
||||||
|
* Backs the Android implementation of the "Application" automation rule
|
||||||
|
* (foreground app -> activate scene). Desktop detects the foreground process via
|
||||||
|
* Win32 ctypes in ``platform_detector.py``; Android has no such API, so this
|
||||||
|
* bridge wraps two in-platform services into synchronous calls a Python thread
|
||||||
|
* can invoke (Chaquopy proxy threads are real OS threads):
|
||||||
|
*
|
||||||
|
* - [getForegroundPackage] via [UsageStatsManager] (needs PACKAGE_USAGE_STATS,
|
||||||
|
* a special-access permission granted from Settings — see MainActivity).
|
||||||
|
* - [listLaunchableApps] via [LauncherApps] for the automation editor's app
|
||||||
|
* picker (no QUERY_ALL_PACKAGES needed — getActivityList is the sanctioned
|
||||||
|
* launchable-app enumeration API).
|
||||||
|
* - [hasUsageAccess] so the server / UI can detect the missing grant.
|
||||||
|
*
|
||||||
|
* Detection only ever string-compares the foreground *package name*, so no label
|
||||||
|
* resolution / package visibility is required at match time.
|
||||||
|
*
|
||||||
|
* Python callers access the singleton via
|
||||||
|
* `jclass("com.ledgrab.android.ForegroundAppBridge").INSTANCE` — see
|
||||||
|
* `server/src/ledgrab/core/automations/platform_detector.py`.
|
||||||
|
*/
|
||||||
|
object ForegroundAppBridge {
|
||||||
|
private const val TAG = "ForegroundAppBridge"
|
||||||
|
|
||||||
|
// Trailing window for queryEvents. queryEvents reports discrete foreground
|
||||||
|
// transitions (not "current app"), and events can lag a few seconds, so we
|
||||||
|
// look back far enough to reliably catch the latest MOVE_TO_FOREGROUND while
|
||||||
|
// staying recent enough not to report a stale app on the ~1s automation tick.
|
||||||
|
private const val WINDOW_MS = 10_000L
|
||||||
|
|
||||||
|
@Volatile private var appContext: Context? = null
|
||||||
|
|
||||||
|
/** Called once from [LedGrabApp.onCreate] to bind the application context. */
|
||||||
|
@JvmStatic
|
||||||
|
fun init(context: Context) {
|
||||||
|
appContext = context.applicationContext
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Package name of the most recently foregrounded app, or null when none is
|
||||||
|
* found in the trailing window, Usage Access is not granted, or on any error.
|
||||||
|
* Never throws across the JNI boundary.
|
||||||
|
*/
|
||||||
|
@JvmStatic
|
||||||
|
fun getForegroundPackage(): String? {
|
||||||
|
val ctx = appContext ?: run {
|
||||||
|
Log.w(TAG, "getForegroundPackage: context not bound (init not called)")
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
return try {
|
||||||
|
val usm = ctx.getSystemService(Context.USAGE_STATS_SERVICE) as? UsageStatsManager
|
||||||
|
?: return null
|
||||||
|
val end = System.currentTimeMillis()
|
||||||
|
val events = usm.queryEvents(end - WINDOW_MS, end)
|
||||||
|
val event = UsageEvents.Event()
|
||||||
|
var latestPkg: String? = null
|
||||||
|
var latestTs = Long.MIN_VALUE
|
||||||
|
while (events.hasNextEvent()) {
|
||||||
|
events.getNextEvent(event)
|
||||||
|
// ACTIVITY_RESUMED (API 29+) shares the value of the legacy
|
||||||
|
// MOVE_TO_FOREGROUND constant, so the single check covers both.
|
||||||
|
// >= (not >) so that on an exact-timestamp tie the later-iterated
|
||||||
|
// event wins — events arrive chronologically, so that is the most
|
||||||
|
// recent foreground transition.
|
||||||
|
if (event.eventType == UsageEvents.Event.MOVE_TO_FOREGROUND &&
|
||||||
|
event.timeStamp >= latestTs
|
||||||
|
) {
|
||||||
|
latestTs = event.timeStamp
|
||||||
|
latestPkg = event.packageName
|
||||||
|
}
|
||||||
|
}
|
||||||
|
latestPkg
|
||||||
|
} catch (e: Exception) {
|
||||||
|
// SecurityException when access is missing, plus any service error.
|
||||||
|
Log.w(TAG, "getForegroundPackage failed: ${e.message}")
|
||||||
|
null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Whether the user has granted Usage Access (PACKAGE_USAGE_STATS) to this app. */
|
||||||
|
@JvmStatic
|
||||||
|
fun hasUsageAccess(): Boolean {
|
||||||
|
val ctx = appContext ?: return false
|
||||||
|
return try {
|
||||||
|
val appOps = ctx.getSystemService(Context.APP_OPS_SERVICE) as? AppOpsManager
|
||||||
|
?: return false
|
||||||
|
val mode = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
|
||||||
|
appOps.unsafeCheckOpNoThrow(
|
||||||
|
AppOpsManager.OPSTR_GET_USAGE_STATS, Process.myUid(), ctx.packageName,
|
||||||
|
)
|
||||||
|
} else {
|
||||||
|
@Suppress("DEPRECATION")
|
||||||
|
appOps.checkOpNoThrow(
|
||||||
|
AppOpsManager.OPSTR_GET_USAGE_STATS, Process.myUid(), ctx.packageName,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
mode == AppOpsManager.MODE_ALLOWED
|
||||||
|
} catch (e: Exception) {
|
||||||
|
Log.w(TAG, "hasUsageAccess failed: ${e.message}")
|
||||||
|
false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Launchable apps as a JSON array string the Python server parses:
|
||||||
|
* `[{"package":"com.netflix.mediaclient","label":"Netflix"}, ...]`
|
||||||
|
*
|
||||||
|
* Uses [LauncherApps.getActivityList] (launcher + leanback launchables) —
|
||||||
|
* no QUERY_ALL_PACKAGES. De-duplicated by package, sorted by label.
|
||||||
|
* Returns `[]` on any error.
|
||||||
|
*/
|
||||||
|
@JvmStatic
|
||||||
|
fun listLaunchableApps(): String {
|
||||||
|
val arr = JSONArray()
|
||||||
|
val ctx = appContext ?: run {
|
||||||
|
Log.w(TAG, "listLaunchableApps: context not bound (init not called)")
|
||||||
|
return arr.toString()
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
val launcher = ctx.getSystemService(Context.LAUNCHER_APPS_SERVICE) as? LauncherApps
|
||||||
|
?: return arr.toString()
|
||||||
|
val seen = HashSet<String>()
|
||||||
|
val items = ArrayList<Pair<String, String>>()
|
||||||
|
for (info in launcher.getActivityList(null, Process.myUserHandle())) {
|
||||||
|
val pkg = info.applicationInfo?.packageName ?: continue
|
||||||
|
if (!seen.add(pkg)) continue
|
||||||
|
val label = info.label?.toString().takeUnless { it.isNullOrBlank() } ?: pkg
|
||||||
|
items.add(pkg to label)
|
||||||
|
}
|
||||||
|
items.sortBy { it.second.lowercase() }
|
||||||
|
for ((pkg, label) in items) {
|
||||||
|
arr.put(JSONObject().put("package", pkg).put("label", label))
|
||||||
|
}
|
||||||
|
} catch (e: Exception) {
|
||||||
|
Log.w(TAG, "listLaunchableApps failed: ${e.message}")
|
||||||
|
}
|
||||||
|
return arr.toString()
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -26,9 +26,13 @@ class LedGrabApp : Application() {
|
|||||||
var initError: Throwable? = null
|
var initError: Throwable? = null
|
||||||
private set
|
private set
|
||||||
|
|
||||||
|
/** Lazily-initialized API-key manager (see [ApiKeyManager]). */
|
||||||
|
val apiKeyManager: ApiKeyManager by lazy { ApiKeyManager(this) }
|
||||||
|
|
||||||
override fun onCreate() {
|
override fun onCreate() {
|
||||||
super.onCreate()
|
super.onCreate()
|
||||||
installCrashLogger()
|
installCrashLogger()
|
||||||
|
pruneOldCrashLogs()
|
||||||
try {
|
try {
|
||||||
if (!Python.isStarted()) {
|
if (!Python.isStarted()) {
|
||||||
Python.start(AndroidPlatform(this))
|
Python.start(AndroidPlatform(this))
|
||||||
@@ -47,6 +51,22 @@ class LedGrabApp : Application() {
|
|||||||
// Bind application context for the BLE bridge so Python can
|
// Bind application context for the BLE bridge so Python can
|
||||||
// scan and connect to BLE LED controllers.
|
// scan and connect to BLE LED controllers.
|
||||||
BleBridge.init(this)
|
BleBridge.init(this)
|
||||||
|
// Bind application context for the camera bridge so Python can
|
||||||
|
// enumerate cameras and open them on demand (webcam capture).
|
||||||
|
CameraBridge.init(this)
|
||||||
|
// Bind application context for the foreground-app bridge so Python can
|
||||||
|
// detect the foreground app (Application automation rule) and list
|
||||||
|
// launchable apps for the editor's picker.
|
||||||
|
ForegroundAppBridge.init(this)
|
||||||
|
|
||||||
|
// Pre-warm the API key on a background thread. First-launch
|
||||||
|
// generation does a SharedPreferences.commit() (synchronous
|
||||||
|
// disk write — 10-50 ms on slow TV-box flash), which would
|
||||||
|
// hit the Main thread otherwise when MainActivity / CaptureService
|
||||||
|
// reads it. Doing it here makes subsequent reads memory-only.
|
||||||
|
Thread({
|
||||||
|
runCatching { apiKeyManager.apiKey }
|
||||||
|
}, "ledgrab-apikey-warmup").apply { isDaemon = true }.start()
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -77,7 +97,24 @@ class LedGrabApp : Application() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Keep only the most recent [MAX_CRASH_LOGS] crash files so a
|
||||||
|
* long-lived install doesn't slowly fill its private storage with
|
||||||
|
* historical traces. Cheap on every launch — listFiles is O(n)
|
||||||
|
* but n is tiny by construction.
|
||||||
|
*/
|
||||||
|
private fun pruneOldCrashLogs() {
|
||||||
|
val logs = filesDir.listFiles { f ->
|
||||||
|
f.isFile && f.name.startsWith("crash-") && f.name.endsWith(".log")
|
||||||
|
} ?: return
|
||||||
|
if (logs.size <= MAX_CRASH_LOGS) return
|
||||||
|
logs.sortedByDescending { it.lastModified() }
|
||||||
|
.drop(MAX_CRASH_LOGS)
|
||||||
|
.forEach { runCatching { it.delete() } }
|
||||||
|
}
|
||||||
|
|
||||||
companion object {
|
companion object {
|
||||||
private const val TAG = "LedGrabApp"
|
private const val TAG = "LedGrabApp"
|
||||||
|
private const val MAX_CRASH_LOGS = 10
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,97 @@
|
|||||||
|
package com.ledgrab.android
|
||||||
|
|
||||||
|
import android.app.Notification
|
||||||
|
import android.service.notification.NotificationListenerService
|
||||||
|
import android.service.notification.StatusBarNotification
|
||||||
|
import android.util.Log
|
||||||
|
import com.chaquo.python.Python
|
||||||
|
import java.util.concurrent.ConcurrentHashMap
|
||||||
|
import java.util.concurrent.Executors
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Captures posted OS notifications and forwards the posting app's display
|
||||||
|
* label to the Python notification pipeline, where the existing
|
||||||
|
* `NotificationColorStripSource` fires its one-shot LED effect.
|
||||||
|
*
|
||||||
|
* Direction is Kotlin -> Python via the process-global Chaquopy instance
|
||||||
|
* (NOT a per-[CaptureService] [PythonBridge]): `system_server` binds this
|
||||||
|
* service independently of [CaptureService], so it resolves Python itself.
|
||||||
|
* The Python receiver (`os_notification_listener.push_notification`) is a
|
||||||
|
* no-op whenever the server/listener isn't running, so a notification
|
||||||
|
* arriving before — or after — a capture session is safely ignored.
|
||||||
|
*/
|
||||||
|
class LedGrabNotificationListener : NotificationListenerService() {
|
||||||
|
|
||||||
|
// Serial executor: the Python receiver does a (non-concurrency-safe) history
|
||||||
|
// disk write and may play a sound, so pushes must not overlap. Off the main
|
||||||
|
// looper to keep the system service responsive.
|
||||||
|
private val pushExecutor = Executors.newSingleThreadExecutor()
|
||||||
|
|
||||||
|
// packageName -> resolved human-readable label. Matches the app_name the
|
||||||
|
// Windows/Linux backends pass, so per-app colors/filters keep working.
|
||||||
|
// Naturally bounded by the number of notification-posting apps (tens) and
|
||||||
|
// cleared with the process — no eviction needed.
|
||||||
|
private val labelCache = ConcurrentHashMap<String, String>()
|
||||||
|
|
||||||
|
override fun onNotificationPosted(sbn: StatusBarNotification?) {
|
||||||
|
val notification = sbn ?: return
|
||||||
|
|
||||||
|
// The Python server (and thus the listener) only exists during a capture
|
||||||
|
// session. isRunning is a coarse early-out — the authoritative gate is the
|
||||||
|
// Python receiver's None-check — but it avoids needless JNI churn here.
|
||||||
|
if (!CaptureService.isRunning) return
|
||||||
|
|
||||||
|
// Filter notifications that should never drive an effect:
|
||||||
|
// - ongoing (media transport, downloads): not user-facing "alerts"
|
||||||
|
// - group summaries: duplicate their child notifications
|
||||||
|
// - our own foreground-service notification: would self-trigger
|
||||||
|
if (notification.isOngoing) return
|
||||||
|
if ((notification.notification.flags and Notification.FLAG_GROUP_SUMMARY) != 0) return
|
||||||
|
if (notification.packageName == packageName) return
|
||||||
|
|
||||||
|
val label = resolveAppLabel(notification.packageName)
|
||||||
|
|
||||||
|
pushExecutor.execute {
|
||||||
|
try {
|
||||||
|
Python.getInstance()
|
||||||
|
.getModule(PY_MODULE)
|
||||||
|
.callAttr("push_notification", label)
|
||||||
|
} catch (t: Throwable) {
|
||||||
|
// Never crash a system-bound service. Python.getInstance() throws
|
||||||
|
// IllegalStateException if Python.start() hasn't run (e.g. the
|
||||||
|
// service was bound at boot before the app process initialized).
|
||||||
|
// Log at debug — the label is potentially sensitive on a shared TV.
|
||||||
|
Log.d(TAG, "push_notification failed: ${t.message}")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Resolve (and cache) a package's human-readable label; fall back to the package name. */
|
||||||
|
private fun resolveAppLabel(pkg: String): String {
|
||||||
|
labelCache[pkg]?.let { return it }
|
||||||
|
val resolved = runCatching {
|
||||||
|
val info = packageManager.getApplicationInfo(pkg, 0)
|
||||||
|
packageManager.getApplicationLabel(info).toString()
|
||||||
|
}.getOrDefault(pkg)
|
||||||
|
labelCache[pkg] = resolved
|
||||||
|
return resolved
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun onListenerConnected() {
|
||||||
|
Log.i(TAG, "Notification listener connected")
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun onListenerDisconnected() {
|
||||||
|
Log.i(TAG, "Notification listener disconnected")
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun onDestroy() {
|
||||||
|
pushExecutor.shutdown()
|
||||||
|
super.onDestroy()
|
||||||
|
}
|
||||||
|
|
||||||
|
companion object {
|
||||||
|
private const val TAG = "LedGrabNotifListener"
|
||||||
|
private const val PY_MODULE = "ledgrab.core.processing.os_notification_listener"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,7 +1,10 @@
|
|||||||
package com.ledgrab.android
|
package com.ledgrab.android
|
||||||
|
|
||||||
import android.Manifest
|
import android.Manifest
|
||||||
|
import android.animation.ObjectAnimator
|
||||||
|
import android.animation.ValueAnimator
|
||||||
import android.annotation.SuppressLint
|
import android.annotation.SuppressLint
|
||||||
|
import android.app.Activity
|
||||||
import android.content.Intent
|
import android.content.Intent
|
||||||
import android.content.pm.PackageManager
|
import android.content.pm.PackageManager
|
||||||
import android.graphics.Bitmap
|
import android.graphics.Bitmap
|
||||||
@@ -13,12 +16,17 @@ import android.os.PowerManager
|
|||||||
import android.provider.Settings
|
import android.provider.Settings
|
||||||
import android.util.Log
|
import android.util.Log
|
||||||
import android.view.View
|
import android.view.View
|
||||||
|
import android.view.ViewStub
|
||||||
|
import android.view.animation.AccelerateDecelerateInterpolator
|
||||||
import android.widget.Button
|
import android.widget.Button
|
||||||
import android.widget.CheckBox
|
import android.widget.CheckBox
|
||||||
import android.widget.ImageView
|
import android.widget.ImageView
|
||||||
|
import android.widget.LinearLayout
|
||||||
|
import android.widget.ScrollView
|
||||||
import android.widget.TextView
|
import android.widget.TextView
|
||||||
import android.app.Activity
|
import androidx.core.app.NotificationManagerCompat
|
||||||
import androidx.core.content.ContextCompat
|
import androidx.core.content.ContextCompat
|
||||||
|
import androidx.core.splashscreen.SplashScreen.Companion.installSplashScreen
|
||||||
import com.google.zxing.BarcodeFormat
|
import com.google.zxing.BarcodeFormat
|
||||||
import com.google.zxing.qrcode.QRCodeWriter
|
import com.google.zxing.qrcode.QRCodeWriter
|
||||||
import kotlinx.coroutines.CoroutineScope
|
import kotlinx.coroutines.CoroutineScope
|
||||||
@@ -46,25 +54,53 @@ class MainActivity : Activity() {
|
|||||||
private const val SERVER_PORT = 8080
|
private const val SERVER_PORT = 8080
|
||||||
private const val REQUEST_MEDIA_PROJECTION = 1001
|
private const val REQUEST_MEDIA_PROJECTION = 1001
|
||||||
private const val REQUEST_POST_NOTIFICATIONS = 1002
|
private const val REQUEST_POST_NOTIFICATIONS = 1002
|
||||||
|
private const val REQUEST_RECORD_AUDIO = 1003
|
||||||
|
private const val REQUEST_CAMERA = 1004
|
||||||
|
private const val QR_SIZE_PX = 560
|
||||||
|
private const val NOTIF_PREFS = "ledgrab_notif"
|
||||||
|
private const val KEY_NOTIF_ACCESS_PROMPTED = "notif_access_prompted"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Stopped-state views (always inflated).
|
||||||
private lateinit var stoppedPanel: View
|
private lateinit var stoppedPanel: View
|
||||||
private lateinit var runningPanel: View
|
|
||||||
private lateinit var statusText: TextView
|
private lateinit var statusText: TextView
|
||||||
private lateinit var urlText: TextView
|
|
||||||
private lateinit var qrImage: ImageView
|
|
||||||
private lateinit var toggleButton: Button
|
private lateinit var toggleButton: Button
|
||||||
private lateinit var stopButtonRunning: Button
|
|
||||||
private lateinit var versionText: TextView
|
private lateinit var versionText: TextView
|
||||||
private lateinit var autostartCheck: CheckBox
|
private lateinit var autostartCheck: CheckBox
|
||||||
private lateinit var autostartPrefs: AutostartPrefs
|
private lateinit var autostartPrefs: AutostartPrefs
|
||||||
|
private lateinit var grantNotificationButton: Button
|
||||||
|
private lateinit var grantUsageAccessButton: Button
|
||||||
|
|
||||||
|
// Running-state views (lazy-inflated via ViewStub).
|
||||||
|
private lateinit var runningPanelStub: ViewStub
|
||||||
|
private var runningPanel: View? = null
|
||||||
|
private var urlText: TextView? = null
|
||||||
|
private var qrImage: ImageView? = null
|
||||||
|
private var stopButtonRunning: Button? = null
|
||||||
|
private var statusDot: View? = null
|
||||||
|
private var statusDotAnimator: ObjectAnimator? = null
|
||||||
|
|
||||||
|
// Cache of the most recently rendered QR (and the URL it encodes).
|
||||||
|
// updateUI() runs on every onResume (HDMI-CEC wakes, app switches,
|
||||||
|
// overlay dismissal, etc.). Rebuilding the 560×560 bitmap each time
|
||||||
|
// is wasteful — usually the IP and key are unchanged. Cache and
|
||||||
|
// short-circuit when the URL matches.
|
||||||
|
private var cachedQrUrl: String? = null
|
||||||
|
private var cachedQrBitmap: Bitmap? = null
|
||||||
|
|
||||||
override fun onCreate(savedInstanceState: Bundle?) {
|
override fun onCreate(savedInstanceState: Bundle?) {
|
||||||
|
// Install the splash screen BEFORE super.onCreate so the system
|
||||||
|
// keeps it on screen until our first frame is ready. This hides
|
||||||
|
// the Chaquopy stdlib unpack delay on cold first launch.
|
||||||
|
val splashScreen = installSplashScreen()
|
||||||
super.onCreate(savedInstanceState)
|
super.onCreate(savedInstanceState)
|
||||||
|
|
||||||
// Surface fatal Python init errors instead of crashing.
|
// Surface fatal Python init errors instead of crashing.
|
||||||
val initError = (application as? LedGrabApp)?.initError
|
val initError = (application as? LedGrabApp)?.initError
|
||||||
if (initError != null) {
|
if (initError != null) {
|
||||||
|
// Tell the splash screen to dismiss immediately — we're
|
||||||
|
// about to render an error screen, not the main UI.
|
||||||
|
splashScreen.setKeepOnScreenCondition { false }
|
||||||
showFatalErrorScreen(initError)
|
showFatalErrorScreen(initError)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -72,39 +108,71 @@ class MainActivity : Activity() {
|
|||||||
setContentView(R.layout.activity_main)
|
setContentView(R.layout.activity_main)
|
||||||
|
|
||||||
stoppedPanel = findViewById(R.id.stopped_panel)
|
stoppedPanel = findViewById(R.id.stopped_panel)
|
||||||
runningPanel = findViewById(R.id.running_panel)
|
runningPanelStub = findViewById(R.id.running_panel_stub)
|
||||||
statusText = findViewById(R.id.status_text)
|
statusText = findViewById(R.id.status_text)
|
||||||
urlText = findViewById(R.id.url_text)
|
|
||||||
qrImage = findViewById(R.id.qr_image)
|
|
||||||
toggleButton = findViewById(R.id.toggle_button)
|
toggleButton = findViewById(R.id.toggle_button)
|
||||||
stopButtonRunning = findViewById(R.id.stop_button_running)
|
|
||||||
versionText = findViewById(R.id.version_text)
|
versionText = findViewById(R.id.version_text)
|
||||||
autostartCheck = findViewById(R.id.autostart_check)
|
autostartCheck = findViewById(R.id.autostart_check)
|
||||||
|
grantNotificationButton = findViewById(R.id.grant_notification_button)
|
||||||
|
grantUsageAccessButton = findViewById(R.id.grant_usage_access_button)
|
||||||
|
|
||||||
val versionName = packageManager
|
val versionName = packageManager.getPackageInfo(packageName, 0).versionName
|
||||||
.getPackageInfo(packageName, 0).versionName
|
|
||||||
versionText.text = getString(R.string.version_prefix, versionName ?: "?")
|
versionText.text = getString(R.string.version_prefix, versionName ?: "?")
|
||||||
|
|
||||||
autostartPrefs = AutostartPrefs(this)
|
autostartPrefs = AutostartPrefs(this)
|
||||||
autostartCheck.isChecked = autostartPrefs.isEnabled
|
// Autostart only takes effect on rooted devices. Hide the
|
||||||
// Autostart only takes effect on rooted devices — grey it out
|
// checkbox entirely on unrooted hardware instead of showing a
|
||||||
// on unrooted hardware so users don't expect magic. Cheap probe
|
// disabled-but-visible control, which reads as broken UI from
|
||||||
// (file-existence only, no process spawn).
|
// across the room.
|
||||||
if (!Root.looksRooted()) {
|
if (Root.looksRooted()) {
|
||||||
autostartCheck.isEnabled = false
|
autostartCheck.visibility = View.VISIBLE
|
||||||
autostartCheck.text = getString(R.string.autostart_unavailable)
|
autostartCheck.isChecked = autostartPrefs.isEnabled
|
||||||
}
|
autostartCheck.setOnCheckedChangeListener { _, isChecked ->
|
||||||
autostartCheck.setOnCheckedChangeListener { _, isChecked ->
|
autostartPrefs.isEnabled = isChecked
|
||||||
autostartPrefs.isEnabled = isChecked
|
if (isChecked) ensureIgnoringBatteryOptimizations()
|
||||||
if (isChecked) ensureIgnoringBatteryOptimizations()
|
}
|
||||||
|
} else {
|
||||||
|
autostartCheck.visibility = View.GONE
|
||||||
}
|
}
|
||||||
|
|
||||||
|
grantNotificationButton.setOnClickListener { openNotificationListenerSettings() }
|
||||||
|
grantUsageAccessButton.setOnClickListener { openUsageAccessSettings() }
|
||||||
toggleButton.setOnClickListener { startCapture() }
|
toggleButton.setOnClickListener { startCapture() }
|
||||||
stopButtonRunning.setOnClickListener { stopCaptureService() }
|
|
||||||
|
|
||||||
|
updateStoppedPermissionButtons()
|
||||||
updateUI()
|
updateUI()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
override fun onDestroy() {
|
||||||
|
stopStatusDotPulse()
|
||||||
|
uiScope.cancel()
|
||||||
|
super.onDestroy()
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun onStop() {
|
||||||
|
// ObjectAnimator retains a hard reference to the dot View. On
|
||||||
|
// backgrounded TV apps onDestroy may never fire, so cancel here
|
||||||
|
// to avoid leaking the entire view hierarchy through an
|
||||||
|
// INFINITE-repeat animator.
|
||||||
|
stopStatusDotPulse()
|
||||||
|
super.onStop()
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun onResume() {
|
||||||
|
super.onResume()
|
||||||
|
if (!::stoppedPanel.isInitialized) return
|
||||||
|
// Restart the pulse if we returned to the foreground while the
|
||||||
|
// service is still running. The running panel's view may have been
|
||||||
|
// recreated; ensureRunningPanelInflated already keys off the field
|
||||||
|
// reference. When stopped, refresh the notification-access button —
|
||||||
|
// the user may have just granted/revoked access in Settings.
|
||||||
|
if (CaptureService.isRunning) {
|
||||||
|
updateUI()
|
||||||
|
} else {
|
||||||
|
updateStoppedPermissionButtons()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Decide whether to go through the MediaProjection consent flow or
|
* Decide whether to go through the MediaProjection consent flow or
|
||||||
* jump straight into root capture. Root check is fast but may block
|
* jump straight into root capture. Root check is fast but may block
|
||||||
@@ -112,20 +180,19 @@ class MainActivity : Activity() {
|
|||||||
* on the UI thread is acceptable because we're responding to a
|
* on the UI thread is acceptable because we're responding to a
|
||||||
* button press and we want to block until the user answers.
|
* button press and we want to block until the user answers.
|
||||||
*/
|
*/
|
||||||
override fun onDestroy() {
|
|
||||||
uiScope.cancel()
|
|
||||||
super.onDestroy()
|
|
||||||
}
|
|
||||||
|
|
||||||
private fun startCapture() {
|
private fun startCapture() {
|
||||||
// `su -c id` can block for seconds while Magisk shows its grant
|
// `su -c id` can block for seconds while Magisk shows its grant
|
||||||
// dialog; running it on the Main thread caused ANRs.
|
// dialog; running it on the Main thread caused ANRs. Render an
|
||||||
|
// explicit "starting" state so the button doesn't look frozen.
|
||||||
|
val originalText = toggleButton.text
|
||||||
toggleButton.isEnabled = false
|
toggleButton.isEnabled = false
|
||||||
statusText.text = "Checking root access…"
|
toggleButton.text = getString(R.string.btn_starting)
|
||||||
|
statusText.text = getString(R.string.status_checking_root)
|
||||||
uiScope.launch(Dispatchers.IO) {
|
uiScope.launch(Dispatchers.IO) {
|
||||||
val rooted = Root.requestGrant()
|
val rooted = Root.requestGrant()
|
||||||
withContext(Dispatchers.Main) {
|
withContext(Dispatchers.Main) {
|
||||||
toggleButton.isEnabled = true
|
toggleButton.isEnabled = true
|
||||||
|
toggleButton.text = originalText
|
||||||
statusText.text = ""
|
statusText.text = ""
|
||||||
if (rooted) {
|
if (rooted) {
|
||||||
Log.i(TAG, "Root available — skipping MediaProjection consent")
|
Log.i(TAG, "Root available — skipping MediaProjection consent")
|
||||||
@@ -145,6 +212,8 @@ class MainActivity : Activity() {
|
|||||||
|
|
||||||
private fun startRootCaptureService() {
|
private fun startRootCaptureService() {
|
||||||
ensureNotificationPermission()
|
ensureNotificationPermission()
|
||||||
|
ensureNotificationListenerAccess()
|
||||||
|
ensureCameraPermission()
|
||||||
ContextCompat.startForegroundService(this, CaptureService.createRootIntent(this))
|
ContextCompat.startForegroundService(this, CaptureService.createRootIntent(this))
|
||||||
updateUI()
|
updateUI()
|
||||||
}
|
}
|
||||||
@@ -156,7 +225,7 @@ class MainActivity : Activity() {
|
|||||||
if (resultCode == RESULT_OK && data != null) {
|
if (resultCode == RESULT_OK && data != null) {
|
||||||
startCaptureService(resultCode, data)
|
startCaptureService(resultCode, data)
|
||||||
} else {
|
} else {
|
||||||
statusText.text = "Permission denied — screen capture requires authorization"
|
statusText.text = getString(R.string.status_permission_denied)
|
||||||
Log.w(TAG, "MediaProjection permission denied")
|
Log.w(TAG, "MediaProjection permission denied")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -164,6 +233,9 @@ class MainActivity : Activity() {
|
|||||||
|
|
||||||
private fun startCaptureService(resultCode: Int, resultData: Intent) {
|
private fun startCaptureService(resultCode: Int, resultData: Intent) {
|
||||||
ensureNotificationPermission()
|
ensureNotificationPermission()
|
||||||
|
ensureNotificationListenerAccess()
|
||||||
|
ensureAudioPermission()
|
||||||
|
ensureCameraPermission()
|
||||||
val intent = CaptureService.createIntent(this, resultCode, resultData)
|
val intent = CaptureService.createIntent(this, resultCode, resultData)
|
||||||
ContextCompat.startForegroundService(this, intent)
|
ContextCompat.startForegroundService(this, intent)
|
||||||
updateUI()
|
updateUI()
|
||||||
@@ -174,42 +246,130 @@ class MainActivity : Activity() {
|
|||||||
updateUI()
|
updateUI()
|
||||||
}
|
}
|
||||||
|
|
||||||
private fun updateUI() {
|
private fun ensureRunningPanelInflated(): View {
|
||||||
if (CaptureService.isRunning) {
|
runningPanel?.let { return it }
|
||||||
val localIp = NetworkUtils.getLocalIpAddress(this) ?: "unknown"
|
val view = runningPanelStub.inflate()
|
||||||
val url = "http://$localIp:$SERVER_PORT"
|
urlText = view.findViewById(R.id.url_text)
|
||||||
|
qrImage = view.findViewById(R.id.qr_image)
|
||||||
|
stopButtonRunning = view.findViewById(R.id.stop_button_running)
|
||||||
|
statusDot = view.findViewById(R.id.status_dot)
|
||||||
|
stopButtonRunning?.setOnClickListener { stopCaptureService() }
|
||||||
|
runningPanel = view
|
||||||
|
return view
|
||||||
|
}
|
||||||
|
|
||||||
urlText.text = url
|
private fun updateUI() {
|
||||||
qrImage.setImageBitmap(null)
|
// Fatal-init-error path took over setContentView and the
|
||||||
// Build the bitmap pixels off the Main thread — encode + 313k
|
// lateinit view fields are unassigned. Guard so any future
|
||||||
// setPixel calls were noticeably janky on slow TV boxes.
|
// caller (Resume, broadcast receiver, etc.) doesn't NPE.
|
||||||
uiScope.launch(Dispatchers.Default) {
|
if (!::stoppedPanel.isInitialized) return
|
||||||
val bitmap = generateQrCode(url)
|
if (CaptureService.isRunning) {
|
||||||
withContext(Dispatchers.Main) {
|
val running = ensureRunningPanelInflated()
|
||||||
if (CaptureService.isRunning && urlText.text == url) {
|
val localIp = NetworkUtils.getLocalIpAddress(this)
|
||||||
qrImage.setImageBitmap(bitmap)
|
if (localIp == null) {
|
||||||
|
// No network — show the no-network state inside the
|
||||||
|
// stopped panel and keep capture stopped. The service
|
||||||
|
// is alive (capture works on loopback) but the URL/QR
|
||||||
|
// are useless without a routable address.
|
||||||
|
statusText.text = getString(R.string.status_no_network)
|
||||||
|
stoppedPanel.visibility = View.VISIBLE
|
||||||
|
versionText.visibility = View.VISIBLE
|
||||||
|
running.visibility = View.GONE
|
||||||
|
toggleButton.requestFocus()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
val displayUrl = "http://$localIp:$SERVER_PORT"
|
||||||
|
val qrUrl = qrUrlFor(displayUrl)
|
||||||
|
|
||||||
|
urlText?.text = displayUrl
|
||||||
|
val cachedForUrl = cachedQrBitmap?.takeIf { cachedQrUrl == qrUrl }
|
||||||
|
if (cachedForUrl != null) {
|
||||||
|
qrImage?.setImageBitmap(cachedForUrl)
|
||||||
|
} else {
|
||||||
|
qrImage?.setImageBitmap(null)
|
||||||
|
// Build the bitmap pixels off the Main thread — encode + 313k
|
||||||
|
// setPixel calls were noticeably janky on slow TV boxes.
|
||||||
|
uiScope.launch(Dispatchers.Default) {
|
||||||
|
val bitmap = generateQrCode(qrUrl)
|
||||||
|
withContext(Dispatchers.Main) {
|
||||||
|
if (CaptureService.isRunning && urlText?.text == displayUrl) {
|
||||||
|
cachedQrUrl = qrUrl
|
||||||
|
cachedQrBitmap = bitmap
|
||||||
|
qrImage?.setImageBitmap(bitmap)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
stoppedPanel.visibility = View.GONE
|
stoppedPanel.visibility = View.GONE
|
||||||
versionText.visibility = View.GONE
|
versionText.visibility = View.GONE
|
||||||
runningPanel.visibility = View.VISIBLE
|
running.visibility = View.VISIBLE
|
||||||
stopButtonRunning.requestFocus()
|
stopButtonRunning?.requestFocus()
|
||||||
|
startStatusDotPulse()
|
||||||
} else {
|
} else {
|
||||||
urlText.text = ""
|
stopStatusDotPulse()
|
||||||
qrImage.setImageBitmap(null)
|
urlText?.text = ""
|
||||||
|
qrImage?.setImageBitmap(null)
|
||||||
|
// Drop the cached bitmap so a Start → IP change → Start
|
||||||
|
// sequence rebuilds the QR for the new address.
|
||||||
|
cachedQrUrl = null
|
||||||
|
cachedQrBitmap = null
|
||||||
|
|
||||||
runningPanel.visibility = View.GONE
|
runningPanel?.visibility = View.GONE
|
||||||
stoppedPanel.visibility = View.VISIBLE
|
stoppedPanel.visibility = View.VISIBLE
|
||||||
versionText.visibility = View.VISIBLE
|
versionText.visibility = View.VISIBLE
|
||||||
toggleButton.requestFocus()
|
toggleButton.requestFocus()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Build the URL we encode into the QR. Embeds the API key as a
|
||||||
|
* URL fragment (``#k=<token>``) so:
|
||||||
|
* - The token never appears in HTTP requests (fragments aren't
|
||||||
|
* sent over the wire) — no access-log leak.
|
||||||
|
* - The frontend can read [location.hash] on first visit and
|
||||||
|
* persist the key to localStorage (see static/js/app.ts).
|
||||||
|
* - The visible URL chip stays short and human-readable.
|
||||||
|
*
|
||||||
|
* The chip text in [updateUI] intentionally uses the *base* URL
|
||||||
|
* (without the fragment) so a human reading the URL out loud
|
||||||
|
* doesn't have to dictate 64 hex chars; only the QR carries the
|
||||||
|
* key. Do not collapse these into a single string — that would
|
||||||
|
* leak the key onto the screen.
|
||||||
|
*/
|
||||||
|
private fun qrUrlFor(base: String): String {
|
||||||
|
val key = (application as? LedGrabApp)?.apiKeyManager?.apiKey
|
||||||
|
return if (key.isNullOrBlank()) base else "$base/#k=$key"
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun startStatusDotPulse() {
|
||||||
|
val dot = statusDot ?: return
|
||||||
|
if (statusDotAnimator?.isStarted == true) return
|
||||||
|
val animator = ObjectAnimator.ofFloat(dot, "alpha", 1f, 0.35f).apply {
|
||||||
|
duration = 900
|
||||||
|
repeatCount = ValueAnimator.INFINITE
|
||||||
|
repeatMode = ValueAnimator.REVERSE
|
||||||
|
interpolator = AccelerateDecelerateInterpolator()
|
||||||
|
}
|
||||||
|
animator.start()
|
||||||
|
statusDotAnimator = animator
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun stopStatusDotPulse() {
|
||||||
|
statusDotAnimator?.cancel()
|
||||||
|
statusDotAnimator = null
|
||||||
|
statusDot?.alpha = 1f
|
||||||
|
}
|
||||||
|
|
||||||
private fun generateQrCode(text: String): Bitmap {
|
private fun generateQrCode(text: String): Bitmap {
|
||||||
val size = 560
|
val size = QR_SIZE_PX
|
||||||
val bitMatrix = QRCodeWriter().encode(text, BarcodeFormat.QR_CODE, size, size)
|
val bitMatrix = QRCodeWriter().encode(text, BarcodeFormat.QR_CODE, size, size)
|
||||||
|
// ALPHA_8 = 1 byte/px instead of 2 (RGB_565) or 4 (ARGB_8888).
|
||||||
|
// The ImageView gets tinted white via the matrix — for a pure
|
||||||
|
// black-and-white QR that's all we need and it halves heap usage
|
||||||
|
// compared to the previous RGB_565 path.
|
||||||
|
val bitmap = Bitmap.createBitmap(size, size, Bitmap.Config.ARGB_8888)
|
||||||
val pixels = IntArray(size * size)
|
val pixels = IntArray(size * size)
|
||||||
for (y in 0 until size) {
|
for (y in 0 until size) {
|
||||||
val rowOffset = y * size
|
val rowOffset = y * size
|
||||||
@@ -218,34 +378,54 @@ class MainActivity : Activity() {
|
|||||||
if (bitMatrix[x, y]) 0xFF000000.toInt() else 0xFFFFFFFF.toInt()
|
if (bitMatrix[x, y]) 0xFF000000.toInt() else 0xFFFFFFFF.toInt()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
val bitmap = Bitmap.createBitmap(size, size, Bitmap.Config.RGB_565)
|
|
||||||
bitmap.setPixels(pixels, 0, size, 0, 0, size, size)
|
bitmap.setPixels(pixels, 0, size, 0, 0, size, size)
|
||||||
return bitmap
|
return bitmap
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Minimal failure UI shown when Python.start() (Chaquopy) blew up.
|
* Minimal failure UI shown when Python.start() (Chaquopy) blew up.
|
||||||
* Rendered programmatically so we don't depend on the regular layout
|
* Stack trace is hidden behind a "Show details" toggle so we don't
|
||||||
* (which itself may reference resources affected by the failure).
|
* print user-path data on shared TV screens by default.
|
||||||
*/
|
*/
|
||||||
private fun showFatalErrorScreen(error: Throwable) {
|
private fun showFatalErrorScreen(error: Throwable) {
|
||||||
Log.e(TAG, "Fatal init error — showing error screen", error)
|
Log.e(TAG, "Fatal init error — showing error screen", error)
|
||||||
val stackText = android.util.Log.getStackTraceString(error)
|
val stackText = Log.getStackTraceString(error)
|
||||||
val container = android.widget.LinearLayout(this).apply {
|
val container = LinearLayout(this).apply {
|
||||||
orientation = android.widget.LinearLayout.VERTICAL
|
orientation = LinearLayout.VERTICAL
|
||||||
setPadding(48, 48, 48, 48)
|
setPadding(48, 48, 48, 48)
|
||||||
}
|
}
|
||||||
val title = TextView(this).apply {
|
val title = TextView(this).apply {
|
||||||
text = "LedGrab failed to start"
|
text = getString(R.string.fatal_title)
|
||||||
textSize = 22f
|
textSize = 22f
|
||||||
}
|
}
|
||||||
|
val description = TextView(this).apply {
|
||||||
|
text = getString(R.string.fatal_body_prefix)
|
||||||
|
textSize = 14f
|
||||||
|
setPadding(0, 24, 0, 12)
|
||||||
|
}
|
||||||
val body = TextView(this).apply {
|
val body = TextView(this).apply {
|
||||||
text = "Python runtime initialization failed:\n\n$stackText"
|
text = stackText
|
||||||
textSize = 12f
|
textSize = 12f
|
||||||
setTextIsSelectable(true)
|
setTextIsSelectable(true)
|
||||||
|
visibility = View.GONE
|
||||||
|
}
|
||||||
|
val scroll = ScrollView(this).apply {
|
||||||
|
addView(body)
|
||||||
|
visibility = View.GONE
|
||||||
|
}
|
||||||
|
val toggleBtn = Button(this).apply {
|
||||||
|
text = getString(R.string.fatal_show_details)
|
||||||
|
setOnClickListener {
|
||||||
|
val showing = scroll.visibility == View.VISIBLE
|
||||||
|
scroll.visibility = if (showing) View.GONE else View.VISIBLE
|
||||||
|
body.visibility = scroll.visibility
|
||||||
|
text = getString(
|
||||||
|
if (showing) R.string.fatal_show_details else R.string.fatal_hide_details,
|
||||||
|
)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
val copyBtn = Button(this).apply {
|
val copyBtn = Button(this).apply {
|
||||||
text = "Copy log"
|
text = getString(R.string.fatal_copy_log)
|
||||||
setOnClickListener {
|
setOnClickListener {
|
||||||
val cm = getSystemService(CLIPBOARD_SERVICE)
|
val cm = getSystemService(CLIPBOARD_SERVICE)
|
||||||
as android.content.ClipboardManager
|
as android.content.ClipboardManager
|
||||||
@@ -254,19 +434,20 @@ class MainActivity : Activity() {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
val scroll = android.widget.ScrollView(this).apply { addView(body) }
|
|
||||||
container.addView(title)
|
container.addView(title)
|
||||||
|
container.addView(description)
|
||||||
|
container.addView(toggleBtn)
|
||||||
container.addView(copyBtn)
|
container.addView(copyBtn)
|
||||||
container.addView(scroll)
|
container.addView(scroll)
|
||||||
setContentView(container)
|
setContentView(container)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Prompt the user to exempt LedGrab from battery optimization. On
|
* Prompt the user to exempt LedGrab from battery optimization.
|
||||||
* TV boxes this is usually a no-op, but on phones Doze/App Standby
|
* Strictly a phone-side concern (Doze/App Standby kill the FG
|
||||||
* will kill the foreground service after a few hours of sleep. We
|
* service after hours of sleep); essentially a no-op on TV boxes.
|
||||||
* only ask when autostart is turned on. No-op on pre-M or when
|
* Only asked when autostart is turned on, which is itself only
|
||||||
* already exempt.
|
* available on rooted devices.
|
||||||
*
|
*
|
||||||
* Play Store flags REQUEST_IGNORE_BATTERY_OPTIMIZATIONS by default
|
* Play Store flags REQUEST_IGNORE_BATTERY_OPTIMIZATIONS by default
|
||||||
* — LedGrab's ambient-capture use case falls under the documented
|
* — LedGrab's ambient-capture use case falls under the documented
|
||||||
@@ -311,4 +492,128 @@ class MainActivity : Activity() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Request RECORD_AUDIO (API 29+) so the capture service can capture
|
||||||
|
* system playback audio for audio-reactive lighting. Fire-and-forget,
|
||||||
|
* like [ensureNotificationPermission]: capture still works without it
|
||||||
|
* (just no audio), so we don't block on the result. If first granted
|
||||||
|
* here, audio becomes available on the next Start.
|
||||||
|
*/
|
||||||
|
private fun ensureAudioPermission() {
|
||||||
|
if (Build.VERSION.SDK_INT < Build.VERSION_CODES.Q) return
|
||||||
|
if (checkSelfPermission(Manifest.permission.RECORD_AUDIO)
|
||||||
|
!= PackageManager.PERMISSION_GRANTED
|
||||||
|
) {
|
||||||
|
@Suppress("DEPRECATION")
|
||||||
|
requestPermissions(
|
||||||
|
arrayOf(Manifest.permission.RECORD_AUDIO),
|
||||||
|
REQUEST_RECORD_AUDIO,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Request CAMERA so the capture service can open the device camera for
|
||||||
|
* on-device webcam capture. Fire-and-forget, like [ensureAudioPermission]:
|
||||||
|
* capture still works without it (just no camera engine), so we don't block
|
||||||
|
* on the result. Gated on actual camera hardware via FEATURE_CAMERA_ANY so
|
||||||
|
* camera-less TV boxes (the common case) never see the prompt. The camera
|
||||||
|
* is opened on demand only while a camera source is active — granting this
|
||||||
|
* does not keep the camera on. If first granted here, the camera engine
|
||||||
|
* becomes available on the next Start.
|
||||||
|
*/
|
||||||
|
private fun ensureCameraPermission() {
|
||||||
|
if (!packageManager.hasSystemFeature(PackageManager.FEATURE_CAMERA_ANY)) return
|
||||||
|
if (checkSelfPermission(Manifest.permission.CAMERA)
|
||||||
|
!= PackageManager.PERMISSION_GRANTED
|
||||||
|
) {
|
||||||
|
@Suppress("DEPRECATION")
|
||||||
|
requestPermissions(
|
||||||
|
arrayOf(Manifest.permission.CAMERA),
|
||||||
|
REQUEST_CAMERA,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Whether the user has granted notification-listener access to this app. */
|
||||||
|
private fun isNotificationAccessGranted(): Boolean =
|
||||||
|
NotificationManagerCompat.getEnabledListenerPackages(this).contains(packageName)
|
||||||
|
|
||||||
|
/** Open the system Notification-access screen (manual affordance / re-grant). */
|
||||||
|
private fun openNotificationListenerSettings() {
|
||||||
|
runCatching {
|
||||||
|
startActivity(Intent(Settings.ACTION_NOTIFICATION_LISTENER_SETTINGS))
|
||||||
|
}.onFailure { Log.w(TAG, "Notification-access settings unavailable: ${it.message}") }
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether Usage Access (PACKAGE_USAGE_STATS) is granted — needed by the
|
||||||
|
* foreground-app automation rule. Delegates to the bridge's AppOps check.
|
||||||
|
*/
|
||||||
|
private fun isUsageAccessGranted(): Boolean = ForegroundAppBridge.hasUsageAccess()
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Open the system Usage-Access screen so the user can grant LedGrab access
|
||||||
|
* for the foreground-app automation rule. Falls back to the generic Settings
|
||||||
|
* screen on TV-box OEM builds that strip the dedicated intent.
|
||||||
|
*/
|
||||||
|
private fun openUsageAccessSettings() {
|
||||||
|
runCatching {
|
||||||
|
startActivity(Intent(Settings.ACTION_USAGE_ACCESS_SETTINGS))
|
||||||
|
}.onFailure {
|
||||||
|
Log.w(TAG, "Usage-access settings unavailable: ${it.message}")
|
||||||
|
runCatching { startActivity(Intent(Settings.ACTION_SETTINGS)) }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Prompt-once-then-remember: the first time capture starts without
|
||||||
|
* notification-listener access, open the settings screen so the user can
|
||||||
|
* grant it — then never nag again (the manual "Grant notification access"
|
||||||
|
* button stays available). Fire-and-forget like [ensureNotificationPermission].
|
||||||
|
*/
|
||||||
|
private fun ensureNotificationListenerAccess() {
|
||||||
|
if (isNotificationAccessGranted()) return
|
||||||
|
val prefs = getSharedPreferences(NOTIF_PREFS, MODE_PRIVATE)
|
||||||
|
if (prefs.getBoolean(KEY_NOTIF_ACCESS_PROMPTED, false)) return
|
||||||
|
prefs.edit().putBoolean(KEY_NOTIF_ACCESS_PROMPTED, true).apply()
|
||||||
|
openNotificationListenerSettings()
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Show each "Grant <permission> access" button only while that access is
|
||||||
|
* missing, then re-wire the D-pad focus chain. Called on create and on resume
|
||||||
|
* (access can change in Settings while we're backgrounded). The usage-access
|
||||||
|
* button is a passive affordance (no auto-prompt at capture start) — the
|
||||||
|
* primary guidance is the web-UI banner when an Android app rule needs it.
|
||||||
|
*/
|
||||||
|
private fun updateStoppedPermissionButtons() {
|
||||||
|
if (!::grantNotificationButton.isInitialized) return
|
||||||
|
grantNotificationButton.visibility =
|
||||||
|
if (isNotificationAccessGranted()) View.GONE else View.VISIBLE
|
||||||
|
grantUsageAccessButton.visibility =
|
||||||
|
if (isUsageAccessGranted()) View.GONE else View.VISIBLE
|
||||||
|
wireStoppedFocusChain()
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Link the visible stopped-panel controls into a single up/down D-pad chain.
|
||||||
|
* The optional controls (the grant-access buttons and the root-only autostart
|
||||||
|
* checkbox) may be GONE, so the chain is computed from whatever is visible —
|
||||||
|
* a static nextFocus pointing at a GONE view would strand the focus on a TV
|
||||||
|
* remote.
|
||||||
|
*/
|
||||||
|
private fun wireStoppedFocusChain() {
|
||||||
|
val chain = listOfNotNull(
|
||||||
|
toggleButton,
|
||||||
|
grantNotificationButton.takeIf { it.visibility == View.VISIBLE },
|
||||||
|
grantUsageAccessButton.takeIf { it.visibility == View.VISIBLE },
|
||||||
|
autostartCheck.takeIf { it.visibility == View.VISIBLE },
|
||||||
|
)
|
||||||
|
chain.forEachIndexed { i, view ->
|
||||||
|
view.nextFocusUpId = (chain.getOrNull(i - 1) ?: view).id
|
||||||
|
view.nextFocusDownId = (chain.getOrNull(i + 1) ?: view).id
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,6 +3,8 @@ package com.ledgrab.android
|
|||||||
import android.content.Context
|
import android.content.Context
|
||||||
import android.net.ConnectivityManager
|
import android.net.ConnectivityManager
|
||||||
import android.net.LinkProperties
|
import android.net.LinkProperties
|
||||||
|
import android.net.Network
|
||||||
|
import android.net.NetworkCapabilities
|
||||||
import java.net.Inet4Address
|
import java.net.Inet4Address
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -11,18 +13,58 @@ import java.net.Inet4Address
|
|||||||
object NetworkUtils {
|
object NetworkUtils {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return the device's local IPv4 address on the active network,
|
* Return the device's local IPv4 address, preferring (in order):
|
||||||
* or `null` if unavailable.
|
* - Ethernet (wired TV-box link)
|
||||||
|
* - Wi-Fi
|
||||||
|
* - any other transport
|
||||||
|
* - whatever the active network reports
|
||||||
|
*
|
||||||
|
* Returns ``null`` only when no IPv4 link addresses exist at all.
|
||||||
|
*
|
||||||
|
* Why not just ``activeNetwork``: on TV boxes with both Ethernet
|
||||||
|
* AND Wi-Fi connected, Android's active-network heuristic can
|
||||||
|
* pick Wi-Fi while the user's phone is on the Ethernet subnet —
|
||||||
|
* leading to a URL/QR that the phone can't reach.
|
||||||
*/
|
*/
|
||||||
fun getLocalIpAddress(context: Context): String? {
|
fun getLocalIpAddress(context: Context): String? {
|
||||||
val cm = context.getSystemService(Context.CONNECTIVITY_SERVICE) as ConnectivityManager
|
val cm = context.getSystemService(Context.CONNECTIVITY_SERVICE) as ConnectivityManager
|
||||||
val network = cm.activeNetwork ?: return null
|
// TODO(AP-mode): On TV boxes acting as a Wi-Fi tether/hotspot,
|
||||||
val props: LinkProperties = cm.getLinkProperties(network) ?: return null
|
// TRANSPORT_WIFI here will resolve to the AP-side interface
|
||||||
|
// (typically 192.168.43.x) which clients on the user's actual
|
||||||
|
// home LAN can't reach. Detecting AP mode requires the @SystemApi
|
||||||
|
// WifiManager.getWifiApState reflection trick — defer until a
|
||||||
|
// user reports needing it.
|
||||||
|
val networks = cm.allNetworks
|
||||||
|
if (networks.isEmpty()) return ipv4Of(cm, cm.activeNetwork ?: return null)
|
||||||
|
|
||||||
|
val ranked = networks
|
||||||
|
.mapNotNull { n ->
|
||||||
|
val caps = cm.getNetworkCapabilities(n) ?: return@mapNotNull null
|
||||||
|
val rank = when {
|
||||||
|
caps.hasTransport(NetworkCapabilities.TRANSPORT_ETHERNET) -> 0
|
||||||
|
caps.hasTransport(NetworkCapabilities.TRANSPORT_WIFI) -> 1
|
||||||
|
caps.hasTransport(NetworkCapabilities.TRANSPORT_VPN) -> 3
|
||||||
|
caps.hasTransport(NetworkCapabilities.TRANSPORT_CELLULAR) -> 4
|
||||||
|
else -> 2
|
||||||
|
}
|
||||||
|
Triple(rank, n, caps)
|
||||||
|
}
|
||||||
|
.sortedBy { it.first }
|
||||||
|
|
||||||
|
for ((_, network, _) in ranked) {
|
||||||
|
val ip = ipv4Of(cm, network)
|
||||||
|
if (ip != null) return ip
|
||||||
|
}
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun ipv4Of(cm: ConnectivityManager, network: Network): String? {
|
||||||
|
val props: LinkProperties = cm.getLinkProperties(network) ?: return null
|
||||||
return props.linkAddresses
|
return props.linkAddresses
|
||||||
|
.asSequence()
|
||||||
.map { it.address }
|
.map { it.address }
|
||||||
.filterIsInstance<Inet4Address>()
|
.filterIsInstance<Inet4Address>()
|
||||||
.firstOrNull { !it.isLoopbackAddress }
|
.firstOrNull { !it.isLoopbackAddress && !it.isLinkLocalAddress }
|
||||||
?.hostAddress
|
?.hostAddress
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -9,7 +9,8 @@ import com.chaquo.python.Python
|
|||||||
* Bridge between Kotlin and the LedGrab Python server.
|
* Bridge between Kotlin and the LedGrab Python server.
|
||||||
*
|
*
|
||||||
* All Python calls go through Chaquopy's `Python.getInstance()`.
|
* All Python calls go through Chaquopy's `Python.getInstance()`.
|
||||||
* Frame data crosses the JNI boundary as a `ByteArray`.
|
* Frame data crosses the JNI boundary as a `ByteArray` (reused across
|
||||||
|
* frames — see ScreenCapture / RootScreenrecord for buffer pools).
|
||||||
*/
|
*/
|
||||||
class PythonBridge(private val context: Context) {
|
class PythonBridge(private val context: Context) {
|
||||||
|
|
||||||
@@ -27,6 +28,7 @@ class PythonBridge(private val context: Context) {
|
|||||||
// single-writer/single-reader pattern we have here.
|
// single-writer/single-reader pattern we have here.
|
||||||
@Volatile private var mediaProjectionEngine: PyObject? = null
|
@Volatile private var mediaProjectionEngine: PyObject? = null
|
||||||
@Volatile private var rootEngine: PyObject? = null
|
@Volatile private var rootEngine: PyObject? = null
|
||||||
|
@Volatile private var androidAudioEngine: PyObject? = null
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Configure the MediaProjection engine with screen dimensions.
|
* Configure the MediaProjection engine with screen dimensions.
|
||||||
@@ -52,12 +54,60 @@ class PythonBridge(private val context: Context) {
|
|||||||
Log.i(TAG, "Root screenrecord engine configured: ${width}x${height}")
|
Log.i(TAG, "Root screenrecord engine configured: ${width}x${height}")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Configure the Android playback-capture audio engine with the format
|
||||||
|
* actually negotiated by [AudioCapture]'s `AudioRecord`. Must be called
|
||||||
|
* before [pushAudio]. Caches the module handle for the per-block fast
|
||||||
|
* path (same pattern as [configureCapture]).
|
||||||
|
*/
|
||||||
|
fun configureAudio(sampleRate: Int, channels: Int, chunkFrames: Int) {
|
||||||
|
val py = Python.getInstance()
|
||||||
|
val engine = py.getModule("ledgrab.core.audio.android_audio_engine")
|
||||||
|
engine.callAttr("configure", sampleRate, channels, chunkFrames)
|
||||||
|
androidAudioEngine = engine
|
||||||
|
Log.i(TAG, "Android audio engine configured: sr=$sampleRate ch=$channels chunk=$chunkFrames")
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Push one interleaved little-endian float32 PCM block to the Python
|
||||||
|
* audio engine. Called from [AudioCapture]'s capture thread. The byte
|
||||||
|
* array crosses the JNI boundary; Python copies it on receipt, so the
|
||||||
|
* caller may reuse the same buffer for the next block.
|
||||||
|
*/
|
||||||
|
fun pushAudio(pcmFloat32: ByteArray) {
|
||||||
|
if (!running) return
|
||||||
|
val engine = androidAudioEngine ?: return
|
||||||
|
try {
|
||||||
|
engine.callAttr("push_samples", pcmFloat32)
|
||||||
|
} catch (e: Exception) {
|
||||||
|
Log.w(TAG, "Failed to push audio: ${e.message}")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Deactivate the Python audio engine. Called from [AudioCapture.stop].
|
||||||
|
*/
|
||||||
|
fun shutdownAudio() {
|
||||||
|
val engine = androidAudioEngine ?: return
|
||||||
|
try {
|
||||||
|
engine.callAttr("shutdown")
|
||||||
|
} catch (e: Exception) {
|
||||||
|
Log.w(TAG, "Failed to shut down audio engine: ${e.message}")
|
||||||
|
}
|
||||||
|
androidAudioEngine = null
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Start the LedGrab FastAPI server on a background thread.
|
* Start the LedGrab FastAPI server on a background thread.
|
||||||
*
|
*
|
||||||
* This blocks until [stopServer] is called, so it runs in its own thread.
|
* Passes [apiKey] through so the Python server's auth gate accepts
|
||||||
|
* Bearer-authenticated LAN requests; null disables auth (loopback
|
||||||
|
* only — see [ApiKeyManager]).
|
||||||
|
*
|
||||||
|
* This blocks until [stopServer] is called, so it runs in its own
|
||||||
|
* thread.
|
||||||
*/
|
*/
|
||||||
fun startServer(port: Int = 8080) {
|
fun startServer(port: Int = 8080, apiKey: String? = null) {
|
||||||
if (running) {
|
if (running) {
|
||||||
Log.w(TAG, "Server already running")
|
Log.w(TAG, "Server already running")
|
||||||
return
|
return
|
||||||
@@ -71,7 +121,11 @@ class PythonBridge(private val context: Context) {
|
|||||||
Log.i(TAG, "Starting Python server (dataDir=$dataDir, port=$port)")
|
Log.i(TAG, "Starting Python server (dataDir=$dataDir, port=$port)")
|
||||||
val py = Python.getInstance()
|
val py = Python.getInstance()
|
||||||
val entry = py.getModule("ledgrab.android_entry")
|
val entry = py.getModule("ledgrab.android_entry")
|
||||||
entry.callAttr("start_server", dataDir, port)
|
if (apiKey != null) {
|
||||||
|
entry.callAttr("start_server", dataDir, port, apiKey)
|
||||||
|
} else {
|
||||||
|
entry.callAttr("start_server", dataDir, port)
|
||||||
|
}
|
||||||
} catch (e: Exception) {
|
} catch (e: Exception) {
|
||||||
Log.e(TAG, "Python server error", e)
|
Log.e(TAG, "Python server error", e)
|
||||||
} finally {
|
} finally {
|
||||||
@@ -106,7 +160,8 @@ class PythonBridge(private val context: Context) {
|
|||||||
*
|
*
|
||||||
* Called from [ScreenCapture] on the capture thread. The byte array
|
* Called from [ScreenCapture] on the capture thread. The byte array
|
||||||
* crosses the JNI boundary — keep frames small (downscale to 480p
|
* crosses the JNI boundary — keep frames small (downscale to 480p
|
||||||
* before calling).
|
* before calling) and pass reusable buffers (see ScreenCapture's
|
||||||
|
* buffer pool).
|
||||||
*/
|
*/
|
||||||
fun pushFrame(rgbaBytes: ByteArray, width: Int, height: Int) {
|
fun pushFrame(rgbaBytes: ByteArray, width: Int, height: Int) {
|
||||||
if (!running) return
|
if (!running) return
|
||||||
|
|||||||
@@ -100,14 +100,41 @@ object Root {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Run an `su -c <cmd>` command. Returns true on exit-zero. Failure
|
* Run a command as root.
|
||||||
* invalidates the cached grant so the next [requestGrant] re-checks
|
*
|
||||||
* (covers cases like Magisk grant being revoked mid-session).
|
* The [argv] array is passed to `su -c` as **a single string** built by
|
||||||
|
* shell-quoting each element. This prevents the shell-injection class
|
||||||
|
* of bug where a caller passes user-influenced data containing
|
||||||
|
* spaces, semicolons, or backticks: each element is treated as a
|
||||||
|
* single shell token regardless of contents.
|
||||||
|
*
|
||||||
|
* Returns true on exit-zero. Failure invalidates the cached grant so
|
||||||
|
* the next [requestGrant] re-checks (covers cases like Magisk grant
|
||||||
|
* being revoked mid-session).
|
||||||
*/
|
*/
|
||||||
@JvmStatic
|
@JvmStatic
|
||||||
fun runAsRoot(cmd: String, timeoutSeconds: Long = 5): Boolean {
|
@JvmOverloads
|
||||||
|
fun runAsRoot(argv: Array<String>, timeoutSeconds: Long = 5): Boolean {
|
||||||
|
require(argv.isNotEmpty()) { "runAsRoot called with empty argv" }
|
||||||
|
val quoted = argv.joinToString(" ") { shellQuote(it) }
|
||||||
|
return execSu(quoted, timeoutSeconds)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Convenience for fully-trusted constant commands (e.g.
|
||||||
|
* ``runAsRoot("pkill -TERM screenrecord")``). DO NOT pass anything
|
||||||
|
* derived from user input through this overload — use [runAsRoot]
|
||||||
|
* with an argv array instead so each token is quoted individually.
|
||||||
|
*/
|
||||||
|
@JvmStatic
|
||||||
|
@JvmOverloads
|
||||||
|
fun runAsRoot(command: String, timeoutSeconds: Long = 5): Boolean {
|
||||||
|
return execSu(command, timeoutSeconds)
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun execSu(shellLine: String, timeoutSeconds: Long): Boolean {
|
||||||
return try {
|
return try {
|
||||||
val process = ProcessBuilder("su", "-c", cmd)
|
val process = ProcessBuilder("su", "-c", shellLine)
|
||||||
.redirectErrorStream(true)
|
.redirectErrorStream(true)
|
||||||
.start()
|
.start()
|
||||||
val finished = process.waitFor(timeoutSeconds, TimeUnit.SECONDS)
|
val finished = process.waitFor(timeoutSeconds, TimeUnit.SECONDS)
|
||||||
@@ -122,12 +149,34 @@ object Root {
|
|||||||
true
|
true
|
||||||
}
|
}
|
||||||
} catch (e: Exception) {
|
} catch (e: Exception) {
|
||||||
Log.w(TAG, "runAsRoot('$cmd') failed: ${e.message}")
|
Log.w(TAG, "runAsRoot('$shellLine') failed: ${e.message}")
|
||||||
cachedGranted = null
|
cachedGranted = null
|
||||||
false
|
false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* POSIX-shell-style single-quote escape. Wraps in single quotes and
|
||||||
|
* escapes embedded single quotes as ``'\''`` so shell metacharacters
|
||||||
|
* inside [s] are inert.
|
||||||
|
*/
|
||||||
|
private fun shellQuote(s: String): String {
|
||||||
|
if (s.isEmpty()) return "''"
|
||||||
|
// Optimisation: if the string contains only safe characters,
|
||||||
|
// skip the quoting overhead. The set is intentionally narrow —
|
||||||
|
// notably `=` is excluded because an unquoted "FOO=bar" at the
|
||||||
|
// start of a command would be parsed as a shell variable
|
||||||
|
// assignment, not a literal arg. Quoting it forces literal use.
|
||||||
|
if (s.all { it.isLetterOrDigit() || it in "_-./" }) return s
|
||||||
|
val sb = StringBuilder(s.length + 2)
|
||||||
|
sb.append('\'')
|
||||||
|
for (ch in s) {
|
||||||
|
if (ch == '\'') sb.append("'\\''") else sb.append(ch)
|
||||||
|
}
|
||||||
|
sb.append('\'')
|
||||||
|
return sb.toString()
|
||||||
|
}
|
||||||
|
|
||||||
/** Forget the cached grant result — useful if Magisk permission was revoked. */
|
/** Forget the cached grant result — useful if Magisk permission was revoked. */
|
||||||
@JvmStatic
|
@JvmStatic
|
||||||
fun invalidateCache() {
|
fun invalidateCache() {
|
||||||
|
|||||||
@@ -38,8 +38,15 @@ class RootScreenrecord(
|
|||||||
private const val TAG = "RootScreenrecord"
|
private const val TAG = "RootScreenrecord"
|
||||||
private const val MIME_TYPE = MediaFormat.MIMETYPE_VIDEO_AVC
|
private const val MIME_TYPE = MediaFormat.MIMETYPE_VIDEO_AVC
|
||||||
private const val INPUT_CHUNK = 64 * 1024
|
private const val INPUT_CHUNK = 64 * 1024
|
||||||
|
// How long to back off when MediaCodec has no input buffer free.
|
||||||
|
// 50 ms keeps the input pump from busy-spinning if the decoder
|
||||||
|
// is stalled (codec init, severe stall, etc.).
|
||||||
|
private const val NO_BUFFER_BACKOFF_MS = 5L
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Instance is single-use: stop() permanently disposes it. Callers
|
||||||
|
// wanting to restart the pipeline must construct a new instance —
|
||||||
|
// see CaptureService.restartRootPipeline().
|
||||||
@Volatile private var process: Process? = null
|
@Volatile private var process: Process? = null
|
||||||
private var decoder: MediaCodec? = null
|
private var decoder: MediaCodec? = null
|
||||||
private var imageReader: ImageReader? = null
|
private var imageReader: ImageReader? = null
|
||||||
@@ -48,7 +55,22 @@ class RootScreenrecord(
|
|||||||
private var outputThread: Thread? = null
|
private var outputThread: Thread? = null
|
||||||
@Volatile private var running = false
|
@Volatile private var running = false
|
||||||
private val framesDeliveredCounter = AtomicInteger(0)
|
private val framesDeliveredCounter = AtomicInteger(0)
|
||||||
@Volatile private var stopped = false
|
// disposed gates duplicate-stop calls only — not start() after
|
||||||
|
// stop() (which is unsupported, see note above). Set at the START
|
||||||
|
// of cleanup so a second concurrent stop() (rare under @Synchronized
|
||||||
|
// but possible if a future caller drops it) doesn't re-run runCatching
|
||||||
|
// blocks against already-released resources.
|
||||||
|
@Volatile private var disposed = false
|
||||||
|
// Guards process respawn vs. concurrent disposal. The input pump
|
||||||
|
// can spawn a fresh `su -c screenrecord` after EOF; without this
|
||||||
|
// lock, stop() could destroy the OLD process between spawn and
|
||||||
|
// assignment, leaving the new one orphaned (GPU encoder leak).
|
||||||
|
private val processLock = Any()
|
||||||
|
|
||||||
|
// Reusable RGBA buffer for ImageReader callbacks (single-threaded
|
||||||
|
// reader callback). See ScreenCapture for the rationale: avoids
|
||||||
|
// ~15 MB/s of per-frame garbage at 30 fps × 480×270×4 B.
|
||||||
|
private val frameBuffer: ByteArray = ByteArray(width * height * 4)
|
||||||
|
|
||||||
/** Monotonic count of frames pushed to the Python bridge. */
|
/** Monotonic count of frames pushed to the Python bridge. */
|
||||||
val framesDelivered: Int get() = framesDeliveredCounter.get()
|
val framesDelivered: Int get() = framesDeliveredCounter.get()
|
||||||
@@ -84,11 +106,11 @@ class RootScreenrecord(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Stop everything and release resources. Idempotent. */
|
/** Stop everything and release resources. Idempotent. Single-use: do not call start() again. */
|
||||||
@Synchronized
|
@Synchronized
|
||||||
fun stop() {
|
fun stop() {
|
||||||
if (stopped) return
|
if (disposed) return
|
||||||
stopped = true
|
disposed = true
|
||||||
// Order matters: signal first so worker loops drop out, then
|
// Order matters: signal first so worker loops drop out, then
|
||||||
// stop the codec on the thread that created it (this one), then
|
// stop the codec on the thread that created it (this one), then
|
||||||
// join workers BEFORE releasing the codec/ImageReader they may
|
// join workers BEFORE releasing the codec/ImageReader they may
|
||||||
@@ -107,7 +129,9 @@ class RootScreenrecord(
|
|||||||
// Best-effort: kill the screenrecord child before reaping `su`,
|
// Best-effort: kill the screenrecord child before reaping `su`,
|
||||||
// otherwise screenrecord can outlive su as an orphan and keep
|
// otherwise screenrecord can outlive su as an orphan and keep
|
||||||
// the GPU encoder busy. Fire-and-forget; ignore failures.
|
// the GPU encoder busy. Fire-and-forget; ignore failures.
|
||||||
runCatching { Root.runAsRoot("pkill -TERM screenrecord", timeoutSeconds = 2) }
|
runCatching {
|
||||||
|
Root.runAsRoot(arrayOf("pkill", "-TERM", "screenrecord"), timeoutSeconds = 2)
|
||||||
|
}
|
||||||
|
|
||||||
runCatching { decoder?.release() }
|
runCatching { decoder?.release() }
|
||||||
decoder = null
|
decoder = null
|
||||||
@@ -120,8 +144,13 @@ class RootScreenrecord(
|
|||||||
runCatching { readerThread?.join(500) }
|
runCatching { readerThread?.join(500) }
|
||||||
readerThread = null
|
readerThread = null
|
||||||
|
|
||||||
runCatching { process?.destroy() }
|
// Use the same lock as the respawn path so we don't destroy a
|
||||||
process = null
|
// not-yet-published process or leak one that was spawned after
|
||||||
|
// we already destroyed the old reference.
|
||||||
|
synchronized(processLock) {
|
||||||
|
runCatching { process?.destroy() }
|
||||||
|
process = null
|
||||||
|
}
|
||||||
|
|
||||||
Log.i(TAG, "Root capture pipeline stopped (frames delivered: ${framesDelivered})")
|
Log.i(TAG, "Root capture pipeline stopped (frames delivered: ${framesDelivered})")
|
||||||
}
|
}
|
||||||
@@ -131,7 +160,7 @@ class RootScreenrecord(
|
|||||||
readerThread = thread
|
readerThread = thread
|
||||||
val handler = Handler(thread.looper)
|
val handler = Handler(thread.looper)
|
||||||
|
|
||||||
val reader = ImageReader.newInstance(width, height, PixelFormat.RGBA_8888, 2)
|
val reader = ImageReader.newInstance(width, height, PixelFormat.RGBA_8888, 3)
|
||||||
reader.setOnImageAvailableListener({ r ->
|
reader.setOnImageAvailableListener({ r ->
|
||||||
val image = r.acquireLatestImage() ?: return@setOnImageAvailableListener
|
val image = r.acquireLatestImage() ?: return@setOnImageAvailableListener
|
||||||
try {
|
try {
|
||||||
@@ -139,19 +168,17 @@ class RootScreenrecord(
|
|||||||
val buffer = plane.buffer
|
val buffer = plane.buffer
|
||||||
val rowStride = plane.rowStride
|
val rowStride = plane.rowStride
|
||||||
val pixelStride = plane.pixelStride
|
val pixelStride = plane.pixelStride
|
||||||
val bytes = if (rowStride == width * pixelStride) {
|
val rowBytes = width * pixelStride
|
||||||
ByteArray(buffer.remaining()).also { buffer.get(it) }
|
val expected = rowBytes * height
|
||||||
|
if (rowStride == rowBytes && buffer.remaining() >= expected) {
|
||||||
|
buffer.get(frameBuffer, 0, expected)
|
||||||
} else {
|
} else {
|
||||||
// Strip row padding — common when width isn't a multiple of 16.
|
for (row in 0 until height) {
|
||||||
val rowBytes = width * pixelStride
|
buffer.position(row * rowStride)
|
||||||
ByteArray(width * height * 4).also { out ->
|
buffer.get(frameBuffer, row * rowBytes, rowBytes)
|
||||||
for (row in 0 until height) {
|
|
||||||
buffer.position(row * rowStride)
|
|
||||||
buffer.get(out, row * rowBytes, rowBytes)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
bridge.pushRootFrame(bytes, width, height)
|
bridge.pushRootFrame(frameBuffer, width, height)
|
||||||
framesDeliveredCounter.incrementAndGet()
|
framesDeliveredCounter.incrementAndGet()
|
||||||
} catch (e: Exception) {
|
} catch (e: Exception) {
|
||||||
Log.w(TAG, "Root frame delivery failed: ${e.message}")
|
Log.w(TAG, "Root frame delivery failed: ${e.message}")
|
||||||
@@ -173,18 +200,26 @@ class RootScreenrecord(
|
|||||||
}
|
}
|
||||||
|
|
||||||
private fun spawnScreenrecord(): Process? {
|
private fun spawnScreenrecord(): Process? {
|
||||||
val cmd = buildString {
|
// argv form — passes safely through Root.runAsRoot's shell-quote
|
||||||
append("screenrecord")
|
// logic so future changes to flag values can't introduce injection.
|
||||||
append(" --output-format=h264")
|
val args = arrayOf(
|
||||||
append(" --size=${width}x$height")
|
"screenrecord",
|
||||||
append(" --bit-rate=$bitRate")
|
"--output-format=h264",
|
||||||
|
"--size=${width}x$height",
|
||||||
|
"--bit-rate=$bitRate",
|
||||||
// Time limit 0 isn't supported; the largest accepted is 180s.
|
// Time limit 0 isn't supported; the largest accepted is 180s.
|
||||||
// We restart the process ourselves if it exits early.
|
// We restart the process ourselves if it exits early.
|
||||||
append(" --time-limit=180")
|
"--time-limit=180",
|
||||||
append(" -")
|
"-",
|
||||||
}
|
)
|
||||||
|
// Inline ProcessBuilder so we have direct access to the child's
|
||||||
|
// stdout (Root.runAsRoot returns Boolean). We still pass args
|
||||||
|
// unquoted because the entire array is a fixed program+flags
|
||||||
|
// with no user-controlled content.
|
||||||
return try {
|
return try {
|
||||||
Runtime.getRuntime().exec(arrayOf("su", "-c", cmd))
|
ProcessBuilder("su", "-c", args.joinToString(" "))
|
||||||
|
.redirectErrorStream(false)
|
||||||
|
.start()
|
||||||
} catch (e: Exception) {
|
} catch (e: Exception) {
|
||||||
Log.e(TAG, "Failed to spawn `su -c screenrecord`: ${e.message}")
|
Log.e(TAG, "Failed to spawn `su -c screenrecord`: ${e.message}")
|
||||||
null
|
null
|
||||||
@@ -210,21 +245,56 @@ class RootScreenrecord(
|
|||||||
// exits cleanly we respawn so capture survives
|
// exits cleanly we respawn so capture survives
|
||||||
// long sessions instead of freezing after ~3min.
|
// long sessions instead of freezing after ~3min.
|
||||||
Log.i(TAG, "screenrecord EOF — respawning")
|
Log.i(TAG, "screenrecord EOF — respawning")
|
||||||
runCatching { process?.destroy() }
|
synchronized(processLock) {
|
||||||
|
runCatching { process?.destroy() }
|
||||||
|
process = null
|
||||||
|
}
|
||||||
val next = spawnScreenrecord()
|
val next = spawnScreenrecord()
|
||||||
if (next == null) {
|
if (next == null) {
|
||||||
// Avoid a tight loop if `su` is suddenly unhappy.
|
// Avoid a tight loop if `su` is suddenly unhappy.
|
||||||
try { Thread.sleep(500) } catch (_: InterruptedException) { break }
|
try { Thread.sleep(500) } catch (_: InterruptedException) { break }
|
||||||
continue@outer
|
continue@outer
|
||||||
}
|
}
|
||||||
process = next
|
// Publish the new process under the lock so a
|
||||||
|
// concurrent stop() either (a) sees no process,
|
||||||
|
// tears down later, and lets us assign it for
|
||||||
|
// the destroy on the NEXT stop call — or (b) sees
|
||||||
|
// !running and we destroy the new process ourselves.
|
||||||
|
val accepted = synchronized(processLock) {
|
||||||
|
if (!running) {
|
||||||
|
false
|
||||||
|
} else {
|
||||||
|
process = next
|
||||||
|
true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (!accepted) {
|
||||||
|
// running flipped false between EOF and now —
|
||||||
|
// someone called stop(). Drop the new process
|
||||||
|
// on the floor; the codec and output thread
|
||||||
|
// are stop()'s responsibility (it's the only
|
||||||
|
// writer to `running`, so we don't need to
|
||||||
|
// tear them down here).
|
||||||
|
runCatching { next.destroy() }
|
||||||
|
break@outer
|
||||||
|
}
|
||||||
stream = next.inputStream
|
stream = next.inputStream
|
||||||
continue@outer
|
continue@outer
|
||||||
}
|
}
|
||||||
var offset = 0
|
var offset = 0
|
||||||
while (offset < n && running) {
|
while (offset < n && running) {
|
||||||
val index = codec.dequeueInputBuffer(50_000)
|
val index = codec.dequeueInputBuffer(50_000)
|
||||||
if (index < 0) continue
|
if (index < 0) {
|
||||||
|
// Codec is starved — back off briefly instead
|
||||||
|
// of spinning. Without this, a stalled codec
|
||||||
|
// burns 100% of one core hammering dequeue.
|
||||||
|
try {
|
||||||
|
Thread.sleep(NO_BUFFER_BACKOFF_MS)
|
||||||
|
} catch (_: InterruptedException) {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
val inputBuffer = codec.getInputBuffer(index) ?: continue
|
val inputBuffer = codec.getInputBuffer(index) ?: continue
|
||||||
inputBuffer.clear()
|
inputBuffer.clear()
|
||||||
val chunk = minOf(n - offset, inputBuffer.capacity())
|
val chunk = minOf(n - offset, inputBuffer.capacity())
|
||||||
|
|||||||
@@ -1,6 +1,5 @@
|
|||||||
package com.ledgrab.android
|
package com.ledgrab.android
|
||||||
|
|
||||||
import android.graphics.Bitmap
|
|
||||||
import android.graphics.PixelFormat
|
import android.graphics.PixelFormat
|
||||||
import android.hardware.display.DisplayManager
|
import android.hardware.display.DisplayManager
|
||||||
import android.hardware.display.VirtualDisplay
|
import android.hardware.display.VirtualDisplay
|
||||||
@@ -8,24 +7,26 @@ import android.media.ImageReader
|
|||||||
import android.media.projection.MediaProjection
|
import android.media.projection.MediaProjection
|
||||||
import android.os.Handler
|
import android.os.Handler
|
||||||
import android.os.HandlerThread
|
import android.os.HandlerThread
|
||||||
|
import android.os.SystemClock
|
||||||
import android.util.DisplayMetrics
|
import android.util.DisplayMetrics
|
||||||
import android.util.Log
|
import android.util.Log
|
||||||
import java.nio.ByteBuffer
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Captures the Android screen via MediaProjection and feeds frames
|
* Captures the Android screen via MediaProjection and feeds frames
|
||||||
* to [PythonBridge].
|
* to [PythonBridge].
|
||||||
*
|
*
|
||||||
* Frames are downscaled to [targetWidth] x [targetHeight] before
|
* Frames are downscaled to roughly [targetWidth] x [targetHeight] before
|
||||||
* crossing the JNI boundary to minimize overhead. For LED ambient
|
* crossing the JNI boundary to minimize overhead. The actual capture
|
||||||
* lighting, even 480x270 contains far more data than needed.
|
* dimensions preserve the source screen's aspect ratio (snapped to even
|
||||||
|
* pixels for codec friendliness) so non-16:9 displays don't get
|
||||||
|
* squashed.
|
||||||
*/
|
*/
|
||||||
class ScreenCapture(
|
class ScreenCapture(
|
||||||
private val projection: MediaProjection,
|
private val projection: MediaProjection,
|
||||||
private val metrics: DisplayMetrics,
|
private val metrics: DisplayMetrics,
|
||||||
private val bridge: PythonBridge,
|
private val bridge: PythonBridge,
|
||||||
private val targetWidth: Int = 480,
|
targetWidth: Int = 480,
|
||||||
private val targetHeight: Int = 270,
|
targetHeight: Int = 270,
|
||||||
private val targetFps: Int = 30,
|
private val targetFps: Int = 30,
|
||||||
private val onProjectionStopped: () -> Unit = {},
|
private val onProjectionStopped: () -> Unit = {},
|
||||||
) {
|
) {
|
||||||
@@ -34,13 +35,51 @@ class ScreenCapture(
|
|||||||
private const val VIRTUAL_DISPLAY_NAME = "LedGrabCapture"
|
private const val VIRTUAL_DISPLAY_NAME = "LedGrabCapture"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Snap to the source aspect ratio so we don't squash 21:9 / portrait
|
||||||
|
// / rotated screens. Width is the budget; height follows.
|
||||||
|
private val captureWidth: Int
|
||||||
|
private val captureHeight: Int
|
||||||
|
|
||||||
|
init {
|
||||||
|
val srcW = metrics.widthPixels.coerceAtLeast(1).toFloat()
|
||||||
|
val srcH = metrics.heightPixels.coerceAtLeast(1).toFloat()
|
||||||
|
val budget = targetWidth.coerceAtLeast(16)
|
||||||
|
val aspect = srcW / srcH
|
||||||
|
val w = budget
|
||||||
|
val h = (w / aspect).toInt().coerceAtLeast(16)
|
||||||
|
// Bias toward even dimensions — some encoders/ImageReaders are
|
||||||
|
// unhappy with odd sizes when row strides come into play.
|
||||||
|
captureWidth = (w and 1.inv()).coerceAtLeast(16)
|
||||||
|
captureHeight = (h and 1.inv()).coerceAtLeast(16)
|
||||||
|
if (captureWidth != targetWidth || captureHeight != targetHeight) {
|
||||||
|
Log.i(
|
||||||
|
TAG,
|
||||||
|
"Capture size adjusted for ${srcW.toInt()}x${srcH.toInt()} " +
|
||||||
|
"(${"%.2f".format(aspect)}:1) → ${captureWidth}x$captureHeight",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
private var virtualDisplay: VirtualDisplay? = null
|
private var virtualDisplay: VirtualDisplay? = null
|
||||||
private var imageReader: ImageReader? = null
|
private var imageReader: ImageReader? = null
|
||||||
private var captureThread: HandlerThread? = null
|
private var captureThread: HandlerThread? = null
|
||||||
private var captureHandler: Handler? = null
|
private var captureHandler: Handler? = null
|
||||||
@Volatile private var running = false
|
@Volatile private var running = false
|
||||||
private var lastFrameTimeMs = 0L
|
|
||||||
private val frameIntervalMs = 1000L / targetFps
|
// Reusable RGBA frame buffer — sized once for the capture dimensions.
|
||||||
|
// The capture handler is single-threaded so no synchronisation is
|
||||||
|
// required around this buffer (each callback runs to completion
|
||||||
|
// before the next is dispatched). Eliminates ~15 MB/s of per-frame
|
||||||
|
// garbage at 30 fps × 480×270×4 B that previously caused GC pauses
|
||||||
|
// on low-end TV boxes.
|
||||||
|
private val frameBuffer: ByteArray = ByteArray(captureWidth * captureHeight * 4)
|
||||||
|
|
||||||
|
// Monotonic frame pacing. `nextFrameNanos` is the target render
|
||||||
|
// time of the next frame; carrying it forward as an accumulator
|
||||||
|
// avoids the integer-division drift the wall-clock version had
|
||||||
|
// (e.g. 30 fps → 33 ms produced ~30.3 fps).
|
||||||
|
private val frameIntervalNanos = (1_000_000_000L / targetFps.coerceAtLeast(1))
|
||||||
|
private var nextFrameNanos = 0L
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Start capturing the screen.
|
* Start capturing the screen.
|
||||||
@@ -48,6 +87,7 @@ class ScreenCapture(
|
|||||||
fun start() {
|
fun start() {
|
||||||
if (running) return
|
if (running) return
|
||||||
running = true
|
running = true
|
||||||
|
nextFrameNanos = SystemClock.elapsedRealtimeNanos()
|
||||||
|
|
||||||
captureThread = HandlerThread("LedGrab-Capture").also { it.start() }
|
captureThread = HandlerThread("LedGrab-Capture").also { it.start() }
|
||||||
captureHandler = Handler(captureThread!!.looper)
|
captureHandler = Handler(captureThread!!.looper)
|
||||||
@@ -56,28 +96,32 @@ class ScreenCapture(
|
|||||||
projection.registerCallback(object : MediaProjection.Callback() {
|
projection.registerCallback(object : MediaProjection.Callback() {
|
||||||
override fun onStop() {
|
override fun onStop() {
|
||||||
Log.i(TAG, "MediaProjection stopped (external)")
|
Log.i(TAG, "MediaProjection stopped (external)")
|
||||||
stop()
|
// We're on captureHandler's thread here — calling stop()
|
||||||
// Notify the service so the foreground notification /
|
// directly would self-join captureThread (handler.join()
|
||||||
// Python server get torn down too — otherwise a stale
|
// from inside the handler thread hangs until the join
|
||||||
// "Running" notification lingers after the user taps
|
// timeout, then closes resources while we're STILL
|
||||||
// Android's system Cast/Screen-capture stop banner.
|
// inside this callback). Just flip `running` to halt
|
||||||
|
// frame processing and hand off to the service; its
|
||||||
|
// onDestroy will call stop() from the main thread,
|
||||||
|
// which is safe to join captureThread from.
|
||||||
|
running = false
|
||||||
onProjectionStopped()
|
onProjectionStopped()
|
||||||
}
|
}
|
||||||
}, captureHandler)
|
}, captureHandler)
|
||||||
|
|
||||||
imageReader = ImageReader.newInstance(
|
imageReader = ImageReader.newInstance(
|
||||||
targetWidth,
|
captureWidth,
|
||||||
targetHeight,
|
captureHeight,
|
||||||
PixelFormat.RGBA_8888,
|
PixelFormat.RGBA_8888,
|
||||||
2, // maxImages — double buffer
|
3, // maxImages — small ring buffer; 3 is more forgiving than 2 under jitter
|
||||||
)
|
)
|
||||||
|
|
||||||
imageReader?.setOnImageAvailableListener({ reader ->
|
imageReader?.setOnImageAvailableListener({ reader ->
|
||||||
if (!running) return@setOnImageAvailableListener
|
if (!running) return@setOnImageAvailableListener
|
||||||
|
|
||||||
val now = System.currentTimeMillis()
|
val now = SystemClock.elapsedRealtimeNanos()
|
||||||
if (now - lastFrameTimeMs < frameIntervalMs) {
|
if (now < nextFrameNanos) {
|
||||||
// Skip frame to maintain target FPS
|
// Too early — drop this image to stay on cadence.
|
||||||
reader.acquireLatestImage()?.close()
|
reader.acquireLatestImage()?.close()
|
||||||
return@setOnImageAvailableListener
|
return@setOnImageAvailableListener
|
||||||
}
|
}
|
||||||
@@ -88,26 +132,30 @@ class ScreenCapture(
|
|||||||
val buffer = plane.buffer
|
val buffer = plane.buffer
|
||||||
val rowStride = plane.rowStride
|
val rowStride = plane.rowStride
|
||||||
val pixelStride = plane.pixelStride
|
val pixelStride = plane.pixelStride
|
||||||
|
val rowBytes = captureWidth * pixelStride
|
||||||
|
val expected = rowBytes * captureHeight
|
||||||
|
|
||||||
// Handle row padding: rowStride may be > width * pixelStride
|
// Fill the reusable buffer. Two paths:
|
||||||
val rgbaBytes = if (rowStride == targetWidth * pixelStride) {
|
// - rowStride == rowBytes: bulk get into the buffer
|
||||||
// No padding — direct copy
|
// - rowStride > rowBytes: row-by-row copy stripping padding
|
||||||
val bytes = ByteArray(buffer.remaining())
|
if (rowStride == rowBytes && buffer.remaining() >= expected) {
|
||||||
buffer.get(bytes)
|
buffer.get(frameBuffer, 0, expected)
|
||||||
bytes
|
|
||||||
} else {
|
} else {
|
||||||
// Strip row padding
|
for (row in 0 until captureHeight) {
|
||||||
val rowBytes = targetWidth * pixelStride
|
|
||||||
val bytes = ByteArray(targetWidth * targetHeight * 4)
|
|
||||||
for (row in 0 until targetHeight) {
|
|
||||||
buffer.position(row * rowStride)
|
buffer.position(row * rowStride)
|
||||||
buffer.get(bytes, row * rowBytes, rowBytes)
|
buffer.get(frameBuffer, row * rowBytes, rowBytes)
|
||||||
}
|
}
|
||||||
bytes
|
|
||||||
}
|
}
|
||||||
|
|
||||||
bridge.pushFrame(rgbaBytes, targetWidth, targetHeight)
|
bridge.pushFrame(frameBuffer, captureWidth, captureHeight)
|
||||||
lastFrameTimeMs = now
|
|
||||||
|
// Advance the pacing accumulator. If we fell badly behind
|
||||||
|
// (long GC, JNI stall), snap forward to "now" instead of
|
||||||
|
// accumulating a burst of catch-up frames.
|
||||||
|
nextFrameNanos += frameIntervalNanos
|
||||||
|
if (now - nextFrameNanos > frameIntervalNanos * 4) {
|
||||||
|
nextFrameNanos = now + frameIntervalNanos
|
||||||
|
}
|
||||||
} catch (e: Exception) {
|
} catch (e: Exception) {
|
||||||
Log.w(TAG, "Frame processing error: ${e.message}")
|
Log.w(TAG, "Frame processing error: ${e.message}")
|
||||||
} finally {
|
} finally {
|
||||||
@@ -117,8 +165,8 @@ class ScreenCapture(
|
|||||||
|
|
||||||
virtualDisplay = projection.createVirtualDisplay(
|
virtualDisplay = projection.createVirtualDisplay(
|
||||||
VIRTUAL_DISPLAY_NAME,
|
VIRTUAL_DISPLAY_NAME,
|
||||||
targetWidth,
|
captureWidth,
|
||||||
targetHeight,
|
captureHeight,
|
||||||
metrics.densityDpi,
|
metrics.densityDpi,
|
||||||
DisplayManager.VIRTUAL_DISPLAY_FLAG_AUTO_MIRROR,
|
DisplayManager.VIRTUAL_DISPLAY_FLAG_AUTO_MIRROR,
|
||||||
imageReader?.surface,
|
imageReader?.surface,
|
||||||
@@ -126,7 +174,7 @@ class ScreenCapture(
|
|||||||
captureHandler,
|
captureHandler,
|
||||||
)
|
)
|
||||||
|
|
||||||
Log.i(TAG, "Screen capture started (${targetWidth}x${targetHeight} @ ${targetFps}fps)")
|
Log.i(TAG, "Screen capture started (${captureWidth}x${captureHeight} @ ${targetFps}fps)")
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -8,6 +8,7 @@ import android.content.IntentFilter
|
|||||||
import android.hardware.usb.UsbManager
|
import android.hardware.usb.UsbManager
|
||||||
import android.os.Build
|
import android.os.Build
|
||||||
import android.util.Log
|
import android.util.Log
|
||||||
|
import androidx.core.content.ContextCompat
|
||||||
import com.hoho.android.usbserial.driver.UsbSerialDriver
|
import com.hoho.android.usbserial.driver.UsbSerialDriver
|
||||||
import com.hoho.android.usbserial.driver.UsbSerialPort
|
import com.hoho.android.usbserial.driver.UsbSerialPort
|
||||||
import com.hoho.android.usbserial.driver.UsbSerialProber
|
import com.hoho.android.usbserial.driver.UsbSerialProber
|
||||||
@@ -54,8 +55,23 @@ object UsbSerialBridge {
|
|||||||
if (!initialized.compareAndSet(false, true)) return
|
if (!initialized.compareAndSet(false, true)) return
|
||||||
|
|
||||||
val filter = IntentFilter(ACTION_USB_PERMISSION)
|
val filter = IntentFilter(ACTION_USB_PERMISSION)
|
||||||
|
val ourPackage = app.packageName
|
||||||
val receiver = object : BroadcastReceiver() {
|
val receiver = object : BroadcastReceiver() {
|
||||||
override fun onReceive(ctx: Context, intent: Intent) {
|
override fun onReceive(ctx: Context, intent: Intent) {
|
||||||
|
// Defence-in-depth: the receiver is registered as
|
||||||
|
// RECEIVER_NOT_EXPORTED, but on pre-API-33 platforms
|
||||||
|
// older Android versions historically defaulted to
|
||||||
|
// exported. Also enforce the package check here so an
|
||||||
|
// explicit-intent attack from another app on the device
|
||||||
|
// is rejected even if the OS treats us as exported.
|
||||||
|
if (intent.`package` != null && intent.`package` != ourPackage) {
|
||||||
|
Log.w(
|
||||||
|
TAG,
|
||||||
|
"Ignoring USB permission broadcast from " +
|
||||||
|
"package='${intent.`package`}' (not us)",
|
||||||
|
)
|
||||||
|
return
|
||||||
|
}
|
||||||
val granted = intent.getBooleanExtra(
|
val granted = intent.getBooleanExtra(
|
||||||
UsbManager.EXTRA_PERMISSION_GRANTED,
|
UsbManager.EXTRA_PERMISSION_GRANTED,
|
||||||
false,
|
false,
|
||||||
@@ -69,13 +85,16 @@ object UsbSerialBridge {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
// Android 14 requires RECEIVER_NOT_EXPORTED for non-system broadcasts.
|
// ContextCompat handles the RECEIVER_NOT_EXPORTED flag correctly
|
||||||
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
|
// across all supported API levels (it's a no-op on platforms
|
||||||
app.registerReceiver(receiver, filter, Context.RECEIVER_NOT_EXPORTED)
|
// where the flag doesn't exist, and explicit on API ≥33 where
|
||||||
} else {
|
// Android enforces it).
|
||||||
@Suppress("UnspecifiedRegisterReceiverFlag")
|
ContextCompat.registerReceiver(
|
||||||
app.registerReceiver(receiver, filter)
|
app,
|
||||||
}
|
receiver,
|
||||||
|
filter,
|
||||||
|
ContextCompat.RECEIVER_NOT_EXPORTED,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
private fun ctx(): Context =
|
private fun ctx(): Context =
|
||||||
|
|||||||
@@ -0,0 +1,58 @@
|
|||||||
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
|
<!-- Android TV launcher banner: 320x180 landscape.
|
||||||
|
Shown on the leanback home row. The previous build reused the square
|
||||||
|
launcher icon, which letterboxed badly. -->
|
||||||
|
<vector xmlns:android="http://schemas.android.com/apk/res/android"
|
||||||
|
android:width="320dp"
|
||||||
|
android:height="180dp"
|
||||||
|
android:viewportWidth="320"
|
||||||
|
android:viewportHeight="180">
|
||||||
|
<!-- Background -->
|
||||||
|
<path
|
||||||
|
android:fillColor="#0d1117"
|
||||||
|
android:pathData="M0,0 L320,0 L320,180 L0,180 Z" />
|
||||||
|
<!-- Subtle teal glow top-left -->
|
||||||
|
<path
|
||||||
|
android:fillColor="#1A64ffda"
|
||||||
|
android:pathData="M0,0 L160,0 L160,90 L0,90 Z" />
|
||||||
|
<!-- Subtle purple glow bottom-right -->
|
||||||
|
<path
|
||||||
|
android:fillColor="#15bb86fc"
|
||||||
|
android:pathData="M160,90 L320,90 L320,180 L160,180 Z" />
|
||||||
|
<!-- TV body, centered -->
|
||||||
|
<path
|
||||||
|
android:fillColor="#1c2333"
|
||||||
|
android:pathData="M88,56 L196,56 Q204,56 204,64 L204,116 Q204,124 196,124 L88,124 Q80,124 80,116 L80,64 Q80,56 88,56 Z" />
|
||||||
|
<!-- TV screen -->
|
||||||
|
<path
|
||||||
|
android:fillColor="#161b22"
|
||||||
|
android:pathData="M92,60 L192,60 Q196,60 196,64 L196,116 Q196,120 192,120 L92,120 Q88,120 88,116 L88,64 Q88,60 92,60 Z" />
|
||||||
|
<!-- LED glow strips -->
|
||||||
|
<path
|
||||||
|
android:fillColor="#64ffda"
|
||||||
|
android:fillAlpha="0.8"
|
||||||
|
android:pathData="M94,50 L190,50 L190,54 L94,54 Z" />
|
||||||
|
<path
|
||||||
|
android:fillColor="#bb86fc"
|
||||||
|
android:fillAlpha="0.7"
|
||||||
|
android:pathData="M72,62 L76,62 L76,118 L72,118 Z" />
|
||||||
|
<path
|
||||||
|
android:fillColor="#ff6b6b"
|
||||||
|
android:fillAlpha="0.7"
|
||||||
|
android:pathData="M208,62 L212,62 L212,118 L208,118 Z" />
|
||||||
|
<path
|
||||||
|
android:fillColor="#ffd93d"
|
||||||
|
android:fillAlpha="0.7"
|
||||||
|
android:pathData="M94,126 L190,126 L190,130 L94,130 Z" />
|
||||||
|
<!-- Wordmark "LedGrab" — drawn as paths so we don't depend on the
|
||||||
|
system font cache being warm at TV launch. -->
|
||||||
|
<!-- L -->
|
||||||
|
<path android:fillColor="#64ffda"
|
||||||
|
android:pathData="M222,72 L228,72 L228,100 L240,100 L240,106 L222,106 Z" />
|
||||||
|
<!-- e -->
|
||||||
|
<path android:fillColor="#e6edf3"
|
||||||
|
android:pathData="M244,82 L260,82 Q264,82 264,86 L264,94 L250,94 L250,100 L262,100 L262,106 L246,106 Q244,106 244,104 Z M250,86 L250,90 L258,90 L258,86 Z" />
|
||||||
|
<!-- d -->
|
||||||
|
<path android:fillColor="#e6edf3"
|
||||||
|
android:pathData="M266,72 L272,72 L272,82 L284,82 Q286,82 286,84 L286,106 L268,106 Q266,106 266,104 Z M272,88 L272,100 L280,100 L280,88 Z" />
|
||||||
|
</vector>
|
||||||
@@ -1,5 +1,9 @@
|
|||||||
<?xml version="1.0" encoding="utf-8"?>
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
|
<!-- Static fallback for the status dot. The animated version
|
||||||
|
(animated_status_dot.xml) is used at runtime; this is what
|
||||||
|
XML rendering tools show in the editor. -->
|
||||||
<shape xmlns:android="http://schemas.android.com/apk/res/android"
|
<shape xmlns:android="http://schemas.android.com/apk/res/android"
|
||||||
android:shape="oval">
|
android:shape="oval">
|
||||||
<solid android:color="@color/green_status" />
|
<solid android:color="@color/green_status" />
|
||||||
|
<size android:width="18dp" android:height="18dp" />
|
||||||
</shape>
|
</shape>
|
||||||
|
|||||||
@@ -0,0 +1,23 @@
|
|||||||
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
|
<!-- Monochrome status-bar icon. Android requires white-on-transparent for
|
||||||
|
notification icons since API 21 - reusing the colored launcher would
|
||||||
|
render as a gray blob. -->
|
||||||
|
<vector xmlns:android="http://schemas.android.com/apk/res/android"
|
||||||
|
android:width="24dp"
|
||||||
|
android:height="24dp"
|
||||||
|
android:viewportWidth="24"
|
||||||
|
android:viewportHeight="24"
|
||||||
|
android:tint="#FFFFFFFF">
|
||||||
|
<!-- TV body -->
|
||||||
|
<path
|
||||||
|
android:fillColor="#FFFFFFFF"
|
||||||
|
android:pathData="M5,7 L19,7 Q20,7 20,8 L20,16 Q20,17 19,17 L5,17 Q4,17 4,16 L4,8 Q4,7 5,7 Z M5.5,8.5 L5.5,15.5 L18.5,15.5 L18.5,8.5 Z" />
|
||||||
|
<!-- TV stand -->
|
||||||
|
<path
|
||||||
|
android:fillColor="#FFFFFFFF"
|
||||||
|
android:pathData="M10,17 L10,18.5 L14,18.5 L14,17 Z M9,19 L15,19 L15,20 L9,20 Z" />
|
||||||
|
<!-- LED glow strips around the TV (bright dots) -->
|
||||||
|
<path
|
||||||
|
android:fillColor="#FFFFFFFF"
|
||||||
|
android:pathData="M6,5.5 L18,5.5 L18,6.5 L6,6.5 Z" />
|
||||||
|
</vector>
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
|
<!-- Splash screen icon (API 31+ uses a 1:1 vector inside a 240dp circle).
|
||||||
|
The SplashScreen API masks this with a circle automatically. -->
|
||||||
|
<vector xmlns:android="http://schemas.android.com/apk/res/android"
|
||||||
|
android:width="240dp"
|
||||||
|
android:height="240dp"
|
||||||
|
android:viewportWidth="108"
|
||||||
|
android:viewportHeight="108">
|
||||||
|
<!-- TV body -->
|
||||||
|
<path
|
||||||
|
android:fillColor="#1c2333"
|
||||||
|
android:pathData="M26,32 L82,32 Q86,32 86,36 L86,68 Q86,72 82,72 L26,72 Q22,72 22,68 L22,36 Q22,32 26,32 Z" />
|
||||||
|
<!-- TV screen -->
|
||||||
|
<path
|
||||||
|
android:fillColor="#161b22"
|
||||||
|
android:pathData="M28,35 L80,35 Q82,35 82,37 L82,66 Q82,68 80,68 L28,68 Q26,68 26,66 L26,37 Q26,35 28,35 Z" />
|
||||||
|
<!-- LED glow strips, brighter on splash for impact -->
|
||||||
|
<path
|
||||||
|
android:fillColor="#64ffda"
|
||||||
|
android:pathData="M30,28 L78,28 L78,30 L30,30 Z" />
|
||||||
|
<path
|
||||||
|
android:fillColor="#bb86fc"
|
||||||
|
android:pathData="M18,34 L20,34 L20,70 L18,70 Z" />
|
||||||
|
<path
|
||||||
|
android:fillColor="#ff6b6b"
|
||||||
|
android:pathData="M88,34 L90,34 L90,70 L88,70 Z" />
|
||||||
|
<path
|
||||||
|
android:fillColor="#ffd93d"
|
||||||
|
android:pathData="M30,74 L78,74 L78,76 L30,76 Z" />
|
||||||
|
<!-- TV stand -->
|
||||||
|
<path
|
||||||
|
android:fillColor="#1c2333"
|
||||||
|
android:pathData="M44,72 L44,78 L64,78 L64,72" />
|
||||||
|
<path
|
||||||
|
android:fillColor="#1c2333"
|
||||||
|
android:pathData="M38,78 L70,78 L70,80 L38,80 Z" />
|
||||||
|
</vector>
|
||||||
@@ -32,16 +32,28 @@
|
|||||||
android:textStyle="bold"
|
android:textStyle="bold"
|
||||||
android:letterSpacing="0.08"
|
android:letterSpacing="0.08"
|
||||||
android:layout_marginBottom="12dp"
|
android:layout_marginBottom="12dp"
|
||||||
android:fontFamily="sans-serif-light" />
|
android:fontFamily="sans-serif" />
|
||||||
|
|
||||||
<TextView
|
<TextView
|
||||||
android:id="@+id/status_text"
|
android:id="@+id/tagline_text"
|
||||||
android:layout_width="wrap_content"
|
android:layout_width="wrap_content"
|
||||||
android:layout_height="wrap_content"
|
android:layout_height="wrap_content"
|
||||||
android:text="@string/tagline"
|
android:text="@string/tagline"
|
||||||
android:textColor="@color/text_secondary"
|
android:textColor="@color/text_secondary"
|
||||||
android:textSize="28sp"
|
android:textSize="28sp"
|
||||||
android:layout_marginBottom="64dp" />
|
android:layout_marginBottom="24dp" />
|
||||||
|
|
||||||
|
<!-- Transient status (root probing / permission denial). Always
|
||||||
|
present so the layout doesn't reflow when text appears. -->
|
||||||
|
<TextView
|
||||||
|
android:id="@+id/status_text"
|
||||||
|
android:layout_width="wrap_content"
|
||||||
|
android:layout_height="32dp"
|
||||||
|
android:gravity="center"
|
||||||
|
android:textColor="@color/text_secondary"
|
||||||
|
android:textSize="20sp"
|
||||||
|
android:layout_marginBottom="32dp"
|
||||||
|
tools:text="Checking root access…" />
|
||||||
|
|
||||||
<Button
|
<Button
|
||||||
android:id="@+id/toggle_button"
|
android:id="@+id/toggle_button"
|
||||||
@@ -51,7 +63,38 @@
|
|||||||
android:text="@string/btn_start"
|
android:text="@string/btn_start"
|
||||||
android:textSize="22sp"
|
android:textSize="22sp"
|
||||||
android:focusable="true"
|
android:focusable="true"
|
||||||
android:focusableInTouchMode="true" />
|
android:focusableInTouchMode="true"
|
||||||
|
android:nextFocusDown="@+id/autostart_check" />
|
||||||
|
|
||||||
|
<!-- Shown only while notification-listener access is missing. The D-pad
|
||||||
|
focus chain is wired at runtime (wireStoppedFocusChain) because this
|
||||||
|
button and the autostart checkbox are both conditionally visible. -->
|
||||||
|
<Button
|
||||||
|
android:id="@+id/grant_notification_button"
|
||||||
|
style="@style/Widget.LedGrab.Button.Secondary"
|
||||||
|
android:layout_width="320dp"
|
||||||
|
android:layout_height="56dp"
|
||||||
|
android:layout_marginTop="20dp"
|
||||||
|
android:text="@string/btn_grant_notification_access"
|
||||||
|
android:textSize="18sp"
|
||||||
|
android:focusable="true"
|
||||||
|
android:focusableInTouchMode="true"
|
||||||
|
android:visibility="gone" />
|
||||||
|
|
||||||
|
<!-- Shown only while Usage Access is missing (needed by the foreground-app
|
||||||
|
automation rule). Like the grant-notification button, its D-pad focus
|
||||||
|
chain is wired at runtime (wireStoppedFocusChain). -->
|
||||||
|
<Button
|
||||||
|
android:id="@+id/grant_usage_access_button"
|
||||||
|
style="@style/Widget.LedGrab.Button.Secondary"
|
||||||
|
android:layout_width="320dp"
|
||||||
|
android:layout_height="56dp"
|
||||||
|
android:layout_marginTop="20dp"
|
||||||
|
android:text="@string/btn_grant_usage_access"
|
||||||
|
android:textSize="18sp"
|
||||||
|
android:focusable="true"
|
||||||
|
android:focusableInTouchMode="true"
|
||||||
|
android:visibility="gone" />
|
||||||
|
|
||||||
<CheckBox
|
<CheckBox
|
||||||
android:id="@+id/autostart_check"
|
android:id="@+id/autostart_check"
|
||||||
@@ -63,10 +106,11 @@
|
|||||||
android:textSize="20sp"
|
android:textSize="20sp"
|
||||||
android:buttonTint="@color/teal_accent"
|
android:buttonTint="@color/teal_accent"
|
||||||
android:focusable="true"
|
android:focusable="true"
|
||||||
android:focusableInTouchMode="true" />
|
android:focusableInTouchMode="true"
|
||||||
|
android:nextFocusUp="@id/toggle_button" />
|
||||||
</LinearLayout>
|
</LinearLayout>
|
||||||
|
|
||||||
<!-- Version at bottom -->
|
<!-- Version at bottom (always visible — looks polished on TV idle). -->
|
||||||
<TextView
|
<TextView
|
||||||
android:id="@+id/version_text"
|
android:id="@+id/version_text"
|
||||||
android:layout_width="wrap_content"
|
android:layout_width="wrap_content"
|
||||||
@@ -77,115 +121,13 @@
|
|||||||
android:textSize="18sp"
|
android:textSize="18sp"
|
||||||
tools:text="v0.1.0" />
|
tools:text="v0.1.0" />
|
||||||
|
|
||||||
<!-- RUNNING STATE -->
|
<!-- RUNNING STATE — deferred-inflate via ViewStub so first paint is
|
||||||
<LinearLayout
|
cheaper and the inflater doesn't measure two competing layouts. -->
|
||||||
android:id="@+id/running_panel"
|
<ViewStub
|
||||||
|
android:id="@+id/running_panel_stub"
|
||||||
android:layout_width="match_parent"
|
android:layout_width="match_parent"
|
||||||
android:layout_height="match_parent"
|
android:layout_height="match_parent"
|
||||||
android:orientation="horizontal"
|
android:inflatedId="@+id/running_panel"
|
||||||
android:gravity="center_vertical"
|
android:layout="@layout/panel_running"
|
||||||
android:paddingStart="120dp"
|
android:visibility="gone" />
|
||||||
android:paddingEnd="120dp"
|
|
||||||
android:paddingTop="80dp"
|
|
||||||
android:paddingBottom="80dp"
|
|
||||||
android:visibility="gone">
|
|
||||||
|
|
||||||
<!-- Left: status + URL + stop -->
|
|
||||||
<LinearLayout
|
|
||||||
android:layout_width="0dp"
|
|
||||||
android:layout_height="wrap_content"
|
|
||||||
android:layout_weight="1"
|
|
||||||
android:orientation="vertical"
|
|
||||||
android:gravity="start|center_vertical"
|
|
||||||
android:paddingEnd="64dp">
|
|
||||||
|
|
||||||
<LinearLayout
|
|
||||||
android:layout_width="wrap_content"
|
|
||||||
android:layout_height="wrap_content"
|
|
||||||
android:orientation="horizontal"
|
|
||||||
android:gravity="center_vertical"
|
|
||||||
android:layout_marginBottom="32dp">
|
|
||||||
|
|
||||||
<View
|
|
||||||
android:layout_width="18dp"
|
|
||||||
android:layout_height="18dp"
|
|
||||||
android:background="@drawable/bg_status_dot"
|
|
||||||
android:layout_marginEnd="16dp" />
|
|
||||||
|
|
||||||
<TextView
|
|
||||||
android:layout_width="wrap_content"
|
|
||||||
android:layout_height="wrap_content"
|
|
||||||
android:text="@string/status_running"
|
|
||||||
android:textColor="@color/green_status"
|
|
||||||
android:textSize="28sp"
|
|
||||||
android:textStyle="bold"
|
|
||||||
android:letterSpacing="0.05" />
|
|
||||||
</LinearLayout>
|
|
||||||
|
|
||||||
<TextView
|
|
||||||
android:layout_width="wrap_content"
|
|
||||||
android:layout_height="wrap_content"
|
|
||||||
android:text="@string/label_web_ui"
|
|
||||||
android:textColor="@color/text_secondary"
|
|
||||||
android:textSize="22sp"
|
|
||||||
android:layout_marginBottom="8dp" />
|
|
||||||
|
|
||||||
<TextView
|
|
||||||
android:id="@+id/url_text"
|
|
||||||
android:layout_width="wrap_content"
|
|
||||||
android:layout_height="wrap_content"
|
|
||||||
android:textColor="@color/teal_accent"
|
|
||||||
android:textSize="30sp"
|
|
||||||
android:maxLines="1"
|
|
||||||
android:textStyle="bold"
|
|
||||||
android:background="@drawable/bg_url_chip"
|
|
||||||
android:paddingStart="24dp"
|
|
||||||
android:paddingEnd="24dp"
|
|
||||||
android:paddingTop="12dp"
|
|
||||||
android:paddingBottom="12dp"
|
|
||||||
android:layout_marginBottom="56dp"
|
|
||||||
tools:text="http://192.168.1.5:8080" />
|
|
||||||
|
|
||||||
<Button
|
|
||||||
android:id="@+id/stop_button_running"
|
|
||||||
style="@style/Widget.LedGrab.Button.Secondary"
|
|
||||||
android:layout_width="240dp"
|
|
||||||
android:layout_height="64dp"
|
|
||||||
android:text="@string/btn_stop"
|
|
||||||
android:textSize="20sp"
|
|
||||||
android:focusable="true"
|
|
||||||
android:focusableInTouchMode="true" />
|
|
||||||
</LinearLayout>
|
|
||||||
|
|
||||||
<!-- Right: QR code -->
|
|
||||||
<LinearLayout
|
|
||||||
android:layout_width="wrap_content"
|
|
||||||
android:layout_height="wrap_content"
|
|
||||||
android:orientation="vertical"
|
|
||||||
android:gravity="center">
|
|
||||||
|
|
||||||
<FrameLayout
|
|
||||||
android:layout_width="wrap_content"
|
|
||||||
android:layout_height="wrap_content"
|
|
||||||
android:background="@drawable/bg_qr_container"
|
|
||||||
android:padding="20dp"
|
|
||||||
android:layout_marginBottom="20dp">
|
|
||||||
|
|
||||||
<ImageView
|
|
||||||
android:id="@+id/qr_image"
|
|
||||||
android:layout_width="280dp"
|
|
||||||
android:layout_height="280dp"
|
|
||||||
android:contentDescription="@string/qr_description"
|
|
||||||
android:scaleType="fitXY" />
|
|
||||||
</FrameLayout>
|
|
||||||
|
|
||||||
<TextView
|
|
||||||
android:layout_width="wrap_content"
|
|
||||||
android:layout_height="wrap_content"
|
|
||||||
android:text="@string/scan_to_configure"
|
|
||||||
android:textColor="@color/text_secondary"
|
|
||||||
android:textSize="22sp"
|
|
||||||
android:gravity="center" />
|
|
||||||
</LinearLayout>
|
|
||||||
</LinearLayout>
|
|
||||||
</FrameLayout>
|
</FrameLayout>
|
||||||
|
|||||||
@@ -0,0 +1,124 @@
|
|||||||
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
|
<!-- RUNNING STATE -->
|
||||||
|
<LinearLayout
|
||||||
|
xmlns:android="http://schemas.android.com/apk/res/android"
|
||||||
|
xmlns:tools="http://schemas.android.com/tools"
|
||||||
|
android:layout_width="match_parent"
|
||||||
|
android:layout_height="match_parent"
|
||||||
|
android:orientation="horizontal"
|
||||||
|
android:gravity="center_vertical"
|
||||||
|
android:paddingStart="120dp"
|
||||||
|
android:paddingEnd="120dp"
|
||||||
|
android:paddingTop="80dp"
|
||||||
|
android:paddingBottom="80dp">
|
||||||
|
|
||||||
|
<!-- Left: status + URL + stop -->
|
||||||
|
<LinearLayout
|
||||||
|
android:layout_width="0dp"
|
||||||
|
android:layout_height="wrap_content"
|
||||||
|
android:layout_weight="1"
|
||||||
|
android:orientation="vertical"
|
||||||
|
android:gravity="start|center_vertical"
|
||||||
|
android:paddingEnd="64dp">
|
||||||
|
|
||||||
|
<LinearLayout
|
||||||
|
android:layout_width="wrap_content"
|
||||||
|
android:layout_height="wrap_content"
|
||||||
|
android:orientation="horizontal"
|
||||||
|
android:gravity="center_vertical"
|
||||||
|
android:layout_marginBottom="32dp">
|
||||||
|
|
||||||
|
<View
|
||||||
|
android:id="@+id/status_dot"
|
||||||
|
android:layout_width="18dp"
|
||||||
|
android:layout_height="18dp"
|
||||||
|
android:background="@drawable/bg_status_dot"
|
||||||
|
android:layout_marginEnd="16dp" />
|
||||||
|
|
||||||
|
<TextView
|
||||||
|
android:layout_width="wrap_content"
|
||||||
|
android:layout_height="wrap_content"
|
||||||
|
android:text="@string/status_running"
|
||||||
|
android:textColor="@color/green_status"
|
||||||
|
android:textSize="28sp"
|
||||||
|
android:textStyle="bold"
|
||||||
|
android:letterSpacing="0.05" />
|
||||||
|
</LinearLayout>
|
||||||
|
|
||||||
|
<TextView
|
||||||
|
android:layout_width="wrap_content"
|
||||||
|
android:layout_height="wrap_content"
|
||||||
|
android:text="@string/label_web_ui"
|
||||||
|
android:textColor="@color/text_secondary"
|
||||||
|
android:textSize="22sp"
|
||||||
|
android:layout_marginBottom="8dp" />
|
||||||
|
|
||||||
|
<TextView
|
||||||
|
android:id="@+id/url_text"
|
||||||
|
android:layout_width="wrap_content"
|
||||||
|
android:layout_height="wrap_content"
|
||||||
|
android:textColor="@color/teal_accent"
|
||||||
|
android:textSize="30sp"
|
||||||
|
android:maxLines="1"
|
||||||
|
android:textStyle="bold"
|
||||||
|
android:background="@drawable/bg_url_chip"
|
||||||
|
android:paddingStart="24dp"
|
||||||
|
android:paddingEnd="24dp"
|
||||||
|
android:paddingTop="12dp"
|
||||||
|
android:paddingBottom="12dp"
|
||||||
|
android:layout_marginBottom="56dp"
|
||||||
|
tools:text="http://192.168.1.5:8080" />
|
||||||
|
|
||||||
|
<Button
|
||||||
|
android:id="@+id/stop_button_running"
|
||||||
|
style="@style/Widget.LedGrab.Button.Secondary"
|
||||||
|
android:layout_width="240dp"
|
||||||
|
android:layout_height="64dp"
|
||||||
|
android:text="@string/btn_stop"
|
||||||
|
android:textSize="20sp"
|
||||||
|
android:focusable="true"
|
||||||
|
android:focusableInTouchMode="true"
|
||||||
|
android:nextFocusUp="@id/stop_button_running"
|
||||||
|
android:nextFocusDown="@id/stop_button_running" />
|
||||||
|
</LinearLayout>
|
||||||
|
|
||||||
|
<!-- Right: QR code + fallback hint -->
|
||||||
|
<LinearLayout
|
||||||
|
android:layout_width="wrap_content"
|
||||||
|
android:layout_height="wrap_content"
|
||||||
|
android:orientation="vertical"
|
||||||
|
android:gravity="center">
|
||||||
|
|
||||||
|
<FrameLayout
|
||||||
|
android:layout_width="wrap_content"
|
||||||
|
android:layout_height="wrap_content"
|
||||||
|
android:background="@drawable/bg_qr_container"
|
||||||
|
android:padding="20dp"
|
||||||
|
android:layout_marginBottom="20dp">
|
||||||
|
|
||||||
|
<ImageView
|
||||||
|
android:id="@+id/qr_image"
|
||||||
|
android:layout_width="280dp"
|
||||||
|
android:layout_height="280dp"
|
||||||
|
android:contentDescription="@string/qr_description"
|
||||||
|
android:scaleType="fitXY" />
|
||||||
|
</FrameLayout>
|
||||||
|
|
||||||
|
<TextView
|
||||||
|
android:layout_width="wrap_content"
|
||||||
|
android:layout_height="wrap_content"
|
||||||
|
android:text="@string/scan_to_configure"
|
||||||
|
android:textColor="@color/text_secondary"
|
||||||
|
android:textSize="22sp"
|
||||||
|
android:gravity="center" />
|
||||||
|
|
||||||
|
<TextView
|
||||||
|
android:layout_width="280dp"
|
||||||
|
android:layout_height="wrap_content"
|
||||||
|
android:text="@string/scan_fallback_hint"
|
||||||
|
android:textColor="@color/text_hint"
|
||||||
|
android:textSize="14sp"
|
||||||
|
android:gravity="center"
|
||||||
|
android:layout_marginTop="6dp" />
|
||||||
|
</LinearLayout>
|
||||||
|
</LinearLayout>
|
||||||
@@ -3,12 +3,29 @@
|
|||||||
<string name="app_name">LedGrab</string>
|
<string name="app_name">LedGrab</string>
|
||||||
<string name="tagline">Фоновая подсветка для телевизора</string>
|
<string name="tagline">Фоновая подсветка для телевизора</string>
|
||||||
<string name="btn_start">Начать захват</string>
|
<string name="btn_start">Начать захват</string>
|
||||||
|
<string name="btn_starting">Запуск…</string>
|
||||||
<string name="btn_stop">Стоп</string>
|
<string name="btn_stop">Стоп</string>
|
||||||
<string name="status_running">Работает</string>
|
<string name="status_running">Работает</string>
|
||||||
|
<string name="status_checking_root">Проверка root-доступа…</string>
|
||||||
|
<string name="status_permission_denied">Доступ запрещён — для захвата экрана требуется разрешение</string>
|
||||||
|
<string name="status_no_network">Нет сети — подключите Wi-Fi или Ethernet</string>
|
||||||
<string name="label_web_ui">Адрес веб-интерфейса</string>
|
<string name="label_web_ui">Адрес веб-интерфейса</string>
|
||||||
<string name="scan_to_configure">Сканируйте для настройки</string>
|
<string name="scan_to_configure">Сканируйте для настройки</string>
|
||||||
|
<string name="scan_fallback_hint">или откройте этот адрес с любого устройства в сети</string>
|
||||||
<string name="qr_description">QR-код для веб-интерфейса</string>
|
<string name="qr_description">QR-код для веб-интерфейса</string>
|
||||||
<string name="version_prefix">v%1$s</string>
|
<string name="version_prefix">v%1$s</string>
|
||||||
<string name="autostart_label">Запускать при загрузке (только с root)</string>
|
<string name="autostart_label">Запускать при загрузке (только с root)</string>
|
||||||
<string name="autostart_unavailable">Запуск при загрузке — недоступно (нужен root)</string>
|
<string name="autostart_unavailable">Запуск при загрузке — недоступно (нужен root)</string>
|
||||||
|
<string name="fatal_title">Не удалось запустить LedGrab</string>
|
||||||
|
<string name="fatal_body_prefix">Ошибка инициализации Python:</string>
|
||||||
|
<string name="fatal_copy_log">Скопировать журнал</string>
|
||||||
|
<string name="fatal_show_details">Показать подробности</string>
|
||||||
|
<string name="fatal_hide_details">Скрыть подробности</string>
|
||||||
|
<string name="notification_channel_name">Захват LedGrab</string>
|
||||||
|
<string name="notification_channel_description">Отображается, пока LedGrab захватывает экран.</string>
|
||||||
|
<string name="notification_title">LedGrab работает</string>
|
||||||
|
<string name="notification_text">Веб-интерфейс: %1$s</string>
|
||||||
|
<string name="notification_listener_label">Захват уведомлений LedGrab</string>
|
||||||
|
<string name="btn_grant_notification_access">Разрешить доступ к уведомлениям</string>
|
||||||
|
<string name="btn_grant_usage_access">Разрешить доступ к статистике использования</string>
|
||||||
</resources>
|
</resources>
|
||||||
|
|||||||
@@ -3,12 +3,29 @@
|
|||||||
<string name="app_name">LedGrab</string>
|
<string name="app_name">LedGrab</string>
|
||||||
<string name="tagline">电视氛围灯光</string>
|
<string name="tagline">电视氛围灯光</string>
|
||||||
<string name="btn_start">开始捕获</string>
|
<string name="btn_start">开始捕获</string>
|
||||||
|
<string name="btn_starting">正在启动…</string>
|
||||||
<string name="btn_stop">停止</string>
|
<string name="btn_stop">停止</string>
|
||||||
<string name="status_running">运行中</string>
|
<string name="status_running">运行中</string>
|
||||||
|
<string name="status_checking_root">正在检查 root 权限…</string>
|
||||||
|
<string name="status_permission_denied">权限被拒绝 — 屏幕捕获需要授权</string>
|
||||||
|
<string name="status_no_network">无网络 — 请连接 Wi-Fi 或以太网</string>
|
||||||
<string name="label_web_ui">Web界面地址</string>
|
<string name="label_web_ui">Web界面地址</string>
|
||||||
<string name="scan_to_configure">扫码配置</string>
|
<string name="scan_to_configure">扫码配置</string>
|
||||||
|
<string name="scan_fallback_hint">或在同一网络的任何设备上访问上方网址</string>
|
||||||
<string name="qr_description">Web界面二维码</string>
|
<string name="qr_description">Web界面二维码</string>
|
||||||
<string name="version_prefix">v%1$s</string>
|
<string name="version_prefix">v%1$s</string>
|
||||||
<string name="autostart_label">开机自启(仅限 root)</string>
|
<string name="autostart_label">开机自启(仅限 root)</string>
|
||||||
<string name="autostart_unavailable">开机自启 — 不可用(需要 root)</string>
|
<string name="autostart_unavailable">开机自启 — 不可用(需要 root)</string>
|
||||||
|
<string name="fatal_title">LedGrab 启动失败</string>
|
||||||
|
<string name="fatal_body_prefix">Python 运行时初始化失败:</string>
|
||||||
|
<string name="fatal_copy_log">复制日志</string>
|
||||||
|
<string name="fatal_show_details">显示详情</string>
|
||||||
|
<string name="fatal_hide_details">隐藏详情</string>
|
||||||
|
<string name="notification_channel_name">LedGrab 屏幕捕获</string>
|
||||||
|
<string name="notification_channel_description">LedGrab 捕获屏幕时显示。</string>
|
||||||
|
<string name="notification_title">LedGrab 运行中</string>
|
||||||
|
<string name="notification_text">Web界面:%1$s</string>
|
||||||
|
<string name="notification_listener_label">LedGrab 通知捕获</string>
|
||||||
|
<string name="btn_grant_notification_access">授予通知访问权限</string>
|
||||||
|
<string name="btn_grant_usage_access">授予使用情况访问权限</string>
|
||||||
</resources>
|
</resources>
|
||||||
|
|||||||
@@ -3,12 +3,29 @@
|
|||||||
<string name="app_name">LedGrab</string>
|
<string name="app_name">LedGrab</string>
|
||||||
<string name="tagline">Ambient lighting for your TV</string>
|
<string name="tagline">Ambient lighting for your TV</string>
|
||||||
<string name="btn_start">Start Capture</string>
|
<string name="btn_start">Start Capture</string>
|
||||||
|
<string name="btn_starting">Starting…</string>
|
||||||
<string name="btn_stop">Stop</string>
|
<string name="btn_stop">Stop</string>
|
||||||
<string name="status_running">Running</string>
|
<string name="status_running">Running</string>
|
||||||
|
<string name="status_checking_root">Checking root access…</string>
|
||||||
|
<string name="status_permission_denied">Permission denied — screen capture requires authorization</string>
|
||||||
|
<string name="status_no_network">No network — connect Wi-Fi or Ethernet</string>
|
||||||
<string name="label_web_ui">Web UI address</string>
|
<string name="label_web_ui">Web UI address</string>
|
||||||
<string name="scan_to_configure">Scan to configure</string>
|
<string name="scan_to_configure">Scan to configure</string>
|
||||||
|
<string name="scan_fallback_hint">or visit the URL above on any device on this network</string>
|
||||||
<string name="qr_description">QR code for web UI</string>
|
<string name="qr_description">QR code for web UI</string>
|
||||||
<string name="version_prefix">v%1$s</string>
|
<string name="version_prefix">v%1$s</string>
|
||||||
<string name="autostart_label">Start on boot (root only)</string>
|
<string name="autostart_label">Start on boot (root only)</string>
|
||||||
<string name="autostart_unavailable">Start on boot — unavailable (root required)</string>
|
<string name="autostart_unavailable">Start on boot — unavailable (root required)</string>
|
||||||
|
<string name="fatal_title">LedGrab failed to start</string>
|
||||||
|
<string name="fatal_body_prefix">Python runtime initialization failed:</string>
|
||||||
|
<string name="fatal_copy_log">Copy log</string>
|
||||||
|
<string name="fatal_show_details">Show details</string>
|
||||||
|
<string name="fatal_hide_details">Hide details</string>
|
||||||
|
<string name="notification_channel_name">LedGrab capture</string>
|
||||||
|
<string name="notification_channel_description">Shows while LedGrab is capturing the screen.</string>
|
||||||
|
<string name="notification_title">LedGrab Running</string>
|
||||||
|
<string name="notification_text">Web UI: %1$s</string>
|
||||||
|
<string name="notification_listener_label">LedGrab notification capture</string>
|
||||||
|
<string name="btn_grant_notification_access">Grant notification access</string>
|
||||||
|
<string name="btn_grant_usage_access">Grant usage access</string>
|
||||||
</resources>
|
</resources>
|
||||||
|
|||||||
@@ -12,6 +12,16 @@
|
|||||||
<item name="android:colorControlActivated">@color/teal_accent</item>
|
<item name="android:colorControlActivated">@color/teal_accent</item>
|
||||||
</style>
|
</style>
|
||||||
|
|
||||||
|
<!-- Splash screen theme. Compatible across API levels via the
|
||||||
|
androidx.core:core-splashscreen library. On API 31+ the system
|
||||||
|
splash uses the foreground icon; on older versions the launch
|
||||||
|
theme just paints the navy background, which is harmless. -->
|
||||||
|
<style name="Theme.LedGrab.Splash" parent="Theme.SplashScreen">
|
||||||
|
<item name="windowSplashScreenBackground">@color/bg_navy</item>
|
||||||
|
<item name="windowSplashScreenAnimatedIcon">@drawable/ic_splash</item>
|
||||||
|
<item name="postSplashScreenTheme">@style/Theme.LedGrab</item>
|
||||||
|
</style>
|
||||||
|
|
||||||
<style name="Widget.LedGrab.Button.Primary" parent="@android:style/Widget.Button">
|
<style name="Widget.LedGrab.Button.Primary" parent="@android:style/Widget.Button">
|
||||||
<item name="android:background">@drawable/bg_button_primary</item>
|
<item name="android:background">@drawable/bg_button_primary</item>
|
||||||
<item name="android:textColor">@color/bg_navy</item>
|
<item name="android:textColor">@color/bg_navy</item>
|
||||||
|
|||||||
@@ -1,8 +1,28 @@
|
|||||||
<?xml version="1.0" encoding="utf-8"?>
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
<!--
|
<!--
|
||||||
LedGrab communicates with WLED controllers, Home Assistant, and MQTT
|
LedGrab is a LAN-only app:
|
||||||
brokers on the local network via plain HTTP/UDP. Cleartext traffic
|
- Inbound: web UI / API on the device (HTTP, port 8080)
|
||||||
must be allowed for these connections to work on Android 9+.
|
- Outbound: WLED HTTP/UDP, Home Assistant, MQTT brokers, mDNS
|
||||||
|
|
||||||
|
All of these are plaintext on the local network. Android's network
|
||||||
|
security config doesn't support CIDR allowlists, so we cannot
|
||||||
|
restrict cleartext to RFC1918 ranges declaratively — we have to
|
||||||
|
permit cleartext base-wide.
|
||||||
|
|
||||||
|
Defence-in-depth that ACTUALLY mitigates this:
|
||||||
|
1. Inbound: the FastAPI server in this app rejects non-loopback
|
||||||
|
requests when no API key is configured (see ledgrab.api.auth).
|
||||||
|
The Android launcher auto-generates an API key on first run
|
||||||
|
(see ApiKeyManager.kt) and injects it via the
|
||||||
|
LEDGRAB_AUTH__API_KEYS env var before uvicorn starts. The
|
||||||
|
user's phone receives the key by scanning the QR, which
|
||||||
|
embeds the key as a URL fragment (never logged server-side).
|
||||||
|
2. Outbound: targets are validated by net_classify in the Python
|
||||||
|
layer (LAN-only HTTP, SSRF-safe).
|
||||||
|
|
||||||
|
DO NOT remove the cleartext permission without first migrating
|
||||||
|
every LAN peer to HTTPS — most WLED firmware, mDNS, and the LAN
|
||||||
|
HTTP server itself rely on this flag.
|
||||||
-->
|
-->
|
||||||
<network-security-config>
|
<network-security-config>
|
||||||
<base-config cleartextTrafficPermitted="true" />
|
<base-config cleartextTrafficPermitted="true" />
|
||||||
|
|||||||
@@ -1,16 +1,18 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
#
|
#
|
||||||
# Cross-compile pydantic-core for Android across all three ABIs:
|
# Cross-compile pydantic-core for Android across all supported ABIs:
|
||||||
# arm64-v8a (primary — real TV hardware)
|
# arm64-v8a (primary — modern TV hardware)
|
||||||
# x86_64 (modern emulators)
|
# x86_64 (modern emulators)
|
||||||
# x86 (legacy emulators)
|
# x86 (legacy emulators)
|
||||||
|
# armeabi-v7a (32-bit ARMv7 — older cheap TV boxes like X96 mini, MeCool)
|
||||||
#
|
#
|
||||||
# Outputs wheels into android/wheels/. Wheels are linked against the real
|
# Outputs wheels into android/wheels/. Wheels are linked against the real
|
||||||
# libpython3.11.so shipped by Chaquopy (stub .so does NOT work — see
|
# libpython3.11.so shipped by Chaquopy (stub .so does NOT work — see
|
||||||
# memory/project_android_app.md for the incident notes).
|
# memory/project_android_app.md for the incident notes).
|
||||||
#
|
#
|
||||||
# Prerequisites (on host):
|
# Prerequisites (on host):
|
||||||
# - Rust + cargo (rustup) with targets: aarch64/x86_64/i686-linux-android
|
# - Rust + cargo (rustup) with targets:
|
||||||
|
# aarch64/x86_64/i686/armv7a-linux-android(eabi)
|
||||||
# - Android NDK (ANDROID_NDK_HOME, or installed at Sdk/ndk/*)
|
# - Android NDK (ANDROID_NDK_HOME, or installed at Sdk/ndk/*)
|
||||||
# - Python 3.11 (matches Chaquopy's embedded version)
|
# - Python 3.11 (matches Chaquopy's embedded version)
|
||||||
# - maturin (pip install maturin)
|
# - maturin (pip install maturin)
|
||||||
@@ -19,9 +21,10 @@
|
|||||||
# core dependency version changes.
|
# core dependency version changes.
|
||||||
#
|
#
|
||||||
# Usage:
|
# Usage:
|
||||||
# ./build-pydantic-core.sh # build all three ABIs
|
# ./build-pydantic-core.sh # build all 4 ABIs
|
||||||
# ./build-pydantic-core.sh arm64 # build a single ABI
|
# ./build-pydantic-core.sh arm64 # build a single ABI
|
||||||
# ./build-pydantic-core.sh arm64 x86_64 # build a subset
|
# ./build-pydantic-core.sh arm64 x86_64 # build a subset
|
||||||
|
# ./build-pydantic-core.sh armv7 # 32-bit ARM only
|
||||||
#
|
#
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
|
|
||||||
@@ -91,21 +94,23 @@ fi
|
|||||||
# ── ABI table ───────────────────────────────────────────────────────
|
# ── ABI table ───────────────────────────────────────────────────────
|
||||||
# Columns: short_name rust_target clang_prefix sysconfig_dir
|
# Columns: short_name rust_target clang_prefix sysconfig_dir
|
||||||
ABI_TABLE=(
|
ABI_TABLE=(
|
||||||
"arm64 aarch64-linux-android aarch64-linux-android${API_LEVEL} cross-sysconfig"
|
"arm64 aarch64-linux-android aarch64-linux-android${API_LEVEL} cross-sysconfig"
|
||||||
"x86_64 x86_64-linux-android x86_64-linux-android${API_LEVEL} cross-sysconfig-x86_64"
|
"x86_64 x86_64-linux-android x86_64-linux-android${API_LEVEL} cross-sysconfig-x86_64"
|
||||||
"x86 i686-linux-android i686-linux-android${API_LEVEL} cross-sysconfig-x86"
|
"x86 i686-linux-android i686-linux-android${API_LEVEL} cross-sysconfig-x86"
|
||||||
|
"armv7 armv7-linux-androideabi armv7a-linux-androideabi${API_LEVEL} cross-sysconfig-armv7"
|
||||||
)
|
)
|
||||||
|
|
||||||
declare -A ABI_TAG_MAP=(
|
declare -A ABI_TAG_MAP=(
|
||||||
[arm64]="arm64_v8a"
|
[arm64]="arm64_v8a"
|
||||||
[x86_64]="x86_64"
|
[x86_64]="x86_64"
|
||||||
[x86]="x86"
|
[x86]="x86"
|
||||||
|
[armv7]="armeabi_v7a"
|
||||||
)
|
)
|
||||||
|
|
||||||
# ── Select which ABIs to build ──────────────────────────────────────
|
# ── Select which ABIs to build ──────────────────────────────────────
|
||||||
SELECTED=("$@")
|
SELECTED=("$@")
|
||||||
if [ ${#SELECTED[@]} -eq 0 ]; then
|
if [ ${#SELECTED[@]} -eq 0 ]; then
|
||||||
SELECTED=(arm64 x86_64 x86)
|
SELECTED=(arm64 x86_64 x86 armv7)
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# ── Ensure rust targets are installed ───────────────────────────────
|
# ── Ensure rust targets are installed ───────────────────────────────
|
||||||
|
|||||||
@@ -0,0 +1,327 @@
|
|||||||
|
"""Generate LedGrab app icon assets.
|
||||||
|
|
||||||
|
Concept: "Spectrum Aperture" — a rounded-square frame (the screen/display)
|
||||||
|
traced by a continuous RGB color-wheel stroke (the bias-light LED strip),
|
||||||
|
on a near-black canvas with a soft chromatic bloom behind it.
|
||||||
|
|
||||||
|
Outputs:
|
||||||
|
server/src/ledgrab/static/icons/icon-512.png (standard, opaque vignette bg)
|
||||||
|
server/src/ledgrab/static/icons/icon-192.png (downscale of 512)
|
||||||
|
server/src/ledgrab/static/icons/icon-512-maskable.png (safe-area padded, opaque)
|
||||||
|
server/src/ledgrab/static/icons/icon-tray.png (256, transparent bg, frame + glow)
|
||||||
|
server/src/ledgrab/static/icons/icon.ico (16/24/32/48/64/128/256)
|
||||||
|
|
||||||
|
Run from repo root:
|
||||||
|
py -3.13 build/generate_icon.py
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import colorsys
|
||||||
|
import math
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from PIL import Image, ImageDraw, ImageFilter
|
||||||
|
|
||||||
|
# ── Tunables ────────────────────────────────────────────────────────────
|
||||||
|
SUPERSAMPLE = 4 # render at 4x and downsample for crispness
|
||||||
|
BASE = 1024 # logical canvas size
|
||||||
|
HQ = BASE * SUPERSAMPLE # render canvas
|
||||||
|
|
||||||
|
BG_TOP = (12, 14, 22) # near-black, faint cool tint
|
||||||
|
BG_BOTTOM = (6, 7, 12) # darker at edges (vignette feel)
|
||||||
|
|
||||||
|
FRAME_INSET = 0.18 # margin from canvas edge to frame (fraction)
|
||||||
|
FRAME_RADIUS = 0.22 # corner radius (fraction of frame side)
|
||||||
|
FRAME_STROKE = 0.085 # stroke width (fraction of canvas)
|
||||||
|
BLOOM_OPACITY = 0.62 # outer bloom strength (0–1)
|
||||||
|
INNER_GLOW_OPACITY = 0.38 # inner chromatic reflection strength
|
||||||
|
|
||||||
|
# Hue rotation offset so red sits at the top
|
||||||
|
HUE_OFFSET = -90.0 # degrees (negative = counter-clockwise shift)
|
||||||
|
|
||||||
|
|
||||||
|
def lerp(a: float, b: float, t: float) -> float:
|
||||||
|
return a + (b - a) * t
|
||||||
|
|
||||||
|
|
||||||
|
def hue_to_rgb(hue_deg: float) -> tuple[int, int, int]:
|
||||||
|
"""Bright, slightly desaturated spectral color (LED-like)."""
|
||||||
|
h = (hue_deg % 360) / 360.0
|
||||||
|
r, g, b = colorsys.hls_to_rgb(h, 0.58, 0.92)
|
||||||
|
return int(r * 255), int(g * 255), int(b * 255)
|
||||||
|
|
||||||
|
|
||||||
|
def vignette_background(size: int) -> Image.Image:
|
||||||
|
"""Dark canvas with a soft radial vignette + faint scanline noise."""
|
||||||
|
img = Image.new("RGB", (size, size), BG_TOP)
|
||||||
|
px = img.load()
|
||||||
|
cx, cy = size / 2, size / 2
|
||||||
|
max_r = math.hypot(cx, cy)
|
||||||
|
for y in range(size):
|
||||||
|
for x in range(size):
|
||||||
|
d = math.hypot(x - cx, y - cy) / max_r
|
||||||
|
t = min(1.0, d**1.6)
|
||||||
|
px[x, y] = (
|
||||||
|
int(lerp(BG_TOP[0], BG_BOTTOM[0], t)),
|
||||||
|
int(lerp(BG_TOP[1], BG_BOTTOM[1], t)),
|
||||||
|
int(lerp(BG_TOP[2], BG_BOTTOM[2], t)),
|
||||||
|
)
|
||||||
|
return img
|
||||||
|
|
||||||
|
|
||||||
|
def draw_chromatic_bloom(size: int) -> Image.Image:
|
||||||
|
"""Soft, large chromatic glow behind the frame — the bias-light effect."""
|
||||||
|
layer = Image.new("RGBA", (size, size), (0, 0, 0, 0))
|
||||||
|
draw = ImageDraw.Draw(layer)
|
||||||
|
|
||||||
|
cx, cy = size / 2, size / 2
|
||||||
|
radius = size * 0.36
|
||||||
|
blob_r = int(size * 0.30)
|
||||||
|
n_blobs = 24
|
||||||
|
|
||||||
|
for i in range(n_blobs):
|
||||||
|
a = i / n_blobs * 360.0
|
||||||
|
bx = cx + math.cos(math.radians(a - 90)) * radius
|
||||||
|
by = cy + math.sin(math.radians(a - 90)) * radius
|
||||||
|
r, g, b = hue_to_rgb(a + HUE_OFFSET)
|
||||||
|
alpha = int(255 * BLOOM_OPACITY * 0.55)
|
||||||
|
draw.ellipse(
|
||||||
|
(bx - blob_r, by - blob_r, bx + blob_r, by + blob_r),
|
||||||
|
fill=(r, g, b, alpha),
|
||||||
|
)
|
||||||
|
|
||||||
|
# Heavy blur → continuous, dreamy halo
|
||||||
|
layer = layer.filter(ImageFilter.GaussianBlur(radius=size * 0.10))
|
||||||
|
return layer
|
||||||
|
|
||||||
|
|
||||||
|
def rounded_rect_mask(size: int, inset: int, radius: int, stroke: int) -> Image.Image:
|
||||||
|
"""L-mode mask of a rounded-rect ring (the frame stroke region)."""
|
||||||
|
mask = Image.new("L", (size, size), 0)
|
||||||
|
draw = ImageDraw.Draw(mask)
|
||||||
|
box_outer = (inset, inset, size - inset, size - inset)
|
||||||
|
box_inner = (
|
||||||
|
inset + stroke,
|
||||||
|
inset + stroke,
|
||||||
|
size - inset - stroke,
|
||||||
|
size - inset - stroke,
|
||||||
|
)
|
||||||
|
r_outer = radius
|
||||||
|
r_inner = max(0, radius - stroke)
|
||||||
|
draw.rounded_rectangle(box_outer, radius=r_outer, fill=255)
|
||||||
|
draw.rounded_rectangle(box_inner, radius=r_inner, fill=0)
|
||||||
|
return mask
|
||||||
|
|
||||||
|
|
||||||
|
def draw_spectrum_frame(size: int) -> Image.Image:
|
||||||
|
"""Draw the rounded-square frame stroke filled with a hue-rotation gradient.
|
||||||
|
|
||||||
|
Strategy: paint a full-canvas angular hue gradient (centered), then
|
||||||
|
clip it with the rounded-ring mask. This guarantees a continuous,
|
||||||
|
seam-free color flow around the entire frame.
|
||||||
|
"""
|
||||||
|
cx, cy = size / 2, size / 2
|
||||||
|
|
||||||
|
gradient = Image.new("RGB", (size, size), (0, 0, 0))
|
||||||
|
gpx = gradient.load()
|
||||||
|
for y in range(size):
|
||||||
|
dy = y - cy
|
||||||
|
for x in range(size):
|
||||||
|
dx = x - cx
|
||||||
|
ang = math.degrees(math.atan2(dy, dx)) + 90.0 # 0° = top
|
||||||
|
r, g, b = hue_to_rgb(ang + HUE_OFFSET)
|
||||||
|
gpx[x, y] = (r, g, b)
|
||||||
|
|
||||||
|
inset = int(size * FRAME_INSET)
|
||||||
|
frame_side = size - 2 * inset
|
||||||
|
stroke = int(size * FRAME_STROKE)
|
||||||
|
radius = int(frame_side * FRAME_RADIUS)
|
||||||
|
|
||||||
|
mask = rounded_rect_mask(size, inset, radius, stroke)
|
||||||
|
|
||||||
|
out = Image.new("RGBA", (size, size), (0, 0, 0, 0))
|
||||||
|
out.paste(gradient, (0, 0), mask)
|
||||||
|
return out
|
||||||
|
|
||||||
|
|
||||||
|
def draw_inner_screen(size: int) -> Image.Image:
|
||||||
|
"""Subtle dark rounded square inside the frame, with faint chromatic
|
||||||
|
inner reflection along the edges — like a screen catching ambient light."""
|
||||||
|
inset = int(size * FRAME_INSET)
|
||||||
|
stroke = int(size * FRAME_STROKE)
|
||||||
|
frame_side = size - 2 * inset
|
||||||
|
radius = int(frame_side * FRAME_RADIUS)
|
||||||
|
|
||||||
|
pad = int(stroke * 0.35)
|
||||||
|
box = (
|
||||||
|
inset + stroke + pad,
|
||||||
|
inset + stroke + pad,
|
||||||
|
size - inset - stroke - pad,
|
||||||
|
size - inset - stroke - pad,
|
||||||
|
)
|
||||||
|
r_inner = max(0, radius - stroke - pad)
|
||||||
|
|
||||||
|
layer = Image.new("RGBA", (size, size), (0, 0, 0, 0))
|
||||||
|
draw = ImageDraw.Draw(layer)
|
||||||
|
# Dark fill, very slight cool tint
|
||||||
|
draw.rounded_rectangle(box, radius=r_inner, fill=(10, 12, 18, 255))
|
||||||
|
|
||||||
|
# Inner chromatic glow: same spectrum, very soft, clipped to the screen
|
||||||
|
bloom = draw_chromatic_bloom(size)
|
||||||
|
screen_mask = Image.new("L", (size, size), 0)
|
||||||
|
ImageDraw.Draw(screen_mask).rounded_rectangle(box, radius=r_inner, fill=255)
|
||||||
|
|
||||||
|
bloom_alpha = bloom.split()[-1].point(lambda v: int(v * INNER_GLOW_OPACITY))
|
||||||
|
bloom.putalpha(bloom_alpha)
|
||||||
|
|
||||||
|
masked_bloom = Image.new("RGBA", (size, size), (0, 0, 0, 0))
|
||||||
|
masked_bloom.paste(bloom, (0, 0), screen_mask)
|
||||||
|
layer.alpha_composite(masked_bloom)
|
||||||
|
|
||||||
|
# Faint highlight glint top-left
|
||||||
|
glint = Image.new("RGBA", (size, size), (0, 0, 0, 0))
|
||||||
|
gdraw = ImageDraw.Draw(glint)
|
||||||
|
glint_box = (
|
||||||
|
box[0] + int(frame_side * 0.04),
|
||||||
|
box[1] + int(frame_side * 0.04),
|
||||||
|
box[0] + int(frame_side * 0.42),
|
||||||
|
box[1] + int(frame_side * 0.18),
|
||||||
|
)
|
||||||
|
gdraw.rounded_rectangle(glint_box, radius=int(frame_side * 0.05), fill=(255, 255, 255, 22))
|
||||||
|
glint = glint.filter(ImageFilter.GaussianBlur(radius=size * 0.012))
|
||||||
|
masked_glint = Image.new("RGBA", (size, size), (0, 0, 0, 0))
|
||||||
|
masked_glint.paste(glint, (0, 0), screen_mask)
|
||||||
|
layer.alpha_composite(masked_glint)
|
||||||
|
|
||||||
|
return layer
|
||||||
|
|
||||||
|
|
||||||
|
def add_outer_frame_glow(frame_rgba: Image.Image) -> Image.Image:
|
||||||
|
"""Take the spectrum frame and produce a blurred, brightened copy for glow."""
|
||||||
|
glow = frame_rgba.copy()
|
||||||
|
# Slightly inflate brightness for glow
|
||||||
|
r, g, b, a = glow.split()
|
||||||
|
glow = Image.merge("RGBA", (r, g, b, a.point(lambda v: min(255, int(v * 0.85)))))
|
||||||
|
glow = glow.filter(ImageFilter.GaussianBlur(radius=glow.width * 0.025))
|
||||||
|
return glow
|
||||||
|
|
||||||
|
|
||||||
|
def render_tray(size: int) -> Image.Image:
|
||||||
|
"""Render a tray-optimised icon: transparent background, bolder frame,
|
||||||
|
tight outer glow. Designed to read clearly at 16–32 px on top of any
|
||||||
|
taskbar color."""
|
||||||
|
hq = size * SUPERSAMPLE
|
||||||
|
|
||||||
|
# Pull the frame inward a touch and beef up the stroke so it reads at 16 px.
|
||||||
|
global FRAME_INSET, FRAME_STROKE
|
||||||
|
saved_inset, saved_stroke = FRAME_INSET, FRAME_STROKE
|
||||||
|
FRAME_INSET = 0.13
|
||||||
|
FRAME_STROKE = 0.115
|
||||||
|
try:
|
||||||
|
frame = draw_spectrum_frame(hq)
|
||||||
|
finally:
|
||||||
|
FRAME_INSET, FRAME_STROKE = saved_inset, saved_stroke
|
||||||
|
|
||||||
|
# Tight, bright glow that doesn't bleed past the tray cell.
|
||||||
|
glow = frame.copy()
|
||||||
|
r, g, b, a = glow.split()
|
||||||
|
glow = Image.merge("RGBA", (r, g, b, a.point(lambda v: min(255, int(v * 0.95)))))
|
||||||
|
glow = glow.filter(ImageFilter.GaussianBlur(radius=hq * 0.012))
|
||||||
|
|
||||||
|
canvas = Image.new("RGBA", (hq, hq), (0, 0, 0, 0))
|
||||||
|
canvas.alpha_composite(glow)
|
||||||
|
canvas.alpha_composite(frame)
|
||||||
|
|
||||||
|
return canvas.resize((size, size), Image.LANCZOS)
|
||||||
|
|
||||||
|
|
||||||
|
def render(size: int, *, maskable: bool = False) -> Image.Image:
|
||||||
|
"""Render the full icon at the given size."""
|
||||||
|
hq = size * SUPERSAMPLE
|
||||||
|
|
||||||
|
if maskable:
|
||||||
|
# Maskable: pad inward so the entire icon survives a circular crop.
|
||||||
|
# We render the standard composition at 80% of canvas size, centered.
|
||||||
|
bg = Image.new("RGB", (hq, hq), BG_BOTTOM).convert("RGBA")
|
||||||
|
bg.paste(vignette_background(hq), (0, 0))
|
||||||
|
|
||||||
|
inner = render(size, maskable=False).resize((int(hq * 0.78), int(hq * 0.78)), Image.LANCZOS)
|
||||||
|
# Strip the bg from the inner render: composite the spectrum
|
||||||
|
# parts on top of our maskable background.
|
||||||
|
ox = (hq - inner.width) // 2
|
||||||
|
oy = (hq - inner.height) // 2
|
||||||
|
bg.alpha_composite(inner, (ox, oy))
|
||||||
|
return bg.resize((size, size), Image.LANCZOS)
|
||||||
|
|
||||||
|
bg = vignette_background(hq).convert("RGBA")
|
||||||
|
bloom = draw_chromatic_bloom(hq)
|
||||||
|
frame = draw_spectrum_frame(hq)
|
||||||
|
frame_glow = add_outer_frame_glow(frame)
|
||||||
|
inner_screen = draw_inner_screen(hq)
|
||||||
|
|
||||||
|
# Composite order: bg → bloom → frame_glow → inner_screen → frame
|
||||||
|
canvas = Image.new("RGBA", (hq, hq), (0, 0, 0, 0))
|
||||||
|
canvas.alpha_composite(bg)
|
||||||
|
canvas.alpha_composite(bloom)
|
||||||
|
canvas.alpha_composite(frame_glow)
|
||||||
|
canvas.alpha_composite(inner_screen)
|
||||||
|
canvas.alpha_composite(frame)
|
||||||
|
|
||||||
|
return canvas.resize((size, size), Image.LANCZOS)
|
||||||
|
|
||||||
|
|
||||||
|
def main() -> None:
|
||||||
|
repo_root = Path(__file__).resolve().parent.parent
|
||||||
|
targets = [
|
||||||
|
repo_root / "server" / "src" / "ledgrab" / "static" / "icons",
|
||||||
|
repo_root
|
||||||
|
/ "android"
|
||||||
|
/ "app"
|
||||||
|
/ "build"
|
||||||
|
/ "python"
|
||||||
|
/ "sources"
|
||||||
|
/ "debug"
|
||||||
|
/ "ledgrab"
|
||||||
|
/ "static"
|
||||||
|
/ "icons",
|
||||||
|
]
|
||||||
|
|
||||||
|
print("Rendering 1024 master...")
|
||||||
|
master = render(1024, maskable=False)
|
||||||
|
|
||||||
|
print("Rendering maskable 1024 master...")
|
||||||
|
maskable_master = render(1024, maskable=True)
|
||||||
|
|
||||||
|
print("Rendering tray 512 master (transparent bg)...")
|
||||||
|
tray_master = render_tray(512)
|
||||||
|
|
||||||
|
for icons_dir in targets:
|
||||||
|
if not icons_dir.exists():
|
||||||
|
print(f" skip (missing): {icons_dir}")
|
||||||
|
continue
|
||||||
|
|
||||||
|
out_512 = icons_dir / "icon-512.png"
|
||||||
|
out_192 = icons_dir / "icon-192.png"
|
||||||
|
out_mask = icons_dir / "icon-512-maskable.png"
|
||||||
|
out_tray = icons_dir / "icon-tray.png"
|
||||||
|
out_ico = icons_dir / "icon.ico"
|
||||||
|
|
||||||
|
master.resize((512, 512), Image.LANCZOS).save(out_512, "PNG", optimize=True)
|
||||||
|
master.resize((192, 192), Image.LANCZOS).save(out_192, "PNG", optimize=True)
|
||||||
|
maskable_master.resize((512, 512), Image.LANCZOS).save(out_mask, "PNG", optimize=True)
|
||||||
|
tray_master.save(out_tray, "PNG", optimize=True)
|
||||||
|
|
||||||
|
# Pre-resize each frame from the 1024 master for maximum crispness.
|
||||||
|
# Pass them via the `sizes` arg so Pillow embeds every variant.
|
||||||
|
ico_sizes = [(16, 16), (24, 24), (32, 32), (48, 48), (64, 64), (128, 128), (256, 256)]
|
||||||
|
# Use the tray (transparent-bg) variant for ICO frames so the file/
|
||||||
|
# taskbar icon doesn't show a dark tile against light backgrounds.
|
||||||
|
ico_source = tray_master.resize((256, 256), Image.LANCZOS)
|
||||||
|
ico_source.save(out_ico, format="ICO", sizes=ico_sizes)
|
||||||
|
|
||||||
|
print(f" wrote: {icons_dir}")
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
+7
-3
@@ -56,9 +56,10 @@ SetCompressor /SOLID lzma
|
|||||||
; ── Functions ─────────────────────────────────────────────
|
; ── Functions ─────────────────────────────────────────────
|
||||||
|
|
||||||
Function LaunchApp
|
Function LaunchApp
|
||||||
|
; Only launch the app — do NOT open the browser here. A manual launch (no
|
||||||
|
; --autostart) makes the app open the WebUI itself once /health responds,
|
||||||
|
; so opening the URL here too made the page appear twice.
|
||||||
ExecShell "open" "wscript.exe" '"$INSTDIR\scripts\${VBSNAME}"'
|
ExecShell "open" "wscript.exe" '"$INSTDIR\scripts\${VBSNAME}"'
|
||||||
Sleep 2000
|
|
||||||
ExecShell "open" "http://localhost:8080/"
|
|
||||||
FunctionEnd
|
FunctionEnd
|
||||||
|
|
||||||
; Detect running instance before install (file lock check on python.exe)
|
; Detect running instance before install (file lock check on python.exe)
|
||||||
@@ -162,8 +163,11 @@ Section "Desktop shortcut" SecDesktop
|
|||||||
SectionEnd
|
SectionEnd
|
||||||
|
|
||||||
Section "Start with Windows" SecAutostart
|
Section "Start with Windows" SecAutostart
|
||||||
|
; Pass --autostart so the VBS sets LEDGRAB_AUTOSTART=1 and the app suppresses
|
||||||
|
; the browser auto-open on Windows login. Manual launches (desktop / start
|
||||||
|
; menu) don't pass the arg, so they keep opening the WebUI tab.
|
||||||
CreateShortcut "$SMSTARTUP\${APPNAME}.lnk" \
|
CreateShortcut "$SMSTARTUP\${APPNAME}.lnk" \
|
||||||
"wscript.exe" '"$INSTDIR\scripts\${VBSNAME}"' \
|
"wscript.exe" '"$INSTDIR\scripts\${VBSNAME}" --autostart' \
|
||||||
"$INSTDIR\app\src\ledgrab\static\icons\icon.ico" 0
|
"$INSTDIR\app\src\ledgrab\static\icons\icon.ico" 0
|
||||||
SectionEnd
|
SectionEnd
|
||||||
|
|
||||||
|
|||||||
+605
-289
@@ -1,335 +1,651 @@
|
|||||||
# LedGrab API Documentation
|
# LedGrab API Reference
|
||||||
|
|
||||||
Complete REST API reference for the LedGrab server.
|
Complete REST + WebSocket API reference for the LedGrab server.
|
||||||
|
|
||||||
**Base URL:** `http://localhost:8080`
|
- **Base URL:** `http://localhost:8080`
|
||||||
**API Version:** v1
|
- **API version:** `v1` (all REST paths are under `/api/v1`, except `/health`)
|
||||||
|
- **Interactive docs:** Swagger UI at [`/docs`](http://localhost:8080/docs), ReDoc at [`/redoc`](http://localhost:8080/redoc), raw schema at [`/openapi.json`](http://localhost:8080/openapi.json). The interactive docs are always the authoritative, up-to-date source for request/response schemas — this file is a hand-maintained overview.
|
||||||
|
|
||||||
|
> The application version is reported by `GET /api/v1/version`; this document is version-agnostic.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
- [Health & Info](#health--info)
|
- [Authentication](#authentication)
|
||||||
- [Device Management](#device-management)
|
- [Conventions](#conventions)
|
||||||
- [Processing Control](#processing-control)
|
- [WebSocket protocol](#websocket-protocol)
|
||||||
- [Settings Management](#settings-management)
|
- [Worked examples](#worked-examples)
|
||||||
- [Calibration](#calibration)
|
- **Endpoint reference**
|
||||||
- [Metrics](#metrics)
|
- [Health & system info](#health--system-info)
|
||||||
|
- [System settings](#system-settings)
|
||||||
|
- [User preferences](#user-preferences)
|
||||||
|
- [Backup, restore & server control](#backup-restore--server-control)
|
||||||
|
- [Updates](#updates)
|
||||||
|
- [Snapshot](#snapshot)
|
||||||
|
- [Devices](#devices)
|
||||||
|
- [Capture templates, engines & filters](#capture-templates-engines--filters)
|
||||||
|
- [Picture sources](#picture-sources)
|
||||||
|
- [Post-processing templates](#post-processing-templates)
|
||||||
|
- [Output targets](#output-targets)
|
||||||
|
- [Output target control & live preview](#output-target-control--live-preview)
|
||||||
|
- [Color strip sources](#color-strip-sources)
|
||||||
|
- [Color strip processing templates](#color-strip-processing-templates)
|
||||||
|
- [Pattern templates](#pattern-templates)
|
||||||
|
- [Gradients](#gradients)
|
||||||
|
- [Audio devices](#audio-devices)
|
||||||
|
- [Audio sources](#audio-sources)
|
||||||
|
- [Audio templates & engines](#audio-templates--engines)
|
||||||
|
- [Audio processing templates](#audio-processing-templates)
|
||||||
|
- [Audio filters](#audio-filters)
|
||||||
|
- [Value sources](#value-sources)
|
||||||
|
- [Weather sources](#weather-sources)
|
||||||
|
- [Automations](#automations)
|
||||||
|
- [Scene presets](#scene-presets)
|
||||||
|
- [Sync clocks](#sync-clocks)
|
||||||
|
- [Webhooks](#webhooks)
|
||||||
|
- [HTTP endpoints](#http-endpoints)
|
||||||
|
- [Game integration](#game-integration)
|
||||||
|
- [Home Assistant](#home-assistant)
|
||||||
|
- [MQTT sources](#mqtt-sources)
|
||||||
|
- [Assets](#assets)
|
||||||
|
- [Graph wiring](#graph-wiring)
|
||||||
|
- [Web UI & PWA](#web-ui--pwa)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Health & Info
|
## Authentication
|
||||||
|
|
||||||
### GET /health
|
LedGrab uses API-key authentication. The behavior depends on whether any keys are configured under `auth.api_keys` (see [INSTALLATION.md](../INSTALLATION.md)):
|
||||||
|
|
||||||
Health check endpoint.
|
| Situation | Loopback (`127.0.0.1` / `::1` / `localhost`) | LAN / remote |
|
||||||
|
| --------- | -------------------------------------------- | ------------ |
|
||||||
|
| **No keys configured** (default) | Allowed anonymously | **Rejected with `401`** |
|
||||||
|
| **Keys configured** | Valid Bearer token required | Valid Bearer token required |
|
||||||
|
|
||||||
|
Pass the key as a Bearer token:
|
||||||
|
|
||||||
|
```http
|
||||||
|
Authorization: Bearer <your-api-key>
|
||||||
|
```
|
||||||
|
|
||||||
|
A few **sensitive endpoints require a real API key even from localhost** (they reject the loopback-anonymous identity): the backup download/restore endpoints, and any endpoint that reveals stored secrets (e.g. `GET /api/v1/home-assistant/sources?include_secrets=true`). Configure a key to use those.
|
||||||
|
|
||||||
|
WebSocket endpoints authenticate with a [first-message handshake](#websocket-protocol) rather than the `Authorization` header.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
- **Content type:** request and response bodies are JSON (`application/json`) unless noted (file uploads use `multipart/form-data`; some endpoints stream binary or file responses).
|
||||||
|
- **Errors:** failures return the standard FastAPI shape with an HTTP status code and a body of `{"detail": "<message>"}`. Validation errors return `422` with a structured `detail` array.
|
||||||
|
- **IDs:** entities are addressed by string IDs (e.g. `dev_…`, `ot_…`, `css_…`) generated on creation.
|
||||||
|
- **Common create/update fields:** most configurable entities accept `name`, `description`, `tags` (string array), and UI styling fields `icon` and `icon_color`.
|
||||||
|
- **Referential integrity:** deleting an entity that is still referenced (e.g. a device used by an output target) returns `409 Conflict`.
|
||||||
|
- **Timestamps:** ISO-8601 UTC strings.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## WebSocket protocol
|
||||||
|
|
||||||
|
All WebSocket endpoints share the same auth handshake:
|
||||||
|
|
||||||
|
1. The client connects. The server accepts the socket.
|
||||||
|
2. The client sends a JSON auth message as the **first** message, within ~3 seconds: `{"type": "auth", "token": "<your-api-key>"}`. On loopback with no keys configured, `token` may be `null` or the message omitted.
|
||||||
|
3. The server replies `{"type": "auth_ok"}` on success, or `{"type": "auth_error", "reason": "..."}` then closes (close code `4401`) on failure. A cross-site `Origin` is rejected with close code `4403`.
|
||||||
|
|
||||||
|
Browser clients must connect from an allowed `cors_origins` origin. After `auth_ok`, the stream payload depends on the endpoint (JSON event objects, JSON spectrum/metric frames, or binary RGB frames — see each endpoint's description).
|
||||||
|
|
||||||
|
The WebSocket endpoints are listed within their resource sections below (method `WS`).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Worked examples
|
||||||
|
|
||||||
|
> Example values are illustrative.
|
||||||
|
|
||||||
|
**Health check** — `GET /health` (no auth on loopback):
|
||||||
|
|
||||||
**Response:**
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"status": "healthy",
|
"status": "healthy",
|
||||||
"timestamp": "2026-02-06T12:00:00Z",
|
"timestamp": "2026-05-29T12:00:00Z",
|
||||||
"version": "0.1.0"
|
"version": "0.8.1",
|
||||||
|
"demo_mode": false,
|
||||||
|
"auth_required": false,
|
||||||
|
"setup_required": false,
|
||||||
|
"uptime_seconds": 3600
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### GET /api/v1/version
|
**Create a WLED device** — `POST /api/v1/devices`:
|
||||||
|
|
||||||
Get version information.
|
|
||||||
|
|
||||||
**Response:**
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"version": "0.1.0",
|
|
||||||
"python_version": "3.11.0",
|
|
||||||
"api_version": "v1"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### GET /api/v1/config/displays
|
|
||||||
|
|
||||||
List available displays for screen capture.
|
|
||||||
|
|
||||||
**Response:**
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"displays": [
|
|
||||||
{
|
|
||||||
"index": 0,
|
|
||||||
"name": "Display 1",
|
|
||||||
"width": 1920,
|
|
||||||
"height": 1080,
|
|
||||||
"is_primary": true
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"count": 1
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Device Management
|
|
||||||
|
|
||||||
### POST /api/v1/devices
|
|
||||||
|
|
||||||
Create and attach a new WLED device.
|
|
||||||
|
|
||||||
**Request:**
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"name": "Living Room TV",
|
"name": "Living Room TV",
|
||||||
"url": "http://192.168.1.100",
|
"url": "http://192.168.1.100",
|
||||||
|
"device_type": "wled",
|
||||||
"led_count": 150
|
"led_count": 150
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
**Response:** `201 Created`
|
Response `201 Created` returns the stored device, including its generated `id`. (For Adalight, send `device_type: "adalight"`, the serial `url` like `COM3` or `/dev/ttyUSB0`, `led_count`, and `baud_rate`. Each device type accepts its own fields — see `/docs`.)
|
||||||
|
|
||||||
|
**Start / stop a target** — `POST /api/v1/output-targets/{target_id}/start`:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{ "status": "started", "target_id": "ot_abc123" }
|
||||||
"id": "device_abc123",
|
|
||||||
"name": "Living Room TV",
|
|
||||||
"url": "http://192.168.1.100",
|
|
||||||
"led_count": 150,
|
|
||||||
"enabled": true,
|
|
||||||
"status": "disconnected",
|
|
||||||
"settings": {
|
|
||||||
"display_index": 0,
|
|
||||||
"fps": 30,
|
|
||||||
"border_width": 10
|
|
||||||
},
|
|
||||||
"calibration": {
|
|
||||||
"layout": "clockwise",
|
|
||||||
"start_position": "bottom_left",
|
|
||||||
"segments": [...]
|
|
||||||
},
|
|
||||||
"created_at": "2026-02-06T12:00:00Z",
|
|
||||||
"updated_at": "2026-02-06T12:00:00Z"
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### GET /api/v1/devices
|
**Authenticated request with a configured key:**
|
||||||
|
|
||||||
List all attached devices.
|
```bash
|
||||||
|
curl -H "Authorization: Bearer your-api-key" \
|
||||||
**Response:**
|
http://localhost:8080/api/v1/devices
|
||||||
```json
|
|
||||||
{
|
|
||||||
"devices": [...],
|
|
||||||
"count": 2
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### GET /api/v1/devices/{device_id}
|
|
||||||
|
|
||||||
Get device details.
|
|
||||||
|
|
||||||
**Response:** Same as POST response
|
|
||||||
|
|
||||||
### PUT /api/v1/devices/{device_id}
|
|
||||||
|
|
||||||
Update device information.
|
|
||||||
|
|
||||||
**Request:**
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"name": "Updated Name",
|
|
||||||
"enabled": true
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### DELETE /api/v1/devices/{device_id}
|
|
||||||
|
|
||||||
Delete/detach a device.
|
|
||||||
|
|
||||||
**Response:** `204 No Content`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Processing Control
|
|
||||||
|
|
||||||
### POST /api/v1/devices/{device_id}/start
|
|
||||||
|
|
||||||
Start screen processing for a device.
|
|
||||||
|
|
||||||
**Response:**
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"status": "started",
|
|
||||||
"device_id": "device_abc123"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### POST /api/v1/devices/{device_id}/stop
|
|
||||||
|
|
||||||
Stop screen processing.
|
|
||||||
|
|
||||||
**Response:**
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"status": "stopped",
|
|
||||||
"device_id": "device_abc123"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### GET /api/v1/devices/{device_id}/state
|
|
||||||
|
|
||||||
Get current processing state.
|
|
||||||
|
|
||||||
**Response:**
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"device_id": "device_abc123",
|
|
||||||
"processing": true,
|
|
||||||
"fps_actual": 29.8,
|
|
||||||
"fps_target": 30,
|
|
||||||
"display_index": 0,
|
|
||||||
"last_update": "2026-02-06T12:00:00Z",
|
|
||||||
"errors": []
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Settings Management
|
## Endpoint reference
|
||||||
|
|
||||||
### GET /api/v1/devices/{device_id}/settings
|
## Health & system info
|
||||||
|
|
||||||
Get processing settings.
|
Health checks, version information, displays, system metrics, and integration status.
|
||||||
|
|
||||||
**Response:**
|
| Method | Path | Description |
|
||||||
```json
|
| ------ | ---- | ----------- |
|
||||||
{
|
| GET | `/health` | Service health: status, version, uptime, and whether auth/setup is required. |
|
||||||
"display_index": 0,
|
| GET | `/api/v1/version` | Application version, Python version, and API version. |
|
||||||
"fps": 30,
|
| GET | `/api/v1/tags` | All tags used across every entity in the system. |
|
||||||
"brightness": 1.0,
|
| GET | `/api/v1/config/displays` | Available displays/monitors for screen capture (optional `engine_type` query, e.g. `scrcpy`). |
|
||||||
"smoothing": 0.3,
|
| GET | `/api/v1/system/processes` | Running process names, for use in automation conditions. |
|
||||||
"interpolation_mode": "average",
|
| GET | `/api/v1/system/performance` | Current CPU, RAM, and GPU utilization metrics. |
|
||||||
"standby_interval": 1.0,
|
| GET | `/api/v1/system/metrics-history` | Last ~2 minutes of system and per-target metrics for dashboard charts. |
|
||||||
"state_check_interval": 30
|
| GET | `/api/v1/system/api-keys` | API-key labels with masked values (read-only; keys live in YAML config). |
|
||||||
}
|
| GET | `/api/v1/system/integrations-status` | Connection status for MQTT and Home Assistant integrations. |
|
||||||
```
|
|
||||||
|
|
||||||
### PUT /api/v1/devices/{device_id}/settings
|
## System settings
|
||||||
|
|
||||||
Update processing settings.
|
Server configuration: MQTT broker, external URL, shutdown action, log level, ADB connection, and live log streaming.
|
||||||
|
|
||||||
**Request:**
|
| Method | Path | Description |
|
||||||
```json
|
| ------ | ---- | ----------- |
|
||||||
{
|
| GET | `/api/v1/system/mqtt/settings` | Current MQTT broker settings (password masked). |
|
||||||
"display_index": 1,
|
| PUT | `/api/v1/system/mqtt/settings` | Update MQTT broker settings (empty password preserves existing). |
|
||||||
"fps": 60,
|
| GET | `/api/v1/system/external-url` | Configured external base URL. |
|
||||||
"brightness": 0.8
|
| PUT | `/api/v1/system/external-url` | Set the external base URL for webhooks and user-visible links. |
|
||||||
}
|
| GET | `/api/v1/system/shutdown-action` | Configured server shutdown action (`stop_targets` or `nothing`). |
|
||||||
```
|
| PUT | `/api/v1/system/shutdown-action` | Set what happens to targets when the server shuts down. |
|
||||||
|
| WS | `/api/v1/system/logs/ws` | Live server log stream with a buffered backlog. |
|
||||||
|
| POST | `/api/v1/adb/connect` | Connect to a Wi-Fi ADB device by IP (auto-appends `:5555`). |
|
||||||
|
| POST | `/api/v1/adb/disconnect` | Disconnect a Wi-Fi ADB device. |
|
||||||
|
| GET | `/api/v1/system/log-level` | Current root logger level. |
|
||||||
|
| PUT | `/api/v1/system/log-level` | Change the log level at runtime without restart. |
|
||||||
|
|
||||||
|
## User preferences
|
||||||
|
|
||||||
|
Dashboard layout, notification settings, card display modes, and the global daylight timezone.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| GET | `/api/v1/preferences/dashboard-layout` | Read the saved dashboard layout (empty when unset). |
|
||||||
|
| PUT | `/api/v1/preferences/dashboard-layout` | Save the dashboard layout (opaque versioned JSON blob). |
|
||||||
|
| DELETE | `/api/v1/preferences/dashboard-layout` | Delete the saved layout; revert to default. |
|
||||||
|
| GET | `/api/v1/preferences/notifications` | Read notification preferences (server defaults when unset). |
|
||||||
|
| PUT | `/api/v1/preferences/notifications` | Persist notification preferences (channels, discovery, grace/debounce). |
|
||||||
|
| GET | `/api/v1/preferences/card-modes` | Read per-surface card-mode preferences. |
|
||||||
|
| PUT | `/api/v1/preferences/card-modes` | Save per-surface card modes (comfortable/compact/dense/row). |
|
||||||
|
| DELETE | `/api/v1/preferences/card-modes` | Delete card-mode preferences; revert to defaults. |
|
||||||
|
| GET | `/api/v1/preferences/daylight-timezone` | Read the global IANA timezone for daylight cycles. |
|
||||||
|
| PUT | `/api/v1/preferences/daylight-timezone` | Persist the daylight-cycle timezone (empty = server local). |
|
||||||
|
|
||||||
|
## Backup, restore & server control
|
||||||
|
|
||||||
|
Database backup/restore, server restart/shutdown, and auto-backup management.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| GET | `/api/v1/system/backup` | Download a full backup `.zip` (database + assets). 🔒 requires a key. |
|
||||||
|
| POST | `/api/v1/system/restore` | Upload a `.db`/`.zip` backup to restore config and trigger a restart. 🔒 requires a key. |
|
||||||
|
| POST | `/api/v1/system/restart` | Schedule a server restart and return immediately. |
|
||||||
|
| POST | `/api/v1/system/shutdown` | Gracefully shut down the server. |
|
||||||
|
| GET | `/api/v1/system/auto-backup/settings` | Auto-backup settings and status (enabled, interval, retention, last/next). |
|
||||||
|
| PUT | `/api/v1/system/auto-backup/settings` | Update auto-backup settings. |
|
||||||
|
| POST | `/api/v1/system/auto-backup/trigger` | Trigger a backup now and return its metadata. |
|
||||||
|
| GET | `/api/v1/system/backups` | List saved auto-backup files. |
|
||||||
|
| GET | `/api/v1/system/backups/{filename}` | Download a specific saved backup file. |
|
||||||
|
| DELETE | `/api/v1/system/backups/{filename}` | Delete a specific saved backup file. |
|
||||||
|
|
||||||
|
> 🔒 = requires a real API key even from localhost (rejects loopback-anonymous access).
|
||||||
|
|
||||||
|
## Updates
|
||||||
|
|
||||||
|
Auto-update management: check, apply, dismiss, and configure.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| GET | `/api/v1/system/update/status` | Current update status (available version, install type, capability). |
|
||||||
|
| POST | `/api/v1/system/update/check` | Trigger an immediate update check. |
|
||||||
|
| POST | `/api/v1/system/update/dismiss` | Dismiss the notification for a specific version. |
|
||||||
|
| POST | `/api/v1/system/update/apply` | Download and apply the available update, then shut down. |
|
||||||
|
| GET | `/api/v1/system/update/settings` | Update settings (enabled, interval, include prereleases). |
|
||||||
|
| PUT | `/api/v1/system/update/settings` | Change auto-update settings. |
|
||||||
|
|
||||||
|
## Snapshot
|
||||||
|
|
||||||
|
A single aggregated poll endpoint for low-overhead clients.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| GET | `/api/v1/snapshot` | Full poll payload (targets, states, metrics, devices, brightness, color/value sources, scene presets, sync clocks, system) in one response. Use `?include=` to request a subset; per-section fault isolation. |
|
||||||
|
|
||||||
|
## Devices
|
||||||
|
|
||||||
|
LED device CRUD, pairing, discovery, health checks, brightness/power control, and the WS pixel stream.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| POST | `/api/v1/devices` | Create/attach a new LED device (validates connectivity). |
|
||||||
|
| POST | `/api/v1/devices/pair` | Run a pairing handshake before creating a device. |
|
||||||
|
| GET | `/api/v1/devices` | List all attached devices. |
|
||||||
|
| GET | `/api/v1/devices/discover` | Scan the network for devices (optional `timeout`, `device_type`). |
|
||||||
|
| GET | `/api/v1/devices/openrgb-zones` | List zones on an OpenRGB device (`url` query). |
|
||||||
|
| GET | `/api/v1/devices/batch/states` | Health/connection state for all devices at once. |
|
||||||
|
| GET | `/api/v1/devices/{device_id}` | Get a device by ID. |
|
||||||
|
| PUT | `/api/v1/devices/{device_id}` | Update device configuration. |
|
||||||
|
| DELETE | `/api/v1/devices/{device_id}` | Delete/detach a device (`409` if referenced). |
|
||||||
|
| GET | `/api/v1/devices/{device_id}/state` | Get device health/connection state. |
|
||||||
|
| POST | `/api/v1/devices/{device_id}/ping` | Force an immediate health check. |
|
||||||
|
| GET | `/api/v1/devices/{device_id}/brightness` | Get current (cached) brightness. |
|
||||||
|
| PUT | `/api/v1/devices/{device_id}/brightness` | Set brightness (`0–255`). |
|
||||||
|
| GET | `/api/v1/devices/{device_id}/power` | Get current power state. |
|
||||||
|
| PUT | `/api/v1/devices/{device_id}/power` | Turn the device on or off. |
|
||||||
|
| WS | `/api/v1/devices/{device_id}/ws` | Pixel stream for `ws` device type (`[brightness][R G B …]`). |
|
||||||
|
|
||||||
|
## Capture templates, engines & filters
|
||||||
|
|
||||||
|
Capture template CRUD/testing, capture engine discovery, and post-processing filter discovery.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| GET | `/api/v1/capture-templates` | List all capture templates. |
|
||||||
|
| POST | `/api/v1/capture-templates` | Create a capture template. |
|
||||||
|
| GET | `/api/v1/capture-templates/{template_id}` | Get a capture template by ID. |
|
||||||
|
| PUT | `/api/v1/capture-templates/{template_id}` | Update a capture template (partial). |
|
||||||
|
| DELETE | `/api/v1/capture-templates/{template_id}` | Delete a template (`409` if used by streams). |
|
||||||
|
| GET | `/api/v1/capture-engines` | List capture engines with platform availability. |
|
||||||
|
| POST | `/api/v1/capture-templates/test` | Test a capture config; returns FPS metrics + preview. |
|
||||||
|
| WS | `/api/v1/capture-templates/test/ws` | Real-time capture test with intermediate frame previews. |
|
||||||
|
| GET | `/api/v1/filters` | List post-processing filter types and option schemas. |
|
||||||
|
| GET | `/api/v1/strip-filters` | List filter types that support 1D LED-strip processing. |
|
||||||
|
|
||||||
|
## Picture sources
|
||||||
|
|
||||||
|
Screen captures, static images, video files, and processed streams used for color extraction.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| GET | `/api/v1/picture-sources` | List all picture sources. |
|
||||||
|
| POST | `/api/v1/picture-sources/validate-image` | Validate an image source and return a preview thumbnail. |
|
||||||
|
| GET | `/api/v1/picture-sources/full-image` | Serve a full-resolution image for lightbox preview (`source` query). |
|
||||||
|
| POST | `/api/v1/picture-sources` | Create a picture source (`raw`/`processed`/`static`/`video`). |
|
||||||
|
| GET | `/api/v1/picture-sources/{stream_id}` | Get a picture source by ID. |
|
||||||
|
| PUT | `/api/v1/picture-sources/{stream_id}` | Update a picture source. |
|
||||||
|
| DELETE | `/api/v1/picture-sources/{stream_id}` | Delete a picture source (`409` if referenced). |
|
||||||
|
| GET | `/api/v1/picture-sources/{stream_id}/thumbnail` | Thumbnail (first frame) for a video source. |
|
||||||
|
| POST | `/api/v1/picture-sources/{stream_id}/test` | Resolve the chain and run a capture test. |
|
||||||
|
| WS | `/api/v1/picture-sources/{stream_id}/test/ws` | Test stream with intermediate frame previews. |
|
||||||
|
|
||||||
|
## Post-processing templates
|
||||||
|
|
||||||
|
Reusable filter chains applied to picture sources.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| GET | `/api/v1/postprocessing-templates` | List all post-processing templates. |
|
||||||
|
| POST | `/api/v1/postprocessing-templates` | Create a template (name + filter list). |
|
||||||
|
| GET | `/api/v1/postprocessing-templates/{template_id}` | Get a template by ID. |
|
||||||
|
| PUT | `/api/v1/postprocessing-templates/{template_id}` | Update a template (partial). |
|
||||||
|
| DELETE | `/api/v1/postprocessing-templates/{template_id}` | Delete a template (`409` if referenced). |
|
||||||
|
| POST | `/api/v1/postprocessing-templates/{template_id}/test` | Capture from a source and apply the filters. |
|
||||||
|
| WS | `/api/v1/postprocessing-templates/{template_id}/test/ws` | Real-time test with intermediate frame previews. |
|
||||||
|
|
||||||
|
## Output targets
|
||||||
|
|
||||||
|
LED strips, Home Assistant light groups, and Zigbee2MQTT bulb groups.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| POST | `/api/v1/output-targets` | Create a target (`led` / `ha_light` / `z2m_light`). |
|
||||||
|
| GET | `/api/v1/output-targets` | List all output targets. |
|
||||||
|
| GET | `/api/v1/output-targets/batch/states` | Processing state for all targets at once. |
|
||||||
|
| GET | `/api/v1/output-targets/batch/metrics` | Metrics for all targets at once. |
|
||||||
|
| GET | `/api/v1/output-targets/{target_id}` | Get a single target. |
|
||||||
|
| PUT | `/api/v1/output-targets/{target_id}` | Update a target (partial, per type). |
|
||||||
|
| DELETE | `/api/v1/output-targets/{target_id}` | Delete a target (stops processing first). |
|
||||||
|
|
||||||
|
## Output target control & live preview
|
||||||
|
|
||||||
|
Start/stop processing, state & metrics, the calibration overlay, the global event stream, and live color/LED preview WebSockets.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| POST | `/api/v1/output-targets/bulk/start` | Start processing for multiple targets. |
|
||||||
|
| POST | `/api/v1/output-targets/bulk/stop` | Stop processing for multiple targets. |
|
||||||
|
| POST | `/api/v1/output-targets/{target_id}/start` | Start processing for one target. |
|
||||||
|
| POST | `/api/v1/output-targets/{target_id}/stop` | Stop processing for one target. |
|
||||||
|
| GET | `/api/v1/output-targets/{target_id}/state` | Current processing state (FPS, timing, device, errors). |
|
||||||
|
| GET | `/api/v1/output-targets/{target_id}/metrics` | Processing metrics (uptime, frames, error count). |
|
||||||
|
| WS | `/api/v1/events/ws` | Real-time state-change events across all targets. |
|
||||||
|
| POST | `/api/v1/output-targets/{target_id}/overlay/start` | Start the on-screen sampling/LED overlay. |
|
||||||
|
| POST | `/api/v1/output-targets/{target_id}/overlay/stop` | Stop the overlay. |
|
||||||
|
| GET | `/api/v1/output-targets/{target_id}/overlay/status` | Whether the overlay is active. |
|
||||||
|
| POST | `/api/v1/output-targets/{target_id}/ha-light/turn-off` | Turn off all HA light entities for the target. |
|
||||||
|
| WS | `/api/v1/output-targets/{target_id}/ha-light/ws` | Live HA light color preview. |
|
||||||
|
| POST | `/api/v1/output-targets/{target_id}/z2m-light/turn-off` | Publish OFF to all Zigbee2MQTT bulbs for the target. |
|
||||||
|
| WS | `/api/v1/output-targets/{target_id}/z2m-light/ws` | Live Zigbee2MQTT bulb color preview. |
|
||||||
|
| WS | `/api/v1/output-targets/{target_id}/led-preview/ws` | Live LED-strip preview (binary RGB frames). |
|
||||||
|
|
||||||
|
## Color strip sources
|
||||||
|
|
||||||
|
CRUD, calibration, raw color push, notifications, and preview streaming for color strip sources.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| GET | `/api/v1/color-strip-sources` | List all color strip sources. |
|
||||||
|
| POST | `/api/v1/color-strip-sources` | Create a color strip source (by `source_type`). |
|
||||||
|
| GET | `/api/v1/color-strip-sources/{source_id}` | Get a color strip source by ID. |
|
||||||
|
| PUT | `/api/v1/color-strip-sources/{source_id}` | Update a source; hot-reloads running streams. |
|
||||||
|
| DELETE | `/api/v1/color-strip-sources/{source_id}` | Delete a source (`409` if referenced). |
|
||||||
|
| POST | `/api/v1/color-strip-sources/{source_id}/overlay/start` | Start the screen overlay (picture-type, calibrated). |
|
||||||
|
| POST | `/api/v1/color-strip-sources/{source_id}/overlay/stop` | Stop the screen overlay. |
|
||||||
|
| GET | `/api/v1/color-strip-sources/{source_id}/overlay/status` | Whether the overlay is active. |
|
||||||
|
| POST | `/api/v1/color-strip-sources/{source_id}/colors` | Push raw LED colors to an `api_input` source. |
|
||||||
|
| POST | `/api/v1/color-strip-sources/{source_id}/notify` | Trigger a one-shot notification effect. |
|
||||||
|
| GET | `/api/v1/color-strip-sources/os-notifications/history` | Recent OS-notification capture history. |
|
||||||
|
| PUT | `/api/v1/color-strip-sources/{source_id}/calibration/test` | Light up LED edges to verify calibration. |
|
||||||
|
| POST | `/api/v1/color-strip-sources/{source_id}/key-colors/test` | Test a `key_colors` source (extract colors from rectangles). |
|
||||||
|
| WS | `/api/v1/color-strip-sources/{source_id}/key-colors/test/ws` | Real-time key-colors test preview. |
|
||||||
|
| WS | `/api/v1/color-strip-sources/preview/ws` | Transient ad-hoc source preview stream. |
|
||||||
|
| WS | `/api/v1/color-strip-sources/{source_id}/ws` | Push raw colors to an `api_input` source over WS. |
|
||||||
|
| WS | `/api/v1/color-strip-sources/{source_id}/test/ws` | Real-time source preview (binary RGB, optional JPEG). |
|
||||||
|
|
||||||
|
## Color strip processing templates
|
||||||
|
|
||||||
|
Reusable filter chains applied to color strips (1D LED data).
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| GET | `/api/v1/color-strip-processing-templates` | List all color-strip processing templates. |
|
||||||
|
| POST | `/api/v1/color-strip-processing-templates` | Create a template (name + filter list). |
|
||||||
|
| GET | `/api/v1/color-strip-processing-templates/{template_id}` | Get a template by ID. |
|
||||||
|
| PUT | `/api/v1/color-strip-processing-templates/{template_id}` | Update a template. |
|
||||||
|
| DELETE | `/api/v1/color-strip-processing-templates/{template_id}` | Delete a template (`409` if referenced). |
|
||||||
|
| WS | `/api/v1/color-strip-processing-templates/{template_id}/test/ws` | Real-time preview: apply the filter chain to an input source. |
|
||||||
|
|
||||||
|
## Pattern templates
|
||||||
|
|
||||||
|
Layout templates of named rectangles for LED device configuration.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| GET | `/api/v1/pattern-templates` | List all pattern templates. |
|
||||||
|
| POST | `/api/v1/pattern-templates` | Create a pattern template (named rectangles). |
|
||||||
|
| GET | `/api/v1/pattern-templates/{template_id}` | Get a pattern template by ID. |
|
||||||
|
| PUT | `/api/v1/pattern-templates/{template_id}` | Update a pattern template. |
|
||||||
|
| DELETE | `/api/v1/pattern-templates/{template_id}` | Delete a template (`409` if referenced by targets). |
|
||||||
|
|
||||||
|
## Gradients
|
||||||
|
|
||||||
|
Reusable gradient definitions (color stops). Built-in gradients are read-only but clonable.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| GET | `/api/v1/gradients` | List all gradients (built-in and user-created). |
|
||||||
|
| POST | `/api/v1/gradients` | Create a user-defined gradient. |
|
||||||
|
| GET | `/api/v1/gradients/{gradient_id}` | Get a gradient by ID. |
|
||||||
|
| PUT | `/api/v1/gradients/{gradient_id}` | Update a gradient (built-ins are read-only). |
|
||||||
|
| POST | `/api/v1/gradients/{gradient_id}/clone` | Clone a gradient into a customizable copy. |
|
||||||
|
| DELETE | `/api/v1/gradients/{gradient_id}` | Delete a gradient (`400` if built-in or referenced). |
|
||||||
|
|
||||||
|
## Audio devices
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| GET | `/api/v1/audio-devices` | List audio input/output devices (flat list + per-engine grouping). |
|
||||||
|
|
||||||
|
## Audio sources
|
||||||
|
|
||||||
|
Audio capture and processing sources for audio-reactive effects.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| GET | `/api/v1/audio-sources` | List all audio sources (optional `source_type`). |
|
||||||
|
| POST | `/api/v1/audio-sources` | Create an audio source (`capture` or `processed`). |
|
||||||
|
| GET | `/api/v1/audio-sources/{source_id}` | Get an audio source by ID. |
|
||||||
|
| PUT | `/api/v1/audio-sources/{source_id}` | Update an audio source (partial). |
|
||||||
|
| DELETE | `/api/v1/audio-sources/{source_id}` | Delete an audio source (`409` if referenced). |
|
||||||
|
| WS | `/api/v1/audio-sources/{source_id}/test/ws` | Real-time spectrum/RMS/peak/beat analysis (~20 Hz). |
|
||||||
|
|
||||||
|
## Audio templates & engines
|
||||||
|
|
||||||
|
Audio capture templates and engine discovery.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| GET | `/api/v1/audio-templates` | List all audio capture templates. |
|
||||||
|
| POST | `/api/v1/audio-templates` | Create an audio capture template. |
|
||||||
|
| GET | `/api/v1/audio-templates/{template_id}` | Get an audio template by ID. |
|
||||||
|
| PUT | `/api/v1/audio-templates/{template_id}` | Update an audio template. |
|
||||||
|
| DELETE | `/api/v1/audio-templates/{template_id}` | Delete a template (cascades to audio sources). |
|
||||||
|
| GET | `/api/v1/audio-engines` | List audio capture engines and availability. |
|
||||||
|
| WS | `/api/v1/audio-templates/{template_id}/test/ws` | Real-time spectrum test for a template + device. |
|
||||||
|
|
||||||
|
## Audio processing templates
|
||||||
|
|
||||||
|
Reusable audio filter chains.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| GET | `/api/v1/audio-processing-templates` | List all audio processing templates. |
|
||||||
|
| POST | `/api/v1/audio-processing-templates` | Create a template (name + filter list). |
|
||||||
|
| GET | `/api/v1/audio-processing-templates/{template_id}` | Get a template by ID. |
|
||||||
|
| PUT | `/api/v1/audio-processing-templates/{template_id}` | Update a template (hot-updates running streams). |
|
||||||
|
| DELETE | `/api/v1/audio-processing-templates/{template_id}` | Delete a template (`409` if referenced). |
|
||||||
|
|
||||||
|
## Audio filters
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| GET | `/api/v1/audio-filters` | List audio filter types and their option schemas. |
|
||||||
|
|
||||||
|
## Value sources
|
||||||
|
|
||||||
|
Dynamic data inputs (brightness and other parameters): static, animated, audio, adaptive, color, sensor, HTTP, Home Assistant, and `template` — a sandboxed-Jinja **combinator** that evaluates an expression over the live values of other value sources.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| GET | `/api/v1/value-sources` | List all value sources (optional `source_type`). |
|
||||||
|
| POST | `/api/v1/value-sources` | Create a value source (discriminated by `source_type`). |
|
||||||
|
| POST | `/api/v1/value-sources/validate-template` | Validate a template expression + inputs (advisory; always `200` with `{valid, error, errors, warnings, variables}`). |
|
||||||
|
| GET | `/api/v1/value-sources/{source_id}` | Get a value source by ID. |
|
||||||
|
| PUT | `/api/v1/value-sources/{source_id}` | Update a value source; hot-reloads running streams. |
|
||||||
|
| DELETE | `/api/v1/value-sources/{source_id}` | Delete a value source (`400` if referenced by a target or another value source). |
|
||||||
|
| WS | `/api/v1/value-sources/{source_id}/test/ws` | Real-time value output stream (~20 Hz). |
|
||||||
|
|
||||||
|
### Template value source (`source_type: "template"`)
|
||||||
|
|
||||||
|
A `float` combinator. Fields: `template` (a Jinja *expression*), `inputs` (`[{name, value_source_id}]` bindings to other value sources), `default_value` (fallback in `[0,1]` on any error), and `eval_interval` (optional re-eval throttle in seconds; `0`/null = every poll). At runtime each input is exposed by its `name` (the source's normalized `0..1` value) plus `raw[name]` (its un-normalized value, where available). Globals: `min`, `max`, `abs`, `round`, `clamp(x, lo=0, hi=1)`. The expression runs in a hardened `ImmutableSandboxedEnvironment` (no statements/blocks, filters, attribute access, `**`, or string repetition); results are coerced, NaN/inf-rejected, and clamped to `[0,1]`. Reference cycles and over-deep nesting are rejected at save time. For time-of-day logic, bind an `adaptive_time` or `daylight` source as an input.
|
||||||
|
|
||||||
|
## Weather sources
|
||||||
|
|
||||||
|
Weather data providers feeding weather-driven value sources.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| GET | `/api/v1/weather-sources` | List all weather sources. |
|
||||||
|
| POST | `/api/v1/weather-sources` | Create a weather source (provider, lat/lon, interval). |
|
||||||
|
| GET | `/api/v1/weather-sources/{source_id}` | Get a weather source by ID. |
|
||||||
|
| PUT | `/api/v1/weather-sources/{source_id}` | Update a weather source. |
|
||||||
|
| DELETE | `/api/v1/weather-sources/{source_id}` | Delete a weather source. |
|
||||||
|
| POST | `/api/v1/weather-sources/{source_id}/test` | Force-fetch current weather and return it. |
|
||||||
|
|
||||||
|
## Automations
|
||||||
|
|
||||||
|
Rules that trigger scene presets (time, display state, MQTT, webhooks, Home Assistant, HTTP polling, active window).
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| POST | `/api/v1/automations` | Create an automation (rules + scene preset + deactivation). |
|
||||||
|
| GET | `/api/v1/automations` | List automations with current activity state. |
|
||||||
|
| GET | `/api/v1/automations/{automation_id}` | Get an automation by ID (includes webhook URL if any). |
|
||||||
|
| PUT | `/api/v1/automations/{automation_id}` | Update an automation (partial); re-evaluates if enabled. |
|
||||||
|
| DELETE | `/api/v1/automations/{automation_id}` | Delete and deactivate an automation. |
|
||||||
|
| POST | `/api/v1/automations/{automation_id}/enable` | Enable and immediately evaluate rules. |
|
||||||
|
| POST | `/api/v1/automations/{automation_id}/disable` | Disable and deactivate. |
|
||||||
|
|
||||||
|
## Scene presets
|
||||||
|
|
||||||
|
Captured snapshots of target state that can be restored.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| POST | `/api/v1/scene-presets` | Create a preset by capturing current target state. |
|
||||||
|
| GET | `/api/v1/scene-presets` | List all scene presets. |
|
||||||
|
| GET | `/api/v1/scene-presets/{preset_id}` | Get a scene preset by ID. |
|
||||||
|
| PUT | `/api/v1/scene-presets/{preset_id}` | Update metadata and optionally change targets. |
|
||||||
|
| DELETE | `/api/v1/scene-presets/{preset_id}` | Delete a scene preset. |
|
||||||
|
| POST | `/api/v1/scene-presets/{preset_id}/recapture` | Re-capture current state into the preset. |
|
||||||
|
| POST | `/api/v1/scene-presets/{preset_id}/activate` | Activate the preset (restore captured state). |
|
||||||
|
|
||||||
|
## Sync clocks
|
||||||
|
|
||||||
|
Shared clocks that drive linked animations with configurable speed.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| GET | `/api/v1/sync-clocks` | List all synchronization clocks. |
|
||||||
|
| POST | `/api/v1/sync-clocks` | Create a sync clock. |
|
||||||
|
| GET | `/api/v1/sync-clocks/{clock_id}` | Get a sync clock by ID. |
|
||||||
|
| PUT | `/api/v1/sync-clocks/{clock_id}` | Update a clock (speed changes hot-applied). |
|
||||||
|
| DELETE | `/api/v1/sync-clocks/{clock_id}` | Delete a clock (`409` if referenced). |
|
||||||
|
| POST | `/api/v1/sync-clocks/{clock_id}/pause` | Pause the clock (freeze linked animations). |
|
||||||
|
| POST | `/api/v1/sync-clocks/{clock_id}/resume` | Resume a paused clock. |
|
||||||
|
| POST | `/api/v1/sync-clocks/{clock_id}/reset` | Reset the clock to `t=0`. |
|
||||||
|
|
||||||
|
## Webhooks
|
||||||
|
|
||||||
|
Inbound trigger endpoint for external services.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| POST | `/api/v1/webhooks/{token}` | Trigger an automation by secret token (`activate`/`deactivate`; rate-limited 30/min/IP). |
|
||||||
|
|
||||||
|
## HTTP endpoints
|
||||||
|
|
||||||
|
Outbound HTTP polling endpoints for integrations. 🔒 These require a real API key even on loopback.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| GET | `/api/v1/http/endpoints` | List all HTTP polling endpoints. |
|
||||||
|
| POST | `/api/v1/http/endpoints` | Create an endpoint (URL, method, auth token, headers). |
|
||||||
|
| GET | `/api/v1/http/endpoints/{endpoint_id}` | Get an endpoint by ID. |
|
||||||
|
| PUT | `/api/v1/http/endpoints/{endpoint_id}` | Update an endpoint. |
|
||||||
|
| DELETE | `/api/v1/http/endpoints/{endpoint_id}` | Delete an endpoint. |
|
||||||
|
| POST | `/api/v1/http/endpoints/test` | One-shot test fetch to validate a config before saving. |
|
||||||
|
| POST | `/api/v1/http/endpoints/{endpoint_id}/test` | Test a stored endpoint without re-entering its token. |
|
||||||
|
|
||||||
|
## Game integration
|
||||||
|
|
||||||
|
Game event ingestion, adapter metadata, presets, and diagnostics.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| GET | `/api/v1/game-integrations/presets` | List built-in effect presets. |
|
||||||
|
| GET | `/api/v1/game-integrations` | List all game integration configs. |
|
||||||
|
| POST | `/api/v1/game-integrations` | Create a game integration config. |
|
||||||
|
| GET | `/api/v1/game-integrations/{integration_id}` | Get a config by ID. |
|
||||||
|
| PUT | `/api/v1/game-integrations/{integration_id}` | Update a config. |
|
||||||
|
| DELETE | `/api/v1/game-integrations/{integration_id}` | Delete a config. |
|
||||||
|
| POST | `/api/v1/game-integrations/{integration_id}/event` | Ingest a game event (adapter-level auth; 16–64 Hz). |
|
||||||
|
| GET | `/api/v1/game-integrations/{integration_id}/status` | Runtime status (connected state, event counts). |
|
||||||
|
| GET | `/api/v1/game-integrations/{integration_id}/events` | Recent events for debugging (`limit`). |
|
||||||
|
| GET | `/api/v1/game-adapters` | List adapter types and supported events. |
|
||||||
|
| POST | `/api/v1/game-integrations/{integration_id}/apply-preset` | Apply a built-in preset (optionally replacing mappings). |
|
||||||
|
| POST | `/api/v1/game-integrations/{integration_id}/auto-setup` | Write game config files and generate an auth token. |
|
||||||
|
|
||||||
|
## Home Assistant
|
||||||
|
|
||||||
|
Home Assistant WebSocket sources, entity discovery, and live status.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| GET | `/api/v1/home-assistant/sources` | List HA sources with status and entity counts (`?include_secrets=true` 🔒). |
|
||||||
|
| POST | `/api/v1/home-assistant/sources` | Create an HA source (host, long-lived token, filters). |
|
||||||
|
| GET | `/api/v1/home-assistant/sources/{source_id}` | Get an HA source (`?include_secrets=true` 🔒). |
|
||||||
|
| PUT | `/api/v1/home-assistant/sources/{source_id}` | Update an HA source; refreshes the connection. |
|
||||||
|
| DELETE | `/api/v1/home-assistant/sources/{source_id}` | Delete an HA source and release its runtime. |
|
||||||
|
| GET | `/api/v1/home-assistant/sources/{source_id}/entities` | List available HA entities (live + cache fallback). |
|
||||||
|
| POST | `/api/v1/home-assistant/sources/{source_id}/test` | Test connection/auth and report HA version. |
|
||||||
|
| GET | `/api/v1/home-assistant/status` | Overall HA integration status per source. |
|
||||||
|
|
||||||
|
## MQTT sources
|
||||||
|
|
||||||
|
MQTT broker connections (sources) and status monitoring.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| GET | `/api/v1/mqtt/sources` | List MQTT sources with connection status. |
|
||||||
|
| POST | `/api/v1/mqtt/sources` | Create an MQTT source (broker connection). |
|
||||||
|
| GET | `/api/v1/mqtt/sources/{source_id}` | Get an MQTT source by ID. |
|
||||||
|
| PUT | `/api/v1/mqtt/sources/{source_id}` | Update a source; restarts the broker runtime. |
|
||||||
|
| DELETE | `/api/v1/mqtt/sources/{source_id}` | Delete a source and release its runtime. |
|
||||||
|
| POST | `/api/v1/mqtt/sources/{source_id}/test` | Test connection to the broker (10s timeout). |
|
||||||
|
| GET | `/api/v1/mqtt/status` | Overall MQTT integration status per source. |
|
||||||
|
|
||||||
|
## Assets
|
||||||
|
|
||||||
|
Media files (sounds, images, videos) used by effects and notifications.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| GET | `/api/v1/assets` | List assets (optional `asset_type` filter). |
|
||||||
|
| GET | `/api/v1/assets/{asset_id}` | Get asset metadata by ID. |
|
||||||
|
| POST | `/api/v1/assets` | Upload a new asset file (`multipart/form-data`). |
|
||||||
|
| PUT | `/api/v1/assets/{asset_id}` | Update asset metadata. |
|
||||||
|
| DELETE | `/api/v1/assets/{asset_id}` | Delete an asset (prebuilt assets are soft-deleted/restorable). |
|
||||||
|
| GET | `/api/v1/assets/{asset_id}/file` | Serve the asset file (download). |
|
||||||
|
| POST | `/api/v1/assets/restore-prebuilt` | Re-import any deleted prebuilt assets. |
|
||||||
|
|
||||||
|
## Graph wiring
|
||||||
|
|
||||||
|
The wiring-graph: schema registry, topology, dependents, validation, and subgraph duplication.
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| GET | `/api/v1/graph/schema` | Registry of connectable reference fields. |
|
||||||
|
| GET | `/api/v1/graph` | Full wiring topology (nodes + edges) and validation report. |
|
||||||
|
| GET | `/api/v1/graph/dependents/{kind}/{entity_id}` | Every entity that references `(kind, entity_id)`. |
|
||||||
|
| POST | `/api/v1/graph/validate-connection` | Validate a proposed wiring edit (existence, kind, no cycle). |
|
||||||
|
| POST | `/api/v1/graph/duplicate` | Deep-clone selected value/color-strip sources with remapped wiring. |
|
||||||
|
|
||||||
|
## Web UI & PWA
|
||||||
|
|
||||||
|
App-level routes served by FastAPI (not under `/api/v1`).
|
||||||
|
|
||||||
|
| Method | Path | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| GET | `/` | The web dashboard UI. |
|
||||||
|
| GET | `/manifest.json` | PWA manifest (root scope). |
|
||||||
|
| GET | `/sw.js` | Service worker (root scope). |
|
||||||
|
| GET | `/openapi.json` | OpenAPI schema. |
|
||||||
|
| GET | `/docs` | Swagger UI (interactive API docs). |
|
||||||
|
| GET | `/redoc` | ReDoc API reference. |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Calibration
|
## Next steps
|
||||||
|
|
||||||
### GET /api/v1/devices/{device_id}/calibration
|
- [Installation Guide](../INSTALLATION.md)
|
||||||
|
- [Calibration Guide](CALIBRATION.md)
|
||||||
Get calibration configuration.
|
- Interactive, always-current schemas: [`/docs`](http://localhost:8080/docs)
|
||||||
|
|
||||||
**Response:**
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"layout": "clockwise",
|
|
||||||
"start_position": "bottom_left",
|
|
||||||
"segments": [
|
|
||||||
{
|
|
||||||
"edge": "bottom",
|
|
||||||
"led_start": 0,
|
|
||||||
"led_count": 40,
|
|
||||||
"reverse": false
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"edge": "right",
|
|
||||||
"led_start": 40,
|
|
||||||
"led_count": 30,
|
|
||||||
"reverse": false
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"edge": "top",
|
|
||||||
"led_start": 70,
|
|
||||||
"led_count": 40,
|
|
||||||
"reverse": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"edge": "left",
|
|
||||||
"led_start": 110,
|
|
||||||
"led_count": 40,
|
|
||||||
"reverse": true
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### PUT /api/v1/devices/{device_id}/calibration
|
|
||||||
|
|
||||||
Update calibration.
|
|
||||||
|
|
||||||
**Request:** Same as GET response
|
|
||||||
|
|
||||||
### POST /api/v1/devices/{device_id}/calibration/test
|
|
||||||
|
|
||||||
Test calibration by lighting up specific edge.
|
|
||||||
|
|
||||||
**Query Parameters:**
|
|
||||||
- `edge`: Edge to test (top, right, bottom, left)
|
|
||||||
- `color`: RGB color array (e.g., [255, 0, 0])
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Metrics
|
|
||||||
|
|
||||||
### GET /api/v1/devices/{device_id}/metrics
|
|
||||||
|
|
||||||
Get detailed processing metrics.
|
|
||||||
|
|
||||||
**Response:**
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"device_id": "device_abc123",
|
|
||||||
"processing": true,
|
|
||||||
"fps_actual": 29.8,
|
|
||||||
"fps_target": 30,
|
|
||||||
"uptime_seconds": 3600.5,
|
|
||||||
"frames_processed": 107415,
|
|
||||||
"errors_count": 2,
|
|
||||||
"last_error": null,
|
|
||||||
"last_update": "2026-02-06T12:00:00Z"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Error Responses
|
|
||||||
|
|
||||||
All endpoints may return error responses in this format:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"error": "ErrorType",
|
|
||||||
"message": "Human-readable error message",
|
|
||||||
"detail": {...},
|
|
||||||
"timestamp": "2026-02-06T12:00:00Z"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Common HTTP Status Codes:**
|
|
||||||
- `200 OK` - Success
|
|
||||||
- `201 Created` - Resource created
|
|
||||||
- `204 No Content` - Success with no response body
|
|
||||||
- `400 Bad Request` - Invalid request
|
|
||||||
- `404 Not Found` - Resource not found
|
|
||||||
- `500 Internal Server Error` - Server error
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Interactive Documentation
|
|
||||||
|
|
||||||
The server provides interactive API documentation:
|
|
||||||
|
|
||||||
- **Swagger UI:** http://localhost:8080/docs
|
|
||||||
- **ReDoc:** http://localhost:8080/redoc
|
|
||||||
- **OpenAPI JSON:** http://localhost:8080/openapi.json
|
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -1,274 +0,0 @@
|
|||||||
# Refactor Plan: Per-Provider Typed Device Configs
|
|
||||||
|
|
||||||
**Status:** Planned, not started.
|
|
||||||
**Target branch:** `refactor/device-typed-configs`
|
|
||||||
**Intended executor:** Sonnet agent (one phase per invocation; human review between phases).
|
|
||||||
|
|
||||||
## Goal
|
|
||||||
|
|
||||||
Replace the flat [`DeviceInfo`](../../server/src/ledgrab/core/processing/target_processor.py) dataclass (and the `**kwargs`-based `LEDDeviceProvider.create_client(url, **kwargs)` contract) with a **discriminated union of per-provider config dataclasses**. Each provider owns its config type and reads typed fields instead of guessing kwargs.
|
|
||||||
|
|
||||||
## Motivation
|
|
||||||
|
|
||||||
Current pain points:
|
|
||||||
|
|
||||||
- [server/src/ledgrab/core/processing/wled_target_processor.py](../../server/src/ledgrab/core/processing/wled_target_processor.py) unpacks ~21 fields by hand into `create_led_client(**kwargs)`.
|
|
||||||
- Every provider's `create_client` starts with `kwargs.get("x", default)` — no type safety, no IDE hints, no way to know at a glance which fields a provider actually uses.
|
|
||||||
- Adding a new per-device-type field requires threading it through `Device` → `DeviceInfo` → `_DEVICE_FIELD_DEFAULTS` → call-site unpacking → kwargs bag → provider.
|
|
||||||
- Fields leak across device types (a WLED device carries `ble_govee_key=""` at runtime for no reason).
|
|
||||||
|
|
||||||
## Scope guardrails
|
|
||||||
|
|
||||||
- **Storage schema (SQLite) unchanged.** Columns stay, dead-for-this-type fields stay, no destructive migration.
|
|
||||||
- **Frontend HTML/TS unchanged in phases 1-4.** It already branches on `device_type` with show/hide logic. Frontend changes are deferred to Phase 5.
|
|
||||||
- **API schemas are last.** Phase 5 converts `DeviceCreate`/`DeviceUpdate`/`DeviceResponse` to a Pydantic v2 discriminated union. This is the only breaking external change and can be deferred indefinitely if needed.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 1 — Config hierarchy (foundation, non-breaking)
|
|
||||||
|
|
||||||
### Create
|
|
||||||
|
|
||||||
**File:** `server/src/ledgrab/core/devices/device_config.py`
|
|
||||||
|
|
||||||
Pattern:
|
|
||||||
|
|
||||||
```python
|
|
||||||
from dataclasses import dataclass
|
|
||||||
from typing import List, Literal, Optional, Union
|
|
||||||
|
|
||||||
@dataclass(frozen=True)
|
|
||||||
class BaseDeviceConfig:
|
|
||||||
device_id: str
|
|
||||||
device_url: str
|
|
||||||
led_count: int
|
|
||||||
software_brightness: int = 255
|
|
||||||
test_mode_active: bool = False
|
|
||||||
auto_shutdown: bool = False
|
|
||||||
rgbw: bool = False
|
|
||||||
|
|
||||||
@dataclass(frozen=True)
|
|
||||||
class WLEDConfig(BaseDeviceConfig):
|
|
||||||
device_type: Literal["wled"] = "wled"
|
|
||||||
use_ddp: bool = False
|
|
||||||
|
|
||||||
# ... one @dataclass(frozen=True) per provider
|
|
||||||
```
|
|
||||||
|
|
||||||
### Config field inventory
|
|
||||||
|
|
||||||
Base: `device_id`, `device_url`, `led_count`, `software_brightness`, `test_mode_active`, `auto_shutdown`, `rgbw`.
|
|
||||||
|
|
||||||
| Config | Extra fields beyond Base |
|
|
||||||
| -------------- | ------------------------ |
|
|
||||||
| WLEDConfig | `use_ddp: bool = False` |
|
|
||||||
| AdalightConfig | `baud_rate: Optional[int] = None` |
|
|
||||||
| AmbiLEDConfig | `baud_rate: Optional[int] = None` |
|
|
||||||
| DMXConfig | `dmx_protocol`, `dmx_start_universe`, `dmx_start_channel` |
|
|
||||||
| ESPNowConfig | `baud_rate`, `espnow_peer_mac`, `espnow_channel` |
|
|
||||||
| HueConfig | `hue_username`, `hue_client_key`, `hue_entertainment_group_id` |
|
|
||||||
| SPIConfig | `spi_speed_hz`, `spi_led_type` |
|
|
||||||
| ChromaConfig | `chroma_device_type` |
|
|
||||||
| GameSenseConfig| `gamesense_device_type` |
|
|
||||||
| BLEConfig | `ble_family`, `ble_govee_key` |
|
|
||||||
| GroupConfig | `group_mode`, `group_device_ids` (**no `device_store` here** — see Phase 2) |
|
|
||||||
| OpenRGBConfig | `zone_mode` |
|
|
||||||
| MockConfig | `send_latency_ms: int = 0` |
|
|
||||||
| DemoConfig | `send_latency_ms: int = 0` |
|
|
||||||
| MQTTConfig | (none) |
|
|
||||||
| WSConfig | (none) |
|
|
||||||
| USBHIDConfig | (none — `hid_usage_page` is parsed from the URL, not config) |
|
|
||||||
|
|
||||||
```python
|
|
||||||
DeviceConfig = Union[
|
|
||||||
WLEDConfig, AdalightConfig, AmbiLEDConfig, DMXConfig, ESPNowConfig,
|
|
||||||
HueConfig, SPIConfig, ChromaConfig, GameSenseConfig, BLEConfig,
|
|
||||||
GroupConfig, MQTTConfig, WSConfig, USBHIDConfig, OpenRGBConfig,
|
|
||||||
MockConfig, DemoConfig,
|
|
||||||
]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Add
|
|
||||||
|
|
||||||
**`Device.to_config() -> DeviceConfig`** in [server/src/ledgrab/storage/device_store.py](../../server/src/ledgrab/storage/device_store.py) (around lines 14-97 where `Device` lives).
|
|
||||||
|
|
||||||
- Dispatches on `self.device_type`.
|
|
||||||
- Constructs the right subclass, pulling only relevant columns.
|
|
||||||
- Ignores columns that don't apply to the type.
|
|
||||||
- This is the **only** place that knows the flat→typed mapping.
|
|
||||||
|
|
||||||
### Do NOT touch in Phase 1
|
|
||||||
|
|
||||||
- Provider signatures (still `create_client(self, url, **kwargs)`).
|
|
||||||
- `create_led_client` factory.
|
|
||||||
- Any call site.
|
|
||||||
- `DeviceInfo` itself.
|
|
||||||
|
|
||||||
### Acceptance
|
|
||||||
|
|
||||||
- New unit test `server/tests/core/devices/test_device_config.py`:
|
|
||||||
- For each provider, build a `Device` with that `device_type`, call `to_config()`, assert right subclass and right fields.
|
|
||||||
- Edge case: extra/irrelevant Device fields must not leak into the wrong config type.
|
|
||||||
- `cd server && ruff check src/ tests/ --fix` — green.
|
|
||||||
- `cd server && py -3.13 -m pytest tests/ --no-cov -q` — green (existing tests untouched, new test passes).
|
|
||||||
- `cd server && npx tsc --noEmit` — green (no TS impact this phase, just a sanity check).
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 2 + Phase 3 — Provider API migration + call-site migration (single PR)
|
|
||||||
|
|
||||||
**These must land in one commit** because the provider signature change would otherwise break the 3 call sites immediately.
|
|
||||||
|
|
||||||
### Change the abstract base
|
|
||||||
|
|
||||||
[server/src/ledgrab/core/devices/led_client.py](../../server/src/ledgrab/core/devices/led_client.py):
|
|
||||||
|
|
||||||
```python
|
|
||||||
class LEDDeviceProvider(ABC):
|
|
||||||
@abstractmethod
|
|
||||||
def create_client(self, config: DeviceConfig, *, deps: ProviderDeps) -> LEDClient: ...
|
|
||||||
```
|
|
||||||
|
|
||||||
`ProviderDeps` is a tiny new dataclass:
|
|
||||||
|
|
||||||
```python
|
|
||||||
@dataclass(frozen=True)
|
|
||||||
class ProviderDeps:
|
|
||||||
device_store: "DeviceStore"
|
|
||||||
# Add future cross-cutting runtime deps here (http_client, etc.)
|
|
||||||
```
|
|
||||||
|
|
||||||
`create_led_client`:
|
|
||||||
|
|
||||||
```python
|
|
||||||
def create_led_client(config: DeviceConfig, *, deps: ProviderDeps) -> LEDClient:
|
|
||||||
return get_provider(config.device_type).create_client(config, deps=deps)
|
|
||||||
```
|
|
||||||
|
|
||||||
### Update every provider (17 files)
|
|
||||||
|
|
||||||
- Narrow signature per provider: e.g. `WLEDDeviceProvider.create_client(self, config: WLEDConfig, *, deps: ProviderDeps)`.
|
|
||||||
- Drop all `kwargs.get("x")` lookups — read typed fields directly.
|
|
||||||
- Providers that don't need `deps` just ignore it.
|
|
||||||
- **GroupDeviceProvider** is the only current consumer of `deps`: reads `deps.device_store`.
|
|
||||||
|
|
||||||
### Call sites (3)
|
|
||||||
|
|
||||||
1. [server/src/ledgrab/core/processing/wled_target_processor.py](../../server/src/ledgrab/core/processing/wled_target_processor.py) lines ~120-148 — the 21-field unpacking. Replace with:
|
|
||||||
```python
|
|
||||||
config = device.to_config()
|
|
||||||
self._led_client = create_led_client(config, deps=self._provider_deps)
|
|
||||||
```
|
|
||||||
`self._provider_deps` is plumbed in from `ProcessorManager` when the target processor is constructed.
|
|
||||||
2. [server/src/ledgrab/core/processing/device_test_mode.py](../../server/src/ledgrab/core/processing/device_test_mode.py) lines 72-78 — minimal test-mode client. Build a synthetic config via a helper `_minimal_config_for_test_mode(device)` (keeps just `device_id`, `device_url`, `led_count`, `baud_rate`) and pass it.
|
|
||||||
3. [server/src/ledgrab/core/devices/group_client.py](../../server/src/ledgrab/core/devices/group_client.py) lines 47-70 — child client construction inside the group. Same pattern: `child_config = child_device.to_config()`; pass `deps` through.
|
|
||||||
|
|
||||||
### Delete
|
|
||||||
|
|
||||||
- `DeviceInfo` dataclass in [server/src/ledgrab/core/processing/target_processor.py](../../server/src/ledgrab/core/processing/target_processor.py) lines 71-109.
|
|
||||||
- `ProcessorManager._get_device_info()` and `_DEVICE_FIELD_DEFAULTS` in [server/src/ledgrab/core/processing/processor_manager.py](../../server/src/ledgrab/core/processing/processor_manager.py) lines 230-275 — `Device.to_config()` subsumes this. Verify no other callers via `ast-index usages "_get_device_info"`.
|
|
||||||
|
|
||||||
### Acceptance
|
|
||||||
|
|
||||||
- `ast-index search "device_info\."` — no hits in non-test code.
|
|
||||||
- `ast-index search "DeviceInfo"` — no hits outside archival comments.
|
|
||||||
- `cd server && py -3.13 -m pytest tests/ --no-cov -q` — all tests pass.
|
|
||||||
- Manual smoke: start server, create a WLED device, start processing, verify LEDs update (or mock output shows frames).
|
|
||||||
- `cd server && ruff check src/ tests/ --fix` — green.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 4 — Test migration
|
|
||||||
|
|
||||||
Update these files:
|
|
||||||
|
|
||||||
- `server/tests/storage/test_device_store.py` — add `to_config()` cases per device type.
|
|
||||||
- `server/tests/api/routes/test_devices_routes.py` — should be mostly untouched (API schemas still flat until Phase 5).
|
|
||||||
- `server/tests/e2e/test_device_flow.py` — update internal assertions only if they touch `DeviceInfo` directly.
|
|
||||||
- `server/tests/test_group_device.py` — construct child clients with `GroupConfig`.
|
|
||||||
- Any fixture helper that builds a fake `DeviceInfo` — migrate to the right `*Config` subclass.
|
|
||||||
|
|
||||||
### Acceptance
|
|
||||||
|
|
||||||
- `cd server && py -3.13 -m pytest tests/ --no-cov -q` — all green.
|
|
||||||
- Coverage of `device_config.py` and `Device.to_config()` ≥ 90%.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 5 — API discriminated union (OPTIONAL, separate PR)
|
|
||||||
|
|
||||||
**Do not start until Phases 1-4 are merged and stable.** Flag this to the human before beginning. This is the only phase with an externally breaking change.
|
|
||||||
|
|
||||||
### Backend
|
|
||||||
|
|
||||||
[server/src/ledgrab/api/schemas/devices.py](../../server/src/ledgrab/api/schemas/devices.py) — replace flat `DeviceCreate`/`DeviceUpdate` with Pydantic v2 tagged unions:
|
|
||||||
|
|
||||||
```python
|
|
||||||
class WLEDDeviceCreate(BaseModel):
|
|
||||||
device_type: Literal["wled"]
|
|
||||||
name: str
|
|
||||||
url: str
|
|
||||||
led_count: int
|
|
||||||
use_ddp: bool = False
|
|
||||||
# ... base fields only
|
|
||||||
|
|
||||||
DeviceCreate = Annotated[
|
|
||||||
Union[WLEDDeviceCreate, AdalightDeviceCreate, ...],
|
|
||||||
Field(discriminator="device_type"),
|
|
||||||
]
|
|
||||||
```
|
|
||||||
|
|
||||||
Add `model_config = ConfigDict(extra="ignore")` on each union member for **one release cycle** so existing clients (frontend, HAOS integration, curl scripts) that send extra fields don't 422 immediately. Add a deprecation note and tighten to `extra="forbid"` in a follow-up.
|
|
||||||
|
|
||||||
### Frontend
|
|
||||||
|
|
||||||
- [server/src/ledgrab/static/js/features/devices.ts](../../server/src/ledgrab/static/js/features/devices.ts) and related — when building the POST/PATCH body, scope the payload to the selected `device_type` using the show/hide knowledge already in `device-discovery.ts`.
|
|
||||||
- **No plain `<select>` elements** — any new pickers use IconSelect or EntitySelect (see root CLAUDE.md UI rules).
|
|
||||||
|
|
||||||
### Tests
|
|
||||||
|
|
||||||
- Update `test_devices_routes.py` to assert discriminated union rejection of mismatched shapes.
|
|
||||||
- Add round-trip tests: create device of each type via API → fetch → compare fields.
|
|
||||||
|
|
||||||
### Acceptance
|
|
||||||
|
|
||||||
- `cd server && py -3.13 -m pytest tests/ --no-cov -q` — green.
|
|
||||||
- `cd server && npx tsc --noEmit && npm run build` — green.
|
|
||||||
- Manual smoke for at least 3 device types (WLED, DMX, Hue) — create, edit, delete via UI.
|
|
||||||
- HAOS integration still works against the server (spot-check; not automated).
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Conventions the implementing agent must follow
|
|
||||||
|
|
||||||
- **Project task tracker is `TODO.md`** — check the "Refactor: Per-Provider Device Configs" section, tick boxes as phases land. Do **not** use the `TodoWrite` tool.
|
|
||||||
- **Auto-restart after Python changes.** See [contexts/server-operations.md](../../contexts/server-operations.md).
|
|
||||||
- **No commits without explicit user approval.** Present each phase's diff for review first.
|
|
||||||
- **Pre-commit gate every phase:**
|
|
||||||
- `cd server && ruff check src/ tests/ --fix`
|
|
||||||
- `cd server && py -3.13 -m pytest tests/ --no-cov -q`
|
|
||||||
- Phase 5 additionally: `cd server && npx tsc --noEmit && npm run build`
|
|
||||||
- **No plain `<select>`** — Phase 5 uses IconSelect / EntitySelect.
|
|
||||||
- **Android parity:** if you add any new runtime dep to `server/pyproject.toml`, update `android/app/build.gradle.kts` per the root [CLAUDE.md](../../CLAUDE.md) "Android Dependency Sync" section. This refactor should not need any new deps.
|
|
||||||
- **Data migration policy:** storage schema is unchanged, so no JSON-file migration is needed. But if you rename any serialized field during `to_dict`/`from_dict`, add migration logic per the root [CLAUDE.md](../../CLAUDE.md) "Data Migration Policy" section.
|
|
||||||
- **Use `ast-index`** for code search (`ast-index search`, `ast-index usages`, `ast-index callers`, `ast-index class`). Fall back to Grep only for regex/string-literal/comment searches.
|
|
||||||
- **Never run `cd` in Bash.** Use absolute paths or the project-relative `cd server && <cmd>` idiom (one-shot, same invocation).
|
|
||||||
|
|
||||||
## Known risks
|
|
||||||
|
|
||||||
1. **Frozen dataclass + inheritance + defaults** — Python's `@dataclass(frozen=True)` with inheritance requires every subclass field to have a default if any parent field does. Base has defaulted fields. Verify in Phase 1. If it breaks, use `kw_only=True` (Python 3.10+).
|
|
||||||
2. **`use_ddp` origin** — currently inferred from `self._protocol == "ddp"` at the call site, not from Device storage. Options: add a column (schema change, more work), **or** keep inference logic inside `Device.to_config()` (recommended — no schema change). Prefer the latter.
|
|
||||||
3. **Test-mode minimal client** ([device_test_mode.py](../../server/src/ledgrab/core/processing/device_test_mode.py) lines 72-78) may not have all `BaseDeviceConfig` fields available. Build a synthetic config via a named helper; do not leak the hack into `Device.to_config()`.
|
|
||||||
4. **Group `device_store` import cycle** — `GroupConfig` must **not** hold `device_store` (would pull storage into the config module). `ProviderDeps` is the deliberate cut.
|
|
||||||
5. **BLE optional import** — `BLEDeviceProvider` is conditionally registered (see [led_client.py](../../server/src/ledgrab/core/devices/led_client.py) lines 321-330). Ensure `BLEConfig` still imports cleanly even when `bleak` is absent — put `BLEConfig` in `device_config.py` (not in `ble_provider.py`) so it's always importable.
|
|
||||||
|
|
||||||
## Deliverables per phase
|
|
||||||
|
|
||||||
1. Branch: `refactor/device-typed-configs`.
|
|
||||||
2. One commit per phase, conventional-commit messages:
|
|
||||||
- `refactor(devices): phase 1 — add DeviceConfig hierarchy`
|
|
||||||
- `refactor(devices): phases 2+3 — typed provider signatures + call-site migration`
|
|
||||||
- `refactor(devices): phase 4 — test migration to typed configs`
|
|
||||||
- `refactor(devices): phase 5 — API discriminated union` (separate PR)
|
|
||||||
3. Phase-by-phase diffs presented for user review **before** each commit.
|
|
||||||
4. Final PR body linking all phases, with manual test plan per device type touched.
|
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 270 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 412 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 213 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 358 KiB |
File diff suppressed because it is too large
Load Diff
+12
-10
@@ -6,33 +6,35 @@
|
|||||||
- `src/ledgrab/api/routes/` — REST API endpoints (one file per entity)
|
- `src/ledgrab/api/routes/` — REST API endpoints (one file per entity)
|
||||||
- `src/ledgrab/api/schemas/` — Pydantic request/response models (one file per entity)
|
- `src/ledgrab/api/schemas/` — Pydantic request/response models (one file per entity)
|
||||||
- `src/ledgrab/core/` — Core business logic (capture, devices, audio, processing, automations)
|
- `src/ledgrab/core/` — Core business logic (capture, devices, audio, processing, automations)
|
||||||
- `src/ledgrab/storage/` — Data models (dataclasses) and JSON persistence stores
|
- `src/ledgrab/storage/` — Data models (dataclasses) and SQLite-backed persistence stores (`BaseSqliteStore`)
|
||||||
- `src/ledgrab/utils/` — Utility functions (logging, monitor detection, SSRF validation, sound playback)
|
- `src/ledgrab/utils/` — Utility functions (logging, monitor detection, SSRF validation, sound playback)
|
||||||
- `src/ledgrab/static/` — Frontend files (TypeScript, CSS, locales)
|
- `src/ledgrab/static/` — Frontend files (TypeScript, CSS, locales)
|
||||||
- `src/ledgrab/templates/` — Jinja2 HTML templates
|
- `src/ledgrab/templates/` — Jinja2 HTML templates
|
||||||
- `config/` — Configuration files (YAML)
|
- `config/` — Configuration files (YAML)
|
||||||
- `data/` — Runtime data (JSON stores, persisted state)
|
- `data/` — Runtime data: SQLite database (`ledgrab.db`) + assets. Relocate the root with `LEDGRAB_DATA_DIR`.
|
||||||
|
|
||||||
## Entity & Storage Pattern
|
## Entity & Storage Pattern
|
||||||
|
|
||||||
Each entity follows: dataclass model (`storage/`) + JSON store (`storage/*_store.py`) + Pydantic schemas (`api/schemas/`) + routes (`api/routes/`).
|
Each entity follows: dataclass model (`storage/`) + SQLite store (`storage/*_store.py`, subclassing `BaseSqliteStore`) + Pydantic schemas (`api/schemas/`) + routes (`api/routes/`).
|
||||||
|
|
||||||
|
Stores keep an in-memory write-through cache over a per-entity SQLite table (the legacy `BaseJsonStore` still exists for reference but new stores use `BaseSqliteStore`). Schema/data shape changes go through `storage/data_migrations.py` — migrations are idempotent and tracked in a dedicated `data_migrations` audit table, so they run safely on every startup. **When renaming or restructuring stored fields, add a migration there** (see the Data Migration Policy in the root `CLAUDE.md`).
|
||||||
|
|
||||||
## Authentication
|
## Authentication
|
||||||
|
|
||||||
Server uses API key authentication via Bearer token in `Authorization` header.
|
API key authentication via Bearer token in the `Authorization` header (`Authorization: Bearer <key>`). WebSocket connections authenticate with a first-message handshake (`{"type":"auth","token":"<key>"}`). See `src/ledgrab/api/auth.py` for the canonical logic.
|
||||||
|
|
||||||
- Config: `config/default_config.yaml` under `auth.api_keys`
|
- Config: `config/default_config.yaml` under `auth.api_keys`; env var `LEDGRAB_AUTH__API_KEYS`
|
||||||
- Env var: `LEDGRAB_AUTH__API_KEYS`
|
- When `api_keys` is **empty** (default): **loopback** requests (`127.0.0.1` / `::1` / `localhost`) are allowed anonymously, but **LAN / remote** requests are rejected with `401`. Auth is *not* fully open.
|
||||||
- When `api_keys` is empty (default), auth is disabled — all endpoints are open
|
- When `api_keys` is **set**: a valid Bearer token is required from every client (loopback included).
|
||||||
- To enable auth, add key entries (e.g. `dev: "your-secret-key"`)
|
- `require_authenticated()` rejects even loopback-anonymous callers on sensitive endpoints (e.g. backup download, secret reveal).
|
||||||
|
|
||||||
## Common Tasks
|
## Common Tasks
|
||||||
|
|
||||||
### Adding a new API endpoint
|
### Adding a new API endpoint
|
||||||
|
|
||||||
1. Create route file in `api/routes/`
|
1. Create route file in `api/routes/` (define an `APIRouter(prefix="/api/v1/...")`)
|
||||||
2. Define request/response schemas in `api/schemas/`
|
2. Define request/response schemas in `api/schemas/`
|
||||||
3. Register the router in `main.py`
|
3. Register the router in `api/__init__.py` (it aggregates every route module into the single `router` that `main.py` mounts)
|
||||||
4. Restart the server
|
4. Restart the server
|
||||||
5. Test via `/docs` (Swagger UI)
|
5. Test via `/docs` (Swagger UI)
|
||||||
|
|
||||||
|
|||||||
@@ -6,17 +6,20 @@ server:
|
|||||||
# For LAN access, add your machine's IP, e.g. "http://192.168.1.100:8080"
|
# For LAN access, add your machine's IP, e.g. "http://192.168.1.100:8080"
|
||||||
cors_origins:
|
cors_origins:
|
||||||
- "http://localhost:8080"
|
- "http://localhost:8080"
|
||||||
|
- "http://192.168.2.100:8080"
|
||||||
|
|
||||||
auth:
|
auth:
|
||||||
# API keys — required for any non-loopback (LAN) request.
|
# API keys — required for any non-loopback (LAN) request.
|
||||||
# When empty:
|
# When empty (default):
|
||||||
# - loopback (127.0.0.1, ::1, localhost) requests are allowed anonymously
|
# - loopback (127.0.0.1, ::1, localhost) requests are allowed anonymously
|
||||||
# - LAN requests are REJECTED with 401 (security default)
|
# - LAN requests are REJECTED with 401 (security default)
|
||||||
# To enable LAN access, add one or more label: "api-key" entries below
|
# To enable LAN access, uncomment the example below and replace the value
|
||||||
# and send `Authorization: Bearer <api-key>` with each request.
|
# with a secret you generated yourself (e.g. `openssl rand -hex 32`).
|
||||||
# Generate secure keys: openssl rand -hex 32
|
# Do NOT ship a hard-coded key here — a publicly-known token grants full
|
||||||
api_keys:
|
# LAN access to anyone on the network.
|
||||||
dev: "development-key-change-in-production"
|
api_keys: {}
|
||||||
|
# api_keys:
|
||||||
|
# my-client: "replace-with-output-of-openssl-rand-hex-32"
|
||||||
|
|
||||||
# Storage paths default to ./data relative to the server's working directory.
|
# Storage paths default to ./data relative to the server's working directory.
|
||||||
# Set LEDGRAB_DATA_DIR in the environment to point at a different data root
|
# Set LEDGRAB_DATA_DIR in the environment to point at a different data root
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
|||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "ledgrab"
|
name = "ledgrab"
|
||||||
version = "0.5.0"
|
version = "0.8.1"
|
||||||
description = "Ambient lighting system that captures screen content and drives LED strips in real time"
|
description = "Ambient lighting system that captures screen content and drives LED strips in real time"
|
||||||
authors = [
|
authors = [
|
||||||
{name = "Alexei Dolgolyov", email = "dolgolyov.alexei@gmail.com"}
|
{name = "Alexei Dolgolyov", email = "dolgolyov.alexei@gmail.com"}
|
||||||
@@ -117,3 +117,11 @@ target-version = ['py311']
|
|||||||
[tool.ruff]
|
[tool.ruff]
|
||||||
line-length = 100
|
line-length = 100
|
||||||
target-version = "py311"
|
target-version = "py311"
|
||||||
|
|
||||||
|
[tool.ruff.lint]
|
||||||
|
# E + F are ruff's defaults; UP007 + UP045 enforce PEP-604 `X | Y` and
|
||||||
|
# `T | None` style so we don't drift back to the legacy `Union[X, Y]` /
|
||||||
|
# `Optional[T]` imports the REVIEW_TODO mechanical sweep removed.
|
||||||
|
# Recent ruff versions split the rule — UP007 covers `Union`, UP045
|
||||||
|
# covers `Optional`.
|
||||||
|
extend-select = ["UP007", "UP045"]
|
||||||
|
|||||||
+86
-28
@@ -288,23 +288,72 @@ $pythonExe = $resolvedPython
|
|||||||
Write-Info "Starting $Module on port $Port..."
|
Write-Info "Starting $Module on port $Port..."
|
||||||
if ($SkipBrowser) { $env:LEDGRAB_RESTART = '1' }
|
if ($SkipBrowser) { $env:LEDGRAB_RESTART = '1' }
|
||||||
|
|
||||||
# Redirect the child's stdout/stderr to a log file. Without this, inheriting
|
# Launch python.exe directly with no parent-handle inheritance. We used to
|
||||||
# the parent shell's handles via Start-Process -WindowStyle Hidden can cause
|
# wrap it in `cmd /c python ... 1>log 2>err` so the parent powershell could
|
||||||
# the child to exit immediately when those handles aren't real console fds
|
# tail crash logs, but that left an empty cmd.exe window hanging around for
|
||||||
# (e.g. when restart.ps1 is driven from WSL/Git-Bash).
|
# the full server lifetime (cmd had to live to hold the redirect handles).
|
||||||
$logPath = Join-Path $env:TEMP ("ledgrab-{0}-{1}.log" -f $Module, $Port)
|
# Instead, let python claim its own console window — the user sees the live
|
||||||
$errPath = "$logPath.err"
|
# server log there, and there's no spurious cmd window.
|
||||||
|
#
|
||||||
|
# Why WMI Win32_Process.Create rather than Start-Process or
|
||||||
|
# [Diagnostics.Process]::Start? Both of those go through CreateProcess with
|
||||||
|
# bInheritHandles=true, which leaks the parent shell's pipe handles into
|
||||||
|
# the new Python process. When the caller is Git-Bash (`restart.ps1 |
|
||||||
|
# tail -10`), the bash pipe then stays open for the full server lifetime,
|
||||||
|
# hanging the bash invocation even after powershell exits. WMI's
|
||||||
|
# Win32_Process.Create uses CreateProcess with bInheritHandles=FALSE.
|
||||||
|
|
||||||
$argList = @()
|
$argList = @()
|
||||||
$argList += $launchArgs
|
$argList += $launchArgs
|
||||||
$argList += @('-m', $Module)
|
$argList += @('-m', $Module)
|
||||||
$startedProc = Start-Process -FilePath $pythonExe `
|
|
||||||
-ArgumentList $argList `
|
# Quote each arg defensively in case a future caller adds whitespace.
|
||||||
-WorkingDirectory $ServerRoot `
|
function Quote-CmdArg {
|
||||||
-WindowStyle Hidden `
|
param([string]$Arg)
|
||||||
-RedirectStandardOutput $logPath `
|
if ($Arg -match '[\s"]') {
|
||||||
-RedirectStandardError $errPath `
|
return '"' + ($Arg -replace '"', '\"') + '"'
|
||||||
-PassThru
|
}
|
||||||
$startedPid = $startedProc.Id
|
return $Arg
|
||||||
|
}
|
||||||
|
$quotedArgs = ($argList | ForEach-Object { Quote-CmdArg $_ }) -join ' '
|
||||||
|
$pyQ = Quote-CmdArg $pythonExe
|
||||||
|
|
||||||
|
$cmdLine = $pyQ + ' ' + $quotedArgs
|
||||||
|
|
||||||
|
# Win32_Process.Create starts detached with no parent-handle inheritance.
|
||||||
|
# Returns @{ ProcessId; ReturnValue (0 = success) }.
|
||||||
|
# Title sets the visible console-window title so the user can tell at a
|
||||||
|
# glance which server the window belongs to (useful when running real +
|
||||||
|
# demo side by side on different ports).
|
||||||
|
$startupInfo = New-CimInstance -ClassName Win32_ProcessStartup `
|
||||||
|
-ClientOnly `
|
||||||
|
-Property @{ Title = "LedGrab - $Module (port $Port)" }
|
||||||
|
$wmiResult = Invoke-CimMethod -ClassName Win32_Process -MethodName Create -Arguments @{
|
||||||
|
CommandLine = $cmdLine
|
||||||
|
CurrentDirectory = $ServerRoot
|
||||||
|
ProcessStartupInformation = $startupInfo
|
||||||
|
} -ErrorAction SilentlyContinue
|
||||||
|
|
||||||
|
if (-not $wmiResult -or $wmiResult.ReturnValue -ne 0) {
|
||||||
|
Write-Warning "WMI Win32_Process.Create failed (ReturnValue=$($wmiResult.ReturnValue)); falling back to Start-Process"
|
||||||
|
# Fallback path — Start-Process inherits parent handles, so a piped
|
||||||
|
# caller may hang. Acceptable here because this branch only runs when
|
||||||
|
# WMI itself is broken (very rare).
|
||||||
|
$startedProc = Start-Process -FilePath $pythonExe `
|
||||||
|
-ArgumentList $argList `
|
||||||
|
-WorkingDirectory $ServerRoot -PassThru
|
||||||
|
$startedPid = if ($startedProc) { $startedProc.Id } else { 0 }
|
||||||
|
} else {
|
||||||
|
$startedPid = [int]$wmiResult.ProcessId
|
||||||
|
}
|
||||||
|
|
||||||
|
# Confirm the process is actually our server (defensive — WMI sometimes
|
||||||
|
# returns a PID for a transient ancestor on heavily loaded boxes).
|
||||||
|
Start-Sleep -Milliseconds 250
|
||||||
|
if (-not (Get-Process -Id $startedPid -ErrorAction SilentlyContinue)) {
|
||||||
|
$rescanned = Get-ServerProcesses -ModuleName $Module -Root $ServerRoot | Select-Object -First 1
|
||||||
|
if ($rescanned) { $startedPid = $rescanned.ProcessId } else { $startedPid = 0 }
|
||||||
|
}
|
||||||
|
|
||||||
# ---- Poll readiness --------------------------------------------------------
|
# ---- Poll readiness --------------------------------------------------------
|
||||||
|
|
||||||
@@ -316,28 +365,37 @@ $deadline = (Get-Date).AddSeconds($StartupTimeoutSec)
|
|||||||
$ready = $false
|
$ready = $false
|
||||||
while ((Get-Date) -lt $deadline) {
|
while ((Get-Date) -lt $deadline) {
|
||||||
# Bail early if the process has already exited — something went wrong.
|
# Bail early if the process has already exited — something went wrong.
|
||||||
$proc = Get-Process -Id $startedPid -ErrorAction SilentlyContinue
|
if ($startedPid -gt 0) {
|
||||||
if (-not $proc) { break }
|
$proc = Get-Process -Id $startedPid -ErrorAction SilentlyContinue
|
||||||
|
if (-not $proc) {
|
||||||
|
$rescanned = Get-ServerProcesses -ModuleName $Module -Root $ServerRoot | Select-Object -First 1
|
||||||
|
if ($rescanned) { $startedPid = $rescanned.ProcessId } else { break }
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
$rescanned = Get-ServerProcesses -ModuleName $Module -Root $ServerRoot | Select-Object -First 1
|
||||||
|
if ($rescanned) { $startedPid = $rescanned.ProcessId }
|
||||||
|
}
|
||||||
if (Test-PortOpen -Port $Port) { $ready = $true; break }
|
if (Test-PortOpen -Port $Port) { $ready = $true; break }
|
||||||
Start-Sleep -Milliseconds 500
|
Start-Sleep -Milliseconds 500
|
||||||
}
|
}
|
||||||
|
|
||||||
if ($ready) {
|
if ($ready) {
|
||||||
Write-Info "Server ready on port $Port (PID $startedPid)"
|
if ($startedPid -gt 0) {
|
||||||
|
Write-Info "Server ready on port $Port (PID $startedPid)"
|
||||||
|
} else {
|
||||||
|
Write-Info "Server ready on port $Port"
|
||||||
|
}
|
||||||
exit 0
|
exit 0
|
||||||
}
|
}
|
||||||
|
|
||||||
$proc = Get-Process -Id $startedPid -ErrorAction SilentlyContinue
|
if ($startedPid -gt 0) {
|
||||||
if (-not $proc) {
|
$proc = Get-Process -Id $startedPid -ErrorAction SilentlyContinue
|
||||||
Write-Warning "Server process $startedPid exited before binding port $Port"
|
if (-not $proc) {
|
||||||
} else {
|
Write-Warning "Server process $startedPid exited before binding port $Port (check the server console window for the error)"
|
||||||
Write-Warning "Server PID $startedPid is running but did not bind port $Port within ${StartupTimeoutSec}s"
|
} else {
|
||||||
}
|
Write-Warning "Server PID $startedPid is running but did not bind port $Port within ${StartupTimeoutSec}s"
|
||||||
if (Test-Path $errPath) {
|
|
||||||
$tail = Get-Content $errPath -Tail 20 -ErrorAction SilentlyContinue
|
|
||||||
if ($tail) {
|
|
||||||
Write-Warning "Last stderr lines from $errPath :"
|
|
||||||
$tail | ForEach-Object { Write-Warning " $_" }
|
|
||||||
}
|
}
|
||||||
|
} else {
|
||||||
|
Write-Warning "Could not locate server process; port $Port did not bind within ${StartupTimeoutSec}s"
|
||||||
}
|
}
|
||||||
exit 1
|
exit 1
|
||||||
|
|||||||
@@ -10,6 +10,15 @@ Set procEnv = WshShell.Environment("Process")
|
|||||||
procEnv("PYTHONPATH") = appRoot & "\app\src"
|
procEnv("PYTHONPATH") = appRoot & "\app\src"
|
||||||
procEnv("LEDGRAB_CONFIG_PATH") = appRoot & "\app\config\default_config.yaml"
|
procEnv("LEDGRAB_CONFIG_PATH") = appRoot & "\app\config\default_config.yaml"
|
||||||
|
|
||||||
|
' If launched as Windows autostart (via the SMSTARTUP shortcut), suppress the
|
||||||
|
' browser auto-open. Manual launches (desktop / start menu) pass no args.
|
||||||
|
For Each arg In WScript.Arguments
|
||||||
|
If arg = "--autostart" Then
|
||||||
|
procEnv("LEDGRAB_AUTOSTART") = "1"
|
||||||
|
Exit For
|
||||||
|
End If
|
||||||
|
Next
|
||||||
|
|
||||||
' Use embedded python.exe (NOT pythonw.exe) with WindowStyle=0.
|
' Use embedded python.exe (NOT pythonw.exe) with WindowStyle=0.
|
||||||
' Same pattern as the Media Server sibling app.
|
' Same pattern as the Media Server sibling app.
|
||||||
embeddedPython = appRoot & "\python\python.exe"
|
embeddedPython = appRoot & "\python\python.exe"
|
||||||
|
|||||||
@@ -1,20 +1,52 @@
|
|||||||
"""LED Grab - Ambient lighting based on screen content."""
|
"""LED Grab - Ambient lighting based on screen content."""
|
||||||
|
|
||||||
from importlib.metadata import version, PackageNotFoundError
|
from importlib.metadata import version, PackageNotFoundError
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
# Fallback version — kept in sync with pyproject.toml. MUST match the
|
# Fallback version — patched at build time by build/build-dist.ps1 so the
|
||||||
# version declared there on every release. The Windows installer build
|
# bundled Windows distribution reports the release version (the installer
|
||||||
# (build/build-dist.ps1) also patches this literal to the resolved build
|
# strips ledgrab-*.dist-info, so importlib.metadata fails there).
|
||||||
# version, so any drift here is corrected for bundled distributions.
|
# In dev (running from source without `pip install -e .`) and on Android
|
||||||
# Used when the package isn't pip-installed (e.g. embedded via Chaquopy
|
# (Chaquopy embeds the source directly with no dist-info), we additionally
|
||||||
# on Android, where the source is included directly via source sets, or
|
# read pyproject.toml so the version is always correct without manual sync.
|
||||||
# in the Windows bundle where the installed dist-info is stripped).
|
_FALLBACK_VERSION = "0.8.1"
|
||||||
_FALLBACK_VERSION = "0.4.2"
|
|
||||||
|
|
||||||
try:
|
|
||||||
__version__ = version("ledgrab")
|
def _read_pyproject_version() -> str | None:
|
||||||
except PackageNotFoundError:
|
"""Read version from pyproject.toml (server/pyproject.toml relative to this file).
|
||||||
__version__ = _FALLBACK_VERSION
|
|
||||||
|
Returns None if the file is absent (typical for installed/bundled distributions
|
||||||
|
where pyproject.toml isn't shipped) or unreadable.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
# __init__.py -> ledgrab/ -> src/ -> server/
|
||||||
|
pyproject = Path(__file__).resolve().parents[2] / "pyproject.toml"
|
||||||
|
if not pyproject.is_file():
|
||||||
|
return None
|
||||||
|
try:
|
||||||
|
import tomllib # Python 3.11+
|
||||||
|
except ImportError:
|
||||||
|
return None
|
||||||
|
with pyproject.open("rb") as f:
|
||||||
|
data = tomllib.load(f)
|
||||||
|
v = data.get("project", {}).get("version")
|
||||||
|
return v if isinstance(v, str) else None
|
||||||
|
except Exception:
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
# Prefer pyproject.toml when it sits next to the source (dev checkout). This
|
||||||
|
# avoids stale `pip install -e .` dist-info pinning an older version after a
|
||||||
|
# bump. When pyproject.toml isn't shipped (installed packages, Windows bundle,
|
||||||
|
# Android), fall back to importlib.metadata, then the patched literal.
|
||||||
|
_live = _read_pyproject_version()
|
||||||
|
if _live:
|
||||||
|
__version__ = _live
|
||||||
|
else:
|
||||||
|
try:
|
||||||
|
__version__ = version("ledgrab")
|
||||||
|
except PackageNotFoundError:
|
||||||
|
__version__ = _FALLBACK_VERSION
|
||||||
|
|
||||||
__author__ = "Alexei Dolgolyov"
|
__author__ = "Alexei Dolgolyov"
|
||||||
__email__ = "dolgolyov.alexei@gmail.com"
|
__email__ = "dolgolyov.alexei@gmail.com"
|
||||||
|
|||||||
+112
-12
@@ -6,6 +6,7 @@ shows a system-tray icon with **Show UI** / **Exit** actions.
|
|||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
import os
|
import os
|
||||||
|
import signal
|
||||||
import socket
|
import socket
|
||||||
import sys
|
import sys
|
||||||
import threading
|
import threading
|
||||||
@@ -38,15 +39,19 @@ _fix_embedded_tcl_paths()
|
|||||||
|
|
||||||
import uvicorn # noqa: E402
|
import uvicorn # noqa: E402
|
||||||
|
|
||||||
from ledgrab.config import get_config # noqa: E402
|
from ledgrab.config import Config, get_config # noqa: E402
|
||||||
from ledgrab.server_ref import set_server, set_tray # noqa: E402
|
from ledgrab.server_ref import set_server, set_tray # noqa: E402
|
||||||
|
from ledgrab.shutdown_state import GRACEFUL_SHUTDOWN_TIMEOUT # noqa: E402
|
||||||
from ledgrab.tray import PYSTRAY_AVAILABLE, TrayManager # noqa: E402
|
from ledgrab.tray import PYSTRAY_AVAILABLE, TrayManager # noqa: E402
|
||||||
from ledgrab.utils import setup_logging, get_logger # noqa: E402
|
from ledgrab.utils import setup_logging, get_logger # noqa: E402
|
||||||
|
from ledgrab.utils.platform import is_windows # noqa: E402
|
||||||
|
from ledgrab.utils.win_shutdown import WindowsShutdownGuard # noqa: E402
|
||||||
|
|
||||||
setup_logging()
|
setup_logging()
|
||||||
logger = get_logger(__name__)
|
logger = get_logger(__name__)
|
||||||
|
|
||||||
_ICON_PATH = Path(__file__).parent / "static" / "icons" / "icon-192.png"
|
_ICON_PATH = Path(__file__).parent / "static" / "icons" / "icon-tray.png"
|
||||||
|
_ICON_FALLBACK_PATH = Path(__file__).parent / "static" / "icons" / "icon-192.png"
|
||||||
|
|
||||||
|
|
||||||
def _run_server(server: uvicorn.Server) -> None:
|
def _run_server(server: uvicorn.Server) -> None:
|
||||||
@@ -83,6 +88,16 @@ def _is_restart() -> bool:
|
|||||||
return os.environ.get("LEDGRAB_RESTART", "") == "1"
|
return os.environ.get("LEDGRAB_RESTART", "") == "1"
|
||||||
|
|
||||||
|
|
||||||
|
def _is_autostart() -> bool:
|
||||||
|
"""Detect if launched via the Windows autostart shortcut."""
|
||||||
|
return os.environ.get("LEDGRAB_AUTOSTART", "") == "1"
|
||||||
|
|
||||||
|
|
||||||
|
def _should_skip_browser() -> bool:
|
||||||
|
"""Skip auto-opening the browser on restarts and on Windows login autostart."""
|
||||||
|
return _is_restart() or _is_autostart()
|
||||||
|
|
||||||
|
|
||||||
def _check_port(host: str, port: int) -> None:
|
def _check_port(host: str, port: int) -> None:
|
||||||
"""Exit with a clear message if the port is already in use."""
|
"""Exit with a clear message if the port is already in use."""
|
||||||
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
|
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
|
||||||
@@ -94,23 +109,46 @@ def _check_port(host: str, port: int) -> None:
|
|||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
|
|
||||||
|
|
||||||
def main() -> None:
|
def _build_server(config: Config) -> uvicorn.Server:
|
||||||
config = get_config()
|
"""Construct the uvicorn Server with a bounded graceful-shutdown timeout.
|
||||||
_check_port(config.server.host, config.server.port)
|
|
||||||
|
|
||||||
|
Extracted so the graceful-shutdown bound is unit-testable — leaving it
|
||||||
|
unset (the uvicorn default of ``None``) is the regression that strands
|
||||||
|
LED targets and prevents the process from exiting.
|
||||||
|
"""
|
||||||
uv_config = uvicorn.Config(
|
uv_config = uvicorn.Config(
|
||||||
"ledgrab.main:app",
|
"ledgrab.main:app",
|
||||||
host=config.server.host,
|
host=config.server.host,
|
||||||
port=config.server.port,
|
port=config.server.port,
|
||||||
log_level=config.server.log_level.lower(),
|
log_level=config.server.log_level.lower(),
|
||||||
|
timeout_graceful_shutdown=GRACEFUL_SHUTDOWN_TIMEOUT,
|
||||||
)
|
)
|
||||||
server = uvicorn.Server(uv_config)
|
return uvicorn.Server(uv_config)
|
||||||
|
|
||||||
|
|
||||||
|
def main() -> None:
|
||||||
|
config = get_config()
|
||||||
|
_check_port(config.server.host, config.server.port)
|
||||||
|
|
||||||
|
server = _build_server(config)
|
||||||
set_server(server)
|
set_server(server)
|
||||||
|
|
||||||
|
# Wire the OS-shutdown safety net. The lifespan in ``ledgrab.main`` signals
|
||||||
|
# ``shutdown_complete`` once it has stopped targets and checkpointed the
|
||||||
|
# DB; the Windows guard waits on that event before letting the OS finish
|
||||||
|
# ending the session. Without this, the entire shutdown lifespan never
|
||||||
|
# runs on PC reboot — devices stay on and the SQLite WAL is lost.
|
||||||
|
guard = _install_os_shutdown_guard(server)
|
||||||
|
|
||||||
use_tray = PYSTRAY_AVAILABLE and (sys.platform == "win32" or _force_tray())
|
use_tray = PYSTRAY_AVAILABLE and (sys.platform == "win32" or _force_tray())
|
||||||
|
|
||||||
if use_tray:
|
if use_tray:
|
||||||
logger.info("Starting with system tray icon")
|
logger.info("Starting with system tray icon")
|
||||||
|
# Install signal handlers BEFORE starting the uvicorn thread so a
|
||||||
|
# SIGINT/SIGBREAK during startup still triggers a clean shutdown.
|
||||||
|
# We do NOT install them on the no-tray path because uvicorn's
|
||||||
|
# ``server.run()`` overwrites SIGINT/SIGTERM with its own handlers.
|
||||||
|
_install_signal_handlers(server)
|
||||||
|
|
||||||
# Uvicorn in a background thread
|
# Uvicorn in a background thread
|
||||||
server_thread = threading.Thread(
|
server_thread = threading.Thread(
|
||||||
@@ -120,8 +158,8 @@ def main() -> None:
|
|||||||
)
|
)
|
||||||
server_thread.start()
|
server_thread.start()
|
||||||
|
|
||||||
# Browser after a short delay (skip on restart — user already has a tab)
|
# Browser after a short delay (skip on restart and on Windows login autostart)
|
||||||
if not _is_restart():
|
if not _should_skip_browser():
|
||||||
threading.Thread(
|
threading.Thread(
|
||||||
target=_open_browser,
|
target=_open_browser,
|
||||||
args=(config.server.port,),
|
args=(config.server.port,),
|
||||||
@@ -129,20 +167,31 @@ def main() -> None:
|
|||||||
).start()
|
).start()
|
||||||
|
|
||||||
# Tray on main thread (blocking)
|
# Tray on main thread (blocking)
|
||||||
|
tray_icon = _ICON_PATH if _ICON_PATH.exists() else _ICON_FALLBACK_PATH
|
||||||
tray = TrayManager(
|
tray = TrayManager(
|
||||||
icon_path=_ICON_PATH,
|
icon_path=tray_icon,
|
||||||
port=config.server.port,
|
port=config.server.port,
|
||||||
on_exit=lambda: _request_shutdown(server),
|
on_exit=lambda: _request_shutdown(server),
|
||||||
)
|
)
|
||||||
set_tray(tray)
|
set_tray(tray)
|
||||||
tray.run()
|
tray.run()
|
||||||
|
|
||||||
# Tray exited — wait for server to finish its graceful shutdown
|
# Tray exited — wait for server to finish its graceful shutdown.
|
||||||
server_thread.join(timeout=10)
|
# Budget: the graceful-shutdown wait (GRACEFUL_SHUTDOWN_TIMEOUT) runs
|
||||||
|
# first, then the lifespan's own ~16 s shutdown (target restore + DB
|
||||||
|
# checkpoint). Join longer than their sum so a slow disk doesn't get
|
||||||
|
# the DB checkpoint cut short.
|
||||||
|
server_thread.join(timeout=25)
|
||||||
|
if guard is not None:
|
||||||
|
guard.stop()
|
||||||
else:
|
else:
|
||||||
if not PYSTRAY_AVAILABLE:
|
if not PYSTRAY_AVAILABLE:
|
||||||
logger.info("System tray not available (install pystray for tray support)")
|
logger.info("System tray not available (install pystray for tray support)")
|
||||||
server.run()
|
try:
|
||||||
|
server.run()
|
||||||
|
finally:
|
||||||
|
if guard is not None:
|
||||||
|
guard.stop()
|
||||||
|
|
||||||
|
|
||||||
def _request_shutdown(server: uvicorn.Server) -> None:
|
def _request_shutdown(server: uvicorn.Server) -> None:
|
||||||
@@ -150,6 +199,57 @@ def _request_shutdown(server: uvicorn.Server) -> None:
|
|||||||
server.should_exit = True
|
server.should_exit = True
|
||||||
|
|
||||||
|
|
||||||
|
def _install_os_shutdown_guard(server: uvicorn.Server) -> "WindowsShutdownGuard | None":
|
||||||
|
"""Install the OS-shutdown safety net (Windows only).
|
||||||
|
|
||||||
|
Returns the guard so the caller can ``stop()`` it on normal exit, or
|
||||||
|
``None`` on platforms where no guard is needed.
|
||||||
|
"""
|
||||||
|
if not is_windows():
|
||||||
|
return None
|
||||||
|
|
||||||
|
# ``shutdown_state`` is a leaf module — importing it does NOT pull in
|
||||||
|
# ``ledgrab.main`` and its global stores. uvicorn loads ``main`` lazily
|
||||||
|
# via the import string ``"ledgrab.main:app"`` once it starts serving.
|
||||||
|
from ledgrab.shutdown_state import shutdown_complete
|
||||||
|
|
||||||
|
guard = WindowsShutdownGuard(
|
||||||
|
on_shutdown=lambda: _request_shutdown(server),
|
||||||
|
shutdown_complete=shutdown_complete,
|
||||||
|
)
|
||||||
|
if guard.start():
|
||||||
|
logger.info("Windows shutdown guard installed")
|
||||||
|
else:
|
||||||
|
logger.warning("Windows shutdown guard failed to start")
|
||||||
|
return guard
|
||||||
|
|
||||||
|
|
||||||
|
def _install_signal_handlers(server: uvicorn.Server) -> None:
|
||||||
|
"""Catch terminal/admin shutdown signals and trigger graceful exit.
|
||||||
|
|
||||||
|
Uvicorn already installs SIGINT/SIGTERM handlers when ``server.run()``
|
||||||
|
is called on the main thread (the no-tray path). For the tray path,
|
||||||
|
uvicorn runs on a background thread and skips signal installation, so
|
||||||
|
we install our own here. SIGBREAK is Windows-specific and fires on
|
||||||
|
Ctrl-Break and in some service-stop scenarios.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def _handler(signum, frame): # noqa: ANN001 - signal handler signature
|
||||||
|
logger.warning("Signal %s received — requesting shutdown", signum)
|
||||||
|
_request_shutdown(server)
|
||||||
|
|
||||||
|
candidates = ["SIGINT", "SIGTERM", "SIGBREAK"]
|
||||||
|
for name in candidates:
|
||||||
|
sig = getattr(signal, name, None)
|
||||||
|
if sig is None:
|
||||||
|
continue
|
||||||
|
try:
|
||||||
|
signal.signal(sig, _handler)
|
||||||
|
except (ValueError, OSError) as e:
|
||||||
|
# ValueError: not on main thread; OSError: signal not supported here.
|
||||||
|
logger.debug("Could not install handler for %s: %s", name, e)
|
||||||
|
|
||||||
|
|
||||||
def _force_tray() -> bool:
|
def _force_tray() -> bool:
|
||||||
"""Allow forcing tray on non-Windows via LEDGRAB_TRAY=1."""
|
"""Allow forcing tray on non-Windows via LEDGRAB_TRAY=1."""
|
||||||
import os
|
import os
|
||||||
|
|||||||
@@ -6,16 +6,17 @@ inside an Android application. Sets up Android-specific paths
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
|
import json
|
||||||
import os
|
import os
|
||||||
import threading
|
import threading
|
||||||
from typing import Any, Optional
|
from typing import Any
|
||||||
|
|
||||||
_server_thread: Optional[threading.Thread] = None
|
_server_thread: threading.Thread | None = None
|
||||||
_server: Optional[Any] = None # uvicorn.Server
|
_server: Any | None = None # uvicorn.Server
|
||||||
_loop: Optional[asyncio.AbstractEventLoop] = None
|
_loop: asyncio.AbstractEventLoop | None = None
|
||||||
|
|
||||||
|
|
||||||
def start_server(data_dir: str, port: int = 8080) -> None:
|
def start_server(data_dir: str, port: int = 8080, api_key: str | None = None) -> None:
|
||||||
"""Start the LedGrab uvicorn server.
|
"""Start the LedGrab uvicorn server.
|
||||||
|
|
||||||
Called from Kotlin's ``PythonBridge.startServer()``. This function
|
Called from Kotlin's ``PythonBridge.startServer()``. This function
|
||||||
@@ -26,6 +27,11 @@ def start_server(data_dir: str, port: int = 8080) -> None:
|
|||||||
data_dir: Android app-private files directory
|
data_dir: Android app-private files directory
|
||||||
(e.g. ``/data/data/com.ledgrab.android/files``).
|
(e.g. ``/data/data/com.ledgrab.android/files``).
|
||||||
port: HTTP port for the web UI / API.
|
port: HTTP port for the web UI / API.
|
||||||
|
api_key: Optional Bearer token to enable LAN auth. When set,
|
||||||
|
published as ``LEDGRAB_AUTH__API_KEYS={"android":<key>}``
|
||||||
|
so the server's auth gate accepts LAN requests carrying
|
||||||
|
``Authorization: Bearer <key>``. When None, the server
|
||||||
|
falls back to its default (loopback-only).
|
||||||
"""
|
"""
|
||||||
# ── Configure paths before any LedGrab imports ──────────────
|
# ── Configure paths before any LedGrab imports ──────────────
|
||||||
os.makedirs(os.path.join(data_dir, "data"), exist_ok=True)
|
os.makedirs(os.path.join(data_dir, "data"), exist_ok=True)
|
||||||
@@ -41,6 +47,14 @@ def start_server(data_dir: str, port: int = 8080) -> None:
|
|||||||
os.environ["LEDGRAB_SERVER__HOST"] = "0.0.0.0"
|
os.environ["LEDGRAB_SERVER__HOST"] = "0.0.0.0"
|
||||||
os.environ["LEDGRAB_SERVER__PORT"] = str(port)
|
os.environ["LEDGRAB_SERVER__PORT"] = str(port)
|
||||||
|
|
||||||
|
# Provision LAN auth when the Kotlin launcher supplied a key. The
|
||||||
|
# config layer (pydantic-settings) parses ``LEDGRAB_AUTH__API_KEYS``
|
||||||
|
# as JSON when the value starts with `{`. We use a dict so the
|
||||||
|
# rest of the codebase sees a labelled key just like the YAML
|
||||||
|
# config form (api_keys: {android: ...}).
|
||||||
|
if api_key:
|
||||||
|
os.environ["LEDGRAB_AUTH__API_KEYS"] = json.dumps({"android": api_key})
|
||||||
|
|
||||||
# ── Now safe to import LedGrab ──────────────────────────────
|
# ── Now safe to import LedGrab ──────────────────────────────
|
||||||
import uvicorn # noqa: E402
|
import uvicorn # noqa: E402
|
||||||
|
|
||||||
@@ -50,10 +64,27 @@ def start_server(data_dir: str, port: int = 8080) -> None:
|
|||||||
logger = get_logger(__name__)
|
logger = get_logger(__name__)
|
||||||
logger.info("LedGrab Android: starting server on port %d", port)
|
logger.info("LedGrab Android: starting server on port %d", port)
|
||||||
logger.info("Data directory: %s", data_dir)
|
logger.info("Data directory: %s", data_dir)
|
||||||
|
if api_key:
|
||||||
|
logger.info("LedGrab Android: API key auth enabled (label=android)")
|
||||||
|
else:
|
||||||
|
logger.warning("LedGrab Android: no API key — LAN requests will be rejected")
|
||||||
|
|
||||||
from ledgrab.config import get_config # noqa: E402
|
from ledgrab.config import get_config # noqa: E402
|
||||||
|
|
||||||
config = get_config()
|
config = get_config()
|
||||||
|
# Defensive: confirm the env var actually landed in the parsed config.
|
||||||
|
# If pydantic-settings ever changes how it deserialises dict[str, str]
|
||||||
|
# from env, the LAN auth would silently break (server would 401 every
|
||||||
|
# phone scan). Logging the mismatch makes the failure mode obvious in
|
||||||
|
# adb logcat.
|
||||||
|
if api_key and config.auth.api_keys.get("android") != api_key:
|
||||||
|
logger.error(
|
||||||
|
"LedGrab Android: API key did NOT land in config — LAN auth will "
|
||||||
|
"reject all requests. Check pydantic-settings dict parsing for "
|
||||||
|
"LEDGRAB_AUTH__API_KEYS."
|
||||||
|
)
|
||||||
|
|
||||||
|
from ledgrab.shutdown_state import GRACEFUL_SHUTDOWN_TIMEOUT
|
||||||
|
|
||||||
uv_config = uvicorn.Config(
|
uv_config = uvicorn.Config(
|
||||||
"ledgrab.main:app",
|
"ledgrab.main:app",
|
||||||
@@ -62,6 +93,9 @@ def start_server(data_dir: str, port: int = 8080) -> None:
|
|||||||
log_level=config.server.log_level.lower(),
|
log_level=config.server.log_level.lower(),
|
||||||
# No uvloop/httptools on Android — use pure-Python asyncio
|
# No uvloop/httptools on Android — use pure-Python asyncio
|
||||||
loop="asyncio",
|
loop="asyncio",
|
||||||
|
# Bound the graceful-shutdown wait so stop_server() can't hang forever
|
||||||
|
# on a lingering WebView events WebSocket — see shutdown_state for why.
|
||||||
|
timeout_graceful_shutdown=GRACEFUL_SHUTDOWN_TIMEOUT,
|
||||||
)
|
)
|
||||||
|
|
||||||
global _server, _loop
|
global _server, _loop
|
||||||
|
|||||||
@@ -27,11 +27,14 @@ from .routes.update import router as update_router
|
|||||||
from .routes.assets import router as assets_router
|
from .routes.assets import router as assets_router
|
||||||
from .routes.home_assistant import router as home_assistant_router
|
from .routes.home_assistant import router as home_assistant_router
|
||||||
from .routes.mqtt import router as mqtt_router
|
from .routes.mqtt import router as mqtt_router
|
||||||
|
from .routes.http_endpoints import router as http_endpoints_router
|
||||||
from .routes.game_integration import router as game_integration_router
|
from .routes.game_integration import router as game_integration_router
|
||||||
from .routes.audio_processing_templates import router as audio_processing_templates_router
|
from .routes.audio_processing_templates import router as audio_processing_templates_router
|
||||||
from .routes.audio_filters import router as audio_filters_router
|
from .routes.audio_filters import router as audio_filters_router
|
||||||
from .routes.pattern_templates import router as pattern_templates_router
|
from .routes.pattern_templates import router as pattern_templates_router
|
||||||
from .routes.preferences import router as preferences_router
|
from .routes.preferences import router as preferences_router
|
||||||
|
from .routes.snapshot import router as snapshot_router
|
||||||
|
from .routes.graph import router as graph_router
|
||||||
|
|
||||||
router = APIRouter()
|
router = APIRouter()
|
||||||
router.include_router(system_router)
|
router.include_router(system_router)
|
||||||
@@ -59,10 +62,13 @@ router.include_router(update_router)
|
|||||||
router.include_router(assets_router)
|
router.include_router(assets_router)
|
||||||
router.include_router(home_assistant_router)
|
router.include_router(home_assistant_router)
|
||||||
router.include_router(mqtt_router)
|
router.include_router(mqtt_router)
|
||||||
|
router.include_router(http_endpoints_router)
|
||||||
router.include_router(game_integration_router)
|
router.include_router(game_integration_router)
|
||||||
router.include_router(audio_processing_templates_router)
|
router.include_router(audio_processing_templates_router)
|
||||||
router.include_router(audio_filters_router)
|
router.include_router(audio_filters_router)
|
||||||
router.include_router(pattern_templates_router)
|
router.include_router(pattern_templates_router)
|
||||||
router.include_router(preferences_router)
|
router.include_router(preferences_router)
|
||||||
|
router.include_router(snapshot_router)
|
||||||
|
router.include_router(graph_router)
|
||||||
|
|
||||||
__all__ = ["router"]
|
__all__ = ["router"]
|
||||||
|
|||||||
@@ -11,13 +11,25 @@ from starlette.websockets import WebSocket, WebSocketDisconnect
|
|||||||
|
|
||||||
from ledgrab.config import get_config
|
from ledgrab.config import get_config
|
||||||
from ledgrab.utils import get_logger
|
from ledgrab.utils import get_logger
|
||||||
|
from ledgrab.utils.net_classify import is_loopback as _classify_is_loopback
|
||||||
|
|
||||||
logger = get_logger(__name__)
|
logger = get_logger(__name__)
|
||||||
|
|
||||||
# Security scheme for Bearer token
|
# Security scheme for Bearer token
|
||||||
security = HTTPBearer(auto_error=False)
|
security = HTTPBearer(auto_error=False)
|
||||||
|
|
||||||
_LOOPBACK_HOSTS = frozenset({"127.0.0.1", "::1", "localhost", "testclient"})
|
|
||||||
|
# Exceptions that legitimately fire when we try to send / close a WebSocket
|
||||||
|
# that is already shutting down: the peer dropped, the connect-state moved
|
||||||
|
# under us, the underlying socket is gone, the JSON encoder choked, etc.
|
||||||
|
# Keeping this tuple narrow means a genuine programming error (AttributeError,
|
||||||
|
# TypeError) bubbles up to the caller instead of silently disappearing.
|
||||||
|
_WS_SEND_BENIGN_EXC: tuple[type[BaseException], ...] = (
|
||||||
|
WebSocketDisconnect,
|
||||||
|
RuntimeError,
|
||||||
|
ConnectionError,
|
||||||
|
OSError,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def is_auth_enabled() -> bool:
|
def is_auth_enabled() -> bool:
|
||||||
@@ -26,15 +38,15 @@ def is_auth_enabled() -> bool:
|
|||||||
|
|
||||||
|
|
||||||
def _is_loopback(host: str | None) -> bool:
|
def _is_loopback(host: str | None) -> bool:
|
||||||
"""Return True when *host* is a loopback address."""
|
"""Return True when *host* is a loopback address.
|
||||||
|
|
||||||
|
Delegates to :func:`ledgrab.utils.net_classify.is_loopback` so this
|
||||||
|
auth gate, the SSRF guard in ``safe_source``, and the LAN-default
|
||||||
|
inference in ``url_scheme`` share one classification source.
|
||||||
|
"""
|
||||||
if not host:
|
if not host:
|
||||||
return False
|
return False
|
||||||
# Strip IPv6 brackets and zone IDs
|
return _classify_is_loopback(host)
|
||||||
h = host.strip().lower()
|
|
||||||
if h.startswith("[") and h.endswith("]"):
|
|
||||||
h = h[1:-1]
|
|
||||||
h = h.split("%", 1)[0]
|
|
||||||
return h in _LOOPBACK_HOSTS
|
|
||||||
|
|
||||||
|
|
||||||
def verify_api_key(
|
def verify_api_key(
|
||||||
@@ -68,6 +80,7 @@ def verify_api_key(
|
|||||||
if not config.auth.api_keys:
|
if not config.auth.api_keys:
|
||||||
# No keys configured — allow loopback only.
|
# No keys configured — allow loopback only.
|
||||||
if _is_loopback(client_host):
|
if _is_loopback(client_host):
|
||||||
|
request.state.auth_label = "anonymous"
|
||||||
return "anonymous"
|
return "anonymous"
|
||||||
# Allow caller to authenticate explicitly even without configured keys?
|
# Allow caller to authenticate explicitly even without configured keys?
|
||||||
# No — there are no keys to compare against. Reject.
|
# No — there are no keys to compare against. Reject.
|
||||||
@@ -111,6 +124,9 @@ def verify_api_key(
|
|||||||
# Log successful authentication
|
# Log successful authentication
|
||||||
logger.debug(f"Authenticated as: {authenticated_as}")
|
logger.debug(f"Authenticated as: {authenticated_as}")
|
||||||
|
|
||||||
|
# Stash the friendly label so the access-log middleware can attribute the
|
||||||
|
# request to a client without re-running the token comparison.
|
||||||
|
request.state.auth_label = authenticated_as
|
||||||
return authenticated_as
|
return authenticated_as
|
||||||
|
|
||||||
|
|
||||||
@@ -142,6 +158,23 @@ def require_authenticated(label: str) -> None:
|
|||||||
WS_AUTH_CLOSE_CODE = 4401
|
WS_AUTH_CLOSE_CODE = 4401
|
||||||
|
|
||||||
|
|
||||||
|
WS_ORIGIN_CLOSE_CODE = 4403
|
||||||
|
"""Close code sent when a WebSocket request fails the Origin allowlist."""
|
||||||
|
|
||||||
|
|
||||||
|
def _is_origin_allowed(origin: str | None, allowed: list[str]) -> bool:
|
||||||
|
"""Return True when *origin* matches one of the configured CORS origins.
|
||||||
|
|
||||||
|
Non-browser clients (Python scripts, curl) don't send Origin — those are
|
||||||
|
allowed through; the Bearer-token check on the auth handshake is the
|
||||||
|
primary defence in that case. Browsers always set Origin, so this only
|
||||||
|
blocks cross-site WebSocket connection attempts (CSWSH).
|
||||||
|
"""
|
||||||
|
if not origin:
|
||||||
|
return True
|
||||||
|
return origin in set(allowed or [])
|
||||||
|
|
||||||
|
|
||||||
async def accept_and_authenticate_ws(websocket: WebSocket, timeout: float = 3.0) -> str | None:
|
async def accept_and_authenticate_ws(websocket: WebSocket, timeout: float = 3.0) -> str | None:
|
||||||
"""Accept the WebSocket, then perform first-message auth handshake.
|
"""Accept the WebSocket, then perform first-message auth handshake.
|
||||||
|
|
||||||
@@ -152,12 +185,29 @@ async def accept_and_authenticate_ws(websocket: WebSocket, timeout: float = 3.0)
|
|||||||
Returns the caller label on success, ``None`` on failure (connection
|
Returns the caller label on success, ``None`` on failure (connection
|
||||||
already closed).
|
already closed).
|
||||||
"""
|
"""
|
||||||
|
# Reject cross-site WebSocket attempts before accepting — a browser-based
|
||||||
|
# attacker page cannot forge the Origin header, so an Origin mismatch is
|
||||||
|
# a strong signal even before the token check. Non-browser clients
|
||||||
|
# legitimately omit Origin; those fall through to the auth handshake.
|
||||||
|
config = get_config()
|
||||||
|
origin = websocket.headers.get("origin")
|
||||||
|
if not _is_origin_allowed(origin, config.server.cors_origins):
|
||||||
|
logger.warning(
|
||||||
|
"Rejected WebSocket from origin %r (not in cors_origins)",
|
||||||
|
origin,
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
await websocket.close(code=WS_ORIGIN_CLOSE_CODE)
|
||||||
|
except _WS_SEND_BENIGN_EXC:
|
||||||
|
pass
|
||||||
|
return None
|
||||||
|
|
||||||
await websocket.accept()
|
await websocket.accept()
|
||||||
label = await verify_ws_auth(websocket, timeout=timeout)
|
label = await verify_ws_auth(websocket, timeout=timeout)
|
||||||
if label is None:
|
if label is None:
|
||||||
try:
|
try:
|
||||||
await websocket.close(code=WS_AUTH_CLOSE_CODE)
|
await websocket.close(code=WS_AUTH_CLOSE_CODE)
|
||||||
except Exception:
|
except _WS_SEND_BENIGN_EXC:
|
||||||
pass
|
pass
|
||||||
return None
|
return None
|
||||||
return label
|
return label
|
||||||
@@ -221,20 +271,29 @@ async def verify_ws_auth(
|
|||||||
# Loopback anonymous: no auth message arrived, but none is required.
|
# Loopback anonymous: no auth message arrived, but none is required.
|
||||||
try:
|
try:
|
||||||
await websocket.send_json({"type": "auth_ok"})
|
await websocket.send_json({"type": "auth_ok"})
|
||||||
except Exception:
|
except _WS_SEND_BENIGN_EXC:
|
||||||
return None
|
return None
|
||||||
return "anonymous"
|
return "anonymous"
|
||||||
logger.warning("WebSocket auth timeout after %.1fs from %s", timeout, client_host)
|
logger.warning("WebSocket auth timeout after %.1fs from %s", timeout, client_host)
|
||||||
try:
|
try:
|
||||||
await websocket.send_json({"type": "auth_error", "reason": "auth timeout"})
|
await websocket.send_json({"type": "auth_error", "reason": "auth timeout"})
|
||||||
except Exception:
|
except _WS_SEND_BENIGN_EXC:
|
||||||
pass
|
pass
|
||||||
return None
|
return None
|
||||||
except WebSocketDisconnect:
|
except WebSocketDisconnect:
|
||||||
return None
|
return None
|
||||||
except Exception as exc:
|
except (RuntimeError, ConnectionError, OSError) as exc:
|
||||||
|
# The peer hung up mid-handshake or the underlying socket is gone.
|
||||||
|
# Promote anything outside this set to a hard failure with a stack
|
||||||
|
# trace so we can see real bugs (decode errors, type errors, …).
|
||||||
logger.debug("WebSocket auth receive error: %s", exc)
|
logger.debug("WebSocket auth receive error: %s", exc)
|
||||||
return None
|
return None
|
||||||
|
except Exception:
|
||||||
|
# Unexpected — log the full traceback so we can see what we missed
|
||||||
|
# without leaving the connection half-open. Re-raise nothing; the
|
||||||
|
# caller will close on the None return.
|
||||||
|
logger.exception("Unexpected error during WebSocket auth handshake")
|
||||||
|
return None
|
||||||
|
|
||||||
# Parse the auth message.
|
# Parse the auth message.
|
||||||
try:
|
try:
|
||||||
@@ -244,7 +303,7 @@ async def verify_ws_auth(
|
|||||||
await websocket.send_json(
|
await websocket.send_json(
|
||||||
{"type": "auth_error", "reason": "invalid JSON in auth message"}
|
{"type": "auth_error", "reason": "invalid JSON in auth message"}
|
||||||
)
|
)
|
||||||
except Exception:
|
except _WS_SEND_BENIGN_EXC:
|
||||||
pass
|
pass
|
||||||
return None
|
return None
|
||||||
|
|
||||||
@@ -253,7 +312,7 @@ async def verify_ws_auth(
|
|||||||
await websocket.send_json(
|
await websocket.send_json(
|
||||||
{"type": "auth_error", "reason": "first message must be {type:'auth'}"}
|
{"type": "auth_error", "reason": "first message must be {type:'auth'}"}
|
||||||
)
|
)
|
||||||
except Exception:
|
except _WS_SEND_BENIGN_EXC:
|
||||||
pass
|
pass
|
||||||
return None
|
return None
|
||||||
|
|
||||||
@@ -263,7 +322,7 @@ async def verify_ws_auth(
|
|||||||
await websocket.send_json(
|
await websocket.send_json(
|
||||||
{"type": "auth_error", "reason": "token must be a string or null"}
|
{"type": "auth_error", "reason": "token must be a string or null"}
|
||||||
)
|
)
|
||||||
except Exception:
|
except _WS_SEND_BENIGN_EXC:
|
||||||
pass
|
pass
|
||||||
return None
|
return None
|
||||||
|
|
||||||
@@ -280,7 +339,7 @@ async def verify_ws_auth(
|
|||||||
"reason": "LAN access requires an API key",
|
"reason": "LAN access requires an API key",
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
except Exception:
|
except _WS_SEND_BENIGN_EXC:
|
||||||
pass
|
pass
|
||||||
return None
|
return None
|
||||||
|
|
||||||
@@ -290,13 +349,13 @@ async def verify_ws_auth(
|
|||||||
logger.warning("Invalid WebSocket auth attempt from %s", client_host)
|
logger.warning("Invalid WebSocket auth attempt from %s", client_host)
|
||||||
try:
|
try:
|
||||||
await websocket.send_json({"type": "auth_error", "reason": "invalid token"})
|
await websocket.send_json({"type": "auth_error", "reason": "invalid token"})
|
||||||
except Exception:
|
except _WS_SEND_BENIGN_EXC:
|
||||||
pass
|
pass
|
||||||
return None
|
return None
|
||||||
|
|
||||||
try:
|
try:
|
||||||
await websocket.send_json({"type": "auth_ok"})
|
await websocket.send_json({"type": "auth_ok"})
|
||||||
except Exception:
|
except _WS_SEND_BENIGN_EXC:
|
||||||
return None
|
return None
|
||||||
logger.debug("WebSocket authenticated as: %s", label)
|
logger.debug("WebSocket authenticated as: %s", label)
|
||||||
return label
|
return label
|
||||||
|
|||||||
@@ -37,6 +37,7 @@ from ledgrab.storage.game_integration_store import GameIntegrationStore
|
|||||||
from ledgrab.core.game_integration.event_bus import GameEventBus
|
from ledgrab.core.game_integration.event_bus import GameEventBus
|
||||||
from ledgrab.storage.mqtt_source_store import MQTTSourceStore
|
from ledgrab.storage.mqtt_source_store import MQTTSourceStore
|
||||||
from ledgrab.core.mqtt.mqtt_manager import MQTTManager
|
from ledgrab.core.mqtt.mqtt_manager import MQTTManager
|
||||||
|
from ledgrab.storage.http_endpoint_store import HTTPEndpointStore
|
||||||
from ledgrab.storage.audio_processing_template_store import AudioProcessingTemplateStore
|
from ledgrab.storage.audio_processing_template_store import AudioProcessingTemplateStore
|
||||||
from ledgrab.storage.pattern_template_store import PatternTemplateStore
|
from ledgrab.storage.pattern_template_store import PatternTemplateStore
|
||||||
|
|
||||||
@@ -165,6 +166,10 @@ def get_mqtt_manager() -> MQTTManager:
|
|||||||
return _get("mqtt_manager", "MQTT manager")
|
return _get("mqtt_manager", "MQTT manager")
|
||||||
|
|
||||||
|
|
||||||
|
def get_http_endpoint_store() -> HTTPEndpointStore:
|
||||||
|
return _get("http_endpoint_store", "HTTP endpoint store")
|
||||||
|
|
||||||
|
|
||||||
def get_audio_processing_template_store() -> AudioProcessingTemplateStore:
|
def get_audio_processing_template_store() -> AudioProcessingTemplateStore:
|
||||||
return _get("audio_processing_template_store", "Audio processing template store")
|
return _get("audio_processing_template_store", "Audio processing template store")
|
||||||
|
|
||||||
@@ -237,6 +242,7 @@ def init_dependencies(
|
|||||||
game_event_bus: GameEventBus | None = None,
|
game_event_bus: GameEventBus | None = None,
|
||||||
mqtt_store: MQTTSourceStore | None = None,
|
mqtt_store: MQTTSourceStore | None = None,
|
||||||
mqtt_manager: MQTTManager | None = None,
|
mqtt_manager: MQTTManager | None = None,
|
||||||
|
http_endpoint_store: HTTPEndpointStore | None = None,
|
||||||
audio_processing_template_store: AudioProcessingTemplateStore | None = None,
|
audio_processing_template_store: AudioProcessingTemplateStore | None = None,
|
||||||
pattern_template_store: PatternTemplateStore | None = None,
|
pattern_template_store: PatternTemplateStore | None = None,
|
||||||
):
|
):
|
||||||
@@ -272,6 +278,7 @@ def init_dependencies(
|
|||||||
"game_event_bus": game_event_bus,
|
"game_event_bus": game_event_bus,
|
||||||
"mqtt_store": mqtt_store,
|
"mqtt_store": mqtt_store,
|
||||||
"mqtt_manager": mqtt_manager,
|
"mqtt_manager": mqtt_manager,
|
||||||
|
"http_endpoint_store": http_endpoint_store,
|
||||||
"audio_processing_template_store": audio_processing_template_store,
|
"audio_processing_template_store": audio_processing_template_store,
|
||||||
"pattern_template_store": pattern_template_store,
|
"pattern_template_store": pattern_template_store,
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,609 @@
|
|||||||
|
"""Authoritative wiring-graph schema and topology engine.
|
||||||
|
|
||||||
|
This module is the single source of truth for **which reference fields connect
|
||||||
|
which entity kinds**. The frontend graph editor historically hard-coded the same
|
||||||
|
information in two places (``graph-connections.ts`` ``CONNECTION_MAP`` and
|
||||||
|
``graph-layout.ts`` ``buildGraph``); the ``GET /api/v1/graph/schema`` endpoint
|
||||||
|
now serves this registry so the client can render ports and edges generically
|
||||||
|
and the two never drift.
|
||||||
|
|
||||||
|
This registry is a *superset* of the current frontend ``buildGraph``: it also
|
||||||
|
declares real references that ``buildGraph`` does not yet draw (e.g.
|
||||||
|
``value_source.value_source_id`` chaining and ``value_source.color_strip_source_id``).
|
||||||
|
The backend is authoritative; the client is expected to converge on it.
|
||||||
|
|
||||||
|
Everything in this module is pure (operates on plain dicts), so the topology
|
||||||
|
build, dependency lookup, cycle and dangling-reference detection are all unit
|
||||||
|
testable without booting the app or any store.
|
||||||
|
|
||||||
|
Field-path grammar (the ``field`` of a :class:`ConnectionField`):
|
||||||
|
|
||||||
|
* ``"device_id"`` — a top-level string id.
|
||||||
|
* ``"brightness.source_id"`` — a nested object; ``brightness`` may be a
|
||||||
|
plain number (unbound :class:`BindableFloat`) or ``{"value", "source_id"}``.
|
||||||
|
* ``"settings.pattern_template_id"`` — arbitrarily deep object access.
|
||||||
|
* ``"layers[].source_id"`` — ``layers`` is a list; read ``source_id``
|
||||||
|
from every element.
|
||||||
|
* ``"calibration.lines[].picture_source_id"`` — object → list → field.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
from dataclasses import asdict, dataclass, is_dataclass
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class ConnectionField:
|
||||||
|
"""One connectable reference: ``target_kind.field`` points at ``source_kind``."""
|
||||||
|
|
||||||
|
target_kind: str
|
||||||
|
"""Entity kind that *holds* the reference (the consumer / referrer)."""
|
||||||
|
field: str
|
||||||
|
"""Dot-path to the reference value (see module docstring grammar)."""
|
||||||
|
source_kind: str
|
||||||
|
"""Entity kind being referenced (the producer / source)."""
|
||||||
|
edge_type: str
|
||||||
|
"""Edge category, used by the client for colour and port grouping."""
|
||||||
|
bindable: bool = False
|
||||||
|
"""True when the slot is a :class:`BindableFloat`/``BindableColor`` value binding."""
|
||||||
|
nested: bool = False
|
||||||
|
"""True when the field lives inside a nested object/list (dotted path)."""
|
||||||
|
|
||||||
|
@property
|
||||||
|
def is_list(self) -> bool:
|
||||||
|
"""True when any path segment iterates a list (``foo[]``)."""
|
||||||
|
return "[]" in self.field
|
||||||
|
|
||||||
|
|
||||||
|
# ── Entity kinds & their human "type" attribute ────────────────────────────
|
||||||
|
# Mirrors the frontend buildGraph(): kind → the serialized field that carries
|
||||||
|
# the entity's subtype (used only for the node label / icon).
|
||||||
|
NODE_TYPE_FIELD: dict[str, str] = {
|
||||||
|
"device": "device_type",
|
||||||
|
"capture_template": "engine_type",
|
||||||
|
"pp_template": "",
|
||||||
|
"audio_template": "engine_type",
|
||||||
|
"pattern_template": "",
|
||||||
|
"picture_source": "stream_type",
|
||||||
|
"audio_source": "source_type",
|
||||||
|
"value_source": "source_type",
|
||||||
|
"color_strip_source": "source_type",
|
||||||
|
"sync_clock": "",
|
||||||
|
"output_target": "target_type",
|
||||||
|
"scene_preset": "",
|
||||||
|
"automation": "",
|
||||||
|
"cspt": "",
|
||||||
|
}
|
||||||
|
|
||||||
|
ENTITY_KINDS: tuple[str, ...] = tuple(NODE_TYPE_FIELD.keys())
|
||||||
|
|
||||||
|
|
||||||
|
# ── The registry ───────────────────────────────────────────────────────────
|
||||||
|
# NOTE: ``gradient`` and ``ha_source`` reference fields are intentionally
|
||||||
|
# omitted — they are not first-class graph node kinds, so wiring them would
|
||||||
|
# only ever produce dangling-reference noise.
|
||||||
|
CONNECTION_SCHEMA: tuple[ConnectionField, ...] = (
|
||||||
|
# ── Picture sources ──
|
||||||
|
ConnectionField("picture_source", "capture_template_id", "capture_template", "template"),
|
||||||
|
ConnectionField("picture_source", "source_stream_id", "picture_source", "picture"),
|
||||||
|
ConnectionField("picture_source", "postprocessing_template_id", "pp_template", "template"),
|
||||||
|
# ── Audio sources ──
|
||||||
|
ConnectionField("audio_source", "audio_template_id", "audio_template", "audio"),
|
||||||
|
ConnectionField("audio_source", "audio_source_id", "audio_source", "audio"),
|
||||||
|
# ── Value sources ──
|
||||||
|
ConnectionField("value_source", "audio_source_id", "audio_source", "audio"),
|
||||||
|
ConnectionField("value_source", "picture_source_id", "picture_source", "picture"),
|
||||||
|
ConnectionField("value_source", "value_source_id", "value_source", "value"),
|
||||||
|
ConnectionField("value_source", "color_strip_source_id", "color_strip_source", "colorstrip"),
|
||||||
|
# AnimatedColorValueSource references a sync clock for shared timing.
|
||||||
|
ConnectionField("value_source", "clock_id", "sync_clock", "clock"),
|
||||||
|
# ── Color strip sources (top-level) ──
|
||||||
|
ConnectionField("color_strip_source", "picture_source_id", "picture_source", "picture"),
|
||||||
|
ConnectionField("color_strip_source", "audio_source_id", "audio_source", "audio"),
|
||||||
|
ConnectionField("color_strip_source", "clock_id", "sync_clock", "clock"),
|
||||||
|
ConnectionField("color_strip_source", "input_source_id", "color_strip_source", "colorstrip"),
|
||||||
|
ConnectionField("color_strip_source", "processing_template_id", "cspt", "template"),
|
||||||
|
# ── Color strip sources (BindableFloat value bindings) ──
|
||||||
|
*(
|
||||||
|
ConnectionField(
|
||||||
|
"color_strip_source",
|
||||||
|
f"{prop}.source_id",
|
||||||
|
"value_source",
|
||||||
|
"value",
|
||||||
|
bindable=True,
|
||||||
|
nested=True,
|
||||||
|
)
|
||||||
|
for prop in (
|
||||||
|
"smoothing",
|
||||||
|
"sensitivity",
|
||||||
|
"intensity",
|
||||||
|
"scale",
|
||||||
|
"speed",
|
||||||
|
"wind_strength",
|
||||||
|
"temperature_influence",
|
||||||
|
"sound_volume",
|
||||||
|
"timeout",
|
||||||
|
"brightness",
|
||||||
|
)
|
||||||
|
),
|
||||||
|
# ── Color strip sources (BindableColor value bindings) ──
|
||||||
|
# NOTE: `bindable` here is *structural* (these are BindableColor fields). They
|
||||||
|
# are NOT usefully wireable from the graph: a ValueStream yields a scalar
|
||||||
|
# (`get_value() -> float`) and every colour consumer reads the static RGB via
|
||||||
|
# `bcolor()` (source_id ignored at runtime). The graph editor keeps them
|
||||||
|
# read-only; do not enable them without a colour-producing value source.
|
||||||
|
*(
|
||||||
|
ConnectionField(
|
||||||
|
"color_strip_source",
|
||||||
|
f"{prop}.source_id",
|
||||||
|
"value_source",
|
||||||
|
"value",
|
||||||
|
bindable=True,
|
||||||
|
nested=True,
|
||||||
|
)
|
||||||
|
for prop in ("color", "color_peak", "fallback_color", "default_color")
|
||||||
|
),
|
||||||
|
# ── Color strip sources (composite layers / mapped zones / calibration) ──
|
||||||
|
ConnectionField(
|
||||||
|
"color_strip_source", "layers[].source_id", "color_strip_source", "colorstrip", nested=True
|
||||||
|
),
|
||||||
|
ConnectionField(
|
||||||
|
"color_strip_source",
|
||||||
|
"layers[].brightness_source_id",
|
||||||
|
"value_source",
|
||||||
|
"value",
|
||||||
|
bindable=True,
|
||||||
|
nested=True,
|
||||||
|
),
|
||||||
|
ConnectionField(
|
||||||
|
"color_strip_source", "layers[].processing_template_id", "cspt", "template", nested=True
|
||||||
|
),
|
||||||
|
ConnectionField(
|
||||||
|
"color_strip_source", "zones[].source_id", "color_strip_source", "colorstrip", nested=True
|
||||||
|
),
|
||||||
|
ConnectionField(
|
||||||
|
"color_strip_source",
|
||||||
|
"calibration.lines[].picture_source_id",
|
||||||
|
"picture_source",
|
||||||
|
"picture",
|
||||||
|
nested=True,
|
||||||
|
),
|
||||||
|
# ── Output targets ──
|
||||||
|
ConnectionField("output_target", "device_id", "device", "device"),
|
||||||
|
ConnectionField("output_target", "color_strip_source_id", "color_strip_source", "colorstrip"),
|
||||||
|
ConnectionField(
|
||||||
|
"output_target", "brightness.source_id", "value_source", "value", bindable=True, nested=True
|
||||||
|
),
|
||||||
|
ConnectionField(
|
||||||
|
"output_target", "transition.source_id", "value_source", "value", bindable=True, nested=True
|
||||||
|
),
|
||||||
|
ConnectionField(
|
||||||
|
"output_target", "settings.pattern_template_id", "pattern_template", "template", nested=True
|
||||||
|
),
|
||||||
|
ConnectionField(
|
||||||
|
"output_target",
|
||||||
|
"settings.brightness.source_id",
|
||||||
|
"value_source",
|
||||||
|
"value",
|
||||||
|
bindable=True,
|
||||||
|
nested=True,
|
||||||
|
),
|
||||||
|
# ── Scene presets ──
|
||||||
|
ConnectionField("scene_preset", "targets[].target_id", "output_target", "scene", nested=True),
|
||||||
|
# ── Automations ──
|
||||||
|
ConnectionField("automation", "scene_preset_id", "scene_preset", "scene"),
|
||||||
|
ConnectionField("automation", "deactivation_scene_preset_id", "scene_preset", "scene"),
|
||||||
|
# ── Devices ──
|
||||||
|
ConnectionField("device", "default_css_processing_template_id", "cspt", "template"),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def schema_for_kind(kind: str) -> list[ConnectionField]:
|
||||||
|
"""Every connectable field whose *referrer* is ``kind``."""
|
||||||
|
return [c for c in CONNECTION_SCHEMA if c.target_kind == kind]
|
||||||
|
|
||||||
|
|
||||||
|
# BindableColor slots are structurally bindable but NOT graph-editable: a
|
||||||
|
# ValueStream yields a scalar (``get_value() -> float``) and colour consumers
|
||||||
|
# read the static RGB via ``bcolor()`` (source_id ignored at runtime), so a
|
||||||
|
# value source cannot drive a colour.
|
||||||
|
_COLOR_BINDABLE_FIELDS: frozenset[str] = frozenset(
|
||||||
|
{
|
||||||
|
"color.source_id",
|
||||||
|
"color_peak.source_id",
|
||||||
|
"fallback_color.source_id",
|
||||||
|
"default_color.source_id",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def is_editable(cf: ConnectionField) -> bool:
|
||||||
|
"""Whether a field can be wired from the graph.
|
||||||
|
|
||||||
|
Editable = a top-level reference, or a single-level ``BindableFloat`` slot.
|
||||||
|
List slots (need an element index), double-nested fields, and the dead
|
||||||
|
colour bindings stay read-only.
|
||||||
|
"""
|
||||||
|
if cf.is_list:
|
||||||
|
return False
|
||||||
|
if not cf.nested:
|
||||||
|
return True
|
||||||
|
return cf.bindable and cf.field.count(".") == 1 and cf.field not in _COLOR_BINDABLE_FIELDS
|
||||||
|
|
||||||
|
|
||||||
|
def schema_as_dicts() -> list[dict[str, Any]]:
|
||||||
|
"""Serialize the registry for the ``/graph/schema`` endpoint."""
|
||||||
|
return [
|
||||||
|
{
|
||||||
|
"target_kind": c.target_kind,
|
||||||
|
"field": c.field,
|
||||||
|
"source_kind": c.source_kind,
|
||||||
|
"edge_type": c.edge_type,
|
||||||
|
"bindable": c.bindable,
|
||||||
|
"nested": c.nested,
|
||||||
|
"is_list": c.is_list,
|
||||||
|
"editable": is_editable(c),
|
||||||
|
}
|
||||||
|
for c in CONNECTION_SCHEMA
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
# ── Reference extraction ────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
|
||||||
|
def extract_refs(entity: dict[str, Any], field_path: str) -> list[str]:
|
||||||
|
"""Resolve a (possibly nested/list) ``field_path`` to its referenced ids.
|
||||||
|
|
||||||
|
Returns only non-empty string ids. Tolerant of missing keys, ``None``
|
||||||
|
values and unbound bindables (a plain number where an object was expected).
|
||||||
|
"""
|
||||||
|
current: list[Any] = [entity]
|
||||||
|
for segment in field_path.split("."):
|
||||||
|
is_list = segment.endswith("[]")
|
||||||
|
key = segment[:-2] if is_list else segment
|
||||||
|
nxt: list[Any] = []
|
||||||
|
for obj in current:
|
||||||
|
if not isinstance(obj, dict):
|
||||||
|
continue
|
||||||
|
val = obj.get(key)
|
||||||
|
if is_list:
|
||||||
|
if isinstance(val, list):
|
||||||
|
nxt.extend(val)
|
||||||
|
elif val is not None:
|
||||||
|
nxt.append(val)
|
||||||
|
current = nxt
|
||||||
|
return [v for v in current if isinstance(v, str) and v]
|
||||||
|
|
||||||
|
|
||||||
|
def remap_refs(entity: dict[str, Any], field_path: str, id_map: dict[str, str]) -> int:
|
||||||
|
"""Rewrite referenced ids under ``field_path`` *in place*, using ``id_map``.
|
||||||
|
|
||||||
|
The write-twin of :func:`extract_refs`: it walks the same dot/list/bindable
|
||||||
|
grammar and replaces any leaf id present in ``id_map`` with its mapped value.
|
||||||
|
Ids absent from ``id_map`` (references to entities outside the remap set) are
|
||||||
|
left untouched, so a clone keeps sharing its un-cloned dependencies. Unbound
|
||||||
|
bindables (a plain number where an object was expected) and missing keys are
|
||||||
|
tolerated. Returns the number of ids rewritten.
|
||||||
|
"""
|
||||||
|
segments = field_path.split(".")
|
||||||
|
# Descend to the container(s) that hold the final key.
|
||||||
|
parents: list[Any] = [entity]
|
||||||
|
for segment in segments[:-1]:
|
||||||
|
is_list = segment.endswith("[]")
|
||||||
|
key = segment[:-2] if is_list else segment
|
||||||
|
nxt: list[Any] = []
|
||||||
|
for obj in parents:
|
||||||
|
if not isinstance(obj, dict):
|
||||||
|
continue
|
||||||
|
val = obj.get(key)
|
||||||
|
if is_list:
|
||||||
|
if isinstance(val, list):
|
||||||
|
nxt.extend(val)
|
||||||
|
elif isinstance(val, dict):
|
||||||
|
nxt.append(val)
|
||||||
|
parents = nxt
|
||||||
|
|
||||||
|
last = segments[-1]
|
||||||
|
last_is_list = last.endswith("[]")
|
||||||
|
key = last[:-2] if last_is_list else last
|
||||||
|
count = 0
|
||||||
|
for obj in parents:
|
||||||
|
if not isinstance(obj, dict):
|
||||||
|
continue
|
||||||
|
val = obj.get(key)
|
||||||
|
if last_is_list:
|
||||||
|
if isinstance(val, list):
|
||||||
|
for i, item in enumerate(val):
|
||||||
|
if isinstance(item, str) and item in id_map:
|
||||||
|
val[i] = id_map[item]
|
||||||
|
count += 1
|
||||||
|
elif isinstance(val, str) and val in id_map:
|
||||||
|
obj[key] = id_map[val]
|
||||||
|
count += 1
|
||||||
|
return count
|
||||||
|
|
||||||
|
|
||||||
|
def serialize_entity(model: Any) -> dict[str, Any]:
|
||||||
|
"""Best-effort serialize a storage model to a plain dict for graph use.
|
||||||
|
|
||||||
|
Prefers ``dataclasses.asdict`` (pure structural, recurses bindables/lists,
|
||||||
|
invokes no managers), falling back to ``to_dict()`` then ``{}``.
|
||||||
|
"""
|
||||||
|
if is_dataclass(model) and not isinstance(model, type):
|
||||||
|
try:
|
||||||
|
return asdict(model)
|
||||||
|
except Exception as exc: # noqa: BLE001 — defensive: never let one model break the graph
|
||||||
|
logger.debug("graph: asdict failed for %r: %s", type(model).__name__, exc)
|
||||||
|
to_dict = getattr(model, "to_dict", None)
|
||||||
|
if callable(to_dict):
|
||||||
|
try:
|
||||||
|
result = to_dict()
|
||||||
|
if isinstance(result, dict):
|
||||||
|
return result
|
||||||
|
except Exception as exc: # noqa: BLE001
|
||||||
|
logger.debug("graph: to_dict failed for %r: %s", type(model).__name__, exc)
|
||||||
|
logger.warning(
|
||||||
|
"graph: could not serialize model %r; excluding from graph", type(model).__name__
|
||||||
|
)
|
||||||
|
return {}
|
||||||
|
|
||||||
|
|
||||||
|
def graph_field_roots(kind: str) -> set[str]:
|
||||||
|
"""Top-level keys the graph needs for ``kind``: ``id``/``name``, the subtype
|
||||||
|
field, and the root segment of every reference path for that kind."""
|
||||||
|
roots: set[str] = {"id", "name"}
|
||||||
|
type_field = NODE_TYPE_FIELD.get(kind, "")
|
||||||
|
if type_field:
|
||||||
|
roots.add(type_field)
|
||||||
|
for cf in CONNECTION_SCHEMA:
|
||||||
|
if cf.target_kind == kind:
|
||||||
|
roots.add(cf.field.split(".", 1)[0].removesuffix("[]"))
|
||||||
|
return roots
|
||||||
|
|
||||||
|
|
||||||
|
def serialize_entity_for_graph(kind: str, model: Any) -> dict[str, Any]:
|
||||||
|
"""Serialize a model and project it to ONLY the keys the graph needs.
|
||||||
|
|
||||||
|
This projection is a **security boundary**: a full ``asdict``/``to_dict``
|
||||||
|
can carry secrets (webhook tokens, device/HA/MQTT credentials), so every
|
||||||
|
field except ``id``/``name``, the subtype field and reference-path roots is
|
||||||
|
dropped before the data reaches the graph API.
|
||||||
|
"""
|
||||||
|
full = serialize_entity(model)
|
||||||
|
roots = graph_field_roots(kind)
|
||||||
|
return {k: v for k, v in full.items() if k in roots}
|
||||||
|
|
||||||
|
|
||||||
|
# ── Topology / validation ───────────────────────────────────────────────────
|
||||||
|
|
||||||
|
|
||||||
|
def _node_from(kind: str, entity: dict[str, Any]) -> dict[str, Any] | None:
|
||||||
|
eid = entity.get("id")
|
||||||
|
if not isinstance(eid, str) or not eid:
|
||||||
|
return None
|
||||||
|
type_field = NODE_TYPE_FIELD.get(kind, "")
|
||||||
|
subtype = entity.get(type_field, "") if type_field else ""
|
||||||
|
return {
|
||||||
|
"id": eid,
|
||||||
|
"kind": kind,
|
||||||
|
"name": entity.get("name") or eid,
|
||||||
|
"type": subtype if isinstance(subtype, str) else "",
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def build_topology(entities_by_kind: dict[str, list[dict[str, Any]]]) -> dict[str, Any]:
|
||||||
|
"""Build the full wiring graph + a validation report.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
entities_by_kind: ``{kind: [serialized_entity_dict, ...]}``.
|
||||||
|
|
||||||
|
Returns a dict with ``nodes``, ``edges`` and ``issues`` (``orphans``,
|
||||||
|
``broken_refs``, ``cycles``).
|
||||||
|
"""
|
||||||
|
nodes: list[dict[str, Any]] = []
|
||||||
|
node_ids: set[str] = set()
|
||||||
|
for kind in ENTITY_KINDS:
|
||||||
|
for entity in entities_by_kind.get(kind, []):
|
||||||
|
node = _node_from(kind, entity)
|
||||||
|
if node and node["id"] not in node_ids:
|
||||||
|
node_ids.add(node["id"])
|
||||||
|
nodes.append(node)
|
||||||
|
|
||||||
|
edges: list[dict[str, Any]] = []
|
||||||
|
broken_refs: list[dict[str, str]] = []
|
||||||
|
for cf in CONNECTION_SCHEMA:
|
||||||
|
for entity in entities_by_kind.get(cf.target_kind, []):
|
||||||
|
referrer = entity.get("id")
|
||||||
|
if not isinstance(referrer, str) or not referrer:
|
||||||
|
continue
|
||||||
|
for ref in extract_refs(entity, cf.field):
|
||||||
|
if ref not in node_ids:
|
||||||
|
broken_refs.append({"ref": ref, "by": referrer, "field": cf.field})
|
||||||
|
continue
|
||||||
|
edges.append(
|
||||||
|
{
|
||||||
|
"from": ref,
|
||||||
|
"to": referrer,
|
||||||
|
"field": cf.field,
|
||||||
|
"edge_type": cf.edge_type,
|
||||||
|
"nested": cf.nested,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
connected: set[str] = set()
|
||||||
|
for e in edges:
|
||||||
|
connected.add(e["from"])
|
||||||
|
connected.add(e["to"])
|
||||||
|
orphans = sorted(nid for nid in node_ids if nid not in connected)
|
||||||
|
cycles = sorted(detect_cycles(edges))
|
||||||
|
|
||||||
|
return {
|
||||||
|
"nodes": nodes,
|
||||||
|
"edges": edges,
|
||||||
|
"issues": {
|
||||||
|
"orphans": orphans,
|
||||||
|
"broken_refs": broken_refs,
|
||||||
|
"cycles": cycles,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def find_dependents(
|
||||||
|
entities_by_kind: dict[str, list[dict[str, Any]]], kind: str, entity_id: str
|
||||||
|
) -> list[dict[str, str]]:
|
||||||
|
"""Return every entity that references ``(kind, entity_id)``.
|
||||||
|
|
||||||
|
``kind`` is the kind of the *referenced* entity; matching schema entries are
|
||||||
|
those whose ``source_kind == kind``.
|
||||||
|
"""
|
||||||
|
name_by_id: dict[str, str] = {}
|
||||||
|
for k in ENTITY_KINDS:
|
||||||
|
for entity in entities_by_kind.get(k, []):
|
||||||
|
eid = entity.get("id")
|
||||||
|
if isinstance(eid, str):
|
||||||
|
name_by_id[eid] = entity.get("name") or eid
|
||||||
|
|
||||||
|
dependents: list[dict[str, str]] = []
|
||||||
|
seen: set[tuple[str, str]] = set()
|
||||||
|
for cf in CONNECTION_SCHEMA:
|
||||||
|
if cf.source_kind != kind:
|
||||||
|
continue
|
||||||
|
for entity in entities_by_kind.get(cf.target_kind, []):
|
||||||
|
referrer = entity.get("id")
|
||||||
|
if not isinstance(referrer, str):
|
||||||
|
continue
|
||||||
|
if entity_id in extract_refs(entity, cf.field):
|
||||||
|
key = (referrer, cf.field)
|
||||||
|
if key in seen:
|
||||||
|
continue
|
||||||
|
seen.add(key)
|
||||||
|
dependents.append(
|
||||||
|
{
|
||||||
|
"id": referrer,
|
||||||
|
"kind": cf.target_kind,
|
||||||
|
"name": name_by_id.get(referrer, referrer),
|
||||||
|
"field": cf.field,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
return dependents
|
||||||
|
|
||||||
|
|
||||||
|
def detect_cycles(edges: list[dict[str, Any]]) -> set[str]:
|
||||||
|
"""Return every node id that participates in a directed cycle (from→to)."""
|
||||||
|
adj: dict[str, list[str]] = {}
|
||||||
|
for e in edges:
|
||||||
|
adj.setdefault(e["from"], []).append(e["to"])
|
||||||
|
|
||||||
|
WHITE, GRAY, BLACK = 0, 1, 2
|
||||||
|
color: dict[str, int] = {}
|
||||||
|
in_cycle: set[str] = set()
|
||||||
|
|
||||||
|
for start in list(adj.keys()):
|
||||||
|
if color.get(start, WHITE) != WHITE:
|
||||||
|
continue
|
||||||
|
stack: list[tuple[str, int]] = [(start, 0)]
|
||||||
|
path: list[str] = [start]
|
||||||
|
color[start] = GRAY
|
||||||
|
while stack:
|
||||||
|
node, idx = stack[-1]
|
||||||
|
neighbors = adj.get(node, [])
|
||||||
|
if idx < len(neighbors):
|
||||||
|
stack[-1] = (node, idx + 1)
|
||||||
|
nxt = neighbors[idx]
|
||||||
|
c = color.get(nxt, WHITE)
|
||||||
|
if c == GRAY:
|
||||||
|
if nxt in path:
|
||||||
|
i = path.index(nxt)
|
||||||
|
in_cycle.update(path[i:])
|
||||||
|
elif c == WHITE:
|
||||||
|
color[nxt] = GRAY
|
||||||
|
path.append(nxt)
|
||||||
|
stack.append((nxt, 0))
|
||||||
|
else:
|
||||||
|
color[node] = BLACK
|
||||||
|
if path and path[-1] == node:
|
||||||
|
path.pop()
|
||||||
|
stack.pop()
|
||||||
|
return in_cycle
|
||||||
|
|
||||||
|
|
||||||
|
def _reachable(edges: list[dict[str, Any]], start: str, goal: str) -> bool:
|
||||||
|
"""True if ``goal`` is reachable from ``start`` following from→to edges."""
|
||||||
|
if start == goal:
|
||||||
|
return True
|
||||||
|
adj: dict[str, list[str]] = {}
|
||||||
|
for e in edges:
|
||||||
|
adj.setdefault(e["from"], []).append(e["to"])
|
||||||
|
seen = {start}
|
||||||
|
queue = [start]
|
||||||
|
while queue:
|
||||||
|
cur = queue.pop()
|
||||||
|
for nxt in adj.get(cur, []):
|
||||||
|
if nxt == goal:
|
||||||
|
return True
|
||||||
|
if nxt not in seen:
|
||||||
|
seen.add(nxt)
|
||||||
|
queue.append(nxt)
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def would_create_cycle(edges: list[dict[str, Any]], source_id: str, target_id: str) -> bool:
|
||||||
|
"""Would wiring ``source_id`` into ``target_id`` (edge source→target) loop?
|
||||||
|
|
||||||
|
A cycle forms if ``source_id`` is already reachable from ``target_id`` via
|
||||||
|
the existing data-flow edges (so the new edge would close the loop), or the
|
||||||
|
two are the same node.
|
||||||
|
"""
|
||||||
|
if source_id == target_id:
|
||||||
|
return True
|
||||||
|
return _reachable(edges, target_id, source_id)
|
||||||
|
|
||||||
|
|
||||||
|
def _entity_exists(
|
||||||
|
entities_by_kind: dict[str, list[dict[str, Any]]], kind: str, entity_id: str
|
||||||
|
) -> bool:
|
||||||
|
return any(e.get("id") == entity_id for e in entities_by_kind.get(kind, []))
|
||||||
|
|
||||||
|
|
||||||
|
def validate_connection(
|
||||||
|
entities_by_kind: dict[str, list[dict[str, Any]]],
|
||||||
|
target_kind: str,
|
||||||
|
target_id: str,
|
||||||
|
field: str,
|
||||||
|
source_id: str,
|
||||||
|
) -> tuple[bool, str | None]:
|
||||||
|
"""Validate a proposed wiring edit before it is persisted.
|
||||||
|
|
||||||
|
Checks, in order: the field is a known connectable reference; the target
|
||||||
|
exists; (when not detaching) the source exists and is of the registry's
|
||||||
|
expected kind; and the edit would not create a dependency cycle. Returns
|
||||||
|
``(ok, error_message)``. Detaching (empty ``source_id``) is always allowed.
|
||||||
|
"""
|
||||||
|
cf = next(
|
||||||
|
(c for c in CONNECTION_SCHEMA if c.target_kind == target_kind and c.field == field),
|
||||||
|
None,
|
||||||
|
)
|
||||||
|
if cf is None:
|
||||||
|
return False, f"Unknown connection field: {target_kind}.{field}"
|
||||||
|
if not is_editable(cf):
|
||||||
|
# List slots (need an element index), double-nested fields, and dead
|
||||||
|
# colour bindings can't be wired from the graph — edit via the entity
|
||||||
|
# editor instead.
|
||||||
|
return False, f"Field '{field}' is not editable via the graph"
|
||||||
|
if not _entity_exists(entities_by_kind, target_kind, target_id):
|
||||||
|
return False, f"Target entity not found: {target_id}"
|
||||||
|
if not source_id:
|
||||||
|
return True, None # detaching a slot is always valid
|
||||||
|
if not _entity_exists(entities_by_kind, cf.source_kind, source_id):
|
||||||
|
return False, f"Source {cf.source_kind} not found: {source_id}"
|
||||||
|
# Cycle check: ignore the edge currently occupying this slot, since the
|
||||||
|
# write replaces it.
|
||||||
|
topo = build_topology(entities_by_kind)
|
||||||
|
edges = [e for e in topo["edges"] if not (e["to"] == target_id and e["field"] == field)]
|
||||||
|
if would_create_cycle(edges, source_id, target_id):
|
||||||
|
return False, "Connection would create a dependency cycle"
|
||||||
|
return True, None
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
"""Shared MQTT-source validation for route handlers.
|
||||||
|
|
||||||
|
Both the device routes and the output-target routes accept an
|
||||||
|
``mqtt_source_id`` that must reference an existing ``MQTTSource``. This module
|
||||||
|
is the single source of truth for that check so the two callers cannot drift.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from fastapi import HTTPException
|
||||||
|
|
||||||
|
from ledgrab.storage.base_store import EntityNotFoundError
|
||||||
|
from ledgrab.storage.mqtt_source_store import MQTTSourceStore
|
||||||
|
|
||||||
|
|
||||||
|
def validate_mqtt_source_exists(mqtt_store: MQTTSourceStore, mqtt_source_id: str | None) -> None:
|
||||||
|
"""Ensure a referenced MQTT source exists.
|
||||||
|
|
||||||
|
Empty / ``None`` is allowed (unconfigured = "first available broker").
|
||||||
|
Raises ``HTTPException(422)`` if a non-empty id does not resolve.
|
||||||
|
"""
|
||||||
|
if not mqtt_source_id:
|
||||||
|
return
|
||||||
|
try:
|
||||||
|
mqtt_store.get(mqtt_source_id)
|
||||||
|
except (ValueError, EntityNotFoundError):
|
||||||
|
raise HTTPException(status_code=422, detail=f"MQTT source {mqtt_source_id} not found")
|
||||||
@@ -3,7 +3,7 @@
|
|||||||
import asyncio
|
import asyncio
|
||||||
import threading
|
import threading
|
||||||
import time
|
import time
|
||||||
from typing import Callable, Optional
|
from typing import Callable
|
||||||
|
|
||||||
import numpy as np
|
import numpy as np
|
||||||
from starlette.websockets import WebSocket
|
from starlette.websockets import WebSocket
|
||||||
@@ -61,8 +61,8 @@ async def stream_capture_test(
|
|||||||
websocket: WebSocket,
|
websocket: WebSocket,
|
||||||
engine_factory: Callable,
|
engine_factory: Callable,
|
||||||
duration: float,
|
duration: float,
|
||||||
pp_filters: Optional[list] = None,
|
pp_filters: list | None = None,
|
||||||
preview_width: Optional[int] = None,
|
preview_width: int | None = None,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""Run a capture test, streaming intermediate thumbnails and a final full-res frame.
|
"""Run a capture test, streaming intermediate thumbnails and a final full-res frame.
|
||||||
|
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ from ledgrab.api.schemas.assets import (
|
|||||||
from ledgrab.config import get_config
|
from ledgrab.config import get_config
|
||||||
from ledgrab.storage.asset_store import AssetStore
|
from ledgrab.storage.asset_store import AssetStore
|
||||||
from ledgrab.storage.base_store import EntityNotFoundError
|
from ledgrab.storage.base_store import EntityNotFoundError
|
||||||
from ledgrab.utils import get_logger
|
from ledgrab.utils import get_logger, read_upload_capped
|
||||||
|
|
||||||
logger = get_logger(__name__)
|
logger = get_logger(__name__)
|
||||||
|
|
||||||
@@ -93,10 +93,11 @@ async def upload_asset(
|
|||||||
config = get_config()
|
config = get_config()
|
||||||
max_size = getattr(getattr(config, "assets", None), "max_file_size_mb", 50) * 1024 * 1024
|
max_size = getattr(getattr(config, "assets", None), "max_file_size_mb", 50) * 1024 * 1024
|
||||||
|
|
||||||
data = await file.read()
|
try:
|
||||||
if len(data) > max_size:
|
data = await read_upload_capped(file, max_size)
|
||||||
|
except ValueError:
|
||||||
raise HTTPException(
|
raise HTTPException(
|
||||||
status_code=400,
|
status_code=413,
|
||||||
detail=f"File too large (max {max_size // (1024 * 1024)} MB)",
|
detail=f"File too large (max {max_size // (1024 * 1024)} MB)",
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -142,6 +143,8 @@ async def update_asset(
|
|||||||
name=body.name,
|
name=body.name,
|
||||||
description=body.description,
|
description=body.description,
|
||||||
tags=body.tags,
|
tags=body.tags,
|
||||||
|
icon=body.icon,
|
||||||
|
icon_color=body.icon_color,
|
||||||
)
|
)
|
||||||
except EntityNotFoundError:
|
except EntityNotFoundError:
|
||||||
raise HTTPException(status_code=404, detail=f"Asset not found: {asset_id}")
|
raise HTTPException(status_code=404, detail=f"Asset not found: {asset_id}")
|
||||||
|
|||||||
@@ -36,6 +36,8 @@ def _apt_to_response(t) -> AudioProcessingTemplateResponse:
|
|||||||
updated_at=t.updated_at,
|
updated_at=t.updated_at,
|
||||||
description=t.description,
|
description=t.description,
|
||||||
tags=t.tags,
|
tags=t.tags,
|
||||||
|
icon=getattr(t, "icon", "") or "",
|
||||||
|
icon_color=getattr(t, "icon_color", "") or "",
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -73,6 +75,8 @@ async def create_audio_processing_template(
|
|||||||
filters=filters,
|
filters=filters,
|
||||||
description=data.description,
|
description=data.description,
|
||||||
tags=data.tags,
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
)
|
)
|
||||||
fire_entity_event("audio_processing_template", "created", template.id)
|
fire_entity_event("audio_processing_template", "created", template.id)
|
||||||
return _apt_to_response(template)
|
return _apt_to_response(template)
|
||||||
@@ -129,6 +133,8 @@ async def update_audio_processing_template(
|
|||||||
filters=filters,
|
filters=filters,
|
||||||
description=data.description,
|
description=data.description,
|
||||||
tags=data.tags,
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
)
|
)
|
||||||
fire_entity_event("audio_processing_template", "updated", template_id)
|
fire_entity_event("audio_processing_template", "updated", template_id)
|
||||||
# Hot-update: rebuild filter pipelines for running streams using this template
|
# Hot-update: rebuild filter pipelines for running streams using this template
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Audio source routes: CRUD for audio sources + real-time test WebSocket."""
|
"""Audio source routes: CRUD for audio sources + real-time test WebSocket."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
from typing import Annotated, Optional
|
from typing import Annotated
|
||||||
|
|
||||||
from fastapi import APIRouter, Body, Depends, HTTPException, Query
|
from fastapi import APIRouter, Body, Depends, HTTPException, Query
|
||||||
from starlette.websockets import WebSocket, WebSocketDisconnect
|
from starlette.websockets import WebSocket, WebSocketDisconnect
|
||||||
@@ -46,6 +46,8 @@ _RESPONSE_MAP = {
|
|||||||
tags=s.tags,
|
tags=s.tags,
|
||||||
created_at=s.created_at,
|
created_at=s.created_at,
|
||||||
updated_at=s.updated_at,
|
updated_at=s.updated_at,
|
||||||
|
icon=getattr(s, "icon", "") or "",
|
||||||
|
icon_color=getattr(s, "icon_color", "") or "",
|
||||||
device_index=s.device_index,
|
device_index=s.device_index,
|
||||||
is_loopback=s.is_loopback,
|
is_loopback=s.is_loopback,
|
||||||
audio_template_id=s.audio_template_id,
|
audio_template_id=s.audio_template_id,
|
||||||
@@ -57,6 +59,8 @@ _RESPONSE_MAP = {
|
|||||||
tags=s.tags,
|
tags=s.tags,
|
||||||
created_at=s.created_at,
|
created_at=s.created_at,
|
||||||
updated_at=s.updated_at,
|
updated_at=s.updated_at,
|
||||||
|
icon=getattr(s, "icon", "") or "",
|
||||||
|
icon_color=getattr(s, "icon_color", "") or "",
|
||||||
audio_source_id=s.audio_source_id,
|
audio_source_id=s.audio_source_id,
|
||||||
audio_processing_template_id=s.audio_processing_template_id,
|
audio_processing_template_id=s.audio_processing_template_id,
|
||||||
),
|
),
|
||||||
@@ -75,6 +79,8 @@ def _to_response(source: AudioSource) -> AudioSourceResponse:
|
|||||||
tags=source.tags,
|
tags=source.tags,
|
||||||
created_at=source.created_at,
|
created_at=source.created_at,
|
||||||
updated_at=source.updated_at,
|
updated_at=source.updated_at,
|
||||||
|
icon=getattr(source, "icon", "") or "",
|
||||||
|
icon_color=getattr(source, "icon_color", "") or "",
|
||||||
device_index=getattr(source, "device_index", -1),
|
device_index=getattr(source, "device_index", -1),
|
||||||
is_loopback=getattr(source, "is_loopback", True),
|
is_loopback=getattr(source, "is_loopback", True),
|
||||||
audio_template_id=getattr(source, "audio_template_id", None),
|
audio_template_id=getattr(source, "audio_template_id", None),
|
||||||
@@ -85,7 +91,7 @@ def _to_response(source: AudioSource) -> AudioSourceResponse:
|
|||||||
@router.get("/api/v1/audio-sources", response_model=AudioSourceListResponse, tags=["Audio Sources"])
|
@router.get("/api/v1/audio-sources", response_model=AudioSourceListResponse, tags=["Audio Sources"])
|
||||||
async def list_audio_sources(
|
async def list_audio_sources(
|
||||||
_auth: AuthRequired,
|
_auth: AuthRequired,
|
||||||
source_type: Optional[str] = Query(
|
source_type: str | None = Query(
|
||||||
None, description="Filter by source_type: capture or processed"
|
None, description="Filter by source_type: capture or processed"
|
||||||
),
|
),
|
||||||
store: AudioSourceStore = Depends(get_audio_source_store),
|
store: AudioSourceStore = Depends(get_audio_source_store),
|
||||||
|
|||||||
@@ -53,6 +53,8 @@ async def list_audio_templates(
|
|||||||
created_at=t.created_at,
|
created_at=t.created_at,
|
||||||
updated_at=t.updated_at,
|
updated_at=t.updated_at,
|
||||||
description=t.description,
|
description=t.description,
|
||||||
|
icon=getattr(t, "icon", "") or "",
|
||||||
|
icon_color=getattr(t, "icon_color", "") or "",
|
||||||
)
|
)
|
||||||
for t in templates
|
for t in templates
|
||||||
]
|
]
|
||||||
@@ -81,6 +83,8 @@ async def create_audio_template(
|
|||||||
engine_config=data.engine_config,
|
engine_config=data.engine_config,
|
||||||
description=data.description,
|
description=data.description,
|
||||||
tags=data.tags,
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
)
|
)
|
||||||
fire_entity_event("audio_template", "created", template.id)
|
fire_entity_event("audio_template", "created", template.id)
|
||||||
return AudioTemplateResponse(
|
return AudioTemplateResponse(
|
||||||
@@ -92,6 +96,8 @@ async def create_audio_template(
|
|||||||
created_at=template.created_at,
|
created_at=template.created_at,
|
||||||
updated_at=template.updated_at,
|
updated_at=template.updated_at,
|
||||||
description=template.description,
|
description=template.description,
|
||||||
|
icon=getattr(template, "icon", "") or "",
|
||||||
|
icon_color=getattr(template, "icon_color", "") or "",
|
||||||
)
|
)
|
||||||
except EntityNotFoundError as e:
|
except EntityNotFoundError as e:
|
||||||
raise HTTPException(status_code=404, detail=str(e))
|
raise HTTPException(status_code=404, detail=str(e))
|
||||||
@@ -127,6 +133,8 @@ async def get_audio_template(
|
|||||||
created_at=t.created_at,
|
created_at=t.created_at,
|
||||||
updated_at=t.updated_at,
|
updated_at=t.updated_at,
|
||||||
description=t.description,
|
description=t.description,
|
||||||
|
icon=getattr(t, "icon", "") or "",
|
||||||
|
icon_color=getattr(t, "icon_color", "") or "",
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -150,6 +158,8 @@ async def update_audio_template(
|
|||||||
engine_config=data.engine_config,
|
engine_config=data.engine_config,
|
||||||
description=data.description,
|
description=data.description,
|
||||||
tags=data.tags,
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
)
|
)
|
||||||
fire_entity_event("audio_template", "updated", template_id)
|
fire_entity_event("audio_template", "updated", template_id)
|
||||||
return AudioTemplateResponse(
|
return AudioTemplateResponse(
|
||||||
@@ -161,6 +171,8 @@ async def update_audio_template(
|
|||||||
created_at=t.created_at,
|
created_at=t.created_at,
|
||||||
updated_at=t.updated_at,
|
updated_at=t.updated_at,
|
||||||
description=t.description,
|
description=t.description,
|
||||||
|
icon=getattr(t, "icon", "") or "",
|
||||||
|
icon_color=getattr(t, "icon_color", "") or "",
|
||||||
)
|
)
|
||||||
except EntityNotFoundError as e:
|
except EntityNotFoundError as e:
|
||||||
raise HTTPException(status_code=404, detail=str(e))
|
raise HTTPException(status_code=404, detail=str(e))
|
||||||
|
|||||||
@@ -23,6 +23,7 @@ from ledgrab.storage.automation import (
|
|||||||
ApplicationRule,
|
ApplicationRule,
|
||||||
DisplayStateRule,
|
DisplayStateRule,
|
||||||
HomeAssistantRule,
|
HomeAssistantRule,
|
||||||
|
HTTPPollRule,
|
||||||
MQTTRule,
|
MQTTRule,
|
||||||
Rule,
|
Rule,
|
||||||
StartupRule,
|
StartupRule,
|
||||||
@@ -51,6 +52,8 @@ def _rule_from_schema(s: RuleSchema) -> Rule:
|
|||||||
"time_of_day": lambda: TimeOfDayRule(
|
"time_of_day": lambda: TimeOfDayRule(
|
||||||
start_time=s.start_time or "00:00",
|
start_time=s.start_time or "00:00",
|
||||||
end_time=s.end_time or "23:59",
|
end_time=s.end_time or "23:59",
|
||||||
|
days_of_week=s.days_of_week or [],
|
||||||
|
timezone=s.timezone or "",
|
||||||
),
|
),
|
||||||
"system_idle": lambda: SystemIdleRule(
|
"system_idle": lambda: SystemIdleRule(
|
||||||
idle_minutes=s.idle_minutes if s.idle_minutes is not None else 5,
|
idle_minutes=s.idle_minutes if s.idle_minutes is not None else 5,
|
||||||
@@ -75,6 +78,11 @@ def _rule_from_schema(s: RuleSchema) -> Rule:
|
|||||||
state=s.state or "",
|
state=s.state or "",
|
||||||
match_mode=s.match_mode or "exact",
|
match_mode=s.match_mode or "exact",
|
||||||
),
|
),
|
||||||
|
"http_poll": lambda: HTTPPollRule(
|
||||||
|
value_source_id=s.value_source_id or "",
|
||||||
|
operator=s.operator or "equals",
|
||||||
|
value=s.value or "",
|
||||||
|
),
|
||||||
}
|
}
|
||||||
factory = _SCHEMA_TO_RULE.get(s.rule_type)
|
factory = _SCHEMA_TO_RULE.get(s.rule_type)
|
||||||
if factory is None:
|
if factory is None:
|
||||||
@@ -122,6 +130,8 @@ def _automation_to_response(
|
|||||||
last_activated_at=state.get("last_activated_at"),
|
last_activated_at=state.get("last_activated_at"),
|
||||||
last_deactivated_at=state.get("last_deactivated_at"),
|
last_deactivated_at=state.get("last_deactivated_at"),
|
||||||
tags=automation.tags,
|
tags=automation.tags,
|
||||||
|
icon=getattr(automation, "icon", "") or "",
|
||||||
|
icon_color=getattr(automation, "icon_color", "") or "",
|
||||||
created_at=automation.created_at,
|
created_at=automation.created_at,
|
||||||
updated_at=automation.updated_at,
|
updated_at=automation.updated_at,
|
||||||
)
|
)
|
||||||
@@ -191,6 +201,8 @@ async def create_automation(
|
|||||||
deactivation_mode=data.deactivation_mode,
|
deactivation_mode=data.deactivation_mode,
|
||||||
deactivation_scene_preset_id=data.deactivation_scene_preset_id,
|
deactivation_scene_preset_id=data.deactivation_scene_preset_id,
|
||||||
tags=data.tags,
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
)
|
)
|
||||||
|
|
||||||
if automation.enabled:
|
if automation.enabled:
|
||||||
@@ -285,6 +297,8 @@ async def update_automation(
|
|||||||
rules=rules,
|
rules=rules,
|
||||||
deactivation_mode=data.deactivation_mode,
|
deactivation_mode=data.deactivation_mode,
|
||||||
tags=data.tags,
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
)
|
)
|
||||||
if data.scene_preset_id is not None:
|
if data.scene_preset_id is not None:
|
||||||
update_kwargs["scene_preset_id"] = data.scene_preset_id
|
update_kwargs["scene_preset_id"] = data.scene_preset_id
|
||||||
|
|||||||
@@ -11,6 +11,7 @@ import sys
|
|||||||
import threading
|
import threading
|
||||||
import zipfile
|
import zipfile
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
from fastapi import APIRouter, Depends, File, HTTPException, UploadFile
|
from fastapi import APIRouter, Depends, File, HTTPException, UploadFile
|
||||||
from fastapi.responses import StreamingResponse
|
from fastapi.responses import StreamingResponse
|
||||||
@@ -28,7 +29,7 @@ from ledgrab.config import get_config
|
|||||||
from ledgrab.core.backup.auto_backup import AutoBackupEngine
|
from ledgrab.core.backup.auto_backup import AutoBackupEngine
|
||||||
from ledgrab.storage.asset_store import AssetStore
|
from ledgrab.storage.asset_store import AssetStore
|
||||||
from ledgrab.storage.database import Database, freeze_writes
|
from ledgrab.storage.database import Database, freeze_writes
|
||||||
from ledgrab.utils import get_logger
|
from ledgrab.utils import get_logger, read_upload_capped
|
||||||
|
|
||||||
logger = get_logger(__name__)
|
logger = get_logger(__name__)
|
||||||
|
|
||||||
@@ -38,28 +39,59 @@ _SERVER_DIR = Path(__file__).resolve().parents[4]
|
|||||||
|
|
||||||
|
|
||||||
def _schedule_restart() -> None:
|
def _schedule_restart() -> None:
|
||||||
"""Spawn a restart script after a short delay so the HTTP response completes."""
|
"""Spawn a restart script after a short delay so the HTTP response completes.
|
||||||
|
|
||||||
def _restart():
|
stdout/stderr of the spawned script are redirected to ``<server>/restart.log``
|
||||||
|
so a silent failure (PowerShell not on PATH, restart.ps1 erroring, etc.)
|
||||||
|
leaves evidence on disk instead of vanishing into a detached child.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def _restart() -> None:
|
||||||
import time
|
import time
|
||||||
|
|
||||||
time.sleep(1)
|
time.sleep(1)
|
||||||
|
|
||||||
|
# Annotated as ``dict[str, Any]`` because the value union spans
|
||||||
|
# int flags (Windows ``creationflags``) and bool (POSIX
|
||||||
|
# ``start_new_session``); a narrower union confuses ``**`` unpacking.
|
||||||
|
popen_kwargs: dict[str, Any]
|
||||||
if sys.platform == "win32":
|
if sys.platform == "win32":
|
||||||
subprocess.Popen(
|
script = _SERVER_DIR / "restart.ps1"
|
||||||
[
|
cmd = ["powershell", "-ExecutionPolicy", "Bypass", "-File", str(script)]
|
||||||
"powershell",
|
popen_kwargs = {
|
||||||
"-ExecutionPolicy",
|
"creationflags": (
|
||||||
"Bypass",
|
subprocess.DETACHED_PROCESS | subprocess.CREATE_NEW_PROCESS_GROUP
|
||||||
"-File",
|
),
|
||||||
str(_SERVER_DIR / "restart.ps1"),
|
}
|
||||||
],
|
|
||||||
creationflags=subprocess.DETACHED_PROCESS | subprocess.CREATE_NEW_PROCESS_GROUP,
|
|
||||||
)
|
|
||||||
else:
|
else:
|
||||||
subprocess.Popen(
|
script = _SERVER_DIR / "restart.sh"
|
||||||
["bash", str(_SERVER_DIR / "restart.sh")],
|
cmd = ["bash", str(script)]
|
||||||
start_new_session=True,
|
popen_kwargs = {"start_new_session": True}
|
||||||
)
|
|
||||||
|
if not script.is_file():
|
||||||
|
logger.error("Restart script missing: %s", script)
|
||||||
|
return
|
||||||
|
|
||||||
|
log_path = _SERVER_DIR / "restart.log"
|
||||||
|
try:
|
||||||
|
# Open in append mode so multiple restarts accumulate; the child
|
||||||
|
# owns its own duped handle, so closing here in the parent is safe.
|
||||||
|
with open(log_path, "ab") as log_file:
|
||||||
|
log_file.write(
|
||||||
|
f"\n--- restart spawned at {time.strftime('%Y-%m-%d %H:%M:%S')} ---\n".encode()
|
||||||
|
)
|
||||||
|
log_file.flush()
|
||||||
|
proc = subprocess.Popen(
|
||||||
|
cmd,
|
||||||
|
stdout=log_file,
|
||||||
|
stderr=subprocess.STDOUT,
|
||||||
|
**popen_kwargs,
|
||||||
|
)
|
||||||
|
logger.info("Restart script launched: %s (PID %s, log %s)", cmd[0], proc.pid, log_path)
|
||||||
|
except OSError as e:
|
||||||
|
logger.error("Failed to launch restart script %s: %s", script, e, exc_info=True)
|
||||||
|
except Exception as e:
|
||||||
|
logger.error("Unexpected error launching restart script: %s", e, exc_info=True)
|
||||||
|
|
||||||
threading.Thread(target=_restart, daemon=True).start()
|
threading.Thread(target=_restart, daemon=True).start()
|
||||||
|
|
||||||
@@ -133,9 +165,11 @@ async def restore_config(
|
|||||||
because restore replaces all configuration including secrets).
|
because restore replaces all configuration including secrets).
|
||||||
"""
|
"""
|
||||||
require_authenticated(auth)
|
require_authenticated(auth)
|
||||||
raw = await file.read()
|
_MAX_BACKUP_BYTES = 200 * 1024 * 1024 # 200 MB (ZIP may contain assets)
|
||||||
if len(raw) > 200 * 1024 * 1024: # 200 MB limit (ZIP may contain assets)
|
try:
|
||||||
raise HTTPException(status_code=400, detail="Backup file too large (max 200 MB)")
|
raw = await read_upload_capped(file, _MAX_BACKUP_BYTES)
|
||||||
|
except ValueError:
|
||||||
|
raise HTTPException(status_code=413, detail="Backup file too large (max 200 MB)")
|
||||||
|
|
||||||
if len(raw) < 100:
|
if len(raw) < 100:
|
||||||
raise HTTPException(status_code=400, detail="File too small to be a valid backup")
|
raise HTTPException(status_code=400, detail="File too small to be a valid backup")
|
||||||
|
|||||||
@@ -43,6 +43,8 @@ def _cspt_to_response(t) -> ColorStripProcessingTemplateResponse:
|
|||||||
updated_at=t.updated_at,
|
updated_at=t.updated_at,
|
||||||
description=t.description,
|
description=t.description,
|
||||||
tags=t.tags,
|
tags=t.tags,
|
||||||
|
icon=getattr(t, "icon", "") or "",
|
||||||
|
icon_color=getattr(t, "icon_color", "") or "",
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -84,6 +86,8 @@ async def create_cspt(
|
|||||||
filters=filters,
|
filters=filters,
|
||||||
description=data.description,
|
description=data.description,
|
||||||
tags=data.tags,
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
)
|
)
|
||||||
fire_entity_event("cspt", "created", template.id)
|
fire_entity_event("cspt", "created", template.id)
|
||||||
return _cspt_to_response(template)
|
return _cspt_to_response(template)
|
||||||
@@ -141,6 +145,8 @@ async def update_cspt(
|
|||||||
filters=filters,
|
filters=filters,
|
||||||
description=data.description,
|
description=data.description,
|
||||||
tags=data.tags,
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
)
|
)
|
||||||
fire_entity_event("cspt", "updated", template_id)
|
fire_entity_event("cspt", "updated", template_id)
|
||||||
return _cspt_to_response(template)
|
return _cspt_to_response(template)
|
||||||
|
|||||||
@@ -4,12 +4,12 @@ from ledgrab.api.schemas.color_strip_sources import (
|
|||||||
ApiInputCSSResponse,
|
ApiInputCSSResponse,
|
||||||
AudioCSSResponse,
|
AudioCSSResponse,
|
||||||
CandlelightCSSResponse,
|
CandlelightCSSResponse,
|
||||||
ColorCycleCSSResponse,
|
|
||||||
ColorStop as ColorStopSchema,
|
ColorStop as ColorStopSchema,
|
||||||
ColorStripSourceResponse,
|
ColorStripSourceResponse,
|
||||||
CompositeCSSResponse,
|
CompositeCSSResponse,
|
||||||
DaylightCSSResponse,
|
DaylightCSSResponse,
|
||||||
EffectCSSResponse,
|
EffectCSSResponse,
|
||||||
|
GameEventCSSResponse,
|
||||||
GradientCSSResponse,
|
GradientCSSResponse,
|
||||||
KeyColorsCSSResponse,
|
KeyColorsCSSResponse,
|
||||||
MappedCSSResponse,
|
MappedCSSResponse,
|
||||||
@@ -18,7 +18,7 @@ from ledgrab.api.schemas.color_strip_sources import (
|
|||||||
PictureAdvancedCSSResponse,
|
PictureAdvancedCSSResponse,
|
||||||
PictureCSSResponse,
|
PictureCSSResponse,
|
||||||
ProcessedCSSResponse,
|
ProcessedCSSResponse,
|
||||||
StaticCSSResponse,
|
SingleColorCSSResponse,
|
||||||
WeatherCSSResponse,
|
WeatherCSSResponse,
|
||||||
)
|
)
|
||||||
from ledgrab.api.schemas.devices import Calibration as CalibrationSchema
|
from ledgrab.api.schemas.devices import Calibration as CalibrationSchema
|
||||||
@@ -27,23 +27,7 @@ from ledgrab.core.capture.calibration import (
|
|||||||
calibration_to_dict,
|
calibration_to_dict,
|
||||||
)
|
)
|
||||||
from ledgrab.storage.color_strip_source import (
|
from ledgrab.storage.color_strip_source import (
|
||||||
AdvancedPictureColorStripSource,
|
_SOURCE_TYPE_MAP as _STORAGE_TYPE_MAP,
|
||||||
ApiInputColorStripSource,
|
|
||||||
AudioColorStripSource,
|
|
||||||
CandlelightColorStripSource,
|
|
||||||
ColorCycleColorStripSource,
|
|
||||||
CompositeColorStripSource,
|
|
||||||
DaylightColorStripSource,
|
|
||||||
EffectColorStripSource,
|
|
||||||
GradientColorStripSource,
|
|
||||||
KeyColorsColorStripSource,
|
|
||||||
MappedColorStripSource,
|
|
||||||
MathWaveColorStripSource,
|
|
||||||
NotificationColorStripSource,
|
|
||||||
PictureColorStripSource,
|
|
||||||
ProcessedColorStripSource,
|
|
||||||
StaticColorStripSource,
|
|
||||||
WeatherColorStripSource,
|
|
||||||
)
|
)
|
||||||
from ledgrab.storage.picture_source import (
|
from ledgrab.storage.picture_source import (
|
||||||
ProcessedPictureSource,
|
ProcessedPictureSource,
|
||||||
@@ -67,6 +51,8 @@ def _common_response_kwargs(source, overlay_active: bool = False) -> dict:
|
|||||||
tags=source.tags,
|
tags=source.tags,
|
||||||
created_at=source.created_at,
|
created_at=source.created_at,
|
||||||
updated_at=source.updated_at,
|
updated_at=source.updated_at,
|
||||||
|
icon=getattr(source, "icon", "") or "",
|
||||||
|
icon_color=getattr(source, "icon_color", "") or "",
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -94,38 +80,46 @@ def _stops_schema(source) -> list[ColorStopSchema] | None:
|
|||||||
return None
|
return None
|
||||||
|
|
||||||
|
|
||||||
# Maps storage class → response builder lambda.
|
# Maps ``source_type`` string → response builder.
|
||||||
|
#
|
||||||
|
# Keying by source_type (rather than type(source)) lets the import-time
|
||||||
|
# coverage check use the storage registry's keys directly, with no
|
||||||
|
# inversion or duplicate-class handling for legacy aliases.
|
||||||
_RESPONSE_MAP: dict = {
|
_RESPONSE_MAP: dict = {
|
||||||
PictureColorStripSource: lambda s, kw: PictureCSSResponse(
|
"picture": lambda s, kw: PictureCSSResponse(
|
||||||
**kw,
|
**kw,
|
||||||
picture_source_id=s.picture_source_id,
|
picture_source_id=s.picture_source_id,
|
||||||
smoothing=s.smoothing.to_dict(),
|
smoothing=s.smoothing.to_dict(),
|
||||||
interpolation_mode=s.interpolation_mode,
|
interpolation_mode=s.interpolation_mode,
|
||||||
calibration=_calibration_schema(s),
|
calibration=_calibration_schema(s),
|
||||||
),
|
),
|
||||||
AdvancedPictureColorStripSource: lambda s, kw: PictureAdvancedCSSResponse(
|
"picture_advanced": lambda s, kw: PictureAdvancedCSSResponse(
|
||||||
**kw,
|
**kw,
|
||||||
smoothing=s.smoothing.to_dict(),
|
smoothing=s.smoothing.to_dict(),
|
||||||
interpolation_mode=s.interpolation_mode,
|
interpolation_mode=s.interpolation_mode,
|
||||||
calibration=_calibration_schema(s),
|
calibration=_calibration_schema(s),
|
||||||
),
|
),
|
||||||
StaticColorStripSource: lambda s, kw: StaticCSSResponse(
|
"single_color": lambda s, kw: SingleColorCSSResponse(
|
||||||
**kw,
|
**kw,
|
||||||
color=s.color.to_dict(),
|
color=s.color.to_dict(),
|
||||||
animation=s.animation,
|
animation=s.animation,
|
||||||
),
|
),
|
||||||
GradientColorStripSource: lambda s, kw: GradientCSSResponse(
|
# Legacy alias: pre-rename rows used "static"; the data migration rewrites
|
||||||
|
# them on first store load but a stale in-flight instance would still
|
||||||
|
# carry source_type='static' until the next reload.
|
||||||
|
"static": lambda s, kw: SingleColorCSSResponse(
|
||||||
|
**kw,
|
||||||
|
color=s.color.to_dict(),
|
||||||
|
animation=s.animation,
|
||||||
|
),
|
||||||
|
"gradient": lambda s, kw: GradientCSSResponse(
|
||||||
**kw,
|
**kw,
|
||||||
stops=_stops_schema(s),
|
stops=_stops_schema(s),
|
||||||
animation=s.animation,
|
animation=s.animation,
|
||||||
easing=s.easing,
|
easing=s.easing,
|
||||||
gradient_id=s.gradient_id,
|
gradient_id=s.gradient_id,
|
||||||
),
|
),
|
||||||
ColorCycleColorStripSource: lambda s, kw: ColorCycleCSSResponse(
|
"effect": lambda s, kw: EffectCSSResponse(
|
||||||
**kw,
|
|
||||||
colors=[list(c) for c in s.colors],
|
|
||||||
),
|
|
||||||
EffectColorStripSource: lambda s, kw: EffectCSSResponse(
|
|
||||||
**kw,
|
**kw,
|
||||||
effect_type=s.effect_type,
|
effect_type=s.effect_type,
|
||||||
palette=s.palette,
|
palette=s.palette,
|
||||||
@@ -136,15 +130,15 @@ _RESPONSE_MAP: dict = {
|
|||||||
mirror=s.mirror,
|
mirror=s.mirror,
|
||||||
custom_palette=s.custom_palette,
|
custom_palette=s.custom_palette,
|
||||||
),
|
),
|
||||||
CompositeColorStripSource: lambda s, kw: CompositeCSSResponse(
|
"composite": lambda s, kw: CompositeCSSResponse(
|
||||||
**kw,
|
**kw,
|
||||||
layers=[dict(layer) for layer in s.layers],
|
layers=[dict(layer) for layer in s.layers],
|
||||||
),
|
),
|
||||||
MappedColorStripSource: lambda s, kw: MappedCSSResponse(
|
"mapped": lambda s, kw: MappedCSSResponse(
|
||||||
**kw,
|
**kw,
|
||||||
zones=[dict(z) for z in s.zones],
|
zones=[dict(z) for z in s.zones],
|
||||||
),
|
),
|
||||||
AudioColorStripSource: lambda s, kw: AudioCSSResponse(
|
"audio": lambda s, kw: AudioCSSResponse(
|
||||||
**kw,
|
**kw,
|
||||||
visualization_mode=s.visualization_mode,
|
visualization_mode=s.visualization_mode,
|
||||||
audio_source_id=s.audio_source_id,
|
audio_source_id=s.audio_source_id,
|
||||||
@@ -157,13 +151,13 @@ _RESPONSE_MAP: dict = {
|
|||||||
mirror=s.mirror,
|
mirror=s.mirror,
|
||||||
beat_decay=s.beat_decay.to_dict(),
|
beat_decay=s.beat_decay.to_dict(),
|
||||||
),
|
),
|
||||||
ApiInputColorStripSource: lambda s, kw: ApiInputCSSResponse(
|
"api_input": lambda s, kw: ApiInputCSSResponse(
|
||||||
**kw,
|
**kw,
|
||||||
fallback_color=s.fallback_color.to_dict(),
|
fallback_color=s.fallback_color.to_dict(),
|
||||||
timeout=s.timeout.to_dict(),
|
timeout=s.timeout.to_dict(),
|
||||||
interpolation=s.interpolation,
|
interpolation=s.interpolation,
|
||||||
),
|
),
|
||||||
NotificationColorStripSource: lambda s, kw: NotificationCSSResponse(
|
"notification": lambda s, kw: NotificationCSSResponse(
|
||||||
**kw,
|
**kw,
|
||||||
notification_effect=s.notification_effect,
|
notification_effect=s.notification_effect,
|
||||||
duration_ms=s.duration_ms.to_dict(),
|
duration_ms=s.duration_ms.to_dict(),
|
||||||
@@ -176,14 +170,14 @@ _RESPONSE_MAP: dict = {
|
|||||||
sound_volume=s.sound_volume.to_dict(),
|
sound_volume=s.sound_volume.to_dict(),
|
||||||
app_sounds=dict(s.app_sounds),
|
app_sounds=dict(s.app_sounds),
|
||||||
),
|
),
|
||||||
DaylightColorStripSource: lambda s, kw: DaylightCSSResponse(
|
"daylight": lambda s, kw: DaylightCSSResponse(
|
||||||
**kw,
|
**kw,
|
||||||
speed=s.speed.to_dict(),
|
speed=s.speed.to_dict(),
|
||||||
use_real_time=s.use_real_time,
|
use_real_time=s.use_real_time,
|
||||||
latitude=s.latitude,
|
latitude=s.latitude,
|
||||||
longitude=s.longitude,
|
longitude=s.longitude,
|
||||||
),
|
),
|
||||||
CandlelightColorStripSource: lambda s, kw: CandlelightCSSResponse(
|
"candlelight": lambda s, kw: CandlelightCSSResponse(
|
||||||
**kw,
|
**kw,
|
||||||
color=s.color.to_dict(),
|
color=s.color.to_dict(),
|
||||||
intensity=s.intensity.to_dict(),
|
intensity=s.intensity.to_dict(),
|
||||||
@@ -192,18 +186,18 @@ _RESPONSE_MAP: dict = {
|
|||||||
wind_strength=s.wind_strength.to_dict(),
|
wind_strength=s.wind_strength.to_dict(),
|
||||||
candle_type=s.candle_type,
|
candle_type=s.candle_type,
|
||||||
),
|
),
|
||||||
ProcessedColorStripSource: lambda s, kw: ProcessedCSSResponse(
|
"processed": lambda s, kw: ProcessedCSSResponse(
|
||||||
**kw,
|
**kw,
|
||||||
input_source_id=s.input_source_id,
|
input_source_id=s.input_source_id,
|
||||||
processing_template_id=s.processing_template_id,
|
processing_template_id=s.processing_template_id,
|
||||||
),
|
),
|
||||||
WeatherColorStripSource: lambda s, kw: WeatherCSSResponse(
|
"weather": lambda s, kw: WeatherCSSResponse(
|
||||||
**kw,
|
**kw,
|
||||||
weather_source_id=s.weather_source_id,
|
weather_source_id=s.weather_source_id,
|
||||||
speed=s.speed.to_dict(),
|
speed=s.speed.to_dict(),
|
||||||
temperature_influence=s.temperature_influence.to_dict(),
|
temperature_influence=s.temperature_influence.to_dict(),
|
||||||
),
|
),
|
||||||
KeyColorsColorStripSource: lambda s, kw: KeyColorsCSSResponse(
|
"key_colors": lambda s, kw: KeyColorsCSSResponse(
|
||||||
**kw,
|
**kw,
|
||||||
picture_source_id=s.picture_source_id,
|
picture_source_id=s.picture_source_id,
|
||||||
rectangles=[r.to_dict() for r in s.rectangles],
|
rectangles=[r.to_dict() for r in s.rectangles],
|
||||||
@@ -211,28 +205,67 @@ _RESPONSE_MAP: dict = {
|
|||||||
smoothing=s.smoothing.to_dict(),
|
smoothing=s.smoothing.to_dict(),
|
||||||
brightness=s.brightness.to_dict(),
|
brightness=s.brightness.to_dict(),
|
||||||
),
|
),
|
||||||
MathWaveColorStripSource: lambda s, kw: MathWaveCSSResponse(
|
"math_wave": lambda s, kw: MathWaveCSSResponse(
|
||||||
**kw,
|
**kw,
|
||||||
waves=s.waves,
|
waves=s.waves,
|
||||||
speed=s.speed.to_dict(),
|
speed=s.speed.to_dict(),
|
||||||
gradient_id=s.gradient_id,
|
gradient_id=s.gradient_id,
|
||||||
),
|
),
|
||||||
|
"game_event": lambda s, kw: GameEventCSSResponse(
|
||||||
|
**kw,
|
||||||
|
game_integration_id=s.game_integration_id,
|
||||||
|
idle_color=s.idle_color.to_dict(),
|
||||||
|
event_mappings=[dict(m) for m in s.event_mappings],
|
||||||
|
),
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _assert_response_map_coverage() -> None:
|
||||||
|
"""Verify _RESPONSE_MAP has a builder for every kind in storage's registry.
|
||||||
|
|
||||||
|
Runs at module import. Surfaces missing builders eagerly instead of
|
||||||
|
letting a request fall through to a silent / wrong response shape.
|
||||||
|
|
||||||
|
Contract note
|
||||||
|
-------------
|
||||||
|
This check is **symmetric** (``_RESPONSE_MAP keys == storage_kinds``)
|
||||||
|
because every kind — sharable or not — needs a response shape. The
|
||||||
|
sister assertion in
|
||||||
|
``core/processing/color_strip_kinds.py::_assert_stream_kind_coverage``
|
||||||
|
is asymmetric because sharable kinds construct their streams via a
|
||||||
|
different path. Adding a new kind requires keeping all three registries
|
||||||
|
aligned: storage's ``_SOURCE_TYPE_MAP``, this ``_RESPONSE_MAP``, and
|
||||||
|
either ``STREAM_BUILDERS`` or ``SHARABLE_KINDS``.
|
||||||
|
"""
|
||||||
|
storage_kinds = set(_STORAGE_TYPE_MAP.keys())
|
||||||
|
builder_kinds = set(_RESPONSE_MAP.keys())
|
||||||
|
missing = storage_kinds - builder_kinds
|
||||||
|
extra = builder_kinds - storage_kinds
|
||||||
|
if missing or extra:
|
||||||
|
problems = []
|
||||||
|
if missing:
|
||||||
|
problems.append(f"missing builders for: {sorted(missing)}")
|
||||||
|
if extra:
|
||||||
|
problems.append(f"unregistered kinds in _RESPONSE_MAP: {sorted(extra)}")
|
||||||
|
raise RuntimeError(
|
||||||
|
"_RESPONSE_MAP is out of sync with storage._SOURCE_TYPE_MAP: " + "; ".join(problems)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
_assert_response_map_coverage()
|
||||||
|
|
||||||
|
|
||||||
def _css_to_response(source, overlay_active: bool = False) -> ColorStripSourceResponse:
|
def _css_to_response(source, overlay_active: bool = False) -> ColorStripSourceResponse:
|
||||||
"""Convert a ColorStripSource to the matching per-type response schema."""
|
"""Convert a ColorStripSource to the matching per-type response schema."""
|
||||||
kw = _common_response_kwargs(source, overlay_active)
|
kw = _common_response_kwargs(source, overlay_active)
|
||||||
builder = _RESPONSE_MAP.get(type(source))
|
builder = _RESPONSE_MAP.get(source.source_type)
|
||||||
if builder is None:
|
if builder is None:
|
||||||
# Fallback: use to_dict() and build a PictureCSSResponse
|
# Coverage is asserted at import time, so reaching this branch means a
|
||||||
logger.warning("No response builder for %s, falling back", type(source).__name__)
|
# source was loaded with a source_type that is not registered.
|
||||||
return PictureCSSResponse(
|
# Surface the bug instead of silently returning a wrong-shaped response.
|
||||||
**kw,
|
raise RuntimeError(
|
||||||
picture_source_id="",
|
f"No CSS response builder registered for source_type "
|
||||||
smoothing=0.3,
|
f"{source.source_type!r} (class={type(source).__name__})"
|
||||||
interpolation_mode="average",
|
|
||||||
calibration=None,
|
|
||||||
)
|
)
|
||||||
return builder(source, kw)
|
return builder(source, kw)
|
||||||
|
|
||||||
|
|||||||
@@ -29,13 +29,20 @@ router = APIRouter()
|
|||||||
|
|
||||||
|
|
||||||
_PREVIEW_ALLOWED_TYPES = {
|
_PREVIEW_ALLOWED_TYPES = {
|
||||||
"static",
|
"single_color",
|
||||||
"gradient",
|
"gradient",
|
||||||
"color_cycle",
|
|
||||||
"effect",
|
"effect",
|
||||||
"daylight",
|
"daylight",
|
||||||
"candlelight",
|
"candlelight",
|
||||||
"notification",
|
"notification",
|
||||||
|
"audio",
|
||||||
|
"math_wave",
|
||||||
|
"weather",
|
||||||
|
"game_event",
|
||||||
|
"api_input",
|
||||||
|
"mapped",
|
||||||
|
"composite",
|
||||||
|
"processed",
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@@ -90,13 +97,65 @@ async def preview_color_strip_ws(
|
|||||||
return ColorStripSource.from_dict(config)
|
return ColorStripSource.from_dict(config)
|
||||||
|
|
||||||
def _create_stream(source):
|
def _create_stream(source):
|
||||||
"""Instantiate and start the appropriate stream class for *source*."""
|
"""Instantiate and start the appropriate stream class for *source*.
|
||||||
from ledgrab.core.processing.color_strip_stream_manager import _SIMPLE_STREAM_MAP
|
|
||||||
|
|
||||||
stream_cls = _SIMPLE_STREAM_MAP.get(source.source_type)
|
Delegates the per-kind dispatch to ``color_strip_kinds.build_stream``
|
||||||
if not stream_cls:
|
so this preview path and the production ``ColorStripStreamManager``
|
||||||
raise ValueError(f"Unsupported preview source_type: {source.source_type}")
|
share a single registry. Per-kind dependencies (CSPT store, audio
|
||||||
s = stream_cls(source)
|
stores, weather manager, …) are gathered into a ``StreamDeps`` bag.
|
||||||
|
|
||||||
|
FastAPI-DI providers raise ``RuntimeError`` when they aren't wired,
|
||||||
|
so we resolve each one through ``_safe`` and pass ``None`` on
|
||||||
|
failure. The per-kind builder will still see a clear error if a
|
||||||
|
truly-required dep is missing for that kind, but unrelated previews
|
||||||
|
(e.g. a ``single_color`` preview on a fresh install where the CSPT
|
||||||
|
store isn't initialized yet) keep working.
|
||||||
|
"""
|
||||||
|
from ledgrab.api.dependencies import (
|
||||||
|
get_audio_processing_template_store,
|
||||||
|
get_audio_source_store,
|
||||||
|
get_audio_template_store,
|
||||||
|
get_cspt_store,
|
||||||
|
)
|
||||||
|
from ledgrab.core.processing.color_strip_kinds import StreamDeps, build_stream
|
||||||
|
|
||||||
|
def _safe(getter):
|
||||||
|
try:
|
||||||
|
return getter()
|
||||||
|
except RuntimeError as e:
|
||||||
|
logger.debug("Preview dep not available (%s): %s", getter.__name__, e)
|
||||||
|
return None
|
||||||
|
|
||||||
|
mgr = get_processor_manager()
|
||||||
|
csm = mgr.color_strip_stream_manager
|
||||||
|
|
||||||
|
# The game-event bus is optional in preview contexts.
|
||||||
|
try:
|
||||||
|
from ledgrab.api.dependencies import get_game_event_bus
|
||||||
|
|
||||||
|
game_event_bus = get_game_event_bus()
|
||||||
|
except RuntimeError as e:
|
||||||
|
logger.debug("Preview: no game event bus available: %s", e)
|
||||||
|
game_event_bus = None
|
||||||
|
|
||||||
|
deps = StreamDeps(
|
||||||
|
css_manager=csm,
|
||||||
|
value_stream_manager=mgr.value_stream_manager,
|
||||||
|
cspt_store=_safe(get_cspt_store),
|
||||||
|
weather_manager=mgr.weather_manager,
|
||||||
|
audio_capture_manager=mgr.audio_capture_manager,
|
||||||
|
audio_source_store=_safe(get_audio_source_store),
|
||||||
|
audio_template_store=_safe(get_audio_template_store),
|
||||||
|
audio_processing_template_store=_safe(get_audio_processing_template_store),
|
||||||
|
game_event_bus=game_event_bus,
|
||||||
|
depth=0,
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
s = build_stream(source, deps)
|
||||||
|
except ValueError as e:
|
||||||
|
# Preserve the registry's original detail so the API consumer
|
||||||
|
# sees which kind was rejected, not just a generic message.
|
||||||
|
raise ValueError(f"Unsupported preview source_type: {e}") from e
|
||||||
# Inject gradient store for palette resolution
|
# Inject gradient store for palette resolution
|
||||||
if hasattr(s, "set_gradient_store"):
|
if hasattr(s, "set_gradient_store"):
|
||||||
try:
|
try:
|
||||||
@@ -122,7 +181,24 @@ async def preview_color_strip_ws(
|
|||||||
cid = None
|
cid = None
|
||||||
else:
|
else:
|
||||||
cid = None
|
cid = None
|
||||||
s.start()
|
# Start the stream; if start() raises, release any resources we
|
||||||
|
# already acquired (clock + anything the stream itself grabbed in
|
||||||
|
# its __init__) so we don't leak refs across failed previews.
|
||||||
|
try:
|
||||||
|
s.start()
|
||||||
|
except Exception:
|
||||||
|
try:
|
||||||
|
s.stop()
|
||||||
|
except Exception as e_stop:
|
||||||
|
logger.exception("unexpected in start-failure rollback s.stop: %s", e_stop)
|
||||||
|
if cid:
|
||||||
|
scm = _get_sync_clock_manager()
|
||||||
|
if scm:
|
||||||
|
try:
|
||||||
|
scm.release(cid)
|
||||||
|
except Exception as e_rel:
|
||||||
|
logger.exception("unexpected in start-failure clock release: %s", e_rel)
|
||||||
|
raise
|
||||||
return s, cid
|
return s, cid
|
||||||
|
|
||||||
def _stop_stream(s, cid):
|
def _stop_stream(s, cid):
|
||||||
@@ -223,10 +299,24 @@ async def preview_color_strip_ws(
|
|||||||
continue
|
continue
|
||||||
new_source = _build_source(new_config)
|
new_source = _build_source(new_config)
|
||||||
if new_type != current_source_type:
|
if new_type != current_source_type:
|
||||||
# Source type changed — recreate stream
|
# Source type changed — stop the old stream first, then
|
||||||
|
# build the new one. If the rebuild fails, drop the
|
||||||
|
# reference so the frame loop doesn't keep polling a
|
||||||
|
# stopped stream and the finally-block doesn't double-stop.
|
||||||
_stop_stream(stream, clock_id)
|
_stop_stream(stream, clock_id)
|
||||||
stream, clock_id = _create_stream(new_source)
|
stream, clock_id = None, None
|
||||||
current_source_type = new_type
|
try:
|
||||||
|
stream, clock_id = _create_stream(new_source)
|
||||||
|
current_source_type = new_type
|
||||||
|
except Exception as rebuild_err:
|
||||||
|
logger.error(
|
||||||
|
f"Preview WS: failed to rebuild stream for new type {new_type}: {rebuild_err}"
|
||||||
|
)
|
||||||
|
await websocket.send_text(
|
||||||
|
_json.dumps({"type": "error", "detail": str(rebuild_err)})
|
||||||
|
)
|
||||||
|
await websocket.close(code=4003, reason=str(rebuild_err))
|
||||||
|
return
|
||||||
else:
|
else:
|
||||||
stream.update_source(new_source)
|
stream.update_source(new_source)
|
||||||
if hasattr(stream, "configure"):
|
if hasattr(stream, "configure"):
|
||||||
@@ -237,12 +327,15 @@ async def preview_color_strip_ws(
|
|||||||
await websocket.send_text(_json.dumps({"type": "error", "detail": str(e)}))
|
await websocket.send_text(_json.dumps({"type": "error", "detail": str(e)}))
|
||||||
|
|
||||||
# Send frame
|
# Send frame
|
||||||
colors = stream.get_latest_colors()
|
if stream is None:
|
||||||
if colors is not None:
|
|
||||||
await websocket.send_bytes(colors.tobytes())
|
|
||||||
else:
|
|
||||||
# Stream hasn't produced a frame yet — send black
|
|
||||||
await websocket.send_bytes(b"\x00" * led_count * 3)
|
await websocket.send_bytes(b"\x00" * led_count * 3)
|
||||||
|
else:
|
||||||
|
colors = stream.get_latest_colors()
|
||||||
|
if colors is not None:
|
||||||
|
await websocket.send_bytes(colors.tobytes())
|
||||||
|
else:
|
||||||
|
# Stream hasn't produced a frame yet — send black
|
||||||
|
await websocket.send_bytes(b"\x00" * led_count * 3)
|
||||||
|
|
||||||
except WebSocketDisconnect:
|
except WebSocketDisconnect:
|
||||||
pass
|
pass
|
||||||
@@ -335,8 +428,17 @@ async def css_api_input_ws(
|
|||||||
continue
|
continue
|
||||||
|
|
||||||
elif "bytes" in message:
|
elif "bytes" in message:
|
||||||
# Binary frame: raw RGBRGB... bytes (3 bytes per LED)
|
# Binary frame: raw RGBRGB... bytes (3 bytes per LED).
|
||||||
|
# Cap to a generous upper bound on the LED count — a hostile
|
||||||
|
# client could otherwise stream 100 MB frames and OOM the
|
||||||
|
# server before any application logic ran.
|
||||||
raw_bytes = message["bytes"]
|
raw_bytes = message["bytes"]
|
||||||
|
_MAX_BINARY_LEDS = 8192
|
||||||
|
if len(raw_bytes) > _MAX_BINARY_LEDS * 3:
|
||||||
|
await websocket.send_json(
|
||||||
|
{"error": f"Binary frame too large (max {_MAX_BINARY_LEDS} LEDs)"}
|
||||||
|
)
|
||||||
|
continue
|
||||||
if len(raw_bytes) % 3 != 0:
|
if len(raw_bytes) % 3 != 0:
|
||||||
await websocket.send_json({"error": "Binary data must be multiple of 3 bytes"})
|
await websocket.send_json({"error": "Binary data must be multiple of 3 bytes"})
|
||||||
continue
|
continue
|
||||||
@@ -476,13 +578,16 @@ async def test_color_strip_ws(
|
|||||||
meta["layer_infos"] = layer_infos
|
meta["layer_infos"] = layer_infos
|
||||||
await websocket.send_text(_json.dumps(meta))
|
await websocket.send_text(_json.dumps(meta))
|
||||||
|
|
||||||
# For api_input: send the current buffer immediately so the client
|
# For api_input: only send an initial frame if a client has actually
|
||||||
# gets a frame right away (fallback color if inactive) rather than
|
# pushed data (push_generation > 0). Without prior data, the preview
|
||||||
# leaving the canvas blank/stale until external data arrives.
|
# stays blank instead of showing the fallback buffer as a stray frame.
|
||||||
if is_api_input:
|
if is_api_input:
|
||||||
initial_colors = stream.get_latest_colors()
|
initial_gen = stream.push_generation
|
||||||
if initial_colors is not None:
|
if initial_gen > 0:
|
||||||
await websocket.send_bytes(initial_colors.tobytes())
|
_last_push_gen = initial_gen
|
||||||
|
initial_colors = stream.get_latest_colors()
|
||||||
|
if initial_colors is not None:
|
||||||
|
await websocket.send_bytes(initial_colors.tobytes())
|
||||||
|
|
||||||
# For picture sources, grab the live stream for frame preview
|
# For picture sources, grab the live stream for frame preview
|
||||||
_frame_live = None
|
_frame_live = None
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ from fastapi import APIRouter, HTTPException, Depends, Query, WebSocket, WebSock
|
|||||||
|
|
||||||
from ledgrab.api.auth import AuthRequired
|
from ledgrab.api.auth import AuthRequired
|
||||||
from ledgrab.core.devices.led_client import (
|
from ledgrab.core.devices.led_client import (
|
||||||
|
PairingNotReady,
|
||||||
get_all_providers,
|
get_all_providers,
|
||||||
get_device_capabilities,
|
get_device_capabilities,
|
||||||
get_provider,
|
get_provider,
|
||||||
@@ -12,6 +13,7 @@ from ledgrab.core.devices.led_client import (
|
|||||||
from ledgrab.api.dependencies import (
|
from ledgrab.api.dependencies import (
|
||||||
fire_entity_event,
|
fire_entity_event,
|
||||||
get_device_store,
|
get_device_store,
|
||||||
|
get_mqtt_store,
|
||||||
get_output_target_store,
|
get_output_target_store,
|
||||||
get_processor_manager,
|
get_processor_manager,
|
||||||
)
|
)
|
||||||
@@ -26,18 +28,48 @@ from ledgrab.api.schemas.devices import (
|
|||||||
DiscoverDevicesResponse,
|
DiscoverDevicesResponse,
|
||||||
OpenRGBZoneResponse,
|
OpenRGBZoneResponse,
|
||||||
OpenRGBZonesResponse,
|
OpenRGBZonesResponse,
|
||||||
|
PairDeviceRequest,
|
||||||
|
PairDeviceResponse,
|
||||||
PowerRequest,
|
PowerRequest,
|
||||||
)
|
)
|
||||||
from ledgrab.core.processing.processor_manager import ProcessorManager
|
from ledgrab.core.processing.processor_manager import ProcessorManager
|
||||||
from ledgrab.storage import DeviceStore
|
from ledgrab.storage import DeviceStore
|
||||||
|
from ledgrab.storage.mqtt_source_store import MQTTSourceStore
|
||||||
from ledgrab.storage.output_target_store import OutputTargetStore
|
from ledgrab.storage.output_target_store import OutputTargetStore
|
||||||
from ledgrab.utils import get_logger
|
from ledgrab.utils import get_logger
|
||||||
|
from ledgrab.utils.url_scheme import infer_http_scheme
|
||||||
|
|
||||||
|
from ._mqtt_validation import validate_mqtt_source_exists
|
||||||
|
|
||||||
logger = get_logger(__name__)
|
logger = get_logger(__name__)
|
||||||
|
|
||||||
router = APIRouter()
|
router = APIRouter()
|
||||||
|
|
||||||
|
|
||||||
|
def _sanitize_url_for_log(url: str) -> str:
|
||||||
|
"""Strip userinfo + fragment from a URL so secrets don't reach logs.
|
||||||
|
|
||||||
|
The pair endpoint receives a user-supplied URL on every call; if a
|
||||||
|
future driver ever accepts ``scheme://user:pass@host`` form the
|
||||||
|
credentials would land in logs without this guard.
|
||||||
|
"""
|
||||||
|
if not url:
|
||||||
|
return ""
|
||||||
|
try:
|
||||||
|
from urllib.parse import urlparse, urlunparse
|
||||||
|
|
||||||
|
parsed = urlparse(url)
|
||||||
|
# urlparse stores userinfo in `netloc`; rebuild without it.
|
||||||
|
if parsed.hostname:
|
||||||
|
netloc = parsed.hostname
|
||||||
|
if parsed.port:
|
||||||
|
netloc = f"{netloc}:{parsed.port}"
|
||||||
|
return urlunparse((parsed.scheme, netloc, parsed.path, parsed.params, parsed.query, ""))
|
||||||
|
except ValueError:
|
||||||
|
pass
|
||||||
|
return url
|
||||||
|
|
||||||
|
|
||||||
def _device_to_response(device) -> DeviceResponse:
|
def _device_to_response(device) -> DeviceResponse:
|
||||||
"""Convert a Device to DeviceResponse."""
|
"""Convert a Device to DeviceResponse."""
|
||||||
return DeviceResponse(
|
return DeviceResponse(
|
||||||
@@ -57,20 +89,32 @@ def _device_to_response(device) -> DeviceResponse:
|
|||||||
dmx_protocol=device.dmx_protocol,
|
dmx_protocol=device.dmx_protocol,
|
||||||
dmx_start_universe=device.dmx_start_universe,
|
dmx_start_universe=device.dmx_start_universe,
|
||||||
dmx_start_channel=device.dmx_start_channel,
|
dmx_start_channel=device.dmx_start_channel,
|
||||||
|
ddp_port=device.ddp_port,
|
||||||
|
ddp_destination_id=device.ddp_destination_id,
|
||||||
|
ddp_color_order=device.ddp_color_order,
|
||||||
espnow_peer_mac=device.espnow_peer_mac,
|
espnow_peer_mac=device.espnow_peer_mac,
|
||||||
espnow_channel=device.espnow_channel,
|
espnow_channel=device.espnow_channel,
|
||||||
hue_username=device.hue_username,
|
hue_paired=bool(device.hue_username and device.hue_client_key),
|
||||||
hue_client_key=device.hue_client_key,
|
|
||||||
hue_entertainment_group_id=device.hue_entertainment_group_id,
|
hue_entertainment_group_id=device.hue_entertainment_group_id,
|
||||||
|
yeelight_min_interval_ms=device.yeelight_min_interval_ms,
|
||||||
|
wiz_min_interval_ms=device.wiz_min_interval_ms,
|
||||||
|
lifx_min_interval_ms=device.lifx_min_interval_ms,
|
||||||
|
govee_min_interval_ms=device.govee_min_interval_ms,
|
||||||
|
opc_channel=device.opc_channel,
|
||||||
|
nanoleaf_paired=bool(device.nanoleaf_token),
|
||||||
|
nanoleaf_min_interval_ms=device.nanoleaf_min_interval_ms,
|
||||||
spi_speed_hz=device.spi_speed_hz,
|
spi_speed_hz=device.spi_speed_hz,
|
||||||
spi_led_type=device.spi_led_type,
|
spi_led_type=device.spi_led_type,
|
||||||
chroma_device_type=device.chroma_device_type,
|
chroma_device_type=device.chroma_device_type,
|
||||||
gamesense_device_type=device.gamesense_device_type,
|
gamesense_device_type=device.gamesense_device_type,
|
||||||
ble_family=device.ble_family,
|
ble_family=device.ble_family,
|
||||||
ble_govee_key=device.ble_govee_key,
|
ble_govee_key=device.ble_govee_key,
|
||||||
|
mqtt_source_id=getattr(device, "mqtt_source_id", "") or "",
|
||||||
default_css_processing_template_id=device.default_css_processing_template_id,
|
default_css_processing_template_id=device.default_css_processing_template_id,
|
||||||
group_device_ids=device.group_device_ids,
|
group_device_ids=device.group_device_ids,
|
||||||
group_mode=device.group_mode,
|
group_mode=device.group_mode,
|
||||||
|
icon=getattr(device, "icon", "") or "",
|
||||||
|
icon_color=getattr(device, "icon_color", "") or "",
|
||||||
created_at=device.created_at,
|
created_at=device.created_at,
|
||||||
updated_at=device.updated_at,
|
updated_at=device.updated_at,
|
||||||
)
|
)
|
||||||
@@ -85,11 +129,13 @@ async def create_device(
|
|||||||
_auth: AuthRequired,
|
_auth: AuthRequired,
|
||||||
store: DeviceStore = Depends(get_device_store),
|
store: DeviceStore = Depends(get_device_store),
|
||||||
manager: ProcessorManager = Depends(get_processor_manager),
|
manager: ProcessorManager = Depends(get_processor_manager),
|
||||||
|
mqtt_store: MQTTSourceStore = Depends(get_mqtt_store),
|
||||||
):
|
):
|
||||||
"""Create and attach a new LED device."""
|
"""Create and attach a new LED device."""
|
||||||
try:
|
try:
|
||||||
device_type = device_data.device_type
|
device_type = device_data.device_type
|
||||||
logger.info(f"Creating {device_type} device: {device_data.name}")
|
logger.info(f"Creating {device_type} device: {device_data.name}")
|
||||||
|
validate_mqtt_source_exists(mqtt_store, device_data.mqtt_source_id)
|
||||||
|
|
||||||
# ── Group device: validate children + compute LED count ──
|
# ── Group device: validate children + compute LED count ──
|
||||||
if device_type == "group":
|
if device_type == "group":
|
||||||
@@ -132,6 +178,8 @@ async def create_device(
|
|||||||
detail="URL is required for non-group device types.",
|
detail="URL is required for non-group device types.",
|
||||||
)
|
)
|
||||||
device_url = device_data.url.rstrip("/")
|
device_url = device_data.url.rstrip("/")
|
||||||
|
if device_type == "wled":
|
||||||
|
device_url = infer_http_scheme(device_url)
|
||||||
|
|
||||||
# ── Non-group: validate via provider ──
|
# ── Non-group: validate via provider ──
|
||||||
if device_type != "group":
|
if device_type != "group":
|
||||||
@@ -166,9 +214,19 @@ async def create_device(
|
|||||||
except HTTPException:
|
except HTTPException:
|
||||||
raise
|
raise
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
|
# Don't leak the raw exception text — it can carry stack
|
||||||
|
# frames, host headers, or other internals that aren't safe
|
||||||
|
# to echo. Log with full context, return a generic message.
|
||||||
|
logger.warning(
|
||||||
|
"Failed to validate %s device at %s: %s",
|
||||||
|
device_type,
|
||||||
|
device_url,
|
||||||
|
e,
|
||||||
|
exc_info=True,
|
||||||
|
)
|
||||||
raise HTTPException(
|
raise HTTPException(
|
||||||
status_code=422,
|
status_code=422,
|
||||||
detail=f"Failed to connect to {device_type} device at {device_url}: {e}",
|
detail=f"Failed to connect to {device_type} device at {device_url}.",
|
||||||
)
|
)
|
||||||
|
|
||||||
# Resolve auto_shutdown default: False for all types
|
# Resolve auto_shutdown default: False for all types
|
||||||
@@ -179,7 +237,7 @@ async def create_device(
|
|||||||
# Create device in storage
|
# Create device in storage
|
||||||
device = store.create_device(
|
device = store.create_device(
|
||||||
name=device_data.name,
|
name=device_data.name,
|
||||||
url=device_data.url,
|
url=device_url,
|
||||||
led_count=led_count,
|
led_count=led_count,
|
||||||
device_type=device_type,
|
device_type=device_type,
|
||||||
baud_rate=device_data.baud_rate,
|
baud_rate=device_data.baud_rate,
|
||||||
@@ -191,17 +249,52 @@ async def create_device(
|
|||||||
dmx_protocol=device_data.dmx_protocol or "artnet",
|
dmx_protocol=device_data.dmx_protocol or "artnet",
|
||||||
dmx_start_universe=device_data.dmx_start_universe or 0,
|
dmx_start_universe=device_data.dmx_start_universe or 0,
|
||||||
dmx_start_channel=device_data.dmx_start_channel or 1,
|
dmx_start_channel=device_data.dmx_start_channel or 1,
|
||||||
|
ddp_port=device_data.ddp_port or 0,
|
||||||
|
ddp_destination_id=(
|
||||||
|
device_data.ddp_destination_id if device_data.ddp_destination_id is not None else 1
|
||||||
|
),
|
||||||
|
ddp_color_order=(
|
||||||
|
device_data.ddp_color_order if device_data.ddp_color_order is not None else 1
|
||||||
|
),
|
||||||
espnow_peer_mac=device_data.espnow_peer_mac or "",
|
espnow_peer_mac=device_data.espnow_peer_mac or "",
|
||||||
espnow_channel=device_data.espnow_channel or 1,
|
espnow_channel=device_data.espnow_channel or 1,
|
||||||
hue_username=device_data.hue_username or "",
|
hue_username=device_data.hue_username or "",
|
||||||
hue_client_key=device_data.hue_client_key or "",
|
hue_client_key=device_data.hue_client_key or "",
|
||||||
hue_entertainment_group_id=device_data.hue_entertainment_group_id or "",
|
hue_entertainment_group_id=device_data.hue_entertainment_group_id or "",
|
||||||
|
yeelight_min_interval_ms=(
|
||||||
|
device_data.yeelight_min_interval_ms
|
||||||
|
if device_data.yeelight_min_interval_ms is not None
|
||||||
|
else 500
|
||||||
|
),
|
||||||
|
wiz_min_interval_ms=(
|
||||||
|
device_data.wiz_min_interval_ms
|
||||||
|
if device_data.wiz_min_interval_ms is not None
|
||||||
|
else 50
|
||||||
|
),
|
||||||
|
lifx_min_interval_ms=(
|
||||||
|
device_data.lifx_min_interval_ms
|
||||||
|
if device_data.lifx_min_interval_ms is not None
|
||||||
|
else 50
|
||||||
|
),
|
||||||
|
govee_min_interval_ms=(
|
||||||
|
device_data.govee_min_interval_ms
|
||||||
|
if device_data.govee_min_interval_ms is not None
|
||||||
|
else 50
|
||||||
|
),
|
||||||
|
opc_channel=(device_data.opc_channel if device_data.opc_channel is not None else 0),
|
||||||
|
nanoleaf_token=device_data.nanoleaf_token or "",
|
||||||
|
nanoleaf_min_interval_ms=(
|
||||||
|
device_data.nanoleaf_min_interval_ms
|
||||||
|
if device_data.nanoleaf_min_interval_ms is not None
|
||||||
|
else 100
|
||||||
|
),
|
||||||
spi_speed_hz=device_data.spi_speed_hz or 800000,
|
spi_speed_hz=device_data.spi_speed_hz or 800000,
|
||||||
spi_led_type=device_data.spi_led_type or "WS2812B",
|
spi_led_type=device_data.spi_led_type or "WS2812B",
|
||||||
chroma_device_type=device_data.chroma_device_type or "chromalink",
|
chroma_device_type=device_data.chroma_device_type or "chromalink",
|
||||||
gamesense_device_type=device_data.gamesense_device_type or "keyboard",
|
gamesense_device_type=device_data.gamesense_device_type or "keyboard",
|
||||||
ble_family=device_data.ble_family or "",
|
ble_family=device_data.ble_family or "",
|
||||||
ble_govee_key=device_data.ble_govee_key or "",
|
ble_govee_key=device_data.ble_govee_key or "",
|
||||||
|
mqtt_source_id=device_data.mqtt_source_id or "",
|
||||||
group_device_ids=group_device_ids,
|
group_device_ids=group_device_ids,
|
||||||
group_mode=group_mode,
|
group_mode=group_mode,
|
||||||
)
|
)
|
||||||
@@ -231,6 +324,79 @@ async def create_device(
|
|||||||
raise HTTPException(status_code=500, detail="Internal server error")
|
raise HTTPException(status_code=500, detail="Internal server error")
|
||||||
|
|
||||||
|
|
||||||
|
@router.post(
|
||||||
|
"/api/v1/devices/pair",
|
||||||
|
response_model=PairDeviceResponse,
|
||||||
|
tags=["Devices"],
|
||||||
|
)
|
||||||
|
async def pair_device(
|
||||||
|
body: PairDeviceRequest,
|
||||||
|
_auth: AuthRequired,
|
||||||
|
):
|
||||||
|
"""Run a pairing handshake against a device before creating it.
|
||||||
|
|
||||||
|
The frontend opens this endpoint after the user has performed the
|
||||||
|
device's physical pairing action (e.g. held the power button for 5s).
|
||||||
|
The response carries provider-specific fields the caller must include
|
||||||
|
in the subsequent ``POST /api/v1/devices`` body.
|
||||||
|
|
||||||
|
Status codes:
|
||||||
|
200 paired — fields returned
|
||||||
|
400 unknown device type, or device type does not support pairing
|
||||||
|
409 device not ready — user must perform the physical action
|
||||||
|
(or retry, e.g. the pairing window timed out)
|
||||||
|
422 invalid URL or device configuration
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
provider = get_provider(body.device_type)
|
||||||
|
except ValueError:
|
||||||
|
raise HTTPException(status_code=400, detail=f"Unknown device type: {body.device_type}")
|
||||||
|
|
||||||
|
try:
|
||||||
|
fields = await provider.pair_device(body.url)
|
||||||
|
except NotImplementedError:
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=400,
|
||||||
|
detail=f"Device type {body.device_type!r} does not support pairing",
|
||||||
|
)
|
||||||
|
except PairingNotReady as exc:
|
||||||
|
raise HTTPException(status_code=409, detail=str(exc))
|
||||||
|
except ValueError as exc:
|
||||||
|
raise HTTPException(status_code=422, detail=str(exc))
|
||||||
|
except Exception as exc:
|
||||||
|
# Strip userinfo before logging so a `scheme://user:pass@host` URL
|
||||||
|
# never lands in the logs (no shipped driver uses userinfo today,
|
||||||
|
# but the pattern is a foot-gun for the next driver author --
|
||||||
|
# caught by review MEDIUM #9). Also keep exc_info=False so a
|
||||||
|
# provider stack trace that may include response bytes from a
|
||||||
|
# hostile receiver doesn't end up in the file either.
|
||||||
|
safe_url = _sanitize_url_for_log(body.url)
|
||||||
|
logger.warning(
|
||||||
|
"Pairing failed for %s at %s: %s: %s",
|
||||||
|
body.device_type,
|
||||||
|
safe_url,
|
||||||
|
type(exc).__name__,
|
||||||
|
exc,
|
||||||
|
)
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=502,
|
||||||
|
detail=f"Pairing failed for {body.device_type} at {safe_url}.",
|
||||||
|
)
|
||||||
|
|
||||||
|
if not isinstance(fields, dict):
|
||||||
|
logger.warning(
|
||||||
|
"Provider %s.pair_device returned %r (expected dict)",
|
||||||
|
body.device_type,
|
||||||
|
type(fields).__name__,
|
||||||
|
)
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=500,
|
||||||
|
detail=f"Provider {body.device_type!r} returned malformed pairing result",
|
||||||
|
)
|
||||||
|
|
||||||
|
return PairDeviceResponse(fields=fields)
|
||||||
|
|
||||||
|
|
||||||
@router.get("/api/v1/devices", response_model=DeviceListResponse, tags=["Devices"])
|
@router.get("/api/v1/devices", response_model=DeviceListResponse, tags=["Devices"])
|
||||||
async def list_devices(
|
async def list_devices(
|
||||||
_auth: AuthRequired,
|
_auth: AuthRequired,
|
||||||
@@ -264,11 +430,20 @@ async def discover_devices(
|
|||||||
raise HTTPException(status_code=400, detail=f"Unknown device type: {device_type}")
|
raise HTTPException(status_code=400, detail=f"Unknown device type: {device_type}")
|
||||||
discovered = await provider.discover(timeout=capped_timeout)
|
discovered = await provider.discover(timeout=capped_timeout)
|
||||||
else:
|
else:
|
||||||
# Discover from all providers in parallel
|
# Discover from all providers in parallel. Discovery is best-effort:
|
||||||
|
# one provider failing (firewall, missing dep, mDNS race) must not
|
||||||
|
# take the entire scan down, so collect exceptions instead of
|
||||||
|
# raising and log them individually.
|
||||||
providers = get_all_providers()
|
providers = get_all_providers()
|
||||||
discover_tasks = [p.discover(timeout=capped_timeout) for p in providers.values()]
|
provider_items = list(providers.items())
|
||||||
all_results = await asyncio.gather(*discover_tasks)
|
discover_tasks = [p.discover(timeout=capped_timeout) for _, p in provider_items]
|
||||||
discovered = [d for batch in all_results for d in batch]
|
all_results = await asyncio.gather(*discover_tasks, return_exceptions=True)
|
||||||
|
discovered = []
|
||||||
|
for (name, _), result in zip(provider_items, all_results):
|
||||||
|
if isinstance(result, BaseException):
|
||||||
|
logger.warning("Discovery failed for provider %s: %s", name, result)
|
||||||
|
continue
|
||||||
|
discovered.extend(result)
|
||||||
elapsed_ms = (time.time() - start) * 1000
|
elapsed_ms = (time.time() - start) * 1000
|
||||||
|
|
||||||
existing_urls = {d.url.rstrip("/").lower() for d in store.get_all_devices()}
|
existing_urls = {d.url.rstrip("/").lower() for d in store.get_all_devices()}
|
||||||
@@ -376,12 +551,34 @@ async def update_device(
|
|||||||
_auth: AuthRequired,
|
_auth: AuthRequired,
|
||||||
store: DeviceStore = Depends(get_device_store),
|
store: DeviceStore = Depends(get_device_store),
|
||||||
manager: ProcessorManager = Depends(get_processor_manager),
|
manager: ProcessorManager = Depends(get_processor_manager),
|
||||||
|
mqtt_store: MQTTSourceStore = Depends(get_mqtt_store),
|
||||||
):
|
):
|
||||||
"""Update device information."""
|
"""Update device information."""
|
||||||
try:
|
try:
|
||||||
# Group-specific validation before applying update
|
# Group-specific validation before applying update
|
||||||
existing = store.get_device(device_id)
|
existing = store.get_device(device_id)
|
||||||
is_group = existing.device_type == "group"
|
is_group = existing.device_type == "group"
|
||||||
|
validate_mqtt_source_exists(mqtt_store, update_data.mqtt_source_id)
|
||||||
|
|
||||||
|
# Normalize URL the same way we do on create:
|
||||||
|
# * always rstrip trailing slashes (so PUT-with-trailing-/ matches
|
||||||
|
# POST-with-trailing-/ in the stored value -- caught by review HIGH #6)
|
||||||
|
# * only WLED gets http/https scheme inference; other schemes
|
||||||
|
# (yeelight://, lifx://, opc://, ddp://, …) pass through.
|
||||||
|
# Done via a local rather than mutating the request DTO so the
|
||||||
|
# input is preserved for any future caller that inspects it.
|
||||||
|
normalized_url = update_data.url
|
||||||
|
if update_data.url:
|
||||||
|
normalized_url = update_data.url.rstrip("/")
|
||||||
|
if existing.device_type == "wled":
|
||||||
|
inferred = infer_http_scheme(normalized_url)
|
||||||
|
if inferred != normalized_url:
|
||||||
|
logger.debug("Inferred WLED URL scheme: %r -> %r", normalized_url, inferred)
|
||||||
|
normalized_url = inferred
|
||||||
|
|
||||||
|
# Group-only field overrides (led_count auto-recompute) are accumulated
|
||||||
|
# here too so the update_data Pydantic model is not mutated in place.
|
||||||
|
normalized_led_count = update_data.led_count
|
||||||
|
|
||||||
if is_group:
|
if is_group:
|
||||||
new_children = update_data.group_device_ids
|
new_children = update_data.group_device_ids
|
||||||
@@ -403,20 +600,20 @@ async def update_device(
|
|||||||
|
|
||||||
# Auto-recompute led_count for sequence mode
|
# Auto-recompute led_count for sequence mode
|
||||||
if effective_mode == "sequence":
|
if effective_mode == "sequence":
|
||||||
update_data.led_count = store.resolve_group_led_count(effective_children)
|
normalized_led_count = store.resolve_group_led_count(effective_children)
|
||||||
elif (
|
elif (
|
||||||
update_data.led_count is None
|
normalized_led_count is None
|
||||||
and new_mode == "independent"
|
and new_mode == "independent"
|
||||||
and new_children is not None
|
and new_children is not None
|
||||||
):
|
):
|
||||||
update_data.led_count = store.resolve_group_max_led_count(effective_children)
|
normalized_led_count = store.resolve_group_max_led_count(effective_children)
|
||||||
|
|
||||||
device = store.update_device(
|
device = store.update_device(
|
||||||
device_id=device_id,
|
device_id=device_id,
|
||||||
name=update_data.name,
|
name=update_data.name,
|
||||||
url=update_data.url,
|
url=normalized_url,
|
||||||
enabled=update_data.enabled,
|
enabled=update_data.enabled,
|
||||||
led_count=update_data.led_count,
|
led_count=normalized_led_count,
|
||||||
baud_rate=update_data.baud_rate,
|
baud_rate=update_data.baud_rate,
|
||||||
auto_shutdown=update_data.auto_shutdown,
|
auto_shutdown=update_data.auto_shutdown,
|
||||||
send_latency_ms=update_data.send_latency_ms,
|
send_latency_ms=update_data.send_latency_ms,
|
||||||
@@ -426,32 +623,51 @@ async def update_device(
|
|||||||
dmx_protocol=update_data.dmx_protocol,
|
dmx_protocol=update_data.dmx_protocol,
|
||||||
dmx_start_universe=update_data.dmx_start_universe,
|
dmx_start_universe=update_data.dmx_start_universe,
|
||||||
dmx_start_channel=update_data.dmx_start_channel,
|
dmx_start_channel=update_data.dmx_start_channel,
|
||||||
|
ddp_port=update_data.ddp_port,
|
||||||
|
ddp_destination_id=update_data.ddp_destination_id,
|
||||||
|
ddp_color_order=update_data.ddp_color_order,
|
||||||
espnow_peer_mac=update_data.espnow_peer_mac,
|
espnow_peer_mac=update_data.espnow_peer_mac,
|
||||||
espnow_channel=update_data.espnow_channel,
|
espnow_channel=update_data.espnow_channel,
|
||||||
hue_username=update_data.hue_username,
|
hue_username=update_data.hue_username,
|
||||||
hue_client_key=update_data.hue_client_key,
|
hue_client_key=update_data.hue_client_key,
|
||||||
hue_entertainment_group_id=update_data.hue_entertainment_group_id,
|
hue_entertainment_group_id=update_data.hue_entertainment_group_id,
|
||||||
|
yeelight_min_interval_ms=update_data.yeelight_min_interval_ms,
|
||||||
|
wiz_min_interval_ms=update_data.wiz_min_interval_ms,
|
||||||
|
lifx_min_interval_ms=update_data.lifx_min_interval_ms,
|
||||||
|
govee_min_interval_ms=update_data.govee_min_interval_ms,
|
||||||
|
opc_channel=update_data.opc_channel,
|
||||||
|
nanoleaf_token=update_data.nanoleaf_token,
|
||||||
|
nanoleaf_min_interval_ms=update_data.nanoleaf_min_interval_ms,
|
||||||
spi_speed_hz=update_data.spi_speed_hz,
|
spi_speed_hz=update_data.spi_speed_hz,
|
||||||
spi_led_type=update_data.spi_led_type,
|
spi_led_type=update_data.spi_led_type,
|
||||||
chroma_device_type=update_data.chroma_device_type,
|
chroma_device_type=update_data.chroma_device_type,
|
||||||
gamesense_device_type=update_data.gamesense_device_type,
|
gamesense_device_type=update_data.gamesense_device_type,
|
||||||
ble_family=update_data.ble_family,
|
ble_family=update_data.ble_family,
|
||||||
ble_govee_key=update_data.ble_govee_key,
|
ble_govee_key=update_data.ble_govee_key,
|
||||||
|
mqtt_source_id=update_data.mqtt_source_id,
|
||||||
group_device_ids=update_data.group_device_ids,
|
group_device_ids=update_data.group_device_ids,
|
||||||
group_mode=update_data.group_mode,
|
group_mode=update_data.group_mode,
|
||||||
|
icon=update_data.icon,
|
||||||
|
icon_color=update_data.icon_color,
|
||||||
)
|
)
|
||||||
|
|
||||||
# Sync connection info in processor manager
|
# Sync connection info in processor manager.
|
||||||
|
#
|
||||||
|
# When a PATCH omits `url` (rename / icon-only edit) `normalized_url`
|
||||||
|
# is None — fall back to the existing record's URL so the processor
|
||||||
|
# is always told the current address, otherwise it silently keeps
|
||||||
|
# whatever it had cached (or worse, treats None as "unconfigured"
|
||||||
|
# and refuses to re-sync).
|
||||||
|
effective_url = normalized_url if normalized_url is not None else existing.url
|
||||||
try:
|
try:
|
||||||
manager.update_device_info(
|
manager.update_device_info(
|
||||||
device_id,
|
device_id,
|
||||||
device_url=update_data.url,
|
device_url=effective_url,
|
||||||
led_count=update_data.led_count,
|
led_count=normalized_led_count,
|
||||||
baud_rate=update_data.baud_rate,
|
baud_rate=update_data.baud_rate,
|
||||||
)
|
)
|
||||||
except ValueError as e:
|
except ValueError as e:
|
||||||
logger.debug("Processor manager device update skipped for %s: %s", device_id, e)
|
logger.debug("Processor manager device update skipped for %s: %s", device_id, e)
|
||||||
pass
|
|
||||||
|
|
||||||
# Sync auto_shutdown and zone_mode in runtime state
|
# Sync auto_shutdown and zone_mode in runtime state
|
||||||
ds = manager.find_device_state(device_id)
|
ds = manager.find_device_state(device_id)
|
||||||
@@ -464,6 +680,10 @@ async def update_device(
|
|||||||
fire_entity_event("device", "updated", device_id)
|
fire_entity_event("device", "updated", device_id)
|
||||||
return _device_to_response(device)
|
return _device_to_response(device)
|
||||||
|
|
||||||
|
except HTTPException:
|
||||||
|
# Intentional 4xx (e.g. unknown mqtt_source_id, group validation)
|
||||||
|
# must propagate unchanged — not be masked as a 500.
|
||||||
|
raise
|
||||||
except ValueError as e:
|
except ValueError as e:
|
||||||
raise HTTPException(status_code=404, detail=str(e))
|
raise HTTPException(status_code=404, detail=str(e))
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
@@ -572,6 +792,32 @@ async def ping_device(
|
|||||||
# ===== WLED BRIGHTNESS ENDPOINTS =====
|
# ===== WLED BRIGHTNESS ENDPOINTS =====
|
||||||
|
|
||||||
|
|
||||||
|
async def resolve_device_brightness(device, manager: ProcessorManager) -> int | None:
|
||||||
|
"""Resolve a device's current brightness for aggregate/batch reads.
|
||||||
|
|
||||||
|
Mirrors GET /brightness but degrades to ``None`` instead of raising, so one
|
||||||
|
unreachable device can't fail a whole snapshot. Reads the server-side cache
|
||||||
|
first and only touches hardware when the cache is cold, then populates it so
|
||||||
|
subsequent reads are I/O-free.
|
||||||
|
"""
|
||||||
|
if "brightness_control" not in get_device_capabilities(device.device_type):
|
||||||
|
return None
|
||||||
|
ds = manager.find_device_state(device.id)
|
||||||
|
if ds and ds.hardware_brightness is not None:
|
||||||
|
return ds.hardware_brightness
|
||||||
|
try:
|
||||||
|
provider = get_provider(device.device_type)
|
||||||
|
bri = await provider.get_brightness(device.url)
|
||||||
|
if ds:
|
||||||
|
ds.hardware_brightness = bri
|
||||||
|
return bri
|
||||||
|
except NotImplementedError:
|
||||||
|
return device.software_brightness
|
||||||
|
except Exception as e:
|
||||||
|
logger.warning("Failed to resolve brightness for device %s: %s", device.id, e)
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
@router.get("/api/v1/devices/{device_id}/brightness", tags=["Settings"])
|
@router.get("/api/v1/devices/{device_id}/brightness", tags=["Settings"])
|
||||||
async def get_device_brightness(
|
async def get_device_brightness(
|
||||||
device_id: str,
|
device_id: str,
|
||||||
|
|||||||
@@ -158,6 +158,8 @@ def _config_to_response(config: Any) -> GameIntegrationResponse:
|
|||||||
updated_at=config.updated_at,
|
updated_at=config.updated_at,
|
||||||
description=config.description,
|
description=config.description,
|
||||||
tags=config.tags,
|
tags=config.tags,
|
||||||
|
icon=getattr(config, "icon", "") or "",
|
||||||
|
icon_color=getattr(config, "icon_color", "") or "",
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -255,6 +257,8 @@ async def create_integration(
|
|||||||
event_mappings=mappings,
|
event_mappings=mappings,
|
||||||
description=data.description,
|
description=data.description,
|
||||||
tags=data.tags,
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
)
|
)
|
||||||
|
|
||||||
fire_entity_event("game_integration", "created", config.id)
|
fire_entity_event("game_integration", "created", config.id)
|
||||||
@@ -323,6 +327,8 @@ async def update_integration(
|
|||||||
event_mappings=mappings,
|
event_mappings=mappings,
|
||||||
description=data.description,
|
description=data.description,
|
||||||
tags=data.tags,
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
)
|
)
|
||||||
|
|
||||||
fire_entity_event("game_integration", "updated", integration_id)
|
fire_entity_event("game_integration", "updated", integration_id)
|
||||||
|
|||||||
@@ -35,6 +35,8 @@ def _to_response(gradient: Gradient) -> GradientResponse:
|
|||||||
tags=gradient.tags,
|
tags=gradient.tags,
|
||||||
created_at=gradient.created_at,
|
created_at=gradient.created_at,
|
||||||
updated_at=gradient.updated_at,
|
updated_at=gradient.updated_at,
|
||||||
|
icon=getattr(gradient, "icon", "") or "",
|
||||||
|
icon_color=getattr(gradient, "icon_color", "") or "",
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -66,6 +68,8 @@ async def create_gradient(
|
|||||||
stops=[s.model_dump() for s in data.stops],
|
stops=[s.model_dump() for s in data.stops],
|
||||||
description=data.description,
|
description=data.description,
|
||||||
tags=data.tags,
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
)
|
)
|
||||||
fire_entity_event("gradient", "created", gradient.id)
|
fire_entity_event("gradient", "created", gradient.id)
|
||||||
return _to_response(gradient)
|
return _to_response(gradient)
|
||||||
@@ -103,6 +107,8 @@ async def update_gradient(
|
|||||||
stops=stops,
|
stops=stops,
|
||||||
description=data.description,
|
description=data.description,
|
||||||
tags=data.tags,
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
)
|
)
|
||||||
fire_entity_event("gradient", "updated", gradient_id)
|
fire_entity_event("gradient", "updated", gradient_id)
|
||||||
return _to_response(gradient)
|
return _to_response(gradient)
|
||||||
|
|||||||
@@ -0,0 +1,249 @@
|
|||||||
|
"""Wiring-graph endpoints: schema registry, full topology, and dependents.
|
||||||
|
|
||||||
|
These power the visual graph editor (and any other client) with a single
|
||||||
|
authoritative view of how entities are wired together:
|
||||||
|
|
||||||
|
* ``GET /api/v1/graph/schema`` — the connectable-field registry.
|
||||||
|
* ``GET /api/v1/graph`` — nodes + edges + validation.
|
||||||
|
* ``GET /api/v1/graph/dependents/{kind}/{id}`` — what references an entity.
|
||||||
|
|
||||||
|
All heavy logic lives in :mod:`ledgrab.api.graph_schema` (pure, unit-tested);
|
||||||
|
this layer only gathers serialized entities from the stores and delegates.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
from typing import Any, Callable
|
||||||
|
|
||||||
|
from fastapi import APIRouter, HTTPException
|
||||||
|
from fastapi.concurrency import run_in_threadpool
|
||||||
|
from pydantic import BaseModel, Field
|
||||||
|
|
||||||
|
from ledgrab.api import dependencies as deps
|
||||||
|
from ledgrab.api.auth import AuthRequired
|
||||||
|
from ledgrab.api.graph_schema import (
|
||||||
|
ENTITY_KINDS,
|
||||||
|
NODE_TYPE_FIELD,
|
||||||
|
build_topology,
|
||||||
|
extract_refs,
|
||||||
|
find_dependents,
|
||||||
|
remap_refs,
|
||||||
|
schema_as_dicts,
|
||||||
|
schema_for_kind,
|
||||||
|
serialize_entity,
|
||||||
|
serialize_entity_for_graph,
|
||||||
|
validate_connection,
|
||||||
|
)
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
class ConnectionValidationRequest(BaseModel):
|
||||||
|
"""A proposed wiring edit: set ``target_kind.field`` to ``source_id``."""
|
||||||
|
|
||||||
|
target_kind: str
|
||||||
|
target_id: str
|
||||||
|
field: str
|
||||||
|
source_id: str = Field(default="", description="Empty string detaches the slot.")
|
||||||
|
|
||||||
|
|
||||||
|
router = APIRouter()
|
||||||
|
|
||||||
|
# kind → dependency getter for the store that owns that entity kind.
|
||||||
|
_KIND_STORES: dict[str, Callable[[], Any]] = {
|
||||||
|
"device": deps.get_device_store,
|
||||||
|
"capture_template": deps.get_template_store,
|
||||||
|
"pp_template": deps.get_pp_template_store,
|
||||||
|
"audio_template": deps.get_audio_template_store,
|
||||||
|
"pattern_template": deps.get_pattern_template_store,
|
||||||
|
"picture_source": deps.get_picture_source_store,
|
||||||
|
"audio_source": deps.get_audio_source_store,
|
||||||
|
"value_source": deps.get_value_source_store,
|
||||||
|
"color_strip_source": deps.get_color_strip_store,
|
||||||
|
"sync_clock": deps.get_sync_clock_store,
|
||||||
|
"output_target": deps.get_output_target_store,
|
||||||
|
"scene_preset": deps.get_scene_preset_store,
|
||||||
|
"automation": deps.get_automation_store,
|
||||||
|
"cspt": deps.get_cspt_store,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _gather_entities() -> dict[str, list[dict[str, Any]]]:
|
||||||
|
"""Serialize every entity, keyed by kind. Missing stores yield ``[]``."""
|
||||||
|
out: dict[str, list[dict[str, Any]]] = {}
|
||||||
|
for kind, getter in _KIND_STORES.items():
|
||||||
|
try:
|
||||||
|
store = getter()
|
||||||
|
models = store.get_all()
|
||||||
|
except (
|
||||||
|
Exception
|
||||||
|
) as exc: # noqa: BLE001 — an uninitialized/failing store must not 500 the graph
|
||||||
|
logger.warning("graph: store for kind %s unavailable: %s", kind, exc)
|
||||||
|
out[kind] = []
|
||||||
|
continue
|
||||||
|
out[kind] = [serialize_entity_for_graph(kind, m) for m in models]
|
||||||
|
return out
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/api/v1/graph/schema", tags=["Graph"])
|
||||||
|
async def get_graph_schema(_auth: AuthRequired) -> dict[str, Any]:
|
||||||
|
"""Return the authoritative registry of connectable reference fields."""
|
||||||
|
return {
|
||||||
|
"kinds": list(ENTITY_KINDS),
|
||||||
|
"node_type_field": NODE_TYPE_FIELD,
|
||||||
|
"connections": schema_as_dicts(),
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/api/v1/graph", tags=["Graph"])
|
||||||
|
async def get_graph(_auth: AuthRequired) -> dict[str, Any]:
|
||||||
|
"""Return the full wiring topology (nodes + edges) and a validation report."""
|
||||||
|
entities = await run_in_threadpool(_gather_entities)
|
||||||
|
return build_topology(entities)
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/api/v1/graph/dependents/{kind}/{entity_id}", tags=["Graph"])
|
||||||
|
async def get_graph_dependents(kind: str, entity_id: str, _auth: AuthRequired) -> dict[str, Any]:
|
||||||
|
"""Return every entity that references ``(kind, entity_id)``."""
|
||||||
|
if kind not in ENTITY_KINDS:
|
||||||
|
raise HTTPException(status_code=404, detail=f"Unknown entity kind: {kind}")
|
||||||
|
entities = await run_in_threadpool(_gather_entities)
|
||||||
|
return {"dependents": find_dependents(entities, kind, entity_id)}
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/api/v1/graph/validate-connection", tags=["Graph"])
|
||||||
|
async def validate_graph_connection(
|
||||||
|
body: ConnectionValidationRequest, _auth: AuthRequired
|
||||||
|
) -> dict[str, Any]:
|
||||||
|
"""Validate a proposed wiring edit (existence + source kind + no cycle).
|
||||||
|
|
||||||
|
The graph editor calls this before persisting a drag-connect so it can
|
||||||
|
refuse edits that would dangle a reference or create a dependency loop.
|
||||||
|
"""
|
||||||
|
entities = await run_in_threadpool(_gather_entities)
|
||||||
|
ok, error = validate_connection(
|
||||||
|
entities, body.target_kind, body.target_id, body.field, body.source_id
|
||||||
|
)
|
||||||
|
return {"ok": ok, "error": error}
|
||||||
|
|
||||||
|
|
||||||
|
# ── Subgraph duplication (server-side blueprint instantiate) ─────────────────
|
||||||
|
# Only these kinds are cloned. They carry no inline secrets — they *reference*
|
||||||
|
# shared secret-bearing entities (devices, HA sources, HTTP endpoints) by id,
|
||||||
|
# and those are NOT cloned — and they have no hardware identity to conflict
|
||||||
|
# over. Output targets, automations, devices and integrations are out of scope.
|
||||||
|
_DUPLICABLE_KINDS: tuple[str, ...] = ("value_source", "color_strip_source")
|
||||||
|
_MAX_DUPLICATE = 200
|
||||||
|
|
||||||
|
|
||||||
|
class DuplicateRequest(BaseModel):
|
||||||
|
"""Duplicate a selected subgraph of value / colour-strip sources."""
|
||||||
|
|
||||||
|
node_ids: list[str] = Field(..., min_length=1, max_length=_MAX_DUPLICATE)
|
||||||
|
name_suffix: str = Field(default=" (copy)", max_length=40)
|
||||||
|
|
||||||
|
|
||||||
|
def _unique_name(existing: set[str], desired: str) -> str:
|
||||||
|
"""A name not already in ``existing`` (appends ' 2', ' 3', … on collision)."""
|
||||||
|
if desired not in existing:
|
||||||
|
return desired
|
||||||
|
i = 2
|
||||||
|
while f"{desired} {i}" in existing:
|
||||||
|
i += 1
|
||||||
|
return f"{desired} {i}"
|
||||||
|
|
||||||
|
|
||||||
|
def _duplicate_subgraph(node_ids: list[str], name_suffix: str) -> dict[str, Any]:
|
||||||
|
"""Deep-clone selected value/colour-strip sources with new ids, rewiring
|
||||||
|
references that point *within* the selection (shared deps are left alone)."""
|
||||||
|
# Index every duplicable entity by id → (kind, store, model); track names.
|
||||||
|
index: dict[str, tuple[str, Any, Any]] = {}
|
||||||
|
existing_names: dict[str, set[str]] = {}
|
||||||
|
for kind in _DUPLICABLE_KINDS:
|
||||||
|
try:
|
||||||
|
store = _KIND_STORES[kind]()
|
||||||
|
models = store.get_all()
|
||||||
|
except Exception as exc: # noqa: BLE001 — a failing store must not 500 the request
|
||||||
|
logger.warning("graph.duplicate: store for %s unavailable: %s", kind, exc)
|
||||||
|
continue
|
||||||
|
names = existing_names.setdefault(kind, set())
|
||||||
|
for m in models:
|
||||||
|
mid = getattr(m, "id", None)
|
||||||
|
mname = getattr(m, "name", None)
|
||||||
|
if isinstance(mname, str):
|
||||||
|
names.add(mname)
|
||||||
|
if isinstance(mid, str) and mid:
|
||||||
|
index[mid] = (kind, store, m)
|
||||||
|
|
||||||
|
selected: list[str] = []
|
||||||
|
skipped: list[dict[str, str]] = []
|
||||||
|
for nid in dict.fromkeys(node_ids): # de-dupe, preserve order
|
||||||
|
if nid in index:
|
||||||
|
selected.append(nid)
|
||||||
|
else:
|
||||||
|
skipped.append(
|
||||||
|
{"id": nid, "reason": "only value and colour-strip sources can be duplicated"}
|
||||||
|
)
|
||||||
|
|
||||||
|
# Pass 1 — create clones; their refs still point at the originals (valid).
|
||||||
|
id_map: dict[str, str] = {}
|
||||||
|
created: list[dict[str, str]] = []
|
||||||
|
clones: list[tuple[str, Any, str]] = []
|
||||||
|
for old_id in selected:
|
||||||
|
kind, store, model = index[old_id]
|
||||||
|
base = (getattr(model, "name", None) or old_id) + name_suffix
|
||||||
|
name = _unique_name(existing_names[kind], base)
|
||||||
|
existing_names[kind].add(name)
|
||||||
|
try:
|
||||||
|
new = store.clone(old_id, name)
|
||||||
|
except Exception as exc: # noqa: BLE001
|
||||||
|
logger.warning("graph.duplicate: clone of %s %s failed: %s", kind, old_id, exc)
|
||||||
|
skipped.append({"id": old_id, "reason": f"clone failed: {exc}"})
|
||||||
|
continue
|
||||||
|
id_map[old_id] = new.id
|
||||||
|
created.append({"id": new.id, "kind": kind, "name": new.name})
|
||||||
|
clones.append((kind, store, new.id))
|
||||||
|
|
||||||
|
# Pass 2 — rewrite references that point within the cloned set.
|
||||||
|
warnings: list[dict[str, str]] = []
|
||||||
|
for kind, store, new_id in clones:
|
||||||
|
clone = serialize_entity(store.get(new_id))
|
||||||
|
changed_roots: set[str] = set()
|
||||||
|
for cf in schema_for_kind(kind):
|
||||||
|
if remap_refs(clone, cf.field, id_map):
|
||||||
|
changed_roots.add(cf.field.split(".", 1)[0].removesuffix("[]"))
|
||||||
|
if not changed_roots:
|
||||||
|
continue
|
||||||
|
# `clone` is the FULL serialized entity, so each changed root carries a
|
||||||
|
# complete, structurally-intact value (the whole `layers` list / bindable
|
||||||
|
# dict) that ``update_source`` replaces or merges wholesale. (Within the
|
||||||
|
# duplicable set the only roots that change are scalar ids, `layers` and
|
||||||
|
# bindable slots — never a partially-built nested object.)
|
||||||
|
updates = {root: clone[root] for root in changed_roots if root in clone}
|
||||||
|
try:
|
||||||
|
store.update_source(new_id, **updates)
|
||||||
|
except Exception as exc: # noqa: BLE001
|
||||||
|
logger.warning("graph.duplicate: ref remap of %s failed: %s", new_id, exc)
|
||||||
|
warnings.append({"id": new_id, "reason": f"reference remap failed: {exc}"})
|
||||||
|
|
||||||
|
# Safety net — a clone must never still reference an OLD (in-selection) id.
|
||||||
|
for kind, store, new_id in clones:
|
||||||
|
clone = serialize_entity(store.get(new_id))
|
||||||
|
for cf in schema_for_kind(kind):
|
||||||
|
if any(ref in id_map for ref in extract_refs(clone, cf.field)):
|
||||||
|
warnings.append({"id": new_id, "reason": f"unremapped reference at {cf.field}"})
|
||||||
|
|
||||||
|
return {"id_map": id_map, "created": created, "skipped": skipped, "warnings": warnings}
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/api/v1/graph/duplicate", tags=["Graph"])
|
||||||
|
async def duplicate_subgraph(body: DuplicateRequest, _auth: AuthRequired) -> dict[str, Any]:
|
||||||
|
"""Deep-clone the selected value/colour-strip sources (new ids, wiring remapped).
|
||||||
|
|
||||||
|
References that point *within* the selection are rewired to the new clones;
|
||||||
|
references to entities outside it (devices, HA sources, …) stay shared with
|
||||||
|
the originals. Only value and colour-strip sources are cloned — they carry no
|
||||||
|
inline secrets — so any other kind in the selection is reported in ``skipped``.
|
||||||
|
"""
|
||||||
|
return await run_in_threadpool(_duplicate_subgraph, body.node_ids, body.name_suffix)
|
||||||
@@ -55,6 +55,8 @@ def _to_response(
|
|||||||
entity_count=len(runtime.get_all_states()) if runtime else 0,
|
entity_count=len(runtime.get_all_states()) if runtime else 0,
|
||||||
description=source.description,
|
description=source.description,
|
||||||
tags=source.tags,
|
tags=source.tags,
|
||||||
|
icon=getattr(source, "icon", "") or "",
|
||||||
|
icon_color=getattr(source, "icon_color", "") or "",
|
||||||
created_at=source.created_at,
|
created_at=source.created_at,
|
||||||
updated_at=source.updated_at,
|
updated_at=source.updated_at,
|
||||||
token=token_field,
|
token=token_field,
|
||||||
@@ -105,6 +107,8 @@ async def create_ha_source(
|
|||||||
entity_filters=data.entity_filters,
|
entity_filters=data.entity_filters,
|
||||||
description=data.description,
|
description=data.description,
|
||||||
tags=data.tags,
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
)
|
)
|
||||||
except ValueError as e:
|
except ValueError as e:
|
||||||
raise HTTPException(status_code=400, detail=str(e))
|
raise HTTPException(status_code=400, detail=str(e))
|
||||||
@@ -158,6 +162,8 @@ async def update_ha_source(
|
|||||||
entity_filters=data.entity_filters,
|
entity_filters=data.entity_filters,
|
||||||
description=data.description,
|
description=data.description,
|
||||||
tags=data.tags,
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
)
|
)
|
||||||
except EntityNotFoundError:
|
except EntityNotFoundError:
|
||||||
raise HTTPException(status_code=404, detail=f"Home Assistant source {source_id} not found")
|
raise HTTPException(status_code=404, detail=f"Home Assistant source {source_id} not found")
|
||||||
@@ -316,6 +322,7 @@ async def get_ha_status(
|
|||||||
name=source.name,
|
name=source.name,
|
||||||
connected=connected,
|
connected=connected,
|
||||||
entity_count=status["entity_count"] if status else 0,
|
entity_count=status["entity_count"] if status else 0,
|
||||||
|
host=source.host or "",
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,270 @@
|
|||||||
|
"""HTTP endpoint routes: CRUD + one-shot test."""
|
||||||
|
|
||||||
|
import json
|
||||||
|
|
||||||
|
from fastapi import APIRouter, Depends, HTTPException
|
||||||
|
|
||||||
|
from ledgrab.api.auth import AuthRequired
|
||||||
|
from ledgrab.api.dependencies import (
|
||||||
|
fire_entity_event,
|
||||||
|
get_http_endpoint_store,
|
||||||
|
)
|
||||||
|
from ledgrab.api.schemas.http_endpoints import (
|
||||||
|
HTTPEndpointCreate,
|
||||||
|
HTTPEndpointListResponse,
|
||||||
|
HTTPEndpointResponse,
|
||||||
|
HTTPEndpointUpdate,
|
||||||
|
HTTPTestRequest,
|
||||||
|
HTTPTestResponse,
|
||||||
|
)
|
||||||
|
from ledgrab.storage.base_store import EntityNotFoundError
|
||||||
|
from ledgrab.storage.http_endpoint import HTTPEndpoint
|
||||||
|
from ledgrab.storage.http_endpoint_store import HTTPEndpointStore
|
||||||
|
from ledgrab.utils import get_logger
|
||||||
|
from ledgrab.utils.safe_source import safe_request_bounded, validate_polling_url
|
||||||
|
|
||||||
|
logger = get_logger(__name__)
|
||||||
|
|
||||||
|
router = APIRouter()
|
||||||
|
|
||||||
|
|
||||||
|
def _warn_if_plaintext_token(url: str, auth_token: str, *, action: str) -> None:
|
||||||
|
"""Log a warning when an auth token would be sent over plaintext http://."""
|
||||||
|
if auth_token and url.lower().startswith("http://"):
|
||||||
|
logger.warning(
|
||||||
|
"HTTP endpoint %s: auth_token will be sent over plaintext http:// to %s. "
|
||||||
|
"Anyone on the network path can read it. Consider https:// if the "
|
||||||
|
"target supports TLS.",
|
||||||
|
action,
|
||||||
|
url,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _to_response(endpoint: HTTPEndpoint) -> HTTPEndpointResponse:
|
||||||
|
return HTTPEndpointResponse(
|
||||||
|
id=endpoint.id,
|
||||||
|
name=endpoint.name,
|
||||||
|
url=endpoint.url,
|
||||||
|
method=endpoint.method,
|
||||||
|
auth_token_set=bool(endpoint.auth_token),
|
||||||
|
headers=dict(endpoint.headers),
|
||||||
|
timeout_s=endpoint.timeout_s,
|
||||||
|
description=endpoint.description,
|
||||||
|
tags=endpoint.tags,
|
||||||
|
icon=getattr(endpoint, "icon", "") or "",
|
||||||
|
icon_color=getattr(endpoint, "icon_color", "") or "",
|
||||||
|
created_at=endpoint.created_at,
|
||||||
|
updated_at=endpoint.updated_at,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@router.get(
|
||||||
|
"/api/v1/http/endpoints",
|
||||||
|
response_model=HTTPEndpointListResponse,
|
||||||
|
tags=["HTTP"],
|
||||||
|
)
|
||||||
|
async def list_http_endpoints(
|
||||||
|
_auth: AuthRequired,
|
||||||
|
store: HTTPEndpointStore = Depends(get_http_endpoint_store),
|
||||||
|
):
|
||||||
|
endpoints = store.get_all_endpoints()
|
||||||
|
return HTTPEndpointListResponse(
|
||||||
|
endpoints=[_to_response(e) for e in endpoints],
|
||||||
|
count=len(endpoints),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@router.post(
|
||||||
|
"/api/v1/http/endpoints",
|
||||||
|
response_model=HTTPEndpointResponse,
|
||||||
|
status_code=201,
|
||||||
|
tags=["HTTP"],
|
||||||
|
)
|
||||||
|
async def create_http_endpoint(
|
||||||
|
data: HTTPEndpointCreate,
|
||||||
|
_auth: AuthRequired,
|
||||||
|
store: HTTPEndpointStore = Depends(get_http_endpoint_store),
|
||||||
|
):
|
||||||
|
validate_polling_url(data.url)
|
||||||
|
_warn_if_plaintext_token(data.url, data.auth_token, action="create")
|
||||||
|
try:
|
||||||
|
endpoint = store.create_endpoint(
|
||||||
|
name=data.name,
|
||||||
|
url=data.url,
|
||||||
|
method=data.method,
|
||||||
|
auth_token=data.auth_token,
|
||||||
|
headers=data.headers,
|
||||||
|
timeout_s=data.timeout_s,
|
||||||
|
description=data.description,
|
||||||
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
|
)
|
||||||
|
except ValueError as e:
|
||||||
|
raise HTTPException(status_code=400, detail=str(e))
|
||||||
|
fire_entity_event("http_endpoint", "created", endpoint.id)
|
||||||
|
return _to_response(endpoint)
|
||||||
|
|
||||||
|
|
||||||
|
@router.get(
|
||||||
|
"/api/v1/http/endpoints/{endpoint_id}",
|
||||||
|
response_model=HTTPEndpointResponse,
|
||||||
|
tags=["HTTP"],
|
||||||
|
)
|
||||||
|
async def get_http_endpoint(
|
||||||
|
endpoint_id: str,
|
||||||
|
_auth: AuthRequired,
|
||||||
|
store: HTTPEndpointStore = Depends(get_http_endpoint_store),
|
||||||
|
):
|
||||||
|
try:
|
||||||
|
endpoint = store.get_endpoint(endpoint_id)
|
||||||
|
except EntityNotFoundError:
|
||||||
|
raise HTTPException(status_code=404, detail=f"HTTP endpoint {endpoint_id} not found")
|
||||||
|
return _to_response(endpoint)
|
||||||
|
|
||||||
|
|
||||||
|
@router.put(
|
||||||
|
"/api/v1/http/endpoints/{endpoint_id}",
|
||||||
|
response_model=HTTPEndpointResponse,
|
||||||
|
tags=["HTTP"],
|
||||||
|
)
|
||||||
|
async def update_http_endpoint(
|
||||||
|
endpoint_id: str,
|
||||||
|
data: HTTPEndpointUpdate,
|
||||||
|
_auth: AuthRequired,
|
||||||
|
store: HTTPEndpointStore = Depends(get_http_endpoint_store),
|
||||||
|
):
|
||||||
|
if data.url is not None:
|
||||||
|
validate_polling_url(data.url)
|
||||||
|
final_url = data.url
|
||||||
|
final_token = data.auth_token
|
||||||
|
if final_url is None or final_token is None:
|
||||||
|
try:
|
||||||
|
existing = store.get_endpoint(endpoint_id)
|
||||||
|
except EntityNotFoundError:
|
||||||
|
raise HTTPException(status_code=404, detail=f"HTTP endpoint {endpoint_id} not found")
|
||||||
|
if final_url is None:
|
||||||
|
final_url = existing.url
|
||||||
|
if final_token is None:
|
||||||
|
final_token = existing.auth_token
|
||||||
|
_warn_if_plaintext_token(final_url, final_token, action="update")
|
||||||
|
try:
|
||||||
|
endpoint = store.update_endpoint(
|
||||||
|
endpoint_id,
|
||||||
|
name=data.name,
|
||||||
|
url=data.url,
|
||||||
|
method=data.method,
|
||||||
|
auth_token=data.auth_token,
|
||||||
|
headers=data.headers,
|
||||||
|
timeout_s=data.timeout_s,
|
||||||
|
description=data.description,
|
||||||
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
|
)
|
||||||
|
except EntityNotFoundError:
|
||||||
|
raise HTTPException(status_code=404, detail=f"HTTP endpoint {endpoint_id} not found")
|
||||||
|
except ValueError as e:
|
||||||
|
raise HTTPException(status_code=400, detail=str(e))
|
||||||
|
fire_entity_event("http_endpoint", "updated", endpoint.id)
|
||||||
|
return _to_response(endpoint)
|
||||||
|
|
||||||
|
|
||||||
|
@router.delete(
|
||||||
|
"/api/v1/http/endpoints/{endpoint_id}",
|
||||||
|
status_code=204,
|
||||||
|
tags=["HTTP"],
|
||||||
|
)
|
||||||
|
async def delete_http_endpoint(
|
||||||
|
endpoint_id: str,
|
||||||
|
_auth: AuthRequired,
|
||||||
|
store: HTTPEndpointStore = Depends(get_http_endpoint_store),
|
||||||
|
):
|
||||||
|
try:
|
||||||
|
store.delete_endpoint(endpoint_id)
|
||||||
|
except EntityNotFoundError:
|
||||||
|
raise HTTPException(status_code=404, detail=f"HTTP endpoint {endpoint_id} not found")
|
||||||
|
fire_entity_event("http_endpoint", "deleted", endpoint_id)
|
||||||
|
|
||||||
|
|
||||||
|
async def _run_http_test(
|
||||||
|
method: str,
|
||||||
|
url: str,
|
||||||
|
headers: dict[str, str],
|
||||||
|
timeout_s: float,
|
||||||
|
) -> HTTPTestResponse:
|
||||||
|
"""Shared one-shot fetch + response shaping for both test endpoints."""
|
||||||
|
try:
|
||||||
|
status, body_bytes, error = await safe_request_bounded(
|
||||||
|
method, url, headers=headers, timeout=timeout_s
|
||||||
|
)
|
||||||
|
except HTTPException:
|
||||||
|
raise
|
||||||
|
except Exception as exc:
|
||||||
|
return HTTPTestResponse(success=False, error=f"Unexpected error: {type(exc).__name__}")
|
||||||
|
|
||||||
|
if error and status == 0:
|
||||||
|
return HTTPTestResponse(success=False, error=error)
|
||||||
|
|
||||||
|
try:
|
||||||
|
body_text = body_bytes.decode("utf-8")
|
||||||
|
except UnicodeDecodeError:
|
||||||
|
body_text = body_bytes.decode("utf-8", errors="replace")
|
||||||
|
try:
|
||||||
|
body_json = json.loads(body_text) if body_text else None
|
||||||
|
except (json.JSONDecodeError, ValueError):
|
||||||
|
body_json = None
|
||||||
|
|
||||||
|
preview = body_text[:500] if body_text else None
|
||||||
|
is_success = 200 <= status < 300
|
||||||
|
return HTTPTestResponse(
|
||||||
|
success=is_success,
|
||||||
|
status_code=status,
|
||||||
|
body_preview=preview,
|
||||||
|
body_json=body_json,
|
||||||
|
error=None if is_success else f"HTTP {status}",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@router.post(
|
||||||
|
"/api/v1/http/endpoints/test",
|
||||||
|
response_model=HTTPTestResponse,
|
||||||
|
tags=["HTTP"],
|
||||||
|
)
|
||||||
|
async def test_http_endpoint(
|
||||||
|
data: HTTPTestRequest,
|
||||||
|
_auth: AuthRequired,
|
||||||
|
):
|
||||||
|
"""One-shot fetch to validate URL + auth before saving."""
|
||||||
|
headers = dict(data.headers)
|
||||||
|
if data.auth_token and not any(k.lower() == "authorization" for k in headers):
|
||||||
|
headers["Authorization"] = f"Bearer {data.auth_token}"
|
||||||
|
return await _run_http_test(data.method, data.url, headers, data.timeout_s)
|
||||||
|
|
||||||
|
|
||||||
|
@router.post(
|
||||||
|
"/api/v1/http/endpoints/{endpoint_id}/test",
|
||||||
|
response_model=HTTPTestResponse,
|
||||||
|
tags=["HTTP"],
|
||||||
|
)
|
||||||
|
async def test_saved_http_endpoint(
|
||||||
|
endpoint_id: str,
|
||||||
|
_auth: AuthRequired,
|
||||||
|
store: HTTPEndpointStore = Depends(get_http_endpoint_store),
|
||||||
|
):
|
||||||
|
"""Run the stored endpoint configuration (URL + auth + headers + timeout).
|
||||||
|
|
||||||
|
Useful for the "test" button on the endpoint card: avoids the user
|
||||||
|
having to open the editor and re-enter the auth token (which is
|
||||||
|
never returned to the client).
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
endpoint = store.get_endpoint(endpoint_id)
|
||||||
|
except EntityNotFoundError:
|
||||||
|
raise HTTPException(status_code=404, detail=f"HTTP endpoint {endpoint_id} not found")
|
||||||
|
return await _run_http_test(
|
||||||
|
endpoint.method,
|
||||||
|
endpoint.url,
|
||||||
|
endpoint.build_request_headers(),
|
||||||
|
endpoint.timeout_s,
|
||||||
|
)
|
||||||
@@ -45,6 +45,8 @@ def _to_response(source: MQTTSource, manager: MQTTManager) -> MQTTSourceResponse
|
|||||||
connected=runtime.is_connected if runtime else False,
|
connected=runtime.is_connected if runtime else False,
|
||||||
description=source.description,
|
description=source.description,
|
||||||
tags=source.tags,
|
tags=source.tags,
|
||||||
|
icon=getattr(source, "icon", "") or "",
|
||||||
|
icon_color=getattr(source, "icon_color", "") or "",
|
||||||
created_at=source.created_at,
|
created_at=source.created_at,
|
||||||
updated_at=source.updated_at,
|
updated_at=source.updated_at,
|
||||||
)
|
)
|
||||||
@@ -90,6 +92,8 @@ async def create_mqtt_source(
|
|||||||
base_topic=data.base_topic,
|
base_topic=data.base_topic,
|
||||||
description=data.description,
|
description=data.description,
|
||||||
tags=data.tags,
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
)
|
)
|
||||||
except ValueError as e:
|
except ValueError as e:
|
||||||
raise HTTPException(status_code=400, detail=str(e))
|
raise HTTPException(status_code=400, detail=str(e))
|
||||||
@@ -139,6 +143,8 @@ async def update_mqtt_source(
|
|||||||
base_topic=data.base_topic,
|
base_topic=data.base_topic,
|
||||||
description=data.description,
|
description=data.description,
|
||||||
tags=data.tags,
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
)
|
)
|
||||||
except EntityNotFoundError:
|
except EntityNotFoundError:
|
||||||
raise HTTPException(status_code=404, detail=f"MQTT source {source_id} not found")
|
raise HTTPException(status_code=404, detail=f"MQTT source {source_id} not found")
|
||||||
|
|||||||
@@ -9,17 +9,27 @@ from ledgrab.api.auth import AuthRequired
|
|||||||
from ledgrab.api.dependencies import (
|
from ledgrab.api.dependencies import (
|
||||||
fire_entity_event,
|
fire_entity_event,
|
||||||
get_device_store,
|
get_device_store,
|
||||||
|
get_mqtt_store,
|
||||||
get_output_target_store,
|
get_output_target_store,
|
||||||
get_processor_manager,
|
get_processor_manager,
|
||||||
|
get_value_source_store,
|
||||||
)
|
)
|
||||||
from ledgrab.api.schemas.output_targets import (
|
from ledgrab.api.schemas.output_targets import (
|
||||||
HALightMappingSchema,
|
HALightMappingSchema,
|
||||||
|
HALightOutputTargetCreate,
|
||||||
HALightOutputTargetResponse,
|
HALightOutputTargetResponse,
|
||||||
|
HALightOutputTargetUpdate,
|
||||||
|
LedOutputTargetCreate,
|
||||||
LedOutputTargetResponse,
|
LedOutputTargetResponse,
|
||||||
|
LedOutputTargetUpdate,
|
||||||
OutputTargetCreate,
|
OutputTargetCreate,
|
||||||
OutputTargetListResponse,
|
OutputTargetListResponse,
|
||||||
OutputTargetResponse,
|
OutputTargetResponse,
|
||||||
OutputTargetUpdate,
|
OutputTargetUpdate,
|
||||||
|
Z2MLightMappingSchema,
|
||||||
|
Z2MLightOutputTargetCreate,
|
||||||
|
Z2MLightOutputTargetResponse,
|
||||||
|
Z2MLightOutputTargetUpdate,
|
||||||
)
|
)
|
||||||
from ledgrab.core.processing.processor_manager import ProcessorManager
|
from ledgrab.core.processing.processor_manager import ProcessorManager
|
||||||
from ledgrab.storage import DeviceStore
|
from ledgrab.storage import DeviceStore
|
||||||
@@ -29,10 +39,18 @@ from ledgrab.storage.ha_light_output_target import (
|
|||||||
HALightMapping,
|
HALightMapping,
|
||||||
HALightOutputTarget,
|
HALightOutputTarget,
|
||||||
)
|
)
|
||||||
|
from ledgrab.storage.z2m_light_output_target import (
|
||||||
|
Z2MLightMapping,
|
||||||
|
Z2MLightOutputTarget,
|
||||||
|
)
|
||||||
|
from ledgrab.storage.mqtt_source_store import MQTTSourceStore
|
||||||
from ledgrab.storage.output_target_store import OutputTargetStore
|
from ledgrab.storage.output_target_store import OutputTargetStore
|
||||||
|
from ledgrab.storage.value_source_store import ValueSourceStore
|
||||||
from ledgrab.utils import get_logger
|
from ledgrab.utils import get_logger
|
||||||
from ledgrab.storage.base_store import EntityNotFoundError
|
from ledgrab.storage.base_store import EntityNotFoundError
|
||||||
|
|
||||||
|
from ._mqtt_validation import validate_mqtt_source_exists
|
||||||
|
|
||||||
logger = get_logger(__name__)
|
logger = get_logger(__name__)
|
||||||
|
|
||||||
router = APIRouter()
|
router = APIRouter()
|
||||||
@@ -52,8 +70,12 @@ def _led_target_to_response(target: WledOutputTarget) -> LedOutputTargetResponse
|
|||||||
min_brightness_threshold=target.min_brightness_threshold.to_dict(),
|
min_brightness_threshold=target.min_brightness_threshold.to_dict(),
|
||||||
adaptive_fps=target.adaptive_fps,
|
adaptive_fps=target.adaptive_fps,
|
||||||
protocol=target.protocol,
|
protocol=target.protocol,
|
||||||
|
max_milliamps=target.max_milliamps,
|
||||||
|
milliamps_per_led=target.milliamps_per_led,
|
||||||
description=target.description,
|
description=target.description,
|
||||||
tags=target.tags,
|
tags=target.tags,
|
||||||
|
icon=getattr(target, "icon", "") or "",
|
||||||
|
icon_color=getattr(target, "icon_color", "") or "",
|
||||||
created_at=target.created_at,
|
created_at=target.created_at,
|
||||||
updated_at=target.updated_at,
|
updated_at=target.updated_at,
|
||||||
)
|
)
|
||||||
@@ -66,8 +88,11 @@ def _ha_light_target_to_response(
|
|||||||
return HALightOutputTargetResponse(
|
return HALightOutputTargetResponse(
|
||||||
id=target.id,
|
id=target.id,
|
||||||
name=target.name,
|
name=target.name,
|
||||||
ha_source_id=target.ha_source_id,
|
ha_source_id=target.ha_source_id or "",
|
||||||
color_strip_source_id=target.color_strip_source_id,
|
source_kind=target.source_kind if target.source_kind in ("css", "color_vs") else "css",
|
||||||
|
# Defensive coalesce — older records stored via resolve_ref may hold None.
|
||||||
|
color_strip_source_id=target.color_strip_source_id or "",
|
||||||
|
color_value_source_id=target.color_value_source_id or "",
|
||||||
brightness=target.brightness.to_dict(),
|
brightness=target.brightness.to_dict(),
|
||||||
ha_light_mappings=[
|
ha_light_mappings=[
|
||||||
HALightMappingSchema(
|
HALightMappingSchema(
|
||||||
@@ -82,34 +107,173 @@ def _ha_light_target_to_response(
|
|||||||
transition=target.transition.to_dict(),
|
transition=target.transition.to_dict(),
|
||||||
color_tolerance=target.color_tolerance.to_dict(),
|
color_tolerance=target.color_tolerance.to_dict(),
|
||||||
min_brightness_threshold=target.min_brightness_threshold.to_dict(),
|
min_brightness_threshold=target.min_brightness_threshold.to_dict(),
|
||||||
|
stop_action=target.stop_action,
|
||||||
description=target.description,
|
description=target.description,
|
||||||
tags=target.tags,
|
tags=target.tags,
|
||||||
|
icon=getattr(target, "icon", "") or "",
|
||||||
|
icon_color=getattr(target, "icon_color", "") or "",
|
||||||
created_at=target.created_at,
|
created_at=target.created_at,
|
||||||
updated_at=target.updated_at,
|
updated_at=target.updated_at,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def _target_to_response(target) -> OutputTargetResponse:
|
def _z2m_light_target_to_response(
|
||||||
"""Convert any OutputTarget to the appropriate typed response."""
|
target: Z2MLightOutputTarget,
|
||||||
if isinstance(target, WledOutputTarget):
|
) -> Z2MLightOutputTargetResponse:
|
||||||
return _led_target_to_response(target)
|
"""Convert a Z2MLightOutputTarget to Z2MLightOutputTargetResponse."""
|
||||||
elif isinstance(target, HALightOutputTarget):
|
return Z2MLightOutputTargetResponse(
|
||||||
return _ha_light_target_to_response(target)
|
id=target.id,
|
||||||
else:
|
name=target.name,
|
||||||
# Fallback for unknown types — use LED response with defaults
|
mqtt_source_id=target.mqtt_source_id or "",
|
||||||
return LedOutputTargetResponse(
|
source_kind=target.source_kind if target.source_kind in ("css", "color_vs") else "css",
|
||||||
id=target.id,
|
color_strip_source_id=target.color_strip_source_id or "",
|
||||||
name=target.name,
|
color_value_source_id=target.color_value_source_id or "",
|
||||||
description=target.description,
|
brightness=target.brightness.to_dict(),
|
||||||
tags=target.tags,
|
z2m_light_mappings=[
|
||||||
created_at=target.created_at,
|
Z2MLightMappingSchema(
|
||||||
updated_at=target.updated_at,
|
friendly_name=m.friendly_name,
|
||||||
|
led_start=m.led_start,
|
||||||
|
led_end=m.led_end,
|
||||||
|
brightness_scale=m.brightness_scale.to_dict(),
|
||||||
|
)
|
||||||
|
for m in target.light_mappings
|
||||||
|
],
|
||||||
|
base_topic=target.base_topic,
|
||||||
|
update_rate=target.update_rate.to_dict(),
|
||||||
|
transition=target.transition.to_dict(),
|
||||||
|
color_tolerance=target.color_tolerance.to_dict(),
|
||||||
|
min_brightness_threshold=target.min_brightness_threshold.to_dict(),
|
||||||
|
stop_action=target.stop_action if target.stop_action in ("none", "turn_off") else "none",
|
||||||
|
description=target.description,
|
||||||
|
tags=target.tags,
|
||||||
|
icon=getattr(target, "icon", "") or "",
|
||||||
|
icon_color=getattr(target, "icon_color", "") or "",
|
||||||
|
created_at=target.created_at,
|
||||||
|
updated_at=target.updated_at,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _validate_color_value_source(
|
||||||
|
value_source_store: ValueSourceStore, color_value_source_id: str
|
||||||
|
) -> None:
|
||||||
|
"""Ensure the referenced ValueSource exists and returns colour."""
|
||||||
|
if not color_value_source_id:
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=400,
|
||||||
|
detail="color_value_source_id is required when source_kind='color_vs'",
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
source = value_source_store.get_source(color_value_source_id)
|
||||||
|
except (ValueError, EntityNotFoundError):
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=422,
|
||||||
|
detail=f"Color value source {color_value_source_id} not found",
|
||||||
|
)
|
||||||
|
if source.to_dict().get("return_type") != "color":
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=400,
|
||||||
|
detail=(
|
||||||
|
f"Value source {color_value_source_id} does not return colour "
|
||||||
|
"(return_type must be 'color')"
|
||||||
|
),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
_TARGET_RESPONSE_BUILDERS: dict = {
|
||||||
|
WledOutputTarget: _led_target_to_response,
|
||||||
|
HALightOutputTarget: _ha_light_target_to_response,
|
||||||
|
Z2MLightOutputTarget: _z2m_light_target_to_response,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _assert_target_response_coverage() -> None:
|
||||||
|
"""Verify the response registry covers every concrete OutputTarget subclass.
|
||||||
|
|
||||||
|
Runs at module import. Surfaces a missing builder eagerly instead of
|
||||||
|
letting a request fall through to the previous silent fallback (which
|
||||||
|
used to return a defaults-filled LedOutputTargetResponse and quietly
|
||||||
|
misshape the payload for unknown target types).
|
||||||
|
"""
|
||||||
|
expected = {WledOutputTarget, HALightOutputTarget, Z2MLightOutputTarget}
|
||||||
|
registered = set(_TARGET_RESPONSE_BUILDERS.keys())
|
||||||
|
missing = expected - registered
|
||||||
|
extra = registered - expected
|
||||||
|
if missing or extra:
|
||||||
|
problems = []
|
||||||
|
if missing:
|
||||||
|
problems.append(f"missing builders: {sorted(c.__name__ for c in missing)}")
|
||||||
|
if extra:
|
||||||
|
problems.append(f"unregistered classes: {sorted(c.__name__ for c in extra)}")
|
||||||
|
raise RuntimeError(
|
||||||
|
"_TARGET_RESPONSE_BUILDERS is out of sync with the OutputTarget "
|
||||||
|
"subclass set: " + "; ".join(problems)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
_assert_target_response_coverage()
|
||||||
|
|
||||||
|
|
||||||
|
def _target_to_response(target) -> OutputTargetResponse:
|
||||||
|
"""Convert any OutputTarget to the appropriate typed response.
|
||||||
|
|
||||||
|
Dispatches via :data:`_TARGET_RESPONSE_BUILDERS` keyed by concrete
|
||||||
|
subclass. Raises ``RuntimeError`` for an unregistered subclass —
|
||||||
|
coverage is asserted at import, so this should never fire in
|
||||||
|
practice; if it does, the storage layer added a new OutputTarget
|
||||||
|
subclass without a matching response builder here.
|
||||||
|
"""
|
||||||
|
builder = _TARGET_RESPONSE_BUILDERS.get(type(target))
|
||||||
|
if builder is None:
|
||||||
|
raise RuntimeError(
|
||||||
|
f"No response builder registered for OutputTarget subclass " f"{type(target).__name__}"
|
||||||
|
)
|
||||||
|
return builder(target)
|
||||||
|
|
||||||
|
|
||||||
# ===== CRUD ENDPOINTS =====
|
# ===== CRUD ENDPOINTS =====
|
||||||
|
|
||||||
|
|
||||||
|
def _build_ha_mappings(
|
||||||
|
payload: list[HALightMappingSchema] | None,
|
||||||
|
) -> list[HALightMapping] | None:
|
||||||
|
if not payload:
|
||||||
|
return None
|
||||||
|
return [
|
||||||
|
HALightMapping(
|
||||||
|
entity_id=m.entity_id,
|
||||||
|
led_start=m.led_start,
|
||||||
|
led_end=m.led_end,
|
||||||
|
brightness_scale=BindableFloat.from_raw(m.brightness_scale, default=1.0),
|
||||||
|
)
|
||||||
|
for m in payload
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def _build_z2m_mappings(
|
||||||
|
payload: list[Z2MLightMappingSchema] | None,
|
||||||
|
) -> list[Z2MLightMapping] | None:
|
||||||
|
if not payload:
|
||||||
|
return None
|
||||||
|
return [
|
||||||
|
Z2MLightMapping(
|
||||||
|
friendly_name=m.friendly_name,
|
||||||
|
led_start=m.led_start,
|
||||||
|
led_end=m.led_end,
|
||||||
|
brightness_scale=BindableFloat.from_raw(m.brightness_scale, default=1.0),
|
||||||
|
)
|
||||||
|
for m in payload
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def _validate_device_exists(device_store: DeviceStore, device_id: str) -> None:
|
||||||
|
if not device_id:
|
||||||
|
return
|
||||||
|
try:
|
||||||
|
device_store.get_device(device_id)
|
||||||
|
except ValueError:
|
||||||
|
raise HTTPException(status_code=422, detail=f"Device {device_id} not found")
|
||||||
|
|
||||||
|
|
||||||
@router.post(
|
@router.post(
|
||||||
"/api/v1/output-targets", response_model=OutputTargetResponse, tags=["Targets"], status_code=201
|
"/api/v1/output-targets", response_model=OutputTargetResponse, tags=["Targets"], status_code=201
|
||||||
)
|
)
|
||||||
@@ -119,53 +283,72 @@ async def create_target(
|
|||||||
target_store: OutputTargetStore = Depends(get_output_target_store),
|
target_store: OutputTargetStore = Depends(get_output_target_store),
|
||||||
device_store: DeviceStore = Depends(get_device_store),
|
device_store: DeviceStore = Depends(get_device_store),
|
||||||
manager: ProcessorManager = Depends(get_processor_manager),
|
manager: ProcessorManager = Depends(get_processor_manager),
|
||||||
|
value_source_store: ValueSourceStore = Depends(get_value_source_store),
|
||||||
|
mqtt_store: MQTTSourceStore = Depends(get_mqtt_store),
|
||||||
):
|
):
|
||||||
"""Create a new output target."""
|
"""Create a new output target."""
|
||||||
try:
|
try:
|
||||||
# Validate device exists if provided
|
match data:
|
||||||
device_id = getattr(data, "device_id", "")
|
case LedOutputTargetCreate():
|
||||||
if device_id:
|
_validate_device_exists(device_store, data.device_id)
|
||||||
try:
|
target = target_store.create_wled_target(
|
||||||
device_store.get_device(device_id)
|
name=data.name,
|
||||||
except ValueError:
|
description=data.description,
|
||||||
raise HTTPException(status_code=422, detail=f"Device {device_id} not found")
|
tags=data.tags,
|
||||||
|
device_id=data.device_id,
|
||||||
ha_light_mappings_raw = getattr(data, "ha_light_mappings", None)
|
color_strip_source_id=data.color_strip_source_id,
|
||||||
ha_mappings = (
|
brightness=data.brightness,
|
||||||
[
|
fps=data.fps,
|
||||||
HALightMapping(
|
keepalive_interval=data.keepalive_interval,
|
||||||
entity_id=m.entity_id,
|
state_check_interval=data.state_check_interval,
|
||||||
led_start=m.led_start,
|
min_brightness_threshold=data.min_brightness_threshold,
|
||||||
led_end=m.led_end,
|
adaptive_fps=data.adaptive_fps,
|
||||||
brightness_scale=BindableFloat.from_raw(m.brightness_scale, default=1.0),
|
protocol=data.protocol,
|
||||||
|
max_milliamps=data.max_milliamps,
|
||||||
|
milliamps_per_led=data.milliamps_per_led,
|
||||||
)
|
)
|
||||||
for m in ha_light_mappings_raw
|
case HALightOutputTargetCreate():
|
||||||
]
|
if data.source_kind == "color_vs":
|
||||||
if ha_light_mappings_raw
|
_validate_color_value_source(value_source_store, data.color_value_source_id)
|
||||||
else None
|
target = target_store.create_ha_light_target(
|
||||||
)
|
name=data.name,
|
||||||
|
description=data.description,
|
||||||
# Create in store
|
tags=data.tags,
|
||||||
target = target_store.create_target(
|
ha_source_id=data.ha_source_id,
|
||||||
name=data.name,
|
source_kind=data.source_kind,
|
||||||
target_type=data.target_type,
|
color_strip_source_id=data.color_strip_source_id,
|
||||||
device_id=device_id,
|
color_value_source_id=data.color_value_source_id,
|
||||||
color_strip_source_id=getattr(data, "color_strip_source_id", ""),
|
brightness=data.brightness,
|
||||||
brightness=getattr(data, "brightness", 1.0),
|
ha_light_mappings=_build_ha_mappings(data.ha_light_mappings),
|
||||||
fps=getattr(data, "fps", 30),
|
update_rate=data.update_rate,
|
||||||
keepalive_interval=getattr(data, "keepalive_interval", 1.0),
|
transition=data.transition,
|
||||||
state_check_interval=getattr(data, "state_check_interval", 30),
|
min_brightness_threshold=data.min_brightness_threshold,
|
||||||
min_brightness_threshold=getattr(data, "min_brightness_threshold", 0),
|
color_tolerance=data.color_tolerance,
|
||||||
adaptive_fps=getattr(data, "adaptive_fps", False),
|
stop_action=data.stop_action,
|
||||||
protocol=getattr(data, "protocol", "ddp"),
|
)
|
||||||
description=data.description,
|
case Z2MLightOutputTargetCreate():
|
||||||
tags=data.tags,
|
if data.source_kind == "color_vs":
|
||||||
ha_source_id=getattr(data, "ha_source_id", ""),
|
_validate_color_value_source(value_source_store, data.color_value_source_id)
|
||||||
ha_light_mappings=ha_mappings,
|
validate_mqtt_source_exists(mqtt_store, data.mqtt_source_id)
|
||||||
update_rate=getattr(data, "update_rate", 2.0),
|
target = target_store.create_z2m_light_target(
|
||||||
transition=getattr(data, "transition", 0.5),
|
name=data.name,
|
||||||
color_tolerance=getattr(data, "color_tolerance", 5),
|
description=data.description,
|
||||||
)
|
tags=data.tags,
|
||||||
|
mqtt_source_id=data.mqtt_source_id,
|
||||||
|
source_kind=data.source_kind,
|
||||||
|
color_strip_source_id=data.color_strip_source_id,
|
||||||
|
color_value_source_id=data.color_value_source_id,
|
||||||
|
brightness=data.brightness,
|
||||||
|
z2m_light_mappings=_build_z2m_mappings(data.z2m_light_mappings),
|
||||||
|
base_topic=data.base_topic,
|
||||||
|
update_rate=data.update_rate,
|
||||||
|
transition=data.transition,
|
||||||
|
min_brightness_threshold=data.min_brightness_threshold,
|
||||||
|
color_tolerance=data.color_tolerance,
|
||||||
|
stop_action=data.stop_action,
|
||||||
|
)
|
||||||
|
case _: # pragma: no cover — Pydantic discriminator already ensures one of the three
|
||||||
|
raise HTTPException(status_code=400, detail="Unknown target_type")
|
||||||
|
|
||||||
# Register in processor manager
|
# Register in processor manager
|
||||||
try:
|
try:
|
||||||
@@ -233,6 +416,18 @@ async def get_target(
|
|||||||
raise HTTPException(status_code=404, detail=str(e))
|
raise HTTPException(status_code=404, detail=str(e))
|
||||||
|
|
||||||
|
|
||||||
|
def _resolve_effective_color_vs_id(
|
||||||
|
target_store: OutputTargetStore, target_id: str, payload_id: str | None
|
||||||
|
) -> str:
|
||||||
|
if payload_id is not None:
|
||||||
|
return payload_id
|
||||||
|
try:
|
||||||
|
existing = target_store.get_target(target_id)
|
||||||
|
except ValueError:
|
||||||
|
return ""
|
||||||
|
return getattr(existing, "color_value_source_id", "") or ""
|
||||||
|
|
||||||
|
|
||||||
@router.put(
|
@router.put(
|
||||||
"/api/v1/output-targets/{target_id}", response_model=OutputTargetResponse, tags=["Targets"]
|
"/api/v1/output-targets/{target_id}", response_model=OutputTargetResponse, tags=["Targets"]
|
||||||
)
|
)
|
||||||
@@ -243,90 +438,165 @@ async def update_target(
|
|||||||
target_store: OutputTargetStore = Depends(get_output_target_store),
|
target_store: OutputTargetStore = Depends(get_output_target_store),
|
||||||
device_store: DeviceStore = Depends(get_device_store),
|
device_store: DeviceStore = Depends(get_device_store),
|
||||||
manager: ProcessorManager = Depends(get_processor_manager),
|
manager: ProcessorManager = Depends(get_processor_manager),
|
||||||
|
value_source_store: ValueSourceStore = Depends(get_value_source_store),
|
||||||
|
mqtt_store: MQTTSourceStore = Depends(get_mqtt_store),
|
||||||
):
|
):
|
||||||
"""Update a output target."""
|
"""Update a output target."""
|
||||||
try:
|
try:
|
||||||
# Validate device exists if changing
|
css_changed = False
|
||||||
device_id = getattr(data, "device_id", None)
|
brightness_changed = False
|
||||||
if device_id is not None and device_id:
|
settings_changed = False
|
||||||
try:
|
device_changed = False
|
||||||
device_store.get_device(device_id)
|
|
||||||
except ValueError:
|
|
||||||
raise HTTPException(status_code=422, detail=f"Device {device_id} not found")
|
|
||||||
|
|
||||||
# Build HA light mappings if provided
|
match data:
|
||||||
ha_light_mappings_raw = getattr(data, "ha_light_mappings", None)
|
case LedOutputTargetUpdate():
|
||||||
ha_mappings = None
|
if data.device_id:
|
||||||
if ha_light_mappings_raw is not None:
|
_validate_device_exists(device_store, data.device_id)
|
||||||
ha_mappings = [
|
target = target_store.update_wled_target(
|
||||||
HALightMapping(
|
target_id,
|
||||||
entity_id=m.entity_id,
|
name=data.name,
|
||||||
led_start=m.led_start,
|
description=data.description,
|
||||||
led_end=m.led_end,
|
tags=data.tags,
|
||||||
brightness_scale=BindableFloat.from_raw(m.brightness_scale, default=1.0),
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
|
device_id=data.device_id,
|
||||||
|
color_strip_source_id=data.color_strip_source_id,
|
||||||
|
brightness=data.brightness,
|
||||||
|
fps=data.fps,
|
||||||
|
keepalive_interval=data.keepalive_interval,
|
||||||
|
state_check_interval=data.state_check_interval,
|
||||||
|
min_brightness_threshold=data.min_brightness_threshold,
|
||||||
|
adaptive_fps=data.adaptive_fps,
|
||||||
|
protocol=data.protocol,
|
||||||
|
max_milliamps=data.max_milliamps,
|
||||||
|
milliamps_per_led=data.milliamps_per_led,
|
||||||
)
|
)
|
||||||
for m in ha_light_mappings_raw
|
css_changed = data.color_strip_source_id is not None
|
||||||
]
|
brightness_changed = data.brightness is not None
|
||||||
|
settings_changed = any(
|
||||||
# Update in store
|
v is not None
|
||||||
target = target_store.update_target(
|
for v in (
|
||||||
target_id=target_id,
|
data.fps,
|
||||||
name=data.name,
|
data.keepalive_interval,
|
||||||
device_id=device_id,
|
data.state_check_interval,
|
||||||
color_strip_source_id=getattr(data, "color_strip_source_id", None),
|
data.min_brightness_threshold,
|
||||||
brightness=getattr(data, "brightness", None),
|
data.adaptive_fps,
|
||||||
fps=getattr(data, "fps", None),
|
data.brightness,
|
||||||
keepalive_interval=getattr(data, "keepalive_interval", None),
|
data.max_milliamps,
|
||||||
state_check_interval=getattr(data, "state_check_interval", None),
|
data.milliamps_per_led,
|
||||||
min_brightness_threshold=getattr(data, "min_brightness_threshold", None),
|
)
|
||||||
adaptive_fps=getattr(data, "adaptive_fps", None),
|
)
|
||||||
protocol=getattr(data, "protocol", None),
|
device_changed = data.device_id is not None
|
||||||
description=data.description,
|
case HALightOutputTargetUpdate():
|
||||||
tags=data.tags,
|
# Validate color VS when switching into / staying in color_vs mode
|
||||||
ha_source_id=getattr(data, "ha_source_id", None),
|
if data.source_kind == "color_vs" or (
|
||||||
ha_light_mappings=ha_mappings,
|
data.source_kind is None and data.color_value_source_id
|
||||||
update_rate=getattr(data, "update_rate", None),
|
):
|
||||||
transition=getattr(data, "transition", None),
|
effective_id = _resolve_effective_color_vs_id(
|
||||||
color_tolerance=getattr(data, "color_tolerance", None),
|
target_store, target_id, data.color_value_source_id
|
||||||
)
|
)
|
||||||
|
_validate_color_value_source(value_source_store, effective_id)
|
||||||
|
target = target_store.update_ha_light_target(
|
||||||
|
target_id,
|
||||||
|
name=data.name,
|
||||||
|
description=data.description,
|
||||||
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
|
ha_source_id=data.ha_source_id,
|
||||||
|
source_kind=data.source_kind,
|
||||||
|
color_strip_source_id=data.color_strip_source_id,
|
||||||
|
color_value_source_id=data.color_value_source_id,
|
||||||
|
brightness=data.brightness,
|
||||||
|
ha_light_mappings=_build_ha_mappings(data.ha_light_mappings),
|
||||||
|
update_rate=data.update_rate,
|
||||||
|
transition=data.transition,
|
||||||
|
min_brightness_threshold=data.min_brightness_threshold,
|
||||||
|
color_tolerance=data.color_tolerance,
|
||||||
|
stop_action=data.stop_action,
|
||||||
|
)
|
||||||
|
css_changed = data.color_strip_source_id is not None
|
||||||
|
brightness_changed = data.brightness is not None
|
||||||
|
settings_changed = any(
|
||||||
|
v is not None
|
||||||
|
for v in (
|
||||||
|
data.source_kind,
|
||||||
|
data.color_value_source_id,
|
||||||
|
data.brightness,
|
||||||
|
data.update_rate,
|
||||||
|
data.transition,
|
||||||
|
data.min_brightness_threshold,
|
||||||
|
data.color_tolerance,
|
||||||
|
data.ha_light_mappings,
|
||||||
|
data.stop_action,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
case Z2MLightOutputTargetUpdate():
|
||||||
|
if data.source_kind == "color_vs" or (
|
||||||
|
data.source_kind is None and data.color_value_source_id
|
||||||
|
):
|
||||||
|
effective_id = _resolve_effective_color_vs_id(
|
||||||
|
target_store, target_id, data.color_value_source_id
|
||||||
|
)
|
||||||
|
_validate_color_value_source(value_source_store, effective_id)
|
||||||
|
if data.mqtt_source_id:
|
||||||
|
validate_mqtt_source_exists(mqtt_store, data.mqtt_source_id)
|
||||||
|
target = target_store.update_z2m_light_target(
|
||||||
|
target_id,
|
||||||
|
name=data.name,
|
||||||
|
description=data.description,
|
||||||
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
|
mqtt_source_id=data.mqtt_source_id,
|
||||||
|
source_kind=data.source_kind,
|
||||||
|
color_strip_source_id=data.color_strip_source_id,
|
||||||
|
color_value_source_id=data.color_value_source_id,
|
||||||
|
brightness=data.brightness,
|
||||||
|
z2m_light_mappings=_build_z2m_mappings(data.z2m_light_mappings),
|
||||||
|
base_topic=data.base_topic,
|
||||||
|
update_rate=data.update_rate,
|
||||||
|
transition=data.transition,
|
||||||
|
min_brightness_threshold=data.min_brightness_threshold,
|
||||||
|
color_tolerance=data.color_tolerance,
|
||||||
|
stop_action=data.stop_action,
|
||||||
|
)
|
||||||
|
css_changed = data.color_strip_source_id is not None
|
||||||
|
brightness_changed = data.brightness is not None
|
||||||
|
settings_changed = any(
|
||||||
|
v is not None
|
||||||
|
for v in (
|
||||||
|
data.source_kind,
|
||||||
|
data.color_value_source_id,
|
||||||
|
data.mqtt_source_id,
|
||||||
|
data.brightness,
|
||||||
|
data.base_topic,
|
||||||
|
data.update_rate,
|
||||||
|
data.transition,
|
||||||
|
data.min_brightness_threshold,
|
||||||
|
data.color_tolerance,
|
||||||
|
data.z2m_light_mappings,
|
||||||
|
data.stop_action,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
case _: # pragma: no cover — Pydantic discriminator already ensures one of the three
|
||||||
|
raise HTTPException(status_code=400, detail="Unknown target_type")
|
||||||
|
|
||||||
# Sync processor manager (run in thread — css release/acquire can block)
|
# Sync processor manager (run in thread — css release/acquire can block)
|
||||||
color_strip_source_id = getattr(data, "color_strip_source_id", None)
|
|
||||||
fps = getattr(data, "fps", None)
|
|
||||||
keepalive_interval = getattr(data, "keepalive_interval", None)
|
|
||||||
state_check_interval = getattr(data, "state_check_interval", None)
|
|
||||||
min_brightness_threshold = getattr(data, "min_brightness_threshold", None)
|
|
||||||
adaptive_fps = getattr(data, "adaptive_fps", None)
|
|
||||||
update_rate = getattr(data, "update_rate", None)
|
|
||||||
transition = getattr(data, "transition", None)
|
|
||||||
color_tolerance = getattr(data, "color_tolerance", None)
|
|
||||||
brightness = getattr(data, "brightness", None)
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
await asyncio.to_thread(
|
await asyncio.to_thread(
|
||||||
target.sync_with_manager,
|
target.sync_with_manager,
|
||||||
manager,
|
manager,
|
||||||
settings_changed=(
|
settings_changed=settings_changed,
|
||||||
fps is not None
|
css_changed=css_changed,
|
||||||
or keepalive_interval is not None
|
brightness_changed=brightness_changed,
|
||||||
or state_check_interval is not None
|
|
||||||
or min_brightness_threshold is not None
|
|
||||||
or adaptive_fps is not None
|
|
||||||
or update_rate is not None
|
|
||||||
or transition is not None
|
|
||||||
or color_tolerance is not None
|
|
||||||
or ha_light_mappings_raw is not None
|
|
||||||
or brightness is not None
|
|
||||||
),
|
|
||||||
css_changed=color_strip_source_id is not None,
|
|
||||||
brightness_changed=brightness is not None,
|
|
||||||
)
|
)
|
||||||
except ValueError as e:
|
except ValueError as e:
|
||||||
logger.debug("Processor config update skipped for target %s: %s", target_id, e)
|
logger.debug("Processor config update skipped for target %s: %s", target_id, e)
|
||||||
pass
|
pass
|
||||||
|
|
||||||
# Device change requires async stop -> swap -> start cycle
|
# LED-only: device change requires async stop -> swap -> start cycle
|
||||||
if device_id is not None:
|
if device_changed and isinstance(target, WledOutputTarget):
|
||||||
try:
|
try:
|
||||||
await manager.update_target_device(target_id, target.device_id)
|
await manager.update_target_device(target_id, target.device_id)
|
||||||
except ValueError as e:
|
except ValueError as e:
|
||||||
|
|||||||
@@ -335,6 +335,35 @@ async def get_overlay_status(
|
|||||||
raise HTTPException(status_code=404, detail=str(e))
|
raise HTTPException(status_code=404, detail=str(e))
|
||||||
|
|
||||||
|
|
||||||
|
# ===== HA LIGHT — MANUAL TURN OFF =====
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/api/v1/output-targets/{target_id}/ha-light/turn-off", tags=["Processing"])
|
||||||
|
async def turn_off_ha_light_target(
|
||||||
|
target_id: str,
|
||||||
|
_auth: AuthRequired,
|
||||||
|
target_store: OutputTargetStore = Depends(get_output_target_store),
|
||||||
|
manager: ProcessorManager = Depends(get_processor_manager),
|
||||||
|
):
|
||||||
|
"""Turn off all HA light entities mapped by the target.
|
||||||
|
|
||||||
|
Works regardless of whether the target's processor is running. Useful
|
||||||
|
when ``stop_action`` is ``"none"`` and lights were left on after a stop.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
# Verify target exists
|
||||||
|
target_store.get_target(target_id)
|
||||||
|
count = await manager.turn_off_ha_light_target(target_id)
|
||||||
|
return {"status": "ok", "target_id": target_id, "entities": count}
|
||||||
|
except ValueError as e:
|
||||||
|
raise HTTPException(status_code=404, detail=str(e))
|
||||||
|
except RuntimeError as e:
|
||||||
|
raise HTTPException(status_code=409, detail=str(e))
|
||||||
|
except Exception as e:
|
||||||
|
logger.error("Failed to turn off HA lights: %s", e, exc_info=True)
|
||||||
|
raise HTTPException(status_code=500, detail="Internal server error")
|
||||||
|
|
||||||
|
|
||||||
# ===== HA LIGHT COLOR PREVIEW WEBSOCKET =====
|
# ===== HA LIGHT COLOR PREVIEW WEBSOCKET =====
|
||||||
|
|
||||||
|
|
||||||
@@ -377,6 +406,75 @@ async def ha_light_colors_ws(
|
|||||||
manager.remove_ha_light_ws_client(target_id, websocket)
|
manager.remove_ha_light_ws_client(target_id, websocket)
|
||||||
|
|
||||||
|
|
||||||
|
# ===== Z2M LIGHT — MANUAL TURN OFF =====
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/api/v1/output-targets/{target_id}/z2m-light/turn-off", tags=["Processing"])
|
||||||
|
async def turn_off_z2m_light_target(
|
||||||
|
target_id: str,
|
||||||
|
_auth: AuthRequired,
|
||||||
|
target_store: OutputTargetStore = Depends(get_output_target_store),
|
||||||
|
manager: ProcessorManager = Depends(get_processor_manager),
|
||||||
|
):
|
||||||
|
"""Publish OFF to all Z2M bulbs mapped by the target.
|
||||||
|
|
||||||
|
Works regardless of whether the target's processor is running. Useful
|
||||||
|
when ``stop_action`` is ``"none"`` and bulbs were left on after a stop.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
target_store.get_target(target_id)
|
||||||
|
count = await manager.turn_off_z2m_light_target(target_id)
|
||||||
|
return {"status": "ok", "target_id": target_id, "entities": count}
|
||||||
|
except ValueError as e:
|
||||||
|
raise HTTPException(status_code=404, detail=str(e))
|
||||||
|
except RuntimeError as e:
|
||||||
|
raise HTTPException(status_code=409, detail=str(e))
|
||||||
|
except Exception as e:
|
||||||
|
logger.error("Failed to turn off Z2M lights: %s", e, exc_info=True)
|
||||||
|
raise HTTPException(status_code=500, detail="Internal server error")
|
||||||
|
|
||||||
|
|
||||||
|
# ===== Z2M LIGHT COLOR PREVIEW WEBSOCKET =====
|
||||||
|
|
||||||
|
|
||||||
|
@router.websocket("/api/v1/output-targets/{target_id}/z2m-light/ws")
|
||||||
|
async def z2m_light_colors_ws(
|
||||||
|
websocket: WebSocket,
|
||||||
|
target_id: str,
|
||||||
|
):
|
||||||
|
"""WebSocket for live Z2M bulb colour preview.
|
||||||
|
|
||||||
|
Streams: {"type":"colors_update","colors":{friendly_name:{r,g,b,hex},...}}
|
||||||
|
at the target's update_rate. Auth via first-message handshake.
|
||||||
|
"""
|
||||||
|
from ledgrab.api.auth import accept_and_authenticate_ws
|
||||||
|
|
||||||
|
if await accept_and_authenticate_ws(websocket) is None:
|
||||||
|
return
|
||||||
|
|
||||||
|
manager: ProcessorManager = get_processor_manager()
|
||||||
|
|
||||||
|
try:
|
||||||
|
proc = manager._processors.get(target_id)
|
||||||
|
if not proc or not proc.is_running:
|
||||||
|
await websocket.close(code=4003, reason="Target not running")
|
||||||
|
return
|
||||||
|
except Exception as e:
|
||||||
|
await websocket.close(code=4004, reason=str(e))
|
||||||
|
return
|
||||||
|
|
||||||
|
try:
|
||||||
|
manager.add_z2m_light_ws_client(target_id, websocket)
|
||||||
|
while True:
|
||||||
|
await websocket.receive_text()
|
||||||
|
except WebSocketDisconnect:
|
||||||
|
pass
|
||||||
|
except (RuntimeError, ConnectionError) as e:
|
||||||
|
logger.debug("ws closed in z2m-light client: %s", e)
|
||||||
|
finally:
|
||||||
|
manager.remove_z2m_light_ws_client(target_id, websocket)
|
||||||
|
|
||||||
|
|
||||||
# ===== LED PREVIEW WEBSOCKET =====
|
# ===== LED PREVIEW WEBSOCKET =====
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -39,6 +39,8 @@ def _pat_template_to_response(t) -> PatternTemplateResponse:
|
|||||||
updated_at=t.updated_at,
|
updated_at=t.updated_at,
|
||||||
description=t.description,
|
description=t.description,
|
||||||
tags=t.tags,
|
tags=t.tags,
|
||||||
|
icon=getattr(t, "icon", "") or "",
|
||||||
|
icon_color=getattr(t, "icon_color", "") or "",
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -83,6 +85,8 @@ async def create_pattern_template(
|
|||||||
rectangles=rectangles,
|
rectangles=rectangles,
|
||||||
description=data.description,
|
description=data.description,
|
||||||
tags=data.tags,
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
)
|
)
|
||||||
fire_entity_event("pattern_template", "created", template.id)
|
fire_entity_event("pattern_template", "created", template.id)
|
||||||
return _pat_template_to_response(template)
|
return _pat_template_to_response(template)
|
||||||
@@ -139,6 +143,8 @@ async def update_pattern_template(
|
|||||||
rectangles=rectangles,
|
rectangles=rectangles,
|
||||||
description=data.description,
|
description=data.description,
|
||||||
tags=data.tags,
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
)
|
)
|
||||||
fire_entity_event("pattern_template", "updated", template_id)
|
fire_entity_event("pattern_template", "updated", template_id)
|
||||||
return _pat_template_to_response(template)
|
return _pat_template_to_response(template)
|
||||||
|
|||||||
@@ -12,6 +12,7 @@ from fastapi.responses import Response
|
|||||||
from ledgrab.api.auth import AuthRequired
|
from ledgrab.api.auth import AuthRequired
|
||||||
from ledgrab.api.dependencies import (
|
from ledgrab.api.dependencies import (
|
||||||
fire_entity_event,
|
fire_entity_event,
|
||||||
|
get_color_strip_store,
|
||||||
get_picture_source_store,
|
get_picture_source_store,
|
||||||
get_output_target_store,
|
get_output_target_store,
|
||||||
get_pp_template_store,
|
get_pp_template_store,
|
||||||
@@ -37,6 +38,7 @@ from ledgrab.api.schemas.picture_sources import (
|
|||||||
)
|
)
|
||||||
from ledgrab.core.capture_engines import EngineRegistry
|
from ledgrab.core.capture_engines import EngineRegistry
|
||||||
from ledgrab.core.filters import FilterRegistry, ImagePool
|
from ledgrab.core.filters import FilterRegistry, ImagePool
|
||||||
|
from ledgrab.storage.color_strip_store import ColorStripStore
|
||||||
from ledgrab.storage.output_target_store import OutputTargetStore
|
from ledgrab.storage.output_target_store import OutputTargetStore
|
||||||
from ledgrab.storage.template_store import TemplateStore
|
from ledgrab.storage.template_store import TemplateStore
|
||||||
from ledgrab.storage.postprocessing_template_store import PostprocessingTemplateStore
|
from ledgrab.storage.postprocessing_template_store import PostprocessingTemplateStore
|
||||||
@@ -63,6 +65,8 @@ _RESPONSE_MAP = {
|
|||||||
tags=s.tags,
|
tags=s.tags,
|
||||||
created_at=s.created_at,
|
created_at=s.created_at,
|
||||||
updated_at=s.updated_at,
|
updated_at=s.updated_at,
|
||||||
|
icon=getattr(s, "icon", "") or "",
|
||||||
|
icon_color=getattr(s, "icon_color", "") or "",
|
||||||
display_index=s.display_index,
|
display_index=s.display_index,
|
||||||
capture_template_id=s.capture_template_id,
|
capture_template_id=s.capture_template_id,
|
||||||
target_fps=s.target_fps,
|
target_fps=s.target_fps,
|
||||||
@@ -74,6 +78,8 @@ _RESPONSE_MAP = {
|
|||||||
tags=s.tags,
|
tags=s.tags,
|
||||||
created_at=s.created_at,
|
created_at=s.created_at,
|
||||||
updated_at=s.updated_at,
|
updated_at=s.updated_at,
|
||||||
|
icon=getattr(s, "icon", "") or "",
|
||||||
|
icon_color=getattr(s, "icon_color", "") or "",
|
||||||
source_stream_id=s.source_stream_id,
|
source_stream_id=s.source_stream_id,
|
||||||
postprocessing_template_id=s.postprocessing_template_id,
|
postprocessing_template_id=s.postprocessing_template_id,
|
||||||
),
|
),
|
||||||
@@ -84,6 +90,8 @@ _RESPONSE_MAP = {
|
|||||||
tags=s.tags,
|
tags=s.tags,
|
||||||
created_at=s.created_at,
|
created_at=s.created_at,
|
||||||
updated_at=s.updated_at,
|
updated_at=s.updated_at,
|
||||||
|
icon=getattr(s, "icon", "") or "",
|
||||||
|
icon_color=getattr(s, "icon_color", "") or "",
|
||||||
image_asset_id=s.image_asset_id,
|
image_asset_id=s.image_asset_id,
|
||||||
),
|
),
|
||||||
VideoCaptureSource: lambda s: VideoPictureSourceResponse(
|
VideoCaptureSource: lambda s: VideoPictureSourceResponse(
|
||||||
@@ -93,6 +101,8 @@ _RESPONSE_MAP = {
|
|||||||
tags=s.tags,
|
tags=s.tags,
|
||||||
created_at=s.created_at,
|
created_at=s.created_at,
|
||||||
updated_at=s.updated_at,
|
updated_at=s.updated_at,
|
||||||
|
icon=getattr(s, "icon", "") or "",
|
||||||
|
icon_color=getattr(s, "icon_color", "") or "",
|
||||||
video_asset_id=s.video_asset_id,
|
video_asset_id=s.video_asset_id,
|
||||||
loop=s.loop,
|
loop=s.loop,
|
||||||
playback_speed=s.playback_speed,
|
playback_speed=s.playback_speed,
|
||||||
@@ -361,11 +371,12 @@ async def delete_picture_source(
|
|||||||
_auth: AuthRequired,
|
_auth: AuthRequired,
|
||||||
store: PictureSourceStore = Depends(get_picture_source_store),
|
store: PictureSourceStore = Depends(get_picture_source_store),
|
||||||
target_store: OutputTargetStore = Depends(get_output_target_store),
|
target_store: OutputTargetStore = Depends(get_output_target_store),
|
||||||
|
css_store: ColorStripStore = Depends(get_color_strip_store),
|
||||||
):
|
):
|
||||||
"""Delete a picture source."""
|
"""Delete a picture source."""
|
||||||
try:
|
try:
|
||||||
# Check if any target references this stream
|
# Check if any target transitively references this stream via a CSS
|
||||||
target_names = store.get_targets_referencing(stream_id, target_store)
|
target_names = store.get_targets_referencing(stream_id, target_store, css_store)
|
||||||
if target_names:
|
if target_names:
|
||||||
names = ", ".join(target_names)
|
names = ", ".join(target_names)
|
||||||
raise HTTPException(
|
raise HTTPException(
|
||||||
@@ -373,6 +384,16 @@ async def delete_picture_source(
|
|||||||
detail=f"Cannot delete picture source: it is assigned to target(s): {names}. "
|
detail=f"Cannot delete picture source: it is assigned to target(s): {names}. "
|
||||||
"Please reassign those targets before deleting.",
|
"Please reassign those targets before deleting.",
|
||||||
)
|
)
|
||||||
|
# Block when any CSS still references this picture source, even if no
|
||||||
|
# target depends on it — deletion would leave the CSS broken.
|
||||||
|
css_refs = css_store.get_referencing_picture_source(stream_id)
|
||||||
|
if css_refs:
|
||||||
|
css_names = ", ".join(css.name for css in css_refs)
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=409,
|
||||||
|
detail=f"Cannot delete picture source: it is used by color strip source(s): "
|
||||||
|
f"{css_names}. Please reassign or delete those first.",
|
||||||
|
)
|
||||||
store.delete_stream(stream_id)
|
store.delete_stream(stream_id)
|
||||||
fire_entity_event("picture_source", "deleted", stream_id)
|
fire_entity_event("picture_source", "deleted", stream_id)
|
||||||
except HTTPException:
|
except HTTPException:
|
||||||
|
|||||||
@@ -49,6 +49,9 @@ def _pp_template_to_response(t) -> PostprocessingTemplateResponse:
|
|||||||
updated_at=t.updated_at,
|
updated_at=t.updated_at,
|
||||||
description=t.description,
|
description=t.description,
|
||||||
tags=t.tags,
|
tags=t.tags,
|
||||||
|
icon=getattr(t, "icon", "") or "",
|
||||||
|
icon_color=getattr(t, "icon_color", "") or "",
|
||||||
|
is_builtin=getattr(t, "is_builtin", False),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -86,6 +89,8 @@ async def create_pp_template(
|
|||||||
filters=filters,
|
filters=filters,
|
||||||
description=data.description,
|
description=data.description,
|
||||||
tags=data.tags,
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
)
|
)
|
||||||
fire_entity_event("pp_template", "created", template.id)
|
fire_entity_event("pp_template", "created", template.id)
|
||||||
return _pp_template_to_response(template)
|
return _pp_template_to_response(template)
|
||||||
@@ -143,6 +148,8 @@ async def update_pp_template(
|
|||||||
filters=filters,
|
filters=filters,
|
||||||
description=data.description,
|
description=data.description,
|
||||||
tags=data.tags,
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
)
|
)
|
||||||
fire_entity_event("pp_template", "updated", template_id)
|
fire_entity_event("pp_template", "updated", template_id)
|
||||||
return _pp_template_to_response(template)
|
return _pp_template_to_response(template)
|
||||||
|
|||||||
@@ -1,17 +1,33 @@
|
|||||||
"""User preferences routes — currently dashboard layout only.
|
"""User preferences routes — dashboard layout + notification settings + daylight tz.
|
||||||
|
|
||||||
The dashboard layout schema is owned by the frontend (open registry of
|
The dashboard layout schema is owned by the frontend (open registry of
|
||||||
section/cell keys); the backend treats the value as an opaque JSON blob,
|
section/cell keys); the backend treats the value as an opaque JSON blob,
|
||||||
validates it's a dict with a `version` field, and persists it under the
|
validates it's a dict with a `version` field, and persists it under the
|
||||||
`dashboard_layout` settings key.
|
`dashboard_layout` settings key.
|
||||||
|
|
||||||
|
Notification preferences are validated server-side via Pydantic so the
|
||||||
|
backend can read them when deciding whether to start the background
|
||||||
|
discovery watcher.
|
||||||
|
|
||||||
|
Daylight timezone is a single global IANA tz name shared by every
|
||||||
|
daylight value-source / color-strip-source. Stored as
|
||||||
|
``{"value": "Europe/Berlin"}`` under the ``daylight_timezone`` key, with
|
||||||
|
empty/missing meaning "use system local time".
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
from fastapi import APIRouter, Body, Depends, HTTPException
|
from fastapi import APIRouter, Body, Depends, HTTPException
|
||||||
|
from pydantic import BaseModel, Field
|
||||||
|
|
||||||
from ledgrab.api.auth import AuthRequired
|
from ledgrab.api.auth import AuthRequired
|
||||||
from ledgrab.api.dependencies import get_database
|
from ledgrab.api.dependencies import get_database
|
||||||
|
from ledgrab.api.schemas.preferences import NotificationPreferences
|
||||||
|
from ledgrab.core.processing.daylight_settings import (
|
||||||
|
DAYLIGHT_TIMEZONE_KEY,
|
||||||
|
get_daylight_timezone,
|
||||||
|
set_daylight_timezone,
|
||||||
|
)
|
||||||
from ledgrab.storage.database import Database
|
from ledgrab.storage.database import Database
|
||||||
from ledgrab.utils import get_logger
|
from ledgrab.utils import get_logger
|
||||||
|
|
||||||
@@ -20,6 +36,34 @@ logger = get_logger(__name__)
|
|||||||
router = APIRouter()
|
router = APIRouter()
|
||||||
|
|
||||||
_DASHBOARD_LAYOUT_KEY = "dashboard_layout"
|
_DASHBOARD_LAYOUT_KEY = "dashboard_layout"
|
||||||
|
_NOTIFICATION_PREFS_KEY = "notification_preferences"
|
||||||
|
_CARD_MODES_KEY = "card_modes"
|
||||||
|
|
||||||
|
|
||||||
|
class DaylightTimezonePreference(BaseModel):
|
||||||
|
"""Global IANA timezone applied to every daylight cycle source."""
|
||||||
|
|
||||||
|
timezone: str = Field("", description="IANA timezone name; empty = system local")
|
||||||
|
|
||||||
|
|
||||||
|
def load_notification_preferences(db: Database | None = None) -> NotificationPreferences:
|
||||||
|
"""Read notification prefs, returning defaults when unset or corrupt.
|
||||||
|
|
||||||
|
Used by both the route handler and `main.lifespan` (so the discovery
|
||||||
|
watcher can decide whether to start without going through HTTP).
|
||||||
|
"""
|
||||||
|
if db is None:
|
||||||
|
from ledgrab.api.dependencies import get_database as _get_db
|
||||||
|
|
||||||
|
db = _get_db()
|
||||||
|
raw = db.get_setting(_NOTIFICATION_PREFS_KEY)
|
||||||
|
if not raw:
|
||||||
|
return NotificationPreferences()
|
||||||
|
try:
|
||||||
|
return NotificationPreferences.model_validate(raw)
|
||||||
|
except Exception as e:
|
||||||
|
logger.warning("Stored notification preferences invalid (%s); using defaults", e)
|
||||||
|
return NotificationPreferences()
|
||||||
|
|
||||||
|
|
||||||
@router.get(
|
@router.get(
|
||||||
@@ -73,3 +117,172 @@ async def delete_dashboard_layout(
|
|||||||
to clear the server-side override entirely."""
|
to clear the server-side override entirely."""
|
||||||
db.set_setting(_DASHBOARD_LAYOUT_KEY, {})
|
db.set_setting(_DASHBOARD_LAYOUT_KEY, {})
|
||||||
return {"ok": True}
|
return {"ok": True}
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Notification preferences
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
@router.get(
|
||||||
|
"/api/v1/preferences/notifications",
|
||||||
|
response_model=NotificationPreferences,
|
||||||
|
tags=["Preferences"],
|
||||||
|
)
|
||||||
|
async def get_notification_preferences(
|
||||||
|
_: AuthRequired,
|
||||||
|
db: Database = Depends(get_database),
|
||||||
|
) -> NotificationPreferences:
|
||||||
|
"""Read notification prefs, returning defaults when unset.
|
||||||
|
|
||||||
|
Defaults: device_offline=both, device_online/discovered=snack,
|
||||||
|
device_lost=none, background discovery on, 10 s startup grace,
|
||||||
|
5 s flap debounce.
|
||||||
|
"""
|
||||||
|
return load_notification_preferences(db)
|
||||||
|
|
||||||
|
|
||||||
|
@router.put(
|
||||||
|
"/api/v1/preferences/notifications",
|
||||||
|
response_model=NotificationPreferences,
|
||||||
|
tags=["Preferences"],
|
||||||
|
)
|
||||||
|
async def put_notification_preferences(
|
||||||
|
_: AuthRequired,
|
||||||
|
body: NotificationPreferences,
|
||||||
|
db: Database = Depends(get_database),
|
||||||
|
) -> NotificationPreferences:
|
||||||
|
"""Persist the notification prefs. Pydantic enforces channel
|
||||||
|
enum + grace/debounce ranges so a bad client cannot poison
|
||||||
|
the stored value."""
|
||||||
|
db.set_setting(_NOTIFICATION_PREFS_KEY, body.model_dump())
|
||||||
|
logger.info(
|
||||||
|
"Notification preferences updated (background_discovery=%s, " "channels=%s)",
|
||||||
|
body.background_discovery_enabled,
|
||||||
|
body.channels.model_dump(),
|
||||||
|
)
|
||||||
|
return body
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Card presentation modes (per-surface comfortable/compact/dense)
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
_VALID_CARD_MODES = {"comfortable", "compact", "dense", "row"}
|
||||||
|
|
||||||
|
|
||||||
|
@router.get(
|
||||||
|
"/api/v1/preferences/card-modes",
|
||||||
|
tags=["Preferences"],
|
||||||
|
)
|
||||||
|
async def get_card_modes(
|
||||||
|
_: AuthRequired,
|
||||||
|
db: Database = Depends(get_database),
|
||||||
|
) -> dict[str, Any]:
|
||||||
|
"""Read the saved card-mode preferences. Returns an empty object when
|
||||||
|
nothing has been saved yet — the frontend falls back to the default
|
||||||
|
mode ("compact") for every surface in that case."""
|
||||||
|
value = db.get_setting(_CARD_MODES_KEY)
|
||||||
|
return value if value is not None else {}
|
||||||
|
|
||||||
|
|
||||||
|
@router.put(
|
||||||
|
"/api/v1/preferences/card-modes",
|
||||||
|
tags=["Preferences"],
|
||||||
|
)
|
||||||
|
async def put_card_modes(
|
||||||
|
_: AuthRequired,
|
||||||
|
body: dict[str, Any] = Body(...),
|
||||||
|
db: Database = Depends(get_database),
|
||||||
|
) -> dict[str, bool]:
|
||||||
|
"""Save card-mode preferences. The body must be a JSON object shaped
|
||||||
|
like ``{"version": 1, "surfaces": {"<surface>": "<mode>", …}}``.
|
||||||
|
|
||||||
|
The surface registry is intentionally open (any string accepted) so
|
||||||
|
new card surfaces can adopt the toggle without a server migration.
|
||||||
|
Invalid mode values are rejected to prevent a bad client from
|
||||||
|
poisoning the stored value."""
|
||||||
|
if not isinstance(body, dict):
|
||||||
|
raise HTTPException(status_code=422, detail="Body must be a JSON object")
|
||||||
|
if not isinstance(body.get("version"), int):
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=422,
|
||||||
|
detail="Body must include a numeric 'version' field",
|
||||||
|
)
|
||||||
|
surfaces = body.get("surfaces", {})
|
||||||
|
if not isinstance(surfaces, dict):
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=422,
|
||||||
|
detail="'surfaces' must be an object mapping surface keys to modes",
|
||||||
|
)
|
||||||
|
for key, mode in surfaces.items():
|
||||||
|
if not isinstance(key, str) or not key:
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=422,
|
||||||
|
detail=f"Surface keys must be non-empty strings (got {key!r})",
|
||||||
|
)
|
||||||
|
if mode not in _VALID_CARD_MODES:
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=422,
|
||||||
|
detail=(
|
||||||
|
f"Surface {key!r} has invalid mode {mode!r}; "
|
||||||
|
f"expected one of {sorted(_VALID_CARD_MODES)}"
|
||||||
|
),
|
||||||
|
)
|
||||||
|
db.set_setting(_CARD_MODES_KEY, body)
|
||||||
|
return {"ok": True}
|
||||||
|
|
||||||
|
|
||||||
|
@router.delete(
|
||||||
|
"/api/v1/preferences/card-modes",
|
||||||
|
tags=["Preferences"],
|
||||||
|
)
|
||||||
|
async def delete_card_modes(
|
||||||
|
_: AuthRequired,
|
||||||
|
db: Database = Depends(get_database),
|
||||||
|
) -> dict[str, bool]:
|
||||||
|
"""Delete saved card-mode preferences — every surface reverts to the
|
||||||
|
frontend default on next load."""
|
||||||
|
db.set_setting(_CARD_MODES_KEY, {})
|
||||||
|
return {"ok": True}
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Daylight timezone (global)
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
@router.get(
|
||||||
|
"/api/v1/preferences/daylight-timezone",
|
||||||
|
response_model=DaylightTimezonePreference,
|
||||||
|
tags=["Preferences"],
|
||||||
|
)
|
||||||
|
async def get_daylight_timezone_preference(
|
||||||
|
_: AuthRequired,
|
||||||
|
) -> DaylightTimezonePreference:
|
||||||
|
"""Return the global daylight cycle timezone (empty = system local)."""
|
||||||
|
return DaylightTimezonePreference(timezone=get_daylight_timezone())
|
||||||
|
|
||||||
|
|
||||||
|
@router.put(
|
||||||
|
"/api/v1/preferences/daylight-timezone",
|
||||||
|
response_model=DaylightTimezonePreference,
|
||||||
|
tags=["Preferences"],
|
||||||
|
)
|
||||||
|
async def put_daylight_timezone_preference(
|
||||||
|
_: AuthRequired,
|
||||||
|
body: DaylightTimezonePreference,
|
||||||
|
) -> DaylightTimezonePreference:
|
||||||
|
"""Persist the global daylight cycle timezone.
|
||||||
|
|
||||||
|
The string is stored verbatim — clients should send a valid IANA name
|
||||||
|
(e.g. ``Europe/Berlin``) or an empty string for "use server local".
|
||||||
|
Daylight streams pick up the new value within ~1 second.
|
||||||
|
"""
|
||||||
|
saved = set_daylight_timezone(body.timezone)
|
||||||
|
logger.info("Daylight timezone updated: %r", saved or "<system local>")
|
||||||
|
return DaylightTimezonePreference(timezone=saved)
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = ["router", "DAYLIGHT_TIMEZONE_KEY"]
|
||||||
|
|||||||
@@ -51,6 +51,8 @@ def _preset_to_response(preset: ScenePreset) -> ScenePresetResponse:
|
|||||||
],
|
],
|
||||||
order=preset.order,
|
order=preset.order,
|
||||||
tags=preset.tags,
|
tags=preset.tags,
|
||||||
|
icon=getattr(preset, "icon", "") or "",
|
||||||
|
icon_color=getattr(preset, "icon_color", "") or "",
|
||||||
created_at=preset.created_at,
|
created_at=preset.created_at,
|
||||||
updated_at=preset.updated_at,
|
updated_at=preset.updated_at,
|
||||||
)
|
)
|
||||||
@@ -84,6 +86,8 @@ async def create_scene_preset(
|
|||||||
targets=targets,
|
targets=targets,
|
||||||
order=store.count(),
|
order=store.count(),
|
||||||
tags=data.tags if data.tags is not None else [],
|
tags=data.tags if data.tags is not None else [],
|
||||||
|
icon=data.icon or "",
|
||||||
|
icon_color=data.icon_color or "",
|
||||||
created_at=now,
|
created_at=now,
|
||||||
updated_at=now,
|
updated_at=now,
|
||||||
)
|
)
|
||||||
@@ -182,6 +186,8 @@ async def update_scene_preset(
|
|||||||
order=data.order,
|
order=data.order,
|
||||||
targets=new_targets,
|
targets=new_targets,
|
||||||
tags=data.tags,
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
)
|
)
|
||||||
except ValueError as e:
|
except ValueError as e:
|
||||||
raise HTTPException(
|
raise HTTPException(
|
||||||
|
|||||||
@@ -0,0 +1,201 @@
|
|||||||
|
"""Aggregated snapshot endpoint for low-overhead polling clients.
|
||||||
|
|
||||||
|
Returns, in a single response, everything the Home Assistant integration's
|
||||||
|
coordinator needs per poll: all output targets with processing state + metrics,
|
||||||
|
all devices with brightness, the color-strip / value-source / scene-preset /
|
||||||
|
sync-clock lists, and the system block (performance, health, update).
|
||||||
|
|
||||||
|
This collapses the integration's previous ~2N+M request fan-out (per-target
|
||||||
|
``/state`` + ``/metrics`` and per-device ``/brightness``) into one round trip.
|
||||||
|
|
||||||
|
The handler delegates to the existing list/batch route handlers so the response
|
||||||
|
sub-shapes stay byte-identical to the individual endpoints — no shaping logic is
|
||||||
|
duplicated here.
|
||||||
|
|
||||||
|
Callers that don't need the whole payload can pass ``?include=`` with a
|
||||||
|
comma-separated subset of section names (the response keys). Omitting it returns
|
||||||
|
every section. Gating is per section, so an excluded section also skips its
|
||||||
|
server-side work — dropping ``device_brightness`` avoids cold-cache hardware
|
||||||
|
probes, and dropping ``system`` skips the (blocking) NVML performance query.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
from fastapi import APIRouter, Depends, HTTPException, Query, Request
|
||||||
|
from fastapi.concurrency import run_in_threadpool
|
||||||
|
|
||||||
|
from ledgrab.api.auth import AuthRequired
|
||||||
|
from ledgrab.api.dependencies import (
|
||||||
|
get_color_strip_store,
|
||||||
|
get_device_store,
|
||||||
|
get_output_target_store,
|
||||||
|
get_processor_manager,
|
||||||
|
get_scene_preset_store,
|
||||||
|
get_sync_clock_manager,
|
||||||
|
get_sync_clock_store,
|
||||||
|
get_update_service,
|
||||||
|
get_value_source_store,
|
||||||
|
)
|
||||||
|
from ledgrab.api.schemas.update import UpdateStatusResponse
|
||||||
|
from ledgrab.utils import get_logger
|
||||||
|
|
||||||
|
from .color_strip_sources.crud import list_color_strip_sources
|
||||||
|
from .devices import list_devices, resolve_device_brightness
|
||||||
|
from .output_targets import batch_target_metrics, batch_target_states, list_targets
|
||||||
|
from .scene_presets import list_scene_presets
|
||||||
|
from .sync_clocks import list_sync_clocks
|
||||||
|
from .system import get_system_performance, health_check
|
||||||
|
from .update import get_update_status
|
||||||
|
from .value_sources import list_value_sources
|
||||||
|
|
||||||
|
logger = get_logger(__name__)
|
||||||
|
|
||||||
|
router = APIRouter()
|
||||||
|
|
||||||
|
# Selectable snapshot sections — these are exactly the response top-level keys.
|
||||||
|
SNAPSHOT_SECTIONS = (
|
||||||
|
"targets",
|
||||||
|
"target_states",
|
||||||
|
"target_metrics",
|
||||||
|
"devices",
|
||||||
|
"device_brightness",
|
||||||
|
"css_sources",
|
||||||
|
"value_sources",
|
||||||
|
"scene_presets",
|
||||||
|
"sync_clocks",
|
||||||
|
"system",
|
||||||
|
)
|
||||||
|
_SECTION_SET = frozenset(SNAPSHOT_SECTIONS)
|
||||||
|
|
||||||
|
|
||||||
|
def _resolve_sections(include: str | None) -> frozenset[str]:
|
||||||
|
"""Validate the ``include`` query param into the set of sections to emit.
|
||||||
|
|
||||||
|
``None``/empty → every section. Unknown names are rejected with 422 so a
|
||||||
|
typo fails loudly instead of silently returning a smaller payload.
|
||||||
|
"""
|
||||||
|
if not include:
|
||||||
|
return _SECTION_SET
|
||||||
|
requested = {part.strip() for part in include.split(",") if part.strip()}
|
||||||
|
unknown = requested - _SECTION_SET
|
||||||
|
if unknown:
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=422,
|
||||||
|
detail=(
|
||||||
|
f"Unknown snapshot section(s): {', '.join(sorted(unknown))}. "
|
||||||
|
f"Valid sections: {', '.join(SNAPSHOT_SECTIONS)}."
|
||||||
|
),
|
||||||
|
)
|
||||||
|
return frozenset(requested)
|
||||||
|
|
||||||
|
|
||||||
|
async def _safe_section(awaitable, label: str):
|
||||||
|
"""Await a section, degrading to ``None`` on failure instead of 500-ing.
|
||||||
|
|
||||||
|
The snapshot is a resilience-oriented poll surface: one failing section
|
||||||
|
(e.g. NVML performance probing) must not fail the whole response. This
|
||||||
|
preserves the per-section fault isolation the HA coordinator relied on
|
||||||
|
before these calls were merged into one request — the coordinator already
|
||||||
|
tolerates a ``None`` section.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
return await awaitable
|
||||||
|
except Exception:
|
||||||
|
logger.warning("snapshot: section %r failed, returning null", label, exc_info=True)
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
async def _update_status_model(_auth, update_service) -> UpdateStatusResponse:
|
||||||
|
"""Fetch update status and coerce it through the response model.
|
||||||
|
|
||||||
|
The standalone ``/system/update/status`` endpoint declares
|
||||||
|
``response_model=UpdateStatusResponse``; coercing here keeps the snapshot's
|
||||||
|
``system.update`` field identical to that endpoint rather than emitting the
|
||||||
|
service's raw dict unfiltered.
|
||||||
|
"""
|
||||||
|
raw = await get_update_status(_auth, update_service)
|
||||||
|
return UpdateStatusResponse.model_validate(raw)
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/api/v1/snapshot", tags=["Snapshot"])
|
||||||
|
async def get_snapshot(
|
||||||
|
request: Request,
|
||||||
|
_auth: AuthRequired,
|
||||||
|
include: str | None = Query(
|
||||||
|
None,
|
||||||
|
description=(
|
||||||
|
"Comma-separated subset of sections to include. Omit for all. "
|
||||||
|
"Valid: " + ", ".join(SNAPSHOT_SECTIONS)
|
||||||
|
),
|
||||||
|
),
|
||||||
|
manager=Depends(get_processor_manager),
|
||||||
|
target_store=Depends(get_output_target_store),
|
||||||
|
device_store=Depends(get_device_store),
|
||||||
|
css_store=Depends(get_color_strip_store),
|
||||||
|
value_store=Depends(get_value_source_store),
|
||||||
|
preset_store=Depends(get_scene_preset_store),
|
||||||
|
clock_store=Depends(get_sync_clock_store),
|
||||||
|
clock_manager=Depends(get_sync_clock_manager),
|
||||||
|
update_service=Depends(get_update_service),
|
||||||
|
) -> dict[str, Any]:
|
||||||
|
"""Return the full poll payload (or a requested subset) in one response.
|
||||||
|
|
||||||
|
Shape (a key is present only when its section is requested)::
|
||||||
|
|
||||||
|
{
|
||||||
|
"targets": [<OutputTargetResponse>, ...],
|
||||||
|
"target_states": {target_id: <state>, ...},
|
||||||
|
"target_metrics": {target_id: <metrics>, ...},
|
||||||
|
"devices": [<DeviceResponse>, ...],
|
||||||
|
"device_brightness": {device_id: int | null, ...},
|
||||||
|
"css_sources": [...],
|
||||||
|
"value_sources": [...],
|
||||||
|
"scene_presets": [...],
|
||||||
|
"sync_clocks": [...],
|
||||||
|
"system": {"performance": {...}, "health": {...}, "update": {...}}
|
||||||
|
}
|
||||||
|
"""
|
||||||
|
sections = _resolve_sections(include)
|
||||||
|
result: dict[str, Any] = {}
|
||||||
|
|
||||||
|
if "targets" in sections:
|
||||||
|
result["targets"] = (await list_targets(_auth, target_store)).targets
|
||||||
|
if "target_states" in sections:
|
||||||
|
result["target_states"] = (await batch_target_states(_auth, manager))["states"]
|
||||||
|
if "target_metrics" in sections:
|
||||||
|
result["target_metrics"] = (await batch_target_metrics(_auth, manager))["metrics"]
|
||||||
|
if "devices" in sections:
|
||||||
|
result["devices"] = (await list_devices(_auth, device_store)).devices
|
||||||
|
if "device_brightness" in sections:
|
||||||
|
device_models = device_store.get_all_devices()
|
||||||
|
brightness_values = await asyncio.gather(
|
||||||
|
*(resolve_device_brightness(d, manager) for d in device_models),
|
||||||
|
return_exceptions=True,
|
||||||
|
)
|
||||||
|
result["device_brightness"] = {
|
||||||
|
model.id: (None if isinstance(value, BaseException) else value)
|
||||||
|
for model, value in zip(device_models, brightness_values)
|
||||||
|
}
|
||||||
|
if "css_sources" in sections:
|
||||||
|
css = await list_color_strip_sources(_auth, css_store, manager)
|
||||||
|
result["css_sources"] = css.sources
|
||||||
|
if "value_sources" in sections:
|
||||||
|
result["value_sources"] = (await list_value_sources(_auth, None, value_store)).sources
|
||||||
|
if "scene_presets" in sections:
|
||||||
|
result["scene_presets"] = (await list_scene_presets(_auth, preset_store)).presets
|
||||||
|
if "sync_clocks" in sections:
|
||||||
|
clocks = await list_sync_clocks(_auth, clock_store, clock_manager)
|
||||||
|
result["sync_clocks"] = clocks.clocks
|
||||||
|
if "system" in sections:
|
||||||
|
result["system"] = {
|
||||||
|
"performance": await _safe_section(
|
||||||
|
run_in_threadpool(get_system_performance, _auth), "system.performance"
|
||||||
|
),
|
||||||
|
"health": await _safe_section(health_check(request), "system.health"),
|
||||||
|
"update": await _safe_section(
|
||||||
|
_update_status_model(_auth, update_service), "system.update"
|
||||||
|
),
|
||||||
|
}
|
||||||
|
|
||||||
|
return result
|
||||||
@@ -8,6 +8,7 @@ from ledgrab.api.dependencies import (
|
|||||||
get_color_strip_store,
|
get_color_strip_store,
|
||||||
get_sync_clock_manager,
|
get_sync_clock_manager,
|
||||||
get_sync_clock_store,
|
get_sync_clock_store,
|
||||||
|
get_value_source_store,
|
||||||
)
|
)
|
||||||
from ledgrab.api.schemas.sync_clocks import (
|
from ledgrab.api.schemas.sync_clocks import (
|
||||||
SyncClockCreate,
|
SyncClockCreate,
|
||||||
@@ -18,6 +19,7 @@ from ledgrab.api.schemas.sync_clocks import (
|
|||||||
from ledgrab.storage.sync_clock import SyncClock
|
from ledgrab.storage.sync_clock import SyncClock
|
||||||
from ledgrab.storage.sync_clock_store import SyncClockStore
|
from ledgrab.storage.sync_clock_store import SyncClockStore
|
||||||
from ledgrab.storage.color_strip_store import ColorStripStore
|
from ledgrab.storage.color_strip_store import ColorStripStore
|
||||||
|
from ledgrab.storage.value_source_store import ValueSourceStore
|
||||||
from ledgrab.core.processing.sync_clock_manager import SyncClockManager
|
from ledgrab.core.processing.sync_clock_manager import SyncClockManager
|
||||||
from ledgrab.utils import get_logger
|
from ledgrab.utils import get_logger
|
||||||
from ledgrab.storage.base_store import EntityNotFoundError
|
from ledgrab.storage.base_store import EntityNotFoundError
|
||||||
@@ -36,6 +38,8 @@ def _to_response(clock: SyncClock, manager: SyncClockManager) -> SyncClockRespon
|
|||||||
speed=rt.speed if rt else clock.speed,
|
speed=rt.speed if rt else clock.speed,
|
||||||
description=clock.description,
|
description=clock.description,
|
||||||
tags=clock.tags,
|
tags=clock.tags,
|
||||||
|
icon=getattr(clock, "icon", "") or "",
|
||||||
|
icon_color=getattr(clock, "icon_color", "") or "",
|
||||||
is_running=rt.is_running if rt else True,
|
is_running=rt.is_running if rt else True,
|
||||||
elapsed_time=rt.get_time() if rt else 0.0,
|
elapsed_time=rt.get_time() if rt else 0.0,
|
||||||
created_at=clock.created_at,
|
created_at=clock.created_at,
|
||||||
@@ -73,6 +77,8 @@ async def create_sync_clock(
|
|||||||
speed=data.speed,
|
speed=data.speed,
|
||||||
description=data.description,
|
description=data.description,
|
||||||
tags=data.tags,
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
)
|
)
|
||||||
fire_entity_event("sync_clock", "created", clock.id)
|
fire_entity_event("sync_clock", "created", clock.id)
|
||||||
return _to_response(clock, manager)
|
return _to_response(clock, manager)
|
||||||
@@ -118,6 +124,8 @@ async def update_sync_clock(
|
|||||||
speed=data.speed,
|
speed=data.speed,
|
||||||
description=data.description,
|
description=data.description,
|
||||||
tags=data.tags,
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
)
|
)
|
||||||
# Hot-update runtime speed
|
# Hot-update runtime speed
|
||||||
if data.speed is not None:
|
if data.speed is not None:
|
||||||
@@ -137,14 +145,18 @@ async def delete_sync_clock(
|
|||||||
_auth: AuthRequired,
|
_auth: AuthRequired,
|
||||||
store: SyncClockStore = Depends(get_sync_clock_store),
|
store: SyncClockStore = Depends(get_sync_clock_store),
|
||||||
css_store: ColorStripStore = Depends(get_color_strip_store),
|
css_store: ColorStripStore = Depends(get_color_strip_store),
|
||||||
|
vs_store: ValueSourceStore = Depends(get_value_source_store),
|
||||||
manager: SyncClockManager = Depends(get_sync_clock_manager),
|
manager: SyncClockManager = Depends(get_sync_clock_manager),
|
||||||
):
|
):
|
||||||
"""Delete a synchronization clock (fails if referenced by CSS sources)."""
|
"""Delete a synchronization clock (fails if referenced by CSS or value sources)."""
|
||||||
try:
|
try:
|
||||||
# Check references
|
# Check references
|
||||||
for source in css_store.get_all_sources():
|
for source in css_store.get_all_sources():
|
||||||
if getattr(source, "clock_id", None) == clock_id:
|
if getattr(source, "clock_id", None) == clock_id:
|
||||||
raise ValueError(f"Cannot delete: referenced by color strip source '{source.name}'")
|
raise ValueError(f"Cannot delete: referenced by color strip source '{source.name}'")
|
||||||
|
for vs in vs_store.get_all_sources():
|
||||||
|
if getattr(vs, "clock_id", None) == clock_id:
|
||||||
|
raise ValueError(f"Cannot delete: referenced by value source '{vs.name}'")
|
||||||
manager.release_all_for(clock_id)
|
manager.release_all_for(clock_id)
|
||||||
store.delete_clock(clock_id)
|
store.delete_clock(clock_id)
|
||||||
fire_entity_event("sync_clock", "deleted", clock_id)
|
fire_entity_event("sync_clock", "deleted", clock_id)
|
||||||
|
|||||||
@@ -9,7 +9,6 @@ import subprocess
|
|||||||
import sys
|
import sys
|
||||||
import time
|
import time
|
||||||
from datetime import datetime, timezone
|
from datetime import datetime, timezone
|
||||||
from typing import Optional
|
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
|
||||||
@@ -25,6 +24,7 @@ from ledgrab.api.dependencies import (
|
|||||||
get_device_store,
|
get_device_store,
|
||||||
get_ha_manager,
|
get_ha_manager,
|
||||||
get_ha_store,
|
get_ha_store,
|
||||||
|
get_mqtt_manager,
|
||||||
get_output_target_store,
|
get_output_target_store,
|
||||||
get_picture_source_store,
|
get_picture_source_store,
|
||||||
get_pp_template_store,
|
get_pp_template_store,
|
||||||
@@ -39,8 +39,11 @@ from ledgrab.api.schemas.system import (
|
|||||||
DisplayListResponse,
|
DisplayListResponse,
|
||||||
GpuInfo,
|
GpuInfo,
|
||||||
HealthResponse,
|
HealthResponse,
|
||||||
|
InstalledAppItem,
|
||||||
|
InstalledAppsResponse,
|
||||||
PerformanceResponse,
|
PerformanceResponse,
|
||||||
ProcessListResponse,
|
ProcessListResponse,
|
||||||
|
SystemInfoResponse,
|
||||||
VersionResponse,
|
VersionResponse,
|
||||||
)
|
)
|
||||||
from ledgrab.config import get_config, is_demo_mode
|
from ledgrab.config import get_config, is_demo_mode
|
||||||
@@ -189,7 +192,7 @@ async def list_all_tags(_: AuthRequired):
|
|||||||
@router.get("/api/v1/config/displays", response_model=DisplayListResponse, tags=["Config"])
|
@router.get("/api/v1/config/displays", response_model=DisplayListResponse, tags=["Config"])
|
||||||
async def get_displays(
|
async def get_displays(
|
||||||
_: AuthRequired,
|
_: AuthRequired,
|
||||||
engine_type: Optional[str] = Query(None, description="Engine type to get displays for"),
|
engine_type: str | None = Query(None, description="Engine type to get displays for"),
|
||||||
):
|
):
|
||||||
"""Get list of available displays.
|
"""Get list of available displays.
|
||||||
|
|
||||||
@@ -278,6 +281,52 @@ async def get_running_processes(_: AuthRequired):
|
|||||||
raise HTTPException(status_code=500, detail="Internal server error")
|
raise HTTPException(status_code=500, detail="Internal server error")
|
||||||
|
|
||||||
|
|
||||||
|
@router.get(
|
||||||
|
"/api/v1/system/installed-apps",
|
||||||
|
response_model=InstalledAppsResponse,
|
||||||
|
tags=["Config"],
|
||||||
|
)
|
||||||
|
def get_installed_apps(_: AuthRequired):
|
||||||
|
"""List launchable apps for the application-rule app picker (Android only).
|
||||||
|
|
||||||
|
Returns launchable apps (package + human label) on Android, where the
|
||||||
|
foreground-app automation rule matches package names. Returns an empty list
|
||||||
|
on desktop, where the process picker (``/system/processes``) is used instead.
|
||||||
|
Sync ``def`` so FastAPI runs the (potentially blocking) bridge call in a
|
||||||
|
thread pool.
|
||||||
|
"""
|
||||||
|
from ledgrab.core.automations import platform_detector as pd
|
||||||
|
|
||||||
|
try:
|
||||||
|
apps = pd.list_installed_apps()
|
||||||
|
items = [InstalledAppItem(package=a["package"], label=a["label"]) for a in apps]
|
||||||
|
return InstalledAppsResponse(apps=items, count=len(items))
|
||||||
|
except Exception as e:
|
||||||
|
logger.error("Failed to list installed apps: %s", e, exc_info=True)
|
||||||
|
raise HTTPException(status_code=500, detail="Internal server error")
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/api/v1/system/info", response_model=SystemInfoResponse, tags=["Info"])
|
||||||
|
def get_system_info(_: AuthRequired):
|
||||||
|
"""Platform capability signal for the automation editor.
|
||||||
|
|
||||||
|
Tells the frontend whether the server is on Android (so the application-rule
|
||||||
|
editor uses the launchable-app picker + package matching and surfaces the
|
||||||
|
Usage-Access banner) vs desktop (process picker + process names), and whether
|
||||||
|
Usage Access is currently granted. Sync ``def`` so the bridge call runs in a
|
||||||
|
thread pool.
|
||||||
|
"""
|
||||||
|
from ledgrab.core.automations import platform_detector as pd
|
||||||
|
from ledgrab.utils.platform import is_android
|
||||||
|
|
||||||
|
android = is_android()
|
||||||
|
return SystemInfoResponse(
|
||||||
|
is_android=android,
|
||||||
|
app_match_kind="package" if android else "process",
|
||||||
|
usage_access_granted=(pd.has_usage_access() if android else True),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
@router.get(
|
@router.get(
|
||||||
"/api/v1/system/performance",
|
"/api/v1/system/performance",
|
||||||
response_model=PerformanceResponse,
|
response_model=PerformanceResponse,
|
||||||
@@ -380,22 +429,20 @@ async def get_integrations_status(
|
|||||||
_: AuthRequired,
|
_: AuthRequired,
|
||||||
ha_store=Depends(get_ha_store),
|
ha_store=Depends(get_ha_store),
|
||||||
ha_manager=Depends(get_ha_manager),
|
ha_manager=Depends(get_ha_manager),
|
||||||
|
mqtt_manager=Depends(get_mqtt_manager),
|
||||||
):
|
):
|
||||||
"""Return connection status for external integrations (MQTT, Home Assistant).
|
"""Return connection status for external integrations (MQTT, Home Assistant).
|
||||||
|
|
||||||
Used by the dashboard to show connectivity indicators.
|
Used by the dashboard to show connectivity indicators. MQTT is reported
|
||||||
|
per-source since the multi-broker refactor — no more global "MQTT
|
||||||
|
enabled" flag.
|
||||||
"""
|
"""
|
||||||
from ledgrab.core.devices.mqtt_client import get_mqtt_service
|
# MQTT status — one entry per configured source
|
||||||
|
mqtt_items = mqtt_manager.get_all_sources_status()
|
||||||
# MQTT status
|
|
||||||
mqtt_service = get_mqtt_service()
|
|
||||||
mqtt_config = get_config().mqtt
|
|
||||||
mqtt_status = {
|
mqtt_status = {
|
||||||
"enabled": mqtt_config.enabled,
|
"sources": mqtt_items,
|
||||||
"connected": mqtt_service.is_connected if mqtt_service else False,
|
"total": len(mqtt_items),
|
||||||
"broker": (
|
"connected": sum(1 for s in mqtt_items if s.get("connected")),
|
||||||
f"{mqtt_config.broker_host}:{mqtt_config.broker_port}" if mqtt_config.enabled else None
|
|
||||||
),
|
|
||||||
}
|
}
|
||||||
|
|
||||||
# Home Assistant status
|
# Home Assistant status
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
"""System routes: MQTT, external URL, ADB, logs WebSocket, log level.
|
"""System routes: external URL, shutdown action, ADB, logs WebSocket, log level.
|
||||||
|
|
||||||
Extracted from system.py to keep files under 800 lines.
|
Extracted from system.py to keep files under 800 lines.
|
||||||
"""
|
"""
|
||||||
@@ -17,13 +17,10 @@ from ledgrab.api.schemas.system import (
|
|||||||
ExternalUrlResponse,
|
ExternalUrlResponse,
|
||||||
LogLevelRequest,
|
LogLevelRequest,
|
||||||
LogLevelResponse,
|
LogLevelResponse,
|
||||||
MQTTSettingsRequest,
|
|
||||||
MQTTSettingsResponse,
|
|
||||||
ShutdownAction,
|
ShutdownAction,
|
||||||
ShutdownActionRequest,
|
ShutdownActionRequest,
|
||||||
ShutdownActionResponse,
|
ShutdownActionResponse,
|
||||||
)
|
)
|
||||||
from ledgrab.config import get_config
|
|
||||||
from ledgrab.storage.database import Database
|
from ledgrab.storage.database import Database
|
||||||
from ledgrab.utils import get_logger
|
from ledgrab.utils import get_logger
|
||||||
|
|
||||||
@@ -32,85 +29,6 @@ logger = get_logger(__name__)
|
|||||||
router = APIRouter()
|
router = APIRouter()
|
||||||
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
# MQTT settings
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
def _load_mqtt_settings(db: Database) -> dict:
|
|
||||||
"""Load MQTT settings: YAML config defaults overridden by DB settings."""
|
|
||||||
cfg = get_config()
|
|
||||||
defaults = {
|
|
||||||
"enabled": cfg.mqtt.enabled,
|
|
||||||
"broker_host": cfg.mqtt.broker_host,
|
|
||||||
"broker_port": cfg.mqtt.broker_port,
|
|
||||||
"username": cfg.mqtt.username,
|
|
||||||
"password": cfg.mqtt.password,
|
|
||||||
"client_id": cfg.mqtt.client_id,
|
|
||||||
"base_topic": cfg.mqtt.base_topic,
|
|
||||||
}
|
|
||||||
overrides = db.get_setting("mqtt")
|
|
||||||
if overrides:
|
|
||||||
defaults.update(overrides)
|
|
||||||
return defaults
|
|
||||||
|
|
||||||
|
|
||||||
@router.get(
|
|
||||||
"/api/v1/system/mqtt/settings",
|
|
||||||
response_model=MQTTSettingsResponse,
|
|
||||||
tags=["System"],
|
|
||||||
)
|
|
||||||
async def get_mqtt_settings(_: AuthRequired, db: Database = Depends(get_database)):
|
|
||||||
"""Get current MQTT broker settings. Password is masked."""
|
|
||||||
s = _load_mqtt_settings(db)
|
|
||||||
return MQTTSettingsResponse(
|
|
||||||
enabled=s["enabled"],
|
|
||||||
broker_host=s["broker_host"],
|
|
||||||
broker_port=s["broker_port"],
|
|
||||||
username=s["username"],
|
|
||||||
password_set=bool(s.get("password")),
|
|
||||||
client_id=s["client_id"],
|
|
||||||
base_topic=s["base_topic"],
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
@router.put(
|
|
||||||
"/api/v1/system/mqtt/settings",
|
|
||||||
response_model=MQTTSettingsResponse,
|
|
||||||
tags=["System"],
|
|
||||||
)
|
|
||||||
async def update_mqtt_settings(
|
|
||||||
_: AuthRequired, body: MQTTSettingsRequest, db: Database = Depends(get_database)
|
|
||||||
):
|
|
||||||
"""Update MQTT broker settings. If password is empty string, the existing password is preserved."""
|
|
||||||
current = _load_mqtt_settings(db)
|
|
||||||
|
|
||||||
# If caller sends an empty password, keep the existing one
|
|
||||||
password = body.password if body.password else current.get("password", "")
|
|
||||||
|
|
||||||
new_settings = {
|
|
||||||
"enabled": body.enabled,
|
|
||||||
"broker_host": body.broker_host,
|
|
||||||
"broker_port": body.broker_port,
|
|
||||||
"username": body.username,
|
|
||||||
"password": password,
|
|
||||||
"client_id": body.client_id,
|
|
||||||
"base_topic": body.base_topic,
|
|
||||||
}
|
|
||||||
db.set_setting("mqtt", new_settings)
|
|
||||||
logger.info("MQTT settings updated")
|
|
||||||
|
|
||||||
return MQTTSettingsResponse(
|
|
||||||
enabled=new_settings["enabled"],
|
|
||||||
broker_host=new_settings["broker_host"],
|
|
||||||
broker_port=new_settings["broker_port"],
|
|
||||||
username=new_settings["username"],
|
|
||||||
password_set=bool(new_settings["password"]),
|
|
||||||
client_id=new_settings["client_id"],
|
|
||||||
base_topic=new_settings["base_topic"],
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
# External URL setting
|
# External URL setting
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
|
|||||||
@@ -45,6 +45,21 @@ logger = get_logger(__name__)
|
|||||||
router = APIRouter()
|
router = APIRouter()
|
||||||
|
|
||||||
|
|
||||||
|
def _template_to_response(t) -> TemplateResponse:
|
||||||
|
return TemplateResponse(
|
||||||
|
id=t.id,
|
||||||
|
name=t.name,
|
||||||
|
engine_type=t.engine_type,
|
||||||
|
engine_config=t.engine_config,
|
||||||
|
tags=t.tags,
|
||||||
|
created_at=t.created_at,
|
||||||
|
updated_at=t.updated_at,
|
||||||
|
description=t.description,
|
||||||
|
icon=getattr(t, "icon", "") or "",
|
||||||
|
icon_color=getattr(t, "icon_color", "") or "",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
# ===== CAPTURE TEMPLATE ENDPOINTS =====
|
# ===== CAPTURE TEMPLATE ENDPOINTS =====
|
||||||
|
|
||||||
|
|
||||||
@@ -57,19 +72,7 @@ async def list_templates(
|
|||||||
try:
|
try:
|
||||||
templates = template_store.get_all_templates()
|
templates = template_store.get_all_templates()
|
||||||
|
|
||||||
template_responses = [
|
template_responses = [_template_to_response(t) for t in templates]
|
||||||
TemplateResponse(
|
|
||||||
id=t.id,
|
|
||||||
name=t.name,
|
|
||||||
engine_type=t.engine_type,
|
|
||||||
engine_config=t.engine_config,
|
|
||||||
tags=t.tags,
|
|
||||||
created_at=t.created_at,
|
|
||||||
updated_at=t.updated_at,
|
|
||||||
description=t.description,
|
|
||||||
)
|
|
||||||
for t in templates
|
|
||||||
]
|
|
||||||
|
|
||||||
return TemplateListResponse(
|
return TemplateListResponse(
|
||||||
templates=template_responses,
|
templates=template_responses,
|
||||||
@@ -100,19 +103,12 @@ async def create_template(
|
|||||||
engine_config=template_data.engine_config,
|
engine_config=template_data.engine_config,
|
||||||
description=template_data.description,
|
description=template_data.description,
|
||||||
tags=template_data.tags,
|
tags=template_data.tags,
|
||||||
|
icon=template_data.icon,
|
||||||
|
icon_color=template_data.icon_color,
|
||||||
)
|
)
|
||||||
|
|
||||||
fire_entity_event("capture_template", "created", template.id)
|
fire_entity_event("capture_template", "created", template.id)
|
||||||
return TemplateResponse(
|
return _template_to_response(template)
|
||||||
id=template.id,
|
|
||||||
name=template.name,
|
|
||||||
engine_type=template.engine_type,
|
|
||||||
engine_config=template.engine_config,
|
|
||||||
tags=template.tags,
|
|
||||||
created_at=template.created_at,
|
|
||||||
updated_at=template.updated_at,
|
|
||||||
description=template.description,
|
|
||||||
)
|
|
||||||
|
|
||||||
except EntityNotFoundError as e:
|
except EntityNotFoundError as e:
|
||||||
raise HTTPException(status_code=404, detail=str(e))
|
raise HTTPException(status_code=404, detail=str(e))
|
||||||
@@ -138,16 +134,7 @@ async def get_template(
|
|||||||
except ValueError:
|
except ValueError:
|
||||||
raise HTTPException(status_code=404, detail=f"Template {template_id} not found")
|
raise HTTPException(status_code=404, detail=f"Template {template_id} not found")
|
||||||
|
|
||||||
return TemplateResponse(
|
return _template_to_response(template)
|
||||||
id=template.id,
|
|
||||||
name=template.name,
|
|
||||||
engine_type=template.engine_type,
|
|
||||||
engine_config=template.engine_config,
|
|
||||||
tags=template.tags,
|
|
||||||
created_at=template.created_at,
|
|
||||||
updated_at=template.updated_at,
|
|
||||||
description=template.description,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
@router.put(
|
@router.put(
|
||||||
@@ -168,19 +155,12 @@ async def update_template(
|
|||||||
engine_config=update_data.engine_config,
|
engine_config=update_data.engine_config,
|
||||||
description=update_data.description,
|
description=update_data.description,
|
||||||
tags=update_data.tags,
|
tags=update_data.tags,
|
||||||
|
icon=update_data.icon,
|
||||||
|
icon_color=update_data.icon_color,
|
||||||
)
|
)
|
||||||
|
|
||||||
fire_entity_event("capture_template", "updated", template_id)
|
fire_entity_event("capture_template", "updated", template_id)
|
||||||
return TemplateResponse(
|
return _template_to_response(template)
|
||||||
id=template.id,
|
|
||||||
name=template.name,
|
|
||||||
engine_type=template.engine_type,
|
|
||||||
engine_config=template.engine_config,
|
|
||||||
tags=template.tags,
|
|
||||||
created_at=template.created_at,
|
|
||||||
updated_at=template.updated_at,
|
|
||||||
description=template.description,
|
|
||||||
)
|
|
||||||
|
|
||||||
except EntityNotFoundError as e:
|
except EntityNotFoundError as e:
|
||||||
raise HTTPException(status_code=404, detail=str(e))
|
raise HTTPException(status_code=404, detail=str(e))
|
||||||
@@ -255,6 +235,7 @@ async def list_engines(_auth: AuthRequired):
|
|||||||
type=engine_type,
|
type=engine_type,
|
||||||
name=engine_type.upper(),
|
name=engine_type.upper(),
|
||||||
default_config=engine_class.get_default_config(),
|
default_config=engine_class.get_default_config(),
|
||||||
|
config_choices=engine_class.get_config_choices(),
|
||||||
available=(engine_type in available_set),
|
available=(engine_type in available_set),
|
||||||
has_own_displays=getattr(engine_class, "HAS_OWN_DISPLAYS", False),
|
has_own_displays=getattr(engine_class, "HAS_OWN_DISPLAYS", False),
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -1,9 +1,10 @@
|
|||||||
"""Value source routes: CRUD for value sources."""
|
"""Value source routes: CRUD for value sources."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
from typing import Annotated, Optional
|
from typing import Annotated
|
||||||
|
|
||||||
from fastapi import APIRouter, Body, Depends, HTTPException, Query, WebSocket, WebSocketDisconnect
|
from fastapi import APIRouter, Body, Depends, HTTPException, Query, WebSocket, WebSocketDisconnect
|
||||||
|
from pydantic import BaseModel, Field
|
||||||
|
|
||||||
from ledgrab.api.auth import AuthRequired
|
from ledgrab.api.auth import AuthRequired
|
||||||
from ledgrab.api.dependencies import (
|
from ledgrab.api.dependencies import (
|
||||||
@@ -23,9 +24,12 @@ from ledgrab.api.schemas.value_sources import (
|
|||||||
DaylightValueSourceResponse,
|
DaylightValueSourceResponse,
|
||||||
GradientMapValueSourceResponse,
|
GradientMapValueSourceResponse,
|
||||||
HAEntityValueSourceResponse,
|
HAEntityValueSourceResponse,
|
||||||
|
HTTPValueSourceResponse,
|
||||||
StaticColorValueSourceResponse,
|
StaticColorValueSourceResponse,
|
||||||
StaticValueSourceResponse,
|
StaticValueSourceResponse,
|
||||||
SystemMetricsValueSourceResponse,
|
SystemMetricsValueSourceResponse,
|
||||||
|
TemplateInput,
|
||||||
|
TemplateValueSourceResponse,
|
||||||
ValueSourceCreate,
|
ValueSourceCreate,
|
||||||
ValueSourceListResponse,
|
ValueSourceListResponse,
|
||||||
ValueSourceResponse,
|
ValueSourceResponse,
|
||||||
@@ -41,9 +45,11 @@ from ledgrab.storage.value_source import (
|
|||||||
DaylightValueSource,
|
DaylightValueSource,
|
||||||
GradientMapValueSource,
|
GradientMapValueSource,
|
||||||
HAEntityValueSource,
|
HAEntityValueSource,
|
||||||
|
HTTPValueSource,
|
||||||
StaticColorValueSource,
|
StaticColorValueSource,
|
||||||
StaticValueSource,
|
StaticValueSource,
|
||||||
SystemMetricsValueSource,
|
SystemMetricsValueSource,
|
||||||
|
TemplateValueSource,
|
||||||
ValueSource,
|
ValueSource,
|
||||||
)
|
)
|
||||||
from ledgrab.storage.value_source_store import ValueSourceStore
|
from ledgrab.storage.value_source_store import ValueSourceStore
|
||||||
@@ -64,6 +70,8 @@ _RESPONSE_MAP = {
|
|||||||
name=s.name,
|
name=s.name,
|
||||||
description=s.description,
|
description=s.description,
|
||||||
tags=s.tags,
|
tags=s.tags,
|
||||||
|
icon=getattr(s, "icon", "") or "",
|
||||||
|
icon_color=getattr(s, "icon_color", "") or "",
|
||||||
created_at=s.created_at,
|
created_at=s.created_at,
|
||||||
updated_at=s.updated_at,
|
updated_at=s.updated_at,
|
||||||
value=s.value,
|
value=s.value,
|
||||||
@@ -73,6 +81,8 @@ _RESPONSE_MAP = {
|
|||||||
name=s.name,
|
name=s.name,
|
||||||
description=s.description,
|
description=s.description,
|
||||||
tags=s.tags,
|
tags=s.tags,
|
||||||
|
icon=getattr(s, "icon", "") or "",
|
||||||
|
icon_color=getattr(s, "icon_color", "") or "",
|
||||||
created_at=s.created_at,
|
created_at=s.created_at,
|
||||||
updated_at=s.updated_at,
|
updated_at=s.updated_at,
|
||||||
waveform=s.waveform,
|
waveform=s.waveform,
|
||||||
@@ -85,6 +95,8 @@ _RESPONSE_MAP = {
|
|||||||
name=s.name,
|
name=s.name,
|
||||||
description=s.description,
|
description=s.description,
|
||||||
tags=s.tags,
|
tags=s.tags,
|
||||||
|
icon=getattr(s, "icon", "") or "",
|
||||||
|
icon_color=getattr(s, "icon_color", "") or "",
|
||||||
created_at=s.created_at,
|
created_at=s.created_at,
|
||||||
updated_at=s.updated_at,
|
updated_at=s.updated_at,
|
||||||
audio_source_id=s.audio_source_id,
|
audio_source_id=s.audio_source_id,
|
||||||
@@ -100,11 +112,14 @@ _RESPONSE_MAP = {
|
|||||||
name=s.name,
|
name=s.name,
|
||||||
description=s.description,
|
description=s.description,
|
||||||
tags=s.tags,
|
tags=s.tags,
|
||||||
|
icon=getattr(s, "icon", "") or "",
|
||||||
|
icon_color=getattr(s, "icon_color", "") or "",
|
||||||
created_at=s.created_at,
|
created_at=s.created_at,
|
||||||
updated_at=s.updated_at,
|
updated_at=s.updated_at,
|
||||||
speed=s.speed,
|
speed=s.speed,
|
||||||
use_real_time=s.use_real_time,
|
use_real_time=s.use_real_time,
|
||||||
latitude=s.latitude,
|
latitude=s.latitude,
|
||||||
|
longitude=s.longitude,
|
||||||
min_value=s.min_value,
|
min_value=s.min_value,
|
||||||
max_value=s.max_value,
|
max_value=s.max_value,
|
||||||
),
|
),
|
||||||
@@ -113,6 +128,8 @@ _RESPONSE_MAP = {
|
|||||||
name=s.name,
|
name=s.name,
|
||||||
description=s.description,
|
description=s.description,
|
||||||
tags=s.tags,
|
tags=s.tags,
|
||||||
|
icon=getattr(s, "icon", "") or "",
|
||||||
|
icon_color=getattr(s, "icon_color", "") or "",
|
||||||
created_at=s.created_at,
|
created_at=s.created_at,
|
||||||
updated_at=s.updated_at,
|
updated_at=s.updated_at,
|
||||||
color=list(s.color),
|
color=list(s.color),
|
||||||
@@ -122,17 +139,22 @@ _RESPONSE_MAP = {
|
|||||||
name=s.name,
|
name=s.name,
|
||||||
description=s.description,
|
description=s.description,
|
||||||
tags=s.tags,
|
tags=s.tags,
|
||||||
|
icon=getattr(s, "icon", "") or "",
|
||||||
|
icon_color=getattr(s, "icon_color", "") or "",
|
||||||
created_at=s.created_at,
|
created_at=s.created_at,
|
||||||
updated_at=s.updated_at,
|
updated_at=s.updated_at,
|
||||||
colors=[list(c) for c in s.colors],
|
colors=[list(c) for c in s.colors],
|
||||||
speed=s.speed,
|
speed=s.speed,
|
||||||
easing=s.easing,
|
easing=s.easing,
|
||||||
|
clock_id=s.clock_id,
|
||||||
),
|
),
|
||||||
AdaptiveTimeColorValueSource: lambda s: AdaptiveTimeColorValueSourceResponse(
|
AdaptiveTimeColorValueSource: lambda s: AdaptiveTimeColorValueSourceResponse(
|
||||||
id=s.id,
|
id=s.id,
|
||||||
name=s.name,
|
name=s.name,
|
||||||
description=s.description,
|
description=s.description,
|
||||||
tags=s.tags,
|
tags=s.tags,
|
||||||
|
icon=getattr(s, "icon", "") or "",
|
||||||
|
icon_color=getattr(s, "icon_color", "") or "",
|
||||||
created_at=s.created_at,
|
created_at=s.created_at,
|
||||||
updated_at=s.updated_at,
|
updated_at=s.updated_at,
|
||||||
schedule=s.schedule,
|
schedule=s.schedule,
|
||||||
@@ -142,6 +164,8 @@ _RESPONSE_MAP = {
|
|||||||
name=s.name,
|
name=s.name,
|
||||||
description=s.description,
|
description=s.description,
|
||||||
tags=s.tags,
|
tags=s.tags,
|
||||||
|
icon=getattr(s, "icon", "") or "",
|
||||||
|
icon_color=getattr(s, "icon_color", "") or "",
|
||||||
created_at=s.created_at,
|
created_at=s.created_at,
|
||||||
updated_at=s.updated_at,
|
updated_at=s.updated_at,
|
||||||
ha_source_id=s.ha_source_id,
|
ha_source_id=s.ha_source_id,
|
||||||
@@ -150,12 +174,15 @@ _RESPONSE_MAP = {
|
|||||||
min_ha_value=s.min_ha_value,
|
min_ha_value=s.min_ha_value,
|
||||||
max_ha_value=s.max_ha_value,
|
max_ha_value=s.max_ha_value,
|
||||||
smoothing=s.smoothing,
|
smoothing=s.smoothing,
|
||||||
|
normalize=s.normalize,
|
||||||
),
|
),
|
||||||
GradientMapValueSource: lambda s: GradientMapValueSourceResponse(
|
GradientMapValueSource: lambda s: GradientMapValueSourceResponse(
|
||||||
id=s.id,
|
id=s.id,
|
||||||
name=s.name,
|
name=s.name,
|
||||||
description=s.description,
|
description=s.description,
|
||||||
tags=s.tags,
|
tags=s.tags,
|
||||||
|
icon=getattr(s, "icon", "") or "",
|
||||||
|
icon_color=getattr(s, "icon_color", "") or "",
|
||||||
created_at=s.created_at,
|
created_at=s.created_at,
|
||||||
updated_at=s.updated_at,
|
updated_at=s.updated_at,
|
||||||
value_source_id=s.value_source_id,
|
value_source_id=s.value_source_id,
|
||||||
@@ -167,6 +194,8 @@ _RESPONSE_MAP = {
|
|||||||
name=s.name,
|
name=s.name,
|
||||||
description=s.description,
|
description=s.description,
|
||||||
tags=s.tags,
|
tags=s.tags,
|
||||||
|
icon=getattr(s, "icon", "") or "",
|
||||||
|
icon_color=getattr(s, "icon_color", "") or "",
|
||||||
created_at=s.created_at,
|
created_at=s.created_at,
|
||||||
updated_at=s.updated_at,
|
updated_at=s.updated_at,
|
||||||
color_strip_source_id=s.color_strip_source_id,
|
color_strip_source_id=s.color_strip_source_id,
|
||||||
@@ -178,6 +207,8 @@ _RESPONSE_MAP = {
|
|||||||
name=s.name,
|
name=s.name,
|
||||||
description=s.description,
|
description=s.description,
|
||||||
tags=s.tags,
|
tags=s.tags,
|
||||||
|
icon=getattr(s, "icon", "") or "",
|
||||||
|
icon_color=getattr(s, "icon_color", "") or "",
|
||||||
created_at=s.created_at,
|
created_at=s.created_at,
|
||||||
updated_at=s.updated_at,
|
updated_at=s.updated_at,
|
||||||
metric=s.metric,
|
metric=s.metric,
|
||||||
@@ -188,6 +219,40 @@ _RESPONSE_MAP = {
|
|||||||
sensor_label=s.sensor_label,
|
sensor_label=s.sensor_label,
|
||||||
poll_interval=s.poll_interval,
|
poll_interval=s.poll_interval,
|
||||||
smoothing=s.smoothing,
|
smoothing=s.smoothing,
|
||||||
|
normalize=s.normalize,
|
||||||
|
),
|
||||||
|
HTTPValueSource: lambda s: HTTPValueSourceResponse(
|
||||||
|
id=s.id,
|
||||||
|
name=s.name,
|
||||||
|
description=s.description,
|
||||||
|
tags=s.tags,
|
||||||
|
icon=getattr(s, "icon", "") or "",
|
||||||
|
icon_color=getattr(s, "icon_color", "") or "",
|
||||||
|
created_at=s.created_at,
|
||||||
|
updated_at=s.updated_at,
|
||||||
|
http_endpoint_id=s.http_endpoint_id,
|
||||||
|
json_path=s.json_path,
|
||||||
|
interval_s=s.interval_s,
|
||||||
|
min_value=s.min_value,
|
||||||
|
max_value=s.max_value,
|
||||||
|
smoothing=s.smoothing,
|
||||||
|
normalize=s.normalize,
|
||||||
|
),
|
||||||
|
TemplateValueSource: lambda s: TemplateValueSourceResponse(
|
||||||
|
id=s.id,
|
||||||
|
name=s.name,
|
||||||
|
description=s.description,
|
||||||
|
tags=s.tags,
|
||||||
|
icon=getattr(s, "icon", "") or "",
|
||||||
|
icon_color=getattr(s, "icon_color", "") or "",
|
||||||
|
created_at=s.created_at,
|
||||||
|
updated_at=s.updated_at,
|
||||||
|
template=s.template,
|
||||||
|
inputs=[
|
||||||
|
TemplateInput(name=i["name"], value_source_id=i["value_source_id"]) for i in s.inputs
|
||||||
|
],
|
||||||
|
default_value=s.default_value,
|
||||||
|
eval_interval=s.eval_interval,
|
||||||
),
|
),
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -202,6 +267,8 @@ def _to_response(source: ValueSource) -> ValueSourceResponse:
|
|||||||
name=source.name,
|
name=source.name,
|
||||||
description=source.description,
|
description=source.description,
|
||||||
tags=source.tags,
|
tags=source.tags,
|
||||||
|
icon=getattr(source, "icon", "") or "",
|
||||||
|
icon_color=getattr(source, "icon_color", "") or "",
|
||||||
created_at=source.created_at,
|
created_at=source.created_at,
|
||||||
updated_at=source.updated_at,
|
updated_at=source.updated_at,
|
||||||
picture_source_id=source.picture_source_id,
|
picture_source_id=source.picture_source_id,
|
||||||
@@ -216,6 +283,8 @@ def _to_response(source: ValueSource) -> ValueSourceResponse:
|
|||||||
name=source.name,
|
name=source.name,
|
||||||
description=source.description,
|
description=source.description,
|
||||||
tags=source.tags,
|
tags=source.tags,
|
||||||
|
icon=getattr(source, "icon", "") or "",
|
||||||
|
icon_color=getattr(source, "icon_color", "") or "",
|
||||||
created_at=source.created_at,
|
created_at=source.created_at,
|
||||||
updated_at=source.updated_at,
|
updated_at=source.updated_at,
|
||||||
schedule=source.schedule,
|
schedule=source.schedule,
|
||||||
@@ -231,6 +300,8 @@ def _to_response(source: ValueSource) -> ValueSourceResponse:
|
|||||||
name=source.name,
|
name=source.name,
|
||||||
description=source.description,
|
description=source.description,
|
||||||
tags=source.tags,
|
tags=source.tags,
|
||||||
|
icon=getattr(source, "icon", "") or "",
|
||||||
|
icon_color=getattr(source, "icon_color", "") or "",
|
||||||
created_at=source.created_at,
|
created_at=source.created_at,
|
||||||
updated_at=source.updated_at,
|
updated_at=source.updated_at,
|
||||||
value=getattr(source, "value", 1.0),
|
value=getattr(source, "value", 1.0),
|
||||||
@@ -241,7 +312,7 @@ def _to_response(source: ValueSource) -> ValueSourceResponse:
|
|||||||
@router.get("/api/v1/value-sources", response_model=ValueSourceListResponse, tags=["Value Sources"])
|
@router.get("/api/v1/value-sources", response_model=ValueSourceListResponse, tags=["Value Sources"])
|
||||||
async def list_value_sources(
|
async def list_value_sources(
|
||||||
_auth: AuthRequired,
|
_auth: AuthRequired,
|
||||||
source_type: Optional[str] = Query(
|
source_type: str | None = Query(
|
||||||
None,
|
None,
|
||||||
description="Filter by source_type: static, animated, audio, adaptive_time, or adaptive_scene",
|
description="Filter by source_type: static, animated, audio, adaptive_time, or adaptive_scene",
|
||||||
),
|
),
|
||||||
@@ -347,6 +418,13 @@ async def delete_value_source(
|
|||||||
if getattr(target, "brightness_value_source_id", "") == source_id:
|
if getattr(target, "brightness_value_source_id", "") == source_id:
|
||||||
raise ValueError(f"Cannot delete: referenced by target '{target.name}'")
|
raise ValueError(f"Cannot delete: referenced by target '{target.name}'")
|
||||||
|
|
||||||
|
# Check if any other value source (template / gradient_map) references it.
|
||||||
|
referencing = store.find_referencing_sources(source_id)
|
||||||
|
if referencing:
|
||||||
|
raise ValueError(
|
||||||
|
"Cannot delete: referenced by value source(s) " + ", ".join(referencing)
|
||||||
|
)
|
||||||
|
|
||||||
store.delete_source(source_id)
|
store.delete_source(source_id)
|
||||||
fire_entity_event("value_source", "deleted", source_id)
|
fire_entity_event("value_source", "deleted", source_id)
|
||||||
except EntityNotFoundError as e:
|
except EntityNotFoundError as e:
|
||||||
@@ -356,6 +434,121 @@ async def delete_value_source(
|
|||||||
raise HTTPException(status_code=400, detail=str(e))
|
raise HTTPException(status_code=400, detail=str(e))
|
||||||
|
|
||||||
|
|
||||||
|
class ValidateTemplateRequest(BaseModel):
|
||||||
|
"""Request body for the advisory template-validation endpoint."""
|
||||||
|
|
||||||
|
template: str = Field(description="Jinja2 expression to validate", max_length=2000)
|
||||||
|
inputs: list[TemplateInput] = Field(default_factory=list, description="Named input bindings")
|
||||||
|
id: str | None = Field(None, description="Source id when editing (enables cycle detection)")
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/api/v1/value-sources/validate-template", tags=["Value Sources"])
|
||||||
|
async def validate_template_value_source(
|
||||||
|
payload: ValidateTemplateRequest,
|
||||||
|
_auth: AuthRequired,
|
||||||
|
store: ValueSourceStore = Depends(get_value_source_store),
|
||||||
|
):
|
||||||
|
"""Validate a template expression + inputs without persisting anything.
|
||||||
|
|
||||||
|
Advisory: always returns HTTP 200 with ``{valid, error, errors, warnings,
|
||||||
|
variables}``. Powers the live editor validator (which must run before a
|
||||||
|
source exists), reusing the exact factory/store validation so the client and
|
||||||
|
server can never disagree. ``errors`` are blocking (save disabled);
|
||||||
|
``warnings`` are non-blocking (e.g. unknown/unbound inputs — create is
|
||||||
|
lenient about those).
|
||||||
|
"""
|
||||||
|
from ledgrab.utils.template_expr import (
|
||||||
|
TemplateValidationError,
|
||||||
|
extract_variables,
|
||||||
|
validate_input_name,
|
||||||
|
validate_template_expression,
|
||||||
|
)
|
||||||
|
|
||||||
|
errors: list[str] = []
|
||||||
|
warnings: list[str] = []
|
||||||
|
|
||||||
|
# 1) Expression compiles and is safe (cost-guarded).
|
||||||
|
try:
|
||||||
|
validate_template_expression(payload.template)
|
||||||
|
except TemplateValidationError as e:
|
||||||
|
errors.append(str(e))
|
||||||
|
|
||||||
|
# 2) Input names valid / unique / non-reserved (blocking).
|
||||||
|
seen: set[str] = set()
|
||||||
|
for inp in payload.inputs:
|
||||||
|
try:
|
||||||
|
validate_input_name(inp.name)
|
||||||
|
except TemplateValidationError as e:
|
||||||
|
errors.append(str(e))
|
||||||
|
continue
|
||||||
|
if inp.name in seen:
|
||||||
|
errors.append(f"duplicate input name: {inp.name}")
|
||||||
|
seen.add(inp.name)
|
||||||
|
|
||||||
|
# 3) Referenced sources exist (non-blocking warning — create is lenient).
|
||||||
|
missing = [
|
||||||
|
inp.value_source_id
|
||||||
|
for inp in payload.inputs
|
||||||
|
if inp.value_source_id and not _source_exists(store, inp.value_source_id)
|
||||||
|
]
|
||||||
|
if missing:
|
||||||
|
warnings.append("unknown value source(s): " + ", ".join(sorted(set(missing))))
|
||||||
|
|
||||||
|
# 4) Variables referenced in the expression but not bound to an input
|
||||||
|
# (blocking): at runtime they raise UndefinedError, so the template would
|
||||||
|
# silently always return default_value. This is almost always a typo, so
|
||||||
|
# flag it as an error rather than letting "valid" mislead the user.
|
||||||
|
used = set(extract_variables(payload.template))
|
||||||
|
undeclared = used - seen
|
||||||
|
if undeclared:
|
||||||
|
errors.append("unbound variable(s): " + ", ".join(sorted(undeclared)))
|
||||||
|
|
||||||
|
# 5) Cycle check when editing an existing source (blocking).
|
||||||
|
if payload.id:
|
||||||
|
child_ids = [i.value_source_id for i in payload.inputs if i.value_source_id]
|
||||||
|
try:
|
||||||
|
store.validate_nesting(payload.id, child_ids)
|
||||||
|
except ValueError as e:
|
||||||
|
errors.append(str(e))
|
||||||
|
|
||||||
|
return {
|
||||||
|
"valid": not errors,
|
||||||
|
"error": errors[0] if errors else None,
|
||||||
|
"errors": errors,
|
||||||
|
"warnings": warnings,
|
||||||
|
"variables": extract_variables(payload.template),
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _source_exists(store: ValueSourceStore, source_id: str) -> bool:
|
||||||
|
try:
|
||||||
|
store.get_source(source_id)
|
||||||
|
return True
|
||||||
|
except Exception:
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
# Per-stream (min, max) attribute pairs for the normalization range, so the
|
||||||
|
# preview can show where the raw value maps. Attribute names differ per stream
|
||||||
|
# type (historical), so probe each pair rather than assume one.
|
||||||
|
_RAW_RANGE_ATTRS: tuple[tuple[str, str], ...] = (
|
||||||
|
("_min_ha", "_max_ha"), # HAEntityValueStream
|
||||||
|
("_min_value", "_max_value"), # HTTPValueStream
|
||||||
|
("_min_val", "_max_val"), # SystemMetricsValueStream
|
||||||
|
("_min_game", "_max_game"), # GameEventValueStream
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _stream_raw_range(stream) -> list | None:
|
||||||
|
"""Return ``[min, max]`` for the stream's normalization range, or None."""
|
||||||
|
for lo_attr, hi_attr in _RAW_RANGE_ATTRS:
|
||||||
|
lo = getattr(stream, lo_attr, None)
|
||||||
|
hi = getattr(stream, hi_attr, None)
|
||||||
|
if isinstance(lo, (int, float)) and isinstance(hi, (int, float)):
|
||||||
|
return [lo, hi]
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
# ===== REAL-TIME VALUE SOURCE TEST WEBSOCKET =====
|
# ===== REAL-TIME VALUE SOURCE TEST WEBSOCKET =====
|
||||||
|
|
||||||
|
|
||||||
@@ -419,10 +612,22 @@ async def test_value_source_ws(
|
|||||||
msg["input_value"] = round(stream.get_input_value(), 4)
|
msg["input_value"] = round(stream.get_input_value(), 4)
|
||||||
if hasattr(stream, "get_raw_value"):
|
if hasattr(stream, "get_raw_value"):
|
||||||
raw = stream.get_raw_value()
|
raw = stream.get_raw_value()
|
||||||
if raw is not None:
|
if isinstance(raw, bool):
|
||||||
msg["raw_value"] = round(raw, 4)
|
# bool is a subclass of int — send as-is (don't coerce/round).
|
||||||
if hasattr(stream, "_min_ha"):
|
msg["raw_value"] = raw
|
||||||
msg["raw_range"] = [stream._min_ha, stream._max_ha]
|
elif isinstance(raw, (int, float)):
|
||||||
|
msg["raw_value"] = round(float(raw), 4)
|
||||||
|
elif raw is not None:
|
||||||
|
# Non-numeric raw (e.g. an HTTP string payload) — send verbatim
|
||||||
|
# rather than crash the socket on round().
|
||||||
|
msg["raw_value"] = raw
|
||||||
|
rng = _stream_raw_range(stream)
|
||||||
|
if rng is not None:
|
||||||
|
msg["raw_range"] = rng
|
||||||
|
# Tell the client whether this source is currently normalizing, so the
|
||||||
|
# preview can render the value as a fraction vs a clamped passthrough.
|
||||||
|
if hasattr(stream, "_normalize_enabled"):
|
||||||
|
msg["normalized"] = bool(stream._normalize_enabled)
|
||||||
await websocket.send_json(msg)
|
await websocket.send_json(msg)
|
||||||
await asyncio.sleep(0.05)
|
await asyncio.sleep(0.05)
|
||||||
except WebSocketDisconnect:
|
except WebSocketDisconnect:
|
||||||
|
|||||||
@@ -39,6 +39,8 @@ def _to_response(source: WeatherSource) -> WeatherSourceResponse:
|
|||||||
update_interval=d["update_interval"],
|
update_interval=d["update_interval"],
|
||||||
description=d.get("description"),
|
description=d.get("description"),
|
||||||
tags=d.get("tags", []),
|
tags=d.get("tags", []),
|
||||||
|
icon=getattr(source, "icon", "") or "",
|
||||||
|
icon_color=getattr(source, "icon_color", "") or "",
|
||||||
created_at=source.created_at,
|
created_at=source.created_at,
|
||||||
updated_at=source.updated_at,
|
updated_at=source.updated_at,
|
||||||
)
|
)
|
||||||
@@ -79,6 +81,8 @@ async def create_weather_source(
|
|||||||
update_interval=data.update_interval,
|
update_interval=data.update_interval,
|
||||||
description=data.description,
|
description=data.description,
|
||||||
tags=data.tags,
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
)
|
)
|
||||||
except ValueError as e:
|
except ValueError as e:
|
||||||
raise HTTPException(status_code=400, detail=str(e))
|
raise HTTPException(status_code=400, detail=str(e))
|
||||||
@@ -125,6 +129,8 @@ async def update_weather_source(
|
|||||||
update_interval=data.update_interval,
|
update_interval=data.update_interval,
|
||||||
description=data.description,
|
description=data.description,
|
||||||
tags=data.tags,
|
tags=data.tags,
|
||||||
|
icon=data.icon,
|
||||||
|
icon_color=data.icon_color,
|
||||||
)
|
)
|
||||||
except EntityNotFoundError:
|
except EntityNotFoundError:
|
||||||
raise HTTPException(status_code=404, detail=f"Weather source {source_id} not found")
|
raise HTTPException(status_code=404, detail=f"Weather source {source_id} not found")
|
||||||
|
|||||||
@@ -30,6 +30,9 @@ _RATE_WINDOW = 60.0 # seconds
|
|||||||
_rate_hits: dict[str, list[float]] = defaultdict(list)
|
_rate_hits: dict[str, list[float]] = defaultdict(list)
|
||||||
|
|
||||||
|
|
||||||
|
_RATE_HITS_HARD_CAP = 1024
|
||||||
|
|
||||||
|
|
||||||
def _check_rate_limit(client_ip: str) -> None:
|
def _check_rate_limit(client_ip: str) -> None:
|
||||||
"""Raise 429 if *client_ip* exceeded the webhook rate limit."""
|
"""Raise 429 if *client_ip* exceeded the webhook rate limit."""
|
||||||
now = time.time()
|
now = time.time()
|
||||||
@@ -44,11 +47,21 @@ def _check_rate_limit(client_ip: str) -> None:
|
|||||||
)
|
)
|
||||||
_rate_hits[client_ip].append(now)
|
_rate_hits[client_ip].append(now)
|
||||||
|
|
||||||
# Periodic cleanup: remove IPs with no recent hits to prevent unbounded growth
|
# Periodic cleanup: remove IPs with no recent hits to prevent unbounded growth.
|
||||||
if len(_rate_hits) > 100:
|
if len(_rate_hits) > 100:
|
||||||
stale = [ip for ip, ts in _rate_hits.items() if not ts or ts[-1] < window_start]
|
stale = [ip for ip, ts in _rate_hits.items() if not ts or ts[-1] < window_start]
|
||||||
for ip in stale:
|
for ip in stale:
|
||||||
del _rate_hits[ip]
|
del _rate_hits[ip]
|
||||||
|
# Hard cap as a final defence against an attacker spraying many distinct
|
||||||
|
# X-Forwarded-For values to drive memory growth past the soft cleanup
|
||||||
|
# threshold. Drop the oldest-touched IPs (by their latest timestamp).
|
||||||
|
if len(_rate_hits) > _RATE_HITS_HARD_CAP:
|
||||||
|
ordered = sorted(
|
||||||
|
_rate_hits.items(),
|
||||||
|
key=lambda kv: kv[1][-1] if kv[1] else 0.0,
|
||||||
|
)
|
||||||
|
for ip, _ in ordered[: len(ordered) - _RATE_HITS_HARD_CAP]:
|
||||||
|
_rate_hits.pop(ip, None)
|
||||||
|
|
||||||
|
|
||||||
class WebhookPayload(BaseModel):
|
class WebhookPayload(BaseModel):
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Asset schemas (CRUD)."""
|
"""Asset schemas (CRUD)."""
|
||||||
|
|
||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
from typing import List, Optional
|
from typing import List
|
||||||
|
|
||||||
from pydantic import BaseModel, Field
|
from pydantic import BaseModel, Field
|
||||||
|
|
||||||
@@ -9,9 +9,19 @@ from pydantic import BaseModel, Field
|
|||||||
class AssetUpdate(BaseModel):
|
class AssetUpdate(BaseModel):
|
||||||
"""Request to update asset metadata."""
|
"""Request to update asset metadata."""
|
||||||
|
|
||||||
name: Optional[str] = Field(None, min_length=1, max_length=100, description="Display name")
|
name: str | None = Field(None, min_length=1, max_length=100, description="Display name")
|
||||||
description: Optional[str] = Field(None, max_length=500, description="Optional description")
|
description: str | None = Field(None, max_length=500, description="Optional description")
|
||||||
tags: Optional[List[str]] = Field(None, description="User-defined tags")
|
tags: List[str] | None = Field(None, description="User-defined tags")
|
||||||
|
icon: str | None = Field(
|
||||||
|
None,
|
||||||
|
max_length=64,
|
||||||
|
description="Icon id from the curated icon library. Pass empty string to clear.",
|
||||||
|
)
|
||||||
|
icon_color: str | None = Field(
|
||||||
|
None,
|
||||||
|
max_length=32,
|
||||||
|
description="Optional CSS color override for the icon. Empty/null inherits the channel accent.",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
class AssetResponse(BaseModel):
|
class AssetResponse(BaseModel):
|
||||||
@@ -23,9 +33,19 @@ class AssetResponse(BaseModel):
|
|||||||
mime_type: str = Field(description="MIME type")
|
mime_type: str = Field(description="MIME type")
|
||||||
asset_type: str = Field(description="Asset type: sound, image, video, other")
|
asset_type: str = Field(description="Asset type: sound, image, video, other")
|
||||||
size_bytes: int = Field(description="File size in bytes")
|
size_bytes: int = Field(description="File size in bytes")
|
||||||
description: Optional[str] = Field(None, description="Description")
|
description: str | None = Field(None, description="Description")
|
||||||
tags: List[str] = Field(default_factory=list, description="User-defined tags")
|
tags: List[str] = Field(default_factory=list, description="User-defined tags")
|
||||||
prebuilt: bool = Field(False, description="Whether this is a shipped prebuilt asset")
|
prebuilt: bool = Field(False, description="Whether this is a shipped prebuilt asset")
|
||||||
|
icon: str | None = Field(
|
||||||
|
None,
|
||||||
|
max_length=64,
|
||||||
|
description="Icon id from the curated icon library. Pass empty string to clear.",
|
||||||
|
)
|
||||||
|
icon_color: str | None = Field(
|
||||||
|
None,
|
||||||
|
max_length=32,
|
||||||
|
description="Optional CSS color override for the icon. Empty/null inherits the channel accent.",
|
||||||
|
)
|
||||||
created_at: datetime = Field(description="Creation timestamp")
|
created_at: datetime = Field(description="Creation timestamp")
|
||||||
updated_at: datetime = Field(description="Last update timestamp")
|
updated_at: datetime = Field(description="Last update timestamp")
|
||||||
|
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user