pepperplus/pepperplus-ri
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

style: fixed docstrings

Browse Source 
close: N25B-171
This commit is contained in:
Luijkx,S.O.H. (Storm)
2025-10-16 14:06:31 +00:00
parent 0c5b47ae16
commit 0b55d5c221
2 changed files with 3 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/robot_interface/endpoints/socket_base.py
View File

@@ -30,7 +30,7 @@ class SocketBase(object):
:param options: A list of options to be set on the socket. The list contains tuples where the first element contains the option :param options: A list of options to be set on the socket. The list contains tuples where the first element contains the option
and the second the value, for example (zmq.CONFLATE, 1). and the second the value, for example (zmq.CONFLATE, 1).
:type options: [(zmq socket option, option value)] :type options: list[tuple[int, int]]
""" """
self.socket = zmq_context.socket(socket_type) self.socket = zmq_context.socket(socket_type)

16
src/robot_interface/endpoints/video_sender.py
View File

@@ -15,15 +15,6 @@ class VideoSender(SocketBase):
def start_video_rcv(self): def start_video_rcv(self):
""" """
Prepares arguments for retrieving video images from Pepper and starts video loop on a separate thread. Prepares arguments for retrieving video images from Pepper and starts video loop on a separate thread.
:param robot_ip: The ip address of the robot to connect with.
:type robot_ip: String
:param port: The port of the robot.
:type port: int
:param socket: The ZMQ socket to send the video images over.
:type: VideoSender
""" """
app = qi.Application() app = qi.Application()
app.start() app.start()
@@ -43,14 +34,11 @@ class VideoSender(SocketBase):
""" """
The main loop of retrieving video images from the robot. The main loop of retrieving video images from the robot.
:param vid_stream: The name of a camera subscription on the video service object vid_service
:type vid_stream: String
:param vid_service: The video service object that the active Qi session is connected to. :param vid_service: The video service object that the active Qi session is connected to.
:type vid_service: Object (Qi service object) :type vid_service: Object (Qi service object)
:param socket: The ZMQ socket to send the video images over. :param vid_stream_name: The name of a camera subscription on the video service object vid_service
:type: VideoSender :type vid_stream_name: String
""" """
while not state.exit_event.is_set(): while not state.exit_event.is_set():
try: try: