discstation 0.1.23 → 0.1.27

package/README.md

@@ -9,12 +9,37 @@ use every mode.
 ## Hardware
 
 - **Brain:** Raspberry Pi 4/5 (or any Linux box)
-- **Remote (optional):** ESP32-C6 with SSD1306 OLED, rotary encoder, and
-  buttons — or none at all; the web UI's on-screen remote covers the same
-  controls when no ESP32 is detected, and steps aside (greyed out,
-  auto-collapsing) the moment one is plugged in
+- **Remote (optional):** ESP32 DevKit or ESP32-C6 with an SSD1306 OLED, 3
+  buttons, and a volume pot — connected by **USB serial** or over **Wi-Fi**
+  (see below) — or none at all; the web UI / mobile app's on-screen remote
+  covers the same controls when no ESP32 is detected, and steps aside
+  (greyed out, auto-collapsing) the moment one appears.
 - **Drive:** ATAPI DVD writer (e.g. iHAS124) over USB
 
+### Wi-Fi remote (optional)
+
+The firmware also serves the same line protocol over TCP 2323, so the
+remote can talk to the host over Wi-Fi instead of a USB cable.
+
+- **Provisioning (no code edit):** on first boot with no stored credentials
+  the remote starts an open `DiscStation-XXXX` access point; join it from a
+  phone, the captive portal (or `http://192.168.4.1`) lists nearby networks
+  — pick yours, enter the password, done. It reconnects on every boot after
+  that. Change networks later: **hold SELECT for 10 s** on the home screen
+  to wipe the credentials and reopen the portal.
+  Power users can instead `cp arduino/<board>/secrets.h.example secrets.h`
+  and set `WIFI_SSID` / `WIFI_PASS` at build time (git-ignored).
+- **Host side:** nothing to configure. With no USB cable present the host
+  finds the remote by mDNS automatically (`discstation-xxxx.local`). Set
+  `DISC_REMOTE_HOST` in `discstation.env` to an explicit IP only if mDNS is
+  blocked on your network, or `off` to never look. A USB cable always wins
+  when both are present.
+- **Trust model:** TCP 2323 is unauthenticated on the LAN, same as the USB
+  link and the LAN web UI — fine for a home appliance. During the ~30 s of
+  portal setup the password crosses an open AP; the ESP32 is 2.4 GHz only
+  (a "connected to the router but no data" symptom usually means a
+  5 GHz-only / band-steering network or a wrong password).
+
 ## Features
 
 | Mode | Description |
@@ -58,10 +83,12 @@ discstation-setup          # dispatches to the installer for your OS, then opens
 
 The host runs as a background service; the UI is the built-in web app at
 `http://localhost:8081`. `discstation-setup` opens it when it finishes, and the
-`discstation` command re-opens it any time. It's a PWA — use your browser's
-**Install DiscStation** (or the in-page **INSTALL APP** button on Chromium) to
-get a standalone app window with a dock/taskbar icon on macOS, Linux, and
-Windows.
+`discstation` command re-opens it any time — both also print the LAN address
+(e.g. `Also reachable at http://192.168.1.50:8081/ ...`) so you know what to
+open from a phone or another computer, or enter into the mobile app. It's a
+PWA — use your browser's **Install DiscStation** (or the in-page
+**INSTALL APP** button on Chromium) to get a standalone app window with a
+dock/taskbar icon on macOS, Linux, and Windows.
 
 `discstation-setup --help` lists the forwarded env vars. From a git clone,
 `npm run setup` does the same thing.
@@ -123,6 +150,14 @@ self-signed cert. On startup the host prints the LAN URL to open
   with no ESP32 attached; greys out and auto-collapses the instant a
   physical remote is detected, so the two never fight for control.
 
+## Mobile App
+
+The `mobile/` Expo app (enter the host's LAN address in its settings screen)
+has the same on-screen remote as the web UI — mode buttons, EJECT/CLOSE,
+disc status, and playback transport, tapped from the "REMOTE" tag next to
+the wordmark. Same auto-collapse behavior when a physical ESP32 shows up,
+same underlying `/remote/button` protocol.
+
 ## Disc Support
 
 - DVD-R, DVD+R (single and dual-layer)