Skip to content
This repository has been archived by the owner on Aug 31, 2023. It is now read-only.

Latest commit

 

History

History
115 lines (85 loc) · 4.08 KB

README.md

File metadata and controls

115 lines (85 loc) · 4.08 KB

Robert-Koch Institut COVID Numbers

⚠️⚠️⚠️

This repository has been archived.

Due to the lack of interest in current covid numbers and missing contributions, this component is no longer maintained. Feel free to get in contact if you wanna take over the maintenance.




GitHub contributors Version hacs_badge codecov

The rki_covid component is a Home Assistant custom sensor for monitoring regional covid numbers in Germany.

Table of contents

Installation

Install with HACS (recommended)

  1. Ensure that HACS is installed.
  2. Search for and install the "RKI Covid numbers" integration.
  3. Configure the rki_covid sensor.
  4. Restart Home Assistant.

Install manually

  1. Download the latest release.
  2. Unpack the release and copy the custom_components/rki_covid directory into the <config dir>/custom_components directory of your Home Assistant installation.
  3. Configure the rki_covid sensor.
  4. Restart Home Assistant.

Configuration

User interface

Open the Configuration of your Home-Assistant instance and select Integrations. Add a new integration, search and select rki covid. A dialog appears to select a district or state to monitor. After submitting the dialog, the newly added sensor entity is available.

Hint: Repeat the process to add multiple districts or states.

Configuration via User interface

Configuration.yaml

It is also possible to add districts / states via the configuration.yaml. Open your configuration file in an editor. Add a new sensor platform called rki_covid and add a list of districts by name.

sensor:
  - platform: rki_covid
    districts:
     - name: 'SK Augsburg'
     - name: 'SK Berlin Mitte'
     - name: 'BL Bayern'
     - name: 'LK München'

Hint: You have to validate the configuration (Configuration > Server Controls > Check configuration) and restart Home Assistant before the new sensors become available.

Entities

Each integration creates multiple entities in the format sensor.NAME_entity.

Sensor Type Description
sensor.NAME_count number indicates the confirmed cases.
sensor.NAME_newCases number indicates the new confirmed cases.
sensor.NAME_deaths number indicates the numbers of confirmed death cases.
sensor.NAME_newDeaths number indicates the numbers of new confirmed death cases.
sensor.NAME_recovered number indicates the numbers of confirmed recovery cases.
sensor.NAME_newRecovered number indicates the numbers of new confirmed recovery cases.
sensor.NAME_casesPer100k number indicates cases per 100k.
sensor.NAME_weekIncidence number indicates the week incidence per 100.000 inhabitants.

Graph

Home-Assistant has built-in cards for graphs wich could be really helpful to display the current count with history.

type: sensor
graph: line
detail: 1
name: 'München '
entity: sensor.sk_munchen_weekincidence
hours_to_show: 72

lovelace_graph.png

Automations

For automations have a look on the trend platform.

Contribution

See Contribution for details.