Modbus - Servo Brick

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

API

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

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.enable
Funktions-ID:
  • 1
Anfrage:
  • servo_num – Typ: uint8, Wertebereich: [0 bis 6, 128 bis 255]
Antwort:
  • keine Antwort

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

BrickServo.disable
Funktions-ID:
  • 2
Anfrage:
  • servo_num – Typ: uint8, Wertebereich: [0 bis 6, 128 bis 255]
Antwort:
  • keine Antwort

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
Funktions-ID:
  • 3
Anfrage:
  • servo_num – Typ: uint8, Wertebereich: [0 bis 6]
Antwort:
  • enabled – Typ: bool, Standardwert: false

Gibt zurück ob ein Servo aktiviert ist.

BrickServo.set_position
Funktions-ID:
  • 4
Anfrage:
  • servo_num – Typ: uint8, Wertebereich: [0 bis 6, 128 bis 255]
  • position – Typ: int16, Einheit: 1/100 °, Wertebereich: ?
Antwort:
  • keine Antwort

Setzt die Position 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
Funktions-ID:
  • 5
Anfrage:
  • servo_num – Typ: uint8, Wertebereich: [0 bis 6]
Antwort:
  • position – Typ: int16, Einheit: 1/100 °, Wertebereich: ?

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

BrickServo.get_current_position
Funktions-ID:
  • 6
Anfrage:
  • servo_num – Typ: uint8, Wertebereich: [0 bis 6]
Antwort:
  • position – Typ: int16, Einheit: 1/100 °, Wertebereich: ?

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
Funktions-ID:
  • 7
Anfrage:
  • servo_num – Typ: uint8, Wertebereich: [0 bis 6, 128 bis 255]
  • velocity – Typ: uint16, Einheit: 1/100 °/s, Wertebereich: [0 bis 216 - 1], Standardwert: 216 - 1
Antwort:
  • keine Antwort

Setzt die maximale Geschwindigkeit des angegebenen Servos. 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).

BrickServo.get_velocity
Funktions-ID:
  • 8
Anfrage:
  • servo_num – Typ: uint8, Wertebereich: [0 bis 6]
Antwort:
  • velocity – Typ: uint16, Einheit: 1/100 °/s, Wertebereich: [0 bis 216 - 1], Standardwert: 216 - 1

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

BrickServo.get_current_velocity
Funktions-ID:
  • 9
Anfrage:
  • servo_num – Typ: uint8, Wertebereich: [0 bis 6]
Antwort:
  • velocity – Typ: uint16, Einheit: 1/100 °/s, Wertebereich: [0 bis 216 - 1], Standardwert: 216 - 1

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
Funktions-ID:
  • 10
Anfrage:
  • servo_num – Typ: uint8, Wertebereich: [0 bis 6, 128 bis 255]
  • acceleration – Typ: uint16, Einheit: 1/100 °/s², Wertebereich: [0 bis 216 - 1], Standardwert: 216 - 1
Antwort:
  • keine Antwort

Setzt die Beschleunigung des angegebenen Servos.

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

BrickServo.get_acceleration
Funktions-ID:
  • 11
Anfrage:
  • servo_num – Typ: uint8, Wertebereich: [0 bis 6]
Antwort:
  • acceleration – Typ: uint16, Einheit: 1/100 °/s², Wertebereich: [0 bis 216 - 1], Standardwert: 216 - 1

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

BrickServo.set_output_voltage
Funktions-ID:
  • 12
Anfrage:
  • voltage – Typ: uint16, Einheit: 1 mV, Wertebereich: [2000 bis 9000], Standardwert: 5000
Antwort:
  • keine Antwort

Setzt die Ausgangsspannung mit welchem der Servo angetrieben wird.

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

BrickServo.get_output_voltage
Funktions-ID:
  • 13
Anfrage:
  • keine Nutzdaten
Antwort:
  • voltage – Typ: uint16, Einheit: 1 mV, Wertebereich: [2000 bis 9000], Standardwert: 5000

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

BrickServo.set_pulse_width
Funktions-ID:
  • 14
Anfrage:
  • servo_num – Typ: uint8, Wertebereich: [0 bis 6, 128 bis 255]
  • min – Typ: uint16, Einheit: 1 µs, Wertebereich: [0 bis 216 - 1], Standardwert: 1000
  • max – Typ: uint16, Einheit: 1 µs, Wertebereich: [0 bis 216 - 1], Standardwert: 2000
Antwort:
  • keine Antwort

Setzt die minimale und maximale Pulsweite des angegebenen Servos.

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.

Der minimale Wert muss kleiner als der maximale sein.

BrickServo.get_pulse_width
Funktions-ID:
  • 15
Anfrage:
  • servo_num – Typ: uint8, Wertebereich: [0 bis 6]
