MQTT - DC Brick

Dies ist die Beschreibung der MQTT API Bindings für den DC Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des DC 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).

Configuration

Download (example-configuration.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
# Change XXYYZZ to the UID of your DC Brick

setup:
    publish '{"mode": "drive_coast"}' to tinkerforge/request/dc_brick/XXYYZZ/set_drive_mode 

    publish '{"frequency": 10000}' to tinkerforge/request/dc_brick/XXYYZZ/set_pwm_frequency  # Use PWM frequency of 10kHz

    publish '{"acceleration": 5000}' to tinkerforge/request/dc_brick/XXYYZZ/set_acceleration  # Slow acceleration

    publish '{"velocity": 32767}' to tinkerforge/request/dc_brick/XXYYZZ/set_velocity  # Full speed forward

    publish '' to tinkerforge/request/dc_brick/XXYYZZ/enable  # Enable motor power

cleanup:
    # If you are done, run this to clean up
    publish '' to tinkerforge/request/dc_brick/XXYYZZ/disable  # Disable motor power

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

setup:
    # The acceleration has to be smaller or equal to the maximum
    # acceleration of the DC motor, otherwise the velocity reached
    # callback will be called too early
    publish '{"acceleration": 5000}' to tinkerforge/request/dc_brick/XXYYZZ/set_acceleration  # Slow acceleration
    publish '{"velocity": 32767}' to tinkerforge/request/dc_brick/XXYYZZ/set_velocity  # Full speed forward
    
    # Use velocity reached callback to swing back and forth
    # between full speed forward and full speed backward
    subscribe to tinkerforge/callback/dc_brick/XXYYZZ/velocity_reached
        if a message arrives
            # message contains velocity as int
            if velocity == 32767
                print "Velocity: Full speed forward, now turning backward"
                publish '{"velocity": -32767}' to tinkerforge/request/dc_brick/XXYYZZ/set_velocity
            elseif velocity == -32767
                print "Velocity: Full speed backward, now turning forward"
                publish '{"velocity": 32767}' to tinkerforge/request/dc_brick/XXYYZZ/set_velocity
            else
                print "Error"
            endif
        endif
    endsubscribe
    publish '{"register": true}' to tinkerforge/register/dc_brick/XXYZZ/velocity_reached
    # Enable motor power
    publish '' to tinkerforge/request/dc_brick/XXYYZZ/enable 

cleanup:
    # If you are done, run this to clean up
    publish '' to tinkerforge/request/dc_brick/XXYYZZ/disable  # Disable motor power

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

Grundfunktionen

request/dc_brick/<UID>/set_velocity
Anfrage:
  • velocity – Typ: int, Einheit: 100/32767 %, Wertebereich: [-32767 bis 215 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt die Geschwindigkeit des Motors. Hierbei sind -32767 maximale Geschwindigkeit rückwärts, 0 ist Halt und 32767 maximale Geschwindigkeit vorwärts. In Abhängigkeit von der Beschleunigung (siehe request/dc_brick/<UID>/set_acceleration) wird der Motor nicht direkt auf die Geschwindigkeit gebracht sondern gleichmäßig beschleunigt.

Die Geschwindigkeit beschreibt das Tastverhältnis der PWM für die Motoransteuerung. Z.B. entspricht ein Geschwindigkeitswert von 3277 einer PWM mit einem Tastverhältnis von 10%. Weiterhin kann neben dem Tastverhältnis auch die Frequenz der PWM verändert werden, siehe request/dc_brick/<UID>/set_pwm_frequency.

request/dc_brick/<UID>/get_velocity
Anfrage:
  • keine Nutzdaten
Antwort:
  • velocity – Typ: int, Einheit: 100/32767 %, Wertebereich: [-32767 bis 215 - 1], Standardwert: 0

Gibt die Geschwindigkeit zurück, wie gesetzt von request/dc_brick/<UID>/set_velocity.

request/dc_brick/<UID>/get_current_velocity
Anfrage:
  • keine Nutzdaten
Antwort:
  • velocity – Typ: int, Einheit: 100/32767 %, Wertebereich: [-32767 bis 215 - 1], Standardwert: 0

Gibt die aktuelle Geschwindigkeit des Motors zurück. Dieser Wert unterscheidet sich von request/dc_brick/<UID>/get_velocity, sobald der Motor auf einen neuen Zielwert, wie von request/dc_brick/<UID>/set_velocity vorgegeben, beschleunigt.

request/dc_brick/<UID>/set_acceleration
Anfrage:
  • acceleration – Typ: int, Einheit: 100/32767 %, Wertebereich: [0 bis 216 - 1], Standardwert: 10000
Antwort:
  • keine Antwort

Setzt die Beschleunigung des Motors. Die Einheit dieses Wertes ist Geschwindigkeit/s. Ein Beschleunigungswert von 10000 bedeutet, dass jede Sekunde die Geschwindigkeit um 10000 erhöht wird (entspricht rund 30% Tastverhältnis).

Beispiel: Soll die Geschwindigkeit von 0 auf 16000 (entspricht ungefähr 50% Tastverhältnis) in 10 Sekunden beschleunigt werden, so ist die Beschleunigung auf 1600 einzustellen.

Eine Beschleunigung von 0 bedeutet ein direkter Sprung des Motors auf die Zielgeschwindigkeit. Es Wird keine Beschleunigungsrampe gefahren.

request/dc_brick/<UID>/get_acceleration
Anfrage:
  • keine Nutzdaten
Antwort:
  • acceleration – Typ: int, Einheit: 100/32767 %, Wertebereich: [0 bis 216 - 1], Standardwert: 10000

Gibt die Beschleunigung zurück, wie gesetzt von request/dc_brick/<UID>/set_acceleration.

request/dc_brick/<UID>/full_brake
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Führt eine aktive Vollbremsung aus.

Warnung

Diese Funktion ist für Notsituationen bestimmt, in denen ein unverzüglicher Halt notwendig ist. Abhängig von der aktuellen Geschwindigkeit und der Kraft des Motors kann eine Vollbremsung brachial sein.

Ein Aufruf von request/dc_brick/<UID>/set_velocity mit 0 erlaubt einen normalen Stopp des Motors.

request/dc_brick/<UID>/enable
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Aktiviert die Treiberstufe. Die Treiberparameter können vor der Aktivierung konfiguriert werden (Geschwindigkeit, Beschleunigung, etc.).

request/dc_brick/<UID>/disable
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Deaktiviert die Treiberstufe. Die Konfiguration (Geschwindigkeit, Beschleunigung, etc.) bleibt erhalten aber der Motor wird nicht angesteuert bis eine erneute Aktivierung erfolgt.

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

Gibt true zurück wenn die Treiberstufe aktiv ist, sonst false.

Fortgeschrittene Funktionen

request/dc_brick/<UID>/set_pwm_frequency
Anfrage:
  • frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [1 bis 20000], Standardwert: 15000
Antwort:
  • keine Antwort

Setzt die Frequenz der PWM, welche den Motor steuert. Oftmals ist eine hohe Frequenz geräuschärmer und der Motor läuft dadurch ruhiger. Trotz dessen führt eine geringe Frequenz zu weniger Schaltvorgängen und somit zu weniger Schaltverlusten. Bei einer Vielzahl von Motoren ermöglichen geringere Frequenzen höhere Drehmomente.

Im Allgemeinen kann diese Funktion ignoriert werden, da der Standardwert höchstwahrscheinlich zu einem akzeptablen Ergebnis führt.

request/dc_brick/<UID>/get_pwm_frequency
Anfrage:
  • keine Nutzdaten
Antwort:
  • frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [1 bis 20000], Standardwert: 15000

Gibt die PWM Frequenz zurück, wie gesetzt von request/dc_brick/<UID>/set_pwm_frequency.

request/dc_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 Stapel wird über diesen bereitgestellt und von einer Step-Down oder Step-Up Power Supply erzeugt.

request/dc_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 DC Brick, eingespeist.

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

Warnung

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

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

Gibt die Stromaufnahme des Motors zurück.

request/dc_brick/<UID>/set_drive_mode
Anfrage:
  • mode – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0
Antwort:
  • keine Antwort

Setzt den Fahrmodus. Verfügbare Modi sind:

  • 0 = Fahren/Bremsen
  • 1 = Fahren/Leerlauf

Diese Modi sind verschiedene Arten der Motoransteuerung.

Im Fahren/Bremsen Modus wird der Motor entweder gefahren oder gebremst. Es gibt keinen Leerlauf. Vorteile sind die lineare Korrelation zwischen PWM und Geschwindigkeit, präzisere Beschleunigungen und die Möglichkeit mit geringeren Geschwindigkeiten zu fahren.

Im Fahren/Leerlauf Modus wir der Motor entweder gefahren oder befindet sich im Leerlauf. Vorteile sind die geringere Stromaufnahme und geringere Belastung des Motors und der Treiberstufe.

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

Für mode:

  • "drive_brake" = 0
  • "drive_coast" = 1
request/dc_brick/<UID>/get_drive_mode
Anfrage:
  • keine Nutzdaten
Antwort:
  • mode – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt den Fahrmodus zurück, wie von request/dc_brick/<UID>/set_drive_mode gesetzt.

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

Für mode:

  • "drive_brake" = 0
  • "drive_coast" = 1
request/dc_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/dc_brick/<UID>/set_spitfp_baudrate. gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von request/dc_brick/<UID>/set_spitfp_baudrate gesetzt statisch verwendet.

Neu in Version 2.3.5 (Firmware).

request/dc_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/dc_brick/<UID>/set_spitfp_baudrate_config.

Neu in Version 2.3.5 (Firmware).

request/dc_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.3 (Firmware).

request/dc_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/dc_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/dc_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.3 (Firmware).

request/dc_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/dc_brick/<UID>/set_spitfp_baudrate.

Neu in Version 2.3.3 (Firmware).

request/dc_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.3 (Firmware).

request/dc_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/dc_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/dc_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/dc_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/dc_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/dc_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/dc_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 DC.

Konfigurationsfunktionen für Callbacks

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

Setzt die minimale Spannung, bei welcher der register/dc_brick/<UID>/under_voltage Callback ausgelöst wird. Der kleinste mögliche Wert mit dem der DC Brick noch funktioniert, ist 6V. 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/dc_brick/<UID>/get_minimum_voltage
Anfrage:
  • keine Nutzdaten
Antwort:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 6000

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

request/dc_brick/<UID>/set_current_velocity_period
Anfrage:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt die Periode mit welcher der register/dc_brick/<UID>/current_velocity Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

request/dc_brick/<UID>/get_current_velocity_period
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt die Periode zurück, wie von request/dc_brick/<UID>/set_current_velocity_period 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/dc_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/dc_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/dc_brick/<UID>/under_voltage[/<SUFFIX>]-Topic veröffentlicht.

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

register/dc_brick/<UID>/emergency_shutdown
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • keine Nutzdaten

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

Dieser Callback wird ausgelöst, wenn entweder der Stromverbrauch (über 5A) oder die Temperatur der Treiberstufe zu hoch ist (über 175°C). Beide Möglichkeiten sind letztendlich gleichbedeutend, da die Temperatur ihren Schwellwert überschreitet sobald der Motor zu viel Strom verbraucht. Im Falle einer Spannung unter 3,3V (Stapel- oder externe Spannungsversorgung) wird dieser Callback auch ausgelöst.

Sobald dieser Callback ausgelöst wird, wird die Treiberstufe deaktiviert. Das bedeutet request/dc_brick/<UID>/enable muss aufgerufen werden, um den Motor erneut zu fahren.

Bemerkung

Dieser Callback funktioniert nur im Fahren/Bremsen Modus (siehe request/dc_brick/<UID>/set_drive_mode). Im Fahren/Leerlauf Modus ist es leider nicht möglich das Überstrom/Übertemperatur-Signal zuverlässig aus dem Chip der Treiberstufe auszulesen.

register/dc_brick/<UID>/velocity_reached
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • velocity – Typ: int, Einheit: 100/32767 %, Wertebereich: [-32767 bis 215 - 1]

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

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Geschwindigkeit erreicht wird. Beispiel: Wenn die aktuelle Geschwindigkeit 0 ist, die Beschleunigung auf 5000 und die Geschwindigkeit auf 10000 konfiguriert ist, wird der register/dc_brick/<UID>/velocity_reached Callback nach ungefähr 2 Sekunden ausgelöst, wenn die konfigurierte Geschwindigkeit letztendlich erreicht ist.

Bemerkung

Da es nicht möglich ist eine Rückmeldung vom Gleichstrommotor zu erhalten, funktioniert dies nur wenn die konfigurierte Beschleunigung (siehe request/dc_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.

register/dc_brick/<UID>/current_velocity
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • velocity – Typ: int, Einheit: 100/32767 %, Wertebereich: [-32767 bis 215 - 1]

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

Dieser Callback wird mit der Periode, wie gesetzt mit request/dc_brick/<UID>/set_current_velocity_period, ausgelöst. Der Payload des Callbacks ist die aktuelle vom Motor genutzte Geschwindigkeit.

Der register/dc_brick/<UID>/current_velocity Callback wird nur nach Ablauf der Periode ausgelöst, wenn sich die Geschwindigkeit geändert hat.