systemctl-mqtt 0.5.0

Description:

systemctlmqtt 0.5.0

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

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

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

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…


When using a custom discovery_prefix
pass --homeassistant-discovery-prefix custom-prefix to systemctl-mqtt.
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 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 …