add friendly_name_template to template sensor

[NovapaX]

Description:

This makes the friendly_name 'templateable' like just like the icon.
Use case (for the template sensor) is probably a bit limited. But it can be things like: Changing the name of a calculated power consumption (value_template) from 'Consumption' to 'Production'
(see example yaml below)

friendly_name can still bet set, but the friendly_name_template will override that if set.

Will update documentation as soon as this gets approved.

Example entry for configuration.yaml (if applicable):

sensor:
  - platform: template
    sensors:
      net_power:
        friendly_name_template: >
          {% if (states('sensor.power_consumption')|float) - (states('sensor.power_production')|float) < 0 %}
            Production
          {% else %}
            Consumption
          {% endif %}
        value_template: "{{ (states('sensor.power_consumption')|float) - (states('sensor.power_production')|float) }}"
        unit_of_measurement: 'kW'

Checklist:

• The code change is tested and works locally.

If user exposed functionality or configuration variables are added/changed:

• Documentation added/updated in home-assistant.github.io

[balloob]

Names are used to identify the entity you're looking at. Icons are used to identify the class of an entity and sometimes the state of that class (like a colored light bulb for lights that are on).

Having the name be templatable means that being able to identify it, is lost.

I find the use case even far fetched and definitely an edge case. I don't think that we should add this.

[arsaboo]

@balloob This only makes the friendly_name templatable and there is a need for something like that. Folks can still search based on entity_id or other attributes. Templates are for advanced users and they should know what they are doing :)

See this thread for a use case. The whole solution was complicated by the fact that we could not use templates for friendly_name.

I understand you may want to keep things simple, but just wanted to highlight the need for something like this.

[rexyiy]

I think this is a really useful feature!
You don't have to use it, if you don't want to (or don't know how) - but if you want you can clean up your frontend by combining more (cohesive) information into one sensor.
@NovapaX's example is IMHO a really good example which I could use (adapted to my needs) several times in my smart home.

[balloob]

You don't have to use it, if you don't want to

This is a bad argument. Every feature we add needs to be maintained, adds runtime overhead, adds tests and so increases the runtime of the test suite that runs for every new feature, adds to the docs etc etc

[balloob]

@arsaboo that seems like an oke use case

[balloob]

Needs tests

[NovapaX]

I was thinking to add similar functionality to rest_sensor. But I guess adding it to template sensor should be enough to cover the use cases. (template sensor can 'pull' from the rest_sensors)
Takes a little more configuration for those who want to use in in combination with other sensors, but this addition should be enough.
If there really is need for this in other sensors it should be solved on another level anyway.

[NovapaX]

EDIT: Ignore the below comment. My mail server got stuck and this came in way after everything was handled nicely. (left the comment for reference) -------- Agree on the edge case argument, but we’re talking about the template sensor here. Which kind of is a solution to all sorts of edge cases. Not being able to identify of course depends how it is used. It could be used to further explain what exactlyuj the user is looking at. (Instead of adding another template sensor to add that information and group them)l Another use case could be the next pickup of the garbage. Instead of showing two sensors (date and type of garbage) that type of garbage can be included in the friendly_name so you only need to show one sensor. I’m just trying to summarize some information to make the homepage/default_view a useful dashboard. Not only for me, but also for my wife.

[jadowse]

seems this does not work on 0.64 on hassio?

[NovapaX]

seems this does not work on 0.64 on hassio?

please file an issue with your configuration and other details.
https://github.com/home-assistant/home-assistant/issues/new