Repository navigation
Releases: DirectorLink/DirectorLink-UniFi-Protect
Release list
DirectorLink · UniFi Protect 1.0.1
DirectorLink · UniFi Protect 1.0.1
Free, open-source Control4 driver for UniFi Protect cameras and doorbells. Part of DirectorLink Drivers.
DirectorLink is an independent project, not affiliated with Control4 or Snap One.
Update both files with Driver → Add or Update Driver or Agent. Keep the file names exactly as they are: a browser's (1).c4z copy installs as a separate driver. Check the downloads against SHA256SUMS.txt.
The first release that is not a beta. The drivers follow Ubiquiti's published Protect Integration API exactly and pass their tests against recorded API answers, but no installer has reported on them from a real UniFi system yet. Field reports are welcome: see Field reports in the README.
Camera
- DirectorLink camera agreement, version 1, complete. New string variable
DIRECTORLINK_CAMERA_EVENTS:Alert=1for a camera,Alert=1,Ring=2for a doorbell (the ids of Alert and Ring in driver.xml), so DirectorLink 1.10 finds the events without reading driver.xml. It comes after the existing variables (their order never changes) and follows the kind. DIRECTORLINK_CAMERA,DIRECTORLINK_CAMERA_KINDandDIRECTORLINK_CAMERA_EVENTSare written on every start, so they are right after a driver update too.- A camera whose kind is
camera(Camera Type set to Camera) never fires Ring. - Every ring gets a new
LAST_RING, later than the one before: the console's time of the press when it is within two minutes behind and five seconds ahead of the controller's clock, else the controller's time.
Hub
- No changes apart from the version number.
Known issues
- Not yet confirmed on a real system.
- Live video needs Control4 OS 3.3.2 or newer. Older controllers get pictures, alerts and rings.
- Away from home (4Sight), live video and pictures are not expected to work: their addresses are the home network's.
- RTSPS may not play in Control4 apps; RTSP is the default.
- H.265: turn off Enhanced Encoding in UniFi Protect for cameras Control4 should play.
- No audio, PTZ or two-way talk.
DirectorLink · UniFi Protect 1.0.0-beta.1
DirectorLink · UniFi Protect 1.0.0-beta.1
Beta. First release. Add one driver, paste an API key from your UniFi console, click Add New Cameras, and every UniFi Protect camera and doorbell is in Control4: pictures, live video, smart detections, alerts and doorbell rings.
Free, open-source Control4 driver for UniFi Protect cameras and doorbells. Part of DirectorLink Drivers.
This beta follows Ubiquiti's published Protect Integration API exactly and passes its tests against recorded API answers, but it has not run on a real UniFi system yet. It stays a beta until an installer's logs confirm pictures, video, alerts and rings. If you try it, please send the log (see Testing the beta in the README).
Files
| Driver in Composer | File |
|---|---|
| DirectorLink · UniFi Protect (shows in the project as UniFi Protect Hub) | DirectorLink-UniFi-Protect.c4z |
| DirectorLink · UniFi Protect Camera | DirectorLink-UniFi-Protect-Camera.c4z |
Check the downloads against SHA256SUMS.txt. Keep the file names exactly as they are: a browser's (1).c4z copy installs as a separate driver.
UniFi Protect Hub
- Official API only. Ubiquiti's Protect Integration API with an API key (Settings > Control Plane > Integrations). No username or password, no private API, no cloud. The key goes only to your console and never into a log.
- Refuses an old Protect clearly: UniFi Protect 5.3 or newer is needed.
- One click adds them all, named as in UniFi Protect. Doorbells are recognized.
- Pictures from a small server on the controller, each camera with its own random login, so Control4 apps and DirectorLink get them without the key.
- Live video: the console's RTSP (port 7447, try it first) or RTSPS (port 7441) stream, chosen by Live Video. Streams that are off are switched on.
- Events at once from the console's event stream: smart detections, motion, doorbell rings.
- One alerts tile, Camera Alert and Doorbell Ring for all cameras.
- Print Diagnostics and Debug logging for testing without hardware on our side.
UniFi Protect Camera
- Pictures and live video on every touchscreen and the app (live video needs Control4 OS 3.3.2 or newer).
- Person, vehicle, animal, package, face, license plate, line crossing, intrusion and motion: events, variables, conditionals and contacts; Sound Detected for smoke alarms, glass break and other sounds.
- Alerts with Alert On, snooze and Hold Time; doorbell rings always ring.
- The DirectorLink camera agreement: DirectorLink's next version shows these cameras, their alerts and rings.
Installing
- Upload both files with Driver → Add or Update Driver or Agent.
- Search DirectorLink, add DirectorLink · UniFi Protect, enter the console's address and the API key, and run Add New Cameras.
Requirements: Control4 OS 3.3.0 or newer (3.3.2 for live video), Composer Pro, UniFi Protect 5.3 or newer. Full steps: directorlink.io/drivers/unifi-protect.
Known issues
- Not yet confirmed on a real system (the reason for the beta).
- Live video needs Control4 OS 3.3.2 or newer. Older controllers get pictures, alerts and rings.
- Away from home (4Sight), live video and pictures are not expected to work: their addresses are the home network's.
- RTSPS may not play in Control4 apps; RTSP is the default.
- H.265: turn off Enhanced Encoding in UniFi Protect for cameras Control4 should play.
- Models: the documented API does not report a camera's model; diagnostics show what the console sends.
- No audio, PTZ or two-way talk.