mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-22 16:56:50 +00:00
Remove entity registry docs (#6030)
This commit is contained in:
Paulus Schoutsen
Franck Nijhof
parent
0817f273ba
commit
062f785563
@ -1,48 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Entity Registry"
|
||||
description: "The entity registry contains."
|
||||
date: 2016-04-20 06:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
Starting with version 0.63, Home Assistant keeps a registry of known entities. The entity registry makes sure that entities get unique identifiers and allow customizing the identifiers and names of these entities.
|
||||
|
||||
Changes require that Home Assistant is shut down when you edit the file, otherwise Home Assistant may over-write your changes, and a restart of Home Assistant is required for your changes to take effect. Version 0.75 introduced a configuration user interface.
|
||||
|
||||
<p class='note'>
|
||||
An entity needs to have a unique ID to be registered in the entity registry.
|
||||
Not all integrations currently provide a unique id for their entities.
|
||||
</p>
|
||||
|
||||
The entity registry is stored in `<config>/entity_registry.yaml`. As a user, you are unable to add entries, only update them. Here is an example file:
|
||||
|
||||
```yaml
|
||||
climate.downstairs_virtual:
|
||||
platform: nest
|
||||
unique_id: EPoMyWkpNyoYu3pGlmGxabcdefghijkl
|
||||
name: Downstairs thermostat
|
||||
light.study_ceiling:
|
||||
platform: hue
|
||||
unique_id: f0:fe:6b:00:14:00:00:00-00
|
||||
disabled_by: user
|
||||
```
|
||||
|
||||
As a user, you can change the `entity_id` and add the `name` and `disabled_by`value to each entry.
|
||||
|
||||
- Changing the _first line_ of each entry will change the `entity_id` of the entity throughout Home Assistant.
|
||||
- The value of `name` will override the _friendly name_ of the entity as given by the integration.
|
||||
|
||||
_Added in Home Assistant 0.64._
|
||||
- The key `disabled_by` can either be `hass` or `user`. This functionality is even more experimental than the whole entity registry itself and might cause integrations to fail and might be removed in the future.
|
||||
|
||||
_Added in Home Assistant 0.64._
|
||||
|
||||
{% linkable_title Supported Components %}
|
||||
|
||||
Only components that provide a unique ID for entities will are supported.
|
||||
|
||||
Note that for Weather Underground, second and subsequent Personal Weather Station ID (pws_id) will have their monitored conditions suffixed with an index number.
|
||||
@ -32,10 +32,6 @@ Here is where you [include and exclude](/docs/z-wave/adding/) Z-Wave devices fro
|
||||
|
||||
## {% linkable_title Z-Wave Node Management %}
|
||||
|
||||
<p class='note warning'>
|
||||
Since 0.63 and the new experimental [entity registry](/docs/configuration/entity-registry/) **Rename Node** no longer changes the entity id for anything other than the `zwave.` entity for the node (it does change the default *friendly_name* attribute for all the entities). If you would like to update the entity id after renaming a z-wave device, you need to manually edit the [entity_registry.yaml](/docs/configuration/entity-registry/) file. See [this issue](https://github.com/home-assistant/home-assistant/issues/12430).
|
||||
</p>
|
||||
|
||||
* **Refresh Node** refreshes the information on the node and its entities. If used on a battery powered device, the device will first need to wake for this to work.
|
||||
* **Remove Failed Node** will remove a failed node from the network. The node needs to be on the controller's Failed Node List (marked as `is_failed: true`), otherwise this command will fail.
|
||||
* **Replace Failed Node** will replace a failed device with another. If the node is not in the controller's Failed Node List, or the node responds, this command will fail.
|
||||
@ -49,24 +45,6 @@ Since 0.63 and the new experimental [entity registry](/docs/configuration/entity
|
||||
Battery powered devices need to be awake before you can use the Z-Wave control panel to update their settings. How to wake your device is device specific, and some devices will stay awake for only a couple of seconds. Please refer to the manual of your device for more details.
|
||||
</p>
|
||||
|
||||
### {% linkable_title Renaming all entities of a node %}
|
||||
|
||||
When you use *Rename Node* it, as mentioned above, only changes the `zwave.` entity. If you've just added a device then the other entities for that device will use that new entity name as the base. However existing entities won't be renamed, so you need to remove them from `entity_registry.yaml`, and the process is like this:
|
||||
|
||||
1. Use *Rename Node* to rename the `zwave.` entity and set the base for all the other entities
|
||||
2. Shut down Home Assistant and wait for it to stop
|
||||
3. Delete the relevant entries from `entity_registry.yaml`
|
||||
4. Start Home Assistant again
|
||||
|
||||
Each block you need to delete will look something like this, you need to delete all 4 lines for each entry. The first number of the `unique-id` is the Node ID of the Z-Wave node.
|
||||
|
||||
```yaml
|
||||
sensor.fibaro_door_sensor_access_control:
|
||||
name:
|
||||
platform: zwave
|
||||
unique_id: 5-72057594126614528
|
||||
```
|
||||
|
||||
#### {% linkable_title Entities of this node %}
|
||||
|
||||
This is a dropdown where you can select all the entities of this node. Once selected you can then use:
|
||||
|
||||
@ -12,7 +12,6 @@
|
||||
<li>{% active_link /hassio/ Hass.io %}</li>
|
||||
<li>{% active_link /docs/installation/virtualenv/ Python Virtual Env %}</li>
|
||||
<li>{% active_link /docs/installation/hassbian/ Hassbian %}</li>
|
||||
<!--<li>{% active_link /docs/installation/raspberry-pi-all-in-one/ Raspberry Pi All-in-One %}</li>-->
|
||||
<li>{% active_link /docs/installation/updating/ Updating %}</li>
|
||||
<li>{% active_link /docs/installation/troubleshooting/ Troubleshooting %}</li>
|
||||
</ul>
|
||||
@ -23,7 +22,6 @@
|
||||
<li>{% active_link /docs/configuration/yaml/ YAML %}</li>
|
||||
<li>{% active_link /docs/configuration/basic/ Basic information %}</li>
|
||||
<li>{% active_link /docs/configuration/devices/ Setting up devices %}</li>
|
||||
<li>{% active_link /docs/configuration/entity-registry/ Entity Registry %}</li>
|
||||
<li>{% active_link /docs/configuration/customizing-devices/ Customizing entities %}</li>
|
||||
<li>{% active_link /docs/configuration/troubleshooting/ Troubleshooting %}</li>
|
||||
<li>{% active_link /docs/configuration/securing/ Security Check Points %}</li>
|
||||
|
||||
@ -55,7 +55,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
|
||||
## Breaking Changes
|
||||
|
||||
- Refactor Hue: If you specify a bridge in your config, the `host` key is now required and needs to be a valid ip address. Option `allow_in_emulated_hue` has been removed. Exclude the lights via the emulated hue config. Due to the internal changes of how the Hue integration works, any Hue custom component will no longer work. ([@balloob] - [#13043]) ([hue docs]) ([light.hue docs]) (breaking change)
|
||||
- Z-Wave: In version 0.47, the opt-in `new_entity_ids` configuration was added to Z-Wave to smooth the transition through the change. Support for old entity IDs is now removed, and the configuration is no longer necessary. If you are migrating from 0.63 or higher, your entity IDs will already be stored in the Entity Registry and no changes are required. If not, [entity IDs can now be manually configured using the Entity Registry](/docs/configuration/entity-registry/) if necessary. ([@armills] - [#12652]) ([zwave docs]) (breaking change)
|
||||
- Z-Wave: In version 0.47, the opt-in `new_entity_ids` configuration was added to Z-Wave to smooth the transition through the change. Support for old entity IDs is now removed, and the configuration is no longer necessary. If you are migrating from 0.63 or higher, your entity IDs will already be stored in the Entity Registry and no changes are required. If not, entity IDs can now be manually configured using the Entity Registry if necessary. ([@armills] - [#12652]) ([zwave docs]) (breaking change)
|
||||
- Spotcrime sensor: This update changes the sensor to require a user supplied API key as a configuration entry. The default key has been removed from the Spotcrime package and has also been modified to accept a user supplied API key.([@jcconnell] - [#12926]) ([sensor.spotcrime docs]) (breaking change)
|
||||
- Smappee sensor: Fixed SI units for current consumption. Total consumption should be in kWh. not kW. ([@vandenberghev] - [#13190]) ([sensor.smappee docs]) (breaking change)
|
||||
- System monitor sensor: Used and available swap space reported by the system monitor component is now measured in MiB instead of GiB. ([@DanNixon] - [#13148]) ([sensor.systemmonitor docs]) (breaking change)
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user