Perl - Silent Stepper Brick

Dies ist die Beschreibung der Perl API Bindings für den Silent Stepper Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Silent Stepper Brick sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Perl API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Configuration

Download (example_configuration.pl)

 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
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickSilentStepper;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XXYYZZ'; # Change XXYYZZ to the UID of your Silent Stepper Brick

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $ss = Tinkerforge::BrickSilentStepper->new(&UID, $ipcon); # Create device object

$ipcon->connect(&HOST, &PORT); # Connect to brickd
# Don't use device before ipcon is connected

$ss->set_motor_current(800); # 800mA
$ss->set_step_configuration($ss->STEP_RESOLUTION_8, 1); # 1/8 steps (interpolated)
$ss->set_max_velocity(2000); # Velocity 2000 steps/s

# Slow acceleration (500 steps/s^2),
# Fast deacceleration (5000 steps/s^2)
$ss->set_speed_ramping(500, 5000);

$ss->enable(); # Enable motor power
$ss->set_steps(60000); # Drive 60000 steps forward

print "Press key to exit\n";
<STDIN>;
$ss->disable();
$ipcon->disconnect();

Callback

Download (example_callback.pl)

 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
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickSilentStepper;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XXYYZZ'; # Change XXYYZZ to the UID of your Silent Stepper Brick

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
our $ss = Tinkerforge::BrickSilentStepper->new(&UID, $ipcon); # Create device object

# Use position reached callback to program random movement
sub cb_position_reached
{
    my ($position) = @_;

    my $steps = 0;
    my $vel = 0;
    my $acc = 0;
    my $dec = 0;

    if (int(rand(1)))
    {
        $steps = int(rand(5000 - 1000)) + 1000; # steps (forward)
        print "Driving forward: $steps steps\n";
    }
    else
    {
        $steps = int(rand(5000 - 1000)) + 1000; # steps (backward)
        print "Driving backward: $steps steps\n";
    }

    $vel = int(rand(2000 - 200)) + 200; # steps/s
    $acc = int(rand(1000 - 100)) + 100; # steps/s^2
    $dec = int(rand(1000 - 100)) + 100; # steps/s^2
    print "Configuration (vel, acc, dec): $vel, $acc, $dec\n";

    $ss->set_speed_ramping($acc, $dec);
    $ss->set_max_velocity($vel);
    $ss->set_steps($steps);
}

$ipcon->connect(&HOST, &PORT); # Connect to brickd
# Don't use device before ipcon is connected

# Register position reached callback to subroutine cb_position_reached
$ss->register_callback($ss->CALLBACK_POSITION_REACHED, 'cb_position_reached');

$ss->set_step_configuration($ss->STEP_RESOLUTION_8, 1); # 1/8 steps (interpolated)
$ss->enable(); # Enable motor power
$ss->set_steps(1); # Drive one step forward to get things going

print "Press key to exit\n";
<STDIN>;
$ss->disable();
$ipcon->disconnect();

API

Allgemein kann jede Subroutine der Perl Bindings Fehler als Tinkerforge::Error Objekt mittels croak() melden. Das Objekt hat eine get_code() und eine get_message() Subroutine. Es sind verschiedene Fehlercodes definiert:

  • Error->ALREADY_CONNECTED = 11
  • Error->NOT_CONNECTED = 12
  • Error->CONNECT_FAILED = 13
  • Error->INVALID_FUNCTION_ID = 21
  • Error->TIMEOUT = 31
  • Error->INVALID_PARAMETER = 41
  • Error->FUNCTION_NOT_SUPPORTED = 42
  • Error->UNKNOWN_ERROR = 43
  • Error->STREAM_OUT_OF_SYNC = 51
  • Error->INVALID_UID = 61

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

BrickSilentStepper->new($uid, $ipcon)
Parameter:
  • $uid -- string
  • $ipcon -- IPConnection
Rückgabetyp:

BrickSilentStepper

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

$silent_stepper = BrickSilentStepper->new("YOUR_DEVICE_UID", $ipcon);

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

