Adding Drivers & Modules

Steps and Advice on using Drivers and Modules with PlaceOS.

PlaceOS uses drivers to communicate with third party systems and integrations.

A driver should be considered the parent and only needs to be loaded once.

A driver should not have any specific configuration attached, this will be done once the driver is instantiated as a module in a system.

For More Information you can read the key concepts of Drivers and Modules.

How to add a Driver

1. Navigate to PlaceOS Backoffice

2. Click on Drivers

3. Click Add New Driver

4. Select the Repository you want to add the driver from

5. Search for and select the required driver

6. Select a driver commit

It is recommended to select the most recent commit

7. Click on Save…

How to add a New Module

A module is an instantiation of a driver for use with a specific system, or collection of systems.

For modules that will be added to multiple systems, it is recommended to create a parent system that contains all the necessary service modules.

Specific configuration of the driver such as API Key's and other relevant configuration will be applied to the module.

1. Navigate to PlaceOS Backoffice

2. Click on Systems

3. Select your System

If configuring a global module, add it to your services system so it can easily be added to other room systems.

4. Click the Modules Tab

5. Click on Add new

6. Select the Driver you want to add from the List

7. Click on Save…

8. Click on the new module to configure

9. Select the appropriate tab for your configuration

10. Enter the required configuration

This might include API keys and other relevant information for that particular driver

11. Click on Save

Add an Existing Module to a System

There are specific applications where you would instantiate a driver in the Services system then re-use this module in additional systems.

Most common use cases for this method is creating bookable room systems, where each room system requires the driver to integrate with the Graph API (in the case of Microsoft 365) or where you have rooms with AV Control.

For the purposes of this demo, we will create a new bookable room system and add the existing calendar module from the tracking system.

1. Navigate to PlaceOS Backoffice

2. Click on Systems

3. Click New System

4. Select the required Zone

5. Enter a System Name

6. Enter the Resource Address

7. Enter a Display Name

8. Click on Save…

9. Click Modules

10. Select the Existing Module from the dropdown menu

11. Click on Add existing

12. Your existing module will now be added to the new system

Last updated