Restore old config format docs

This commit is contained in:
Paulus Schoutsen 2017-02-19 12:33:48 -08:00
parent 6116ee55c3
commit c644446fe7

View File

@ -11,31 +11,26 @@ footer: true
By default, all of your devices will be visible and have a default icon determined by their domain. You can customize the look and feel of your front page by altering some of these parameters. This can be done by overriding attributes of specific entities. By default, all of your devices will be visible and have a default icon determined by their domain. You can customize the look and feel of your front page by altering some of these parameters. This can be done by overriding attributes of specific entities.
This format works for version 0.37+. For pre-0.37 use [Older format](https://home-assistant.io/getting-started/customizing-devices/#older-format)
`customize` consists of a list of attribute customization blocks
```yaml ```yaml
# Example configuration.yaml entry
homeassistant: homeassistant:
name: Home name: Home
unit_system: metric unit_system: metric
# etc # etc
customize: customize:
# Only the 'entity_id' is required. All other options are optional. # Add an entry for each entity that you want to overwrite.
- entity_id: sensor.living_room_motion sensor.living_room_motion:
hidden: true hidden: true
- entity_id: thermostat.family_roomfamily_room thermostat.family_room:
entity_picture: https://example.com/images/nest.jpg entity_picture: https://example.com/images/nest.jpg
friendly_name: Nest friendly_name: Nest
- entity_id: switch.wemo_switch_1 switch.wemo_switch_1:
friendly_name: Toaster friendly_name: Toaster
entity_picture: /local/toaster.jpg entity_picture: /local/toaster.jpg
- entity_id: switch.wemo_switch_2 switch.wemo_switch_2:
friendly_name: Kitchen kettle friendly_name: Kitchen kettle
icon: mdi:kettle icon: mdi:kettle
- entity_id: switch.rfxtrx_switch switch.rfxtrx_switch:
assumed_state: false assumed_state: false
``` ```
@ -50,59 +45,6 @@ homeassistant:
| `assumed_state` | For switches with an assumed state two buttons are shown (turn off, turn on) instead of a switch. By setting `assumed_state` to `false` you will get the default switch icon. | `assumed_state` | For switches with an assumed state two buttons are shown (turn off, turn on) instead of a switch. By setting `assumed_state` to `false` you will get the default switch icon.
| `sensor_class` | Sets the [class of the sensor](/components/binary_sensor/), changing the device state and icon that is displayed on the UI (see below). | `sensor_class` | Sets the [class of the sensor](/components/binary_sensor/), changing the device state and icon that is displayed on the UI (see below).
### {% linkable_title Advanced example %}
You can also specify attributes for all devices in a domain, use wildcards, use several entity IDs as a list or comma separated list.
```yaml
homeassistant:
customize:
- entity_id: sensor
icon: mdi:kettle # Give all sensor the kettle icon
- entity_id: light.family*
hidden: true # Hide all lights that have an ID starting with 'family'
- entity_id: switch.wemo_switch_1,switch.wemo_switch_2,switch.wemo_switch_3
entity_picture: /local/toaster.jpg # Set picture on multiple devices
```
Either `entity_id` must be present in each customization block.
### {% linkable_title Older format %}
In the previous version of customize format the keys were the IDs:
```yaml
homeassistant:
name: Home
unit_system: metric
# etc
customize:
# Only the 'entity_id' is required. All other options are optional.
sensor.living_room_motion:
hidden: true
thermostat.family_roomfamily_room:
entity_picture: https://example.com/images/nest.jpg
friendly_name: Nest
switch.wemo_switch_1:
friendly_name: Toaster
entity_picture: /local/toaster.jpg
switch.wemo_switch_2:
friendly_name: Kitchen kettle
icon: mdi:kettle
- entity_id: switch.rfxtrx_switch:
assumed_state: false
```
This format doesn't support comma-separated IDs, wildcards or domain matching.
The formats can't be mixed
```yaml
# NOT A VALID CONFIGURATION
customize:
sensor.living_room_motion:
hidden: true
- entity_id: thermostat.family_roomfamily_room
friendly_name: Nest
```
### {% linkable_title Reloading customize %} ### {% linkable_title Reloading customize %}