Homebridge Start und Status in FHEM

Um nicht bei jeder Änderung, welche die Homebridge betrifft, diese über die Console manuell neustarten zu müssen zeigt diese Lösung wie dies bequem aus FHEMWEB erfolgen kann. In den nachfolgenden Abschnitten sind die einzelnen Schritte dazu erläutert.

Vorwort

Die im weitern genutzten Bezeichnungen von Dummys, Scriptdateinamen o.ä. können geändert werden. Die Änderungen müssen jedoch auch an allen entsprechenden Stellen vorgenommen werden. Genannte IP Adressen, Benutzernamen und Passwörter sind auf die eigenen Gegebenheiten anzupassen. Die Berechtigungen des Benutzers müssen zur Ausführung der Scripte geprüft und ggf. angepasst werden. Entprechende Linux Kentnisse sollten vorhanden sein. Dieser Artikel berücksichtigt das FHEM und Homebridge nicht zwingend auf dem selben System laufen. Die hier gezeigte Lösung kann für beide Varianten genutzt werden, FHEM und Homebridge auf dem gleichen System oder auf getrennten Systemen.

Umsetzung

Status- und Kontroll-Dummy

Status- bzw. Kontroll-Dummy

Es wird ein Dummy benötigt, welcher den Status des Homebridge-Dienstes anzeigt und über den dieser Dienst gesteuert werden kann. Das nötige Script um die Homebridge als Dienst zu starten wird weiter unten in diesem Artikel erstellt.

define SYS_Homebridge dummy
attr SYS_Homebridge devStateIcon .*on:general_an .*off:general_aus .*:audio_rec
attr SYS_Homebridge eventMap status:status start:start stop:stop restart:restart
attr SYS_Homebridge icon it_router
attr SYS_Homebridge room System
attr SYS_Homebridge userReadings OnStateChange:(start|stop|restart|status) {  system ("sudo service homebridge ".ReadingsVal($NAME,"state","restart")." &" );;  }
attr SYS_Homebridge webCmd status:start:stop:restart

Der Dummy wird durch setzen von "start", "stop", "restart" oder "status" jeweils das userReading ausführen und somit letztendlich den homebridge Dienst steuert.

Start Script anlegen

Nun ist das Startscript für die Homebridge anzulegen. Mittels dem folgenden Befehl wird (wenn noch nicht vorhanden) das homebridge Script angelegt und im Editor geöffnet.

sudo nano /etc/init.d/homebridge

Wenn die Homebridge nicht auf dem selben System läuft wie FHEM muss dieser Schritt auf dem Homebridge System ausgeführt werden.

Das nun folgende Script kann in die homebridge Datei, die im Nano Editor geöffnet, ist rein kopiert werden.

Achtung: die Variabeln homeBridgeUser, fhemHost und fhemHostTelnetPort sind ggf. auf die eigenen Gegebenheiten anzupassen.

#!/bin/sh
### BEGIN INIT INFO
# Provides: homebridge
# Required-Start: $network $remote_fs $syslog
# Required-Stop: $remote_fs $syslog
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: Start daemon at boot time for homebridge
# Description: Enable service provided by daemon.
### END INIT INFO
export PATH=$PATH:/usr/local/bin
export NODE_PATH=$NODE_PATH:/usr/local/lib/node_modules

PID=`pidof homebridge`
homeBridgeUser="fhem"
fhemHost=127.0.0.1          #FHEM Server (Masterinstanz)
fhemHostTelnetPort=7072     #TelnetPort der FHEM Instanz
fhemDefine="SYS_Homebridge"

case "$1" in
start)
if ps -p $PID > /dev/null 2>&1; then
        echo "Homebridge is already running"
        perl /opt/fhem/fhem.pl $fhemHost:$fhemHostTelnetPort "setreading $fhemDefine info Homebridge is already running"			
else
        su - $homeBridgeUser -c "homebridge > /dev/null 2>&1 &"
        echo "Homebridge starting"
        perl /opt/fhem/fhem.pl $fhemHost:$fhemHostTelnetPort "setreading $fhemDefine info Homebridge starting"	
	perl /opt/fhem/fhem.pl $fhemHost:$fhemHostTelnetPort "set $fhemDefine on"
        sleep 2
	$0 status
fi
;;
stop)
if ! ps -p $PID > /dev/null 2>&1; then
        echo "Homebridge is not running"
        perl /opt/fhem/fhem.pl $fhemHost:$fhemHostTelnetPort "setreading $fhemDefine info Homebridge is not running"
else
        kill $PID
        echo "Homebridge stopping"
        perl /opt/fhem/fhem.pl $fhemHost:$fhemHostTelnetPort "setreading $fhemDefine info Homebridge stopping"
        perl /opt/fhem/fhem.pl $fhemHost:$fhemHostTelnetPort "set $fhemDefine off"
        sleep 2
	$0 status		
fi
;;
restart)
if ! ps -p $PID > /dev/null 2>&1; then
        $0 start
