Modbus - Stepper Brick

Dies ist die Beschreibung des Modbus Protokolls für den Stepper Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Stepper Brick sind in dessen Hardware Beschreibung zusammengefasst.

API

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen

BrickStepper.set_max_velocity
Funktions ID:

1

Anfrage:
  • velocity -- uint16
Antwort:

keine Antwort

Setzt die maximale Geschwindigkeit des Schrittmotors in Schritten je Sekunde. 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 set_target_position, set_steps, drive_forward oder drive_backward verwendet werden.

BrickStepper.get_max_velocity
Funktions ID:

2

Anfrage:

keine Nutzdaten

Antwort:
  • velocity -- uint16

Gibt die Geschwindigkeit zurück, wie von set_max_velocity gesetzt.

BrickStepper.get_current_velocity
Funktions ID:

3

Anfrage:

keine Nutzdaten

Antwort:
  • velocity -- uint16

Gibt die aktuelle Geschwindigkeit des Schrittmotors in Schritten je Sekunde zurück.

BrickStepper.set_speed_ramping
Funktions ID:

4

Anfrage:
  • acceleration -- uint16
  • deacceleration -- uint16
Antwort:

keine Antwort

Setzt die Beschleunigung und die Verzögerung des Schrittmotors. Die Werte müssen in Schritten/s² angegeben werden. 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).

Der Standardwert ist 1000 für beide Parameter.

BrickStepper.get_speed_ramping
Funktions ID:

5

Anfrage:

keine Nutzdaten

Antwort:
  • acceleration -- uint16
  • deacceleration -- uint16

Gibt die Beschleunigung und Verzögerung zurück, wie von set_speed_ramping gesetzt.

BrickStepper.full_brake
Funktions ID:6
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 stop stoppt den Motor.

BrickStepper.set_steps
Funktions ID:

11

Anfrage:
  • steps -- int32
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 set_max_velocity und set_speed_ramping gesetzt, verwendet.

BrickStepper.get_steps
Funktions ID:

12

Anfrage:

keine Nutzdaten

Antwort:
  • steps -- int32

Gibt die letzten Schritte zurück, wie von set_steps gesetzt.

BrickStepper.get_remaining_steps
Funktions ID:

13

Anfrage:

keine Nutzdaten

Antwort:
  • steps -- int32

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

BrickStepper.drive_forward
Funktions ID:16
Anfrage:keine Nutzdaten
Antwort:keine Antwort

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

BrickStepper.drive_backward
Funktions ID:17
Anfrage:keine Nutzdaten
Antwort:keine Antwort

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

BrickStepper.stop
Funktions ID:18
Anfrage:keine Nutzdaten
Antwort:keine Antwort

Stoppt den Schrittmotor mit der Verzögerung, wie von set_speed_ramping gesetzt.

BrickStepper.set_motor_current
Funktions ID:

22

Anfrage:
  • current -- uint16
Antwort:

keine Antwort

Setzt den Strom in mA mit welchem der Motor angetrieben wird. Der minimale Wert ist 100mA, der maximale Wert ist 2291mA und der Standardwert ist 800mA.

Warnung

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

BrickStepper.get_motor_current
Funktions ID:

23

Anfrage:

keine Nutzdaten

Antwort:
  • current -- uint16

Gibt den Strom zurück, wie von set_motor_current gesetzt.

BrickStepper.enable
Funktions ID:24
Anfrage:keine Nutzdaten
Antwort:keine Antwort

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

BrickStepper.disable
Funktions ID:25
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.

BrickStepper.is_enabled
Funktions ID:

26

Anfrage:

keine Nutzdaten

Antwort:
  • enabled -- bool

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

Fortgeschrittene Funktionen

BrickStepper.set_current_position
Funktions ID:

7

Anfrage:
  • position -- int32
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).

BrickStepper.get_current_position
Funktions ID:

8

Anfrage:

keine Nutzdaten

