MQTT - Stepper Brick

Dies ist die Beschreibung der MQTT API Bindings für den Stepper Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Stepper 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
17
18
19
20
21
22
23
24
25
26
27
# Change XXYYZZ to the UID of your Stepper Brick

setup:
    publish '{"current": 800}' to tinkerforge/request/stepper_brick/XXYYZZ/set_motor_current # 800 mA

    publish '{"mode": "eighth_step"}' to tinkerforge/request/stepper_brick/XXYYZZ/set_step_mode # 1/8 step mode

    publish '{"velocity": 2000}' to tinkerforge/request/stepper_brick/XXYYZZ/set_max_velocity # Velocity 2000 steps/s

    # Slow acceleration (500 steps/s^2),
    # Fast deacceleration (5000 steps/s^2)
    publish '{"acceleration": 500, "deacceleration": 5000}' to tinkerforge/request/stepper_brick/XXYYZZ/set_speed_ramping

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

    publish '{"steps": 60000}' to tinkerforge/request/stepper_brick/XXYYZZ/set_steps # Drive 60000 steps forward

cleanup:
    # If you are done, run this to clean up
    # Stop motor before disabling motor power
    publish '' to tinkerforge/request/stepper_brick/XXYYZZ/stop # Request motor stop

    publish '{"acceleration": 500, "deacceleration": 5000}' to tinkerforge/request/stepper_brick/XXYYZZ/set_speed_ramping # Fast deacceleration (5000 steps/s^2) for stopping

    wait for 0.4s # Wait for motor to actually stop: max velocity (2000 steps/s) / decceleration (5000 steps/s^2) = 0.4 s

    publish '' to tinkerforge/request/stepper_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
33
34
35
36
37
38
39
40
41
42
# Change XXYYZZ to the UID of your Stepper Brick

setup:
    # Use position reached callback to program random movement
    subscribe to tinkerforge/callback/stepper_brick/XXYYZZ/position_reached
        if a message arives
            # message contains the current position as int
            generate random numbers r,
                                    steps [1000;5000],
                                    vel [200; 2000],
                                    acc [100; 1000] and
                                    dec [100; 1000]

            if r is even
                # Driving forward
            else
                # Driving backward
                set steps to -steps
            endif

            publish '{"acceleration": acc, "deceleration": dec}' to tinkerforge/request/stepper_brick/XXYYZZ/set_speed_ramping
            publish '{"velocity": vel}' to tinkerforge/request/stepper_brick/XXYYZZ/set_max_velocity
            publish '{"steps": steps}' to tinkerforge/request/stepper_brick/XXYYZZ/set_steps
        endif
    endsubscribe

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

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

    publish '{"steps": 1}' to tinkerforge/request/stepper_brick/XXYYZZ/set_steps # Drive one step forward to get things going

cleanup:
    # If you are done, run this to clean up
    # Stop motor before disabling motor power
    publish '' to tinkerforge/request/stepper_brick/XXYYZZ/stop # Request motor stop

    publish '{"acceleration": 500, "deacceleration": 5000}' to tinkerforge/request/stepper_brick/XXYYZZ/set_speed_ramping # Fast deacceleration (5000 steps/s^2) for stopping

    wait for 0.4s # Wait for motor to actually stop: max velocity (2000 steps/s) / decceleration (5000 steps/s^2) = 0.4 s

    publish '' to tinkerforge/request/stepper_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/stepper_brick/<UID>/set_max_velocity
Anfrage:
  • velocity – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]
Antwort:
  • keine Antwort

Setzt die maximale Geschwindigkeit des Schrittmotors. Diese Funktion startet nicht den Motor, sondern setzt nur die maximale Geschwindigkeit auf welche der Schrittmotor beschleunigt wird. Um den Motor zu fahren können request/stepper_brick/<UID>/set_target_position, request/stepper_brick/<UID>/set_steps, request/stepper_brick/<UID>/drive_forward oder request/stepper_brick/<UID>/drive_backward verwendet werden.

request/stepper_brick/<UID>/get_max_velocity
Anfrage:
  • keine Nutzdaten
Antwort:
  • velocity – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]

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

