A pimatic plugin to interact with your Google Calendar
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets
devices
ui
.gitignore
History.md
LICENSE.md
README.md
device-config-schema.coffee
google-calendar-config-schema.coffee
google-calendar.coffee
package.json

README.md

pimatic-google-calendar

npm version dependencies status

A pimatic plugin to display and interact with your google calendar.

Setup

  1. Use this wizard to create a project in the Google Developers Console and automatically turn on the API. Click Continue, then Go to credentials .
  2. On the left of the page, select Credentials, then at the top of the page, select the OAuth consent screen tab. Select an Email address, enter a Product name if not already set, and click the Save button.
  3. Select the Credentials tab, click the Create credentials button and select OAuth client ID.
  4. Select the application type Other, enter the name "pimatic-google-calendar", and click the Create button.
  5. Go to your Pimatic webinterface and open the plugin page. Under Browse Plugins search for google-calendar and click install.
  6. Restart Pimatic.
  7. On the google-calendar settings page enter your client id and client secret from the Google Developers Console and click save.
  8. Restart Pimatic again.
  9. Open http(s)://pimatic-ip/google/calendar and sign in with your Google Account and allow read access to your calendar.
  10. Copy the code from the textbox
  11. Open http(s)://pimatic-ip/google/calendar?code="your copied code here"
  12. Restart Pimatic again.

Plugin Configuration

{
      "plugin": "google-calendar",
      "client_id": "",
      "client_secret": ""
}

The plugin has the following configuration properties:

Property Default Type Description
client_id - String Your client id from the setup above
client_secret - String Your client secrect from the setup above
access_token - String automatically generated access token
refresh_token - String automatically generated refresh token
debug false Boolean Debug mode. Writes debug messages to the pimatic log, if set to true

Device Configuration

The following device can be created:

CalendarDevice

{
		"id": "",
		"name": "",
		"class": "CalendarDevice"
}

The device has the following configuration properties:

Property Default Type Description
calendar_ids ["primary"] Array calendar ids used to fetch events
view "month" String diffent views of the calendar eg. month, week, day or list
interval 60000 Number interval for fetching events
contentHeight 430 Number content height in px
timeFormat "H:mm" String time format, for more details see here
firstDayOfWeek "sunday" String first day of week (sunday or monday)
locale - String automatically set locale from pimatic locale setting in config.json. Default pimatic locale is "en"

If you don't know your calendar ids, set the debug option of the plugin to true. All availble ids will be logged.

ListView DayView WeekView MonthView

ToDo

  • add support for rules
  • implement event colors
  • use sweetAlert2 for setup

History

See Release History.

License

Copyright (c) 2017, Thorsten Reichelt and contributors. All rights reserved.

License: GPL-2.0.