docs(demo): self-contained demo scene for README screenshots#54
Merged
Conversation
Add docs/demo/ — a no-personal-data airspace that drives the whole pipeline from curated fixtures so every feature shows up for a screenshot. Watchpoint is the White House (our PII-scrub convention); all aircraft/drones are synthetic offsets from it. serve.py (stdlib) feeds the fixtures over HTTP with a live `now` and a climbing `messages` counter so the message-rate entities read realistic msg/s. config.yaml turns on every feature and names receivers/alerts to match the shipped dashboard (rx-1090 / rx-978 / dump3411, military_close). The scene exercises country flags, military/interesting/emergency flags + alerts, the helicopter map icon, drone + operator + FAA make/model, and spoof_suspect (a 0x00 serial + two drones sharing self_id "Spoofing test", which converges to flag both within a poll). photos + drone_registry are on (one public lookup each, no personal data); README documents the fully-offline alternative. Also add a "Suspected spoofed drones" card to the example dashboard so the spoof-detection feature is visible in the screenshots. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The repo's .gitignore matches every `config.yaml`, so the demo's config was silently skipped by `git add` and never shipped. Add a committed `config.example.yaml` (placeholder mqtt) and document the `cp config.example.yaml config.yaml` step — mirroring the root config convention. This also keeps real broker credentials out of git by construction: the file you put creds in (config.yaml) is ignored. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The example map uses zone.home (the real home zone) as the observer marker — fine for real users, a location leak in demo screenshots. Document replacing it with a fixed White-House watchpoint template sensor. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add docs/demo/ — a no-personal-data airspace that drives the whole pipeline from curated fixtures so every feature shows up for a screenshot. Watchpoint is the White House (our PII-scrub convention); all aircraft/drones are synthetic offsets from it. serve.py (stdlib) feeds the fixtures over HTTP with a live
nowand a climbingmessagescounter so the message-rate entities read realistic msg/s.config.yaml turns on every feature and names receivers/alerts to match the shipped dashboard (rx-1090 / rx-978 / dump3411, military_close). The scene exercises country flags, military/interesting/emergency flags + alerts, the helicopter map icon, drone + operator + FAA make/model, and spoof_suspect (a 0x00 serial + two drones sharing self_id "Spoofing test", which converges to flag both within a poll). photos + drone_registry are on (one public lookup each, no personal data); README documents the fully-offline alternative.
Also add a "Suspected spoofed drones" card to the example dashboard so the spoof-detection feature is visible in the screenshots.