Shell - Silent Stepper Brick¶

Configuration¶

Download (example-configuration.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XXYYZZ # Change XXYYZZ to the UID of your Silent Stepper Brick

tinkerforge call silent-stepper-brick $uid set-motor-current 800 # 800 mA
tinkerforge call silent-stepper-brick $uid set-step-configuration step-resolution-8 true # 1/8 steps (interpolated)
tinkerforge call silent-stepper-brick $uid set-max-velocity 2000 # Velocity 2000 steps/s

# Slow acceleration (500 steps/s^2),
# Fast deacceleration (5000 steps/s^2)
tinkerforge call silent-stepper-brick $uid set-speed-ramping 500 5000

tinkerforge call silent-stepper-brick $uid enable # Enable motor power
tinkerforge call silent-stepper-brick $uid set-steps 60000 # Drive 60000 steps forward

echo "Press key to exit"; read dummy

# Stop motor before disabling motor power
tinkerforge call silent-stepper-brick $uid stop # Request motor stop
tinkerforge call silent-stepper-brick $uid set-speed-ramping 500 5000 # Fast deacceleration (5000 steps/s^2) for stopping
sleep 0.4 # Wait for motor to actually stop: max velocity (2000 steps/s) / decceleration (5000 steps/s^2) = 0.4 s
tinkerforge call silent-stepper-brick $uid disable # Disable motor power

Callback¶

Download (example-callback.sh)

 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

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XXYYZZ # Change XXYYZZ to the UID of your Silent Stepper Brick

# Use position reached callback to program random movement
tinkerforge dispatch silent-stepper-brick $uid position-reached\
 --execute "echo Changing configuration;
            tinkerforge call silent-stepper-brick $uid set-max-velocity $(((RANDOM%1800)+1200));
            tinkerforge call silent-stepper-brick $uid set-speed-ramping $(((RANDOM%900)+100)) $(((RANDOM%900)+100));
            if [ $((RANDOM % 2)) -eq 1 ];
            then tinkerforge call silent-stepper-brick $uid set-steps $(((RANDOM%4000)+1000));
            else tinkerforge call silent-stepper-brick $uid set-steps $(((RANDOM%4000)-5000));
            fi" &

tinkerforge call silent-stepper-brick $uid set-step-configuration step-resolution-8 true # 1/8 steps (interpolated)
tinkerforge call silent-stepper-brick $uid enable # Enable motor power
tinkerforge call silent-stepper-brick $uid set-steps 1 # Drive one step forward to get things going

echo "Press key to exit"; read dummy

# Stop motor before disabling motor power
tinkerforge call silent-stepper-brick $uid stop # Request motor stop
tinkerforge call silent-stepper-brick $uid set-speed-ramping 500 5000 # Fast deacceleration (5000 steps/s^2) for stopping
sleep 0.4 # Wait for motor to actually stop: max velocity (2000 steps/s) / decceleration (5000 steps/s^2) = 0.4 s
tinkerforge call silent-stepper-brick $uid disable # Disable motor power

kill -- -$$ # Stop callback dispatch in background

Befehlsstruktur¶

Allgemeine Optionen des call und des dispatch Befehls sind hier zu finden. Im Folgenden wird die spezifische Befehlsstruktur dargestellt.

tinkerforge call silent-stepper-brick [<option>..] <uid> <function> [<argument>..]¶

Parameter:	<uid> – Typ: String <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des Silent Stepper Brick aufzurufen. Der Befehl kennt mehrere Optionen:

• --help zeigt Hilfe für den spezifischen call Befehl an und endet dann
• --list-functions zeigt eine Liste der bekannten Funktionen des Silent Stepper Brick an und endet dann

tinkerforge dispatch silent-stepper-brick [<option>..] <uid> <callback>¶

Parameter:	<uid> – Typ: String <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des Silent Stepper Brick abzufertigen. Der Befehl kennt mehrere Optionen:

• --help zeigt Hilfe für den spezifischen dispatch Befehl an und endet dann
• --list-callbacks zeigt eine Liste der bekannten Callbacks des Silent Stepper Brick an und endet dann

tinkerforge call silent-stepper-brick <uid> <function> [<option>..] [<argument>..]¶

Parameter:	<uid> – Typ: String <function> – Typ: String

Abhängig von der Art der aufzurufenden <function> kennt diese verschiedene Optionen. Alle Funktionen kennen die folgenden Optionen:

• --help zeigt Hilfe für die spezifische <function> an und endet dann

Getter-Funktionen kennen zusätzlich die folgenden Optionen:

• --execute <command> Shell-Befehl der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Setter-Funktionen kennen zusätzlich die folgenden Optionen:

• --expect-response fragt Antwort an und wartet auf diese

Mit der --expect-response Option für Setter-Funktionen können Timeouts und andere Fehlerfälle auch für Aufrufe von Setter-Funktionen detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn diese Option für eine Setter-Funktion nicht angegeben ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

tinkerforge dispatch silent-stepper-brick <uid> <callback> [<option>..]¶

Parameter:	<uid> – Typ: String <callback> – Typ: String

Der abzufertigende <callback> kennt mehrere Optionen:

• --help zeigt Hilfe für den spezifische <callback> an und endet dann
• --execute <command> Shell-Befehlszeile der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Grundfunktionen¶

tinkerforge call silent-stepper-brick <uid> set-max-velocity <velocity>¶

Parameter:	<velocity> – Typ: Int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]
Ausgabe:	keine Ausgabe

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 set-target-position, set-steps, drive-forward oder drive-backward verwendet werden.

