signalk-weather-router-plus 0.1.0-beta.1

package/CHANGELOG.md

@@ -0,0 +1,170 @@
+# Changelog
+
+All notable changes to this project are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project
+uses [Semantic Versioning](https://semver.org/).
+
+## [Unreleased]
+
+### Added
+
+- **Centre on the boat:** a button under the map's zoom buttons centres
+  the map on the boat's Signal K position, keeping the zoom.
+- The route summary (distance, time, arrival, sail and motor time,
+  waypoints, highest waves, validation badge) is also shown at the top of
+  the Itinerary tab.
+
+### Fixed
+
+- **A route could cross a narrow point of land.** Candidate legs were
+  checked for land at points 200 m apart, so a spit narrower than that
+  could fall between two of them (job `b0d324f7`: a leg across the tip of
+  Point Judith, RI; the final check flagged it but could only warn).
+  Legs are now checked against every land-raster cell their path
+  crosses, and the final validation tests each leg against the coastline
+  polygon edges instead of points every 100 m, so land of any width is
+  found. Checked on nine routes (Gibraltar, Messina, the Dardanelles and
+  Bosphorus, Singapore, Øresund and Dover, Newport → Horta, Point
+  Judith): all succeed with no land crossing and none is slower; the
+  Aegean → Black Sea route keeps further off the shore in the straits
+  (3.8% longer).
+- The polar diagram's "180°" label overlapped its caption; the caption
+  now has its own strip below the diagram.
+- **The conditions popup showed 0.0 kn of current where no current model
+  has data** (e.g. the Narrows, New York: no source resolves it), which
+  read as slack water. `/api/conditions` now returns `current_ms` and
+  `current_dir_deg` as null there, and the popup says there is no current
+  data instead of drawing a zero line. Answers saved before this change
+  are not served again.
+
+## [0.1.0-beta.1] - 2026-09-30
+
+First public beta: weather routing that runs entirely inside the Signal K
+server, with no outside routing service. The history of the development
+builds before this release, with their measurements, is in
+[docs/development-notes.md](https://github.com/motamman/signalk-weather-router-plus/blob/main/docs/development-notes.md).
+
+### Added
+
+#### Routing
+
+- Isochrone router (a TypeScript port of the routePlanning subsector
+  router) in a worker thread, against the vessel's polar. Modes
+  `sail_max` (sail when the polar speed reaches the sail threshold,
+  motor otherwise), `fastest` and `motor`. Tack penalty, motor speed,
+  under-keel and overhead margins, maximum wave height.
+- **Routes through straits anywhere:** a global water grid shipped with
+  the plugin (0.02°, built from GSHHG full-resolution level 1, with 4,987
+  narrow passages) gives each route a corridor; routes such as Lisbon →
+  Palma through Gibraltar or the Aegean → Black Sea through the
+  Dardanelles and the Bosphorus need no waypoints. Where the corridor
+  crosses a passage narrower than a stage step, an automatic
+  pass-through point is placed at its narrowest point and steps shorten
+  there. Known canals are closed unless **Allow canals** is on.
+- **Waypoints as legs:** each waypoint ends a leg; the next departs at
+  the arrival time. **Precise** (exactly through the waypoint) or
+  **Approximate** (through a circle of 50–2000 m, one search across
+  consecutive approximate waypoints). The destination is always exact.
+- **Route simplification:** waypoints within 10 m of a straight line are
+  dropped, and runs of waypoints become one straight leg when it stays
+  clear of land and is at most 5% slower. Your own waypoints are kept.
+- **Polar performance** (default 100%, 30–120%): the share of the
+  polar's speeds the boat actually makes under sail.
+- Every leg is checked against the exact coastline polygons.
+- Route jobs with progress over Server-Sent Events; results as GeoJSON,
+  saved to the Signal K Resources API, with a notification on completion
+  or failure. **Live mode** re-plans from the boat's position.
+- `wrp-route` command-line tool (no Signal K needed).
+
+#### Weather, currents and tides
+
+- **ECMWF open data**, global at 0.25°: wind, pressure and waves;
+  optional air and sea temperature, precipitation, dew point and
+  precipitation type. Every cycle (00z/12z to 360 h, 06z/18z to 144 h),
+  horizon 3–360 h (default 72 h). Fetched by byte range and decoded in
+  the plugin.
+- **The forecast is decoded once to disk**, not held in memory: about
+  1.1 GB for 72 h with the extra fields, 3.9 GB at 360 h. The forecast
+  is ready 1.3 s after a restart when the current run is already decoded
+  (Raspberry Pi 5, measured). On that Pi (8 GB), the whole Signal K
+  process, with this plugin, its two tile build workers and the server's
+  other plugins, used 1.9 GB after 7 hours (measured 30 September).
+- A resource guard refuses a forecast, a route or a setting the device
+  cannot hold (memory kept free, default 1 GB; 1 GB of disk kept free)
+  and says what to change.
+- **Currents:** Copernicus Marine SMOC (worldwide, hourly, including
+  tidal currents), NOAA Global RTOFS as a backup, and tidal-harmonic
+  files you install (FES2014, NECOFS) taking priority where they cover.
+- **Tides and water level:** Copernicus Marine hourly sea level: tide
+  height, total water level and surge, high and low waters.
+
+#### Web app
+
+- Plan on the map: click menu, draggable start, destination and
+  waypoints, course extension, itinerary cards per leg with the tack,
+  saved routes, run log.
+- Map layers named for the quantity shown: wind speed (colour) and flow
+  lines, wind barbs, wave height and direction lines, current speed and
+  arrows, sea state, precipitation, air and sea temperature, pressure
+  isobars with highs and lows, tide height, OpenSeaMap seamarks and your
+  own vessel. Colour layers stop at the coastline; water the current and
+  tide models cannot resolve is hatched "no model data".
+- **Map tiles saved on disk and built ahead of time:** colour layers,
+  barbs and arrows load as fixed tiles on the hour, answered from disk
+  (11–27 ms per tile measured on the Pi against a 10 s median before
+  caching). Worker threads build the tiles around the boat and the area
+  the map shows for every hour of the forecast (zoom 6–15, 250 km radius
+  to zoom 8, half of it at each deeper zoom). Disk cap 20 GB by default.
+- **Conditions popup** (shift-click): 72-hour charts of wind, waves, sea
+  state, tide and current, pressure, temperature and precipitation, and
+  a raw table.
+- **Units from your Signal K unit preferences**; values are SI
+  everywhere else.
+- **Settings tab** for vessel, forecast, currents, tides, routing and
+  publishing, shared by every client.
+
+#### Polars
+
+- Polar library (default polar plus a polars directory), polar diagram
+  and point-of-sail angles, polar per route.
+- **Create polar from boat specs:** a physics model (ORC VPP 2026 sail
+  forces, Delft hull series resistance, heeling limit with crew on the
+  rail). Checked against 441 ORC 2026 non-spinnaker certificates: median
+  error 3.3% upwind, 3.2% reaching, 3.3% running. No spinnaker assumed.
+
+#### Signal K integration
+
+- **Configuration panel** in the Admin UI: coastline with a Download
+  button and progress, the map cache settings in your units, and the
+  other plugin options.
+- **Coastline downloaded on first start** when none is configured: GSHHG
+  2.3.7 full-resolution level 1 (149 MB, once) from the authors' site,
+  or an identical copy on router.zeddisplay.com, checked by SHA-256.
+- **Weather API provider:** point forecasts anywhere, including
+  temperature, dew point, humidity, water temperature, water level and
+  its tendency.
+- REST API with an OpenAPI document; every map and point answer is shared
+  by all clients through the same disk cache.
+
+### Known issues
+
+- Tide heights and water level are relative to **mean sea level, not
+  chart datum**. Do not use them for under-keel clearance.
+- Currents and tides come from ~9 km models: fine along coasts, not
+  inside small harbours or narrow channels.
+- Open water only; no depths, fairways or bridges. Passages narrower than
+  about 150 m are not navigable for the router. A start or end deep
+  inside a harbour can fail; start from the approach.
+- One route computes at a time; others queue. Routes beyond the forecast
+  horizon use the last forecast step.
+- Map layers show the forecast on the hour; latitudes beyond ±85° have no
+  map tiles.
+- Behind a caching proxy (e.g. Cloudflare), the web app at
+  `/signalk-weather-router-plus/` can run the previous version's scripts
+  for a few hours after an update; reload without cache, or open
+  `/plugins/signalk-weather-router-plus/ui`, which always loads the
+  current scripts.
+- The configuration panel has been tested on Signal K server 2.33.0.
+
+[Unreleased]: https://github.com/motamman/signalk-weather-router-plus/compare/v0.1.0-beta.1...HEAD
+[0.1.0-beta.1]: https://github.com/motamman/signalk-weather-router-plus/releases/tag/v0.1.0-beta.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,89 @@
+Weather Router Plus (signalk-weather-router-plus)
+Copyright 2026 Maurice Tamman
+
+Licensed under the Apache License, Version 2.0 (see LICENSE).
+
+The Apache License does not grant permission to use the names
+"Weather Router Plus" or "signalk-weather-router-plus", or the project's
+icons, for a modified or forked version (Apache License 2.0, section 6).
+See CONTRIBUTING.md.
+
+===========================================================================
+Third-party material included in this distribution
+===========================================================================
+
+OpenLayers 9.1.0 (public/ol.js, public/ol.css)
+https://openlayers.org/
+
+  BSD 2-Clause License
+
+  Copyright 2005-present, OpenLayers Contributors
+  All rights reserved.
+
+  Redistribution and use in source and binary forms, with or without
+  modification, are permitted provided that the following conditions are met:
+
+  1. Redistributions of source code must retain the above copyright notice, this
+     list of conditions and the following disclaimer.
+
+  2. Redistributions in binary form must reproduce the above copyright notice,
+     this list of conditions and the following disclaimer in the documentation
+     and/or other materials provided with the distribution.
+
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+Global water grid (data/water-grid-0.02.bin.gz)
+
+  Built from the GSHHG 2.3.7 full-resolution level-1 shoreline
+  (GSHHS_f_L1.shp): Wessel, P., and W. H. F. Smith, A Global
+  Self-consistent, Hierarchical, High-resolution Shoreline Database,
+  J. Geophys. Res., 101, 8741-8743, 1996.
+
+  GSHHG is distributed under the GNU Lesser General Public License,
+  version 3 or later, with the permission notice in
+  licenses/GSHHG-LICENSE.txt. This file, as a work derived from GSHHG, is
+  provided under the same terms: licenses/LGPL-3.0.txt, which
+  supplements licenses/GPL-3.0.txt. The GSHHG data it was built from is
+  available from https://www.soest.hawaii.edu/pwessel/gshhg/ (and
+  https://router.zeddisplay.com/downloads/gshhg-shp-2.3.7.zip); the
+  program that builds this file from it is tools/build_water_grid.ts in
+  the source repository (npm run build:water-grid). The rest of this
+  package is licensed under the Apache License 2.0; the LGPL applies to
+  this data file only.
+
+===========================================================================
+Data the plugin downloads at run time (not included in this distribution)
+===========================================================================
+
+GSHHG 2.3.7 shoreline (when no coastline is configured)
+  Wessel & Smith, GNU Lesser General Public License.
+  https://www.soest.hawaii.edu/pwessel/gshhg/ (an identical copy is served
+  at https://router.zeddisplay.com/downloads/gshhg-shp-2.3.7.zip).
+
+Weather forecasts: ECMWF open data
+  Source: European Centre for Medium-Range Weather Forecasts (ECMWF),
+  https://www.ecmwf.int/en/forecasts/datasets/open-data . Licensed under
+  Creative Commons Attribution 4.0 International (CC BY 4.0,
+  https://creativecommons.org/licenses/by/4.0/) and the ECMWF Terms of Use
+  (https://apps.ecmwf.int/datasets/licences/general/).
+
+Ocean currents and sea level: Copernicus Marine Service
+  Generated using E.U. Copernicus Marine Service Information;
+  https://doi.org/10.48670/moi-00016 . Licence:
+  https://marine.copernicus.eu/user-corner/service-commitments-and-licence
+
+Ocean currents: NOAA Global RTOFS
+  U.S. National Oceanic and Atmospheric Administration, National Centers
+  for Environmental Prediction. A work of the U.S. Government.
+
+Tidal harmonics (FES2014, NECOFS) and polar files are supplied by the user
+and remain under their own terms.