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.
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.
BrickServo.
enable
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
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: |
|
---|---|
Anfrage: |
|
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: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt zurück ob ein Servo aktiviert ist.
BrickServo.
set_position
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
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: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Position des angegebenen Servos zurück, wie von set_position
gesetzt.
BrickServo.
get_current_position
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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: |
|
---|---|
Anfrage: |
|
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: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Geschwindigkeit des angegebenen Servos zurück, wie von
set_velocity
gesetzt.
BrickServo.
get_current_velocity
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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: |
|
---|---|
Anfrage: |
|
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: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Beschleunigung des angegebenen Servos zurück, wie von
set_acceleration
gesetzt.
BrickServo.
set_output_voltage
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
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: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Ausgangsspannung zurück, wie von set_output_voltage
gesetzt.
BrickServo.
set_pulse_width
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
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: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die minimale und maximale Pulsweite des angegebenen Servos zurück, wie von
set_pulse_width
gesetzt.
BrickServo.
set_degree
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
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:
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².set_position
steuert jetzt die Drehzahl in U/min.Der minimale Wert muss kleiner als der maximale sein.
BrickServo.
get_degree
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt den minimalen und maximalen Winkel für den angegebenen Servo zurück,
wie von set_degree
gesetzt.
BrickServo.
set_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
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: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Periode für den angegebenen Servo zurück, wie von set_period
gesetzt.
BrickServo.
get_servo_current
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt den Stromverbrauch des angegebenen Servos zurück.
BrickServo.
get_overall_current
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt den Stromverbrauch aller Servos zusammen zurück.
BrickServo.
get_stack_input_voltage
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.
BrickServo.
set_spitfp_baudrate_config
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
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: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Baudratenkonfiguration zurück, siehe set_spitfp_baudrate_config
.
Neu in Version 2.3.4 (Firmware).
BrickServo.
get_send_timeout_count
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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:
BrickServo.
set_spitfp_baudrate
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
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: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
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: |
|
---|---|
Anfrage: |
|
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: |
|
---|---|
Anfrage: |
|
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: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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: |
|
---|---|
Anfrage: |
|
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: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.
BrickServo.
set_minimum_voltage
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
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: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die minimale Spannung zurück, wie von set_minimum_voltage
gesetzt.
BrickServo.
enable_position_reached_callback
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Aktiviert den CALLBACK_POSITION_REACHED
Callback.
Voreinstellung ist deaktiviert.
Neu in Version 2.0.1 (Firmware).
BrickServo.
disable_position_reached_callback
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Deaktiviert den CALLBACK_POSITION_REACHED
Callback.
Neu in Version 2.0.1 (Firmware).
BrickServo.
is_position_reached_callback_enabled
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Aktiviert den CALLBACK_VELOCITY_REACHED
Callback.
Voreinstellung ist deaktiviert.
Neu in Version 2.0.1 (Firmware).
BrickServo.
disable_velocity_reached_callback
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
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: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt true zurück wenn der CALLBACK_VELOCITY_REACHED
Callback aktiviert ist, false sonst.
Neu in Version 2.0.1 (Firmware).
BrickServo.
CALLBACK_UNDER_VOLTAGE
¶Funktions-ID: |
|
---|---|
Antwort: |
|
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: |
|
---|---|
Antwort: |
|
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: |
|
---|---|
Antwort: |
|
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 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: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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: |
|
---|---|
Anfrage: |
|
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: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.