tinkerforge call silent-stepper-brick <uid> get-max-velocity¶

Ausgabe:	velocity – Typ: Int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]

Gibt die Geschwindigkeit zurück, wie von set-max-velocity gesetzt.

tinkerforge call silent-stepper-brick <uid> get-current-velocity¶

Ausgabe:	velocity – Typ: Int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]

Gibt die aktuelle Geschwindigkeit des Schrittmotors zurück.

tinkerforge call silent-stepper-brick <uid> set-speed-ramping <acceleration> <deacceleration>¶

Parameter:	<acceleration> – Typ: Int, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000 <deacceleration> – Typ: Int, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000
Ausgabe:	keine Ausgabe

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

tinkerforge call silent-stepper-brick <uid> get-speed-ramping¶

Ausgabe:	acceleration – Typ: Int, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000 deacceleration – Typ: Int, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000

Gibt die Beschleunigung und Verzögerung zurück, wie von set-speed-ramping gesetzt.

tinkerforge call silent-stepper-brick <uid> full-brake¶

Ausgabe:	keine Ausgabe

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.

tinkerforge call silent-stepper-brick <uid> set-steps <steps>¶

Parameter:	<steps> – Typ: Int, Wertebereich: [-231 bis 231 - 1]
Ausgabe:	keine Ausgabe

Setzt die Anzahl der Schritte die der Schrittmotor fahren soll. Positive Werte fahren den Motor vorwärts und negative rückwärts. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit set-max-velocity und set-speed-ramping gesetzt, verwendet.

tinkerforge call silent-stepper-brick <uid> get-steps¶

Ausgabe:	steps – Typ: Int, Wertebereich: [-231 bis 231 - 1]

Gibt die letzten Schritte zurück, wie von set-steps gesetzt.

tinkerforge call silent-stepper-brick <uid> get-remaining-steps¶

Ausgabe:	steps – Typ: Int, Wertebereich: [-231 bis 231 - 1]

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

tinkerforge call silent-stepper-brick <uid> drive-forward¶

Ausgabe:	keine Ausgabe

Fährt den Schrittmotor vorwärts bis drive-backward oder stop aufgerufen wird. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit set-max-velocity und set-speed-ramping gesetzt, verwendet.

tinkerforge call silent-stepper-brick <uid> drive-backward¶

Ausgabe:	keine Ausgabe

Fährt den Schrittmotor rückwärts bis drive-forward oder stop aufgerufen wird. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit set-max-velocity und set-speed-ramping gesetzt, verwendet.

tinkerforge call silent-stepper-brick <uid> stop¶

Ausgabe:	keine Ausgabe

Stoppt den Schrittmotor mit der Verzögerung, wie von set-speed-ramping gesetzt.

tinkerforge call silent-stepper-brick <uid> set-motor-current <current>¶

Parameter:	<current> – Typ: Int, Einheit: 1 mA, Wertebereich: [360 bis 1640], Standardwert: 800
Ausgabe:	keine Ausgabe

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.

tinkerforge call silent-stepper-brick <uid> get-motor-current¶

Ausgabe:	current – Typ: Int, Einheit: 1 mA, Wertebereich: [360 bis 1640], Standardwert: 800

Gibt den Strom zurück, wie von set-motor-current gesetzt.

tinkerforge call silent-stepper-brick <uid> enable¶

Ausgabe:	keine Ausgabe

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

tinkerforge call silent-stepper-brick <uid> disable¶

Ausgabe:	keine Ausgabe

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

Warnung

