Changes between Version 2 and Version 3 of WikiStart

Timestamp:: 2012-06-05 16:26:23 (12 years ago)
Author:: psykokwak
Comment:: Update according the new 1.2.3 version.

Legend:

: Unmodified
: Added
: Removed
: Modified

WikiStart

-                      v2
+                      v3
 == Overview ==
 The plugin is a simple switch (similar to a motion detector) which uses a Google Calendar as input. The plugin will check periodically if an event with a particular name is active in the calendar. If such event is currently active the plugin will go to state tripped=1, if not then tripped=0. In addition a variable is set that can be additionally specified in the event and may be used in a scene.
+The plugin is a simple switch (similar to a motion detector) which uses a Google Calendar as input. The plugin will check periodically if an event with or without a particular name will be active in a near futur in the calendar. When the calendar event starts the plugin will go to state tripped=1, if not then tripped=0. In addition a variable is set that can be additionally specified in the event and may be used in a scene.
 For example, I control my central heating that way. I specify in Google Calendar events throughout the day that are called HEATING_ON. When an event with such name is present the scene running the heating is triggered. I can also specify an event in the form of HEATING_ON!{20}. In this case the 20 is extracted and stored in a variable. I use the 20 to override the temperature set-point of the heating (it now will heat to 20 degree and not use the set-point of the room thermostat). Other options would be to use events such as LIGHT_ON or ALARM_ON which could be specified in the same calendar that several instances of the plugin use.
+For example, I control my central heating that way. I specify in Google Calendar events throughout the day that are called HEATING_ON. When an event with such name is present the scene running the heating is triggered. I can also specify an event in the form of HEATING_ON{20}. In this case the 20 is extracted and stored in a variable. I use the 20 to override the temperature set-point of the heating (it now will heat to 20 degree and not use the set-point of the room thermostat). Other options would be to use events such as LIGHT_ON or ALARM_ON which could be specified in the same calendar that several instances of the plugin use. You also can set no keyword. In this case the switch will trigger on every calendar event whatever the name. (It could be usefull for public calendar like "public holidays")
 == How it works ==
 The plugin periodically (period defined in I_GCAl.xml in UPDATE_FREQU with 5min as a reasonable value)  contacts a google calendar and requests all calendar events in a window of  UPDATE_FREQU. Google Calendar returns all active events in this period as a JSON output. In that output I look for a keyword defined in the control tab of the plugin (I do not parse the JSON properly, it is just a pattern matching in the output for the keyword). If the keyword is found the plugin goes to the state Tripped.
+The plugin periodically (period defined in I_GCAl.xml in UPDATE_FREQ in seconds. Default:21600 (6 hours))  contacts a google calendar and requests all calendar events in a window of UPDATE_FREQ seconds. Google Calendar returns all active events in this period as a JSON output. In that output it looks for the next event eventually that has "keyword" as name defined in the control tab of the plugin. If there is a such event, the plugin waits until the event starts and triggers to 1. When the event finishes, trigger returns to 0.
 == Install ==
 * Get a Google account and setup a calendar. You may want to create a separate calendar instance for the home automation stuff.
 * Click on calendar settings and then click on the XML button at "Private Address". You will now see a link that vera will use as a pointer to access the calendar. Copy this link and change at the start https to http (have not figured out yet how to use https).
+* Click on calendar settings and then click on the XML button at "Private Address". You will now see a link that vera will use as a pointer to access the calendar. You can also do this manipulation for a public calendar.
 * Install the 4 files [http://code.mios.com/trac/mios_google-calendar-plugin/changeset/5/tags/0.1?old_path=%2F&format=zip UI4-ZIPFILE] [http://code.mios.com/trac/mios_google-calendar-plugin/changeset/5/tags/0.1-UI5?old_path=%2F&format=zip UI5-ZIPFILE] files on vera and create a device using D_GCal.xml
+* Install the following [http://code.mios.com/trac/mios_google-calendar-plugin/changeset/6/trunk?old_path=%2F&format=zip files] on vera and create a device using D_GCal.xml. Put all files into /etc/cmh-ludl/ directory except "json.lua" which goes into /usr/lib/lua/ directory.
 * Click on the device you created. In the control tab there will be 2 boxes. In the first one you have to insert the link to the calendar (The box is a bit small but it works). Then press set. In the second box you enter the event name you want to use (e.g. HEATING_ON). Then press set.
+* Click on the device you created. In the control tab there will be 2 boxes. In the first one you have to insert the link to the calendar (The box is a bit small but it works). Then press set. In the second box you enter the event name you want to use (e.g. HEATING_ON). Then press set. You can leave this box empty to catch all events whatever the name.
 * You can use the button "check" to see if events in the calendar are picked up. Otherwise the plugin will check every 5min (this value can be configured).
+* You can use the button "check" to see if events in the calendar are picked up. Otherwise the plugin will check every UPDATE_FREQ seconds (this value can be configured).
+More detailed installation steps can be found here: http://forum.micasaverde.com/index.php/topic,7558.0.html
+More detailed installation steps and exemples can be found here: http://forum.micasaverde.com/index.php/topic,7558.msg74154.html#msg74154