BrickSilentStepper->set_max_velocity($velocity)
Parameter:$velocity -- int
Rückgabetyp:undef

Setzt die maximale Geschwindigkeit des Schrittmotors in Schritten je Sekunde. Diese Funktion startet nicht den Motor, sondern setzt nur die maximale Geschwindigkeit auf welche der Schrittmotor beschleunigt wird. Um den Motor zu fahren können set_target_position(), set_steps(), drive_forward() oder drive_backward() verwendet werden.

BrickSilentStepper->get_max_velocity()
Rückgabetyp:int

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

BrickSilentStepper->get_current_velocity()
Rückgabetyp:int

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

BrickSilentStepper->set_speed_ramping($acceleration, $deacceleration)
Parameter:
  • $acceleration -- int
  • $deacceleration -- int
Rückgabetyp:

undef

Setzt die Beschleunigung und die Verzögerung des Schrittmotors. Die Werte müssen in Schritten/s² angegeben werden. Eine Beschleunigung von 1000 bedeutet, dass jede Sekunde die Geschwindigkeit um 1000 Schritte/s erhöht wird.

Beispiel: Wenn die aktuelle Geschwindigkeit 0 ist und es soll auf eine Geschwindigkeit von 8000 Schritten/s in 10 Sekunden beschleunigt werden, muss die Beschleunigung auf 800 Schritte/s² gesetzt werden.

Eine Beschleunigung/Verzögerung von 0 bedeutet ein sprunghaftes Beschleunigen/Verzögern (nicht empfohlen).

Der Standardwert ist 1000 für beide Parameter.

BrickSilentStepper->get_speed_ramping()
Rückgabetyp:[int, int]

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

Das zurückgegebene Array enthält die Elemente acceleration und deacceleration.

BrickSilentStepper->full_brake()
Rückgabetyp:undef

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.

BrickSilentStepper->set_steps($steps)
Parameter:$steps -- int
Rückgabetyp:undef

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.

BrickSilentStepper->get_steps()
Rückgabetyp:int

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

BrickSilentStepper->get_remaining_steps()
Rückgabetyp:int

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.

BrickSilentStepper->drive_forward()
Rückgabetyp:undef

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.

BrickSilentStepper->drive_backward()
Rückgabetyp:undef

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.

BrickSilentStepper->stop()
Rückgabetyp:undef

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

BrickSilentStepper->set_motor_current($current)
Parameter:$current -- int
Rückgabetyp:undef

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

Warnung

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

BrickSilentStepper->get_motor_current()
Rückgabetyp:int

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

BrickSilentStepper->enable()
Rückgabetyp:undef

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

BrickSilentStepper->disable()
Rückgabetyp:undef

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

BrickSilentStepper->is_enabled()
Rückgabetyp:bool

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

BrickSilentStepper->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 -- int
  • $motor_run_current -- int
  • $standstill_delay_time -- int
  • $power_down_time -- int
  • $stealth_threshold -- int
  • $coolstep_threshold -- int
  • $classic_threshold -- int
  • $high_velocity_chopper_mode -- bool
Rückgabetyp:

undef

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. Die Einheit ist mA und 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. Die Einheit ist mA und 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. Der Wertebereich ist 0 bis 307ms.
  • Power Down Time: Setzt die Wartezeit nach dem Stehenbleiben. Der Wertebereich ist 0 bis 5222ms.
  • Stealth Threshold: Setzt den oberen Grenzwert für den Stealth Modus in Schritte/s. Der Wertebereich ist 0-65536 Schritte/s. Wenn die Geschwindigkeit des Motors über diesen 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 Schritte/s. Der Wertebereich ist 0-65536 Schritte/s. Der Coolstep Grenzwert muss über dem Stealth Grenzwert liegen.
  • Classic Threshold: Sets den unteren Grenzwert für den Classic Modus. Der Wertebereich ist 0-65536 Schritte/s. Im Classic Modus wird der Schrittmotor geräuschvoll aber das Drehmoment wird maximiert.
  • High Velocity Shopper Mode: Wenn der High Velocity Shopper 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.

