Refactor ONVIF

[hunterjm]

Proposed change

The goals of this refactor are as follows:

1. Abstract calls to the ONVIF web service into a centrally managed device class.
2. Improve efficiency of the integration by removing unnecessary duplicate API calls to the device.
3. Update config flow and entity initialization logic to add all compatible streams, but default disable lower resolution profiles. Main change is in how profile logic is handled.
4. Fix the PTZ service and add additional validation based on what PTZ options are available on the specified profile.

There is no functionality change here other than fixing the PTZ service which was confirmed not working. This will, however, lead way for the next PR which will add support for creating sensors based on event notifications.

Type of change

• Dependency upgrade
• Bugfix (non-breaking change which fixes an issue)
• New integration (thank you!)
• New feature (which adds functionality to an existing integration)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

Example entry for configuration.yaml:

# Example configuration.yaml

Additional information

• This PR fixes or closes issue: ONVIF problem "PTZ actions are not supported on camera '...' #34641 and 107.1 "PTZ actions are not supported on camera" #33007
• This PR is related to issue: N/A
• Link to documentation pull request: N/A

Checklist

• The code change is tested and works locally.
• Local tests pass. Your PR cannot be merged unless tests pass
• There is no commented out code in this PR.
• I have followed the development checklist
• The code has been formatted using Black (black --fast homeassistant tests)
• Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

• Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

• The manifest file has all fields filled out correctly.
  Updated and included derived files by running: python3 -m script.hassfest.
• New or updated dependencies have been added to requirements_all.txt.
  Updated by running python3 -m script.gen_requirements_all.
• Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

• No score or internal
• 🥈 Silver
• 🥇 Gold
• 🏆 Platinum

[balloob]

AMAZING 🎉 Few minor comments.

[MartinHjelmare]

Some comments.

[MartinHjelmare]

Are we planning to extract this to a library?

[hunterjm]

This already existed in the current camera class. The same type of logic exists in the generic camera integration as well.

I've currently abstracted most of the API calls to device.py with a few in config_flow.py for validation checks during setup. It wouldn't be too far of a stretch to create a Home Assistant specific ONVIF library that further abstracts the logic if requested, though I think that's beyond the scope of this PR.

[MartinHjelmare]

Yes, it's out of scope for this PR. I'm interested in our plan for the future and what we consider ok or not ok.

[hunterjm]

@dshokouhi identified some issues with my PTZ move_type support detection. I'm getting a PTZ camera delivered today to do some additional testing. Will address PR comments along with that update hopefully later tonight.

The service still works if called with a supported type, but the warnings for unsupported operations don't work.

[hunterjm]

Most PR comments addressed with a few follow-ups.

The PTZ support is fine. The Amcrest camera being used says it supports the RelativeMove PTZ move type, but just fails silently. It's more of a device conformance issue at that point.

[MartinHjelmare]

Looks good!

[chron0]

Still struggling to get PTZ working. I've tested the camera with https://github.com/agsh/onvif and PTZ is working with it so I can offer another probably flaky test subject from the h.view camera family. Looking forward to see it released so I can test it as well.

[hunterjm]

Please don’t comment on merged PRs. Feel free to hit up #cameras on discord though, as I am looking for some more testers. @ me there