Skip to main content

 

Eptura Knowledge Center

Set up and pair sensors

Add your sensors to the Eptura Device Hub and pair them with your Eptura Engage workspace resources to monitor a space and initiate actions in Eptura Engage when activity is detected. Multiple sensors can be paired with the same Eptura Engage resource so larger areas can be monitored and actions initiated in Eptura Engage for the same resource.

When spaces are not pre-booked and a sensor detects presence, Eptura Engage creates anonymous bookings that are not associated with an actual user. This enables Eptura Engage to show and record the space as in use and allows administrators to accurately monitor how and when resources are being used.

PIN/RFID authentication must be disabled for Eptura screens installed at spaces monitored by sensors: When authentication settings are enabled, the user must either enter a PIN or swipe their RFID card to complete actions such as creating, starting, or ending a booking. These authentication settings must be disabled to allow anonymous bookings to be made (or ended) when the sensor detects changes to the presence in an unbooked space.

Authentication options are set in the desk booking screen and meeting room screen settings groups in the Device Hub.

Sensors home page on the Device Hub


dh-sensor-01_v1.png

Open the Device Hub Sensors page from Device Management (A) and Sensors (B). From here you can add and manage sensors, and pair them with Eptura Engage resources such as rooms and desks. Use the drop-down lists (C) to filter the list by Sensor provider, sensor type, latest sensor activity, and paired or unpaired sensors. To find a specific sensor, enter the sensor name in the search box (D).

The list of sensors shows the name of the sensor, the sensor type, the sensor provider, the sensor ID, the Eptura Engage resource the sensor is paired with, and the time of the sensor’s last activity.

When adding sensors to the Device Hub you have the option to store additional information of your choice. This can be accessed from the Metadata column.

How to add sensors to the Device Hub


Sensors can be added directly to the Device Hub individually and manually paired with the workspace, or uploaded and paired in bulk via a CSV file.

Add sensors manually to the Device Hub


Sensors can be added to the Device Hub individually and paired with the workspace.

Add the sensor

dh-sensor-02_v1.png

  1. Sign in to the Eptura Device Hub
  2. Select Device Management from the left icon bar (A) and select Sensors (B).
  3. Click Add sensor (E) to open the 'Add sensor' page.
  4. Select your sensor provider from the list (F).
  5. Select the sensor type you are adding from the list (G).
  6. Enter the sensor’s UUID (H).
  7. Enter a name for the sensor (J).
  8. Sensor Metadata: To save more information about the sensor (serial number, etc.), create appropriate labels and enter relevant details (K). Click Add another (L) to add more labels if required. Up to 10 additional labels can be added.
  9. Click Save to save the sensor and pair it with a workspace later, or you can pair it now.
Pair the sensor with a space

sensors 02b.png

  1. From the drop-down lists (M) at the bottom of the 'Add sensor' page, select the CountryLocationBuilding, and Floor for the workspace that the sensor will manage.
  2. Select the Workspace type (N), either a personal space or a meeting space.
  3. In the Workspace field (O) enter the name of the workspace to pair with the sensor.
  4. Click Save.

The sensor is now shown on the 'Sensors' page.

Add sensors in bulk to the Device Hub using a CSV file


Sensors can be added to the Device Hub in bulk via a CSV file. This creates the sensor resources in the Device Hub and pairs each one with the workspace name specified in the CSV. Sensor resources are added to the default sensor settings profile.

The process involves downloading a template CSV from the Device Hub that contains all workspace names for the selected location, adding your sensor information to the relevant workspace entries, and finally, uploading the CSV to the Device Hub.

The CSV template includes the following fields:

Field label
Description
WorkspaceId Id of workspace (prefilled).
WorkspaceName Optional: Name of the workspace (prefilled).
WorkspaceType Optional: Type of workspace (prefilled).
SensorId Id of Sensor (provider ID).
SensorProvider Enum
0=Reogix
SensorType Enum
0=Presence
SensorName Optional: Name of the Sensor.
Requirements and considerations when uploading sensor data via a CSV file
  • The maximum size of the CSV file is 10 MB.
  • Up to 25,000 sensor mappings can be processed via a single CSV file.
  • The SensorID values must contain a minimum of 8 characters. Prefix shorter SensorID values with leading zeros to ensure a minimum of 8 characters before uploading.
    • NOTE: If any SensorID values have a prefix of ‘0’ (zero), care must be taken if the CSV file is opened/edited in Microsoft Excel, or any other application that automatically removes a preceding zero. We recommend using a simple text editor such as Notepad++ to edit the CSV file.
  • After the file is uploaded, the records are processed in batches of 5,000 (max) in the background, with an interval of 30 minutes between batches.
  • Only one CSV file can be uploaded per API request.

