From 14f0a96a86319c4c26641bcd2b7eb2f7a4c7454d Mon Sep 17 00:00:00 2001 From: SukramJ Date: Fri, 30 Aug 2019 15:17:53 +0200 Subject: [PATCH] Add enabled property to entity doc (#310) * Add enabled property to entity doc * Update entity_index.md * moved property enabled to System Properties * switch to lowercase * fix typo --- docs/entity_index.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/entity_index.md b/docs/entity_index.md index 031928f6..8fa56d29 100644 --- a/docs/entity_index.md +++ b/docs/entity_index.md @@ -77,6 +77,14 @@ The following properties are also available on entities. However, they are for a | icon | icon | `None` | Icon to use in the frontend. Icons start with `mdi:` plus an [identifier](https://materialdesignicons.com/). You probably don't need this since Home Assistant already provides default icons for all devices. | entity_registry_enabled_default | boolean | `True` | Indicate if the entity should be enabled or disabled when it is first added to the entity registry. +## System properties + +The following properties are used and controlled by Home Assistant, and should not be overridden by integrations. + +| Name | Type | Default | Description +| ---- | ---- | ------- | ----------- +| enabled | boolean | `True` | Indicate if entity is enabled in the entity registry. It also returns `True` if the platform doesn't support the entity registry. Disabled entities will not be added to Home Assistant. + ## Standard attributes The following `device_state_attributes` are considered standard and should follow the convention below. The constant should be imported from `homeassistant/const.py`.