Setup guide

UniFi Protect Viewport is a two-part product: the UniFi Protect Viewport base driver switches a physical UniFi Protect Viewport’s liveview from Crestron remotes, keypads, and touch panels, and the optional Camera Grid companion adds a named, tappable camera grid to the touch panel. Both are covered here; Camera Grid needs the base driver already paired before it’s added.

Before you start

• A Crestron Home processor (CP4-R class).
• A UniFi Protect NVR/console with the integration API enabled, on the same network the Crestron processor can reach.
• One or more UniFi Protect Viewport hardware units on that Protect system, for the base driver.
• About 10 minutes for both drivers, or 5 for the base driver alone.

Step 1: Add the UniFi Protect Viewport driver

1. In the UniFi Protect application, generate an integration API key for this driver.
2. In Crestron Home Setup, add the UniFi Protect Viewport driver as a Video Server device and enter the API key.
3. On first connect, the driver discovers every camera and multi-camera view (grid) on the NVR and assigns each one a numbered Preset row, in discovery order, up to 48 items.

Step 2: Assign presets

The installer settings page lists one numbered Preset row per camera or view, captioned with its name. The number typed into a row is the preset that camera or view answers to on the remote, keypad, and Additional Functions list — the same number everywhere.

• Renumber the client’s favorite cameras and views into Preset 1–10 so they’re reachable from a hard remote (keys 1–9) and the keypad’s 0 key (Preset 10).
• Set a row to 0 to hide that item from the keypad, remote, Additional Functions, and the grid-ring rotation.
• Items left above Preset 10 are still reachable from the touch panel’s Additional Functions list, or from the Camera Grid companion (Step 3).

Step 3: Add Camera Grid (optional)

Camera Grid gives homeowners a named, tappable grid on the touch panel instead of relying on preset numbers.

1. Confirm the base UniFi Protect Viewport driver is already installed and paired.
2. Add the Camera Grid driver in Crestron Home Setup as an Extension device (category NVR), and enter its own Protect API key — it does not inherit the base driver’s key.
3. On first connect, Camera Grid discovers cameras and views and builds the on-panel grid automatically. Tap Edit cameras to rename, pin (favorite), or hide any camera; changes are saved and restored automatically after a reload.
4. Grid Columns (installer setting, 1–3, default 2) controls tiles per row. Show in Home / Show in Room control where the tile appears.

Licensing

Both drivers ship with a keyless trial: install and pair with no license key, and each runs at full function while the Driver Status attribute counts the trial down unattended. License keys for UniFi Viewport are issued from syndrivers.com after purchase — one purchase includes both the base driver’s key and the Camera Grid companion’s key, but each key is entered on its own driver and is locked to that driver id and the processor it was issued for.

Troubleshooting

Driver seems unresponsive (“Unreachable”). The driver backs off its polling automatically when the NVR stops responding and recovers on its own once it’s reachable again — check NVR power and network first.

License key rejected — “wrong driver” or “wrong node.” A key from the other driver (Viewport vs. Camera Grid) was entered, or the key is bound to a different processor. Re-copy the key issued for the driver showing the error, or contact support for a re-issue if the processor changed.

Camera Grid tile taps do nothing. Confirm the base UniFi Protect Viewport driver is still installed, paired, and reachable — Camera Grid hands the switch to it and has nothing to switch on its own if it’s missing.

Keypad 0 does nothing, or something unexpected happens. Key 0 always maps to Preset 10 — whichever camera or view has the value 10 in its Preset row answers to it.