For the complete documentation index, see llms.txt. This page is also available as Markdown.

EnOcean configuration

Overview

UMA Vision supports EnOcean sensors paired through Cisco Catalyst Access Points via EnOcean Smart Studio. This allows organisations running Cisco APs to use their existing network infrastructure for IoT sensors — no additional gateway hardware is required. Sensors connect using an EnOcean USB 300 dongle plugged into the Access Point, and data flows through EnOcean Smart Studio's MQTT broker into UMA Vision.

Data flow: Sensor → EnOcean USB 300 dongle → Cisco Catalyst Access Point → WSS Tunnel → EnOcean Smart Studio → MQTT Broker → UMA Vision

This guide covers the full setup process: preparing your Cisco infrastructure, configuring EnOcean Smart Studio, and adding devices in UMA Vision.


Supported Sensors

Only the following sensors are currently supported via the EnOcean Smart Studio integration. Four sensor types are available:

Sensor Type
UMA Device Name
EnOcean Device Type
What It Measures

Desk Occupancy

EnOcean Desk Occupancy Sensor

A5-07-01

Motion / presence at a desk

Room Occupancy

EnOcean Room Occupancy Sensor

A5-07-01

Motion / presence in a room

Environmental

EnOcean Environmental Sensor

A5-09-04

Temperature, humidity, CO₂

CT Clamp (Current Monitoring)

EnOcean Current Monitoring Sensor

3 Phase CT Clamp

Energy consumption

Each sensor type uses a specific EnOcean Equipment Profile (EEP). You will need the correct EEP when registering sensors in EnOcean Smart Studio. Contact your supplier for the EEP references for room, environmental, and CT clamp sensors if needed.


Prerequisites

Before starting, ensure the following are in place:

  • Cisco Catalyst Access Point — a supported model such as the C9120AXI-E

  • Cisco Wireless LAN Controller (WLC) — Cisco Catalyst 9800 series, running software version 17.6.1 or later

  • PoE power source — the switch or power injector must support PoE Standard 802.3at. USB ports on the AP will not be powered if PoE requirements are not met

  • EnOcean USB 300 dongle — plugged into the AP's USB port to enable IoT connectivity

  • EnOcean Smart Studio subscription — sign up at app.enocean.cloud

  • IOxClient — Cisco's CLI tool for deploying IOx applications, downloaded from Cisco's website

  • WSS Tunnel package — the tunnel application and activation payload, available from EnOcean's Bitbucket repository

  • UMA Vision MQTT credentials — provided by UMA. These are customer-specific credentials used to connect EnOcean Smart Studio to UMA Vision's MQTT broker


Configuration

Step 1: Verify Your Cisco Access Point

The Access Point must be joined to your Wireless LAN Controller and properly configured before deploying the EnOcean tunnel.

Check AP status on the WLC

  1. Confirm the AP has joined the WLC and its status is Healthy

    • Navigate to Monitoring → Wireless → AP Statistics

  2. Note the AP's IP address — you will need this when deploying the tunnel application

    • Navigate to Monitoring → Wireless → AP Statistics

  3. If there are join issues, check the join statistics for errors

    • Navigate to Monitoring → Wireless → AP Statistics → Join Statistics

Verify USB module and power

  1. Check that the USB module is detected and its state is Enabled

    • Navigate to Configuration → Wireless → Access Points → Edit AP → Interfaces

    • If no module is detected, the operational state will show as disabled — ensure the EnOcean USB 300 dongle is properly seated

  2. Verify the PoE power source shows FULL Power mode

    • Navigate to Configuration → Wireless → Access Points → Edit AP → Interfaces

  3. Confirm the USB module appears in the AP's inventory

    • Navigate to Configuration → Wireless → Access Points → Edit AP → Inventory

Note your WLC and join profile details

You will need these values during tunnel deployment:

  • WLC Name — found under Administration → Device

  • AP Join Profile settings — found under Configuration → Tags & Profiles → AP Join

    • Ensure USB Enable is ticked (enables USB on all joined APs)

    • Ensure AppHost Enable is ticked (enables application hosting on all joined APs)

    • Note the User Management credentials (username and password) — you will need these for the IOxClient profile


Step 2: Deploy the WSS Tunnel Application

The WSS tunnel runs on the Cisco AP and creates a secure connection between the EnOcean USB 300 dongle and EnOcean Smart Studio. You deploy it using Cisco's IOxClient CLI tool.

Install, activate, and start the tunnel

Run the following commands using IOxClient, replacing the placeholder values with your own:

Where:

  • <profile-name> — the name of your IOxClient profile (e.g. myprofile)

  • <package-name> — the name for the WSS tunnel app instance

  • <package.tar> — the path to the WSS tunnel package downloaded from EnOcean's Bitbucket repository

  • <activation-payload-file> — the path to the activation payload file from the same repository

Configure the tunnel

Create or update the package_config.ini file with the following values:

The tunnel username and password are found in EnOcean Smart Studio under Integrations → Applications → Aruba Gateway.

Apply the configuration and restart:

Verify the connection

Once the tunnel is running, log in to EnOcean Smart Studio. Your Cisco Access Point should now appear as an online gateway. If it does, the tunnel deployment is complete.


Step 3: Add Sensors in EnOcean Smart Studio

With the gateway (AP) connected, you can now register your sensors in Smart Studio.

  1. Add each sensor using its EnOcean radio ID (printed on the sensor or its packaging) and the correct EEP for the sensor type

  2. Once added, sensors should appear as online and begin transmitting data through the connected gateway


Step 4: Configure MQTT Connection to UMA Vision

EnOcean Smart Studio needs to be configured to forward sensor data to UMA Vision via MQTT. UMA will provide you with customer-specific MQTT credentials for this step.

  1. In EnOcean Smart Studio, go to Integrations

  2. Under Applications → MQTT Broker, enter the MQTT connection details provided by UMA:

    • Broker address — provided by UMA

    • Username — provided by UMA

    • Password — provided by UMA

  3. Click Update and ensure the MQTT Broker is enabled

Important: Do not change the default MQTT topic format (v0/sensor/[ID]/telemetry). UMA Vision expects sensor data on this topic structure. Changing it will prevent sensor readings from appearing in UMA.

Sensor data will now start flowing into UMA Vision.


Step 5: Add Devices in UMA Vision

Once data is flowing from Smart Studio, adding devices in UMA Vision is straightforward.

  1. Go to Devices in UMA Vision

  2. Click Add Device

  3. Select EnOcean as the device group

  4. Choose the sensor type:

    • EnOcean Desk Occupancy Sensor

    • EnOcean Room Occupancy Sensor

    • EnOcean Environmental Sensor

    • EnOcean Current Monitoring Sensor

  5. Enter the sensor's EnOcean radio ID — this must match the ID registered in Smart Studio

  6. Save the device

The sensor will appear in your device list. Once it begins receiving data, it will show as online with its last communication time, the gateway it's connected through, its EEP, and current readings.


Auto-Booking and Auto-Release

EnOcean occupancy sensors (desk and room) support auto-booking and auto-release, just like other occupancy sensors in UMA Vision.

  • Auto-booking — when the sensor detects motion, the resource is automatically booked for the detected user

  • Auto-release — when no motion is detected for the configured period, the resource is automatically released and made available for others

To enable these features, go to the resource's settings and configure auto-booking and auto-release as you would for any other occupancy sensor.


Analytics and Reporting

All EnOcean sensor data flows through to UMA Vision's analytics and reporting features. Historical readings for occupancy, temperature, humidity, CO₂, and energy are recorded and available in:

  • Sensor dashboards — Energy, Occupancy, Air Quality & CO₂, Temperature & Humidity (Analytics Pro)

  • Space Usage & Trends — sensor utilisation data alongside calendar bookings (Analytics Pro)

  • Device detail pages — real-time and historical readings for individual sensors

  • Reports — sensor data is included in standard and AI-generated reports


Troubleshooting

Issue
What to check

AP not appearing in Smart Studio

Verify the WSS tunnel is running (ioxclient application status). Check the package_config.ini credentials match Smart Studio. Ensure the AP has internet connectivity.

Sensor not appearing in Smart Studio

Confirm the sensor's radio ID and EEP are entered correctly. Check the sensor has battery power and is within range of the AP.

Sensor shows as offline in UMA Vision

Check the sensor is online in Smart Studio first. Verify the MQTT broker is enabled and credentials are correct in Smart Studio. Confirm the EnOcean radio ID in UMA matches the one in Smart Studio.

No sensor readings in UMA

Ensure the MQTT connection is active in Smart Studio (check the broker status). Verify the device type in UMA matches the actual sensor type.

Auto-booking / auto-release not working

Confirm the sensor is an occupancy type (desk or room). Check that auto-booking and auto-release are enabled on the resource in UMA Vision.


Sensor installation guides

Desk occupancy sensor


Room occupancy sensor


Co2, temperature and humidity sensor


Current monitoring sensor (3 channel)

Last updated

Was this helpful?