Die Standardwerte sind:

  • Standstill Current: 200
  • Motor Run Current: 800
  • Standstill Delay Time: 0
  • Power Down Time: 1000
  • Stealth Threshold: 500
  • Coolstep Threshold: 500
  • Classic Threshold: 1000
  • High Velocity Shopper Mode: false
BrickSilentStepper->get_basic_configuration()
Rückgabetyp:[int, int, int, int, int, int, int, bool]

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

Das zurückgegebene Array enthält die Elemente standstill_current, motor_run_current, standstill_delay_time, power_down_time, stealth_threshold, coolstep_threshold, classic_threshold und high_velocity_chopper_mode.

Fortgeschrittene Funktionen

BrickSilentStepper->set_current_position($position)
Parameter:$position -- int
Rückgabetyp:undef

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

BrickSilentStepper->get_current_position()
Rückgabetyp:int

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

BrickSilentStepper->set_target_position($position)
Parameter:$position -- int
Rückgabetyp:undef

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

BrickSilentStepper->get_target_position()
Rückgabetyp:int

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

BrickSilentStepper->set_step_configuration($step_resolution, $interpolation)
Parameter:
  • $step_resolution -- int
  • $interpolation -- bool
Rückgabetyp:

undef

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.

Der Standardwert ist 1/256 Schritte mit aktivierter Interpolation.

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

  • BrickSilentStepper->STEP_RESOLUTION_1 = 8
  • BrickSilentStepper->STEP_RESOLUTION_2 = 7
  • BrickSilentStepper->STEP_RESOLUTION_4 = 6
  • BrickSilentStepper->STEP_RESOLUTION_8 = 5
  • BrickSilentStepper->STEP_RESOLUTION_16 = 4
  • BrickSilentStepper->STEP_RESOLUTION_32 = 3
  • BrickSilentStepper->STEP_RESOLUTION_64 = 2
  • BrickSilentStepper->STEP_RESOLUTION_128 = 1
  • BrickSilentStepper->STEP_RESOLUTION_256 = 0
BrickSilentStepper->get_step_configuration()
Rückgabetyp:[int, bool]

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

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

  • BrickSilentStepper->STEP_RESOLUTION_1 = 8
  • BrickSilentStepper->STEP_RESOLUTION_2 = 7
  • BrickSilentStepper->STEP_RESOLUTION_4 = 6
  • BrickSilentStepper->STEP_RESOLUTION_8 = 5
  • BrickSilentStepper->STEP_RESOLUTION_16 = 4
  • BrickSilentStepper->STEP_RESOLUTION_32 = 3
  • BrickSilentStepper->STEP_RESOLUTION_64 = 2
  • BrickSilentStepper->STEP_RESOLUTION_128 = 1
  • BrickSilentStepper->STEP_RESOLUTION_256 = 0

Das zurückgegebene Array enthält die Elemente step_resolution und interpolation.

BrickSilentStepper->get_stack_input_voltage()
Rückgabetyp:int

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

BrickSilentStepper->get_external_input_voltage()
Rückgabetyp:int

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

BrickSilentStepper->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 -- int
  • $enable_random_slow_decay -- bool
  • $fast_decay_duration -- int
  • $hysteresis_start_value -- int
  • $hysteresis_end_value -- int
  • $sine_wave_offset -- int
  • $chopper_mode -- int
  • $comparator_blank_time -- int
  • $fast_decay_without_comparator -- bool
Rückgabetyp:

