Split APIHandler into single files

2020-03-06 17:22:40 +01:00
parent 5c0622d669
commit 28c6f3f2a1
7 changed files with 299 additions and 351 deletions
--- a/api/display.py
+++ b/api/display.py
@@ -0,0 +1,47 @@
+class DisplayAPIMixin:
+    """API calls related to the current image (osd, on screen display)."""
+
+    def get_osd(self) -> object:
+        """
+        Get OSD information.
+        See examples/response/GetOsd.json for example response data.
+        :return: response json
+        """
+        body = [{"cmd": "GetOsd", "action": 1, "param": {"channel": 0}}]
+        return self._execute_command('GetOsd', body)
+
+    def get_mask(self) -> object:
+        """
+        Get the camera mask information.
+        See examples/response/GetMask.json for example response data.
+        :return: response json
+        """
+        body = [{"cmd": "GetMask", "action": 1, "param": {"channel": 0}}]
+        return self._execute_command('GetMask', body)
+
+    def set_osd(self, bg_color: bool = 0, channel: int = 0, osd_channel_enabled: bool = 0, osd_channel_name: str = "",
+                osd_channel_pos: str = "Lower Right", osd_time_enabled: bool = 0,
+                osd_time_pos: str = "Lower Right") -> bool:
+        """
+        Set OSD
+        :param bg_color: bool
+        :param channel: int channel id
+        :param osd_channel_enabled: bool
+        :param osd_channel_name: string channel name
+        :param osd_channel_pos: string channel position ["Upper Left","Top Center","Upper Right","Lower Left","Bottom Center","Lower Right"]
+        :param osd_time_enabled: bool
+        :param osd_time_pos: string time position ["Upper Left","Top Center","Upper Right","Lower Left","Bottom Center","Lower Right"]
+        :return: whether the action was successful
+        """
+        body = [{"cmd": "SetOsd", "action": 1, "param": {
+            "Osd": {"bgcolor": bg_color, "channel": channel,
+                    "osdChannel": {"enable": osd_channel_enabled, "name": osd_channel_name,
+                                   "pos": osd_channel_pos},
+                    "osdTime": {"enable": osd_time_enabled, "pos": osd_time_pos}
+                    }
+        }}]
+        r_data = self._execute_command('SetOsd', body)
+        if r_data["value"]["rspCode"] == "200":
+            return True
+        print("Could not set OSD. Camera responded with status:", r_data["value"])
+        return False