Geen omschrijving

Fabian Peter Hammerle 3598f78705 env: add upper version constraint for pytest to keep compatibility with python3.5 3 jaren geleden
.github e897e3e879 configure github's dependabot to update Pipfile.lock 4 jaren geleden
switchbot_mqtt b49dbfa18c upgrade paho-mqtt to no longer suppress exceptions occuring in mqtt callbacks 3 jaren geleden
tests b49dbfa18c upgrade paho-mqtt to no longer suppress exceptions occuring in mqtt callbacks 3 jaren geleden
.dockerignore 046e59cda6 docker: no longer require build arg SWITCHBOT_MQTT_VERSION 4 jaren geleden
.gitignore 3b5ea00bf0 pipeline / pipenv: explicitly specify python version to workaround pipenv picking highest available 4 jaren geleden
.pylintrc 663ae02dff pipeline: enable pylint_import_requirements explicitly 4 jaren geleden
CHANGELOG.md b49dbfa18c upgrade paho-mqtt to no longer suppress exceptions occuring in mqtt callbacks 3 jaren geleden
COPYING cb2596d32e standard python project tech stack (pipenv, pytest, pylint etc.); mqtt connect; GPLv3+ 4 jaren geleden
Dockerfile b49dbfa18c upgrade paho-mqtt to no longer suppress exceptions occuring in mqtt callbacks 3 jaren geleden
Pipfile 3598f78705 env: add upper version constraint for pytest to keep compatibility with python3.5 3 jaren geleden
Pipfile.lock 3598f78705 env: add upper version constraint for pytest to keep compatibility with python3.5 3 jaren geleden
README.md 5f7ed542c9 docker: add env vars $MQTT_HOST/PORT/USERNAME/PASSWORD 3 jaren geleden
mypy.ini cb2596d32e standard python project tech stack (pipenv, pytest, pylint etc.); mqtt connect; GPLv3+ 4 jaren geleden
setup.py 7ff05ba3f2 dev env: upgrade black 4 jaren geleden

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 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
    restart: unless-stopped

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).

Alternatives