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-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Device class: standardize intro paragraph (#32981)

Browse Source 
* Device class: standardize intro paragraph

* Humidifier device classes: add screenshot

* Apply suggestions from code review

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>

* Fix typo

* Rephrase

* Update source/_integrations/humidifier.markdown

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>

---------

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>
This commit is contained in:
c0ffeeca7 2024-05-28 16:02:23 +02:00 committed by GitHub
parent 290df39c66
commit e567a642c0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
12 changed files with 122 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
source/_integrations/binary_sensor.markdown
View File

@ -27,25 +27,21 @@ a binary sensor to detect room occupancy. Other binary sensors can be created
manually using the [template integration](/integrations/template/) manually using the [template integration](/integrations/template/)
or using an [input boolean helper](/integrations/input_boolean). or using an [input boolean helper](/integrations/input_boolean).
{% include integrations/building_block_integration.md %} {% include integrations/building_block_integration.md %}
### Device class ### Device class
Knowing a sensor is binary impacts how the sensor's current state may be The device class defines how the entity is represented on the [dashboard](/dashboards/). This can be modified in the [customize section](/docs/configuration/customizing-devices/). For example, different states may be represented by different icons, colors, or text.
represented in Home Assistant's UI (see [Dashboards](/dashboards/)). Opposing states
may be given different icons, colors, and value labels to highlight a particular
state over the other. This is set by the binary sensor's device class.
Here are a few examples of this representation in the UI: The screenshot shows a few examples of different device classes for binary sensors:
![List of binary sensors](/images/screenshots/binary_sensor_classes_icons.png) ![List of binary sensors](/images/screenshots/binary_sensor_classes_icons.png)
Example of various device classes icons in `on` and `off` state. The on image Example of various device classes icons in `on` and `off` state. The on image
in this example has `state_color: true` specified in the Entities card in this example has `state_color: true` specified in the entities card
configuration to receive the icon coloring. configuration to receive the icon coloring.
The full list of supported binary sensor device classes is below The following device classes are supported for binary sensors:
*(note: these may also be modified in the [customizing section](/docs/configuration/customizing-devices)).*
- **None**: Generic on/off. This is the default and doesn't need to be set. - **None**: Generic on/off. This is the default and doesn't need to be set.
- **battery**: `on` means low, `off` means normal - **battery**: `on` means low, `off` means normal

12
source/_integrations/button.markdown
View File

@ -9,6 +9,11 @@ ha_domain: button
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: entity ha_integration_type: entity
related:
- docs: /docs/configuration/customizing-devices/
title: Customizing devices
- docs: /dashboards/
title: Dashboard
--- ---
A button {% term entity %} is an entity that can fire an {% term event %} / trigger an {% term action %} towards A button {% term entity %} is an entity that can fire an {% term event %} / trigger an {% term action %} towards
@ -55,14 +60,17 @@ This service can be called to trigger a button press for that entity.
## Device class ## Device class
The way these buttons are displayed in the frontend can be modified in the [customize section](/docs/configuration/customizing-devices/). The device class defines how the entity is represented on the [dashboard](/dashboards/). This can be modified in the [customize section](/docs/configuration/customizing-devices/). For example, different states may be represented by different icons, colors, or text.
The following device classes are supported for buttons:
The screenshot shows different icons representing different device classes for buttons:
<p class='img'> <p class='img'>
<img src='/images/screenshots/button_classes_icons.png' /> <img src='/images/screenshots/button_classes_icons.png' />
Example of device class icons. Example of device class icons.
</p> </p>
The following device classes are supported for buttons:
- **None**: Generic button. This is the default and doesn't need to be set. - **None**: Generic button. This is the default and doesn't need to be set.
- **identify**: The button is used to identify a device. - **identify**: The button is used to identify a device.
- **restart**: The button restarts the device. - **restart**: The button restarts the device.

39
source/_integrations/cover.markdown
View File

@ -9,6 +9,11 @@ ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_domain: cover ha_domain: cover
ha_integration_type: entity ha_integration_type: entity
related:
- docs: /docs/configuration/customizing-devices/
title: Customizing devices
- docs: /dashboards/
title: Dashboard
--- ---
Home Assistant can give you an interface to control covers such as rollershutters, blinds, and garage doors. Home Assistant can give you an interface to control covers such as rollershutters, blinds, and garage doors.
@ -17,7 +22,18 @@ Home Assistant can give you an interface to control covers such as rollershutter
## Device class ## Device class
The way these {% term sensors %} are displayed in the {% term frontend %} can be modified in the [customize section](/docs/configuration/customizing-devices/). The following device classes are supported for covers: The device class defines how the entity is represented on the [dashboard](/dashboards/). This can be modified in the [customize section](/docs/configuration/customizing-devices/). For example, different states may be represented by different icons, colors, or text.
The screenshot shows different icons representing different device classes for covers:
<p class='img'>
<img src='/images/screenshots/cover_classes_icons.png' />
List of cover examples.
</p>
Example of various device classes icons in `open` and `closed` state. The open image in this example has `state_color: true` specified in the Entities card configuration to receive the icon coloring.
The following device classes are supported for covers.
- **None**: Generic cover. This is the default and doesn't need to be set. - **None**: Generic cover. This is the default and doesn't need to be set.
- **awning**: Control of an awning, such as an exterior retractable window, door, or patio cover. - **awning**: Control of an awning, such as an exterior retractable window, door, or patio cover.
@ -31,11 +47,6 @@ The way these {% term sensors %} are displayed in the {% term frontend %} can be
- **shutter**: Control of shutters, which are linked slats that swing out/in to covering an opening or may be tilted to partially cover an opening, such as indoor or exterior window shutters. - **shutter**: Control of shutters, which are linked slats that swing out/in to covering an opening or may be tilted to partially cover an opening, such as indoor or exterior window shutters.
- **window**: Control of a physical window that opens and closes or may tilt. - **window**: Control of a physical window that opens and closes or may tilt.
Here are a few examples of this representation in the UI:
![List of cover examples](/images/screenshots/cover_classes_icons.png)
Example of various device classes icons in `open` and `closed` state. The open image in this example has `state_color: true` specified in the Entities card configuration to receive the icon coloring.
## Services ## Services
### Cover control services ### Cover control services
@ -43,8 +54,8 @@ Example of various device classes icons in `open` and `closed` state. The open i
Available services: `cover.open_cover`, `cover.close_cover`, `cover.stop_cover`, `cover.toggle`, `cover.open_cover_tilt`, `cover.close_cover_tilt`, `cover.stop_cover_tilt`, `cover.toggle_tilt` Available services: `cover.open_cover`, `cover.close_cover`, `cover.stop_cover`, `cover.toggle`, `cover.open_cover_tilt`, `cover.close_cover_tilt`, `cover.stop_cover_tilt`, `cover.toggle_tilt`
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of covers. Use `entity_id: all` to target all. | `entity_id` | yes | String or list of strings that point at `entity_id`'s of covers. Use `entity_id: all` to target all. |
#### Automation example #### Automation example
@ -64,9 +75,9 @@ automation:
Set cover position of one or multiple covers. Set cover position of one or multiple covers.
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of covers. Use `entity_id: all` to target all. | `entity_id` | yes | String or list of strings that point at `entity_id`'s of covers. Use `entity_id: all` to target all. |
| `position` | no | Integer between 0 and 100. | `position` | no | Integer between 0 and 100. |
#### Automation example #### Automation example
@ -88,9 +99,9 @@ automation:
Set cover tilt position of one or multiple covers. Set cover tilt position of one or multiple covers.
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of covers. Use `entity_id: all` to target all. | `entity_id` | yes | String or list of strings that point at `entity_id`'s of covers. Use `entity_id: all` to target all. |
| `tilt_position` | no | Integer between 0 and 100. | `tilt_position` | no | Integer between 0 and 100. |
#### Automation example #### Automation example

7
source/_integrations/event.markdown
View File

@ -9,6 +9,11 @@ ha_domain: event
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: entity ha_integration_type: entity
related:
- docs: /docs/configuration/customizing-devices/
title: Customizing devices
- docs: /dashboards/
title: Dashboard
--- ---
Events are signals that are emitted when something happens, for example, when a user presses a physical button like a doorbell or when a button on a remote control is pressed. Events are signals that are emitted when something happens, for example, when a user presses a physical button like a doorbell or when a button on a remote control is pressed.
@ -77,6 +82,8 @@ When creating automations in the automation editor in the UI, the event types ar
## Device classes ## Device classes
The device class defines how the entity is represented on the [dashboard](/dashboards/). This can be modified in the [customize section](/docs/configuration/customizing-devices/). For example, different states may be represented by different icons, colors, or text.
The following device classes are supported by event entities: The following device classes are supported by event entities:
- **None**: Generic event. This is the default and doesn't need to be set. - **None**: Generic event. This is the default and doesn't need to be set.

14
source/_integrations/humidifier.markdown
View File

@ -10,6 +10,11 @@ ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
- '@Shulyaka' - '@Shulyaka'
ha_integration_type: entity ha_integration_type: entity
related:
- docs: /docs/configuration/customizing-devices/
title: Customizing devices
- docs: /dashboards/
title: Dashboard
--- ---
The `humidifier` integration is built for the controlling and monitoring of humidifiers, dehumidifiers, and hygrostat devices. The `humidifier` integration is built for the controlling and monitoring of humidifiers, dehumidifiers, and hygrostat devices.
@ -18,7 +23,14 @@ The `humidifier` integration is built for the controlling and monitoring of humi
## Device class ## Device class
The way sensors are displayed in the {% term frontend %} can be modified in the [customize section](/docs/configuration/customizing-devices/). For example, if the device class is set to humidifier, the UI shows "Humidifying". If it is set to dehumidifier, it shows "Drying". The device class defines how the entity is represented on the [dashboard](/dashboards/). This can be modified in the [customize section](/docs/configuration/customizing-devices/). For example, different states may be represented by different icons, colors, or text.
The screenshot shows different text and UI for different device classes for humidifiers:
<p class='img'>
<img src='/images/screenshots/humidifier_device_class.png' />
Humidifier device classes.
</p>
The following device classes are supported for humidifiers: The following device classes are supported for humidifiers:

9
source/_integrations/media_player.markdown
View File

@ -9,6 +9,11 @@ ha_domain: media_player
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: entity ha_integration_type: entity
related:
- docs: /docs/configuration/customizing-devices/
title: Customizing devices
- docs: /dashboards/
title: Dashboard
--- ---
Interacts with media players on your network. Interacts with media players on your network.
@ -180,7 +185,9 @@ Allows to group media players together for synchronous playback. Only works on s
### Device class ### Device class
The way media players are displayed in the frontend can be modified in the [customize section](/getting-started/customizing-devices/). The following device classes are supported for media players: The device class defines how the entity is represented on the [dashboard](/dashboards/). This can be modified in the [customize section](/docs/configuration/customizing-devices/). For example, different states may be represented by different icons, colors, or text.
The following device classes are supported for media players:
- `tv`: Device is a television type device. - `tv`: Device is a television type device.
- `speaker`: Device is a speaker or stereo type device. - `speaker`: Device is a speaker or stereo type device.

9
source/_integrations/number.markdown
View File

@ -10,6 +10,11 @@ ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
- '@Shulyaka' - '@Shulyaka'
ha_integration_type: entity ha_integration_type: entity
related:
- docs: /docs/configuration/customizing-devices/
title: Customizing devices
- docs: /dashboards/
title: Dashboard
--- ---
Keeps track on `number` entities in your environment, their state, and allows you to control them. This integration allows other integrations to get a value input from user within a range. Keeps track on `number` entities in your environment, their state, and allows you to control them. This integration allows other integrations to get a value input from user within a range.
@ -20,7 +25,9 @@ If you are looking for a way to create a number entity, please take a look at th
## Device class ## Device class
The type of data a number represents impacts how it is displayed in the frontend. This is controlled by the number's device class designation. Built-in numbers and many created from an integration will have this designation predefined. Those can be modified in the [customize section](/docs/configuration/customizing-devices/). When manually creating a new number the device class may be optionally assigned. A full list of available number device classes is below: The device class defines how the entity is represented on the [dashboard](/dashboards/). This can be modified in the [customize section](/docs/configuration/customizing-devices/). For example, different states may be represented by different icons, colors, or text.
The following device classes are supported for numbers:
- **None**: Generic number. This is the default and doesn't need to be set. - **None**: Generic number. This is the default and doesn't need to be set.
- **apparent_power**: Apparent power in VA. - **apparent_power**: Apparent power in VA.

21
source/_integrations/sensor.markdown
View File

@ -9,6 +9,11 @@ ha_domain: sensor
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: entity ha_integration_type: entity
related:
- docs: /docs/configuration/customizing-devices/
title: Customizing devices
- docs: /dashboards/
title: Dashboard
--- ---
Sensors are a basic integration in Home Assistant. They monitor the states and conditions of a variety of entities. An entity can be many things. This can include a physical device like a motion sensor that reports the battery level, a web service that retrieves the weather temperature, a built-in function that calculates the sun's elevation relative to your GPS position, or even a custom sensor you may have created to report the free space on your laptop. These are all _things_ reporting different types of information. Sensors are a basic integration in Home Assistant. They monitor the states and conditions of a variety of entities. An entity can be many things. This can include a physical device like a motion sensor that reports the battery level, a web service that retrieves the weather temperature, a built-in function that calculates the sun's elevation relative to your GPS position, or even a custom sensor you may have created to report the free space on your laptop. These are all _things_ reporting different types of information.
@ -17,7 +22,16 @@ Some of these sensors are built-in to Home Assistant, some are created automatic
## Device class ## Device class
The type of data a sensor returns impacts how it is displayed in the frontend. This is controlled by the sensor's device class designation. Built-in sensors and many created from an integration will have this designation predefined. Those can be modified in the [customize section](/docs/configuration/customizing-devices/). When manually creating a new sensor the device class may be optionally assigned. A full list of available sensor device classes is below: The device class defines how the entity is represented on the [dashboard](/dashboards/). This can be modified in the [customize section](/docs/configuration/customizing-devices/). For example, different states may be represented by different icons, colors, or text.
The screenshot shows different icons representing different device classes for sensors:
<p class='img'>
<img src='/images/screenshots/sensor_device_classes_icons.png' />
Example of various device class icons for sensors.
</p>
The following device classes are supported for sensors:
- **None**: Generic sensor. This is the default and doesn't need to be set. - **None**: Generic sensor. This is the default and doesn't need to be set.
- **apparent_power**: Apparent power in VA. - **apparent_power**: Apparent power in VA.
@ -71,8 +85,3 @@ The type of data a sensor returns impacts how it is displayed in the frontend. T
- **water**: Water consumption in L, gal, m³, ft³, or CCF - **water**: Water consumption in L, gal, m³, ft³, or CCF
- **weight**: Generic mass in kg, g, mg, µg, oz, lb, or st - **weight**: Generic mass in kg, g, mg, µg, oz, lb, or st
- **wind_speed**: Wind speed in Beaufort, ft/s, km/h, kn, m/s, or mph - **wind_speed**: Wind speed in Beaufort, ft/s, km/h, kn, m/s, or mph
<p class='img'>
<img src='/images/screenshots/sensor_device_classes_icons.png' />
Example of various device class icons for sensors.
</p>

15
source/_integrations/switch.markdown
View File

@ -11,6 +11,11 @@ ha_platforms:
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: entity ha_integration_type: entity
related:
- docs: /docs/configuration/customizing-devices/
title: Customizing devices
- docs: /dashboards/
title: Dashboard
--- ---
Keeps track which switches are in your environment, their state and allows you to control them. Keeps track which switches are in your environment, their state and allows you to control them.
@ -22,10 +27,12 @@ Keeps track which switches are in your environment, their state and allows you t
## Device class ## Device class
The way these switches are displayed in the frontend can be modified in the [customize section](/docs/configuration/customizing-devices/). The following device classes are supported for switches: The device class defines how the entity is represented on the [dashboard](/dashboards/). This can be modified in the [customize section](/docs/configuration/customizing-devices/). For example, different states may be represented by different icons, colors, or text.
The following device classes are supported for switches:
- **None**: Generic switch. This is the default and doesn't need to be set. - **None**: Generic switch. This is the default and doesn't need to be set.
- **outlet**: This switch, switches a power outlet. - **outlet**: A switch for a power outlet.
- **switch**: A generic switch. - **switch**: A generic switch.
## Use the services ## Use the services
@ -37,5 +44,5 @@ In the frontend open the sidebar. At the bottom, under **Developer Tools**, clic
``` ```
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | String or list of strings that point at `entity_id`s of switches. To target all switches, set `entity_id` to `all`. | `entity_id` | no | String or list of strings that point at `entity_id`s of switches. To target all switches, set `entity_id` to `all`. |

10
source/_integrations/update.markdown
View File

@ -8,6 +8,11 @@ ha_domain: update
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: entity ha_integration_type: entity
related:
- docs: /docs/configuration/customizing-devices/
title: Customizing devices
- docs: /dashboards/
title: Dashboard
--- ---
An update {% term entity %} is an entity that indicates if an update is available for a An update {% term entity %} is an entity that indicates if an update is available for a
@ -51,8 +56,9 @@ information on the update state:
## Device class ## Device class
The way these update entities are displayed in the frontend depend on their The device class defines how the entity is represented on the [dashboard](/dashboards/). This can be modified in the [customize section](/docs/configuration/customizing-devices/). For example, different states may be represented by different icons, colors, or text.
device classes. The following device classes are supported for switches:
The following device classes are supported for update entities:
- **`None`**: A generic software update. This is the default and doesn't need - **`None`**: A generic software update. This is the default and doesn't need
to be set. to be set.

9
source/_integrations/valve.markdown
View File

@ -9,6 +9,11 @@ ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_domain: valve ha_domain: valve
ha_integration_type: entity ha_integration_type: entity
related:
- docs: /docs/configuration/customizing-devices/
title: Customizing devices
- docs: /dashboards/
title: Dashboard
--- ---
The valve entity in Home Assistant provides an interface to control valves such as water, gas, or air valves. The valve entity in Home Assistant provides an interface to control valves such as water, gas, or air valves.
@ -17,7 +22,9 @@ The valve entity in Home Assistant provides an interface to control valves such
## Device class ## Device class
You can change the device class of the valve in the [customize section](/docs/configuration/customizing-devices/). Valves support the following device classes: A device class defines how the entity is represented on the [dashboard](/dashboards/). This can be modified in the [customize section](/docs/configuration/customizing-devices/). For example, different states may be represented by different icons, colors, or text.
The following device classes are supported for valves:
- **None**: Generic valve. This is the default and doesn't need to be set. - **None**: Generic valve. This is the default and doesn't need to be set.
- **water**: Valve that controls the flow of water through a system. - **water**: Valve that controls the flow of water through a system.

BIN
source/images/screenshots/humidifier_device_class.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 118 KiB