From 81e17a3bfe7316f99b92721688c38051e1d3554a Mon Sep 17 00:00:00 2001 From: Kristjan ESPERANTO <35647502+KristjanESPERANTO@users.noreply.github.com> Date: Mon, 9 Jun 2025 00:31:22 +0200 Subject: [PATCH] docs: remove `REQUIRED` from some default values + fix typos --- modules/weather.md | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/modules/weather.md b/modules/weather.md index 44356c18..bf41082b 100755 --- a/modules/weather.md +++ b/modules/weather.md @@ -49,7 +49,7 @@ The following properties can be configured: | `type` | Which type of weather data should be displayed.

**Possible values:** `current` , `hourly` , `daily` , or `forecast`
**Default value:** `current`

**Note:** The `daily` type is another name for the `forecast` type, and the two are interchangeable.

The `hourly` type is currently only implemented for these provider:
- **Environment Canada** (`envcanada`)
- **Openmeteo**
- **OpenWeatherMap** (`openweathermap`), and only when `/onecall` is used as the specified endpoint. Latitude and longitude [(see below)](/modules/weather.md#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.
- **Weather.gov** (`weathergov`)
- **Yr** (`yr`) | | `units` | What units to use. Specified by config.js

**Possible values:** `config.units` = Specified by config.js, `metric` = Celsius, `imperial` = Fahrenheit
**Default value:** `config.units` | | `tempUnits` | What units to use for temperature. If not specified, the module uses the `units` value from `config.js`.

**Possible values:** `config.units` = Specified by config.js, `metric` = Celsius, `imperial` = Fahrenheit
**Default value:** `config.units` | -| `windUnits` | What units to use for wind speed. If not specified, the module uses the `units` value from `config.js`.

**Possible values:** `config.units` = Specified by config.js, `mps` or `metric` = metres per second, `kmh` = kilometres per hour, `mph` or `imperial` = miles per hour, `beaufort` = use beaufort scale, `knots` = show wind in knots
**Default value:** `units` | +| `windUnits` | What units to use for wind speed. If not specified, the module uses the `units` value from `config.js`.

**Possible values:** `config.units` = Specified by config.js, `mps` or `metric` = metres per second, `kmh` = kilometers per hour, `mph` or `imperial` = miles per hour, `beaufort` = use beaufort scale, `knots` = show wind in knots
**Default value:** `units` | | `roundTemp` | Round temperature value to nearest integer.

**Possible values:** `true` (round to integer) or `false` (display exact value with decimal point)
**Default value:** `false` | | `degreeLabel` | Show the degree label for your chosen units (Metric = C, Imperial = F).

**Possible values:** `true` or `false`
**Default value:** `false` | | `updateInterval` | How often does the content needs to be fetched? (Milliseconds)

**Possible values:** `1000` - `86400000`
**Default value:** `600000` (10 minutes) | @@ -93,7 +93,7 @@ The following properties can be configured: | `maxEntries` | How many entries of an OpenWeatherMap One Call hourly or daily forecast type to return. Specified by config.js

**Possible values:** `1` - `48` for `'hourly'` , `1` - `7` for `'daily'`
**Default value:** `5` (5 entries)
This value is optional and specifically meant to be used with the OpenWeatherMap provider and its `'/onecall'` endpoint. By default the weather module will return 5 entries. Intended to act as a more generalized of the `maxNumberOfDays` option. | | `ignoreToday` | If set to `true`, today's weather will not be displayed.

**Possible values:** `true` or `false`
**Default value:** `false` | -### Openweathermap options +### OpenWeatherMap options **Note:** When using the type: "forecast" config, if you are using a free api key, the max forecast days you can retrieve is 5. Providing anything higher than @@ -115,25 +115,25 @@ retrieve more than 5 days you must subscribe to the OpenWeatherMap API. | Option | Description | | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `apiBase` | The Pirate Weather base URL.

**Possible value:** `'https://api.pirateweather.net'`
This value is **REQUIRED** | -| `weatherEndpoint` | The Pirate Weather API endPoint.

**Possible values:** `/forecast`
This value is **REQUIRED** | +| `apiBase` | The Pirate Weather base URL.

**Default value:** `'https://api.pirateweather.net'` | +| `weatherEndpoint` | The Pirate Weather API endPoint.

**Default value:** `/forecast` | | `apiKey` | The [Pirate Weather](https://pirateweather.net/) API key, which can be obtained by creating a Pirate Weather account.

This value is **REQUIRED** | | `lat` | The geo coordinate latitude.

This value is **REQUIRED** | | `lon` | The geo coordinate longitude.

This value is **REQUIRED** | ### Weather.gov options -| Option | Description | -| --------- | -------------------------------------------------------------------------------------------------------------------------- | -| `apiBase` | The weather.gov base URL.

**Possible value:** `'https://api.weather.gov/points/'`
This value is **REQUIRED** | -| `lat` | The geo coordinate latitude.

This value is **REQUIRED** | -| `lon` | The geo coordinate longitude.

This value is **REQUIRED** | +| Option | Description | +| --------- | ----------------------------------------------------------------------------------------- | +| `apiBase` | The weather.gov base URL.

**Default value:** `'https://api.weather.gov/points/'` | +| `lat` | The geo coordinate latitude.

This value is **REQUIRED** | +| `lon` | The geo coordinate longitude.

This value is **REQUIRED** | ### UK Met Office (`ukmetoffice`) options | Option | Description | | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `apiBase` | The UKMO base URL.

**Possible value:** `'https://datapoint.metoffice.gov.uk/public/data/val/wxfcs/all/json/'`
This value is **REQUIRED** | +| `apiBase` | The UKMO base URL.

**Default value:** `'https://datapoint.metoffice.gov.uk/public/data/val/wxfcs/all/json/'` | | `locationID` | The UKMO API location code.

**Possible values:** `322942`
This value is **REQUIRED** | | `apiKey` | The [UK Met Office](https://www.metoffice.gov.uk/datapoint/getting-started) API key, which can be obtained by creating an UKMO Datapoint account.

This value is **REQUIRED** | @@ -141,7 +141,7 @@ retrieve more than 5 days you must subscribe to the OpenWeatherMap API. | Option | Description | | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `apiBase` | The UKMO DataHub base URL.

**Possible value:** `'https://data.hub.api.metoffice.gov.uk/sitespecific/v0/point/'`
This value is **REQUIRED** | +| `apiBase` | The UKMO DataHub base URL.

**Default value:** `'https://data.hub.api.metoffice.gov.uk/sitespecific/v0/point/'` | | `apiKey` | Your API key (MetOffice API ClientID). See the [Getting Started](https://datahub.metoffice.gov.uk) guide on the Met Office website for creating a new account. Subscribe to the Site Specific Forecast service - Global Spot.
This value is **REQUIRED** | | `lat` | The latitude coordinate for the desired location.

**Possible value:** `50.7271915`
This value is **REQUIRED** | | `lon` | The longitude coordinate for the desired location.

**Possible value:** `-3.4776089`
This value is **REQUIRED** | @@ -150,7 +150,7 @@ retrieve more than 5 days you must subscribe to the OpenWeatherMap API. | Option | Description | | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -| `apiBase` | The Weather base URL.

**Possible value:** `https://api.weatherbit.io/v2.0`
This value is **REQUIRED** | +| `apiBase` | The Weather base URL.

**Default value:** `'https://api.weatherbit.io/v2.0'` | | `weatherEndpoint` | The Weatherbit API endPoint.

**Possible values:** `/current`, `/forecast/daily`
This value is **REQUIRED** | | `apiKey` | The [Weatherbit API](https://www.weatherbit.io) key which can be obtained by creating an WeatherBit account

This value is **REQUIRED** | | `lat` | The geo coordinate latitude.

This value is **REQUIRED** | @@ -172,7 +172,7 @@ retrieve more than 5 days you must subscribe to the OpenWeatherMap API. When using the `type: "forecast"` config, the module can display a max of 6 days (Today + the next 5 days). The forecast for each day reflects the daytime forecast. The Today forecast is a special case that will reflect the daytime -forecast until late afternoon, after which Today will be reflecting the nightime +forecast until late afternoon, after which Today will be reflecting the nighttime forecast for the current day. When using the `type: "hourly"` config, the module can display a max of 24 @@ -186,17 +186,17 @@ hours. ### Weatherflow options -| Option | Description | -| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `apiBase` | The Weatherflow base URL.

**Possible value:** `https://swd.weatherflow.com/swd/rest/`
This value is **REQUIRED** | -| `token` | The [Weatherflow](https://weatherflow.github.io/Tempest/api/) token which can be obtained in the webapp of Weatherflow

This value is **REQUIRED** | -| `stationid` | The id of your weather station from wich you want to show the data. This also can be obtained in the webapp of Weatherflow

This value is **REQUIRED** | +| Option | Description | +| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `apiBase` | The Weatherflow base URL.

**Default value:** `'https://swd.weatherflow.com/swd/rest/'` | +| `token` | The [Weatherflow](https://weatherflow.github.io/Tempest/api/) token which can be obtained in the webapp of Weatherflow

This value is **REQUIRED** | +| `stationid` | The id of your weather station from which you want to show the data. This also can be obtained in the webapp of Weatherflow

This value is **REQUIRED** | ### Open-Meteo (`openmeteo`) options | Option | Description | | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `apiBase` | The Weatherflow base URL.

**Possible value:** `https://api.open-meteo.com/v1`
This value is **REQUIRED** | +| `apiBase` | The Weatherflow base URL.

**Default value:** `'https://api.open-meteo.com/v1'` | | `lat` | The latitude coordinate for the desired location.

**Possible value:** `59.322665`
This value is **REQUIRED** | | `lon` | The longitude coordinate for the desired location.

**Possible value:** `18.069666`
This value is **REQUIRED** | | `maxNumberOfDays` | How many days of forecast to return. Specified by config.js

**Possible values:** `1` - `8`
**Default value:** `5` (5 days)
This value is optional. By default the weather module will return 5 days. |