feat: Include People engagement models support

Add cam position and head pose to media config
Add camera client and models
Add display client and update documentation
Add media client and models
Add undistort parameters to camera model
Add uri entry to the camera model

Author: edisonf

docs/source/rrmsutils.models.camera.rst

@@ -0,0 +1,21 @@
+rrmsutils.models.camera package
+===============================
+
+Submodules
+----------
+
+rrmsutils.models.camera.cameraconfiguration module
+--------------------------------------------------
+
+.. automodule:: rrmsutils.models.camera.cameraconfiguration
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: rrmsutils.models.camera
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/rrmsutils.models.display.rst

@@ -0,0 +1,29 @@
+rrmsutils.models.display package
+================================
+
+Submodules
+----------
+
+rrmsutils.models.display.displayconfiguration module
+----------------------------------------------------
+
+.. automodule:: rrmsutils.models.display.displayconfiguration
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rrmsutils.models.display.heatmap module
+---------------------------------------
+
+.. automodule:: rrmsutils.models.display.heatmap
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: rrmsutils.models.display
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/rrmsutils.models.engagementanalytics.rst

@@ -0,0 +1,29 @@
+rrmsutils.models.engagementanalytics package
+============================================
+
+Submodules
+----------
+
+rrmsutils.models.engagementanalytics.configuration module
+---------------------------------------------------------
+
+.. automodule:: rrmsutils.models.engagementanalytics.configuration
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rrmsutils.models.engagementanalytics.detection module
+-----------------------------------------------------
+
+.. automodule:: rrmsutils.models.engagementanalytics.detection
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: rrmsutils.models.engagementanalytics
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/rrmsutils.models.media.rst

@@ -0,0 +1,29 @@
+rrmsutils.models.media package
+==============================
+
+Submodules
+----------
+
+rrmsutils.models.media.brightness module
+----------------------------------------
+
+.. automodule:: rrmsutils.models.media.brightness
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rrmsutils.models.media.configuration module
+-------------------------------------------
+
+.. automodule:: rrmsutils.models.media.configuration
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: rrmsutils.models.media
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/rrmsutils.models.rst

@@ -10,7 +10,11 @@ Subpackages
    rrmsutils.models.aiagent
    rrmsutils.models.analytics
    rrmsutils.models.bips
+   rrmsutils.models.camera
    rrmsutils.models.detection
+   rrmsutils.models.display
+   rrmsutils.models.engagementanalytics
+   rrmsutils.models.media
    rrmsutils.models.ptz
 
 Submodules
@@ -24,6 +28,22 @@ rrmsutils.models.apiresponse module
    :undoc-members:
    :show-inheritance:
 
+rrmsutils.models.heatmap module
+-------------------------------
+
+.. automodule:: rrmsutils.models.heatmap
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rrmsutils.models.point module
+-----------------------------
+
+.. automodule:: rrmsutils.models.point
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Module contents
 ---------------
 

docs/source/rrmsutils.rst

@@ -8,6 +8,7 @@ Subpackages
    :maxdepth: 4
 
    rrmsutils.models
+   rrmsutils.utils
 
 Submodules
 ----------
@@ -28,6 +29,14 @@ rrmsutils.bips module
    :undoc-members:
    :show-inheritance:
 
+rrmsutils.camera module
+-----------------------
+
+.. automodule:: rrmsutils.camera
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 rrmsutils.detection module
 --------------------------
 
@@ -36,6 +45,46 @@ rrmsutils.detection module
    :undoc-members:
    :show-inheritance:
 
+rrmsutils.directionschemagenerator module
+-----------------------------------------
+
+.. automodule:: rrmsutils.directionschemagenerator
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rrmsutils.display module
+------------------------
+
+.. automodule:: rrmsutils.display
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rrmsutils.engagementanalytics module
+------------------------------------
+
+.. automodule:: rrmsutils.engagementanalytics
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rrmsutils.heatmapschemagenerator module
+---------------------------------------
+
+.. automodule:: rrmsutils.heatmapschemagenerator
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rrmsutils.media module
+----------------------
+
+.. automodule:: rrmsutils.media
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 rrmsutils.ptz module
 --------------------
 

docs/source/rrmsutils.utils.rst

@@ -0,0 +1,29 @@
+rrmsutils.utils package
+=======================
+
+Submodules
+----------
+
+rrmsutils.utils.influxdb module
+-------------------------------
+
+.. automodule:: rrmsutils.utils.influxdb
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rrmsutils.utils.redisclient module
+----------------------------------
+
+.. automodule:: rrmsutils.utils.redisclient
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: rrmsutils.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:

rrmsutils/camera.py

@@ -0,0 +1,91 @@
+#  Copyright (C) 2024 RidgeRun, LLC (http://www.ridgerun.com)
+#  All Rights Reserved.
+#
+#  The contents of this software are proprietary and confidential to RidgeRun,
+#  LLC.  No part of this program may be photocopied, reproduced or translated
+#  into another programming language without prior written consent of
+#  RidgeRun, LLC.  The user is free to modify the source code after obtaining
+#  a software license from RidgeRun.  All source code changes must be provided
+#  back to RidgeRun without any encumbrance.
+
+"""Wrapper for Camera API
+"""
+
+import requests
+
+from rrmsutils.models.camera.cameraconfiguration import CamerasConfiguration
+
+__all__ = ['Camera']
+
+
+class Camera():
+    """Wrapper for Camera API
+    """
+
+    __headers_get = {"Accept": "application/json"}
+    __headers_put = {
+        "Accept": "application/json",
+        "Content-type": "application/json"}
+
+    def __init__(self, host="127.0.0.1", port=5050) -> None:
+        """Client for Camera service
+
+        Args:
+            host (str, optional): Camera server address. Defaults to "127.0.0.1".
+            port (int, optional): Camera server port. Defaults to 5050.
+        """
+        self.__base = f'http://{host}:{port}'
+        self.__configuration = self.__base + '/configuration'
+
+    def __get(self, url: str):
+        return requests.get(url, headers=self.__headers_get, timeout=100)
+
+    def __put(self, url: str, data: str):
+        return requests.put(url, headers=self.__headers_put, data=data, timeout=100)
+
+    def get_configuration(self):
+        """Gets the cameras configuration
+
+        Returns:
+            CamerasConfiguration or None: The cameras index, resolution
+            and streaming configuration. None in case of error
+        """
+        try:
+            response = self.__get(self.__configuration)
+            if response.status_code != 200:
+                return None
+        except Exception:
+            return None
+
+        json_data = response.json()
+        configuration = None
+        try:
+            configuration = CamerasConfiguration.model_validate(json_data)
+        except Exception:
+            return None
+
+        return configuration
+
+    def set_configuration(self, configuration: CamerasConfiguration) -> bool:
+        """Sets the cameras configuration
+
+        Args:
+            configuration (CamerasConfiguration): The cameras configuration
+
+        Returns:
+            bool: True in case of success, False in case of error
+        """
+
+        try:
+            data = CamerasConfiguration.model_validate(configuration)
+        except Exception:
+            return False
+
+        try:
+            response = self.__put(self.__configuration, data.model_dump_json())
+            if response.status_code != 200:
+                return False
+        except Exception:
+            return False
+
+        return True