PHP - Silent Stepper Brick

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Configuration

Download (ExampleConfiguration.php)

 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
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickSilentStepper.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickSilentStepper;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XXYYZZ'; // Change XXYYZZ to the UID of your Silent Stepper Brick

$ipcon = new IPConnection(); // Create IP connection
$ss = new BrickSilentStepper(UID, $ipcon); // Create device object

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

$ss->setMotorCurrent(800); // 800 mA
$ss->setStepConfiguration(BrickSilentStepper::STEP_RESOLUTION_8,
                          TRUE); // 1/8 steps (interpolated)
$ss->setMaxVelocity(2000); // Velocity 2000 steps/s

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

$ss->enable(); // Enable motor power
$ss->setSteps(60000); // Drive 60000 steps forward

echo "Press key to exit\n";
fgetc(fopen('php://stdin', 'r'));

// Stop motor before disabling motor power
$ss->stop(); // Request motor stop
$ss->setSpeedRamping(500, 5000); // Fast deacceleration (5000 steps/s^2) for stopping
usleep(400*1000); // Wait for motor to actually stop: max velocity (2000 steps/s) / decceleration (5000 steps/s^2) = 0.4 s
$ss->disable(); // Disable motor power

$ipcon->disconnect();

?>

Callback

Download (ExampleCallback.php)

 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
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickSilentStepper.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickSilentStepper;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XXYYZZ'; // Change XXYYZZ to the UID of your Silent Stepper Brick

// Use position reached callback to program random movement
function cb_positionReached($position)
{
    $ss = $user_data;

    if (rand(0, 1)) {
        $steps = rand(1000, 5000); // steps (forward)
        echo "Driving forward: $steps steps\n";
    } else {
        $steps = rand(-5000, -1000); // steps (backward)
        echo "Driving backward: $steps steps\n";
    }

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

    $ss->setSpeedRamping($acc, $dec);
    $ss->setMaxVelocity($vel);
    $ss->setSteps($steps);
}

$ipcon = new IPConnection(); // Create IP connection
$ss = new BrickSilentStepper(UID, $ipcon); // Create device object

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

// Register position reached callback to function cb_positionReached
$ss->registerCallback(BrickSilentStepper::CALLBACK_POSITION_REACHED,
                      'cb_positionReached', $ss);

$ss->setStepConfiguration(BrickSilentStepper::STEP_RESOLUTION_8,
                          TRUE); // 1/8 steps (interpolated)
$ss->enable(); // Enable motor power
$ss->setSteps(1); // Drive one step forward to get things going

echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever

?>

API

Funktion die mehrere Werte zurückgeben geben diese in einem assoziativen Array zurück.

Grundfunktionen

class BrickSilentStepper(string $uid, IPConnection $ipcon)
Parameter:
  • $uid – Typ: string
  • $ipcon – Typ: IPConnection
Rückgabe:
  • $silent_stepper – Typ: BrickSilentStepper

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

<?php   $silent_stepper = new BrickSilentStepper('YOUR_DEVICE_UID', $ipcon);   ?>

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

void BrickSilentStepper::setMaxVelocity(int $velocity)
Parameter:
  • $velocity – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]

Setzt die maximale Geschwindigkeit des Schrittmotors. Diese Funktion startet nicht den Motor, sondern setzt nur die maximale Geschwindigkeit auf welche der Schrittmotor beschleunigt wird. Um den Motor zu fahren können setTargetPosition(), setSteps(), driveForward() oder driveBackward() verwendet werden.

int BrickSilentStepper::getMaxVelocity()
Rückgabe:
  • $velocity – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]

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

int BrickSilentStepper::getCurrentVelocity()
Rückgabe:
  • $velocity – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]

Gibt die aktuelle Geschwindigkeit des Schrittmotors zurück.

