signalk-chiplog 2.6.0 → 2.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (17) hide show
  1. package/CHANGELOG.md +33 -1
  2. package/README.md +63 -49
  3. package/index.js +110 -27
  4. package/lib/database.js +54 -1
  5. package/lib/detection.js +4 -16
  6. package/lib/event-watcher.js +142 -2
  7. package/lib/events.js +2 -1
  8. package/lib/history-api.js +401 -0
  9. package/lib/history-series.js +138 -0
  10. package/lib/influx-history.js +27 -102
  11. package/lib/replay-job.js +48 -26
  12. package/package.json +4 -1
  13. package/public/js/animation/boat-model.mjs +534 -171
  14. package/public/js/animation/camera3d.mjs +5 -2
  15. package/public/js/i18n.mjs +8 -4
  16. package/public/js/log-lines.mjs +5 -0
  17. package/public/vendor/three.min.mjs +172 -172
package/CHANGELOG.md CHANGED
@@ -6,6 +6,37 @@ All notable changes to Chiplog are documented here. The format follows
6
6
 
7
7
  ## [Unreleased]
8
8
 
9
+ ## [2.7.0] - 2026-09-22
10
+
11
+ ### Added
12
+
13
+ - **Heading changes are logged automatically.** A turn of 30° or more (configurable), held steady for a minute above 2
14
+ knots, is added to the timeline as the average heading it settled on. Can be turned off in settings.
15
+
16
+ - **The retrospective analysis can read the Signal K History API.** Instead of connecting to an InfluxDB 1.x database
17
+ itself, Chiplog can now read whichever history provider the server has registered — signalk-to-influxdb2, QuestDB,
18
+ TimescaleDB — with no database credentials to set. Pick it with **History source** in the settings; InfluxDB 1.x stays
19
+ the default, so an existing installation is untouched.
20
+ - **Engine and sail segments are reconstructed from an InfluxDB 1.x history too.** The retrospective analysis read the
21
+ engine RPMs but never listed the boat's engines, so a reconstructed passage carried no propulsion segment and no
22
+ engine hours.
23
+
24
+ ### Changed
25
+
26
+ - **The 3D animation starts on the medium boat size.** The 3D view opened with the smallest of the three; it now opens
27
+ on the middle one, where the boat is large enough to be read. **Boat size** still offers all three.
28
+
29
+ - **The 3D animation's boat is drawn as a cartoon.** The generated sailboat has been rebuilt: a fuller hull with a
30
+ proper sheer and overhangs, a planked deck with a covering board, a coachroof with portholes, a cockpit with a crew on
31
+ the weather rail, a roached mainsail with a stripe and a burgee at the masthead — all in flat colours with an inked
32
+ silhouette, so it still reads when the boat is only a hundred pixels long. Nothing changes for a crew who load their
33
+ own `.glb`.
34
+
35
+ - **`navigation.state` is followed whatever its source.** Chiplog no longer prefers signalk-autostate's value over
36
+ another source of the same path: it uses the one Signal K resolves the path to. On a boat where the AIS transponder
37
+ and signalk-autostate both publish it, which one wins is settled in the server's source priorities — that is also
38
+ where a transponder left at "under way using engine" while moored is corrected.
39
+
9
40
  ## [2.6.0] - 2026-09-20
10
41
 
11
42
  ### Changed
@@ -352,7 +383,8 @@ First release.
352
383
  - REST API under `/plugins/signalk-chiplog/api`, documented in [docs/API.md](docs/API.md).
353
384
  - Single SQLite database through Node's built-in `node:sqlite`: no native module to build.
354
385
 
355
- [Unreleased]: https://github.com/ricard33/signalk-chiplog/compare/v2.6.0...HEAD
386
+ [Unreleased]: https://github.com/ricard33/signalk-chiplog/compare/v2.7.0...HEAD
387
+ [2.7.0]: https://github.com/ricard33/signalk-chiplog/compare/v2.6.0...v2.7.0
356
388
  [2.6.0]: https://github.com/ricard33/signalk-chiplog/compare/v2.5.1...v2.6.0
357
389
  [2.5.1]: https://github.com/ricard33/signalk-chiplog/compare/v2.5.0...v2.5.1
358
390
  [2.5.0]: https://github.com/ricard33/signalk-chiplog/compare/v2.4.0...v2.5.0
package/README.md CHANGED
@@ -8,7 +8,7 @@ sensors cannot know from a tablet at the helm: manoeuvres, notes and handwriting
8
8
  such as a lock or a lunch anchorage.
9
9
  - **GPS track**, distance, time under engine and under sail.
