Skip to main content

Python Client for ONVIF2 Camera

Project description

‘<https://pepy.tech/badge/onvif2_zeep>’_

ONVIF Client Implementation in Python base wsdl ver10/20, support hevc(h.265)

Dependencies

zeep >= 3.0.0

Install python-onvif2-zeep

python-onvif-zeep ,see https://github.com/FalkTannhaeuser/python-onvif-zeep)

From Source

You should clone this repository and run setup.py:

cd python-onvif2-zeep && python setup.py install

Alternatively, you can run:

pip install --upgrade onvif2_zeep

Getting Started

Initialize an ONVIFCamera instance

from onvif2 import ONVIFCamera
    from zeep.transports import Transport
mycam = ONVIFCamera('192.168.0.2', 80, 'user', 'passwd', wsdl_dir='/home/onvif2/wsdl')

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:

/home/onvif2/ver10/device/wsdl/devicemgmt.wsdl

download the wsdl folder,and put to the /home/onvif2

are available.

Get media2 from your camera

media2_service = self.mycam.create_media2_service()

## get the streamUri
profiles = media2_service.GetProfiles()
for profile in profiles:
    o = self.media2_service.create_type('GetStreamUri')
    o.ProfileToken = profile.token
    o.Protocol = 'RTSP'
    uri = self.media2_service.GetStreamUri(o)

    dic = {'token': profile.token,
           'rtsp': uri}
                print(dic)

## get video info , 'h265' or 'h264', 'width' 'height' 'gop' ....
configurations = media2_service.GetVideoEncoderConfigurations()

for configuration in configurations:
    if configuration['Encoding'].lower() == 'h264' or configuration['Encoding'].lower() == 'h265':
        width = configuration['Resolution']['Width']
        height = configuration['Resolution']['Height']
        dic = {'token': configuration['token'],
               'encoding': configuration['Encoding'],
               'ratio': "{}*{}".format(width, height),
               'fps': configuration['RateControl']['FrameRateLimit'],
               'bitrate': configuration['RateControl']['BitrateLimit'],
               'gop': configuration['GovLength'],
               'profile': configuration['Profile'],
               'quality': configuration['Quality']}
    else:
        dic = {'token': configuration['Name'], 'encoding': configuration['Encoding']}

    print(dic)

Get information from your camera

# Get Hostname
resp = mycam.devicemgmt.GetHostname()
print 'My camera`s hostname: ' + str(resp.Name)

# Get system date and time
dt = 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'}
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'
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
mycam.devicemgmt.SetSystemDateAndTime(time_params)

Use events

mycam = ONVIFCamera(‘192.168.1.10’, 8899, ‘admin’, ‘admin’) #, no_cache=True) event_service = mycam.create_events_service() print(event_service.GetEventProperties())

pullpoint = mycam.create_pullpoint_service() req = pullpoint.create_type(‘PullMessages’) req.MessageLimit=100 print(pullpoint.PullMessages({“Timeout”:timedelta(seconds=2),”MessageLimit”:10}))

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
mycam.ptz.GetConfiguration()
# Another way
# 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')
yourservice.SomeOperation()
# Another way
# mycam.yourservice.SomeOperation()

ONVIF CLI

python-onvif also provides a command line interactive interface: onvif-cli. onvif-cli is installed automatically.

Single command example

$ onvif-cli devicemgmt GetHostname --user 'admin' --password '12345' --host '192.168.0.112' --port 80
True: {'FromDHCP': True, 'Name': hision}
$ onvif-cli devicemgmt SetHostname "{'Name': 'NewerHostname'}" --user 'admin' --password '12345' --host '192.168.0.112' --port 80
True: {}

Interactive mode

$ onvif-cli -u 'admin' -a '12345' --host '192.168.0.112' --port 80 --wsdl /etc/onvif/wsdl/
ONVIF >>> cmd
analytics   devicemgmt  events      imaging     media       ptz
ONVIF >>> cmd devicemgmt GetWsdlUrl
True: http://www.onvif.org/
ONVIF >>> cmd devicemgmt SetHostname {'Name': 'NewHostname'}
ONVIF >>> cmd devicemgmt GetHostname
True: {'Name': 'NewHostName'}
ONVIF >>> cmd devicemgmt SomeOperation
False: No Operation: SomeOperation

NOTE: Tab completion is supported for interactive mode.

Batch mode

$ vim batchcmds
$ cat batchcmds
cmd devicemgmt GetWsdlUrl
cmd devicemgmt SetHostname {'Name': 'NewHostname', 'FromDHCP': True}
cmd devicemgmt GetHostname
$ onvif-cli --host 192.168.0.112 -u admin -a 12345 -w /etc/onvif/wsdl/ < batchcmds
ONVIF >>> True: http://www.onvif.org/
ONVIF >>> True: {}
ONVIF >>> True: {'FromDHCP': False, 'Name': NewHostname}

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

onvif2_zeep-0.3.4.tar.gz (318.6 kB view details)

Uploaded Source

Built Distribution

onvif2_zeep-0.3.4-py3-none-any.whl (349.3 kB view details)

Uploaded Python 3

File details

Details for the file onvif2_zeep-0.3.4.tar.gz.

File metadata

  • Download URL: onvif2_zeep-0.3.4.tar.gz
  • Upload date:
  • Size: 318.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.12

File hashes

Hashes for onvif2_zeep-0.3.4.tar.gz
Algorithm Hash digest
SHA256 f82e44031e912de4647990fdc78cbe02db674c8e141bcfd4f2541190cbc76b5d
MD5 9abd87f1bf6eeb7dcde5a42fec885441
BLAKE2b-256 7798aece7bab71daf3d1b929e81eaa88880c5af59c9ef506d90987285d8b7926

See more details on using hashes here.

File details

Details for the file onvif2_zeep-0.3.4-py3-none-any.whl.

File metadata

  • Download URL: onvif2_zeep-0.3.4-py3-none-any.whl
  • Upload date:
  • Size: 349.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.12

File hashes

Hashes for onvif2_zeep-0.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f386f683e6756dbf1e8307a0207bef30153c784f3028cb80749cee83b18aaeea
MD5 f56e58a32e8c5f98eed03d31d8ef956f
BLAKE2b-256 9624d63e25452c869384dc55d60eb30268e647be9d8f74b9b99dd385bc4cfc4b

See more details on using hashes here.

Supported by

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