MQTT - Servo Bricklet 2.0

Dies ist die Beschreibung der MQTT API Bindings für das Servo Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Servo Bricklet 2.0 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 XYZ to the UID of your Servo Bricklet 2.0

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

    publish '{"register": true}' to tinkerforge/register/servo_v2_bricklet/XYZ/position_reached # Register position_reached callback

    # Enable position reached callback
    publish '{"servo_channel": 0, "enabled": true}' to tinkerforge/request/servo_v2_bricklet/XYZ/set_position_reached_callback_configuration

    # 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_channel": 0, "velocity": 10000, "acceleration": 500000, "deceleration": 500000}' to tinkerforge/request/servo_v2_bricklet/XYZ/set_motion_configuration

    publish '{"servo_channel": 0, "position": 9000}' to tinkerforge/request/servo_v2_bricklet/XYZ/set_position

    publish '{"servo_channel": 0, "enable": true}' to tinkerforge/request/servo_v2_bricklet/XYZ/set_enable

cleanup:
    # If you are done, run this to clean up
    publish '{"servo_channel": 0, "enable": false}' to tinkerforge/request/servo_v2_bricklet/XYZ/set_enable

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
# Change XYZ to the UID of your Servo Bricklet 2.0

setup:
    # Servo 1: Connected to port 0, period of 19.5ms, pulse width of 1 to 2ms
    #          and operating angle -100 to 100°
    publish '{"servo_channel": 0, "min": -10000, "max": 10000}' to tinkerforge/request/servo_v2_bricklet/XYZ/set_degree

    publish '{"servo_channel": 0, "min": 1000, "max": 2000}' to tinkerforge/request/servo_v2_bricklet/XYZ/set_pulse_width

    publish '{"servo_channel": 0, "period": 19500}' to tinkerforge/request/servo_v2_bricklet/XYZ/set_period

    publish '{"servo_channel": 0, "velocity": 500000, "acceleration": 1000, "deceleration": 1000}' to tinkerforge/request/servo_v2_bricklet/XYZ/set_motion_configuration # Full velocity with slow ac-/deceleration

    # Servo 2: Connected to port 5, period of 20ms, pulse width of 0.95 to 1.95ms
    #          and operating angle -90 to 90°
    publish '{"servo_channel": 5, "min": -9000, "max": 9000}' to tinkerforge/request/servo_v2_bricklet/XYZ/set_degree

    publish '{"servo_channel": 5, "min": 950, "max": 1950}' to tinkerforge/request/servo_v2_bricklet/XYZ/set_pulse_width

    publish '{"servo_channel": 5, "period": 20000}' to tinkerforge/request/servo_v2_bricklet/XYZ/set_period

    publish '{"servo_channel": 5, "velocity": 500000, "acceleration": 500000, "deceleration": 500000}' to tinkerforge/request/servo_v2_bricklet/XYZ/set_motion_configuration # Full velocity with full ac-/deceleration

    publish '{"servo_channel": 0, "position": 10000}' to tinkerforge/request/servo_v2_bricklet/XYZ/set_position # Set to most right position

    publish '{"servo_channel": 0, "enable": true}' to tinkerforge/request/servo_v2_bricklet/XYZ/set_enable

    publish '{"servo_channel": 5, "position": -9000}' to tinkerforge/request/servo_v2_bricklet/XYZ/set_position # Set to most left position

    publish '{"servo_channel": 5, "enable": true}' to tinkerforge/request/servo_v2_bricklet/XYZ/set_enable

cleanup:
    # If you are done, run this to clean up
    publish '{"servo_channel": 0, "enable": false}' to tinkerforge/request/servo_v2_bricklet/XYZ/set_enable

    publish '{"servo_channel": 5, "enable": false}' to tinkerforge/request/servo_v2_bricklet/XYZ/set_enable

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_channel Parameter verwendet, kann einen Servo über die Servo-Kanal (0 bis 9) 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 << 15) adressiert die Servos 1 und 5. 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_v2_bricklet/<UID>/get_status
Anfrage:
  • keine Nutzdaten
Antwort:
  • enabled – Typ: [bool, ...], Länge: 10
  • current_position – Typ: [int, ...], Länge: 10, Einheit: 1/100 °, Wertebereich: ?
  • current_velocity – Typ: [int, ...], Länge: 10, Einheit: 1/100 °/s, Wertebereich: [0 bis 500000]
  • current – Typ: [int, ...], Länge: 10, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]
  • input_voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Gibt die Status-Informationen des Servo Bricklet 2.0 zurück.

