Dies ist die Beschreibung der Visual Basic .NET API Bindings für das Silent Stepper Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Silent Stepper Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die Visual Basic .NET API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (ExampleConfiguration.vb)
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 | Imports System
Imports System.Threading
Imports Tinkerforge
Module ExampleConfiguration
Const HOST As String = "localhost"
Const PORT As Integer = 4223
Const UID As String = "XYZ" ' Change XYZ to the UID of your Silent Stepper Bricklet 2.0
Sub Main()
Dim ipcon As New IPConnection() ' Create IP connection
Dim ss As New BrickletSilentStepperV2(UID, ipcon) ' Create device object
ipcon.Connect(HOST, PORT) ' Connect to brickd
' Don't use device before ipcon is connected
ss.SetMotorCurrent(800) ' 800 mA
ss.SetStepConfiguration(BrickletSilentStepperV2.STEP_RESOLUTION_8, _
True) ' 1/8 steps (interpolated)
ss.SetMaxVelocity(2000) ' Velocity 2000 steps/s
' Slow acceleration (500 steps/s^2),
' Fast deacceleration (5000 steps/s^2)
ss.SetSpeedRamping(500, 5000)
ss.SetEnabled(True) ' Enable motor power
ss.SetSteps(60000) ' Drive 60000 steps forward
Console.WriteLine("Press key to exit")
Console.ReadLine()
' Stop motor before disabling motor power
ss.Stop() ' Request motor stop
ss.SetSpeedRamping(500, _
5000) ' Fast deacceleration (5000 steps/s^2) for stopping
Thread.Sleep(400) ' Wait for motor to actually stop: max velocity (2000 steps/s) / decceleration (5000 steps/s^2) = 0.4 s
ss.SetEnabled(False) ' Disable motor power
ipcon.Disconnect()
End Sub
End Module
|
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 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 | Imports System
Imports System.Threading
Imports Tinkerforge
Module ExampleCallback
Const HOST As String = "localhost"
Const PORT As Integer = 4223
Const UID As String = "XYZ" ' Change XYZ to the UID of your Silent Stepper Bricklet 2.0
Dim rand As Random = New Random()
' Use position reached callback to program random movement
Sub PositionReachedCB(ByVal sender As BrickletSilentStepperV2, ByVal position As Integer)
Dim steps As Integer
If rand.Next(0, 2) = 0 Then
steps = rand.Next(1000, 5001) ' steps (forward)
Console.WriteLine("Driving forward: " + steps.ToString() + " steps")
Else
steps = rand.Next(-5000, -999) ' steps (backward)
Console.WriteLine("Driving backward: " + steps.ToString() + " steps")
End If
Dim vel As Integer = rand.Next(200, 2001) ' steps/s
Dim acc As Integer = rand.Next(100, 1001) ' steps/s^2
Dim dec As Integer = rand.Next(100, 1001) ' steps/s^2
Console.WriteLine("Configuration (vel, acc, dec): (" + vel.ToString() + ", " + _
acc.ToString() + ", " + dec.ToString() + ")")
sender.SetSpeedRamping(acc, dec)
sender.SetMaxVelocity(vel)
sender.SetSteps(steps)
End Sub
Sub Main()
Dim ipcon As New IPConnection() ' Create IP connection
Dim ss As New BrickletSilentStepperV2(UID, ipcon) ' Create device object
ipcon.Connect(HOST, PORT) ' Connect to brickd
' Don't use device before ipcon is connected
' Register position reached callback to subroutine PositionReachedCB
AddHandler ss.PositionReachedCallback, AddressOf PositionReachedCB
ss.SetStepConfiguration(BrickletSilentStepperV2.STEP_RESOLUTION_8, _
True) ' 1/8 steps (interpolated)
ss.SetEnabled(True) ' Enable motor power
ss.SetSteps(1) ' Drive one step forward to get things going
Console.WriteLine("Press key to exit")
Console.ReadLine()
' Stop motor before disabling motor power
ss.Stop() ' Request motor stop
ss.SetSpeedRamping(500, _
5000) ' Fast deacceleration (5000 steps/s^2) for stopping
Thread.Sleep(400) ' Wait for motor to actually stop: max velocity (2000 steps/s) / decceleration (5000 steps/s^2) = 0.4 s
ss.SetEnabled(False) ' Disable motor power
ipcon.Disconnect()
End Sub
End Module
|
Da Visual Basic .NET nicht mehrere Rückgabewerte direkt unterstützt, wird das
ByRef
Schlüsselwort genutzt um mehrere Werte von einer Funktion zurückzugeben.
Alle folgend aufgelisteten Funktionen und Prozeduren sind Thread-sicher.
BrickletSilentStepperV2
(ByVal uid As String, ByVal ipcon As IPConnection)¶Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
Dim silentStepperV2 As New BrickletSilentStepperV2("YOUR_DEVICE_UID", ipcon)
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletSilentStepperV2.
SetMaxVelocity
(ByVal velocity As Integer)¶Parameter: |
|
---|
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 SetTargetPosition()
, SetSteps()
, DriveForward()
oder
DriveBackward()
verwendet werden.
BrickletSilentStepperV2.
GetMaxVelocity
() As Integer¶Rückgabe: |
|
---|
Gibt die Geschwindigkeit zurück, wie von SetMaxVelocity()
gesetzt.
BrickletSilentStepperV2.
GetCurrentVelocity
() As Integer¶Rückgabe: |
|
---|
Gibt die aktuelle Geschwindigkeit des Schrittmotors zurück.
BrickletSilentStepperV2.
SetSpeedRamping
(ByVal acceleration As Integer, ByVal deacceleration As Integer)¶Parameter: |
|
---|
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).
BrickletSilentStepperV2.
GetSpeedRamping
(ByRef acceleration As Integer, ByRef deacceleration As Integer)¶Ausgabeparameter: |
|
---|
Gibt die Beschleunigung und Verzögerung zurück, wie von SetSpeedRamping()
gesetzt.
BrickletSilentStepperV2.
FullBrake
()¶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.
BrickletSilentStepperV2.
SetSteps
(ByVal steps As Integer)¶Parameter: |
|
---|
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.
BrickletSilentStepperV2.
GetSteps
() As Integer¶Rückgabe: |
|
---|
Gibt die letzten Schritte zurück, wie von SetSteps()
gesetzt.
BrickletSilentStepperV2.
GetRemainingSteps
() As Integer¶Rückgabe: |
|
---|
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.
BrickletSilentStepperV2.
DriveForward
()¶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.
BrickletSilentStepperV2.
DriveBackward
()¶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.
BrickletSilentStepperV2.
Stop
()¶Stoppt den Schrittmotor mit der Verzögerung, wie von
SetSpeedRamping()
gesetzt.
BrickletSilentStepperV2.
SetMotorCurrent
(ByVal current As Integer)¶Parameter: |
|
---|
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.
BrickletSilentStepperV2.
GetMotorCurrent
() As Integer¶Rückgabe: |
|
---|
Gibt den Strom zurück, wie von SetMotorCurrent()
gesetzt.
BrickletSilentStepperV2.
SetEnabled
(ByVal enabled As Boolean)¶Parameter: |
|
---|
Aktiviert/Deaktiviert die Treiberstufe. Die Treiberparameter können vor der Aktivierung konfiguriert werden (maximale Geschwindigkeit, Beschleunigung, etc.).
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
Stop()
Funktion gestoppt werden, bevor die Treiberstufe deaktiviert
wird. Die Stop()
Funktion wartet nicht bis der Motor wirklich
zum Stillstand gekommen ist. Dazu muss nach dem Aufruf der Stop()
Funktion eine angemessen Zeit gewartet werden bevor die Funktion SetEnabled()
mit false aufgerufen wird.
BrickletSilentStepperV2.
GetEnabled
() As Boolean¶Rückgabe: |
|
---|
Gibt zurück ob der Schrittmotortreiber aktiviert ist.
BrickletSilentStepperV2.
SetBasicConfiguration
(ByVal standstillCurrent As Integer, ByVal motorRunCurrent As Integer, ByVal standstillDelayTime As Integer, ByVal powerDownTime As Integer, ByVal stealthThreshold As Integer, ByVal coolstepThreshold As Integer, ByVal classicThreshold As Integer, ByVal highVelocityChopperMode As Boolean)¶Parameter: |
|
---|
Setzt die Basiskonfiguration-Parameter für verschiedene Modi (Stealth, Coolstep, Classic).
SetMotorCurrent()
).SetMotorCurrent()
).Wenn alle drei Grenzwerte (Thresholds) genutzt werden sollen muss sichergestellt werden, dass Stealth Threshold < Coolstep Threshold < Classic Threshold.
BrickletSilentStepperV2.
GetBasicConfiguration
(ByRef standstillCurrent As Integer, ByRef motorRunCurrent As Integer, ByRef standstillDelayTime As Integer, ByRef powerDownTime As Integer, ByRef stealthThreshold As Integer, ByRef coolstepThreshold As Integer, ByRef classicThreshold As Integer, ByRef highVelocityChopperMode As Boolean)¶Ausgabeparameter: |
|
---|
Gibt die Konfiguration zurück, wie von SetBasicConfiguration()
gesetzt.
BrickletSilentStepperV2.
SetGPIOConfiguration
(ByVal channel As Byte, ByVal debounce As Integer, ByVal stopDeceleration As Integer)¶Parameter: |
|
---|
Setzt die GPIO-Konfiguration für einen Kanal.
Es kann ein Debounce und eine Debeschleunigung gesetzt werden. Letzteres wird
genutzt wenn die Action auf normal stop
konfiguriert ist. Siehe
SetGPIOAction()
.
BrickletSilentStepperV2.
GetGPIOConfiguration
(ByVal channel As Byte, ByRef debounce As Integer, ByRef stopDeceleration As Integer)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Gibt die GPIO-Konfiguration für einen Kanal zurück, wie von SetGPIOConfiguration()
gesetzt.
BrickletSilentStepperV2.
SetGPIOAction
(ByVal channel As Byte, ByVal action As Long)¶Parameter: |
|
---|
Setzt die GPIO-Action für einen Kanal.
Die Action kann ein normal stop
, ein full brake
oder ein callback
sein. Jeweils für eine steigende oder fallende Flanke.
Die Actions sind eine Bitmaske und sie können simultan verwendet werden.
Es ist zum Beispiel möglich einen full brake
und callback
gleichzeitig
zu triggern oder eine auf eine steigende und fallende Flanke gleichzeitig.
Die Debeschleunigung für den normal stop
kann über
SetGPIOConfiguration()
konfiguriert werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für action:
BrickletSilentStepperV2.
GetGPIOAction
(ByVal channel As Byte) As Long¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt die GPIO-Action für einen Kanal zurück, wie von SetGPIOAction()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für action:
BrickletSilentStepperV2.
GetGPIOState
() As Boolean()¶Rückgabe: |
|
---|
Gibt den GPIO-Zustand für beide Kanäle zurück. True wenn der der Zustand
high
ist und false wenn der Zustand low
ist.
BrickletSilentStepperV2.
SetCurrentPosition
(ByVal position As Integer)¶Parameter: |
|
---|
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).
BrickletSilentStepperV2.
GetCurrentPosition
() As Integer¶Rückgabe: |
|
---|
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()
.
BrickletSilentStepperV2.
SetTargetPosition
(ByVal position As Integer)¶Parameter: |
|
---|
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()
).
BrickletSilentStepperV2.
GetTargetPosition
() As Integer¶Rückgabe: |
|
---|
Gibt die letzte Zielposition zurück, wie von SetTargetPosition()
gesetzt.
BrickletSilentStepperV2.
SetStepConfiguration
(ByVal stepResolution As Byte, ByVal interpolation As Boolean)¶Parameter: |
|
---|
Setzt die Schrittauflösung von Vollschritt bis zu 1/256 Schritt.
Wenn Interpolation aktiviert ist, führt der Silent Stepper Bricklet 2.0 immer 1/256 interpolierte Schritte aus. Wenn zum Beispiel Vollschritt mit Interpolation genutzt wird, führt jeder Schritt zu 256 1/256 Schritten beim Motor.
Für einen maximalen Drehmoment sollte Vollschritt mit Interpolation genutzt werden. Für maximale Auflösung sollte 1/256 Schritt genutzt werden. Interpolation führt auch dazu, dass der Motor weniger Geräusche erzeugt.
Für den Fall, dass oft die Geschwindigkeit mit sehr hohen Beschleunigungen geändert wird, sollte Interpolation ausgeschaltet werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für stepResolution:
BrickletSilentStepperV2.
GetStepConfiguration
(ByRef stepResolution As Byte, ByRef interpolation As Boolean)¶Ausgabeparameter: |
|
---|
Gibt den Schrittmodus zurück, wie von SetStepConfiguration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für stepResolution:
BrickletSilentStepperV2.
GetInputVoltage
() As Integer¶Rückgabe: |
|
---|
Gibt die externe Eingangsspannung zurück. Die externe Eingangsspannung wird über die schwarze Stromversorgungsbuchse, in den Silent Stepper Bricklet 2.0, 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.
BrickletSilentStepperV2.
SetSpreadcycleConfiguration
(ByVal slowDecayDuration As Byte, ByVal enableRandomSlowDecay As Boolean, ByVal fastDecayDuration As Byte, ByVal hysteresisStartValue As Byte, ByVal hysteresisEndValue As Short, ByVal sineWaveOffset As Short, ByVal chopperMode As Byte, ByVal comparatorBlankTime As Byte, ByVal fastDecayWithoutComparator As Boolean)¶Parameter: |
|
---|
Note: Typischerweise können diese Werte bei ihren Standardwerten gelassen werden. Sie sollten nur geändert werden, wenn man weiß was man tut.
Setzt die Spreadcycle Konfigurationsparameter. Spreadcycle ist ein Chopper-Algorithmus der aktiv den Motorstrom regelt. Weitere Informationen dazu können im TMC2130 Datenblatt auf Seite 47 (7 spreadCycle and Classic Chopper) gefunden werden.
Slow Decay Duration: Steuert die Aus-Zeit (off time) in der Slow Decay Phase. 0 = Treiber deaktiviert, alle Brücken aus. Nur wenn die Comparator Blank Time >=2 ist sollte ein Wert von 1 gesetzt werden.
Enable Random Slow Decay: Muss auf False gesetzt werden um die Aus-Zeit (off time) des Choppers auf die gesetzte Slow Decay Duration zu setzen. Wenn dieser Wert auf True gesetzt wird, wird die Decay Dauer zufällig variiert.
Fast Decay Duration: Setzt die Fast Decay Dauer. Dieser Parameter wird nur benutzt, wenn der Spread Cycle als Chopper Modus genutzt wird.
Hysteresis Start Value: Setzt der Startwert der Hysterese. Dieser Parameter wird nur benutzt, wenn der Spread Cycle als Chopper Modus genutzt wird.
Hysteresis End Value: Setzt den Endwert der Hysterese. Dieser Parameter wird nur benutzt, wenn der Spread Cycle als Chopper Modus genutzt wird.
Sinewave Offset: Setzt den Sinuswellen Offset. Der Wert wird nur benutzt, wenn als Chopper Modus Fast Decay benutzt wird. 1/512 dieses Werts wird zum Absolutwert der Sinuswelle hinzuaddiert.
Chopper Mode: 0 = Spread Cycle, 1 = Fast Decay.
Comperator Blank Time: Setzt die Totzeit von Komparator. Mögliche Werte sind
Ein Wert von 1 oder 2 wird für die meisten Anwendungen empfohlen.
Fast Decay Without Comperator: Wenn dieser Wert auf True gesetzt wird, dann wird der Strom-Komparator nicht im Fast Decay Modus genutzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für chopperMode:
BrickletSilentStepperV2.
GetSpreadcycleConfiguration
(ByRef slowDecayDuration As Byte, ByRef enableRandomSlowDecay As Boolean, ByRef fastDecayDuration As Byte, ByRef hysteresisStartValue As Byte, ByRef hysteresisEndValue As Short, ByRef sineWaveOffset As Short, ByRef chopperMode As Byte, ByRef comparatorBlankTime As Byte, ByRef fastDecayWithoutComparator As Boolean)¶Ausgabeparameter: |
|
---|
Gibt die Konfiguration zurück, wie von SetBasicConfiguration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für chopperMode:
BrickletSilentStepperV2.
SetStealthConfiguration
(ByVal enableStealth As Boolean, ByVal amplitude As Byte, ByVal gradient As Byte, ByVal enableAutoscale As Boolean, ByVal forceSymmetric As Boolean, ByVal freewheelMode As Byte)¶Parameter: |
|
---|
Note: Typischerweise können diese Werte bei ihren Standardwerten gelassen werden. Sie sollten nur geändert werden, wenn man weiß was man tut.
Setzt die Konfigurationsparameter für den Stealth Modus.
SetBasicConfiguration()
gesetzt wurde, liegt.SetBasicConfiguration()
) auf 0 gesetzt wurde.Die folgenden Konstanten sind für diese Funktion verfügbar:
Für freewheelMode:
BrickletSilentStepperV2.
GetStealthConfiguration
(ByRef enableStealth As Boolean, ByRef amplitude As Byte, ByRef gradient As Byte, ByRef enableAutoscale As Boolean, ByRef forceSymmetric As Boolean, ByRef freewheelMode As Byte)¶Ausgabeparameter: |
|
---|
Gibt die Konfiguration zurück, wie von SetStealthConfiguration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für freewheelMode:
BrickletSilentStepperV2.
SetCoolstepConfiguration
(ByVal minimumStallguardValue As Byte, ByVal maximumStallguardValue As Byte, ByVal currentUpStepWidth As Byte, ByVal currentDownStepWidth As Byte, ByVal minimumCurrent As Byte, ByVal stallguardThresholdValue As Short, ByVal stallguardMode As Byte)¶Parameter: |
|
---|
Note: Typischerweise können diese Werte bei ihren Standardwerten gelassen werden. Sie sollten nur geändert werden, wenn man weiß was man tut.
Setzt die Konfigurationsparameter für Coolstep.
GetDriverStatus()
). Ein niedriger Wert führt zu einer höheren
Empfindlichkeit. Der korrekte Wert muss typischerweise ausprobiert werden. 0 sollte für die meisten Motoren
funktionieren.Die folgenden Konstanten sind für diese Funktion verfügbar:
Für currentUpStepWidth:
Für currentDownStepWidth:
Für minimumCurrent:
Für stallguardMode:
BrickletSilentStepperV2.
GetCoolstepConfiguration
(ByRef minimumStallguardValue As Byte, ByRef maximumStallguardValue As Byte, ByRef currentUpStepWidth As Byte, ByRef currentDownStepWidth As Byte, ByRef minimumCurrent As Byte, ByRef stallguardThresholdValue As Short, ByRef stallguardMode As Byte)¶Ausgabeparameter: |
|
---|
Gibt die Konfiguration zurück, wie von SetCoolstepConfiguration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für currentUpStepWidth:
Für currentDownStepWidth:
Für minimumCurrent:
Für stallguardMode:
BrickletSilentStepperV2.
SetMiscConfiguration
(ByVal disableShortToGroundProtection As Boolean, ByVal synchronizePhaseFrequency As Byte)¶Parameter: |
|
---|
Note: Typischerweise können diese Werte bei ihren Standardwerten gelassen werden. Sie sollten nur geändert werden, wenn man weiß was man tut.
Setzt verschiedene Parametereinstellungen.
BrickletSilentStepperV2.
GetMiscConfiguration
(ByRef disableShortToGroundProtection As Boolean, ByRef synchronizePhaseFrequency As Byte)¶Ausgabeparameter: |
|
---|
Gibt die Konfiguration zurück, wie von SetMiscConfiguration()
gesetzt.
BrickletSilentStepperV2.
SetErrorLEDConfig
(ByVal config As Byte)¶Parameter: |
|
---|
Konfiguriert die Touch-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option den Fehler-Status anzuzeigen.
Wenn die LED konfiguriert ist um Fehler anzuzeigen gibt es drei unterschiedliche Zustände:
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletSilentStepperV2.
GetErrorLEDConfig
() As Byte¶Rückgabe: |
|
---|
Gibt die LED-Konfiguration zurück, wie von SetErrorLEDConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletSilentStepperV2.
GetDriverStatus
(ByRef openLoad As Byte, ByRef shortToGround As Byte, ByRef overTemperature As Byte, ByRef motorStalled As Boolean, ByRef actualMotorCurrent As Byte, ByRef fullStepActive As Boolean, ByRef stallguardResult As Byte, ByRef stealthVoltageAmplitude As Byte)¶Ausgabeparameter: |
|
---|
Gibt den aktuellen Treiberstatus zurück.
Motor Run Current
, wie von SetBasicConfiguration()
gesetzt. Beispiel: Wenn ein Motor Run Current
von 1000mA gesetzt wurde und ein Wert von 15 zurückgegeben wird, entspricht das einem Actual Motor Current
von 16/32*1000mA = 500mA.SetStealthConfiguration()
).Die folgenden Konstanten sind für diese Funktion verfügbar:
Für openLoad:
Für shortToGround:
Für overTemperature:
BrickletSilentStepperV2.
SetTimeBase
(ByVal timeBase As Long)¶Parameter: |
|
---|
Setzt die Zeitbasis der Geschwindigkeit und Beschleunigung des Silent Stepper Bricklet 2.0.
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.
BrickletSilentStepperV2.
GetTimeBase
() As Long¶Rückgabe: |
|
---|
Gibt die Zeitbasis zurück, wie von SetTimeBase()
gesetzt.
BrickletSilentStepperV2.
GetAllData
(ByRef currentVelocity As Integer, ByRef currentPosition As Integer, ByRef remainingSteps As Integer, ByRef inputVoltage As Integer, ByRef currentConsumption As Integer)¶Ausgabeparameter: |
|
---|
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.
Der Stromverbrauch des Schrittmotors wird berechnet aus dem
Actual Motor Current
-Wert (siehe SetBasicConfiguration()
) multipliziert
mit dem Motor Run Current
(see GetDriverStatus()
). Es handelt
sich dabei um eine interne Berechnung des Treibers, nicht um eine externe
unabhängige Messung.
Die Stromverbrauchsberechnung war bis Firmware 2.0.1 fehlerhaft, sie funktioniert seit Version 2.0.2 wie beschrieben.
Es existiert auch ein Callback für diese Funktion, siehe AllDataCallback
Callback.
BrickletSilentStepperV2.
GetSPITFPErrorCount
(ByRef errorCountAckChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)¶Ausgabeparameter: |
|
---|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.
BrickletSilentStepperV2.
SetStatusLEDConfig
(ByVal config As Byte)¶Parameter: |
|
---|
Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.
Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.
Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletSilentStepperV2.
GetStatusLEDConfig
() As Byte¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von SetStatusLEDConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletSilentStepperV2.
GetChipTemperature
() As Short¶Rückgabe: |
|
---|
Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.
Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.
BrickletSilentStepperV2.
Reset
()¶Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.
Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.
BrickletSilentStepperV2.
GetIdentity
(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)¶Ausgabeparameter: |
|
---|
Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.
Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.
Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.
BrickletSilentStepperV2.
SetMinimumVoltage
(ByVal voltage As Integer)¶Parameter: |
|
---|
Setzt die minimale Spannung, bei welcher der UnderVoltageCallback
Callback
ausgelöst wird. Der kleinste mögliche Wert mit dem der Silent Stepper Bricklet 2.0 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.
BrickletSilentStepperV2.
GetMinimumVoltage
() As Integer¶Rückgabe: |
|
---|
Gibt die minimale Spannung zurück, wie von SetMinimumVoltage()
gesetzt.
BrickletSilentStepperV2.
SetAllCallbackConfiguration
(ByVal period As Long)¶Parameter: |
|
---|
Setzt die Periode mit welcher der AllDataCallback
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
BrickletSilentStepperV2.
GetAllDataCallbackConfiguraton
() As Long¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetAllCallbackConfiguration()
gesetzt.
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:
Sub MyCallback(ByVal sender As BrickletSilentStepperV2, ByVal value As Short) Console.WriteLine("Value: {0}", value) End Sub AddHandler silentStepperV2.ExampleCallback, AddressOf MyCallback
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.
BrickletSilentStepperV2.
UnderVoltageCallback
(ByVal sender As BrickletSilentStepperV2, ByVal voltage As Integer)¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn die Eingangsspannung unter den, mittels
SetMinimumVoltage()
gesetzten, Schwellwert sinkt. Der Parameter
ist die aktuelle Spannung.
BrickletSilentStepperV2.
PositionReachedCallback
(ByVal sender As BrickletSilentStepperV2, ByVal position As Integer)¶Callback-Parameter: |
|
---|
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.
BrickletSilentStepperV2.
AllDataCallback
(ByVal sender As BrickletSilentStepperV2, ByVal currentVelocity As Integer, ByVal currentPosition As Integer, ByVal remainingSteps As Integer, ByVal inputVoltage As Integer, ByVal currentConsumption As Integer)¶Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit SetAllCallbackConfiguration()
,
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.
BrickletSilentStepperV2.
NewStateCallback
(ByVal sender As BrickletSilentStepperV2, ByVal stateNew As Byte, ByVal statePrevious As Byte)¶Callback-Parameter: |
|
---|
Dieser Callback wird immer dann ausgelöst, wenn der Silent Stepper Bricklet 2.0 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:
Für stateNew:
Für statePrevious:
BrickletSilentStepperV2.
GPIOStateCallback
(ByVal sender As BrickletSilentStepperV2, ByVal gpioState() As Boolean)¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst durch GPIO-Änderungen wenn er über SetGPIOAction()
aktiviert wurde.
Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.
BrickletSilentStepperV2.
GetAPIVersion
() As Byte()¶Ausgabeparameter: |
|
---|
Gibt die Version der API Definition 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.
BrickletSilentStepperV2.
GetResponseExpected
(ByVal functionId As Byte) As Boolean¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
Für functionId:
BrickletSilentStepperV2.
SetResponseExpected
(ByVal functionId As Byte, ByVal responseExpected As Boolean)¶Parameter: |
|
---|
Ä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:
Für functionId:
BrickletSilentStepperV2.
SetResponseExpectedAll
(ByVal responseExpected As Boolean)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
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.
BrickletSilentStepperV2.
SetBootloaderMode
(ByVal mode As Byte) As Byte¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.
Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
Für status:
BrickletSilentStepperV2.
GetBootloaderMode
() As Byte¶Rückgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode()
.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletSilentStepperV2.
SetWriteFirmwarePointer
(ByVal pointer As Long)¶Parameter: |
|
---|
Setzt den Firmware-Pointer für WriteFirmware()
. Der Pointer
muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke
in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
BrickletSilentStepperV2.
WriteFirmware
(ByVal data() As Byte) As Byte¶Parameter: |
|
---|---|
Rückgabe: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
SetWriteFirmwarePointer()
gesetzt wurde. Die Firmware wird
alle 4 Datenblöcke in den Flash geschrieben.
Eine Firmware kann nur im Bootloader-Mode geschrieben werden.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
BrickletSilentStepperV2.
WriteUID
(ByVal uid As Long)¶Parameter: |
|
---|
Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.
Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.
BrickletSilentStepperV2.
ReadUID
() As Long¶Rückgabe: |
|
---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.
BrickletSilentStepperV2.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Silent Stepper Bricklet 2.0 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.
BrickletSilentStepperV2.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Silent Stepper Bricklet 2.0 dar.