updates
This commit is contained in:
darthsandmann
189
deps/lib/python3.10/site-packages/onvif_zeep_async-1.2.0.dist-info/METADATA
vendored
Normal file
189
deps/lib/python3.10/site-packages/onvif_zeep_async-1.2.0.dist-info/METADATA
vendored
Normal file
@ -0,0 +1,189 @@
|
||||
Metadata-Version: 2.1
|
||||
Name: onvif-zeep-async
|
||||
Version: 1.2.0
|
||||
Summary: Async Python Client for ONVIF Camera
|
||||
Home-page: http://github.com/hunterjm/python-onvif-zeep-async
|
||||
Author: Cherish Chen
|
||||
Author-email: sinchb128@gmail.com
|
||||
Maintainer: sinchb
|
||||
Maintainer-email: sinchb128@gmail.com
|
||||
License: MIT
|
||||
Keywords: ONVIF,Camera,IPC
|
||||
Platform: UNKNOWN
|
||||
Requires-Python: >=3
|
||||
Requires-Dist: httpx (<1.0.0,>=0.19.0)
|
||||
Requires-Dist: zeep[async] (<5.0.0,>=4.1.0)
|
||||
|
||||
python-onvif-zeep-async
|
||||
=======================
|
||||
|
||||
ONVIF Client Implementation in Python 3
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
`zeep[async] <http://docs.python-zeep.org>`_ >= 4.1.0, < 5.0.0
|
||||
`httpx <https://www.python-httpx.org/>`_ >= 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 <http://www.onvif.org/onvif/ver20/util/operationIndex.html>`_.
|
||||
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()
|
||||
|
||||
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
|
||||
----------
|
||||
|
||||
* `ONVIF Offical Website <http://www.onvif.com>`_
|
||||
|
||||
* `Operations Index <http://www.onvif.org/onvif/ver20/util/operationIndex.html>`_
|
||||
|
||||
* `ONVIF Develop Documents <http://www.onvif.org/specs/DocMap-2.4.2.html>`_
|
||||
|
||||
* `Foscam Python Lib <http://github.com/quatanium/foscam-python-lib>`_
|
||||
|
||||
|
||||
Reference in New Issue
Block a user