Die Treiberstufe zu deaktivieren während der Motor sich noch dreht kann zur Beschädigung der Treiberstufe führen. Der Motor sollte durch Aufrufen der 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 disable Funktion aufgerufen wird.

tinkerforge call silent-stepper-brick <uid> is-enabled¶

Ausgabe:	enabled – Typ: Bool, Standardwert: false

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

tinkerforge call silent-stepper-brick <uid> set-basic-configuration <standstill-current> <motor-run-current> <standstill-delay-time> <power-down-time> <stealth-threshold> <coolstep-threshold> <classic-threshold> <high-velocity-chopper-mode>¶

Parameter:

<standstill-current> – Typ: Int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1], Standardwert: 200 <motor-run-current> – Typ: Int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1], Standardwert: 800 <standstill-delay-time> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 307], Standardwert: 0 <power-down-time> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 5222], Standardwert: 1000 <stealth-threshold> – Typ: Int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1], Standardwert: 500 <coolstep-threshold> – Typ: Int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1], Standardwert: 500 <classic-threshold> – Typ: Int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1], Standardwert: 1000 <high-velocity-chopper-mode> – Typ: Bool, Standardwert: false

Ausgabe:

keine Ausgabe

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 set-motor-current).
• 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 set-motor-current).
• 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.

tinkerforge call silent-stepper-brick <uid> get-basic-configuration¶

Ausgabe:

standstill-current – Typ: Int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1], Standardwert: 200 motor-run-current – Typ: Int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1], Standardwert: 800 standstill-delay-time – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 307], Standardwert: 0 power-down-time – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 5222], Standardwert: 1000 stealth-threshold – Typ: Int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1], Standardwert: 500 coolstep-threshold – Typ: Int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1], Standardwert: 500 classic-threshold – Typ: Int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1], Standardwert: 1000 high-velocity-chopper-mode – Typ: Bool, Standardwert: false

Gibt die Konfiguration zurück, wie von set-basic-configuration gesetzt.

Fortgeschrittene Funktionen¶

tinkerforge call silent-stepper-brick <uid> set-current-position <position>¶

Parameter:	<position> – Typ: Int, Wertebereich: [-231 bis 231 - 1]
Ausgabe:	keine Ausgabe

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

tinkerforge call silent-stepper-brick <uid> get-current-position¶

Ausgabe:	position – Typ: Int, Wertebereich: [-231 bis 231 - 1]

Gibt die aktuelle Position des Schrittmotors in Schritten zurück. Nach dem Hochfahren ist die Position 0. Die Schritte werden bei Verwendung aller möglichen Fahrfunktionen gezählt (set-target-position, set-steps, drive-forward der drive-backward). Es ist auch möglich den Schrittzähler auf 0 oder jeden anderen gewünschten Wert zu setzen mit set-current-position.

tinkerforge call silent-stepper-brick <uid> set-target-position <position>¶

Parameter:	<position> – Typ: Int, Wertebereich: [-231 bis 231 - 1]
Ausgabe:	keine Ausgabe

Setzt die Zielposition des Schrittmotors in Schritten. Beispiel: Wenn die aktuelle Position des Motors 500 ist und set-target-position mit 1000 aufgerufen wird, dann verfährt der Schrittmotor 500 Schritte vorwärts. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit set-max-velocity und set-speed-ramping gesetzt, verwendet.

Ein Aufruf von set-target-position mit dem Parameter x ist äquivalent mit einem Aufruf von set-steps mit dem Parameter (x - get-current-position).

tinkerforge call silent-stepper-brick <uid> get-target-position¶

Ausgabe:	position – Typ: Int, Wertebereich: [-231 bis 231 - 1]

Gibt die letzte Zielposition zurück, wie von set-target-position gesetzt.

tinkerforge call silent-stepper-brick <uid> set-step-configuration <step-resolution> <interpolation>¶

Parameter:	<step-resolution> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0 <interpolation> – Typ: Bool, Standardwert: true
Ausgabe:	keine Ausgabe

Setzt die Schrittauflösung von Vollschritt bis zu 1/256 Schritt.

Wenn Interpolation aktiviert ist, führt der Silent Stepper Brick 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 Symbole sind für diese Funktion verfügbar:

Für <step-resolution>:

• step-resolution-1 = 8
• step-resolution-2 = 7
• step-resolution-4 = 6
• step-resolution-8 = 5
• step-resolution-16 = 4
• step-resolution-32 = 3
• step-resolution-64 = 2
• step-resolution-128 = 1
• step-resolution-256 = 0

tinkerforge call silent-stepper-brick <uid> get-step-configuration¶

