ROOMZ

The ROOMZ app integrates ROOMZ sensors with the Eliona platform to provide real-time data about workspace occupancy.

Overview

This guide provides instructions for installing, configuring, and using the ROOMZ app to collect data from ROOMZ sensors.

Installation

Install the ROOMZ app from the Eliona App Store.

Configuration

Register the app in ROOMZ, then configure the ROOMZ app through the Eliona settings interface.

Registering the App in ROOMZ Portal

The ROOMZ app uses an experimental Webhook API, which is not generally available yet. Contact ROOMZ support to activate data sending and get webhook secret. The webhook endpoint for your Eliona instance is: https://{your-eliona-instance}/apps-public/roomz/webhook.

As the Webhook enpoint has to be exposed to the Internet, all incoming data are verified using ROOMZ signature. To verify this, ROOMZ has to provide a Webhook secret, a public key to verify the signature.

Configuring the ROOMZ App

Configure the app in Eliona by navigating to Apps > ROOMZ > Settings, which opens the app's Generic Frontend. Use the POST method to set up the configuration. Each configuration requires the following parameters:

AttributeDescription

secret

Webhook secret provided by ROOMZ.

enable

Flag to enable or disable this configuration.

projectIDs

List of Eliona project IDs for data collection.

Example configuration JSON:

{
  "secret": "some-webhook-secret",
  "enable": true,
  "projectIDs": [
    "10"
  ]
}

Continuous Asset Creation

Once configured, the app listens for data updates from ROOMZ. Each time there is a presence status change (someone enters or leaves a space), the app receives a message from ROOMZ and writes the data to Eliona.

The app automatically creates all assets for the spaces being monitored - If the app receives data from a sensor for the first time, it creates a new asset under the "ROOMZ root" asset. The asset is named by the space ID (the only information provided by the ROOMZ API) but can be renamed and relocated by the user.

The user who created or last updated the app's configuration will be notified of newly created assets.

Last updated