Skip to content

Commit

Permalink
Merge pull request #11 from symcon/fixes/migrate-test
Browse files Browse the repository at this point in the history
Migration der Tests auf phpUnit v10
  • Loading branch information
Sunnyka98 committed Sep 19, 2023
2 parents fd5455c + e36a329 commit 32d05b1
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 87 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
77 changes: 2 additions & 75 deletions EgiGeoZone/README.md
Original file line number Diff line number Diff line change
@@ -1,79 +1,6 @@
# EgiGeoZone
Das Modul dient zum empfangen von EgiGeoZone Daten.

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

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)
8. [Anhang](#8-anhang)
[Link to the english documentation](https://www.symcon.de/en/service/documentation/module-reference/egigeozone/)


### 1. Funktionsumfang

* Pro Gerät eine eigene Standortliste
* Benutzername und Passwort Identifikation innerhalb von IP-Symcon.
* Richtet automatisch den Webhook "/hook/egigeozone" ein.
* Es wird empfohlen dies in Kombination mit dem Connect Modul zu nutzen.

![](EgiGeoZone-InAppConfig.png)

### 2. Voraussetzungen

- IP-Symcon ab Version 4.2
- EgiGeoZone App für Google Android

### 3. Software-Installation

* Über den Module Store das Modul EgiGeoZone installieren.
* Alternativ über das Module Control folgende URL hinzufügen:
`https://github.com/symcon/EgiGeoZone`

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

- Unter "Instanz hinzufügen" kann das 'EgiGeoZone'-Modul mithilfe der Schnellsuche 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
------------ | ---------------------------------
Benutzername | Benutzername, welcher in der EgiGeoZone App angegeben werden muss, um IP-Symcon Daten schicken zu können.
Passwort | Passwort, welches in der EgiGeoZone App angeben werden muss.

_Werden diese Daten Leer gelassen kann jeder über den Hook Daten an IP-Symcon schicken._

### 5. Statusvariablen und Profile

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

##### Statusvariablen
Die Variablen werden anhand der Geräte ID und beim erstmaligen senden innerhalb des EgiGeoZone Moduls automatisch angelegt. Es können mehrere Geräte über einen Hook laufen. Jedes Gerät wird unter seiner eigenen "Kategorie" eingerichtet.

Name | Typ | Beschreibung
------------------------------ | --------------- | ----------------
Gerätename | Instanz (Dummy) | Dient als "Kategorie" in der sich alle überwachten Standorte, sowie der Zeitstempel und Längen-/Breitengrad befinden. Wird pro Gerät erstellt.
Latitude | Float | Breitengrad der letzten Aktivität.
Longitude | Float | Längengrad der letzten Aktivität.
Timestamp | Integer | UnixTimestamp der letzten Aktivität.
Beispielstandort (GeoZoneTest) | Boolean | Present oder Absent. Information wird von Gefency geliefert.

Beispiel:
![](EgiGeoZone-Variablen.png)

##### Profile:

Es werden keine zusätzlichen Profile hinzugefügt.

### 6. WebFront

Es gibt keine native Darstellung via WebFront oder in den mobilen Apps.
Geräte und Variablen, welche angezeigt werden sollen, können via Link angezeigt werden.

### 7. PHP-Befehlsreferenz

Es sind keine PHP-Skriptbefehle vorhanden.
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 EgiGeoZone Repository:

- __EgiGeoZone__ ([Dokumentation](EgiGeoZone))
- __EgiGeoZone__ ([Dokumentation](https://www.symcon.de/de/service/dokumentation/modulreferenz/egigeozone))
Empfängt Daten von der EgiGeoZone App für Google Android.
23 changes: 12 additions & 11 deletions tests/phpunit.xml
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit>
<php>
<const name="PHPUNIT_TESTSUITE" value="true"/>
</php>
<filter>
<whitelist processUncoveredFilesFromWhitelist="true">
<directory suffix=".php">../EgiGeoZone</directory>
<directory suffix=".php">..libs</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">../EgiGeoZone</directory>
<directory suffix=".php">..libs</directory>
</include>
</source>
</phpunit>

0 comments on commit 32d05b1

Please sign in to comment.