Mathematica - Stepper Brick

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Configuration

Download (ExampleConfiguration.nb)

 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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XXYYZZ"(*Change XXYYZZ to the UID of your Stepper Brick*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
stepper=NETNew["Tinkerforge.BrickStepper",uid,ipcon]
ipcon@Connect[host,port]

stepper@SetMotorCurrent[800](*800mA*)
stepper@SetStepMode[8](*1/8 step mode*)
stepper@SetMaxVelocity[2000](*Velocity 2000 steps/s*)

(*Slow acceleration (500 steps/s^2),*)
(*Fast deacceleration (5000 steps/s^2)*)
stepper@SetSpeedRamping[500,5000]

stepper@Enable[](*Enable motor power*)
stepper@SetSteps[60000](*Drive 60000 steps forward*)

Input["Click OK to exit"]

(*Clean up*)
stepper@Disable[]
ipcon@Disconnect[]
ReleaseNETObject[stepper]
ReleaseNETObject[ipcon]

Callback

Download (ExampleCallback.nb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XXYYZZ"(*Change XXYYZZ to the UID of your Stepper Brick*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
stepper=NETNew["Tinkerforge.BrickStepper",uid,ipcon]
ipcon@Connect[host,port]

(*Use position reached callback to program random movement*)
PositionReachedCB[sender_,position_]:=
 Module[{},
  If[EvenQ[RandomInteger[]],
   steps:=RandomInteger[{1000,5000}];(*steps (forward)*)
   Print["Driving forward: "<>ToString[steps]<>" steps"],
   steps:=RandomInteger[{-5000,-1000}];(*steps (backward)*)
   Print["Driving backward: "<>ToString[steps]<>" steps"]
  ];

  vel=RandomInteger[{200,2000}];(*steps/s*)
  acc=RandomInteger[{100,1000}];(*steps/s^2*)
  dec=RandomInteger[{100,1000}];(*steps/s^2*)

  Print["Configuration (vel, acc, dec): ("<>
        ToString[vel]<>", "<>ToString[acc]<>", "<>ToString[dec]<>")"];

  sender@SetSpeedRamping[acc,dec];
  sender@SetMaxVelocity[vel];
  sender@SetSteps[steps]
 ]

AddEventHandler[stepper@PositionReachedCallback,PositionReachedCB]

stepper@Enable[](*Enable motor power*)
stepper@SetSteps[1](*Drive one step forward to get things going*)

Input["Click OK to exit"]

(*Clean up*)
stepper@Disable[]
ipcon@Disconnect[]
ReleaseNETObject[stepper]
ReleaseNETObject[ipcon]

API

Prinzipiell kann jede Funktion der Mathematica Bindings, welche einen Wert zurück gibt eine Tinkerforge.TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Da .NET/Link nicht mehrere Rückgabewerte direkt unterstützt, wird das out Schlüsselwort genutzt, um mehrere Werte aus einer Funktion zurückzugeben. Weitere Informationen über das out Schlüsselwort in .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist Tinkerforge.*.

Grundfunktionen

BrickStepper[uid, ipcon] → stepper
Parameter:
  • uid -- String
  • ipcon -- NETObject[IPConnection]
Rückgabe:
  • stepper -- NETObject[BrickStepper]

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

stepper=NETNew["Tinkerforge.BrickStepper","YOUR_DEVICE_UID",ipcon]

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

Die .NET Runtime hat eingebauten Garbage Collection welche Objekte wieder freigibt, wenn sie vom Programm nicht mehr verwendet werden. Da Mathematica aber selbst nicht automatisch feststellen kann, wann ein Mathematica "Programm" ein .NET Objekt nicht mehr verwendet, muss sich das Programm selbst darum kümmern. Für diesen Zweck wird die ReleaseNETObject[] Funktion in den Beispielen verwendet.

Weitere Informationen über Objekt-Verwaltung mittels .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

BrickStepper@SetMaxVelocity[velocity] → Null
Parameter:
  • velocity -- Integer

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 SetTargetPosition[], SetSteps[], DriveForward[] oder DriveBackward[] verwendet werden.

BrickStepper@GetMaxVelocity[] → velocity
Rückgabe:
  • velocity -- Integer

Gibt die Geschwindigkeit zurück, wie von SetMaxVelocity[] gesetzt.

BrickStepper@GetCurrentVelocity[] → velocity
Rückgabe:
  • velocity -- Integer

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

BrickStepper@SetSpeedRamping[acceleration, deacceleration] → Null
Parameter:
  • acceleration -- Integer
  • deacceleration -- Integer

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@GetSpeedRamping[out acceleration, out deacceleration] → Null
Parameter:
  • acceleration -- Integer
  • deacceleration -- Integer

Gibt die Beschleunigung und Verzögerung zurück, wie von SetSpeedRamping[] gesetzt.

BrickStepper@FullBrake[] → Null

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@SetSteps[steps] → Null
Parameter:
  • steps -- Integer

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 SetMaxVelocity[] und SetSpeedRamping[] gesetzt, verwendet.

BrickStepper@GetSteps[] → steps
Rückgabe:
  • steps -- Integer

Gibt die letzten Schritte zurück, wie von SetSteps[] gesetzt.

BrickStepper@GetRemainingSteps[] → steps
Rückgabe:
  • steps -- Integer

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

BrickStepper@DriveForward[] → Null

Fährt den Schrittmotor vorwärts bis DriveBackward[] oder Stop[] aufgerufen wird. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit SetMaxVelocity[] und SetSpeedRamping[] gesetzt, verwendet.

BrickStepper@DriveBackward[] → Null

Fährt den Schrittmotor rückwärts bis DriveForward[] oder Stop[] aufgerufen wird. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit SetMaxVelocity[] und SetSpeedRamping[] gesetzt, verwendet.

BrickStepper@Stop[] → Null

Stoppt den Schrittmotor mit der Verzögerung, wie von SetSpeedRamping[] gesetzt.

BrickStepper@SetMotorCurrent[current] → Null
Parameter:
  • current -- Integer

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@GetMotorCurrent[] → current
Rückgabe:
  • current -- Integer

Gibt den Strom zurück, wie von SetMotorCurrent[] gesetzt.

BrickStepper@Enable[] → Null

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

BrickStepper@Disable[] → Null

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

BrickStepper@IsEnabled[] → enabled
Rückgabe:
  • enabled -- True/False

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

Fortgeschrittene Funktionen

BrickStepper@SetCurrentPosition[position] → Null
Parameter:
  • position -- Integer

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@GetCurrentPosition[] → position
Rückgabe:
  • position -- Integer

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 (SetTargetPosition[], SetSteps[], DriveForward[] der DriveBackward[]). Es ist auch möglich den Schrittzähler auf 0 oder jeden anderen gewünschten Wert zu setzen mit SetCurrentPosition[].

BrickStepper@SetTargetPosition[position] → Null
Parameter:
  • position -- Integer

Setzt die Zielposition des Schrittmotors in Schritten. Beispiel: Wenn die aktuelle Position des Motors 500 ist und SetTargetPosition[] mit 1000 aufgerufen wird, dann verfährt der Schrittmotor 500 Schritte vorwärts. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit SetMaxVelocity[] und SetSpeedRamping[] gesetzt, verwendet.

Ein Aufruf von SetTargetPosition[] mit dem Parameter x ist äquivalent mit einem Aufruf von SetSteps[] mit dem Parameter (x - GetCurrentPosition[]).

BrickStepper@GetTargetPosition[] → position
Rückgabe:
  • position -- Integer

Gibt die letzte Zielposition zurück, wie von SetTargetPosition[] gesetzt.

BrickStepper@SetStepMode[mode] → Null
Parameter:
  • mode -- Integer

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 Konstanten sind für diese Funktion verfügbar:

  • BrickStepper`STEPUMODEUFULLUSTEP = 1
  • BrickStepper`STEPUMODEUHALFUSTEP = 2
  • BrickStepper`STEPUMODEUQUARTERUSTEP = 4
  • BrickStepper`STEPUMODEUEIGHTHUSTEP = 8
BrickStepper@GetStepMode[] → mode
Rückgabe:
  • mode -- Integer

Gibt den Schrittmodus zurück, wie von SetStepMode[] gesetzt.

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

  • BrickStepper`STEPUMODEUFULLUSTEP = 1
  • BrickStepper`STEPUMODEUHALFUSTEP = 2
  • BrickStepper`STEPUMODEUQUARTERUSTEP = 4
  • BrickStepper`STEPUMODEUEIGHTHUSTEP = 8
BrickStepper@GetStackInputVoltage[] → voltage
Rückgabe:
  • voltage -- Integer

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@GetExternalInputVoltage[] → voltage
Rückgabe:
  • voltage -- Integer

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@GetCurrentConsumption[] → current
Rückgabe:
  • current -- Integer

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

BrickStepper@SetDecay[decay] → Null
Parameter:
  • decay -- Integer

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 SetSyncRect[]).

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@GetDecay[] → decay
Rückgabe:
  • decay -- Integer

Gibt den Decay Modus zurück, wie von SetDecay[] gesetzt.

BrickStepper@SetSyncRect[syncRect] → Null
Parameter:
  • syncRect -- True/False

Aktiviert oder deaktiviert (true oder false) die Synchrongleichrichtung.

Bei aktiver Synchrongleichrichtung kann der Decay Modus geändert werden (Siehe SetDecay[]). 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@IsSyncRect[] → syncRect
Rückgabe:
  • syncRect -- True/False

Gibt zurück ob die Synchrongleichrichtung aktiviert ist.

BrickStepper@SetTimeBase[timeBase] → Null
Parameter:
  • timeBase -- Integer

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@GetTimeBase[] → timeBase
Rückgabe:
  • timeBase -- Integer

Gibt die Zeitbasis zurück, wie von SetTimeBase[] gesetzt.

BrickStepper@GetAllData[out currentVelocity, out currentPosition, out remainingSteps, out stackVoltage, out externalVoltage, out currentConsumption] → Null
Parameter:
  • currentVelocity -- Integer
  • currentPosition -- Integer
  • remainingSteps -- Integer
  • stackVoltage -- Integer
  • externalVoltage -- Integer
  • currentConsumption -- Integer

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

BrickStepper@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}
Rückgabe:
  • apiVersioni -- Integer

