Unifi Protect alarm status

[ced455]

Integration name

UniFi Protect

Link to integration documentation on our website

https://www.home-assistant.io/integrations/unifiprotect/

Describe the enhancement

Since Unifi Protect 6.1, we have been able to arm/disarm the system to receive notifications from the app.
I would like to be able to change the settings from HA and access its status.

Use cases

My Use case would be to sync my alarm with unifi protect arm/disarm.

Anything else?

No response

[github-actions[bot]]

🏷️ I've automatically added the integration: unifiprotect label to help categorize this feature request.

[dbzzzde]

+1

[zoic21]

+1

[ghost]

+1
I've been waiting for this feature from UniFi for quite a while! I've been doing this in Arlo for ages, but I've switched all of my cameras to Unifi Protect and would love to be able to arm/disarm the system (in essence, change the system's notification profiles) based on the status of my home's burglar alarm system, all via HA.

[stefanneubig]

+1

[jensenvance]

This is longer overdue. Add the ability to arm/disarm from home assistant and expose the siren also.

[charlessamford]

The Unifi Protect POE Siren definitely needs further access and control from HA. Please add this capability. Thank you !!

[rdylina]

+1

[Braaxxi]

+1

[jhulndev]

Can anyone confirm if this is a limitation of the current Protect API?

I'm not seeing any Protect API endpoints related to alarm profiles or sirens. Seems like we need Unifi to include these before any work can be done on the HA side?

[zoic21]

Hello,
Yes It's what I understand too but even if lot of people ask to add alarm profils in api (or in action at least) there is no change on unifi side...

[marcin-olek]

+1

[moritzniemann]

+1

[kaldurhan]

+1

[Stawrit]

+1

[tjkcc]

waiting for this quite a bit

[jensenvance]

Figured it out. Best method is to create shell scripts for arm and disarm, it works great for me - create an arm and disarm.sh and then go from there. Ask ChatGPT or Claude for full directions, that made it a breeze - you can even have Claude CoWork do it for you with the extension.

an example file:
#!/bin/bash
BASE_URL="YOURUNIFIPROTECTIP"
LOGIN_URL="$BASE_URL/api/auth/login"
ARM_URL="$BASE_URL/proxy/protect/api/arm/enable"
USERNAME="UNIFIUSERNAME"
PASSWORD="UNIFIPASSWORD"
ARM_PROFILE_ID="FIND IN F12 CONSOLE WHEN ARM/DISARMING IN CHROME"
COOKIE_JAR="/tmp/uiprotect_arm_cookie.txt"
HEADER_FILE="/tmp/uiprotect_arm_headers.txt"
TOKEN_FILE="/tmp/uiprotect_arm_token.txt"

Only login if cookie is missing or older than 30 minutes

if [ ! -f $COOKIE_JAR ] || [ $(find $COOKIE_JAR -mmin +30 | wc -l) -gt 0 ]; then
rm -f $COOKIE_JAR $HEADER_FILE $TOKEN_FILE
curl -k -s -D $HEADER_FILE -c $COOKIE_JAR -X POST "$LOGIN_URL"
-H "Content-Type: application/json"
-d "{"username":"$USERNAME","password":"$PASSWORD","token":"","rememberMe":true}" > /dev/null

Save CSRF token to its own file

grep -i "x-csrf-token:" $HEADER_FILE | awk '{print $2}' | tr -d '\r' > $TOKEN_FILE
fi

CSRF_TOKEN=$(cat $TOKEN_FILE)

if [ -z "$CSRF_TOKEN" ]; then
echo "No: X-Csrf-Token!"
exit 1
fi

curl -k -s -b $COOKIE_JAR
-H "X-Csrf-Token: $CSRF_TOKEN"
-H "Content-Type: application/json"
-X POST "$ARM_URL"
-d "{"armProfileId": "$ARM_PROFILE_ID"}"

[kaldurhan]

When I get a response 'No: X-Csrf-Token!' does that mean I use the wrong armProfileID? I got the armProfileID by downloading a supportfile from Unifi console, extract it to disk and then search for text input armProfileID. Is that a correct approach also?

I had this problem later on. Turned out my HA could not resolve my internal DNS for the nvr. So i had to use IP-address instead of dns name in the BASE_URL
It should't be related to the armprofileID

[janvdmeij]

OK. I found it with dev tools. But it is the same as in the supportfile. So I suppose both methods are OK.

But when I fire the script from a Linux desktop I still get the 'No: X-Csrf-Token!' error. I have a home-assistant green. When I copy the script to the home-assistant green and fire it from the console I get the same error. I already put the IP in the base_url and tried with and without the https:// in front. Do you have any other suggestions?

[janvdmeij]

OK. Great. I got the scripts to work. But is there a way to return the current 'arm' state? With that it would be possible to create a toggle switch in HA.

[kaldurhan]

Yupp, i redid the script that we use to arm and disarm and voila:
Note: i use a secrets file for my credentials. so you need to add that part to this script if you dont use a secrets file.

#!/bin/bash


# Load secrets
SECRETS_FILE="/config/scripts/secrets.env"
[ -f "$SECRETS_FILE" ] || { echo "Secrets file not found: $SECRETS_FILE"; exit 1; }
source "$SECRETS_FILE"

BASE_URL="https://IP_TO_YOUR_NVR"
LOGIN_URL="$BASE_URL/api/auth/login"
STATUS_URL="$BASE_URL/proxy/protect/api/bootstrap"


ARM_PROFILE_ID="Armed"

COOKIE_JAR="/tmp/uiprotect_arm_cookie.txt"
HEADER_FILE="/tmp/uiprotect_arm_headers.txt"
TOKEN_FILE="/tmp/uiprotect_arm_token.txt"

# Only login if cookie is missing or older than 30 minutes
if [ ! -f $COOKIE_JAR ] || [ $(find $COOKIE_JAR -mmin +30 | wc -l) -gt 0 ]; then
  rm -f $COOKIE_JAR $HEADER_FILE $TOKEN_FILE

  curl -k -s -D $HEADER_FILE -c $COOKIE_JAR -X POST "$LOGIN_URL" \
    -H "Content-Type: application/json" \
    -d "{\"username\":\"$USERNAME\",\"password\":\"$PASSWORD\",\"token\":\"\",\"rememberMe\":true}" > /dev/null

  # Save CSRF token
  grep -i "x-csrf-token:" $HEADER_FILE | awk '{print $2}' | tr -d '\r' > $TOKEN_FILE
fi

CSRF_TOKEN=$(cat $TOKEN_FILE)

if [ -z "$CSRF_TOKEN" ]; then
  echo "No CSRF Token!"
  exit 1
fi

curl -k -s -b $COOKIE_JAR \
  -H "x-csrf-token: $CSRF_TOKEN" \
  -H "Content-Type: application/json" \
  "$STATUS_URL" \
  | jq -r '.nvr.armMode.status'

i added a sensor in configuration.yaml that runs this script every 5 seconds:

command_line:
  - sensor:
      name: unifi_protect_arm_status
      command: >-
        /config/scripts/unifi_protect_status.sh
      scan_interval: 5

now you will have a sensor that gives you the state of the NVR

[janvdmeij]

Thank you! This works like a charm!