From 2567115affa124f0e392cbc35a91d7c07ada163d Mon Sep 17 00:00:00 2001 From: Sunnyka <71286632+Sunnyka98@users.noreply.github.com> Date: Wed, 19 Apr 2023 16:12:59 +0200 Subject: [PATCH 1/3] migrate tests to v10 --- tests/phpunit.xml | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/tests/phpunit.xml b/tests/phpunit.xml index d326dd8..fd56424 100644 --- a/tests/phpunit.xml +++ b/tests/phpunit.xml @@ -1,11 +1,12 @@ - - - - - - - ../Treppenhauslichtsteuerung - - - \ No newline at end of file + + + + + + + + ../Treppenhauslichtsteuerung + + + From b9572f331ab1568e60b046effd1dccb36ae11b26 Mon Sep 17 00:00:00 2001 From: Sunnyka <71286632+Sunnyka98@users.noreply.github.com> Date: Wed, 19 Apr 2023 16:13:14 +0200 Subject: [PATCH 2/3] reference documentation to site --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 89a4b6b..d0aabd5 100644 --- a/README.md +++ b/README.md @@ -6,5 +6,5 @@ Folgende Module beinhaltet das Treppenhauslichtsteuerung Repository: -- __Treppenhauslichtsteuerung__ ([Dokumentation](Treppenhauslichtsteuerung)) +- __Treppenhauslichtsteuerung__ ([Dokumentation](https://www.symcon.de/de/service/dokumentation/modulreferenz/treppenhauslichtsteuerung)) Beim Aktivieren wird das Licht im Treppenhaus eingeschaltet und wird kurz nach Verlassen des Treppenhauses wieder ausgeschaltet. From 1988967cc8168a1172c914516e5a971a6304c0da Mon Sep 17 00:00:00 2001 From: Sunnyka <71286632+Sunnyka98@users.noreply.github.com> Date: Wed, 20 Sep 2023 10:52:15 +0200 Subject: [PATCH 3/3] redirect readme --- Treppenhauslichtsteuerung/README.md | 101 +--------------------------- 1 file changed, 2 insertions(+), 99 deletions(-) diff --git a/Treppenhauslichtsteuerung/README.md b/Treppenhauslichtsteuerung/README.md index 0ffbcc8..b1f3ae2 100644 --- a/Treppenhauslichtsteuerung/README.md +++ b/Treppenhauslichtsteuerung/README.md @@ -1,101 +1,4 @@ # Treppenhauslichtsteuerung -Nachdem ein Auslöser aktiviert wird, geht das Licht im Treppenhaus an. Wird der Auslöser wiederholt aktiviert bleibt das Licht an und der Timer wird zurückgesetzt. Erst wenn für eine vorgegebene Zeit keine weitere Auslösung stattfindet wird das Licht ausgeschaltet. +[Link zur deutschen Dokumentation](https://www.symcon.de/de/service/dokumentation/modulreferenz/treppenhauslichtsteuerung/) - -### Inhaltsverzeichnis - -1. [Funktionsumfang](#1-funktionsumfang) -2. [Voraussetzungen](#2-voraussetzungen) -3. [Software-Installation](#3-software-installation) -4. [Einrichten der Instanzen in IP-Symcon](#4-einrichten-der-instanzen-in-ip-symcon) -5. [Statusvariablen und Profile](#5-statusvariablen-und-profile) -6. [WebFront](#6-webfront) -7. [PHP-Befehlsreferenz](#7-php-befehlsreferenz) - -### 1. Funktionsumfang - -* Auswahl von Ein- und Ausgabevariablen in einer Liste. -* Auswahl der Dauer bevor das Licht ausgeschaltet wird. -* Angabe der Helligkeit in Abhängigkeit einer Nacht-Modus Variable -* .Reversed Profile werden sowohl für Ein- als auch Ausgabevariablen unterstützt -* Möglichkeit die verbleibende Zeit bis zum Auschalten anzuzeigen. - -### 2. Voraussetzungen - -- IP-Symcon ab Version 5.0 - -### 3. Software-Installation - -* Über den Module Store das Modul Treppenhauslichtsteuerung installieren. -* Alternativ über das Module Control folgende URL hinzufügen: -`https://github.com/symcon/Treppenhauslichtsteuerung` - -### 4. Einrichten der Instanzen in IP-Symcon - -- Unter "Instanz hinzufügen" kann das 'Treppenhauslicht'-Modul mithilfe des Schnellfilters gefunden werden. - - Weitere Informationen zum Hinzufügen von Instanzen in der [Dokumentation der Instanzen](https://www.symcon.de/service/dokumentation/konzepte/instanzen/#Instanz_hinzufügen) - -__Konfigurationsseite__: - -Name | Beschreibung -------------------------------- | --------------------------------- -Eingabesensoren | Liste der Eingabesensoren, bei deren Aktivierung das Licht aktiviert werden soll, z.B. Bewegungssensoren oder Taster - Das Licht wird aktiviert sobald eine Variable auf aktiv gesetzt wird. Als aktiv gelten hierbei Variablen mit einem Wert, der nicht false, 0, oder "" ist. Sollte die Variable ein .Reversed Profil haben gelten die genannten Werte als aktiv. -Ausgabevariablen | Liste der Variablen, welche aktiv, also auf ihren Maximalwert geschaltet werden und das Licht darstellen. Sollte eine Variable ein .Reversed Profil haben wird diese auf den Minimalwert geschaltet. Variablen des Typs String werden nicht geschaltet. Die Variablen werden akiv geschaltet, wenn ein Sensor aus der Eingabesensor Liste ausgelöst wird. -Dauer | Nachdem die ausgewählte Dauer ohne weitere Auslösung eines Eingabesensors vergeht, wird das Licht deaktiviert. -Aktion erneut senden | Wenn ein unzuverlässiges Funk-System verwendet wird, so ist es ggf. erforderlich bei jedem Impuls die Aktion zu senden. Im Normalfall sollte diese Option deaktiviert bleiben, da ständiges senden der Aktion bei Funk-Aktoren ggf. den Duty-Cycle aufbrauchen kann. -Restlaufzeit anzeigen | Wenn aktiv wird die verbleibende Zeit bis zum Ausschalten in einer Variable angezeigt. -Aktualisierungsintervall | Das Intervall, in dem die "Restzeit" Variable aktualisiert wird. -Nacht-/Tag-Modus | Ermöglicht es die gewählten Variablen basiernd auf der Tageszeit, oder der Umgebungshelligkeit auf unterschiedliche Werte zu schalten - -__Nacht-/Tag-Modus - Nacht-/Tag Varaible__ -Name | Beschreibung --------------------------| --------------------------------- -Tag/Nacht | Eine Variable, die angibt ob Nacht oder Tag ist. -Invertiert | Gibt an, ob der Wert der Nacht-Modus Variable invertiert werden soll. Dies ist notwendig, wenn die Ist-Tag Variable von der Location Instanz verwendet werden soll. Diese ist nämlich FALSE, wenn es Dunkel ist. -Helligkeit (Nacht-Modus) | Gibt die Helligkeit in Prozent an, die Nachts geschaltet werden soll. -Helligkeit (Tag-Modus) | Gibt die Helligkeit in Prozent an, auf die am Tag geschaltet werden soll. - -__Nacht-/Tag-Modus - Umgebungshelligkeitsvariable__ -Name | Beschreibung ----------------------------- | --------------------------------- -Umgebungshelligkeit | Die Variable, die als Umgebungshelligkeit genutzt wird. -Umgebungshelligkeitsschwelle | Der Grenzwert, bei dem zwischen den Werten für Tag und Nacht gewechselt wird. -Helligkeit (Nacht-Modus) | Gibt die Helligkeit in Prozent an, die bei Unterschreitung der Helligkeit geschaltet werden soll. -Helligkeit (Tag-Modus) | Gibt die Helligkeit in Prozent an, die bei Überschreitung der Helligkeit geschaltet werden soll. - -### 5. Statusvariablen und Profile - -##### Statusvariablen - -Name | Typ | Beschreibung --------------------------- | ------- | --------------------------- -Treppenhaussteuerung aktiv | Boolean | Die Variable gibt an, ob die Treppenhaussteuerung aktiviert ist -Restzeit | String | Wenn "Restlaufzeit anzeigen" aktiv ist wird hier die verbleibende Zeit bis zum Auschalten angezeigt - -##### Profile: - -Es werden keine zusätzlichen Profile hinzugefügt. - -### 6. WebFront - -Über das WebFront werden keine zusätzlichen Informationen angezeigt. - -### 7. PHP-Befehlsreferenz - -`boolean THL_Start(integer $InstanzID);` -Aktiviert das Licht im Treppenhaus und startet den Timer, welcher das Licht wieder deaktiviert. Bei wiederholtem Aufruf wird der Timer zurückgesetzt. - -Beispiel: -`THL_Start(12345);` - -`boolean THL_Stop(integer $InstanzID);` -Deaktiviert das Licht im Treppenhaus und den Timer. - -Beispiel: -`THL_Stop(12345);` - -`boolean THL_SetActive(integer $InstanzID, boolean $Wert);` -Aktiviert oder deaktiviert die Treppenhauslichtsteuerung. Wurde das Treppenhauslicht durch die Steuerung eingeschaltet und die Steuerung wird deaktiviert, so wird der aktuelle Steuervorgang noch zu Ende geführt. Allerdings wird der Timer bei erneutem Auslösen des Eingabesensors nicht zurückgesetzt. Das Treppenhauslicht wird also trotz deaktivierter Steuerung nach Ablauf des Timers ausgeschaltet. - -Beispiel: -`THL_SetActive(12345, true);` +[Link to the english documentation](https://www.symcon.de/en/service/documentation/module-reference/staircase-light-controls/) \ No newline at end of file