Skip to content

Update entity naming convention for Shelly #39091

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.

Sign up for GitHub

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 4 commits into
base: next
Choose a base branch
from
Open

Update entity naming convention for Shelly #39091

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b22bf62
Entity naming convention for gen1 devices
bieniu May 19, 2025
1037209
Fix device name
bieniu May 19, 2025
500b7f4
Entity naming convention for gen2+ devices
bieniu May 19, 2025
afe5a05
Make sub-device names more unique
bieniu May 22, 2025
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: 44 additions & 15 deletions source/_integrations/shelly.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,23 +131,26 @@ Currently, only static IP or DHCP reserved IP are supported for the main device.

## Entity naming (generation 1)

The integration uses `Device Name` to name its entities if the device has only one relay or no relays at all.
The integration uses the following strategy to name its devices and entities if the device has only one relay (channel) or no relays at all:

The integration uses the following strategy to name its entities if the device has more than one relay:
- If a `Device Name` is set in the device, the integration will use it to generate the device name and entity names.
- If a `Device Name` is not set, the integration will use the `Device ID` to generate the device name and entity names.

- If `Device Name` or `Channel Name` is set in the device, the integration will use them to generate the entities' name.
- If channel names are set, they will be used in the entity names. The device name will not be used.
- If only the device name is set, and the device has multiple channels, the channel number will be appended to the entity name (e.g., Channel 2).
- In case device name and channel names are not set, the entity name will be generated by the `Device Type`, `Device ID` and `Channel Number`.
The integration creates a sub-device for every relay and uses the following strategy to name its entities if the device has more than one relay:

- If a `Device Name` is set in the device, the integration will use it to generate the main device name and entity names assigned to the main device.
- If a `Device Name` is not set, the integration will use the `Device ID` to generate the main device name and entity names assigned to the main device.
- If a `Channel Name` is set in the device, the integration will use it to generate the sub-device name and entity names assigned to this sub-device (channel/relay).
- If a `Channel Name` is not set in the device, the integration will use the device name and channel/relay number to generate the sub-device name and entity names assigned to this sub-device (channel/relay).

Examples:

| Device Name | Channel Name | Entity Name |
| ----------- | -------------- | ------------------------------- |
| `Not set` | `Not Set` | shellyswitch25-ABC123 Channel 1 |
| `Not set` | Kids Room Bulb | Kids Room Bulb |
| Kitchen | `Not Set` | Kitchen Channel 1 |
| Bedroom | Round Bulb | Round Bulb |
| Device Name | Channel Name | Main Device Name | Sub-device Name | Entity Name |
| ----------- | -------------- | --------------------- | ------------------------------- | -------------------------------- |
| `Not set` | `Not Set` | shellyswitch25-ABC123 | shellyswitch25-ABC123 Channel 1 | shellyswitch25-ABC123 Channel 1 |
| `Not set` | Kids Room Bulb | shellyswitch25-ABC123 | Kids Room Bulb | Kids Room Bulb |
| Kitchen | `Not Set` | Kitchen | Kitchen Channel 1 | Kitchen Channel 1 |
| Bedroom | Round Bulb | Bedroom | Round Bulb | Round Bulb |

Names are set from the device web page:

Expand All @@ -157,10 +160,36 @@ Names are set from the device web page:

## Entity naming (generation 2+)

The integration uses the following strategy to name its entities:
The integration uses the following strategy to name its devices and entities if the device has only one relay (channel) or no relays at all:

- If a `Device Name` is set in the device, the integration will use it to generate the device name and entity names.
- If a `Device Name` is not set, the integration will use the `Device ID` to generate the device name and entity names.
- If a `Channel Name` is set in the device, the integration will add it as a suffix to the entity names.

Examples:

| Device Name | Channel Name | Integration Device Name | Entity Name |
| ----------- | -------------- | ------------------------ | --------------------------------------- |
| `Not set` | `Not Set` | shelly1gen3-aabbccddeeff | shelly1gen3-aabbccddeeff |
| `Not set` | Kids Room Bulb | shelly1gen3-aabbccddeeff | shelly1gen3-aabbccddeeff Kids Room Bulb |
| Kitchen | `Not Set` | Kitchen | Kitchen |
| Bedroom | Round Bulb | Bedroom | Bedroom Round Bulb |

The integration creates a sub-device for every relay (channel) and uses the following strategy to name its devices and entities if the device has more than one relay:

- If a `Device Name` is set in the device, the integration will use it to generate the main device name and entity names assigned to the main device.
- If a `Device Name` is not set, the integration will use the `Device ID` to generate the main device name and entity names assigned to the main device.
- If a `Channel Name` is set in the device, the integration will use it to generate the sub-device name and entity names assigned to this sub-device (channel/relay).
- If a `Channel Name` is set to the default value in the device, the integration will use the device name and this ddefault channel name to generate the sub-device name and entity names assigned to this sub-device (channel/relay).

Examples:

- If `Channel Name` is set in the device, the integration will use it to generate the entities' name, e.g. `Kitchen Light`
- If `Channel Name` is set to the default value, the integration will use the `Device ID` and default channel name to generate the entities' name, e.g. `ShellyPro4PM-9808D1D8B912 Switch 0`.
| Device Name | Channel Name | Main Device Name | Sub-device Name | Entity Name |
| ----------- | -------------- | -------------------------- | ----------------------------------- | ----------------------------------- |
| `Not set` | `Not Set` | shelly2pmgen3-aabbccddeeff | shelly2pmgen3-aabbccddeeff Switch 1 | shelly2pmgen3-aabbccddeeff Switch 1 |
| `Not set` | Kids Room Bulb | shelly2pmgen3-aabbccddeeff | Kids Room Bulb | Kids Room Bulb |
| Kitchen | `Not Set` | Kitchen | Kitchen Switch 1 | Kitchen Switch 1 |
| Bedroom | Round Bulb | Bedroom | Round Bulb | Round Bulb |

## Cover entities

Expand Down
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy