mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 01:06:52 +00:00
Add config flow documentation to switchbot (#19371)
Co-authored-by: J. Nick Koston <nick@koston.org> Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
parent
9ccaa4a3aa
commit
d9e32261b7
@ -1,47 +1,28 @@
|
|||||||
---
|
---
|
||||||
title: SwitchBot
|
title: SwitchBot
|
||||||
description: Instructions on how to set up Switchbot switches.
|
description: Instructions on how to set up SwitchBot switches.
|
||||||
ha_category:
|
ha_category:
|
||||||
|
- Cover
|
||||||
- Switch
|
- Switch
|
||||||
ha_release: 0.78
|
ha_release: 0.78
|
||||||
ha_iot_class: Local Polling
|
ha_iot_class: Local Polling
|
||||||
ha_codeowners:
|
ha_codeowners:
|
||||||
- '@danielhiversen'
|
- '@danielhiversen'
|
||||||
|
- '@RenierM26'
|
||||||
ha_domain: switchbot
|
ha_domain: switchbot
|
||||||
ha_platforms:
|
ha_platforms:
|
||||||
|
- cover
|
||||||
- switch
|
- 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
|
{% include integrations/config_flow.md %}
|
||||||
|
|
||||||
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 %}
|
|
||||||
|
|
||||||
## SwitchBot Entity
|
## 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.
|
- `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.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user