10
10
  - **Hourly instrument readings**, as on a paper log, plus readings at departure, arrival and each manoeuvre.
11
- - **Automatic events**: alarms, autopilot changes, strong wind, falling barometer.
11
+ - **Automatic events**: alarms, autopilot changes, strong wind, falling barometer, held heading changes.
12
12
  - **Departure and arrival names**, looked up online and corrected once for good.
13
13
  - **Consultation webapp**: logbook by day, map, timeline, corrections, export.
14
14
  - **Replay a range of passages** on the map — an hour of sailing per second — and save it as an MP4 for a phone, a
@@ -87,9 +87,9 @@ A **passage** is one logbook entry: from leaving a berth or anchorage to arrivin
87
87
  which carries on once the boat moves.
88
88
  - **Power cuts and restarts.** If the server comes back after the boat has been still for longer than the tolerance, the
89
89
  passage is closed at its last movement. A short restart carries on with the same passage.
90
- - **Under way or stopped** comes from `navigation.state` when signalk-autostate provides it. Otherwise Chiplog averages
91
- speed over ground over 3 minutes: under way above 1 knot, stopped below half a knot. This keeps a boat swinging at
92
- anchor from starting passages.
90
+ - **Under way or stopped** comes from `navigation.state` when something publishes it — signalk-autostate, typically.
91
+ Otherwise Chiplog averages speed over ground over 3 minutes: under way above 1 knot, stopped below half a knot. This
92
+ keeps a boat swinging at anchor from starting passages.
93
93
 
94
94
  A passage that was split in two — a stop just longer than the tolerance, for instance — can be merged back from the
95
95
  logbook webapp. The stop the merge folds away is kept on the timeline as its own line, naming the place, since it would
@@ -131,6 +131,8 @@ Added to the timeline without anyone touching anything:
131
131
  - **Wind** — true wind, averaged over 2 minutes, rising above 20 and 30 knots and falling back below them
132
132
  (configurable).
133
133
  - **Barometer** — a fall of 4 hPa or more over 3 hours (configurable).
134
+ - **Heading changes** — a turn of 30° or more, held steady for a minute, above 2 knots (configurable, and can be turned
135
+ off).
134
136
 
135
137
  An alarm at anchor between two passages goes to the passage that ended there, as long as the boat is within 1 nautical
136
138
  mile of that arrival.
@@ -236,9 +238,9 @@ Open **Chiplog** from the Signal K webapps, or `/signalk-chiplog/`. Reading need
236
238
  saves it as a video in one of five shapes (Mobile 9:16, Portrait 3:4, Square 1:1, Landscape 4:3, Widescreen 16:9).
237
239
  Everything happens in the browser: nothing is rendered or encoded on the Signal K server, and the map tiles are the
238
240
  only thing downloaded. **View → 3D** shows the same film, at the map's own scale and with north still at the top, as a