Ausgabe:	step-resolution – Typ: Int, Wertebereich: Siehe Symbole interpolation – Typ: Bool, Standardwert: true

Gibt den Schrittmodus zurück, wie von set-step-configuration gesetzt.

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

Für step-resolution:

• step-resolution-1 = 8
• step-resolution-2 = 7
• step-resolution-4 = 6
• step-resolution-8 = 5
• step-resolution-16 = 4
• step-resolution-32 = 3
• step-resolution-64 = 2
• step-resolution-128 = 1
• step-resolution-256 = 0

tinkerforge call silent-stepper-brick <uid> get-stack-input-voltage¶

Ausgabe:	voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

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

tinkerforge call silent-stepper-brick <uid> get-external-input-voltage¶

Ausgabe:	voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Gibt die externe Eingangsspannung zurück. Die externe Eingangsspannung wird über die schwarze Stromversorgungsbuchse, in den Silent Stepper Brick, eingespeist.

Sobald eine externe Eingangsspannung und die Spannungsversorgung des Stapels anliegt, wird der Motor über die externe Spannung versorgt. Sollte nur die Spannungsversorgung des Stapels verfügbar sein, erfolgt die Versorgung des Motors über diese.

Warnung

Das bedeutet, bei einer hohen Versorgungsspannung des Stapels und einer geringen externen Versorgungsspannung erfolgt die Spannungsversorgung des Motors über die geringere externe Versorgungsspannung. Wenn dann die externe Spannungsversorgung getrennt wird, erfolgt sofort die Versorgung des Motors über die höhere Versorgungsspannung des Stapels.

tinkerforge call silent-stepper-brick <uid> set-spreadcycle-configuration <slow-decay-duration> <enable-random-slow-decay> <fast-decay-duration> <hysteresis-start-value> <hysteresis-end-value> <sine-wave-offset> <chopper-mode> <comparator-blank-time> <fast-decay-without-comparator>¶

Parameter:

<slow-decay-duration> – Typ: Int, Wertebereich: [0 bis 15], Standardwert: 4 <enable-random-slow-decay> – Typ: Bool, Standardwert: false <fast-decay-duration> – Typ: Int, Wertebereich: [0 bis 15], Standardwert: 0 <hysteresis-start-value> – Typ: Int, Wertebereich: [0 bis 7], Standardwert: 0 <hysteresis-end-value> – Typ: Int, Wertebereich: [-3 bis 12], Standardwert: 0 <sine-wave-offset> – Typ: Int, Wertebereich: [-3 bis 12], Standardwert: 0 <chopper-mode> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0 <comparator-blank-time> – Typ: Int, Wertebereich: [0 bis 3], Standardwert: 1 <fast-decay-without-comparator> – Typ: Bool, Standardwert: false

Ausgabe:

keine Ausgabe

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

Für <chopper-mode>:

• chopper-mode-spread-cycle = 0
• chopper-mode-fast-decay = 1

tinkerforge call silent-stepper-brick <uid> get-spreadcycle-configuration¶

Ausgabe:

slow-decay-duration – Typ: Int, Wertebereich: [0 bis 15], Standardwert: 4 enable-random-slow-decay – Typ: Bool, Standardwert: false fast-decay-duration – Typ: Int, Wertebereich: [0 bis 15], Standardwert: 0 hysteresis-start-value – Typ: Int, Wertebereich: [0 bis 7], Standardwert: 0 hysteresis-end-value – Typ: Int, Wertebereich: [-3 bis 12], Standardwert: 0 sine-wave-offset – Typ: Int, Wertebereich: [-3 bis 12], Standardwert: 0 chopper-mode – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0 comparator-blank-time – Typ: Int, Wertebereich: [0 bis 3], Standardwert: 1 fast-decay-without-comparator – Typ: Bool, Standardwert: false

Gibt die Konfiguration zurück, wie von set-basic-configuration gesetzt.

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

Für chopper-mode:

• chopper-mode-spread-cycle = 0
• chopper-mode-fast-decay = 1

tinkerforge call silent-stepper-brick <uid> set-stealth-configuration <enable-stealth> <amplitude> <gradient> <enable-autoscale> <force-symmetric> <freewheel-mode>¶

Parameter:	<enable-stealth> – Typ: Bool, Standardwert: true <amplitude> – Typ: Int, Wertebereich: [0 bis 255], Standardwert: 128 <gradient> – Typ: Int, Wertebereich: [0 bis 255], Standardwert: 4 <enable-autoscale> – Typ: Bool, Standardwert: true <force-symmetric> – Typ: Bool, Standardwert: false <freewheel-mode> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
Ausgabe:	keine Ausgabe

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 set-basic-configuration 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 set-basic-configuration) auf 0 gesetzt wurde.

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