else
        $0 stop
        $0 start
fi
;;
status)
if ps -p $PID > /dev/null 2>&1; then
        echo "Homebridge is running PID $PID"
        perl /opt/fhem/fhem.pl $fhemHost:$fhemHostTelnetPort "setreading $fhemDefine info Homebridge running as PID $PID"
else
        echo "Homebridge is not running"
        perl /opt/fhem/fhem.pl $fhemHost:$fhemHostTelnetPort "setreading $fhemDefine info Homebridge is not running"
fi
;;
*)
echo "Usage: $0 {start|stop|status|restart}"
exit 1
;;
esac
exit 0

Das Script setzt in dem bereits angelegten Dummy ein Reading info in dem der Ausführungsstatus des Scripts wieder gegeben wird. Das Reading state wir auf on oder off gesetzt. On bedeutet das Homebridge gestartet ist, off das die Homebridge nicht ausgeführt wird.

Damit die Homebridge auch mit Start des Systems gestartet wird sind die folgenden zwei Schritte notwendig

sudo chmod 755 /etc/init.d/homebridge
sudo update-rc.d homebridge defaults

Zum testen kann der Dienst nun mit dem Befehl

sudo service homebridge start

bzw.

sudo /etc/init.d/homebridge start

gestartet werden. In dem angelegten Dummy werden zwei Readings erzeugt mit den entsprechenden Rückmeldungen aus dem Script. Die Readings werden erst angezeigt wenn die bereits geöffnete Detailseite des Dummys neu geladen wird.

Testlauf / Fertig

Nun können die einzelnen Aktionen über den Dummy ausführt werden. Dabei wird jeweils der eingerichtete Dienst angesteuert und eine (mit kurzer Verzögerung) Rückmeldung gegeben.

Sonstiges

FHEM Benutzer Zugriff auf Script gewähren

Damit aus FHEM das Script ausgeführt werden kann benötigt dieser Benutzer entsprechende Berechtigungen. Dazu ist in der sudoers ein Eintrag zu ergänzen. Dazu wird die sudoers Datei im Nano Editor geöffnet

sudo nano /etc/sudoers

Dort sollte im Abschnitt # User privilege specification die folgende Zeile ergänzt werden

fhem ALL=(ALL) NOPASSWD:/etc/init.d/homebridge

Achtung! Sollte FHEM nicht unter dem Benuter fhem laufen ist dies an den entsprechenden Stellen anzupassen.

Beispielinhalt der sudoers:

#
# This file MUST be edited with the 'visudo' command as root.
#
# Please consider adding local content in /etc/sudoers.d/ instead of
# directly modifying this file.
#
# See the man page for details on how to write a sudoers file.
#
Defaults	env_reset
Defaults	mail_badpass
Defaults	secure_path="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"

# Host alias specification

# User alias specification

# Cmnd alias specification

# User privilege specification
root	ALL=(ALL:ALL) ALL
fhem ALL=(ALL) NOPASSWD:/etc/init.d/homebridge

# Members of the admin group may gain root privileges
%admin  ALL = (ALL) NOPASSWD: ALL

# Allow members of group sudo to execute any command
%sudo	ALL=(ALL:ALL) ALL

# See sudoers(5) for more information on "#include" directives:

#includedir /etc/sudoers.d

Anpassung wenn FHEM und Homebridge auf getrennten Systemen laufen

Unter dem Kapitel Umsetzung wurde bereits alles vorbereitet um mit wenigen Änderungen eine Homebridge zu starten die nicht auf dem selben System läuft wie FHEM. Es sind nur 2 Änderungen notwendig. Die erste Änderung betrifft den eingerichteten Dummy. Hier ist das vorhandenen userReadings wie folgt abzuändern

attr SYS_Homebridge userReadings OnStateChange:(start|stop|restart|status) { system ("sudo /opt/fhem/FHEM/homebridgeserviceremote.sh ".ReadingsVal($NAME,"state","restart")." &" );; }

Dadurch wird, durch die Aktionen des Dummys, ein weiteres Script angesprochen.

Nun wird dieses Script mit hilfe des Nano Editor angelegt

sudo nano /opt/fhem/FHEM/homebridgeserviceremote.sh

und mit dem folgenden Inhalt befüllt.

Achtung: die Variabeln remoteUser, remotePasswort und remoteHost sind ggf. auf die eigenen Gegebenheiten der entfernt laufenden Homebridge anzupassen. Der hier genannte Benutzer muss natürlich berechtigt sein die Homebridge starten zu können. Es sollte auch nicht der root User verwendet werden, sondern ein eigens dafür angelegter und in den Berechtigungen eingeschränkter Benutzer verwendet werden. Wer zur Fehleranalyse etwas mehr sehen möchte ändert den Wert von debug auf 1.

#!/bin/bash
debug=0
remoteUser="root"
remotePasswort="root"
remoteHost="192.168.1.111"
remoteService="homebridge"
fhemHostTelnetPort=7072           #TelnetPort der FHEM Instanz

