signalk-pypilot-newui 2.12.0 → 3.1.0

package/CHANGELOG.md

@@ -1,5 +1,235 @@
 # Changelog
 
+## 3.1.0 — 2026-10-10 — Fullscreen auto, configurable bottom chip, heading precision, AIS polish
+
+Rolls up Rev439 → Rev449 (11 revs) on top of 3.0.0. Minor bump: a
+family of UX refinements + a couple of safety-oriented fixes;
+backward-compatible with 3.0.0 plugin config and SK paths. The theme
+of the release is **"glance information at a distance"** — the sailor
+mounts the tablet across the cockpit and reads the visor as a true
+instrument, so chip sizes, legibility, precision indicators, and
+fullscreen-by-default all got tightened in this bump.
+
+### Added
+
+- **Fullscreen + Screen Wake Lock auto-on by default** (Rev446/Rev448).
+  On the very first user tap, the visor requests browser fullscreen
+  on `<html>` and takes a `navigator.wakeLock("screen")` so the
+  display never dims nor locks — same UX as YouTube's player. A
+  floating ⛶ button top-right toggles both and persists the sailor's
+  choice (`localStorage[pypilot-newui.fullscreenAuto]`), so later
+  reloads honour "I opted out".
+- **Configurable bottom chip on the rose — up to 4 datapoints
+  cycled** (Rev439 → Rev445). Short-tap on the chip under the compass
+  cycles through the user-picked set (default: SOG → Depth → %Polar);
+  long-press opens a modal where the sailor picks up to 4 datapoints
+  from the same catalog as the four configurable corners (base paths +
+  performance extras + any custom SK path registered in a corner).
+  Persisted in `localStorage[pypilot-newui.roseBottomChipPaths]`.
+  Replaces the old "always AWS/TWS mirror" behaviour.
+- **Heading-precision gauge under the compass readout** (Rev443/Rev444).
+  Second line inside the `#rose-hdg-chip` shows how far off the pilot
+  still is from its own target — the sailor's "glance accuracy
+  reading", not the target value itself. Signed `target - current`:
+  negative = pilot must correct to port (babor), positive = to
+  starboard (estribor). Colour: `|err|<3°` green, `<10°` orange, else
+  red. In compass / gps / nav uses heading − target; in wind / aproado
+  uses AWA − target; in true wind / empopado uses TWA − target.
+  Shows `--` when the AP is OFF (`state.engaged === false`) so a
+  stale `state.target` can never mislead the sailor.
+- **Safe-exit to compass after APROADO / EMPOPADO** (Rev440). When
+  the user finishes an aproado or empopado without opting in to full
+  `restoreAll`, the visor now auto-switches the pilot back to COMPASS
+  with the current heading as target. Rationale: leaving the pilot in
+  WIND / TRUE WIND after the manoeuvre is less stable for "hold what
+  I have now" than COMPASS. Carlos sea-trial 2026-10-10. Falls back
+  to no-op if the heading sensor is absent.
+- **AIS target as a tinted top-view hull sprite** (Rev442 → Rev443,
+  Rev447 → Rev449). Replaces the plain red triangle with the
+  `boat-cenital.svg` sprite (same asset as the own-vessel sprite in
+  the rose centre), tinted via SVG `feColorMatrix` filters per state:
+  red (alarm, blinking, 150 % scale) · orange (warn, fixed, 100 %) ·
+  blue-grey (acked, no blink, 100 %). Bow always points toward the
+  self vessel (rotation now `rotate(relDeg + 90)` to match the
+  horizontal asset). Alarm sprite blinks; acked stays fully visible
+  but muted. Paints as the LAST element inside the rose SVG so it
+  stays on top of wind arrows, sectors and HUDs.
+- **Only the 3 most urgent AIS targets painted** (Rev441). When more
+  than 3 collision alarms are active, only the 3 lowest-TCPA ones
+  render on the rose. The infobox navigator still walks ALL alarms so
+  the sailor can scroll through the hidden ones.
+- **Tap on an AIS target opens its data popup** (Rev441). Click
+  delegation on `#ais-alarm-layer`: tapping a hull sets
+  `_aisInfoboxIdx` to that MMSI and forces the popup open — works for
+  both pending and silenced targets. Auto-resets to the newest threat
+  after 20 s if no further interaction.
+- **ACK keeps the AIS target arrow on the rose** (Rev441 → Rev442).
+  ACK no longer deletes the MMSI from `state.aisAlarms`; the hull
+  stays visible (silenced style) until the plugin declares the
+  threat gone. Button toggles ACK ↔ ACKED (ES: SILENCIAR ↔
+  SILENCIADO), with `disabled` + `.is-acked` styling when the MMSI is
+  already acknowledged.
+- **X close button on the AIS infobox** (Rev442). When the sailor
+  opened the popup by tapping a hull, the X dismisses it and clears
+  the user-pick flag so new threats can take over.
+- **Long "Viento Aparente" / "Viento Real" labels in the mode-selector
+  modal** (Rev441). The modal shows the long names so wind modes are
+  explicit on first open; the bbar button keeps the short labels
+  (APARENTE / REAL) to fit the narrow chip.
+- **Landscape tabbar made compact** (Rev446). `.tab-btn` padding
+  `12→4 px`, font-size `14→12 px` inside
+  `@media (orientation: landscape)`. Saves ~20 vertical pixels for
+  tablets mounted horizontally.
+
+### Changed
+
+- **Heading chip grows UPWARD** (Rev444). The chip rect height
+  expands toward `-y` (bottom edge still at `-84`), so the new
+  precision line never covers the target diamond that sits just
+  below the top of the compass ring.
+- **AWS / TWS sub-line font-size bumped three steps** (Rev443 →
+  Rev445). From `clamp(11, 2vw, 16px)` to `clamp(20, 3.8vw, 32px)`
+  so the kn number sits halfway between the dim corner label and
+  the big angle value when read from the helm.
+- **AIS voice is a short safety nudge, not a report** (Rev441,
+  Rev449). The voice line used to spell CPA / TCPA / MMSI, which TTS
+  mangled on long numbers. Now it just says *"Alarma AIS, target en
+  rumbo de colisión"* / *"AIS alarm, target on collision course"*;
+  the data stays visible in the infobox. ES says "AIS" as a word
+  (Rev449 — was "A I S" letter-by-letter).
+
+### Fixed
+
+- **AIS target bearing was 180° off in some geometries** (Rev448 —
+  found during 2026-10-10 sea trial). `renderAisAlarms` checked
+  `state.position.latitude` but `state.position` carries short keys
+  `{lat, lon}` — the test always failed and the code fell back to
+  `cpaPositions.self` (= *projected* self position at CPA future
+  time). Bearing was then computed between two **future** positions,
+  which can be nowhere near the current geometry. The adapter now
+  converts `{lat, lon}` → `{latitude, longitude}` once at render
+  time, so the hull always paints at the real bearing to the target
+  as-of-now.
+- **Signal K server token kept being asked "every once in a while"**
+  (Rev446). `handleAuthWrite` wiped the permanent device token on
+  the FIRST `401` and kicked off an access-request modal — a single
+  transient 401 (SK restart in flight, proxy hiccup, DNS blip) was
+  enough to invalidate a perfectly good token. Now requires THREE
+  consecutive 401 writes before wiping; one successful write resets
+  the counter.
+- **Precision gauge sign convention** (Rev444). First pass used
+  `heading − target`; Carlos's convention is "the correction the
+  pilot still has to apply" → `target − heading`. Negative therefore
+  means *pilot must go to port* and positive *pilot must go to
+  starboard*.
+
+## 3.0.0 — 2026-10-10 — AIS collision overlay + Freeboard-SK embedded
+
+Rolls up Rev431 through Rev438 (8 revs). The headline feature of 3.0.0
+is an AIS collision overlay on the compass rose and a Freeboard-SK
+chart embedded in the rose box on double-tap. Pypilot-newui is a pure
+CONSUMER of the external
+[`signalk-collision-alerts`](https://github.com/dirkwa/signalk-collision-alerts)
+plugin (by @dirkwa, the maintainer of @signalk/app-dock and
+server-admin-ui) and of the Signal K v2 Notifications API — no
+CPA/TCPA engine lives here. The decision rationale is captured in the
+new memory `feedback_signalk_ecosystem_first.md`: Signal K is a
+cooperative ecosystem; reinventing a well-maintained plugin is
+anti-pattern. See `docs/_feature_ais_overlay.md` for the full
+operator guide + install.
+
+Carlos classified this bump as **major (3.0.0)** at the start of the
+sprint: it adds a new optional external-plugin dependency, changes
+double-tap-on-rose behaviour (was no-op; now opens Freeboard) and
+introduces a user-facing concept — AIS alarms with ACK — that was
+not present in the 2.x line.
+
+### Added
+
+- **AIS collision overlay (Rev431 → Rev438)**. Subscribes to
+  `notifications.navigation.closestApproach.<mmsi>` emitted by
+  `signalk-collision-alerts`. For each active `warn` / `alarm`:
+  - **Red / orange triangle** painted on the compass circle at the
+    bearing from the self vessel to the target *as of now* (not the
+    CPA future projection — Rev436 fetches the target's current
+    position + SOG via `/signalk/v1/api/vessels/<ctx>/...` on each
+    delta with a 30 s cache).
+  - **Infobox** on top of the self boat with level badge
+    (`ALARM` / `WARN`), target name (or "objetivo" when the target
+    has no name yet — MMSI never shown or spoken), CPA · TCPA,
+    closing speed, ACK button, and when > 1 target is active a
+    `N/M` navigator with `‹` / `›`.
+  - **Voice**: short Spanish sentence built from the raw data, not
+    the plugin's English string (which TTS garbled into "ce-pe-a cero
+    coma cero cuatro ene eme"). Example: *"Alarma A I S, PIRATA DE
+    ONS, a 47 metros, ya"*.
+  - **ACK** button sends `POST /signalk/v2/api/notifications/<id>/acknowledge`
+    (so Freeboard + every SK consumer sees it) AND silences the MMSI
+    locally for 10 min — survives the plugin re-publishing the same
+    threat with a fresh UUID.
+  - **"Silenciadas…" modal** (Rev438) lists every locally-silenced
+    MMSI with remaining minutes + per-row *Reactivar* + bulk *Reactivar
+    todas*.
+  - **Stationary filter** (Rev436): targets whose cached SOG < 0.15 kn
+    are dropped from the UI even if the plugin keeps emitting the
+    alarm. Mandatory in a Ría with dozens of moored vessels.
+  - **Overlay-card in Setup → ROSE OVERLAYS**: master on/off, voice
+    sub-toggle, link to the plugin's config page, access to the
+    silenced modal.
+- **Freeboard-SK embedded in the rose box** (Rev432 → Rev433). Double-
+  tap `#wind-rose` opens `/@signalk/freeboard-sk/` as an iframe
+  positioned inside the compass square so the side panels (mode,
+  nudges, AP) stay visible. Chrome row has ⤢ Maximize (full
+  viewport) / ⤡ Restore / × Close. Iframe `src` cleared on close so
+  Freeboard releases its websocket.
+
+### Changed
+
+- No breaking API changes to the pypilot-newui plugin itself —
+  everything existing in 2.12.0 still works identically. The 3.0.0
+  bump reflects the new user-facing concepts (AIS alarms, Freeboard
+  entry point) and the optional external-plugin dependency.
+
+### Fixed
+
+Bugs found and fixed during the AIS sprint, each informed by Carlos's
+QA notes and the real SK bus on Tunatunes:
+- **ACK button did not close the infobox** (Rev436). Was keyed by
+  notification UUID (Rev434); plugin cycles the id while the threat
+  persists → infobox resurrected on the next delta. Now keyed by
+  MMSI with a 10-minute TTL.
+- **Triangle 180° off** (Rev436). Rev431 pointed at
+  `data.cpaPositions.target` which is the *projected* position at the
+  CPA future instant — hence "me avisa babor cuando el target me
+  viene por aleta estribor". Now uses the current self + target
+  positions fetched from the SK REST API.
+- **Multiple alarms, including moored vessels** (Rev436). Added the
+  stationary SOG < 0.15 kn drop filter so a Ría with 30 moored boats
+  doesn't fire false alarms through the plugin's own thresholds.
+- **TTS garble on Freeboard open** (Rev436). Removed the
+  `_alSpeak("abriendo carta")` that the English TTS read as "ICE
+  open chat".
+- **Overlay-card nested checkbox hidden under the master** (Rev437).
+  CSS `.overlay-card input[type=checkbox]` matched every checkbox and
+  stacked them at top-right. Scoped to direct child so the AIS
+  card's "Voice alert" sub-toggle renders in-flow.
+
+### Known limitations / upstream work
+
+- **Upstream `signalk-collision-alerts` issue #17** —
+  https://github.com/dirkwa/signalk-collision-alerts/issues/17 — the
+  admin UI does not render the `Alert sensitivity` / `Level`
+  dropdowns because the plugin's typebox schema emits `anyOf+const`
+  instead of `enum`. We filed the issue with a fix proposal; the
+  workaround is to hand-edit the plugin JSON config or patch the
+  built `config.js` locally. See `docs/_feature_ais_overlay.md`.
+- **Needs sea-trial QA** on real moving traffic with mixed `warn` /
+  `alarm` targets. Default sensible config documented
+  (preset: `harbour`, `maxRange`: 3 NM) for a Ría-style navigation
+  env; switch to `coastal` / `offshore` as needed.
+
+---
+
 ## 2.12.0 — 2026-10-08 — Virtual-tack audit cycle + Profile UX overhaul + safety aproado/empopado
 
 Rolls up Rev410 through Rev430 (21 revs). Driven by two sea trials

package/README.md

@@ -10,9 +10,36 @@ watches how your autopilot is behaving and quietly suggests how to
 sharpen its settings, so you spend more time sailing and less time
 guessing which slider to move.
 
+Since **3.0.0** the visor also ships with an **integrated
+chartplotter**: double-tap the compass rose and
+[Freeboard-SK](https://www.npmjs.com/package/@signalk/freeboard-sk)
+opens embedded inside the rose box with every AIS target, your route
+and all overlays — side panels (mode, nudges, AP) stay reachable, no
+tab switching, no re-authentication. **For charts to render you need a
+Signal K chart provider installed and configured in Freeboard-SK**
+(see [Chart provider is required](#chart-provider-is-required-for-the-embedded-plotter)
+below).
+
 Runs alongside [`pypilot-autopilot-provider`](https://www.npmjs.com/package/pypilot-autopilot-provider)
 by Panaaj — see [Working alongside pypilot-autopilot-provider](#working-alongside-pypilot-autopilot-provider).
 
+## Chart provider is required for the embedded plotter
+
+The chartplotter embedded in the rose uses Freeboard-SK, which itself
+is only a renderer — it needs a Signal K **chart provider** plugin to
+know where to fetch tiles from. Any of the standard providers works:
+
+- **[`@signalk/charts-plugin`](https://www.npmjs.com/package/@signalk/charts-plugin)**
+  — serves local MBTiles / S57 / XYZ chart sets you drop into
+  `~/.signalk/charts/` (OpenCPN-style). Recommended default.
+- **[`signalk-chart-tiler`](https://www.npmjs.com/package/signalk-chart-tiler)**
+  or any other upstream raster/vector provider.
+
+Without a provider, Freeboard-SK will open embedded in the rose but
+the map area will stay empty. Install one from the SK App Store, add
+your chart sources, and the chartplotter inside pypilot-newui lights
+up automatically.
+
 ## Screenshots
 
 ![Control - compass rose with concentric target + wind arrows](https://raw.githubusercontent.com/Aitonos/signalk-pypilot-newui/main/public/screenshots/01-control-rose.jpg)
@@ -235,6 +262,40 @@ pypilot version, restart pypilot_web).
 
 **Webapp URL**: `http://<sk-host>:3000/signalk-pypilot-newui/`
 
+## Works well with
+
+Pypilot-newui is built as a well-behaved citizen of the Signal K
+ecosystem — it consumes other mature plugins and standard APIs instead
+of reinventing them. The sections below describe the plugins we
+integrate with; none are hard dependencies (the autopilot visor works
+on its own), but installing them unlocks the features listed.
+
+- **[`@signalk/freeboard-sk`](https://www.npmjs.com/package/@signalk/freeboard-sk)**
+  — Double-tap the compass rose to open Freeboard-SK embedded inside
+  the rose box (side panels stay visible and usable). Lets you drop
+  from the autopilot view to the full chart with every AIS target in
+  one tap, without leaving the pypilot-newui session. **Pair with a
+  Signal K chart provider (e.g. `@signalk/charts-plugin`) or the chart
+  area will stay empty** — see
+  [Chart provider is required](#chart-provider-is-required-for-the-embedded-plotter).
+  See `docs/_feature_ais_overlay.md`.
+
+- **[`signalk-collision-alerts`](https://www.npmjs.com/package/signalk-collision-alerts)**
+  by @dirkwa — Provides the CPA/TCPA engine behind our AIS collision
+  overlay. Pypilot-newui subscribes to
+  `notifications.navigation.closestApproach.*` and renders a red /
+  orange triangle on the rose + an infobox with ACK that routes
+  through the Signal K v2 Notifications API, so an ACK from
+  pypilot-newui is also seen by Freeboard-SK and every other SK
+  client.
+  See `docs/_feature_ais_overlay.md`.
+
+- **[`pypilot-autopilot-provider`](https://www.npmjs.com/package/pypilot-autopilot-provider)**
+  by Panaaj — Shares the single pypilot socket cleanly with our
+  autopilot provider (see next section) so KIP, Freeboard's Autopilot
+  Console and any other SK v2 Autopilot API client all drive the same
+  pilot without duplicate connections.
+
 ## Working alongside `pypilot-autopilot-provider`
 
 We build on top of the excellent

package/dist/index.js

@@ -28,7 +28,7 @@ const trip_recorder_1 = require("./trip-recorder");
 const maneuver_trace_1 = require("./maneuver-trace");
 // Rev counter bumped on every build so the user can distinguish deploys
 // from the webapp header (feedback_revision_bump_each_build).
-const PLUGIN_REVISION = "Rev430";
+const PLUGIN_REVISION = "Rev449";
 // Rev59: read package.json once at load time so /status can report the
 // npm package version alongside the internal Rev counter.
 // eslint-disable-next-line @typescript-eslint/no-require-imports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "signalk-pypilot-newui",
-  "version": "2.12.0",
+  "version": "3.1.0",
   "description": "Signal K friendly UI for the pypilot autopilot, with first-class Signal K paths and Simple Switches so any downstream Signal K client can drive or monitor the pilot. Touch-first mobile visor + full pypilot data (servo, gains, calibration, tack, warnings). Coexists with pypilot-autopilot-provider.",
   "main": "./dist/index.js",
   "scripts": {
@@ -15,12 +15,19 @@
     "signalk-webapp",
     "signalk-category-instruments",
     "signalk-category-utility",
+    "signalk-category-ais",
+    "signalk-category-notifications",
     "pypilot",
     "tinypilot",
     "autopilot",
     "steering",
     "kip",
-    "mobile-first"
+    "mobile-first",
+    "ais",
+    "cpa",
+    "tcpa",
+    "collision-avoidance",
+    "freeboard-sk-companion"
   ],
   "author": {
     "name": "Aitonos",