Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thebino/rki_covid

🦠 Custom integration for Home Assistant to monitor covid numbers provided by Robert-Koch Institut
https://github.com/thebino/rki_covid

automation custom hassio home-assistant lovelace sensor

Last synced: 8 days ago
JSON representation

🦠 Custom integration for Home Assistant to monitor covid numbers provided by Robert-Koch Institut

Host: GitHub
URL: https://github.com/thebino/rki_covid
Owner: thebino
License: apache-2.0
Archived: true
Created: 2020-12-05T13:55:48.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2023-08-31T13:50:05.000Z (about 1 year ago)
Last Synced: 2024-05-01T17:07:04.199Z (7 months ago)
Topics: automation, custom, hassio, home-assistant, lovelace, sensor
Language: Python
Homepage:
Size: 10.6 MB
Stars: 41
Watchers: 4
Forks: 11
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        # 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](https://img.shields.io/github/contributors/thebino/rki_covid)](https://github.com/thebino/rki_covid/graphs/contributors)

![Version](https://img.shields.io/github/v/release/thebino/rki_covid)

[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg)](https://github.com/custom-components/hacs)

[![codecov](https://codecov.io/gh/thebino/rki_covid/branch/master/graph/badge.svg)](https://codecov.io/gh/thebino/rki_covid)

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

## Table of contents

* [Installation](#installation)

  * [Install with HACS](#install-with-hacs)

  * [Install manually](#install-manually)

* [Configuration](#configuration)

  * [Configuration via User interface](#user-interface)

  * [Configuration via configuration.yaml](#configurationyaml)

* [Entities](#entities)

* [Graph](#graph)

* [Automations](#automations)

* [Contribution](#contribution)

## Installation

### Install with HACS (recommended)

1. Ensure that [HACS](https://community.home-assistant.io/t/custom-component-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](https://github.com/thebino/rki_covid/releases/latest).

2. Unpack the release and copy the `custom_components/rki_covid` directory

   into the `/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](docs/configuration.gif)

#### 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.

```yaml

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.

```yaml

type: sensor

graph: line

detail: 1

name: 'München '

entity: sensor.sk_munchen_weekincidence

hours_to_show: 72

```

![lovelace_graph.png](docs/lovelace_graph.png)

#### Automations

For automations have a look on the [trend](https://www.home-assistant.io/integrations/trend/) platform.

## Contribution

See [Contribution](CONTRIBUTING.md) for details.