Für <freewheel-mode>:

• freewheel-mode-normal = 0
• freewheel-mode-freewheeling = 1
• freewheel-mode-coil-short-ls = 2
• freewheel-mode-coil-short-hs = 3

tinkerforge call silent-stepper-brick <uid> get-stealth-configuration¶

Ausgabe:	enable-stealth – Typ: Bool, Standardwert: true amplitude – Typ: Int, Wertebereich: [0 bis 255], Standardwert: 128 gradient – Typ: Int, Wertebereich: [0 bis 255], Standardwert: 4 enable-autoscale – Typ: Bool, Standardwert: true force-symmetric – Typ: Bool, Standardwert: false freewheel-mode – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt die Konfiguration zurück, wie von set-stealth-configuration gesetzt.

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

Für freewheel-mode:

• freewheel-mode-normal = 0
• freewheel-mode-freewheeling = 1
• freewheel-mode-coil-short-ls = 2
• freewheel-mode-coil-short-hs = 3

tinkerforge call silent-stepper-brick <uid> set-coolstep-configuration <minimum-stallguard-value> <maximum-stallguard-value> <current-up-step-width> <current-down-step-width> <minimum-current> <stallguard-threshold-value> <stallguard-mode>¶

Parameter:

<minimum-stallguard-value> – Typ: Int, Wertebereich: [0 bis 15], Standardwert: 2 <maximum-stallguard-value> – Typ: Int, Wertebereich: [0 bis 15], Standardwert: 10 <current-up-step-width> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0 <current-down-step-width> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0 <minimum-current> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0 <stallguard-threshold-value> – Typ: Int, Wertebereich: [-64 bis 63], Standardwert: 0 <stallguard-mode> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0

Ausgabe:

keine Ausgabe

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 get-driver-status). 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 Symbole sind für diese Funktion verfügbar:

Für <current-up-step-width>:

• current-up-step-increment-1 = 0
• current-up-step-increment-2 = 1
• current-up-step-increment-4 = 2
• current-up-step-increment-8 = 3

Für <current-down-step-width>:

• current-down-step-decrement-1 = 0
• current-down-step-decrement-2 = 1
• current-down-step-decrement-8 = 2
• current-down-step-decrement-32 = 3

Für <minimum-current>:

• minimum-current-half = 0
• minimum-current-quarter = 1

Für <stallguard-mode>:

• stallguard-mode-standard = 0
• stallguard-mode-filtered = 1

tinkerforge call silent-stepper-brick <uid> get-coolstep-configuration¶

Ausgabe:

minimum-stallguard-value – Typ: Int, Wertebereich: [0 bis 15], Standardwert: 2 maximum-stallguard-value – Typ: Int, Wertebereich: [0 bis 15], Standardwert: 10 current-up-step-width – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0 current-down-step-width – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0 minimum-current – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0 stallguard-threshold-value – Typ: Int, Wertebereich: [-64 bis 63], Standardwert: 0 stallguard-mode – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt die Konfiguration zurück, wie von set-coolstep-configuration gesetzt.

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

Für current-up-step-width:

• current-up-step-increment-1 = 0
• current-up-step-increment-2 = 1
• current-up-step-increment-4 = 2
• current-up-step-increment-8 = 3

Für current-down-step-width:

• current-down-step-decrement-1 = 0
• current-down-step-decrement-2 = 1
• current-down-step-decrement-8 = 2
• current-down-step-decrement-32 = 3

Für minimum-current:

• minimum-current-half = 0
• minimum-current-quarter = 1

Für stallguard-mode:

• stallguard-mode-standard = 0
• stallguard-mode-filtered = 1

tinkerforge call silent-stepper-brick <uid> set-misc-configuration <disable-short-to-ground-protection> <synchronize-phase-frequency>¶

Parameter:	<disable-short-to-ground-protection> – Typ: Bool, Standardwert: false <synchronize-phase-frequency> – Typ: Int, Wertebereich: [0 bis 15], Standardwert: 0
Ausgabe:	keine Ausgabe

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.

tinkerforge call silent-stepper-brick <uid> get-misc-configuration¶

Ausgabe:	disable-short-to-ground-protection – Typ: Bool, Standardwert: false synchronize-phase-frequency – Typ: Int, Wertebereich: [0 bis 15], Standardwert: 0

Gibt die Konfiguration zurück, wie von set-misc-configuration gesetzt.

tinkerforge call silent-stepper-brick <uid> get-driver-status¶

