Document binary sensors for Shelly inputs (#20047)

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Co-authored-by: Shay Levy <levyshay1@gmail.com>
This commit is contained in:
Radu Cotescu 2022-01-03 11:53:48 +01:00 committed by GitHub
parent ac42a7d305
commit 19452937d9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -79,6 +79,16 @@ The integration uses the following strategy to name its entities:
- 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`.
## Binary input sensors
### Binary input sensors (generation 1)
Depending on how a device's button type is configured, the integration will create binary sensors corresponding to those inputs. binary sensors are not created when the button type is `momentary` or `momentary_on_release`, for these types you need to use events for your automations.
### Binary input sensors (generation 2)
For generation 2 hardware it's possible to select if a device's input is connected to a button or a switch. Binary sensors are created only if the input mode is set to `switch`. When the input is of type `button` you need to use events for your automations.
## Events
If the **BUTTON TYPE** of the switch connected to the device is set to `momentary` or `detached switch`, integration fires events under the type `shelly.click` when the switch is used. You can use these events in your automations.