Extend onvif server to support Unifi Protect #1520

acortelyou · 2024-12-24T07:54:14Z

Resolves #613.

Marking draft pending feedback.

Note: Unifi uses appears to use MAC as unique identifier, requiring bridge network to achieve multiple instances

AlexxIT · 2024-12-24T14:34:16Z

FrameRateLimit should be integer. Where you get this values?

acortelyou · 2024-12-24T15:23:32Z

I used tcpdump to compare go2rtc and a working implementation, 29.97 just happens to be the framerate from the NTSC cameras I have.

Bitrate and FPS are displayed in the Unifi Protect web GUI but unclear if exact values are critical to functionality.

The RateControl block is required but I didn't test if FPS comes from there or GetVideoSources.

I figure those values and more should be configurable, but I didn't see an obvious way to extract the information from a stream/producer object.

Unifi Protect also seems unwilling to authenticate over RTSP even when you embed the credentials in the stream uri. I couldn't find where in the onvif spec you're supposed to configure that. The creds are included in each soap request.

acortelyou · 2024-12-24T19:19:16Z

I did some additional testing.

VideoEncoderConfiguration.RateControl is required to be present but the contents are not.

VideoEncoderConfiguration.RateControl.{FrameRateLimit,BitrateLimit} are optional but they are used as the values shown in the webui, for display only.

VideoEncoderConfiguration.Resolution is what shows in the webui, for display only.

Removing VideoSourceConfiguration seems to break the snapshots for some reason.

VideoSources.FrameRate don't seem to be required, removed.

VideoEncoderConfiguration Quality, Interval, and SessionTimeout don't seem to be required, removed.

BrunoTCouto · 2024-12-29T01:52:03Z

Looking foward this implementation 👀

Thanks @acortelyou

AlexxIT · 2024-12-30T17:33:39Z

Thanks!

acortelyou · 2024-12-30T20:12:30Z

Thanks to you @AlexxIT !

Note, I minimized the changes for the purposes of this PR just to get things working.

Eventually when multiple onvif servers are implemented it would be great if we could configure Resolution, Quality, FrameRateLimit, BitrateLimit and SnapshotType: (none|jpeg|mp4) to allow for LQ/HQ switching and correct metadata for each video source in each onvif server.

Things could get complicated when you have multiple qualities and resolutions per stream eg:

streams:
  dahua_camera:
    - rtsp://admin:[email protected]/cam/realmonitor?channel=1&subtype=0&unicast=true&proto=Onvif
    - rtsp://admin:[email protected]/cam/realmonitor?channel=1&subtype=1

AlexxIT · 2024-12-31T04:24:31Z

Things already complicated, because go2rtc don't know resolution for every stream right now.

AlexxIT · 2025-01-03T14:02:24Z

https://github.com/AlexxIT/go2rtc/releases/tag/v1.9.8

blockiindahood · 2025-01-03T14:30:18Z

I reviewed #613 and some other issues, but I can't get clear information on how to implement go2rtc via onvif to record cameras from go2rtc in Unifi Protect, since it needs credentials to connect to an onvif server. Setting a pair of creds for the api does not do anything to UP, in Home Assistant though, it works without any, like Alex mentiones many times.

Sorry, If it's the wrong place to ask, but this issue seems to have the most accurate intention of getting go2rtc to work with Unifi.

BrunoTCouto · 2025-01-03T14:54:20Z

@blockiindahood I used admin/admin and it worked fine, only thing that I was not able to do is use multiple cameras, so I'm running one instance of go2rtc for each camera.

Maybe @acortelyou and @AlexxIT can add a guide how to use multiple cameras at once, but as far I understood it's not possible at the moment

blockiindahood · 2025-01-03T15:00:25Z

@BrunoTCouto I also read that currently multi ONVIF Servers aren't supported, and that it's on the todo board.

I understand that only one camera is possible, but how do I make it clear to unifi?
Must I only implement one camera, and not more?

Also what IP did you fill in?
These settings do not work for me: (sadly also not admin/admin, did you set that in the api section of the config?)

BrunoTCouto · 2025-01-03T15:05:27Z

@blockiindahood I used the go2rtc IP address.

Nothing really fancy on my config.

Something like this 👇

streams:
  entrada_social: "rtsp://CameraUsername:[email protected]:554/Streaming/channels/101"
  
log:
  api: trace
  onvif: trace

BrunoTCouto · 2025-01-03T15:07:20Z

One thing you should check is, I download the binary directly from the build pipeline, so maybe check if you are in the release of this code, and if it is really deployed already.

blockiindahood · 2025-01-03T15:12:24Z

Looking in the logs of go2rtc, I see that Unifi is connecting and trying the credentials, but seems that they are wrong.
Do I have to set them anywhere?

I am using go2rtc with HASS on an Raspi 4.

