Skip to content

Commit

Permalink
Rename entity ids!
Browse files Browse the repository at this point in the history
Breaking changes:

Rename spreizung_mod_hz to delta_temp_ch
Rename spreizung_mod_ww to delta_temp_dhw
Rename water_flow to flow_rate
  • Loading branch information
wrfz committed Sep 11, 2024
1 parent e6e0536 commit 801f506
Show file tree
Hide file tree
Showing 4 changed files with 74 additions and 74 deletions.
106 changes: 53 additions & 53 deletions README.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
[![en](https://img.shields.io/badge/lang-en-red.svg)](README.en.md)
[![de](https://img.shields.io/badge/lang-de-blue.svg)](README.md)

# Warning!
## Warning!

The use of esphome-daikin-rotex-can may cause damage to the heating system if used improperly.
Usage is at your own risk, and the developer assumes no responsibility for any damages.
Expand All @@ -16,63 +16,63 @@ Please note that this software is not supported by the manufacturer.

# How to setup

1. Open the `ESPHome Dashboard`.
2. Click on `NEW DEVICE` in the bottom right corner.
3. Click the `CONTINUE` button.
4. Enter any name for the configuration (e.g., Rotex) and confirm with `NEXT`.
5. Select `ESP32-S3`.
6. Complete the basic configuration by clicking `SKIP`.
7. Click `EDIT` on the newly created configuration.
1. Open the `ESPHome Dashboard`
2. Click on `NEW DEVICE` in the bottom right corner
3. Click the `CONTINUE` button
4. Enter any name for the configuration (e.g., Rotex) and confirm with `NEXT`
5. Select `ESP32-S3`
6. Complete the basic configuration by clicking `SKIP`
7. Click `EDIT` on the newly created configuration
8. Copy the following three sections from [examples/full.yaml](examples/full.yaml):
- `esphome``platformio_options` (Very important to ensure successful compilation later)
- canbus (Adjust GPIOs according to your needs)
- daikin_rotex_can (Unnecessary entities can be removed)
- `canbus` (Adjust GPIOs according to your needs)
- `daikin_rotex_can` (Unnecessary entities can be removed)
9. In the ESPHome Dashboard, click on the three vertical dots in the bottom right corner of the configuration and then click `Install`.


Supported sensors and controls:
------------------------

|ID |Empfohlener Name |Beschreibubg |
|--- |--- |--- |
|**bypass_valve** |BPV |Prozentuale Öffnungsstellung des Bypass-Ventils |
|**circulation_pump** |Umwälzpumpe |Prozentuale Betriebsleistung der Umwälzpumpe |
|**circulation_pump_min** |Umwälzpumpe Min |Minimale Betriebsstufe der Umwälzpumpe |
|**circulation_pump_max** |Umwälzpumpe Max |Maximale Betriebsstufe der Umwälzpumpe |
|**dhw_mixer_position** |DHW Mischer Position |Position des Warmwassermischers |
|**dhw_run** |Warmwasser bereiten |Steuerung zur Aktivierung der Warmwasserbereitung|
|**ehs_for_ch** |EHS fuer CH |Externes Heizsystem für die Heizung |
|**error_code** |Fehlercode |Fehlercode und Beschreibung |
|**flow_temperature_day** |T Vorlauf Tag |Vorlauftemperatur für den Tagbetrieb |
|**heating_curve** |Heizkurve |Heizkurve zur Temperaturregelung |
|**hk_function** |HK Funktion |Heizkreisfunktion |
|**max_target_flow_temp** |Max VL Soll |Maximale Vorlauftemperatur |
|**min_target_flow_temp** |Min VL Soll |Minimale Vorlauftemperatur |
|**mode_of_operating** |Betriebsart |Betriebsart der Wärmepumpe |
|**operating_mode** |Betriebsmodus |Aktueller Betriebsmodus der Wärmepumpe |
|**qboh** |EHS für DHW |Externes Heizsystem für die Warmwasserbereitung |
|**qch** |Energie Heizung |Erzeugte Heizenergie |
|**qdhw** |Energie für WW |Erzeugte Energie für Warmwasser |
|**quiet** |Flüsterbetrieb |Aktivierung des Flüsterbetriebs |
|**runtime_compressor** |Laufzeit Compressor |Laufzeit des Kompressors |
|**runtime_pump** |Laufzeit Pump |Laufzeit der Pumpe |
|**sg_mode** |SG Modus |SG-Modus |
|**smart_grid** |Smart Grid |Smart-Grid-Funktion |
|**spreizung_mod_hz** |Spreizung MOD HZ |Temperaturdifferenz im Heizbetrieb |
|**spreizung_mod_ww** |Spreizung MOD WW |Temperaturdifferenz bei der Warmwasserbereitung |
|**status_kesselpumpe** |Status Kesselpumpe |Status der Kesselpumpe |
|**status_kompressor** |Status Kompressor |Status des Kompressors |
|**target_room1_temperature** |Raumsoll 1 |Raum-Soll Temperatur |
|**tdhw1** |Warmwassertemperatur |Warmwassertemperatur |
|**temperature_outside** |Aussentemperatur |Außentemperatur, gemessen von der Außeneinheit |
|**t_ext** |T-Aussen |Außentemperatur. |
|**tr** |Ruecklauftemperatur Heizung |Rücklauftemperatur der Heizung |
|**tv** |Heizkreis Vorlauf (TV) |Vorlauftemperatur des Heizkreises |
|**tvbh** |Vorlauftemperatur Heizung (TVBH) |Vorlauftemperatur des Heizsystems |
|**t_hs** |T-WE |Warmwassererzeugertemperatur (T-WE) |
|**water_flow** |Durchfluss |Durchflussmenge in Litern pro Stunde |
|**water_pressure** |Wasserdruck |Wasserdruck des Systems |
|**target_hot_water_temperature**|T-WW-Soll1 |Sollwert für die Warmwassertemperatur |
|**target_supply_temperature** |Vorlauf Soll |Sollwert der Vorlauftemperatur |
|**thermal_power** |Thermische Leistung |Aktuelle thermische Leistung |
|**total_energy_produced** |Erzeugte Energie Gesamt |Gesamt erzeugte Energie |
|ID |Empfohlener Name |Beschreibubg |
|--- |--- |--- |
|**bypass_valve** |BPV |Percentage opening position of the bypass valve |
|**circulation_pump** |Umwälzpumpe |Percentage operating performance of the circulation pump |
|**circulation_pump_min** |Umwälzpumpe Min |Minimum operating level of the circulation pump |
|**circulation_pump_max** |Umwälzpumpe Max |Maximum operating level of the circulation pump |
|**delta_temp_ch** |Spreizung MOD HZ |Temperature difference during heating operation |
|**delta_temp_dhw** |Spreizung MOD WW |Temperature difference during hot water preparation |
|**dhw_mixer_position** |DHW Mischer Position |Position of the hot water mixer |
|**dhw_run** |Warmwasser bereiten |Control for activating hot water preparation |
|**ehs_for_ch** |EHS fuer CH |External heating system for heating |
|**error_code** |Fehlercode |Error code and description |
|**flow_rate** |Durchfluss |Flow rate in liters per hour |
|**flow_temperature_day** |T Vorlauf Tag |Flow temperature for daytime operation |
|**heating_curve** |Heizkurve |Heating curve for temperature control |
|**hk_function** |HK Funktion |Heating circuit function |
|**max_target_flow_temp** |Max VL Soll |Maximum flow temperature |
|**min_target_flow_temp** |Min VL Soll |Minimum flow temperature |
|**mode_of_operating** |Betriebsart |Operating mode of the heat pump |
|**operating_mode** |Betriebsmodus |Current operating mode of the heat pump |
|**qboh** |EHS für DHW |External heating system for hot water preparation |
|**qch** |Energie Heizung |Produced heating energy |
|**qdhw** |Energie für WW |Produced energy for hot water |
|**quiet** |Flüsterbetrieb |Activation of quiet operation |
|**runtime_compressor** |Laufzeit Compressor |Runtime of the compressor |
|**runtime_pump** |Laufzeit Pump |Runtime of the pump |
|**sg_mode** |SG Modus |SG mode |
|**smart_grid** |Smart Grid |Smart grid function |
|**status_kesselpumpe** |Status Kesselpumpe |Status of the boiler pump |
|**status_kompressor** |Status Kompressor |Status of the compressor |
|**target_room1_temperature** |Raumsoll 1 |Target room temperature |
|**tdhw1** |Warmwassertemperatur |Hot water temperature |
|**temperature_outside** |Aussentemperatur |Outside temperature measured by the outdoor unit |
|**t_ext** |T-Aussen |Outside temperature |
|**tr** |Ruecklauftemperatur Heizung |Return temperature of the heating system |
|**tv** |Heizkreis Vorlauf (TV) |Flow temperature of the heating circuit |
|**tvbh** |Vorlauftemperatur Heizung (TVBH) |Flow temperature of the heating system |
|**t_hs** |T-WE |Hot water generator temperature (T-WE) |
|**water_pressure** |Wasserdruck |Water pressure of the system |
|**target_hot_water_temperature**|T-WW-Soll1 |Setpoint for hot water temperature |
|**target_supply_temperature** |Vorlauf Soll |Setpoint for supply temperature |
|**thermal_power** |Thermische Leistung |Current thermal power |
|**total_energy_produced** |Erzeugte Energie Gesamt |Total energy produced |
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#### Language Selection:
#### Sprache wählen:
[![en](https://img.shields.io/badge/lang-en-red.svg)](README.en.md)
[![de](https://img.shields.io/badge/lang-de-blue.svg)](README.md)

# Warnung!
## Warnung!

Die Nutzung von esphome-daikin-rotex-can kann bei unsachgemäßer Anwendung zu Schäden an der Heizungsanlage führen.
Die Verwendung erfolgt auf eigenes Risiko, und der Entwickler übernimmt keine Haftung für etwaige Schäden.
Expand All @@ -14,17 +14,17 @@ Es wird darauf hingewiesen, dass diese Software nicht vom Hersteller unterstütz

# Installationsanleitung

1. `ESPHome Dashboard` öffnen.
2. Rechts unten auf `NEW DEVICE` klicken.
3. Auf die Schaltfläche `CONTINUE` klicken.
4. Einen beliebigen Name für die Konfiguration eingeben (z.B. Rotex) und mit `NEXT` bestätigen.
5. `ESP32-S3` wählen.
6. Mit `SKIP` die Erstellung der Grundkonfiguration abschließen.
1. `ESPHome Dashboard` öffnen
2. Rechts unten auf `NEW DEVICE` klicken
3. Auf die Schaltfläche `CONTINUE` klicken
4. Einen beliebigen Name für die Konfiguration eingeben (z.B. Rotex) und mit `NEXT` bestätigen
5. `ESP32-S3` wählen
6. Mit `SKIP` die Erstellung der Grundkonfiguration abschließen
7. Bei der neu erstellten Konfiguration auf `EDIT` klicken
8. Aus [examples/full.yaml](examples/full.yaml) folgende drei Sektionen übernehmen:
- `esphome``platformio_options` (Sehr wichtig, damit die spätere Kompilation funktioniert)
- canbus (GPIOs den eigenen Bedürfnissen anpassen)
- daikin_rotex_can (Nicht benötigte Entities können entfernt werden)
- `canbus` (GPIOs den eigenen Bedürfnissen anpassen)
- `daikin_rotex_can` (Nicht benötigte Entities können entfernt werden)
9. Im ESPHome Dashboard bei der Konfiguration rechts unten auf die drei senkrechten Punkte klicken und anschliessend auf `Install`


Expand All @@ -37,10 +37,13 @@ Unterstützte Sensoren und Schalter:
|**circulation_pump** |Umwälzpumpe |Prozentuale Betriebsleistung der Umwälzpumpe |
|**circulation_pump_min** |Umwälzpumpe Min |Minimale Betriebsstufe der Umwälzpumpe |
|**circulation_pump_max** |Umwälzpumpe Max |Maximale Betriebsstufe der Umwälzpumpe |
|**delta_temp_ch** |Spreizung MOD HZ |Temperaturdifferenz im Heizbetrieb |
|**delta_temp_ww** |Spreizung MOD WW |Temperaturdifferenz bei der Warmwasserbereitung |
|**dhw_mixer_position** |DHW Mischer Position |Position des Warmwassermischers |
|**dhw_run** |Warmwasser bereiten |Steuerung zur Aktivierung der Warmwasserbereitung|
|**ehs_for_ch** |EHS fuer CH |Externes Heizsystem für die Heizung |
|**error_code** |Fehlercode |Fehlercode und Beschreibung |
|**flow_rate** |Durchfluss |Durchflussmenge in Litern pro Stunde |
|**flow_temperature_day** |T Vorlauf Tag |Vorlauftemperatur für den Tagbetrieb |
|**heating_curve** |Heizkurve |Heizkurve zur Temperaturregelung |
|**hk_function** |HK Funktion |Heizkreisfunktion |
Expand All @@ -56,8 +59,6 @@ Unterstützte Sensoren und Schalter:
|**runtime_pump** |Laufzeit Pump |Laufzeit der Pumpe |
|**sg_mode** |SG Modus |SG-Modus |
|**smart_grid** |Smart Grid |Smart-Grid-Funktion |
|**spreizung_mod_hz** |Spreizung MOD HZ |Temperaturdifferenz im Heizbetrieb |
|**spreizung_mod_ww** |Spreizung MOD WW |Temperaturdifferenz bei der Warmwasserbereitung |
|**status_kesselpumpe** |Status Kesselpumpe |Status der Kesselpumpe |
|**status_kompressor** |Status Kompressor |Status des Kompressors |
|**target_room1_temperature** |Raumsoll 1 |Raum-Soll Temperatur |
Expand All @@ -68,7 +69,6 @@ Unterstützte Sensoren und Schalter:
|**tv** |Heizkreis Vorlauf (TV) |Vorlauftemperatur des Heizkreises |
|**tvbh** |Vorlauftemperatur Heizung (TVBH) |Vorlauftemperatur des Heizsystems |
|**t_hs** |T-WE |Warmwassererzeugertemperatur (T-WE) |
|**water_flow** |Durchfluss |Durchflussmenge in Litern pro Stunde |
|**water_pressure** |Wasserdruck |Wasserdruck des Systems |
|**target_hot_water_temperature**|T-WW-Soll1 |Sollwert für die Warmwassertemperatur |
|**target_supply_temperature** |Vorlauf Soll |Sollwert der Vorlauftemperatur |
Expand Down
4 changes: 2 additions & 2 deletions components/daikin_rotex_can/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@
},
{
"type": "sensor",
"name": "spreizung_mod_hz",
"name": "delta_temp_ch",
"device_class": DEVICE_CLASS_TEMPERATURE,
"unit_of_measurement": UNIT_KELVIN,
"accuracy_decimals": 0,
Expand All @@ -295,7 +295,7 @@
},
{
"type": "sensor",
"name": "spreizung_mod_ww",
"name": "delta_temp_dhw",
"device_class": DEVICE_CLASS_TEMPERATURE,
"unit_of_measurement": UNIT_KELVIN,
"accuracy_decimals": 0,
Expand Down
12 changes: 6 additions & 6 deletions examples/full.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,10 @@ daikin_rotex_can:
name: "Umwälzpumpe Min"
circulation_pump_max:
name: "Umwälzpumpe Max"
delta_temp_ch:
name: "Spreizung MOD HZ"
delta_temp_dhw:
name: "Spreizung MOD WW"
dhw_mixer_position:
name: "DHW Mischer Position"
dhw_run:
Expand All @@ -72,6 +76,8 @@ daikin_rotex_can:
name: "EHS fuer CH"
error_code:
name: "Fehlercode"
flow_rate:
name: "Durchfluss"
flow_temperature_day:
name: "T Vorlauf Tag"
heating_curve:
Expand Down Expand Up @@ -102,10 +108,6 @@ daikin_rotex_can:
name: "SG Modus"
smart_grid:
name: "Smart Grid"
spreizung_mod_hz:
name: "Spreizung MOD HZ"
spreizung_mod_ww:
name: "Spreizung MOD WW"
status_kesselpumpe:
name: "Status Kesselpumpe"
status_kompressor:
Expand All @@ -126,8 +128,6 @@ daikin_rotex_can:
name: "Vorlauftemperatur Heizung (TVBH)"
t_hs:
name: "T-WE"
water_flow:
name: "Durchfluss"
water_pressure:
name: "Wasserdruck"
target_hot_water_temperature:
Expand Down

0 comments on commit 801f506

Please sign in to comment.