-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
39 changed files
with
2,119 additions
and
725 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| # Abfall.ICS | ||
|
|
||
| [](https://www.symcon.de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/) | ||
| [](https://www.symcon.de/produkt/) | ||
| [](https://github.com/Wilkware/WasteManagement) | ||
| [](https://creativecommons.org/licenses/by-nc-sa/4.0/) | ||
| [](https://github.com/Wilkware/WasteManagement/actions) | ||
|
|
||
| IP-Symcon Modul für die Visualisierung von Entsorgungsterminen. | ||
|
|
||
| ## Inhaltverzeichnis | ||
|
|
||
| 1. [Funktionsumfang](#user-content-1-funktionsumfang) | ||
| 2. [Voraussetzungen](#user-content-2-voraussetzungen) | ||
| 3. [Installation](#user-content-3-installation) | ||
| 4. [Einrichten der Instanzen in IP-Symcon](#user-content-4-einrichten-der-instanzen-in-ip-symcon) | ||
| 5. [Statusvariablen und Profile](#user-content-5-statusvariablen-und-profile) | ||
| 6. [WebFront](#user-content-6-webfront) | ||
| 7. [PHP-Befehlsreferenz](#user-content-7-php-befehlsreferenz) | ||
| 8. [Versionshistorie](#user-content-8-versionshistorie) | ||
|
|
||
| ### 1. Funktionsumfang | ||
|
|
||
| Das Modul bietet einen generischen Abfallkalender mittels der Bereitstellung einer iCalendar Datei (ICS). | ||
|
|
||
| ### 2. Voraussetzungen | ||
|
|
||
| * IP-Symcon ab Version 6.4 | ||
|
|
||
| ### 3. Installation | ||
|
|
||
| * Über den Modul Store das Modul Abfallwirtschaft (ehem. Awido) installieren. | ||
| * Alternativ Über das Modul-Control folgende URL hinzufügen. | ||
| `https://github.com/Wilkware/WasteManagement` oder `git://github.com/Wilkware/WasteManagement.git` | ||
|
|
||
| ### 4. Einrichten der Instanzen in IP-Symcon | ||
|
|
||
| * Unter "Instanz hinzufügen" ist das _'Waste_ICS'_-Modul (Alias: _'Abfallwirtschaft (Abfall_ICS)'_ oder _'Entsorgungskalender (Abfall_ICS)'_) unter dem Hersteller _'(Geräte)'_ aufgeführt. | ||
|
|
||
| __Konfigurationsseite__: | ||
|
|
||
| Entsprechend der gewählten Auswahl verändert sich das Formular dynamisch. | ||
| Eine komplette Neuauswahl erreicht man durch Auswahl "Bitte wählen ..." an der gewünschten Stelle. | ||
|
|
||
| VORSTICHT: eine Änderung der Auswahl bedingt ein Update bzw. ein Neuanlegen der Statusvariablen!!! | ||
| Alte Variablen, welche es im anderen Landkreis gab werden nicht gelöscht! Hat man diese in einem WF verlinkt muss man danach | ||
| selber aufräumen. Ich denke aber mal das ein Umzug nicht so häufig vorkommt ;-) | ||
|
|
||
| _Einstellungsbereich:_ | ||
|
|
||
| > Online Dienste ... | ||
| Name | Beschreibung | ||
| ----------------------- | ---------------------------------- | ||
| Anbieter | 'Abfall.IO (abfallplus.de)' | ||
|
|
||
| > Abfallwirtschaft ... | ||
| Name | Beschreibung | ||
| ----------------------- | --------------------------------- | ||
| Entsorgungsgebiet | Liste der verfügbaren Gebiete (siehe oben) | ||
| Stadt/Gemeinde | Ort im Entsorgungsgebiet (kann identisch zum Gebiet sein) | ||
| Stadt-/Ortsteil | In einigen Gegend zusätzliche Gebietseinschränkung | ||
| Straße/Abfuhrbezirk | Strasse bzw. Abfuhrbezirk im gewählten Ort | ||
| Hausnummer | Hausnummer von-bis, oder Alle = gesamte Strasse | ||
| Entsorgungen | Entsorgungsarten, d.h. was wird im Gebiet an Entsorgung angeboten | ||
|
|
||
| > Visualisierung ... | ||
| Name | Beschreibung | ||
| --------------------------------------------- | --------------------------------- | ||
| Unterstützung für Tile Visu aktivieren? | Aktivierung, ob HTML für Kacheldarstellung erstellt werden soll | ||
| Abfallgruppen | Farbliche Zuordnung der Abfallarten | ||
|
|
||
| > Erweiterte Einstellungen ... | ||
| Name | Beschreibung | ||
| ------------------------------------------------------- | --------------------------------- | ||
| Tägliche Aktualisierung aktivieren? | Status, ob das tägliche Update aktiv oder inaktiv ist | ||
| Variablen für nicht ausgewählte Entsorgungen erstellen? | Status, ob für nicht genutzte Entsorgungen auch Variablen angelegt werden sollen, standardmäßig nein | ||
| Skript | Skript, welches nach dem Update der Termine ausgeführt wird, z.B. für Sortierung usw. | ||
|
|
||
| _Aktionsbereich:_ | ||
|
|
||
| Aktion | Beschreibung | ||
| ----------------------- | --------------------------------- | ||
| AKTUALISEREN | Werte werden neu ermittelt und geschrieben | ||
|
|
||
| ### 5. Statusvariablen und Profile | ||
|
|
||
| Die Statusvariablen/Timer werden automatisch angelegt. Das Löschen einzelner kann zu Fehlfunktionen führen. | ||
|
|
||
| Name | Typ | Beschreibung | ||
| -------------------| --------- | ---------------- | ||
| Entsorgungsart(en) | String | Abhängig vom Entsorgungsgebiet und den angebotenem Service mehrere Variablen, z.B.: Restmüll, Biotonne usw. | ||
|
|
||
| Es werden keine zusätzlichen Profile benötigt. | ||
|
|
||
| ### 6. WebFront | ||
|
|
||
| Man kann die Statusvariablen(Strings) direkt im WF verlinken. | ||
| Aber wie bei der Konfiguration beschrieben, muss man aufpassen wenn die Konfiguration geändert wird. Dann müssen gegebenenfalls die Links neu eingerichtet werden. | ||
|
|
||
| ### 7. PHP-Befehlsreferenz | ||
|
|
||
| ```php | ||
| void WMICS_Update(int $InstanzID); | ||
| ``` | ||
|
|
||
| Holt die nächsten anstehenden Entsorgungstermine für die gewählten Entsorgungsarten. | ||
| Die Funktion liefert keinerlei Rückgabewert. | ||
|
|
||
| __Beispiel__: `WMICS_Update(12345);` | ||
|
|
||
|
|
||
| ### 8. Versionshistorie | ||
|
|
||
| v1.0.20240304 | ||
|
|
||
| * _NEU_: Initialversion | ||
|
|
||
| ## Entwickler | ||
|
|
||
| Seit nunmehr über 10 Jahren fasziniert mich das Thema Haussteuerung. In den letzten Jahren betätige ich mich auch intensiv in der IP-Symcon Community und steuere dort verschiedenste Skript und Module bei. Ihr findet mich dort unter dem Namen @pitti ;-) | ||
|
|
||
| [](https://wilkware.github.io/) | ||
|
|
||
| ## Spenden | ||
|
|
||
| Die Software ist für die nicht kommerzielle Nutzung kostenlos, über eine Spende bei Gefallen des Moduls würde ich mich freuen. | ||
|
|
||
| [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=8816166) | ||
|
|
||
| ## Lizenz | ||
|
|
||
| Namensnennung - Nicht-kommerziell - Weitergabe unter gleichen Bedingungen 4.0 International | ||
|
|
||
| [](https://creativecommons.org/licenses/by-nc-sa/4.0/) |
Oops, something went wrong.