BrunoTCouto · 2025-01-03T15:17:14Z

Not sure, logs from where ? go2rtsp or something else?

blockiindahood · 2025-01-03T15:18:07Z

Oh, sorry, logs from go2rtc!

BrunoTCouto · 2025-01-03T15:21:38Z

Im without my personal computer to test the release from today. But saw that other changes were made to onvif. Can't help much more as my config was really simple

blockiindahood · 2025-01-03T15:24:35Z

Okay, thank you @BrunoTCouto, I'll then must look further into it.

BrunoTCouto · 2025-01-03T15:27:08Z

Maybe try with the binaries from this action. It's the ones I'm using

https://github.com/AlexxIT/go2rtc/actions/runs/12549881204/job/34991696663

AlexxIT · 2025-01-03T15:50:19Z

I managed to run UniFi Protect using https://github.com/dciancu/unifi-protect-unvr-docker-arm64
Haven't had a chance to test compatibility with the latest version of go2rtc yet.

acortelyou · 2025-01-04T07:01:48Z

Must I only implement one camera, and not more?

Unifi Protect assumes that each ONVIF server you are adopting is a single camera which can have multiple streams (ie LQ/HQ).

You must implement one go2rtc server per "camera" you wish to adopt with just one or two streams.

Unifi Protect also assumes each ONVIF server will have it's own IP (and maybe MAC).

You must also implement an IP per "camera" you wish to adopt.

There are many ways to do that but it is highly dependent on your scenario so I won't be able to provide a one size fits all guide.

Docker can create virtual interfaces with unique IP/MAC for each container.
see here: https://docs.docker.com/engine/network/tutorials/macvlan/

You might be able to add extra static IPs to your network interface and have each API/ONVIF server only listen on the correct IP/port but I didn't test that.
see here: https://www.computernetworkingnotes.com/linux-tutorials/how-to-configure-multiple-ip-addresses-on-linux.html

AlexxIT · 2025-01-04T10:56:58Z

@acortelyou were you able to connect at least one camera from go2rtc to UniFi?
It looks like UniFi is using auto discovery mode. Which is not yet implemented in go2rtc.
I haven't found a way to enter onvif host/post manually into UniFi Protect.

blockiindahood · 2025-01-04T11:02:03Z

@AlexxIT there is a way to manually add a onvif cam:

acortelyou · 2025-01-05T09:59:23Z

@AlexxIT Yes, I have had five separate go2rtc docker containers using macvlan networking adopted in Unifi Protect on a UDM for several weeks now.

I manually adopted them using host:port, admin, 1234 but did not configure auth in go2rtc as Unifi Protect does seem to send auth for the RTSP stream.

streams:
  hq: 'rtsp://admin:[email protected]/cam/realmonitor?channel=2&subtype=0&unicast=true&proto=Onvif'

log:
  api: trace
  onvif: trace

michael-blue2 · 2025-01-05T12:09:28Z

@AlexxIT Yes, I have had five separate go2rtc docker containers using macvlan networking adopted in Unifi Protect on a UDM for several weeks now.

I manually adopted them using host:port, admin, 1234 but did not configure auth in go2rtc as Unifi Protect does seem to send auth for the RTSP stream.
streams:
  hq: 'rtsp://admin:[email protected]/cam/realmonitor?channel=2&subtype=0&unicast=true&proto=Onvif'

log:
  api: trace
  onvif: trace  

It might sound dump, but which port did you use? and how did you choose that one? on the host:port in the udm

AlexxIT · 2025-01-05T12:17:48Z

@blockiindahood thanks!

@acortelyou look like I have broke your PR with removing empty RateControl tag. It's important for UniFi. I'll bring it back in an update.

Successfully connected one camera from go2rtc to UniFi Protect.

acortelyou · 2025-01-05T12:46:03Z

@AlexxIT Yes, the RateControl block is required. Framerate and bitrate would be configured there but are optional.

I thought I mentioned that but the conversation is split up over multiple issues and the PR... Might be wise to lock this conversation and all ONVIF/Unifi issues except for one.

@ALL The version in this PR worked. The current officially released version doesn't work. I suspect that's why there's so many questions/frustration about how to use it.

Unifi Protect needs the port of the ONVIF server which is part of the go2rtc API server which listens on 1984 by default.

AlexxIT · 2025-01-05T14:22:23Z

Two news:

I have created issue for discussion UniFi Protect UniFi Protect discussion #1538
I "hacked" this thing :)

You can add as many cameras as you want from go2rtc to UniFi Protect without any problems:

WebUI > Settings > System > Migration > Download File
Unpack zip file, edit cameras.json, add new cameras
Important to use different (random) mac and id

Important to fill correct thirdPartyCameraInfo

