Anhang - GollmerSt/SolvisSmartHomeServer GitHub Wiki

Übersicht über die Kommando-Zeilen-Parameter:

Folgende Dateien dienen der Konfiguration und der Datenablage des Programmes:

Bis auf die Datei log4j2.xml existiert für jede der XML-Dateien ein XML-Shema. In dieser Datei sind die einzelnen XML-Elemente dokumentiert. Auf eine weitere Dokumentation wird hier daher verzichtet. Wenn jemand die control.xml verändern will, sollte er einen XML-Editor verwenden, der auch mit den XSD-Dateien umgehen kann (z.B. der XML-Editor des Eclipse-Pakets). Auf diese Weise werden die Fehlermöglichkeiten reduziert. In dem Editor kann man sich dann in der Regel zu jedem Attribut/Element auch die dazugehörige Dokumentation ansehen (in Eclipse durch Tool-Tips). Außerdem stellen solche Editoren Pull-Down-Menüs breit, mit dnen man die Atribute/Tags entsprechend dem XSD-Shema auswählen kann.

Seit Version V01.00.11 zum Loggen nicht mehr Log4j2 verwendet sonder TinyLog. Dadurch ist das Programmpaket um 2 MByte kleiner geworden (nun 1,4 MByte). Der Fileinhalt sieht wie folgt aus:

writer1             = console  
writer1.level       = error  
writer1.format      = {date: HH:mm:ss,SSS}|{level}|{message}  
writer1.tag         = -  
  
writer2             = rolling file  
writer2.level       = info  
writer2.file        = solvis-tiny.log.{count}  
writer2.format      = [{date: yyyy-MM-dd HH:mm:ss,SSS}] {level} {message}  
writer2.append      = true  
writer2.policies    = size: 1mb  
writer2.backups     = 5  
  
writer3             = console  
writer3.level       = info  
writer3.format      = {date: HH:mm:ss,SSS}|LEARN|{message}  
writer3.tag         = LEARN  

writer4             = rolling file  
writer4.level       = error  
writer4.file        = solvis-error.log.{count}  
writer4.format      = [{date: yyyy-MM-dd HH:mm:ss,SSS}] {level} {message}  
writer4.append      = true  
writer4.policies    = size: 1mb  
writer4.backups     = 2  

writingthread       = false  
autoshutdown        = false  

Wenn mehr geloggt werden soll, ist der Wert des Properties writer2.level von info auf debug zu stellen. Dies ist zur Fehleranalyse u. U. notwendig.

Bis zur Version V01.00.10 genutzt.

Der Server nutzt log4j2 von der Apache Software Foundation. Dieses System bietet eine Vielzahl von Möglichkeiten, so ermöglichst es auch das Logging auch in einer Datenbank.

Für den Anwender ist der letzte Abschnitt dieser Datei interessant:

<Async name="Async">
	<appender-ref ref="Solvis" level="info" />
	<appender-ref ref="Console" level="LEARN"/>
	<appender-ref ref="Solvis-Error" level="error"/>
	<!-- appender-ref ref="RFC5424" level="info"/ --> <!-- Database logging -->
</Async>

Der erste Appender (Solvis) schreibt in die Datei solvis.log. In der obigen Einstellungen werden alle Levels ab info dort reingeschrieben. Zur Fehlersuche ist es sinnvoll info durch debug zu ersetzen. Dann liefert der Log noch mehr Informationen.

Der zweite Appender (Console) bestimmt, was auf die Konsole geschrieben wird. Mit der obigen Definition werden nur die Ausgaben des Lern-Vorgangs sowie Fehlermeldungen ausgegeben. Läuft der Server als Service, kann man die letzten Meldungen mittels sudo systemctl status ausgeben lassen.

Der dritte Appender (Solvis-Error) bewirkt, dass Fehlermeldungen in eine Extra-Datei mit dem Namen solvis-error.log geschrieben werden.

Der letzte auskommentierte Appender (RFC5424) wäre für ein Datenbank-Logging notwendig. Der ist aktuell nicht aktiv und die in der log4j2.xml dazu notwendigen Teile habe ich einfach die verwendet, die ich auch in der Arbeit verwende. Das erfordert noch weitere Infrastruktur, daher ist das erst mal auskommentiert.

Das makefile wird wie folgt aufgerufen:

sudo make Ausführungs-Rule

Folgende Ausführungs-Rules sind möglich:

Das Makefile geht von folgenden Vorgaben aus:

1. FHEM (falls vorhanden) liegt im Verzeichnis /opt/fhem
2. Der SolvisSmartHomeServer wird im Verzeichnis /opt/solvis/SolvisSmartHomeServer installiert
3. Der Server läuft unter dem User solvis

Ist das System etwas anders konfiguriert, ist der Header des Makefiles anzupassen. Im Header des Makefiles finden sich dazu folgende Variablen:

Mit dem Release V01.05.01 wurde das Makefile so geändert, das hier normalerweise keine Anpassungen mehr notwendig sind, auch dann nicht, wenn kein FHEM auf dem System existiert. Der Server läuft seit V01.05.01 nicht mehr unter dem User fhem sondern unter dem User solvis. Außerdem ist das Default vom writablePathLinux im base.xml auf /opt/solvis geändert worden, ein Verzeichnis, dass das Makefile in der Grundkonfiguration automatisch erstellt und mit den entsprechenden Benutzerrechten versieht.

Es empfiehlt sich seit dem Rrelease V01.05.01 daher nicht diese Einträge zu ändern.

Will man es denoch ändern, ist zu beachten, dass man die Service-Datei SolvisSmartHomeServer.service möglicherweise ebenfalls ändern muss. Dort steht der Aufruf des Servers sowie der Usernamen drin.