Antwort:
  • position -- int32

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 (set_target_position, set_steps, drive_forward der drive_backward). Es ist auch möglich den Schrittzähler auf 0 oder jeden anderen gewünschten Wert zu setzen mit set_current_position.

BrickStepper.set_target_position
Funktions ID:

9

Anfrage:
  • position -- int32
Antwort:

keine Antwort

Setzt die Zielposition des Schrittmotors in Schritten. Beispiel: Wenn die aktuelle Position des Motors 500 ist und 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 set_max_velocity und set_speed_ramping gesetzt, verwendet.

Ein Aufruf von set_target_position mit dem Parameter x ist äquivalent mit einem Aufruf von set_steps mit dem Parameter (x - get_current_position).

BrickStepper.get_target_position
Funktions ID:

10

Anfrage:

keine Nutzdaten

Antwort:
  • position -- int32

Gibt die letzte Zielposition zurück, wie von set_target_position gesetzt.

BrickStepper.set_step_mode
Funktions ID:

14

Anfrage:
  • mode -- uint8
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.

Der Standardwert ist 8 (Achtelschritt).

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 1: full step, für mode
  • 2: half step, für mode
  • 4: quarter step, für mode
  • 8: eighth step, für mode
BrickStepper.get_step_mode
Funktions ID:

15

Anfrage:

keine Nutzdaten

Antwort:
  • mode -- uint8

Gibt den Schrittmodus zurück, wie von set_step_mode gesetzt.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 1: full step, für mode
  • 2: half step, für mode
  • 4: quarter step, für mode
  • 8: eighth step, für mode
BrickStepper.get_stack_input_voltage
Funktions ID:

19

Anfrage:

keine Nutzdaten

Antwort:
  • voltage -- uint16

Gibt die Eingangsspannung (in mV) des Stapels zurück. Die Eingangsspannung des Stapel wird über diesen bereitgestellt und von einer Step-Down oder Step-Up Power Supply erzeugt.

BrickStepper.get_external_input_voltage
Funktions ID:

20

Anfrage:

keine Nutzdaten

Antwort:
  • voltage -- uint16

Gibt die externe Eingangsspannung (in mV) 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.

BrickStepper.get_current_consumption
Funktions ID:

21

Anfrage:

keine Nutzdaten

Antwort:
  • current -- uint16

Gibt die Stromaufnahme des Motors zurück (in mA).

BrickStepper.set_decay
Funktions ID:

27

Anfrage:
  • decay -- uint16
Antwort:

keine Antwort

Setzt den Decay Modus (Abklingmodus) des Schrittmotors. Der mögliche Wertebereich ist 0 bis 65535. 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 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.

Der Standardwert ist 10000.

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.

BrickStepper.get_decay
Funktions ID:

28

Anfrage:

keine Nutzdaten

Antwort:
  • decay -- uint16

Gibt den Decay Modus zurück, wie von set_decay gesetzt.

BrickStepper.set_sync_rect
Funktions ID:

33

Anfrage:
  • sync_rect -- bool
Antwort:

keine Antwort

Aktiviert oder deaktiviert (true oder false) die Synchrongleichrichtung.

