the78mole / esphome_components

ESPhome Components from the little digger
Other
24 stars 11 forks source link

thoughts on naming schema in buderus-km271.yaml #16

Closed qschneider closed 1 year ago

qschneider commented 1 year ago

Playing around with the entities in HA i stumbled over the naming schema of some entities. If we just provide a name and not an id, HA will generate an entity_id of the name which is misleading sometimes. So it might be better for user experience if we define ids AND names, so entity naming could be changed to some other language without changing the entity_ids.

Bascht74 commented 1 year ago

Is the ESPHome id really feeding HA with the entity name? In my last attempts HA takes the name out of the entity name and not the id. Maybe they changed it...

Could you double check with a new entity that has a name & id that is completely different. Then check what the name and entity id is in HA.

Bascht74 commented 1 year ago

So it might be better for user experience if we define ids AND names, so entity naming could be changed to some other language without changing the entity_ids.

You can add the id to your config, e.g.

    boiler_target_temperature:
      name: "Kesselvorlaufsolltemperatur"
      id: something_you_name_it
Bascht74 commented 1 year ago

I checked it:

number:
  - platform: template
    id: warmwasser_Temperatur
    name: "Warmwassersolltemperatur Tag"

will be in HA: number.warmwassersolltemperatur_tag and not number.warmwasser_temperatur

same for you?

qschneider commented 1 year ago

Yes, sadly you are right! Searching for it i found your Feature requesthttps://github.com/esphome/feature-requests/issues/1741 and this https://github.com/home-assistant/core/issues/47546 . Too bad that we use an id: in esphome that isn't recognized in HA nor it is wished. So we have to choose names that differ enough in HA to be self explaining.

qschneider commented 1 year ago

resolved in #12 and #22 so we could close here ?

qschneider commented 1 year ago

to reflect the changes in the PR we should also rename the corresponding esphome yaml. For example like this.

heating_circuit_1_curve_p10:
  name: "HK1 Heizkurve +10 °C"
heating_circuit_1_curve_0:
  name: "HK1 Heizkurve 0 °C"
heating_circuit_1_curve_n10:
  name: "HK1 Heizkurve -10 °C minus"

and name: "HK2 Heizkurve +10 °C" heating_circuit_2_curve_0: name: "HK2 Heizkurve 0 °C" heating_circuit_2_curve_n10: name: "HK2 Heizkurve -10 °C minus"

Bascht74 commented 1 year ago

Hi @qschneider,

I am fine with how they are, because they are just an example in the yaml code. So you can name it as you like and they stay the same, even if the code here changes...

the78mole commented 1 year ago

Lets close it. Its just make up 😜