Gibt die Version der API Definition (Major, Minor, Revision) zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

BrickStepper@GetResponseExpected[functionId] → responseExpected
Parameter:
  • functionId -- Integer
Rückgabe:
  • responseExpected -- True/False

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels SetResponseExpected[]. Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

  • BrickStepper`FUNCTIONUSETUMAXUVELOCITY = 1
  • BrickStepper`FUNCTIONUSETUSPEEDURAMPING = 4
  • BrickStepper`FUNCTIONUFULLUBRAKE = 6
  • BrickStepper`FUNCTIONUSETUCURRENTUPOSITION = 7
  • BrickStepper`FUNCTIONUSETUTARGETUPOSITION = 9
  • BrickStepper`FUNCTIONUSETUSTEPS = 11
  • BrickStepper`FUNCTIONUSETUSTEPUMODE = 14
  • BrickStepper`FUNCTIONUDRIVEUFORWARD = 16
  • BrickStepper`FUNCTIONUDRIVEUBACKWARD = 17
  • BrickStepper`FUNCTIONUSTOP = 18
  • BrickStepper`FUNCTIONUSETUMOTORUCURRENT = 22
  • BrickStepper`FUNCTIONUENABLE = 24
  • BrickStepper`FUNCTIONUDISABLE = 25
  • BrickStepper`FUNCTIONUSETUDECAY = 27
  • BrickStepper`FUNCTIONUSETUMINIMUMUVOLTAGE = 29
  • BrickStepper`FUNCTIONUSETUSYNCURECT = 33
  • BrickStepper`FUNCTIONUSETUTIMEUBASE = 35
  • BrickStepper`FUNCTIONUSETUALLUDATAUPERIOD = 38
  • BrickStepper`FUNCTIONUSETUSPITFPUBAUDRATEUCONFIG = 231
  • BrickStepper`FUNCTIONUSETUSPITFPUBAUDRATE = 234
  • BrickStepper`FUNCTIONUENABLEUSTATUSULED = 238
  • BrickStepper`FUNCTIONUDISABLEUSTATUSULED = 239
  • BrickStepper`FUNCTIONURESET = 243
BrickStepper@SetResponseExpected[functionId, responseExpected] → Null
Parameter:
  • functionId -- Integer
  • responseExpected -- True/False

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

  • BrickStepper`FUNCTIONUSETUMAXUVELOCITY = 1
  • BrickStepper`FUNCTIONUSETUSPEEDURAMPING = 4
  • BrickStepper`FUNCTIONUFULLUBRAKE = 6
  • BrickStepper`FUNCTIONUSETUCURRENTUPOSITION = 7
  • BrickStepper`FUNCTIONUSETUTARGETUPOSITION = 9
  • BrickStepper`FUNCTIONUSETUSTEPS = 11
  • BrickStepper`FUNCTIONUSETUSTEPUMODE = 14
  • BrickStepper`FUNCTIONUDRIVEUFORWARD = 16
  • BrickStepper`FUNCTIONUDRIVEUBACKWARD = 17
  • BrickStepper`FUNCTIONUSTOP = 18
  • BrickStepper`FUNCTIONUSETUMOTORUCURRENT = 22
  • BrickStepper`FUNCTIONUENABLE = 24
  • BrickStepper`FUNCTIONUDISABLE = 25
  • BrickStepper`FUNCTIONUSETUDECAY = 27
  • BrickStepper`FUNCTIONUSETUMINIMUMUVOLTAGE = 29
  • BrickStepper`FUNCTIONUSETUSYNCURECT = 33
  • BrickStepper`FUNCTIONUSETUTIMEUBASE = 35
  • BrickStepper`FUNCTIONUSETUALLUDATAUPERIOD = 38
  • BrickStepper`FUNCTIONUSETUSPITFPUBAUDRATEUCONFIG = 231
  • BrickStepper`FUNCTIONUSETUSPITFPUBAUDRATE = 234
  • BrickStepper`FUNCTIONUENABLEUSTATUSULED = 238
  • BrickStepper`FUNCTIONUDISABLEUSTATUSULED = 239
  • BrickStepper`FUNCTIONURESET = 243