undef

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. Werte sind im Bereich von 0-15 möglich. 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. Werte sind von 0-15 möglich. Dieser Parameter wird nur benutzt, wenn der Spread Cycle als Chopper Modus genutzt wird.

  • Hysteresis Start Value: Setzt der Startwert der Hysterese. Der Wertebereich ist 0-7. Dieser Parameter wird nur benutzt, wenn der Spread Cycle als Chopper Modus genutzt wird.

  • Hysteresis End Value: Setzt den Endwert der Hysterese. Der Wertebereich ist -3 bis 12.

  • Sets the hysteresis end value. The value range is -3 to 12. Dieser Parameter wird nur benutzt, wenn der Spread Cycle als Chopper Modus genutzt wird.

  • Sinewave Offset: Setzt den Sinuswellen Offset. Der Wertebereich ist -3 bis 12. 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 Standardwerte sind:

  • Slow Decay Duration: 4
  • Enable Random Slow Decay: 0
  • Fast Decay Duration: 0
  • Hysteresis Start Value: 0
  • Hysteresis End Value: 0
  • Sinewave Offset: 0
  • Chopper Mode: 0
  • Comperator Blank Time: 1
  • Fast Decay Without Comperator: false

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

  • BrickSilentStepper->CHOPPER_MODE_SPREAD_CYCLE = 0
  • BrickSilentStepper->CHOPPER_MODE_FAST_DECAY = 1
BrickSilentStepper->get_spreadcycle_configuration()
Rückgabetyp:[int, bool, int, int, int, int, int, int, bool]

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

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

  • BrickSilentStepper->CHOPPER_MODE_SPREAD_CYCLE = 0
  • BrickSilentStepper->CHOPPER_MODE_FAST_DECAY = 1

Das zurückgegebene Array enthält die Elemente slow_decay_duration, enable_random_slow_decay, fast_decay_duration, hysteresis_start_value, hysteresis_end_value, sine_wave_offset, chopper_mode, comparator_blank_time und fast_decay_without_comparator.

BrickSilentStepper->set_stealth_configuration($enable_stealth, $amplitude, $gradient, $enable_autoscale, $force_symmetric, $freewheel_mode)
Parameter:
  • $enable_stealth -- bool
  • $amplitude -- int
  • $gradient -- int
  • $enable_autoscale -- bool
  • $force_symmetric -- bool
  • $freewheel_mode -- int
Rückgabetyp:

undef

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. Der Wertebereich ist 0-255.
  • 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. Der Wertebereich ist 0-255.
  • 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 Standardwerte sind:

  • Enable Stealth: true
  • Amplitude: 128
  • Gradient: 4
  • Enable Autoscale: true
  • Force Symmetric: false
  • Freewheel Mode: 0 (Normal)

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

  • BrickSilentStepper->FREEWHEEL_MODE_NORMAL = 0
  • BrickSilentStepper->FREEWHEEL_MODE_FREEWHEELING = 1
  • BrickSilentStepper->FREEWHEEL_MODE_COIL_SHORT_LS = 2
  • BrickSilentStepper->FREEWHEEL_MODE_COIL_SHORT_HS = 3
BrickSilentStepper->get_stealth_configuration()
Rückgabetyp:[bool, int, int, bool, bool, int]

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

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

  • BrickSilentStepper->FREEWHEEL_MODE_NORMAL = 0
  • BrickSilentStepper->FREEWHEEL_MODE_FREEWHEELING = 1
  • BrickSilentStepper->FREEWHEEL_MODE_COIL_SHORT_LS = 2
  • BrickSilentStepper->FREEWHEEL_MODE_COIL_SHORT_HS = 3

Das zurückgegebene Array enthält die Elemente enable_stealth, amplitude, gradient, enable_autoscale, force_symmetric und freewheel_mode.

BrickSilentStepper->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 -- int
  • $maximum_stallguard_value -- int
  • $current_up_step_width -- int
  • $current_down_step_width -- int
  • $minimum_current -- int
  • $stallguard_threshold_value -- int
  • $stallguard_mode -- int
Rückgabetyp:

undef

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. Der Wertebereich ist 0-15. 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()). Der Wertebereich ist -64 bis +63. 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 Standardwerte sind:

  • Minimum Stallguard Value: 2
  • Maximum Stallguard Value: 10
  • Current Up Step Width: 0
  • Current Down Step Width: 0
  • Minimum Current: 0
  • Stallguard Threshold Value: 0
  • Stallguard Mode: 0

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

  • BrickSilentStepper->CURRENT_UP_STEP_INCREMENT_1 = 0
  • BrickSilentStepper->CURRENT_UP_STEP_INCREMENT_2 = 1
  • BrickSilentStepper->CURRENT_UP_STEP_INCREMENT_4 = 2
  • BrickSilentStepper->CURRENT_UP_STEP_INCREMENT_8 = 3
  • BrickSilentStepper->CURRENT_DOWN_STEP_DECREMENT_1 = 0
  • BrickSilentStepper->CURRENT_DOWN_STEP_DECREMENT_2 = 1
  • BrickSilentStepper->CURRENT_DOWN_STEP_DECREMENT_8 = 2
  • BrickSilentStepper->CURRENT_DOWN_STEP_DECREMENT_32 = 3
  • BrickSilentStepper->MINIMUM_CURRENT_HALF = 0
  • BrickSilentStepper->MINIMUM_CURRENT_QUARTER = 1
  • BrickSilentStepper->STALLGUARD_MODE_STANDARD = 0
  • BrickSilentStepper->STALLGUARD_MODE_FILTERED = 1
BrickSilentStepper->get_coolstep_configuration()
Rückgabetyp:[int, int, int, int, int, int, int]

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

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

  • BrickSilentStepper->CURRENT_UP_STEP_INCREMENT_1 = 0
  • BrickSilentStepper->CURRENT_UP_STEP_INCREMENT_2 = 1
  • BrickSilentStepper->CURRENT_UP_STEP_INCREMENT_4 = 2
  • BrickSilentStepper->CURRENT_UP_STEP_INCREMENT_8 = 3
  • BrickSilentStepper->CURRENT_DOWN_STEP_DECREMENT_1 = 0
  • BrickSilentStepper->CURRENT_DOWN_STEP_DECREMENT_2 = 1
  • BrickSilentStepper->CURRENT_DOWN_STEP_DECREMENT_8 = 2
  • BrickSilentStepper->CURRENT_DOWN_STEP_DECREMENT_32 = 3
  • BrickSilentStepper->MINIMUM_CURRENT_HALF = 0
  • BrickSilentStepper->MINIMUM_CURRENT_QUARTER = 1
  • BrickSilentStepper->STALLGUARD_MODE_STANDARD = 0
  • BrickSilentStepper->STALLGUARD_MODE_FILTERED = 1

Das zurückgegebene Array enthält die Elemente minimum_stallguard_value, maximum_stallguard_value, current_up_step_width, current_down_step_width, minimum_current, stallguard_threshold_value und stallguard_mode.

BrickSilentStepper->set_misc_configuration($disable_short_to_ground_protection, $synchronize_phase_frequency)
Parameter:
  • $disable_short_to_ground_protection -- bool
  • $synchronize_phase_frequency -- int
Rückgabetyp:

undef

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.

Die Standardwerte sind:

  • Disable Short To Ground Protection: 0
  • Synchronize Phase Frequency: 0
BrickSilentStepper->get_misc_configuration()
Rückgabetyp:[bool, int]

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

Das zurückgegebene Array enthält die Elemente disable_short_to_ground_protection und synchronize_phase_frequency.

BrickSilentStepper->get_driver_status()
Rückgabetyp:[int, int, int, bool, int, bool, int, int]

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 Kurzschlus 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. Der zurückgegebene Wert ist zwischen 0 und 31. 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 Konstanten sind für diese Funktion verfügbar:

  • BrickSilentStepper->OPEN_LOAD_NONE = 0
  • BrickSilentStepper->OPEN_LOAD_PHASE_A = 1
  • BrickSilentStepper->OPEN_LOAD_PHASE_B = 2
  • BrickSilentStepper->OPEN_LOAD_PHASE_AB = 3
  • BrickSilentStepper->SHORT_TO_GROUND_NONE = 0
  • BrickSilentStepper->SHORT_TO_GROUND_PHASE_A = 1
  • BrickSilentStepper->SHORT_TO_GROUND_PHASE_B = 2
  • BrickSilentStepper->SHORT_TO_GROUND_PHASE_AB = 3
  • BrickSilentStepper->OVER_TEMPERATURE_NONE = 0
  • BrickSilentStepper->OVER_TEMPERATURE_WARNING = 1
  • BrickSilentStepper->OVER_TEMPERATURE_LIMIT = 2

