signalk-chiplog 2.14.0 → 2.16.0

package/CHANGELOG.md

@@ -6,6 +6,42 @@ All notable changes to Chiplog are documented here. The format follows
 
 ## [Unreleased]
 
+## [2.16.0] - 2026-11-02
+
+### Added
+
+- **An API for companion apps**, such as Chiplog Skipper, described in [docs/API.md](docs/API.md):
+  - **Versioned**: the public routes are also served under `/plugins/signalk-chiplog/api/v1`, described by an OpenAPI
+    document (`GET /api/v1/openapi.json`, also listed by the Signal K server). `GET /state` now says `apiVersions`,
+    `pluginVersion`, `features` and the `logbookId`.
+  - **Planned passages** (`/plans`): departure, arrival, Signal K route and fallback points, criteria, crew and watches;
+    linking a plan to the passage that opens puts the planned crew aboard.
+  - **Defects** (`/defects`), with severity, status and links to the passage, plan or journal line they came from.
+  - **Tanks at arrival** (`endTanks`): noted as a passage closes, by detection or by the crew, beside those noted at
+    departure; both can be set by hand with `PATCH /entries/:id`, and imported with `POST /entries`.
+  - **A changes feed** (`GET /changes?since=`), listing the passages, events, crew, plans and defects changed since a
+    cursor, deletions included.
+  - Every new route is open to read/write users; none needs admin.
+- **Plans and defects in the online backup**, sent whole like the places to a service that keeps them, and brought back
+  by a restore.
+
+### Changed
+
+- The first backup run after the update sends every passage's content again, without its track: a passage now carries
+  its tanks at arrival.
+
+## [2.15.0] - 2026-10-30
+
+### Added
+
+- **Delete an instrument reading.** An administrator can delete any reading from a passage's journal (trash icon on its
+  row), including those taken at departure and arrival. Any log line, automatic ones included, can now be deleted from
+  the journal too.
+- **Link to the passage in the summary emails.** A new **Server address for the summary link** setting; each summary
+  then ends with a link that opens the passage in the webapp. Without it, no link.
+- **Icon buttons in the journal**: edit and delete are a pencil and a bin instead of words.
+- **Hour scale on the tide graph**: the passage page's curve is graduated every three hours, in the logbook's time zone.
+
 ## [2.14.0] - 2026-10-25
 
 ### Added
@@ -523,7 +559,9 @@ First release.
 - REST API under `/plugins/signalk-chiplog/api`, documented in [docs/API.md](docs/API.md).
 - Single SQLite database through Node's built-in `node:sqlite`: no native module to build.
 
-[Unreleased]: https://github.com/ricard33/signalk-chiplog/compare/v2.14.0...HEAD
+[Unreleased]: https://github.com/ricard33/signalk-chiplog/compare/v2.16.0...HEAD
+[2.16.0]: https://github.com/ricard33/signalk-chiplog/compare/v2.15.0...v2.16.0
+[2.15.0]: https://github.com/ricard33/signalk-chiplog/compare/v2.14.0...v2.15.0
 [2.14.0]: https://github.com/ricard33/signalk-chiplog/compare/v2.13.0...v2.14.0
 [2.13.0]: https://github.com/ricard33/signalk-chiplog/compare/v2.12.0...v2.13.0
 [2.12.0]: https://github.com/ricard33/signalk-chiplog/compare/v2.11.0...v2.12.0

package/README.md

