jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-16 13:56:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update switch.command_line friendly_name behavior (#1437)

Browse Source 
`switch.command_line` will now always use `object_id` for `entity_id`, even if `friendly_name` is given.

https://github.com/home-assistant/home-assistant/issues/3434
https://github.com/home-assistant/home-assistant/pull/4343

How interesting -- issue 3434 and PR 4343.
This commit is contained in:
Nathan Henrie 2016-11-16 14:14:31 -07:00 committed by Fabian Affolter
parent 3587076d2e
commit edf76a05b2
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
source/_components/switch.command_line.markdown
View File

@ -38,6 +38,10 @@ Configuration variables:
- **value_template** (*Optional*): If specified, `command_state` will ignore the result code of the command but the template evaluating to `true` will indicate the switch is on.
- **friendly_name** (*Optional*): The name used to display the switch in the frontend.
A note on `friendly_name`:
When set, the `friendly_name` had been previously used for API calls and backend configuration instead of the `object_id` ("identifier"), but [this behavior is changing](https://github.com/home-assistant/home-assistant/pull/4343) to make the `friendly_name` for display purposes only. This allows users to set an `identifier` that emphasizes uniqueness and predictability for API and config purposes but have a prettier `friendly_name` still show up in the UI. As an additional benefit, if a user wanted to change the `friendly_name` / display name (e.g. from "Kitchen Lightswitch" to "Kitchen Switch" or "Living Room Light", or remove the `friendly_name` altogether), he or she could do so without needing to change existing automations or API calls. See aREST device below for an example.
## {% linkable_title Examples %}
In this section you find some real life examples of how to use this switch.
@ -51,14 +55,16 @@ The example below is doing the same as the [aREST switch](/components/switch.are
switch:
platform: command_line
switches:
arest_pin4:
arest_pin_four:
command_on: "/usr/bin/curl -X GET http://192.168.1.10/digital/4/1"
command_off: "/usr/bin/curl -X GET http://192.168.1.10/digital/4/0"
command_state: "/usr/bin/curl -X GET http://192.168.1.10/digital/4"
value_template: '{% raw %}{{ return_value == "1" }}{% endraw %}'
friendly_name: aREST Pin 4
friendly_name: Kitchen Lightswitch
```
Given this example, in the UI one would see the `friendly_name` of "Kitchen Light". However, the `identifier` is `arest_pin_four`, making the `entity_id` `switch.arest_pin_four`, which is what one would use in [`automation`](https://home-assistant.io/components/automation/) or in [API calls](https://home-assistant.io/developers/).
### {% linkable_title Shutdown your local host %}
This switch will shutdown your system that is hosting Home Assistant.