mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 15:26:59 +00:00
Document MQTT enabled_by_default (#18069)
This commit is contained in:
parent
b8b14dbba6
commit
464231a9de
@ -125,6 +125,11 @@ device:
|
|||||||
description: "Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant."
|
description: "Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant."
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
enabled_by_default:
|
||||||
|
description: Flag which defines if the entity should be enabled when first added.
|
||||||
|
required: false
|
||||||
|
type: boolean
|
||||||
|
default: true
|
||||||
icon:
|
icon:
|
||||||
description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
|
description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
|
||||||
required: false
|
required: false
|
||||||
|
@ -100,6 +100,11 @@ device_class:
|
|||||||
description: Sets the [class of the device](/integrations/binary_sensor/#device-class), changing the device state and icon that is displayed on the frontend.
|
description: Sets the [class of the device](/integrations/binary_sensor/#device-class), changing the device state and icon that is displayed on the frontend.
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
enabled_by_default:
|
||||||
|
description: Flag which defines if the entity should be enabled when first added.
|
||||||
|
required: false
|
||||||
|
type: boolean
|
||||||
|
default: true
|
||||||
expire_after:
|
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`.
|
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
|
required: false
|
||||||
|
@ -89,6 +89,11 @@ device:
|
|||||||
description: 'Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.'
|
description: 'Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.'
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
enabled_by_default:
|
||||||
|
description: Flag which defines if the entity should be enabled when first added.
|
||||||
|
required: false
|
||||||
|
type: boolean
|
||||||
|
default: true
|
||||||
icon:
|
icon:
|
||||||
description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
|
description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
|
||||||
required: false
|
required: false
|
||||||
|
@ -128,6 +128,11 @@ device:
|
|||||||
description: 'Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.'
|
description: 'Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.'
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
enabled_by_default:
|
||||||
|
description: Flag which defines if the entity should be enabled when first added.
|
||||||
|
required: false
|
||||||
|
type: boolean
|
||||||
|
default: true
|
||||||
fan_mode_command_template:
|
fan_mode_command_template:
|
||||||
description: A template to render the value sent to the `fan_mode_command_topic` with.
|
description: A template to render the value sent to the `fan_mode_command_topic` with.
|
||||||
required: false
|
required: false
|
||||||
|
@ -110,6 +110,11 @@ device_class:
|
|||||||
description: Sets the [class of the device](/integrations/cover/), changing the device state and icon that is displayed on the frontend.
|
description: Sets the [class of the device](/integrations/cover/), changing the device state and icon that is displayed on the frontend.
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
enabled_by_default:
|
||||||
|
description: Flag which defines if the entity should be enabled when first added.
|
||||||
|
required: false
|
||||||
|
type: boolean
|
||||||
|
default: true
|
||||||
icon:
|
icon:
|
||||||
description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
|
description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
|
||||||
required: false
|
required: false
|
||||||
|
@ -101,6 +101,11 @@ device:
|
|||||||
description: 'Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.'
|
description: 'Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.'
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
enabled_by_default:
|
||||||
|
description: Flag which defines if the entity should be enabled when first added.
|
||||||
|
required: false
|
||||||
|
type: boolean
|
||||||
|
default: true
|
||||||
icon:
|
icon:
|
||||||
description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
|
description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
|
||||||
required: false
|
required: false
|
||||||
|
@ -151,6 +151,11 @@ device:
|
|||||||
description: 'Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.'
|
description: 'Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.'
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
enabled_by_default:
|
||||||
|
description: Flag which defines if the entity should be enabled when first added.
|
||||||
|
required: false
|
||||||
|
type: boolean
|
||||||
|
default: true
|
||||||
effect_command_topic:
|
effect_command_topic:
|
||||||
description: "The MQTT topic to publish commands to change the light's effect state."
|
description: "The MQTT topic to publish commands to change the light's effect state."
|
||||||
required: false
|
required: false
|
||||||
@ -516,6 +521,11 @@ device:
|
|||||||
description: 'The firmware version of the device.'
|
description: 'The firmware version of the device.'
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
enabled_by_default:
|
||||||
|
description: Flag which defines if the entity should be enabled when first added.
|
||||||
|
required: false
|
||||||
|
type: boolean
|
||||||
|
default: true
|
||||||
effect:
|
effect:
|
||||||
description: Flag that defines if the light supports effects.
|
description: Flag that defines if the light supports effects.
|
||||||
required: false
|
required: false
|
||||||
@ -849,6 +859,11 @@ device:
|
|||||||
description: 'The firmware version of the device.'
|
description: 'The firmware version of the device.'
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
enabled_by_default:
|
||||||
|
description: Flag which defines if the entity should be enabled when first added.
|
||||||
|
required: false
|
||||||
|
type: boolean
|
||||||
|
default: true
|
||||||
effect_list:
|
effect_list:
|
||||||
description: List of possible effects.
|
description: List of possible effects.
|
||||||
required: false
|
required: false
|
||||||
|
@ -97,6 +97,11 @@ device:
|
|||||||
description: 'Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.'
|
description: 'Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.'
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
enabled_by_default:
|
||||||
|
description: Flag which defines if the entity should be enabled when first added.
|
||||||
|
required: false
|
||||||
|
type: boolean
|
||||||
|
default: true
|
||||||
icon:
|
icon:
|
||||||
description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
|
description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
|
||||||
required: false
|
required: false
|
||||||
|
@ -87,6 +87,11 @@ device:
|
|||||||
description: 'Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.'
|
description: 'Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.'
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
enabled_by_default:
|
||||||
|
description: Flag which defines if the entity should be enabled when first added.
|
||||||
|
required: false
|
||||||
|
type: boolean
|
||||||
|
default: true
|
||||||
icon:
|
icon:
|
||||||
description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
|
description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
|
||||||
required: false
|
required: false
|
||||||
|
@ -51,18 +51,23 @@ availability_topic:
|
|||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
command_topic:
|
command_topic:
|
||||||
description: The MQTT topic to publish commands to change the switch state.
|
description: The MQTT topic to publish commands to change the scene state.
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
enabled_by_default:
|
||||||
|
description: Flag which defines if the entity should be enabled when first added.
|
||||||
|
required: false
|
||||||
|
type: boolean
|
||||||
|
default: true
|
||||||
icon:
|
icon:
|
||||||
description: Icon for the switch.
|
description: Icon for the scene.
|
||||||
required: false
|
required: false
|
||||||
type: icon
|
type: icon
|
||||||
name:
|
name:
|
||||||
description: The name to use when displaying this switch.
|
description: The name to use when displaying this scene.
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
default: MQTT Switch
|
default: MQTT Scene
|
||||||
payload_available:
|
payload_available:
|
||||||
description: The payload that represents the available state.
|
description: The payload that represents the available state.
|
||||||
required: false
|
required: false
|
||||||
@ -89,7 +94,7 @@ retain:
|
|||||||
type: boolean
|
type: boolean
|
||||||
default: false
|
default: false
|
||||||
unique_id:
|
unique_id:
|
||||||
description: An ID that uniquely identifies this switch device. If two switches have the same unique ID, Home Assistant will raise an exception.
|
description: An ID that uniquely identifies this scene entity. If two scenes have the same unique ID, Home Assistant will raise an exception.
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
{% endconfiguration %}
|
{% endconfiguration %}
|
||||||
@ -102,15 +107,15 @@ Make sure that your topic matches exactly. `some-topic/` and `some-topic` are di
|
|||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
In this section, you will find some real-life examples of how to use this sensor.
|
In this section, you will find some real-life examples of how to use the MQTT Scene.
|
||||||
|
|
||||||
### Full configuration
|
### Full configuration
|
||||||
|
|
||||||
The example below shows a full configuration for a switch.
|
The example below shows a full configuration for a scene.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
switch:
|
scene:
|
||||||
- platform: mqtt
|
- platform: mqtt
|
||||||
unique_id: living_room_party_scene
|
unique_id: living_room_party_scene
|
||||||
name: "Living Room Party Scene"
|
name: "Living Room Party Scene"
|
||||||
|
@ -92,6 +92,11 @@ device_class:
|
|||||||
required: false
|
required: false
|
||||||
type: device_class
|
type: device_class
|
||||||
default: None
|
default: None
|
||||||
|
enabled_by_default:
|
||||||
|
description: Flag which defines if the entity should be enabled when first added.
|
||||||
|
required: false
|
||||||
|
type: boolean
|
||||||
|
default: true
|
||||||
expire_after:
|
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`.
|
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
|
required: false
|
||||||
|
@ -97,6 +97,11 @@ device:
|
|||||||
description: 'Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.'
|
description: 'Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.'
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
enabled_by_default:
|
||||||
|
description: Flag which defines if the entity should be enabled when first added.
|
||||||
|
required: false
|
||||||
|
type: boolean
|
||||||
|
default: true
|
||||||
icon:
|
icon:
|
||||||
description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
|
description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
|
||||||
required: false
|
required: false
|
||||||
|
@ -93,6 +93,11 @@ docked_topic:
|
|||||||
description: The MQTT topic subscribed to receive docked state values from the vacuum.
|
description: The MQTT topic subscribed to receive docked state values from the vacuum.
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
enabled_by_default:
|
||||||
|
description: Flag which defines if the entity should be enabled when first added.
|
||||||
|
required: false
|
||||||
|
type: boolean
|
||||||
|
default: true
|
||||||
error_template:
|
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.
|
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
|
required: false
|
||||||
|
Loading…
x
Reference in New Issue
Block a user