Check if an ONVIF-capable IP PTZ camera supports RelativeMove with FOV

fovtest.py

# This script can help you determine if your PTZ is capable of
# working with Frigate NVR's autotracker.
#
# Cameras with a "YES" printed for each parameter at the end of
# the output will likely be supported by Frigate.
#
# Make sure you're using python3 with the onvif-zeep package
# Update the values for your camera below, then run:
# pip3 install onvif-zeep
# python3 ./fovtest.py

from onvif import ONVIFCamera

# UPDATE the IP address, ONVIF port, "admin" and "password" with your camera's details.
mycam = ONVIFCamera('192.168.1.100', 80, 'admin', 'password', '/etc/onvif/wsdl/')

print('Connected to ONVIF camera')
# Create media service object
media = mycam.create_media_service()
print('Created media service object')
print
# Get target profile
media_profiles = media.GetProfiles()

print('Media profiles')
print(media_profiles)

for key, onvif_profile in enumerate(media_profiles):
    if (
        not onvif_profile.VideoEncoderConfiguration
        or onvif_profile.VideoEncoderConfiguration.Encoding != "H264"
    ):
        continue

    # Configure PTZ options
    if onvif_profile.PTZConfiguration:
        if onvif_profile.PTZConfiguration.DefaultContinuousPanTiltVelocitySpace is not None:
            media_profile = onvif_profile 

token = media_profile.token
print('Chosen token')
print(token)

print
# Create ptz service object
print('Creating PTZ object')
ptz = mycam.create_ptz_service()
print('Created PTZ service object')
print

# Get PTZ configuration options for getting option ranges
request = ptz.create_type("GetConfigurations")
configs = ptz.GetConfigurations(request)[0]
print('PTZ configurations:')
print(configs)
print()
request = ptz.create_type('GetConfigurationOptions')
request.ConfigurationToken = media_profile.PTZConfiguration.token
ptz_configuration_options = ptz.GetConfigurationOptions(request)
print('PTZ configuration options:')
print(ptz_configuration_options)
print()
print('PTZ service capabilities:')
request = ptz.create_type('GetServiceCapabilities')
service_capabilities = ptz.GetServiceCapabilities(request)
print(service_capabilities)
print()
print('PTZ status:')
request = ptz.create_type("GetStatus")
request.ProfileToken = token
status = ptz.GetStatus(request)
print(status)

pantilt_space_id = next(
    (
        i
        for i, space in enumerate(
            ptz_configuration_options.Spaces.RelativePanTiltTranslationSpace
        )
        if "TranslationSpaceFov" in space["URI"]
    ),
    None,
)

zoom_space_id = next(
    (
        i
        for i, space in enumerate(
            ptz_configuration_options.Spaces.RelativeZoomTranslationSpace
        )
        if "TranslationGenericSpace" in space["URI"]
    ),
    None,
)

def find_by_key(dictionary, target_key):
    if target_key in dictionary:
        return dictionary[target_key]
    else:
        for value in dictionary.values():
            if isinstance(value, dict):
                result = find_by_key(value, target_key)
                if result is not None:
                    return result
    return None        
        
if find_by_key(vars(service_capabilities), "MoveStatus"):
    print("YES - GetServiceCapabilities shows that the camera supports MoveStatus.")
else:
    print("NO - GetServiceCapabilities shows that the camera does not support MoveStatus.")

# there doesn't seem to be an onvif standard with this optional parameter
# some cameras can report MoveStatus with or without PanTilt or Zoom attributes
pan_tilt_status = getattr(status.MoveStatus, "PanTilt", None)
zoom_status = getattr(status.MoveStatus, "Zoom", None)

if pan_tilt_status is not None and pan_tilt_status == "IDLE" and (
    zoom_status is None or zoom_status == "IDLE"
):
    print("YES - MoveStatus is reporting IDLE.")

# if it's not an attribute, see if MoveStatus even exists in the status result
if pan_tilt_status is None:
    pan_tilt_status = getattr(status.MoveStatus, "MoveStatus", None)

    # we're unsupported
    if pan_tilt_status is None or (isinstance(pan_tilt_status, str) and pan_tilt_status not in [
        "IDLE",
        "MOVING",
    ]):
        print("NO - MoveStatus not reporting IDLE or MOVING.")

