mirror of
https://github.com/fhem/fhem-mirror.git
synced 2025-04-06 18:28:44 +00:00
HTML Tidy
git-svn-id: https://svn.fhem.de/fhem/trunk@5072 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
jpawlowski
parent
a1e458ea0a
commit
d01be61a65
@ -881,211 +881,349 @@ sub RESIDENTS_TimeDiff($$) {
|
||||
1;
|
||||
|
||||
=pod
|
||||
|
||||
=begin html
|
||||
|
||||
<a name="RESIDENTS"></a>
|
||||
<h3>RESIDENTS</h3>
|
||||
<ul>
|
||||
|
||||
<a name="RESIDENTSdefine"></a>
|
||||
<b>Define</b>
|
||||
<ul>
|
||||
<code>define <rgr_ResidentsName> RESIDENTS</code>
|
||||
<br><br>
|
||||
|
||||
Provides a special dummy device to represent a group of individuals living at your home.<br>
|
||||
It locically combines individual states of <a href="#ROOMMATE">ROOMMATE</a> and <a href="#GUEST">GUEST</a> devices and allows state changes for all members.<br>
|
||||
Based on the current state and other readings, you may trigger other actions within FHEM.<br><br>
|
||||
|
||||
Example:<br>
|
||||
<ul><code>
|
||||
# Standalone<br>
|
||||
define rgr_Residents RESIDENTS
|
||||
</code></ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<a name="RESIDENTSset"></a>
|
||||
<b>Set</b>
|
||||
<ul>
|
||||
<code>set <rgr_ResidentsName> <command> [<parameter>]</code>
|
||||
<br><br>
|
||||
Currently, the following commands are defined.<br>
|
||||
<ul>
|
||||
<li><b>addGuest</b> - creates a new GUEST device and adds it to the current RESIDENTS group. Just enter the dummy name and there you go.</li>
|
||||
<li><b>addRoommate</b> - creates a new ROOMMATE device and adds it to the current RESIDENTS group. Just enter the first name and there you go.</li>
|
||||
<li><b>removeGuest</b> - shows all GUEST members and allows to delete their dummy devices easily.</li>
|
||||
<li><b>removeRoommate</b> - shows all ROOMMATE members and allows to delete their dummy devices easily.</li>
|
||||
<li><b>state</b> home,gotosleep,asleep,awoken,absent,gone switch between states for all group members at once; see attribute rgr_states to adjust list shown in FHEMWEB</li>
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
<br><br>
|
||||
<ul>
|
||||
<u>Possible states and their meaning</u><br><br>
|
||||
<ul>
|
||||
This module differs between 7 states:<br><br>
|
||||
|
||||
<ul>
|
||||
<li><b>home</b> - residents are present at home and at least one of them is not asleep</li>
|
||||
<li><b>gotosleep</b> - present residents are on their way to bed (if they are not asleep already)</li>
|
||||
<li><b>asleep</b> - all present residents are currently sleeping</li>
|
||||
<li><b>awoken</b> - at least one resident just woke up from sleep</li>
|
||||
<li><b>absent</b> - no resident is currently at home but at least one will be back shortly</li>
|
||||
<li><b>gone</b> - all residents left home for longer period</li>
|
||||
<li><b>none</b> - no active member</li>
|
||||
</ul><br>
|
||||
<p>
|
||||
<a name="RESIDENTS" id="RESIDENTS"></a>
|
||||
</p>
|
||||
<h3>
|
||||
RESIDENTS
|
||||
</h3>
|
||||
<div style="margin-left: 2em">
|
||||
<a name="RESIDENTSdefine" id="RESIDENTSdefine"></a> <b>Define</b>
|
||||
<div style="margin-left: 2em">
|
||||
<code>define <rgr_ResidentsName> RESIDENTS</code><br>
|
||||
<br>
|
||||
Provides a special dummy device to represent a group of individuals living at your home.<br>
|
||||
It locically combines individual states of <a href="#ROOMMATE">ROOMMATE</a> and <a href="#GUEST">GUEST</a> devices and allows state changes for all members.<br>
|
||||
Based on the current state and other readings, you may trigger other actions within FHEM.<br>
|
||||
<br>
|
||||
Example:<br>
|
||||
<div style="margin-left: 2em">
|
||||
<code># Standalone<br>
|
||||
define rgr_Residents RESIDENTS</code>
|
||||
</div>
|
||||
</div><br>
|
||||
<br>
|
||||
Note: State 'none' cannot explicitly be set. Setting state to 'gone' will be handled as 'none' for GUEST member devices.
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<a name="RESIDENTSattr"></a>
|
||||
<b>Attributes</b><br>
|
||||
<ul><ul>
|
||||
<li><b>rgr_showAllStates</b> - states 'asleep' and 'awoken' are hidden by default to allow simple gotosleep process via devStateIcon; defaults to 0</li>
|
||||
<li><b>rgr_states</b> - list of states to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces; unsupported states will lead to errors though</li>
|
||||
</ul></ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<b>Generated Readings/Events:</b><br>
|
||||
<ul><ul>
|
||||
<li><b>lastActivity</b> - the last state change of one of the group members</li>
|
||||
<li><b>lastActivityBy</b> - the realname of the last group member with changed state</li>
|
||||
<li><b>lastArrival</b> - timestamp of last arrival at home</li>
|
||||
<li><b>lastAwake</b> - timestamp of last sleep cycle end</li>
|
||||
<li><b>lastDeparture</b> - timestamp of last departure from home</li>
|
||||
<li><b>lastDurAbsence</b> - duration of last absence from home in following format: hours:minutes:seconds</li>
|
||||
<li><b>lastDurPresence</b> - duration of last presence at home in following format: hours:minutes:seconds</li>
|
||||
<li><b>lastDurSleep</b> - duration of last sleep in following format: hours:minutes:seconds</li>
|
||||
<li><b>lastSleep</b> - timestamp of last sleep cycle begin</li>
|
||||
<li><b>lastState</b> - the prior state</li>
|
||||
<li><b>presence</b> - reflects the home presence state, depending on value of reading 'state' (can be 'present' or 'absent')</li>
|
||||
<li><b>residentsAbsent</b> - number of residents with state 'absent'</li>
|
||||
<li><b>residentsAsleep</b> - number of residents with state 'asleep'</li>
|
||||
<li><b>residentsAwoken</b> - number of residents with state 'awoken'</li>
|
||||
<li><b>residentsGone</b> - number of residents with state 'gone'</li>
|
||||
<li><b>residentsGotosleep</b> - number of residents with state 'gotosleep'</li>
|
||||
<li><b>residentsGuests</b> - number of active guests who are currently treated as part of the residents scope</li>
|
||||
<li><b>residentsHome</b> - number of residents with state 'home'</li>
|
||||
<li><b>residentsTotal</b> - total number of all active residents despite their current state</li>
|
||||
<li><b>residentsTotalAbsent</b> - number of all residents who are currently underway</li>
|
||||
<li><b>residentsTotalPresent</b> - number of all residents who are currently at home</li>
|
||||
<li><b>residentsTotalWayhome</b> - number of all active residents who are currently on their way back home</li>
|
||||
<li><b>state</b> - reflects the current state</li>
|
||||
</ul></ul>
|
||||
|
||||
</ul>
|
||||
<a name="RESIDENTSset" id="RESIDENTSset"></a> <b>Set</b>
|
||||
<div style="margin-left: 2em">
|
||||
<code>set <rgr_ResidentsName> <command> [<parameter>]</code><br>
|
||||
<br>
|
||||
Currently, the following commands are defined.<br>
|
||||
<ul>
|
||||
<li>
|
||||
<b>addGuest</b> - creates a new GUEST device and adds it to the current RESIDENTS group. Just enter the dummy name and there you go.
|
||||
</li>
|
||||
<li>
|
||||
<b>addRoommate</b> - creates a new ROOMMATE device and adds it to the current RESIDENTS group. Just enter the first name and there you go.
|
||||
</li>
|
||||
<li>
|
||||
<b>removeGuest</b> - shows all GUEST members and allows to delete their dummy devices easily.
|
||||
</li>
|
||||
<li>
|
||||
<b>removeRoommate</b> - shows all ROOMMATE members and allows to delete their dummy devices easily.
|
||||
</li>
|
||||
<li>
|
||||
<b>state</b> home,gotosleep,asleep,awoken,absent,gone switch between states for all group members at once; see attribute rgr_states to adjust list shown in FHEMWEB
|
||||
</li>
|
||||
</ul>
|
||||
</div><br>
|
||||
<br>
|
||||
<div style="margin-left: 2em">
|
||||
<u>Possible states and their meaning</u><br>
|
||||
<br>
|
||||
<div style="margin-left: 2em">
|
||||
This module differs between 7 states:<br>
|
||||
<br>
|
||||
<ul>
|
||||
<li>
|
||||
<b>home</b> - residents are present at home and at least one of them is not asleep
|
||||
</li>
|
||||
<li>
|
||||
<b>gotosleep</b> - present residents are on their way to bed (if they are not asleep already)
|
||||
</li>
|
||||
<li>
|
||||
<b>asleep</b> - all present residents are currently sleeping
|
||||
</li>
|
||||
<li>
|
||||
<b>awoken</b> - at least one resident just woke up from sleep
|
||||
</li>
|
||||
<li>
|
||||
<b>absent</b> - no resident is currently at home but at least one will be back shortly
|
||||
</li>
|
||||
<li>
|
||||
<b>gone</b> - all residents left home for longer period
|
||||
</li>
|
||||
<li>
|
||||
<b>none</b> - no active member
|
||||
</li>
|
||||
</ul><br>
|
||||
<br>
|
||||
Note: State 'none' cannot explicitly be set. Setting state to 'gone' will be handled as 'none' for GUEST member devices.
|
||||
</div>
|
||||
</div><br>
|
||||
<br>
|
||||
<a name="RESIDENTSattr" id="RESIDENTSattr"></a> <b>Attributes</b><br>
|
||||
<div style="margin-left: 2em">
|
||||
<ul>
|
||||
<li>
|
||||
<b>rgr_showAllStates</b> - states 'asleep' and 'awoken' are hidden by default to allow simple gotosleep process via devStateIcon; defaults to 0
|
||||
</li>
|
||||
<li>
|
||||
<b>rgr_states</b> - list of states to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces; unsupported states will lead to errors though
|
||||
</li>
|
||||
</ul>
|
||||
</div><br>
|
||||
<br>
|
||||
<br>
|
||||
<b>Generated Readings/Events:</b><br>
|
||||
<div style="margin-left: 2em">
|
||||
<ul>
|
||||
<li>
|
||||
<b>lastActivity</b> - the last state change of one of the group members
|
||||
</li>
|
||||
<li>
|
||||
<b>lastActivityBy</b> - the realname of the last group member with changed state
|
||||
</li>
|
||||
<li>
|
||||
<b>lastArrival</b> - timestamp of last arrival at home
|
||||
</li>
|
||||
<li>
|
||||
<b>lastAwake</b> - timestamp of last sleep cycle end
|
||||
</li>
|
||||
<li>
|
||||
<b>lastDeparture</b> - timestamp of last departure from home
|
||||
</li>
|
||||
<li>
|
||||
<b>lastDurAbsence</b> - duration of last absence from home in following format: hours:minutes:seconds
|
||||
</li>
|
||||
<li>
|
||||
<b>lastDurPresence</b> - duration of last presence at home in following format: hours:minutes:seconds
|
||||
</li>
|
||||
<li>
|
||||
<b>lastDurSleep</b> - duration of last sleep in following format: hours:minutes:seconds
|
||||
</li>
|
||||
<li>
|
||||
<b>lastSleep</b> - timestamp of last sleep cycle begin
|
||||
</li>
|
||||
<li>
|
||||
<b>lastState</b> - the prior state
|
||||
</li>
|
||||
<li>
|
||||
<b>presence</b> - reflects the home presence state, depending on value of reading 'state' (can be 'present' or 'absent')
|
||||
</li>
|
||||
<li>
|
||||
<b>residentsAbsent</b> - number of residents with state 'absent'
|
||||
</li>
|
||||
<li>
|
||||
<b>residentsAsleep</b> - number of residents with state 'asleep'
|
||||
</li>
|
||||
<li>
|
||||
<b>residentsAwoken</b> - number of residents with state 'awoken'
|
||||
</li>
|
||||
<li>
|
||||
<b>residentsGone</b> - number of residents with state 'gone'
|
||||
</li>
|
||||
<li>
|
||||
<b>residentsGotosleep</b> - number of residents with state 'gotosleep'
|
||||
</li>
|
||||
<li>
|
||||
<b>residentsGuests</b> - number of active guests who are currently treated as part of the residents scope
|
||||
</li>
|
||||
<li>
|
||||
<b>residentsHome</b> - number of residents with state 'home'
|
||||
</li>
|
||||
<li>
|
||||
<b>residentsTotal</b> - total number of all active residents despite their current state
|
||||
</li>
|
||||
<li>
|
||||
<b>residentsTotalAbsent</b> - number of all residents who are currently underway
|
||||
</li>
|
||||
<li>
|
||||
<b>residentsTotalPresent</b> - number of all residents who are currently at home
|
||||
</li>
|
||||
<li>
|
||||
<b>residentsTotalWayhome</b> - number of all active residents who are currently on their way back home
|
||||
</li>
|
||||
<li>
|
||||
<b>state</b> - reflects the current state
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
=end html
|
||||
|
||||
=begin html_DE
|
||||
|
||||
<a name="RESIDENTS"></a>
|
||||
<h3>RESIDENTS</h3>
|
||||
<ul>
|
||||
|
||||
<a name="RESIDENTSdefine"></a>
|
||||
<b>Define</b>
|
||||
<ul>
|
||||
<code>define <rgr_ResidentsName> RESIDENTS</code>
|
||||
<br><br>
|
||||
|
||||
Stellt ein spezielles Dummy-Device bereit, um eine Gruppe von Personen zu repräsentieren, die zusammen wohnen.<br>
|
||||
Es kombiniert dabei logisch die individuellen Stati von <a href="#ROOMMATE">ROOMMATE</a> und <a href="#GUEST">GUEST</a> Devices und erlaubt den Status für alle Mitglieder zeitgleich zu ändern.
|
||||
Basierend auf dem aktuelle Status und anderen Readings können andere Aktionen innerhalb von FHEM angestoßen werden.<br><br>
|
||||
|
||||
Beispiele:<br>
|
||||
<ul><code>
|
||||
# Einzeln<br>
|
||||
define rgr_Residents RESIDENTS
|
||||
</code></ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<a name="RESIDENTSset"></a>
|
||||
<b>Set</b>
|
||||
<ul>
|
||||
<code>set <rgr_ResidentsName> <command> [<parameter>]</code>
|
||||
<br><br>
|
||||
Momentan sind die folgenden Kommandos definiert.<br>
|
||||
<ul>
|
||||
<li><b>addGuest</b> - erstellt ein neues GUEST Device und fügt es der aktuellen RESIDENTS Gruppe hinzu. Einfach den Platzhalternamen eingeben und das wars.</li>
|
||||
<li><b>addRoommate</b> - erstellt ein neues GUEST Device und fügt es der aktuellen RESIDENTS Gruppe hinzu. Einfach den Vornamen eingeben und das wars.</li>
|
||||
<li><b>removeGuest</b> - zeigt alle Mitglieder vom Typ GUEST an und ermöglicht ein einfaches löschen des dazugehörigen Dummy Devices.</li>
|
||||
<li><b>removeRoommate</b> - zeigt alle Mitglieder vom Typ ROOMMATE an und ermöglicht ein einfaches löschen des dazugehörigen Dummy Devices.</li>
|
||||
<li><b>state</b> home,gotosleep,asleep,awoken,absent,gone wechselt den Status für alle Gruppenmitglieder gleichzeitig; siehe Attribut rgr_states, um die angezeigte Liste in FHEMWEB abzuändern</li>
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
<br><br>
|
||||
<ul>
|
||||
<u>Mögliche Stati und ihre Bedeutung</u><br><br>
|
||||
<ul>
|
||||
Dieses Modul unterscheidet 7 verschiedene Stati:<br><br>
|
||||
|
||||
<ul>
|
||||
<li><b>home</b> - Bewohner sind zu Hause und mindestens einer schläft nicht</li>
|
||||
<li><b>gotosleep</b> - alle anwesenden Bewohner sind auf dem Weg ins Bett (wenn sie nicht schon schlafen)</li>
|
||||
<li><b>asleep</b> - alle anwesenden Bewohner schlafen</li>
|
||||
<li><b>awoken</b> - mindestens einer der anwesenden Bewohner ist gerade aufgewacht</li>
|
||||
<li><b>absent</b> - keiner der Bewohner ist momentan zu Hause; mindestens einer ist aber in Kürze zurück</li>
|
||||
<li><b>gone</b> - alle Bewohner sind für längere Zeit verreist</li>
|
||||
<li><b>none</b> - kein Mitglied aktiv</li>
|
||||
</ul><br>
|
||||
<p>
|
||||
<a name="RESIDENTS" id="RESIDENTS"></a>
|
||||
</p>
|
||||
<h3>
|
||||
RESIDENTS
|
||||
</h3>
|
||||
<div style="margin-left: 2em">
|
||||
<a name="RESIDENTSdefine" id="RESIDENTSdefine"></a> <b>Define</b>
|
||||
<div style="margin-left: 2em">
|
||||
<code>define <rgr_ResidentsName> RESIDENTS</code><br>
|
||||
<br>
|
||||
Stellt ein spezielles Dummy-Device bereit, um eine Gruppe von Personen zu repräsentieren, die zusammen wohnen.<br>
|
||||
Es kombiniert dabei logisch die individuellen Stati von <a href="#ROOMMATE">ROOMMATE</a> und <a href="#GUEST">GUEST</a> Devices und erlaubt den Status für alle Mitglieder zeitgleich zu ändern. Basierend auf dem aktuelle Status und anderen Readings können andere Aktionen innerhalb von FHEM angestoßen werden.<br>
|
||||
<br>
|
||||
Beispiele:<br>
|
||||
<div style="margin-left: 2em">
|
||||
<code># Einzeln<br>
|
||||
define rgr_Residents RESIDENTS</code>
|
||||
</div>
|
||||
</div><br>
|
||||
<br>
|
||||
Hinweis: Der Status 'none' kann nicht explizit gesetzt werden. Das setzen von 'gone' wird bei Mitgliedern vom Typ GUEST als 'none' behandelt.
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<a name="RESIDENTSattr"></a>
|
||||
<b>Attribute</b><br>
|
||||
<ul><ul>
|
||||
<li><b>rgr_showAllStates</b> - die Stati 'asleep' und 'awoken' sind normalerweise nicht immer sichtbar, um einen einfachen Zubettgeh-Prozess über das devStateIcon Attribut zu ermöglichen; Standard ist 0</li>
|
||||
<li><b>rgr_states</b> - Liste aller in FHEMWEB angezeigter Stati; Eintrage nur mit Komma trennen und KEINE Leerzeichen benutzen; nicht unterstützte Stati führen zu Fehlern</li>
|
||||
</ul></ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<b>Generierte Readings/Events:</b><br>
|
||||
<ul><ul>
|
||||
<li><b>lastActivity</b> - der letzte Status Wechsel eines Gruppenmitglieds</li>
|
||||
<li><b>lastActivityBy</b> - der Name des Gruppenmitglieds, dessen Status zuletzt geändert wurde</li>
|
||||
<li><b>lastArrival</b> - Zeitstempel der letzten Ankunft zu Hause</li>
|
||||
<li><b>lastAwake</b> - Zeitstempel des Endes des letzten Schlafzyklus</li>
|
||||
<li><b>lastDeparture</b> - Zeitstempel des letzten Verlassens des Zuhauses</li>
|
||||
<li><b>lastDurAbsence</b> - Dauer der letzten Abwesenheit im folgenden Format: Stunden:Minuten:Sekunden</li>
|
||||
<li><b>lastDurPresence</b> - Dauer der letzten Anwesenheit im folgenden Format: Stunden:Minuten:Sekunden</li>
|
||||
<li><b>lastDurSleep</b> - Dauer des letzten Schlafzyklus im folgenden Format: Stunden:Minuten:Sekunden</li>
|
||||
<li><b>lastSleep</b> - Zeitstempel des Beginns des letzten Schlafzyklus</li>
|
||||
<li><b>lastState</b> - der vorherige Status</li>
|
||||
<li><b>presence</b> - gibt den Zuhause Status in Abhängigkeit des Readings 'state' wieder (kann 'present' oder 'absent' sein)</li>
|
||||
<li><b>residentsAbsent</b> - Anzahl der Bewohner mit Status 'absent'</li>
|
||||
<li><b>residentsAsleep</b> - Anzahl der Bewohner mit Status 'asleep'</li>
|
||||
<li><b>residentsAwoken</b> - Anzahl der Bewohner mit Status 'awoken'</li>
|
||||
<li><b>residentsGone</b> - Anzahl der Bewohner mit Status 'gone'</li>
|
||||
<li><b>residentsGotosleep</b> - Anzahl der Bewohner mit Status 'gotosleep'</li>
|
||||
<li><b>residentsGuests</b> - Anzahl der aktiven Gäste, welche momentan du den Bewohnern dazugezählt werden</li>
|
||||
<li><b>residentsHome</b> - Anzahl der Bewohner mit Status 'home'</li>
|
||||
<li><b>residentsTotal</b> - Summe aller aktiven Bewohner unabhängig von ihrem aktuellen Status</li>
|
||||
<li><b>residentsTotalAbsent</b> - Summe aller aktiven Bewohner, die unterwegs sind</li>
|
||||
<li><b>residentsTotalPresent</b> - Summe aller aktiven Bewohner, die momentan Zuhause sind</li>
|
||||
<li><b>residentsTotalWayhome</b> - Summe aller aktiven Bewohner, die momentan auf dem Weg zurück nach Hause sind</li>
|
||||
<li><b>state</b> - gibt den aktuellen Status wieder</li>
|
||||
</ul></ul>
|
||||
|
||||
</ul>
|
||||
<a name="RESIDENTSset" id="RESIDENTSset"></a> <b>Set</b>
|
||||
<div style="margin-left: 2em">
|
||||
<code>set <rgr_ResidentsName> <command> [<parameter>]</code><br>
|
||||
<br>
|
||||
Momentan sind die folgenden Kommandos definiert.<br>
|
||||
<ul>
|
||||
<li>
|
||||
<b>addGuest</b> - erstellt ein neues GUEST Device und fügt es der aktuellen RESIDENTS Gruppe hinzu. Einfach den Platzhalternamen eingeben und das wars.
|
||||
</li>
|
||||
<li>
|
||||
<b>addRoommate</b> - erstellt ein neues GUEST Device und fügt es der aktuellen RESIDENTS Gruppe hinzu. Einfach den Vornamen eingeben und das wars.
|
||||
</li>
|
||||
<li>
|
||||
<b>removeGuest</b> - zeigt alle Mitglieder vom Typ GUEST an und ermöglicht ein einfaches löschen des dazugehörigen Dummy Devices.
|
||||
</li>
|
||||
<li>
|
||||
<b>removeRoommate</b> - zeigt alle Mitglieder vom Typ ROOMMATE an und ermöglicht ein einfaches löschen des dazugehörigen Dummy Devices.
|
||||
</li>
|
||||
<li>
|
||||
<b>state</b> home,gotosleep,asleep,awoken,absent,gone wechselt den Status für alle Gruppenmitglieder gleichzeitig; siehe Attribut rgr_states, um die angezeigte Liste in FHEMWEB abzuändern
|
||||
</li>
|
||||
</ul>
|
||||
</div><br>
|
||||
<br>
|
||||
<div style="margin-left: 2em">
|
||||
<u>Mögliche Stati und ihre Bedeutung</u><br>
|
||||
<br>
|
||||
<div style="margin-left: 2em">
|
||||
Dieses Modul unterscheidet 7 verschiedene Stati:<br>
|
||||
<br>
|
||||
<ul>
|
||||
<li>
|
||||
<b>home</b> - Bewohner sind zu Hause und mindestens einer schläft nicht
|
||||
</li>
|
||||
<li>
|
||||
<b>gotosleep</b> - alle anwesenden Bewohner sind auf dem Weg ins Bett (wenn sie nicht schon schlafen)
|
||||
</li>
|
||||
<li>
|
||||
<b>asleep</b> - alle anwesenden Bewohner schlafen
|
||||
</li>
|
||||
<li>
|
||||
<b>awoken</b> - mindestens einer der anwesenden Bewohner ist gerade aufgewacht
|
||||
</li>
|
||||
<li>
|
||||
<b>absent</b> - keiner der Bewohner ist momentan zu Hause; mindestens einer ist aber in Kürze zurück
|
||||
</li>
|
||||
<li>
|
||||
<b>gone</b> - alle Bewohner sind für längere Zeit verreist
|
||||
</li>
|
||||
<li>
|
||||
<b>none</b> - kein Mitglied aktiv
|
||||
</li>
|
||||
</ul><br>
|
||||
<br>
|
||||
Hinweis: Der Status 'none' kann nicht explizit gesetzt werden. Das setzen von 'gone' wird bei Mitgliedern vom Typ GUEST als 'none' behandelt.
|
||||
</div>
|
||||
</div><br>
|
||||
<br>
|
||||
<a name="RESIDENTSattr" id="RESIDENTSattr"></a> <b>Attribute</b><br>
|
||||
<div style="margin-left: 2em">
|
||||
<ul>
|
||||
<li>
|
||||
<b>rgr_showAllStates</b> - die Stati 'asleep' und 'awoken' sind normalerweise nicht immer sichtbar, um einen einfachen Zubettgeh-Prozess über das devStateIcon Attribut zu ermöglichen; Standard ist 0
|
||||
</li>
|
||||
<li>
|
||||
<b>rgr_states</b> - Liste aller in FHEMWEB angezeigter Stati; Eintrage nur mit Komma trennen und KEINE Leerzeichen benutzen; nicht unterstützte Stati führen zu Fehlern
|
||||
</li>
|
||||
</ul>
|
||||
</div><br>
|
||||
<br>
|
||||
<br>
|
||||
<b>Generierte Readings/Events:</b><br>
|
||||
<div style="margin-left: 2em">
|
||||
<ul>
|
||||
<li>
|
||||
<b>lastActivity</b> - der letzte Status Wechsel eines Gruppenmitglieds
|
||||
</li>
|
||||
<li>
|
||||
<b>lastActivityBy</b> - der Name des Gruppenmitglieds, dessen Status zuletzt geändert wurde
|
||||
</li>
|
||||
<li>
|
||||
<b>lastArrival</b> - Zeitstempel der letzten Ankunft zu Hause
|
||||
</li>
|
||||
<li>
|
||||
<b>lastAwake</b> - Zeitstempel des Endes des letzten Schlafzyklus
|
||||
</li>
|
||||
<li>
|
||||
<b>lastDeparture</b> - Zeitstempel des letzten Verlassens des Zuhauses
|
||||
</li>
|
||||
<li>
|
||||
<b>lastDurAbsence</b> - Dauer der letzten Abwesenheit im folgenden Format: Stunden:Minuten:Sekunden
|
||||
</li>
|
||||
<li>
|
||||
<b>lastDurPresence</b> - Dauer der letzten Anwesenheit im folgenden Format: Stunden:Minuten:Sekunden
|
||||
</li>
|
||||
<li>
|
||||
<b>lastDurSleep</b> - Dauer des letzten Schlafzyklus im folgenden Format: Stunden:Minuten:Sekunden
|
||||
</li>
|
||||
<li>
|
||||
<b>lastSleep</b> - Zeitstempel des Beginns des letzten Schlafzyklus
|
||||
</li>
|
||||
<li>
|
||||
<b>lastState</b> - der vorherige Status
|
||||
</li>
|
||||
<li>
|
||||
<b>presence</b> - gibt den Zuhause Status in Abhängigkeit des Readings 'state' wieder (kann 'present' oder 'absent' sein)
|
||||
</li>
|
||||
<li>
|
||||
<b>residentsAbsent</b> - Anzahl der Bewohner mit Status 'absent'
|
||||
</li>
|
||||
<li>
|
||||
<b>residentsAsleep</b> - Anzahl der Bewohner mit Status 'asleep'
|
||||
</li>
|
||||
<li>
|
||||
<b>residentsAwoken</b> - Anzahl der Bewohner mit Status 'awoken'
|
||||
</li>
|
||||
<li>
|
||||
<b>residentsGone</b> - Anzahl der Bewohner mit Status 'gone'
|
||||
</li>
|
||||
<li>
|
||||
<b>residentsGotosleep</b> - Anzahl der Bewohner mit Status 'gotosleep'
|
||||
</li>
|
||||
<li>
|
||||
<b>residentsGuests</b> - Anzahl der aktiven Gäste, welche momentan du den Bewohnern dazugezählt werden
|
||||
</li>
|
||||
<li>
|
||||
<b>residentsHome</b> - Anzahl der Bewohner mit Status 'home'
|
||||
</li>
|
||||
<li>
|
||||
<b>residentsTotal</b> - Summe aller aktiven Bewohner unabhängig von ihrem aktuellen Status
|
||||
</li>
|
||||
<li>
|
||||
<b>residentsTotalAbsent</b> - Summe aller aktiven Bewohner, die unterwegs sind
|
||||
</li>
|
||||
<li>
|
||||
<b>residentsTotalPresent</b> - Summe aller aktiven Bewohner, die momentan Zuhause sind
|
||||
</li>
|
||||
<li>
|
||||
<b>residentsTotalWayhome</b> - Summe aller aktiven Bewohner, die momentan auf dem Weg zurück nach Hause sind
|
||||
</li>
|
||||
<li>
|
||||
<b>state</b> - gibt den aktuellen Status wieder
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
=end html_DE
|
||||
|
||||
|
||||
@ -894,355 +894,501 @@ sub GUEST_StartInternalTimers($$) {
|
||||
1;
|
||||
|
||||
=pod
|
||||
|
||||
=begin html
|
||||
|
||||
<a name="GUEST"></a>
|
||||
<h3>GUEST</h3>
|
||||
<ul>
|
||||
|
||||
<a name="GUESTdefine"></a>
|
||||
<b>Define</b>
|
||||
<ul>
|
||||
<code>define <rg_GuestName> GUEST [<device name of resident group>]</code>
|
||||
<br><br>
|
||||
|
||||
Provides a special dummy device to represent a guest of your home.<br>
|
||||
Based on the current state and other readings, you may trigger other actions within FHEM.<br><br>
|
||||
Used by superior module <a href="#RESIDENTS">RESIDENTS</a> but may also be used stand-alone.<br><br>
|
||||
|
||||
Example:<br>
|
||||
<ul><code>
|
||||
# Standalone<br>
|
||||
define rg_Guest GUEST
|
||||
<br><br>
|
||||
# Typical group member<br>
|
||||
define rg_Guest GUEST rgr_Residents # to be member of resident group rgr_Residents
|
||||
<br><br>
|
||||
# Member of multiple groups<br>
|
||||
define rg_Guest GUEST rgr_Residents,rgr_Guests # to be member of resident group rgr_Residents and rgr_Guests
|
||||
</code></ul>
|
||||
</ul><br>
|
||||
|
||||
<ul>Please note the RESIDENTS group device needs to be existing before a GUEST device can become a member of it.</ul><br>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<a name="GUESTset"></a>
|
||||
<b>Set</b>
|
||||
<ul>
|
||||
<code>set <rg_GuestName> <command> [<parameter>]</code>
|
||||
<br><br>
|
||||
Currently, the following commands are defined.<br>
|
||||
<ul>
|
||||
<li><b>location</b> - sets reading 'location'; see attribute rg_locations to adjust list shown in FHEMWEB</li>
|
||||
<li><b>mood</b> - sets reading 'mood'; see attribute rg_moods to adjust list shown in FHEMWEB</li>
|
||||
<li><b>state</b> home,gotosleep,asleep,awoken,absent,none switch between states; see attribute rg_states to adjust list shown in FHEMWEB</li>
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
<br><br>
|
||||
<ul>
|
||||
<u>Possible states and their meaning</u><br><br>
|
||||
<ul>
|
||||
This module differs between 6 states:<br><br>
|
||||
|
||||
<ul>
|
||||
<li><b>home</b> - individual is present at home and awake</li>
|
||||
<li><b>gotosleep</b> - individual is on it's way to bed</li>
|
||||
<li><b>asleep</b> - individual is currently sleeping</li>
|
||||
<li><b>awoken</b> - individual just woke up from sleep</li>
|
||||
<li><b>absent</b> - individual is not present at home but will be back shortly</li>
|
||||
<li><b>none</b> - guest device is disabled</li>
|
||||
</ul>
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<ul>
|
||||
<u>Presence correlation to location</u><br><br>
|
||||
<ul>
|
||||
Under specific circumstances, changing state will automatically change reading 'location' as well.<br>
|
||||
<p>
|
||||
<a name="GUEST" id="GUEST"></a>
|
||||
</p>
|
||||
<h3>
|
||||
GUEST
|
||||
</h3>
|
||||
<div style="margin-left: 2em">
|
||||
<a name="GUESTdefine" id="GUESTdefine"></a> <b>Define</b>
|
||||
<div style="margin-left: 2em">
|
||||
<code>define <rg_GuestName> GUEST [<device name of resident group>]</code><br>
|
||||
<br>
|
||||
Provides a special dummy device to represent a guest of your home.<br>
|
||||
Based on the current state and other readings, you may trigger other actions within FHEM.<br>
|
||||
<br>
|
||||
Used by superior module <a href="#RESIDENTS">RESIDENTS</a> but may also be used stand-alone.<br>
|
||||
<br>
|
||||
Example:<br>
|
||||
<div style="margin-left: 2em">
|
||||
<code># Standalone<br>
|
||||
define rg_Guest GUEST<br>
|
||||
<br>
|
||||
# Typical group member<br>
|
||||
define rg_Guest GUEST rgr_Residents # to be member of resident group rgr_Residents<br>
|
||||
<br>
|
||||
# Member of multiple groups<br>
|
||||
define rg_Guest GUEST rgr_Residents,rgr_Guests # to be member of resident group rgr_Residents and rgr_Guests</code>
|
||||
</div>
|
||||
</div><br>
|
||||
<div style="margin-left: 2em">
|
||||
Please note the RESIDENTS group device needs to be existing before a GUEST device can become a member of it.
|
||||
</div><br>
|
||||
<br>
|
||||
Whenever presence state changes from 'absent' to 'present', the location is set to 'home'. If attribute rg_locationHome was defined, first location from it will be used as home location.<br>
|
||||
<br>
|
||||
Whenever presence state changes from 'present' to 'absent', the location is set to 'underway'. If attribute rg_locationUnderway was defined, first location from it will be used as underway location.
|
||||
</ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<ul>
|
||||
<u>Auto Gone</u><br><br>
|
||||
<ul>
|
||||
Whenever an individual is set to 'absent', a trigger is started to automatically change state to 'gone' after a specific timeframe.<br>
|
||||
Default value is 16 hours.<br>
|
||||
<a name="GUESTset" id="GUESTset"></a> <b>Set</b>
|
||||
<div style="margin-left: 2em">
|
||||
<code>set <rg_GuestName> <command> [<parameter>]</code><br>
|
||||
<br>
|
||||
Currently, the following commands are defined.<br>
|
||||
<ul>
|
||||
<li>
|
||||
<b>location</b> - sets reading 'location'; see attribute rg_locations to adjust list shown in FHEMWEB
|
||||
</li>
|
||||
<li>
|
||||
<b>mood</b> - sets reading 'mood'; see attribute rg_moods to adjust list shown in FHEMWEB
|
||||
</li>
|
||||
<li>
|
||||
<b>state</b> home,gotosleep,asleep,awoken,absent,none switch between states; see attribute rg_states to adjust list shown in FHEMWEB
|
||||
</li>
|
||||
</ul>
|
||||
</div><br>
|
||||
<br>
|
||||
This behaviour can be customized by attribute rg_autoGoneAfter.
|
||||
</ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<ul>
|
||||
<u>Synchronizing presence with other ROOMMATE or GUEST devices</u><br><br>
|
||||
<ul>
|
||||
If you always leave or arrive at your house together with other roommates or guests, you may enable a synchronization of your presence state for certain individuals.<br>
|
||||
By setting attribute rg_passPresenceTo, those individuals will follow your presence state changes to 'home', 'absent' or 'gone' as you do them with your own device.<br>
|
||||
<div style="margin-left: 2em">
|
||||
<u>Possible states and their meaning</u><br>
|
||||
<br>
|
||||
<div style="margin-left: 2em">
|
||||
This module differs between 6 states:<br>
|
||||
<br>
|
||||
<ul>
|
||||
<li>
|
||||
<b>home</b> - individual is present at home and awake
|
||||
</li>
|
||||
<li>
|
||||
<b>gotosleep</b> - individual is on it's way to bed
|
||||
</li>
|
||||
<li>
|
||||
<b>asleep</b> - individual is currently sleeping
|
||||
</li>
|
||||
<li>
|
||||
<b>awoken</b> - individual just woke up from sleep
|
||||
</li>
|
||||
<li>
|
||||
<b>absent</b> - individual is not present at home but will be back shortly
|
||||
</li>
|
||||
<li>
|
||||
<b>none</b> - guest device is disabled
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><br>
|
||||
<br>
|
||||
Please note that individuals with current state 'none' or 'gone' (in case of roommates) will not be touched.
|
||||
</ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<ul>
|
||||
<u>Location correlation to state</u><br><br>
|
||||
<ul>
|
||||
Under specific circumstances, changing location will have an effect on the actual state as well.<br>
|
||||
<div style="margin-left: 2em">
|
||||
<u>Presence correlation to location</u><br>
|
||||
<br>
|
||||
<div style="margin-left: 2em">
|
||||
Under specific circumstances, changing state will automatically change reading 'location' as well.<br>
|
||||
<br>
|
||||
Whenever presence state changes from 'absent' to 'present', the location is set to 'home'. If attribute rg_locationHome was defined, first location from it will be used as home location.<br>
|
||||
<br>
|
||||
Whenever presence state changes from 'present' to 'absent', the location is set to 'underway'. If attribute rg_locationUnderway was defined, first location from it will be used as underway location.
|
||||
</div>
|
||||
</div><br>
|
||||
<br>
|
||||
Whenever location is set to 'home', the state is set to 'home' if prior presence state was 'absent'. If attribute rg_locationHome was defined, all of those locations will trigger state change to 'home' as well.<br>
|
||||
<div style="margin-left: 2em">
|
||||
<u>Auto Gone</u><br>
|
||||
<br>
|
||||
<div style="margin-left: 2em">
|
||||
Whenever an individual is set to 'absent', a trigger is started to automatically change state to 'gone' after a specific timeframe.<br>
|
||||
Default value is 16 hours.<br>
|
||||
<br>
|
||||
This behaviour can be customized by attribute rg_autoGoneAfter.
|
||||
</div>
|
||||
</div><br>
|
||||
<br>
|
||||
Whenever location is set to 'underway', the state is set to 'absent' if prior presence state was 'present'. If attribute rg_locationUnderway was defined, all of those locations will trigger state change to 'absent' as well. Those locations won't appear in reading 'lastLocation'.<br>
|
||||
<div style="margin-left: 2em">
|
||||
<u>Synchronizing presence with other ROOMMATE or GUEST devices</u><br>
|
||||
<br>
|
||||
<div style="margin-left: 2em">
|
||||
If you always leave or arrive at your house together with other roommates or guests, you may enable a synchronization of your presence state for certain individuals.<br>
|
||||
By setting attribute rg_passPresenceTo, those individuals will follow your presence state changes to 'home', 'absent' or 'gone' as you do them with your own device.<br>
|
||||
<br>
|
||||
Please note that individuals with current state 'none' or 'gone' (in case of roommates) will not be touched.
|
||||
</div>
|
||||
</div><br>
|
||||
<br>
|
||||
Whenever location is set to 'wayhome', the reading 'wayhome' is set to '1' if current presence state is 'absent'. If attribute rg_locationWayhome was defined, LEAVING one of those locations will set reading 'wayhome' to '1' as well. So you actually have implicit and explicit options to trigger wayhome.<br>
|
||||
Arriving at home will reset the value of 'wayhome' to '0'.<br>
|
||||
<div style="margin-left: 2em">
|
||||
<u>Location correlation to state</u><br>
|
||||
<br>
|
||||
<div style="margin-left: 2em">
|
||||
Under specific circumstances, changing location will have an effect on the actual state as well.<br>
|
||||
<br>
|
||||
Whenever location is set to 'home', the state is set to 'home' if prior presence state was 'absent'. If attribute rg_locationHome was defined, all of those locations will trigger state change to 'home' as well.<br>
|
||||
<br>
|
||||
Whenever location is set to 'underway', the state is set to 'absent' if prior presence state was 'present'. If attribute rg_locationUnderway was defined, all of those locations will trigger state change to 'absent' as well. Those locations won't appear in reading 'lastLocation'.<br>
|
||||
<br>
|
||||
Whenever location is set to 'wayhome', the reading 'wayhome' is set to '1' if current presence state is 'absent'. If attribute rg_locationWayhome was defined, LEAVING one of those locations will set reading 'wayhome' to '1' as well. So you actually have implicit and explicit options to trigger wayhome.<br>
|
||||
Arriving at home will reset the value of 'wayhome' to '0'.<br>
|
||||
<br>
|
||||
If you are using the <a href="#GEOFANCY">GEOFANCY</a> module, you can easily have your location updated with GEOFANCY events by defining a simple NOTIFY-trigger like this:<br>
|
||||
<br>
|
||||
<code>define n_rg_Guest.location notify geofancy:currLoc_Guest.* set rg_Guest location $EVTPART1</code><br>
|
||||
<br>
|
||||
By defining geofencing zones called 'home' and 'wayhome' in the iOS app, you automatically get all the features of automatic state changes described above.
|
||||
</div>
|
||||
</div><br>
|
||||
<br>
|
||||
If you are using the <a href="#GEOFANCY">GEOFANCY</a> module, you can easily have your location updated with GEOFANCY events by defining a simple NOTIFY-trigger like this:<br>
|
||||
<a name="GUESTattr" id="GUESTattr"></a> <b>Attributes</b><br>
|
||||
<div style="margin-left: 2em">
|
||||
<ul>
|
||||
<li>
|
||||
<b>rg_autoGoneAfter</b> - hours after which state should be auto-set to 'gone' when current state is 'absent'; defaults to 16 hours
|
||||
</li>
|
||||
<li>
|
||||
<b>rg_locationHome</b> - locations matching these will be treated as being at home; first entry reflects default value to be used with state correlation; separate entries by space; defaults to 'home'
|
||||
</li>
|
||||
<li>
|
||||
<b>rg_locationUnderway</b> - locations matching these will be treated as being underway; first entry reflects default value to be used with state correlation; separate entries by comma or space; defaults to "underway"
|
||||
</li>
|
||||
<li>
|
||||
<b>rg_locationWayhome</b> - leaving a location matching these will set reading wayhome to 1; separate entries by space; defaults to "wayhome"
|
||||
</li>
|
||||
<li>
|
||||
<b>rg_locations</b> - list of locations to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces
|
||||
</li>
|
||||
<li>
|
||||
<b>rg_moodDefault</b> - the mood that should be set after arriving at home or changing state from awoken to home
|
||||
</li>
|
||||
<li>
|
||||
<b>rg_moodSleepy</b> - the mood that should be set if state was changed to gotosleep or awoken
|
||||
</li>
|
||||
<li>
|
||||
<b>rg_moods</b> - list of moods to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces
|
||||
</li>
|
||||
<li>
|
||||
<b>rg_passPresenceTo</b> - synchronize presence state with other GUEST or GUEST devices; separte devices by space
|
||||
</li>
|
||||
<li>
|
||||
<b>rg_realname</b> - whenever GUEST wants to use the realname it uses the value of attribute alias or group; defaults to group
|
||||
</li>
|
||||
<li>
|
||||
<b>rg_showAllStates</b> - states 'asleep' and 'awoken' are hidden by default to allow simple gotosleep process via devStateIcon; defaults to 0
|
||||
</li>
|
||||
<li>
|
||||
<b>rg_states</b> - list of states to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces; unsupported states will lead to errors though
|
||||
</li>
|
||||
</ul>
|
||||
</div><br>
|
||||
<br>
|
||||
<code>
|
||||
define n_rg_Guest.location notify geofancy:currLoc_Guest.* set rg_Guest location $EVTPART1
|
||||
</code><br>
|
||||
<br>
|
||||
By defining geofencing zones called 'home' and 'wayhome' in the iOS app, you automatically get all the features of automatic state changes described above.
|
||||
</ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<a name="GUESTattr"></a>
|
||||
<b>Attributes</b><br>
|
||||
<ul><ul>
|
||||
<li><b>rg_autoGoneAfter</b> - hours after which state should be auto-set to 'gone' when current state is 'absent'; defaults to 16 hours</li>
|
||||
<li><b>rg_locationHome</b> - locations matching these will be treated as being at home; first entry reflects default value to be used with state correlation; separate entries by space; defaults to 'home'</li>
|
||||
<li><b>rg_locationUnderway</b> - locations matching these will be treated as being underway; first entry reflects default value to be used with state correlation; separate entries by comma or space; defaults to "underway"</li>
|
||||
<li><b>rg_locationWayhome</b> - leaving a location matching these will set reading wayhome to 1; separate entries by space; defaults to "wayhome"</li>
|
||||
<li><b>rg_locations</b> - list of locations to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces</li>
|
||||
<li><b>rg_moodDefault</b> - the mood that should be set after arriving at home or changing state from awoken to home</li>
|
||||
<li><b>rg_moodSleepy</b> - the mood that should be set if state was changed to gotosleep or awoken</li>
|
||||
<li><b>rg_moods</b> - list of moods to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces</li>
|
||||
<li><b>rg_passPresenceTo</b> - synchronize presence state with other GUEST or GUEST devices; separte devices by space</li>
|
||||
<li><b>rg_realname</b> - whenever GUEST wants to use the realname it uses the value of attribute alias or group; defaults to group</li>
|
||||
<li><b>rg_showAllStates</b> - states 'asleep' and 'awoken' are hidden by default to allow simple gotosleep process via devStateIcon; defaults to 0</li>
|
||||
<li><b>rg_states</b> - list of states to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces; unsupported states will lead to errors though</li>
|
||||
</ul></ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<b>Generated Readings/Events:</b><br>
|
||||
<ul><ul>
|
||||
<li><b>durTimerAbsence</b> - timer to show the duration of absence from home in minutes</li>
|
||||
<li><b>durTimerPresence</b> - timer to show the duration of presence at home in minutes</li>
|
||||
<li><b>durTimerSleep</b> - timer to show the duration of sleep in minutes</li>
|
||||
<li><b>lastArrival</b> - timestamp of last arrival at home</li>
|
||||
<li><b>lastAwake</b> - timestamp of last sleep cycle end</li>
|
||||
<li><b>lastDeparture</b> - timestamp of last departure from home</li>
|
||||
<li><b>lastDurAbsence</b> - duration of last absence from home in following format: hours:minutes:seconds</li>
|
||||
<li><b>lastDurPresence</b> - duration of last presence at home in following format: hours:minutes:seconds</li>
|
||||
<li><b>lastDurSleep</b> - duration of last sleep in following format: hours:minutes:seconds</li>
|
||||
<li><b>lastLocation</b> - the prior location</li>
|
||||
<li><b>lastMood</b> - the prior mood</li>
|
||||
<li><b>lastSleep</b> - timestamp of last sleep cycle begin</li>
|
||||
<li><b>lastState</b> - the prior state</li>
|
||||
<li><b>location</b> - the current location</li>
|
||||
<li><b>presence</b> - reflects the home presence state, depending on value of reading 'state' (can be 'present' or 'absent')</li>
|
||||
<li><b>mood</b> - the current mood</li>
|
||||
<li><b>state</b> - reflects the current state</li>
|
||||
<li><b>wayhome</b> - depending on current location, it can become '1' if individual is on his/her way back home</li><br>
|
||||
<br>
|
||||
The following readings will be set to '-' if state was changed to 'none':<br>
|
||||
lastArrival, lastDurAbsence, lastLocation, lastMood, location, mood
|
||||
</ul></ul>
|
||||
|
||||
</ul>
|
||||
<b>Generated Readings/Events:</b><br>
|
||||
<div style="margin-left: 2em">
|
||||
<ul>
|
||||
<li>
|
||||
<b>durTimerAbsence</b> - timer to show the duration of absence from home in minutes
|
||||
</li>
|
||||
<li>
|
||||
<b>durTimerPresence</b> - timer to show the duration of presence at home in minutes
|
||||
</li>
|
||||
<li>
|
||||
<b>durTimerSleep</b> - timer to show the duration of sleep in minutes
|
||||
</li>
|
||||
<li>
|
||||
<b>lastArrival</b> - timestamp of last arrival at home
|
||||
</li>
|
||||
<li>
|
||||
<b>lastAwake</b> - timestamp of last sleep cycle end
|
||||
</li>
|
||||
<li>
|
||||
<b>lastDeparture</b> - timestamp of last departure from home
|
||||
</li>
|
||||
<li>
|
||||
<b>lastDurAbsence</b> - duration of last absence from home in following format: hours:minutes:seconds
|
||||
</li>
|
||||
<li>
|
||||
<b>lastDurPresence</b> - duration of last presence at home in following format: hours:minutes:seconds
|
||||
</li>
|
||||
<li>
|
||||
<b>lastDurSleep</b> - duration of last sleep in following format: hours:minutes:seconds
|
||||
</li>
|
||||
<li>
|
||||
<b>lastLocation</b> - the prior location
|
||||
</li>
|
||||
<li>
|
||||
<b>lastMood</b> - the prior mood
|
||||
</li>
|
||||
<li>
|
||||
<b>lastSleep</b> - timestamp of last sleep cycle begin
|
||||
</li>
|
||||
<li>
|
||||
<b>lastState</b> - the prior state
|
||||
</li>
|
||||
<li>
|
||||
<b>location</b> - the current location
|
||||
</li>
|
||||
<li>
|
||||
<b>presence</b> - reflects the home presence state, depending on value of reading 'state' (can be 'present' or 'absent')
|
||||
</li>
|
||||
<li>
|
||||
<b>mood</b> - the current mood
|
||||
</li>
|
||||
<li>
|
||||
<b>state</b> - reflects the current state
|
||||
</li>
|
||||
<li>
|
||||
<b>wayhome</b> - depending on current location, it can become '1' if individual is on his/her way back home
|
||||
</li>
|
||||
<li style="list-style: none">
|
||||
<br>
|
||||
<br>
|
||||
The following readings will be set to '-' if state was changed to 'none':<br>
|
||||
lastArrival, lastDurAbsence, lastLocation, lastMood, location, mood
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
=end html
|
||||
|
||||
=begin html_DE
|
||||
|
||||
<a name="GUEST"></a>
|
||||
<h3>GUEST</h3>
|
||||
<ul>
|
||||
|
||||
<a name="GUESTdefine"></a>
|
||||
<b>Define</b>
|
||||
<ul>
|
||||
<code>define <rg_FirstName> GUEST [<Device Name der Bewohnergruppe>]</code>
|
||||
<br><br>
|
||||
|
||||
Stellt ein spezielles Dummy Device bereit, welches einen Gast repräsentiert.<br>
|
||||
Basierend auf dem aktuelle Status und anderen Readings können andere Aktionen innerhalb von FHEM angestoßen werden.<br><br>
|
||||
Wird vom übergeordneten Modul <a href="#RESIDENTS">RESIDENTS</a> verwendet, kann aber auch einzeln benutzt werden.<br><br>
|
||||
|
||||
Beispiele:<br>
|
||||
<ul><code>
|
||||
# Einzeln<br>
|
||||
define rg_Guest GUEST
|
||||
<br><br>
|
||||
# Typisches Gruppenmitglied<br>
|
||||
define rg_Guest GUEST rgr_Residents # um Mitglied der Gruppe rgr_Residents zu sein
|
||||
<br><br>
|
||||
# Mitglied in mehreren Gruppen<br>
|
||||
define rg_Guest GUEST rgr_Residents,rgr_Guests # um Mitglied den Gruppen rgr_Residents und rgr_Guests zu sein
|
||||
</code></ul>
|
||||
</ul><br>
|
||||
|
||||
<ul>Bitte beachten, dass das RESIDENTS Gruppen Device zunächst angelegt werden muss, bevor ein GUEST Objekt dort Mitglied werden kann.</ul><br>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<a name="GUESTset"></a>
|
||||
<b>Set</b>
|
||||
<ul>
|
||||
<code>set <rg_FirstName> <command> [<parameter>]</code>
|
||||
<br><br>
|
||||
Momentan sind die folgenden Kommandos definiert.<br>
|
||||
<ul>
|
||||
<li><b>location</b> - setzt das Reading 'location'; siehe auch Attribut rg_locations, um die in FHEMWEB angezeigte Liste anzupassen</li>
|
||||
<li><b>mood</b> - setzt das Reading 'mood'; siehe auch Attribut rg_moods, um die in FHEMWEB angezeigte Liste anzupassen</li>
|
||||
<li><b>state</b> home,gotosleep,asleep,awoken,absent,gone wechselt den Status; siehe auch Attribut rg_states, um die in FHEMWEB angezeigte Liste anzupassen</li>
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
<br><br>
|
||||
<ul>
|
||||
<u>Mögliche Stati und ihre Bedeutung</u><br><br>
|
||||
<ul>
|
||||
Dieses Modul unterscheidet 6 verschiedene Stati:<br><br>
|
||||
|
||||
<ul>
|
||||
<li><b>home</b> - Mitbrwohner ist zuhause und wach</li>
|
||||
<li><b>gotosleep</b> - Mitbewohner ist auf dem Weg ins Bett</li>
|
||||
<li><b>asleep</b> - Mitbewohner schläft</li>
|
||||
<li><b>awoken</b> - Mitbewohner ist gerade aufgewacht</li>
|
||||
<li><b>absent</b> - Mitbewohner ist momentan nicht zuhause, wird aber bald zurück sein</li>
|
||||
<li><b>none</b> - Gast Device ist deaktiviert</li>
|
||||
</ul>
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<ul>
|
||||
<u>Zusammenhang zwischen Anwesenheit/Presence und Aufenthaltsort/Location</u><br><br>
|
||||
<ul>
|
||||
Unter bestimmten Umständen führt der Wechsel des Status auch zu einer Änderung des Readings 'location'.<br>
|
||||
<p>
|
||||
<a name="GUEST" id="GUEST"></a>
|
||||
</p>
|
||||
<h3>
|
||||
GUEST
|
||||
</h3>
|
||||
<div style="margin-left: 2em">
|
||||
<a name="GUESTdefine" id="GUESTdefine"></a> <b>Define</b>
|
||||
<div style="margin-left: 2em">
|
||||
<code>define <rg_FirstName> GUEST [<Device Name der Bewohnergruppe>]</code><br>
|
||||
<br>
|
||||
Stellt ein spezielles Dummy Device bereit, welches einen Gast repräsentiert.<br>
|
||||
Basierend auf dem aktuelle Status und anderen Readings können andere Aktionen innerhalb von FHEM angestoßen werden.<br>
|
||||
<br>
|
||||
Wird vom übergeordneten Modul <a href="#RESIDENTS">RESIDENTS</a> verwendet, kann aber auch einzeln benutzt werden.<br>
|
||||
<br>
|
||||
Beispiele:<br>
|
||||
<div style="margin-left: 2em">
|
||||
<code># Einzeln<br>
|
||||
define rg_Guest GUEST<br>
|
||||
<br>
|
||||
# Typisches Gruppenmitglied<br>
|
||||
define rg_Guest GUEST rgr_Residents # um Mitglied der Gruppe rgr_Residents zu sein<br>
|
||||
<br>
|
||||
# Mitglied in mehreren Gruppen<br>
|
||||
define rg_Guest GUEST rgr_Residents,rgr_Guests # um Mitglied den Gruppen rgr_Residents und rgr_Guests zu sein</code>
|
||||
</div>
|
||||
</div><br>
|
||||
<div style="margin-left: 2em">
|
||||
Bitte beachten, dass das RESIDENTS Gruppen Device zunächst angelegt werden muss, bevor ein GUEST Objekt dort Mitglied werden kann.
|
||||
</div><br>
|
||||
<br>
|
||||
Wannimmer die Anwesenheit (bzw. das Reading 'presence') von 'absent' auf 'present' wechselt, wird 'location' auf 'home' gesetzt. Sofern das Attribut rg_locationHome gesetzt ist, wird die erste Lokation daraus anstelle von 'home' verwendet.<br>
|
||||
<br>
|
||||
Wannimmer die Anwesenheit (bzw. das Reading 'presence') von 'present' auf 'absent' wechselt, wird 'location' auf 'underway' gesetzt. Sofern das Attribut rg_locationUnderway gesetzt ist, wird die erste Lokation daraus anstelle von 'underway' verwendet.
|
||||
</ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<ul>
|
||||
<u>Auto-Status 'gone'</u><br><br>
|
||||
<ul>
|
||||
Immer wenn ein Mitbewohner auf 'absent' gesetzt wird, wird ein Zähler gestartet, der nach einer bestimmten Zeit den Status automatisch auf 'gone' setzt.<br>
|
||||
Der Standard ist nach 16 Stunden.<br>
|
||||
<a name="GUESTset" id="GUESTset"></a> <b>Set</b>
|
||||
<div style="margin-left: 2em">
|
||||
<code>set <rg_FirstName> <command> [<parameter>]</code><br>
|
||||
<br>
|
||||
Momentan sind die folgenden Kommandos definiert.<br>
|
||||
<ul>
|
||||
<li>
|
||||
<b>location</b> - setzt das Reading 'location'; siehe auch Attribut rg_locations, um die in FHEMWEB angezeigte Liste anzupassen
|
||||
</li>
|
||||
<li>
|
||||
<b>mood</b> - setzt das Reading 'mood'; siehe auch Attribut rg_moods, um die in FHEMWEB angezeigte Liste anzupassen
|
||||
</li>
|
||||
<li>
|
||||
<b>state</b> home,gotosleep,asleep,awoken,absent,gone wechselt den Status; siehe auch Attribut rg_states, um die in FHEMWEB angezeigte Liste anzupassen
|
||||
</li>
|
||||
</ul>
|
||||
</div><br>
|
||||
<br>
|
||||
Dieses Verhalten kann über das Attribut rg_autoGoneAfter angepasst werden.
|
||||
</ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<ul>
|
||||
<u>Anwesenheit mit anderen GUEST oder ROOMMATE Devices synchronisieren</u><br><br>
|
||||
<ul>
|
||||
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.<br>
|
||||
Durch das Setzen des Attributs rg_PassPresenceTo folgen die dort aufgeführten Mitbewohner ihren eigenen Statusänderungen nach 'home', 'absent' oder 'gone'.<br>
|
||||
<div style="margin-left: 2em">
|
||||
<u>Mögliche Stati und ihre Bedeutung</u><br>
|
||||
<br>
|
||||
<div style="margin-left: 2em">
|
||||
Dieses Modul unterscheidet 6 verschiedene Stati:<br>
|
||||
<br>
|
||||
<ul>
|
||||
<li>
|
||||
<b>home</b> - Mitbrwohner ist zuhause und wach
|
||||
</li>
|
||||
<li>
|
||||
<b>gotosleep</b> - Mitbewohner ist auf dem Weg ins Bett
|
||||
</li>
|
||||
<li>
|
||||
<b>asleep</b> - Mitbewohner schläft
|
||||
</li>
|
||||
<li>
|
||||
<b>awoken</b> - Mitbewohner ist gerade aufgewacht
|
||||
</li>
|
||||
<li>
|
||||
<b>absent</b> - Mitbewohner ist momentan nicht zuhause, wird aber bald zurück sein
|
||||
</li>
|
||||
<li>
|
||||
<b>none</b> - Gast Device ist deaktiviert
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><br>
|
||||
<br>
|
||||
Bitte beachten, dass Mitbewohner mit dem aktuellen Status 'none' oder 'gone' (im Falle von ROOMMATE Devices) nicht beachtet werden.
|
||||
</ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<ul>
|
||||
<u>Zusammenhang zwischen Aufenthaltsort/Location und Anwesenheit/Presence</u><br><br>
|
||||
<ul>
|
||||
Unter bestimmten Umständen hat der Wechsel des Readings 'location' auch einen Einfluss auf den tatsächlichen Status.<br>
|
||||
<div style="margin-left: 2em">
|
||||
<u>Zusammenhang zwischen Anwesenheit/Presence und Aufenthaltsort/Location</u><br>
|
||||
<br>
|
||||
<div style="margin-left: 2em">
|
||||
Unter bestimmten Umständen führt der Wechsel des Status auch zu einer Änderung des Readings 'location'.<br>
|
||||
<br>
|
||||
Wannimmer die Anwesenheit (bzw. das Reading 'presence') von 'absent' auf 'present' wechselt, wird 'location' auf 'home' gesetzt. Sofern das Attribut rg_locationHome gesetzt ist, wird die erste Lokation daraus anstelle von 'home' verwendet.<br>
|
||||
<br>
|
||||
Wannimmer die Anwesenheit (bzw. das Reading 'presence') von 'present' auf 'absent' wechselt, wird 'location' auf 'underway' gesetzt. Sofern das Attribut rg_locationUnderway gesetzt ist, wird die erste Lokation daraus anstelle von 'underway' verwendet.
|
||||
</div>
|
||||
</div><br>
|
||||
<br>
|
||||
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 rg_locationHome gesetzt wurde, so lösen alle dort angegebenen Lokationen einen Statuswechsel nach 'home' aus.<br>
|
||||
<div style="margin-left: 2em">
|
||||
<u>Auto-Status 'gone'</u><br>
|
||||
<br>
|
||||
<div style="margin-left: 2em">
|
||||
Immer wenn ein Mitbewohner auf 'absent' gesetzt wird, wird ein Zähler gestartet, der nach einer bestimmten Zeit den Status automatisch auf 'gone' setzt.<br>
|
||||
Der Standard ist nach 16 Stunden.<br>
|
||||
<br>
|
||||
Dieses Verhalten kann über das Attribut rg_autoGoneAfter angepasst werden.
|
||||
</div>
|
||||
</div><br>
|
||||
<br>
|
||||
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 rg_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.<br>
|
||||
<div style="margin-left: 2em">
|
||||
<u>Anwesenheit mit anderen GUEST oder ROOMMATE Devices synchronisieren</u><br>
|
||||
<br>
|
||||
<div style="margin-left: 2em">
|
||||
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.<br>
|
||||
Durch das Setzen des Attributs rg_PassPresenceTo folgen die dort aufgeführten Mitbewohner ihren eigenen Statusänderungen nach 'home', 'absent' oder 'gone'.<br>
|
||||
<br>
|
||||
Bitte beachten, dass Mitbewohner mit dem aktuellen Status 'none' oder 'gone' (im Falle von ROOMMATE Devices) nicht beachtet werden.
|
||||
</div>
|
||||
</div><br>
|
||||
<br>
|
||||
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 rg_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).<br>
|
||||
Die Ankunft zuhause setzt den Wert von 'wayhome' zurück auf '0'.<br>
|
||||
<div style="margin-left: 2em">
|
||||
<u>Zusammenhang zwischen Aufenthaltsort/Location und Anwesenheit/Presence</u><br>
|
||||
<br>
|
||||
<div style="margin-left: 2em">
|
||||
Unter bestimmten Umständen hat der Wechsel des Readings 'location' auch einen Einfluss auf den tatsächlichen Status.<br>
|
||||
<br>
|
||||
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 rg_locationHome gesetzt wurde, so lösen alle dort angegebenen Lokationen einen Statuswechsel nach 'home' aus.<br>
|
||||
<br>
|
||||
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 rg_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.<br>
|
||||
<br>
|
||||
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 rg_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).<br>
|
||||
Die Ankunft zuhause setzt den Wert von 'wayhome' zurück auf '0'.<br>
|
||||
<br>
|
||||
Wenn Sie auch das <a href="#GEOFANCY">GEOFANCY</a> Modul verwenden, können Sie das Reading 'location' ganz einfach über GEOFANCY Ereignisse aktualisieren lassen. Definieren Sie dazu einen NOTIFY-Trigger wie diesen:<br>
|
||||
<br>
|
||||
<code>define n_rg_Manfred.location notify geofancy:currLoc_Manfred.* set rg_Manfred location $EVTPART1</code><br>
|
||||
<br>
|
||||
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.
|
||||
</div>
|
||||
</div><br>
|
||||
<br>
|
||||
Wenn Sie auch das <a href="#GEOFANCY">GEOFANCY</a> Modul verwenden, können Sie das Reading 'location' ganz einfach über GEOFANCY Ereignisse aktualisieren lassen. Definieren Sie dazu einen NOTIFY-Trigger wie diesen:<br>
|
||||
<a name="GUESTattr" id="GUESTattr"></a> <b>Attribute</b><br>
|
||||
<div style="margin-left: 2em">
|
||||
<ul>
|
||||
<li>
|
||||
<b>rg_autoGoneAfter</b> - Anzahl der Stunden, nach denen sich der Status automatisch auf 'gone' ändert, wenn der aktuelle Status 'absent' ist; Standard ist 36 Stunden
|
||||
</li>
|
||||
<li>
|
||||
<b>rg_locationHome</b> - hiermit übereinstimmende Lokationen werden als zuhause gewertet; der erste Eintrag wird für das Zusammenspiel bei Statusänderungen benutzt; mehrere Einträge durch Leerzeichen trennen; Standard ist 'home'
|
||||
</li>
|
||||
<li>
|
||||
<b>rg_locationUnderway</b> - hiermit übereinstimmende Lokationen werden als unterwegs gewertet; der erste Eintrag wird für das Zusammenspiel bei Statusänderungen benutzt; mehrere Einträge durch Leerzeichen trennen; Standard ist 'underway'
|
||||
</li>
|
||||
<li>
|
||||
<b>rg_locationWayhome</b> - das Verlassen einer Lokation, die hier aufgeführt ist, lässt das Reading 'wayhome' auf '1' setzen; mehrere Einträge durch Leerzeichen trennen; Standard ist "wayhome"
|
||||
</li>
|
||||
<li>
|
||||
<b>rg_locations</b> - Liste der in FHEMWEB anzuzeigenden Lokationsauswahlliste in FHEMWEB; mehrere Einträge nur durch Komma trennen und KEINE Leerzeichen verwenden
|
||||
</li>
|
||||
<li>
|
||||
<b>rg_moodDefault</b> - die Stimmung, die nach Ankunft zuhause oder nach dem Statuswechsel von 'awoken' auf 'home' gesetzt werden soll
|
||||
</li>
|
||||
<li>
|
||||
<b>rg_moodSleepy</b> - die Stimmung, die nach Statuswechsel zu 'gotosleep' oder 'awoken' gesetzt werden soll
|
||||
</li>
|
||||
<li>
|
||||
<b>rg_moods</b> - Liste von Stimmungen, wie sie in FHEMWEB angezeigt werden sollen; mehrere Einträge nur durch Komma trennen und KEINE Leerzeichen verwenden
|
||||
</li>
|
||||
<li>
|
||||
<b>rg_passPresenceTo</b> - synchronisiere die Anwesenheit mit anderen GUEST oder ROOMMATE Devices; mehrere Devices durch Leerzeichen trennen
|
||||
</li>
|
||||
<li>
|
||||
<b>rg_realname</b> - wo immer GUEST den richtigen Namen verwenden möchte nutzt es den Wert des Attributs alias oder group; Standard ist group
|
||||
</li>
|
||||
<li>
|
||||
<b>rg_showAllStates</b> - die Stati 'asleep' und 'awoken' sind normalerweise nicht immer sichtbar, um einen einfachen Zubettgeh-Prozess über das devStateIcon Attribut zu ermöglichen; Standard ist 0
|
||||
</li>
|
||||
<li>
|
||||
<b>rg_states</b> - Liste aller in FHEMWEB angezeigter Stati; Eintrage nur mit Komma trennen und KEINE Leerzeichen benutzen; nicht unterstützte Stati führen zu Fehlern
|
||||
</li>
|
||||
</ul>
|
||||
</div><br>
|
||||
<br>
|
||||
<code>
|
||||
define n_rg_Manfred.location notify geofancy:currLoc_Manfred.* set rg_Manfred location $EVTPART1
|
||||
</code><br>
|
||||
<br>
|
||||
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.
|
||||
</ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<a name="GUESTattr"></a>
|
||||
<b>Attribute</b><br>
|
||||
<ul><ul>
|
||||
<li><b>rg_autoGoneAfter</b> - Anzahl der Stunden, nach denen sich der Status automatisch auf 'gone' ändert, wenn der aktuelle Status 'absent' ist; Standard ist 36 Stunden</li>
|
||||
<li><b>rg_locationHome</b> - hiermit übereinstimmende Lokationen werden als zuhause gewertet; der erste Eintrag wird für das Zusammenspiel bei Statusänderungen benutzt; mehrere Einträge durch Leerzeichen trennen; Standard ist 'home'</li>
|
||||
<li><b>rg_locationUnderway</b> - hiermit übereinstimmende Lokationen werden als unterwegs gewertet; der erste Eintrag wird für das Zusammenspiel bei Statusänderungen benutzt; mehrere Einträge durch Leerzeichen trennen; Standard ist 'underway'</li>
|
||||
<li><b>rg_locationWayhome</b> - das Verlassen einer Lokation, die hier aufgeführt ist, lässt das Reading 'wayhome' auf '1' setzen; mehrere Einträge durch Leerzeichen trennen; Standard ist "wayhome"</li>
|
||||
<li><b>rg_locations</b> - Liste der in FHEMWEB anzuzeigenden Lokationsauswahlliste in FHEMWEB; mehrere Einträge nur durch Komma trennen und KEINE Leerzeichen verwenden</li>
|
||||
<li><b>rg_moodDefault</b> - die Stimmung, die nach Ankunft zuhause oder nach dem Statuswechsel von 'awoken' auf 'home' gesetzt werden soll</li>
|
||||
<li><b>rg_moodSleepy</b> - die Stimmung, die nach Statuswechsel zu 'gotosleep' oder 'awoken' gesetzt werden soll</li>
|
||||
<li><b>rg_moods</b> - Liste von Stimmungen, wie sie in FHEMWEB angezeigt werden sollen; mehrere Einträge nur durch Komma trennen und KEINE Leerzeichen verwenden</li>
|
||||
<li><b>rg_passPresenceTo</b> - synchronisiere die Anwesenheit mit anderen GUEST oder ROOMMATE Devices; mehrere Devices durch Leerzeichen trennen</li>
|
||||
<li><b>rg_realname</b> - wo immer GUEST den richtigen Namen verwenden möchte nutzt es den Wert des Attributs alias oder group; Standard ist group</li>
|
||||
<li><b>rg_showAllStates</b> - die Stati 'asleep' und 'awoken' sind normalerweise nicht immer sichtbar, um einen einfachen Zubettgeh-Prozess über das devStateIcon Attribut zu ermöglichen; Standard ist 0</li>
|
||||
<li><b>rg_states</b> - Liste aller in FHEMWEB angezeigter Stati; Eintrage nur mit Komma trennen und KEINE Leerzeichen benutzen; nicht unterstützte Stati führen zu Fehlern</li>
|
||||
</ul></ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<b>Generierte Readings/Events:</b><br>
|
||||
<ul><ul>
|
||||
<li><b>durTimerAbsence</b> - Timer, der die Dauer der Abwesenheit in Minuten anzeigt</li>
|
||||
<li><b>durTimerPresence</b> - Timer, der die Dauer der Anwesenheit in Minuten anzeigt</li>
|
||||
<li><b>durTimerSleep</b> - Timer, der die Schlafdauer in Minuten anzeigt/li>
|
||||
<li><b>lastArrival</b> - Zeitstempel der letzten Ankunft zu Hause</li>
|
||||
<li><b>lastAwake</b> - Zeitstempel des Endes des letzten Schlafzyklus</li>
|
||||
<li><b>lastDeparture</b> - Zeitstempel des letzten Verlassens des Zuhauses</li>
|
||||
<li><b>lastDurAbsence</b> - Dauer der letzten Abwesenheit im folgenden Format: Stunden:Minuten:Sekunden</li>
|
||||
<li><b>lastDurPresence</b> - Dauer der letzten Anwesenheit im folgenden Format: Stunden:Minuten:Sekunden</li>
|
||||
<li><b>lastDurSleep</b> - Dauer des letzten Schlafzyklus im folgenden Format: Stunden:Minuten:Sekunden</li>
|
||||
<li><b>lastLocation</b> - der vorherige Aufenthaltsort</li>
|
||||
<li><b>lastMood</b> - die vorherige Stimmung</li>
|
||||
<li><b>lastSleep</b> - Zeitstempel des Beginns des letzten Schlafzyklus</li>
|
||||
<li><b>lastState</b> - der vorherige Status</li>
|
||||
<li><b>location</b> - der aktuelle Aufenthaltsort</li>
|
||||
<li><b>presence</b> - gibt den Zuhause Status in Abhängigkeit des Readings 'state' wieder (kann 'present' oder 'absent' sein)</li>
|
||||
<li><b>mood</b> - die aktuelle Stimmung</li>
|
||||
<li><b>state</b> - gibt den aktuellen Status wieder</li>
|
||||
<li><b>wayhome</b> - abhängig vom aktullen Aufenthaltsort, kann der Wert '1' werden, wenn die Person auf dem weg zurück nach Hause ist</li>
|
||||
<br>
|
||||
Die folgenden Readings werden auf '-' gesetzt, sobald der Status auf 'none' steht:<br>
|
||||
lastArrival, lastDurAbsence, lastLocation, lastMood, location, mood
|
||||
</ul></ul>
|
||||
|
||||
</ul>
|
||||
<b>Generierte Readings/Events:</b><br>
|
||||
<div style="margin-left: 2em">
|
||||
<ul>
|
||||
<li>
|
||||
<b>durTimerAbsence</b> - Timer, der die Dauer der Abwesenheit in Minuten anzeigt
|
||||
</li>
|
||||
<li>
|
||||
<b>durTimerPresence</b> - Timer, der die Dauer der Anwesenheit in Minuten anzeigt
|
||||
</li>
|
||||
<li>
|
||||
<b>durTimerSleep</b> - Timer, der die Schlafdauer in Minuten anzeigt/li>
|
||||
</li>
|
||||
<li>
|
||||
<b>lastArrival</b> - Zeitstempel der letzten Ankunft zu Hause
|
||||
</li>
|
||||
<li>
|
||||
<b>lastAwake</b> - Zeitstempel des Endes des letzten Schlafzyklus
|
||||
</li>
|
||||
<li>
|
||||
<b>lastDeparture</b> - Zeitstempel des letzten Verlassens des Zuhauses
|
||||
</li>
|
||||
<li>
|
||||
<b>lastDurAbsence</b> - Dauer der letzten Abwesenheit im folgenden Format: Stunden:Minuten:Sekunden
|
||||
</li>
|
||||
<li>
|
||||
<b>lastDurPresence</b> - Dauer der letzten Anwesenheit im folgenden Format: Stunden:Minuten:Sekunden
|
||||
</li>
|
||||
<li>
|
||||
<b>lastDurSleep</b> - Dauer des letzten Schlafzyklus im folgenden Format: Stunden:Minuten:Sekunden
|
||||
</li>
|
||||
<li>
|
||||
<b>lastLocation</b> - der vorherige Aufenthaltsort
|
||||
</li>
|
||||
<li>
|
||||
<b>lastMood</b> - die vorherige Stimmung
|
||||
</li>
|
||||
<li>
|
||||
<b>lastSleep</b> - Zeitstempel des Beginns des letzten Schlafzyklus
|
||||
</li>
|
||||
<li>
|
||||
<b>lastState</b> - der vorherige Status
|
||||
</li>
|
||||
<li>
|
||||
<b>location</b> - der aktuelle Aufenthaltsort
|
||||
</li>
|
||||
<li>
|
||||
<b>presence</b> - gibt den Zuhause Status in Abhängigkeit des Readings 'state' wieder (kann 'present' oder 'absent' sein)
|
||||
</li>
|
||||
<li>
|
||||
<b>mood</b> - die aktuelle Stimmung
|
||||
</li>
|
||||
<li>
|
||||
<b>state</b> - gibt den aktuellen Status wieder
|
||||
</li>
|
||||
<li>
|
||||
<b>wayhome</b> - abhängig vom aktullen Aufenthaltsort, kann der Wert '1' werden, wenn die Person auf dem weg zurück nach Hause ist
|
||||
</li>
|
||||
<li style="list-style: none">
|
||||
<br>
|
||||
Die folgenden Readings werden auf '-' gesetzt, sobald der Status auf 'none' steht:<br>
|
||||
lastArrival, lastDurAbsence, lastLocation, lastMood, location, mood
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
=end html_DE
|
||||
|
||||
|
||||
@ -884,362 +884,502 @@ sub ROOMMATE_StartInternalTimers($$) {
|
||||
1;
|
||||
|
||||
=pod
|
||||
|
||||
=begin html
|
||||
|
||||
<a name="ROOMMATE"></a>
|
||||
<h3>ROOMMATE</h3>
|
||||
<ul>
|
||||
|
||||
<a name="ROOMMATEdefine"></a>
|
||||
<b>Define</b>
|
||||
<ul>
|
||||
<code>define <rr_FirstName> ROOMMATE [<device name of resident group>]</code>
|
||||
<br><br>
|
||||
|
||||
Provides a special dummy device to represent a resident of your home.<br>
|
||||
Based on the current state and other readings, you may trigger other actions within FHEM.<br><br>
|
||||
Used by superior module <a href="#RESIDENTS">RESIDENTS</a> but may also be used stand-alone.<br><br>
|
||||
|
||||
Example:<br>
|
||||
<ul><code>
|
||||
# Standalone<br>
|
||||
define rr_Manfred ROOMMATE
|
||||
<br><br>
|
||||
# Typical group member<br>
|
||||
define rr_Manfred ROOMMATE rgr_Residents # to be member of resident group rgr_Residents
|
||||
<br><br>
|
||||
# Member of multiple groups<br>
|
||||
define rr_Manfred ROOMMATE rgr_Residents,rgr_Parents # to be member of resident group rgr_Residents and rgr_Parents
|
||||
<br><br>
|
||||
# Complex family structure<br>
|
||||
define rr_Manfred ROOMMATE rgr_Residents,rgr_Parents # Parent<br>
|
||||
define rr_Lisa ROOMMATE rgr_Residents,rgr_Parents # Parent<br>
|
||||
define rr_Rick ROOMMATE rgr_Residents,rgr_Children # Child1<br>
|
||||
define rr_Alex ROOMMATE rgr_Residents,rgr_Children # Child2
|
||||
</code></ul>
|
||||
</ul><br>
|
||||
|
||||
<ul>Please note the RESIDENTS group device needs to be existing before a ROOMMATE device can become a member of it.</ul><br>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<a name="ROOMMATEset"></a>
|
||||
<b>Set</b>
|
||||
<ul>
|
||||
<code>set <rr_FirstName> <command> [<parameter>]</code>
|
||||
<br><br>
|
||||
Currently, the following commands are defined.<br>
|
||||
<ul>
|
||||
<li><b>location</b> - sets reading 'location'; see attribute rr_locations to adjust list shown in FHEMWEB</li>
|
||||
<li><b>mood</b> - sets reading 'mood'; see attribute rr_moods to adjust list shown in FHEMWEB</li>
|
||||
<li><b>state</b> home,gotosleep,asleep,awoken,absent,gone switch between states; see attribute rr_states to adjust list shown in FHEMWEB</li>
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
<br><br>
|
||||
<ul>
|
||||
<u>Possible states and their meaning</u><br><br>
|
||||
<ul>
|
||||
This module differs between 6 states:<br><br>
|
||||
|
||||
<ul>
|
||||
<li><b>home</b> - individual is present at home and awake</li>
|
||||
<li><b>gotosleep</b> - individual is on it's way to bed</li>
|
||||
<li><b>asleep</b> - individual is currently sleeping</li>
|
||||
<li><b>awoken</b> - individual just woke up from sleep</li>
|
||||
<li><b>absent</b> - individual is not present at home but will be back shortly</li>
|
||||
<li><b>gone</b> - individual is away from home for longer period</li>
|
||||
</ul>
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<ul>
|
||||
<u>Presence correlation to location</u><br><br>
|
||||
<ul>
|
||||
Under specific circumstances, changing state will automatically change reading 'location' as well.<br>
|
||||
<p>
|
||||
<a name="ROOMMATE" id="ROOMMATE"></a>
|
||||
</p>
|
||||
<h3>
|
||||
ROOMMATE
|
||||
</h3>
|
||||
<div style="margin-left: 2em">
|
||||
<a name="ROOMMATEdefine" id="ROOMMATEdefine"></a> <b>Define</b>
|
||||
<div style="margin-left: 2em">
|
||||
<code>define <rr_FirstName> ROOMMATE [<device name of resident group>]</code><br>
|
||||
<br>
|
||||
Provides a special dummy device to represent a resident of your home.<br>
|
||||
Based on the current state and other readings, you may trigger other actions within FHEM.<br>
|
||||
<br>
|
||||
Used by superior module <a href="#RESIDENTS">RESIDENTS</a> but may also be used stand-alone.<br>
|
||||
<br>
|
||||
Example:<br>
|
||||
<div style="margin-left: 2em">
|
||||
<code># Standalone<br>
|
||||
define rr_Manfred ROOMMATE<br>
|
||||
<br>
|
||||
# Typical group member<br>
|
||||
define rr_Manfred ROOMMATE rgr_Residents # to be member of resident group rgr_Residents<br>
|
||||
<br>
|
||||
# Member of multiple groups<br>
|
||||
define rr_Manfred ROOMMATE rgr_Residents,rgr_Parents # to be member of resident group rgr_Residents and rgr_Parents<br>
|
||||
<br>
|
||||
# Complex family structure<br>
|
||||
define rr_Manfred ROOMMATE rgr_Residents,rgr_Parents # Parent<br>
|
||||
define rr_Lisa ROOMMATE rgr_Residents,rgr_Parents # Parent<br>
|
||||
define rr_Rick ROOMMATE rgr_Residents,rgr_Children # Child1<br>
|
||||
define rr_Alex ROOMMATE rgr_Residents,rgr_Children # Child2</code>
|
||||
</div>
|
||||
</div><br>
|
||||
<div style="margin-left: 2em">
|
||||
Please note the RESIDENTS group device needs to be existing before a ROOMMATE device can become a member of it.
|
||||
</div><br>
|
||||
<br>
|
||||
Whenever presence state changes from 'absent' to 'present', the location is set to 'home'. If attribute rr_locationHome was defined, first location from it will be used as home location.<br>
|
||||
<br>
|
||||
Whenever presence state changes from 'present' to 'absent', the location is set to 'underway'. If attribute rr_locationUnderway was defined, first location from it will be used as underway location.
|
||||
</ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<ul>
|
||||
<u>Auto Gone</u><br><br>
|
||||
<ul>
|
||||
Whenever an individual is set to 'absent', a trigger is started to automatically change state to 'gone' after a specific timeframe.<br>
|
||||
Default value is 36 hours.<br>
|
||||
<a name="ROOMMATEset" id="ROOMMATEset"></a> <b>Set</b>
|
||||
<div style="margin-left: 2em">
|
||||
<code>set <rr_FirstName> <command> [<parameter>]</code><br>
|
||||
<br>
|
||||
Currently, the following commands are defined.<br>
|
||||
<ul>
|
||||
<li>
|
||||
<b>location</b> - sets reading 'location'; see attribute rr_locations to adjust list shown in FHEMWEB
|
||||
</li>
|
||||
<li>
|
||||
<b>mood</b> - sets reading 'mood'; see attribute rr_moods to adjust list shown in FHEMWEB
|
||||
</li>
|
||||
<li>
|
||||
<b>state</b> home,gotosleep,asleep,awoken,absent,gone switch between states; see attribute rr_states to adjust list shown in FHEMWEB
|
||||
</li>
|
||||
</ul>
|
||||
</div><br>
|
||||
<br>
|
||||
This behaviour can be customized by attribute rr_autoGoneAfter.
|
||||
</ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<ul>
|
||||
<u>Synchronizing presence with other ROOMMATE or GUEST devices</u><br><br>
|
||||
<ul>
|
||||
If you always leave or arrive at your house together with other roommates or guests, you may enable a synchronization of your presence state for certain individuals.<br>
|
||||
By setting attribute rr_passPresenceTo, those individuals will follow your presence state changes to 'home', 'absent' or 'gone' as you do them with your own device.<br>
|
||||
<div style="margin-left: 2em">
|
||||
<u>Possible states and their meaning</u><br>
|
||||
<br>
|
||||
<div style="margin-left: 2em">
|
||||
This module differs between 6 states:<br>
|
||||
<br>
|
||||
<ul>
|
||||
<li>
|
||||
<b>home</b> - individual is present at home and awake
|
||||
</li>
|
||||
<li>
|
||||
<b>gotosleep</b> - individual is on it's way to bed
|
||||
</li>
|
||||
<li>
|
||||
<b>asleep</b> - individual is currently sleeping
|
||||
</li>
|
||||
<li>
|
||||
<b>awoken</b> - individual just woke up from sleep
|
||||
</li>
|
||||
<li>
|
||||
<b>absent</b> - individual is not present at home but will be back shortly
|
||||
</li>
|
||||
<li>
|
||||
<b>gone</b> - individual is away from home for longer period
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><br>
|
||||
<br>
|
||||
Please note that individuals with current state 'gone' or 'none' (in case of guests) will not be touched.
|
||||
</ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<ul>
|
||||
<u>Location correlation to state</u><br><br>
|
||||
<ul>
|
||||
Under specific circumstances, changing location will have an effect on the actual state as well.<br>
|
||||
<div style="margin-left: 2em">
|
||||
<u>Presence correlation to location</u><br>
|
||||
<br>
|
||||
<div style="margin-left: 2em">
|
||||
Under specific circumstances, changing state will automatically change reading 'location' as well.<br>
|
||||
<br>
|
||||
Whenever presence state changes from 'absent' to 'present', the location is set to 'home'. If attribute rr_locationHome was defined, first location from it will be used as home location.<br>
|
||||
<br>
|
||||
Whenever presence state changes from 'present' to 'absent', the location is set to 'underway'. If attribute rr_locationUnderway was defined, first location from it will be used as underway location.
|
||||
</div>
|
||||
</div><br>
|
||||
<br>
|
||||
Whenever location is set to 'home', the state is set to 'home' if prior presence state was 'absent'. If attribute rr_locationHome was defined, all of those locations will trigger state change to 'home' as well.<br>
|
||||
<div style="margin-left: 2em">
|
||||
<u>Auto Gone</u><br>
|
||||
<br>
|
||||
<div style="margin-left: 2em">
|
||||
Whenever an individual is set to 'absent', a trigger is started to automatically change state to 'gone' after a specific timeframe.<br>
|
||||
Default value is 36 hours.<br>
|
||||
<br>
|
||||
This behaviour can be customized by attribute rr_autoGoneAfter.
|
||||
</div>
|
||||
</div><br>
|
||||
<br>
|
||||
Whenever location is set to 'underway', the state is set to 'absent' if prior presence state was 'present'. If attribute rr_locationUnderway was defined, all of those locations will trigger state change to 'absent' as well. Those locations won't appear in reading 'lastLocation'.<br>
|
||||
<div style="margin-left: 2em">
|
||||
<u>Synchronizing presence with other ROOMMATE or GUEST devices</u><br>
|
||||
<br>
|
||||
<div style="margin-left: 2em">
|
||||
If you always leave or arrive at your house together with other roommates or guests, you may enable a synchronization of your presence state for certain individuals.<br>
|
||||
By setting attribute rr_passPresenceTo, those individuals will follow your presence state changes to 'home', 'absent' or 'gone' as you do them with your own device.<br>
|
||||
<br>
|
||||
Please note that individuals with current state 'gone' or 'none' (in case of guests) will not be touched.
|
||||
</div>
|
||||
</div><br>
|
||||
<br>
|
||||
Whenever location is set to 'wayhome', the reading 'wayhome' is set to '1' if current presence state is 'absent'. If attribute rr_locationWayhome was defined, LEAVING one of those locations will set reading 'wayhome' to '1' as well. So you actually have implicit and explicit options to trigger wayhome.<br>
|
||||
Arriving at home will reset the value of 'wayhome' to '0'.<br>
|
||||
<div style="margin-left: 2em">
|
||||
<u>Location correlation to state</u><br>
|
||||
<br>
|
||||
<div style="margin-left: 2em">
|
||||
Under specific circumstances, changing location will have an effect on the actual state as well.<br>
|
||||
<br>
|
||||
Whenever location is set to 'home', the state is set to 'home' if prior presence state was 'absent'. If attribute rr_locationHome was defined, all of those locations will trigger state change to 'home' as well.<br>
|
||||
<br>
|
||||
Whenever location is set to 'underway', the state is set to 'absent' if prior presence state was 'present'. If attribute rr_locationUnderway was defined, all of those locations will trigger state change to 'absent' as well. Those locations won't appear in reading 'lastLocation'.<br>
|
||||
<br>
|
||||
Whenever location is set to 'wayhome', the reading 'wayhome' is set to '1' if current presence state is 'absent'. If attribute rr_locationWayhome was defined, LEAVING one of those locations will set reading 'wayhome' to '1' as well. So you actually have implicit and explicit options to trigger wayhome.<br>
|
||||
Arriving at home will reset the value of 'wayhome' to '0'.<br>
|
||||
<br>
|
||||
If you are using the <a href="#GEOFANCY">GEOFANCY</a> module, you can easily have your location updated with GEOFANCY events by defining a simple NOTIFY-trigger like this:<br>
|
||||
<br>
|
||||
<code>define n_rr_Manfred.location notify geofancy:currLoc_Manfred.* set rr_Manfred location $EVTPART1</code><br>
|
||||
<br>
|
||||
By defining geofencing zones called 'home' and 'wayhome' in the iOS app, you automatically get all the features of automatic state changes described above.
|
||||
</div>
|
||||
</div><br>
|
||||
<br>
|
||||
If you are using the <a href="#GEOFANCY">GEOFANCY</a> module, you can easily have your location updated with GEOFANCY events by defining a simple NOTIFY-trigger like this:<br>
|
||||
<a name="ROOMMATEattr" id="ROOMMATEattr"></a> <b>Attributes</b><br>
|
||||
<div style="margin-left: 2em">
|
||||
<ul>
|
||||
<li>
|
||||
<b>rr_autoGoneAfter</b> - hours after which state should be auto-set to 'gone' when current state is 'absent'; defaults to 36 hours
|
||||
</li>
|
||||
<li>
|
||||
<b>rr_locationHome</b> - locations matching these will be treated as being at home; first entry reflects default value to be used with state correlation; separate entries by space; defaults to 'home'
|
||||
</li>
|
||||
<li>
|
||||
<b>rr_locationUnderway</b> - locations matching these will be treated as being underway; first entry reflects default value to be used with state correlation; separate entries by comma or space; defaults to "underway"
|
||||
</li>
|
||||
<li>
|
||||
<b>rr_locationWayhome</b> - leaving a location matching these will set reading wayhome to 1; separate entries by space; defaults to "wayhome"
|
||||
</li>
|
||||
<li>
|
||||
<b>rr_locations</b> - list of locations to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces
|
||||
</li>
|
||||
<li>
|
||||
<b>rr_moodDefault</b> - the mood that should be set after arriving at home or changing state from awoken to home
|
||||
</li>
|
||||
<li>
|
||||
<b>rr_moodSleepy</b> - the mood that should be set if state was changed to gotosleep or awoken
|
||||
</li>
|
||||
<li>
|
||||
<b>rr_moods</b> - list of moods to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces
|
||||
</li>
|
||||
<li>
|
||||
<b>rr_passPresenceTo</b> - synchronize presence state with other ROOMMATE or GUEST devices; separte devices by space
|
||||
</li>
|
||||
<li>
|
||||
<b>rr_realname</b> - whenever ROOMMATE wants to use the realname it uses the value of attribute alias or group; defaults to group
|
||||
</li>
|
||||
<li>
|
||||
<b>rr_showAllStates</b> - states 'asleep' and 'awoken' are hidden by default to allow simple gotosleep process via devStateIcon; defaults to 0
|
||||
</li>
|
||||
<li>
|
||||
<b>rr_states</b> - list of states to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces; unsupported states will lead to errors though
|
||||
</li>
|
||||
</ul>
|
||||
</div><br>
|
||||
<br>
|
||||
<code>
|
||||
define n_rr_Manfred.location notify geofancy:currLoc_Manfred.* set rr_Manfred location $EVTPART1
|
||||
</code><br>
|
||||
<br>
|
||||
By defining geofencing zones called 'home' and 'wayhome' in the iOS app, you automatically get all the features of automatic state changes described above.
|
||||
</ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<a name="ROOMMATEattr"></a>
|
||||
<b>Attributes</b><br>
|
||||
<ul><ul>
|
||||
<li><b>rr_autoGoneAfter</b> - hours after which state should be auto-set to 'gone' when current state is 'absent'; defaults to 36 hours</li>
|
||||
<li><b>rr_locationHome</b> - locations matching these will be treated as being at home; first entry reflects default value to be used with state correlation; separate entries by space; defaults to 'home'</li>
|
||||
<li><b>rr_locationUnderway</b> - locations matching these will be treated as being underway; first entry reflects default value to be used with state correlation; separate entries by comma or space; defaults to "underway"</li>
|
||||
<li><b>rr_locationWayhome</b> - leaving a location matching these will set reading wayhome to 1; separate entries by space; defaults to "wayhome"</li>
|
||||
<li><b>rr_locations</b> - list of locations to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces</li>
|
||||
<li><b>rr_moodDefault</b> - the mood that should be set after arriving at home or changing state from awoken to home</li>
|
||||
<li><b>rr_moodSleepy</b> - the mood that should be set if state was changed to gotosleep or awoken</li>
|
||||
<li><b>rr_moods</b> - list of moods to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces</li>
|
||||
<li><b>rr_passPresenceTo</b> - synchronize presence state with other ROOMMATE or GUEST devices; separte devices by space</li>
|
||||
<li><b>rr_realname</b> - whenever ROOMMATE wants to use the realname it uses the value of attribute alias or group; defaults to group</li>
|
||||
<li><b>rr_showAllStates</b> - states 'asleep' and 'awoken' are hidden by default to allow simple gotosleep process via devStateIcon; defaults to 0</li>
|
||||
<li><b>rr_states</b> - list of states to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces; unsupported states will lead to errors though</li>
|
||||
</ul></ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<b>Generated Readings/Events:</b><br>
|
||||
<ul><ul>
|
||||
<li><b>durTimerAbsence</b> - timer to show the duration of absence from home in minutes</li>
|
||||
<li><b>durTimerPresence</b> - timer to show the duration of presence at home in minutes</li>
|
||||
<li><b>durTimerSleep</b> - timer to show the duration of sleep in minutes</li>
|
||||
<li><b>lastArrival</b> - timestamp of last arrival at home</li>
|
||||
<li><b>lastAwake</b> - timestamp of last sleep cycle end</li>
|
||||
<li><b>lastDeparture</b> - timestamp of last departure from home</li>
|
||||
<li><b>lastDurAbsence</b> - duration of last absence from home in following format: hours:minutes:seconds</li>
|
||||
<li><b>lastDurPresence</b> - duration of last presence at home in following format: hours:minutes:seconds</li>
|
||||
<li><b>lastDurSleep</b> - duration of last sleep in following format: hours:minutes:seconds</li>
|
||||
<li><b>lastLocation</b> - the prior location</li>
|
||||
<li><b>lastMood</b> - the prior mood</li>
|
||||
<li><b>lastSleep</b> - timestamp of last sleep cycle begin</li>
|
||||
<li><b>lastState</b> - the prior state</li>
|
||||
<li><b>location</b> - the current location</li>
|
||||
<li><b>presence</b> - reflects the home presence state, depending on value of reading 'state' (can be 'present' or 'absent')</li>
|
||||
<li><b>mood</b> - the current mood</li>
|
||||
<li><b>state</b> - reflects the current state</li>
|
||||
<li><b>wayhome</b> - depending on current location, it can become '1' if individual is on his/her way back home</li>
|
||||
</ul></ul>
|
||||
|
||||
</ul>
|
||||
<b>Generated Readings/Events:</b><br>
|
||||
<div style="margin-left: 2em">
|
||||
<ul>
|
||||
<li>
|
||||
<b>durTimerAbsence</b> - timer to show the duration of absence from home in minutes
|
||||
</li>
|
||||
<li>
|
||||
<b>durTimerPresence</b> - timer to show the duration of presence at home in minutes
|
||||
</li>
|
||||
<li>
|
||||
<b>durTimerSleep</b> - timer to show the duration of sleep in minutes
|
||||
</li>
|
||||
<li>
|
||||
<b>lastArrival</b> - timestamp of last arrival at home
|
||||
</li>
|
||||
<li>
|
||||
<b>lastAwake</b> - timestamp of last sleep cycle end
|
||||
</li>
|
||||
<li>
|
||||
<b>lastDeparture</b> - timestamp of last departure from home
|
||||
</li>
|
||||
<li>
|
||||
<b>lastDurAbsence</b> - duration of last absence from home in following format: hours:minutes:seconds
|
||||
</li>
|
||||
<li>
|
||||
<b>lastDurPresence</b> - duration of last presence at home in following format: hours:minutes:seconds
|
||||
</li>
|
||||
<li>
|
||||
<b>lastDurSleep</b> - duration of last sleep in following format: hours:minutes:seconds
|
||||
</li>
|
||||
<li>
|
||||
<b>lastLocation</b> - the prior location
|
||||
</li>
|
||||
<li>
|
||||
<b>lastMood</b> - the prior mood
|
||||
</li>
|
||||
<li>
|
||||
<b>lastSleep</b> - timestamp of last sleep cycle begin
|
||||
</li>
|
||||
<li>
|
||||
<b>lastState</b> - the prior state
|
||||
</li>
|
||||
<li>
|
||||
<b>location</b> - the current location
|
||||
</li>
|
||||
<li>
|
||||
<b>presence</b> - reflects the home presence state, depending on value of reading 'state' (can be 'present' or 'absent')
|
||||
</li>
|
||||
<li>
|
||||
<b>mood</b> - the current mood
|
||||
</li>
|
||||
<li>
|
||||
<b>state</b> - reflects the current state
|
||||
</li>
|
||||
<li>
|
||||
<b>wayhome</b> - depending on current location, it can become '1' if individual is on his/her way back home
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
=end html
|
||||
|
||||
=begin html_DE
|
||||
|
||||
<a name="ROOMMATE"></a>
|
||||
<h3>ROOMMATE</h3>
|
||||
<ul>
|
||||
|
||||
<a name="ROOMMATEdefine"></a>
|
||||
<b>Define</b>
|
||||
<ul>
|
||||
<code>define <rr_FirstName> ROOMMATE [<Device Name der Bewohnergruppe>]</code>
|
||||
<br><br>
|
||||
|
||||
Stellt ein spezielles Dummy Device bereit, welches einen Mitbewohner repräsentiert.<br>
|
||||
Basierend auf dem aktuelle Status und anderen Readings können andere Aktionen innerhalb von FHEM angestoßen werden.<br><br>
|
||||
Wird vom übergeordneten Modul <a href="#RESIDENTS">RESIDENTS</a> verwendet, kann aber auch einzeln benutzt werden.<br><br>
|
||||
|
||||
Beispiele:<br>
|
||||
<ul><code>
|
||||
# Einzeln<br>
|
||||
define rr_Manfred ROOMMATE
|
||||
<br><br>
|
||||
# Typisches Gruppenmitglied<br>
|
||||
define rr_Manfred ROOMMATE rgr_Residents # um Mitglied der Gruppe rgr_Residents zu sein
|
||||
<br><br>
|
||||
# Mitglied in mehreren Gruppen<br>
|
||||
define rr_Manfred ROOMMATE rgr_Residents,rgr_Parents # um Mitglied den Gruppen rgr_Residents und rgr_Parents zu sein
|
||||
<br><br>
|
||||
# Komplexe Familien Struktur<br>
|
||||
define rr_Manfred ROOMMATE rgr_Residents,rgr_Parents # Elternteil<br>
|
||||
define rr_Lisa ROOMMATE rgr_Residents,rgr_Parents # Elternteil<br>
|
||||
define rr_Rick ROOMMATE rgr_Residents,rgr_Children # Kind1<br>
|
||||
define rr_Alex ROOMMATE rgr_Residents,rgr_Children # Kind2
|
||||
</code></ul>
|
||||
</ul><br>
|
||||
|
||||
<ul>Bitte beachten, dass das RESIDENTS Gruppen Device zunächst angelegt werden muss, bevor ein ROOMMATE Objekt dort Mitglied werden kann.</ul><br>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<a name="ROOMMATEset"></a>
|
||||
<b>Set</b>
|
||||
<ul>
|
||||
<code>set <rr_FirstName> <command> [<parameter>]</code>
|
||||
<br><br>
|
||||
Momentan sind die folgenden Kommandos definiert.<br>
|
||||
<ul>
|
||||
<li><b>location</b> - setzt das Reading 'location'; siehe auch Attribut rr_locations, um die in FHEMWEB angezeigte Liste anzupassen</li>
|
||||
<li><b>mood</b> - setzt das Reading 'mood'; siehe auch Attribut rr_moods, um die in FHEMWEB angezeigte Liste anzupassen</li>
|
||||
<li><b>state</b> home,gotosleep,asleep,awoken,absent,gone wechselt den Status; siehe auch Attribut rr_states, um die in FHEMWEB angezeigte Liste anzupassen</li>
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
<br><br>
|
||||
<ul>
|
||||
<u>Mögliche Stati und ihre Bedeutung</u><br><br>
|
||||
<ul>
|
||||
Dieses Modul unterscheidet 6 verschiedene Stati:<br><br>
|
||||
|
||||
<ul>
|
||||
<li><b>home</b> - Mitbrwohner ist zuhause und wach</li>
|
||||
<li><b>gotosleep</b> - Mitbewohner ist auf dem Weg ins Bett</li>
|
||||
<li><b>asleep</b> - Mitbewohner schläft</li>
|
||||
<li><b>awoken</b> - Mitbewohner ist gerade aufgewacht</li>
|
||||
<li><b>absent</b> - Mitbewohner ist momentan nicht zuhause, wird aber bald zurück sein</li>
|
||||
<li><b>gone</b> - Mitbewohner ist für längere Zeit verreist</li>
|
||||
</ul>
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<ul>
|
||||
<u>Zusammenhang zwischen Anwesenheit/Presence und Aufenthaltsort/Location</u><br><br>
|
||||
<ul>
|
||||
Unter bestimmten Umständen führt der Wechsel des Status auch zu einer Änderung des Readings 'location'.<br>
|
||||
<br>
|
||||
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.<br>
|
||||
<br>
|
||||
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.
|
||||
</ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<ul>
|
||||
<u>Auto-Status 'gone'</u><br><br>
|
||||
<ul>
|
||||
Immer wenn ein Mitbewohner auf 'absent' gesetzt wird, wird ein Zähler gestartet, der nach einer bestimmten Zeit den Status automatisch auf 'gone' setzt.<br>
|
||||
Der Standard ist nach 36 Stunden.<br>
|
||||
<br>
|
||||
Dieses Verhalten kann über das Attribut rr_autoGoneAfter angepasst werden.
|
||||
</ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<ul>
|
||||
<u>Anwesenheit mit anderen ROOMMATE oder GUEST Devices synchronisieren</u><br><br>
|
||||
<ul>
|
||||
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.<br>
|
||||
Durch das Setzen des Attributs rr_PassPresenceTo folgen die dort aufgeführten Mitbewohner ihren eigenen Statusänderungen nach 'home', 'absent' oder 'gone'.<br>
|
||||
<br>
|
||||
Bitte beachten, dass Mitbewohner mit dem aktuellen Status 'gone' oder 'none' (im Falle von Gästen) nicht beachtet werden.
|
||||
</ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<ul>
|
||||
<u>Zusammenhang zwischen Aufenthaltsort/Location und Anwesenheit/Presence</u><br><br>
|
||||
<ul>
|
||||
Unter bestimmten Umständen hat der Wechsel des Readings 'location' auch einen Einfluss auf den tatsächlichen Status.<br>
|
||||
<br>
|
||||
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.<br>
|
||||
<br>
|
||||
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.<br>
|
||||
<br>
|
||||
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).<br>
|
||||
Die Ankunft zuhause setzt den Wert von 'wayhome' zurück auf '0'.<br>
|
||||
<br>
|
||||
Wenn Sie auch das <a href="#GEOFANCY">GEOFANCY</a> Modul verwenden, können Sie das Reading 'location' ganz einfach über GEOFANCY Ereignisse aktualisieren lassen. Definieren Sie dazu einen NOTIFY-Trigger wie diesen:<br>
|
||||
<br>
|
||||
<code>
|
||||
define n_rr_Manfred.location notify geofancy:currLoc_Manfred.* set rr_Manfred location $EVTPART1
|
||||
</code><br>
|
||||
<br>
|
||||
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.
|
||||
</ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<a name="ROOMMATEattr"></a>
|
||||
<b>Attribute</b><br>
|
||||
<ul><ul>
|
||||
<li><b>rr_autoGoneAfter</b> - Anzahl der Stunden, nach denen sich der Status automatisch auf 'gone' ändert, wenn der aktuelle Status 'absent' ist; Standard ist 36 Stunden</li>
|
||||
<li><b>rr_locationHome</b> - hiermit übereinstimmende Lokationen werden als zuhause gewertet; der erste Eintrag wird für das Zusammenspiel bei Statusänderungen benutzt; mehrere Einträge durch Leerzeichen trennen; Standard ist 'home'</li>
|
||||
<li><b>rr_locationUnderway</b> - hiermit übereinstimmende Lokationen werden als unterwegs gewertet; der erste Eintrag wird für das Zusammenspiel bei Statusänderungen benutzt; mehrere Einträge durch Leerzeichen trennen; Standard ist 'underway'</li>
|
||||
<li><b>rr_locationWayhome</b> - das Verlassen einer Lokation, die hier aufgeführt ist, lässt das Reading 'wayhome' auf '1' setzen; mehrere Einträge durch Leerzeichen trennen; Standard ist "wayhome"</li>
|
||||
<li><b>rr_locations</b> - Liste der in FHEMWEB anzuzeigenden Lokationsauswahlliste in FHEMWEB; mehrere Einträge nur durch Komma trennen und KEINE Leerzeichen verwenden</li>
|
||||
<li><b>rr_moodDefault</b> - die Stimmung, die nach Ankunft zuhause oder nach dem Statuswechsel von 'awoken' auf 'home' gesetzt werden soll</li>
|
||||
<li><b>rr_moodSleepy</b> - die Stimmung, die nach Statuswechsel zu 'gotosleep' oder 'awoken' gesetzt werden soll</li>
|
||||
<li><b>rr_moods</b> - Liste von Stimmungen, wie sie in FHEMWEB angezeigt werden sollen; mehrere Einträge nur durch Komma trennen und KEINE Leerzeichen verwenden</li>
|
||||
<li><b>rr_passPresenceTo</b> - synchronisiere die Anwesenheit mit anderen ROOMMATE oder GUEST Devices; mehrere Devices durch Leerzeichen trennen</li>
|
||||
<li><b>rr_realname</b> - wo immer ROOMMATE den richtigen Namen verwenden möchte nutzt es den Wert des Attributs alias oder group; Standard ist group</li>
|
||||
<li><b>rr_showAllStates</b> - die Stati 'asleep' und 'awoken' sind normalerweise nicht immer sichtbar, um einen einfachen Zubettgeh-Prozess über das devStateIcon Attribut zu ermöglichen; Standard ist 0</li>
|
||||
<li><b>rr_states</b> - Liste aller in FHEMWEB angezeigter Stati; Eintrage nur mit Komma trennen und KEINE Leerzeichen benutzen; nicht unterstützte Stati führen zu Fehlern</li>
|
||||
</ul></ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<b>Generierte Readings/Events:</b><br>
|
||||
<ul><ul>
|
||||
<li><b>durTimerAbsence</b> - Timer, der die Dauer der Abwesenheit in Minuten anzeigt</li>
|
||||
<li><b>durTimerPresence</b> - Timer, der die Dauer der Anwesenheit in Minuten anzeigt</li>
|
||||
<li><b>durTimerSleep</b> - Timer, der die Schlafdauer in Minuten anzeigt/li>
|
||||
<li><b>lastArrival</b> - Zeitstempel der letzten Ankunft zu Hause</li>
|
||||
<li><b>lastAwake</b> - Zeitstempel des Endes des letzten Schlafzyklus</li>
|
||||
<li><b>lastDeparture</b> - Zeitstempel des letzten Verlassens des Zuhauses</li>
|
||||
<li><b>lastDurAbsence</b> - Dauer der letzten Abwesenheit im folgenden Format: Stunden:Minuten:Sekunden</li>
|
||||
<li><b>lastDurPresence</b> - Dauer der letzten Anwesenheit im folgenden Format: Stunden:Minuten:Sekunden</li>
|
||||
<li><b>lastDurSleep</b> - Dauer des letzten Schlafzyklus im folgenden Format: Stunden:Minuten:Sekunden</li>
|
||||
<li><b>lastLocation</b> - der vorherige Aufenthaltsort</li>
|
||||
<li><b>lastMood</b> - die vorherige Stimmung</li>
|
||||
<li><b>lastSleep</b> - Zeitstempel des Beginns des letzten Schlafzyklus</li>
|
||||
<li><b>lastState</b> - der vorherige Status</li>
|
||||
<li><b>location</b> - der aktuelle Aufenthaltsort</li>
|
||||
<li><b>presence</b> - gibt den Zuhause Status in Abhängigkeit des Readings 'state' wieder (kann 'present' oder 'absent' sein)</li>
|
||||
|
||||
<li><b>mood</b> - die aktuelle Stimmung</li>
|
||||
<li><b>state</b> - gibt den aktuellen Status wieder</li>
|
||||
<li><b>wayhome</b> - abhängig vom aktullen Aufenthaltsort, kann der Wert '1' werden, wenn die Person auf dem weg zurück nach Hause ist</li>
|
||||
</ul></ul>
|
||||
|
||||
</ul>
|
||||
<p>
|
||||
<a name="ROOMMATE" id="ROOMMATE"></a>
|
||||
</p>
|
||||
<h3>
|
||||
ROOMMATE
|
||||
</h3>
|
||||
<div style="margin-left: 2em">
|
||||
<a name="ROOMMATEdefine" id="ROOMMATEdefine"></a> <b>Define</b>
|
||||
<div style="margin-left: 2em">
|
||||
<code>define <rr_FirstName> ROOMMATE [<Device Name der Bewohnergruppe>]</code><br />
|
||||
<br />
|
||||
Stellt ein spezielles Dummy Device bereit, welches einen Mitbewohner repräsentiert.<br />
|
||||
Basierend auf dem aktuelle Status und anderen Readings können andere Aktionen innerhalb von FHEM angestoßen werden.<br />
|
||||
<br />
|
||||
Wird vom übergeordneten Modul <a href="#RESIDENTS">RESIDENTS</a> verwendet, kann aber auch einzeln benutzt werden.<br />
|
||||
<br />
|
||||
Beispiele:<br />
|
||||
<div style="margin-left: 2em">
|
||||
<code># Einzeln<br />
|
||||
define rr_Manfred ROOMMATE<br />
|
||||
<br />
|
||||
# Typisches Gruppenmitglied<br />
|
||||
define rr_Manfred ROOMMATE rgr_Residents # um Mitglied der Gruppe rgr_Residents zu sein<br />
|
||||
<br />
|
||||
# Mitglied in mehreren Gruppen<br />
|
||||
define rr_Manfred ROOMMATE rgr_Residents,rgr_Parents # um Mitglied den Gruppen rgr_Residents und rgr_Parents zu sein<br />
|
||||
<br />
|
||||
# Komplexe Familien Struktur<br />
|
||||
define rr_Manfred ROOMMATE rgr_Residents,rgr_Parents # Elternteil<br />
|
||||
define rr_Lisa ROOMMATE rgr_Residents,rgr_Parents # Elternteil<br />
|
||||
define rr_Rick ROOMMATE rgr_Residents,rgr_Children # Kind1<br />
|
||||
define rr_Alex ROOMMATE rgr_Residents,rgr_Children # Kind2</code>
|
||||
</div>
|
||||
</div><br />
|
||||
<div style="margin-left: 2em">
|
||||
Bitte beachten, dass das RESIDENTS Gruppen Device zunächst angelegt werden muss, bevor ein ROOMMATE Objekt dort Mitglied werden kann.
|
||||
</div><br />
|
||||
<br />
|
||||
<br />
|
||||
<a name="ROOMMATEset" id="ROOMMATEset"></a> <b>Set</b>
|
||||
<div style="margin-left: 2em">
|
||||
<code>set <rr_FirstName> <command> [<parameter>]</code><br />
|
||||
<br />
|
||||
Momentan sind die folgenden Kommandos definiert.<br />
|
||||
<ul>
|
||||
<li>
|
||||
<b>location</b> - setzt das Reading 'location'; siehe auch Attribut rr_locations, um die in FHEMWEB angezeigte Liste anzupassen
|
||||
</li>
|
||||
<li>
|
||||
<b>mood</b> - setzt das Reading 'mood'; siehe auch Attribut rr_moods, um die in FHEMWEB angezeigte Liste anzupassen
|
||||
</li>
|
||||
<li>
|
||||
<b>state</b> home,gotosleep,asleep,awoken,absent,gone wechselt den Status; siehe auch Attribut rr_states, um die in FHEMWEB angezeigte Liste anzupassen
|
||||
</li>
|
||||
</ul>
|
||||
</div><br />
|
||||
<br />
|
||||
<div style="margin-left: 2em">
|
||||
<u>Mögliche Stati und ihre Bedeutung</u><br />
|
||||
<br />
|
||||
<div style="margin-left: 2em">
|
||||
Dieses Modul unterscheidet 6 verschiedene Stati:<br />
|
||||
<br />
|
||||
<ul>
|
||||
<li>
|
||||
<b>home</b> - Mitbrwohner ist zuhause und wach
|
||||
</li>
|
||||
<li>
|
||||
<b>gotosleep</b> - Mitbewohner ist auf dem Weg ins Bett
|
||||
</li>
|
||||
<li>
|
||||
<b>asleep</b> - Mitbewohner schläft
|
||||
</li>
|
||||
<li>
|
||||
<b>awoken</b> - Mitbewohner ist gerade aufgewacht
|
||||
</li>
|
||||
<li>
|
||||
<b>absent</b> - Mitbewohner ist momentan nicht zuhause, wird aber bald zurück sein
|
||||
</li>
|
||||
<li>
|
||||
<b>gone</b> - Mitbewohner ist für längere Zeit verreist
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><br />
|
||||
<br />
|
||||
<div style="margin-left: 2em">
|
||||
<u>Zusammenhang zwischen Anwesenheit/Presence und Aufenthaltsort/Location</u><br />
|
||||
<br />
|
||||
<div style="margin-left: 2em">
|
||||
Unter bestimmten Umständen führt der Wechsel des Status auch zu einer Änderung des Readings 'location'.<br />
|
||||
<br />
|
||||
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.<br />
|
||||
<br />
|
||||
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.
|
||||
</div>
|
||||
</div><br />
|
||||
<br />
|
||||
<div style="margin-left: 2em">
|
||||
<u>Auto-Status 'gone'</u><br />
|
||||
<br />
|
||||
<div style="margin-left: 2em">
|
||||
Immer wenn ein Mitbewohner auf 'absent' gesetzt wird, wird ein Zähler gestartet, der nach einer bestimmten Zeit den Status automatisch auf 'gone' setzt.<br />
|
||||
Der Standard ist nach 36 Stunden.<br />
|
||||
<br />
|
||||
Dieses Verhalten kann über das Attribut rr_autoGoneAfter angepasst werden.
|
||||
</div>
|
||||
</div><br />
|
||||
<br />
|
||||
<div style="margin-left: 2em">
|
||||
<u>Anwesenheit mit anderen ROOMMATE oder GUEST Devices synchronisieren</u><br />
|
||||
<br />
|
||||
<div style="margin-left: 2em">
|
||||
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.<br />
|
||||
Durch das Setzen des Attributs rr_PassPresenceTo folgen die dort aufgeführten Mitbewohner ihren eigenen Statusänderungen nach 'home', 'absent' oder 'gone'.<br />
|
||||
<br />
|
||||
Bitte beachten, dass Mitbewohner mit dem aktuellen Status 'gone' oder 'none' (im Falle von Gästen) nicht beachtet werden.
|
||||
</div>
|
||||
</div><br />
|
||||
<br />
|
||||
<div style="margin-left: 2em">
|
||||
<u>Zusammenhang zwischen Aufenthaltsort/Location und Anwesenheit/Presence</u><br />
|
||||
<br />
|
||||
<div style="margin-left: 2em">
|
||||
Unter bestimmten Umständen hat der Wechsel des Readings 'location' auch einen Einfluss auf den tatsächlichen Status.<br />
|
||||
<br />
|
||||
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.<br />
|
||||
<br />
|
||||
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.<br />
|
||||
<br />
|
||||
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).<br />
|
||||
Die Ankunft zuhause setzt den Wert von 'wayhome' zurück auf '0'.<br />
|
||||
<br />
|
||||
Wenn Sie auch das <a href="#GEOFANCY">GEOFANCY</a> Modul verwenden, können Sie das Reading 'location' ganz einfach über GEOFANCY Ereignisse aktualisieren lassen. Definieren Sie dazu einen NOTIFY-Trigger wie diesen:<br />
|
||||
<br />
|
||||
<code>define n_rr_Manfred.location notify geofancy:currLoc_Manfred.* set rr_Manfred location $EVTPART1</code><br />
|
||||
<br />
|
||||
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.
|
||||
</div>
|
||||
</div><br />
|
||||
<br />
|
||||
<a name="ROOMMATEattr" id="ROOMMATEattr"></a> <b>Attribute</b><br />
|
||||
<div style="margin-left: 2em">
|
||||
<ul>
|
||||
<li>
|
||||
<b>rr_autoGoneAfter</b> - Anzahl der Stunden, nach denen sich der Status automatisch auf 'gone' ändert, wenn der aktuelle Status 'absent' ist; Standard ist 36 Stunden
|
||||
</li>
|
||||
<li>
|
||||
<b>rr_locationHome</b> - hiermit übereinstimmende Lokationen werden als zuhause gewertet; der erste Eintrag wird für das Zusammenspiel bei Statusänderungen benutzt; mehrere Einträge durch Leerzeichen trennen; Standard ist 'home'
|
||||
</li>
|
||||
<li>
|
||||
<b>rr_locationUnderway</b> - hiermit übereinstimmende Lokationen werden als unterwegs gewertet; der erste Eintrag wird für das Zusammenspiel bei Statusänderungen benutzt; mehrere Einträge durch Leerzeichen trennen; Standard ist 'underway'
|
||||
</li>
|
||||
<li>
|
||||
<b>rr_locationWayhome</b> - das Verlassen einer Lokation, die hier aufgeführt ist, lässt das Reading 'wayhome' auf '1' setzen; mehrere Einträge durch Leerzeichen trennen; Standard ist "wayhome"
|
||||
</li>
|
||||
<li>
|
||||
<b>rr_locations</b> - Liste der in FHEMWEB anzuzeigenden Lokationsauswahlliste in FHEMWEB; mehrere Einträge nur durch Komma trennen und KEINE Leerzeichen verwenden
|
||||
</li>
|
||||
<li>
|
||||
<b>rr_moodDefault</b> - die Stimmung, die nach Ankunft zuhause oder nach dem Statuswechsel von 'awoken' auf 'home' gesetzt werden soll
|
||||
</li>
|
||||
<li>
|
||||
<b>rr_moodSleepy</b> - die Stimmung, die nach Statuswechsel zu 'gotosleep' oder 'awoken' gesetzt werden soll
|
||||
</li>
|
||||
<li>
|
||||
<b>rr_moods</b> - Liste von Stimmungen, wie sie in FHEMWEB angezeigt werden sollen; mehrere Einträge nur durch Komma trennen und KEINE Leerzeichen verwenden
|
||||
</li>
|
||||
<li>
|
||||
<b>rr_passPresenceTo</b> - synchronisiere die Anwesenheit mit anderen ROOMMATE oder GUEST Devices; mehrere Devices durch Leerzeichen trennen
|
||||
</li>
|
||||
<li>
|
||||
<b>rr_realname</b> - wo immer ROOMMATE den richtigen Namen verwenden möchte nutzt es den Wert des Attributs alias oder group; Standard ist group
|
||||
</li>
|
||||
<li>
|
||||
<b>rr_showAllStates</b> - die Stati 'asleep' und 'awoken' sind normalerweise nicht immer sichtbar, um einen einfachen Zubettgeh-Prozess über das devStateIcon Attribut zu ermöglichen; Standard ist 0
|
||||
</li>
|
||||
<li>
|
||||
<b>rr_states</b> - Liste aller in FHEMWEB angezeigter Stati; Eintrage nur mit Komma trennen und KEINE Leerzeichen benutzen; nicht unterstützte Stati führen zu Fehlern
|
||||
</li>
|
||||
</ul>
|
||||
</div><br />
|
||||
<br />
|
||||
<br />
|
||||
<b>Generierte Readings/Events:</b><br />
|
||||
<div style="margin-left: 2em">
|
||||
<ul>
|
||||
<li>
|
||||
<b>durTimerAbsence</b> - Timer, der die Dauer der Abwesenheit in Minuten anzeigt
|
||||
</li>
|
||||
<li>
|
||||
<b>durTimerPresence</b> - Timer, der die Dauer der Anwesenheit in Minuten anzeigt
|
||||
</li>
|
||||
<li>
|
||||
<b>durTimerSleep</b> - Timer, der die Schlafdauer in Minuten anzeigt/li>
|
||||
</li>
|
||||
<li>
|
||||
<b>lastArrival</b> - Zeitstempel der letzten Ankunft zu Hause
|
||||
</li>
|
||||
<li>
|
||||
<b>lastAwake</b> - Zeitstempel des Endes des letzten Schlafzyklus
|
||||
</li>
|
||||
<li>
|
||||
<b>lastDeparture</b> - Zeitstempel des letzten Verlassens des Zuhauses
|
||||
</li>
|
||||
<li>
|
||||
<b>lastDurAbsence</b> - Dauer der letzten Abwesenheit im folgenden Format: Stunden:Minuten:Sekunden
|
||||
</li>
|
||||
<li>
|
||||
<b>lastDurPresence</b> - Dauer der letzten Anwesenheit im folgenden Format: Stunden:Minuten:Sekunden
|
||||
</li>
|
||||
<li>
|
||||
<b>lastDurSleep</b> - Dauer des letzten Schlafzyklus im folgenden Format: Stunden:Minuten:Sekunden
|
||||
</li>
|
||||
<li>
|
||||
<b>lastLocation</b> - der vorherige Aufenthaltsort
|
||||
</li>
|
||||
<li>
|
||||
<b>lastMood</b> - die vorherige Stimmung
|
||||
</li>
|
||||
<li>
|
||||
<b>lastSleep</b> - Zeitstempel des Beginns des letzten Schlafzyklus
|
||||
</li>
|
||||
<li>
|
||||
<b>lastState</b> - der vorherige Status
|
||||
</li>
|
||||
<li>
|
||||
<b>location</b> - der aktuelle Aufenthaltsort
|
||||
</li>
|
||||
<li>
|
||||
<b>presence</b> - gibt den Zuhause Status in Abhängigkeit des Readings 'state' wieder (kann 'present' oder 'absent' sein)
|
||||
</li>
|
||||
<li>
|
||||
<b>mood</b> - die aktuelle Stimmung
|
||||
</li>
|
||||
<li>
|
||||
<b>state</b> - gibt den aktuellen Status wieder
|
||||
</li>
|
||||
<li>
|
||||
<b>wayhome</b> - abhängig vom aktullen Aufenthaltsort, kann der Wert '1' werden, wenn die Person auf dem weg zurück nach Hause ist
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
=end html_DE
|
||||
|
||||
|
||||
@ -2591,215 +2591,387 @@ sub ENIGMA2_GetRemotecontrolCommand($) {
|
||||
1;
|
||||
|
||||
=pod
|
||||
|
||||
=begin html
|
||||
|
||||
<a name="ENIGMA2"></a>
|
||||
<h3>ENIGMA2</h3>
|
||||
<ul>
|
||||
|
||||
<a name="ENIGMA2define"></a>
|
||||
<b>Define</b>
|
||||
<ul>
|
||||
<code>define <name> ENIGMA2 <ip-address-or-hostname> [<port>] [<poll-interval>]
|
||||
[<http-user>] [<http-password>]</code>
|
||||
<br><br>
|
||||
|
||||
This module controls ENIGMA2 based devices like Dreambox or VUplus via network connection.<br><br>
|
||||
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.<br><br>
|
||||
|
||||
Example:<br>
|
||||
<ul><code>
|
||||
define SATReceiver ENIGMA2 192.168.0.10
|
||||
<br><br>
|
||||
# With custom port<br>
|
||||
define SATReceiver ENIGMA2 192.168.0.10 8080
|
||||
<br><br>
|
||||
# With custom interval of 20 seconds<br>
|
||||
define SATReceiver ENIGMA2 192.168.0.10 80 20
|
||||
<br><br>
|
||||
# With HTTP user credentials<br>
|
||||
define SATReceiver ENIGMA2 192.168.0.10 80 20 root secret
|
||||
</code></ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<a name="ENIGMA2set"></a>
|
||||
<b>Set </b>
|
||||
<ul>
|
||||
<code>set <name> <command> [<parameter>]</code>
|
||||
<br><br>
|
||||
Currently, the following commands are defined.<br>
|
||||
<ul>
|
||||
<li><b>on</b> - powers on the device and send a WoL magic package if needed</li>
|
||||
<li><b>off</b> - turns the device in standby mode</li>
|
||||
<li><b>toggle</b> - switch between on and off</li>
|
||||
<li><b>shutdown</b> - turns the device in deepstandby mode</li>
|
||||
<li><b>reboot</b> - reboots the device</li>
|
||||
<li><b>restartGui</b> - restarts the GUI / ENIGMA2 process</li>
|
||||
<li><b>channel</b> channel,0...999,sRef - zap to specific channel or service reference</li>
|
||||
<li><b>channelUp</b> - zap to next channel</li>
|
||||
<li><b>channelDown</b> - zap to previous channel</li>
|
||||
<li><b>volume</b> 0...100 - set the volume level in percentage</li>
|
||||
<li><b>volumeUp</b> - increases the volume level</li>
|
||||
<li><b>volumeDown</b> - decreases the volume level</li>
|
||||
<li><b>mute</b> on,off,toggle - controls volume mute</li>
|
||||
<li><b>play</b> on,off - starts/resumes playback</li>
|
||||
<li><b>pause</b> on,off - pauses current playback or enables timeshift</li>
|
||||
<li><b>stop</b> on,off - stops current playback</li>
|
||||
<li><b>input</b> tv,radio - switches between tv and radio mode</li>
|
||||
<li><b>statusRequest</b> - requests the current status of the device</li>
|
||||
<li><b>remoteControl</b> UP,DOWN,... - sends remote control commands; see remoteControl help</li>
|
||||
<li><b>showText</b> text - sends info message to screen to be displayed for 8 seconds</li>
|
||||
<li><b>msg</b> yesno,info... - allows more complex messages as showText, see commands as listed below</li>
|
||||
</ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
<ul>
|
||||
<u>Messaging</u><br><br>
|
||||
<ul>
|
||||
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:<br><br>
|
||||
|
||||
<u>Type Selection:</u><br>
|
||||
<ul><code>
|
||||
msg yesno<br>
|
||||
msg info<br>
|
||||
msg message<br>
|
||||
msg attention<br>
|
||||
</code></ul><br><br>
|
||||
|
||||
The following parameter are essentially needed after type specification:
|
||||
<ul><code>
|
||||
msg <TYPE> <TIMEOUT> <YOUR MESSAGETEXT><br>
|
||||
</code></ul>
|
||||
</ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<a name="ENIGMA2get"></a>
|
||||
<b>Get</b>
|
||||
<ul>
|
||||
<code>get <name> <what></code>
|
||||
<br><br>
|
||||
Currently, the following commands are defined:<br><br>
|
||||
|
||||
<ul><code>channel<br>
|
||||
currentMedia<br>
|
||||
currentTitle<br>
|
||||
mute<br>
|
||||
nextTitle<br>
|
||||
power<br>
|
||||
providername<br>
|
||||
servicevideosize<br>
|
||||
input<br>
|
||||
streamUrl<br>
|
||||
volume<br>
|
||||
</code></ul>
|
||||
</ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<a name="ENIGMA2attr"></a>
|
||||
<b>Attributes</b><br>
|
||||
<ul><ul>
|
||||
<li><b>bouquet-tv</b> - service reference address where the favorite television bouquet can be found (initially set automatically during define)</li>
|
||||
<li><b>bouquet-radio</b> - service reference address where the favorite radio bouquet can be found (initially set automatically during define)</li>
|
||||
<li><b>disable</b> - Disable polling (true/false)</li>
|
||||
<li><b>http-method</b> - HTTP access method to be used; e.g. a FritzBox might need to use POST instead of GET (GET/POST)</li>
|
||||
<li><b>https</b> - Access box via secure HTTP (true/false)</li>
|
||||
<li><b>timeout</b> - Set different polling timeout in seconds (default=6)</li>
|
||||
</ul></ul>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<b>Generated Readings/Events:</b><br>
|
||||
<ul><ul>
|
||||
<li><b>acg</b> - Shows Automatic Gain Control value in percent; reflects overall signal quality strength</li>
|
||||
<li><b>apid</b> - Shows the audio process ID for current channel</li>
|
||||
<li><b>ber</b> - Shows Bit Error Rate for current channel</li>
|
||||
<li><b>channel</b> - Shows the service name of current channel or media file name; part of FHEM-4-AV-Devices compatibility</li>
|
||||
<li><b>currentMedia</b> - The service reference ID of current channel; part of FHEM-4-AV-Devices compatibility</li>
|
||||
<li><b>currentTitle</b> - Shows the title of the running event; part of FHEM-4-AV-Devices compatibility</li>
|
||||
<li><b>enigmaversion</b> - Shows the installed version of ENIGMA2</li>
|
||||
<li><b>eventcurrenttime</b> - Shows the current time of running event as UNIX timestamp</li>
|
||||
<li><b>eventcurrenttime_hr</b> - Shows the current time of running event in human-readable format</li>
|
||||
<li><b>eventcurrenttime_next</b> - Shows the current time of next event as UNIX timestamp</li>
|
||||
<li><b>eventcurrenttime_next_hr</b> - Shows the current time of next event in human-readable format</li>
|
||||
<li><b>eventdescription</b> - Shows the description of running event</li>
|
||||
<li><b>eventdescription_next</b> - Shows the description of next event</li>
|
||||
<li><b>evenduration</b> - Shows the total duration time of running event in seconds</li>
|
||||
<li><b>evenduration_hr</b> - Shows the total duration time of running event in human-readable format</li>
|
||||
<li><b>evenduration_next</b> - Shows the total duration time of next event in seconds</li>
|
||||
<li><b>evenduration_next_hr</b> - Shows the total duration time of next event in human-readable format</li>
|
||||
<li><b>eventname</b> - Shows the name of running event</li>
|
||||
<li><b>eventname_next</b> - Shows the name of next event</li>
|
||||
<li><b>eventremaining</b> - Shows the remaining duration time of running event in seconds</li>
|
||||
<li><b>eventremaining_hr</b> - Shows the remaining duration time of running event in human-readable format</li>
|
||||
<li><b>eventremaining_next</b> - Shows the remaining duration time of next event in seconds</li>
|
||||
<li><b>eventremaining_next_hr</b> - Shows the remaining duration time of next event in human-readable format</li>
|
||||
<li><b>eventstart</b> - Shows the starting time of running event as UNIX timestamp</li>
|
||||
<li><b>eventstart_hr</b> - Shows the starting time of running event in human readable format</li>
|
||||
<li><b>eventstart_next</b> - Shows the starting time of next event as UNIX timestamp</li>
|
||||
<li><b>eventstart_next_hr</b> - Shows the starting time of next event in human readable format</li>
|
||||
<li><b>eventtitle</b> - Shows the title of the running event</li>
|
||||
<li><b>eventtitle_next</b> - Shows the title of the next event</li>
|
||||
<li><b>fpversion</b> - Shows the firmware version for the front processor</li>
|
||||
<li><b>hddX_capacity</b> - Shows the total capacity of the installed hard drive in GB</li>
|
||||
<li><b>hddX_free</b> - Shows the free capacity of the installed hard drive in GB</li>
|
||||
<li><b>hddX_model</b> - Shows hardware details for the installed hard drive</li>
|
||||
<li><b>imageversion</b> - Shows the version for the installed software image</li>
|
||||
<li><b>input</b> - Shows currently used input; part of FHEM-4-AV-Devices compatibility</li>
|
||||
<li><b>iswidescreen</b> - Indicates widescreen format - 0=off 1=on</li>
|
||||
<li><b>lanmac</b> - Shows the device MAC address</li>
|
||||
<li><b>model</b> - Shows details about the device hardware</li>
|
||||
<li><b>mute</b> - Reports the mute status of the device (can be "on" or "off")</li>
|
||||
<li><b>nextTitle</b> - Shows the title of the next event; part of FHEM-4-AV-Devices compatibility</li>
|
||||
<li><b>onid</b> - The ON ID</li>
|
||||
<li><b>pcrpid</b> - The PCR process ID</li>
|
||||
<li><b>pmtpid</b> - The PMT process ID</li>
|
||||
<li><b>power</b> - Reports the power status of the device (can be "on" or "off")</li>
|
||||
<li><b>presence</b> - Reports the presence status of the receiver (can be "absent" or "present"). In case of an absent device, control is basically limited to turn it on again. This will only work if the device supports Wake-On-LAN packages, otherwise command "on" will have no effect.</li>
|
||||
<li><b>providername</b> - Service provider of current channel</li>
|
||||
<li><b>recordings</b> - Number of active recordings</li>
|
||||
<li><b>servicename</b> - Name for current channel</li>
|
||||
<li><b>servicereference</b> - The service reference ID of current channel</li>
|
||||
<li><b>servicevideosize</b> - Video resolution for current channel</li>
|
||||
<li><b>sid</b> - The S-ID</li>
|
||||
<li><b>snr</b> - Shows Signal to Noise for current channel in percent</li>
|
||||
<li><b>snrdb</b> - Shows Signal to Noise in dB</li>
|
||||
<li><b>state</b> - Reports current power state and an absence of the device (can be "on", "off" or "absent")</li>
|
||||
<li><b>tsid</b> - The TS ID</li>
|
||||
<li><b>tuner_X</b> - Details about the used tuner hardware</li>
|
||||
<li><b>txtpid</b> - The TXT process ID</li>
|
||||
<li><b>videoheight</b> - Height of the video resolution for current channel</li>
|
||||
<li><b>videowidth</b> - Width of the video resolution for current channel</li>
|
||||
<li><b>volume</b> - Reports current volume level of the receiver in percentage values (between 0 and 100 %)</li>
|
||||
<li><b>vpid</b> - The Video process ID</li>
|
||||
<li><b>webifversion</b> - Type and version of the used web interface</li>
|
||||
</ul></ul>
|
||||
|
||||
</ul>
|
||||
<p>
|
||||
<a name="ENIGMA2" id="ENIGMA2"></a>
|
||||
</p>
|
||||
<h3>
|
||||
ENIGMA2
|
||||
</h3>
|
||||
<div style="margin-left: 2em">
|
||||
<a name="ENIGMA2define" id="ENIGMA2define"></a> <b>Define</b>
|
||||
<div style="margin-left: 2em">
|
||||
<code>define <name> ENIGMA2 <ip-address-or-hostname> [<port>] [<poll-interval>] [<http-user>] [<http-password>]</code><br>
|
||||
<br>
|
||||
This module controls ENIGMA2 based devices like Dreambox or VUplus via network connection.<br>
|
||||
<br>
|
||||
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.<br>
|
||||
<br>
|
||||
Example:<br>
|
||||
<div style="margin-left: 2em">
|
||||
<code>define SATReceiver ENIGMA2 192.168.0.10<br>
|
||||
<br>
|
||||
# With custom port<br>
|
||||
define SATReceiver ENIGMA2 192.168.0.10 8080<br>
|
||||
<br>
|
||||
# With custom interval of 20 seconds<br>
|
||||
define SATReceiver ENIGMA2 192.168.0.10 80 20<br>
|
||||
<br>
|
||||
# With HTTP user credentials<br>
|
||||
define SATReceiver ENIGMA2 192.168.0.10 80 20 root secret</code>
|
||||
</div>
|
||||
</div><br>
|
||||
<br>
|
||||
<a name="ENIGMA2set" id="ENIGMA2set"></a> <b>Set</b>
|
||||
<div style="margin-left: 2em">
|
||||
<code>set <name> <command> [<parameter>]</code><br>
|
||||
<br>
|
||||
Currently, the following commands are defined.<br>
|
||||
<ul>
|
||||
<li>
|
||||
<b>on</b> - powers on the device and send a WoL magic package if needed
|
||||
</li>
|
||||
<li>
|
||||
<b>off</b> - turns the device in standby mode
|
||||
</li>
|
||||
<li>
|
||||
<b>toggle</b> - switch between on and off
|
||||
</li>
|
||||
<li>
|
||||
<b>shutdown</b> - turns the device in deepstandby mode
|
||||
</li>
|
||||
<li>
|
||||
<b>reboot</b> - reboots the device
|
||||
</li>
|
||||
<li>
|
||||
<b>restartGui</b> - restarts the GUI / ENIGMA2 process
|
||||
</li>
|
||||
<li>
|
||||
<b>channel</b> channel,0...999,sRef - zap to specific channel or service reference
|
||||
</li>
|
||||
<li>
|
||||
<b>channelUp</b> - zap to next channel
|
||||
</li>
|
||||
<li>
|
||||
<b>channelDown</b> - zap to previous channel
|
||||
</li>
|
||||
<li>
|
||||
<b>volume</b> 0...100 - set the volume level in percentage
|
||||
</li>
|
||||
<li>
|
||||
<b>volumeUp</b> - increases the volume level
|
||||
</li>
|
||||
<li>
|
||||
<b>volumeDown</b> - decreases the volume level
|
||||
</li>
|
||||
<li>
|
||||
<b>mute</b> on,off,toggle - controls volume mute
|
||||
</li>
|
||||
<li>
|
||||
<b>play</b> on,off - starts/resumes playback
|
||||
</li>
|
||||
<li>
|
||||
<b>pause</b> on,off - pauses current playback or enables timeshift
|
||||
</li>
|
||||
<li>
|
||||
<b>stop</b> on,off - stops current playback
|
||||
</li>
|
||||
<li>
|
||||
<b>input</b> tv,radio - switches between tv and radio mode
|
||||
</li>
|
||||
<li>
|
||||
<b>statusRequest</b> - requests the current status of the device
|
||||
</li>
|
||||
<li>
|
||||
<b>remoteControl</b> UP,DOWN,... - sends remote control commands; see remoteControl help
|
||||
</li>
|
||||
<li>
|
||||
<b>showText</b> text - sends info message to screen to be displayed for 8 seconds
|
||||
</li>
|
||||
<li>
|
||||
<b>msg</b> yesno,info... - allows more complex messages as showText, see commands as listed below
|
||||
</li>
|
||||
</ul>
|
||||
</div><br>
|
||||
<br>
|
||||
<div style="margin-left: 2em">
|
||||
<u>Messaging</u><br>
|
||||
<br>
|
||||
<div style="margin-left: 2em">
|
||||
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:<br>
|
||||
<br>
|
||||
<u>Type Selection:</u><br>
|
||||
<div style="margin-left: 2em">
|
||||
<code>msg yesno<br>
|
||||
msg info<br>
|
||||
msg message<br>
|
||||
msg attention<br></code>
|
||||
</div><br>
|
||||
<br>
|
||||
The following parameter are essentially needed after type specification:
|
||||
<div style="margin-left: 2em">
|
||||
<code>msg <TYPE> <TIMEOUT> <YOUR MESSAGETEXT><br></code>
|
||||
</div>
|
||||
</div>
|
||||
</div><br>
|
||||
<br>
|
||||
<a name="ENIGMA2get" id="ENIGMA2get"></a> <b>Get</b>
|
||||
<div style="margin-left: 2em">
|
||||
<code>get <name> <what></code><br>
|
||||
<br>
|
||||
Currently, the following commands are defined:<br>
|
||||
<br>
|
||||
<div style="margin-left: 2em">
|
||||
<code>channel<br>
|
||||
currentMedia<br>
|
||||
currentTitle<br>
|
||||
mute<br>
|
||||
nextTitle<br>
|
||||
power<br>
|
||||
providername<br>
|
||||
servicevideosize<br>
|
||||
input<br>
|
||||
streamUrl<br>
|
||||
volume<br></code>
|
||||
</div>
|
||||
</div><br>
|
||||
<br>
|
||||
<a name="ENIGMA2attr" id="ENIGMA2attr"></a> <b>Attributes</b><br>
|
||||
<div style="margin-left: 2em">
|
||||
<ul>
|
||||
<li>
|
||||
<b>bouquet-tv</b> - service reference address where the favorite television bouquet can be found (initially set automatically during define)
|
||||
</li>
|
||||
<li>
|
||||
<b>bouquet-radio</b> - service reference address where the favorite radio bouquet can be found (initially set automatically during define)
|
||||
</li>
|
||||
<li>
|
||||
<b>disable</b> - Disable polling (true/false)
|
||||
</li>
|
||||
<li>
|
||||
<b>http-method</b> - HTTP access method to be used; e.g. a FritzBox might need to use POST instead of GET (GET/POST)
|
||||
</li>
|
||||
<li>
|
||||
<b>https</b> - Access box via secure HTTP (true/false)
|
||||
</li>
|
||||
<li>
|
||||
<b>timeout</b> - Set different polling timeout in seconds (default=6)
|
||||
</li>
|
||||
</ul>
|
||||
</div><br>
|
||||
<br>
|
||||
<br>
|
||||
<b>Generated Readings/Events:</b><br>
|
||||
<div style="margin-left: 2em">
|
||||
<ul>
|
||||
<li>
|
||||
<b>acg</b> - Shows Automatic Gain Control value in percent; reflects overall signal quality strength
|
||||
</li>
|
||||
<li>
|
||||
<b>apid</b> - Shows the audio process ID for current channel
|
||||
</li>
|
||||
<li>
|
||||
<b>ber</b> - Shows Bit Error Rate for current channel
|
||||
</li>
|
||||
<li>
|
||||
<b>channel</b> - Shows the service name of current channel or media file name; part of FHEM-4-AV-Devices compatibility
|
||||
</li>
|
||||
<li>
|
||||
<b>currentMedia</b> - The service reference ID of current channel; part of FHEM-4-AV-Devices compatibility
|
||||
</li>
|
||||
<li>
|
||||
<b>currentTitle</b> - Shows the title of the running event; part of FHEM-4-AV-Devices compatibility
|
||||
</li>
|
||||
<li>
|
||||
<b>enigmaversion</b> - Shows the installed version of ENIGMA2
|
||||
</li>
|
||||
<li>
|
||||
<b>eventcurrenttime</b> - Shows the current time of running event as UNIX timestamp
|
||||
</li>
|
||||
<li>
|
||||
<b>eventcurrenttime_hr</b> - Shows the current time of running event in human-readable format
|
||||
</li>
|
||||
<li>
|
||||
<b>eventcurrenttime_next</b> - Shows the current time of next event as UNIX timestamp
|
||||
</li>
|
||||
<li>
|
||||
<b>eventcurrenttime_next_hr</b> - Shows the current time of next event in human-readable format
|
||||
</li>
|
||||
<li>
|
||||
<b>eventdescription</b> - Shows the description of running event
|
||||
</li>
|
||||
<li>
|
||||
<b>eventdescription_next</b> - Shows the description of next event
|
||||
</li>
|
||||
<li>
|
||||
<b>evenduration</b> - Shows the total duration time of running event in seconds
|
||||
</li>
|
||||
<li>
|
||||
<b>evenduration_hr</b> - Shows the total duration time of running event in human-readable format
|
||||
</li>
|
||||
<li>
|
||||
<b>evenduration_next</b> - Shows the total duration time of next event in seconds
|
||||
</li>
|
||||
<li>
|
||||
<b>evenduration_next_hr</b> - Shows the total duration time of next event in human-readable format
|
||||
</li>
|
||||
<li>
|
||||
<b>eventname</b> - Shows the name of running event
|
||||
</li>
|
||||
<li>
|
||||
<b>eventname_next</b> - Shows the name of next event
|
||||
</li>
|
||||
<li>
|
||||
<b>eventremaining</b> - Shows the remaining duration time of running event in seconds
|
||||
</li>
|
||||
<li>
|
||||
<b>eventremaining_hr</b> - Shows the remaining duration time of running event in human-readable format
|
||||
</li>
|
||||
<li>
|
||||
<b>eventremaining_next</b> - Shows the remaining duration time of next event in seconds
|
||||
</li>
|
||||
<li>
|
||||
<b>eventremaining_next_hr</b> - Shows the remaining duration time of next event in human-readable format
|
||||
</li>
|
||||
<li>
|
||||
<b>eventstart</b> - Shows the starting time of running event as UNIX timestamp
|
||||
</li>
|
||||
<li>
|
||||
<b>eventstart_hr</b> - Shows the starting time of running event in human readable format
|
||||
</li>
|
||||
<li>
|
||||
<b>eventstart_next</b> - Shows the starting time of next event as UNIX timestamp
|
||||
</li>
|
||||
<li>
|
||||
<b>eventstart_next_hr</b> - Shows the starting time of next event in human readable format
|
||||
</li>
|
||||
<li>
|
||||
<b>eventtitle</b> - Shows the title of the running event
|
||||
</li>
|
||||
<li>
|
||||
<b>eventtitle_next</b> - Shows the title of the next event
|
||||
</li>
|
||||
<li>
|
||||
<b>fpversion</b> - Shows the firmware version for the front processor
|
||||
</li>
|
||||
<li>
|
||||
<b>hddX_capacity</b> - Shows the total capacity of the installed hard drive in GB
|
||||
</li>
|
||||
<li>
|
||||
<b>hddX_free</b> - Shows the free capacity of the installed hard drive in GB
|
||||
</li>
|
||||
<li>
|
||||
<b>hddX_model</b> - Shows hardware details for the installed hard drive
|
||||
</li>
|
||||
<li>
|
||||
<b>imageversion</b> - Shows the version for the installed software image
|
||||
</li>
|
||||
<li>
|
||||
<b>input</b> - Shows currently used input; part of FHEM-4-AV-Devices compatibility
|
||||
</li>
|
||||
<li>
|
||||
<b>iswidescreen</b> - Indicates widescreen format - 0=off 1=on
|
||||
</li>
|
||||
<li>
|
||||
<b>lanmac</b> - Shows the device MAC address
|
||||
</li>
|
||||
<li>
|
||||
<b>model</b> - Shows details about the device hardware
|
||||
</li>
|
||||
<li>
|
||||
<b>mute</b> - Reports the mute status of the device (can be "on" or "off")
|
||||
</li>
|
||||
<li>
|
||||
<b>nextTitle</b> - Shows the title of the next event; part of FHEM-4-AV-Devices compatibility
|
||||
</li>
|
||||
<li>
|
||||
<b>onid</b> - The ON ID
|
||||
</li>
|
||||
<li>
|
||||
<b>pcrpid</b> - The PCR process ID
|
||||
</li>
|
||||
<li>
|
||||
<b>pmtpid</b> - The PMT process ID
|
||||
</li>
|
||||
<li>
|
||||
<b>power</b> - Reports the power status of the device (can be "on" or "off")
|
||||
</li>
|
||||
<li>
|
||||
<b>presence</b> - Reports the presence status of the receiver (can be "absent" or "present"). In case of an absent device, control is basically limited to turn it on again. This will only work if the device supports Wake-On-LAN packages, otherwise command "on" will have no effect.
|
||||
</li>
|
||||
<li>
|
||||
<b>providername</b> - Service provider of current channel
|
||||
</li>
|
||||
<li>
|
||||
<b>recordings</b> - Number of active recordings
|
||||
</li>
|
||||
<li>
|
||||
<b>servicename</b> - Name for current channel
|
||||
</li>
|
||||
<li>
|
||||
<b>servicereference</b> - The service reference ID of current channel
|
||||
</li>
|
||||
<li>
|
||||
<b>servicevideosize</b> - Video resolution for current channel
|
||||
</li>
|
||||
<li>
|
||||
<b>sid</b> - The S-ID
|
||||
</li>
|
||||
<li>
|
||||
<b>snr</b> - Shows Signal to Noise for current channel in percent
|
||||
</li>
|
||||
<li>
|
||||
<b>snrdb</b> - Shows Signal to Noise in dB
|
||||
</li>
|
||||
<li>
|
||||
<b>state</b> - Reports current power state and an absence of the device (can be "on", "off" or "absent")
|
||||
</li>
|
||||
<li>
|
||||
<b>tsid</b> - The TS ID
|
||||
</li>
|
||||
<li>
|
||||
<b>tuner_X</b> - Details about the used tuner hardware
|
||||
</li>
|
||||
<li>
|
||||
<b>txtpid</b> - The TXT process ID
|
||||
</li>
|
||||
<li>
|
||||
<b>videoheight</b> - Height of the video resolution for current channel
|
||||
</li>
|
||||
<li>
|
||||
<b>videowidth</b> - Width of the video resolution for current channel
|
||||
</li>
|
||||
<li>
|
||||
<b>volume</b> - Reports current volume level of the receiver in percentage values (between 0 and 100 %)
|
||||
</li>
|
||||
<li>
|
||||
<b>vpid</b> - The Video process ID
|
||||
</li>
|
||||
<li>
|
||||
<b>webifversion</b> - Type and version of the used web interface
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
=end html
|
||||
|
||||
=begin html_DE
|
||||
|
||||
<a name="ENIGMA2"></a>
|
||||
<h3>ENIGMA2</h3>
|
||||
<ul>
|
||||
Eine deutsche Version der Dokumentation ist derzeit nicht vorhanden.
|
||||
Die englische Version ist hier zu finden:
|
||||
</ul>
|
||||
<ul>
|
||||
<a href='http://fhem.de/commandref.html#ENIGMA2'>ENIGMA2</a>
|
||||
</ul>
|
||||
<p>
|
||||
<a name="ENIGMA2" id="ENIGMA2"></a>
|
||||
</p>
|
||||
<h3>
|
||||
ENIGMA2
|
||||
</h3>
|
||||
<div style="margin-left: 2em">
|
||||
Eine deutsche Version der Dokumentation ist derzeit nicht vorhanden. Die englische Version ist hier zu finden:
|
||||
</div>
|
||||
<div style="margin-left: 2em">
|
||||
<a href='http://fhem.de/commandref.html#ENIGMA2'>ENIGMA2</a>
|
||||
</div>
|
||||
|
||||
=end html_DE
|
||||
|
||||
|
||||
@ -1633,108 +1633,145 @@ sub ONKYO_AVR_RClayout() {
|
||||
1;
|
||||
|
||||
=pod
|
||||
|
||||
=begin html
|
||||
|
||||
<a name="ONKYO_AVR"></a>
|
||||
<h3>ONKYO_AVR</h3>
|
||||
<ul>
|
||||
|
||||
<a name="ONKYO_AVRdefine"></a>
|
||||
<b>Define</b>
|
||||
<ul>
|
||||
<code>define <name> ONKYO_AVR <ip-address-or-hostname> [<protocol-version>] [<zone>] [<poll-interval>]</code>
|
||||
<br><br>
|
||||
|
||||
This module controls ONKYO A/V receivers via network connection.<br><br>
|
||||
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.<br><br>
|
||||
|
||||
Example:<br>
|
||||
<ul><code>
|
||||
define avr ONKYO_AVR 192.168.0.10
|
||||
<br><br>
|
||||
# With explicit protocol version 2013 and later<br>
|
||||
define avr ONKYO_AVR 192.168.0.10 2013
|
||||
<br><br>
|
||||
# With protocol version prior 2013<br>
|
||||
define avr ONKYO_AVR 192.168.0.10 pre2013
|
||||
<br><br>
|
||||
# With zone2<br>
|
||||
define avr ONKYO_AVR 192.168.0.10 pre2013 zone2
|
||||
<br><br>
|
||||
# With custom interval of 60 seconds<br>
|
||||
define avr ONKYO_AVR 192.168.0.10 pre2013 main 60
|
||||
<br><br>
|
||||
# With zone2 and custom interval of 60 seconds<br>
|
||||
define avr ONKYO_AVR 192.168.0.10 pre2013 zone2 60
|
||||
</code></ul>
|
||||
|
||||
</ul><br><br>
|
||||
|
||||
|
||||
<a name="ONKYO_AVRset"></a>
|
||||
<b>Set </b>
|
||||
<ul>
|
||||
<code>set <name> <command> [<parameter>]</code>
|
||||
<br><br>
|
||||
Currently, the following commands are defined (may vary depending on zone).<br>
|
||||
<ul>
|
||||
<li><b>on</b> - powers on the device</li>
|
||||
<li><b>off</b> - turns the device in standby mode</li>
|
||||
<li><b>sleep</b> 1..90,off - sets auto-turnoff after X minutes</li>
|
||||
<li><b>toggle</b> - switch between on and off</li>
|
||||
<li><b>volume</b> 0...100 - set the volume level in percentage</li>
|
||||
<li><b>volumeUp</b> - increases the volume level</li>
|
||||
<li><b>volumeDown</b> - decreases the volume level</li>
|
||||
<li><b>mute</b> on,off - controls volume mute</li>
|
||||
<li><b>input</b> - switches between inputs</li>
|
||||
<li><b>statusRequest</b> - requests the current status of the device</li>
|
||||
<li><b>remoteControl</b> - sends remote control commands; see remoteControl help</li>
|
||||
</ul>
|
||||
</ul><br><br>
|
||||
|
||||
|
||||
<a name="ONKYO_AVRget"></a>
|
||||
<b>Get</b>
|
||||
<ul>
|
||||
<code>get <name> <what></code>
|
||||
<br><br>
|
||||
Currently, the following commands are defined (may vary depending on zone):<br><br>
|
||||
|
||||
<ul><code>power<br>
|
||||
input<br>
|
||||
volume<br>
|
||||
mute<br>
|
||||
sleep<br>
|
||||
</code></ul>
|
||||
</ul><br><br>
|
||||
|
||||
<b>Generated Readings/Events (may vary depending on zone):</b><br>
|
||||
<ul>
|
||||
<li><b>input</b> - Shows currently used input; part of FHEM-4-AV-Devices compatibility</li>
|
||||
<li><b>mute</b> - Reports the mute status of the device (can be "on" or "off")</li>
|
||||
<li><b>power</b> - Reports the power status of the device (can be "on" or "off")</li>
|
||||
<li><b>presence</b> - Reports the presence status of the receiver (can be "absent" or "present"). In case of an absent device, control is not possible.</li>
|
||||
<li><b>sleep</b> - Reports current sleep state (can be "off" or shows timer in minutes)</li>
|
||||
<li><b>state</b> - Reports current power state and an absence of the device (can be "on", "off" or "absent")</li>
|
||||
<li><b>volume</b> - Reports current volume level of the receiver in percentage values (between 0 and 100 %)</li>
|
||||
</ul>
|
||||
</ul>
|
||||
<p>
|
||||
<a name="ONKYO_AVR" id="ONKYO_AVR"></a>
|
||||
</p>
|
||||
<h3>
|
||||
ONKYO_AVR
|
||||
</h3>
|
||||
<div style="margin-left: 2em">
|
||||
<a name="ONKYO_AVRdefine" id="ONKYO_AVRdefine"></a> <b>Define</b>
|
||||
<div style="margin-left: 2em">
|
||||
<code>define <name> ONKYO_AVR <ip-address-or-hostname> [<protocol-version>] [<zone>] [<poll-interval>]</code><br>
|
||||
<br>
|
||||
This module controls ONKYO A/V receivers via network connection.<br>
|
||||
<br>
|
||||
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.<br>
|
||||
<br>
|
||||
Example:<br>
|
||||
<div style="margin-left: 2em">
|
||||
<code>define avr ONKYO_AVR 192.168.0.10<br>
|
||||
<br>
|
||||
# With explicit protocol version 2013 and later<br>
|
||||
define avr ONKYO_AVR 192.168.0.10 2013<br>
|
||||
<br>
|
||||
# With protocol version prior 2013<br>
|
||||
define avr ONKYO_AVR 192.168.0.10 pre2013<br>
|
||||
<br>
|
||||
# With zone2<br>
|
||||
define avr ONKYO_AVR 192.168.0.10 pre2013 zone2<br>
|
||||
<br>
|
||||
# With custom interval of 60 seconds<br>
|
||||
define avr ONKYO_AVR 192.168.0.10 pre2013 main 60<br>
|
||||
<br>
|
||||
# With zone2 and custom interval of 60 seconds<br>
|
||||
define avr ONKYO_AVR 192.168.0.10 pre2013 zone2 60</code>
|
||||
</div>
|
||||
</div><br>
|
||||
<br>
|
||||
<a name="ONKYO_AVRset" id="ONKYO_AVRset"></a> <b>Set</b>
|
||||
<div style="margin-left: 2em">
|
||||
<code>set <name> <command> [<parameter>]</code><br>
|
||||
<br>
|
||||
Currently, the following commands are defined (may vary depending on zone).<br>
|
||||
<ul>
|
||||
<li>
|
||||
<b>on</b> - powers on the device
|
||||
</li>
|
||||
<li>
|
||||
<b>off</b> - turns the device in standby mode
|
||||
</li>
|
||||
<li>
|
||||
<b>sleep</b> 1..90,off - sets auto-turnoff after X minutes
|
||||
</li>
|
||||
<li>
|
||||
<b>toggle</b> - switch between on and off
|
||||
</li>
|
||||
<li>
|
||||
<b>volume</b> 0...100 - set the volume level in percentage
|
||||
</li>
|
||||
<li>
|
||||
<b>volumeUp</b> - increases the volume level
|
||||
</li>
|
||||
<li>
|
||||
<b>volumeDown</b> - decreases the volume level
|
||||
</li>
|
||||
<li>
|
||||
<b>mute</b> on,off - controls volume mute
|
||||
</li>
|
||||
<li>
|
||||
<b>input</b> - switches between inputs
|
||||
</li>
|
||||
<li>
|
||||
<b>statusRequest</b> - requests the current status of the device
|
||||
</li>
|
||||
<li>
|
||||
<b>remoteControl</b> - sends remote control commands; see remoteControl help
|
||||
</li>
|
||||
</ul>
|
||||
</div><br>
|
||||
<br>
|
||||
<a name="ONKYO_AVRget" id="ONKYO_AVRget"></a> <b>Get</b>
|
||||
<div style="margin-left: 2em">
|
||||
<code>get <name> <what></code><br>
|
||||
<br>
|
||||
Currently, the following commands are defined (may vary depending on zone):<br>
|
||||
<br>
|
||||
<div style="margin-left: 2em">
|
||||
<code>power<br>
|
||||
input<br>
|
||||
volume<br>
|
||||
mute<br>
|
||||
sleep<br></code>
|
||||
</div>
|
||||
</div><br>
|
||||
<br>
|
||||
<b>Generated Readings/Events (may vary depending on zone):</b><br>
|
||||
<ul>
|
||||
<li>
|
||||
<b>input</b> - Shows currently used input; part of FHEM-4-AV-Devices compatibility
|
||||
</li>
|
||||
<li>
|
||||
<b>mute</b> - Reports the mute status of the device (can be "on" or "off")
|
||||
</li>
|
||||
<li>
|
||||
<b>power</b> - Reports the power status of the device (can be "on" or "off")
|
||||
</li>
|
||||
<li>
|
||||
<b>presence</b> - Reports the presence status of the receiver (can be "absent" or "present"). In case of an absent device, control is not possible.
|
||||
</li>
|
||||
<li>
|
||||
<b>sleep</b> - Reports current sleep state (can be "off" or shows timer in minutes)
|
||||
</li>
|
||||
<li>
|
||||
<b>state</b> - Reports current power state and an absence of the device (can be "on", "off" or "absent")
|
||||
</li>
|
||||
<li>
|
||||
<b>volume</b> - Reports current volume level of the receiver in percentage values (between 0 and 100 %)
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
=end html
|
||||
|
||||
=begin html_DE
|
||||
|
||||
<a name="ONKYO_AVR"></a>
|
||||
<h3>ONKYO_AVR</h3>
|
||||
<ul>
|
||||
Eine deutsche Version der Dokumentation ist derzeit nicht vorhanden.
|
||||
Die englische Version ist hier zu finden:
|
||||
</ul>
|
||||
<ul>
|
||||
<a href='http://fhem.de/commandref.html#ONKYO_AVR'>ONKYO_AVR</a>
|
||||
</ul>
|
||||
<p>
|
||||
<a name="ONKYO_AVR" id="ONKYO_AVR"></a>
|
||||
</p>
|
||||
<h3>
|
||||
ONKYO_AVR
|
||||
</h3>
|
||||
<div style="margin-left: 2em">
|
||||
Eine deutsche Version der Dokumentation ist derzeit nicht vorhanden. Die englische Version ist hier zu finden:
|
||||
</div>
|
||||
<div style="margin-left: 2em">
|
||||
<a href='http://fhem.de/commandref.html#ONKYO_AVR'>ONKYO_AVR</a>
|
||||
</div>
|
||||
|
||||
=end html_DE
|
||||
|
||||
=cut
|
||||
|
||||
@ -416,86 +416,92 @@ sub GEOFANCY_ISO8601UTCtoLocal ($) {
|
||||
1;
|
||||
|
||||
=pod
|
||||
|
||||
=begin html
|
||||
|
||||
<a name="GEOFANCY"></a>
|
||||
<h3>GEOFANCY</h3>
|
||||
<ul>
|
||||
Provides webhook receiver for geofencing via the following iOS apps:<br>
|
||||
<br>
|
||||
<li><a href="https://itunes.apple.com/de/app/geofency-time-tracking-automatic/id615538630?l=en&mt=8">Geofency</a></li>
|
||||
<li><a href="https://itunes.apple.com/de/app/geofancy/id725198453?l=en&mt=8">Geofancy</a></li>
|
||||
|
||||
<p>Note: GEOFANCY is an extension to <a href="FHEMWEB">FHEMWEB</a>. You need to install FHEMWEB to use GEOFANCY.</p>
|
||||
|
||||
<a name="GEOFANCYdefine"></a>
|
||||
<b>Define</b>
|
||||
<ul>
|
||||
<code>define <name> <infix></code><br><br>
|
||||
|
||||
Defines the webhook server. <code><infix></code> is the portion behind the FHEMWEB base URL (usually
|
||||
<code>http://hostname:8083/fhem</code>)<br>
|
||||
<br>
|
||||
Example:
|
||||
<p>
|
||||
<a name="GEOFANCY" id="GEOFANCY"></a>
|
||||
</p>
|
||||
<h3>
|
||||
GEOFANCY
|
||||
</h3>
|
||||
<ul>
|
||||
<code>define geofancy GEOFANCY geo</code><br>
|
||||
</ul><br>
|
||||
The webhook will be reachable at http://hostname:8083/fhem/geo in that case.<br>
|
||||
<br>
|
||||
</ul>
|
||||
|
||||
<a name="GEOFANCYset"></a>
|
||||
<b>Set</b>
|
||||
<ul>
|
||||
<li><b>clear</b> readings can be used to cleanup auto-created readings from deprecated devices.</li>
|
||||
</ul>
|
||||
<br><br>
|
||||
|
||||
<a name="GEOFANCYattr"></a>
|
||||
<b>Attributes</b>
|
||||
<br><br>
|
||||
<ul>
|
||||
<li>devAlias: can be used to rename device names in the format DEVICEUUID:Aliasname. Separate using blank to rename multiple devices.</li>
|
||||
</ul>
|
||||
<br><br>
|
||||
|
||||
<b>Usage information</b>
|
||||
<br><br>
|
||||
<ul>
|
||||
Likely your FHEM installation is not reachable directly from the internet (good idea!).<br>
|
||||
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.<br>
|
||||
You might also want to think about protecting the access by using HTTP Basic Authentication and encryption via SSL.<br>
|
||||
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!)<br>
|
||||
<br>
|
||||
To make that reverse proxy available from the internet, just forward the appropriate port via your internet router.<br>
|
||||
<br>
|
||||
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.
|
||||
</ul>
|
||||
<br><br>
|
||||
|
||||
<b>Integration with Home Automation</b>
|
||||
<br><br>
|
||||
<ul>
|
||||
You might want to have a look to the module family of <a href="#ROOMMATE">ROOMMATE</a>, <a href="#GUEST">GUEST</a> and <a href="#RESIDENTS">RESIDENTS</a> for an easy processing of GEOFANCY events.
|
||||
</ul>
|
||||
</ul>
|
||||
<li style="list-style: none">Provides webhook receiver for geofencing via the following iOS apps:<br>
|
||||
<br>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://itunes.apple.com/de/app/geofency-time-tracking-automatic/id615538630?l=en&mt=8">Geofency</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://itunes.apple.com/de/app/geofancy/id725198453?l=en&mt=8">Geofancy</a>
|
||||
</li>
|
||||
<li style="list-style: none">
|
||||
<p>
|
||||
Note: GEOFANCY is an extension to <a href="FHEMWEB">FHEMWEB</a>. You need to install FHEMWEB to use GEOFANCY.
|
||||
</p><a name="GEOFANCYdefine" id="GEOFANCYdefine"></a> <b>Define</b>
|
||||
<div style="margin-left: 2em">
|
||||
<code>define <name> <infix></code><br>
|
||||
<br>
|
||||
Defines the webhook server. <code><infix></code> is the portion behind the FHEMWEB base URL (usually <code>http://hostname:8083/fhem</code>)<br>
|
||||
<br>
|
||||
Example:
|
||||
<div style="margin-left: 2em">
|
||||
<code>define geofancy GEOFANCY geo</code><br>
|
||||
</div><br>
|
||||
The webhook will be reachable at http://hostname:8083/fhem/geo in that case.<br>
|
||||
<br>
|
||||
</div><a name="GEOFANCYset" id="GEOFANCYset"></a> <b>Set</b>
|
||||
<ul>
|
||||
<li>
|
||||
<b>clear</b> readings can be used to cleanup auto-created readings from deprecated devices.
|
||||
</li>
|
||||
</ul><br>
|
||||
<br>
|
||||
<a name="GEOFANCYattr" id="GEOFANCYattr"></a> <b>Attributes</b><br>
|
||||
<br>
|
||||
<ul>
|
||||
<li>devAlias: can be used to rename device names in the format DEVICEUUID:Aliasname. Separate using blank to rename multiple devices.
|
||||
</li>
|
||||
</ul><br>
|
||||
<br>
|
||||
<b>Usage information</b><br>
|
||||
<br>
|
||||
<div style="margin-left: 2em">
|
||||
Likely your FHEM installation is not reachable directly from the internet (good idea!).<br>
|
||||
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.<br>
|
||||
You might also want to think about protecting the access by using HTTP Basic Authentication and encryption via SSL.<br>
|
||||
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!)<br>
|
||||
<br>
|
||||
To make that reverse proxy available from the internet, just forward the appropriate port via your internet router.<br>
|
||||
<br>
|
||||
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.
|
||||
</div><br>
|
||||
<br>
|
||||
<b>Integration with Home Automation</b><br>
|
||||
<br>
|
||||
<div style="margin-left: 2em">
|
||||
You might want to have a look to the module family of <a href="#ROOMMATE">ROOMMATE</a>, <a href="#GUEST">GUEST</a> and <a href="#RESIDENTS">RESIDENTS</a> for an easy processing of GEOFANCY events.
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
=end html
|
||||
|
||||
=begin html_DE
|
||||
|
||||
<a name="GEOFANCY"></a>
|
||||
<h3>GEOFANCY</h3>
|
||||
<ul>
|
||||
Eine deutsche Version der Dokumentation ist derzeit nicht vorhanden.
|
||||
Die englische Version ist hier zu finden:
|
||||
</ul>
|
||||
<ul>
|
||||
<a href='http://fhem.de/commandref.html#GEOFANCY'>GEOFANCY</a>
|
||||
</ul>
|
||||
<p>
|
||||
<a name="GEOFANCY" id="GEOFANCY"></a>
|
||||
</p>
|
||||
<h3>
|
||||
GEOFANCY
|
||||
</h3>
|
||||
<div style="margin-left: 2em">
|
||||
Eine deutsche Version der Dokumentation ist derzeit nicht vorhanden. Die englische Version ist hier zu finden:
|
||||
</div>
|
||||
<div style="margin-left: 2em">
|
||||
<a href='http://fhem.de/commandref.html#GEOFANCY'>GEOFANCY</a>
|
||||
</div>
|
||||
|
||||
=end html_DE
|
||||
|
||||
=cut
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user