Skip to content

Commit e7b8fb8

Browse files
authored
Revise README for better structure and information
Updated README.md to improve clarity and organization.
1 parent 91453bb commit e7b8fb8

File tree

1 file changed

+15
-16
lines changed

1 file changed

+15
-16
lines changed

README.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,25 @@
11
# Luxtronik
22

3-
If you like 🩷 this project, [sponsor it (click)](https://github.com/sponsors/BenPru).
3+
This is a Home Assistant integration integration.
44

5-
## Warning
5+
It is based on [Bouni/luxtronik](https://github.com/Bouni/luxtronik). This component extends the original luxtronik integration with automatic discovery, UI Setup and Home Assistant entities like climate and water heater.
66

7-
> :warning: **New Code-Base - PLEASE READ!** :warning:
8-
* Backup your data before update (different config structure!). If you make a downgrade of this integration (<2023.9) restore your data backup (The entries for Luxtronik in ./storage/core.config_entries + core.device_registry + core.entity_registry should be enough.)! If not you get double entities!
9-
* This release has no more language selection. The HA backend language is used.
10-
* Some entities which can not detected automatically are hidden or disabled by default. In the devices you can find them and activate it. Please check this list before creating issues with entity whiches.
11-
* In the integration configuration you can set a ha sensor id for the indoor temperature value.
7+
If you like this project, give it a ⭐, or sponsor the developer:
8+
* Project creator: [BenPru](https://github.com/sponsors/BenPru).
9+
* Current developer: [rhammen](https://github.com/sponsors/rhammen).
1210

13-
> :warning: **Known Issues** :warning:
14-
* The update sensor "rings" for new firmware versions, but the "Install"-Button has no function. The Firmware has to be installed manually. An the Install-Button is necessary to get notified.
11+
Big thanks to [all community members](https://github.com/BenPru/luxtronik/graphs/contributors) who have contributed to this project!
12+
Every contribution counts :pray:
1513

16-
This component has been created to be used with Home Assistant.
14+
## ⚠️ Warning
15+
Some of these settings can impact the performance of your heatpump. The project aims to protect your heatpump, but no guarantees can be given. Please be careful.
1716

18-
> :warning: **Use at your own risk!** :warning:
19-
> You can write config parameters to your heatpump, altering it's efficiency and functionality.
20-
> Please be careful.
17+
## 📖 Documentation
18+
Consult your manual and don't change things if you don't know what it does.
19+
Share your knowledge and help with updating this user documentation of this project.
2120

22-
Based on [Bouni/luxtronik](https://github.com/Bouni/luxtronik) / [Bouni/python-luxtronik](https://github.com/Bouni/python-luxtronik). ❤️
23-
24-
This component extends the original luxtronik component with automatic discovery of the heatpump und home assistant climate thermostat. The `Luxtronik` integration lets you monitor and control heat pump units containing a Luxtronik controller. It is used by various manufacturers such as:
21+
## 🔧 Compatibility
22+
The integration lets you monitor and control heat pump units containing a Luxtronik controller. It is used by various manufacturers such as:
2523

2624
- Alpha Innotec
2725
- Siemens Novelan
@@ -33,6 +31,7 @@ This component extends the original luxtronik component with automatic discovery
3331

3432
This integration works locally. It's only necessary to connect the Luxtronik controller to your network using an ethernet cable. No additional hard- or software is needed.
3533

34+
## 📑 Table of Content
3635
1. [Installation](#1-installation)
3736
1.1 [HACS (Recommended)](#11-hacs-recommended)
3837
1.2 [Manual installation](#12-manual-installation)

0 commit comments

Comments
 (0)