Sie befinden sich hier: eisfair / Pack-Eis
News News News

Navigation

Content

Dateianzeige für owswitch (1.0.0)

usr/share/doc/owswitch/owswitch.txt
Das owswitch-Paket Die Einleitung Das owwitch-Paket ermoeglich die Ueberwachung und das Steuern von 1-wire Sensoren und Aktoren die z.B. an einem DS2413-Modul angeschlossen wurden. Aendert sich der Status eines Ports, so koennen auf Wunsch externe Programme aufgerufen werden um z.B. Warnungen etc. zu versenden. Die Voraussetzungen Das owswitch-Paket benoetigt ein installiertes owfs-Paket um funktionieren zu koennen. Die Installation Das owswitch-Paket wird ueber das Setup-Menue installiert. Wird eine aeltere Paketversion vorgefunden, so wird diese deinstalliert bevor die neuen Programmdateien installiert werden. Das Menue im Setup-Programm Das Menue im Setup-Programm ist wie folgt aufgebaut: * owswitch administration + View documentation: Anzeigen der Dokumentation + Edit configuration: Bearbeiten der Konfiguration + Advanced configuration file handling: Konfigurationen verwalten + Show status: Status des owswitch-Monitors anzeigen + Start service: Starten des owswitch-Monitors + Stop service: Stoppen des owswitch-Monitors + Restart service: Neustarten des owswitch-Monitors + Show sensor status: Aktuellen Sensorstatus anzeigen + View log file: Die Logmeldungen anzeigen + Exit: Untermenue verlassen Die Menuepunkte duerften selbsterklaerend sein, da sie keinerlei weitere Eingaben erwarten. Aus diesem Grund wird auf deren Funktion nicht weiter eingegangen. Die Aenderung der Konfiguration Die Konfiguration kann ueber den Menuepunkt 'Edit configuration' geaendert werden. Standardmaessig wird der Editor aufgerufen, der in der Environment-Konfiguration ueber die Variable 'EDITOR' festgelegt wurde. Nachdem der Editor beendet wurde wird abgefragt, ob die Konfiguration aktiviert werden soll. Wird dies bestaetigt, werden ueber ein Skript die Anpassungen umgehend wirksam gemacht. Die Konfigurationsdatei In der Konfigurationsdatei, die ueber das Menue zugaenglich ist, sind folgende Parameter vorhanden; wer sie von Hand editieren will findet sie unter /etc/config.d/owswitch. Die Parameter START_OWSWITCH Fuer die Aktivierung des owswitch-Paketes muss diese Variable lediglich auf den Wert `yes' gestellt werden. Die Einstellung 'no' deaktiviert das owswitch-Paket. Gueltige Werte: yes, no Standardeinstellung: START_OWSWITCH='no' OWSWITCH_SOURCE (Optionaler Parameter) Ueber diesen Parameter wird auf Wunsch festgelegt, welches Programm zum Abruf der 1-Wire-Sensordaten verwendet werden soll. Zur Auswahl stehen zur Zeit `owread' (Standard) fuer den lokalen Datenabruf und `owhttp' fuer den Datenabruf von einem entfernten Rechner mittels http-Protokoll. Gueltige Werte: owread, owhttp Standardeinstellung: OWSWITCH_SOURCE='' OWSWITCH_OWFS_HOSTNAME (Optionaler Parameter) Wurde ueber den Parameter [1]OWSWITCH_SOURCE als Datenquelle das Programm `owhttp' festgelegt, so wird ueber diesen Parameter der Hostname des entfernten Rechners festgelegt, von dem die 1-Wire-Sensordaten abgerufen werden sollen. Gueltige Werte: FQDN-Name eines Servers, IP-Adresse Standardeinstellung: OWSWITCH_OWFS_HOSTNAME='' OWSWITCH_OWFS_PORT (Optionaler Parameter) Wurde ueber den Parameter [2]OWSWITCH_SOURCE als Datenquelle das Programm `owhttp' festgelegt, so wird ueber diesen Parameter der TCP-Port des entfernten Rechners festgelegt, von dem die 1-Wire-Sensordaten abgerufen werden sollen. Standardmaessig wird sonst der Port 2121/tcp verwendet. Gueltige Werte: TCP-Port Standardeinstellung: OWSWITCH_OWFS_PORT='' OWSWITCH_N Ueber diesen Parameter wird die Anzahl der am 1-Wire-Bus angeschlossenen DS2413 PIO-Sensoren festgelegt. Gueltige Werte: Zahl Standardeinstellung: OWSWITCH_N='1' OWSWITCH_x_ID Ueber diesen Parameter wird die Sensor-ID eines am 1-Wire-Bus angeschlossenen DS2413 PIO-Sensors festgelegt/ausgewaehlt. Gueltige Werte: gueltige Sensor-ID Standardeinstellung: OWSWITCH_1_ID='3A.67C6697351FF' OWSWITCH_x_NAME (Optionaler Parameter) Ueber diesen Parameter kann einem 1-Wire-Sensor ein eindeutiger Name zugewiesen werden, ueber den er sich im owfs-Dateisystem einfacher identifizieren laesst. Wird kein Name vergeben, so laesst sich ein Sensor immer noch ueber dessen ID ansprechen. Beispiel: Parameter: OWSWITCH_1_NAME='Tueroeffner' Programmaufruf: owread Tueroeffner/type Gueltige Werte: eindeutiger Name ohne Umlaute Standardeinstellung: OWSWITCH_1_NAME='' OWSWITCH_x_ACTIVE Wird dieser Parameter auf den Wert 'yes' gesetzt, so wird dieser 1-Wire-Sensor aktiviert, 'no' deaktiviert ihn, sodass dessen Status nicht ueberwacht wird. Gueltige Werte: yes, no Standardeinstellung: OWSWITCH_1_ACTIVE='no' OWSWITCH_x_PIO_N Ueber diesen Parameter wird die Anzahl der PIO-Ports festgelegt, die von dem ausgewaehlten 1-Wire-Sensor unterstuetzt werden. Ein DS2413-Sensor unterstuetzt ueblicherweise insgesamt 2 PIO-Ports. Gueltige Werte: Zahl Standardeinstellung: OWSWITCH_1_PIO_N='2' OWSWITCH_x_PIO_y_NAME (Optionaler Parameter) Ueber diesen Parameter kann einem PIO-Port eines 1-Wire-Sensors ein Name zugewiesen werden, um diesen einfacher identifizieren zu koennen. Gueltige Werte: Text Standardeinstellung: OWSWITCH_1_PIO_1_NAME='' OWSWITCH_x_PIO_y_FUNC Ueber diesen Parameter stellt man die Funktion des PIO-Ports ein. Soll der PIO-Portstatus nicht aus dem OWFS-Cache gelesen werden, um schnelle Statuswechsel zu erkennen, so muss `input-uncached' bzw. `output-uncached' ausgewaehlt werden. Hinweis Standardmaessig wird der PIO-Portstatus aus dem OWFS-Cache gelesen um den 1-Wire-Bus nicht uebermaessig stark zu belasten. Das Lesen des ungepufferten Status sollte somit moeglichst vermieden werden. Folgende Werte koennen eingestellt werden: + none: Der PIO-Port wird nicht benutzt. + input: Der PIO-Port wird als Eingang verwendet. + input-uncached: Der PIO-Port wird als Eingang verwendet und der Status soll nicht aus dem Cache gelesen werden. + output: Der PIO-Port wird als Ausgang verwendet. + output-uncached: Der PIO-Port wird als Ausgang verwendet und der Status soll nicht aus dem Cache gelesen werden. Gueltige Werte: none, input, input-uncached, output, output-uncached Standardeinstellung: OWSWITCH_1_PIO_1_FUNC='input' OWSWITCH_x_PIO_y_INPUT_DEFAULT Ueber diesen Parameter wird der Standardwert fuer einen PIO-Port, welcher als Eingang (input) konfiguriert wurde, festgelegt werden. + 0: Kontakt geschlossen. + 1: Kontakt geoeffnet. Gueltige Werte: 0, 1 Standardeinstellung: OWSWITCH_1_PIO_1_INPUT_DEFAULT='0' OWSWITCH_x_PIO_y_ON_EXEC_ACTIVE Wird dieser Parameter auf den Wert 'yes' gesetzt, so wird der ueber den Parameter [3]OWSWITCH_x_PIO_y_ON_EXEC festgelegt Befehl ausgefuehrt, sobald sich der Status des PIO-Ports auf `1' aendert (0->1). Gueltige Werte: yes, no Standardeinstellung: OWSWITCH_1_PIO_1_ON_EXEC_ACTIVE='no' OWSWITCH_x_PIO_y_ON_EXEC Ueber diesen Parameter wird der Befehl festgelegt, welcher ausgefuehrt wird sobald sich der Status des PIO-Ports auf `1' aendert (0->1). Gueltige Werte: gueltiger Shell-Befehl Standardeinstellung: OWSWITCH_1_PIO_1_ON_EXEC='' OWSWITCH_x_PIO_y_OFF_EXEC_ACTIVE Wird dieser Parameter auf den Wert 'yes' gesetzt, so wird der ueber den Parameter [4]OWSWITCH_x_PIO_y_OFF_EXEC festgelegt Befehl ausgefuehrt, sobald sich der Status des PIO-Ports auf `0' aendert (1->0). Gueltige Werte: yes, no Standardeinstellung: OWSWITCH_1_PIO_1_OFF_EXEC_ACTIVE='no' OWSWITCH_x_PIO_y_OFF_EXEC Ueber diesen Parameter wird der Befehl festgelegt, welcher ausgefuehrt wird sobald sich der Status des PIO-Ports auf `0' aendert (1->0). Gueltige Werte: gueltiger Shell-Befehl Standardeinstellung: OWSWITCH_1_PIO_1_OFF_EXEC='' Verschiedenes Setzen eines PIO-Ausgangs Hat man den PIO-Port eines 1-Wire-Moduls als Ausgang (output) konfiguriert, so kann man dessen Status ueber das Kommandozeilenskript `owswitch-set-output' abfragen und setzen. Das Skript kann dabei in unterschiedlicher Weise aufgerufen werden. Wird es z.B. ohne weitere Optionen aufgerufen, so werden alle 1-Wire Module die mindestens einen PIO-Port als Ausgang konfiguriert haben angezeigt. Die Ausgaenge werden dabei durch ein FUNC:out kenntlich gemacht. Der Status wird dabei als STATUS:0|1 ausgegeben. Bei eine, DS2413 1-Wire Modul entsprechend z.B. die PIO-Stati folgenden Schaltzustaenden: + 0: ON, geschlossener Kontakt. + 1: OFF, geoeffneter Kontakt Beispiel: /usr/bin/owswitch-set-output OWFS server has been enabled ... checking sensor stati ... - all sensors reachable. - all available sensors configured. sensor status/stati: ID:3A.3CF813000000 PIO:1 FUNC:in DEF:0 STATUS:0 (on) PIO:2 FUNC:out DEF:o STATUS:1 (off) Soll der Ausgang 2 (PIO-Port) des Moduls mit der ID `3A.3CF813000000' auf `1' (on) gesetzt werden, so kann man dies durch folgenden Befehl veranlassen: Beispiel: /usr/bin/owswitch-set-output --seton 3A.3CF813000000:2 OWFS server has been enabled ... checking sensor stati ... - all sensors reachable. - all available sensors configured. set sensor status ... - ID:3A.3CF813000000 PIO:2 STATUS:0 (on) status changed 0->1 Soll der Ausgang 2 (PIO-Port) des Moduls mit der ID `3A.3CF813000000' auf `0' (off) gesetzt werden, so kann man dies durch folgenden Befehl veranlassen: Beispiel: /usr/bin/owswitch-set-output --setoff 3A.3CF813000000:2 OWFS server has been enabled ... checking sensor stati ... - all sensors reachable. - all available sensors configured. set sensor status ... - ID:3A.3CF813000000 PIO:2 STATUS:1 (off) status changed 1->0 Soll der Ausgang 2 (PIO-Port) des Moduls mit der ID `3A.3CF813000000' umgeschaltet werden, d.h. wenn dessen aktueller Status `0' (off) ist, soll er auf `1' (on), bzw. wenn dessen aktueller Status `1' (on) ist, soll dieser auf `0' (off) gesetzt werden, so kann man dies durch folgenden Befehl bewerkstelligen: Beispiel: /usr/bin/owswitch-set-output --toggle 3A.3CF813000000:2 OWFS server has been enabled ... checking sensor stati ... - all sensors reachable. - all available sensors configured. set sensor status ... - ID:3A.3CF813000000 PIO:2 STATUS:1 (off) status changed 1->0 Sollen mehrere Ausgaenge (PIO-Ports) eines Modules mit einem Programmaufruf gesetzt werden, so fuegt man diese, getrennt durch einen Doppelpunkt, aneinander. Beispiel: /usr/bin/owswitch-set-output --toggle 3A.3CF813000000:1:2 Sollen mehrere Ausgaenge (PIO-Ports) unterschiedlicher Module mit einem Programmaufruf gesetzt werden, so fuegt man diese, getrennt durch ein Leerzeichen, aneinander und setzt diese zusaetzlich in Hochkomma. Beispiel: /usr/bin/owswitch-set-output --toggle "3A.3CF813000000:1 3A.3BB813000000:1" Will man die Bildschirmausgabe unterdruecken, so reicht es dem Befehl ein -quiet voran zu stellen. __________________________________________________________________ Juergen Edner 2016-07-17