Antwort:
  • min – Typ: uint16, Einheit: 1 µs, Wertebereich: [0 bis 216 - 1], Standardwert: 1000
  • max – Typ: uint16, Einheit: 1 µs, Wertebereich: [0 bis 216 - 1], Standardwert: 2000

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

BrickServo.set_degree
Funktions-ID:
  • 16
Anfrage:
  • servo_num – Typ: uint8, Wertebereich: [0 bis 6, 128 bis 255]
  • min – Typ: int16, Einheit: 1/100 °, Wertebereich: [-215 bis 215 - 1], Standardwert: -9000
  • max – Typ: int16, Einheit: 1/100 °, Wertebereich: [-215 bis 215 - 1], Standardwert: 9000
Antwort:
  • keine Antwort

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.

Der minimale Wert muss kleiner als der maximale sein.

BrickServo.get_degree
Funktions-ID:
  • 17
Anfrage:
  • servo_num – Typ: uint8, Wertebereich: [0 bis 6]
Antwort:
  • min – Typ: int16, Einheit: 1/100 °, Wertebereich: [-215 bis 215 - 1], Standardwert: -9000
  • max – Typ: int16, Einheit: 1/100 °, Wertebereich: [-215 bis 215 - 1], Standardwert: 9000

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

BrickServo.set_period
Funktions-ID:
  • 18
Anfrage:
  • servo_num – Typ: uint8, Wertebereich: [0 bis 6, 128 bis 255]
  • period – Typ: uint16, Einheit: 1 µs, Wertebereich: [0 bis 216 - 1], Standardwert: 19500
Antwort:
  • keine Antwort

Setzt die Periode des angegebenen Servos.

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 meist funktionieren.

BrickServo.get_period
Funktions-ID:
  • 19
Anfrage:
  • servo_num – Typ: uint8, Wertebereich: [0 bis 6]
Antwort:
  • period – Typ: uint16, Einheit: 1 µs, Wertebereich: [0 bis 216 - 1], Standardwert: 19500

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

BrickServo.get_servo_current
Funktions-ID:
  • 20
Anfrage:
  • servo_num – Typ: uint8, Wertebereich: [0 bis 6]
Antwort:
  • current – Typ: uint16, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

Gibt den Stromverbrauch des angegebenen Servos zurück.

BrickServo.get_overall_current
Funktions-ID:
  • 21
Anfrage:
  • keine Nutzdaten
Antwort:
  • current – Typ: uint16, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

Gibt den Stromverbrauch aller Servos zusammen zurück.

BrickServo.get_stack_input_voltage
Funktions-ID:
  • 22
Anfrage:
  • keine Nutzdaten
Antwort:
  • voltage – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Gibt die Eingangsspannung des Stapels 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
Funktions-ID:
  • 23
Anfrage:
  • keine Nutzdaten
Antwort:
  • voltage – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Gibt die externe Eingangsspannung 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.set_spitfp_baudrate_config
Funktions-ID:
  • 231
Anfrage:
  • enable_dynamic_baudrate – Typ: bool, Standardwert: true
  • minimum_dynamic_baudrate – Typ: uint32, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000
Antwort:
  • keine Antwort

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.

Neu in Version 2.3.4 (Firmware).

BrickServo.get_spitfp_baudrate_config
Funktions-ID:
  • 232
Anfrage:
  • keine Nutzdaten
Antwort:
  • enable_dynamic_baudrate – Typ: bool, Standardwert: true
  • minimum_dynamic_baudrate – Typ: uint32, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000

Gibt die Baudratenkonfiguration zurück, siehe set_spitfp_baudrate_config.

Neu in Version 2.3.4 (Firmware).

BrickServo.get_send_timeout_count
Funktions-ID:
  • 233
Anfrage:
  • communication_method – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:
  • timeout_count – Typ: uint32, Wertebereich: [0 bis 232 - 1]

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.

Neu in Version 2.3.2 (Firmware).

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für communication_method:

  • 0 = None
  • 1 = USB
  • 2 = SPI Stack
  • 3 = Chibi
  • 4 = RS485
  • 5 = WIFI
  • 6 = Ethernet
  • 7 = WIFI V2
BrickServo.set_spitfp_baudrate
Funktions-ID:
  • 234
Anfrage:
  • bricklet_port – Typ: char, Wertebereich: ['a' bis 'b']
  • baudrate – Typ: uint32, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000
Antwort:
  • keine Antwort

Setzt die Baudrate eines spezifischen Bricklet Ports .

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.

Neu in Version 2.3.2 (Firmware).

BrickServo.get_spitfp_baudrate
Funktions-ID:
  • 235
Anfrage:
  • bricklet_port – Typ: char, Wertebereich: ['a' bis 'b']
Antwort:
  • baudrate – Typ: uint32, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000

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
Funktions-ID:
  • 237
