We have moved at community.getvera.com

Author Topic: Release Notes - Version 3.1 in Alt App Store - Soon in Mios Marketplace  (Read 1972 times)

Offline Stuart

  • Moderator
  • Hero Member
  • *****
  • Posts: 728
  • Karma: +71/-2
This version of Google Calendar supports the Google V3 API's and the necessary authentication required by Google.

Google Credentials
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'  here:
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 here:
There is also an advanced configuration document here - 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.
1. 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.
3. 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".
4.  In the Control tab (of the plugin).  Copy / type your Calendar ID into the Calendar ID field and press "Set".
5. Switch the GCal plugin to Arm Mode

Release Method
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
http://<your vera ip>:3480/data_request?id=update_plugin&Plugin=7016

Release Notes

Note: if you are upgrading from a release prior to 2.0 - please follow the procedure described for rel 2.0 (see below)

Release 3.1
1.  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.
2.  GCal3 is now formally available from the Alt App Store for users of AltUI.
3.  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
4.  Made some minor improvements to the handling of Calendar ID and Credential File changes.

Release 2.7
UI Changes
Fixed a problem caused by google changing its data format when requesting an access token.
(Pending release by Vera.  You can download the patched file from here  http://forum.micasaverde.com/index.php/topic,26692.msg418778.html#msg418778 )

Release 2.6
UI Changes
The calendar Tab has been removed.  It serves little purpose and was a source of confusion.

Non-Functional Changes (because they do not affect the working of the plugin)
Due to some differences between Vera units the following changes have been made to assist with general robustness:
1. JSON parser:  If json.lua is not present, a symbolic link to dkjson.lua is created.  This means that if either file is referenced in a "require" statement - then it should work transparently.
2. Removed as much curl code as possible.  Some had to be retained because the alternatives (to curl) do not resolve url redirects (necessary for some iCal).

Release 2.5
Improvements / Changes include:
1.  Improved the handling of events that span midnight
2.  Removed the need to set gc_ExtraDays to some value > 0 if you have a single event that spans multiple days.
3.  Fixed the sometimes incorrect counts of gc_EventsToday and gc_EventsLeft Today ( another "Midnight" thing).
4.  Removed most of gc_Variables (some plugin control info and calendar "snapshot" used for network outages)
    It was taking up too much space in the UI.  It's now in a file.
    A couple of variables are retained to keep the Calendar Tab functioning.
5  Changed some initialization code that sometimes resulted in "Startup Lua Failed".
6  Fixed an incorrect default for gc_EndDelta
7  Added a size check on the json parser used for UI5 (json.lua) to force a download of the correct
   version (Some UI5 users has an old version that was causing startup failures)

NOTE:  This upgrade will preserve the plugin settings BUT you will need to reset CalendarID and Credentials File Name(if other than the default)  PLEASE follow the instructions here:

Release 2.4
I broke the calendar tab in this release.  It is fixed in R2.5.
So I have pulled this Release from the marketplace

Release 2.3
Added graceful handling of an internet outage:
 - If the internet drops - GCal will continue to work using the last "good" calendar information.
 - If vera reboots and there is no internet  - GCal will continue to work using the last "good" calendar information.
 - When working "offline" the event name in the display panel will be proceeded by two asterisks i.e. **
 - If the calendar id or Credentials file are changed -- GCal MUST have an internet connection at that time to validate that the calendar is accessible, and to get a "good" set of calendar information.
 - Of course - if you have an extended internet outage - the last "good" calendar information may not be any use if all the events have passed ....

Fixed a bug when an event spans midnight.
 - When GCal reads from google it now looks back to the start of the previous day (so as not to miss events that started the prior day).
 - If you have an event that spans more than one day - you will need to set gc_ExtraDays to some value > 0 (the default) to look back more days.

Release 2.2
Fixed a small bug where the check interval was 180 sec instead of 180 min

Release 2.1 - Removed this from marketplace because I had a bug that I fixed in R2.2

1.  Updated the user documentation (V2.1) to add some clarifications.
2.  At startup - the plugin will recognize if it's not on a vera unit and bypass some checks (instead of just stopping).
3.  Configuration (credentials and CalendarID) checking and error messages and are easier to understand.
4.  Made a small change so that the "window" of time that the plugin looks for events is aligned with the local day. I.e. when it checks for events 'today' it looks from the start of 'today' until the end of 'today'.  If you need the plugin to look further you can use the gc_ExtraDays (default = 0) variable.

Release 2.0

This is a fairly significant release.  Please see the release notes posted here:

Edit:  Removed release notes for version prior to 2.0.  The changes are all reflected in the documentation so the notes were just taking up space.
« Last Edit: October 01, 2018, 07:22:45 pm by Stuart »