From 8846683affbc0cc4ed06ebe0fb68ca32a33841f2 Mon Sep 17 00:00:00 2001
From: borisneubert <borisneubert@2b470e98-0d58-463d-a4d8-8e2adae1ed80>
Date: Sun, 24 Jun 2012 09:32:47 +0000
Subject: [PATCH] added get summary to Calendar, amended documentation

git-svn-id: svn://svn.code.sf.net/p/fhem/code/trunk@1641 2b470e98-0d58-463d-a4d8-8e2adae1ed80
---
 fhem/FHEM/57_Calendar.pm  |  5 +++--
 fhem/docs/commandref.html | 46 ++++++++++++++++++++++++++-------------
 2 files changed, 34 insertions(+), 17 deletions(-)

diff --git a/fhem/FHEM/57_Calendar.pm b/fhem/FHEM/57_Calendar.pm
index 7a2d8cdf8..e693f256d 100644
--- a/fhem/FHEM/57_Calendar.pm
+++ b/fhem/FHEM/57_Calendar.pm
@@ -714,7 +714,7 @@ sub Calendar_Get($@) {
   my @events;
 
   my $cmd= $a[1];
-  if($cmd eq "text" || $cmd eq "full") {
+  if($cmd eq "text" || $cmd eq "full" || $cmd eq "summary") {
 
     return "argument is missing" if($#a != 2);
     my $reading= $a[2];
@@ -734,6 +734,7 @@ sub Calendar_Get($@) {
       foreach my $event (sort { $a->start() <=> $b->start() } @events) {
         push @texts, $event->asText() if $cmd eq "text";
         push @texts, $event->asFull() if $cmd eq "full";
+        push @texts, $event->summary() if $cmd eq "summary";
       }
     }  
     return join("\n", @texts);
@@ -749,7 +750,7 @@ sub Calendar_Get($@) {
     return join(";", @uids);
   
   } else {
-    return "Unknown argument $cmd, choose one of text full find";
+    return "Unknown argument $cmd, choose one of text summary full find";
   }
 
 }
diff --git a/fhem/docs/commandref.html b/fhem/docs/commandref.html
index 586d26a93..a009bfbc9 100644
--- a/fhem/docs/commandref.html
+++ b/fhem/docs/commandref.html
@@ -1374,8 +1374,6 @@ A line ending with \ will be concatenated with the next one, so long lines
 <ul>
   <br>
 
-  Note: this module requires the Time::Local module.<br><br>
-
   <a name="Calendardefine"></a>
   <b>Define</b>
   <ul>
@@ -1387,8 +1385,10 @@ A line ending with \ will be concatenated with the next one, so long lines
     start with <code>http://</code>, not <code>https://</code>, and the file at the given URL
     must be in ICal format.<br><br>
 
-    Note for users of Google Calendar: You can literally use the private ICAL URL from your Google Calendar with the
-    <code>https://</code> replaced by <code>http://</code>.<br><br>
+    Note for users of Google Calendar: You can literally use the private ICal URL from your Google Calendar with the
+    <code>https://</code> replaced by <code>http://</code>. Google App accounts do not work since requests to the URL
+    get redirected first and the fhem mechanism for retrieving data via http cannot handle this. Neither can it
+    handle HTTPS.<br><br>
 
     The optional parameter <code>interval</code> is the time between subsequent updates
     in seconds. It defaults to 3600 (1 hour).<br><br>
@@ -1415,10 +1415,11 @@ A line ending with \ will be concatenated with the next one, so long lines
   <a name="Calendarget"></a>
   <b>Get</b>
   <ul>
-    <code>get &lt;name&gt; full|text &lt;reading&gt|&lt;uid&gt;</code><br><br>
+    <code>get &lt;name&gt; full|text|summary &lt;reading&gt|&lt;uid&gt;</code><br><br>
 
-    Returns, line by line, the full state or a textual representation of the calendar event(s) listed in the
-    reading lt;reading&gt or identified by the UID &lt;uid&gt.<br><br>
+    Returns, line by line, the full state or a textual representation or the summary (subject, title)
+    of the calendar event(s) listed in the
+    reading &lt;reading&gt or identified by the UID &lt;uid&gt.<br><br>
 
     <code>get &lt;name&gt; find &lt;regexp&gt;</code><br><br>
 
@@ -1448,32 +1449,33 @@ A line ending with \ will be concatenated with the next one, so long lines
   are stripped off the UID to make your life easier.<p>
 
   A calendar event can be in one of the following states:
-  <table>
+  <table border="1">
   <tr><td>new</td><td>The calendar event was first seen at the most recent update. Either this was your first retrieval of
   the calendar or you newly added the calendar event to the source calendar.</td></tr>
   <tr><td>known</td><td>The calendar event was already there before the most recent update.</td></tr>
   <tr><td>updated</td><td>The calendar event was already there before the most recent update but it has changed since it
   was last retrieved.</td></tr>
   <tr><td>deleted</td><td>The calendar event was there before the most recent update but is no longer. You removed it from the source calendar. The calendar event will be removed from all lists at the next update.</td></tr>
-  </table>
+  </table><br>
   Calendar events that lie completely in the past (current time on wall clock is later than the calendar event's end time)
   are not retrieved and are thus not accessible through the calendar.
   <p>
 
   A calendar event can be in one of the following modes:
-  <table>
+  <table border="1">
   <tr><td>upcoming</td><td>Neither the alarm time nor the start time of the calendar event is reached.</td></tr>
   <tr><td>alarm</td><td>The alarm time has passed but the start time of the calendar event is not yet reached.</td></tr>
   <tr><td>start</td><td>The start time has passed but the end time of the calendar event is not yet reached.</td></tr>
   <tr><td>end</td><td>The end time of the calendar event has passed.</td></tr>
-  </table>
+  </table><br>
   A calendar event transitions from one mode to another immediately when the time for the change has come. This is done by waiting
   for the earliest future time among all alarm, start or end times of all calendar events.
   <p>
 
-  A calendar device has several readings. Each reading is a semicolon-separated list of UIDs of
+  A calendar device has several readings. Except for <code>calname</code>, each reading is a semicolon-separated list of UIDs of
   calendar events that satisfy certain conditions:
-  <table>
+  <table border="1">
+  <tr><td>calname</td><td>name of the calendar</td></tr>
   <tr><td>all</td><td>all events</td></tr>
   <tr><td>modeAlarm</td><td>events in alarm mode</td></tr>
   <tr><td>modeAlarmOrStart</td><td>events in alarm or start mode</td></tr>
@@ -1499,7 +1501,7 @@ A line ending with \ will be concatenated with the next one, so long lines
     <code>
     get MyCalendar full all<br>
     2767324dsfretfvds7dsfn3e4dsa234r234sdfds6bh874googlecom   known    alarm 31.05.2012 17:00:00 07.06.2012 16:30:00-07.06.2012 18:00:00 Erna for coffee<br>
-    992hydf4;44awer5466lhfdsrgl7tin6b6mckf8glmhui4googlecom   known upcoming                     08.06.2012 00:00:00-09.06.2012 00:00:00 Vacation
+    992hydf4y44awer5466lhfdsrgl7tin6b6mckf8glmhui4googlecom   known upcoming                     08.06.2012 00:00:00-09.06.2012 00:00:00 Vacation
     </code><br><br>
     </ul>
 
@@ -1521,7 +1523,7 @@ A line ending with \ will be concatenated with the next one, so long lines
     get MyCalendar find .*Erna.*<br>
     2767324dsfretfvds7dsfn3e4dsa234r234sdfds6bh874googlecom
     </code><br><br>
-    The define a notify:<br><br>
+    Then define a notify:<br><br>
     <code>
     define ErnaComes notify MyCalendar:modeStarted.*2767324dsfretfvds7dsfn3e4dsa234r234sdfds6bh874googlecom.* set MyLight on
     </code><br><br>
@@ -1531,6 +1533,20 @@ A line ending with \ will be concatenated with the next one, so long lines
     </code><br><br>
     </ul>
 
+    <i>Switch actors on and off</i><br><br>
+    <ul>
+    Think about a calendar with calendar events whose summaries (subjects, titles) are the names of devices in your fhem installation.
+    You want the respective devices to switch on when the calendar event starts and to switch off when the calendar event ends.<br><br>
+    <code>
+    define SwitchActorOn notify MyCalendar:modeStarted.* { my $uid= "%EVTPART1";; my $actor= fhem("get C summary $uid");; fhem("set $actor on") }<br><br>
+    define SwitchActorOff notify MyCalendar:modeEnded.* { my $uid= "%EVTPART1";; my $actor= fhem("get C summary $uid");; fhem("set $actor off") }
+    </code><br><br>
+    You can also do some logging:<br><br>
+    <code>
+    define LogActors notify MyCalendar:mode(Started|Ended).* { my $reading= "%EVTPART0";; my $uid= "%EVTPART1";; my $actor= fhem("get C summary $uid");; Log 1, "Actor: $actor, Reading $reading" }
+    </code><br><br>
+    </ul>
+
     
   </ul>