@@ -33,6 +33,7 @@ English and French, chosen from the browser's language.
 - [Passage summary emails](#passage-summary-emails-)
 - [Retrospective analysis](#retrospective-analysis-)
 - [Importing from PostgSail](#importing-from-postgsail-)
+- [Companion apps](#companion-apps-)
 - [Privacy and online services](#privacy-and-online-services-)
 - [Troubleshooting](#troubleshooting-)
 - [Limitations](#limitations-)
@@ -217,12 +218,13 @@ Open **Chiplog** from the Signal K webapps, or `/signalk-chiplog/`. Reading need
   counter at departure and arrival and the hours run, and the tank levels and battery charge, voltage and current noted
   at departure), and the log: every reading and event in order, including handwritten notes. A passage in progress
   refreshes every minute. Each line's comment can be edited (read/write access); a manoeuvre or note the crew logged
-  themselves can also be **redated** and deleted (with the instrument reading taken when it was logged) — automatic
-  lines (alarms, autopilot, weather, corrections) can only be annotated. Correcting a time reads the position back from
-  the track at that time, and leaves it empty when the track has nothing within 2 minutes of it, since the entry was not
-  made where it happened. A time outside the passage, or in the future, is refused, and the departure manoeuvre that
-  opened a passage is moved by changing that passage's departure time in **Corrections** below. Under each position, in
-  grey, its bearing and distance from the nearest landmark.
+  themselves can also be **redated** — automatic lines (alarms, autopilot, weather, corrections) can only be annotated.
+  Any line can be deleted (with the instrument reading taken when it was logged), and so can a reading on its own, which
+  needs an administrator. Correcting a time reads the position back from the track at that time, and leaves it empty
+  when the track has nothing within 2 minutes of it, since the entry was not made where it happened. A time outside the
+  passage, or in the future, is refused, and the departure manoeuvre that opened a passage is moved by changing that
+  passage's departure time in **Corrections** below. Under each position, in grey, its bearing and distance from the
+  nearest landmark.
 - **Corrections** (read/write access):
   - rename the departure, or the arrival once the passage is closed — a passage in progress has none yet to rename;
   - switch an engine period to sail or back;
@@ -482,6 +484,7 @@ In the Signal K admin, **Apps & Plugins → Configuration → Chiplog**.
 | SMTP port                                                        | 587                                              | 587 for submission with STARTTLS, 465 for implicit TLS, 25 for a local relay.                                                                                                                                |
 | SMTP security                                                    | STARTTLS                                         | STARTTLS, TLS, or none for a relay on the boat itself.                                                                                                                                                       |
 | SMTP user name / password                                        | —                                                | Leave empty if the relay needs no authentication.                                                                                                                                                            |
+| Server address for the summary link                              | —                                                | The address the server is reached at by whoever reads the summary, e.g. `https://boat.example.org`. Each summary then links to its passage in the webapp. Empty leaves the link out.                         |
 | Map tiles for the summary                                        | `https://tile.openstreetmap.org/{z}/{x}/{y}.png` | The tiles the summary map is drawn over, e.g. a self-hosted server. Empty draws the track on a plain background.                                                                                             |
 | Logbook language (PDF and summary emails)                        | en                                               | Language of the PDF logbooks on the USB drive and of the summary emails (English or French).                                                                                                                 |
 | Ship's time zone (PDF and summary emails)                        | the server's                                     | Time zone of the PDF logbooks on the USB drive and of the summary emails, e.g. `Europe/Paris`.                                                                                                               |
@@ -595,6 +598,10 @@ summary of every passage once it is over for good.
   distance, the duration, the time under way, the time under engine and under sail, the average and maximum speed, and
   the maximum wind — the same figures and wording as the passage page, in the **logbook language** and **ship's time
   zone** set below.
+- **A link to the passage.** Set **Server address for the summary link** to the address the server is reached at
+  (`https://boat.example.org`, or a LAN address if the readers are aboard) and each summary ends with a link that opens
+  the passage in the webapp. Without it the summary carries no link, as the plugin cannot know its own address from
+  outside.
 - **The map** is drawn on the server and travels inside the message, so it shows up in the mail rather than as an
   attachment to open. Tiles come from OpenStreetMap by default; set your own tile server, or clear the setting to get
   the track drawn on a plain background and send nothing to a tile server.
@@ -676,6 +683,23 @@ node scripts/import-postgsail.js PostgSail_Trip.geojson --url http://boat.local:
   and landmarks are then looked up in the background, like for any passage. Tide and weather forecasts are not fetched
   for passages this old.
 
+## Companion apps 🧭
+
+Chiplog keeps what happened. A companion app, such as Chiplog Skipper on a tablet, can add what was planned and decided
+around it, through the plugin's REST API — nothing to set up in the plugin:
+
+- **Planned passages**: departure, arrival, the Signal K route and fallback points, the crew and the watches. Once the
+  passage opens, the planned crew is the one recorded aboard.
+- **Defects** noticed under way or after, with their severity and whether they are fixed.
+- **Tanks at arrival**, noted as a passage ends next to those noted at departure, so that what a passage used can be
+  worked out. A boat without tank sensors can have them typed in.
+- **Decisions, check-lists, briefings and signatures** appear in the passage's journal as notes.
+
+The app connects with a Signal K device access request, like the tablet entry app, and needs read/write access, never
+admin. Plans and defects go to the [online backup](#online-backup-) with the rest of the logbook, when the service keeps
+them. For developers: the API is versioned (`/plugins/signalk-chiplog/api/v1`) and described by an OpenAPI document,
+listed in the Signal K admin under **Documentation**, and in [docs/API.md](docs/API.md).
+
 ## Privacy and online services 🔒
 
 - **Place names.** With geocoding on, the position of each departure and arrival that matches no known place is sent to

package/index.js

@@ -1,4 +1,5 @@
 const { registerRoutes } = require('./lib/api');
+const { getOpenApi } = require('./lib/openapi');
 const { openDatabase } = require('./lib/database');
 const { createPassageDetector, DETECTION_DEFAULTS, TICK_INTERVAL_MS } = require('./lib/detection');
 const { ApiError } = require('./lib/errors');
@@ -261,6 +262,12 @@ module.exports = function (app) {
         title: 'SMTP password',
         format: 'password'
       },
+      summaryMailServerUrl: {
+        type: 'string',
+        title: 'Server address for the summary link',
+        description:
+          'The address the server is reached at from the recipients’ side, e.g. https://boat.example.org or http://192.168.1.10:3000. Each summary then links to its passage in the logbook; empty leaves the link out'
+      },
       summaryMailTileUrl: {
         type: 'string',
         title: 'Map tiles for the summary',
@@ -673,6 +680,7 @@ module.exports = function (app) {
           : SUMMARY_MAIL_DEFAULTS.smtpSecurity,
         smtpUsername: config.smtpUsername || null,
         smtpPassword: config.smtpPassword || null,
+        summaryMailServerUrl: config.summaryMailServerUrl || null,
         summaryMailTileUrl:
           config.summaryMailTileUrl === undefined
             ? SUMMARY_MAIL_DEFAULTS.summaryMailTileUrl
@@ -887,6 +895,10 @@ module.exports = function (app) {
     }
   };
 
+  // The versioned API's description, which the server lists with its own (Signal K admin,
+  // Documentation > OpenAPI).
+  plugin.getOpenApi = () => getOpenApi();
+
   // The server registers routes once, before start() and even while the plugin
   // is disabled, and never removes them: every request must check the database.
   plugin.registerWithRouter = function (router) {
@@ -906,6 +918,7 @@ module.exports = function (app) {
           vesselPosition: () => readVesselPosition(app),
           observeEvent: (entryId, time) => detector.observeEvent(entryId, time),
           noteDeparture: (entryId) => detector.noteDeparture(entryId),
+          noteArrival: (entryId) => detector.noteArrival(entryId),
           usbExport,
           summaryMailer,
           cloudSync,