Visual Basic .NET - Silent Stepper Bricklet 2.0

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.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Configuration

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

Callback

Download (ExampleCallback.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
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

API

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.

Grundfunktionen

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

Sub BrickletSilentStepperV2.SetMaxVelocity(ByVal velocity As Integer)
Parameter:
  • velocity – Typ: Integer, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]

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.

Function BrickletSilentStepperV2.GetMaxVelocity() As Integer
Rückgabe:
  • velocity – Typ: Integer, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]

Gibt die Geschwindigkeit zurück, wie von SetMaxVelocity() gesetzt.

Function BrickletSilentStepperV2.GetCurrentVelocity() As Integer
Rückgabe:
  • velocity – Typ: Integer, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]

Gibt die aktuelle Geschwindigkeit des Schrittmotors zurück.

Sub BrickletSilentStepperV2.SetSpeedRamping(ByVal acceleration As Integer, ByVal deacceleration As Integer)
Parameter:
  • acceleration – Typ: Integer, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000
  • deacceleration – Typ: Integer, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000

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

Sub BrickletSilentStepperV2.GetSpeedRamping(ByRef acceleration As Integer, ByRef deacceleration As Integer)
Ausgabeparameter:
  • acceleration – Typ: Integer, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000
  • deacceleration – Typ: Integer, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000

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

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

Sub BrickletSilentStepperV2.SetSteps(ByVal steps As Integer)
Parameter:
  • steps – Typ: Integer, Wertebereich: [-231 bis 231 - 1]

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.

Function BrickletSilentStepperV2.GetSteps() As Integer
Rückgabe:
  • steps – Typ: Integer, Wertebereich: [-231 bis 231 - 1]

Gibt die letzten Schritte zurück, wie von SetSteps() gesetzt.

Function BrickletSilentStepperV2.GetRemainingSteps() As Integer
Rückgabe:
  • steps – Typ: Integer, Wertebereich: [-231 bis 231 - 1]

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.

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

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

Sub BrickletSilentStepperV2.Stop()

Stoppt den Schrittmotor mit der Verzögerung, wie von SetSpeedRamping() gesetzt.

Sub BrickletSilentStepperV2.SetMotorCurrent(ByVal current As Integer)
Parameter:
  • current – Typ: Integer, Einheit: 1 mA, Wertebereich: [360 bis 1640], Standardwert: 800

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.

Function BrickletSilentStepperV2.GetMotorCurrent() As Integer
Rückgabe:
  • current – Typ: Integer, Einheit: 1 mA, Wertebereich: [360 bis 1640], Standardwert: 800

Gibt den Strom zurück, wie von SetMotorCurrent() gesetzt.

Sub BrickletSilentStepperV2.SetEnabled(ByVal enabled As Boolean)
Parameter:
  • enabled – Typ: Boolean, Standardwert: false

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.

Function BrickletSilentStepperV2.GetEnabled() As Boolean
Rückgabe:
  • enabled – Typ: Boolean, Standardwert: false

Gibt zurück ob der Schrittmotortreiber aktiviert ist.

Sub 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:
  • standstillCurrent – Typ: Integer, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1], Standardwert: 200
  • motorRunCurrent – Typ: Integer, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1], Standardwert: 800
  • standstillDelayTime – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 307], Standardwert: 0
  • powerDownTime – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 5222], Standardwert: 1000
  • stealthThreshold – Typ: Integer, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1], Standardwert: 500
  • coolstepThreshold – Typ: Integer, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1], Standardwert: 500
  • classicThreshold – Typ: Integer, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1], Standardwert: 1000
  • highVelocityChopperMode – Typ: Boolean, Standardwert: false

Setzt die Basiskonfiguration-Parameter für verschiedene Modi (Stealth, Coolstep, Classic).

  • Standstill Current: Mit diesem Wert kann der Phasenstrom im Stillstand reduziert werden. Dies ist zum Beispiel sinnvoll um das Aufheizen des Motors zu verringern. Wenn der Motor steht wird dieser mit dem eingestellte Phasenstrom betrieben bis die eingestellte Power Down Time um ist. Danach wird der Phasenstrom schrittweise bis zum Standstill Current reduziert. Die dafür benötigte Zeit wird mittels Power Down Time eingestellt. Der eingestellte Phasenstrom ist das Maximum für diesen Wert (see SetMotorCurrent()).
  • Motor Run Current: Dieser Wert setzt den Phasenstrom, wenn der Motor sich dreht. Ein Wert von mindestens der Hälfte des maximalen Phasenstrom sollte für gute Ergebnisse im Mikroschrittbetrieb gesetzt werden. Der maximal zulässige Wert ist der maximale Phasenstrom. Der eingegebene Wert wird von der API intern in einen Faktor im Bereich von 1/32 ... 32/32 umgerechnet, mit dem der Phasenstrom begrenzt wird. Der maximale Phasenstrom sollte im laufenden Betrieb nicht geändert werden. Für eine Änderung im laufenden Betrieb ist dieser Wert da (see SetMotorCurrent()).
  • Standstill Delay Time: Steuert die Zeit für das Verringern des Motorstroms bis zum Standstill Current. Eine hohe Standstill Delay Time führt zu einem ruhigen und ruckelfreien Übergang.
  • Power Down Time: Setzt die Wartezeit nach dem Stehenbleiben.
  • Stealth Threshold: Setzt den oberen Grenzwert für den Stealth Modus. Wenn die Geschwindigkeit des Motors über diesem Wert liegt wird der Stealth Modus abgeschaltet. Ansonsten angeschaltet. Im Stealth Modus nimmt das Drehmoment mit steigender Geschwindigkeit ab.
  • Coolstep Threshold: Setzt den unteren Grenzwert für den Coolstep Modus. Der Coolstep Grenzwert muss über dem Stealth Grenzwert liegen.
  • Classic Threshold: Sets den unteren Grenzwert für den Classic Modus. Im Classic Modus wird der Schrittmotor geräuschvoll aber das Drehmoment wird maximiert.
  • High Velocity Chopper Mode: Wenn der High Velocity Chopper Modus aktiviert wird, optimiert der Schrittmotortreiber die Ansteuerung des Motors für hohe Geschwindigkeiten.

