jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-14 12:56:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update type of device_info in entity.md (#2363)

Browse Source
This commit is contained in:
Kars de Jong 2024-10-14 11:58:23 +02:00 committed by GitHub
parent adfeab2cdc
commit f627443fc7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/core/entity.md
View File

@ -101,7 +101,7 @@ The following properties are used to populate the entity and device registries.
| Name | Type | Default | Description
| ------------------------------- | --------------------------------------- | ------- | -----------
| device_info | <code>dict &#124; None</code> | `None` | [Device registry](/docs/device_registry_index) descriptor for [automatic device registration.](/docs/device_registry_index#automatic-registration-through-an-entity)
| device_info | <code>DeviceInfo &#124; None</code> | `None` | [Device registry](/docs/device_registry_index) descriptor for [automatic device registration.](/docs/device_registry_index#automatic-registration-through-an-entity)
| entity_category | <code>EntityCategory &#124; None</code> | `None` | Classification of a non-primary entity. Set to `EntityCategory.CONFIG` for an entity that allows changing the configuration of a device, for example, a switch entity, making it possible to turn the background illumination of a switch on and off. Set to `EntityCategory.DIAGNOSTIC` for an entity exposing some configuration parameter or diagnostics of a device but does not allow changing it, for example, a sensor showing RSSI or MAC address. |
| entity_registry_enabled_default | `bool` | `True` | Indicate if the entity should be enabled or disabled when first added to the entity registry. This includes fast-changing diagnostic entities or, assumingly less commonly used entities. For example, a sensor exposing RSSI or battery voltage should typically be set to `False`; to prevent unneeded (recorded) state changes or UI clutter by these entities. |
| entity_registry_visible_default | `bool` | `True` | Indicate if the entity should be hidden or visible when first added to the entity registry. |