Ausgabe:	open-load – Typ: Int, Wertebereich: Siehe Symbole short-to-ground – Typ: Int, Wertebereich: Siehe Symbole over-temperature – Typ: Int, Wertebereich: Siehe Symbole motor-stalled – Typ: Bool actual-motor-current – Typ: Int, Wertebereich: [0 bis 31] full-step-active – Typ: Bool stallguard-result – Typ: Int, Wertebereich: [0 bis 255] stealth-voltage-amplitude – Typ: Int, 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 set-basic-configuration 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 set-stealth-configuration).

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

Für open-load:

• open-load-none = 0
• open-load-phase-a = 1
• open-load-phase-b = 2
• open-load-phase-ab = 3

Für short-to-ground:

• short-to-ground-none = 0
• short-to-ground-phase-a = 1
• short-to-ground-phase-b = 2
• short-to-ground-phase-ab = 3

Für over-temperature:

• over-temperature-none = 0
• over-temperature-warning = 1
• over-temperature-limit = 2

tinkerforge call silent-stepper-brick <uid> set-time-base <time-base>¶

Parameter:	<time-base> – Typ: Int, Einheit: 1 s, Wertebereich: [0 bis 232 - 1], Standardwert: 1
Ausgabe:	keine Ausgabe

Setzt die Zeitbasis der Geschwindigkeit und Beschleunigung des Silent Stepper Brick.

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

tinkerforge call silent-stepper-brick <uid> get-time-base¶

Ausgabe:	time-base – Typ: Int, Einheit: 1 s, Wertebereich: [0 bis 232 - 1], Standardwert: 1

Gibt die Zeitbasis zurück, wie von set-time-base gesetzt.

tinkerforge call silent-stepper-brick <uid> get-all-data¶

Ausgabe:

current-velocity – Typ: Int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1] current-position – Typ: Int, Wertebereich: [-231 bis 231 - 1] remaining-steps – Typ: Int, Wertebereich: [-231 bis 231 - 1] stack-voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1] external-voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1] current-consumption – Typ: Int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

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

Der Stromverbrauch des Schrittmotors wird berechnet aus dem Actual Motor Current-Wert (siehe set-basic-configuration) multipliziert mit dem Motor Run Current (see get-driver-status). 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 all-data Callback.

tinkerforge call silent-stepper-brick <uid> set-spitfp-baudrate-config <enable-dynamic-baudrate> <minimum-dynamic-baudrate>¶

Parameter:	<enable-dynamic-baudrate> – Typ: Bool, Standardwert: true <minimum-dynamic-baudrate> – Typ: Int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000
Ausgabe:	keine Ausgabe

Das SPITF-Protokoll kann mit einer dynamischen Baudrate genutzt werden. Wenn die dynamische Baudrate aktiviert ist, versucht der Brick die Baudrate anhand des Datenaufkommens zwischen Brick und Bricklet anzupassen.

Die Baudrate wird exponentiell erhöht wenn viele Daten gesendet/empfangen werden und linear verringert wenn wenig Daten gesendet/empfangen werden.

Diese Vorgehensweise verringert die Baudrate in Anwendungen wo nur wenig Daten ausgetauscht werden müssen (z.B. eine Wetterstation) und erhöht die Robustheit. Wenn immer viele Daten ausgetauscht werden (z.B. Thermal Imaging Bricklet), wird die Baudrate automatisch erhöht.

In Fällen wo wenige Daten all paar Sekunden so schnell wie Möglich übertragen werden sollen (z.B. RS485 Bricklet mit hoher Baudrate aber kleinem Payload) kann die dynamische Baudrate zum maximieren der Performance ausgestellt werden.

Die maximale Baudrate kann pro Port mit der Funktion set-spitfp-baudrate. gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von set-spitfp-baudrate gesetzt statisch verwendet.

Neu in Version 2.0.4 (Firmware).

tinkerforge call silent-stepper-brick <uid> get-spitfp-baudrate-config¶

Ausgabe:	enable-dynamic-baudrate – Typ: Bool, Standardwert: true minimum-dynamic-baudrate – Typ: Int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000

Gibt die Baudratenkonfiguration zurück, siehe set-spitfp-baudrate-config.

Neu in Version 2.0.4 (Firmware).

tinkerforge call silent-stepper-brick <uid> get-send-timeout-count <communication-method>¶

Parameter:	<communication-method> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:	timeout-count – Typ: Int, Wertebereich: [0 bis 232 - 1]

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

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

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

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

Für <communication-method>:

