Document entity_category for MQTT entities (#19786)

This commit is contained in:
Erik Montnemery 2021-10-17 19:19:10 +02:00 committed by GitHub
parent f4294d6a32
commit 2f27e946ac
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
15 changed files with 85 additions and 0 deletions

View File

@ -131,6 +131,11 @@ enabled_by_default:
required: false
type: boolean
default: true
entity_category:
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
required: false
type: string
default: None
icon:
description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
required: false

View File

@ -105,6 +105,11 @@ enabled_by_default:
required: false
type: boolean
default: true
entity_category:
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
required: false
type: string
default: None
expire_after:
description: Defines the number of seconds after the sensor's state expires, if it's not updated. After expiry, the sensor's state becomes `unavailable`.
required: false

View File

@ -94,6 +94,11 @@ enabled_by_default:
required: false
type: boolean
default: true
entity_category:
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
required: false
type: string
default: None
icon:
description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
required: false

View File

@ -133,6 +133,11 @@ enabled_by_default:
required: false
type: boolean
default: true
entity_category:
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
required: false
type: string
default: None
fan_mode_command_template:
description: A template to render the value sent to the `fan_mode_command_topic` with.
required: false

View File

@ -115,6 +115,11 @@ enabled_by_default:
required: false
type: boolean
default: true
entity_category:
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
required: false
type: string
default: None
icon:
description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
required: false

View File

@ -106,6 +106,11 @@ enabled_by_default:
required: false
type: boolean
default: true
entity_category:
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
required: false
type: string
default: None
icon:
description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
required: false

View File

@ -112,6 +112,11 @@ enabled_by_default:
required: false
type: boolean
default: true
entity_category:
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
required: false
type: string
default: None
icon:
description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
required: false

View File

@ -165,6 +165,11 @@ enabled_by_default:
required: false
type: boolean
default: true
entity_category:
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
required: false
type: string
default: None
effect_command_topic:
description: "The MQTT topic to publish commands to change the light's effect state."
required: false
@ -526,6 +531,11 @@ enabled_by_default:
required: false
type: boolean
default: true
entity_category:
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
required: false
type: string
default: None
effect:
description: Flag that defines if the light supports effects.
required: false
@ -864,6 +874,11 @@ enabled_by_default:
required: false
type: boolean
default: true
entity_category:
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
required: false
type: string
default: None
effect_list:
description: List of possible effects.
required: false

View File

@ -102,6 +102,11 @@ enabled_by_default:
required: false
type: boolean
default: true
entity_category:
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
required: false
type: string
default: None
icon:
description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
required: false

View File

@ -96,6 +96,11 @@ enabled_by_default:
required: false
type: boolean
default: true
entity_category:
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
required: false
type: string
default: None
icon:
description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
required: false

View File

@ -59,6 +59,11 @@ enabled_by_default:
required: false
type: boolean
default: true
entity_category:
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
required: false
type: string
default: None
icon:
description: Icon for the scene.
required: false

View File

@ -100,6 +100,11 @@ enabled_by_default:
required: false
type: boolean
default: true
entity_category:
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
required: false
type: string
default: None
icon:
description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
required: false

View File

@ -97,6 +97,11 @@ enabled_by_default:
required: false
type: boolean
default: true
entity_category:
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
required: false
type: string
default: None
expire_after:
description: Defines the number of seconds after the sensor's state expires, if it's not updated. After expiry, the sensor's state becomes `unavailable`.
required: false

View File

@ -102,6 +102,11 @@ enabled_by_default:
required: false
type: boolean
default: true
entity_category:
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
required: false
type: string
default: None
icon:
description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
required: false

View File

@ -98,6 +98,11 @@ enabled_by_default:
required: false
type: boolean
default: true
entity_category:
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
required: false
type: string
default: None
error_template:
description: Defines a [template](/topics/templating/) to define potential error messages emitted by the vacuum. This is required if `error_topic` is set.
required: false