if pantilt_space_id is not None and configs.DefaultRelativePanTiltTranslationSpace is not None:
    print("YES - RelativeMove Pan/Tilt (FOV) is supported.")
else:
    print("NO - RelativeMove Pan/Tilt is unsupported.")
    
if zoom_space_id is not None:
    print("YES - RelativeMove Zoom is supported.")
else:
    print("NO - RelativeMove Zoom is unsupported.")

When I run the script I get the following response, does that mean my camera wouldn't work, or does it mean code not working prpoperly? I didn't get any yes or no;s.

Traceback (most recent call last):
  File "/home/manny/Downloads/./fovtest.py", line 15, in <module>
    mycam = ONVIFCamera('http://10.69.69.10', 80, 'myuser', 'mypw', '/etc/onvif/wsdl/')
  File "/usr/local/lib/python3.10/dist-packages/onvif/client.py", line 216, in __init__
    self.update_xaddrs()
  File "/usr/local/lib/python3.10/dist-packages/onvif/client.py", line 223, in update_xaddrs
    self.devicemgmt  = self.create_devicemgmt_service()
  File "/usr/local/lib/python3.10/dist-packages/onvif/client.py", line 333, in create_devicemgmt_service
    return self.create_onvif_service('devicemgmt', from_template)
  File "/usr/local/lib/python3.10/dist-packages/onvif/client.py", line 312, in create_onvif_service
    xaddr, wsdl_file, binding_name = self.get_definition(name, portType)
  File "/usr/local/lib/python3.10/dist-packages/onvif/client.py", line 292, in get_definition
    raise ONVIFError('No such file: %s' % wsdlpath)
onvif.exceptions.ONVIFError: Unknown error: No such file: /etc/onvif/wsdl/devicemgmt.wsdl```

When running this on Windows, I worked around this by editing this in the fovtest.py:
mycam = ONVIFCamera('http://10.69.69.10', 80, 'myuser', 'mypw', '/etc/onvif/wsdl/')
to
mycam = ONVIFCamera('http://10.69.69.10', 80, 'myuser', 'mypw', '/wsdl/')

I then copied the wsdl folder as well as the fovtest.py to the root of my C drive and just ran the fovtest.py from there.
Hopefully this can help more people report back.

Unfortunately my super el cheapo Aliexpress PTZ cam doesn't support RelativeMove PanTilt (nor was I expecting it to of course! :D), but surprisingly it did support RelativeMove Zoom :)

At least now I know that when I invest in a decent PT(Z), I can run the script and quickly find out so that I can start to experiment with this feature in Frigate as I've been dying to try this as well as the upcoming LPR. Great job Frigate team!
Was thinking of an Amcrest PTZ which 'should' be supported according to the Frigate wiki but if anyone has any pointers it would be much appreciated.

How about implementing a wsdl path detection with something like this?

import os
from onvif import ONVIFCamera
import onvif as onvif_pkg

# 1) Try the 'wsdl' folder inside the onvif package itself
pkg_dir   = os.path.dirname(onvif_pkg.__file__)
wsdl_dir1 = os.path.join(pkg_dir, 'wsdl')

# 2) Try the sibling 'wsdl' folder next to the onvif package
site_pkg  = os.path.dirname(pkg_dir)
wsdl_dir2 = os.path.join(site_pkg, 'wsdl')

# 3) Fallback to /etc/onvif/wsdl
candidates = [wsdl_dir1, wsdl_dir2, '/etc/onvif/wsdl']

for d in candidates:
    if os.path.isdir(d):
        wsdl_dir = d
        break
else:
    raise FileNotFoundError(
        "Could not find WSDL files; looked in:\n  " +
        "\n  ".join(candidates)
    )
# UPDATE the IP address, ONVIF port, "admin" and "password" with your camera's details.
mycam = ONVIFCamera('192.168.1.100', 80, 'admin', 'password', wsdl_dir)