ROOMZ

The ROOMZ app integrates ROOMZ sensors with the Eliona platform to provide real-time room usage data.

Overview

This manual contains instructions for the installation, configuration, and use of the ROOMZ app for data acquisition from ROOMZ sensors.

Installation

Install the ROOMZ app from the Eliona App Store.

Configuration

Register the app in ROOMZ and then configure the ROOMZ app via the Eliona settings.

Registering the App in the ROOMZ Portal

The ROOMZ app uses an experimental Webhook APIarrow-up-right that is not yet generally available. Contact ROOMZ support to activate the sending of data and to receive a webhook secret. The webhook endpoint for your Eliona instance is: https://{your-eliona-instance}/apps-public/roomz/webhook.

Since the webhook endpoint must be accessible via the internet, all incoming data is verified using the ROOMZ signature. For verification, ROOMZ must provide a webhook secret and a public key to check the signature.

Configuring the ROOMZ App

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

Attribute
Description

secret

Webhook secret provided by ROOMZ.

enable

Flag to activate or deactivate this configuration.

projectIDs

List of Eliona project IDs for data collection.

Example configuration JSON:

Continuous Asset Creation

After configuration, the app listens for data updates from ROOMZ. Each time the presence status changes (someone enters or leaves a room), the app receives a message from ROOMZ and writes the data to Eliona.

The app automatically creates all assets for the monitored rooms - When 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 after the room ID (the only information provided by the ROOMZ API), but it can be renamed and moved by the user.

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

Last updated