request/stepper_brick/<UID>/get_current_velocity
Anfrage:
  • keine Nutzdaten
Antwort:
  • velocity – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]

Gibt die aktuelle Geschwindigkeit des Schrittmotors zurück.

request/stepper_brick/<UID>/set_speed_ramping
Anfrage:
  • acceleration – Typ: int, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000
  • deacceleration – Typ: int, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000
Antwort:
  • keine Antwort

Setzt die Beschleunigung und die Verzögerung des Schrittmotors. Eine Beschleunigung von 1000 bedeutet, dass jede Sekunde die Geschwindigkeit um 1000 Schritte/s erhöht wird.

Beispiel: Wenn die aktuelle Geschwindigkeit 0 ist und es soll auf eine Geschwindigkeit von 8000 Schritten/s in 10 Sekunden beschleunigt werden, muss die Beschleunigung auf 800 Schritte/s² gesetzt werden.

Eine Beschleunigung/Verzögerung von 0 bedeutet ein sprunghaftes Beschleunigen/Verzögern (nicht empfohlen).

request/stepper_brick/<UID>/get_speed_ramping
Anfrage:
  • keine Nutzdaten
Antwort:
  • acceleration – Typ: int, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000
  • deacceleration – Typ: int, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000

Gibt die Beschleunigung und Verzögerung zurück, wie von request/stepper_brick/<UID>/set_speed_ramping gesetzt.

request/stepper_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/stepper_brick/<UID>/stop stoppt den Motor.

request/stepper_brick/<UID>/set_steps
Anfrage:
  • steps – Typ: int, Wertebereich: [-231 bis 231 - 1]
Antwort:
  • keine Antwort

Setzt die Anzahl der Schritte die der Schrittmotor fahren soll. Positive Werte fahren den Motor vorwärts und negative rückwärts. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit request/stepper_brick/<UID>/set_max_velocity und request/stepper_brick/<UID>/set_speed_ramping gesetzt, verwendet.

request/stepper_brick/<UID>/get_steps
Anfrage:
  • keine Nutzdaten
Antwort:
  • steps – Typ: int, Wertebereich: [-231 bis 231 - 1]

Gibt die letzten Schritte zurück, wie von request/stepper_brick/<UID>/set_steps gesetzt.

request/stepper_brick/<UID>/get_remaining_steps
Anfrage:
  • keine Nutzdaten
Antwort:
  • steps – Typ: int, Wertebereich: [-231 bis 231 - 1]

Gibt die verbleibenden Schritte des letzten Aufrufs von request/stepper_brick/<UID>/set_steps zurück. Beispiel: Wenn request/stepper_brick/<UID>/set_steps mit 2000 aufgerufen wird und request/stepper_brick/<UID>/get_remaining_steps aufgerufen wird wenn der Motor 500 Schritte fahren hat, wird 1500 zurückgegeben.

request/stepper_brick/<UID>/drive_forward
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Fährt den Schrittmotor vorwärts bis request/stepper_brick/<UID>/drive_backward oder request/stepper_brick/<UID>/stop aufgerufen wird. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit request/stepper_brick/<UID>/set_max_velocity und request/stepper_brick/<UID>/set_speed_ramping gesetzt, verwendet.

request/stepper_brick/<UID>/drive_backward
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Fährt den Schrittmotor rückwärts bis request/stepper_brick/<UID>/drive_forward oder request/stepper_brick/<UID>/stop aufgerufen wird. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit request/stepper_brick/<UID>/set_max_velocity und request/stepper_brick/<UID>/set_speed_ramping gesetzt, verwendet.

request/stepper_brick/<UID>/stop
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Stoppt den Schrittmotor mit der Verzögerung, wie von request/stepper_brick/<UID>/set_speed_ramping gesetzt.

request/stepper_brick/<UID>/set_motor_current
Anfrage:
  • current – Typ: int, Einheit: 1 mA, Wertebereich: [100 bis 2291], Standardwert: 800
Antwort:
  • keine Antwort

Setzt den Strom mit welchem der Motor angetrieben wird.

Warnung

Dieser Wert sollte nicht über die Spezifikation des Schrittmotors gesetzt werden. Sonst ist eine Beschädigung des Motors möglich.

request/stepper_brick/<UID>/get_motor_current
Anfrage:
  • keine Nutzdaten
Antwort:
  • current – Typ: int, Einheit: 1 mA, Wertebereich: [100 bis 2291], Standardwert: 800

Gibt den Strom zurück, wie von request/stepper_brick/<UID>/set_motor_current gesetzt.

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

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

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

Warnung

Die Treiberstufe zu deaktivieren während der Motor sich noch dreht kann zur Beschädigung der Treiberstufe führen. Der Motor sollte durch Aufrufen der request/stepper_brick/<UID>/stop Funktion gestoppt werden, bevor die Treiberstufe deaktiviert wird. Die request/stepper_brick/<UID>/stop Funktion wartet nicht bis der Motor wirklich zum Stillstand gekommen ist. Dazu muss nach dem Aufruf der request/stepper_brick/<UID>/stop Funktion eine angemessen Zeit gewartet werden bevor die request/stepper_brick/<UID>/disable Funktion aufgerufen wird.

request/stepper_brick/<UID>/is_enabled
Anfrage:
  • keine Nutzdaten
Antwort:
  • enabled – Typ: bool

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

Fortgeschrittene Funktionen

request/stepper_brick/<UID>/set_current_position
Anfrage:
  • position – Typ: int, Wertebereich: [-231 bis 231 - 1]
Antwort:
  • keine Antwort

Setzt den aktuellen Schrittwert des internen Schrittzählers. Dies kann benutzt werden um die aktuelle Position auf 0 zu setzen wenn ein definierter Startpunkt erreicht wurde (z.B. wenn eine CNC Maschine eine Ecke erreicht).

request/stepper_brick/<UID>/get_current_position
Anfrage:
  • keine Nutzdaten
Antwort:
  • position – Typ: int, Wertebereich: [-231 bis 231 - 1]

Gibt die aktuelle Position des Schrittmotors in Schritten zurück. Nach dem Hochfahren ist die Position 0. Die Schritte werden bei Verwendung aller möglichen Fahrfunktionen gezählt (request/stepper_brick/<UID>/set_target_position, request/stepper_brick/<UID>/set_steps, request/stepper_brick/<UID>/drive_forward der request/stepper_brick/<UID>/drive_backward). Es ist auch möglich den Schrittzähler auf 0 oder jeden anderen gewünschten Wert zu setzen mit request/stepper_brick/<UID>/set_current_position.

request/stepper_brick/<UID>/set_target_position
Anfrage:
  • position – Typ: int, Wertebereich: [-231 bis 231 - 1]
Antwort:
  • keine Antwort

Setzt die Zielposition des Schrittmotors in Schritten. Beispiel: Wenn die aktuelle Position des Motors 500 ist und request/stepper_brick/<UID>/set_target_position mit 1000 aufgerufen wird, dann verfährt der Schrittmotor 500 Schritte vorwärts. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit request/stepper_brick/<UID>/set_max_velocity und request/stepper_brick/<UID>/set_speed_ramping gesetzt, verwendet.

Ein Aufruf von request/stepper_brick/<UID>/set_target_position mit dem Parameter x ist äquivalent mit einem Aufruf von request/stepper_brick/<UID>/set_steps mit dem Parameter (x - request/stepper_brick/<UID>/get_current_position).

request/stepper_brick/<UID>/get_target_position
Anfrage:
  • keine Nutzdaten
Antwort:
  • position – Typ: int, Wertebereich: [-231 bis 231 - 1]

Gibt die letzte Zielposition zurück, wie von request/stepper_brick/<UID>/set_target_position gesetzt.

request/stepper_brick/<UID>/set_step_mode
Anfrage:
  • mode – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 8
Antwort:
  • keine Antwort

Setzt den Schrittmodus des Schrittmotors. Mögliche Werte sind:

  • Vollschritt = 1
  • Halbschritt = 2
  • Viertelschritt = 4
  • Achtelschritt = 8

Ein höherer Wert erhöht die Auflösung und verringert das Drehmoment des Schrittmotors.

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

Für mode:

  • "full_step" = 1
  • "half_step" = 2
  • "quarter_step" = 4
  • "eighth_step" = 8
request/stepper_brick/<UID>/get_step_mode
Anfrage:
  • keine Nutzdaten
Antwort:
  • mode – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 8

Gibt den Schrittmodus zurück, wie von request/stepper_brick/<UID>/set_step_mode gesetzt.

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

Für mode:

  • "full_step" = 1
  • "half_step" = 2
  • "quarter_step" = 4
  • "eighth_step" = 8
request/stepper_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/stepper_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 Stepper 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/stepper_brick/<UID>/get_current_consumption
Anfrage:
  • keine Nutzdaten
Antwort:
  • current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

Gibt die Stromaufnahme des Motors zurück.

request/stepper_brick/<UID>/set_decay
Anfrage:
  • decay – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 10000
Antwort:
  • keine Antwort

Setzt den Decay Modus (Abklingmodus) des Schrittmotors. Ein Wert von 0 setzt den Fast Decay Modus (schneller Stromabbau), ein Wert von 65535 den Slow Decay Modus (langsamer Stromabbau) ein Wert dazwischen den Mixed Decay Modus (Nutzung beider Modi).

Eine Änderung des Decay Modus ist nur möglich wenn die Synchrongleichrichtung aktiviert ist (siehe request/stepper_brick/<UID>/set_sync_rect).

Für eine gute Erläuterung der verschiedenen Decay Modi siehe diesen Blogeintrag (Englisch) von Avayan oder diesen Blogeintrag (Deutsch) von T. Ostermann.

Ein guter Decay Modus ist leider unterschiedlich für jeden Motor. Der beste Weg einen guten Decay Modus für den jeweiligen Schrittmotor zu finden, wenn der Strom nicht mit einem Oszilloskop gemessen werden kann, ist auf die Geräusche des Motors zu hören. Wenn der Wert zu gering ist, ist oftmals ein hoher Ton zu hören und wenn er zu hoch ist, oftmals ein brummendes Geräusch.

Im Allgemeinen ist der Fast Decay Modus (kleine Werte) geräuschvoller, erlaubt aber höhere Motorgeschwindigkeiten.

Bemerkung

Es existiert leider keine Formel zur Berechnung des optimalen Decay Modus eines Schrittmotors. Sollten Probleme mit lauten Geräuschen oder einer zu geringen maximalen Motorgeschwindigkeit bestehen, bleibt nur Ausprobieren um einen besseren Decay Modus zu finden.

request/stepper_brick/<UID>/get_decay
Anfrage:
  • keine Nutzdaten
Antwort:
  • decay – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 10000

Gibt den Decay Modus zurück, wie von request/stepper_brick/<UID>/set_decay gesetzt.

request/stepper_brick/<UID>/set_sync_rect
Anfrage:
  • sync_rect – Typ: bool, Standardwert: false
Antwort:
  • keine Antwort

Aktiviert oder deaktiviert (true oder false) die Synchrongleichrichtung.

Bei aktiver Synchrongleichrichtung kann der Decay Modus geändert werden (Siehe request/stepper_brick/<UID>/set_decay). Ohne Synchrongleichrichtung wird der Fast Decay Modus verwendet.

Für eine Erläuterung der Synchrongleichrichtung siehe hier.

Warnung

Wenn hohe Geschwindigkeiten (> 10000 Schritte/s) mit einem großen Schrittmotor mit einer hohen Induktivität genutzt werden sollen, wird dringend geraten die Synchrongleichrichtung zu deaktivieren. Sonst kann es vorkommen, dass der Brick die Last nicht bewältigen kann und überhitzt.

request/stepper_brick/<UID>/is_sync_rect
Anfrage:
  • keine Nutzdaten
Antwort:
  • sync_rect – Typ: bool, Standardwert: false

Gibt zurück ob die Synchrongleichrichtung aktiviert ist.

request/stepper_brick/<UID>/set_time_base
Anfrage:
  • time_base – Typ: int, Einheit: 1 s, Wertebereich: [0 bis 232 - 1], Standardwert: 1
