From bf6a27dfc207f276b95d3bedd3f485b50feac9d1 Mon Sep 17 00:00:00 2001
From: risiko79 <>
Date: Sun, 31 Jan 2016 14:33:35 +0000
Subject: [PATCH] 98_weekprofike: change documentation
git-svn-id: https://svn.fhem.de/fhem/trunk@10684 2b470e98-0d58-463d-a4d8-8e2adae1ed80
---
fhem/FHEM/98_weekprofile.pm | 33 ++++++++++++---------------------
1 file changed, 12 insertions(+), 21 deletions(-)
diff --git a/fhem/FHEM/98_weekprofile.pm b/fhem/FHEM/98_weekprofile.pm
index 06112666c..c533a4880 100644
--- a/fhem/FHEM/98_weekprofile.pm
+++ b/fhem/FHEM/98_weekprofile.pm
@@ -1189,7 +1189,6 @@ sub weekprofile_getEditLNK_MasterDev($$)
reference_profile
set <name> reference_profile <source> <destination>
Create a reference from destination to source. The destination will be overwritten if it exits.
- Still under development!!!
restore_topic
set <name> restore_topic <topic>
@@ -1203,7 +1202,7 @@ sub weekprofile_getEditLNK_MasterDev($$)
- profile_data
get <name> profile_data <profilename>
- Get the profile date from 'profilename' in json-Format
+ Get the profile data from 'profilename' in json-Format
- profile_names
set <name> profile_names [topicname]
@@ -1218,7 +1217,7 @@ sub weekprofile_getEditLNK_MasterDev($$)
If name is 'topicname:profilename', '0' or the reference name is returned.
- topic_names
- Return a list of topic names.
+ Return a comma seperated list of topic names.
@@ -1226,12 +1225,7 @@ sub weekprofile_getEditLNK_MasterDev($$)
Readings
- active_topic
- Active topic.
-
-
-
- - active_topic
- Active\restored topic name
+ Active\last restored topic name
- profile_count
Count of all profiles including references.
@@ -1242,7 +1236,7 @@ sub weekprofile_getEditLNK_MasterDev($$)
Attributes
- widgetWeekdays
- Comma seperated list od week days starting at Monday
+ Comma seperated list of week days starting at Monday
attr name widgetWeekdays Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
- widgetEditOnNewPage
@@ -1282,7 +1276,7 @@ sub weekprofile_getEditLNK_MasterDev($$)
um das Wochenprofil vom Gerät grafisch bearbeiten zu können und andere Profile auf das Gerät zu übertragen.
Wird kein 'Master-Gerät' angegeben, wird erstmalig ein Default-Profil angelegt.
- Ein weiterer Anwendungsfall ist die Verwendung von Rubriken 'Topics'.
+ Ein weiterer Anwendungsfall ist die Verwendung von Rubriken\Kategorien 'Topics'.
Hier sollte kein 'Master-Gerät' angegeben werden. Dieses Feature muss erst über das Attribut 'useTopics' aktiviert werden.
Topics sind z.B. Winter, Sommer, Urlaub, Party, etc.
Innerhalb einer Topic kann es mehrere Wochenprofile geben. Sinnvollerweise sollten es soviele wie Thermostate sein.
@@ -1353,14 +1347,16 @@ sub weekprofile_getEditLNK_MasterDev($$)
Liefert die Profildaten von 'profilname' im json-Format
- profile_names
- set <name> profile_names
- Liefert alle Profilnamen getrennt durch ','
+ 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
+ - profile_references [name]
Liefert eine Liste von Referenzen der Form
- ref_topic:ref_profile -> dest_topic:dest_profile
+ ref_topic:ref_profile>dest_topic:dest_profile
+ Ist name 'topicname:profilename' wird '0' der Name der Referenz zurück gegeben.
@@ -1368,12 +1364,7 @@ sub weekprofile_getEditLNK_MasterDev($$)
Readings
- active_topic
- Aktive Topic.
-
-
-
- - active_topic
- Aktive Topic.
+ Aktive\zuletzt gesetzter Topicname.
- profile_count
Anzahl aller Profile mit Referenzen.