Bei aktiver Synchrongleichrichtung kann der Decay Modus geändert werden (Siehe 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.

Der Standardwert ist false.

BrickStepper.is_sync_rect
Funktions ID:

34

Anfrage:

keine Nutzdaten

Antwort:
  • sync_rect -- bool

Gibt zurück ob die Synchrongleichrichtung aktiviert ist.

BrickStepper.set_time_base
Funktions ID:

35

Anfrage:
  • time_base -- uint32
Antwort:

keine Antwort

Setzt die Zeitbasis der Geschwindigkeit und Beschleunigung des Stepper Brick (in Sekunden).

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.

Der Standardwert ist 1.

BrickStepper.get_time_base
Funktions ID:

36

Anfrage:

keine Nutzdaten

Antwort:
  • time_base -- uint32

Gibt die Zeitbasis zurück, wie von set_time_base gesetzt.

BrickStepper.get_all_data
Funktions ID:

37

Anfrage:

keine Nutzdaten

Antwort:
  • current_velocity -- uint16
  • current_position -- int32
  • remaining_steps -- int32
  • stack_voltage -- uint16
  • external_voltage -- uint16
  • current_consumption -- uint16

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 CALLBACK_ALL_DATA Callback.

BrickStepper.set_spitfp_baudrate_config
Funktions ID:

231

Anfrage:
  • enable_dynamic_baudrate -- bool
  • minimum_dynamic_baudrate -- uint32
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 set_spitfp_baudrate. gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von set_spitfp_baudrate gesetzt statisch verwendet.

Die minimale dynamische Baudrate hat einen Wertebereich von 400000 bis 2000000 Baud.

Standardmäßig ist die dynamische Baudrate aktiviert und die minimale dynamische Baudrate ist 400000.

Neu in Version 2.3.6 (Firmware).

BrickStepper.get_spitfp_baudrate_config
Funktions ID:

232

Anfrage:

keine Nutzdaten

Antwort:
  • enable_dynamic_baudrate -- bool
  • minimum_dynamic_baudrate -- uint32

Gibt die Baudratenkonfiguration zurück, siehe set_spitfp_baudrate_config.

Neu in Version 2.3.6 (Firmware).

BrickStepper.get_send_timeout_count
Funktions ID:

233

Anfrage:
  • communication_method -- uint8
Antwort:
  • timeout_count -- uint32

Gibt den Timeout-Zähler für die verschiedenen Kommunikationsmöglichkeiten zurück

Die Kommunikationsmöglichkeiten 0-2 stehen auf allen Bricks zur verfügung, 3-7 nur auf Master Bricks.

Diese Funktion ist hauptsächlich zum debuggen während der Entwicklung gedacht. Im normalen Betrieb sollten alle Zähler fast immer auf 0 stehen bleiben.

Neu in Version 2.3.4 (Firmware).

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: none, für communication_method
  • 1: usb, für communication_method
  • 2: spi stack, für communication_method
  • 3: chibi, für communication_method
  • 4: rs485, für communication_method
  • 5: wifi, für communication_method
  • 6: ethernet, für communication_method
  • 7: wifi v2, für communication_method
BrickStepper.set_spitfp_baudrate
Funktions ID:

234

Anfrage:
  • bricklet_port -- char
  • baudrate -- uint32
Antwort:

keine Antwort

Setzt die Baudrate eines spezifischen Bricklet Ports ('a' - 'd'). Die Baudrate hat einen möglichen Wertebereich von 400000 bis 2000000.

Für einen höheren Durchsatz der Bricklets kann die Baudrate erhöht werden. Wenn der Fehlerzähler auf Grund von lokaler Störeinstrahlung hoch ist (siehe get_spitfp_error_count) kann die Baudrate verringert werden.

Wenn das Feature der dynamische Baudrate aktiviert ist, setzt diese Funktion die maximale Baudrate (siehe set_spitfp_baudrate_config).

EMV Tests werden mit der Standardbaudrate durchgeführt. Falls eine CE-Kompatibilität o.ä. in der Anwendung notwendig ist empfehlen wir die Baudrate nicht zu ändern.

Die Standardbaudrate für alle Ports ist 1400000.

Neu in Version 2.3.3 (Firmware).

BrickStepper.get_spitfp_baudrate
Funktions ID:

235

Anfrage:
  • bricklet_port -- char
Antwort:
  • baudrate -- uint32

Gibt die Baudrate für einen Bricklet Port zurück, siehe set_spitfp_baudrate.

Neu in Version 2.3.3 (Firmware).

BrickStepper.get_spitfp_error_count
Funktions ID:

237

Anfrage:
  • bricklet_port -- char
Antwort:
  • error_count_ack_checksum -- uint32
  • error_count_message_checksum -- uint32
  • error_count_frame -- uint32
  • error_count_overflow -- uint32

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

BrickStepper.enable_status_led
Funktions ID:238
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).

