Skip to content

Multi device [ESP Home docs] #1

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

Closed
wants to merge 2 commits into from
Closed
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
59 changes: 59 additions & 0 deletions components/devices.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
Sub Device Configuration
========================

.. seo::
:description: Instructions for setting up sub devices in ESPHome.
:image: folder-open.svg

ESPHome has support for createting sub devices in configuration where
individual entities can be grouped to. The grouping has no direct effect
on the functionality of the entities, but it can be used to group
entities together in the Home Assistant UI. This is useful for
example when you have a mix sensors on one device that are related to
different physical devices.

.. note::

Requires Home Assistant 2025.x or newer.

Base Sub Device Configuration
-----------------------------

All devices in ESPHome have an id and name, and an optional suggested area.

.. code-block:: yaml

# Example devices configuration
id: my_device
name: My Device

# Optional variables:
area: Living Room

Configuration variables:

- **id** (**Required**, string): Specify the ID for code generation.
- **name** (**Required**, string): The name for the sub device.
- **area** (*Optional*, string): The suggested area for the sub device.

Assign entity to sub device
---------------------------

For individual entities in your configuration, you can assign them to a
sub device by using the ``device_id`` option. This is done by adding
the ``device_id`` option to the entity configuration. The value should
be the ID of the sub device you want to assign the entity to.

.. code-block:: yaml

sensor:
- platform: template
# ...
device_id: my_device


See Also
--------

- :doc:`esphome`
- :ghedit:`Edit`
1 change: 1 addition & 0 deletions components/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ ESPHome-specific components or components supporting ESPHome device provisioning
JSON, components/json, json.svg, dark-invert
XXTEA, components/xxtea, xxtea.svg
Script, components/script, description.svg, dark-invert
Sub Devices, components/devices, home-assistant.svg, dark-invert

ESPHome Configuration
---------------------
Expand Down