Das zurückgegebene Array enthält die Elemente open_load, short_to_ground, over_temperature, motor_stalled, actual_motor_current, full_step_active, stallguard_result und stealth_voltage_amplitude.

BrickSilentStepper->set_time_base($time_base)
Parameter:$time_base -- int
Rückgabetyp:undef

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

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

Der Standardwert ist 1.

BrickSilentStepper->get_time_base()
Rückgabetyp:int

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

BrickSilentStepper->get_all_data()
Rückgabetyp:[int, int, int, int, int, int]

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

Das zurückgegebene Array enthält die Elemente current_velocity, current_position, remaining_steps, stack_voltage, external_voltage und current_consumption.

BrickSilentStepper->get_api_version()
Rückgabetyp:[int, int, int]

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

BrickSilentStepper->get_response_expected($function_id)
Parameter:$function_id -- int
Rückgabetyp:bool

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

  • BrickSilentStepper->FUNCTION_SET_MAX_VELOCITY = 1
  • BrickSilentStepper->FUNCTION_SET_SPEED_RAMPING = 4
  • BrickSilentStepper->FUNCTION_FULL_BRAKE = 6
  • BrickSilentStepper->FUNCTION_SET_CURRENT_POSITION = 7
  • BrickSilentStepper->FUNCTION_SET_TARGET_POSITION = 9
  • BrickSilentStepper->FUNCTION_SET_STEPS = 11
  • BrickSilentStepper->FUNCTION_SET_STEP_CONFIGURATION = 14
  • BrickSilentStepper->FUNCTION_DRIVE_FORWARD = 16
  • BrickSilentStepper->FUNCTION_DRIVE_BACKWARD = 17
  • BrickSilentStepper->FUNCTION_STOP = 18
  • BrickSilentStepper->FUNCTION_SET_MOTOR_CURRENT = 22
  • BrickSilentStepper->FUNCTION_ENABLE = 24
  • BrickSilentStepper->FUNCTION_DISABLE = 25
  • BrickSilentStepper->FUNCTION_SET_BASIC_CONFIGURATION = 27
  • BrickSilentStepper->FUNCTION_SET_SPREADCYCLE_CONFIGURATION = 29
  • BrickSilentStepper->FUNCTION_SET_STEALTH_CONFIGURATION = 31
  • BrickSilentStepper->FUNCTION_SET_COOLSTEP_CONFIGURATION = 33
  • BrickSilentStepper->FUNCTION_SET_MISC_CONFIGURATION = 35
  • BrickSilentStepper->FUNCTION_SET_MINIMUM_VOLTAGE = 38
  • BrickSilentStepper->FUNCTION_SET_TIME_BASE = 42
  • BrickSilentStepper->FUNCTION_SET_ALL_DATA_PERIOD = 45
  • BrickSilentStepper->FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • BrickSilentStepper->FUNCTION_SET_SPITFP_BAUDRATE = 234
  • BrickSilentStepper->FUNCTION_ENABLE_STATUS_LED = 238
  • BrickSilentStepper->FUNCTION_DISABLE_STATUS_LED = 239
  • BrickSilentStepper->FUNCTION_RESET = 243
BrickSilentStepper->set_response_expected($function_id, $response_expected)
Parameter:
  • $function_id -- int
  • $response_expected -- bool
Rückgabetyp:

undef

