switchbot-mqtt

Fixed

• Publish birth and last will message on expected/documented topic
  homeassistant/switchbot-mqtt/status instead of topic
  homeassistant/switchbot_mqtt/status.

Added

• Birth ("online") and last will ("offline") message on topic homeassistant/switchbot-mqtt/status
  (@phbasler, https://github.com/fphammerle/switchbot-mqtt/pull/105)

Correction: Inadvertently publishing on homeassistant/switchbot_mqtt/status instead of documented homeassistant/switchbot-mqtt/status. Topic will be fixed in next release.

Fixed

• ValueError: too many values to unpack when connecting to MQTT broker via IPv6
  (https://github.com/fphammerle/switchbot-mqtt/issues/42)

Added

• command-line option --mqtt-topic-prefix

Added

• command-line option --mqtt-enable-tls
• command-line option --mqtt-disable-tls (enabled by default)

Deprecated

• invocation with neither --mqtt-enable-tls nor --mqtt-disable-tls

Added

• MQTT messages on topic homeassistant/cover/switchbot-curtain/MAC_ADDRESS/position/set-percent
  trigger command to set curtain motors' position (payload: decimal integer in range [0, 100])
• support PySwitchbot v0.11.0 and v0.12.0

Removed

• compatibility with python3.6
• no longer report button automator's battery percentage on deprecated topic homeassistant/cover/switchbot/+/battery-percentage
  (use homeassistant/switch/switchbot/+/battery-percentage instead, see v2.1.0)

Added

• MQTT messages on topic homeassistant/switch/switchbot/MAC_ADDRESS/request-device-info
  and homeassistant/cover/switchbot-curtain/MAC_ADDRESS/request-device-info trigger
  update and reporting of device information (battery level, and curtains' position).
  Requires --fetch-device-info.

Added

• battery level of button automators will additionally be reported on topic
  homeassistant/switch/switchbot/MAC_ADDRESS/battery-percentage.
  old (misleading) topic kept for downward compatibility.
• --fetch-device-info can alternatively be enabled by assigning a non-empty value
  to the environment variable FETCH_DEVICE_INFO

Added

• command-line option --fetch-device-info enables battery level reports on topics
  homeassistant/cover/{switchbot,switchbot-curtain}/MAC_ADDRESS/battery-percentage
  after every command.
• option --debug to change log level to DEBUG

Changed

• changed default log level from DEBUG to INFO
• shortened log format (revert with --debug)

Removed

• compatibility with python3.5

Added

• command-line option --fetch-device-info enables reporting of curtain motors'
  position on topic homeassistant/cover/switchbot-curtain/MAC_ADDRESS/position
  after sending stop command.

Added

• support for password-protected switchbot devices
  via optional command-line parameter --device-password-file
  (json file mapping mac addresses to the respective password)

Added

• Command-line parameter --retries to alter maximum number of attempts to send a command
  to a SwitchBot device (default unchanged)

Fixed

• Dockerfile: split pipenv install into two stages to speed up image builds
• Dockerfile: chmod files copied from host to no longer require o=rX perms on host
• Dockerfile: add registry to base image specifier for podman build
• Dockerfile: add --force flag to rm invocation to avoid interactive questions while running podman build

Added

• Control SwitchBot Curtain motors via OPEN, CLOSE, and STOP on topic homeassistant/cover/switchbot-curtain/aa:bb:cc:dd:ee:ff/set

Changed

• Docker image:
  • Upgrade paho-mqtt to no longer suppress exceptions occuring in mqtt callbacks
    ( https://github.com/eclipse/paho.mqtt.python/blob/v1.5.1/ChangeLog.txt#L4 )
  • Build stage: revert user after applying chown workaround for inter-stage copy
• Log format: added name of logger between level and message

Added

• Docker image: support parametrization via environment variables
  (MQTT_HOST, MQTT_PORT, MQTT_USERNAME & MQTT_PASSWORD)

Fixed

• Compatibility with python3.5:
  • Replaced PEP526-style variable type hint with PEP484-compatible
  • Tests: Fixed AttributeError due to unavailable MagicMock.assert_called_once

Added

• Added command line parameter --mqtt-password-file

Fixed

• Docker build: fix pipenv failing to create cache

Added

• Publish new state to homeassistant/switch/switchbot/MAC_ADDRESS/state on success

Added

• Added command line parameters --mqtt-username and --mqtt-password

Fixed

• Fixed executable name in command line help
• Docker: no longer require build arg SWITCHBOT_MQTT_VERSION
  (fixes auto build on hub.docker.com)