ABFALL: Unterschied zwischen den Versionen

Aus FHEMWiki
(added example for doif)
K (Modultyp korrigiert; verschiedene kleine Korrekturen; Intra-Wiki Links nur bei erstmaligem Auftreten)
Zeile 1: Zeile 1:
{{Infobox Modul
{{Infobox Modul
|ModPurpose=Legt ein Device an, das alle Termine aus einem [[Calendar]] in Readings übernimmt, welche speziell für das Thema Abfallkalender ausgelegt sind.
|ModPurpose=Filtern von (Abfall-)Terminen aus einem Calendar.
|ModType=d
|ModType=x
|ModFTopic=48237
|ModFTopic=48237
|ModForumArea=Codeschnipsel
|ModForumArea=Codeschnipsel
Zeile 8: Zeile 8:
}}
}}


[[ABFALL]] ist ein Hilfsmodul, das alle Termine aus einem bestehenden Kalender des Moduls [[Calendar]] in Readings übernimmt.  
[[ABFALL]] ist ein (inoffizielles, nicht Bestandteil der Distribution) Hilfsmodul, das bestimmte Termine aus einem bestehenden Kalender des Moduls [[Calendar]] in Readings übernimmt.  


== Voraussetzungen ==
== Voraussetzungen ==
Es muss ein [[Calendar]]-Objekt definiert sein. Der dabei benutzte Name muss in der Definition des ABFALL-Objekts spezifiziert werden.
Es muss ein Calendar-Objekt definiert sein. Der dabei benutzte Name muss in der Definition des ABFALL-Objekts spezifiziert werden.
Es können auch mehrere [[Calendar]] Objekte übergeben werden.
Es können auch mehrere Calendar Objekte übergeben werden.


Sonderzeichen aus dem Namen der Termine, werden entfernt um die Name der generierten Readings FHEM tauglich zu machen, für die Werte der Readings bleiben diese allerdings erhalten.
Sonderzeichen aus dem Namen der Termine, werden entfernt um die Namen der generierten Readings FHEM tauglich zu machen, für die Werte der Readings bleiben diese allerdings erhalten.


== Anwendung ==
== Anwendung ==
=== Installation ===
=== Installation ===
Mit folgenden Befehl kann das Modul direkt in den Standard FHEM Update Prozess eingeklinkt werden.
Mit folgendem Befehl kann das Modul direkt in den Standard FHEM Update Prozess eingeklinkt werden.
:<code>update add https://raw.githubusercontent.com/uniqueck/fhem-abfall/master/controls_fhemabfall.txt</code>
:<code>update add https://raw.githubusercontent.com/uniqueck/fhem-abfall/master/controls_fhemabfall.txt</code>
Um es nur zu installieren, kann auch einfach nur das Command
Um es nur zu installieren, kann auch einfach nur das Command
:<code>update all https://raw.githubusercontent.com/uniqueck/fhem-abfall/master/controls_fhemabfall.txt</code>
:<code>update all https://raw.githubusercontent.com/uniqueck/fhem-abfall/master/controls_fhemabfall.txt</code>
eingegeben werden.
eingegeben werden.
=== Entwicklungsstrang ===
=== Entwicklungsstrang ===
:<code>update add https://raw.githubusercontent.com/uniqueck/fhem-abfall/develop/controls_fhemabfall.txt</code>
:<code>update add https://raw.githubusercontent.com/uniqueck/fhem-abfall/develop/controls_fhemabfall.txt</code>
Zeile 39: Zeile 40:


=== Werte aktualisieren ===
=== Werte aktualisieren ===
Die Werte aktualisieren sich abhängig vom notify der entsprechenden [[Calendar]] Instanz, welche im define angegeben wurde(n).
Die Werte aktualisieren sich abhängig vom [[notify]] der entsprechenden Calendar Instanz, welche im define angegeben wurde(n).


=== Weitere Attribute ===
=== Weitere Attribute ===
Zeile 71: Zeile 72:
!align="right" |delimiter_text_reading
!align="right" |delimiter_text_reading
|
|
|Wenn zwei Abholungen an ein und demselben Tag existieren, da wird diese Trennzeichen genutzt um die beiden (oder mehrere) zu einem Text zu verbinden. Nur relevant für die Readings next_text und now_text
|Wenn zwei Abholungen an ein und demselben Tag existieren, wird dieses Trennzeichen genutzt, um die beiden (oder mehrere) Werte zu einem Text zu verbinden. Nur relevant für die Readings next_text und now_text
|und
|und
|-
|-
Zeile 81: Zeile 82:
!align="right" |filter
!align="right" |filter
|
|
|regex zum Filtern von den Namen der Termine aus den Kalendern, so dass nur solche genutzt werden, welche diesem Filter entsprechen
|regex zum Filtern der Namen der Termine aus den Kalendern, so dass nur solche genutzt werden, welche diesem Filter entsprechen
|
|
|-
|-
Zeile 93: Zeile 94:
           data-on-colors='["#000","#6EB54C"]'  
           data-on-colors='["#000","#6EB54C"]'  
           data-icons='["fa-trash-o","fa-trash-o"]'></div></pre>
           data-icons='["fa-trash-o","fa-trash-o"]'></div></pre>