Wenn alle drei Grenzwerte (Thresholds) genutzt werden sollen muss sichergestellt werden, dass Stealth Threshold < Coolstep Threshold < Classic Threshold.

Sub 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:
  • standstillCurrent – Typ: Integer, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1], Standardwert: 200
  • motorRunCurrent – Typ: Integer, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1], Standardwert: 800
  • standstillDelayTime – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 307], Standardwert: 0
  • powerDownTime – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 5222], Standardwert: 1000
  • stealthThreshold – Typ: Integer, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1], Standardwert: 500
  • coolstepThreshold – Typ: Integer, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1], Standardwert: 500
  • classicThreshold – Typ: Integer, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1], Standardwert: 1000
  • highVelocityChopperMode – Typ: Boolean, Standardwert: false

Gibt die Konfiguration zurück, wie von SetBasicConfiguration() gesetzt.

Sub BrickletSilentStepperV2.SetGPIOConfiguration(ByVal channel As Byte, ByVal debounce As Integer, ByVal stopDeceleration As Integer)
Parameter:
  • channel – Typ: Byte, Wertebereich: [0 bis 1]
  • debounce – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 200
  • stopDeceleration – Typ: Integer, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 216 - 1

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

Sub BrickletSilentStepperV2.GetGPIOConfiguration(ByVal channel As Byte, ByRef debounce As Integer, ByRef stopDeceleration As Integer)
Parameter:
  • channel – Typ: Byte, Wertebereich: [0 bis 1]
Ausgabeparameter:
  • debounce – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 200
  • stopDeceleration – Typ: Integer, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 216 - 1

Gibt die GPIO-Konfiguration für einen Kanal zurück, wie von SetGPIOConfiguration() gesetzt.

Sub BrickletSilentStepperV2.SetGPIOAction(ByVal channel As Byte, ByVal action As Long)
Parameter:
  • channel – Typ: Byte, Wertebereich: [0 bis 1]
  • action – Typ: Long, Wertebereich: Siehe Konstanten, Standardwert: 0

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.GPIO_ACTION_NONE = 0
  • BrickletSilentStepperV2.GPIO_ACTION_NORMAL_STOP_RISING_EDGE = 1
  • BrickletSilentStepperV2.GPIO_ACTION_NORMAL_STOP_FALLING_EDGE = 2
  • BrickletSilentStepperV2.GPIO_ACTION_FULL_BRAKE_RISING_EDGE = 4
  • BrickletSilentStepperV2.GPIO_ACTION_FULL_BRAKE_FALLING_EDGE = 8
  • BrickletSilentStepperV2.GPIO_ACTION_CALLBACK_RISING_EDGE = 16
  • BrickletSilentStepperV2.GPIO_ACTION_CALLBACK_FALLING_EDGE = 32
Function BrickletSilentStepperV2.GetGPIOAction(ByVal channel As Byte) As Long
Parameter:
  • channel – Typ: Byte, Wertebereich: [0 bis 1]
Rückgabe:
  • action – Typ: Long, Wertebereich: Siehe Konstanten, Standardwert: 0

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.GPIO_ACTION_NONE = 0
  • BrickletSilentStepperV2.GPIO_ACTION_NORMAL_STOP_RISING_EDGE = 1
  • BrickletSilentStepperV2.GPIO_ACTION_NORMAL_STOP_FALLING_EDGE = 2
  • BrickletSilentStepperV2.GPIO_ACTION_FULL_BRAKE_RISING_EDGE = 4
  • BrickletSilentStepperV2.GPIO_ACTION_FULL_BRAKE_FALLING_EDGE = 8
  • BrickletSilentStepperV2.GPIO_ACTION_CALLBACK_RISING_EDGE = 16
  • BrickletSilentStepperV2.GPIO_ACTION_CALLBACK_FALLING_EDGE = 32
Function BrickletSilentStepperV2.GetGPIOState() As Boolean()
Rückgabe:
  • gpioState – Typ: Boolean Array, Länge: 2

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.

Fortgeschrittene Funktionen

Sub BrickletSilentStepperV2.SetCurrentPosition(ByVal position As Integer)
Parameter:
  • position – Typ: Integer, Wertebereich: [-231 bis 231 - 1]

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

Function BrickletSilentStepperV2.GetCurrentPosition() As Integer
Rückgabe:
  • position – Typ: Integer, Wertebereich: [-231 bis 231 - 1]