Der Status umfasst

  • für jeden Kanal die Information ob dieser gerade aktiviert oder deaktiviert ist,
  • für jeden Kanal die aktuelle Position
  • für jeden Kanal die aktuelle Geschwindigkeit,
  • für jeden Kanal den Stromverbrauch und
  • die Eingangsspannung

Hinweis: Die Position und Geschwindigkeit ist eine Momentaufnahme der aktuellen Position und Geschwindigkeit eines sich in Bewegung befindlichen Servos.

request/servo_v2_bricklet/<UID>/set_enable
Anfrage:
  • servo_channel – Typ: int, Wertebereich: [0 bis 9, 215 bis 33791]
  • enable – Typ: bool, Standardwert: false
Antwort:
  • keine Antwort

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

request/servo_v2_bricklet/<UID>/get_enabled
Anfrage:
  • servo_channel – Typ: int, Wertebereich: [0 bis 9]
Antwort:
  • enable – Typ: bool, Standardwert: false

Gibt zurück ob ein Servo-Kanal aktiviert ist.

request/servo_v2_bricklet/<UID>/set_position
Anfrage:
  • servo_channel – Typ: int, Wertebereich: [0 bis 9, 215 bis 33791]
  • position – Typ: int, Einheit: 1/100 °, Wertebereich: ?
Antwort:
  • keine Antwort

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

Der Standardbereich für die Position ist -9000 bis 9000, aber dies kann, entsprechend dem verwendetem Servo, mit request/servo_v2_bricklet/<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_v2_bricklet/<UID>/set_degree definiert werden.

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

Gibt die Position des angegebenen Servo-Kanals zurück, wie von request/servo_v2_bricklet/<UID>/set_position gesetzt.

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

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

request/servo_v2_bricklet/<UID>/get_current_velocity
Anfrage:
  • servo_channel – Typ: int, Wertebereich: [0 bis 9]
Antwort:
  • velocity – Typ: int, Einheit: 1/100 °/s, Wertebereich: [0 bis 500000]

Gibt die aktuelle Geschwindigkeit des angegebenen Servo-Kanals zurück. Dies kann von der Geschwindigkeit die per request/servo_v2_bricklet/<UID>/set_motion_configuration gesetzt wurde abweichen, wenn der Servo gerade sein Geschwindigkeitsziel anfährt.

request/servo_v2_bricklet/<UID>/set_motion_configuration
Anfrage:
  • servo_channel – Typ: int, Wertebereich: [0 bis 9, 215 bis 33791]
  • velocity – Typ: int, Einheit: 1/100 °/s, Wertebereich: [0 bis 500000], Standardwert: 100000
  • acceleration – Typ: int, Einheit: 1/100 °/s², Wertebereich: [0 bis 500000], Standardwert: 50000
  • deceleration – Typ: int, Einheit: 1/100 °/s², Wertebereich: [0 bis 500000], Standardwert: 50000
Antwort:
  • keine Antwort

Setzt die maximale Geschwindigkeit des angegebenen Servo-Kanals in °/100s sowie die Beschleunigung und Verzögerung in °/100s².

Mit einer Geschwindigkeit von 0 °/100s wird die Position sofort gesetzt (keine Geschwindigkeit).

Mit einer Beschleunigung/Verzögerung von 0 °/100s² wird die Geschwindigkeit sofort gesetzt (keine Beschleunigung/Verzögerung).

request/servo_v2_bricklet/<UID>/get_motion_configuration
Anfrage:
  • servo_channel – Typ: int, Wertebereich: [0 bis 9]
Antwort:
  • velocity – Typ: int, Einheit: 1/100 °/s, Wertebereich: [0 bis 500000], Standardwert: 100000
  • acceleration – Typ: int, Einheit: 1/100 °/s², Wertebereich: [0 bis 500000], Standardwert: 50000
  • deceleration – Typ: int, Einheit: 1/100 °/s², Wertebereich: [0 bis 500000], Standardwert: 50000

Gibt die 'Motion Configuration' zurück, wie von request/servo_v2_bricklet/<UID>/set_motion_configuration gesetzt.

