Skip to content

Add device_id param documentation #5108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: current
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions components/binary_sensor/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ Advanced options:
See https://developers.home-assistant.io/docs/core/entity/#generic-properties
for a list of available options.
Set to ``""`` to remove the default entity category.
- **device_id** (*Optional*, :ref:`config-id`): Identifier of the sub‑device this entity belongs to. Must match the id of an entry in :ref:`esphome.devices <esphome-devices>`. If omitted, the entity remains attached to the main device.
- If MQTT enabled, all other options from :ref:`MQTT Component <config-mqtt-component>`.
- If Webserver enabled and version 3 is selected, All other options from Webserver Component.. See :ref:`Webserver Version 3 <config-webserver-version-3-options>`.

Expand Down
1 change: 1 addition & 0 deletions components/button/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ Configuration variables:
- **entity_category** (*Optional*, string): The category of the entity.
See https://developers.home-assistant.io/docs/core/entity/#generic-properties
for a list of available options. Set to ``""`` to remove the default entity category.
- **device_id** (*Optional*, string): Identifier of the sub‑device this entity belongs to. Must match the id of an entry in :ref:`esphome.devices <esphome-devices>`. If omitted, the entity remains attached to the main ESP device.
- **device_class** (*Optional*, string): The device class for the button.
See https://www.home-assistant.io/integrations/button/#device-class
for a list of available options.
Expand Down
1 change: 1 addition & 0 deletions components/climate/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ Advanced options:
See https://developers.home-assistant.io/docs/core/entity/#generic-properties
for a list of available options.
Set to ``""`` to remove the default entity category.
- **device_id** (*Optional*, string): Identifier of the sub‑device this entity belongs to. Must match the id of an entry in :ref:`esphome.devices <esphome-devices>`. If omitted, the entity remains attached to the main ESP device.
- If Webserver enabled and version 3 is selected, All other options from Webserver Component.. See :ref:`Webserver Version 3 <config-webserver-version-3-options>`.

MQTT options:
Expand Down
1 change: 1 addition & 0 deletions components/cover/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ Advanced options:
See https://developers.home-assistant.io/docs/core/entity/#generic-properties
for a list of available options.
Set to ``""`` to remove the default entity category.
- **device_id** (*Optional*, string): Identifier of the sub‑device this entity belongs to. Must match the id of an entry in :ref:`esphome.devices <esphome-devices>`. If omitted, the entity remains attached to the main ESP device.
- If Webserver enabled and version 3 is selected, All other options from Webserver Component.. See :ref:`Webserver Version 3 <config-webserver-version-3-options>`.


Expand Down
1 change: 1 addition & 0 deletions components/datetime/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ Configuration variables:
See https://developers.home-assistant.io/docs/core/entity/#generic-properties
for a list of available options.
Set to ``""`` to remove the default entity category.
- **device_id** (*Optional*, string): Identifier of the sub‑device this entity belongs to. Must match the id of an entry in :ref:`esphome.devices <esphome-devices>`. If omitted, the entity remains attached to the main ESP device.
- **time_id** (*Optional*, :ref:`config-id`): The ID of the time entity. Automatically set
to the ID of a time component if only a single one is defined. Required if ``on_time`` is used.
- If Webserver enabled and version 3 is selected, All other options from Webserver Component.. See :ref:`Webserver Version 3 <config-webserver-version-3-options>`.
Expand Down
1 change: 1 addition & 0 deletions components/esp32_camera.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ Configuration variables:
See https://developers.home-assistant.io/docs/core/entity/#generic-properties
for a list of available options.
Set to ``""`` to remove the default entity category.
- **device_id** (*Optional*, string): Identifier of the sub‑device this entity belongs to. Must match the id of an entry in :ref:`esphome.devices <esphome-devices>`. If omitted, the entity remains attached to the main ESP device.

Connection Options:

Expand Down
1 change: 1 addition & 0 deletions components/event/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ One of ``id`` or ``name`` is required.
- **entity_category** (*Optional*, string): The category of the entity.
See https://developers.home-assistant.io/docs/core/entity/#generic-properties
for a list of available options. Set to ``""`` to remove the default entity category.
- **device_id** (*Optional*, string): Identifier of the sub-device this entity belongs to. Must match the id of an entry in :ref:`esphome.devices <esphome-devices>`. If omitted, the entity remains attached to the main ESP device.
- **device_class** (*Optional*, string): The device class for the event. The following device classes are supported by event entities:

- None: Generic event. This is the default and doesn't need to be set.
Expand Down
1 change: 1 addition & 0 deletions components/fan/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ Configuration variables:
See https://developers.home-assistant.io/docs/core/entity/#generic-properties
for a list of available options.
Set to ``""`` to remove the default entity category.
- **device_id** (*Optional*, string): Identifier of the sub-device this entity belongs to. Must match the id of an entry in :ref:`esphome.devices <esphome-devices>`. If omitted, the entity remains attached to the main ESP device.
- If Webserver enabled and version 3 is selected, All other options from Webserver Component.. See :ref:`Webserver Version 3 <config-webserver-version-3-options>`.

MQTT options:
Expand Down
1 change: 1 addition & 0 deletions components/light/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ All light configuration schemas inherit these options.
- **entity_category** (*Optional*, string): The category of the entity. See `this list
<https://developers.home-assistant.io/docs/core/entity/#generic-properties>`__ for a list of available options. Set
to ``""`` to remove the default entity category.
- **device_id** (*Optional*, string): Identifier of the sub-device this entity belongs to. Must match the id of an entry in :ref:`esphome.devices <esphome-devices>`. If omitted, the entity remains attached to the main ESP device.
- If MQTT enabled, all other options from :ref:`MQTT Component <config-mqtt-component>`.
- If Webserver enabled and :ref:`version 3 <config-webserver-version-3-options>` is selected, all other options from
:doc:`/components/web_server`.
Expand Down
1 change: 1 addition & 0 deletions components/lock/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ Configuration variables:
- **entity_category** (*Optional*, string): The category of the entity.
See https://developers.home-assistant.io/docs/core/entity/#generic-properties
for a list of available options. Set to ``""`` to remove the default entity category.
- **device_id** (*Optional*, string): Identifier of the sub-device this entity belongs to. Must match the id of an entry in :ref:`esphome.devices <esphome-devices>`. If omitted, the entity remains attached to the main ESP device.
- If MQTT enabled, All other options from :ref:`MQTT Component <config-mqtt-component>`.
- If Webserver enabled and version 3 is selected, All other options from Webserver Component.. See :ref:`Webserver Version 3 <config-webserver-version-3-options>`.

Expand Down
1 change: 1 addition & 0 deletions components/media_player/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ Configuration variables:
- **entity_category** (*Optional*, string): The category of the entity.
See https://developers.home-assistant.io/docs/core/entity/#generic-properties
for a list of available options. Set to ``""`` to remove the default entity category.
- **device_id** (*Optional*, string): Identifier of the sub-device this entity belongs to. Must match the id of an entry in :ref:`esphome.devices <esphome-devices>`. If omitted, the entity remains attached to the main ESP device.

.. _media_player-actions:

Expand Down
1 change: 1 addition & 0 deletions components/number/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ Configuration variables:
See https://developers.home-assistant.io/docs/core/entity/#generic-properties
for a list of available options.
Set to ``""`` to remove the default entity category.
- **device_id** (Optional, string): Identifier of the sub-device this entity belongs to. Must match the id of an entry in :ref:`esphome.devices <esphome-devices>`. If omitted, the entity remains attached to the main ESP device.
- **unit_of_measurement** (*Optional*, string): Manually set the unit
of measurement for the number.
- **mode** (*Optional*, string): Defines how the number should be displayed in the frontend.
Expand Down
1 change: 1 addition & 0 deletions components/select/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ Configuration variables:
See https://developers.home-assistant.io/docs/core/entity/#generic-properties
for a list of available options.
Set to ``""`` to remove the default entity category.
- **device_id** (*Optional*, string): Identifier of the sub-device this entity belongs to. Must match the id of an entry in :ref:`esphome.devices <esphome-devices>`. If omitted, the entity remains attached to the main ESP device.
- If Webserver enabled and version 3 is selected, All other options from Webserver Component.. See :ref:`Webserver Version 3 <config-webserver-version-3-options>`.

