No Description

Fabian Peter Hammerle 66cfdfe017 dev env: added upper version constraints for astroid & pylint to keep compatibility with python3.5 1 week ago
.github 76b63a06e8 test against python3.9 2 weeks ago
docs 56dc5bad31 prepare-for-shutdown: publish config for home assistant to enable automatic discovery 8 months ago
systemctl_mqtt c790a93981 instruct sessions to lock on systemctl/hostname/lock-all-sessions 4 months ago
tests 3d38cf6028 upgrade black 2 months ago
.dockerignore 74669520c1 added dockerfile & docker-compose.yml 8 months ago
.gitignore c790a93981 instruct sessions to lock on systemctl/hostname/lock-all-sessions 4 months ago
.isort.cfg 04fcb2b7a9 isort: added config to workaround persistent misclassification of paho.mqtt.client 8 months ago
.pylintrc 1574063886 mqtt message on topic systemctl/hostname/poweroff schedules poweroff with delay of 4 seconds 8 months ago
CHANGELOG.md c9682a0419 dockerfile: add registry to base image specifier & force `rm` for `podman build` 3 weeks ago
COPYING 1574063886 mqtt message on topic systemctl/hostname/poweroff schedules poweroff with delay of 4 seconds 8 months ago
Dockerfile c9682a0419 dockerfile: add registry to base image specifier & force `rm` for `podman build` 3 weeks ago
Makefile e72910d853 refactor makefile: minor renamings for consistency with switchbot-mqtt's Makefile 3 weeks ago
Pipfile 66cfdfe017 dev env: added upper version constraints for astroid & pylint to keep compatibility with python3.5 1 week ago
Pipfile.lock 66cfdfe017 dev env: added upper version constraints for astroid & pylint to keep compatibility with python3.5 1 week ago
README.md 89ea939a49 readme: create usage sections 3 months ago
docker-apparmor-profile c790a93981 instruct sessions to lock on systemctl/hostname/lock-all-sessions 4 months ago
docker-compose.yml c32424c058 docker-compose: assign bridge name 4 months ago
mypy.ini 1574063886 mqtt message on topic systemctl/hostname/poweroff schedules poweroff with delay of 4 seconds 8 months ago
setup.py 76b63a06e8 test against python3.9 2 weeks ago

README.md

systemctl-mqtt

CI Pipeline Status Coverage Status Last Release Compatible Python Versions DOI

MQTT client triggering & reporting shutdown on systemd-based systems

Setup

$ pip3 install --user --upgrade systemctl-mqtt
$ systemctl-mqtt --mqtt-host HOSTNAME_OR_IP_ADDRESS

On debian-based systems, dependencies can optionally be installed via:

$ sudo apt-get install --no-install-recommends python3-dbus python3-gi python3-paho-mqtt

Usage

Schedule Poweroff

Schedule poweroff by sending a MQTT message to topic systemctl/hostname/poweroff.

$ mosquitto_pub -h MQTT_BROKER -t systemctl/hostname/poweroff -n

Shutdown Report

systemctl-mqtt subscribes to logind's PrepareForShutdown signal.

systemctl halt|poweroff|reboot triggers a message with payload true on topic systemctl/hostname/preparing-for-shutdown.

Lock Screen

Lock screen by sending a MQTT message to topic systemctl/hostname/lock-all-sessions.

$ mosquitto_pub -h MQTT_BROKER -t systemctl/hostname/lock-all-sessions -n

Home Assistant 🏡

Sample Setup

Send Poweroff Command

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

script:
  poweroff_raspberry_pi:
    sequence:
      service: mqtt.publish
      data:
        topic: systemctl/raspberrypi/poweroff

homeassistant:
  customize:
    script.poweroff_raspberry_pi:
      friendly_name: poweroff pi
      icon: mdi:power

Trigger Automation on Shutdown

automation:
- trigger:
    platform: mqtt
    topic: systemctl/raspberrypi/preparing-for-shutdown
    payload: 'true'
  action:
    service: switch.turn_off
    entity_id: switch.desk_lamp

Automatic Discovery of Shutdown Sensor (Optional)

After enabling MQTT device discovery home assistant will automatically detect a new entity binary_sensor.hostname_preparing_for_shutdown.

mqtt:
  broker: BROKER_HOSTNAME_OR_IP_ADDRESS
  discovery: true # default in home assistant >=v0.117.0
  # credentials, additional options…

homeassistant discovery binary_sensor.hostname_preparing_for_shutdown

When using a custom discovery_prefix pass --homeassistant-discovery-prefix custom-prefix to systemctl-mqtt.

Docker 🐳

  1. Clone this repository.
  2. Edit docker-compose.yml.
  3. Load AppArmor profile: sudo apparmor_parser ./docker-apparmor-profile
  4. sudo docker-compose up --build

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

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

MQTT via TLS

TLS is enabled by default. Run systemctl-mqtt --mqtt-disable-tls … to disable TLS.

MQTT Authentication

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

Adapt Poweroff Delay

systemctl-mqtt --poweroff-delay-seconds 60 …