# Vorraussetzungen prüfen
if [ $(dpkg-query -W -f='${Status}' sshpass 2>/dev/null | grep -c "ok installed") -eq 0 ];
then
	if [ "$debug" = "1" ]; then 
		echo "sshpass wird benötigt. Installation beginnt"; 
		perl /opt/fhem/fhem.pl $fhemHostTelnetPort "{Log 1, \"[homebridgeserviceremote.sh] sshpass wird benötigt. Installation beginnt\"}";
	fi
	apt-get install sshpass
	if [ "$debug" = "1" ]; then 
		echo "sshpass wurde installiert";
		perl /opt/fhem/fhem.pl $fhemHostTelnetPort "{Log 1, \"[homebridgeserviceremote.sh] sshpass wurde installiert\"}";		
	fi
fi
###################################

# Befehl ausführen
case "$1" in
start)
	if [ "$debug" = "1" ]; then 
		echo "Ausführen von 'sudo service $remoteService start' auf '$remoteHost' als '$remoteUser'"; 
		perl /opt/fhem/fhem.pl $fhemHostTelnetPort "{Log 1, \"[homebridgeserviceremote.sh] Ausführen von 'sudo service $remoteService start' auf '$remoteHost' als '$remoteUser'\"}";
	fi
	sshpass -p "$remotePasswort" ssh -o StrictHostKeyChecking=no $remoteUser@$remoteHost "sudo service $remoteService start"
	if [ "$debug" = "1" ]; then 
		echo "Ausführung beendet"; 
		perl /opt/fhem/fhem.pl $fhemHostTelnetPort "{Log 1, \"[homebridgeserviceremote.sh] Ausführung beendet\"}";
	fi
;;
stop)
	if [ "$debug" = "1" ]; then 
		echo "Ausführen von 'sudo service $remoteService stop' auf '$remoteHost' als '$remoteUser'"; 
		perl /opt/fhem/fhem.pl $fhemHostTelnetPort "{Log 1, \"[homebridgeserviceremote.sh] Ausführen von 'sudo service $remoteService stop' auf '$remoteHost' als '$remoteUser'\"}";
	fi
	sshpass -p "$remotePasswort" ssh -o StrictHostKeyChecking=no $remoteUser@$remoteHost "sudo service $remoteService stop"
	if [ "$debug" = "1" ]; then 
		echo "Ausführung beendet"; 
		perl /opt/fhem/fhem.pl $fhemHostTelnetPort "{Log 1, \"[homebridgeserviceremote.sh] Ausführung beendet\"}";
	fi
;;
restart)
	if [ "$debug" = "1" ]; then 
		echo "Ausführen von 'sudo service $remoteService restart' auf '$remoteHost' als '$remoteUser'"; 
		perl /opt/fhem/fhem.pl $fhemHostTelnetPort "{Log 1, \"[homebridgeserviceremote.sh] Ausführen von 'sudo service $remoteService restart' auf '$remoteHost' als '$remoteUser'\"}";
	fi
	sshpass -p "$remotePasswort" ssh -o StrictHostKeyChecking=no $remoteUser@$remoteHost "sudo service $remoteService restart"
	if [ "$debug" = "1" ]; then 
		echo "Ausführung beendet"; 
		perl /opt/fhem/fhem.pl $fhemHostTelnetPort "{Log 1, \"[homebridgeserviceremote.sh] Ausführung beendet\"}";
	fi

;;
status)
	if [ "$debug" = "1" ]; then 
		echo "Ausführen von 'sudo service $remoteService status' auf '$remoteHost' als '$remoteUser'";
		perl /opt/fhem/fhem.pl $fhemHostTelnetPort "{Log 1, \"[homebridgeserviceremote.sh] Ausführen von 'sudo service $remoteService status' auf '$remoteHost' als '$remoteUser'\"}";		
	fi
	sshpass -p "$remotePasswort" ssh -o StrictHostKeyChecking=no $remoteUser@$remoteHost "sudo service $remoteService status"
	if [ "$debug" = "1" ]; then 
		echo "Ausführung beendet"; 
		perl /opt/fhem/fhem.pl $fhemHostTelnetPort "{Log 1, \"[homebridgeserviceremote.sh] Ausführung beendet\"}";
	fi
;;
*)
echo "Usage: $0 {start|stop|status|restart}"
exit 1
;;
esac
exit 0
###################################

Das Script macht nicht sehr viel. Es verbindet sich über ssh mit dem entfernten System und startet (stopt, etc.) den Homebridge Dienst. Hinweis: es wird sshpass benötigt, welches das Script bei bedarf versucht zu installieren.

Dankeschön

Ein Dankeschön geht an die Entwicklergemeinde rund um Homebridge und dem FHEM Plugin für die Homebridge.

Ein besonderes Dankeschön an No Legend der die zugrunde liegende Idee und Lösung in diesem Artikel beschrieben hat.