[UniFi] [Protect] [IP] Version [1.0]

Introduction & Manufacturer Profile

UniFi Protect is Ubiquiti's professional-grade video surveillance platform that delivers enterprise-level security without the complexity or recurring fees of traditional systems. Built on the foundation of local processing and storage, UniFi Protect offers a comprehensive solution for modern surveillance needs.

UniFi Protect represents Ubiquiti's commitment to providing professional security solutions that prioritize user control, privacy, and reliability while maintaining an intuitive user experience suitable for both residential and commercial applications.

Version History

Version 1.0

Initial Release

System Requirements & Prerequisites

RTI System Requirements

Integration Designer: 11.12 or later.

XP FW: 22.3.31 or later.

Driver Information

Supports all UniFi Protect devices: cameras, doorbells, sensors, lights, chimes, and viewports.

Requires a Local API Key generated from the UniFi Protect interface.

Direct network communication to the UniFi Gateway device (UDM, UNVR, or Cloud Key).

For remote configuration, use UniFi Teleport VPN connection.

Network Requirements

The RTI processor must have network access to the UniFi Gateway device.

HTTPS communication on port 443.

For off-site programming, establish a Teleport VPN connection first.

Obtaining Your API Key

To use this driver, you must generate a Local API Key from your UniFi Protect system:

Step 1: Access UniFi Protect Settings

Open the UniFi Protect web interface or mobile app

Navigate to Settings (gear icon)

Select Control Plane from the left menu.

Select the Integrations Tab.

Step 2: Generate the API Key

Under the Your API Keys section enter a descriptive name (e.g., "RTI Control System")

Select Never Expire from the dropdown menu.

Select Create API Key.

The system will display your API key only once - copy it immediately

Store the key securely - you cannot retrieve it later

Important Notes:

If you lose your API key, you must generate a new one

API keys can be manually revoked at any time

For security, create a dedicated user account for the integration rather than using your personal admin account

Step 3: Create dedicated user

Select the Admins & Users menu item below the settings cog

Select Create New, Create New User

Enter the Name, and enable the admin checkbox.

Select Create

Once created, select the user.

In the popup, select the Settings cog

Enable the Restrict to local access only checkbox

Set Protect to Full Management

If using the UniFi Network driver as well, Set Network to Full Management as well

Driver Configuration

Initial Setup

Add the Driver

Add the "Unifi Protect" driver to Global in Integration Designer

Initial Configuration Wizard

API Key: Enter the Local API Key you generated from UniFi Protect

Gateway IP Address: Enter the IP address of your UniFi Gateway device

This is the device running the Protect application (UDM, UNVR, or Cloud Key Gen2+)

Example: 192.168.1.1

Device Discovery

After entering the IP address, click OK when prompted to retrieve the configuration

The driver will automatically discover and configure all UniFi Protect devices

This process may take 10-60 seconds depending on the number of devices

Device Organization

The driver automatically organizes devices by type:

Cameras: Standard security cameras

Doorbells: Video doorbells with ring detection

Lights: Smart security lights with motion detection

Sensors: Environmental and security sensors

Viewports: Display devices for viewing camera feeds

Chimes: Integrated with associated cameras/doorbells (not listed separately)

Adding Sources

Once the driver has pulled the configuration, any found devices will be listed in the Add to Existing Driver section of the Add Workspace Item window.

You need to add any of the devices you want to control to the project from there.

Template Page Names

Use these template page names when creating user interfaces:

Unifi Camera - For cameras and doorbells

Unifi Light - For smart lights

Unifi Sensor - For sensors

Unifi Viewport - For viewport devices

Driver Features

Camera/Doorbell

Commands

OSD Controls

OSD: Name - Toggle/Enable/Disable camera name overlay

OSD: Date - Toggle/Enable/Disable date/time stamp

OSD: Logo - Toggle/Enable/Disable UniFi logo

OSD: Position - Set overlay position (Top Left/Middle/Right, Bottom Left/Middle/Right)

Audio Controls

Mic Volume - Set microphone volume (0-100)

Permanently Disable Mic - Disable microphone (cannot be undone)

Display Controls

LED State - Toggle/Enable/Disable status LED

Video Controls

HDR Type - Set HDR mode (Auto/On/Off)

Video Mode - Select video recording mode

Smart Detection

Smart Detect Objects - Enable/disable object detection types

Smart Detect Audio - Enable/disable audio detection types

PTZ Controls (Compatible Cameras)

Start a Patrol - Begin patrol route (Patrol 1-5)

Stop Current Patrol - Stop active patrol

Move to Preset - Move camera to preset position (Home, Preset 1-5)

Chime Controls (Doorbells)

Set Chime Ring Volume - Adjust chime volume (0-100)

Set Ring Repeat Number - Set number of ring repeats (1-10)

Variables

Status Information

Camera/Doorbell Name - Device name (string)

Online - Connection status (boolean)

RTSP Streams

RTSP Url - High - High quality stream URL

RTSP Url - Medium - Medium quality stream URL

RTSP Url - Low - Low quality stream URL

RTSP Url - Package - Package camera stream (doorbells)

OSD Status

