Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/artspb/homeassistant-tk-husteblume

TK Husteblume integration for Home Assistant
https://github.com/artspb/homeassistant-tk-husteblume

allergy custom-component hacs homeassistant tk-de

Last synced: 12 days ago
JSON representation

TK Husteblume integration for Home Assistant

Awesome Lists containing this project

README 

        
# TK Husteblume



[![GitHub Release][releases-shield]][releases]

[![GitHub Activity][commits-shield]][commits]

[![License][license-shield]](LICENSE)



[![pre-commit][pre-commit-shield]][pre-commit]

[![Black][black-shield]][black]



[![hacs][hacsbadge]][hacs]

[![Project Maintenance][maintenance-shield]][user_profile]



[![Discord][discord-shield]][discord]

[![Community Forum][forum-shield]][forum]



This integration provides information about allergens available in the [TK Husteblume](https://www.tk.de/techniker/magazin/digitale-gesundheit/apps/husteblume-allergie-app-2025388) app.

For each allergen (e.g., Birch, Alder, etc.), an entity is created with its current level on the scale from 0 to 4.

The forecast for tomorrow and the day after tomorrow is provided via attributes.

The tracked allergens can be disabled via options.

All of them are turned into entities by default.



The app asks a user to enter some statistical information about them (an age group, a gender, and a birth month).

The integration mimics this behavior as the API requires this data.

Additionally, one needs to provide a tracking station.

Choosing the one closest to the user's location is recommended.

As there's no limit in the number of integration instances, one can create as many combinations of the user data as needed.



**This component will set up the following platforms.**



| Platform | Description                       |

| -------- | --------------------------------- |

| `sensor` | Show info from TK Husteblume API. |



## Installation



1. Using the tool of choice, open the directory (folder) for your HA configuration (where you find `configuration.yaml`).

2. If you do not have a `custom_components` directory (folder) there, you need to create it.

3. In the `custom_components` directory (folder) create a new folder called `tk_husteblume`.

4. Download _all_ the files from the `custom_components/tk_husteblume/` directory (folder) in this repository.

5. Place the files you downloaded in the new directory (folder) you created.

6. Restart Home Assistant

7. In the HA UI, go to "Configuration" -> "Integrations" click "+" and search for "TK Husteblume"



Using your HA configuration directory (folder) as a starting point, you should now also have this:



```text

custom_components/tk_husteblume/translations/de.json

custom_components/tk_husteblume/translations/en.json

custom_components/tk_husteblume/__init__.py

custom_components/tk_husteblume/api.py

custom_components/tk_husteblume/config_flow.py

custom_components/tk_husteblume/const.py

custom_components/tk_husteblume/entity.py

custom_components/tk_husteblume/manifest.json

custom_components/tk_husteblume/sensor.py

```



## Configuration is done in the UI



## Contributions are welcome!



If you want to contribute to this, please read the [Contribution guidelines](CONTRIBUTING.md)



## Credits



This project was generated from [@oncleben31](https://github.com/oncleben31)'s [Home Assistant Custom Component Cookiecutter](https://github.com/oncleben31/cookiecutter-homeassistant-custom-component) template.



Code template was mainly taken from [@Ludeeus](https://github.com/ludeeus)'s [integration_blueprint][integration_blueprint] template



---



[integration_blueprint]: https://github.com/custom-components/integration_blueprint

[black]: https://github.com/psf/black

[black-shield]: https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge

[commits-shield]: https://img.shields.io/github/commit-activity/y/artspb/homeassistant-tk-husteblume.svg?style=for-the-badge

[commits]: https://github.com/artspb/homeassistant-tk-husteblume/commits/main

[hacs]: https://hacs.xyz

[hacsbadge]: https://img.shields.io/badge/HACS-Custom-orange.svg?style=for-the-badge

[discord]: https://discord.gg/Qa5fW2R

[discord-shield]: https://img.shields.io/discord/330944238910963714.svg?style=for-the-badge

[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge

[forum]: https://community.home-assistant.io/

[license-shield]: https://img.shields.io/github/license/artspb/homeassistant-tk-husteblume.svg?style=for-the-badge

[maintenance-shield]: https://img.shields.io/badge/maintainer-%40artspb-blue.svg?style=for-the-badge

[pre-commit]: https://github.com/pre-commit/pre-commit

[pre-commit-shield]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?style=for-the-badge

[releases-shield]: https://img.shields.io/github/release/artspb/homeassistant-tk-husteblume.svg?style=for-the-badge

[releases]: https://github.com/artspb/homeassistant-tk-husteblume/releases

[user_profile]: https://github.com/artspb