Skip to content

Latest commit

 

History

History
50 lines (22 loc) · 2.01 KB

README.md

File metadata and controls

50 lines (22 loc) · 2.01 KB

Open-Meteo weather provider plugin for Signal K server

Signal K Server plugin for integrating the Open-Meteo weather service with the Weather API.

Description

This plugin communicates with the Open-Meteo API and acts as a provider for the Signal K Weather API to expose weather data under the path /signalk/v2/api/weather (see the Signal K Server documentation for details).

Requests from the Signal K server, via the Weather API, are passed to the plugin which then retrieves the forecast and observation data from the Open-Meteo service.

You can select the number of daily forecasts and hourly point forecasts as well as have the plugin poll Open-Meteo at regular intervals to retrieve weather data for the vessels current location.

Weather data is accessed by making requests to the Signal K Server REST API /signalk/v2/api/weather.

Additionally, weather data retrieved from polling using the vessels position is available via /signalk/v1/api/meteo/openmeteo.

Data Caching

Data retrieved fron the Open-Meteo service is cached to reduce the number of requests made over the Internet connection.

The cache data is refreshed when a request is received for a location within the cached area AND the age of the cached data >= poll interval.

Configuration

From the Signal K server Admin console:

  • Select Server -> Plugin Config

  • From the list of plugins select Open-Meteo (Weather Provider) to display the details screen.

  • Select the number of Daily forecasts to retrieve

  • Select the number of Hourly Point forecasts to retrieve from Open-Meteo.

  • Select the polling interval. (Note: This is also used as the maximum age for cache data.)

  • Check Poll periodically using vessel position to regularly fetch weather data for the vessel's current posiition.

  • Optional: Enter an Open-Meteo API Key. This will, in future releases, enable "premium content" only available with a subscription to be accessed.

Requirements

  • Signal K Server that implements the Weather API.