MQTT - Servo Brick

Dies ist die Beschreibung der MQTT 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 MQTT API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Callback

Download (example-callback.txt)

 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
# Change XXYYZZ to the UID of your Servo Brick

setup:
    # Use position reached callback to swing back and forth
    subscribe to tinkerforge/callback/servo_brick/XXYYZZ/position_reached
        if a message arives
            # message contains the current servoNum and position as int
            if position is 9000
                # Position is 90°, going to -90°
                publish '{"servo_num": 0, "position": -9000}' to tinkerforge/request/servo_brick/XXYYZZ/set_position
            elseif position is -9000
                # Position is -90°, going to 90°
                publish '{"servo_num": 0, "position": 9000}' to tinkerforge/request/servo_brick/XXYYZZ/set_position
            else
                # Another program has set the position, print an error
            endif
        endif
    endsubscribe

    publish '{"register": true}' to tinkerforge/register/servo_brick/XXYYZZ/position_reached # Register position_reached callback

    # Enable position reached callback
    publish '' to tinkerforge/request/servo_brick/XXYYZZ/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
    publish '{"servo_num": 0, "velocity": 10000}' to tinkerforge/request/servo_brick/XXYYZZ/set_velocity

    publish '{"servo_num": 0, "position": 9000}' to tinkerforge/request/servo_brick/XXYYZZ/set_position

    publish '{"servo_num": 0}' to tinkerforge/request/servo_brick/XXYYZZ/enable

cleanup:
    # If you are done, run this to clean up
    publish '{"servo_num": 0}' to tinkerforge/request/servo_brick/XXYYZZ/disable

Configuration

Download (example-configuration.txt)

 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
# Change XXYYZZ to the UID of your Servo Brick

setup:
    # 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°
    publish '{"voltage": 5500}' to tinkerforge/request/servo_brick/XXYYZZ/set_output_voltage

    publish '{"servo_num": 0, "min": -10000, "max": 10000}' to tinkerforge/request/servo_brick/XXYYZZ/set_degree

    publish '{"servo_num": 0, "min": 1000, "max": 2000}' to tinkerforge/request/servo_brick/XXYYZZ/set_pulse_width

    publish '{"servo_num": 0, "period": 19500}' to tinkerforge/request/servo_brick/XXYYZZ/set_period

    publish '{"servo_num": 0, "acceleration": 1000}' to tinkerforge/request/servo_brick/XXYYZZ/set_acceleration # Slow acceleration

    publish '{"servo_num": 0, "velocity": 65535}' to tinkerforge/request/servo_brick/XXYYZZ/set_velocity # Full speed

    publish '{"servo_num": 5, "min": -9000, "max": 9000}' to tinkerforge/request/servo_brick/XXYYZZ/set_degree

    publish '{"servo_num": 5, "min": 950, "max": 1950}' to tinkerforge/request/servo_brick/XXYYZZ/set_pulse_width

    publish '{"servo_num": 5, "period": 20000}' to tinkerforge/request/servo_brick/XXYYZZ/set_period

    publish '{"servo_num": 5, "acceleration": 65535}' to tinkerforge/request/servo_brick/XXYYZZ/set_acceleration # Full acceleration

    publish '{"servo_num": 5, "velocity": 65535}' to tinkerforge/request/servo_brick/XXYYZZ/set_velocity # Full speed

    publish '{"servo_num": 0, "position": 10000}' to tinkerforge/request/servo_brick/XXYYZZ/set_position # Set to most right position

    publish '{"servo_num": 0}' to tinkerforge/request/servo_brick/XXYYZZ/enable

    publish '{"servo_num": 5, "position": -9000}' to tinkerforge/request/servo_brick/XXYYZZ/set_position # Set to most left position

    publish '{"servo_num": 5}' to tinkerforge/request/servo_brick/XXYYZZ/enable

cleanup:
    # If you are done, run this to clean up
    publish '{"servo_num": 0}' to tinkerforge/request/servo_brick/XXYYZZ/disable

    publish '{"servo_num": 5}' to tinkerforge/request/servo_brick/XXYYZZ/disable

API

Alle veröffentlichten Payloads an die und von den MQTT-Bindings sind im JSON Format.

Falls ein Fehler auftritt, veröffentlichen die Bindings ein JSON-Objekt, das die Fehlermeldung als _ERROR-Member enthält. Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/... für .../request/... und .../callback/... für .../register/....

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

request/servo_brick/<UID>/enable
Anfrage:
  • servo_num – Typ: int, 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.

request/servo_brick/<UID>/disable
Anfrage:
  • servo_num – Typ: int, 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.