void BrickSilentStepper::setSpeedRamping(int $acceleration, int $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

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

array BrickSilentStepper::getSpeedRamping()
Rückgabe-Array:
  • '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 setSpeedRamping() gesetzt.

void BrickSilentStepper::fullBrake()

Führt eine aktive Vollbremsung aus.

Warnung

Diese Funktion ist für Notsituationen bestimmt, in denen ein unverzüglicher Halt notwendig ist. Abhängig von der aktuellen Geschwindigkeit und der Kraft des Motors kann eine Vollbremsung brachial sein.

Ein Aufruf von stop() stoppt den Motor.

void BrickSilentStepper::setSteps(int $steps)
Parameter:
  • $steps – Typ: int, Wertebereich: [-231 bis 231 - 1]

Setzt die Anzahl der Schritte die der Schrittmotor fahren soll. Positive Werte fahren den Motor vorwärts und negative rückwärts. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit setMaxVelocity() und setSpeedRamping() gesetzt, verwendet.

int BrickSilentStepper::getSteps()
Rückgabe:
  • $steps – Typ: int, Wertebereich: [-231 bis 231 - 1]

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

int BrickSilentStepper::getRemainingSteps()
Rückgabe:
  • $steps – Typ: int, Wertebereich: [-231 bis 231 - 1]

Gibt die verbleibenden Schritte des letzten Aufrufs von setSteps() zurück. Beispiel: Wenn setSteps() mit 2000 aufgerufen wird und getRemainingSteps() aufgerufen wird wenn der Motor 500 Schritte fahren hat, wird 1500 zurückgegeben.

void BrickSilentStepper::driveForward()

Fährt den Schrittmotor vorwärts bis driveBackward() oder stop() aufgerufen wird. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit setMaxVelocity() und setSpeedRamping() gesetzt, verwendet.

void BrickSilentStepper::driveBackward()

Fährt den Schrittmotor rückwärts bis driveForward() oder stop() aufgerufen wird. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit setMaxVelocity() und setSpeedRamping() gesetzt, verwendet.

void BrickSilentStepper::stop()

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

void BrickSilentStepper::setMotorCurrent(int $current)
Parameter:
  • $current – Typ: int, Einheit: 1 mA, Wertebereich: [360 bis 1640], Standardwert: 800

Setzt den Strom mit welchem der Motor angetrieben wird.

Warnung

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

int BrickSilentStepper::getMotorCurrent()
Rückgabe:
  • $current – Typ: int, Einheit: 1 mA, Wertebereich: [360 bis 1640], Standardwert: 800

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

void BrickSilentStepper::enable()

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

void BrickSilentStepper::disable()

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.

bool BrickSilentStepper::isEnabled()
Rückgabe:
  • $enabled – Typ: bool

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

void BrickSilentStepper::setBasicConfiguration(int $standstill_current, int $motor_run_current, int $standstill_delay_time, int $power_down_time, int $stealth_threshold, int $coolstep_threshold, int $classic_threshold, bool $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

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

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

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

array BrickSilentStepper::getBasicConfiguration()
Rückgabe-Array:
  • '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 setBasicConfiguration() gesetzt.

Fortgeschrittene Funktionen

void BrickSilentStepper::setCurrentPosition(int $position)
Parameter:
  • $position – Typ: int, Wertebereich: [-231 bis 231 - 1]

Setzt den aktuellen Schrittwert des internen Schrittzählers. Dies kann benutzt werden um die aktuelle Position auf 0 zu setzen wenn ein definierter Startpunkt erreicht wurde (z.B. wenn eine CNC Maschine eine Ecke erreicht).

int BrickSilentStepper::getCurrentPosition()
Rückgabe:
  • $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 (setTargetPosition(), setSteps(), driveForward() der driveBackward()). Es ist auch möglich den Schrittzähler auf 0 oder jeden anderen gewünschten Wert zu setzen mit setCurrentPosition().

void BrickSilentStepper::setTargetPosition(int $position)
Parameter:
  • $position – Typ: int, Wertebereich: [-231 bis 231 - 1]

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

Ein Aufruf von setTargetPosition() mit dem Parameter x ist äquivalent mit einem Aufruf von setSteps() mit dem Parameter (x - getCurrentPosition()).

int BrickSilentStepper::getTargetPosition()
Rückgabe:
  • $position – Typ: int, Wertebereich: [-231 bis 231 - 1]

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

void BrickSilentStepper::setStepConfiguration(int $step_resolution, bool $interpolation)
Parameter:
  • $step_resolution – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
  • $interpolation – Typ: bool, Standardwert: TRUE

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

Für $step_resolution:

  • 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
array BrickSilentStepper::getStepConfiguration()
Rückgabe-Array:
  • 'step_resolution' – Typ: int, Wertebereich: Siehe Konstanten
  • 'interpolation' – Typ: bool, Standardwert: TRUE

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

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

Für $step_resolution:

  • 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
int BrickSilentStepper::getStackInputVoltage()
Rückgabe:
  • $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.

int BrickSilentStepper::getExternalInputVoltage()
Rückgabe:
  • $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.

void BrickSilentStepper::setSpreadcycleConfiguration(int $slow_decay_duration, bool $enable_random_slow_decay, int $fast_decay_duration, int $hysteresis_start_value, int $hysteresis_end_value, int $sine_wave_offset, int $chopper_mode, int $comparator_blank_time, bool $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 Konstanten, Standardwert: 0
  • $comparator_blank_time – Typ: int, Wertebereich: [0 bis 3], Standardwert: 1
  • $fast_decay_without_comparator – Typ: bool, Standardwert: FALSE

Note: Typischerweise können diese Werte bei ihren Standardwerten gelassen werden. Sie sollten nur geändert werden, wenn man weiß was man tut.

Setzt die Spreadcycle Konfigurationsparameter. Spreadcycle ist ein Chopper-Algorithmus der aktiv den Motorstrom regelt. Weitere Informationen dazu können im TMC2130 Datenblatt auf Seite 47 (7 spreadCycle and Classic Chopper) gefunden werden.

  • Slow Decay Duration: Steuert die Aus-Zeit (off time) in der Slow Decay Phase. 0 = Treiber deaktiviert, alle Brücken aus. Nur wenn die Comparator Blank Time >=2 ist sollte ein Wert von 1 gesetzt werden.

  • Enable Random Slow Decay: Muss auf False gesetzt werden um die Aus-Zeit (off time) des Choppers auf die gesetzte Slow Decay Duration zu setzen. Wenn dieser Wert auf True gesetzt wird, wird die Decay Dauer zufällig variiert.

  • Fast Decay Duration: Setzt die Fast Decay Dauer. Dieser Parameter wird nur benutzt, wenn der Spread Cycle als Chopper Modus genutzt wird.

  • Hysteresis Start Value: Setzt der Startwert der Hysterese. Dieser Parameter wird nur benutzt, wenn der Spread Cycle als Chopper Modus genutzt wird.

  • Hysteresis End Value: Setzt den Endwert der Hysterese. Dieser Parameter wird nur benutzt, wenn der Spread Cycle als Chopper Modus genutzt wird.

  • Sinewave Offset: Setzt den Sinuswellen Offset. Der Wert wird nur benutzt, wenn als Chopper Modus Fast Decay benutzt wird. 1/512 dieses Werts wird zum Absolutwert der Sinuswelle hinzuaddiert.

  • Chopper Mode: 0 = Spread Cycle, 1 = Fast Decay.

  • Comperator Blank Time: Setzt die Totzeit von Komparator. Mögliche Werte sind

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

    Ein Wert von 1 oder 2 wird für die meisten Anwendungen empfohlen.

  • Fast Decay Without Comperator: Wenn dieser Wert auf True gesetzt wird, dann wird der Strom-Komparator nicht im Fast Decay Modus genutzt.

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

Für $chopper_mode:

  • BrickSilentStepper::CHOPPER_MODE_SPREAD_CYCLE = 0
  • BrickSilentStepper::CHOPPER_MODE_FAST_DECAY = 1
array BrickSilentStepper::getSpreadcycleConfiguration()
Rückgabe-Array:
  • '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 Konstanten, 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 setBasicConfiguration() gesetzt.

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

Für $chopper_mode:

  • BrickSilentStepper::CHOPPER_MODE_SPREAD_CYCLE = 0
  • BrickSilentStepper::CHOPPER_MODE_FAST_DECAY = 1
void BrickSilentStepper::setStealthConfiguration(bool $enable_stealth, int $amplitude, int $gradient, bool $enable_autoscale, bool $force_symmetric, int $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 Konstanten, Standardwert: 0

Note: Typischerweise können diese Werte bei ihren Standardwerten gelassen werden. Sie sollten nur geändert werden, wenn man weiß was man tut.

Setzt die Konfigurationsparameter für den Stealth Modus.

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

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

Für $freewheel_mode:

  • BrickSilentStepper::FREEWHEEL_MODE_NORMAL = 0
  • BrickSilentStepper::FREEWHEEL_MODE_FREEWHEELING = 1
  • BrickSilentStepper::FREEWHEEL_MODE_COIL_SHORT_LS = 2
  • BrickSilentStepper::FREEWHEEL_MODE_COIL_SHORT_HS = 3
array BrickSilentStepper::getStealthConfiguration()
Rückgabe-Array:
  • '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 Konstanten, Standardwert: 0

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

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

Für $freewheel_mode:

  • BrickSilentStepper::FREEWHEEL_MODE_NORMAL = 0
  • BrickSilentStepper::FREEWHEEL_MODE_FREEWHEELING = 1
  • BrickSilentStepper::FREEWHEEL_MODE_COIL_SHORT_LS = 2
  • BrickSilentStepper::FREEWHEEL_MODE_COIL_SHORT_HS = 3
void BrickSilentStepper::setCoolstepConfiguration(int $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)
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 Konstanten, Standardwert: 0
  • $current_down_step_width – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
  • $minimum_current – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
  • $stallguard_threshold_value – Typ: int, Wertebereich: [-64 bis 63], Standardwert: 0
  • $stallguard_mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

Note: Typischerweise können diese Werte bei ihren Standardwerten gelassen werden. Sie sollten nur geändert werden, wenn man weiß was man tut.

Setzt die Konfigurationsparameter für Coolstep.

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

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

Für $current_up_step_width:

  • 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

Für $current_down_step_width:

  • 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

Für $minimum_current:

  • BrickSilentStepper::MINIMUM_CURRENT_HALF = 0
  • BrickSilentStepper::MINIMUM_CURRENT_QUARTER = 1

Für $stallguard_mode:

  • BrickSilentStepper::STALLGUARD_MODE_STANDARD = 0
  • BrickSilentStepper::STALLGUARD_MODE_FILTERED = 1
array BrickSilentStepper::getCoolstepConfiguration()
Rückgabe-Array:
  • '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 Konstanten, Standardwert: 0
  • 'current_down_step_width' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
  • 'minimum_current' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
  • 'stallguard_threshold_value' – Typ: int, Wertebereich: [-64 bis 63], Standardwert: 0
  • 'stallguard_mode' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

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

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

Für $current_up_step_width:

  • 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

Für $current_down_step_width:

  • 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

Für $minimum_current:

  • BrickSilentStepper::MINIMUM_CURRENT_HALF = 0
  • BrickSilentStepper::MINIMUM_CURRENT_QUARTER = 1

Für $stallguard_mode:

  • BrickSilentStepper::STALLGUARD_MODE_STANDARD = 0
  • BrickSilentStepper::STALLGUARD_MODE_FILTERED = 1
void BrickSilentStepper::setMiscConfiguration(bool $disable_short_to_ground_protection, int $synchronize_phase_frequency)
Parameter:
  • $disable_short_to_ground_protection – Typ: bool, Standardwert: FALSE
  • $synchronize_phase_frequency – Typ: int, Wertebereich: [0 bis 15], Standardwert: 0

Note: Typischerweise können diese Werte bei ihren Standardwerten gelassen werden. Sie sollten nur geändert werden, wenn man weiß was man tut.

Setzt verschiedene Parametereinstellungen.

  • Disable Short To Ground Protection: Setze diesen Wert auf False um den Kurzschluss nach Masse Schutz zu aktivieren. Ansonsten ist dieser deaktiviert.
  • Synchronize Phase Frequency: Mit diesem Parameter kann der Chopper für beide Phasen eines zweiphasen Motors synchronisiert werden. Der Wertebereich ist 0-15. Wenn der Wert auf 0 gesetzt wird ist die Synchronisation abgeschaltet. Ansonsten wird die Synchronisation mit folgender Formel durchgeführt: f_sync = f_clk/(value*64). Im Classic Modus ist die Synchronisation automatisch abgeschaltet. f_clk ist 12.8MHz.
array BrickSilentStepper::getMiscConfiguration()
Rückgabe-Array:
  • '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 setMiscConfiguration() gesetzt.

array BrickSilentStepper::getDriverStatus()
Rückgabe-Array:
  • 'open_load' – Typ: int, Wertebereich: Siehe Konstanten
  • 'short_to_ground' – Typ: int, Wertebereich: Siehe Konstanten
  • 'over_temperature' – Typ: int, Wertebereich: Siehe Konstanten
  • '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 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. Er repräsentiert einer Multiplikator von 1/32 bis zu 32/32 vom Motor Run Current, wie von setBasicConfiguration() gesetzt. Beispiel: Wenn ein Motor Run Current von 1000mA gesetzt wurde und ein Wert von 15 zurückgegeben wird, entspricht das einem Actual Motor Current von 16/32*1000mA = 500mA.
  • Stallguard Result: Der Stallguard Wert gibt einen Hinweis auf die Last des Motors. Ein niedriger Wert bedeutet eine höhere Last. Über Ausprobieren kann man mit diesem Wert herausfinden, welcher Wert zu einem geeigneten Drehmoment bei der aktuellen Geschwindigkeit führt. Danach kann über diesen Wert herausgefunden werden, wenn eine Blockierung des Motors wahrscheinlich wird und es kann dementsprechend darauf reagiert werden (z.B. indem die Geschwindigkeit reduziert wird). Im Stillstand kann dieser Wert nicht benutzt werden. Er zeigt dann die Chopper On-Time für Motorspule A.
  • Stealth Voltage Amplitude: Zeigt das aktuelle PWM Scaling. Im Stealth Modus kann dieser Wert benutzt werden um die Motorlast abzuschätzen und eine Blockierung erkannt werden, wenn autoscale aktiviert wurde (see setStealthConfiguration()).

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

Für $open_load:

  • BrickSilentStepper::OPEN_LOAD_NONE = 0
  • BrickSilentStepper::OPEN_LOAD_PHASE_A = 1
  • BrickSilentStepper::OPEN_LOAD_PHASE_B = 2
  • BrickSilentStepper::OPEN_LOAD_PHASE_AB = 3

Für $short_to_ground:

  • 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

Für $over_temperature:

  • BrickSilentStepper::OVER_TEMPERATURE_NONE = 0
  • BrickSilentStepper::OVER_TEMPERATURE_WARNING = 1
  • BrickSilentStepper::OVER_TEMPERATURE_LIMIT = 2
void BrickSilentStepper::setTimeBase(int $time_base)
Parameter:
  • $time_base – Typ: int, Einheit: 1 s, Wertebereich: [0 bis 232 - 1], Standardwert: 1

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.

int BrickSilentStepper::getTimeBase()
Rückgabe:
  • $time_base – Typ: int, Einheit: 1 s, Wertebereich: [0 bis 232 - 1], Standardwert: 1

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

array BrickSilentStepper::getAllData()
Rückgabe-Array:
  • '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 setBasicConfiguration()) multipliziert mit dem Motor Run Current (see getDriverStatus()). Es handelt sich dabei um eine interne Berechnung des Treibers, nicht um eine externe unabhängige Messung.

Die Stromverbrauchsberechnung war bis Firmware 2.0.1 fehlerhaft, sie funktioniert seit Version 2.0.2 wie beschrieben.

Es existiert auch ein Callback für diese Funktion, siehe CALLBACK_ALL_DATA Callback.

void BrickSilentStepper::setSPITFPBaudrateConfig(bool $enable_dynamic_baudrate, int $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

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

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

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

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

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

Neu in Version 2.0.4 (Firmware).

array BrickSilentStepper::getSPITFPBaudrateConfig()
Rückgabe-Array:
  • '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 setSPITFPBaudrateConfig().

Neu in Version 2.0.4 (Firmware).

int BrickSilentStepper::getSendTimeoutCount(int $communication_method)
Parameter:
  • $communication_method – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • $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 Konstanten sind für diese Funktion verfügbar:

Für $communication_method:

  • 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
void BrickSilentStepper::setSPITFPBaudrate(string $bricklet_port, int $baudrate)
Parameter:
  • $bricklet_port – Typ: string, Wertebereich: ['a' bis 'b']
  • $baudrate – Typ: int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000

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 getSPITFPErrorCount()) kann die Baudrate verringert werden.

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

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

int BrickSilentStepper::getSPITFPBaudrate(string $bricklet_port)
Parameter:
  • $bricklet_port – Typ: string, Wertebereich: ['a' bis 'b']
Rückgabe:
  • $baudrate – Typ: int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000

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

array BrickSilentStepper::getSPITFPErrorCount(string $bricklet_port)
Parameter:
  • $bricklet_port – Typ: string, Wertebereich: ['a' bis 'b']
Rückgabe-Array:
  • '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.

void BrickSilentStepper::enableStatusLED()

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.

void BrickSilentStepper::disableStatusLED()

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.

bool BrickSilentStepper::isStatusLEDEnabled()
Rückgabe:
  • $enabled – Typ: bool, Standardwert: TRUE

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

int BrickSilentStepper::getChipTemperature()
Rückgabe:
  • $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.

void BrickSilentStepper::reset()

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.

array BrickSilentStepper::getIdentity()
Rückgabe-Array:
  • 'uid' – Typ: string, Länge: bis zu 8
  • 'connected_uid' – Typ: string, Länge: bis zu 8
  • 'position' – Typ: string, Wertebereich: ['0' bis '8']
  • 'hardware_version' – Typ: array(int, ...), 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: array(int, ...), 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. Es gibt auch eine Konstante für den Device Identifier dieses Bricks.

Konfigurationsfunktionen für Callbacks

void BrickSilentStepper::registerCallback(int $callback_id, callable $callback, mixed $user_data=NULL)
Parameter:
  • $callback_id – Typ: int
  • $callback – Typ: callable
  • $user_data – Typ: mixed

Registriert die $function für die gegebene $callback_id. Die optionalen $user_data werden der Funktion als letztes Parameter mit übergeben.

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

void BrickSilentStepper::setMinimumVoltage(int $voltage)
Parameter:
  • $voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 8000

Setzt die minimale Spannung, 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.

int BrickSilentStepper::getMinimumVoltage()
Rückgabe:
  • $voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 8000

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

void BrickSilentStepper::setAllDataPeriod(int $period)
Parameter:
  • $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

int BrickSilentStepper::getAllDataPeriod()
Rückgabe:
  • $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion registerCallback() des Geräte Objektes durchgeführt werden. Der erste Parameter ist der Callback ID und der zweite die Callback-Funktion:

<?php

function myCallback($param)
{
    echo $param . "\n";
}

$silent_stepper->registerCallback(BrickSilentStepper::CALLBACK_EXAMPLE, 'myCallback');

?>

Die verfügbaren IDs mit den dazugehörigen Funktionssignaturen 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.

int BrickSilentStepper::CALLBACK_UNDER_VOLTAGE
<?php   void callback(int $voltage [, mixed $user_data])   ?>
Callback-Parameter:
  • $voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
  • $user_data – Typ: mixed

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

int BrickSilentStepper::CALLBACK_POSITION_REACHED
<?php   void callback(int $position [, mixed $user_data])   ?>
Callback-Parameter:
  • $position – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • $user_data – Typ: mixed

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Position, wie von setSteps() oder setTargetPosition() gesetzt, erreicht wird.

Bemerkung

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

int BrickSilentStepper::CALLBACK_ALL_DATA
<?php   void callback(int $current_velocity, int $current_position, int $remaining_steps, int $stack_voltage, int $external_voltage, int $current_consumption [, mixed $user_data])   ?>
Callback-Parameter:
  • $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]
  • $user_data – Typ: mixed

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

int BrickSilentStepper::CALLBACK_NEW_STATE
<?php   void callback(int $state_new, int $state_previous [, mixed $user_data])   ?>
Callback-Parameter:
  • $state_new – Typ: int, Wertebereich: Siehe Konstanten
  • $state_previous – Typ: int, Wertebereich: Siehe Konstanten
  • $user_data – Typ: mixed

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:

Für $state_new:

  • 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

Für $state_previous:

  • 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

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

array BrickSilentStepper::getAPIVersion()
Rückgabe-Array:
  • $api_version – Typ: array(int, ...), 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]

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

bool BrickSilentStepper::getResponseExpected(int $function_id)
Parameter:
  • $function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • $response_expected – Typ: 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 setResponseExpected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

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

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

Für $function_id:

  • 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::FUNCTION_WRITE_BRICKLET_PLUGIN = 246
void BrickSilentStepper::setResponseExpected(int $function_id, bool $response_expected)
Parameter:
  • $function_id – Typ: int, Wertebereich: Siehe Konstanten
  • $response_expected – Typ: bool

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

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

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

Für $function_id:

  • 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::FUNCTION_WRITE_BRICKLET_PLUGIN = 246
void BrickSilentStepper::setResponseExpectedAll(bool $response_expected)
Parameter:
  • $response_expected – Typ: bool

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

Interne Funktionen

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

array BrickSilentStepper::getProtocol1BrickletName(string $port)
Parameter:
  • $port – Typ: string, Wertebereich: ['a' bis 'b']
Rückgabe-Array:
  • 'protocol_version' – Typ: int, Wertebereich: [0 bis 255]
  • 'firmware_version' – Typ: array(int, ...), 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.

void BrickSilentStepper::writeBrickletPlugin(string $port, int $offset, array $chunk)
Parameter:
  • $port – Typ: string, Wertebereich: ['a' bis 'b']
  • $offset – Typ: int, Wertebereich: [0 bis 255]
  • $chunk – Typ: array(int, ...), Länge: 32, Wertebereich: [0 bis 255]

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.

array BrickSilentStepper::readBrickletPlugin(string $port, int $offset)
Parameter:
  • $port – Typ: string, Wertebereich: ['a' bis 'b']
  • $offset – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:
  • $chunk – Typ: array(int, ...), 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.

Konstanten

int BrickSilentStepper::DEVICE_IDENTIFIER

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

Die getIdentity() Funktion und der IPConnection::CALLBACK_ENUMERATE Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

string BrickSilentStepper::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Silent Stepper Brick dar.