API-Liste
Der Alvik hat eine ganze Menge an Funktionen bzw. Methoden, die man über auf den Alvik zugreifen kann, um dessen vollen Funktionsumfang auszuschöpfen.
Bevorsie auf eine dieser Funktionen zuzugreifen können, müssen Sie zunächst eine Instanz der Klasse ArduinoAlvik() initialisieren. Diese Referenz ist sowohl für MicroPython als auch für C++-Umgebungen nützlich, da die Funktionen alle so erstellt wurden, dass sie in den Entwicklungsumgebungen die gleiche Form haben, sodass Ihre Erfahrung mit beiden Optionen einfach sein sollte.
ArduinoAlvik() Ist die Klasse
begin() ist die Funktion
alvik ist die Instanz
alvik.begin() ist die Methode
alvik = ArduinoAlvik()
Anschließend können Sie die folgenden Funktionen als Methoden der von Ihnen erstellten Instanz verwenden, zum Beispiel:
alvik.begin()
is_on
alvik.is_on()
Gibt true zurück, wenn der Roboter eingeschaltet ist
Ausgaben
- boolean: Gibt true zurück, wenn der Roboter eingeschaltet ist, andernfalls false.
begin
alvik.begin()
Startet alle Alvik-Operationen
is_target_reached
alvik.is_target_reached()
Gibt True zurück, wenn der Roboter eine M- oder R-Bestätigung gesendet hat. Es antwortet auch mit einer Ack-Empfangsnachricht
Ausgaben
- boolean: Gibt True zurück, wenn der Roboter das Ziel erreicht hat, andernfalls False.
stop
alvik.stop()
Stoppt alle Alvik-Operationen
get_orientation
alvik.get_orientation()
Gibt die Ausrichtung der IMU zurück
Ausgaben
- r: Rollwert
- p: Nickwert
- y: Gierwert
get_acceleration
alvik.get_accelerations()
Gibt die 3-Achsen-Beschleunigungswerte der IMU zurück
Ausgaben
- ax: Beschleunigung auf x
- ay: Beschleunigung auf y
- az: Beschleunigung auf z
get_gyros
alvik.get_gyros()
Gibt die 3-Achsen-Winkelbeschleunigung der IMU zurück
Ausgaben
- gx: Winkelbeschleunigung auf x
- gy: Winkelbeschleunigung auf y
- gz: Winkelbeschleunigung auf z
get_imu
alvik.get_imu()
Gibt alle IMU-Messwerte zurück
Ausgaben
- ax: Beschleunigung auf x
- ay: Beschleunigung auf y
- az: Beschleunigung auf z
- gx: Winkelbeschleunigung auf x
- gy: Winkelbeschleunigung auf y
- gz: Winkelbeschleunigung auf z
Hier ein Beispiel:
get_line_sensors
alvik.get_line_sensors()
Gibt die Messwerte der Linienfolgesensoren zurück
Ausgaben
- left: Messwert des linken Sensors
- center: Messwert des mittleren Sensors
- right: Messwert des rechten Sensors
brake
alvik.brake()
Bremst den Roboter
get_ack
get_ack.get_ack()
Gibt die letzte Bestätigung zurück
Ausgaben
- last_ack: Wert der letzten Bestätigung.
get_battery_charge
alvik.get_battery_charge()
Gibt den Ladezustand der Batterie zurück
Ausgaben
- battery_soc: Ladezustand in Prozent.
get_touch_any
alvik.get_touch_any()
Gibt true zurück, wenn eine beliebige Taste gedrückt wird
Ausgaben
- touch_any: true, wenn eine beliebige Taste gedrückt wird, andernfalls false.
get_touch_ok
alvik.get_touch_ok()
Gibt true zurück, wenn die OK-Taste gedrückt wird
Ausgaben
- touch_ok: true, wenn die OK-Taste gedrückt wird, andernfalls false.
get_touch_cancel
alvik.get_touch_cancel()
Gibt true zurück, wenn die Abbruch-Taste gedrückt wird
Ausgaben
- touch_cancel: true, wenn die Abbruch-Taste gedrückt wird, andernfalls false.
get_touch_center
alvik.get_touch_center()
Gibt true zurück, wenn die mittlere Taste gedrückt wird
Ausgaben
- touch_center: true, wenn die mittlere Taste gedrückt wird, andernfalls false.
get_touch_up
alvik.get_touch_up()
Gibt true zurück, wenn die Aufwärts-Taste gedrückt wird
Ausgaben
- touch_up: true, wenn die Aufwärts-Taste gedrückt wird, andernfalls false.
get_touch_left
alvik.get_touch_left()
Gibt true zurück, wenn die Links-Taste gedrückt wird
Ausgaben
- touch_left: true, wenn die Links-Taste gedrückt wird, andernfalls false.
get_touch_down
alvik.get_touch_down
Gibt true zurück, wenn die Abwärts-Taste gedrückt wird
Ausgaben
- touch_down: true, wenn die Abwärts-Taste gedrückt wird, andernfalls false.
get_touch_right
alvik.get_touch_right()
Gibt true zurück, wenn die Rechts-Taste gedrückt wird
Ausgaben
- touch_right: true, wenn die Rechts-Taste gedrückt wird, andernfalls false.
get_color_raw
alvik.get_color_raw()
get_color_raw()
Gibt die Rohmesswerte des Farbsensors zurück
Ausgaben
- color: Rohmesswerte des Farbsensors
get_color_label
alvik.get_color_label()
Gibt die vom Sensor erkannte Farbbezeichnung zurück
Ausgaben
- color: die vom Sensor erkannte Farbbezeichnung
get_version
alvik.get_version()
Gibt die Firmware-Version des Alvik zurück
Ausgaben
- version: Gibt die Firmware-Version des Alvik zurück
print_status
alvik.print_status()
Gibt den Alvik-Status aus
Ausgaben
- status: Gibt den Alvik-Status aus
set_behaviour
alvik.set_behaviour()
Setzt das Verhalten von Alvik
Eingaben
- behaviour: Verhaltenscode
rotate
alvik.rotate()
rotate(angle: float, unit: str = 'deg', blocking: bool = True)
Dreht den Roboter um den angegebenen Winkel
Eingaben
- angle: der Winkelwert
- unit: Winkel-Einheit
- blocking: True oder False
move
alvik.move()
move(distance: float, unit: str = 'cm', blocking: bool = True)
Bewegt den Roboter um die angegebene Strecke
Eingaben
get_wheels_speed
alvik.get_wheels_speed()
get_wheels_speed(unit: str = 'rpm')
Eingaben
- unit: Einheit der Drehzahl der Räder. ?
Ausgaben
- left_wheel_speed: der Geschwindigkeitswert
- right_wheel_speed: der Geschwindigkeitswert
Gibt die Geschwindigkeit der Räder zurück
set_wheels_speed
alvik.set_wheels_speed()
set_wheels_speed(left_speed: float, right_speed: float, unit: str = 'rpm')
Setzt die Geschwindigkeit des linken/rechten Motors
Eingaben
- left_speed: der Geschwindigkeitswert
- right_speed: der Geschwindigkeitswert
- unit: Einheit der Drehzahl der Räder. ?
set_wheels_position
alvik.set_wheels_position()
set_wheels_position(left_angle: float, right_angle: float, unit: str = 'deg')
Setzt den Winkel des linken/rechten Motors
Eingaben
- left_angle: der Winkelwert
- right_angle: der Winkelwert
- unit: die Winkel-Einheit, ?
get_wheels_position
lavik.get_wheels_position()
get_wheels_position(unit: str = 'deg')
Gibt den Winkel der Räder zurück
Eingaben
- angular_unit: Einheit der Drehzahl der Räder. ?
Ausgaben
- angular_velocity: Geschwindigkeit der Räder.
drive
alvik.move()
drive(linear_velocity: float, angular_velocity: float, linear_unit: str = 'cm/s',angular_unit: str = 'deg/s')
Fährt den Roboter mit linearer und Winkelgeschwindigkeit
Eingaben
- linear_velocity: Geschwindigkeit des Roboters.
- angular_velocity: Geschwindigkeit der Räder.
- linear_unit: Einheit der linearen Geschwindigkeit. ?
- angular_unit: Einheit der Drehzahl der Räder. ?
get_drive_speed
alvik.get_drive_speed()
get_drive_speed(linear_unit: str = 'cm/s', angular_unit: str = 'deg/s')
Gibt die lineare und Winkelgeschwindigkeit des Roboters zurück
Eingaben
- linear_unit: Einheit der linearen Geschwindigkeit. ?
- angular_unit: Einheit der Drehzahl der Räder. ?
Ausgaben
- linear_velocity: Geschwindigkeit des Roboters.
- angular_velocity: Geschwindigkeit der Räder.
reset_pose
alvik.reset_pose()
reset_pose(x: float, y: float, theta: float, distance_unit: str = 'cm', angle_unit: str = 'deg')
Setzt die Roboterpose zurück
Eingaben
get_pose
alvik.get_pose()
get_pose(distance_unit: str = 'cm', angle_unit: str = 'deg')
Gibt die aktuelle Pose des Roboters zurück
Eingaben
Ausgaben
- x
- y
- theta
set_servo_positions
alvik.set_servo_positions()
set_servo_positions(a_position: int, b_position: int)
Setzt den Winkel der Servomotoren A/B
Eingaben
- a_position: Position des Servomotors A (0-180)
- b_position: Position des Servomotors B (0-180)
left_led.set_color
alvik.left_led.set_color(0, 0, 0)
wählt einen Farbcode für die linke LED
ersetze left durch right für die rechte LED
Eingaben
- (1,0,0) rot
- (0,1,0) grün
- (0,0,1) blau
set_illuminator
alvik.set_illuminator()
set_illuminator(value: bool)
Schaltet die Beleuchtungs-LED ein/aus
Eingaben
- value: True = EIN, False = AUS
color_calibration
alvik.color_calibration()
color_calibration(background: str = 'white')
Kalibriert den Farbsensor
Eingaben
- background: Zeichenkette "white" oder "black"
rgb2hsv
alvik.rgb2hsv()
rgb2hsv(r: float, g: float, b: float)
Konvertiert normalisiertes RGB in HSV
Eingaben
- r: Rotwert
- g: Grünwert
- b: Blauwert
Ausgaben
- h: Farbwert
- s: Sättigungswert
- v: Helligkeitswert
get_color
alvik.get_color()
get_color(color_format: str = 'rgb')
Gibt die normalisierten Farbmesswerte des Farbsensors zurück
Eingaben
- color_format: nur rgb oder hsv
Ausgaben
- r oder h
- g oder s
- b oder v
hsv2label
alvik.hsv2label()
hsv2label(h, s, v)
Gibt die Farbbezeichnung zurück, die der angegebenen normalisierten HSV-Farbeingabe entspricht
Eingaben
- h: Farbwert
- s: Sättigungswert
- v: Helligkeitswert
Ausgaben
- color label: wie "BLACK" oder "GREEN", falls möglich, andernfalls "UNDEFINED" zurückgeben
get_distance
alvik.get_distance()
get_distance(unit: str = 'cm')
Gibt die Entfernungsmesswerte des TOF-Sensors zurück
Eingaben
- unit: Einheit der Entfernungsausgabe
Ausgaben
- left_tof: Objektentfernung 45° links
- center_left_tof: Objektentfernung 22° links
- center_tof: Objektentfernung in der Mitte
- center_right_tof: Objektentfernung 22° rechts
- right_tof: Objektentfernung 45° rechts
get_distance_top
alvik.get_distance_top()
get_distance_top(unit: str = 'cm')
Gibt die Entfernungsmesswerte des oberen Hindernisses zurück
Eingaben
- unit: Einheit der Entfernungsausgabe
Ausgaben
- top_tof: Objektentfernung 45° oben
get_distance_bottom
alvik.get_distance_bottom()
get_distance_bottom(unit: str = 'cm')
Gibt die Entfernungsmesswerte des unteren Hindernisses zurück
Eingaben
- unit: Einheit der Entfernungsausgabe
Ausgaben
- bottom_tof: Objektentfernung 45° unten
on_touch_ok_pressed
alvik.on_touch_ok_pressed()
on_touch_ok_pressed(callback: callable, args: tuple = ())
Registriert einen Rückruf, wenn die Berührungstaste OK gedrückt wird
Eingaben
- callback: der Name der aufzurufenden Funktion
- args: optionale Argumente der Funktion
on_touch_cancel_pressed
alvik.on_touch_cancel_pressed()
on_touch_cancel_pressed(callback: callable, args: tuple = ())
Registriert einen Rückruf, wenn die Berührungstaste ABBRECHEN gedrückt wird
Eingaben
- callback: der Name der aufzurufenden Funktion
- args: optionale Argumente der Funktion
on_touch_center_pressed
alvik.on_touch_center_pressed()
on_touch_center_pressed(callback: callable, args: tuple = ())
Registriert einen Rückruf, wenn die Berührungstaste MITTE gedrückt wird
Eingaben
- callback: der Name der aufzurufenden Funktion
- args: optionale Argumente der Funktion
on_touch_up_pressed
alvik.on_touch_up_pressed()
on_touch_up_pressed(callback: callable, args: tuple = ())
Registriert einen Rückruf, wenn die Berührungstaste AUFWÄRTS gedrückt wird
Eingaben
- callback: der Name der aufzurufenden Funktion
- args: optionale Argumente der Funktion
on_touch_left_pressed
alvik.on_touch_left_pressed()
on_touch_left_pressed(callback: callable, args: tuple = ())
Registriert einen Rückruf, wenn die Berührungstaste LINKS gedrückt wird
Eingaben
- callback: der Name der aufzurufenden Funktion
- args: optionale Argumente der Funktion
on_touch_down_pressed
alvik.on_touch_down_pressed()
on_touch_down_pressed(callback: callable, args: tuple = ())
Registriert einen Rückruf, wenn die Berührungstaste ABWÄRTS gedrückt wird
Eingaben
- callback: der Name der aufzurufenden Funktion
- args: optionale Argumente der Funktion
on_touch_right_pressed
alvik.on_touch_right_pressed()
on_touch_right_pressed(callback: callable, args: tuple = ())
Registriert einen Rückruf, wenn die Berührungstaste RECHTS gedrückt wird
Eingaben
- callback: der Name der aufzurufenden Funktion
- args: optionale Argumente der Funktion