request/servo_brick/<UID>/is_enabled
Anfrage:
  • servo_num – Typ: int, Wertebereich: [0 bis 6]
Antwort:
  • enabled – Typ: bool, Standardwert: false

Gibt zurück ob ein Servo aktiviert ist.

request/servo_brick/<UID>/set_position
Anfrage:
  • servo_num – Typ: int, Wertebereich: [0 bis 6, 128 bis 255]
  • position – Typ: int, 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 request/servo_brick/<UID>/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 request/servo_brick/<UID>/set_degree definiert werden.

request/servo_brick/<UID>/get_position
Anfrage:
  • servo_num – Typ: int, Wertebereich: [0 bis 6]
Antwort:
  • position – Typ: int, Einheit: 1/100 °, Wertebereich: ?

Gibt die Position des angegebenen Servos zurück, wie von request/servo_brick/<UID>/set_position gesetzt.

request/servo_brick/<UID>/get_current_position
Anfrage:
  • servo_num – Typ: int, Wertebereich: [0 bis 6]
Antwort:
  • position – Typ: int, Einheit: 1/100 °, Wertebereich: ?

Gibt die aktuelle Position des angegebenen Servos zurück. Dies kann vom Wert von request/servo_brick/<UID>/set_position abweichen, wenn der Servo gerade sein Positionsziel anfährt.

request/servo_brick/<UID>/set_velocity
Anfrage:
  • servo_num – Typ: int, Wertebereich: [0 bis 6, 128 bis 255]
  • velocity – Typ: int, 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 request/servo_brick/<UID>/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).

request/servo_brick/<UID>/get_velocity
Anfrage:
  • servo_num – Typ: int, Wertebereich: [0 bis 6]
Antwort:
  • velocity – Typ: int, Einheit: 1/100 °/s, Wertebereich: [0 bis 216 - 1], Standardwert: 216 - 1

Gibt die Geschwindigkeit des angegebenen Servos zurück, wie von request/servo_brick/<UID>/set_velocity gesetzt.

request/servo_brick/<UID>/get_current_velocity
Anfrage:
  • servo_num – Typ: int, Wertebereich: [0 bis 6]
Antwort:
  • velocity – Typ: int, 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 request/servo_brick/<UID>/set_velocity abweichen, wenn der Servo gerade sein Geschwindigkeitsziel anfährt.

request/servo_brick/<UID>/set_acceleration
Anfrage:
  • servo_num – Typ: int, Wertebereich: [0 bis 6, 128 bis 255]
  • acceleration – Typ: int, 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).

request/servo_brick/<UID>/get_acceleration
Anfrage:
  • servo_num – Typ: int, Wertebereich: [0 bis 6]
Antwort:
  • acceleration – Typ: int, Einheit: 1/100 °/s², Wertebereich: [0 bis 216 - 1], Standardwert: 216 - 1

Gibt die Beschleunigung des angegebenen Servos zurück, wie von request/servo_brick/<UID>/set_acceleration gesetzt.

request/servo_brick/<UID>/set_output_voltage
Anfrage:
  • voltage – Typ: int, 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

request/servo_brick/<UID>/get_output_voltage
Anfrage:
  • keine Nutzdaten
Antwort:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [2000 bis 9000], Standardwert: 5000

Gibt die Ausgangsspannung zurück, wie von request/servo_brick/<UID>/set_output_voltage gesetzt.

request/servo_brick/<UID>/set_pulse_width
Anfrage:
  • servo_num – Typ: int, Wertebereich: [0 bis 6, 128 bis 255]
  • min – Typ: int, Einheit: 1 µs, Wertebereich: [0 bis 216 - 1], Standardwert: 1000
  • max – Typ: int, 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.

request/servo_brick/<UID>/get_pulse_width
Anfrage:
  • servo_num – Typ: int, Wertebereich: [0 bis 6]
Antwort:
  • min – Typ: int, Einheit: 1 µs, Wertebereich: [0 bis 216 - 1], Standardwert: 1000
  • max – Typ: int, Einheit: 1 µs, Wertebereich: [0 bis 216 - 1], Standardwert: 2000

Gibt die minimale und maximale Pulsweite des angegebenen Servos zurück, wie von request/servo_brick/<UID>/set_pulse_width gesetzt.

request/servo_brick/<UID>/set_degree
Anfrage:
  • servo_num – Typ: int, Wertebereich: [0 bis 6, 128 bis 255]
  • min – Typ: int, Einheit: 1/100 °, Wertebereich: [-215 bis 215 - 1], Standardwert: -9000
  • max – Typ: int, 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 request/servo_brick/<UID>/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 request/servo_brick/<UID>/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. request/servo_brick/<UID>/set_position steuert jetzt die Drehzahl in U/min.

