diff --git a/source/_integrations/shelly.markdown b/source/_integrations/shelly.markdown index fece0e1d7e8..5ac20b9c38d 100644 --- a/source/_integrations/shelly.markdown +++ b/source/_integrations/shelly.markdown @@ -22,8 +22,32 @@ To add a Shelly device to your installation, make sure they are connected to you Integration is communicating directly with the device; cloud connection is not needed. +## Entity naming + +The integration uses the following strategy to name its entities: + +- 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`. + +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 | + +Names are set from the device web page: + +- Device name can be set in **Settings** >> **DEVICE NAME** +- Channel name for single-channel devices can be set in **Settings** >> **CHANNEL NAME** +- Channel name for multi-channel devices can be set in **Settings** >> **CHANNEL NAME** after selecting the channel, by clicking on the channel name. + ## Known issues and limitations - Only supports firmware 1.8 and later - Support relays, lights (with brightness), sensors and rollers -- Support for battery powered devices is currently very limited +- Support for battery-powered devices is currently very limited