MMM-MyCovid19/README.md

50 lines
1.7 KiB
Markdown
Raw Normal View History

2020-07-26 08:50:34 +00:00
# Module: MMM-covid19
This module displays COVID-19 data aggregated by [c19d](https://c19d.smsvc.net).
2020-07-26 08:50:34 +00:00
2020-07-26 13:35:36 +00:00
![](screenshot.png)
2020-07-26 08:50:34 +00:00
## Installation
1. Navigate to the `MagicMirror/modules` directory.
1. Clone the module
1. Configure the module as per below
1. Restart MagicMirror
## Using the module
```javascript
modules: [
{
2021-12-29 08:57:02 +00:00
module: "MMM-MyCovid19",
2020-07-26 08:50:34 +00:00
position: "top_left",
config: {
// The config property is optional.
// See 'Configuration options' for more information.
}
}
]
```
## Configuration options
| Option | Description |
| ------ | ----------- |
| `region` | Choose region to be fetched <br> **Default:** `Bonn` |
| `updateInterval` | How often does the content needs to be fetched? (Milliseconds) <br> **Default:** 10800000 (4 hours) |
2020-08-05 20:11:13 +00:00
| `showHeader` | Show *COVID-19 Daten* as module header? <br> **Values:** `true` or `/false` <br> **Default:** `true` |
2020-07-26 08:50:34 +00:00
| `appendLocationNameToHeader` | Append region name to header? <br> **Values:** `true` or `/false` <br> **Default:** `true` |
### List available regions
`curl -s https://c19d.smsvc.net/api/v2/districts | jq '.[].LK_Name'`
2020-08-05 18:54:19 +00:00
## MMPM integration
```
mmpm add-ext-pkg \
--title="MMM-MyCovid19" \
2020-08-05 18:54:19 +00:00
--author="smark" \
--repo="https://git.smsvc.net/MagicMirror/MMM-MyCovid19" \
2020-08-05 18:54:19 +00:00
--desc="covid19 statistics"
```