=== Benachrichtigung ===
=== Benachrichtigung ===
==== DOIF ====
==== DOIF ====
Zeile 98: Zeile 100:
[Abfall:now_text] ne "") ( set fhemBot message Heute wird [Abfall:now_text] abgeholt)</pre>
[Abfall:now_text] ne "") ( set fhemBot message Heute wird [Abfall:now_text] abgeholt)</pre>


=== externe Links auf Artikel mit dem Abfall Modul ===
=== Links ===
[https://forum.fhem.de/index.php/topic,50177.0.html Abfall Visualisierung mit Bilderrahmen]
* Forenthema {{Link2Forum|Topic=50177|LinkText=Abfall Visualisierung mit Bilderrahmen}}

Version vom 18. Januar 2017, 08:59 Uhr

ABFALL
Zweck / Funktion
Filtern von (Abfall-)Terminen aus einem Calendar.
Allgemein
Typ Inoffiziell
Details
Dokumentation Thema
Support (Forum) Codeschnipsel
Modulname 57_ABFALL.pm
Ersteller Constantin / uniqueck
Wichtig: sofern vorhanden, gilt im Zweifel immer die (englische) Beschreibung in der commandref!


ABFALL ist ein (inoffizielles, nicht Bestandteil der Distribution) Hilfsmodul, das bestimmte Termine aus einem bestehenden Kalender des Moduls Calendar in Readings übernimmt.

Voraussetzungen

Es muss ein Calendar-Objekt definiert sein. Der dabei benutzte Name muss in der Definition des ABFALL-Objekts spezifiziert werden. Es können auch mehrere Calendar Objekte übergeben werden.

Sonderzeichen aus dem Namen der Termine, werden entfernt um die Namen der generierten Readings FHEM tauglich zu machen, für die Werte der Readings bleiben diese allerdings erhalten.

Anwendung

Installation

Mit folgendem Befehl kann das Modul direkt in den Standard FHEM Update Prozess eingeklinkt werden.

update add https://raw.githubusercontent.com/uniqueck/fhem-abfall/master/controls_fhemabfall.txt

Um es nur zu installieren, kann auch einfach nur das Command

update all https://raw.githubusercontent.com/uniqueck/fhem-abfall/master/controls_fhemabfall.txt

eingegeben werden.

Entwicklungsstrang

update add https://raw.githubusercontent.com/uniqueck/fhem-abfall/develop/controls_fhemabfall.txt

bzw.

update all https://raw.githubusercontent.com/uniqueck/fhem-abfall/develop/controls_fhemabfall.txt

Define

define <Name> ABFALL <calendarname>,<calendarname2>,...

Erläuterung der Parameter im define:

<calendarname>
Name des Calendar Kalenders

Beispiel:

define myAbfall ABFALL AbfallGoogleCalender

Werte aktualisieren

Die Werte aktualisieren sich abhängig vom notify der entsprechenden Calendar Instanz, welche im define angegeben wurde(n).

Weitere Attribute

Attribut Werteliste Beschreibung Default Wert
calendarname_praefix 0 und 1 soll der Kalendername als praefix dem Reading vorangestellt werden, sollte bei nur einem Kalender auf 0 gesetzt werden 1 - praefix wird vorangestellt
abfall_clear_reading_regex regex zum Entfernen von Anteilen aus dem Termin, dieser wird vor dem Entfernen von Sonderzeichen aus den Namen der Termine angewandt.
disable 0 und 1 deaktiviert das Modul 0
weekday_mapping Mapping, wie die Readings der Tage angezeigt werden sollen, zum Beispiel So Mo Di Mi Do Fr Sa Sonntag Montag Dienstag Mittwoch Donnerstag Freitag Samstag
delimiter_text_reading Wenn zwei Abholungen an ein und demselben Tag existieren, wird dieses Trennzeichen genutzt, um die beiden (oder mehrere) Werte zu einem Text zu verbinden. Nur relevant für die Readings next_text und now_text und
delimiter_reading wie attribute delimiter_text_reading, allerdings nur für die readings next und now
filter regex zum Filtern der Namen der Termine aus den Kalendern, so dass nur solche genutzt werden, welche diesem Filter entsprechen

Anwendungsbeispiel(e)

Einbindung ins Tablet UI

<div data-device="myABFALL" data-type="symbol" class="bigger warn wider" 
          data-get="next" data-get-warn=".*(\d+).*" 
          data-get-on='["Restmuell_.*","Wertstoff_.*"]'
          data-on-colors='["#000","#6EB54C"]' 
          data-icons='["fa-trash-o","fa-trash-o"]'></div>

Benachrichtigung

DOIF

[Abfall:next_tage] == 1) ( set fhemBot message Morgen wird [Abfall:next_text] abgeholt)
[Abfall:now_text] ne "") ( set fhemBot message Heute wird [Abfall:now_text] abgeholt)

Links

Abgerufen von „http://wiki.fhem.de/w/index.php?title=ABFALL&oldid=18546“