Gibt die aktuelle Position des Schrittmotors in Schritten zurück. Nach dem Hochfahren ist die Position 0. Die Schritte werden bei Verwendung aller möglichen Fahrfunktionen gezählt (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().

Sub BrickletSilentStepperV2.SetTargetPosition(ByVal position As Integer)
Parameter:
  • position – Typ: Integer, Wertebereich: [-231 bis 231 - 1]

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

Function BrickletSilentStepperV2.GetTargetPosition() As Integer
Rückgabe:
  • position – Typ: Integer, Wertebereich: [-231 bis 231 - 1]

Gibt die letzte Zielposition zurück, wie von SetTargetPosition() gesetzt.

Sub BrickletSilentStepperV2.SetStepConfiguration(ByVal stepResolution As Byte, ByVal interpolation As Boolean)
Parameter:
  • stepResolution – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0
  • interpolation – Typ: Boolean, Standardwert: true

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.STEP_RESOLUTION_1 = 8
  • BrickletSilentStepperV2.STEP_RESOLUTION_2 = 7
  • BrickletSilentStepperV2.STEP_RESOLUTION_4 = 6
  • BrickletSilentStepperV2.STEP_RESOLUTION_8 = 5
  • BrickletSilentStepperV2.STEP_RESOLUTION_16 = 4
  • BrickletSilentStepperV2.STEP_RESOLUTION_32 = 3
  • BrickletSilentStepperV2.STEP_RESOLUTION_64 = 2
  • BrickletSilentStepperV2.STEP_RESOLUTION_128 = 1
  • BrickletSilentStepperV2.STEP_RESOLUTION_256 = 0
Sub BrickletSilentStepperV2.GetStepConfiguration(ByRef stepResolution As Byte, ByRef interpolation As Boolean)
Ausgabeparameter:
  • stepResolution – Typ: Byte, Wertebereich: Siehe Konstanten
  • interpolation – Typ: Boolean, Standardwert: true

Gibt den Schrittmodus zurück, wie von SetStepConfiguration() gesetzt.

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

Für stepResolution:

  • BrickletSilentStepperV2.STEP_RESOLUTION_1 = 8
  • BrickletSilentStepperV2.STEP_RESOLUTION_2 = 7
  • BrickletSilentStepperV2.STEP_RESOLUTION_4 = 6
  • BrickletSilentStepperV2.STEP_RESOLUTION_8 = 5
  • BrickletSilentStepperV2.STEP_RESOLUTION_16 = 4
  • BrickletSilentStepperV2.STEP_RESOLUTION_32 = 3
  • BrickletSilentStepperV2.STEP_RESOLUTION_64 = 2
  • BrickletSilentStepperV2.STEP_RESOLUTION_128 = 1
  • BrickletSilentStepperV2.STEP_RESOLUTION_256 = 0
Function BrickletSilentStepperV2.GetInputVoltage() As Integer
Rückgabe:
  • voltage – Typ: Integer, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

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.

Sub 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:
  • slowDecayDuration – Typ: Byte, Wertebereich: [0 bis 15], Standardwert: 4
  • enableRandomSlowDecay – Typ: Boolean, Standardwert: false
  • fastDecayDuration – Typ: Byte, Wertebereich: [0 bis 15], Standardwert: 0
  • hysteresisStartValue – Typ: Byte, Wertebereich: [0 bis 7], Standardwert: 0
  • hysteresisEndValue – Typ: Short, Wertebereich: [-3 bis 12], Standardwert: 0
  • sineWaveOffset – Typ: Short, Wertebereich: [-3 bis 12], Standardwert: 0
  • chopperMode – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0
  • comparatorBlankTime – Typ: Byte, Wertebereich: [0 bis 3], Standardwert: 1
  • fastDecayWithoutComparator – Typ: Boolean, Standardwert: false

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

    • 0 = 16 Takte,
    • 1 = 24 Takte,
    • 2 = 36 Takte und
    • 3 = 54 Takte.

    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.CHOPPER_MODE_SPREAD_CYCLE = 0
  • BrickletSilentStepperV2.CHOPPER_MODE_FAST_DECAY = 1
Sub 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:
  • slowDecayDuration – Typ: Byte, Wertebereich: [0 bis 15], Standardwert: 4
  • enableRandomSlowDecay – Typ: Boolean, Standardwert: false
  • fastDecayDuration – Typ: Byte, Wertebereich: [0 bis 15], Standardwert: 0
  • hysteresisStartValue – Typ: Byte, Wertebereich: [0 bis 7], Standardwert: 0
  • hysteresisEndValue – Typ: Short, Wertebereich: [-3 bis 12], Standardwert: 0
  • sineWaveOffset – Typ: Short, Wertebereich: [-3 bis 12], Standardwert: 0
  • chopperMode – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0
  • comparatorBlankTime – Typ: Byte, Wertebereich: [0 bis 3], Standardwert: 1
  • fastDecayWithoutComparator – Typ: Boolean, Standardwert: false

Gibt die Konfiguration zurück, wie von SetBasicConfiguration() gesetzt.

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

Für chopperMode:

  • BrickletSilentStepperV2.CHOPPER_MODE_SPREAD_CYCLE = 0
  • BrickletSilentStepperV2.CHOPPER_MODE_FAST_DECAY = 1
Sub 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:
  • enableStealth – Typ: Boolean, Standardwert: true
  • amplitude – Typ: Byte, Wertebereich: [0 bis 255], Standardwert: 128
  • gradient – Typ: Byte, Wertebereich: [0 bis 255], Standardwert: 4
  • enableAutoscale – Typ: Boolean, Standardwert: true
  • forceSymmetric – Typ: Boolean, Standardwert: false
  • freewheelMode – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0

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.

  • Enable Stealth: Stealth Modus wird aktiviert, wenn dieser Wert auf True gesetzt wird. Ansonsten ist der Modus deaktiviert auch wenn die Geschwindigkeit des Motors unter dem Grenzwert, der mittels SetBasicConfiguration() gesetzt wurde, liegt.
  • Amplitude: Wenn Autoscale aktiviert wurde, wird die PWM Amplitude mit diesem Wert skaliert. Wenn autoscale deaktiviert ist, definiert dieser Wert die maximale PWM Amplitudenänderungen pro Halbwelle.
  • Gradient: Wenn Autoscale deaktiviert wurde, wird der PWM Steigung (Gradient) bei diesem Wert skaliert. Wird Autoscale aktiviert, definiert dieser Wert die maximale PWM Steigung. Mit Autoscale wird ein Wert über 64 empfohlen, ansonsten kann es sein, dass die Regelung den Strom nicht korrekt messen kann.
  • Enable Autoscale: Die automatische Stromregelung ist aktiviert, wenn dieser Wert auf True gesetzt wird. Ansonsten werden die vom Nutzer definierten Amplituden und Steigungen genutzt.
  • Force Symmetric: Wenn auf True gesetzt wird, dann wird ein symmetrisches PWM erzwungen. Ansonsten kann sich der PWM Wert innerhalb eines PWM Taktes ändern.
  • Freewheel Mode: Der Freewheel Modus definiert das Verhalten im Stillstand, wenn der Standstill Current (siehe SetBasicConfiguration()) auf 0 gesetzt wurde.

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

Für freewheelMode:

  • BrickletSilentStepperV2.FREEWHEEL_MODE_NORMAL = 0
  • BrickletSilentStepperV2.FREEWHEEL_MODE_FREEWHEELING = 1
  • BrickletSilentStepperV2.FREEWHEEL_MODE_COIL_SHORT_LS = 2
  • BrickletSilentStepperV2.FREEWHEEL_MODE_COIL_SHORT_HS = 3
Sub 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:
  • enableStealth – Typ: Boolean, Standardwert: true
  • amplitude – Typ: Byte, Wertebereich: [0 bis 255], Standardwert: 128
  • gradient – Typ: Byte, Wertebereich: [0 bis 255], Standardwert: 4
  • enableAutoscale – Typ: Boolean, Standardwert: true
  • forceSymmetric – Typ: Boolean, Standardwert: false
  • freewheelMode – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt die Konfiguration zurück, wie von SetStealthConfiguration() gesetzt.

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

Für freewheelMode:

  • BrickletSilentStepperV2.FREEWHEEL_MODE_NORMAL = 0
  • BrickletSilentStepperV2.FREEWHEEL_MODE_FREEWHEELING = 1
  • BrickletSilentStepperV2.FREEWHEEL_MODE_COIL_SHORT_LS = 2
  • BrickletSilentStepperV2.FREEWHEEL_MODE_COIL_SHORT_HS = 3
Sub 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:
  • minimumStallguardValue – Typ: Byte, Wertebereich: [0 bis 15], Standardwert: 2
  • maximumStallguardValue – Typ: Byte, Wertebereich: [0 bis 15], Standardwert: 10
  • currentUpStepWidth – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0
  • currentDownStepWidth – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0
  • minimumCurrent – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0
  • stallguardThresholdValue – Typ: Short, Wertebereich: [-64 bis 63], Standardwert: 0
  • stallguardMode – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0

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.

  • Minimum Stallguard Value: Wenn der Stallguard-Wert unter diesem Wert*32 fällt wird der Motorstrom erhöht um den Motorbelastungswinkel (motor load angle) zu reduzieren. Ein Wert von 0 deaktiviert Coolstep.
  • Maximum Stallguard Value: Wenn der Stallguard-Wert über (Min Stallguard Value + Max Stallguard Value + 1)*32 geht wird der Motorstrom verringert um Energie zu sparen.
  • Current Up Step Width: Setzt das Inkrement pro Stallguard-Wert. Der Wertebereich ist 0-3, was mit den Inkrementen 1, 2, 4 und 8 korrespondiert.
  • Current Down Step Width: Setzt das Decrement pro Stallguard-Wert. Der Wertebereich ist 0-3, was mit den Dekrementen 1, 2, 8 und 16 korrespondiert.
  • Minimum Current: Setzt den minimalen Strom für die Coolstep Stromregelung. Es kann zwischen der Hälfte und einem Viertel des Motorstroms gewählt werden.
  • Stallguard Threshold Value: Setzt den Grenzwert für die Stall-Ausgabe (Motor blockiert) (siehe 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.
  • Stallguard Mode: Setze 0 für eine Standardauflösung und 1 für Filtered Mode. Im Filtered Modus wird das Stallguard Signal nur alle vier Vollschritte aktualisiert.

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

Für currentUpStepWidth:

  • BrickletSilentStepperV2.CURRENT_UP_STEP_INCREMENT_1 = 0
  • BrickletSilentStepperV2.CURRENT_UP_STEP_INCREMENT_2 = 1
  • BrickletSilentStepperV2.CURRENT_UP_STEP_INCREMENT_4 = 2
  • BrickletSilentStepperV2.CURRENT_UP_STEP_INCREMENT_8 = 3

Für currentDownStepWidth:

  • BrickletSilentStepperV2.CURRENT_DOWN_STEP_DECREMENT_1 = 0
  • BrickletSilentStepperV2.CURRENT_DOWN_STEP_DECREMENT_2 = 1
  • BrickletSilentStepperV2.CURRENT_DOWN_STEP_DECREMENT_8 = 2
  • BrickletSilentStepperV2.CURRENT_DOWN_STEP_DECREMENT_32 = 3

Für minimumCurrent:

  • BrickletSilentStepperV2.MINIMUM_CURRENT_HALF = 0
  • BrickletSilentStepperV2.MINIMUM_CURRENT_QUARTER = 1

Für stallguardMode:

  • BrickletSilentStepperV2.STALLGUARD_MODE_STANDARD = 0
  • BrickletSilentStepperV2.STALLGUARD_MODE_FILTERED = 1
Sub 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:
  • minimumStallguardValue – Typ: Byte, Wertebereich: [0 bis 15], Standardwert: 2
  • maximumStallguardValue – Typ: Byte, Wertebereich: [0 bis 15], Standardwert: 10
  • currentUpStepWidth – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0
  • currentDownStepWidth – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0
  • minimumCurrent – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0
  • stallguardThresholdValue – Typ: Short, Wertebereich: [-64 bis 63], Standardwert: 0
  • stallguardMode – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt die Konfiguration zurück, wie von SetCoolstepConfiguration() gesetzt.

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

Für currentUpStepWidth:

  • BrickletSilentStepperV2.CURRENT_UP_STEP_INCREMENT_1 = 0
  • BrickletSilentStepperV2.CURRENT_UP_STEP_INCREMENT_2 = 1
  • BrickletSilentStepperV2.CURRENT_UP_STEP_INCREMENT_4 = 2
  • BrickletSilentStepperV2.CURRENT_UP_STEP_INCREMENT_8 = 3

Für currentDownStepWidth:

  • BrickletSilentStepperV2.CURRENT_DOWN_STEP_DECREMENT_1 = 0
  • BrickletSilentStepperV2.CURRENT_DOWN_STEP_DECREMENT_2 = 1
  • BrickletSilentStepperV2.CURRENT_DOWN_STEP_DECREMENT_8 = 2
  • BrickletSilentStepperV2.CURRENT_DOWN_STEP_DECREMENT_32 = 3

Für minimumCurrent:

  • BrickletSilentStepperV2.MINIMUM_CURRENT_HALF = 0
  • BrickletSilentStepperV2.MINIMUM_CURRENT_QUARTER = 1

Für stallguardMode:

  • BrickletSilentStepperV2.STALLGUARD_MODE_STANDARD = 0
  • BrickletSilentStepperV2.STALLGUARD_MODE_FILTERED = 1
Sub BrickletSilentStepperV2.SetMiscConfiguration(ByVal disableShortToGroundProtection As Boolean, ByVal synchronizePhaseFrequency As Byte)
Parameter:
  • disableShortToGroundProtection – Typ: Boolean, Standardwert: false
  • synchronizePhaseFrequency – Typ: Byte, Wertebereich: [0 bis 15], Standardwert: 0

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.

  • Disable Short To Ground Protection: Setze diesen Wert auf False um den Kurzschluss nach Masse Schutz zu aktivieren. Ansonsten ist dieser deaktiviert.
  • Synchronize Phase Frequency: Mit diesem Parameter kann der Chopper für beide Phasen eines zweiphasen Motors synchronisiert werden. Der Wertebereich ist 0-15. Wenn der Wert auf 0 gesetzt wird ist die Synchronisation abgeschaltet. Ansonsten wird die Synchronisation mit folgender Formel durchgeführt: f_sync = f_clk/(value*64). Im Classic Modus ist die Synchronisation automatisch abgeschaltet. f_clk ist 12.8MHz.
Sub BrickletSilentStepperV2.GetMiscConfiguration(ByRef disableShortToGroundProtection As Boolean, ByRef synchronizePhaseFrequency As Byte)
Ausgabeparameter:
  • disableShortToGroundProtection – Typ: Boolean, Standardwert: false
  • synchronizePhaseFrequency – Typ: Byte, Wertebereich: [0 bis 15], Standardwert: 0

Gibt die Konfiguration zurück, wie von SetMiscConfiguration() gesetzt.

Sub BrickletSilentStepperV2.SetErrorLEDConfig(ByVal config As Byte)
Parameter:
  • config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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:

  • Aus: Es liegt kein Fehler vor.
  • 250ms Intervall-Blinken: Übertemperaturwarnung.
  • 1s Intervall-Blinken: Eingangsspannung zu gering.
  • Durchgängig rot: Motor deaktiviert auf Grund von Kurzschluss mit Masse in Phase A oder B oder auf Grund von zu hoher Temperatur.

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

Für config:

  • BrickletSilentStepperV2.ERROR_LED_CONFIG_OFF = 0
  • BrickletSilentStepperV2.ERROR_LED_CONFIG_ON = 1
  • BrickletSilentStepperV2.ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletSilentStepperV2.ERROR_LED_CONFIG_SHOW_ERROR = 3
Function BrickletSilentStepperV2.GetErrorLEDConfig() As Byte
Rückgabe:
  • config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die LED-Konfiguration zurück, wie von SetErrorLEDConfig() gesetzt.

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

Für config:

  • BrickletSilentStepperV2.ERROR_LED_CONFIG_OFF = 0
  • BrickletSilentStepperV2.ERROR_LED_CONFIG_ON = 1
  • BrickletSilentStepperV2.ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletSilentStepperV2.ERROR_LED_CONFIG_SHOW_ERROR = 3
Sub 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:
  • openLoad – Typ: Byte, Wertebereich: Siehe Konstanten
  • shortToGround – Typ: Byte, Wertebereich: Siehe Konstanten
  • overTemperature – Typ: Byte, Wertebereich: Siehe Konstanten
  • motorStalled – Typ: Boolean
  • actualMotorCurrent – Typ: Byte, Wertebereich: [0 bis 31]
  • fullStepActive – Typ: Boolean
  • stallguardResult – Typ: Byte, Wertebereich: [0 bis 255]
  • stealthVoltageAmplitude – Typ: Byte, Wertebereich: [0 bis 255]

Gibt den aktuellen Treiberstatus zurück.

  • Open Load: Gibt an, dass keine Last an den Phasen A oder B, oder bei beiden vorhanden ist (open load). In dem Fall kann es ein Problem mit der Verkabelung des Motors geben. Es kann aber auch Fehlmeldungen geben, wenn der Motor sich schnell bewegt oder sich im Stillstand befindet.
  • Short To Ground: Gibt an, dass es einen Kurzschluss zwischen einer Phase (A,B) oder beiden Phasen nach Masse gibt. Wenn dies erkannt wird, wird der Treiber automatisch deaktiviert und muss wieder manuell aktiviert werden.
  • Over Temperature: Wenn der Treiber sich aufwärmt gibt dieser Status "Warning" aus. Dies ist erwartet, wenn der Motor längere Zeit benutzt wird. Wenn das Temperaturlimit erreicht wird ändert sich der Status zu "Limit". In diesem Fall wird der Treiber automatisch deaktiviert bis er sich wieder abgekühlt hat.
  • Motor Stalled: Ist True, wenn erkannt wurde, dass der Motor blockiert.
  • Actual Motor Current: Gibt die aktuelle Motorstromskalierung im Coolstep Modus aus. Er repräsentiert einer Multiplikator von 1/32 bis zu 32/32 vom 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.
  • Stallguard Result: Der Stallguard Wert gibt einen Hinweis auf die Last des Motors. Ein niedriger Wert bedeutet eine höhere Last. Über Ausprobieren kann man mit diesem Wert herausfinden, welcher Wert zu einem geeigneten Drehmoment bei der aktuellen Geschwindigkeit führt. Danach kann über diesen Wert herausgefunden werden, wenn eine Blockierung des Motors wahrscheinlich wird und es kann dementsprechend darauf reagiert werden (z.B. indem die Geschwindigkeit reduziert wird). Im Stillstand kann dieser Wert nicht benutzt werden. Er zeigt dann die Chopper On-Time für Motorspule A.
  • Stealth Voltage Amplitude: Zeigt das aktuelle PWM Scaling. Im Stealth Modus kann dieser Wert benutzt werden um die Motorlast abzuschätzen und eine Blockierung erkannt werden, wenn autoscale aktiviert wurde (see SetStealthConfiguration()).

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

Für openLoad:

  • BrickletSilentStepperV2.OPEN_LOAD_NONE = 0
  • BrickletSilentStepperV2.OPEN_LOAD_PHASE_A = 1
  • BrickletSilentStepperV2.OPEN_LOAD_PHASE_B = 2
  • BrickletSilentStepperV2.OPEN_LOAD_PHASE_AB = 3

Für shortToGround:

  • BrickletSilentStepperV2.SHORT_TO_GROUND_NONE = 0
  • BrickletSilentStepperV2.SHORT_TO_GROUND_PHASE_A = 1
  • BrickletSilentStepperV2.SHORT_TO_GROUND_PHASE_B = 2
  • BrickletSilentStepperV2.SHORT_TO_GROUND_PHASE_AB = 3

Für overTemperature:

  • BrickletSilentStepperV2.OVER_TEMPERATURE_NONE = 0
  • BrickletSilentStepperV2.OVER_TEMPERATURE_WARNING = 1
  • BrickletSilentStepperV2.OVER_TEMPERATURE_LIMIT = 2
Sub BrickletSilentStepperV2.SetTimeBase(ByVal timeBase As Long)
Parameter:
  • timeBase – Typ: Long, Einheit: 1 s, Wertebereich: [0 bis 232 - 1], Standardwert: 1

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.

Function BrickletSilentStepperV2.GetTimeBase() As Long
Rückgabe:
  • timeBase – Typ: Long, Einheit: 1 s, Wertebereich: [0 bis 232 - 1], Standardwert: 1

Gibt die Zeitbasis zurück, wie von SetTimeBase() gesetzt.

Sub BrickletSilentStepperV2.GetAllData(ByRef currentVelocity As Integer, ByRef currentPosition As Integer, ByRef remainingSteps As Integer, ByRef inputVoltage As Integer, ByRef currentConsumption As Integer)
Ausgabeparameter:
  • currentVelocity – Typ: Integer, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]
  • currentPosition – Typ: Integer, Wertebereich: [-231 bis 231 - 1]
  • remainingSteps – Typ: Integer, Wertebereich: [-231 bis 231 - 1]
  • inputVoltage – Typ: Integer, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
  • currentConsumption – Typ: Integer, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

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

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.

Sub BrickletSilentStepperV2.GetSPITFPErrorCount(ByRef errorCountAckChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)
Ausgabeparameter:
  • errorCountAckChecksum – Typ: Long, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: Long, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: Long, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: Long, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

Sub BrickletSilentStepperV2.SetStatusLEDConfig(ByVal config As Byte)
Parameter:
  • config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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.STATUS_LED_CONFIG_OFF = 0
  • BrickletSilentStepperV2.STATUS_LED_CONFIG_ON = 1
  • BrickletSilentStepperV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletSilentStepperV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
Function BrickletSilentStepperV2.GetStatusLEDConfig() As Byte
Rückgabe:
  • config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von SetStatusLEDConfig() gesetzt.

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

Für config:

  • BrickletSilentStepperV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletSilentStepperV2.STATUS_LED_CONFIG_ON = 1
  • BrickletSilentStepperV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletSilentStepperV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
Function BrickletSilentStepperV2.GetChipTemperature() As Short
Rückgabe:
  • temperature – Typ: Short, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

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

Sub 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:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: Char, Wertebereich: ["a"C bis "h"C, "z"C]
  • hardwareVersion – Typ: Byte Array, Länge: 3
    • 0: major – Typ: Byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Byte, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: Byte Array, Länge: 3
    • 0: major – Typ: Byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Byte, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: Integer, Wertebereich: [0 bis 216 - 1]

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.

Konfigurationsfunktionen für Callbacks

Sub BrickletSilentStepperV2.SetMinimumVoltage(ByVal voltage As Integer)
Parameter:
  • voltage – Typ: Integer, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 8000

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.

Function BrickletSilentStepperV2.GetMinimumVoltage() As Integer
Rückgabe:
  • voltage – Typ: Integer, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 8000

Gibt die minimale Spannung zurück, wie von SetMinimumVoltage() gesetzt.

Sub BrickletSilentStepperV2.SetAllCallbackConfiguration(ByVal period As Long)
Parameter:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

Function BrickletSilentStepperV2.GetAllDataCallbackConfiguraton() As Long
Rückgabe:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetAllCallbackConfiguration() gesetzt.

Callbacks

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.

Event BrickletSilentStepperV2.UnderVoltageCallback(ByVal sender As BrickletSilentStepperV2, ByVal voltage As Integer)
Callback-Parameter:
  • sender – Typ: BrickletSilentStepperV2
  • voltage – Typ: Integer, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird ausgelöst, wenn die Eingangsspannung unter den, mittels SetMinimumVoltage() gesetzten, Schwellwert sinkt. Der Parameter ist die aktuelle Spannung.

Event BrickletSilentStepperV2.PositionReachedCallback(ByVal sender As BrickletSilentStepperV2, ByVal position As Integer)
Callback-Parameter:
  • sender – Typ: BrickletSilentStepperV2
  • position – Typ: Integer, Wertebereich: [-231 bis 231 - 1]

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 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:
  • sender – Typ: BrickletSilentStepperV2
  • currentVelocity – Typ: Integer, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]
  • currentPosition – Typ: Integer, Wertebereich: [-231 bis 231 - 1]
  • remainingSteps – Typ: Integer, Wertebereich: [-231 bis 231 - 1]
  • inputVoltage – Typ: Integer, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
  • currentConsumption – Typ: Integer, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

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.

Event BrickletSilentStepperV2.NewStateCallback(ByVal sender As BrickletSilentStepperV2, ByVal stateNew As Byte, ByVal statePrevious As Byte)
Callback-Parameter:
  • sender – Typ: BrickletSilentStepperV2
  • stateNew – Typ: Byte, Wertebereich: Siehe Konstanten
  • statePrevious – Typ: Byte, Wertebereich: Siehe Konstanten

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:

  • BrickletSilentStepperV2.STATE_STOP = 1
  • BrickletSilentStepperV2.STATE_ACCELERATION = 2
  • BrickletSilentStepperV2.STATE_RUN = 3
  • BrickletSilentStepperV2.STATE_DEACCELERATION = 4
  • BrickletSilentStepperV2.STATE_DIRECTION_CHANGE_TO_FORWARD = 5
  • BrickletSilentStepperV2.STATE_DIRECTION_CHANGE_TO_BACKWARD = 6

Für statePrevious:

  • BrickletSilentStepperV2.STATE_STOP = 1
  • BrickletSilentStepperV2.STATE_ACCELERATION = 2
  • BrickletSilentStepperV2.STATE_RUN = 3
  • BrickletSilentStepperV2.STATE_DEACCELERATION = 4
  • BrickletSilentStepperV2.STATE_DIRECTION_CHANGE_TO_FORWARD = 5
  • BrickletSilentStepperV2.STATE_DIRECTION_CHANGE_TO_BACKWARD = 6
