Skip to content

Commit

Permalink
Merge pull request #12 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 authored Sep 20, 2023
2 parents f7f27d5 + f9a90bf commit 9e6d123
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 72 deletions.
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 ZaehlerstandTag Repository:

- __Zählerstand (Tag)__ ([Dokumentation](ZaehlerstandTag))
- __Zählerstand (Tag)__ ([Dokumentation](https://www.symcon.de/de/service/dokumentation/modulreferenz/zaehlerstand-tag))
Für ein ausgewähltes Datum kann der Zählerstand angezeigt werden
63 changes: 2 additions & 61 deletions ZaehlerstandTag/README.md
Original file line number Diff line number Diff line change
@@ -1,64 +1,5 @@
# Zählerstand (Tag)
Das Modul erlaubt die Auswahl eines Datums und zeigt dann den jeweiligen (Ersten/Letzten) Zählerwert dieses Tages an.

### Inhaltsverzeichnis
[Link zur deutschen Dokumentation](https://www.symcon.de/de/service/dokumentation/modulreferenz/zaehlerstand-tag/)

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

* Bei Änderung des Datums wird je nach Wert-Auswahl der Erste/Letzte gelesene Zählerwert der geloggten Variable ausgegeben.

### 2. Voraussetzungen

- IP-Symcon ab Version 4.2

### 3. Software-Installation

* Über den Module Store das Modul Zählerstand (Tag) installieren.
* Alternativ über das Module Control folgende URL hinzufügen:
`https://github.com/symcon/ZaehlerstandTag`

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

- Unter "Instanz hinzufügen" kann das 'Zählerstand (Tag)'-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 als Datenquelle genutzt werden soll.
Wert | Erster/Letzter Wert des Tages.

### 5. Statusvariablen und Profile

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

##### Statusvariablen

Name | Typ | Beschreibung
----------- | ------------- | ----------------
Zählerstand | Integer/Float | Wert für das ausgewählte Datum.

##### Profile:

Es werden keine zusätzlichen Profile hinzugefügt.

### 6. WebFront

Über das WebFront wird die Variable angezeigt. Es kann ein Datum gewählt werden für das der Zählerstand (jeweils der Erste/Letzte des Tages) angezeigt wird.

### 7. PHP-Befehlsreferenz

`boolean ZST_Calculate(integer $InstanzID);`
Ermittelt den Wert für das gewählte Datum neu.
Die Funktion liefert keinerlei Rückgabewert.
Beispiel:
`ZST_Calculate(12345);`
[Link to the english documentation](https://www.symcon.de/en/service/documentation/module-reference/reading-day/)
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">../ZaehlerstandTag</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">../ZaehlerstandTag</directory>
</include>
</source>
</phpunit>

0 comments on commit 9e6d123

Please sign in to comment.