No Description

dependabot[bot] 02d03d950d build(deps-dev): bump pylint from 2.13.8 to 2.13.9 2 days ago
.github d1fdb7ccc6 build(deps): bump docker/build-push-action from 2.10.0 to 3.0.0 2 weeks ago
switchbot_mqtt f0f5e96b77 disable pylint's similarity checks locally 2 weeks ago
tests f0f5e96b77 disable pylint's similarity checks locally 2 weeks ago
.dockerignore 046e59cda6 docker: no longer require build arg SWITCHBOT_MQTT_VERSION 2 years ago
.gitignore 3b5ea00bf0 pipeline / pipenv: explicitly specify python version to workaround pipenv picking highest available 1 year ago
.pylintrc f0f5e96b77 disable pylint's similarity checks locally 2 weeks ago
CHANGELOG.md d4bda8864a release v3.2.0 1 month ago
COPYING cb2596d32e standard python project tech stack (pipenv, pytest, pylint etc.); mqtt connect; GPLv3+ 2 years ago
Dockerfile d7b875458d setup github action verifying docker build succeeds (to replace docker's autobuild service) 11 months ago
Makefile 870cac5cfc refactor makefile: rename variables (including removal of "DOCKER_" prefixes) 1 year ago
Pipfile 67012e187e dev env: add typed-ast to fix mypy on python3.7 3 months ago
Pipfile.lock 02d03d950d build(deps-dev): bump pylint from 2.13.8 to 2.13.9 2 days ago
README.md 64a57aa390 add command-line option `--mqtt-topic-prefix` 1 month ago
mypy.ini c6bc41e1c3 add additional (internal) type hints to enable mypy's strict mode 4 months ago
setup.py 878afa9bf6 fix "TypeError: 'ABCMeta' object is not subscriptable" on python<3.9 3 months ago

README.md

SwitchBot MQTT client

CI Pipeline Status Coverage Status Last Release Compatible Python Versions

MQTT client controlling SwitchBot button automators and curtain motors

Compatible with Home Assistant's MQTT Switch and MQTT Cover platform.

Setup

$ pip3 install --user --upgrade switchbot-mqtt

Usage

$ switchbot-mqtt --mqtt-host HOSTNAME_OR_IP_ADDRESS --mqtt-enable-tls
# or
$ switchbot-mqtt --mqtt-host HOSTNAME_OR_IP_ADDRESS --mqtt-disable-tls

Use sudo hcitool lescan or select device settings > 3 dots on top right in SwitchBot app to determine your SwitchBot's mac address.

Button Automator

Send ON or OFF to topic homeassistant/switch/switchbot/aa:bb:cc:dd:ee:ff/set.

$ mosquitto_pub -h MQTT_BROKER -t homeassistant/switch/switchbot/aa:bb:cc:dd:ee:ff/set -m ON

The command-line option --fetch-device-info enables battery level reports on topic homeassistant/switch/switchbot/MAC_ADDRESS/battery-percentage after every command. The report may be requested manually by sending a MQTT message to the topic homeassistant/switch/switchbot/MAC_ADDRESS/request-device-info (requires --fetch-device-info)

Curtain Motor

Send OPEN, CLOSE, or STOP to topic homeassistant/cover/switchbot-curtain/aa:bb:cc:dd:ee:ff/set:

$ mosquitto_pub -h MQTT_BROKER -t homeassistant/cover/switchbot-curtain/aa:bb:cc:dd:ee:ff/set -m CLOSE

Or a position in percent (0 fully closed, 100 fully opened) to topic homeassistant/cover/switchbot-curtain/aa:bb:cc:dd:ee:ff/position/set-percent:

$ mosquitto_pub -h MQTT_BROKER -t homeassistant/cover/switchbot-curtain/aa:bb:cc:dd:ee:ff/position/set-percent -m 42

The command-line option --fetch-device-info enables position reports on topic homeassistant/cover/switchbot-curtain/MAC_ADDRESS/position after STOP commands and battery level reports on topic homeassistant/cover/switchbot-curtain/MAC_ADDRESS/battery-percentage after every command. These reports may be requested manually by sending a MQTT message to the topic homeassistant/cover/switchbot-curtain/MAC_ADDRESS/request-device-info (requires --fetch-device-info)

Device Passwords

In case some of your Switchbot devices are password-protected, create a JSON file mapping MAC addresses to passwords and provide its path via the --device-password-file option:

{
  "11:22:33:44:55:66": "password",
  "aa:bb:cc:dd:ee:ff": "secret",
  "00:00:00:0f:f1:ce": "random string"
}
$ switchbot-mqtt --device-password-file /some/where/switchbot-passwords.json …

MQTT Authentication

switchbot-mqtt --mqtt-username me --mqtt-password secret …
# or
switchbot-mqtt --mqtt-username me --mqtt-password-file /var/lib/secrets/mqtt/password …

⚠️ --mqtt-password leaks the password to other users on the same machine, if /proc is mounted with hidepid=0 (default).

MQTT Topic

By default, switchbot-mqtt prepends homeassistant/ to all MQTT topics. This common prefix can be changed via --mqtt-topic-prefix:

# listens on living-room/switch/switchbot/aa:bb:cc:dd:ee:ff/set
switchbot-mqtt --mqtt-topic-prefix living-room/ …
# listens on switch/switchbot/aa:bb:cc:dd:ee:ff/set
switchbot-mqtt --mqtt-topic-prefix '' …

Home Assistant 🏡

Rationale

Why not use the official SwitchBot integration?

I prefer not to share the host's network stack with home assistant (more complicated network setup and additional netfilter rules required for isolation).

Sadly, docker run --network host even requires --userns host:

docker: Error response from daemon: cannot share the host's network namespace when user namespaces are enabled.

The docker image built from this repository works around this limitation by explicitly running as an unprivileged user.

The official home assistant image runs as root. This imposes an unnecessary security risk, especially when disabling user namespace remapping (--userns host). See https://github.com/fphammerle/docker-home-assistant for an alternative.

Setup

# https://www.home-assistant.io/docs/mqtt/broker/#configuration-variables
mqtt:
  broker: BROKER_HOSTNAME_OR_IP_ADDRESS
  # credentials, additional options…

# https://www.home-assistant.io/integrations/switch.mqtt/#configuration-variables
switch:
- platform: mqtt
  name: switchbot_button
  command_topic: homeassistant/switch/switchbot/aa:bb:cc:dd:ee:ff/set
  state_topic: homeassistant/switch/switchbot/aa:bb:cc:dd:ee:ff/state
  # http://materialdesignicons.com/
  icon: mdi:light-switch

cover:
- platform: mqtt
  name: switchbot_curtains
  command_topic: homeassistant/cover/switchbot-curtain/11:22:33:44:55:66/set
  set_position_topic: homeassistant/cover/switchbot-curtain/aa:bb:cc:dd:ee:ff/position/set-percent
  state_topic: homeassistant/cover/switchbot-curtain/11:22:33:44:55:66/state

Docker 🐳

Pre-built docker images are available at https://hub.docker.com/r/fphammerle/switchbot-mqtt/tags

Annotation of signed tags docker/* contains docker image digests: https://github.com/fphammerle/switchbot-mqtt/tags

$ docker build -t switchbot-mqtt .
$ docker run --name spelunca_switchbot \
    --userns host --network host \
    switchbot-mqtt:latest \
    switchbot-mqtt --mqtt-host HOSTNAME_OR_IP_ADDRESS

Alternatively, you can use docker-compose:

version: '3.8'

services:
  switchbot-mqtt:
    image: switchbot-mqtt
    container_name: switchbot-mqtt
    network_mode: host
    userns_mode: host
    environment:
    - MQTT_HOST=localhost
    - MQTT_PORT=1883
    #- MQTT_USERNAME=username
    #- MQTT_PASSWORD=password
    #- FETCH_DEVICE_INFO=yes
    restart: unless-stopped

Alternatives