Event BrickletSilentStepperV2.GPIOStateCallback(ByVal sender As BrickletSilentStepperV2, ByVal gpioState() As Boolean)
Callback-Parameter:
  • sender – Typ: BrickletSilentStepperV2
  • gpioState – Typ: Boolean Array, Länge: 2

Dieser Callback wird ausgelöst durch GPIO-Änderungen wenn er über SetGPIOAction() aktiviert wurde.

Virtuelle Funktionen

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.

Function BrickletSilentStepperV2.GetAPIVersion() As Byte()
Ausgabeparameter:
  • apiVersion – Typ: Byte Array, Länge: 3
    • 0: major – Typ: Byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Byte, Wertebereich: [0 bis 255]

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.

Function BrickletSilentStepperV2.GetResponseExpected(ByVal functionId As Byte) As Boolean
Parameter:
  • functionId – Typ: Byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: Boolean

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.FUNCTION_SET_MAX_VELOCITY = 1
  • BrickletSilentStepperV2.FUNCTION_SET_SPEED_RAMPING = 4
  • BrickletSilentStepperV2.FUNCTION_FULL_BRAKE = 6
  • BrickletSilentStepperV2.FUNCTION_SET_CURRENT_POSITION = 7
  • BrickletSilentStepperV2.FUNCTION_SET_TARGET_POSITION = 9
  • BrickletSilentStepperV2.FUNCTION_SET_STEPS = 11
  • BrickletSilentStepperV2.FUNCTION_SET_STEP_CONFIGURATION = 14
  • BrickletSilentStepperV2.FUNCTION_DRIVE_FORWARD = 16
  • BrickletSilentStepperV2.FUNCTION_DRIVE_BACKWARD = 17
  • BrickletSilentStepperV2.FUNCTION_STOP = 18
  • BrickletSilentStepperV2.FUNCTION_SET_MOTOR_CURRENT = 22
  • BrickletSilentStepperV2.FUNCTION_SET_ENABLED = 24
  • BrickletSilentStepperV2.FUNCTION_SET_BASIC_CONFIGURATION = 26
  • BrickletSilentStepperV2.FUNCTION_SET_SPREADCYCLE_CONFIGURATION = 28
  • BrickletSilentStepperV2.FUNCTION_SET_STEALTH_CONFIGURATION = 30
  • BrickletSilentStepperV2.FUNCTION_SET_COOLSTEP_CONFIGURATION = 32
  • BrickletSilentStepperV2.FUNCTION_SET_MISC_CONFIGURATION = 34
  • BrickletSilentStepperV2.FUNCTION_SET_ERROR_LED_CONFIG = 36
  • BrickletSilentStepperV2.FUNCTION_SET_MINIMUM_VOLTAGE = 39
  • BrickletSilentStepperV2.FUNCTION_SET_TIME_BASE = 43
  • BrickletSilentStepperV2.FUNCTION_SET_ALL_CALLBACK_CONFIGURATION = 46
  • BrickletSilentStepperV2.FUNCTION_SET_GPIO_CONFIGURATION = 48
  • BrickletSilentStepperV2.FUNCTION_SET_GPIO_ACTION = 50
  • BrickletSilentStepperV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletSilentStepperV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletSilentStepperV2.FUNCTION_RESET = 243
  • BrickletSilentStepperV2.FUNCTION_WRITE_UID = 248
