Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time
February 21, 2017 00:07
February 21, 2017 00:07


What is the SwitchBot opensource project?

SwitchBot is a smart IoT robot to mechanically control all your switches and buttons. You can control the bot by your smartphone app (iOS or Android, SwitchLink, or other platform based on our open APIs.

This project aims to provide a super light-weight solution to control your SwitchBot on Raspberry Pi/OpenWRT or any other Linux based board.

The python-host distribution is supported and tested on Python 2.7.

How to Install?

On Raspberry Pi

You will need:


  1. Boot your fresh Pi and open a command prompt.
  2. Install the require library.
sudo apt-get update
sudo apt-get install python-pexpect
sudo apt-get install libusb-dev libdbus-1-dev libglib2.0-dev 
sudo apt-get install libudev-dev libical-dev libreadline-dev
sudo pip install bluepy
  1. Clone this repo to the Pi.
git clone
cd python-host


You can use in two ways:

  1. Scan and control by device name.
sudo python

Follow the instruction, input the device number for SwitchBot you want to control.

  1. Control SwitchBot by MAC address. (MAC address should be retrived in advanced)
sudo python [mac_addr action_cmd]

action_cmd :Press, Turn On, Turn Off.

eg: sudo python  xx:xx:xx:xx:xx:xx Press

Python 3 and new bluetooth stack support

The original script will work only on Python 2 and it relies on the old Bluez utils (like hciconfig and hcitool) that have been deprecated in the latest Bluez releases.

If you want to use the script on Python 3 or on a Linux distro that no longer ships Bluez with the old tools, use the script instead.

To install the required dependencies on Debian 11 "Bullseye", Raspberry Pi OS or Ubuntu 21.10 or later:

sudo apt install python3-bluez

On older versions of Ubuntu/Debian/Raspbian:

sudo apt-get install python3-pip
sudo apt-get install libbluetooth-dev
pip3 install pybluez
sudo apt-get install libboost-python-dev
sudo apt-get install libboost-thread-dev
pip3 install gattlib

If for some reason the gattlib installation fails:

sudo apt-get install pkg-config python3-dev
sudo apt-get install libglib2.0-dev

pip3 download gattlib
tar xvzf ./gattlib-0.20150805.tar.gz
cd gattlib-0.20150805/
sed -ie 's/boost_python-py34/boost_python-py36/' # "py36" might be "py37" (for example). Check "python3 --version"
pip3 install .

Type python3 -h/--help for usage tips.

eg: sudo python3 -d xx:xx:xx:xx:xx:xx -c close

Enjoy :)



Thanks to contributors





SwitchBot (Official website)

Facebook @SwitchBotRobot

Twitter @SwitchBot


The python code running on Raspberry Pi or other Linux based boards to control SwitchBot.







No releases published


No packages published