ONVIF Client Implementation in Python 3
zeep[async] >= 4.1.0, < 5.0.0 httpx >= 0.19.0, < 1.0.0
From Source
You should clone this repository and run setup.py:
cd python-onvif-zeep-async && python setup.py install
Alternatively, you can run:
pip install --upgrade onvif-zeep-async
from onvif import ONVIFCamera
mycam = ONVIFCamera('192.168.0.2', 80, 'user', 'passwd', '/etc/onvif/wsdl/')
await mycam.update_xaddrs()
Now, an ONVIFCamera instance is available. By default, a devicemgmt service is also available if everything is OK.
So, all operations defined in the WSDL document:
/etc/onvif/wsdl/devicemgmt.wsdl
are available.
# Get Hostname resp = await mycam.devicemgmt.GetHostname() print 'My camera`s hostname: ' + str(resp.Name) # Get system date and time dt = await mycam.devicemgmt.GetSystemDateAndTime() tz = dt.TimeZone year = dt.UTCDateTime.Date.Year hour = dt.UTCDateTime.Time.Hour
To configure your camera, there are two ways to pass parameters to service methods.
Dict
This is the simpler way:
params = {'Name': 'NewHostName'}
await device_service.SetHostname(params)
Type Instance
This is the recommended way. Type instance will raise an exception if you set an invalid (or non-existent) parameter.
params = mycam.devicemgmt.create_type('SetHostname')
params.Hostname = 'NewHostName'
await mycam.devicemgmt.SetHostname(params)
time_params = mycam.devicemgmt.create_type('SetSystemDateAndTime')
time_params.DateTimeType = 'Manual'
time_params.DaylightSavings = True
time_params.TimeZone.TZ = 'CST-8:00:00'
time_params.UTCDateTime.Date.Year = 2014
time_params.UTCDateTime.Date.Month = 12
time_params.UTCDateTime.Date.Day = 3
time_params.UTCDateTime.Time.Hour = 9
time_params.UTCDateTime.Time.Minute = 36
time_params.UTCDateTime.Time.Second = 11
await mycam.devicemgmt.SetSystemDateAndTime(time_params)
ONVIF protocol has defined many services. You can find all the services and operations here. ONVIFCamera has support methods to create new services:
# Create ptz service ptz_service = mycam.create_ptz_service() # Get ptz configuration await mycam.ptz.GetConfiguration() # Another way # await ptz_service.GetConfiguration()
Or create an unofficial service:
xaddr = 'http://192.168.0.3:8888/onvif/yourservice'
yourservice = mycam.create_onvif_service('service.wsdl', xaddr, 'yourservice')
await yourservice.SomeOperation()
# Another way
# await mycam.yourservice.SomeOperation()