Signal K
    Preparing search index...

    Interface WeatherProviderMethods

    interface WeatherProviderMethods {
        getForecasts: (
            position: Position,
            type: WeatherForecastType,
            options?: WeatherReqParams,
        ) => Promise<WeatherData[]>;
        getObservations: (
            position: Position,
            options?: WeatherReqParams,
        ) => Promise<WeatherData[]>;
        getWarnings: (position: Position) => Promise<WeatherWarning[]>;
        pluginId?: string;
    }
    Index

    Other

    pluginId?

    Weather API

    getForecasts getObservations getWarnings

    Other

    pluginId?: string

    Weather API

    getForecasts: (
        position: Position,
        type: WeatherForecastType,
        options?: WeatherReqParams,
    ) => Promise<WeatherData[]>

    Retrieves forecast data from the weather provider for the supplied position, forecast type and number of intervals. The returned array of forecasts should be ordered in ascending date order.

    Type declaration

    Retrieve point forecast data for the next eight point intervalss

    getForecasts(
      {latitude: 16.34765, longitude: 12.5432}, 
      'point',
      {maxCount: 8}
    );

    [
        {
            "date": "2024-05-03T06:00:00.259Z",
            "type": "point",
            "outside": { ... }
        },
        {
            "date": "2024-05-03T05:00:00.259Z",
            "type": "point",
            "outside": { ... }
        }
    ]
    getObservations: (
        position: Position,
        options?: WeatherReqParams,
    ) => Promise<WeatherData[]>

    Retrieves observation data from the weather provider for the supplied position. The returned array of observations should be ordered in descending date order.

    Type declaration

     getObservations({latitude: 16.34765, longitude: 12.5432}, {maxCount: 1});

    [
        {
            "date": "2024-05-03T06:00:00.259Z",
            "type": "observation",
            "outside": { ... }
        },
        {
            "date": "2024-05-03T05:00:00.259Z",
            "type": "observation",
            "outside": { ... }
        }
    ]
    getWarnings: (position: Position) => Promise<WeatherWarning[]>

    Retrieves warning data from the weather provider for the supplied position. The returned array of warnings should be ordered in ascending date order.

    Type declaration

     getWarnings({latitude: 16.34765, longitude: 12.5432});

    [
      {
        "startTime": "2024-05-03T05:00:00.259Z",
        "endTime": "2024-05-03T08:00:00.702Z",
        "details": "Strong wind warning.",
        "source": "MyWeatherService",
        "type": "Warning"
      }
    ]

    On This Page

    Other
    Weather API