Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/cjne/thermiagenesis

Home assistant custom component for Thermia Inverter/Mega heat pumps
https://github.com/cjne/thermiagenesis

energy hacs home-assistant homeassistant thermia

Last synced: 27 days ago
JSON representation

Home assistant custom component for Thermia Inverter/Mega heat pumps

Awesome Lists containing this project

README

        

# Thermia Genesis

[![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]
[![BuyMeCoffee][buymecoffeebadge]][buymecoffee]

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

This custom component for [home assistant](https://home-assistant.io/) will let you connect your Thermia Diplomat Inverter or
Mega heat pump to Home Assistant using ModbusTCP.

Supports all register values, 300+ entities are avaliable (most are disabled by default)

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

| Platform | Description |
| --------------- | ----------------------------------- |
| `binary_sensor` | Show something `True` or `False`. |
| `sensor` | Show info from Thermia Genesis API. |
| `switch` | Switch something `True` or `False`. |

## 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 `thermiagenesis`.
4. Download _all_ the files from the `custom_components/thermiagenesis/` 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 "Thermia Genesis"

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

```text
custom_components/thermiagenesis/translations/en.json
custom_components/thermiagenesis/translations/fr.json
custom_components/thermiagenesis/translations/nb.json
custom_components/thermiagenesis/translations/sensor.en.json
custom_components/thermiagenesis/translations/sensor.fr.json
custom_components/thermiagenesis/translations/sensor.nb.json
custom_components/thermiagenesis/translations/sensor.nb.json
custom_components/thermiagenesis/__init__.py
custom_components/thermiagenesis/api.py
custom_components/thermiagenesis/binary_sensor.py
custom_components/thermiagenesis/config_flow.py
custom_components/thermiagenesis/const.py
custom_components/thermiagenesis/manifest.json
custom_components/thermiagenesis/sensor.py
custom_components/thermiagenesis/switch.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
[buymecoffee]: https://www.buymeacoffee.com/cjne
[buymecoffeebadge]: https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=for-the-badge
[commits-shield]: https://img.shields.io/github/commit-activity/y/cjne/thermiagenesis.svg?style=for-the-badge
[commits]: https://github.com/cjne/thermiagenesis/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
[exampleimg]: example.png
[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/cjne/thermiagenesis.svg?style=for-the-badge
[maintenance-shield]: https://img.shields.io/badge/maintainer-%40cjne-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/cjne/thermiagenesis.svg?style=for-the-badge
[releases]: https://github.com/cjne/thermiagenesis/releases
[user_profile]: https://github.com/cjne