Motion and smart detect setup

[crxporter]

@franklinvv - let's start a discussion here about endpoints! I'll be happy to share and get you running there.

[franklinvv]

Hey, thanks! Great idea! So, I've been scouring the internet to see if I can find any documentation about Protect endpoints, but I only managed to find the ones that are listed in the README as of now, which are:

• /proxy/protect/api/bootstrap (HTTP)
• /proxy/protect/api/cameras (HTTP)
• /proxy/protect/ws/updates (WebSocket, very spammy)

It appears to be possible to retrieve data about events as well?

[crxporter]

Yeah, all of the documentation is... non existent. Welcome to "cutting edge" I guess! Most everything I know is borrowed from other pieces of github or discovered by our main dev (Shaquu).

[crxporter]

I'm not sure how "new" you are to nodered. Seems like you've been around a little bit.

But here's a flow with all the stuff I've described-

[{"id":"25d193e8.931aa4","type":"function","z":"93dc4db2.de8ac","name":"lastUpdateId","func":"if (\"lastUpdateId\" in msg.payload) {\n    return {\n        payload: {\n            endpoint: `/proxy/protect/ws/updates?lastUpdateId=${msg.payload.lastUpdateId}`\n        }\n    };\n}","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":500,"y":420,"wires":[["367d1b38.56ec24","1b0f15fa.bf17ea"]]},{"id":"5e958d35.6f65cc","type":"unifi-request","z":"93dc4db2.de8ac","name":"","accessControllerNodeId":"bb62493.c90b9b8","endpoint":"/proxy/protect/api/bootstrap","method":"GET","data":"{}","x":290,"y":420,"wires":[["1b0f15fa.bf17ea","69ca3313.d939ec","25d193e8.931aa4"]]},{"id":"367d1b38.56ec24","type":"unifi-web-socket","z":"93dc4db2.de8ac","name":"Protect","endpoint":"/proxy/protect/ws/updates?","accessControllerNodeId":"bb62493.c90b9b8","reconnectTimeout":30000,"x":680,"y":420,"wires":[["d9602475e9621fc9","17a5572.c9bdea9","4668a261.89730c","f0be6569.37883"],["d553721c.049278","02ad55e4c08f4a42"]]},{"id":"1b0f15fa.bf17ea","type":"debug","z":"93dc4db2.de8ac","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","targetType":"full","statusVal":"","statusType":"auto","x":520,"y":340,"wires":[]},{"id":"ed307f26.4c36e8","type":"inject","z":"93dc4db2.de8ac","name":"","props":[{"p":"payload"},{"p":"topic","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"","payload":"","payloadType":"date","x":120,"y":420,"wires":[["5e958d35.6f65cc"]]},{"id":"69ca3313.d939ec","type":"function","z":"93dc4db2.de8ac","name":"Set cam IDs","func":"if (!(\"cameras\" in msg.payload)) {\n    return;\n}\nmsg.payload.cameras.forEach(element => {\n    // let myWarning = {\n    //     id: element.id,\n    //     name: element.name\n    // }\n    flow.set(element.id, element.name);\n    // node.warn(myWarning);\n})\n\nmsg.payload.sensors.forEach(element => {\n    // let myWarning = {\n    //     id: element.id,\n    //     name: element.name\n    // }\n    flow.set(element.id, element.name);\n    // node.warn(myWarning);\n})\n\nreturn;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":490,"y":480,"wires":[[]]},{"id":"d9602475e9621fc9","type":"function","z":"93dc4db2.de8ac","name":"","func":"if ('payload' in msg) {\n    // node.warn(\"hi\");\n    return;\n} else {\n    node.warn(msg);\n    return;\n}\n\nreturn;\n\n// if ('action' in msg.payload) {\n//     // node.warn(\"hello\");\n//     return;\n// }\n\n// return;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":780,"y":380,"wires":[["286c813e.a49f5e"]]},{"id":"17a5572.c9bdea9","type":"function","z":"93dc4db2.de8ac","name":"Motion detection","func":"if (!(\"payload\" in msg)) {\n    return;\n}\n\nif (!(\"payload\" in msg.payload)) {\n    return;\n}\n\n// if (msg.payload.action.id != \"60b6ab840105c10387000471\") {\n//     return;\n// }\n\n// if (msg.payload.action.action == \"add\") {\n//     return msg;\n// }\n\nif (\"isMotionDetected\" in msg.payload.payload) {\n    let newMsg = {};\n    newMsg.topic = flow.get(msg.payload.action.id);\n    newMsg.payload = {\n        \"MotionDetected\": msg.payload.payload.isMotionDetected\n    }\n    return newMsg;\n}\n\nreturn;\n\n","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":550,"y":620,"wires":[["758e41f1.890cc8"]]},{"id":"4668a261.89730c","type":"function","z":"93dc4db2.de8ac","name":"Smart detect from bell","func":"if (!(\"payload\" in msg)) {\n    return;\n}\n\nif (msg.payload.action.action != \"add\") {\n    return;\n}\n\nif (msg.payload.payload.type != \"smartDetectZone\") {\n    return;\n}\n\nif (msg.payload.payload.camera == \"60b6ab840105c10387000471\") {\n    msg.topic = flow.get(msg.payload.payload.camera);\n    flow.set(msg.payload.payload.id,\"started\");\n    return msg;\n}\n\nreturn;\n\n// 60f33ce90261690387004ad2","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":560,"y":680,"wires":[["48fdc455.23a9cc"]]},{"id":"f0be6569.37883","type":"function","z":"93dc4db2.de8ac","name":"Event end","func":"if (!(\"payload\" in msg)) {\n    return;\n}\n\nif (msg.payload.action.action != \"update\") {\n    return;\n}\n\nif (!(\"end\" in msg.payload.payload)) {\n    return;\n}\n\nif (flow.get(msg.payload.action.id) == \"started\") {\n    // Event id matches smart detect\n    msg.eventId = msg.payload.action.id;\n    let endpoint = \"/proxy/protect/api/thumbnails/e-\" + msg.eventId;\n    msg.filename = \"/home/pi/images/\" + msg.eventId + \".jpg\";\n    msg.payload = {\n        \"endpoint\": endpoint\n    }\n    flow.set(msg.eventId, undefined);\n    return msg;\n}\n\nreturn;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":520,"y":740,"wires":[["ff388436.70eca8","c900802a.47544"]]},{"id":"d553721c.049278","type":"debug","z":"93dc4db2.de8ac","name":"","active":false,"tosidebar":true,"console":false,"tostatus":false,"complete":"false","statusVal":"","statusType":"auto","x":830,"y":560,"wires":[]},{"id":"02ad55e4c08f4a42","type":"file","z":"93dc4db2.de8ac","name":"","filename":"/home/pi/wslog.txt","appendNewline":true,"createDir":false,"overwriteFile":"false","encoding":"none","x":890,"y":500,"wires":[[]]},{"id":"286c813e.a49f5e","type":"debug","z":"93dc4db2.de8ac","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","targetType":"full","statusVal":"","statusType":"auto","x":930,"y":380,"wires":[]},{"id":"758e41f1.890cc8","type":"debug","z":"93dc4db2.de8ac","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","targetType":"full","statusVal":"","statusType":"auto","x":750,"y":620,"wires":[]},{"id":"48fdc455.23a9cc","type":"debug","z":"93dc4db2.de8ac","name":"","active":false,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","targetType":"msg","statusVal":"","statusType":"auto","x":790,"y":680,"wires":[]},{"id":"ff388436.70eca8","type":"debug","z":"93dc4db2.de8ac","name":"","active":false,"tosidebar":true,"console":false,"tostatus":false,"complete":"false","statusVal":"","statusType":"auto","x":730,"y":740,"wires":[]},{"id":"c900802a.47544","type":"delay","z":"93dc4db2.de8ac","name":"","pauseType":"delay","timeout":"1","timeoutUnits":"seconds","rate":"1","nbRateUnits":"1","rateUnits":"second","randomFirst":"1","randomLast":"5","randomUnits":"seconds","drop":false,"x":320,"y":800,"wires":[["d1e5b088.4bdb68"]]},{"id":"d1e5b088.4bdb68","type":"unifi-request","z":"93dc4db2.de8ac","name":"","accessControllerNodeId":"bb62493.c90b9b8","endpoint":"","method":"GET","data":"{}","responseType":"arraybuffer","x":470,"y":800,"wires":[["c34cf89f.508758","cdf0de1f.d2dba8"]]},{"id":"c34cf89f.508758","type":"image","z":"93dc4db2.de8ac","name":"","width":"360","data":"payload","dataType":"msg","thumbnail":false,"active":true,"pass":false,"outputs":0,"x":680,"y":800,"wires":[]},{"id":"cdf0de1f.d2dba8","type":"function","z":"93dc4db2.de8ac","name":"","func":"msg.filename = \"/home/pi/images/\" + msg.inputMsg.eventId + \".jpg\";\n\nreturn msg;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":340,"y":880,"wires":[["709de1b5.8b9b58"]]},{"id":"709de1b5.8b9b58","type":"file","z":"93dc4db2.de8ac","name":"","filename":"","appendNewline":false,"createDir":false,"overwriteFile":"true","encoding":"none","x":470,"y":880,"wires":[[]]},{"id":"bb62493.c90b9b8","type":"unifi-access-controller","name":"Bloken","controllerIp":"10.0.0.1"}]

[crxporter]

Oh - obviously this endpoint /proxy/protect/ws/updates?... also has doorbell notifications. I don't have that running right now though, it'll be coming soon to my setup. I know 100% it's there cause I've checked.

[crxporter]

Alright you're connected to this websocket /proxy/protect/ws/updates?lastUpdateId=${msg.payload.lastUpdateId}

That's the starting point. I have found a few very useful things coming from that websocket.

If you get a message that passes this JS test:

if (msg.payload.action.action == "add" && msg.payload.payload.type == "smartDetectZone")

Then you are working with a smart detection!

The important bit of the smart detection is in the same payload, located at msg.payload.payload.id

That little guy is the unique string for the smart detect event. You will use it again later!

Some time later you will get a new message which will pass the following test. This is the "end" of your smart detect event. The msg.payload.action.id will match the previous ID.

if (msg.payload.action.action == "update" && "end" in msg.payload.payload)

From there you can find the thumbnail using a unifi http request pointed at this "/proxy/protect/api/thumbnails/e-" + msg.payload.action.id

I'm using the image preview node red contrib to view these thumbnails. Also saving them to my pi locally just for dev purposes. Eventually I might build something else from this.

[crxporter]

And what if you want to watch motion alerts instead of smart detection?! We can do that, too!

Watching that same endpoint /proxy/protect/ws/updates?lastUpdateId=${msg.payload.lastUpdateId} I have this JS in a function node to filter motion events. But before you can do that, you'll need to figure out what each of your camera IDs are.

Run the output of /proxy/protect/api/bootstrap through this function:

if (!("cameras" in msg.payload)) {
    return;
}
msg.payload.cameras.forEach(element => {
    // let myWarning = {
    //     id: element.id,
    //     name: element.name
    // }
    flow.set(element.id, element.name);
    // node.warn(myWarning);
})

msg.payload.sensors.forEach(element => {
    // let myWarning = {
    //     id: element.id,
    //     name: element.name
    // }
    flow.set(element.id, element.name);
    // node.warn(myWarning);
})

return;

That will set flow variables which have the "friendly name" for each of your cameras! It's very helpful for the next part.

Now we run the output of updates websocket through this JS function:

if (!("payload" in msg)) {
    return;
}

if (!("payload" in msg.payload)) {
    return;
}

// if (msg.payload.action.id != "60b6ab840105c10387000471") {
//     return;
// }

// if (msg.payload.action.action == "add") {
//     return msg;
// }

if ("isMotionDetected" in msg.payload.payload) {
    let newMsg = {};
    newMsg.topic = flow.get(msg.payload.action.id);
    newMsg.payload = {
        "MotionDetected": msg.payload.payload.isMotionDetected
    }
    return newMsg;
}

return;

That will output messages like

{
  "topic": "Family",
  "payload": {
    "MotionDetected": true
  },
  "_msgid": "fa186f0a53b2a0c8"
}

And the same format but false once motion has stopped.

[franklinvv]

Great, your setup has helped me a LOT. I am able to fetch stills from my doorbell just like you do. I am also trying to find out if I can get stills from other cameras that don't have that smart detect feature. That should be feasible, right?

[crxporter]

Yes I believe the http endpoint is the same, but you use the motion id from "motion detection event added" events.

[crxporter]

It'll look very similar to this line:

if (msg.payload.action.action == "add" && msg.payload.payload.type == "smartDetectZone")

but "smartDetectZone" will change to something about motion detection event starting.

[crxporter]

Quick follow up with an actual motion event starting message:

{
  "action": {
    "action": "add",
    "newUpdateId": "8edcaaeb-3e82-4a1d-a497-1f1cde90246d",
    "modelKey": "event",
    "id": "61453bef00e8b30387024f62"
  },
  "payload": {
    "type": "motion",
    "start": 1631927275936,
    "score": 0,
    "smartDetectTypes": [],
    "smartDetectEvents": [],
    "metadata": {},
    "camera": "cameraID",
    "partition": null,
    "user": null,
    "id": "61453bef00e8b30387024f62",
    "modelKey": "event"
  }
}

The event ID is 61453bef00e8b30387024f62 and the thing that tells you it's a new motion event is a combo of the "action: add" and "type: motion"