5.7 KiB
| title | description | redirect_from |
|---|---|---|
| Customizing entities | Simple customization for entities in the frontend. | /getting-started/customizing-devices/ |
Changing the entity_id
You can use the UI to change the entity_id and friendly name of supported entities. To do this:
- Select the entity, either from the frontend or by clicking
next to the entity in the dev-states menu - Click on the cog in the right corner of the entity's dialog
- Enter the new name or the new entity ID (remember not to change the domain of the entity - the part before the
.) - Select Save
If your entity is not supported, or you cannot customize what you need via this method, please see below for more options:
Customizing 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.
Customization using the UI
Under the Configuration menu you'll find the Customization menu. If this menu item is not visible, enable advanced mode on your profile page first. When you select an entity to customize, you'll see all the existing attributes listed and you can customize those or select an additional supported attribute (see below). You may also need to add the following to your configuration.yaml file, depending when you started using Home Assistant:
homeassistant:
customize: !include customize.yaml
Possible values
{% configuration customize %}
friendly_name:
description: Name of the entity as displayed in the UI.
required: false
type: string
homebridge_name:
description: Name of the entity in HomeBridge.
required: false
type: string
hidden:
description: Set to true to hide the entity.
required: false
type: boolean
default: false
homebridge_hidden:
description: Set to true to hide the entity from HomeBridge.
required: false
type: boolean
default: false
emulated_hue_hidden:
description: Set to true to hide the entity from emulated_hue (this will be deprecated in the near future and should be configured in emulated_hue).
required: false
type: boolean
default: false
entity_picture:
description: URL to use as picture for entity.
required: false
type: string
icon:
description: "Any icon from MaterialDesignIcons.com (Cheatsheet). Prefix name with mdi:, ie mdi:home. Note: Newer icons may not yet be available in the current Home Assistant release. You can check when an icon was added to MaterialDesignIcons.com at MDI History."
required: false
type: string
assumed_state:
description: 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.
required: false
type: boolean
default: true
device_class:
description: Sets the class of the device, changing the device state and icon that is displayed on the UI (see below). It does not set the unit_of_measurement.
required: false
type: device_class
default: None
unit_of_measurement:
description: Defines the units of measurement, if any. This will also influence the graphical presentation in the history visualisation as continuous value. Sensors with missing unit_of_measurement are showing as discrete values.
required: false
type: string
default: None
initial_state:
description: Sets the initial state for automations, on or off.
required: false
type: string
{% endconfiguration %}
Device Class
Device class is currently supported by the following components:
Manual customization
If you implement customize, customize_domain, or customize_glob you must make sure it is done inside of homeassistant: or it will fail.
homeassistant:
name: Home
unit_system: metric
# etc
customize:
# Add an entry for each entity that you want to overwrite.
sensor.living_room_motion:
hidden: true
thermostat.family_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
switch.rfxtrx_switch:
assumed_state: false
# Customize all entities in a domain
customize_domain:
light:
icon: mdi:home
automation:
initial_state: 'on'
# Customize entities matching a pattern
customize_glob:
"light.kitchen_*":
icon: mdi:description
"scene.month_*_colors":
hidden: true
emulated_hue_hidden: false
homebridge_hidden: true
Reloading customize
Home Assistant offers a service to reload the core configuration while Home Assistant is running called homeassistant.reload_core_config. This allows you to change your customize section and see it being applied without having to restart Home Assistant. To call this service, go to the 
service developer tools, select the service homeassistant.reload_core_config and click "CALL SERVICE".