Sub BrickletSilentStepperV2.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)
Parameter:
  • functionId – Typ: Byte, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: Boolean

Ä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.FUNCTION_SET_MAX_VELOCITY = 1
  • BrickletSilentStepperV2.FUNCTION_SET_SPEED_RAMPING = 4
  • BrickletSilentStepperV2.FUNCTION_FULL_BRAKE = 6
  • BrickletSilentStepperV2.FUNCTION_SET_CURRENT_POSITION = 7
  • BrickletSilentStepperV2.FUNCTION_SET_TARGET_POSITION = 9
  • BrickletSilentStepperV2.FUNCTION_SET_STEPS = 11
  • BrickletSilentStepperV2.FUNCTION_SET_STEP_CONFIGURATION = 14
  • BrickletSilentStepperV2.FUNCTION_DRIVE_FORWARD = 16
  • BrickletSilentStepperV2.FUNCTION_DRIVE_BACKWARD = 17
  • BrickletSilentStepperV2.FUNCTION_STOP = 18
  • BrickletSilentStepperV2.FUNCTION_SET_MOTOR_CURRENT = 22
  • BrickletSilentStepperV2.FUNCTION_SET_ENABLED = 24
  • BrickletSilentStepperV2.FUNCTION_SET_BASIC_CONFIGURATION = 26
  • BrickletSilentStepperV2.FUNCTION_SET_SPREADCYCLE_CONFIGURATION = 28
  • BrickletSilentStepperV2.FUNCTION_SET_STEALTH_CONFIGURATION = 30
  • BrickletSilentStepperV2.FUNCTION_SET_COOLSTEP_CONFIGURATION = 32
  • BrickletSilentStepperV2.FUNCTION_SET_MISC_CONFIGURATION = 34
  • BrickletSilentStepperV2.FUNCTION_SET_ERROR_LED_CONFIG = 36
  • BrickletSilentStepperV2.FUNCTION_SET_MINIMUM_VOLTAGE = 39
  • BrickletSilentStepperV2.FUNCTION_SET_TIME_BASE = 43
  • BrickletSilentStepperV2.FUNCTION_SET_ALL_CALLBACK_CONFIGURATION = 46
  • BrickletSilentStepperV2.FUNCTION_SET_GPIO_CONFIGURATION = 48
  • BrickletSilentStepperV2.FUNCTION_SET_GPIO_ACTION = 50
  • BrickletSilentStepperV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletSilentStepperV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletSilentStepperV2.FUNCTION_RESET = 243
  • BrickletSilentStepperV2.FUNCTION_WRITE_UID = 248
