Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jasperslits authored May 13, 2024
1 parent df1e087 commit d96bb78
Showing 1 changed file with 22 additions and 11 deletions.
33 changes: 22 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Requires add-on from https://github.com/arjenhiemstra/ithowifi and MQTT integrat
This simplifies the integration by creating the sensors for the various Itho Daalderop devices: Heatpump WPU 5G, HRU-350 and related devices, CVE boxes, Autotemp units for floor heating.
For best user experience it should be used with the auto-discovery for the CVE / non-CVE devices in the add-on.

This custom component has no relation with the Itho Daalderop company.
This custom component has no relation with the Itho Daalderop company or with Arjen Hiemstra's Itho Wifi add-on.

Note: The 'add-on' here in the context is the add-on to the Itho Daalderop units, not an Add-on in Home Assistant.
Note: The 'add-on' here in the context is the ESP32 add-on to the Itho Daalderop units, not an Add-on in Home Assistant.

### Use-case
Full auto-discovery from the add-on to Home Assistant is the best experience but as this is not there yet, this add-on should eliminate the manual creation via YAML of sensors for:
Expand All @@ -20,25 +20,36 @@ It creates the commony used sensors and uses a predefined MQTT state topic to di

This custom integration should become obsolete once full auto-discovery has the same capabilities.

### Prerequisites
1. Working add-on connected to the Itho deviced
2. State topics for MQTT like table below

| Device | MQTT base topic |
|---|---|
| HRU | ithohru |
| WPU | ithowpu |
| CVE | ithohru |
| Autotemp | ithotemp |
| Remotes | ithohru |

### What works / should work
1. Create Heatpump WPU sensors
2. Create NONCVE / HRU Fan sensors
3. Create CVE fan sensors
4. Create up to two Remotes for monitoring CO2 levels
5. Create Auto temp sensors

Overall: translations are available in English for now. NL to follow
Overall: translations are available in English only for now. Dutch to follow.

## How to install
1. In the Add-On from Arjen: Update the add-on MQTT configuration to use ithohru for NON-CVE, ithowpu for Heatpump/WPU and ithotemp for Autotemp.
2. On the system running Home Assistant: Create /usr/share/hassio/homeassistant/custom_components/itho
3. Install:
3a) Git clone or download the content to custom_components in the /usr/share/hassio/homeassistant directory
3b) Install the component via HACS
4. Restart Home Assistant
5. Go to Integrations
6. Add Itho integration
7. Enable the devices you want to configure
3. Git clone or download the content to custom_components in the /usr/share/hassio/homeassistant directory **OR**
4. Alternative: Install the component via HACS custom repo. See https://hacs.xyz/docs/faq/custom_repositories/ and use Integration in the dropdown and https://github.com/jasperslits/haithowifi/ as name
5. Restart Home Assistant
6. Go to Integrations
7. Add Itho integration
8. Enable the devices you want to configure

### Screenshots
1. Add integration
Expand All @@ -60,7 +71,7 @@ Overall: translations are available in English for now. NL to follow
### TODO:
* Add binary sensors for bypass of HRU
* Update of NL translations
* Submit project for HACS integration
* Submit project for HACS integration. In progress via https://github.com/hacs/default/pull/2494
* Add reconfigure to config flow


Expand Down

0 comments on commit d96bb78

Please sign in to comment.