Ubiquiti UniFi

Setup

See the Data Servers page for information on configuring driver communication.

Prerequisites


Software	Minimum Version
IPFusion — Ubiquiti UnFi	1.0
.NET Framework	4.7.2

When completing your setup, be sure to have the Ubiquiti UniFi documentation available for reference.

Ports

These ports must be open in your network firewall for the integration to work.


Purpose	Default Value	Configurable
Ubiquiti Unfi Server Connection	12445	No
Dataserver	9681	Yes
Debug Tools	9682	No

Communication Configuration

In the integrated system configuration panel, you will find the Server Information. The below information is required.


Address	The host name or IP address of the Ubiquiti server.
Username	The username for logging into the Ubiquiti server. Note: It is recommended to have a user account created specifically for the Runtime connection.
Password	The password for logging into the Ubiquiti server.
Access Token	The token used to gain access to the Ubiquiti server.

Assets

System

This asset represents the connection to the Ubiquiti UniFi system.

Supported States


Acknowledged	An asset alarm has been acknowledged.
Fault	An issue has been detected in a connected asset.
Masked	The asset has been masked over its true state.
No Communication	Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid. Note: This status is required in all status tables.
Normal	The asset is online and in its default state.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands


Acknowledge	Acknowledge an asset alarm.
Cancel	Deselects all selected assets.
Mask	Mask the asset's true state.
Reset	Resets the asset to its true hardware state.
New Note	Adding the New Note Command to your Command Table subscribes this asset to Notes, allowing an operator to attach Notes to this asset in Runtime.
Workflow Trigger	Allows users to trigger Workflows to create custom commands.

See the Command Tables page for more information on configuring command tables.

Door

This asset represents of the state of a door in the Ubiquiti system.

Required Property Grid Fields


Door ID	The unique identifier for the door.
DPS Mode	The status or typical position of the door. Choose from Normally Closed and Normally Open.

Supported States

Note: This asset supports multistate, meaning the asset can be in multiple statuses at once.


Acknowledged	An asset alarm has been acknowledged.
Closed	The door is closed.
Fault	An issue has been detected in a connected asset.
Locked	The door is locked.
Masked	The asset has been masked over its true state.
No Communication	Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid. Note: This status is required in all status tables.
Open	The door is open.
REX Active	A Request to Exit can be sent to the door.
REX Inactive	A Request to Exit cannot be sent to the door.
Unlocked	The door is unlocked.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands


Acknowledge	Acknowledge an asset alarm.
Cancel	Deselects all selected assets.
Mask	Mask the asset's true state.
New Note	Adding the New Note Command to your Command Table subscribes this asset to Notes, allowing an operator to attach Notes to this asset in Runtime.
Reset	Resets the asset to its true hardware state.
Temporary Unlock	Temporarily unlocks the door.
Workflow Trigger	Allows users to trigger Workflows to create custom commands.

See the Command Tables page for more information on configuring command tables.

Camera

The camera asset is designed to represent a camera in the Ubiquiti system.

Required Property Grid Fields


ID	The unique identifier for the camera.

Supported States

Note: Multistate statuses are not supported for this system.


Acknowledged	An asset alarm has been acknowledged.
Fault	An issue has been detected in a connected asset.
Masked	The asset has been masked over its true state.
Motion Detected	The asset detects motion.
No Communication	Communication has been lost with the driver or camera. This can also occur when the camera has been disabled. Note: This status is required in all status tables.
Normal	The asset is online and in its default state.
Recording	The camera asset is recording video.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands


Acknowledge	Acknowledge an asset alarm.
Reset	Resets the asset to its true hardware state.
Cancel	Deselects all selected assets.
Mask	Mask the asset's true state.
New Note	Adding the New Note Command to your Command Table subscribes this asset to Notes, allowing an operator to attach Notes to this asset in Runtime.
Workflow Trigger	Allows users to trigger Workflows to create custom commands.

See the Command Tables page for more information on configuring command tables.

Troubleshooting

Logs from the driver and Runtime can be viewed in the Debug Tools client. These messages contain information which can provide further context for issues during initialization, or while actively running. This can help diagnose problems.