Der minimale Wert muss kleiner als der maximale sein.

request/servo_brick/<UID>/get_degree
Anfrage:
  • servo_num – Typ: int, Wertebereich: [0 bis 6]
Antwort:
  • min – Typ: int, Einheit: 1/100 °, Wertebereich: [-215 bis 215 - 1], Standardwert: -9000
  • max – Typ: int, 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 request/servo_brick/<UID>/set_degree gesetzt.

request/servo_brick/<UID>/set_period
Anfrage:
  • servo_num – Typ: int, Wertebereich: [0 bis 6, 128 bis 255]
  • period – Typ: int, 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.

request/servo_brick/<UID>/get_period
Anfrage:
  • servo_num – Typ: int, Wertebereich: [0 bis 6]
Antwort:
  • period – Typ: int, Einheit: 1 µs, Wertebereich: [0 bis 216 - 1], Standardwert: 19500

Gibt die Periode für den angegebenen Servo zurück, wie von request/servo_brick/<UID>/set_period gesetzt.

request/servo_brick/<UID>/get_servo_current
Anfrage:
  • servo_num – Typ: int, Wertebereich: [0 bis 6]
Antwort:
  • current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

Gibt den Stromverbrauch des angegebenen Servos zurück.

request/servo_brick/<UID>/get_overall_current
Anfrage:
  • keine Nutzdaten
Antwort:
  • current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

Gibt den Stromverbrauch aller Servos zusammen zurück.

request/servo_brick/<UID>/get_stack_input_voltage
Anfrage:
  • keine Nutzdaten
Antwort:
  • voltage – Typ: int, 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.

request/servo_brick/<UID>/get_external_input_voltage
Anfrage:
  • keine Nutzdaten
Antwort:
  • voltage – Typ: int, 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

request/servo_brick/<UID>/set_spitfp_baudrate_config
Anfrage:
  • enable_dynamic_baudrate – Typ: bool, Standardwert: true
  • minimum_dynamic_baudrate – Typ: int, 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 request/servo_brick/<UID>/set_spitfp_baudrate. gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von request/servo_brick/<UID>/set_spitfp_baudrate gesetzt statisch verwendet.

Neu in Version 2.3.4 (Firmware).

request/servo_brick/<UID>/get_spitfp_baudrate_config
Anfrage:
  • keine Nutzdaten
Antwort:
  • enable_dynamic_baudrate – Typ: bool, Standardwert: true
  • minimum_dynamic_baudrate – Typ: int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000

Gibt die Baudratenkonfiguration zurück, siehe request/servo_brick/<UID>/set_spitfp_baudrate_config.

Neu in Version 2.3.4 (Firmware).

request/servo_brick/<UID>/get_send_timeout_count
Anfrage:
  • communication_method – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • timeout_count – Typ: int, 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.

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

Für communication_method:

  • "none" = 0
  • "usb" = 1
  • "spi_stack" = 2
  • "chibi" = 3
  • "rs485" = 4
  • "wifi" = 5
  • "ethernet" = 6
  • "wifi_v2" = 7

Neu in Version 2.3.2 (Firmware).

request/servo_brick/<UID>/set_spitfp_baudrate
Anfrage:
  • bricklet_port – Typ: char, Wertebereich: ["a" bis "b"]
  • baudrate – Typ: int, 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 request/servo_brick/<UID>/get_spitfp_error_count) kann die Baudrate verringert werden.

Wenn das Feature der dynamische Baudrate aktiviert ist, setzt diese Funktion die maximale Baudrate (siehe request/servo_brick/<UID>/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).

request/servo_brick/<UID>/get_spitfp_baudrate
Anfrage:
  • bricklet_port – Typ: char, Wertebereich: ["a" bis "b"]
Antwort:
  • baudrate – Typ: int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000

Gibt die Baudrate für einen Bricklet Port zurück, siehe request/servo_brick/<UID>/set_spitfp_baudrate.

Neu in Version 2.3.2 (Firmware).

request/servo_brick/<UID>/get_spitfp_error_count
Anfrage:
  • bricklet_port – Typ: char, Wertebereich: ["a" bis "b"]
Antwort:
  • error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: int, 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).

request/servo_brick/<UID>/enable_status_led
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).

request/servo_brick/<UID>/disable_status_led
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).

request/servo_brick/<UID>/is_status_led_enabled
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).

request/servo_brick/<UID>/get_chip_temperature
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int, 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.

request/servo_brick/<UID>/reset
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.

