93 lines
3.5 KiB
Python
93 lines
3.5 KiB
Python
from .recording import RecordingAPIMixin
|
|
from .zoom import ZoomAPIMixin
|
|
from .device import DeviceAPIMixin
|
|
from .display import DisplayAPIMixin
|
|
from .network import NetworkAPIMixin
|
|
from .system import SystemAPIMixin
|
|
from .user import UserAPIMixin
|
|
from resthandle import Request
|
|
|
|
|
|
class APIHandler(SystemAPIMixin,
|
|
NetworkAPIMixin,
|
|
UserAPIMixin,
|
|
DeviceAPIMixin,
|
|
DisplayAPIMixin,
|
|
RecordingAPIMixin,
|
|
ZoomAPIMixin):
|
|
"""
|
|
The APIHandler class is the backend part of the API, the actual API calls
|
|
are implemented in Mixins.
|
|
This handles communication directly with the camera.
|
|
Current camera's tested: RLC-411WS
|
|
|
|
All Code will try to follow the PEP 8 standard as described here: https://www.python.org/dev/peps/pep-0008/
|
|
"""
|
|
|
|
def __init__(self, ip: str, username: str, password: str, https=False, **kwargs):
|
|
"""
|
|
Initialise the Camera API Handler (maps api calls into python)
|
|
:param ip:
|
|
:param username:
|
|
:param password:
|
|
: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
|
|
"""
|
|
scheme = 'https' if https else 'http'
|
|
self.url = f"{scheme}://{ip}/cgi-bin/api.cgi"
|
|
self.ip = ip
|
|
self.token = None
|
|
self.username = username
|
|
self.password = password
|
|
Request.proxies = kwargs.get("proxy") # Defaults to None if key isn't found
|
|
|
|
def login(self) -> bool:
|
|
"""
|
|
Get login token
|
|
Must be called first, before any other operation can be performed
|
|
:return: bool
|
|
"""
|
|
try:
|
|
body = [{"cmd": "Login", "action": 0,
|
|
"param": {"User": {"userName": self.username, "password": self.password}}}]
|
|
param = {"cmd": "Login", "token": "null"}
|
|
response = Request.post(self.url, data=body, params=param)
|
|
if response is not None:
|
|
data = response.json()[0]
|
|
code = data["code"]
|
|
if int(code) == 0:
|
|
self.token = data["value"]["Token"]["name"]
|
|
print("Login success")
|
|
return True
|
|
print(self.token)
|
|
return False
|
|
else:
|
|
print("Failed to login\nStatus Code:", response.status_code)
|
|
return False
|
|
except Exception as e:
|
|
print("Error Login\n", e)
|
|
raise
|
|
|
|
def _execute_command(self, command, data, multi=False):
|
|
"""
|
|
Send a POST request to the IP camera with given data.
|
|
:param command: name of the command to send
|
|
:param data: object to send to the camera (send as json)
|
|
:param multi: whether the given command name should be added to the
|
|
url parameters of the request. Defaults to False. (Some multi-step
|
|
commands seem to not have a single command name)
|
|
:return: response JSON as python object
|
|
"""
|
|
params = {"token": self.token, 'cmd': command}
|
|
if multi:
|
|
del params['cmd']
|
|
try:
|
|
if self.token is None:
|
|
raise ValueError("Login first")
|
|
response = Request.post(self.url, data=data, params=params)
|
|
return response.json()
|
|
except Exception as e:
|
|
print(f"Command {command} failed: {e}")
|
|
raise
|