request/servo_v2_bricklet/<UID>/set_pulse_width
Anfrage:
  • servo_channel – Typ: int, Wertebereich: [0 bis 9, 215 bis 33791]
  • min – Typ: int, Einheit: 1 µs, Wertebereich: [0 bis 232 - 1], Standardwert: 1000
  • max – Typ: int, Einheit: 1 µs, Wertebereich: [0 bis 232 - 1], Standardwert: 2000
Antwort:
  • keine Antwort

Setzt die minimale und maximale Pulsweite des angegebenen Servo-Kanals 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.

request/servo_v2_bricklet/<UID>/get_pulse_width
Anfrage:
  • servo_channel – Typ: int, Wertebereich: [0 bis 9]
Antwort:
  • min – Typ: int, Einheit: 1 µs, Wertebereich: [0 bis 232 - 1], Standardwert: 1000
  • max – Typ: int, Einheit: 1 µs, Wertebereich: [0 bis 232 - 1], Standardwert: 2000

Gibt die minimale und maximale Pulsweite des angegebenen Servo-Kanals zurück, wie von request/servo_v2_bricklet/<UID>/set_pulse_width gesetzt.

request/servo_v2_bricklet/<UID>/set_degree
Anfrage:
  • servo_channel – Typ: int, Wertebereich: [0 bis 9, 215 bis 33791]
  • 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 Servo-Kanals (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_v2_bricklet/<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_v2_bricklet/<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_v2_bricklet/<UID>/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.

request/servo_v2_bricklet/<UID>/get_degree
Anfrage:
  • servo_channel – Typ: int, Wertebereich: [0 bis 9]
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-Kanals zurück, wie von request/servo_v2_bricklet/<UID>/set_degree gesetzt.

request/servo_v2_bricklet/<UID>/set_period
Anfrage:
  • servo_channel – Typ: int, Wertebereich: [0 bis 9, 215 bis 33791]
  • period – Typ: int, Einheit: 1 µs, Wertebereich: [1 bis 1000000], Standardwert: 19500
Antwort:
  • keine Antwort

Setzt die Periode des angegebenen Servo-Kanals 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 1000000µs.

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

request/servo_v2_bricklet/<UID>/get_period
Anfrage:
  • servo_channel – Typ: int, Wertebereich: [0 bis 9]
Antwort:
  • period – Typ: int, Einheit: 1 µs, Wertebereich: [1 bis 1000000], Standardwert: 19500

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

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

Gibt den Stromverbrauch des angegebenen Servo-Kanals in mA zurück.

request/servo_v2_bricklet/<UID>/set_servo_current_configuration
Anfrage:
  • servo_channel – Typ: int, Wertebereich: [0 bis 9, 215 bis 33791]
  • averaging_duration – Typ: int, Einheit: 1 ms, Wertebereich: [1 bis 255], Standardwert: 255
Antwort:
  • keine Antwort

Setzt die Durchschnittsberechnungsdauer der Strommessung des angegebenen Servo-Kanals in ms.

request/servo_v2_bricklet/<UID>/get_servo_current_configuration
Anfrage:
  • servo_channel – Typ: int, Wertebereich: [0 bis 9]
Antwort:
  • averaging_duration – Typ: int, Einheit: 1 ms, Wertebereich: [1 bis 255], Standardwert: 255

Gibt die Servo-Stromverbrauchskonfiguration für den angegebenen Servo-Kanal zurück, wie von request/servo_v2_bricklet/<UID>/set_servo_current_configuration gesetzt.

request/servo_v2_bricklet/<UID>/set_input_voltage_configuration
Anfrage:
  • averaging_duration – Typ: int, Einheit: 1 ms, Wertebereich: [1 bis 255], Standardwert: 255
Antwort:
  • keine Antwort

Setzt die Durchschnittsberechnungsdauer der Eingangsspannungsmessung des angegebenen Servo-Kanals in ms.

request/servo_v2_bricklet/<UID>/get_input_voltage_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • averaging_duration – Typ: int, Einheit: 1 ms, Wertebereich: [1 bis 255], Standardwert: 255

Gibt die Servo-Eingangsspannungskonfiguration zurück, wie von request/servo_v2_bricklet/<UID>/set_input_voltage_configuration gesetzt.

request/servo_v2_bricklet/<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 in mA zurück.

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

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

Fortgeschrittene Funktionen

request/servo_v2_bricklet/<UID>/set_current_calibration
Anfrage:
  • offset – Typ: [int, ...], Länge: 10, Einheit: 1 mA, Wertebereich: [-215 bis 215 - 1]
Antwort:
  • keine Antwort

Setzt einen Offset-Wert (in mA) für jeden Kanal.

Hinweis: Im Auslieferungszustand ist das Servo Bricklet 2.0 bereits kalibriert.

request/servo_v2_bricklet/<UID>/get_current_calibration
Anfrage:
  • keine Nutzdaten
Antwort:
  • offset – Typ: [int, ...], Länge: 10, Einheit: 1 mA, Wertebereich: [-215 bis 215 - 1]

Gibt die Stromkalibrierung zurück, wie von request/servo_v2_bricklet/<UID>/set_current_calibration.

request/servo_v2_bricklet/<UID>/get_spitfp_error_count
Anfrage:
  • keine Nutzdaten
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 Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

request/servo_v2_bricklet/<UID>/set_status_led_config
Anfrage:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
Antwort:
  • keine Antwort

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für config:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_status" = 3
request/servo_v2_bricklet/<UID>/get_status_led_config
Anfrage:
  • keine Nutzdaten
Antwort:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von request/servo_v2_bricklet/<UID>/set_status_led_config gesetzt.

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

Für config:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_status" = 3
request/servo_v2_bricklet/<UID>/get_chip_temperature
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int, Einheit: 1 °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 hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

request/servo_v2_bricklet/<UID>/reset
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

request/servo_v2_bricklet/<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: ["a" bis "h", "z"]
  • 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 das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

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

Konfigurationsfunktionen für Callbacks

request/servo_v2_bricklet/<UID>/set_position_reached_callback_configuration
Anfrage:
  • servo_channel – Typ: int, Wertebereich: [0 bis 9, 215 bis 33791]
  • enabled – Typ: bool, Standardwert: false
Antwort:
  • keine Antwort

Aktiviert/Deaktiviert register/servo_v2_bricklet/<UID>/position_reached Callback.

request/servo_v2_bricklet/<UID>/get_position_reached_callback_configuration
Anfrage:
  • servo_channel – Typ: int, Wertebereich: [0 bis 9]
Antwort:
  • enabled – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels request/servo_v2_bricklet/<UID>/set_position_reached_callback_configuration gesetzt.

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_v2_bricklet/<UID>/position_reached
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • servo_channel – Typ: int, Wertebereich: [0 bis 9]
  • position – Typ: int, Einheit: 1/100 °, Wertebereich: ?

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/servo_v2_bricklet/<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_v2_bricklet/<UID>/position_reached[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst, wenn eine konfigurierte Position, wie von request/servo_v2_bricklet/<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_v2_bricklet/<UID>/set_position_reached_callback_configuration 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_v2_bricklet/<UID>/set_motion_configuration) 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.

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_v2_bricklet/<UID>/set_bootloader_mode
Anfrage:
  • mode – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • status – Typ: int, Wertebereich: Siehe Symbole

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

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

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

Für mode:

  • "bootloader" = 0
  • "firmware" = 1
  • "bootloader_wait_for_reboot" = 2
  • "firmware_wait_for_reboot" = 3
  • "firmware_wait_for_erase_and_reboot" = 4

Für status:

  • "ok" = 0
  • "invalid_mode" = 1
  • "no_change" = 2
  • "entry_function_not_present" = 3
  • "device_identifier_incorrect" = 4
  • "crc_mismatch" = 5
request/servo_v2_bricklet/<UID>/get_bootloader_mode
Anfrage:
  • keine Nutzdaten
Antwort:
  • mode – Typ: int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe request/servo_v2_bricklet/<UID>/set_bootloader_mode.

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

Für mode:

  • "bootloader" = 0
  • "firmware" = 1
  • "bootloader_wait_for_reboot" = 2
  • "firmware_wait_for_reboot" = 3
  • "firmware_wait_for_erase_and_reboot" = 4
request/servo_v2_bricklet/<UID>/set_write_firmware_pointer
Anfrage:
  • pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

Setzt den Firmware-Pointer für request/servo_v2_bricklet/<UID>/write_firmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

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

request/servo_v2_bricklet/<UID>/write_firmware
Anfrage:
  • data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Antwort:
  • status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von request/servo_v2_bricklet/<UID>/set_write_firmware_pointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

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

request/servo_v2_bricklet/<UID>/write_uid
Anfrage:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

request/servo_v2_bricklet/<UID>/read_uid
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.