Bookings Driver
How to Configure the Bookings Driver on PlaceOS
Last updated
How to Configure the Bookings Driver on PlaceOS
Last updated
The primary purpose of the Bookings Driver is to enable room booking panels, kiosks and space maps.
Best practice is to add the Bookings Driver to every system on PlaceOS that supports room booking.
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
Before we can use the PlaceOS Bookings Driver we must instantiate it as a driver.
Navigate to the Drivers tab
Click the +
icon to add a new driver
Select PlaceOS Drivers
Repository
Select the drivers > place > bookings.cr
Driver Base
Select the latest commit
Click Save
You need to instantiate a single instance of the PlaceOS Bookings Driver in each system that has a bookable space.
Navigate to a bookable system
Select the Modules
tab
Click Add New
Select PlaceOS Bookings
Click Save
Click the Black Dot next to the Module to start it
You can test by creating a booking and inspecting the state of the Bookings Driver.
Inspecting the state will return a JSON response of all bookings for that systems calendar resource.
In the example below, you will see a positive response with a calendar booking.
Status | Values | Function |
---|---|---|
| (Bool) |
|
| (Bool) |
|
| (Bool) |
|
| (Bool) |
|
| (Bool) |
|
|
| Describes the current status of the room |
List of settings can be found in the driver source: https://github.com/PlaceOS/drivers/blob/master/drivers/place/bookings.cr#L12
Setting | Default Value | |
---|---|---|
|
| Number of minutes BEFORE the Booking start time until the |
|
| Number of minutes AFTER the Booking start time until |
|
| Exposes a |
This will make status
change to pending
5 mins before the booking start time. Then change to busy
at the booking start time.