Python - Servo Brick

Dies ist die Beschreibung der Python API Bindings für den Servo Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Servo Brick sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Python API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Callback

Download (example_callback.py)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XXYYZZ" # Change XXYYZZ to the UID of your Servo Brick

from tinkerforge.ip_connection import IPConnection
from tinkerforge.brick_servo import BrickServo

# Use position reached callback to swing back and forth
def cb_position_reached(servo_num, position):
    if position == 9000:
        print('Position: 90°, going to -90°')
        servo.set_position(servo_num, -9000)
    elif position == -9000:
        print('Position: -90°, going to 90°')
        servo.set_position(servo_num, 9000)
    else:
        print('Error') # Can only happen if another program sets position

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    servo = BrickServo(UID, ipcon) # Create device object

    ipcon.connect(HOST, PORT) # Connect to brickd
    # Don't use device before ipcon is connected

    # Register position reached callback to function cb_position_reached
    servo.register_callback(servo.CALLBACK_POSITION_REACHED, cb_position_reached)

    # Enable position reached callback
    servo.enable_position_reached_callback()

    # Set velocity to 100°/s. This has to be smaller or equal to the
    # maximum velocity of the servo you are using, otherwise the position
    # reached callback will be called too early
    servo.set_velocity(0, 10000)
    servo.set_position(0, 9000)
    servo.enable(0)

    raw_input("Press key to exit\n") # Use input() in Python 3
    servo.disable(0)
    ipcon.disconnect()

Configuration

Download (example_configuration.py)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XXYYZZ" # Change XXYYZZ to the UID of your Servo Brick

from tinkerforge.ip_connection import IPConnection
from tinkerforge.brick_servo import BrickServo

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    servo = BrickServo(UID, ipcon) # Create device object

    ipcon.connect(HOST, PORT) # Connect to brickd
    # Don't use device before ipcon is connected

    # Configure two servos with voltage 5.5V
    # Servo 1: Connected to port 0, period of 19.5ms, pulse width of 1 to 2ms
    #          and operating angle -100 to 100°
    #
    # Servo 2: Connected to port 5, period of 20ms, pulse width of 0.95
    #          to 1.95ms and operating angle -90 to 90°
    servo.set_output_voltage(5500)

    servo.set_degree(0, -10000, 10000)
    servo.set_pulse_width(0, 1000, 2000)
    servo.set_period(0, 19500)
    servo.set_acceleration(0, 1000) # Slow acceleration
    servo.set_velocity(0, 65535) # Full speed

    servo.set_degree(5, -9000, 9000)
    servo.set_pulse_width(5, 950, 1950)
    servo.set_period(5, 20000)
    servo.set_acceleration(5, 65535) # Full acceleration
    servo.set_velocity(5, 65535) # Full speed

    servo.set_position(0, 10000) # Set to most right position
    servo.enable(0)

    servo.set_position(5, -9000) # Set to most left position
    servo.enable(5)

    raw_input("Press key to exit\n") # Use input() in Python 3
    servo.disable(0)
    servo.disable(5)
    ipcon.disconnect()

API

Prinzipiell kann jede Funktion der Python Bindings tinkerforge.ip_connection.Error Exception werfen, welche ein value und eine description Property hat. value kann verschiende Werte haben:

  • Error.TIMEOUT = -1
  • Error.ALREADY_CONNECTED = -7
  • Error.NOT_CONNECTED = -8
  • Error.INVALID_PARAMETER = -9
  • Error.NOT_SUPPORTED = -10
  • Error.UNKNOWN_ERROR_CODE = -11
  • Error.STREAM_OUT_OF_SYNC = -12

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Jede Funktion der Servo Brick API, welche den servo_num Parameter verwendet, kann einen Servo über die Servo Nummer (0 bis 6) adressieren. Falls es sich um eine Setter-Funktion handelt können mehrere Servos gleichzeitig mit einer Bitmaske adressiert werden. Um dies zu kennzeichnen muss das höchstwertigste Bit gesetzt werden. Beispiel: 1 adressiert den Servo 1, (1 << 1) | (1 << 5) | (1 << 7) adressiert die Servos 1 und 5, 0xFF adressiert alle 7 Servos, und so weiter. Das ermöglicht es Konfigurationen von verschiedenen Servos mit einem Funktionsaufruf durchzuführen. Es ist sichergestellt das die Änderungen in der selben PWM Periode vorgenommen werden, für alle Servos entsprechend der Bitmaske.

