Skip to content

Commit 9746ee1

Browse files
committed
Documentation update
1 parent 9bd05d8 commit 9746ee1

2 files changed

Lines changed: 54 additions & 11 deletions

File tree

README.md

Lines changed: 53 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,53 +4,96 @@
44
![GitHub Release](https://img.shields.io/github/v/release/iluvdata/liebherr)
55
![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Filuvdata%2Fliebherr%2Frefs%2Fheads%2Fmain%2Fcustom_components%2Fliebherr%2Fmanifest.json&query=%24.version&prefix=v&label=dev-version&labelColor=orange)
66

7-
This is a custom integration for Home Assistant that allows you to connect and control Liebherr smart devices via the Liebherr HomeAPI.
7+
This is a *unofficial* custom integration for Home Assistant that allows you to connect and control Liebherr smart devices via the Liebherr HomeAPI.
8+
9+
## Acknowledgement
10+
This is a rewrite of the great [custom intergration](https://github.com/bhuebschen/liebherr) orginally maintained by @bhuebschen from a fork created by @skatsavos. The original intergration stopped work in Oct 2025 and the orginal maintainer did not appear to be maintaining the project.
11+
12+
> [!Warning]
13+
> This is nearly a complete rewrite to the orginal integration. As such there is not a suitable upgrade path. I'd suggest starting deleting the prior liebherr entry and HACS respository from your Homeassistant **before** proceeding with installation below.
14+
15+
> [!Caution]
16+
> I only have access to a Liebherr fridge with a limited number of features. I have not been able to test:
17+
> - AutoDoor
18+
> - BioFreshPlus
19+
> - HydroBreeze
20+
>
21+
> If you encounter an issue with these features please submit an issue here.
822
923
## Features
1024
- Monitor current and target temperatures of your Liebherr fridges and freezers.
11-
- Control device features such as switching power modes.
12-
- View detailed information about your appliances.
25+
- Control device features such as cooling modes and ice makers.
26+
27+
## Significant Changes from [bhuebschen/liebherr v0.1.1](https://github.com/bhuebschen/liebherr)
28+
- Data is now pulled from the API using a single "coordinated" pull set on a configurable interval per https://github.com/bhuebschen/liebherr/issues/44#issuecomment-3442421338 and https://developer.liebherr.com/apis/smartdevice-homeapi/ set to a default interval of 30s.
29+
- Added support for all the support features in the API such as IceMaker Control, BioFreshPlus, AutoDoor, Presentation Light (wine fridges) and HydroBreeze (see Caution above).
30+
- Translation support has been greatly expanded but please note I was not able to update the many translations (please feel free to contribute)!
31+
- Device/appliance list will only be queried upon setup. If you add a new device to your Liebherr account you with have to "Reload" the integration in Homeassitant (or restart Homeassistant).
1332

1433
## Installation
1534

1635
### HACS (Recommended)
36+
37+
> [!Warning]
38+
> Consider manually removing the prior version to avoid orphaned devices/entities.
39+
40+
[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?category=custom_respository&owner=iluvdata&repository=liebherr)
41+
42+
### OR
43+
1744
1. Ensure that [HACS](https://hacs.xyz/) is installed in your Home Assistant instance.
1845
2. Add this repository as a custom repository in HACS:
1946
- Open HACS in Home Assistant.
2047
- Go to **Integrations**.
2148
- Click on the three dots in the top-right corner and select **Custom repositories**.
22-
- Add the following URL: `https://github.com/bhuebschen/liebherr`.
49+
- Add the following URL: `https://github.com/iluvdata/liebherr`.
2350
- Select **Integration** as the category.
2451
3. Search for "Liebherr" in the HACS integrations list and install it.
2552

26-
[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=bhuebschen&repository=liebherr&category=integration)
27-
2853

2954
### Manual Installation
30-
1. Download the latest release from the [GitHub Releases page](https://github.com/bhuebschen/liebherr/releases).
55+
1. Download the latest release from the [GitHub Releases page](https://github.com/iluvdata/liebherr/releases).
3156
2. Extract the downloaded archive.
3257
3. Copy the `custom_components/liebherr` folder to your Home Assistant `custom_components` directory.
3358
- Example: `/config/custom_components/liebherr`
3459
4. Restart Home Assistant.
3560

3661
## Configuration
62+
63+
[![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=pdf_scrape)
64+
65+
### Or
3766
1. In Home Assistant, navigate to **Settings** > **Devices & Services**.
3867
2. Click **Add Integration**.
3968
3. Search for "Liebherr" and select it.
40-
4. Enter your Liebherr HomeAPI API key. (see [here](https://developer.liebherr.com/apis/smartdevice-homeapi/), how to get the key)
41-
5. Complete the setup process.
69+
70+
### Then
71+
72+
1. Enter your Liebherr HomeAPI API key. (see [here](https://developer.liebherr.com/apis/smartdevice-homeapi/), how to get the key)
73+
2. Complete the setup process.
4274

4375
## Usage
4476
Once the integration is configured, your Liebherr devices will appear as entities in Home Assistant. You can:
4577
- Monitor temperatures and other metrics.
4678
- Control switches and settings via the Home Assistant UI or automations.
79+
- Change the poll interval on the configuration
80+
81+
Controls will map to the following domains:
82+
| Liebherr Control | Homeassistant Domain |
83+
| -----------------| ---------------------|
84+
| Ice Maker, BioFreshPlus | Select |
85+
| Presentation Light | Light |
86+
| SuperCool, SuperFreeze, PartyMode, NightMode | Switch|
87+
| HydroBreeze | Fan |
88+
| Temperature | Climate |
4789

4890
## Troubleshooting
4991
- Ensure your Liebherr api key is correct.
5092
- Check the Home Assistant logs for any errors related to the integration.
93+
- Enable debug on the integration.
5194

5295
## Support
53-
If you encounter any issues or have feature requests, please open an issue on the [GitHub Issues page](https://github.com/bhuebschen/liebherr/issues).
96+
If you encounter any issues or have feature requests, please open an issue on the [GitHub Issues page](https://github.com/iluvdata/liebherr/issues).
5497

5598
## Contributions
5699
Contributions are welcome! Feel free to submit pull requests to improve this integration.

custom_components/liebherr/changelog.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66
0.0.8: sensors (hydrobreeze, biofresh and autodoor) added, more notification types supported
77
0.0.9: code cleanup and more features supported
88
0.1.0: official HomeAPI
9-
0.2.0: Migrated to coordinated data pulls to avoid 429 responses from API, fully support the currently offered API (Ice Maker, Hydro Breeze, Bio Fresh Plus, Presentation Light, etc) and for translations.
9+
2025.10.1: Migrated to coordinated data pulls to avoid 429 responses from API, fully support the currently offered API (Ice Maker, Hydro Breeze, Bio Fresh Plus, Presentation Light, etc) and for translations.

0 commit comments

Comments
 (0)