Skip to content

Commit

Permalink
redirect readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Sunnyka98 authored Sep 19, 2023
1 parent cc5b8a8 commit dc54396
Showing 1 changed file with 2 additions and 47 deletions.
49 changes: 2 additions & 47 deletions AnwesenheitsSimulation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,51 +23,6 @@ Ist auch innerhalb dieser 30 Tage kein gültiger Tagesdatensatz vorhanden, ist k

### 2. Voraussetzungen

- IP-Symcon ab Version 5.0
[Link zur deutschen Dokumentation](https://www.symcon.de/de/service/dokumentation/modulreferenz/anwesenheitssimulation/)

### 3. Software-Installation

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

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

- Unter "Instanz hinzufügen" kann das 'AnwesenheitsSimulation'-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)
- Alle zu schaltenden Variablen müssen der Variablen Liste in der Instanzkonfiguration hinzugefügt werden.

__Konfigurationsseite__:

Name | Beschreibung
------------- | ---------------------------------
Variablen | Eine Liste der Variablen, welche für die Simulation der Anwesenheit genuzt werden sollen. Die hinzugefügten Variablen benötigen eine Aktion und müssen geloggt sein.
Mindestanzahl | Dies beschreibt die durchschnittliche Mindestanzahl von Variablenschaltungen aller ausgewählten Variablen, die vorhanden sein müssen.

### 5. Statusvariablen und Profile

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

Name | Typ | Beschreibung
----------------------- | --------- | ----------------
Simulation aktiv | Boolean | Zeigt an ob ob die Simulation aktiviert ist oder nicht. True = Aktiviert; False = Deaktiviert;
Simulationsquelle (Tag) | String | Der String beinhaltet das Datum, nach dem die Simulationsdaten ausgewählt wurden.
Simulationsvorschau | String | Zeigt eine Tabelle welche eine Übersicht über die zukünftigen Schaltvorgänge gibt.

Es werden keine zusätzlichen Profile benötigt.

### 6. WebFront

Über das WebFront kann die Simulation de-/aktiviert werden.
Es wird zusätzlich die Information angezeigt, welcher Tag zur Simulation genutzt wird.
Falls nicht genügend oder ungültige Daten vorhanden sind, wird dieses ebenfalls hier angezeigt.
Es wird eine Liste mit allen ausgewählten Variablen angezeigt, welche den aktuellen und nächsten Wert, sowie die Uhrzeit der Schaltung beinhaltet.

### 7. PHP-Befehlsreferenz

`boolean AS_SetSimulation(integer $InstanzID, boolean $SetActive);`
$SetActive aktiviert (true) oder deaktiviert (false) die Anwesenheits-Simulation mit der InstanzID $InstanzID.
Die Funktion liefert keinerlei Rückgabewert.

Beispiel:
`AS_SetSimulation(12345, true);`
[Link to the english documentation](https://www.symcon.de/en/service/documentation/module-reference/presence-simulation/)

0 comments on commit dc54396

Please sign in to comment.