Search
⌃K

Calendar Driver

How to Configure the Calendar Driver on PlaceOS
The PlaceOS Calendar Driver connects to Microsoft Graph API (365) or Google Workspace.
The Calendar Driver and the Bookings Driver work together to get resource calendar events.
The Calendar Driver can also make ad-hoc bookings from kiosks or room booking panels.
To configure and deploy the Calendar Driver for Microsoft 365 where Delegated Access has been used, please refer to this page related to configuring PlaceOS Calendar Driver for 365.​

Prerequisites

  • Administrator access to your PlaceOS Backoffice
  • PlaceOS Drivers Repository Configured in Backoffice
  • Systems have a valid calendar resource address from Microsoft 365 or Google Workspace

Add Driver

Before we can use the PlaceOS Calendar Driver we must instantiate it as a driver.
  1. 1.
    Navigate to the Drivers tab
  2. 2.
    Click the + icon to add a new driver
  3. 3.
    Select PlaceOS Drivers Repository
  4. 4.
    Select the drivers > place > calendar.cr Driver Base
  5. 5.
    Select the latest commit
  6. 6.
    Click Save
    Add Calendar Driver
    ​

Add to System

You need to instantiate a single instance of the PlaceOS Calendar Driver.
We recommend instantiating the driver in a generic system e.g. *Tracking.
That module is then added to each system that requires booking or calendar functionality.

Instantiate the Driver

  1. 1.
    Navigate to the system you will instantiate the driver in
  2. 2.
    Select the Modules tab
  3. 3.
    Click Add New
    ​
    Add Calendar Driver
    ​
  4. 4.
    Search for the PlaceOS Calendar driver
    ​
    Search for Driver
    ​
  5. 5.
    Click Save
    ​
    Save Calendar Driver
    ​
  6. 6.
    Enable the driver by clicking the black dot, it should turn green
    Start Calendar Driver
    ​

Configure Driver

For Google Integration, we recommend creating a Service User on Google Workspace.
Service Users are the same as a regular Users Accounts with a descriptive name e.g. [email protected]
For testing, you can use your own Google Workspace Account.
The driver is now instantiated as a module, we need to configure the API Credentials.
  1. 1.
    Navigate to the Drivers tab
  2. 2.
    Select the Calendar Driver
  3. 3.
    In the Settings view select unencrypted tab
  4. 4.
    Delete all the example configuration provided by the driver
  5. 5.
    If using Google Calendar API, paste this configuration into the encrypted tab:
    calendar_config:
    scopes: ["https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/admin.directory.user.readonly"],
    domain: "primary.domain.com", #Your Google Workspace Domain
    sub: "[email protected]", # User or Service User Account
    issuer: "[email protected]", # client_id from the JSON
    signing_key: "PEM encoded private key" # private_key from the JSON
  6. 6.
    If using Office 365, paste this configuration into the encrypted tab:
    calendar_config:
    tenant: "",
    client_id: "",
    client_secret: "",
    conference_type: nil # This can be set to "teamsForBusiness" to add a Teams link to EVERY created Event
  7. 7.
    Enter your API information for Microsoft Azure or Google Workspace replacing placeholder text
    Calendar Driver Config
    ​

Add Module to Systems

You can now add the module to other systems as required.
  1. 1.
    Navigate to an existing system
  2. 2.
    Select the Modules tab
  3. 3.
    From the drop down, select the Calendar Module
  4. 4.
    Click Add Existing
    ​
    Add Existing Driver
    ​

Test Module

You can test by creating a booking or inspecting the state of the Calendar Driver.
Inspecting State should return a valid response.
Inspect State
This should return:
{
"connected": true
}
You can also execute a function on the module and view the response.
As a test, executing the list_users function should return a list of users if connected properly.
Exec Users
Previous
Configure Staff API
Next
Enable Sensor UI
Last modified 1yr ago