Skip to content

Latest commit

 

History

History
51 lines (45 loc) · 4.88 KB

Upgrade_Instructions.md

File metadata and controls

51 lines (45 loc) · 4.88 KB

Google_Calendar_Search Upgrade from v2.x to v3.x

For discussion and more information, visit the Hubitat Community [RELEASE] Google Calendar, Task, and Reminder Search.

The steps below are very important but please note that your existing setup should still continue to work however you will not be able to create new or update existing Search triggers until you do.

Google API Updates

  1. Login to the Google Cloud Console: https://console.cloud.google.com

  2. In the upper left corner click the "hamburger icon" to open the left navigation, click APIs & Services, and click Credentials image

  3. At the top, click + Create Credentials and choose OAuth client ID image

  4. Set Application type to Web application, set a Name, set Authorized redirect URIs to https://cloud.hubitat.com/oauth/stateredirect image

  5. Click Create

  6. In the OAuth client created popup, copy the Client ID and Client Secret into your favorite text editor to use in the GCal Search HE app and click OK

  7. The old "TV and Limited Input/Desktop app" OAuth credential is no longer needed and you should remove it by clicking the trash can at the far right.

  8. Optional: This new version extends the search capabilities to Google Tasks and Google Reminders. If you wish to search Tasks you will need to enable access to the Tasks API (Reminders uses an unofficial API that doesn't need entitlement in the Console).

  9. In the top blue search, enter 'tasks api' and choose Tasks API under Marketplace image

  10. Click Enable

  11. Be sure you have your Client ID and Client Secret handy to continue setup within your HE hub. If you ever need to get them again, you can navigate to APIs & Services and then Credentials to view your OAuth credentials. Clicking the Pencil icon will expose your Client ID and Client Secret.

Hubitat Installation and Setup

Note: Google Calendar Search is available via Hubitat Package Manager (HPM). If you originally installed via HPM, skip to Step 4 below.

  1. Back up your hub and save a local copy before proceeding.
  2. Navigate to Apps Code and update both GCal Search and GCal Search Trigger apps with the new code.
  1. Navigate to Drivers Code and update the GCal Switch driver with the new code.
  1. Navigate to Apps and open the GCal Search parent app.
  2. Click Google API Authorization
  3. Click Reset Google Authentication
  4. Enter the Client ID and Secret copied from Step 6 above
  5. Click Authenticate GCal Search
  6. Follow the prompts in the popup.
  7. When prompted that Google hasn't verified this app, click Advanced image
  8. In the bottle left click Go to hubitat.com/Hubitat Calendar (or whatever you named your project) image
  9. Choose which Google Apps to entitle access. This needs to match which APIs you enabled access in the Console (except Reminders). Click Continue

image

  1. Follow the instructions on the final page and close the popup window.
  2. Assuming a successful Google Authentication, a message will appear in HE letting you know and to click Next to continue setup.
  3. Click Next
  4. All existing GCal Search Triggers will be upgraded with the new settings and no additional action is required.
  5. If you wish to setup new Google Task or Google Reminder searches, click New Search... and follow the instructions.
  6. If you have any questions or issues, please post them in the [RELEASE] Google Calendar, Task, and Reminder Search community thread.