Ä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:

  • BrickSilentStepper->FUNCTION_SET_MAX_VELOCITY = 1
  • BrickSilentStepper->FUNCTION_SET_SPEED_RAMPING = 4
  • BrickSilentStepper->FUNCTION_FULL_BRAKE = 6
  • BrickSilentStepper->FUNCTION_SET_CURRENT_POSITION = 7
  • BrickSilentStepper->FUNCTION_SET_TARGET_POSITION = 9
  • BrickSilentStepper->FUNCTION_SET_STEPS = 11
  • BrickSilentStepper->FUNCTION_SET_STEP_CONFIGURATION = 14
  • BrickSilentStepper->FUNCTION_DRIVE_FORWARD = 16
  • BrickSilentStepper->FUNCTION_DRIVE_BACKWARD = 17
  • BrickSilentStepper->FUNCTION_STOP = 18
  • BrickSilentStepper->FUNCTION_SET_MOTOR_CURRENT = 22
  • BrickSilentStepper->FUNCTION_ENABLE = 24
  • BrickSilentStepper->FUNCTION_DISABLE = 25
  • BrickSilentStepper->FUNCTION_SET_BASIC_CONFIGURATION = 27
  • BrickSilentStepper->FUNCTION_SET_SPREADCYCLE_CONFIGURATION = 29
  • BrickSilentStepper->FUNCTION_SET_STEALTH_CONFIGURATION = 31
  • BrickSilentStepper->FUNCTION_SET_COOLSTEP_CONFIGURATION = 33
  • BrickSilentStepper->FUNCTION_SET_MISC_CONFIGURATION = 35
  • BrickSilentStepper->FUNCTION_SET_MINIMUM_VOLTAGE = 38
  • BrickSilentStepper->FUNCTION_SET_TIME_BASE = 42
  • BrickSilentStepper->FUNCTION_SET_ALL_DATA_PERIOD = 45
  • BrickSilentStepper->FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • BrickSilentStepper->FUNCTION_SET_SPITFP_BAUDRATE = 234
  • BrickSilentStepper->FUNCTION_ENABLE_STATUS_LED = 238
  • BrickSilentStepper->FUNCTION_DISABLE_STATUS_LED = 239
  • BrickSilentStepper->FUNCTION_RESET = 243
BrickSilentStepper->set_response_expected_all($response_expected)
Parameter:$response_expected -- bool
Rückgabetyp:undef

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

BrickSilentStepper->set_spitfp_baudrate_config($enable_dynamic_baudrate, $minimum_dynamic_baudrate)
Parameter:
  • $enable_dynamic_baudrate -- bool
  • $minimum_dynamic_baudrate -- int
Rückgabetyp:

undef

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

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

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

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

Die maximale Baudrate kann pro Port mit der Funktion set_spitfp_baudrate(). gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von set_spitfp_baudrate() gesetzt statisch verwendet.

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

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

Neu in Version 2.0.4 (Firmware).

BrickSilentStepper->get_spitfp_baudrate_config()
Rückgabetyp:[bool, int]

Gibt die Baudratenkonfiguration zurück, siehe set_spitfp_baudrate_config().

Neu in Version 2.0.4 (Firmware).

Das zurückgegebene Array enthält die Elemente enable_dynamic_baudrate und minimum_dynamic_baudrate.

BrickSilentStepper->get_send_timeout_count($communication_method)
Parameter:$communication_method -- int
Rückgabetyp:int

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

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

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

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

  • BrickSilentStepper->COMMUNICATION_METHOD_NONE = 0
  • BrickSilentStepper->COMMUNICATION_METHOD_USB = 1
  • BrickSilentStepper->COMMUNICATION_METHOD_SPI_STACK = 2
  • BrickSilentStepper->COMMUNICATION_METHOD_CHIBI = 3
  • BrickSilentStepper->COMMUNICATION_METHOD_RS485 = 4
  • BrickSilentStepper->COMMUNICATION_METHOD_WIFI = 5
  • BrickSilentStepper->COMMUNICATION_METHOD_ETHERNET = 6
  • BrickSilentStepper->COMMUNICATION_METHOD_WIFI_V2 = 7
BrickSilentStepper->set_spitfp_baudrate($bricklet_port, $baudrate)
Parameter:
  • $bricklet_port -- char
  • $baudrate -- int
Rückgabetyp:

undef

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

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

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

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

Die Standardbaudrate für alle Ports ist 1400000.

BrickSilentStepper->get_spitfp_baudrate($bricklet_port)
Parameter:$bricklet_port -- char
Rückgabetyp:int

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

BrickSilentStepper->get_spitfp_error_count($bricklet_port)
Parameter:$bricklet_port -- char
Rückgabetyp:[int, int, int, int]

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.

