LogoLogo
  • PlaceOS Documentation
  • Overview
    • Key Concepts
      • Drivers
      • Interfaces
      • Modules
      • Settings
      • Systems
      • Triggers
      • Zones
    • Languages
      • Crystal
      • TypeScript
    • Protocols
      • MQTT
      • SAML
      • OAuth2
  • How To
    • Configure PlaceOS for Microsoft 365
      • Step 1: Room Calendar Access
        • Create Azure App Registration (Application Permissions)
        • Exchange Calendar Group
        • Limit Application Permissions
        • Configure PlaceOS Calendar Driver
      • Step 2: User Authentication & Calendar Access
        • Create a PlaceOS Authentication Source
        • Create Azure App Registration (Delegated Permissions)
        • Configure PlaceOS Authentication Source
        • Add User Login Redirects
      • Concierge Access
      • Troubleshooting
        • Blocked or Blacklisted IP Error
    • Configure PlaceOS for Google Workspace
      • Google Configuration
        • Create Google Cloud Project & Enable API
        • Configure Google Cloud Service Account
        • Add Google Workplace Permissions
        • Create Google Marketplace App (optional)
        • Google Workspace Service User (RBAC)
        • Configure Access to Google Resource Calendars
      • User Authentication
        • Create a PlaceOS Authentication Source for Google
        • Create Google Cloud OAuth2 Client App
        • Configure PlaceOS Auth Source for Google
        • Add User Login Redirects
    • Deployment
      • Deploy AWS Fargate on Modular CloudFormation Stacks
      • Deploy AWS Fargate on Nested CloudFormation Stacks
      • Writing Import Scripts
    • Analytics
      • MQTT Integration
    • Backoffice
      • Add a Domain to PlaceOS
      • Backoffice File Upload
      • Configure Staff API
      • Calendar Driver
      • Enable Sensor UI
      • Bookings Driver
      • Configure a webhook
    • Authentication
      • Azure B2C
        • Azure B2C Custom Policy Framework
        • Configure PlaceOS for Azure B2C
        • 365 Room Resources on Azure B2C
      • Configure SAML SSO
        • Configure SAML2 with AD FS
        • Configure SAML2 with Auth0
        • Configure SAML2 with Azure AD
        • Configure SAML2 with Google Workspace
      • Configure OAuth2 SSO
      • X-API Keys
      • Bearer tokens
    • Location Services
      • Location Services
      • Area Management
      • Discovering User Devices
      • Locating Users on a Network
      • People Finding with Cisco Meraki on PlaceOS
      • People Finding with Juniper Mist on PlaceOS
    • Notifications
      • Catering Orders
    • User Interfaces
      • Booking Panel App
      • Workplace App
      • Native Booking Panel App
      • Deploy a Frontend Interface
      • Microsoft Outlook Plugin
      • Configure Endpoint Auto Login
      • SVG Map Creation
      • Configuring a default UI
  • Tutorials
    • Setup a dev environment
    • Backend
      • Troubleshooting Backend Failures
      • Import Bookable Rooms
      • Writing A Driver
        • Testing drivers
        • ChatGPT / LLM Capabilities
          • Native GPT Plugins
      • Testing Internal Builds
    • Backoffice
      • Adding Drivers & Modules
      • Add Zone Structure
    • Common Configurations
      • Asset Manager
      • Catering
      • Locker Booking
      • Webex Instant Connect
      • Desk booking
      • Sensor Data Collection
        • Configure Kontakt IO
        • Configuring Meraki
        • Configuring DNA Spaces
      • Elevated Privileges
  • Reference
    • API
      • Real-time Websocket
      • Rest API
      • Staff API
    • Drivers
      • PlaceOS
        • Bookings
        • Staff API
        • Visitor Mailer
        • Lockers
      • Microsoft
        • Graph API
    • PlaceOS Skills
    • Privacy Policy
    • Recommended Products
    • Supported Integrations
    • System Architecture
    • System Functionality & Requirements
    • Infrastructure Requirements
    • Security Compliance
      • FAQ
      • GDPR
      • Security
    • Microsoft Azure Permissions
  • Glossary
  • 🎯PlaceOS Roadmap
  • 🆘PlaceOS Support
  • 👩‍💻PlaceOS Github
  • 📝PlaceOS Changelog
Powered by GitBook
On this page
  • How to add a Driver
  • How to add a New Module
  • Add an Existing Module to a System
Export as PDF
  1. Tutorials
  2. Backoffice

Adding Drivers & Modules

Steps and Advice on using Drivers and Modules with PlaceOS.

PreviousBackofficeNextAdd Zone Structure

Last updated 2 years ago

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.

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


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

Step 2 screenshot
Step 3 screenshot

In most cases this will be preconfigured as the PlaceOS Drivers Repo.

Step 5 screenshot
Step 7 screenshot
Step 2 screenshot
Step 4 screenshot
Step 5 screenshot
Step 6 screenshot
Step 7 screenshot
Step 8 screenshot
Step 9 screenshot
Step 11 screenshot
Step 2 screenshot
Step 3 screenshot
Step 4 screenshot
Step 5 screenshot
Step 6 screenshot
Step 7 screenshot
Step 8 screenshot
Step 9 screenshot
Step 10 screenshot
Step 11 screenshot
Step 12 screenshot
Drivers
Modules
Step 4 screenshot