Adds support for Ubiquiti UniFi Protect devices in Homey.
  • JavaScript 92.6%
  • HTML 6.6%
  • CSS 0.6%
  • Python 0.2%
Find a file
Stephan Eizinga 4cdd20817f
Some checks failed
Validate Homey App / Validate Homey App (push) Has been cancelled
feat(alarm): add actions to arm and disarm NVR alarm, update constants and flow definitions
2026-07-16 21:49:30 +02:00
.github Update issue templates 2024-08-09 12:35:17 +02:00
.homeycompose feat(sensor): add support for UP-AirQuality metrics and capabilities, including air quality, battery, and smoke status 2026-07-15 15:33:24 +02:00
assets feat: implement v2 API integration for NVR alarm management and add icons for weather components 2026-05-25 17:03:42 +02:00
drivers feat(alarm): add actions to arm and disarm NVR alarm, update constants and flow definitions 2026-07-16 21:49:30 +02:00
library feat(alarm): add actions to arm and disarm NVR alarm, update constants and flow definitions 2026-07-16 21:49:30 +02:00
locales feat(camera): add RTSP URL validation and update snapshot URL handling 2026-06-04 08:31:37 +02:00
settings Enhance error handling and localization updates for UniFi Protect integration 2026-04-19 00:00:26 +02:00
specs feat(sensor): add support for UP-AirQuality metrics and capabilities, including air quality, battery, and smoke status 2026-07-15 15:33:24 +02:00
tools UP-AirQuality has no alarm contact 2026-07-15 15:57:55 +02:00
widgets feat: implement v2 API integration for NVR alarm management and add icons for weather components 2026-05-25 17:04:08 +02:00
wiki Added GitHub CoPilot training data and Alarm Manager 2026-03-08 13:47:42 +01:00
.eslintignore Add more context about Homey App SDK 2026-03-08 16:05:35 +01:00
.eslintrc.json Bugfix: Fixing Smart Detection Trigger for camera's 2024-11-11 11:55:18 +01:00
.gitignore feat(alarm): add actions to arm and disarm NVR alarm, update constants and flow definitions 2026-07-16 21:49:30 +02:00
.homeychangelog.json feat(sensor): add support for UP-AirQuality metrics and capabilities, including air quality, battery, and smoke status 2026-07-15 15:33:24 +02:00
.homeyplugins.json Preparing for publication. 2020-02-06 22:28:29 +01:00
AGENTS.md Added GitHub CoPilot training data and Alarm Manager 2026-03-08 14:18:07 +01:00
api.js feat: implement v2 API integration for NVR alarm management and add icons for weather components 2026-05-25 17:04:08 +02:00
app.js refactor(app): compress bootstrap 2026-06-09 22:35:52 +02:00
app.json feat(alarm): add actions to arm and disarm NVR alarm, update constants and flow definitions 2026-07-16 21:49:30 +02:00
CODE_OF_CONDUCT.md Rebuild from UniFi Protect app, evertyting is know with websockets and minimal setInterval en setTimeout functions. 2021-02-19 08:01:59 +01:00
CONTRIBUTING.md Rebuild from UniFi Protect app, evertyting is know with websockets and minimal setInterval en setTimeout functions. 2021-02-19 08:01:59 +01:00
env.json fix(snapshot): restore stable snapshot retrieval and reduce memory footprint 2026-06-09 23:22:44 +02:00
LICENSE Rebuild from UniFi Protect app, evertyting is know with websockets and minimal setInterval en setTimeout functions. 2021-02-19 08:01:59 +01:00
MEMORY_LEAK_ANALYSIS.md fix(memory): resolve critical memory leaks by managing timers and event listeners 2026-06-09 22:13:07 +02:00
MEMORY_LEAK_COMPLETE_REPORT.md fix(memory): resolve critical memory leaks by managing timers and event listeners 2026-06-09 22:13:07 +02:00
MEMORY_LEAK_FIX_SUMMARY.md fix(memory): resolve critical memory leaks by managing timers and event listeners 2026-06-09 22:13:07 +02:00
package-lock.json UP-AirQuality has no alarm contact 2026-07-15 15:57:55 +02:00
package.json Add first test for air sensors 2026-07-15 13:06:19 +02:00
README.md #4 Add information about creating a local account 2024-08-09 12:42:02 +02:00
README.nl.txt Updating app.json 2025-09-05 08:18:36 +02:00
README.txt Updating app.json 2025-09-05 08:18:36 +02:00
tsconfig.json Add more context about Homey App SDK 2026-03-08 16:05:35 +01:00

Ubiquiti UniFi Protect

Adds support for Ubiquiti UniFi Protect devices in Homey.

Supported devices

  • UniFi® Protect (Network Video Recorder):
    • UniFi® Cloud Key v2 Pro
    • UniFi® Dream Machine Pro (UnifiOs)
    • UniFi® Protect Network Video Recorder (UnifiOs)
  • UniFi® Video Camera G3 series:
    • UVC-G3
    • UVC-G3-AF
    • UVC-G3-DOME
    • UVC-G3-FLEX
    • UVC-G3-MICRO
    • UVC-G3-PRO
  • UniFi® Video Camera G4 series:
    • UVC-G4-PRO
    • UVC-G4-BULLET
  • UniFi® Doorbell G4 series:
    • UVC-G4-DOORBELL
    • UVC-G4-DOORBELL-PRO

Getting started

  1. Create a local access user in the UniFi Protect web interface (used only for Homey.
  2. Install this UniFi Protect app on your Homey.
  3. Go to the UniFi Protect app's settings page.
  4. You will be prompted to enter the credentials of the UniFi Video user you created in step 2 and some network information.
  5. Start the 'add device wizard' in Homey, search for your UniFi Cloud Key and/or cameras and add them to your devices.
  6. If the user credentials changed in UniFi Protect, they can be updated on the UniFi Protect app's settings page.

Usage

  • A flow can be triggered when motion detection on a camera starts or ends.
  • A flow can be triggered when a snapshot is created on a camera. This card supplies the name of the camera that created the snapshot and the snapshot image itself.
  • A flow action card can be used to create a snapshot, which is is saved to an Image tag.
  • A flow action card is available to set a camera's recording mode, being one of 'Don't record', 'Always record' or 'Record only motion'.

How to create an local account?

  • Login in your local UniFi web interface, and click on Admins & Users. Note: This must be done from your local device and not from unifi.ui.com or within the app.
  • Click on the '+' icon to add a new user.
  • Fill in the user details, and make sure to select 'Restrict to local access only' as the user type.
  • Give the user Full Management rights and click on 'Add'.

Troubleshooting / FAQ

  • Question: I am using not the latest firmware on the cloudkey and can't connect.
    • A: Please upgrade your Cloudkey to 2.0.27 and Protect version 1.17.2
  • Question: I get a lot of false motion alerts. Is there anything to do about that?
    • A: Turn off 'Enable Auto Rotate' and rotate the camera manually.
    • A: Remove the default motion zone and create a motion zone with only the zone what you want to detect motions.
    • A: Set 'Minimum seconds of motion to trigger event' on 1 second or higher
    • Do you have more tips? let me know!
  • Question: I am using a UnifiOS device, I don't see any storage information.
    • A: UnifiOS device does not release storage information through the API.

Feedback

If you find a bug or if you are missing a feature, please create an issue here. Thank you for using this app!

Attributions

Icons made by Google from Flaticon