Das zurückgegebene Array enthält die Elemente error_count_ack_checksum, error_count_message_checksum, error_count_frame und error_count_overflow.

BrickSilentStepper->enable_status_led()
Rückgabetyp:undef

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.

BrickSilentStepper->disable_status_led()
Rückgabetyp:undef

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.

BrickSilentStepper->is_status_led_enabled()
Rückgabetyp:bool

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

BrickSilentStepper->get_protocol1_bricklet_name($port)
Parameter:$port -- char
Rückgabetyp:[int, [int, int, int], string]

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

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

Das zurückgegebene Array enthält die Elemente protocol_version, firmware_version und name.

BrickSilentStepper->get_chip_temperature()
Rückgabetyp:int

Gibt die Temperatur in °C/10, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

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

BrickSilentStepper->reset()
Rückgabetyp:undef

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.

BrickSilentStepper->get_identity()
Rückgabetyp:[string, string, char, [int, int, int], [int, int, int], int]

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

Die Position kann '0'-'8' (Stack Position) sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricks.

Das zurückgegebene Array enthält die Elemente uid, connected_uid, position, hardware_version, firmware_version und device_identifier.

Konfigurationsfunktionen für Callbacks

BrickSilentStepper->register_callback($id, $callback)
Parameter:
  • $id -- int
  • $callback -- string
Rückgabetyp:

undef

Registriert den $function Namen für die gegebene $callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

BrickSilentStepper->set_minimum_voltage($voltage)
Parameter:$voltage -- int
Rückgabetyp:undef

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

Der Standardwert ist 8V.

BrickSilentStepper->get_minimum_voltage()
Rückgabetyp:int

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

BrickSilentStepper->set_all_data_period($period)
Parameter:$period -- int
Rückgabetyp:undef

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

BrickSilentStepper->get_all_data_period()
Rückgabetyp:int

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. Die Registrierung kann mit der Funktion register_callback() des Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID und der zweite Parameter ist der Name der Callback-Funktion:

sub my_callback
{
    print "@_[0]";
}

$silent_stepper->register_callback(BrickSilentStepper->CALLBACK_EXAMPLE, 'my_callback')

Die Callback Funktion wird dann von einem internen Thread der IP Connection aufgerufen werden. Im Gegensatz zu vielen anderen Programmiersprachen werden Variablen nicht automatisch zwischen Threads geteilt. Wenn eine Variable gleichzeitig in einer Callback Funktion und dem Rest des Programms genutzt werden soll, dann muss diese als :shared markiert werden. Siehe dazu auch die Dokumentation des threads::shared Perl Moduls für weitere Details.

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen 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.

BrickSilentStepper->CALLBACK_UNDER_VOLTAGE
Parameter:$voltage -- int

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

BrickSilentStepper->CALLBACK_POSITION_REACHED
Parameter:$position -- int

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.

BrickSilentStepper->CALLBACK_ALL_DATA
Parameter:
  • $current_velocity -- int
  • $current_position -- int
  • $remaining_steps -- int
  • $stack_voltage -- int
  • $external_voltage -- int
  • $current_consumption -- int

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.

BrickSilentStepper->CALLBACK_NEW_STATE
Parameter:
  • $state_new -- int
  • $state_previous -- int

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

  • BrickSilentStepper->STATE_STOP = 1
  • BrickSilentStepper->STATE_ACCELERATION = 2
  • BrickSilentStepper->STATE_RUN = 3
  • BrickSilentStepper->STATE_DEACCELERATION = 4
  • BrickSilentStepper->STATE_DIRECTION_CHANGE_TO_FORWARD = 5
  • BrickSilentStepper->STATE_DIRECTION_CHANGE_TO_BACKWARD = 6

Konstanten

BrickSilentStepper->DEVICE_IDENTIFIER

Diese Konstante wird verwendet um einen Silent Stepper Brick zu identifizieren.

Die get_identity() Funktion und der IPConnection->CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickSilentStepper->DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Silent Stepper Brick dar.