Skip to content

feat: add weatherapi options to weather module configuration #359

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
angeldeejay wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

feat: add weatherapi options to weather module configuration #359

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion modules/weather.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The following properties can be configured:

| Option | Description |
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `weatherProvider` | Which weather provider should be used. <br><br> **Possible values:** `openweathermap` , `pirateweather` , `weathergov`, `ukmetofficedatahub`, `weatherbit`, `envcanada`, `openmeteo`, `weatherflow`, `SMHI` or `yr`<br> **Default value:** `openweathermap` |
| `weatherProvider` | Which weather provider should be used. <br><br> **Possible values:** `openweathermap` , `pirateweather` , `weathergov`, `ukmetofficedatahub`, `weatherbit`, `envcanada`, `openmeteo`, `weatherflow`, `SMHI`, `weatherapi` or `yr`<br> **Default value:** `openweathermap` |
| `type` | Which type of weather data should be displayed. <br><br> **Possible values:** `current` , `hourly` , `daily` , or `forecast` <br> **Default value:** `current` <br><br> **Note:** The `daily` type is another name for the `forecast` type, and the two are interchangeable. <br><br> The `hourly` type is currently only implemented for these provider: <br>- **Environment Canada** (`envcanada`) <br>- **Openmeteo** <br>- **OpenWeatherMap** (`openweathermap`), and only when `/onecall` is used as the specified endpoint. Latitude and longitude [(see below)](/modules/weather#openweathermap-options) are **required** for `hourly`. The locationID and location options are ignored when the OpenWeatherMap One Call API is used and you will get wrong weather information.<br>- **Weather.gov** (`weathergov`)<br/>- **Yr** (`yr`) |
| `units` | What units to use. Specified by config.js <br><br> **Possible values:** `config.units` = Specified by config.js, `metric` = Celsius, `imperial` = Fahrenheit <br> **Default value:** `config.units` |
| `tempUnits` | What units to use for temperature. If not specified, the module uses the `units` value from `config.js`. <br><br> **Possible values:** `config.units` = Specified by config.js, `metric` = Celsius, `imperial` = Fahrenheit <br> **Default value:** `config.units` |
Expand Down Expand Up @@ -193,6 +193,15 @@ hours.
| `maxNumberOfDays` | How many days of forecast to return. Specified by config.js <br><br> **Possible values:** `1` - `8` <br> **Default value:** `5` (5 days) <br> This value is optional. By default the weather module will return 5 days. |
| `pastDays` | How many days should forecast should include from historic data. Specified by config.js <br><br> **Possible values:** `0` - `5` <br> **Default value:** `0` (0 days) <br> This value is optional. By default the weather module will return 0 days from historical data. <br><br> **Note:** Since Open-Meteo returns 8 days of data at all, this setting could reduce the range of forecast data set on `maxNumberOfDays`. e.g. if `maxNumberOFDays` is set to `7` and `pastDays` is set to `5`, data received will be from 5 days from the past to 2 days in the future (8 days) |

### Weather API (`weatherapi`) options

| Option | Description |
| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `apiBase` | The Weather API base URL.<br><br> **Possible value:** `https://api.weatherapi.com/v1` <br> This value is **REQUIRED** |
| `apiKey` | The [Weather API](https://www.weatherapi.com) key which can be obtained by creating an Weather API account <br><br> This value is **REQUIRED** |
| `lat` | The latitude coordinate for the desired location. <br><br> **Possible value:** `59.322665` <br> This value is **REQUIRED** |
| `lon` | The longitude coordinate for the desired location. <br><br> **Possible value:** `18.069666` <br> This value is **REQUIRED** |

### Yr options

The Yr weather provider is quite simple to set up, and only requires the
Expand Down