pyHik 0.2.5__tar.gz → 0.4.0__tar.gz

pyhik-0.4.0/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) John Mihalic 2016
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

pyhik-0.4.0/PKG-INFO

@@ -0,0 +1,35 @@
+Metadata-Version: 2.4
+Name: pyHik
+Version: 0.4.0
+Summary: Python API for Hikvision cameras and NVRs - event streaming, ISAPI access, and device control.
+Home-page: https://github.com/mezz64/pyhik
+Download-URL: https://github.com/mezz64/pyhik/tarball/0.4.0
+Author: John Mihalic
+Author-email: mezz64@users.noreply.github.com
+License: MIT
+Keywords: hik,hikvision,event stream,events,api wrapper,homeassistant,isapi,nvr,camera
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+License-File: LICENSE.txt
+Requires-Dist: requests>=2.20.0
+Provides-Extra: isapi
+Requires-Dist: xmltodict>=0.13.0; extra == "isapi"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: download-url
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary

pyhik-0.4.0/README.md

@@ -0,0 +1,45 @@
+[![PyPI](https://img.shields.io/pypi/v/pyHik.svg)](https://pypi.python.org/pypi/pyHik)
+
+# Introduction
+
+This is a python module aiming to expose common API events from a Hikvision IP camera or nvr.  Most rebadged models work as well with full functionality.
+
+Code is licensed under the MIT license.
+
+
+# Requirements
+
+If internal callback methods are used no external libraries are required, otherwise:
+* [pyDispatcher] 2.0.5 
+
+# Installation
+
+```pip install pyhik```
+
+# Usage
+
+```python
+import pyhik.hikvision
+
+camera = pyhik.hikvision.HikCamera('http://X.X.X.X', port=80, usr='admin', pwd='1234')
+```
+
+# Available Methods
+
+### Callbacks
+* add_update_callback(callback, msg) - used to register an update callback function.
+** msg should take the form: cam_id.event_type.channel
+
+### Properties
+* get_id - returns unique camera/nvr id
+* get_name - returns camera/nvr name
+* current_event_states - returns the event state dictionary
+
+### Functions
+* start_stream - initialzes the event stream processing thread
+* disconnect - closes the http stream session and stops the processing thread
+
+# TODO
+
+* Support motion detection status and ability to turn on/off
+* Support IR day/night status and ability to switch between day/night/auto

pyhik-0.4.0/pyHik.egg-info/PKG-INFO

@@ -0,0 +1,35 @@
+Metadata-Version: 2.4
+Name: pyHik
+Version: 0.4.0
+Summary: Python API for Hikvision cameras and NVRs - event streaming, ISAPI access, and device control.
+Home-page: https://github.com/mezz64/pyhik
+Download-URL: https://github.com/mezz64/pyhik/tarball/0.4.0
+Author: John Mihalic
+Author-email: mezz64@users.noreply.github.com
+License: MIT
+Keywords: hik,hikvision,event stream,events,api wrapper,homeassistant,isapi,nvr,camera
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+License-File: LICENSE.txt
+Requires-Dist: requests>=2.20.0
+Provides-Extra: isapi
+Requires-Dist: xmltodict>=0.13.0; extra == "isapi"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: download-url
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary

pyhik-0.4.0/pyHik.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+LICENSE.txt
+README.md
+setup.cfg
+setup.py
+pyHik.egg-info/PKG-INFO
+pyHik.egg-info/SOURCES.txt
+pyHik.egg-info/dependency_links.txt
+pyHik.egg-info/requires.txt
+pyHik.egg-info/top_level.txt
+pyhik/__init__.py
+pyhik/constants.py
+pyhik/hikvision.py
+pyhik/isapi.py
+pyhik/watchdog.py
+test/test_hikvision.py
+test/test_isapi.py

pyhik-0.4.0/pyHik.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pyhik-0.4.0/pyHik.egg-info/requires.txt

@@ -0,0 +1,4 @@
+requests>=2.20.0
+
+[isapi]
+xmltodict>=0.13.0

pyhik-0.4.0/pyHik.egg-info/top_level.txt

@@ -0,0 +1 @@
+pyhik

pyhik-0.4.0/pyhik/__init__.py

@@ -0,0 +1,53 @@
+"""pyhik - Python library for Hikvision camera/NVR events."""
+
+from pyhik.hikvision import (
+    HikCamera,
+    inject_events_into_camera,
+    get_video_channels,
+    Recording,
+    RecordingDay,
+    VideoChannel,
+)
+from pyhik.constants import __version__, VALID_NOTIFICATION_METHODS
+from pyhik.isapi import (
+    ISAPIClient,
+    ISAPIError,
+    ISAPIConnectionError,
+    ISAPIAuthError,
+    ISAPINotFoundError,
+    StorageDevice,
+    AlarmServerInfo,
+    StreamInfo,
+    CameraInfo,
+    OutputPort,
+    InputPort,
+    EventState,
+    DeviceCapabilities,
+)
+
+__all__ = [
+    # Legacy event-based API
+    'HikCamera',
+    'inject_events_into_camera',
+    'get_video_channels',
+    'Recording',
+    'RecordingDay',
+    'VideoChannel',
+    'VALID_NOTIFICATION_METHODS',
+    '__version__',
+    # ISAPI client
+    'ISAPIClient',
+    'ISAPIError',
+    'ISAPIConnectionError',
+    'ISAPIAuthError',
+    'ISAPINotFoundError',
+    # Data classes
+    'StorageDevice',
+    'AlarmServerInfo',
+    'StreamInfo',
+    'CameraInfo',
+    'OutputPort',
+    'InputPort',
+    'EventState',
+    'DeviceCapabilities',
+]

{pyHik-0.2.5 → pyhik-0.4.0}/pyhik/constants.py

@@ -2,20 +2,23 @@
 pyhik.constants
 ~~~~~~~~~~~~~~~~~~~~
 Constants list
-Copyright (c) 2016-2019 John Mihalic <https://github.com/mezz64>
+Copyright (c) 2016-2021 John Mihalic <https://github.com/mezz64>
 Licensed under the MIT license.
 """
 
 MAJOR_VERSION = 0
-MINOR_VERSION = 2
-SUB_MINOR_VERSION = 5
+MINOR_VERSION = 4
+SUB_MINOR_VERSION = 0
 __version__ = '{}.{}.{}'.format(
     MAJOR_VERSION, MINOR_VERSION, SUB_MINOR_VERSION)
 
-CONNECT_TIMEOUT = 5
+CONNECT_TIMEOUT = 10
 READ_TIMEOUT = 60
+SNAPSHOT_TIMEOUT = 10
+RECORDING_SEARCH_TIMEOUT = 30
 
 DEFAULT_PORT = 80
+DEFAULT_RTSP_PORT = 554
 XML_ENCODING = 'UTF-8'
 XML_NAMESPACE = 'http://www.hikvision.com/ver20/XMLSchema'
 
@@ -31,6 +34,7 @@ SENSOR_MAP = {
     'videoloss': 'Video Loss',
     'tamperdetection': 'Tamper Detection',
     'shelteralarm': 'Tamper Detection',
+    'defocus': 'Tamper Detection',
     'diskfull': 'Disk Full',
     'diskerror': 'Disk Error',
     'nicbroken': 'Net Interface Broken',
@@ -46,8 +50,27 @@ SENSOR_MAP = {
     'attendedbaggage': 'Attended Baggage',
     'recordingfailure': 'Recording Failure',
     'regionexiting': "Exiting Region",
-    'regionentrance': "Entering Region"
+    'regionentrance': "Entering Region",
+    'duration': "Ongoing Events",
+    'thermometry': "Thermometry"
 }
 
+# The name 'id' should always be last
+CHANNEL_NAMES = ['dynVideoInputChannelID', 'videoInputChannelID',
+                 'dynInputIOPortID', 'inputIOPortID',
+                 'id']
+
+ID_TYPES = ['channelID', 'dynChannelID', 'inputIOPortID',
+            'dynInputIOPortID']
+
 CAM_DEVICE = 'CAM'
 NVR_DEVICE = 'NVR'
+
+CONTEXT_INFO = 'INFO'
+CONTEXT_TRIG = 'TRIGGERS'
+CONTEXT_ALERT = 'ALERTS'
+CONTEXT_MOTION = 'MOTION'
+
+# Notification methods that indicate the event is active/configured
+# Expanded from original list of just 'center' and 'HTTP' to support NVRs
+VALID_NOTIFICATION_METHODS = {'center', 'HTTP', 'record', 'email', 'beep'}