Skip to main content

A library to communicate with Switchbot

Project description

pySwitchbot codecov

Library to control Switchbot IoT devices https://www.switch-bot.com/bot

Obtaining encryption key for Switchbot Locks

Using the script scripts/get_encryption_key.py you can manually obtain locks encryption key.

Usage:

$ python3 get_encryption_key.py MAC USERNAME
Key ID: XX
Encryption key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Where MAC is MAC address of the lock and USERNAME is your SwitchBot account username, after that script will ask for your password. If authentication succeeds then script should output your key id and encryption key.

Examples:

WoLock (Lock-Pro)

Unlock:

import asyncio
from switchbot.discovery import GetSwitchbotDevices
from switchbot.devices import lock
from switchbot.const import SwitchbotModel

BLE_MAC="XX:XX:XX:XX:XX:XX" # The MAC of your lock
KEY_ID="XX" # The key-ID of your encryption-key for your lock
ENC_KEY="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" # The encryption-key with key-ID "XX"
LOCK_MODEL=SwitchbotModel.LOCK_PRO # Your lock model (here we use the Lock-Pro)


async def main():
    wolock = await GetSwitchbotDevices().get_locks()
    await lock.SwitchbotLock(
        wolock[BLE_MAC].device, KEY_ID, ENCRYPTION_KEY, model=LOCK_MODEL
    ).unlock()


asyncio.run(main())

Lock:

import asyncio
from switchbot.discovery import GetSwitchbotDevices
from switchbot.devices import lock
from switchbot.const import SwitchbotModel

BLE_MAC="XX:XX:XX:XX:XX:XX" # The MAC of your lock
KEY_ID="XX" # The key-ID of your encryption-key for your lock
ENC_KEY="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" # The encryption-key with key-ID "XX"
LOCK_MODEL=SwitchbotModel.LOCK_PRO # Your lock model (here we use the Lock-Pro)


async def main():
    wolock = await GetSwitchbotDevices().get_locks()
    await lock.SwitchbotLock(
        wolock[BLE_MAC].device, KEY_ID, ENCRYPTION_KEY, model=LOCK_MODEL
    ).lock()


asyncio.run(main())

WoCurtain (Curtain 3)

import asyncio
from pprint import pprint
from switchbot import GetSwitchbotDevices
from switchbot.devices import curtain


async def main():
    # get the BLE advertisement data of all switchbot devices in the vicinity
    advertisement_data = await GetSwitchbotDevices().discover()

    for i in advertisement_data.values():
        pprint(i)
        print()  # print newline so that devices' data is separated visually

    # find your device's BLE address by inspecting the above printed debug logs, example below
    ble_address = "9915077C-C6FD-5FF6-27D3-45087898790B"
    # get the BLE device (via its address) and construct a curtain device
    ble_device = advertisement_data[ble_address].device
    curtain_device = curtain.SwitchbotCurtain(ble_device, reverse_mode=False)

    pprint(await curtain_device.get_device_data())
    pprint(await curtain_device.get_basic_info())
    await curtain_device.set_position(100)


if __name__ == "__main__":
    asyncio.run(main())

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyswitchbot-1.0.0.tar.gz (96.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyswitchbot-1.0.0-py3-none-any.whl (85.9 kB view details)

Uploaded Python 3

File details

Details for the file pyswitchbot-1.0.0.tar.gz.

File metadata

  • Download URL: pyswitchbot-1.0.0.tar.gz
  • Upload date:
  • Size: 96.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyswitchbot-1.0.0.tar.gz
Algorithm Hash digest
SHA256 410c8aea9c2dae5a610d806c40375a21662187db13879c4eac7e620396042c7c
MD5 b880b6910229015416bee69353361881
BLAKE2b-256 44d4ac7eaab0a5b956283cc9db03a220502bfc5652cdae65e743968a1fc3bb84

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyswitchbot-1.0.0.tar.gz:

Publisher: python-publish.yml on sblibs/pySwitchbot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyswitchbot-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: pyswitchbot-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 85.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyswitchbot-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 016c4d3500e824e7d8b0c6969736e8bad016a1563636650f2a372d98a281caa4
MD5 406f7291c070a71f4b9ee6b17cb7ac3d
BLAKE2b-256 9ee4319489757f26a2caccaa41eb8cc9a32d0a6ad10135defd2a21bbe2839e7a

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyswitchbot-1.0.0-py3-none-any.whl:

Publisher: python-publish.yml on sblibs/pySwitchbot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page