Changes between Version 1 and Version 2 of WikiStart


Ignore:
Timestamp:
2012-02-15 00:49:02 (12 years ago)
Author:
utz
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiStart

    v1 v2  
    1 = Welcome to Trac 0.12.3 = 
     1= Google Calendar Plugin = 
    22 
    3 Trac is a '''minimalistic''' approach to '''web-based''' management of 
    4 '''software projects'''. Its goal is to simplify effective tracking and handling of software issues, enhancements and overall progress. 
     3== Overview == 
     4The 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. 
    55 
    6 All aspects of Trac have been designed with the single goal to  
    7 '''help developers write great software''' while '''staying out of the way''' 
    8 and imposing as little as possible on a team's established process and 
    9 culture. 
     6For 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. 
    107 
    11 As all Wiki pages, this page is editable, this means that you can 
    12 modify the contents of this page simply by using your 
    13 web-browser. Simply click on the "Edit this page" link at the bottom 
    14 of the page. WikiFormatting will give you a detailed description of 
    15 available Wiki formatting commands. 
     8== How it works == 
     9The 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. 
    1610 
    17 "[wiki:TracAdmin trac-admin] ''yourenvdir'' initenv" created 
    18 a new Trac environment, containing a default set of wiki pages and some sample 
    19 data. This newly created environment also contains  
    20 [wiki:TracGuide documentation] to help you get started with your project. 
     11== Install == 
     12* Get a Google account and setup a calendar. You may want to create a separate calendar instance for the home automation stuff. 
    2113 
    22 You can use [wiki:TracAdmin trac-admin] to configure 
    23 [http://trac.edgewall.org/ Trac] to better fit your project, especially in 
    24 regard to ''components'', ''versions'' and ''milestones''.  
     14* 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). 
    2515 
     16* 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 
    2617 
    27 TracGuide is a good place to start. 
     18* 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. 
    2819 
    29 Enjoy! [[BR]] 
    30 ''The Trac Team'' 
     20* 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). 
    3121 
    32 == Starting Points == 
     22More detailed installation steps can be found here: http://forum.micasaverde.com/index.php/topic,7558.0.html 
    3323 
    34  * TracGuide --  Built-in Documentation 
    35  * [http://trac.edgewall.org/ The Trac project] -- Trac Open Source Project 
    36  * [http://trac.edgewall.org/wiki/TracFaq Trac FAQ] -- Frequently Asked Questions 
    37  * TracSupport --  Trac Support 
    38  
    39 For a complete list of local wiki pages, see TitleIndex.