README.md 3.6 KB
SwitchBot MQTT client
MQTT client controlling SwitchBot button automators
Compatible with Home Assistant's MQTT Switch platform.
Setup
$ pip3 install --user --upgrade switchbot-mqtt
$ switchbot-mqtt --mqtt-host HOSTNAME_OR_IP_ADDRESS
Use sudo hcitool lescan
or select device settings > 3 dots on top right in
SwitchBot app
to determine your SwitchBot's mac address.
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
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: some_name
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
Docker 🐳
Pre-built docker image 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