Skip to main content

Python Switchbot utilities

Project description

PyPI - Downloads PyPI PyPI - License

Switchbot_utility

Python Switchbot Utilities using Switchbot API.

Installing

pip install switchbot-utility

Getting start

Get token and secret,

  1. Download the SwitchBot app on App Store or Google Play Store
  2. Register a SwitchBot account and log in into your account
  3. Generate an Open Token within the app a) Go to Profile > Preference b) Tap App Version 10 times. Developer Options will show up c) Tap Developer Options d) Copy token and secret

create settings.json file, and fill token and secret.

{
    "token": "",
    "secret": ""
}

Run example script.

from switchbot_utility.switchbot import Switchbot

switchbot = Switchbot()
switchbot.devicelist()

Scripts makes deviceList.txt. You can manipulate device using diviceId in this file.

Other Example

Get temperature from SwitchbotMeter

from switchbot_utility.switchbot_meter import SwitchbotMeter

meter = SwitchbotMeter("meterDeviceId")
print(meter.get_temperature())

Unlock SwitchbotLock

from switchbot_utility.switchbot_lock import SwitchbotLock

lock = SwitchbotLock("lockDeviceId")
lock.unlock()

Commands reference

Read the document

Supported divice

Term Description Tested
Hub Generally referred to these devices, SwitchBot Hub Model No. SwitchBot Hub S1/SwitchBot Hub Mini Model No. W0202200/SwitchBot Hub Plus Model No. SwitchBot Hub S1 No
Hub Mini Short for SwitchBot Hub Mini Model No. W0202200 Yes
Hub Plus Short for SwitchBot Hub Plus Model No. SwitchBot Hub S1 No
Bot Short for SwitchBot Bot Model No. SwitchBot S1 Yes
Curtain Short for SwitchBot Curtain Model No. W0701600 Yes
Plug Short for SwitchBot Plug Model No. SP11. Currently only available in Japan Yes
Meter Short for SwitchBot Thermometer and Hygrometer Model No. SwitchBot MeterTH S1 Yes
Meter Plus (JP) Short for SwitchBot Thermometer and Hygrometer Plus (JP) Model No. W2201500 Yes
Meter Plus (US) Short for SwitchBot Thermometer and Hygrometer Plus (US) Model No. W2301500 No
Motion Sensor Short for SwitchBot Motion Sensor Model No. W1101500 No
Contact Sensor Short for SwitchBot Contact Sensor Model No. W1201500 Yes
Color Bulb Short for SwitchBot Color Bulb Model No. W1401400 Yes
Strip Light Short for SwitchBot LED Strip Light Model No. W1701100 No
Plug Mini (US) Short for SwitchBot Plug Mini (US) Model No. W1901400 and W1901401 No
Plug Mini (JP) Short for SwitchBot Plug Mini (JP) Model No. W2001400 and W2001401 Yes
Lock Short for SwitchBot Lock Model No. W1601700 Yes
Keypad Short for SwitchBot Lock Model No. W2500010 No
Keypad Touch Short for SwitchBot Lock Model No. W2500020 Yes
Robot Vacuum Cleaner S1 Short for SwitchBot Robot Vacuum Cleaner S1 Model No. W3011000. Currently only available in Japan. No
Robot Vacuum Cleaner S1 Plus Short for SwitchBot Robot Vacuum Cleaner S1 Plus Model No. W3011010. Currently only available in Japan. No
Ceiling Light Short for SwitchBot Ceiling Light Model No. W2612230 and W2612240. Currently only available in Japan. No
Ceiling Light Pro Short for SwitchBot Ceiling Light Pro Model No. W2612210 and W2612220. Currently only available in Japan. No
Indoor Cam Short for SwitchBot Indoor Cam Model No. W1301200 No
Pan/Tilt Cam Short for SwitchBot Pan/Tilt Cam Model No. W1801200 No
Pan/Tilt Cam 2K Short for SwitchBot Pan/Tilt Cam 2K Model No. W3101100 No
Blind Tilt Short for SwitchBot Blind Tilt Model No. W2701600 No

Project details


Download files

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

Source Distribution

switchbot_utility-0.4.tar.gz (11.1 kB view hashes)

Uploaded Source

Built Distribution

switchbot_utility-0.4-py3-none-any.whl (21.8 kB view hashes)

Uploaded Python 3

Supported by

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