No Description

Fabian Peter Hammerle affa64575f release v0.3.0 2 years ago
.github 663ae02dff pipeline: enable pylint_import_requirements explicitly 2 years ago
switchbot_mqtt 7fce0c4545 _report_state; adapt logging; no longer wait for publish (froze) 2 years ago
tests 087dc684f9 test mqtt: disable irrelevant too-many-arguments check 2 years ago
.dockerignore 046e59cda6 docker: no longer require build arg SWITCHBOT_MQTT_VERSION 2 years ago
.gitignore cb2596d32e standard python project tech stack (pipenv, pytest, pylint etc.); mqtt connect; GPLv3+ 2 years ago
.pylintrc 663ae02dff pipeline: enable pylint_import_requirements explicitly 2 years ago
CHANGELOG.md affa64575f release v0.3.0 2 years ago
COPYING cb2596d32e standard python project tech stack (pipenv, pytest, pylint etc.); mqtt connect; GPLv3+ 2 years ago
Dockerfile 7fd15fc735 refactor dockerfile: merge run layers 2 years ago
Pipfile cb2596d32e standard python project tech stack (pipenv, pytest, pylint etc.); mqtt connect; GPLv3+ 2 years ago
Pipfile.lock cb2596d32e standard python project tech stack (pipenv, pytest, pylint etc.); mqtt connect; GPLv3+ 2 years ago
README.md ce8cf8c8bf publish new state to homeassistant/switch/switchbot/MAC_ADDRESS/state on success 2 years ago
mypy.ini cb2596d32e standard python project tech stack (pipenv, pytest, pylint etc.); mqtt connect; GPLv3+ 2 years ago
setup.py cb08933a42 fix setuptools_scm: ignore docker image digest tags docker/* 2 years ago

README.md

SwitchBot MQTT client

CI Pipeline Status Coverage Status Last Release Compatible Python Versions

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

Alternatives