update documentation

This commit is contained in:
Konstantin Lampalzer 2022-10-13 00:31:43 +02:00
parent e1a17808f7
commit af3aaf7998
7 changed files with 88 additions and 16 deletions

View file

@ -6,14 +6,14 @@ from compLib.CompLibClient import CompLibClient
class IRSensor(object):
"""Access the different IR Sensors of the robot
"""Ermöglicht den Zugriff auf die einzelnen IRSensoren des Roboters
"""
@staticmethod
def read_all():
"""Read all IR sensors at once.
"""Auslesen aller Sensoren gleichzeitig
:return: Array of all current ir sensors
:return: Array aller Sensorwerte
"""
request = CompLib_pb2.IRSensorsReadAllRequest()
request.header.message_type = request.DESCRIPTOR.full_name
@ -26,7 +26,7 @@ class IRSensor(object):
@staticmethod
def enable():
"""Turn on all IR emitters
"""Aktivieren Infrarot-Sender. Muss bei jedem Programmstart ausgeführt werden.
"""
request = CompLib_pb2.IRSensorsEnableRequest()
request.header.message_type = request.DESCRIPTOR.full_name
@ -36,7 +36,7 @@ class IRSensor(object):
@staticmethod
def disable():
"""Turn off all IR emitters
"""Deaktivieren der Infrarot-Sender
"""
request = CompLib_pb2.IRSensorsDisableRequest()
request.header.message_type = request.DESCRIPTOR.full_name