From d9e32261b77074b237bdb34d9d03ae579ddd0963 Mon Sep 17 00:00:00 2001 From: RenierM26 <66512715+RenierM26@users.noreply.github.com> Date: Wed, 22 Sep 2021 19:27:49 +0200 Subject: [PATCH] Add config flow documentation to switchbot (#19371) Co-authored-by: J. Nick Koston Co-authored-by: Franck Nijhof --- source/_integrations/switchbot.markdown | 37 ++++++------------------- 1 file changed, 9 insertions(+), 28 deletions(-) diff --git a/source/_integrations/switchbot.markdown b/source/_integrations/switchbot.markdown index 0e8723aa0ef..498695669bc 100644 --- a/source/_integrations/switchbot.markdown +++ b/source/_integrations/switchbot.markdown @@ -1,47 +1,28 @@ --- title: SwitchBot -description: Instructions on how to set up Switchbot switches. +description: Instructions on how to set up SwitchBot switches. ha_category: + - Cover - Switch ha_release: 0.78 ha_iot_class: Local Polling ha_codeowners: - '@danielhiversen' + - '@RenierM26' ha_domain: switchbot ha_platforms: + - cover - switch --- -The `switchbot` switch platform allows you to control SwitchBot [devices](https://www.switch-bot.com/). +The SwitchBot integration allows you to control SwitchBot [devices](https://www.switch-bot.com/). -## Manual Configuration - -To enable it, add the following lines to your `configuration.yaml`: - -```yaml -switch: - - platform: switchbot - mac: "MAC_ADDRESS" -``` - -{% configuration %} -mac: - description: The device MAC address with upper-case letters. - required: true - type: string -name: - description: The name used to display the switch in the frontend. - required: false - type: string -password: - description: The password of the switch if set - required: false - type: string -{% endconfiguration %} +{% include integrations/config_flow.md %} ## SwitchBot Entity -There are two attributes available on the SwitchBot entity to give you more information about your device. +There are three attributes available on the SwitchBot entity to give you more information about your device. - `last_run_success`: If `true` if the last action sent to the SwitchBot succeeded. This attribute is useful for error trapping when Bluetooth connectivity is intermittent. If `false`, see home-assistant.log for specific error messages. -- `assumed_state`: Always `true`. If the state of the SwitchBot entity cannot be determined, it is assumed to be `on`. +- `Switch mode`: Specifies the mode of the SwitchBot. If `true` the the SwitchBot is in Pull/Retract mode for toggle switches otherwise the bot is in momentary switch mode. +- `MAC address`: The BTLE MAC for the device.