request/servo_brick/<UID>/get_identity
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: string, Länge: bis zu 8
  • connected_uid – Typ: string, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ["0" bis "8"]
  • hardware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • firmware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • device_identifier – Typ: int, Wertebereich: [0 bis 216 - 1]
  • _display_name – Typ: string

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. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.

Der Display Name enthält den Anzeigenamen des Servo.

Konfigurationsfunktionen für Callbacks

request/servo_brick/<UID>/set_minimum_voltage
Anfrage:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 5000
Antwort:
  • keine Antwort

Setzt die minimale Spannung, bei welcher der register/servo_brick/<UID>/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.

request/servo_brick/<UID>/get_minimum_voltage
Anfrage:
  • keine Nutzdaten
Antwort:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 5000

Gibt die minimale Spannung zurück, wie von request/servo_brick/<UID>/set_minimum_voltage gesetzt.

request/servo_brick/<UID>/enable_position_reached_callback
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Aktiviert den register/servo_brick/<UID>/position_reached Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

request/servo_brick/<UID>/disable_position_reached_callback
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Deaktiviert den register/servo_brick/<UID>/position_reached Callback.

Neu in Version 2.0.1 (Firmware).

request/servo_brick/<UID>/is_position_reached_callback_enabled
Anfrage:
  • keine Nutzdaten
Antwort:
  • enabled – Typ: bool, Standardwert: false

Gibt true zurück wenn der register/servo_brick/<UID>/position_reached Callback aktiviert ist, false sonst.

Neu in Version 2.0.1 (Firmware).

request/servo_brick/<UID>/enable_velocity_reached_callback
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Aktiviert den register/servo_brick/<UID>/velocity_reached Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

request/servo_brick/<UID>/disable_velocity_reached_callback
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Deaktiviert den register/servo_brick/<UID>/velocity_reached Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

request/servo_brick/<UID>/is_velocity_reached_callback_enabled
Anfrage:
  • keine Nutzdaten
Antwort:
  • enabled – Typ: bool, Standardwert: false

Gibt true zurück wenn der register/servo_brick/<UID>/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 dem entsprechenden .../register/...-Topic und einem optionalen Suffix durchgeführt werden. Mit diesem Suffix kann das Callback später deregistriert werden.

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.

register/servo_brick/<UID>/under_voltage
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/servo_brick/<UID>/under_voltage[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/servo_brick/<UID>/under_voltage[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst, wenn die Eingangsspannung unter den, mittels request/servo_brick/<UID>/set_minimum_voltage gesetzten, Schwellwert sinkt. Der Payload des Callbacks ist die aktuelle Spannung.

register/servo_brick/<UID>/position_reached
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • servo_num – Typ: int, Wertebereich: [0 bis 6]
  • position – Typ: int, Einheit: 1/100 °, Wertebereich: ?

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/servo_brick/<UID>/position_reached[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/servo_brick/<UID>/position_reached[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst, wenn eine konfigurierte Position, wie von request/servo_brick/<UID>/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 Payload-Member des Callbacks sind der Servo und die Position die erreicht wurde.

Dieser Callback kann mit request/servo_brick/<UID>/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 request/servo_brick/<UID>/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.

register/servo_brick/<UID>/velocity_reached
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • servo_num – Typ: int, Wertebereich: [0 bis 6]
  • velocity – Typ: int, Einheit: 1/100 °/s, Wertebereich: [-215 bis 215 - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/servo_brick/<UID>/velocity_reached[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/servo_brick/<UID>/velocity_reached[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Geschwindigkeit, wie von request/servo_brick/<UID>/set_velocity gesetzt, erreicht wird. Die Payload-Member des Callbacks sind der Servo und die Geschwindigkeit die erreicht wurde.

Dieser Callback kann mit request/servo_brick/<UID>/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 request/servo_brick/<UID>/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.

request/servo_brick/<UID>/get_protocol1_bricklet_name
Anfrage:
  • port – Typ: char, Wertebereich: ["a" bis "b"]
Antwort:
  • protocol_version – Typ: int, Wertebereich: [0 bis 255]
  • firmware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • name – Typ: string, Länge: bis zu 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.

request/servo_brick/<UID>/write_bricklet_plugin
Anfrage:
  • port – Typ: char, Wertebereich: ["a" bis "b"]
  • offset – Typ: int, Wertebereich: [0 bis 255]
  • chunk – Typ: [int, ...], Länge: 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.

request/servo_brick/<UID>/read_bricklet_plugin
Anfrage:
  • port – Typ: char, Wertebereich: ["a" bis "b"]
  • offset – Typ: int, Wertebereich: [0 bis 255]
Antwort:
  • chunk – Typ: [int, ...], Länge: 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.