About the REST API

The O3 Room REST API allows you to send and receive data from the O3-HUB sensor hub installed in each room. This data gives you information about the room control setpoints, and its designated room activities that have been previously configured in enteliWEB.

The O3 Room REST API is REST-based, uses basic authentication, and always returns responses in JSON.

These room settings are previously configured by the enteliWEB administrator to match what the occupants intend to do in the room, for example, a meeting or presentation. The O3 app relies on the Bluetooth beacon in the sensor hub for room location information, and therefore is designed to work only with rooms or spaces that have the O3-HUB devices.

diagram showing the system incorporating the O3 app

Before You Start

The following tasks are absolutely required before you can interact with the API:

Set Up the enteliWEB Server

  • You must have enteliWEB version 4.8 or later installed, with the Web Services and Interface API license add-on activated. You can check the status of the add-on by going to gear icon > Configuration > Support in enteliWEB.
  • If you are creating an app for mobile devices, a wireless access point must be installed to allow Wi-Fi connections to enteliWEB.
  • If you are creating an app and submitting it to the Apple App Store or Google Play, the enteliWEB server must be set up for HTTPS connections, which requires installing an SSL certificate from a trusted certificate authority.

  • All room occupants need enteliWEB user accounts in enteliWEB and added as members of the O3 Room Guests group.

Create the Sensor Hub Object Database

Create a database for the sensor hub on the O3-DIN controller that is connected to the hub.

The fastest way to create the database is to use the templates in the Database Creation tool in enteliWEB.

Some of these objects in this database are used to set up the O3 rooms and activities. You may need to create extra objects to supplement the template objects.

Ensure CSV30s040 object is in the database, where s is the address assigned by the sensor hub's rotary switch. This object value displays the sensor hub's MAC address and is required by the O3 Room REST API.

Set Up O3 Rooms and Activities in enteliWEB

See Creating O3 Rooms in the enteliWEB help.

See Creating O3 Room Activities in the enteliWEB help.

Each O3 room can be set up to be controlled by any occupant or specific users.

  • If a room can be controlled by any occupant, add the O3 Room Guests group as the Principal Occupant of the room.
  • If a room can only be controlled by specific users, add these users as the Principal Occupant of the room.
 
© 2019 Delta Controls O3 Room REST API Version 1.0