This version of Google Calendar supports the Google V3 API’s and the necessary authentication required by Google.
In Google API’s prior to V3 it was possible to access a calendar using a url that included a unique key.
Now you need explicit credentials (service account) as well as an ID that identifies the calendar you wish to access.
You will also need to share the calendar with your service account.
The document ‘Setting up a Google V3 API Service Account’ below gives step-by-step instructions on how to create an account , get a credentials file and your Calendar ID.
You need to set up credentials before you use GCAL3
Installation and Setup
Be sure to read the Installation and Initial Setup document below. Note needs some minor updates because the test calendar is built in.
There is also an advanced configuration document with a lot of features, some explanations and some examples.
If the documentation is in error, misleading or ambiguous - I’ll try to fix that too.
GCal3 has three levels of debug messages (1-3). For troubleshooting, set gc_debug to 3.
Each plugin has the ability to capture it’s own log files (see the 2.0 release notes).
Or you can use the GetLog plugin available here:
To assist folks with initial setup / troubleshooting / proving that the plugin is working – I have created a test calendar and a test set of credentials. From release 3.1 they are installed on plugin creation. They can also be downloaded from here:
The test calendar events are named for the time (in GMT) that they occur – so the actual time, in your timezone may be different.
Be sure to replace the test values for CalendarID and Credential File with your own following the sequence below. This sequence also applies if you want to retest with the test calendar. From release 3.1 you can omit step 2 since the credential file was installed when the plugin was created.
- Switch the GCal plugin to Bypass Mode and leave it there until all the steps below are complete.
2a. For Vera: In Apps --> Develop Apps --> Luup Files Upload your credentials file (usually GCal3.json).
2b. For openluup copy the credential file to the /etc/cmh-ludl folder.
- In the Control tab (of the plugin). Type the name of your credential file (e.g. GCal3.json) into the Credential File field and Press “Set”.
- In the Control tab (of the plugin). Copy / type your Calendar ID into the Calendar ID field and press “Set”.
- Switch the GCal plugin to Arm Mode
Most releases will be through the marketplace and the Alt App Store. From time-to-time there will be test patches (individual files).
To force an update from vera (since vera is inconsistent in this regard) you can use
Note: if you are upgrading from a release prior to 2.0 - please follow the procedure described for rel 2.0 (see below)
- Created a common code base for Vera and openluup (rolled up from 2.7). The same code now installs on either platform and takes into account some minor differences. Functionally - they are identical and will be kept in sync.
- GCal3 is now formally available from the Alt App Store for users of AltUI.
- The test calendar ID and test credentials are now part of the install and are the initial defaults. This should make it easier to test that installation was successful
- Made some minor improvements to the handling of Calendar ID and Credential File changes.
Edit: Removed release notes for version prior to 2.x.
This is a fairly significant release. Please see the release notes posted here:
Setting Up. google V3 Service Account
Setting up a Google V3 API Service Account V5.pdf (448.5 KB)
Installation and Initial Setup
GCal3 - Installation and Initial Setup .pdf (188.5 KB)
GCal3 - Advanced Configuration.pdf (482.2 KB)