PyPI - Downloads PyPI - Version 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.

import switchbot_utility.switchbot as sbu

switchbot = sbu.Switchbot()
switchbot.devicelist()

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

Other Example

Get temperature from SwitchbotMeter

import switchbot_utility as sbu

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

Unlock SwitchbotLock

import switchbot_utility as sbu

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

Commands reference

Read the document

Supported device

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
Hub 2 Short for SwitchBot Hub 2 Model No. W3202100 Yes
Hub 3 Short for SwitchBot Hub 3 Model No. W7202100 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
Outdoor Meter Short for Indoor/Outdoor Thermo-Hygrometer Model No. W3400010 Yes
Meter Pro Short for SwitchBot Meter Pro Model No. W4900000 No
Meter Pro (CO2 Monitor) Short for SwitchBot Meter Pro (CO2 Monitor) Model No. W4900010 Yes
Motion Sensor Short for SwitchBot Motion Sensor Model No. W1101500 No
Contact Sensor Short for SwitchBot Contact Sensor Model No. W1201500 Yes
Presence Sensor Short for SwitchBot Presence Sensor Model No. W8200000 No
Water Leak Detector Short for SwitchBot Water Leak Detector Model No. W4402000 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 (EU) Short for SwitchBot Plug Mini (EU) Model No. W7732300 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
Lock Pro Short for SwitchBot Lock Pro Model No. W3500000 No
Lock Lite Short for SwitchBot Lock Lite Model No. W5110000 No
Lock Ultra Short for SwitchBot Lock Ultra Model No. W5600000 No
Keypad Short for SwitchBot Lock Model No. W2500010 No
Keypad Touch Short for SwitchBot Lock Model No. W2500020 Yes
Keypad Vision Short for SwitchBot Keypad Vision Model No. W5600003 No
Keypad Vision Pro Short for SwitchBot Keypad Vision Pro Model No. W5600009 No
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
K10+ Short for SwitchBot Mini Robot Vacuum K10+ Model No. W3011020 Yes
K10+ Pro Short for SwitchBot Mini Robot Vacuum K10+ Pro Model No. W3011026 No
S10 Short for SwitchBot Floor Cleaning Robot S10 Model No. W3211800 No
S20 Short for SwitchBot Floor Cleaning Robot S20 Model No. W6602310 No
K10+ Pro Combo Short for SwitchBot Robot Vacuum K10+ Pro Combo Model No. W3002500 No
K20+ Pro Short for SwitchBot Multitasking Household Robot K20+ Pro Model No. W3002520 No
K11+ Short for Robot Vacuum K11+ Model No. W3003100 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
RGBICWW Strip Light Short for SwitchBot RGBICWW Strip Light Model No. W1702109 No
RGBICWW Floor Lamp Short for SwitchBot RGBICWW Floor Lamp Model No. W1702101 No
RGBIC Neon Rope Light Short for SwitchBot RGBIC Neon Rope Light No. W1702107 No
RGBIC Neon Wire Rope Light Short for SwitchBot RGBIC Neon Wire Rope Light Model No. W1702108 No
Floor Lamp Short for SwitchBot RGBWW Floor Lamp Model No. W1702100 No
Strip Light 3 Short for SwitchBot RGBWW Strip Light 3 Model No. W1702110 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
Roller Shade Short for SwitchBot Roller Shade Model No. W5000000 No
Air Purifier PM2.5 Short for SwitchBot Air Purifier Model No. W5302300 No
Air Purifier Table PM2.5 Short for SwitchBot Air Purifier Table Model No. W5302310 No
Air Purifier VOC Short for SwitchBot Air Purifier Model No. W5302300 No
Air Purifier Table VOC Short for SwitchBot Air Purifier Table Model No. W5302310 No
Battery Circulator Fan Short for SwitchBot Battery Circulator Fan Model No. W3800510 No
Circulator Fan Short for SwitchBot Circulator Fan Model No. W3800511 No
Evaporative Humidifier Short for SwitchBot Evaporative Humidifier Model No.W3902300 Yes
Evaporative Humidifier (Auto-refill) Short for SwitchBot Evaporative Humidifier (Auto-refill) Model No. W3902310 No

Project links

Data verified by PyPI on Jul 20, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for hidekichi from gravatar.com hidekichi

Credits

Author: MATSUMURA Hidetoshi

GitHub Statistics

Data verified by PyPI on Jul 20, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

MIT License

Requires

Python >=3.6

Tags

IoT Switchbot Switchbot API

Classifiers

Report project as malware

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.10.tar.gz (119.2 kB view details)

Uploaded Source

Built Distribution

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

switchbot_utility-0.4.10-py3-none-any.whl (38.5 kB view details)

Uploaded Python 3

File details

Details for the file switchbot_utility-0.4.10.tar.gz.

File metadata

  • Download URL: switchbot_utility-0.4.10.tar.gz
  • Upload date:
  • Size: 119.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for switchbot_utility-0.4.10.tar.gz
Algorithm Hash digest
SHA256 ae7078ae8569c858b15381c7d90cf31ef66cff6c98baf194de4cc69ddbcdbdf9
MD5 adeef7175f93680ff1510d45793ffdeb
BLAKE2b-256 27b7707786c89a6473057f26b705a5f14348f97478934370783d0885b809c101

See more details on using hashes here.

Provenance

The following attestation bundles were made for switchbot_utility-0.4.10.tar.gz:

Publisher: python-publish.yml on iCarrot0605/Switchbot_utility

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

File details

Details for the file switchbot_utility-0.4.10-py3-none-any.whl.

File metadata

File hashes

Hashes for switchbot_utility-0.4.10-py3-none-any.whl
Algorithm Hash digest
SHA256 0ba959acc733cdad317a344908971b4ead265af7916f07cf0af822d607409bb2
MD5 1268d7f57a21fffd29005835a454840a
BLAKE2b-256 65b84d9f359b55577ca9fcff1d0c21e219cb6e5e62238f6e5c5e418091cc350d

See more details on using hashes here.

Provenance

The following attestation bundles were made for switchbot_utility-0.4.10-py3-none-any.whl:

Publisher: python-publish.yml on iCarrot0605/Switchbot_utility

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

Release history Release notifications | RSS feed

This release

0.4.10 This release

2 files

0.4.9

2 files

Yanked

0.4.8

2 files

0.4.7

2 files

0.4.6

2 files

0.4.5

2 files

0.4.4

2 files

0.4.3

2 files

0.4.2

2 files

0.4.1

2 files

0.4

2 files

0.3.1

2 files

0.3

2 files

0.2.1

2 files

0.2

2 files

0.1

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

0.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page