239
- camera tilted down onto a 3D sailboat that heels and trims its sails to the wind and rides the waves, with the map
240
- laid flat under it; frame it closer or wider than the map and pick the boat's size if you like, and load your own boat
241
- as a `.glb` file — sails included — if you would rather see it (see
241
+ camera tilted down onto a cartoon sailboat that heels and trims its sails to the wind and rides the waves, with the
242
+ map laid flat under it; frame it closer or wider than the map and pick the boat's size if you like, and load your own
243
+ boat as a `.glb` file — sails included — if you would rather see it (see
242
244
  [Your own boat](#your-own-boat-in-the-3d-animation-)). The MP4 export then films the 3D view.
243
245
  - **Export** — download the whole logbook or a date range as a PDF logbook to print, JSON, CSV or GPX, and write the
244
246
  abandon-ship copy to the USB drive now (admin). The PDF is written in the webapp's language and the device's time
@@ -254,7 +256,7 @@ shortcuts beside it; where any date is allowed, the calendar has an _Any date_ b
254
256
 
255
257
  ### Your own boat in the 3D animation ⛵
256
258
 
257
- The 3D view draws a generic sailboat. To see yours instead, use **Boat → Use my own boat…** under the animation and pick
259
+ The 3D view draws a cartoon sailboat. To see yours instead, use **Boat → Use my own boat…** under the animation and pick
258
260
  a `.glb` file. The model is kept in **that browser only** (it is never sent to the logbook or the Signal K server), so
259
261
  it has to be loaded again on another device; **Use the default boat** puts the generic one back.
260
262
 
@@ -418,36 +420,43 @@ a regular Signal K user account.
418
420
 
419
421
  In the Signal K admin, **Apps & Plugins → Configuration → Chiplog**.
420
422
 
421
- | Setting | Default | What it does |
422
- | ---------------------------------------------------------------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
423
- | Stop duration within which a new departure continues the passage | 30 min | A passage closes when the boat stops; leaving again sooner reopens it, the stop kept as a stopover. |
424
- | Under-way speed without navigation.state | 1 kn | Used only without signalk-autostate: under way above it, stopped below half of it. |
425
- | Propulsion assumed without engine data | sail | When nothing says whether the engine is running. Set to engine on a motorboat. |
426
- | Instrument snapshot interval | 60 min | Readings on this clock boundary during a passage. |
427
- | Track point interval | 15 s | A track point at least this often while moving. |
428
- | Place matching radius | 200 m | A departure or arrival this close to a known place takes its name. |
429
- | Name departures and arrivals with online geocoding | on | Turn off to never send positions online; places are then named after their coordinates until corrected. |
430
- | Geocoding service | `https://nominatim.openstreetmap.org` | Any Nominatim-compatible service, e.g. a self-hosted one. |
431
- | Read each journal line against the nearest landmark | on | Fetches the landmarks of the areas sailed through from OpenStreetMap, so each position is also given as a bearing and distance from one. Turn off to keep the coordinates alone. |
432
- | Landmark service (Overpass API) | `https://overpass-api.de/api/interpreter` | Any Overpass-compatible service, e.g. a self-hosted one. |
433
- | Fetch the tide forecast at departure | on | Turn off to never send the departure position online; the passage page then shows no tide. |
434
- | Marine service | `https://marine-api.open-meteo.com/v1/marine` | Any Open-Meteo Marine-compatible service, e.g. a self-hosted one. Serves the tide, and the sea state and current of the weather forecast. |
435
- | Fetch the marine weather forecast at departure | on | Turn off to never send the departure position to the weather services; the passage page and the PDF then show no forecast. |
436
- | Weather service | `https://api.open-meteo.com/v1/forecast` | Any Open-Meteo-compatible forecast service, e.g. a self-hosted one. |
437
- | USB export directory | — | Where the abandon-ship copy is written, e.g. `/media/usb`. Empty turns the USB copy off. |
438
- | Automatic USB copy interval | 15 min | How often the USB copy is brought up to date. 0 turns the periodic copy off. |
439
- | Copy to the USB drive at each arrival | on | Brings the USB copy up to date as soon as a passage ends. |
440
- | Logbook language (PDF) | en | Language of the PDF logbooks on the USB drive (English or French). |
441
- | Ship's time zone (PDF) | the server's | Time zone of the PDF logbooks on the USB drive, e.g. `Europe/Paris`. |
442
- | Wind speed thresholds | 20, 30 kn | Logged when the 2-minute average true wind crosses them. |
443
- | Barometric drop warning | 4 hPa / 3 h | 0 turns it off. |
444
- | InfluxDB host (retrospective analysis) | — | Local or remote host of the InfluxDB 1.x database signalk-to-influxdb writes to. Empty turns the retrospective analysis page off. |
445
- | InfluxDB port | 8086 | |
446
- | InfluxDB database | — | |
447
- | InfluxDB username / password | — | Leave empty if the database needs none. |
448
- | InfluxDB protocol | http | `http` or `https`. |
449
- | InfluxDB query timeout | 30 s | Each retrospective query gives up and reports an error past this, instead of hanging against an unreachable or overloaded database. |
450
- | InfluxDB vessel context | this server's own | Only needed running the replay from a different Signal K server than the one that wrote the history, e.g. development pointed at a production database. |
423
+ | Setting | Default | What it does |
424
+ | ---------------------------------------------------------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
425
+ | Stop duration within which a new departure continues the passage | 30 min | A passage closes when the boat stops; leaving again sooner reopens it, the stop kept as a stopover. |
426
+ | Under-way speed without navigation.state | 1 kn | Used only without signalk-autostate: under way above it, stopped below half of it. |
427
+ | Propulsion assumed without engine data | sail | When nothing says whether the engine is running. Set to engine on a motorboat. |
428
+ | Instrument snapshot interval | 60 min | Readings on this clock boundary during a passage. |
429
+ | Track point interval | 15 s | A track point at least this often while moving. |
430
+ | Place matching radius | 200 m | A departure or arrival this close to a known place takes its name. |
431
+ | Name departures and arrivals with online geocoding | on | Turn off to never send positions online; places are then named after their coordinates until corrected. |
432
+ | Geocoding service | `https://nominatim.openstreetmap.org` | Any Nominatim-compatible service, e.g. a self-hosted one. |
433
+ | Read each journal line against the nearest landmark | on | Fetches the landmarks of the areas sailed through from OpenStreetMap, so each position is also given as a bearing and distance from one. Turn off to keep the coordinates alone. |
434
+ | Landmark service (Overpass API) | `https://overpass-api.de/api/interpreter` | Any Overpass-compatible service, e.g. a self-hosted one. |
435
+ | Fetch the tide forecast at departure | on | Turn off to never send the departure position online; the passage page then shows no tide. |
436
+ | Marine service | `https://marine-api.open-meteo.com/v1/marine` | Any Open-Meteo Marine-compatible service, e.g. a self-hosted one. Serves the tide, and the sea state and current of the weather forecast. |
437
+ | Fetch the marine weather forecast at departure | on | Turn off to never send the departure position to the weather services; the passage page and the PDF then show no forecast. |
438
+ | Weather service | `https://api.open-meteo.com/v1/forecast` | Any Open-Meteo-compatible forecast service, e.g. a self-hosted one. |
439
+ | USB export directory | — | Where the abandon-ship copy is written, e.g. `/media/usb`. Empty turns the USB copy off. |
440
+ | Automatic USB copy interval | 15 min | How often the USB copy is brought up to date. 0 turns the periodic copy off. |
441
+ | Copy to the USB drive at each arrival | on | Brings the USB copy up to date as soon as a passage ends. |
442
+ | Logbook language (PDF) | en | Language of the PDF logbooks on the USB drive (English or French). |
443
+ | Ship's time zone (PDF) | the server's | Time zone of the PDF logbooks on the USB drive, e.g. `Europe/Paris`. |
444
+ | Wind speed thresholds | 20, 30 kn | Logged when the 2-minute average true wind crosses them. |
445
+ | Barometric drop warning | 4 hPa / 3 h | 0 turns it off. |
446
+ | Log heading changes | on | Turn off to leave heading changes out of the log. |
447
+ | Heading change threshold | 30° | A change must be at least this large to be logged. |
448
+ | Heading change tolerance | 10° | How much the new heading may wander while holding and still count as steady. |
449
+ | Heading change hold time | 60 s | How long the new heading must hold before it is logged. |
450
+ | Heading change minimum speed | 2 kn | Below this speed over ground, the course is too noisy to log a change. |
451
+ | Heading change cooldown | 5 min | A new change is logged only once the last one is at least this old. |
452
+ | History source (retrospective analysis) | InfluxDB 1.x | Select Signal K History API to read the server's own history provider, such as signalk-to-influxdb2 — no database connection needed. InfluxDB 1.x stays the default so existing installations are untouched. |
453
+ | InfluxDB host (retrospective analysis) | — | Shown only for the InfluxDB 1.x legacy source. Local or remote host of the database signalk-to-influxdb writes to. Empty turns the retrospective analysis page off. |
454
+ | InfluxDB port | 8086 | |
455
+ | InfluxDB database | — | |
456
+ | InfluxDB username / password | — | Leave empty if the database needs none. |
457
+ | InfluxDB protocol | http | `http` or `https`. |
458
+ | Retrospective query timeout | 30 s | Each retrospective query gives up and reports an error past this, instead of hanging against an unreachable or overloaded history. Applies to either source. |
459
+ | Vessel context (retrospective analysis) | this server's own | Only needed running the replay from a different Signal K server than the one that wrote the history, e.g. development pointed at a production database. Applies to either source. |
451
460
 
452
461
  ## Signal K data used 🔌
453
462
 
@@ -459,7 +468,7 @@ None of these is required except position and speed over ground; each feature us
459
468
  | Engine or sail | `propulsion.*.revolutions`, `propulsion.*.state`, `navigation.state` |
460
469
  | Readings | `navigation.headingTrue` (or `headingMagnetic` + `magneticVariation`), `navigation.speedThroughWater`, `environment.wind.*`, `environment.depth.belowSurface` (or `belowTransducer`), `environment.outside.pressure`, `environment.outside.temperature`, `environment.water.temperature`, `navigation.log`, `propulsion.*.runTime` |
461
470
  | Boat status | `tanks.*.*.currentLevel`, `.currentVolume`, `.capacity`, `.name`, `electrical.batteries.*.voltage`, `.current`, `.capacity.stateOfCharge`, `.temperature`, `.name` |
462
- | Events | `notifications.*`, `steering.autopilot.state`, `.mode`, `.engaged`, `.target`, `environment.wind.speedTrue`, `environment.outside.pressure` |
471
+ | Events | `notifications.*`, `steering.autopilot.state`, `.mode`, `.engaged`, `.target`, `environment.wind.speedTrue`, `environment.outside.pressure`, `navigation.headingTrue` (or `headingMagnetic` + `magneticVariation`) |
463
472
 
464
473
  ## Backups and abandon ship 🛟
465
474
 
@@ -485,9 +494,13 @@ stopped? The **Retrospective** page (admin access) reconstructs those passages f
485
494
  Chiplog runs live — the same thresholds, so a reconstructed passage is one Chiplog would have logged had it been running
486
495
  at the time.
487
496
 
488
- - **Requires [signalk-to-influxdb](https://github.com/tkurki/signalk-to-influxdb)** (a recommended companion plugin)
489
- already having written the boat's data into an InfluxDB 1.x database — local or on another machine, set in **Apps &
490
- Plugins → Configuration**: host, port, database, and a username/password if it needs one.
497
+ - Choose a history source in **Apps & Plugins → Configuration**:
498
+ - **Signal K History API** (recommended) reads the server's active history provider, such as
499
+ [signalk-to-influxdb2](https://github.com/tkurki/signalk-to-influxdb2), without database credentials or storage
500
+ schema assumptions.
501
+ - **InfluxDB 1.x (legacy)** requires [signalk-to-influxdb](https://github.com/tkurki/signalk-to-influxdb) to have
502
+ written the boat's data into an InfluxDB 1.x database — local or on another machine — set with host, port, database,
503
+ and a username/password if it needs one.
491
504
  - Pick a **from** and **to** date on the Retrospective page and start it. It runs in the background — the page shows its
492
505
  progress — and can be cancelled at any point; a first quick pass finds when the boat moved, and only those stretches
493
506
  are then fetched and reconstructed, so weeks in port take next to no time. Once done, the page sums up what it added:
@@ -567,9 +580,10 @@ Chiplog works, but departures and arrivals are decided from speed only. The mess
567
580
  - **"has not been updated since…"** — the source named stopped publishing. signalk-autostate republishes every 10
568
581
  minutes while it receives position and speed: check that the GPS data reaches the server, and that the plugin is
569
582
  enabled.
570
- - **"is “default” (from nmea0183.AI)"** — another device publishes a navigational status Chiplog does not use, typically
571
- the boat's own AIS transponder, and signalk-autostate's value is not there to take over. Check that signalk-autostate
572
- is enabled; Chiplog prefers its value over any other source.
583
+ - **"is “default” (from nmea0183.AI)"** — the source Signal K resolved `navigation.state` to publishes a navigational
584
+ status Chiplog does not use, typically the boat's own AIS transponder. Chiplog follows whichever source the server
585
+ picks, so the fix is on the server: check that signalk-autostate is enabled, and give it priority over the transponder
586
+ in Signal K's source priorities.
573
587
 
574
588
  ### Passages are not opening
575
589
 
@@ -624,10 +638,10 @@ context** in the plugin configuration.
624
638
  ### A retrospective analysis takes minutes then fails with no clear reason
625
639
 
626
640
  The InfluxDB server did not answer — unreachable, overloaded, a firewall or a VPN not connected. Each query now gives up
627
- after **InfluxDB query timeout** (30 seconds by default) with the connection problem it ran into, rather than hanging
628
- until some far longer, less informative failure; check that the server named in the plugin configuration is reachable
629
- from wherever Signal K runs, and that it is not overloaded — or raise the timeout if it is simply slow to answer a
630
- six-hour chunk.
641
+ after **Retrospective query timeout** (30 seconds by default) with the connection problem it ran into, rather than
642
+ hanging until some far longer, less informative failure; check that the server named in the plugin configuration is
643
+ reachable from wherever Signal K runs, and that it is not overloaded — or raise the timeout if it is simply slow to
644
+ answer a six-hour chunk.
631
645
 
632
646
  ### A retrospective analysis over several days makes the InfluxDB server unresponsive
633
647
 
package/index.js CHANGED
@@ -225,50 +225,121 @@ module.exports = function (app) {
225
225
  default: EVENT_DEFAULTS.pressureDropThreshold,
226
226
  minimum: 0
227
227
  },
228
- influxHost: {
229
- type: 'string',
230
- title: 'InfluxDB host (retrospective analysis)',
228
+ headingChangeEnabled: {
229
+ type: 'boolean',
230
+ title: 'Log heading changes',
231
231
  description:
232
- 'For reconstructing past passages from a signalk-to-influxdb history (InfluxDB 1.x), local or remote. Leave empty to turn that feature off'
232
+ 'Records a course change once it is held; turn off to leave heading changes out of the log',
233
+ default: EVENT_DEFAULTS.headingChangeEnabled
233
234
  },
234
- influxPort: {
235
+ headingChangeThreshold: {
235
236
  type: 'number',
236
- title: 'InfluxDB port',
237
- default: INFLUX_DEFAULTS.influxPort
237
+ title: 'Heading change threshold (degrees)',
238
+ description: 'A change must be at least this large to be logged',
239
+ default: EVENT_DEFAULTS.headingChangeThreshold,
240
+ minimum: 1,
241
+ maximum: 180
238
242
  },
239
- influxDatabase: {
240
- type: 'string',
241
- title: 'InfluxDB database'
243
+ headingChangeTolerance: {
244
+ type: 'number',
245
+ title: 'Heading change tolerance (degrees)',
246
+ description: 'How much the new heading may wander while holding and still count as steady',
247
+ default: EVENT_DEFAULTS.headingChangeTolerance,
248
+ minimum: 0
242
249
  },
243
- influxUsername: {
244
- type: 'string',
245
- title: 'InfluxDB username',
246
- description: 'Leave empty if the database needs none'
250
+ headingChangeHoldSeconds: {
251
+ type: 'number',
252
+ title: 'Heading change hold time (seconds)',
253
+ description: 'How long the new heading must hold before it is logged',
254
+ default: EVENT_DEFAULTS.headingChangeHoldSeconds,
255
+ minimum: 1
247
256
  },
248
- influxPassword: {
249
- type: 'string',
250
- title: 'InfluxDB password',
251
- format: 'password'
257
+ headingChangeMinSpeed: {
258
+ type: 'number',
259
+ title: 'Heading change minimum speed (knots)',
260
+ description: 'Below this speed over ground, the course is too noisy to log a change',
261
+ default: EVENT_DEFAULTS.headingChangeMinSpeed,
262
+ minimum: 0
263
+ },
264
+ headingChangeCooldownMinutes: {
265
+ type: 'number',
266
+ title: 'Heading change cooldown (minutes)',
267
+ description: 'A new change is logged only once the last one is at least this old',
268
+ default: EVENT_DEFAULTS.headingChangeCooldownMinutes,
269
+ minimum: 0
252
270
  },
253
- influxProtocol: {
271
+ retrospectiveHistorySource: {
254
272
  type: 'string',
255
- title: 'InfluxDB protocol',
256
- enum: ['http', 'https'],
257
- default: INFLUX_DEFAULTS.influxProtocol
273
+ title: 'History source for retrospective analysis',
274
+ description:
275
+ 'Signal K reads the server’s own History API provider (signalk-to-influxdb2, for example), needing no database connection of its own — the better choice on a new installation. InfluxDB 1.x keeps the legacy direct database reader, and stays the default so installations already set up that way go on working untouched.',
276
+ enum: ['influxdb1', 'signalk'],
277
+ enumNames: ['InfluxDB 1.x (legacy)', 'Signal K History API'],
278
+ default: 'influxdb1'
258
279
  },
259
280
  influxQueryTimeoutSeconds: {
260
281
  type: 'number',
261
- title: 'InfluxDB query timeout (seconds)',
282
+ title: 'Retrospective query timeout (seconds)',
262
283
  description:
263
- 'Each retrospective query is given up on and reported as an error past this, rather than hanging indefinitely against an unreachable or overloaded database',
284
+ 'Each retrospective query is given up on and reported as an error past this, rather than hanging indefinitely against an unreachable or overloaded history. Applies to either history source',
264
285
  default: INFLUX_DEFAULTS.influxQueryTimeoutSeconds,
265
286
  minimum: 1
266
287
  },
267
288
  influxSelfContext: {
268
289
  type: 'string',
269
- title: 'InfluxDB vessel context',
290
+ title: 'Vessel context (retrospective analysis)',
270
291
  description:
271
- 'Only needed running the replay from a different Signal K server than the one that wrote the history — e.g. a development instance pointed at a boat’s production database. The vessel context the data was tagged with, such as "vessels.urn:mrn:imo:mmsi:123456789"; a failed replay names the contexts actually found. Leave empty to use this server’s own (Signal K → Server → Vessel Identity)'
292
+ 'Only needed running the replay from a different Signal K server than the one that wrote the history — e.g. a development instance pointed at a boat’s production database. The vessel context the data was tagged with, such as "vessels.urn:mrn:imo:mmsi:123456789"; a failed replay names the contexts actually found. Leave empty to use this server’s own (Signal K → Server → Vessel Identity). Applies to either history source'
293
+ }
294
+ },
295
+ // RJSF evaluates dependencies each time the selector changes. Keeping the
296
+ // InfluxDB fields out of the top-level properties hides them in History
297
+ // API mode and inserts them immediately after the source selector.
298
+ dependencies: {
299
+ retrospectiveHistorySource: {
300
+ oneOf: [
301
+ {
302
+ properties: {
303
+ retrospectiveHistorySource: { const: 'influxdb1' },
304
+ influxHost: {
305
+ type: 'string',
306
+ title: 'InfluxDB host (retrospective analysis)',
307
+ description:
308
+ 'For reconstructing past passages from a signalk-to-influxdb history (InfluxDB 1.x), local or remote. Leave empty to turn that feature off'
309
+ },
310
+ influxPort: {
311
+ type: 'number',
312
+ title: 'InfluxDB port',
313
+ default: INFLUX_DEFAULTS.influxPort
314
+ },
315
+ influxDatabase: {
316
+ type: 'string',
317
+ title: 'InfluxDB database'
318
+ },
319
+ influxUsername: {
320
+ type: 'string',
321
+ title: 'InfluxDB username',
322
+ description: 'Leave empty if the database needs none'
323
+ },
324
+ influxPassword: {
325
+ type: 'string',
326
+ title: 'InfluxDB password',
327
+ format: 'password'
328
+ },
329
+ influxProtocol: {
330
+ type: 'string',
331
+ title: 'InfluxDB protocol',
332
+ enum: ['http', 'https'],
333
+ default: INFLUX_DEFAULTS.influxProtocol
334
+ }
335
+ }
336
+ },
337
+ {
338
+ properties: {
339
+ retrospectiveHistorySource: { const: 'signalk' }
340
+ }
341
+ }
342
+ ]
272
343
  }
273
344
  }
274
345
  };
@@ -400,6 +471,16 @@ module.exports = function (app) {
400
471
  logbookTimeZone: config.logbookTimeZone || null,
401
472
  windSpeedThresholds: config.windSpeedThresholds ?? EVENT_DEFAULTS.windSpeedThresholds,
402
473
  pressureDropThreshold: config.pressureDropThreshold ?? EVENT_DEFAULTS.pressureDropThreshold,
474
+ headingChangeEnabled: config.headingChangeEnabled ?? EVENT_DEFAULTS.headingChangeEnabled,
475
+ headingChangeThreshold:
476
+ config.headingChangeThreshold ?? EVENT_DEFAULTS.headingChangeThreshold,
477
+ headingChangeTolerance:
478
+ config.headingChangeTolerance ?? EVENT_DEFAULTS.headingChangeTolerance,
479
+ headingChangeHoldSeconds:
480
+ config.headingChangeHoldSeconds ?? EVENT_DEFAULTS.headingChangeHoldSeconds,
481
+ headingChangeMinSpeed: config.headingChangeMinSpeed ?? EVENT_DEFAULTS.headingChangeMinSpeed,
482
+ headingChangeCooldownMinutes:
483
+ config.headingChangeCooldownMinutes ?? EVENT_DEFAULTS.headingChangeCooldownMinutes,
403
484
  influxHost: config.influxHost || null,
404
485
  influxPort: config.influxPort ?? INFLUX_DEFAULTS.influxPort,
405
486
  influxDatabase: config.influxDatabase || null,
@@ -408,7 +489,9 @@ module.exports = function (app) {
408
489
  influxProtocol: config.influxProtocol || INFLUX_DEFAULTS.influxProtocol,
409
490
  influxQueryTimeoutSeconds:
410
491
  config.influxQueryTimeoutSeconds ?? INFLUX_DEFAULTS.influxQueryTimeoutSeconds,
411
- influxSelfContext: config.influxSelfContext || null
492
+ influxSelfContext: config.influxSelfContext || null,
493
+ retrospectiveHistorySource:
494
+ config.retrospectiveHistorySource === 'signalk' ? 'signalk' : 'influxdb1'
412
495
  };
413
496
 
414
497
  if (settings.logbookTimeZone && !isTimeZone(settings.logbookTimeZone)) {
package/lib/database.js CHANGED
@@ -371,7 +371,10 @@ const MIGRATIONS = [
371
371
  ALTER TABLE places ADD COLUMN country_code TEXT;
372
372
  ALTER TABLE places ADD COLUMN country_checked INTEGER NOT NULL DEFAULT 0
373
373
  CHECK (country_checked IN (0, 1));
374
- `
374
+ `,
375
+ // Another CHECK-widening rebuild, same reason and same shape as
376
+ // addPropulsionChangeEventType.
377
+ addHeadingChangeEventType
375
378
  ];
376
379
 
377
380
  function addPropulsionChangeEventType(db, version) {
@@ -472,6 +475,56 @@ function addStopoverEventType(db, version) {
472
475
  db.exec('PRAGMA foreign_keys = ON');
473
476
  }
474
477
 
478
+ function addHeadingChangeEventType(db, version) {
479
+ db.exec('PRAGMA foreign_keys = OFF');
480
+ withTransaction(db, () => {
481
+ db.exec(`
482
+ -- The event-watcher logs a held course change (SPEC §4.6) the same way
483
+ -- as the other automatic events.
484
+ CREATE TABLE events_new (
485
+ id INTEGER PRIMARY KEY AUTOINCREMENT,
486
+ entry_id INTEGER NOT NULL REFERENCES log_entries (id) ON DELETE CASCADE,
487
+ time TEXT NOT NULL,
488
+ type TEXT NOT NULL CHECK (
489
+ type IN (
490
+ 'manoeuvre',
491
+ 'text_annotation',
492
+ 'handwritten_annotation',
493
+ 'sk_alarm',
494
+ 'autopilot',
495
+ 'weather_threshold',
496
+ 'manual_correction',
497
+ 'propulsion_change',
498
+ 'stopover',
499
+ 'heading_change'
500
+ )
501
+ ),
502
+ subtype TEXT,
503
+ lat REAL,
504
+ lon REAL,
505
+ comment TEXT,
506
+ payload TEXT,
507
+ source TEXT NOT NULL DEFAULT 'manual' CHECK (source IN ('auto', 'manual')),
508
+ created_at TEXT NOT NULL,
509
+ client_ref TEXT
510
+ );
511
+ INSERT INTO events_new (
512
+ id, entry_id, time, type, subtype, lat, lon, comment, payload, source, created_at, client_ref
513
+ )
514
+ SELECT id, entry_id, time, type, subtype, lat, lon, comment, payload, source, created_at, client_ref
515
+ FROM events;
516
+ DROP TABLE events;
517
+ ALTER TABLE events_new RENAME TO events;
518
+ CREATE INDEX idx_events_entry_time ON events (entry_id, time);
519
+ CREATE INDEX idx_events_type ON events (type);
520
+ CREATE UNIQUE INDEX idx_events_client_ref ON events (client_ref)
521
+ WHERE client_ref IS NOT NULL;
522
+ `);
523
+ db.exec(`PRAGMA user_version = ${version + 1}`);
524
+ });
525
+ db.exec('PRAGMA foreign_keys = ON');
526
+ }
527
+
475
528
  function seedBuiltinManoeuvreTypes(db) {
476
529
  const insert = db.prepare(
477
530
  `INSERT INTO manoeuvre_types (key, label, sort_order, builtin)
package/lib/detection.js CHANGED
@@ -27,12 +27,6 @@ const MAX_AGE_MS = {
27
27
  'navigation.position': 2 * 60 * 1000
28
28
  };
29
29
 
30
- // navigation.state can have several sources: an AIS class A transponder
31
- // reports the boat's own navigational status — often left undefined, or at
32
- // "under way using engine" while moored — which would otherwise hide
33
- // signalk-autostate's decision. Its value is preferred whenever present.
34
- const AUTOSTATE_SOURCE_PREFIX = 'signalk-autostate';
35
-
36
30
  const STOPPED_STATES = new Set(['moored', 'anchored', 'aground', 'not-under-way']);
37
31
  const UNDERWAY_STATES = new Set([
38
32
  'sailing',
@@ -97,19 +91,14 @@ function createFreshnessTracker(readSelfPath) {
97
91
  };
98
92
  }
99
93
 
100
- // The reading of navigation.state detection relies on — signalk-autostate's
101
- // when it publishes one — with its source, from Signal K's per-source values.
94
+ // The reading of navigation.state detection relies on, with the source the
95
+ // server resolved it to. A boat publishing the path from several sources — its
96
+ // own AIS class A transponder alongside signalk-autostate, typically — settles
97
+ // which one wins with the server's source priorities, not here.
102
98
  function stateReading(node) {
103
99
  if (!node) {
104
100
  return null;
105
101
  }
106
- const sources = node.values && typeof node.values === 'object' ? node.values : {};
107
- const autostate = Object.keys(sources).find((source) =>
108
- source.startsWith(AUTOSTATE_SOURCE_PREFIX)
109
- );
110
- if (autostate) {
111
- return { source: autostate, node: sources[autostate] };
112
- }
113
102
  return { source: node.$source ?? null, node };
114
103
  }
115
104
 
@@ -446,7 +435,6 @@ function createPassageDetector({ db, readSelfPath, settings, clock = Date.now })
446
435
  }
447
436
 
448
437
  module.exports = {
449
- AUTOSTATE_SOURCE_PREFIX,
450
438
  MAX_AGE_MS,
451
439
  METRES_PER_SECOND_PER_KNOT,
452
440
  UNDERWAY_STATES,