signalk-basic-tide-widgets
v0.0.1
Published
Lightweight, provider-agnostic chart-plotter tide widgets driven by the standard Signal K environment.tide.* data.
Downloads
316
Maintainers
Readme
Basic Tide Widgets
Lightweight tide widgets for web-based Signal K chartplotters (Freeboard-SK and any other host that supports the Plotter Extensions API).
These widgets show tide information using only the standard Signal K
environment.tide.* data, so they work with any plugin that publishes those
paths — including signalk-tides and signalk-tide-watch. There is
no configuration of stations or data sources: install a tide provider, install
this, and place the widgets on your chart.
Widgets
| Widget | Size | Shows | | ------ | ---- | ----- | | Tide Level (Basic) | 1×1 | The current tide level relative to mean-low water, plus the next low and high times. | | Tide Cycle (Basic) | 2×1 | The current level over an estimated tide curve — last and next low/high. |
A small configuration panel (long-press a widget) lets you choose the time
format (8:30a, 8:30 AM, or 08:30), the font sizes, and the depth units.
Depth units start on "Server default", which shows tide heights in the unit you've chosen in the Signal K server's Unit Preferences — so the widgets match the rest of your system automatically, and changing the preference on the server updates them too. Switch a widget to Feet or Meters only when you want that one widget to override your server preference.
Estimated curve. The standard tide deltas only carry the next high and low, so the 2×1 graph estimates the surrounding cycle. It is meant for a quick glance, not precise planning.
Want the full, multi-day, harmonic-accurate tide graph?
Install signalk-tides by openwaters.io, powered by the
excellent Neaps offline tide engine. It computes true multi-day
predictions for your position and ships its own richer Tide Graph widget.
This "Basic" pack is the low-bar option for when you just want something from the
standard data; signalk-tides is the real thing.
Installation
Install from the Signal K App Store (search "Basic Tide Widgets"), or:
npm install signalk-basic-tide-widgetsThen enable the plugin in the Signal K server admin UI. Make sure a tide
provider that publishes environment.tide.* (e.g. signalk-tides) is also
installed and running.
Requirements
- A Signal K server.
- A chartplotter host implementing the Plotter Extensions API (e.g. Freeboard-SK).
- A tide provider publishing
environment.tide.*.
