Skip to content
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.

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

weathergov: Removed weatherEndpoint. Added hourly under "Type:" #132

Merged
merged 2 commits into from
Jan 12, 2023
Merged
Changes from all commits
Commits
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
3 changes: 1 addition & 2 deletions modules/weather.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The following properties can be configured:
| Option | Description |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `weatherProvider` | Which weather provider should be used. <br><br> **Possible values:** `openweathermap` , `darksky` , `weathergov`, `ukmetofficedatahub`, `ukmetoffice`, `weatherbit`, or `envcanada`<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: <br> **Environment Canada** (`envcanada`) provider <br> **OpenWeatherMap** provider, and only when `/onecall` is used as the specified endpoint. |
| `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: <br>- **Environment Canada** (`envcanada`) provider <br>- **OpenWeatherMap** (openweathermap) provider, and only when `/onecall` is used as the specified endpoint.<br>- **Weather.gov** (weathergov) provider, MagicMirror<sup>2</sup> v2.22.0 |
| `units` | What units to use. Specified by config.js <br><br> **Possible values:** `config.units` = Specified by config.js, `default` = Kelvin, `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, `default` = Kelvin, `metric` = Celsius, `imperial` = Fahrenheit <br> **Default value:** `units` |
| `windUnits` | What units to use for wind speed. If not specified, the module uses the `units` value from `config.js`. <br><br> **Possible values:** `config.units` = Specified by config.js, `mps` = metres per second, `kmh` or `metric` = kilometres per hour, `mph` or `imperial` = miles per hour **Default value:** `units` |
Expand Down Expand Up @@ -115,7 +115,6 @@ Please note Darksky no longer accept new signups and the API will shutdown at th
| Option | Description |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `apiBase` | The weather.gov base URL. <br><br> **Possible value:** `'https://api.weather.gov/points/'` <br> This value is **REQUIRED** |
| `weatherEndpoint` | The weather.gov API endPoint. <br><br> **Possible values:** `/forecast` for forecast and `/forecast/hourly` for current. <br> This value is **REQUIRED** |
| `lat` | The geo coordinate latitude. <br><br> This value is **REQUIRED** |
| `lon` | The geo coordinate longitude. <br><br> This value is **REQUIRED** |

Expand Down