BrickStepper.disable_status_led
Funktions ID:239
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).

BrickStepper.is_status_led_enabled
Funktions ID:

240

Anfrage:

keine Nutzdaten

Antwort:
  • enabled -- bool

Gibt true zurück wenn die Status LED aktiviert ist, false sonst.

Neu in Version 2.3.1 (Firmware).

BrickStepper.get_protocol1_bricklet_name
Funktions ID:

241

Anfrage:
  • port -- char
Antwort:
  • protocol_version -- uint8
  • firmware_version -- uint8[3]
  • name -- char[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.

BrickStepper.get_chip_temperature
Funktions ID:

242

Anfrage:

keine Nutzdaten

Antwort:
  • temperature -- int16

Gibt die Temperatur in °C/10, 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.

BrickStepper.reset
Funktions ID:243
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.

BrickStepper.get_identity
Funktions ID:

255

Anfrage:

keine Nutzdaten

Antwort:
  • uid -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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 kann '0'-'8' (Stack Position) sein.

Eine Liste der Device Identifier Werte ist hier zu finden. 

Konfigurationsfunktionen für Callbacks

BrickStepper.set_minimum_voltage
Funktions ID:

29

Anfrage:
  • voltage -- uint16
Antwort:

keine Antwort

Setzt die minimale Spannung in mV, bei welcher der CALLBACK_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.

Der Standardwert ist 8V.

BrickStepper.get_minimum_voltage
Funktions ID:

30

Anfrage:

keine Nutzdaten

Antwort:
  • voltage -- uint16

Gibt die minimale Spannung zurück, wie von set_minimum_voltage gesetzt.

BrickStepper.set_all_data_period
Funktions ID:

38

Anfrage:
  • period -- uint32
Antwort:

keine Antwort

Setzt die Periode in ms mit welcher der CALLBACK_ALL_DATA Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

BrickStepper.get_all_data_period
Funktions ID:

39

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32

Gibt die Periode zurück, wie von set_all_data_period gesetzt.

Callbacks

BrickStepper.CALLBACK_UNDER_VOLTAGE
Funktions ID:

31

Antwort:
  • voltage -- uint16

Dieser Callback wird ausgelöst wenn die Eingangsspannung unter den, mittels set_minimum_voltage gesetzten, Schwellwert sinkt. Der Rückgabewert ist die aktuelle Spannung in mV.

BrickStepper.CALLBACK_POSITION_REACHED
Funktions ID:

32

Antwort:
  • position -- int32

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Position, wie von set_steps oder 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 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.

BrickStepper.CALLBACK_ALL_DATA
Funktions ID:

40

Antwort:
  • current_velocity -- uint16
  • current_position -- int32
  • remaining_steps -- int32
  • stack_voltage -- uint16
  • external_voltage -- uint16
  • current_consumption -- uint16

Dieser Callback wird mit der Periode, wie gesetzt mit set_all_data_period, ausgelöst. Die Rückgabewerte sind die aktuelle Geschwindigkeit, die aktuelle Position, die verbleibenden Schritte, die Spannung des Stapels, die externe Spannung und der aktuelle Stromverbrauch des Schrittmotors.

BrickStepper.CALLBACK_NEW_STATE
Funktions ID:

41

Antwort:
  • state_new -- uint8
  • state_previous -- uint8

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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 1: stop, für state_new und state_previous
  • 2: acceleration, für state_new und state_previous
  • 3: run, für state_new und state_previous
  • 4: deacceleration, für state_new und state_previous
  • 5: direction change to forward, für state_new und state_previous
  • 6: direction change to backward, für state_new und state_previous