Grundfunktionen

BrickServo(uid, ipcon)
Parameter:
  • uid -- string
  • ipcon -- IPConnection

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

servo = BrickServo("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

BrickServo.enable(servo_num)
Parameter:servo_num -- int
Rückgabetyp:None

Aktiviert einen Servo (0 bis 6). Wenn ein Servo aktiviert wird, wird die konfigurierte Position, Geschwindigkeit, Beschleunigung, etc. sofort übernommen.

BrickServo.disable(servo_num)
Parameter:servo_num -- int
Rückgabetyp:None

Deaktiviert einen Servo (0 bis 6). Deaktivierte Servos werden nicht angesteuert, z.B. halten deaktivierte Servos nicht ihre Position wenn eine Last angebracht ist.

BrickServo.is_enabled(servo_num)
Parameter:servo_num -- int
Rückgabetyp:bool

Gibt zurück ob ein Servo aktiviert ist.

BrickServo.set_position(servo_num, position)
Parameter:
  • servo_num -- int
  • position -- int
Rückgabetyp:

None

Setzt die Position in °/100 für den angegebenen Servo.

Der Standardbereich für die Position ist -9000 bis 9000, aber dies kann, entsprechend dem verwendetem Servo, mit set_degree() definiert werden.

Wenn ein Linearservo oder RC Brushless Motor Controller oder ähnlich mit dem Servo Brick gesteuert werden soll, können Längen oder Geschwindigkeiten mit set_degree() definiert werden.

BrickServo.get_position(servo_num)
Parameter:servo_num -- int
Rückgabetyp:int

Gibt die Position des angegebenen Servos zurück, wie von set_position() gesetzt.

BrickServo.get_current_position(servo_num)
Parameter:servo_num -- int
Rückgabetyp:int

Gibt die aktuelle Position des angegebenen Servos zurück. Dies kann vom Wert von set_position() abweichen, wenn der Servo gerade sein Positionsziel anfährt.

BrickServo.set_velocity(servo_num, velocity)
Parameter:
  • servo_num -- int
  • velocity -- int
Rückgabetyp:

None

Setzt die maximale Geschwindigkeit des angegebenen Servos in °/100s. Die Geschwindigkeit wird entsprechend mit dem Wert, wie von set_acceleration() gesetzt, beschleunigt.

Die minimale Geschwindigkeit ist 0 (keine Bewegung) und die maximale ist 65535. Mit einem Wert von 65535 wird die Position sofort gesetzt (keine Geschwindigkeit).

Der Standardwert ist 65535.

BrickServo.get_velocity(servo_num)
Parameter:servo_num -- int
Rückgabetyp:int

Gibt die Geschwindigkeit des angegebenen Servos zurück, wie von set_velocity() gesetzt.

BrickServo.get_current_velocity(servo_num)
Parameter:servo_num -- int
Rückgabetyp:int

Gibt die aktuelle Geschwindigkeit des angegebenen Servos zurück. Dies kann vom Wert von set_velocity() abweichen, wenn der Servo gerade sein Geschwindigkeitsziel anfährt.

BrickServo.set_acceleration(servo_num, acceleration)
Parameter:
  • servo_num -- int
  • acceleration -- int
Rückgabetyp:

None

Setzt die Beschleunigung des angegebenen Servos in °/100s².

Die minimale Beschleunigung ist 1 und die maximale 65535. Mit einem Wert von 65535 wird die Geschwindigkeit sofort gesetzt (keine Beschleunigung).

Der Standardwert ist 65535.

BrickServo.get_acceleration(servo_num)
Parameter:servo_num -- int
Rückgabetyp:int

Gibt die Beschleunigung des angegebenen Servos zurück, wie von set_acceleration() gesetzt.

BrickServo.set_output_voltage(voltage)
Parameter:voltage -- int
Rückgabetyp:None

Setzt die Ausgangsspannung mit welchem der Servo angetrieben wird in mV. Die minimale Ausgangsspannung ist 2000mV und die maximale 9000mV.

Bemerkung

Es wird empfohlen diesen Wert auf die maximale Spannung laut Spezifikation des Servos zu setzten. Die meisten Servos erreichen ihre maximale Kraft nur mit hohen Spannungen

Der Standardwert ist 5000.

BrickServo.get_output_voltage()
Rückgabetyp:int

Gibt die Ausgangsspannung zurück, wie von set_output_voltage() gesetzt.

BrickServo.set_pulse_width(servo_num, min, max)
Parameter:
  • servo_num -- int
  • min -- int
  • max -- int
Rückgabetyp:

None

Setzt die minimale und maximale Pulsweite des angegebenen Servos in µs.

Normalerweise werden Servos mit einer PWM angesteuert, wobei die Länge des Pulses die Position des Servos steuert. Jeder Servo hat unterschiedliche minimale und maximale Pulsweiten, diese können mit dieser Funktion spezifiziert werden.

Wenn im Datenblatt des Servos die minimale und maximale Pulsweite spezifiziert ist, sollten diese Werte entsprechend gesetzt werden. Sollte der Servo ohne ein Datenblatt vorliegen, müssen die Werte durch Ausprobieren gefunden werden.

Beide Werte haben einen Wertebereich von 1 bis 65535 (unsigned 16-bit integer). Der minimale Wert muss kleiner als der maximale sein.

Die Standardwerte sind 1000µs (1ms) und 2000µs (2ms) für minimale und maximale Pulsweite.

BrickServo.get_pulse_width(servo_num)
Parameter:servo_num -- int
Rückgabetyp:(int, int)

Gibt die minimale und maximale Pulsweite des angegebenen Servos zurück, wie von set_pulse_width() gesetzt.

Das zurückgegebene namedtuple enthält die Variablen min und max.

BrickServo.set_degree(servo_num, min, max)
Parameter:
  • servo_num -- int
  • min -- int
  • max -- int
Rückgabetyp:

None

Setzt den minimalen und maximalen Winkel des angegebenen Servos (standardmäßig in °/100).

Dies definiert die abstrakten Werte zwischen welchen die minimale und maximale Pulsweite skaliert wird. Beispiel: Wenn eine Pulsweite von 1000µs bis 2000µs und ein Winkelbereich von -90° bis 90° spezifiziert ist, wird ein Aufruf von set_position() mit 0 in einer Pulsweite von 1500µs resultieren (-90° = 1000µs, 90° = 2000µs, etc.).

Anwendungsfälle:

  • Das Datenblatt des Servos spezifiziert einen Bereich von 200° mit einer Mittelposition bei 110°. In diesem Fall kann das Minimum auf -9000 und das Maximum auf 11000 gesetzt werden.
  • Es wird ein Bereich von 220° am Servo gemessen und eine Mittelposition ist nicht bekannt bzw. wird nicht benötigt. In diesem Fall kann das Minimum auf 0 und das Maximum auf 22000 gesetzt werden.
  • Ein Linearservo mit einer Antriebslänge von 20cm. In diesem Fall kann das Minimum auf 0 und das Maximum auf 20000 gesetzt werden. Jetzt kann die Position mittels set_position() mit einer Auflösung von cm/100 gesetzt werden. Auch die Geschwindigkeit hat eine Auflösung von cm/100s und die Beschleunigung von cm/100s².
  • Die Einheit ist irrelevant und eine möglichst hohe Auflösung ist gewünscht. In diesem Fall kann das Minimum auf -32767 und das Maximum auf 32767 gesetzt werden.
  • Ein Brushless Motor, mit einer maximalen Drehzahl von 1000 U/min, soll mit einem RC Brushless Motor Controller gesteuert werden. In diesem Fall kann das Minimum auf 0 und das Maximum auf 10000 gesetzt werden. set_position() steuert jetzt die Drehzahl in U/min.

Beide Werte haben einen Wertebereich von -32767 bis 32767 (signed 16-bit integer). Der minimale Wert muss kleiner als der maximale sein.

Die Standardwerte sind -9000 und 9000 für den minimalen und maximalen Winkel.

BrickServo.get_degree(servo_num)
Parameter:servo_num -- int
Rückgabetyp:(int, int)

Gibt den minimalen und maximalen Winkel für den angegebenen Servo zurück, wie von set_degree() gesetzt.

Das zurückgegebene namedtuple enthält die Variablen min und max.

BrickServo.set_period(servo_num, period)
Parameter:
  • servo_num -- int
  • period -- int
Rückgabetyp:

None

Setzt die Periode des angegebenen Servos in µs.

Normalerweise werden Servos mit einer PWM angesteuert. Unterschiedliche Servos erwarten PWMs mit unterschiedlichen Perioden. Die meisten Servos werden mit einer Periode von 20ms betrieben.

Wenn im Datenblatt des Servos die Periode spezifiziert ist, sollte dieser Wert entsprechend gesetzt werden. Sollte der Servo ohne ein Datenblatt vorliegen und die korrekte Periode unbekannt sein, wird der Standardwert (19,5ms) meinst funktionieren.

Die minimal mögliche Periode ist 1µs und die maximale 65535µs.

Der Standardwert ist 19,5ms (19500µs).

BrickServo.get_period(servo_num)
Parameter:servo_num -- int
Rückgabetyp:int

Gibt die Periode für den angegebenen Servo zurück, wie von set_period() gesetzt.

BrickServo.get_servo_current(servo_num)
Parameter:servo_num -- int
Rückgabetyp:int

Gibt den Stromverbrauch des angegebenen Servos in mA zurück.

BrickServo.get_overall_current()
Rückgabetyp:int

Gibt den Stromverbrauch aller Servos zusammen in mA zurück.

BrickServo.get_stack_input_voltage()
Rückgabetyp:int

Gibt die Eingangsspannung des Stapels in mV zurück. Die Eingangsspannung des Stapels wird über diesen verteilt, z.B. mittels einer Step-Down oder Step-Up Power Supply.

BrickServo.get_external_input_voltage()
Rückgabetyp:int

Gibt die externe Eingangsspannung (in mV) zurück. Die externe Eingangsspannung wird über die schwarze Stromversorgungsbuchse, in den Servo Brick, eingespeist.

Sobald eine externe Eingangsspannung und die Spannungsversorgung des Stapels anliegt, werden die Motoren über die externe Spannung versorgt. Sollte nur die Spannungsversorgung des Stapels verfügbar sein, erfolgt die Versorgung der Motoren über diese.

Warnung

Das bedeutet, bei einer hohen Versorgungsspannung des Stapels und einer geringen externen Versorgungsspannung erfolgt die Spannungsversorgung der Motoren über die geringere externe Versorgungsspannung. Wenn dann die externe Spannungsversorgung getrennt wird, erfolgt sofort die Versorgung der Motoren über die höhere Versorgungsspannung des Stapels.

Fortgeschrittene Funktionen

BrickServo.get_api_version()
Rückgabetyp:[int, int, int]

Gibt die Version der API Definition (Major, Minor, Revision) zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

BrickServo.get_response_expected(function_id)
Parameter:function_id -- int
Rückgabetyp:bool

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels set_response_expected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Siehe set_response_expected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

BrickServo.set_response_expected(function_id, response_expected)
Parameter:
  • function_id -- int
  • response_expected -- bool
Rückgabetyp:

None

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickServo.FUNCTION_ENABLE = 1
  • BrickServo.FUNCTION_DISABLE = 2
  • BrickServo.FUNCTION_SET_POSITION = 4
  • BrickServo.FUNCTION_SET_VELOCITY = 7
  • BrickServo.FUNCTION_SET_ACCELERATION = 10
  • BrickServo.FUNCTION_SET_OUTPUT_VOLTAGE = 12
  • BrickServo.FUNCTION_SET_PULSE_WIDTH = 14
  • BrickServo.FUNCTION_SET_DEGREE = 16
  • BrickServo.FUNCTION_SET_PERIOD = 18
  • BrickServo.FUNCTION_SET_MINIMUM_VOLTAGE = 24
  • BrickServo.FUNCTION_ENABLE_POSITION_REACHED_CALLBACK = 29
  • BrickServo.FUNCTION_DISABLE_POSITION_REACHED_CALLBACK = 30
  • BrickServo.FUNCTION_ENABLE_VELOCITY_REACHED_CALLBACK = 32
  • BrickServo.FUNCTION_DISABLE_VELOCITY_REACHED_CALLBACK = 33
  • BrickServo.FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • BrickServo.FUNCTION_SET_SPITFP_BAUDRATE = 234
  • BrickServo.FUNCTION_ENABLE_STATUS_LED = 238
  • BrickServo.FUNCTION_DISABLE_STATUS_LED = 239
  • BrickServo.FUNCTION_RESET = 243
BrickServo.set_response_expected_all(response_expected)
Parameter:response_expected -- bool
Rückgabetyp:None

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

BrickServo.set_spitfp_baudrate_config(enable_dynamic_baudrate, minimum_dynamic_baudrate)
Parameter:
  • enable_dynamic_baudrate -- bool
  • minimum_dynamic_baudrate -- int
Rückgabetyp:

None

Das SPITF-Protokoll kann mit einer dynamischen Baudrate genutzt werden. Wenn die dynamische Baudrate aktiviert ist, versucht der Brick die Baudrate anhand des Datenaufkommens zwischen Brick und Bricklet anzupassen.

Die Baudrate wird exponentiell erhöht wenn viele Daten gesendet/empfangen werden und linear verringert wenn wenig Daten gesendet/empfangen werden.

Diese Vorgehensweise verringert die Baudrate in Anwendungen wo nur wenig Daten ausgetauscht werden müssen (z.B. eine Wetterstation) und erhöht die Robustheit. Wenn immer viele Daten ausgetauscht werden (z.B. Thermal Imaging Bricklet), wird die Baudrate automatisch erhöht.

In Fällen wo wenige Daten all paar Sekunden so schnell wie Möglich übertragen werden sollen (z.B. RS485 Bricklet mit hoher Baudrate aber kleinem Payload) kann die dynamische Baudrate zum maximieren der Performance ausgestellt werden.

Die maximale Baudrate kann pro Port mit der Funktion set_spitfp_baudrate(). gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von set_spitfp_baudrate() gesetzt statisch verwendet.

Die minimale dynamische Baudrate hat einen Wertebereich von 400000 bis 2000000 Baud.

Standardmäßig ist die dynamische Baudrate aktiviert und die minimale dynamische Baudrate ist 400000.

Neu in Version 2.3.4 (Firmware).

BrickServo.get_spitfp_baudrate_config()
Rückgabetyp:(bool, int)

Gibt die Baudratenkonfiguration zurück, siehe set_spitfp_baudrate_config().

Neu in Version 2.3.4 (Firmware).

Das zurückgegebene namedtuple enthält die Variablen enable_dynamic_baudrate und minimum_dynamic_baudrate.

BrickServo.get_send_timeout_count(communication_method)
Parameter:communication_method -- int
Rückgabetyp:int

Gibt den Timeout-Zähler für die verschiedenen Kommunikationsmöglichkeiten zurück

Die Kommunikationsmöglichkeiten 0-2 stehen auf allen Bricks zur verfügung, 3-7 nur auf Master Bricks.

Diese Funktion ist hauptsächlich zum debuggen während der Entwicklung gedacht. Im normalen Betrieb sollten alle Zähler fast immer auf 0 stehen bleiben.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • BrickServo.COMMUNICATION_METHOD_NONE = 0
  • BrickServo.COMMUNICATION_METHOD_USB = 1
  • BrickServo.COMMUNICATION_METHOD_SPI_STACK = 2
  • BrickServo.COMMUNICATION_METHOD_CHIBI = 3
  • BrickServo.COMMUNICATION_METHOD_RS485 = 4
  • BrickServo.COMMUNICATION_METHOD_WIFI = 5
  • BrickServo.COMMUNICATION_METHOD_ETHERNET = 6
  • BrickServo.COMMUNICATION_METHOD_WIFI_V2 = 7

Neu in Version 2.3.2 (Firmware).

BrickServo.set_spitfp_baudrate(bricklet_port, baudrate)
Parameter:
  • bricklet_port -- chr
  • baudrate -- int
Rückgabetyp:

None

Setzt die Baudrate eines spezifischen Bricklet Ports ('a' - 'd'). Die Baudrate hat einen möglichen Wertebereich von 400000 bis 2000000.

Für einen höheren Durchsatz der Bricklets kann die Baudrate erhöht werden. Wenn der Fehlerzähler auf Grund von lokaler Störeinstrahlung hoch ist (siehe get_spitfp_error_count()) kann die Baudrate verringert werden.

Wenn das Feature der dynamische Baudrate aktiviert ist, setzt diese Funktion die maximale Baudrate (siehe set_spitfp_baudrate_config()).

EMV Tests werden mit der Standardbaudrate durchgeführt. Falls eine CE-Kompatibilität o.ä. in der Anwendung notwendig ist empfehlen wir die Baudrate nicht zu ändern.

Die Standardbaudrate für alle Ports ist 1400000.

Neu in Version 2.3.2 (Firmware).

BrickServo.get_spitfp_baudrate(bricklet_port)
Parameter:bricklet_port -- chr
Rückgabetyp:int

Gibt die Baudrate für einen Bricklet Port zurück, siehe set_spitfp_baudrate().

Neu in Version 2.3.2 (Firmware).

BrickServo.get_spitfp_error_count(bricklet_port)
Parameter:bricklet_port -- chr
Rückgabetyp:(int, int, int, int)

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricks auftreten. Jedes Bricklet hat eine ähnliche Funktion welche die Fehler auf Brickletseite ausgibt.

Neu in Version 2.3.2 (Firmware).

Das zurückgegebene namedtuple enthält die Variablen error_count_ack_checksum, error_count_message_checksum, error_count_frame und error_count_overflow.

BrickServo.enable_status_led()
Rückgabetyp:None

Aktiviert die Status LED.

Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.

Der Standardzustand ist aktiviert.

Neu in Version 2.3.1 (Firmware).

BrickServo.disable_status_led()
Rückgabetyp:None

Deaktiviert die Status LED.

Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.

Der Standardzustand ist aktiviert.

Neu in Version 2.3.1 (Firmware).

BrickServo.is_status_led_enabled()
Rückgabetyp:bool

Gibt true zurück wenn die Status LED aktiviert ist, false sonst.

Neu in Version 2.3.1 (Firmware).

BrickServo.get_protocol1_bricklet_name(port)
Parameter:port -- chr
Rückgabetyp:(int, [int, int, int], str)

Gibt die Firmware und Protokoll Version und den Namen des Bricklets für einen gegebenen Port zurück.

Der einzige Zweck dieser Funktion ist es, automatischen Flashen von Bricklet v1.x.y Plugins zu ermöglichen.

Das zurückgegebene namedtuple enthält die Variablen protocol_version, firmware_version und name.

BrickServo.get_chip_temperature()
Rückgabetyp:int

Gibt die Temperatur in °C/10, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine Genauigkeit von +-15%. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

BrickServo.reset()
Rückgabetyp:None

Ein Aufruf dieser Funktion setzt den Brick zurück. Befindet sich der Brick innerhalb eines Stapels wird der gesamte Stapel zurück gesetzt.

Nach dem Zurücksetzen ist es notwendig neue Geräteobjekte zu erzeugen, Funktionsaufrufe auf bestehende führt zu undefiniertem Verhalten.

BrickServo.get_identity()
Rückgabetyp:(str, str, chr, [int, int, int], [int, int, int], int)

Gibt die UID, die UID zu der der Brick verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position kann '0'-'8' (Stack Position) sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Brick.

Das zurückgegebene namedtuple enthält die Variablen uid, connected_uid, position, hardware_version, firmware_version und device_identifier.

Konfigurationsfunktionen für Callbacks

BrickServo.register_callback(callback_id, function)
Parameter:
  • callback_id -- int
  • function -- callable
Rückgabetyp:

None

Registriert die function für die gegebene callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

BrickServo.set_minimum_voltage(voltage)
Parameter:voltage -- int
Rückgabetyp:None

Setzt die minimale Spannung in mV, bei welcher der CALLBACK_UNDER_VOLTAGE Callback ausgelöst wird. Der kleinste mögliche Wert mit dem der Servo Brick noch funktioniert, ist 5V. Mit dieser Funktion kann eine Entladung der versorgenden Batterie detektiert werden. Beim Einsatz einer Netzstromversorgung wird diese Funktionalität höchstwahrscheinlich nicht benötigt.

Der Standardwert ist 5V (5000mV).

BrickServo.get_minimum_voltage()
Rückgabetyp:int

Gibt die minimale Spannung zurück, wie von set_minimum_voltage() gesetzt.

BrickServo.enable_position_reached_callback()
Rückgabetyp:None

Aktiviert den CALLBACK_POSITION_REACHED Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

BrickServo.disable_position_reached_callback()
Rückgabetyp:None

Deaktiviert den CALLBACK_POSITION_REACHED Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

BrickServo.is_position_reached_callback_enabled()
Rückgabetyp:bool

Gibt true zurück wenn der CALLBACK_POSITION_REACHED Callback aktiviert ist, false sonst.

Neu in Version 2.0.1 (Firmware).

BrickServo.enable_velocity_reached_callback()
Rückgabetyp:None

Aktiviert den CALLBACK_VELOCITY_REACHED Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

BrickServo.disable_velocity_reached_callback()
Rückgabetyp:None

Deaktiviert den CALLBACK_VELOCITY_REACHED Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

BrickServo.is_velocity_reached_callback_enabled()
Rückgabetyp:bool

Gibt true zurück wenn der CALLBACK_VELOCITY_REACHED Callback aktiviert ist, false sonst.

Neu in Version 2.0.1 (Firmware).

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion register_callback() des Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID und der zweite Parameter die Callback-Funktion:

def my_callback(param):
    print(param)

servo.register_callback(BrickServo.CALLBACK_EXAMPLE, my_callback)

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

BrickServo.CALLBACK_UNDER_VOLTAGE
Parameter:voltage -- int

Dieser Callback wird ausgelöst wenn die Eingangsspannung unter den, mittels set_minimum_voltage() gesetzten, Schwellwert sinkt. Der Parameter ist die aktuelle Spannung in mV.

BrickServo.CALLBACK_POSITION_REACHED
Parameter:
  • servo_num -- int
  • position -- int

Dieser Callback wird ausgelöst wenn eine konfigurierte Position, wie von set_position() gesetzt, erreicht wird. Falls die neue Position der aktuellen Position entspricht, wird der Callback nicht ausgelöst, weil sich der Servo nicht bewegt hat. Die Parameter sind der Servo und die Position die erreicht wurde.

Dieser Callback kann mit enable_position_reached_callback() aktiviert werden.

Bemerkung

Da es nicht möglich ist eine Rückmeldung vom Servo zu erhalten, funktioniert dies nur wenn die konfigurierte Geschwindigkeit (siehe set_velocity()) kleiner oder gleich der maximalen Geschwindigkeit des Motors ist. Andernfalls wird der Motor hinter dem Vorgabewert zurückbleiben und der Callback wird zu früh ausgelöst.

BrickServo.CALLBACK_VELOCITY_REACHED
Parameter:
  • servo_num -- int
  • velocity -- int

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Geschwindigkeit, wie von set_velocity() gesetzt, erreicht wird. Die Parameter sind der Servo und die Geschwindigkeit die erreicht wurde.

Dieser Callback kann mit enable_velocity_reached_callback() aktiviert werden.

Bemerkung

Da es nicht möglich ist eine Rückmeldung vom Servo zu erhalten, funktioniert dies nur wenn die konfigurierte Beschleunigung (siehe set_acceleration()) kleiner oder gleich der maximalen Beschleunigung des Motors ist. Andernfalls wird der Motor hinter dem Vorgabewert zurückbleiben und der Callback wird zu früh ausgelöst.

Konstanten

BrickServo.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um einen Servo Brick zu identifizieren.

Die get_identity() Funktion und der CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickServo.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Servo Brick dar.