Automations:
Expand Down
1 change: 1 addition & 0 deletions components/sensor/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ Configuration variables:
See https://developers.home-assistant.io/docs/core/entity/#generic-properties
for a list of available options.
Set to ``""`` to remove the default entity category.
- **device_id** (*Optional*, string): Identifier of the sub-device this entity belongs to. Must match the id of an entry in :ref:`esphome.devices <esphome-devices>`. If omitted, the entity remains attached to the main ESP device.
- If Webserver enabled and version 3 is selected, All other options from Webserver Component.. See :ref:`Webserver Version 3 <config-webserver-version-3-options>`.

Automations:
Expand Down
1 change: 1 addition & 0 deletions components/switch/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ Configuration variables:
See https://developers.home-assistant.io/docs/core/entity/#generic-properties
for a list of available options.
Set to ``""`` to remove the default entity category.
- **device_id** (*Optional*, string): Identifier of the sub-device this entity belongs to. Must match the id of an entry in :ref:`esphome.devices <esphome-devices>`. If omitted, the entity remains attached to the main ESP device.
- **device_class** (*Optional*, string): The device class for the switch.
See https://www.home-assistant.io/integrations/switch/#device-class
for a list of available options.
Expand Down
1 change: 1 addition & 0 deletions components/text/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ Configuration variables:
- **entity_category** (*Optional*, string): The category of the entity.
See https://developers.home-assistant.io/docs/core/entity/#generic-properties
for a list of available options. Set to ``""`` to remove the default entity category.
- **device_id** (*Optional*, string): Identifier of the sub-device this entity belongs to. Must match the id of an entry in :ref:`esphome.devices <esphome-devices>`. If omitted, the entity remains attached to the main ESP device.
- **mode** (**Required**, string): Defines how the text should be displayed in the frontend.
One of ``text`` or ``password``.
- If Webserver enabled and version 3 is selected, All other options from Webserver Component.. See :ref:`Webserver Version 3 <config-webserver-version-3-options>`.
Expand Down
1 change: 1 addition & 0 deletions components/text_sensor/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ Configuration variables:
See https://developers.home-assistant.io/docs/core/entity/#generic-properties
for a list of available options.
Set to ``""`` to remove the default entity category.
- **device_id** (*Optional*, string): Identifier of the sub-device this entity belongs to. Must match the id of an entry in :ref:`esphome.devices <esphome-devices>`. If omitted, the entity remains attached to the main ESP device.
- If MQTT enabled, All other options from :ref:`MQTT Component <config-mqtt-component>`.
- If Webserver enabled and version 3 is selected, All other options from Webserver Component.. See :ref:`Webserver Version 3 <config-webserver-version-3-options>`.

Expand Down
1 change: 1 addition & 0 deletions components/update/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Configuration variables:
(usually Home Assistant) without the user manually enabling it (via the Home Assistant UI). Defaults to ``false``.
- **entity_category** (*Optional*, string): The category of the update entity. See
https://developers.home-assistant.io/docs/core/entity/#generic-properties for a list of available options.
- **device_id** (*Optional*, string): Identifier of the sub-device this entity belongs to. Must match the id of an entry in :ref:`esphome.devices <esphome-devices>`. If omitted, the entity remains attached to the main ESP device.
- **icon** (*Optional*, icon): The icon to use for the update entity in the frontend.
- **internal** (*Optional*, boolean): Mark this component as internal. Internal components will
not be exposed to the frontend (like Home Assistant). Specifying an ``id`` without a ``name`` will
Expand Down
1 change: 1 addition & 0 deletions components/valve/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ Advanced options:
(usually Home Assistant) without the user manually enabling it (via the Home Assistant UI). Defaults to ``false``.
- **entity_category** (*Optional*, string): The category of the entity. See
https://developers.home-assistant.io/docs/core/entity/#generic-properties for a list of available options. Set to ``""`` to remove the default entity category.
- **device_id** (*Optional*, string): Identifier of the sub-device this entity belongs to. Must match the id of an entry in :ref:`esphome.devices <esphome-devices>`. If omitted, the entity remains attached to the main ESP device.
- If Webserver enabled and version 3 is selected, All other options from Webserver Component.. See :ref:`Webserver Version 3 <config-webserver-version-3-options>`.

MQTT options:
Expand Down