@mxtommy/kip 4.5.0-beta.1 → 4.5.0

package/public/assets/help-docs/widget-historical-series.md

@@ -0,0 +1,66 @@
+
+
+## Widget Historical Chart
+
+Widgets that use numeric paths automatically track and store data for their configured paths. This lets you easily view charts showing the last 15 minutes, 1 hour, 8 hours, or 24 hours of data.
+
+## Accessing Widget Historical Charts
+
+### Locked Dashboard Quick View
+You can open a widget history dialog directly from a locked dashboard:
+
+- **Touch devices:** Two-finger tap a widget
+- **Desktop / mouse:** Right-click a widget or two-finger click on trackpads
+
+This dialog displays only historical data (no live stream overlay).
+
+## Which Widgets Support History?
+Most widgets that use numeric paths support history, including the Horizon widget.
+
+## Which Chart Widgets Support Data Seeding?
+
+### Data Chart Widget
+- **Supported:** Yes, fully seeded with history data.
+- **Requirements:** Time scale must be minutes or longer.
+
+### Wind Trends Widget
+- **Supported:** Yes, fully seeded with history data.
+- **Requirements:** Time span of `5 minutes` or `30 minutes`.
+
+### Numeric Widget's Mini Chart
+- **Supported:** No. Mini charts use very short time windows (12 seconds) and skip history seeding.
+- Mini charts start live-only for performance reasons.
+
+### History Seeding
+When you open a chart widget with a large time scale (minutes or larger):
+1. KIP requests historical data points.
+2. The chart immediately displays the historical trend.
+
+### Live Updates
+After history data loads:
+- New data points arrive continuously.
+- The chart smoothly transitions from history to live updates.
+- Old data points are removed to maintain a rolling window of the configured time scale.
+
+## How Does Historical Widget Data Work?
+
+KIP and its server-side plugin work together to seamlessly monitor dashboard and widget configurations. For numeric and chart-type widgets (such as Data Chart and Wind Trends), time-series data is automatically captured and managed in the background. For the Data Chart widget, this enables pre-filling the chart instead of starting empty.
+
+Time-series data is pruned automatically, retaining only the data required by active widgets and only for the time ranges those widgets display. This process is fully transparent, requires no manual intervention, and keeps server storage efficient and lean.
+
+This feature uses History-API query/request, introduced in Signal K version 2.22.1.
+
+## Configuration Options
+
+Configuration options are found in **Settings → Options → Display** under the Widget Historical Data section.
+
+You can:
+- Disable KIP's automatic time-series and data capture services and use a History-API provider of your choice. See [Using The History-API](history-api.md) in the Integrations Help menu for more details.
+- Disable access to widget historical charts (disables two-finger tap, mouse right-click, or two-finger click on trackpads).
+
+If you don't want to use this feature, set the option to use a History API provider (this turns off the plugin's data collection), and disable widget historical charts to also disable the UI elements.
+
+## Questions or Issues?
+
+- Refer to [Using The History-API](history-api.md) to learn how to use other History API providers.
+- For general questions or issues, see the `Contact-Us` help page—the KIP community is active on Discord and GitHub.

package/public/assets/help-docs/zones.md

@@ -2,7 +2,6 @@
 
 Stay informed about your vessel’s data with Signal K’s state notifications. For example, Signal K can flag certain sensor readings—such as depth or temperature—when they reach critical levels. KIP can then visually or audibly alert you. For instance, if the depth drops to 3 meters or less, KIP can highlight this with a warning sound or visual cue. This powerful feature combines **Zones Configuration** and **Notification Methods** in Signal K.
 
----
 
 ## Zones & Notification Configuration
 
@@ -15,7 +14,6 @@ For more details on path units, see the [Keys Reference (Vessel)](https://signal
 
 As path values move between zone ranges, Signal K generates a notification sent to KIP. Each notification includes a state (severity), optional presentation methods (visual and/or sound), and an optional message.
 
----
 
 ### Zone State and Method Guidance
 
@@ -26,13 +24,12 @@ As path values move between zone ranges, Signal K generates a notification sent
 - KIP uses predefined, state specific sound files.
 - You can configure KIP to globally ignore audio prompts in **Settings > Notifications**; this applies globally to all notifications and paths.
 
-**Tips:**
-1. You don’t need zones for every path.
-2. You don’t need to configure every zone for a given path. Only configure what is really needed. For example, if all you want is to be alerted at 20% State Of Charge, just add one zone with the Alarm state and method. No need for Warn and Alert zones in this case.
-3. Don't enable the **visual** method if you don't want a zone state in the Notifications menu.
-4. Keep your zone setup simple—too many Notifications can become overwhelming.
+>**Tips:**
+>1. You don’t need zones for every path.
+>2. You don’t need to configure every zone for a given path. Only configure what is really needed. For example, if all you want is to be alerted at 20% State Of Charge, just add one zone with the Alarm state and method. No need for Warn and Alert zones in this case.
+>3. Don't enable the **visual** method if you don't want a zone state in the Notifications menu.
+>4. Keep your zone setup simple—too many Notifications can become overwhelming.
 
----
 
 ### Taking Action on Notifications
 
@@ -46,7 +43,6 @@ You can **Silence** or **Resolve** notifications.
 - If you turn off a device, then resolve its last notification, it will remain resolved until the device is powered back on and sends new data.
 - Different devices send data at different intervals—some multiple times per second, others as infrequently as once per day. Check your device or plugin documentation for details. Once a notification is silenced or resolved, it will stay in this state until a new value is received and evaluated.
 
----
 
 ## Displaying Zones and Notifications
 
@@ -81,7 +77,6 @@ You can **Silence** or **Resolve** notifications.
 - **Individual Widgets:**  
   Widgets such as **Numeric**, **Simple Linear**, **Linear**, **Radial**, and **Steel Style** visually highlight relevant data ranges according to their configured zones and integrate notification states into their display. You can configure each widget to ignore zones if desired.
 
----
 
 ## KIP Notification Configuration Override