OSD: Name Enabled - Name overlay status (boolean)

OSD: Date Enabled - Date/time overlay status (boolean)

OSD: Logo Enabled - Logo overlay status (boolean)

OSD: Overlay Location - Current position (Top/Bottom, Left/Middle/Right)

Detection Status

Motion Detected - Motion detection state (boolean)

Doorbell Ringing - Ring status for doorbells (boolean)

Audio Status

Mic Visible - Microphone feature availability (boolean)

Mic Enabled - Microphone state (boolean)

Mic Volume - Current microphone volume (0-100)

LED Status

LED Visible - LED feature availability (boolean)

LED Enabled - Status LED state (boolean)

LED Disabled - LED disabled state (boolean)

HDR Status

HDR Visible - HDR feature availability (boolean)

HDR On - HDR enabled (boolean)

HDR Off - HDR disabled (boolean)

HDR Auto - HDR auto mode (boolean)

Video Mode Status

Video Modes Visible - Video mode feature availability (boolean)

Video Mode: [Mode Name] Visible - Individual mode availability (boolean)

Video Mode: [Mode Name] Enabled - Individual mode status (boolean)

Smart Detection Status

Smart Objects Visible - Object detection feature availability (boolean)

Smart Object: [Type] Enabled - Detection type enabled (boolean)

Smart Object: [Type] Detected - Active detection state (boolean)

Smart Audio Visible - Audio detection feature availability (boolean)

Smart Audio: [Type] Enabled - Audio detection type enabled (boolean)

Smart Audio: [Type] Detected - Active audio detection state (boolean)

PTZ Status (Compatible Cameras)

PTZ Visible - PTZ feature availability (boolean)

Patrol [1-5] Visible - Patrol slot availability (boolean)

Patrol [1-5] Active - Patrol active state (boolean)

Chime Status (Doorbells)

Chime: Ring Repeat Number - Number of repeats (1-10)

Chime: Ring Volume - Volume level (0-100)

Chime: Ringing - Chime ringing state (boolean)

Events

Connection Events

Offline - Camera disconnected from network

Online - Camera connected to network

Motion Events

Motion Started - Motion detection began

Motion Stopped - Motion detection ended

Doorbell Events (Doorbells Only)

Doorbell Ring Started - Doorbell button pressed

Doorbell Ring Stopped - Ring event ended

LED Events

LED is Enabled - Status LED turned on

LED is Disabled - Status LED turned off

HDR Events

HDR Type: Auto - HDR set to automatic

HDR Type: On - HDR enabled

HDR Type: Off - HDR disabled

Video Mode Events

Video Mode: [Mode Name] - Video mode changed

Smart Object Detection Events

Smart Detect Object: [Object Type] Started - [Object Type] detected

Smart Detect Object: [Object Type] Stopped - [Object Type] detection ended

Smart Audio Detection Events

Smart Detect Audio: [Audio Type] Started - [Audio Type] detected

Smart Detect Audio: [Audio Type] Stopped - [Audio Type] detection ended

Lights

Commands

Force Light - Toggle/On/Off manual light control

Mode - Set light mode (Always/On With Motion/Off)

Enable At - Set when light is active (Always/Night Only)

Indicator LED - Toggle/Enable/Disable status indicator

LED Level - Set brightness level (1-6)

PIR Sensitivity - Set motion detection sensitivity (0-100)

PIR Duration - Set light-on duration after motion (15-900 seconds)

Variables

Status Information

Name - Light name (string)

Online - Connection status (boolean)

Force Light - Manual control state (boolean)

Force Light Off - Manual off state (boolean)

Light On - Light operational state (boolean)

Is Dark - Darkness detection state (boolean)

Motion Detected - Motion state (boolean)

Mode Status

Light Mode: Always - Always on mode (boolean)

Light Mode: On With Motion - Motion mode (boolean)

Light Mode: Off - Off mode (boolean)

Enabled At: Always - Always enabled (boolean)

Enabled At: Night Only - Night only enabled (boolean)

Settings

PIR Duration (s) - Motion duration setting (15-900)

PIR Sensitivity - Motion sensitivity (0-100)

LED Level - Brightness level (1-6)

Indicator LED Enabled - Status indicator state (boolean)

Indicator LED Disabled - Status indicator off state (boolean)

Events

Connection Events

Offline - Light disconnected from network

Online - Light connected to network

Motion Events

Motion Detected - Motion sensor triggered

Motion Ended - Motion sensor cleared

Light Events

Light is On - Light turned on

Light is Off - Light turned off

Is Dark - Darkness detected by sensor

Is Not Dark - Light detected by sensor

Sensors

Commands

Motion Settings

Motion Detect - Toggle/Enable/Disable motion detection

Motion Sensitivity - Set motion detection sensitivity (0-100)

Temperature Settings

Temperature Enable/Disable - Toggle temperature monitoring

Temperature Thresholds - Set high/low temperature limits

Humidity Settings

Humidity Enable/Disable - Toggle humidity monitoring

Humidity Thresholds - Set high/low humidity limits (0-100%)

Light Settings

Light Enable/Disable - Toggle light level monitoring

