Ver Control4 Drivers Made Easy. Google Calendar - Installation Manual

Transcription

1 Ver. 1.0 Control4 Drivers Made Easy Google Calendar - Installation Manual

2 THEDRIVERSLAB CONTROL4 DRIVERS MADE EASY Google Calendar Driver V TheDriversLab

3 Table of Contents Introduction... 1 Highlighted Features... 1 Requirements... 1 Change Log... 1 Driver Installation... 2 Copy the Driver... 2 Add the Driver to the Project... 2 Configure the Driver... 3 Optional Configuration Steps... 5 Programming... 5 Home Notify Programming... 8 Support... 9

4 GOOGLE CALENDAR CONTROL4 DRIVER Introduction Our Google Calendar Driver provides for an access to any Google calendar. Using the Driver, one can program event notifications as well as get a list of all and filtered upcoming events. The Driver is very lean and takes advantage of Google s API to outsource a lot of the processing power, yielding better and faster results. One license is required per project and allows for multiple instances for multiple calendars. Highlighted Features 1. Fire an event whenever an event reminder is set. 2. Automatically gets a list of all available calendars. 3. Stores the number of upcoming events for today, the following day and upcoming week in variables. 4. Has a Command to retrieve the time and description of any upcoming event. 5. Has a Command to retrieve the total number of events for an upcoming date. 6. Automatically retrieves new and modified events. 7. Supports multiple instances per-project for handling of multiple calendars. Requirements The Driver has only been tested on Control4 OS2.1, OS2.4, and OS2.5. The Driver s compatibility on older operation systems is not guaranteed. Change Log 07/09/2013 V Minor bug fixes 06/28/2013 V Initial V1.0 Release 2013 TheDriversLab.com Google Calendar Driver 1

5 Driver Installation Copy the Driver 1. Download and extract the.zip Driver files. 2. Copy the Driver file Google_Calendar_ip_thedriverslab_Google Calendar.c4i to the Control4 Drivers directory. The directory is typically located at My Documents\Control4\Drivers or Libraries\Documents\Control4\Drivers for Windows Launch the Composer Pro and connect to the Controller where the Driver will be installed. Add the Driver to the Project 1. Select System Design on the left: 2. Select the Search tab on the right with Device Type -- others -- and Manufacturer TheDriversLab: 3. Double-click the Google Calendar Driver to add it to the Project. 4. The Driver will now appear in the Project as follows: 2013 TheDriversLab.com Google Calendar Driver 2

6 Configure the Driver 1. Click on the Google Calendar Driver on the left pane under System. 2. The Properties tab is located on the right. 3. Step one: enter the License Key. 4. Click on the Lua tab and copy the URL to your browser: 5. Go back to Composer Pro and copy the User Code: 2013 TheDriversLab.com Google Calendar Driver 3

7 6. Go to the browser and paste the User Code that was copied from the Composer Pro into the text input: 7. Press Continue. In the following page, press Allow Access: 2013 TheDriversLab.com Google Calendar Driver 4

8 8. On the next page, the following message will be displayed: 9. Go back to Composer Pro and into the Lua tab. It should list all the available calendars under the Google account: 10. Copy the name of the Calendar to be monitored: 11. Paste it in the Calendar field under the Properties tab: 12. Once set, the Driver will automatically populate the Next Event field. 13. The configuration of the Driver is now complete. Optional Configuration Steps Set the Polling Frequency to determine how often updates should be retrieved. 60 minutes is the idle compromise between performance and accurate reading. Programming 1. In Composer Pro, select the Programming tab on the left side of the screen TheDriversLab.com Google Calendar Driver 5

9 2. Select the Event Reminder event from the Google Calendar Driver: 3. Expand Google Calendar under the Actions section on the right side of the screen. 4. The Driver includes the following variables: I. EventName Contains the name of the event whose reminder was just triggered II. III. IV. EventTime Contains the date and time of the event whose reminder was just triggered EventsToday_String Contains a string with the total number of upcoming events today EventsTomorrow_String Contains a string with the total number of upcoming events tomorrow V. EventsThisWeek_String Contains a string with the total number of upcoming events this week VI. EventsToday Contains the total number of upcoming events today 2013 TheDriversLab.com Google Calendar Driver 6

10 VII. VIII. IX. EventsTomorrow Contains the total number of upcoming events tomorrow EventsThisWeek Contains the total number of upcoming events this week Custom_TotalNumberOfEvents_String Contains a string with the total number of upcoming events for day X. Being set after a call to the Get Total Events In Day command X. Custom_TotalNumberOfEvents Contains the total number of upcoming events for day X. Being set after a call to the Get Total Events In Day command XI. XII. Custom_EventName Contains the name of the event that was returned by a call to the command Get Event In Day Custom_EventTime Contains the time and date of the event that was returned by a call to the command Get Event In Day 5. Select the Command tab and select the Get Event In Day command: 6. Enter 3 in How_Many_Days and 1 in Event_Number: 7. Double-click the event to add it the trigger TheDriversLab.com Google Calendar Driver 7

11 8. The following command will retrieve the first event, three days from today, every time there is an event reminder. 9. The Driver is officially installed. Home Notify Programming If the Home Notify Driver is installed on the same project, it could be used to send a notification to the mobile device every time there is an event reminder: 1. Select the Event Reminder event under the Google Calendar Driver: 2. Expand the list of the Home Notify Driver under the Actions pane on the right side: 3. Select a variable that is not currently being used. i.e. VAR4 4. Check Set to Value of and select the EventName variable of the Google Calendar Driver. The following procedure could be done also to the EventTime variable TheDriversLab.com Google Calendar Driver 8

12 5. Select the Home Notify Driver under the Actions pane and check Device Specific Command. 6. In the message field type: I have an event $VAR4 at $VAR5. 7. The setup is complete. At the time of an event reminder, the Driver will send a notification to the mobile device with the event description and time. Support Got questions? Got stuck? Having issues? Our support team is available at support@thedriverslab.com to address your concerns. Still having trouble? Our technicians can be reached at: (855) Toll-Free for U.S customers +1 (323) 813-1LAB - For all customers 2013 TheDriversLab.com Google Calendar Driver 9