Antwort:
  • keine Antwort

Setzt die Zeitbasis der Geschwindigkeit und Beschleunigung des Stepper Brick.

Beispiel: Wenn aller 1,5 Sekunden ein Schritt gefahren werden soll, kann die Zeitbasis auf 15 und die Geschwindigkeit auf 10 gesetzt werden. Damit ist die Geschwindigkeit 10Schritte/15s = 1Schritt/1,5s.

request/stepper_brick/<UID>/get_time_base
Anfrage:
  • keine Nutzdaten
Antwort:
  • time_base – Typ: int, Einheit: 1 s, Wertebereich: [0 bis 232 - 1], Standardwert: 1

Gibt die Zeitbasis zurück, wie von request/stepper_brick/<UID>/set_time_base gesetzt.

request/stepper_brick/<UID>/get_all_data
Anfrage:
  • keine Nutzdaten
Antwort:
  • current_velocity – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]
  • current_position – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • remaining_steps – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • stack_voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
  • external_voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
  • current_consumption – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

Gibt die folgenden Parameter zurück: Die aktuelle Geschwindigkeit, die aktuelle Position, die verbleibenden Schritte, die Spannung des Stapels, die externe Spannung und der aktuelle Stromverbrauch des Schrittmotors.

Es existiert auch ein Callback für diese Funktion, siehe register/stepper_brick/<UID>/all_data Callback.

request/stepper_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/stepper_brick/<UID>/set_spitfp_baudrate. gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von request/stepper_brick/<UID>/set_spitfp_baudrate gesetzt statisch verwendet.

Neu in Version 2.3.6 (Firmware).

request/stepper_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/stepper_brick/<UID>/set_spitfp_baudrate_config.

Neu in Version 2.3.6 (Firmware).

request/stepper_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.4 (Firmware).

request/stepper_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/stepper_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/stepper_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/stepper_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/stepper_brick/<UID>/set_spitfp_baudrate.

Neu in Version 2.3.3 (Firmware).

request/stepper_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/stepper_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/stepper_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/stepper_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/stepper_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/stepper_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/stepper_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 Stepper.

Konfigurationsfunktionen für Callbacks

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

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

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

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

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

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

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

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

register/stepper_brick/<UID>/position_reached
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • position – Typ: int, Wertebereich: [-231 bis 231 - 1]

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

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Position, wie von request/stepper_brick/<UID>/set_steps oder request/stepper_brick/<UID>/set_target_position gesetzt, erreicht wird.

Bemerkung

Da es nicht möglich ist eine Rückmeldung vom Schrittmotor zu erhalten, funktioniert dies nur wenn die konfigurierte Beschleunigung (siehe request/stepper_brick/<UID>/set_speed_ramping) 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/stepper_brick/<UID>/all_data
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • current_velocity – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]
  • current_position – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • remaining_steps – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • stack_voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
  • external_voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
  • current_consumption – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

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

Dieser Callback wird mit der Periode, wie gesetzt mit request/stepper_brick/<UID>/set_all_data_period, ausgelöst. Die Payload-Member des Callbacks sind die aktuelle Geschwindigkeit, die aktuelle Position, die verbleibenden Schritte, die Spannung des Stapels, die externe Spannung und der aktuelle Stromverbrauch des Schrittmotors.

register/stepper_brick/<UID>/new_state
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • state_new – Typ: int, Wertebereich: Siehe Symbole
  • state_previous – Typ: int, Wertebereich: Siehe Symbole

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

Dieser Callback wird immer dann ausgelöst, wenn der Stepper Brick einen neuen Zustand erreicht. Es wird sowohl der neue wie auch der alte Zustand zurückgegeben.

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

Für state_new:

  • "stop" = 1
  • "acceleration" = 2
  • "run" = 3
  • "deacceleration" = 4
  • "direction_change_to_forward" = 5
  • "direction_change_to_backward" = 6

Für state_previous:

  • "stop" = 1
  • "acceleration" = 2
  • "run" = 3
  • "deacceleration" = 4
  • "direction_change_to_forward" = 5
  • "direction_change_to_backward" = 6

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