Sub BrickletSilentStepperV2.SetResponseExpectedAll(ByVal responseExpected As Boolean)
Parameter:
  • responseExpected – Typ: Boolean

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

Interne Funktionen

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

Function BrickletSilentStepperV2.SetBootloaderMode(ByVal mode As Byte) As Byte
Parameter:
  • mode – Typ: Byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: Byte, Wertebereich: Siehe Konstanten

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:

  • BrickletSilentStepperV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletSilentStepperV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletSilentStepperV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletSilentStepperV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletSilentStepperV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • BrickletSilentStepperV2.BOOTLOADER_STATUS_OK = 0
  • BrickletSilentStepperV2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletSilentStepperV2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletSilentStepperV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletSilentStepperV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletSilentStepperV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
Function BrickletSilentStepperV2.GetBootloaderMode() As Byte
Rückgabe:
  • mode – Typ: Byte, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode().

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

Für mode:

  • BrickletSilentStepperV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletSilentStepperV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletSilentStepperV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletSilentStepperV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletSilentStepperV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
Sub BrickletSilentStepperV2.SetWriteFirmwarePointer(ByVal pointer As Long)
Parameter:
  • pointer – Typ: Long, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

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.

Function BrickletSilentStepperV2.WriteFirmware(ByVal data() As Byte) As Byte
Parameter:
  • data – Typ: Byte Array, Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: Byte, Wertebereich: [0 bis 255]

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.

Sub BrickletSilentStepperV2.WriteUID(ByVal uid As Long)
Parameter:
  • uid – Typ: Long, Wertebereich: [0 bis 232 - 1]

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.

Function BrickletSilentStepperV2.ReadUID() As Long
Rückgabe:
  • uid – Typ: Long, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

Konstanten

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

Const BrickletSilentStepperV2.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Silent Stepper Bricklet 2.0 dar.