Skip to content

Updated SwitchBot documentation to include details about the lock #25421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
frenck merged 5 commits into from
Jan 2, 2023
Merged

Updated SwitchBot documentation to include details about the lock #25421

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2e3ab6f
Updated SwitchBot documentation to include details about the lock
dsypniewski Dec 27, 2022
de0359f
Updated SwitchBot documentation to reflect further changes in the int…
dsypniewski Dec 31, 2022
fd6d012
Moving details related to obtaining the encryption key to the library
dsypniewski Dec 31, 2022
3575634
Update README link
dsypniewski Jan 2, 2023
794e868
Tiny tweaks
frenck Jan 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 39 additions & 1 deletion source/_integrations/switchbot.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ ha_category:
- Light
- Sensor
- Switch
- Lock
ha_release: 0.78
ha_iot_class: Local Push
ha_codeowners:
Expand All @@ -15,6 +16,7 @@ ha_codeowners:
- '@RenierM26'
- '@murtas'
- '@Eloston'
- '@dsypniewski'
ha_domain: switchbot
ha_bluetooth: true
ha_platforms:
Expand All @@ -23,6 +25,7 @@ ha_platforms:
- light
- sensor
- switch
- lock
ha_config_flow: true
ha_integration_type: integration
---
Expand Down Expand Up @@ -55,6 +58,7 @@ Please note, device names configured in the SwitchBot app are not transferred in
- Meter/Meter Plus 70BB (WoSensorTH)
- Motion Sensor (WoPresence)
- Plug Mini (WoPlug), both the original (model W1901400) and HomeKit-enabled (model W1901401)
- Lock (WoLock)

## SwitchBot Entity

Expand All @@ -67,7 +71,41 @@ There are three attributes available on the SwitchBot entity to give you more in

- `Retry count`: How many times to retry sending commands to your SwitchBot devices.

### Error codes and troubleshooting
## SwitchBot Lock

The integration currently only uses the primary lock state; in dual lock mode, not all things might work properly.

A SwitchBot lock can be set up in Home Assistant in two different ways. You can enter the key id and encryption key yourself, or Home Assistant can import them from your SwitchBot account.

### SwitchBot account (recommended)
Comment thread
frenck marked this conversation as resolved.

Using this option you can provide your SwitchBot account login credentials and Home Assistant will import the appropriate encryption key from your account.

{% configuration_basic %}
Username:
description: SwitchBot account username
Password:
description: SwitchBot account password
{% endconfiguration_basic %}

<div class='note warning'>
This integration doesn't support SSO accounts (Login with Google, etc.) only username and password accounts.
</div>

### Enter the lock encryption key manually

This option is for those that would rather obtain the encryption key themselves, and/or want to know exactly where and how are their account credentials used.

{% configuration_basic %}
Key ID:
description: Locks' encryption key ID
Encryption key:
description: Locks' encryption key
{% endconfiguration_basic %}

For instructions on how to obtain the locks encryption key, see README in [PySwitchbot](https://github.com/Danielhiversen/pySwitchbot#obtaining-locks-encryption-key) project.

## Error codes and troubleshooting

The SwitchBot integration will automatically discover devices once the [Bluetooth](/integrations/bluetooth) integration is enabled and functional.

Expand Down