• communication-method-none = 0
• communication-method-usb = 1
• communication-method-spi-stack = 2
• communication-method-chibi = 3
• communication-method-rs485 = 4
• communication-method-wifi = 5
• communication-method-ethernet = 6
• communication-method-wifi-v2 = 7

tinkerforge call silent-stepper-brick <uid> set-spitfp-baudrate <bricklet-port> <baudrate>¶

Parameter:	<bricklet-port> – Typ: Char, Wertebereich: [a bis b] <baudrate> – Typ: Int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000
Ausgabe:	keine Ausgabe

Setzt die Baudrate eines spezifischen Bricklet Ports .

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

Wenn das Feature der dynamische Baudrate aktiviert ist, setzt diese Funktion die maximale Baudrate (siehe set-spitfp-baudrate-config).

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

tinkerforge call silent-stepper-brick <uid> get-spitfp-baudrate <bricklet-port>¶

Parameter:	<bricklet-port> – Typ: Char, Wertebereich: [a bis b]
Ausgabe:	baudrate – Typ: Int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000

Gibt die Baudrate für einen Bricklet Port zurück, siehe set-spitfp-baudrate.

tinkerforge call silent-stepper-brick <uid> get-spitfp-error-count <bricklet-port>¶

Parameter:	<bricklet-port> – Typ: Char, Wertebereich: [a bis b]
Ausgabe:	error-count-ack-checksum – Typ: Int, Wertebereich: [0 bis 232 - 1] error-count-message-checksum – Typ: Int, Wertebereich: [0 bis 232 - 1] error-count-frame – Typ: Int, Wertebereich: [0 bis 232 - 1] error-count-overflow – Typ: Int, Wertebereich: [0 bis 232 - 1]

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

Die Fehler sind aufgeteilt in

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

Die Fehlerzähler sind für Fehler die auf der Seite des Bricks auftreten. Jedes Bricklet hat eine ähnliche Funktion welche die Fehler auf Brickletseite ausgibt.

tinkerforge call silent-stepper-brick <uid> enable-status-led¶

Ausgabe:	keine Ausgabe

Aktiviert die Status LED.

Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.

Der Standardzustand ist aktiviert.

tinkerforge call silent-stepper-brick <uid> disable-status-led¶

Ausgabe:	keine Ausgabe

Deaktiviert die Status LED.

Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.

Der Standardzustand ist aktiviert.

tinkerforge call silent-stepper-brick <uid> is-status-led-enabled¶

Ausgabe:	enabled – Typ: Bool, Standardwert: true

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

tinkerforge call silent-stepper-brick <uid> get-chip-temperature¶

Ausgabe:	temperature – Typ: Int, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1]

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

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

tinkerforge call silent-stepper-brick <uid> reset¶

Ausgabe:	keine Ausgabe

Ein Aufruf dieser Funktion setzt den Brick zurück. Befindet sich der Brick innerhalb eines Stapels wird der gesamte Stapel zurück gesetzt.

Nach dem Zurücksetzen ist es notwendig neue Geräteobjekte zu erzeugen, Funktionsaufrufe auf bestehende führt zu undefiniertem Verhalten.

tinkerforge call silent-stepper-brick <uid> get-identity¶

Ausgabe:

uid – Typ: String, Länge: bis zu 8 connected-uid – Typ: String, Länge: bis zu 8 position – Typ: Char, Wertebereich: [0 bis 8] hardware-version – Typ: Int Array, Länge: 3 0: major – Typ: Int, Wertebereich: [0 bis 255] 1: minor – Typ: Int, Wertebereich: [0 bis 255] 2: revision – Typ: Int, Wertebereich: [0 bis 255] firmware-version – Typ: Int Array, Länge: 3 0: major – Typ: Int, Wertebereich: [0 bis 255] 1: minor – Typ: Int, Wertebereich: [0 bis 255] 2: revision – Typ: Int, Wertebereich: [0 bis 255] device-identifier – Typ: Int, Wertebereich: [0 bis 216 - 1]

Gibt die UID, die UID zu der der Brick verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist die Position im Stack von '0' (unterster Brick) bis '8' (oberster Brick).

Eine Liste der Device Identifier Werte ist hier zu finden. 

Konfigurationsfunktionen für Callbacks¶

tinkerforge call silent-stepper-brick <uid> set-minimum-voltage <voltage>¶

Parameter:	<voltage> – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 8000
Ausgabe:	keine Ausgabe

