diff --git a/fhem/CHANGED b/fhem/CHANGED
index 03a3a0edf..ab1919b4a 100644
--- a/fhem/CHANGED
+++ b/fhem/CHANGED
@@ -1,5 +1,6 @@
# Add changes at the top of the list. Keep it in ASCII, and 80-char wide.
# Do not insert empty lines here, update check depends on it.
+ - change: 98_weekprofile: using id's in module documentation
- change: 93_RFHEM: Deprecation message (use FHEM2FHEM), some fixes
- change: 93_DbRep: SQL code for SQLite, Forum:#122791
- bugfix: 70_ZoneMinder: Trigger-Port state fixed
diff --git a/fhem/FHEM/98_weekprofile.pm b/fhem/FHEM/98_weekprofile.pm
index 727c21e3c..0f8eece97 100644
--- a/fhem/FHEM/98_weekprofile.pm
+++ b/fhem/FHEM/98_weekprofile.pm
@@ -1752,14 +1752,17 @@ sub weekprofile_getEditLNK_MasterDev($$)
}
1;
+__END__
+
=pod
+=encoding utf8
=item summary administration of weekprofiles
=item summary_DE Verwaltung von Wochenprofilen
=item helper
=begin html
-
+
weekprofile
With this module you can manage and edit different weekprofiles. You can send the profiles to different devices.
@@ -1800,13 +1803,14 @@ sub weekprofile_getEditLNK_MasterDev($$)
If the maste device is Homatic HM-TC-IT-WM-W-EU then only the first profile (R_P1_...) will be used!
- For this module libjson-perl have to be installed
+ For this module libjson-perl have to be installed
+
Events:
Currently the following event will be created:
- PROFILE_TRANSFERED: if a profile or a part of a profile (changes) is send to a device
- PROFILES_SAVED: the profile are stored in the config file (also if there are no changes)
-
+
Define
define <name> weekprofile [master device]
@@ -1821,66 +1825,79 @@ sub weekprofile_getEditLNK_MasterDev($$)
Without a master device a 'default' profile will be created
-
+
Set
+
- profile_data
set <name> profile_data <profilename> <json data>
The profile 'profilename' will be changed. The data have to be in json format.
+
- send_to_device
set <name> send_to_device <profilename> [devices]
The profile 'profilename' will be transfered to one or more the devices. Without the parameter device the profile
will be transferd to the master device. 'devices' is a comma seperated list of device names
+
- copy_profile
set <name> copy_profile <source> <destination>
Copy from source to destination. The destination will be overwritten
+
- remove_profile
set <name> remove_profile <profilename>
Delete profile 'profilename'.
+
- reference_profile
set <name> reference_profile <source> <destination>
Create a reference from destination to source. The destination will be overwritten if it exits.
+
- restore_topic
set <name> restore_topic <topic>
All weekprofiles from the topic will be transfered to the correcponding devices.
Therefore a user attribute 'weekprofile' with the weekprofile name without the topic name have to exist in the device.
+
- reread_master
- Refresh (reread) the master profile from the master device.
+ Refresh (reread) the master profile from the master device.
+
- import_profile
set <name> import_profile <device> <[profilename]>
- Importing a profile from a supported device
+ Importing a profile from a supported device
-
+
Get
+
- profile_data
get <name> profile_data <profilename>
Get the profile data from 'profilename' in json-Format
+
- profile_names
set <name> profile_names [topicname]
Get a comma seperated list of weekprofile profile names from the topic 'topicname'
If topicname is not set, 'default' will be used
If topicname is '*', all weekprofile profile names are returned.
+
- profile_references [name]
If name is '*', a comma seperated list of all references in the following syntax
ref_topic:ref_profile>dest_topic:dest_profile
are returned
If name is 'topicname:profilename', '0' or the reference name is returned.
+
- topic_names
Return a comma seperated list of topic names.
+
- associations [ReturnType (0|1)]
Returns a list of supported devices with the associated profile.
ReturnType 0: HTML table
@@ -1888,7 +1905,7 @@ sub weekprofile_getEditLNK_MasterDev($$)
-
+
Readings
- active_topic
@@ -1902,66 +1919,84 @@ sub weekprofile_getEditLNK_MasterDev($$)
-
+
Attributes
+
- widgetTranslations
Comma seperated list of texts translations :
attr name widgetTranslations Abbrechen:Cancel,Speichern:Save
+
- widgetWeekdays
Comma seperated list of week days starting at Monday
attr name widgetWeekdays Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
+
- widgetEditOnNewPage
Editing the profile on a new html page if it is set to '1'
+
- widgetEditDaysInRow
Count of visible days in on row during Edit. Default 2.
+
- widgetTempRange
Set the temperature range of the dropdown list in the FHEM widget
Syntax: min:max:step e.g. 5:30:0.5
+
- tempMap
Temperature key value pair
- Syntax: :,:
- e.g. off:5.0,on:30.0
+ Syntax: :,: e.g. off:5.0,on:30.0
+
+ - tempON
+ deprecated - please use tempMap
+
+
+ - tempOFF
+ deprecated - please use tempMap
+
+
- sendKeywordsToDevices
Send temperatur keywords instead of temparture values to device
Default: 0
+
- configFile
Path and filename of the configuration file where the profiles will be stored
Default: ./log/weekprofile-.cfg
+
- icon
icon for edit
Default: edit_settings
+
- useTopics
Enable topics.
Default: 0
+
- sendDelay
Default: 0
Delay in seconds between sending profile data the same type of device.
This is usefull to avoid messages like "queue is full, dropping packet" by HM devices
+
- forceCompleteProfile
Default: 0
Force to send the complete profile to the device instead of only the changes.
Possibility to resend a complete week profile
-
=end html
=begin html_DE
-
+
weekprofile
Beschreibung im Wiki: http://www.fhemwiki.de/wiki/Weekprofile
@@ -2003,13 +2038,14 @@ sub weekprofile_getEditLNK_MasterDev($$)
Beim Homatic HM-TC-IT-WM-W-EU wird nur das 1. Profil (R_P1_...) genommen!
- Für das Module wird libjson-perl benötigt
+ Für das Modul wird libjson-perl benötigt
+
Events:
Aktuell werden folgende Events erzeugt:
- PROFILE_TRANSFERED: wenn ein Profil oder Teile davon zu einem Gerät gesended wurden
- PROFILES_SAVED: wenn Profile in die Konfigurationsdatei gespeichert wurden (auch wenn es keine Änderung gab!)
-
+
Define
define <name> weekprofile [master device]
@@ -2024,56 +2060,67 @@ sub weekprofile_getEditLNK_MasterDev($$)
Wird kein 'Master-Geräte' angegeben, wird ein 'default' Profil angelegt.
-
+
Set
+
- profile_data
set <name> profile_data <profilname> <json data>
Es wird das Profil 'profilname' geändert. Die Profildaten müssen im json-Format übergeben werden.
+
- send_to_device
set <name> send_to_device <profilname> [devices]
Das Profil wird an ein oder mehrere Geräte übertragen. Wird kein Gerät angegeben, wird das 'Master-Gerät' verwendet.
'Devices' ist eine kommagetrennte Auflistung von Geräten
+
- copy_profile
set <name> copy_profile <quelle> <ziel>
Kopiert das Profil 'quelle' auf 'ziel'. 'ziel' wird überschrieben oder neu angelegt.
+
- remove_profile
set <name> remove_profile <profilname>
Das Profil 'profilname' wird gelöscht.
+
- reference_profile
set <name> reference_profile <quelle> <ziel>
Referenziert das Profil 'ziel'auf 'quelle'. 'ziel' wird überschrieben oder neu angelegt.
+
- restore_topic
set <name> restore_topic <topic>
Alle Wochenpläne in der Topic werden zu den entsprechenden Geräten übertragen.
Dazu muss im Gerät ein Userattribut 'weekprofile' mit dem Namen des Wochenplans ohne Topic gesetzt sein.
+
- reread_master
Aktualisiert das master profile indem das 'Master-Geräte' neu ausgelesen wird.
+
- import_profile
set <name> import_profile <device> <[profilename]>
Profil von einem Gerät importieren.
-
+
Get
+
- profile_data
get <name> profile_data <profilname>
Liefert die Profildaten von 'profilname' im json-Format
+
- profile_names
set <name> profile_names [topic_name]
Liefert alle Profilnamen getrennt durch ',' einer Topic 'topic_name'
Ist 'topic_name' gleich '*' werden alle Profilnamen zurück gegeben.
+
- profile_references [name]
Liefert eine Liste von Referenzen der Form
@@ -2081,6 +2128,7 @@ sub weekprofile_getEditLNK_MasterDev($$)
Ist name 'topicname:profilename' wird '0' der Name der Referenz zurück gegeben.
+
- associations [Rückgabetyp (0|1)]
Gibt eine Liste der unterstützten Geräte mit dem verbundenen\zugeordnetem Profilnamen zurück.
Rückgabetyp 0: HTML Tabelle
@@ -2088,7 +2136,7 @@ sub weekprofile_getEditLNK_MasterDev($$)
-
+
Readings
- active_topic
@@ -2102,60 +2150,79 @@ sub weekprofile_getEditLNK_MasterDev($$)
-
+
Attribute
+
- widgetTranslations
- Liste von Übersetzungen der Form :<Übersetzung> getrennt durch ',' um Texte im Widget zu übersetzen.
+ Liste von Übersetzungen der Form :<Übersetzung> getrennt durch ',' um Texte im Widget zu Übersetzen.
attr name widgetTranslations Abbrechen:Abbr,Speichern:Save
+
- widgetWeekdays
Liste von Wochentagen getrennt durch ',' welche im Widget angzeigt werden.
Beginnend bei Montag. z.B.
attr name widgetWeekdays Montag,Dienstag,Mittwoch,Donnerstag,Freitag,Samstag,Sonntag
+
- widgetEditDaysInRow
Anzahl in der in einer Reihe dargestellten Tage während der Bearbeitung. Default 2.
+
- widgetEditOnNewPage
Wenn gesetzt ('1'), dann wird die Bearbeitung auf einer separaten\neuen Webseite gestartet.
+
- widgetTempRange
Bereich der Temperatur Dropdown-Box im FHEM widget
Syntax: min:max:step z.B. 5:30:0.5
+
- tempMap
Temperatur Schlüssel-Werte-Paare
Syntax: :,:
z.B. off:5.0,on:30.0
+
+ - tempOn
+ Veraltet - bitte tempMap benutzen
+
+
+ - tempOff
+ Veraltet - bitte tempMap benutzen
+
+
- sendKeywordsToDevices
Sende Temperatur-Schlüsselwort zum Gerät anstatt der Werte
Default: 0
+
- configFile
Pfad und Dateiname wo die Profile gespeichert werden sollen.
Default: ./log/weekprofile-.cfg
+
- icon
Änders des Icons zum Bearbeiten
Default: edit_settings
+
- useTopics
Verwendung von Topic aktivieren.
+
- sendDelay
Default: 0
Verzögerungszweit in Sekunden zwischen dem Senden von Profildaten an ein Thermostat gleichen Typs.
Hilfreich zur Vermeidung von Meldungen wie "queue is full, dropping packet".
+
- forceCompleteProfile
Default: 0
Ezwingt das Senden eines komplettes Wochenprofiles anstatt der Änderungen
Es besteht somit die Möglichkeit eines erneuten Senden der Daten an das Thermostats
-
=end html_DE