"thirdPartyCameraInfo": {
   "port": "1984",
   "username": "admin",
   "password": "admin",
   "rtspUrl": "rtsp://192.168.1.123:8554/reolink2",
   "rtspUrlLQ": null,
   "snapshotUrl": "http://192.168.1.123:1984/api/frame.jpeg?src=reolink2"
 }

Pack zip with changes
WebUI > Settings > System > Migration > Import File

Extend onvif server to support Unifi Protect

3a50b36

AlexxIT self-assigned this Dec 24, 2024

Remove non-essential fields

159d942

acortelyou mentioned this pull request Dec 28, 2024

How to configure go2rtc as a ONVIF _server_? #1036

Open

acortelyou added 2 commits December 29, 2024 16:16

Remove optional fields, normalize indentation

b8303b9

Remove inaccurate comments

cf88bf9

acortelyou marked this pull request as ready for review December 30, 2024 00:23

AlexxIT self-requested a review December 30, 2024 10:05

AlexxIT approved these changes Dec 30, 2024

View reviewed changes

AlexxIT merged commit 2c3219f into AlexxIT:master Dec 30, 2024

AlexxIT added this to the v1.9.8 milestone Jan 3, 2025

AlexxIT mentioned this pull request Jan 5, 2025

UniFi Protect discussion #1538

Open

BrunoTCouto mentioned this pull request Jan 6, 2025

fix(onvif): Add RateControl to fix Unifi Protect integration #1539

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extend onvif server to support Unifi Protect #1520

Extend onvif server to support Unifi Protect #1520

acortelyou commented Dec 24, 2024

AlexxIT commented Dec 24, 2024

acortelyou commented Dec 24, 2024 •

edited

Loading

acortelyou commented Dec 24, 2024

BrunoTCouto commented Dec 29, 2024

AlexxIT commented Dec 30, 2024

acortelyou commented Dec 30, 2024

AlexxIT commented Dec 31, 2024

AlexxIT commented Jan 3, 2025

blockiindahood commented Jan 3, 2025

BrunoTCouto commented Jan 3, 2025

blockiindahood commented Jan 3, 2025

BrunoTCouto commented Jan 3, 2025 •

edited

Loading

BrunoTCouto commented Jan 3, 2025 •

edited

Loading

blockiindahood commented Jan 3, 2025 •

edited

Loading

BrunoTCouto commented Jan 3, 2025

blockiindahood commented Jan 3, 2025

BrunoTCouto commented Jan 3, 2025

blockiindahood commented Jan 3, 2025

BrunoTCouto commented Jan 3, 2025

AlexxIT commented Jan 3, 2025

acortelyou commented Jan 4, 2025

AlexxIT commented Jan 4, 2025

blockiindahood commented Jan 4, 2025

acortelyou commented Jan 5, 2025 •

edited

Loading

michael-blue2 commented Jan 5, 2025

AlexxIT commented Jan 5, 2025

acortelyou commented Jan 5, 2025 •

edited

Loading

AlexxIT commented Jan 5, 2025

Extend onvif server to support Unifi Protect #1520

Extend onvif server to support Unifi Protect #1520

Conversation

acortelyou commented Dec 24, 2024

AlexxIT commented Dec 24, 2024

acortelyou commented Dec 24, 2024 • edited Loading

acortelyou commented Dec 24, 2024

BrunoTCouto commented Dec 29, 2024

AlexxIT commented Dec 30, 2024

acortelyou commented Dec 30, 2024

AlexxIT commented Dec 31, 2024

AlexxIT commented Jan 3, 2025

blockiindahood commented Jan 3, 2025

BrunoTCouto commented Jan 3, 2025

blockiindahood commented Jan 3, 2025

BrunoTCouto commented Jan 3, 2025 • edited Loading

BrunoTCouto commented Jan 3, 2025 • edited Loading

blockiindahood commented Jan 3, 2025 • edited Loading

BrunoTCouto commented Jan 3, 2025

blockiindahood commented Jan 3, 2025

BrunoTCouto commented Jan 3, 2025

blockiindahood commented Jan 3, 2025

BrunoTCouto commented Jan 3, 2025

AlexxIT commented Jan 3, 2025

acortelyou commented Jan 4, 2025

AlexxIT commented Jan 4, 2025

blockiindahood commented Jan 4, 2025

acortelyou commented Jan 5, 2025 • edited Loading

michael-blue2 commented Jan 5, 2025

AlexxIT commented Jan 5, 2025

acortelyou commented Jan 5, 2025 • edited Loading

AlexxIT commented Jan 5, 2025

acortelyou commented Dec 24, 2024 •

edited

Loading

BrunoTCouto commented Jan 3, 2025 •

edited

Loading

BrunoTCouto commented Jan 3, 2025 •

edited

Loading

blockiindahood commented Jan 3, 2025 •

edited

Loading

acortelyou commented Jan 5, 2025 •

edited

Loading

acortelyou commented Jan 5, 2025 •

edited

Loading