How to download and complete the CSV, and upload the sensor data

Create a default sensor settings profile before uploading the sensor data to the Device Hub. Learn moreSettings and rules for sensors

dh-sensor-03.png

  1. Sign in to the Eptura Device Hub
  2. Select Device Management from the left icon bar (A) and select Sensors (B). 
  3. Click Bulk upload (P) to open the 'Bulk Add Sensors' page. 
  4. Select location for sensors (Q): From the drop-down lists, select the CountryLocationBuilding, and Floor to apply to the sensor devices.
  5. Click Download .csv file (R) to create a CSV file containing the details of all workspaces at the selected location. ⚠️Do not change the name of the downloaded CSV file!
  6. Add your sensor devices to the CSV alongside the workspaces you want to pair them with.
  7. Upload CSV file: Click Browse (S) to find and select the CSV file containing the workspace and sensor information. The name of the file must be identical to the name of the downloaded file.
  8. Click Upload (T).

Do not exceed the maximum person capacity of a space when pairing multiple sensors to the same Eptura Engage resource: The number of sensors paired with a Eptura Engage resource must not exceed the maximum capacity (occupancy) configured for the resource in the Eptura Engage room settings. When pairing sensors manually, you are prevented from pairing more than this number; however, when pairing sensors via bulk upload, the number of paired sensors is not validated against the resource capacity setting, so it is possible to pair more than is necessary.

The time to upload the data depends on the number of sensors being added. You can navigate away from this page while your file is processing.

For a successful upload, the CSV file must be in UTF-8 format, include a maximum of 1,000 rows, and the name of the file must be identical to the name of the downloaded file.

Pair sensors with workspaces


A sensor resource must be paired with an Eptura Engage workspace resource to communicate with Eptura Engage and initiate actions when activity is detected in a workspace. Multiple sensors can be paired with the same Eptura Engage workspace to monitor larger spaces and initiate actions in Eptura Engage for the same resource.

The number of sensors paired to an Eptura Engage resource must not exceed the maximum capacity set in the room settings.

Pair sensors with the space they will monitor. You can apply the pairing when the sensors are added to the Device Hub, either individually Learn how, or in bulk using the CSV file Learn how.

You can also apply a pairing (or unpair) after adding sensors to the Device Hub:

dh-sensor-04_v1.png

  1. Sign in to the Eptura Device Hub
  2. Select Device Management from the left icon bar (A) and select Sensors (B). 
  3. Use the Filter (C) to find all paired or unpaired sensors, or use the Search box (D) to find a particular sensor. 
  4. Click Pair (or Unpair) from the Action column (U). If you want to pair or unpair multiple sensors with a workspace, select the sensors from the list (V) and click the Pair multiple or Unpair multiple (W) button above the list.
  5. If pairing, the 'Pair Sensor With A Space' popup window is displayed. Select the Location details from the drop-down lists, select the Workspace type, and enter the name of the workspace to pair the sensor with.
    sensors 09.png
  6. Click Pair with this workspace when done.

Edit a sensor resource


Edit a sensor to change the workspace pairing or unpair it from a workspace. You can also change the sensor name and add/amend additional information about the sensor (metadata).

When created, it is not possible to edit the provider, UUID, and type of sensor..

  1. Sign in to the Eptura Device Hub
  2. Select Device Management from the left icon bar (A) and select Sensors (B). 
  3. Use the Filter (C) and/or Search box (D) to find the sensor you want to edit. 
  4. Click the sensor to open the 'Edit sensor' page, and make your changes. (The fields are described in Add the sensor). 
  5. Click Save when done.

Deleting a sensor resource


The sensor is automatically unpaired from the Eptura Engage resource when deleted.

  1. Sign in to the Eptura Device Hub
  2. Select Device Management from the left icon bar (A) and select Sensors (B). 
  3. Use the Filter (C) and/or Search box (D) to find the sensor you want to delete. 
  4. Click the bin icon to the right of a sensor in the list to delete it, or if you want to delete multiple sensors, select the sensors from the list (V) and click the Delete multiple button (X) above the list.
  5. Click Delete to confirm.