feature: Weather API definition. #1733
Conversation
There was a problem hiding this comment.
@panaaj nice work on this proposal. I'm curious what the current status is.
One question: what would you think about adding parameters to control the date/range of the forecast. For example, getting a 3-day vs 7-day forecast, and specifying a start date. Specifically, I'm thinking about tides, but I think it applies to all the data.
I recently released the signalk-tides plugin, which uses the resource API to return tide forecast, and accepts a date parameter.
| _Note: This API is currently under development and the information provided here is likely to change._ | ||
|
|
||
|
|
||
| The Signal K server [Weather API](../rest-api/autopilot_api.md) will provide a common set of operations for retrieving meteorological data and (like the Resources API) will rely on a "provider plugin" to facilitate communication with the autopilot device. |
There was a problem hiding this comment.
I'm confused about the references to autopilot here. Is this just remnants of a copy/paste from another doc?
| water?: { | ||
| temperature?: number | ||
| level?: number | ||
| levelTendency?: TendencyKind |
There was a problem hiding this comment.
Just to clarify, is this for tide level? If so, I'm curious if you have thoughts on how this API would be used to get the tide forecast. For example, the time and height of the next extreme, or a 3/5/7 day tide forecast.
There was a problem hiding this comment.
It is there because this is a path that appears in the meteo context that is populated from AIS messages.
More of an alignment thing at this stage of the game.
There was a problem hiding this comment.
Just to clarify, is this for tide level?
Water level (incl. tide):
Deviation from local chart datum, in 0.01 metre steps. -10.0 to +30.0 metres
Water level trend:
0 = steady, 1 = decreasing, 2 = increasing
More info here:
https://www.iala.int/asm/meteorological-hydrographic-data/
https://academy.iala.int/asm/metreorological-hydrological-data-2/
|
This has stalled due to prioritising work on the autopilot API, but am keen to progress. |
|
I think alignment with tides information, where it makes sense, is a good idea. |
|
Updated to accept the number of forecast (hourly or point) or observation records to return. Will add the option to accept a date. |
|
I feel this is somewhat closer to a first release. |
|
@tkurki Seeking review with the intent to merge ready for next server release. |
Version 2 Weather API:
Goals:
Features:
/signalk/v2/api/weather/signalk/v2/api/weather/_providersThe following table contains links to weather provider plugins that are ready for publishing once the API is merged and available.