Setzt die minimale Spannung, bei welcher der under-voltage Callback ausgelöst wird. Der kleinste mögliche Wert mit dem der Silent Stepper Brick noch funktioniert, ist 8V. Mit dieser Funktion kann eine Entladung der versorgenden Batterie detektiert werden. Beim Einsatz einer Netzstromversorgung wird diese Funktionalität höchstwahrscheinlich nicht benötigt.

tinkerforge call silent-stepper-brick <uid> get-minimum-voltage¶

Ausgabe:	voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 8000

Gibt die minimale Spannung zurück, wie von set-minimum-voltage gesetzt.

tinkerforge call silent-stepper-brick <uid> set-all-data-period <period>¶

Parameter:	<period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Ausgabe:	keine Ausgabe

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

tinkerforge call silent-stepper-brick <uid> get-all-data-period¶

Ausgabe:	period – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von set-all-data-period gesetzt.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:

tinkerforge dispatch silent-stepper-brick <uid> example

Die verfügbaren Callbacks werden weiter unten beschrieben.

tinkerforge dispatch silent-stepper-brick <uid> under-voltage¶

Ausgabe:	voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird ausgelöst, wenn die Eingangsspannung unter den, mittels set-minimum-voltage gesetzten, Schwellwert sinkt. Der Parameter ist die aktuelle Spannung.

tinkerforge dispatch silent-stepper-brick <uid> position-reached¶

Ausgabe:	position – Typ: Int, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Position, wie von set-steps oder set-target-position gesetzt, erreicht wird.

Bemerkung

Da es nicht möglich ist eine Rückmeldung vom Schrittmotor zu erhalten, funktioniert dies nur wenn die konfigurierte Beschleunigung (siehe set-speed-ramping) kleiner oder gleich der maximalen Beschleunigung des Motors ist. Andernfalls wird der Motor hinter dem Vorgabewert zurückbleiben und der Callback wird zu früh ausgelöst.

tinkerforge dispatch silent-stepper-brick <uid> all-data¶

Ausgabe:

current-velocity – Typ: Int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1] current-position – Typ: Int, Wertebereich: [-231 bis 231 - 1] remaining-steps – Typ: Int, Wertebereich: [-231 bis 231 - 1] stack-voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1] external-voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1] current-consumption – Typ: Int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit set-all-data-period, 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.

tinkerforge dispatch silent-stepper-brick <uid> new-state¶

Ausgabe:	state-new – Typ: Int, Wertebereich: Siehe Symbole state-previous – Typ: Int, Wertebereich: Siehe Symbole

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

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

Für state-new:

• state-stop = 1
• state-acceleration = 2
• state-run = 3
• state-deacceleration = 4
• state-direction-change-to-forward = 5
• state-direction-change-to-backward = 6

Für state-previous:

• state-stop = 1
• state-acceleration = 2
• state-run = 3
• state-deacceleration = 4
• state-direction-change-to-forward = 5
• state-direction-change-to-backward = 6

Interne Funktionen¶

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

tinkerforge call silent-stepper-brick <uid> get-protocol1-bricklet-name <port>¶

Parameter:	<port> – Typ: Char, Wertebereich: [a bis b]
Ausgabe:	protocol-version – Typ: Int, Wertebereich: [0 bis 255] firmware-version – Typ: Int Array, Länge: 3 0: major – Typ: Int, Wertebereich: [0 bis 255] 1: minor – Typ: Int, Wertebereich: [0 bis 255] 2: revision – Typ: Int, Wertebereich: [0 bis 255] name – Typ: String, Länge: bis zu 40

Gibt die Firmware und Protokoll Version und den Namen des Bricklets für einen gegebenen Port zurück.

Der einzige Zweck dieser Funktion ist es, automatischen Flashen von Bricklet v1.x.y Plugins zu ermöglichen.

tinkerforge call silent-stepper-brick <uid> write-bricklet-plugin <port> <offset> <chunk>¶

Parameter:	<port> – Typ: Char, Wertebereich: [a bis b] <offset> – Typ: Int, Wertebereich: [0 bis 255] <chunk> – Typ: Int Array, Länge: 32, Wertebereich: [0 bis 255]
Ausgabe:	keine Ausgabe

Schreibt 32 Bytes Firmware auf das Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden an die Position offset * 32 geschrieben.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

tinkerforge call silent-stepper-brick <uid> read-bricklet-plugin <port> <offset>¶

Parameter:	<port> – Typ: Char, Wertebereich: [a bis b] <offset> – Typ: Int, Wertebereich: [0 bis 255]
Ausgabe:	chunk – Typ: Int Array, Länge: 32, Wertebereich: [0 bis 255]

Liest 32 Bytes Firmware vom Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden ab der Position offset * 32 gelesen.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.