Merge pull request #37 from barretobrock/develop

Refactor package to be imported as a single package

Author: Benehiko

.gitignore

@@ -1,3 +1,4 @@
+secrets.cfg
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

Camera.py

@@ -2,9 +2,9 @@
 
 <p align="center">
  <img alt="Reolink Approval" src="https://img.shields.io/badge/reolink-approved-blue?style=flat-square">
- <img alt="GitHub" src="https://img.shields.io/github/license/ReolinkCameraApi/reolink-python-api?style=flat-square">
- <img alt="GitHub tag (latest SemVer)" src="https://img.shields.io/github/v/tag/ReolinkCameraApi/reolink-python-api?style=flat-square">
- <img alt="PyPI" src="https://img.shields.io/pypi/v/reolink-api?style=flat-square">
+ <img alt="GitHub" src="https://img.shields.io/github/license/ReolinkCameraAPI/reolinkapipy?style=flat-square">
+ <img alt="GitHub tag (latest SemVer)" src="https://img.shields.io/github/v/tag/ReolinkCameraAPI/reolinkapipy?style=flat-square">
+ <img alt="PyPI" src="https://img.shields.io/pypi/v/reolinkapi?style=flat-square">
  <img alt="Discord" src="https://img.shields.io/discord/773257004911034389?style=flat-square">
 </p>
 

ConfigHandler.py

@@ -0,0 +1,11 @@
+import reolinkapi
+
+if __name__ == "__main__":
+    cam = reolinkapi.Camera("192.168.0.102", defer_login=True)
+
+    # must first login since I defer have deferred the login process
+    cam.login()
+
+    dst = cam.get_dst()
+    ok = cam.add_user("foo", "bar", "admin")
+    alarm = cam.get_alarm_motion()

README.md

@@ -0,0 +1,44 @@
+"""Downloads all motion events from camera from the past hour."""
+import os
+from configparser import RawConfigParser
+from datetime import datetime as dt, timedelta
+from reolinkapi import Camera
+
+
+def read_config(props_path: str) -> dict:
+    """Reads in a properties file into variables.
+
+    NB! this config file is kept out of commits with .gitignore. The structure of this file is such:
+    # secrets.cfg
+        [camera]
+        ip={ip_address}
+        username={username}
+        password={password}
+    """
+    config = RawConfigParser()
+    assert os.path.exists(props_path), f"Path does not exist: {props_path}"
+    config.read(props_path)
+    return config
+
+
+# Read in your ip, username, & password
+#   (NB! you'll likely have to create this file. See tests/test_camera.py for details on structure)
+config = read_config('../secrets.cfg')
+
+ip = config.get('camera', 'ip')
+un = config.get('camera', 'username')
+pw = config.get('camera', 'password')
+
+# Connect to camera
+cam = Camera(ip, un, pw)
+
+start = (dt.now() - timedelta(hours=1))
+end = dt.now()
+# Collect motion events between these timestamps for substream
+processed_motions = cam.get_motion_files(start=start, end=end, streamtype='sub')
+
+dl_dir = os.path.join(os.path.expanduser('~'), 'Downloads')
+for i, motion in enumerate(processed_motions):
+    fname = motion['filename']
+    # Download the mp4
+    resp = cam.get_file(fname, output_path=os.path.join(dl_dir, f'motion_event_{i}.mp4'))

api/__init__.py

@@ -1,6 +1,5 @@
 import cv2
-
-from Camera import Camera
+from reolinkapi import Camera
 
 
 def non_blocking():

api/recording.py

@@ -0,0 +1,4 @@
+from reolinkapi.handlers.api_handler import APIHandler
+from .camera import Camera
+
+__version__ = "0.1.2"

examples/basic_usage.py

@@ -0,0 +1,38 @@
+from reolinkapi.handlers.api_handler import APIHandler
+
+
+class Camera(APIHandler):
+
+    def __init__(self, ip: str,
+                 username: str = "admin",
+                 password: str = "",
+                 https: bool = False,
+                 defer_login: bool = False,
+                 **kwargs):
+        """
+        Initialise the Camera object by passing the ip address.
+        The default details {"username":"admin", "password":""} will be used if nothing passed
+        For deferring the login to the camera, just pass defer_login = True.
+        For connecting to the camera behind a proxy pass a proxy argument: proxy={"http": "socks5://127.0.0.1:8000"}
+        :param ip:
+        :param username:
+        :param password:
+        :param https: connect to the camera over https
+        :param defer_login: defer the login process
+        :param proxy: Add a proxy dict for requests to consume.
+        eg: {"http":"socks5://[username]:[password]@[host]:[port], "https": ...}
+        More information on proxies in requests: https://stackoverflow.com/a/15661226/9313679
+        """
+        # For when you need to connect to a camera behind a proxy, pass
+        # a proxy argument: proxy={"http": "socks5://127.0.0.1:8000"}
+        APIHandler.__init__(self, ip, username, password, https=https, **kwargs)
+
+        # Normal call without proxy:
+        # APIHandler.__init__(self, ip, username, password)
+
+        self.ip = ip
+        self.username = username
+        self.password = password
+
+        if not defer_login:
+            super().login()