Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-10-31 08:31:29 +01:00
Code Issues Projects Releases Wiki Activity

Add 'icon' property to Binary Sensor, Climate, Cover, Fan, and Light platforms (#1489)

Browse Source 
* Added 'icon' field to lights

* Icon property is not ignored (checked with HA 2021.9.7) if a device class is set

* Added icon properties to binary sensor, climate, cover, and fan components
This commit is contained in:
Paul Monigatti 2021-10-10 21:39:50 +13:00 committed by GitHub
parent 8bed2ede8d
commit 5f0f796387
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
components/binary_sensor/index.rst
View File

@ -30,6 +30,7 @@ Configuration variables:
- **device_class** (*Optional*, string): The device class for the
sensor. See https://www.home-assistant.io/components/binary_sensor/
for a list of available options.
- **icon** (*Optional*, icon): Manually set the icon to use for the binary sensor in the frontend.
- **filters** (*Optional*, list): A list of filters to apply on the binary sensor values such as
inverting signals. See :ref:`binary_sensor-filters`.

1
components/climate/index.rst
View File

@ -33,6 +33,7 @@ All climate platforms in ESPHome inherit from the climate configuration schema.
Configuration variables:
- **icon** (*Optional*, icon): Manually set the icon to use for the climate device in the frontend.
- **visual** (*Optional*): Visual settings for the climate device - these do not
affect operation and are solely for controlling how the climate device shows up in the
frontend.

1
components/cover/index.rst
View File

@ -30,6 +30,7 @@ Configuration variables:
- **device_class** (*Optional*, string): The device class for the
sensor. See https://www.home-assistant.io/components/cover/ for a list of available options.
- **icon** (*Optional*, icon): Manually set the icon to use for the cover in the frontend.
Advanced options:

1
components/fan/index.rst
View File

@ -29,6 +29,7 @@ Base Fan Configuration
Configuration variables:
- **name** (**Required**, string): The name of the fan.
- **icon** (*Optional*, icon): Manually set the icon to use for the fan in the frontend.
- **internal** (*Optional*, boolean): Mark this component as internal. Internal components will
not be exposed to the frontend (like Home Assistant). Only specifying an ``id`` without
a ``name`` will implicitly set this to true.

1
components/light/index.rst
View File

@ -26,6 +26,7 @@ All light configuration schemas inherit these options.
Configuration variables:
- **icon** (*Optional*, icon): Manually set the icon to use for the light in the frontend.
- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
- **gamma_correct** (*Optional*, float): Apply a `gamma correction
factor <https://en.wikipedia.org/wiki/Gamma_correction>`__ to the light channels.

3
components/sensor/index.rst
View File

@ -48,8 +48,7 @@ Configuration variables:
- **state_class** (*Optional*, string): The state class for the
sensor. See https://developers.home-assistant.io/docs/core/entity/sensor/#available-state-classes
for a list of available options. Set to ``""`` to remove the default state class of a sensor.
- **icon** (*Optional*, icon): Manually set the icon to use for the sensor in the frontend. The icon set here
is ignored by Home Assistant, if a device class is already set.
- **icon** (*Optional*, icon): Manually set the icon to use for the sensor in the frontend.
- **accuracy_decimals** (*Optional*, int): Manually set the accuracy of decimals to use when reporting values.
- **filters** (*Optional*): Specify filters to use for some basic
transforming of values. See :ref:`Sensor Filters <sensor-filters>` for more information.