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.

If you implement customize, customize_domain, or customize_glob you must make sure it is done inside of homeassistant: or it will fail.

  name: Home
  unit_system: metric
  # etc

    # Add an entry for each entity that you want to overwrite.
      hidden: true
      friendly_name: Nest
      friendly_name: Toaster
      entity_picture: /local/toaster.jpg
      friendly_name: Kitchen kettle
      icon: mdi:kettle
      assumed_state: false
  # Customize all entities in a domain
      icon: mdi:home
      initial_state: 'on'
  # Customize entities matching a pattern
      icon: mdi:description
      hidden: true
      emulated_hue_hidden: false
      homebridge_hidden: true

Possible values

Attribute Description
friendly_name Name of the entity.
homebridge_name Name of the entity in HomeBridge.
hidden Set to true to hide the entity.
homebridge_hidden Set to true to hide the entity from HomeBridge.
emulated_hue_hidden 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).
entity_picture Url to use as picture for entity.
icon Any icon from (Cheatsheet). Prefix name with mdi:, ie mdi:home.
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.
device_class Sets the class of the device, changing the device state and icon that is displayed on the UI (see below).
initial_state Sets the initial state for automations. on or off.
unit_of_measurement Defines the units of measurement, if any.

Device Class

Device class is currently supported by the following components:

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 tool icon service developer tools, select the service homeassistant.reload_core_config and click “CALL SERVICE”.

New customize information will be applied the next time the state of the entity gets updated.