chore: add documentation RI

Code functionality left unchanged, only added docs where missing

close: N25B-298

src/robot_interface/endpoints/actuation_receiver.py

@@ -10,22 +10,32 @@ from robot_interface.core.config import settings
 
 
 class ActuationReceiver(ReceiverBase):
+    """
+    The actuation receiver endpoint, responsible for handling speech and gesture requests.
+
+    :param zmq_context: The ZeroMQ context to use.
+    :type zmq_context: zmq.Context
+
+    :param port: The port to use.
+    :type port: int
+
+    :ivar _tts_service: The text-to-speech service object from the Qi session.
+    :vartype _tts_service: ssl.SSLSession | None
+    """
     def __init__(self, zmq_context, port=settings.agent_settings.actuating_receiver_port):
-        """
-        The actuation receiver endpoint, responsible for handling speech and gesture requests.
 
-        :param zmq_context: The ZeroMQ context to use.
-        :type zmq_context: zmq.Context
-
-        :param port: The port to use.
-        :type port: int
-        """
         super(ActuationReceiver, self).__init__("actuation")
         self.create_socket(zmq_context, zmq.SUB, port)
         self.socket.setsockopt_string(zmq.SUBSCRIBE, u"")  # Causes block if given in options
         self._tts_service = None
 
     def _handle_speech(self, message):
+        """
+        Handle a speech actuation request.
+        
+        :param message: The message to handle, must contain properties "endpoint" and "data".
+        :type message: dict
+        """
         text = message.get("data")
         if not text:
             logging.warn("Received message to speak, but it lacks data.")
@@ -48,5 +58,11 @@ class ActuationReceiver(ReceiverBase):
         qi.async(self._tts_service.say, text)
 
     def handle_message(self, message):
+        """
+        Handle an actuation/speech message with the receiver.
+
+        :param message: The message to handle, must contain properties "endpoint" and "data".
+        :type message: dict
+        """
         if message["endpoint"] == "actuate/speech":
             self._handle_speech(message)