Anfrage:
  • bricklet_port – Typ: char, Wertebereich: ['a' bis 'b']
Antwort:
  • error_count_ack_checksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: uint32, Wertebereich: [0 bis 232 - 1]

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).

BrickServo.enable_status_led
Funktions-ID:
  • 238
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

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
Funktions-ID:
  • 239
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

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
Funktions-ID:
  • 240
Anfrage:
  • keine Nutzdaten
Antwort:
  • enabled – Typ: bool, Standardwert: true

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

Neu in Version 2.3.1 (Firmware).

BrickServo.get_chip_temperature
Funktions-ID:
  • 242
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int16, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, 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
Funktions-ID:
  • 243
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

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
Funktions-ID:
  • 255
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: char[8]
  • connected_uid – Typ: char[8]
  • position – Typ: char, Wertebereich: ['0' bis '8']
  • hardware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • firmware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • device_identifier – Typ: uint16, Wertebereich: [0 bis 216 - 1]

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 ist die Position im Stack von '0' (unterster Brick) bis '8' (oberster Brick).

Eine Liste der Device Identifier Werte ist hier zu finden. 

Konfigurationsfunktionen für Callbacks

BrickServo.set_minimum_voltage
Funktions-ID:
  • 24
Anfrage:
  • voltage – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 5000
Antwort:
  • keine Antwort

Setzt die minimale Spannung, 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.

BrickServo.get_minimum_voltage
Funktions-ID:
  • 25
Anfrage:
  • keine Nutzdaten
Antwort:
  • voltage – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 5000

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

BrickServo.enable_position_reached_callback
Funktions-ID:
  • 29
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Aktiviert den CALLBACK_POSITION_REACHED Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

BrickServo.disable_position_reached_callback
Funktions-ID:
  • 30
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Deaktiviert den CALLBACK_POSITION_REACHED Callback.

Neu in Version 2.0.1 (Firmware).

BrickServo.is_position_reached_callback_enabled
Funktions-ID:
  • 31
Anfrage:
  • keine Nutzdaten
Antwort:
  • enabled – Typ: bool, Standardwert: false

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
Funktions-ID:
  • 32
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Aktiviert den CALLBACK_VELOCITY_REACHED Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

BrickServo.disable_velocity_reached_callback
Funktions-ID:
  • 33
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Deaktiviert den CALLBACK_VELOCITY_REACHED Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

BrickServo.is_velocity_reached_callback_enabled
Funktions-ID:
  • 34
Anfrage:
  • keine Nutzdaten
Antwort:
  • enabled – Typ: bool, Standardwert: false

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

Neu in Version 2.0.1 (Firmware).

Callbacks

BrickServo.CALLBACK_UNDER_VOLTAGE
Funktions-ID:
  • 26
Antwort:
  • voltage – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird ausgelöst, wenn die Eingangsspannung unter den, mittels set_minimum_voltage gesetzten, Schwellwert sinkt. Der Rückgabewert ist die aktuelle Spannung.

BrickServo.CALLBACK_POSITION_REACHED
Funktions-ID:
  • 27
Antwort:
  • servo_num – Typ: uint8, Wertebereich: [0 bis 6]
  • position – Typ: int16, Einheit: 1/100 °, Wertebereich: ?

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 Rückgabewerte 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
Funktions-ID:
  • 28
Antwort:
  • servo_num – Typ: uint8, Wertebereich: [0 bis 6]
  • velocity – Typ: int16, Einheit: 1/100 °/s, Wertebereich: [-215 bis 215 - 1]

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Geschwindigkeit, wie von set_velocity gesetzt, erreicht wird. Die Rückgabewerte 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.

Interne Funktionen

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

BrickServo.get_protocol1_bricklet_name
Funktions-ID:
  • 241
Anfrage:
  • port – Typ: char, Wertebereich: ['a' bis 'b']
Antwort:
  • protocol_version – Typ: uint8, Wertebereich: [0 bis 255]
  • firmware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • name – Typ: char[40]

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.

BrickServo.write_bricklet_plugin
Funktions-ID:
  • 246
Anfrage:
  • port – Typ: char, Wertebereich: ['a' bis 'b']
  • offset – Typ: uint8, Wertebereich: [0 bis 255]
  • chunk – Typ: uint8[32], Wertebereich: [0 bis 255]
Antwort:
  • keine Antwort

Schreibt 32 Bytes Firmware auf das Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden an die Position offset * 32 geschrieben.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickServo.read_bricklet_plugin
Funktions-ID:
  • 247
Anfrage:
  • port – Typ: char, Wertebereich: ['a' bis 'b']
  • offset – Typ: uint8, Wertebereich: [0 bis 255]
Antwort:
  • chunk – Typ: uint8[32], Wertebereich: [0 bis 255]

Liest 32 Bytes Firmware vom Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden ab der Position offset * 32 gelesen.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.