Light Thresholds - Set high/low light level limits (0-100)

Alarm Settings

Alarm Enable/Disable - Toggle alarm function

Leak Detection

Internal Leak Enable/Disable - Toggle internal leak detection

External Leak Enable/Disable* - Toggle external leak detection

Variables

Status Information

Name - Sensor name (string)

Online - Connection status (boolean)

Battery Status

Battery Level - Charge percentage (0-100)

Battery Is Low - Low battery alert (boolean)

Contact Status

Contact Is Open - Contact sensor state (boolean)

Motion Status

Motion Enabled - Motion detection enabled (boolean)

Motion Disabled - Motion detection disabled (boolean)

Motion Sensitivity - Sensitivity level (0-100)

Motion Detected - Motion state (boolean)

Temperature Status

Temperature Enabled - Temperature monitoring enabled (boolean)

Temperature Disabled - Temperature monitoring disabled (boolean)

Temperature Threshold Low (°C) - Low threshold (-39 to 127)

Temperature Threshold High (°C) - High threshold (-39 to 127)

Temperature Level - Current temperature (string)

Temperature Status - Status (High/Normal/Low)

Temperature Is High - High temperature alert (boolean)

Temperature Is Low - Low temperature alert (boolean)

Humidity Status

Humidity Enabled - Humidity monitoring enabled (boolean)

Humidity Disabled - Humidity monitoring disabled (boolean)

Humidity Threshold Low (%) - Low threshold (0-100)

Humidity Threshold High (%) - High threshold (0-100)

Humidity Level - Current humidity (0-100)

Humidity Status - Status (High/Normal/Low)

Humidity Is High - High humidity alert (boolean)

Humidity Is Low - Low humidity alert (boolean)

Light Status

Light Enabled - Light monitoring enabled (boolean)

Light Disabled - Light monitoring disabled (boolean)

Light Threshold Low - Low threshold (0-100)

Light Threshold High - High threshold (0-100)

Light Level - Current light level (0-100)

Light Status - Status (High/Normal/Low)

Light Level Changed - Change detection (boolean)

Alarm Status

Alarm Enabled - Alarm function enabled (boolean)

Alarm Disabled - Alarm function disabled (boolean)

Leak Detection Status

Internal Leak Enabled - Internal detection enabled (boolean)

Internal Leak Disabled - Internal detection disabled (boolean)

External Leak Enabled - External detection enabled (boolean)

External Leak Disabled - External detection disabled (boolean)

Events

Connection Events

Offline - Sensor disconnected from network

Online - Sensor connected to network

Battery Events

Battery Low Event - Battery level below threshold

Contact Events

Contact Opened Event Started - Contact sensor opened

Contact Opened Event Stopped - Contact sensor closed

Temperature Events

Temperature High Event Started - Temperature above high threshold

Temperature High Event Stopped - Temperature returned to normal

Temperature Low Event Started - Temperature below low threshold

Temperature Low Event Stopped - Temperature returned to normal

Humidity Events

Humidity High Event Started - Humidity above high threshold

Humidity High Event Stopped - Humidity returned to normal

Humidity Low Event Started - Humidity below low threshold

Humidity Low Event Stopped - Humidity returned to normal

Light Events

Light Level Changed Event Started - Light level changed significantly

Light Level Changed Event Stopped - Light level stabilized

Motion Events

Motion Started - Motion detected

Motion Stopped - Motion ended

Alarm Events

Alarm Enabled - Alarm function turned on

Alarm Disabled - Alarm function turned off

Leak Detection Events

Internal Leak Enabled - Internal leak detection turned on

Internal Leak Disabled - Internal leak detection turned off

External Leak Enabled - External leak detection turned on

External Leak Disabled - External leak detection turned off

Viewports

Commands

Select Liveview - Choose active live view layout

Variables

Status Information

Name - Viewport name (string)

Online - Connection status (boolean)

Current Liveview - Active live view index

[Liveview Name] Name - Individual live view name (string)

[Liveview Name] Active - Individual live view state (boolean)

Events

Connection Events

Offline - Viewport disconnected from network

Online - Viewport connected to network

Troubleshooting

Common Issues

Driver won't connect to gateway:

Verify the gateway IP address is correct

Ensure the RTI processor can reach the gateway (ping test)

Confirm the API key is valid and hasn't been revoked

Check that the gateway is running the latest Protect firmware

Devices not appearing after configuration:

Refresh the driver configuration

Use "Retrieve Devices" from the driver menu

Verify devices are adopted and online in UniFi Protect

Make sure you have added any devices you want to control to the project from the Add to Existing Driver section of the Add Workspace Item window.

RTSP streams not showing:

Ensure RTSP is enabled in UniFi Protect settings

Smart detection not triggering events:

Verify smart detection is enabled on the camera in UniFi Protect

Confirm the camera model supports the detection type

Check that detection zones are properly configured

System Testing

Integration Designer 11.12:

XP Processor Model: XP-6s

XP Processor Firmware: 25.9.24

Device Model(s): All Protect Device Types

Support Contact

RTI Control

+ 1.952.253.3137

support@rticontrol.com