BrickStepper@SetResponseExpectedAll[responseExpected] → Null
Parameter:
  • responseExpected -- True/False

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

BrickStepper@SetSPITFPBaudrateConfig[enableDynamicBaudrate, minimumDynamicBaudrate] → Null
Parameter:
  • enableDynamicBaudrate -- True/False
  • minimumDynamicBaudrate -- Integer

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 SetSPITFPBaudrate[]. gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von SetSPITFPBaudrate[] 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@GetSPITFPBaudrateConfig[out enableDynamicBaudrate, out minimumDynamicBaudrate] → Null
Parameter:
  • enableDynamicBaudrate -- True/False
  • minimumDynamicBaudrate -- Integer

Gibt die Baudratenkonfiguration zurück, siehe SetSPITFPBaudrateConfig[].

Neu in Version 2.3.6 (Firmware).

BrickStepper@GetSendTimeoutCount[communicationMethod] → timeoutCount
Parameter:
  • communicationMethod -- Integer
Rückgabe:
  • timeoutCount -- Integer

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 Konstanten sind für diese Funktion verfügbar:

  • BrickStepper`COMMUNICATIONUMETHODUNONE = 0
  • BrickStepper`COMMUNICATIONUMETHODUUSB = 1
  • BrickStepper`COMMUNICATIONUMETHODUSPIUSTACK = 2
  • BrickStepper`COMMUNICATIONUMETHODUCHIBI = 3
  • BrickStepper`COMMUNICATIONUMETHODURS485 = 4
  • BrickStepper`COMMUNICATIONUMETHODUWIFI = 5
  • BrickStepper`COMMUNICATIONUMETHODUETHERNET = 6
  • BrickStepper`COMMUNICATIONUMETHODUWIFIUV2 = 7

Neu in Version 2.3.4 (Firmware).

BrickStepper@SetSPITFPBaudrate[brickletPort, baudrate] → Null
Parameter:
  • brickletPort -- Integer
  • baudrate -- Integer

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 GetSPITFPErrorCount[]) kann die Baudrate verringert werden.

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

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@GetSPITFPBaudrate[brickletPort] → baudrate
Parameter:
  • brickletPort -- Integer
Rückgabe:
  • baudrate -- Integer

Gibt die Baudrate für einen Bricklet Port zurück, siehe SetSPITFPBaudrate[].

Neu in Version 2.3.3 (Firmware).

BrickStepper@GetSPITFPErrorCount[brickletPort, out errorCountACKChecksum, out errorCountMessageChecksum, out errorCountFrame, out errorCountOverflow] → Null
Parameter:
  • brickletPort -- Integer
  • errorCountACKChecksum -- Integer
  • errorCountMessageChecksum -- Integer
  • errorCountFrame -- Integer
  • errorCountOverflow -- Integer

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@EnableStatusLED[] → Null

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@DisableStatusLED[] → Null

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@IsStatusLEDEnabled[] → enabled
Rückgabe:
  • enabled -- True/False

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

