jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-09 10:26:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Explain Shelly entities naming (#14608)

Browse Source 
Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
Shay Levy 2020-09-28 11:03:58 +03:00 committed by GitHub
parent c1f48423c9
commit a376e93900
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
source/_integrations/shelly.markdown
View File

@ -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.
</div>
## 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