No Description

Fabian Peter Hammerle f348d613ce retain msgs on systemctl/hostname/preparing-for-shutdown		4 years ago
.github	aee870c751 prepare glib loop to receive dbus signals	4 years ago
systemctl_mqtt	47bb97bb07 retain msgs on systemctl/hostname/preparing-for-shutdown	4 years ago
tests	2511d653f4 added unit tests for _State.publish_preparing_for_shutdown	4 years ago
.dockerignore	74669520c1 added dockerfile & docker-compose.yml	4 years ago
.gitignore	ab72c20968 pipeline / pipenv: explicitly specify python version to workaround pipenv picking highest available	4 years ago
.isort.cfg	04fcb2b7a9 isort: added config to workaround persistent misclassification of paho.mqtt.client	4 years ago
.pylintrc	1574063886 mqtt message on topic systemctl/hostname/poweroff schedules poweroff with delay of 4 seconds	4 years ago
CHANGELOG.md	20dafb5c80 document shutdown report on systemctl/hostname/preparing-for-shutdown	4 years ago
COPYING	1574063886 mqtt message on topic systemctl/hostname/poweroff schedules poweroff with delay of 4 seconds	4 years ago
Dockerfile	771ac46360 dockerfile: added missing dependencies	4 years ago
Pipfile	522e1c6d7b pylint-import-requirements: upgrade to new stable version incorporating fix for PyGObject's custom loader	4 years ago
Pipfile.lock	522e1c6d7b pylint-import-requirements: upgrade to new stable version incorporating fix for PyGObject's custom loader	4 years ago
README.md	20dafb5c80 document shutdown report on systemctl/hostname/preparing-for-shutdown	4 years ago
docker-apparmor-profile	47bb97bb07 retain msgs on systemctl/hostname/preparing-for-shutdown	4 years ago
docker-compose.yml	e57f5aaeea added link to merge request enabling apparmor for raspberrypi's official kernel	4 years ago
mypy.ini	1574063886 mqtt message on topic systemctl/hostname/poweroff schedules poweroff with delay of 4 seconds	4 years ago
setup.py	20dafb5c80 document shutdown report on systemctl/hostname/preparing-for-shutdown	4 years ago

systemctl-mqtt

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

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.

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

Docker 🐳

Clone this repository.
Edit docker-compose.yml.
Load AppArmor profile: sudo apparmor_parser ./docker-apparmor-profile
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 Authentication

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

README.md