Metadata-Version: 2.0
Name: hikvisionapi
Version: 0.1.6
Summary: The client for HIKVISION cameras, DVR
Home-page: https://github.com/MissiaL/hikvision-client
Author: Petr Alekseev
Author-email: petrmissial@gmail.com
License: UNKNOWN
Download-URL: https://github.com/MissiaL/hikvision-client/tarball/0.1.6
Keywords: api,hikvision,hikvision-client
Platform: UNKNOWN
Requires-Dist: xmltodict
Requires-Dist: requests

LIbrary for Hikvision Cameras
=============================

Simple and easy to use library for working with video equipment
companies Hikvision

--------------

Install
-------

.. code:: bash

    pip install hikvisionapi


Examples
--------

.. code:: python

    from hikvision import Client

    api = Client('http://192.168.0.2', 'admin', 'admin')
    response = api.System.deviceInfo(method='get', json=True)

.. code:: json

    response = {
        "DeviceInfo": {
        "@version": "1.0", "@xmlns": "http://www.hikvision.com/ver20/XMLSchema",
        "deviceName": "HIKVISION"
    }

You can get response as text:

.. code:: python

    response = api.System.deviceInfo(method='get', json=False)

.. code:: text

    response = '<?xml version="1.0" encoding="UTF-8" ?>
    <DeviceInfo version="1.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
    <deviceName>HIKVISION</deviceName>
    </DeviceInfo>'

===========
<ID> prefix
===========

For the numbering of channels using a prefix starting with **_**

.. code:: python

    api.System.Video.inputs.channels._1.motionDetection(method='get')

url path:

.. code:: text

    'System/Video/inputs/channels/1/motionDetection'


More examples:

.. code:: python

    xml = api.System.deviceInfo(method='get', json=False)
    api.System.deviceInfo(method='put', data=xml, json=False)


