signalk-binnacle 0.1.3 → 0.2.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.
package/README.md
CHANGED
|
@@ -8,11 +8,13 @@
|
|
|
8
8
|
|
|
9
9
|
A WebGL chart plotter for [Signal K](https://signalk.org).
|
|
10
10
|
|
|
11
|
-
> **0.
|
|
12
|
-
>
|
|
13
|
-
>
|
|
14
|
-
>
|
|
15
|
-
>
|
|
11
|
+
> **0.2.0.** This release adds a Tides panel for US waters (the nearest NOAA station's next high and
|
|
12
|
+
> low, a 48-hour curve, and the nearest tidal-current flood or ebb) and a set of free, key-free chart
|
|
13
|
+
> overlays: OpenSeaMap seamarks, marine protected areas, maritime boundaries, and NASA GIBS ocean
|
|
14
|
+
> conditions (sea-surface temperature and sea ice). The Layers panel is reorganized into collapsible
|
|
15
|
+
> categories with a better default order (US charts on top), imported charts gain a review step and
|
|
16
|
+
> register on the server so other devices discover them, and each depth source splits into a base and
|
|
17
|
+
> a survey-quality facet. See the [changelog](CHANGELOG.md) for the full list.
|
|
16
18
|
>
|
|
17
19
|
> **It has not been field-tested at any scale.** It has been developed and verified against a single
|
|
18
20
|
> Signal K server, never across a fleet or a range of real-world boats, hardware, and conditions. It
|
|
@@ -35,12 +37,17 @@ Signal K server.
|
|
|
35
37
|
Binnacle ships its full feature set as a Signal K webapp:
|
|
36
38
|
|
|
37
39
|
- **Charts and layers:** a GPU vector base map, server charts, four streaming bathymetry and ENC
|
|
38
|
-
sources
|
|
40
|
+
sources (each splitting into a base chart and a survey-quality facet), and your own imported
|
|
41
|
+
PMTiles, in a collapsible, categorized Layers panel with per-layer toggle, fade, and drag-reorder.
|
|
42
|
+
- **Overlays:** free, key-free OpenSeaMap seamarks, marine protected areas, maritime boundaries, and
|
|
43
|
+
NASA GIBS ocean conditions (sea-surface temperature and sea ice), each with its source attribution.
|
|
39
44
|
- **Routing:** draw and save routes as Signal K resources and follow one with a nav strip
|
|
40
45
|
(cross-track, distance, bearing, velocity made good, and time to go) over the v2 Course API, with
|
|
41
46
|
an arrival alarm.
|
|
42
47
|
- **Weather:** a zoom-capped mini-map with animated WebGL wind, pressure isobars, waves,
|
|
43
48
|
precipitation, cloud, and radar, a tap-for-value readout, and a conditions and warnings panel.
|
|
49
|
+
- **Tides:** the nearest NOAA tide station's next high and low with a 48-hour curve, and the nearest
|
|
50
|
+
tidal-current station's next flood or ebb, for US waters.
|
|
44
51
|
- **Lookout:** a collision watch with CPA and TCPA, chart-highlight rings, an audible alarm, and a
|
|
45
52
|
published Signal K notification.
|
|
46
53
|
- **Tracks:** record, save, show, and export your voyage track.
|
|
@@ -98,6 +105,17 @@ To add HTTPS to Signal K, the simplest way is the
|
|
|
98
105
|
issues the server certificate, and distributes the root to your devices by QR code. The Signal K
|
|
99
106
|
server's built-in SSL settings (Server, then Settings, then SSL) are an alternative.
|
|
100
107
|
|
|
108
|
+
One more step is required, and it is easy to miss: your browser has to **trust** that certificate,
|
|
109
|
+
not just reach it. A self-signed certificate, including one the signalk-ssl plugin generates, is not
|
|
110
|
+
trusted by default, and browsers refuse to register a service worker from an origin whose certificate
|
|
111
|
+
they do not trust, even after you click through the page's certificate warning. So if you only accept
|
|
112
|
+
the one-time warning, the page loads but offline caching never activates, and the console shows a
|
|
113
|
+
message like "service worker registration failed: an SSL certificate error occurred." To fix it,
|
|
114
|
+
install the certificate authority's root (the QR code or `.pem` the plugin gives you) into your
|
|
115
|
+
browser or operating system trust store and mark it trusted, then reload over HTTPS. Once the
|
|
116
|
+
certificate is trusted, the service worker registers and the base map and chart tiles cache for
|
|
117
|
+
offline use.
|
|
118
|
+
|
|
101
119
|
## Development
|
|
102
120
|
|
|
103
121
|
This project targets Node 22 or newer. Lint and format use the Biome binary, which must be installed
|