Skip to main content

Async Python Client for ONVIF Camera

Project description

ONVIF Client Implementation in Python 3

Dependencies

zeep[async] >= 4.1.0, < 5.0.0 httpx >= 0.19.0, < 1.0.0

Install python-onvif-zeep-async

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

Getting Started

Initialize an ONVIFCamera instance

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 information from your camera

# 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

Configure (Control) your camera

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)

Use other services

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()

References

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

onvif_zeep_async-4.0.1.tar.gz (186.1 kB view details)

Uploaded Source

Built Distribution

onvif_zeep_async-4.0.1-py3-none-any.whl (201.5 kB view details)

Uploaded Python 3

File details

Details for the file onvif_zeep_async-4.0.1.tar.gz.

File metadata

  • Download URL: onvif_zeep_async-4.0.1.tar.gz
  • Upload date:
  • Size: 186.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for onvif_zeep_async-4.0.1.tar.gz
Algorithm Hash digest
SHA256 f8255c89a575c0f0e931a1dbf8bfef7459de304ea779085f02e303aad43c90d4
MD5 77691ce575f991c6c0e5ac47c9c61660
BLAKE2b-256 9d49460046553d6bf1c8e272f84d365a1bd8bc30ea3a5cb5fb16168e1e1de364

See more details on using hashes here.

Provenance

The following attestation bundles were made for onvif_zeep_async-4.0.1.tar.gz:

Publisher: python-publish.yml on openvideolibs/python-onvif-zeep-async

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file onvif_zeep_async-4.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for onvif_zeep_async-4.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6410a7002e80cd02df04158c10b74c5c130f074825117e5cda518b94baa4ac98
MD5 d599964708ac58125b637d8aa4997879
BLAKE2b-256 85365314018d12b8e667234d9696918147b9291cbecc6bf42c6848e1dcffa859

See more details on using hashes here.

Provenance

The following attestation bundles were made for onvif_zeep_async-4.0.1-py3-none-any.whl:

Publisher: python-publish.yml on openvideolibs/python-onvif-zeep-async

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page