Skip to content

Commit

Permalink
Merge pull request #19 from symcon/fixes/migrate-tests
Browse files Browse the repository at this point in the history
Migration der Tests auf phpUnit v10
  • Loading branch information
Sunnyka98 committed Sep 20, 2023
2 parents 06c8b31 + 1988967 commit 162e20c
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 110 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
101 changes: 2 additions & 99 deletions Treppenhauslichtsteuerung/README.md
Original file line number Diff line number Diff line change
@@ -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/)
21 changes: 11 additions & 10 deletions tests/phpunit.xml
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit>
<php>
<const name="PHPUNIT_TESTSUITE" value="true"/>
</php>
<filter>
<whitelist processUncoveredFilesFromWhitelist="true">
<directory suffix=".php">../Treppenhauslichtsteuerung</directory>
</whitelist>
</filter>
</phpunit>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.1/phpunit.xsd" cacheDirectory=".phpunit.cache">
<coverage/>
<php>
<const name="PHPUNIT_TESTSUITE" value="true"/>
</php>
<source>
<include>
<directory suffix=".php">../Treppenhauslichtsteuerung</directory>
</include>
</source>
</phpunit>

0 comments on commit 162e20c

Please sign in to comment.