Neu in Version 2.3.1 (Firmware).

BrickStepper@GetProtocol1BrickletName[port, out protocolVersion, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out name] → Null
Parameter:
  • port -- Integer
  • protocolVersion -- Integer
  • firmwareVersioni -- Integer
  • name -- String

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@GetChipTemperature[] → temperature
Rückgabe:
  • temperature -- Integer

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[] → Null

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@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null
Parameter:
  • uid -- String
  • connectedUid -- String
  • position -- Integer
  • hardwareVersioni -- Integer
  • firmwareVersioni -- Integer
  • deviceIdentifier -- Integer

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. Es gibt auch eine Konstante für den Device Identifier dieses Bricks.

Konfigurationsfunktionen für Callbacks

BrickStepper@SetMinimumVoltage[voltage] → Null
Parameter:
  • voltage -- Integer

Setzt die minimale Spannung in mV, bei welcher der UnderVoltageCallback 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@GetMinimumVoltage[] → voltage
Rückgabe:
  • voltage -- Integer

Gibt die minimale Spannung zurück, wie von SetMinimumVoltage[] gesetzt.

BrickStepper@SetAllDataPeriod[period] → Null
Parameter:
  • period -- Integer

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

BrickStepper@GetAllDataPeriod[] → period
Rückgabe:
  • period -- Integer

Gibt die Periode zurück, wie von SetAllDataPeriod[] gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Funktion einem Callback Property des Geräte Objektes zugewiesen wird:

MyCallback[sender_,value_]:=Print["Value: "<>ToString[value]]

AddEventHandler[stepper@ExampleCallback,MyCallback]

Weitere Informationen über Event-Behandlung mittels .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten beschrieben.

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.

event BrickStepper@UnderVoltageCallback[sender, voltage]
Parameter:
  • sender -- NETObject[BrickStepper]
  • voltage -- Integer

Dieser Callback wird ausgelöst, wenn die Eingangsspannung unter den, mittels SetMinimumVoltage[] gesetzten, Schwellwert sinkt. Der Parameter ist die aktuelle Spannung in mV.

event BrickStepper@PositionReachedCallback[sender, position]
Parameter:
  • sender -- NETObject[BrickStepper]
  • position -- Integer

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Position, wie von SetSteps[] oder SetTargetPosition[] 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 SetSpeedRamping[]) 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.

event BrickStepper@AllDataCallback[sender, currentVelocity, currentPosition, remainingSteps, stackVoltage, externalVoltage, currentConsumption]
Parameter:
  • sender -- NETObject[BrickStepper]
  • currentVelocity -- Integer
  • currentPosition -- Integer
  • remainingSteps -- Integer
  • stackVoltage -- Integer
  • externalVoltage -- Integer
  • currentConsumption -- Integer

Dieser Callback wird mit der Periode, wie gesetzt mit SetAllDataPeriod[], ausgelöst. Die Parameter sind die aktuelle Geschwindigkeit, die aktuelle Position, die verbleibenden Schritte, die Spannung des Stapels, die externe Spannung und der aktuelle Stromverbrauch des Schrittmotors.

event BrickStepper@NewStateCallback[sender, stateNew, statePrevious]
Parameter:
  • sender -- NETObject[BrickStepper]
  • stateNew -- Integer
  • statePrevious -- Integer

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 Konstanten sind für diese Funktion verfügbar:

  • BrickStepper`STATEUSTOP = 1
  • BrickStepper`STATEUACCELERATION = 2
  • BrickStepper`STATEURUN = 3
  • BrickStepper`STATEUDEACCELERATION = 4
  • BrickStepper`STATEUDIRECTIONUCHANGEUTOUFORWARD = 5
  • BrickStepper`STATEUDIRECTIONUCHANGEUTOUBACKWARD = 6

Konstanten

BrickStepper`DEVICEUIDENTIFIER

Diese Konstante wird verwendet um einen Stepper Brick zu identifizieren.

Die GetIdentity[] Funktion und der IPConnection@EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickStepper`DEVICEDISPLAYNAME

Diese Konstante stellt den Anzeigenamen eines Stepper Brick dar.