Skip to content

Latest commit

 

History

History
51 lines (38 loc) · 2.3 KB

SPEC.md

File metadata and controls

51 lines (38 loc) · 2.3 KB

FloRo Remote: Technical Specification (index)

Repo: ItsRRM97/floro-ble-controller (GitHub also redirects to rawshn97/floro-ble-controller) · Branch: main
Canonical URL: https://rawshn.com/floro-remote/
Audience: product, developers, and agents

This file is the entrypoint. Shipped contracts live under specs/. Edit the feature file you care about; keep this index short.

Doc Role
SPEC.md (this file) Index + reading order
specs/ Shipped per-feature specs
SPEC_IN_PROGRESS.md Future / not shipped
README.md Setup and BLE command table
DESIGN.md Visual IA, tokens, anti-patterns
docs/PROTOCOL.md Reverse-engineered Neon Attack UART
AGENTS.md Agent bootstrap (no build step, Cloud limits)

Spec map

Spec Feature Path
specs/overview.md Purpose, stack, layout, deploy (repo)
specs/ble.md Web Bluetooth, command queue, reconnect, wire format js/ble.js, js/protocol.js
specs/pwa.md Installable PWA, service worker, install prompt manifest.webmanifest, sw.js, js/pwa-install.js
specs/analytics.md Microsoft Clarity events, filtering js/clarity.js
docs/ble-protocol.schema.json BLE Nordic UART JSON schema js/protocol.js

PM tip: change one feature → edit that one file under specs/. Unshipped ideas → SPEC_IN_PROGRESS.md.


Capabilities (at a glance)

Feature Summary
Sign remote Solid color + 200 animation modes, brightness 1–8, speed, favorites, scene restore
BLE Nordic UART to FloRo / Neon Attack firmware; Chrome/Edge, HTTPS or localhost
PWA Installable at /floro-remote/; native install when the browser offers it
Deploy Static files vendored into rawshn-portfolio public/floro-remote/

Document history

Date Change
2026-09-05 Rebrand to FloRo Remote, modular ES refactor, protocol schema
2026-09-05 Initial spec split (overview, BLE, PWA) plus PWA install reimplementation