Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/LukeSkywalker92/MMM-DWD-WarnWeather
Weather-Warnings for MagicMirror2
https://github.com/LukeSkywalker92/MMM-DWD-WarnWeather
Last synced: 3 months ago
JSON representation
Weather-Warnings for MagicMirror2
- Host: GitHub
- URL: https://github.com/LukeSkywalker92/MMM-DWD-WarnWeather
- Owner: LukeSkywalker92
- License: mit
- Created: 2016-11-09T18:17:20.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-02-13T15:41:35.000Z (9 months ago)
- Last Synced: 2024-06-29T10:33:08.764Z (5 months ago)
- Language: JavaScript
- Homepage:
- Size: 889 KB
- Stars: 63
- Watchers: 8
- Forks: 19
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-mmm - **MMM-DWD-WarnWeather**
README
MMM-DWD-WarnWeather
===================
This a module for the [MagicMirror](https://github.com/MichMich/MagicMirror). It can display weather-warnings of [Deutscher Wetterdienst](http://www.dwd.de/DE/Home/home_node.html). The module shows you current weather-warnings of your region in Germany.
## Preview
## Installation
1. Navigate into your MagicMirror's `modules` folder and execute `git clone https://github.com/LukeSkywalker92/MMM-DWD-WarnWeather.git`. A new folder will appear, navigate into it.
2. Execute `npm install` to install the node dependencies.
## Config
The entry in `config.js` can include the following options:
|Option|Description|
|---|---|
|`region`|now using the new more detailed DWD API.
To find the correct region name:
- go [here](https://maps.dwd.de/geoserver/dwd/wms?service=WMS&version=1.1.0&request=GetMap&layers=dwd:Warngebiete_Gemeinden&styles=&bbox=5.876914,47.270362,15.037507,55.044381&width=1024&height=868&srs=EPSG:4326&format=application/openlayers#)
- toggle options toolbar (three dots at the top left)
- if necessary enter "NAME LIKE '%<your region name>%'" at the top right next to the 'CQL' dropdown
- optional: change style in dropdown from "Default" to "Warngebiete_Gemeinden_Text" for easier selection
- click on your city/town/community/area...
- the correct region name is KURZNAME from the table below the map (case sensitive!)
**Type:** `string`
Use **either** this **or** `lat` and `lng`.|
|`warnCellID`|Cell ID of your region. You can find your region using [this csv file](https://www.dwd.de/DE/leistungen/opendata/help/warnungen/cap_warncellids_csv.csv?__blob=publicationFile&v=3)
Use **either** this **or** `lat` and `lng` **or** `region`.|
|`lat`|Latitude of the place to check.
Use **either** this and `lng` **or** `warnCellID` **or** `region`.|
|`lng`|Longitude of the place to check.
Use **either** this and `lat` **or** `warnCellID` **or** `region`.|
|`changeColor`|When `changeColor` is set to true, the color of the warning icons will change based on the warning level.
**Default value:** `true`|
|`interval`|How often the warnings are updated.
**Default value:** `10 • 60 • 1000` // every 10 minutes|
|`longversion`|Show the full Description of Warnings if true.
**Default value:** `false`|
|`width`|set the piont, where the full Description break down.
**Default value:** `55`|
|`minutes`|show minutes in start ad end time information
**Default value:** `true`|
|`displayRegionName`|show region name in header info
**Default value:** `true`|
|`loadingText`|The text used while loading warnings.
**Default value:** `'Warnungen werden geladen...'`|
|`noWarningText`|The text used when there are no warnings for your region.
**Default value:** `'Keine Warnungen'`|
|`hideNoWarning`|Hide the module when no warning is available.
**Default value:** `false`|
|`severityThreshold`|The warning level at which the weather warnings are to be displayed.
**Type:** Integer, **Values:** 1, 2, 3, 4
**Default value:** `1`|
|`displayInnerHeader`|Display a second header line with the text "Wetterwarnungen" appended by the region if displayRegionName is set to true.
**Type:** boolean, **Values:** true, false
**Default value:** `true`|
Here is an example of an entry in `config.js`
```
{
module: 'MMM-DWD-WarnWeather',
position: 'top_left',
header: 'Wetterwarnungen',
config: {
region: 'Lörrach',
changeColor: true,
minutes: false,
displayRegionName: true,
displayInnerHeader: true,
interval: 10 * 60 * 1000, // every 10 minutes
loadingText: 'Warnungen werden geladen...',
noWarningText: 'Keine Warnungen',
severityThreshold: 2
}
},
```
## Dependencies
- [request](https://www.npmjs.com/package/request) (installed via `npm install`)
## Important Notes
- This is my first project using Node, so feel free to submit pull requests or post on the issues/wiki and I will do my best to improve the project.
- Right now the data for warnings comes from the *Deutsche Wetterdienst*. So the warnings are only available for germany. If you find an similar API for other countries, feel free to give me a hint or to implement this API in this module yourself.
- Because it's only data for germany, i did not translate any of the warnings to english. Also feel free to do that.
## Special Thanks
- [Michael Teeuw](https://github.com/MichMich) for creating the awesome [MagicMirror2](https://github.com/MichMich/MagicMirror/tree/develop) project that made this module possible.
- [SamLewis0602](https://github.com/SamLewis0602) for creating the [MMM-Traffic](https://github.com/SamLewis0602/MMM-Traffic) module that I used as guidance in creating this module.
## Documentation of the DWD Api
WMS-Dienste für die eigene Website: https://www.dwd.de/DE/wetter/warnungen_aktuell/objekt_einbindung/einbindung_karten_geowebservice.pdf?__blob=publicationFile&v=11
Common Alerting Protocol: https://www.dwd.de/DE/leistungen/opendata/help/warnungen/cap_dwd_profile_de_pdf.pdf
Severity levels:
- Minor (Level 1 - Wetterwarnung - Gelb)
- Moderate (Level 2 - Markante Wetterwarnung - Orange)
- Severe (Level 3 - Unwetterwarnung - Rot)
- Extreme (level 4 - Extreme Unwetterwarnung - Violet)