Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migration der Tests auf phpUnit v10 #14

Merged
merged 3 commits into from
Sep 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.DS_Store
.idea/
.phpunit.*
.php_cs.cache
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 ZaehlerUeberlauf Repository:

- __Zähler-Überlauf__ ([Dokumentation](ZaehlerUeberlauf))
- __Zähler-Überlauf__ ([Dokumentation](https://www.symcon.de/de/service/dokumentation/modulreferenz/zaehlerueberlauf))
Zähler, welche überlaufen können als Zähler dargestellt werden.
60 changes: 2 additions & 58 deletions ZaehlerUeberlauf/README.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,4 @@
# Zählerüberlauf
Das Modul stellt überlaufende Zähler als kontinuierliche Zähler dar.
[Link zur deutschen Dokumentation](https://www.symcon.de/de/service/dokumentation/modulreferenz/zaehlerueberlauf/)

### 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

* Berechnet den Gesamtwert einer Variable und zählt diese hoch, obwohl das Gerät einen Überlauf hat.

### 2. Voraussetzungen

- IP-Symcon ab Version 4.2

### 3. Software-Installation

* Über den Module Store das Modul Zähler-Überlauf installieren.
* Alternativ über das Module Control folgende URL hinzufügen:
`https://github.com/symcon/ZaehlerUeberlauf`

### 4. Einrichten der Instanzen in IP-Symcon

- Unter "Instanz hinzufügen" kann das 'Zählerüberlauf'-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
----------- | ---------------------------------
Quelle | Quellvariable, welche für die Berechnung genutzt werden soll.
Maximalwert | Ab welchem Wert ein Überlauf stattfindet. Der maximale Wert, welcher das Gerät zählt.

### 5. Statusvariablen und Profile

Die Statusvariablen/Kategorien werden automatisch angelegt. Das Löschen einzelner kann zu Fehlfunktionen führen.

##### Statusvariablen

Name | Typ | Beschreibung
------- | ----- | ----------------
Zähler | Float | Fortlaufend hochzählender Wert.

##### Profile:

Es werden keine zusätzlichen Profile hinzugefügt.

### 6. WebFront

Über das WebFront wird die Variable angezeigt. Es ist keine weitere Steuerung oder gesonderte Darstellung integriert.

### 7. PHP-Befehlsreferenz

Es sind keine besonderen Funktionen vorhanden.
[Link to the english documentation](https://www.symcon.de/en/service/documentation/module-reference/meter-overflow/)
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">../ZaeherUeberlauf</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">../ZaeherUeberlauf</directory>
</include>
</source>
</phpunit>