49 lines
1.7 KiB
Markdown
49 lines
1.7 KiB
Markdown
# Module: MMM-covid19
|
|
|
|
This module displays COVID-19 data aggregated by [c19d](https://c19d.smsvc.net).
|
|
|
|
|
|
|
|
## 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: [
|
|
{
|
|
module: "MMM-MyCovid19",
|
|
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) |
|
|
| `showHeader` | Show *COVID-19 Daten* as module header? <br> **Values:** `true` or `/false` <br> **Default:** `true` |
|
|
| `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'`
|
|
|
|
## MMPM integration
|
|
```
|
|
mmpm add-ext-pkg \
|
|
--title="MMM-MyCovid19" \
|
|
--author="smark" \
|
|
--repo="https://git.smsvc.net/MagicMirror/MMM-MyCovid19" \
|
|
--desc="covid19 statistics"
|
|
```
|