diff --git a/fhem/FHEM/10_RESIDENTS.pm b/fhem/FHEM/10_RESIDENTS.pm index 3ad03fa09..5b3fb9bc5 100644 --- a/fhem/FHEM/10_RESIDENTS.pm +++ b/fhem/FHEM/10_RESIDENTS.pm @@ -881,211 +881,349 @@ sub RESIDENTS_TimeDiff($$) { 1; =pod + =begin html - -

RESIDENTS

- + Set +
+ set <rgr_ResidentsName> <command> [<parameter>]
+
+ Currently, the following commands are defined.
+ +

+
+
+ Possible states and their meaning
+
+
+ This module differs between 7 states:
+
+
+
+ Note: State 'none' cannot explicitly be set. Setting state to 'gone' will be handled as 'none' for GUEST member devices. +
+

+
+ Attributes
+
+ +

+
+
+ Generated Readings/Events:
+
+ +
+ =end html =begin html_DE - -

RESIDENTS

- + Set +
+ set <rgr_ResidentsName> <command> [<parameter>]
+
+ Momentan sind die folgenden Kommandos definiert.
+ +

+
+
+ Mögliche Stati und ihre Bedeutung
+
+
+ Dieses Modul unterscheidet 7 verschiedene Stati:
+
+
+
+ Hinweis: Der Status 'none' kann nicht explizit gesetzt werden. Das setzen von 'gone' wird bei Mitgliedern vom Typ GUEST als 'none' behandelt. +
+

+
+ Attribute
+
+ +

+
+
+ Generierte Readings/Events:
+
+ +
+ =end html_DE diff --git a/fhem/FHEM/20_GUEST.pm b/fhem/FHEM/20_GUEST.pm index d2815c657..6058fdd54 100644 --- a/fhem/FHEM/20_GUEST.pm +++ b/fhem/FHEM/20_GUEST.pm @@ -894,355 +894,501 @@ sub GUEST_StartInternalTimers($$) { 1; =pod + =begin html - -

GUEST

- + Generated Readings/Events:
+
+ +
+ =end html =begin html_DE - -

GUEST

- + Generierte Readings/Events:
+
+ +
+ =end html_DE diff --git a/fhem/FHEM/20_ROOMMATE.pm b/fhem/FHEM/20_ROOMMATE.pm index 1823c442a..9f8614e92 100644 --- a/fhem/FHEM/20_ROOMMATE.pm +++ b/fhem/FHEM/20_ROOMMATE.pm @@ -884,362 +884,502 @@ sub ROOMMATE_StartInternalTimers($$) { 1; =pod + =begin html - -

ROOMMATE

- + Generated Readings/Events:
+
+ +
+ =end html =begin html_DE - -

ROOMMATE

- +

+ +

+

+ ROOMMATE +

+
+ Define +
+ define <rr_FirstName> ROOMMATE [<Device Name der Bewohnergruppe>]
+
+ Stellt ein spezielles Dummy Device bereit, welches einen Mitbewohner repräsentiert.
+ Basierend auf dem aktuelle Status und anderen Readings können andere Aktionen innerhalb von FHEM angestoßen werden.
+
+ Wird vom übergeordneten Modul RESIDENTS verwendet, kann aber auch einzeln benutzt werden.
+
+ Beispiele:
+
+ # Einzeln
+ define rr_Manfred ROOMMATE
+
+ # Typisches Gruppenmitglied
+ define rr_Manfred ROOMMATE rgr_Residents # um Mitglied der Gruppe rgr_Residents zu sein
+
+ # Mitglied in mehreren Gruppen
+ define rr_Manfred ROOMMATE rgr_Residents,rgr_Parents # um Mitglied den Gruppen rgr_Residents und rgr_Parents zu sein
+
+ # Komplexe Familien Struktur
+ define rr_Manfred ROOMMATE rgr_Residents,rgr_Parents # Elternteil
+ define rr_Lisa ROOMMATE rgr_Residents,rgr_Parents # Elternteil
+ define rr_Rick ROOMMATE rgr_Residents,rgr_Children # Kind1
+ define rr_Alex ROOMMATE rgr_Residents,rgr_Children # Kind2 +
+

+
+ Bitte beachten, dass das RESIDENTS Gruppen Device zunächst angelegt werden muss, bevor ein ROOMMATE Objekt dort Mitglied werden kann. +

+
+
+ Set +
+ set <rr_FirstName> <command> [<parameter>]
+
+ Momentan sind die folgenden Kommandos definiert.
+ +

+
+
+ Mögliche Stati und ihre Bedeutung
+
+
+ Dieses Modul unterscheidet 6 verschiedene Stati:
+
+
    +
  • + home - Mitbrwohner ist zuhause und wach +
    • +
  • + gotosleep - Mitbewohner ist auf dem Weg ins Bett +
    • +
  • + asleep - Mitbewohner schläft +
    • +
  • + awoken - Mitbewohner ist gerade aufgewacht +
    • +
  • + absent - Mitbewohner ist momentan nicht zuhause, wird aber bald zurück sein +
    • +
  • + gone - Mitbewohner ist für längere Zeit verreist +
    • +
+
+

+
+
+ Zusammenhang zwischen Anwesenheit/Presence und Aufenthaltsort/Location
+
+
+ Unter bestimmten Umständen führt der Wechsel des Status auch zu einer Änderung des Readings 'location'.
+
+ Wannimmer die Anwesenheit (bzw. das Reading 'presence') von 'absent' auf 'present' wechselt, wird 'location' auf 'home' gesetzt. Sofern das Attribut rr_locationHome gesetzt ist, wird die erste Lokation daraus anstelle von 'home' verwendet.
+
+ Wannimmer die Anwesenheit (bzw. das Reading 'presence') von 'present' auf 'absent' wechselt, wird 'location' auf 'underway' gesetzt. Sofern das Attribut rr_locationUnderway gesetzt ist, wird die erste Lokation daraus anstelle von 'underway' verwendet. +
+

+
+
+ Auto-Status 'gone'
+
+
+ Immer wenn ein Mitbewohner auf 'absent' gesetzt wird, wird ein Zähler gestartet, der nach einer bestimmten Zeit den Status automatisch auf 'gone' setzt.
+ Der Standard ist nach 36 Stunden.
+
+ Dieses Verhalten kann über das Attribut rr_autoGoneAfter angepasst werden. +
+

+
+
+ Anwesenheit mit anderen ROOMMATE oder GUEST Devices synchronisieren
+
+
+ Wenn Sie immer zusammen mit anderen Mitbewohnern oder Gästen das Haus verlassen oder erreichen, können Sie ihren Status ganz einfach auf andere Mitbewohner übertragen.
+ Durch das Setzen des Attributs rr_PassPresenceTo folgen die dort aufgeführten Mitbewohner ihren eigenen Statusänderungen nach 'home', 'absent' oder 'gone'.
+
+ Bitte beachten, dass Mitbewohner mit dem aktuellen Status 'gone' oder 'none' (im Falle von Gästen) nicht beachtet werden. +
+

+
+
+ Zusammenhang zwischen Aufenthaltsort/Location und Anwesenheit/Presence
+
+
+ Unter bestimmten Umständen hat der Wechsel des Readings 'location' auch einen Einfluss auf den tatsächlichen Status.
+
+ Immer wenn eine Lokation mit dem Namen 'home' gesetzt wird, wird auch der Status auf 'home' gesetzt, sofern die Anwesenheit bis dahin noch auf 'absent' stand. Sofern das Attribut rr_locationHome gesetzt wurde, so lösen alle dort angegebenen Lokationen einen Statuswechsel nach 'home' aus.
+
+ Immer wenn eine Lokation mit dem Namen 'underway' gesetzt wird, wird auch der Status auf 'absent' gesetzt, sofern die Anwesenheit bis dahin noch auf 'present' stand. Sofern das Attribut rr_locationUnderway gesetzt wurde, so lösen alle dort angegebenen Lokationen einen Statuswechsel nach 'underway' aus. Diese Lokationen werden auch nicht in das Reading 'lastLocation' übertragen.
+
+ Immer wenn eine Lokation mit dem Namen 'wayhome' gesetzt wird, wird das Reading 'wayhome' auf '1' gesetzt, sofern die Anwesenheit zu diesem Zeitpunkt 'absent' ist. Sofern das Attribut rr_locationWayhome gesetzt wurde, so führt das VERLASSEN einer dort aufgeführten Lokation ebenfalls dazu, dass das Reading 'wayhome' auf '1' gesetzt wird. Es gibt also 2 Möglichkeiten den Nach-Hause-Weg-Indikator zu beeinflussen (implizit und explizit).
+ Die Ankunft zuhause setzt den Wert von 'wayhome' zurück auf '0'.
+
+ Wenn Sie auch das GEOFANCY Modul verwenden, können Sie das Reading 'location' ganz einfach über GEOFANCY Ereignisse aktualisieren lassen. Definieren Sie dazu einen NOTIFY-Trigger wie diesen:
+
+ define n_rr_Manfred.location notify geofancy:currLoc_Manfred.* set rr_Manfred location $EVTPART1
+
+ Durch das Anlegen von Geofencing-Zonen mit den Namen 'home' und 'wayhome' in der iOS App werden zukünftig automatisch alle Statusänderungen wie oben beschrieben durchgeführt. +
+

+
+ Attribute
+
+ +

+
+
+ Generierte Readings/Events:
+
+ +
+
=end html_DE diff --git a/fhem/FHEM/70_ENIGMA2.pm b/fhem/FHEM/70_ENIGMA2.pm index ac52ba33a..a5efc4e11 100644 --- a/fhem/FHEM/70_ENIGMA2.pm +++ b/fhem/FHEM/70_ENIGMA2.pm @@ -2591,215 +2591,387 @@ sub ENIGMA2_GetRemotecontrolCommand($) { 1; =pod + =begin html - -

ENIGMA2

- +

+ +

+

+ ENIGMA2 +

+
+ Define +
+ define <name> ENIGMA2 <ip-address-or-hostname> [<port>] [<poll-interval>] [<http-user>] [<http-password>]
+
+ This module controls ENIGMA2 based devices like Dreambox or VUplus via network connection.
+
+ Defining an ENIGMA2 device will schedule an internal task (interval can be set with optional parameter <poll-interval> in seconds, if not set, the value is 45 seconds), which periodically reads the status of the device and triggers notify/filelog commands.
+
+ Example:
+
+ define SATReceiver ENIGMA2 192.168.0.10
+
+ # With custom port
+ define SATReceiver ENIGMA2 192.168.0.10 8080
+
+ # With custom interval of 20 seconds
+ define SATReceiver ENIGMA2 192.168.0.10 80 20
+
+ # With HTTP user credentials
+ define SATReceiver ENIGMA2 192.168.0.10 80 20 root secret +
+

+
+ Set +
+ set <name> <command> [<parameter>]
+
+ Currently, the following commands are defined.
+ +

+
+
+ Messaging
+
+
+ showText has predefined settings. If you would like to send more individual messages to your TV screen, the function msg can be used. For this application the following commands are available:
+
+ Type Selection:
+
+ msg yesno
+ msg info
+ msg message
+ msg attention
 +

+
+ The following parameter are essentially needed after type specification: +
+ msg <TYPE> <TIMEOUT> <YOUR MESSAGETEXT>
 +
+
+

+
+ Get +
+ get <name> <what>
+
+ Currently, the following commands are defined:
+
+
+ channel
+ currentMedia
+ currentTitle
+ mute
+ nextTitle
+ power
+ providername
+ servicevideosize
+ input
+ streamUrl
+ volume
 +
+

+
+ Attributes
+
+ +

+
+
+ Generated Readings/Events:
+
+ +
+
=end html =begin html_DE - -

ENIGMA2

- - +

+ +

+

+ ENIGMA2 +

+
+ Eine deutsche Version der Dokumentation ist derzeit nicht vorhanden. Die englische Version ist hier zu finden: +
+
+ ENIGMA2 +
=end html_DE diff --git a/fhem/FHEM/70_ONKYO_AVR.pm b/fhem/FHEM/70_ONKYO_AVR.pm index e66a5e517..f1863e69c 100644 --- a/fhem/FHEM/70_ONKYO_AVR.pm +++ b/fhem/FHEM/70_ONKYO_AVR.pm @@ -1633,108 +1633,145 @@ sub ONKYO_AVR_RClayout() { 1; =pod + =begin html - -

ONKYO_AVR

- +

+ +

+

+ ONKYO_AVR +

+
+ Define +
+ define <name> ONKYO_AVR <ip-address-or-hostname> [<protocol-version>] [<zone>] [<poll-interval>]
+
+ This module controls ONKYO A/V receivers via network connection.
+
+ Defining an ONKYO device will schedule an internal task (interval can be set with optional parameter <poll-interval> in seconds, if not set, the value is 75 seconds), which periodically reads the status of the device and triggers notify/filelog commands.
+
+ Example:
+
+ define avr ONKYO_AVR 192.168.0.10
+
+ # With explicit protocol version 2013 and later
+ define avr ONKYO_AVR 192.168.0.10 2013
+
+ # With protocol version prior 2013
+ define avr ONKYO_AVR 192.168.0.10 pre2013
+
+ # With zone2
+ define avr ONKYO_AVR 192.168.0.10 pre2013 zone2
+
+ # With custom interval of 60 seconds
+ define avr ONKYO_AVR 192.168.0.10 pre2013 main 60
+
+ # With zone2 and custom interval of 60 seconds
+ define avr ONKYO_AVR 192.168.0.10 pre2013 zone2 60 +
+

+
+ Set +
+ set <name> <command> [<parameter>]
+
+ Currently, the following commands are defined (may vary depending on zone).
+ +

+
+ Get +
+ get <name> <what>
+
+ Currently, the following commands are defined (may vary depending on zone):
+
+
+ power
+ input
+ volume
+ mute
+ sleep
 +
+

+
+ Generated Readings/Events (may vary depending on zone):
+ +
=end html =begin html_DE - -

ONKYO_AVR

- - +

+ +

+

+ ONKYO_AVR +

+
+ Eine deutsche Version der Dokumentation ist derzeit nicht vorhanden. Die englische Version ist hier zu finden: +
+
+ ONKYO_AVR +
=end html_DE + =cut diff --git a/fhem/FHEM/98_GEOFANCY.pm b/fhem/FHEM/98_GEOFANCY.pm index 1f0918744..cd21f17c4 100644 --- a/fhem/FHEM/98_GEOFANCY.pm +++ b/fhem/FHEM/98_GEOFANCY.pm @@ -416,86 +416,92 @@ sub GEOFANCY_ISO8601UTCtoLocal ($) { 1; =pod + =begin html - -

GEOFANCY

- +
  • Provides webhook receiver for geofencing via the following iOS apps:
    +
    +
    • +
  • + Geofency +
    • +
  • + Geofancy +
    • +
  • +

    + Note: GEOFANCY is an extension to FHEMWEB. You need to install FHEMWEB to use GEOFANCY. +

    Define +
    + define <name> <infix>
    +
    + Defines the webhook server. <infix> is the portion behind the FHEMWEB base URL (usually http://hostname:8083/fhem)
    +
    + Example: +
    + define geofancy GEOFANCY geo
    +

    + The webhook will be reachable at http://hostname:8083/fhem/geo in that case.
    +
    +
    Set +
    +
    + Attributes
    +
    +
    +
    + Usage information
    +
    +
    + Likely your FHEM installation is not reachable directly from the internet (good idea!).
    + It is recommended to have a reverse proxy like nginx or Apache in front of FHEM where you can make sure access is only possible to specific subdirectories like /fhem/geo.
    + You might also want to think about protecting the access by using HTTP Basic Authentication and encryption via SSL.
    + Also the definition of a dedicated FHEMWEB instance for that purpose might help to restrict FHEM's functionality (note that the 'hidden' attributes of FHEMWEB currently do NOT protect from just guessing/knowing the correct URL!)
    +
    + To make that reverse proxy available from the internet, just forward the appropriate port via your internet router.
    +
    + The actual solution on how you can securely make your Geofancy webhook available to the internet is not part of this documentation and depends on your own skills. +

    +
    + Integration with Home Automation
    +
    +
    + You might want to have a look to the module family of ROOMMATE, GUEST and RESIDENTS for an easy processing of GEOFANCY events. +
    +
    • + =end html =begin html_DE - -

    GEOFANCY

    - - +

    + +

    +

    + GEOFANCY +

    +
    + Eine deutsche Version der Dokumentation ist derzeit nicht vorhanden. Die englische Version ist hier zu finden: +
    +
    + GEOFANCY +
    =end html_DE + =cut