PHP - Stepper Brick

Dies ist die Beschreibung der PHP API Bindings für den Stepper Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des 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/BrickStepper.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickStepper;

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

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

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

$stepper->setMotorCurrent(800); // 800 mA
$stepper->setStepMode(8); // 1/8 step mode
$stepper->setMaxVelocity(2000); // Velocity 2000 steps/s

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

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

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

// Stop motor before disabling motor power
$stepper->stop(); // Request motor stop
$stepper->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
$stepper->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
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickStepper;

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

// Use position reached callback to program random movement
function cb_positionReached($position, $user_data)
{
    $stepper = $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";

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

$ipcon = new IPConnection(); // Create IP connection
$stepper = new BrickStepper(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
$stepper->registerCallback(BrickStepper::CALLBACK_POSITION_REACHED,
                           'cb_positionReached', $stepper);

$stepper->enable(); // Enable motor power
$stepper->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 BrickStepper(string $uid, IPConnection $ipcon)
Parameter:
  • $uid – Typ: string
  • $ipcon – Typ: IPConnection
Rückgabe:
  • $stepper – Typ: BrickStepper

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

<?php   $stepper = new BrickStepper('YOUR_DEVICE_UID', $ipcon);   ?>

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

void BrickStepper::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 BrickStepper::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 BrickStepper::getCurrentVelocity()
Rückgabe:
  • $velocity – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]

Gibt die aktuelle Geschwindigkeit des Schrittmotors zurück.

void BrickStepper::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 BrickStepper::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 BrickStepper::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 BrickStepper::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 BrickStepper::getSteps()
Rückgabe:
  • $steps – Typ: int, Wertebereich: [-231 bis 231 - 1]

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

int BrickStepper::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 BrickStepper::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 BrickStepper::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 BrickStepper::stop()

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

void BrickStepper::setMotorCurrent(int $current)
Parameter:
  • $current – Typ: int, Einheit: 1 mA, Wertebereich: [100 bis 2291], 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 BrickStepper::getMotorCurrent()
Rückgabe:
  • $current – Typ: int, Einheit: 1 mA, Wertebereich: [100 bis 2291], Standardwert: 800

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

void BrickStepper::enable()

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

void BrickStepper::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 BrickStepper::isEnabled()
Rückgabe:
  • $enabled – Typ: bool

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

Fortgeschrittene Funktionen

void BrickStepper::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 BrickStepper::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 BrickStepper::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 BrickStepper::getTargetPosition()
Rückgabe:
  • $position – Typ: int, Wertebereich: [-231 bis 231 - 1]

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

void BrickStepper::setStepMode(int $mode)
Parameter:
  • $mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 8

Setzt den Schrittmodus des Schrittmotors. Mögliche Werte sind:

  • Vollschritt = 1
  • Halbschritt = 2
  • Viertelschritt = 4
  • Achtelschritt = 8

Ein höherer Wert erhöht die Auflösung und verringert das Drehmoment des Schrittmotors.

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

Für $mode:

  • BrickStepper::STEP_MODE_FULL_STEP = 1
  • BrickStepper::STEP_MODE_HALF_STEP = 2
  • BrickStepper::STEP_MODE_QUARTER_STEP = 4
  • BrickStepper::STEP_MODE_EIGHTH_STEP = 8
int BrickStepper::getStepMode()
Rückgabe:
  • $mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 8

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

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

Für $mode:

  • BrickStepper::STEP_MODE_FULL_STEP = 1
  • BrickStepper::STEP_MODE_HALF_STEP = 2
  • BrickStepper::STEP_MODE_QUARTER_STEP = 4
  • BrickStepper::STEP_MODE_EIGHTH_STEP = 8
int BrickStepper::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 BrickStepper::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 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.

int BrickStepper::getCurrentConsumption()
Rückgabe:
  • $current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

Gibt die Stromaufnahme des Motors zurück.

void BrickStepper::setDecay(int $decay)
Parameter:
  • $decay – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 10000

Setzt den Decay Modus (Abklingmodus) des Schrittmotors. Ein Wert von 0 setzt den Fast Decay Modus (schneller Stromabbau), ein Wert von 65535 den Slow Decay Modus (langsamer Stromabbau) ein Wert dazwischen den Mixed Decay Modus (Nutzung beider Modi).

Eine Änderung des Decay Modus ist nur möglich wenn die Synchrongleichrichtung aktiviert ist (siehe setSyncRect()).

Für eine gute Erläuterung der verschiedenen Decay Modi siehe diesen Blogeintrag (Englisch) von Avayan oder diesen Blogeintrag (Deutsch) von T. Ostermann.

Ein guter Decay Modus ist leider unterschiedlich für jeden Motor. Der beste Weg einen guten Decay Modus für den jeweiligen Schrittmotor zu finden, wenn der Strom nicht mit einem Oszilloskop gemessen werden kann, ist auf die Geräusche des Motors zu hören. Wenn der Wert zu gering ist, ist oftmals ein hoher Ton zu hören und wenn er zu hoch ist, oftmals ein brummendes Geräusch.

Im Allgemeinen ist der Fast Decay Modus (kleine Werte) geräuschvoller, erlaubt aber höhere Motorgeschwindigkeiten.

Bemerkung

Es existiert leider keine Formel zur Berechnung des optimalen Decay Modus eines Schrittmotors. Sollten Probleme mit lauten Geräuschen oder einer zu geringen maximalen Motorgeschwindigkeit bestehen, bleibt nur Ausprobieren um einen besseren Decay Modus zu finden.

int BrickStepper::getDecay()
Rückgabe:
  • $decay – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 10000

Gibt den Decay Modus zurück, wie von setDecay() gesetzt.

void BrickStepper::setSyncRect(bool $sync_rect)
Parameter:
  • $sync_rect – Typ: bool, Standardwert: FALSE

Aktiviert oder deaktiviert (true oder false) die Synchrongleichrichtung.

Bei aktiver Synchrongleichrichtung kann der Decay Modus geändert werden (Siehe setDecay()). Ohne Synchrongleichrichtung wird der Fast Decay Modus verwendet.

Für eine Erläuterung der Synchrongleichrichtung siehe hier.

Warnung

Wenn hohe Geschwindigkeiten (> 10000 Schritte/s) mit einem großen Schrittmotor mit einer hohen Induktivität genutzt werden sollen, wird dringend geraten die Synchrongleichrichtung zu deaktivieren. Sonst kann es vorkommen, dass der Brick die Last nicht bewältigen kann und überhitzt.

bool BrickStepper::isSyncRect()
Rückgabe:
  • $sync_rect – Typ: bool, Standardwert: FALSE

Gibt zurück ob die Synchrongleichrichtung aktiviert ist.

void BrickStepper::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 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 BrickStepper::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 BrickStepper::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.

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

void BrickStepper::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.3.6 (Firmware).

array BrickStepper::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.3.6 (Firmware).

int BrickStepper::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:

  • BrickStepper::COMMUNICATION_METHOD_NONE = 0
  • BrickStepper::COMMUNICATION_METHOD_USB = 1
  • BrickStepper::COMMUNICATION_METHOD_SPI_STACK = 2
  • BrickStepper::COMMUNICATION_METHOD_CHIBI = 3
  • BrickStepper::COMMUNICATION_METHOD_RS485 = 4
  • BrickStepper::COMMUNICATION_METHOD_WIFI = 5
  • BrickStepper::COMMUNICATION_METHOD_ETHERNET = 6
  • BrickStepper::COMMUNICATION_METHOD_WIFI_V2 = 7

Neu in Version 2.3.4 (Firmware).

void BrickStepper::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.

Neu in Version 2.3.3 (Firmware).

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

Neu in Version 2.3.3 (Firmware).

array BrickStepper::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.

Neu in Version 2.3.3 (Firmware).

void BrickStepper::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.

Neu in Version 2.3.1 (Firmware).

void BrickStepper::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.

Neu in Version 2.3.1 (Firmware).

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

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

Neu in Version 2.3.1 (Firmware).

int BrickStepper::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 BrickStepper::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 BrickStepper::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 BrickStepper::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 BrickStepper::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 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 BrickStepper::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 BrickStepper::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 BrickStepper::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";
}

$stepper->registerCallback(BrickStepper::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 BrickStepper::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 BrickStepper::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 BrickStepper::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 BrickStepper::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 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:

  • BrickStepper::STATE_STOP = 1
  • BrickStepper::STATE_ACCELERATION = 2
  • BrickStepper::STATE_RUN = 3
  • BrickStepper::STATE_DEACCELERATION = 4
  • BrickStepper::STATE_DIRECTION_CHANGE_TO_FORWARD = 5
  • BrickStepper::STATE_DIRECTION_CHANGE_TO_BACKWARD = 6

Für $state_previous:

  • BrickStepper::STATE_STOP = 1
  • BrickStepper::STATE_ACCELERATION = 2
  • BrickStepper::STATE_RUN = 3
  • BrickStepper::STATE_DEACCELERATION = 4
  • BrickStepper::STATE_DIRECTION_CHANGE_TO_FORWARD = 5
  • BrickStepper::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 BrickStepper::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 BrickStepper::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:

  • BrickStepper::FUNCTION_SET_MAX_VELOCITY = 1
  • BrickStepper::FUNCTION_SET_SPEED_RAMPING = 4
  • BrickStepper::FUNCTION_FULL_BRAKE = 6
  • BrickStepper::FUNCTION_SET_CURRENT_POSITION = 7
  • BrickStepper::FUNCTION_SET_TARGET_POSITION = 9
  • BrickStepper::FUNCTION_SET_STEPS = 11
  • BrickStepper::FUNCTION_SET_STEP_MODE = 14
  • BrickStepper::FUNCTION_DRIVE_FORWARD = 16
  • BrickStepper::FUNCTION_DRIVE_BACKWARD = 17
  • BrickStepper::FUNCTION_STOP = 18
  • BrickStepper::FUNCTION_SET_MOTOR_CURRENT = 22
  • BrickStepper::FUNCTION_ENABLE = 24
  • BrickStepper::FUNCTION_DISABLE = 25
  • BrickStepper::FUNCTION_SET_DECAY = 27
  • BrickStepper::FUNCTION_SET_MINIMUM_VOLTAGE = 29
  • BrickStepper::FUNCTION_SET_SYNC_RECT = 33
  • BrickStepper::FUNCTION_SET_TIME_BASE = 35
  • BrickStepper::FUNCTION_SET_ALL_DATA_PERIOD = 38
  • BrickStepper::FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • BrickStepper::FUNCTION_SET_SPITFP_BAUDRATE = 234
  • BrickStepper::FUNCTION_ENABLE_STATUS_LED = 238
  • BrickStepper::FUNCTION_DISABLE_STATUS_LED = 239
  • BrickStepper::FUNCTION_RESET = 243
  • BrickStepper::FUNCTION_WRITE_BRICKLET_PLUGIN = 246
void BrickStepper::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:

  • BrickStepper::FUNCTION_SET_MAX_VELOCITY = 1
  • BrickStepper::FUNCTION_SET_SPEED_RAMPING = 4
  • BrickStepper::FUNCTION_FULL_BRAKE = 6
  • BrickStepper::FUNCTION_SET_CURRENT_POSITION = 7
  • BrickStepper::FUNCTION_SET_TARGET_POSITION = 9
  • BrickStepper::FUNCTION_SET_STEPS = 11
  • BrickStepper::FUNCTION_SET_STEP_MODE = 14
  • BrickStepper::FUNCTION_DRIVE_FORWARD = 16
  • BrickStepper::FUNCTION_DRIVE_BACKWARD = 17
  • BrickStepper::FUNCTION_STOP = 18
  • BrickStepper::FUNCTION_SET_MOTOR_CURRENT = 22
  • BrickStepper::FUNCTION_ENABLE = 24
  • BrickStepper::FUNCTION_DISABLE = 25
  • BrickStepper::FUNCTION_SET_DECAY = 27
  • BrickStepper::FUNCTION_SET_MINIMUM_VOLTAGE = 29
  • BrickStepper::FUNCTION_SET_SYNC_RECT = 33
  • BrickStepper::FUNCTION_SET_TIME_BASE = 35
  • BrickStepper::FUNCTION_SET_ALL_DATA_PERIOD = 38
  • BrickStepper::FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • BrickStepper::FUNCTION_SET_SPITFP_BAUDRATE = 234
  • BrickStepper::FUNCTION_ENABLE_STATUS_LED = 238
  • BrickStepper::FUNCTION_DISABLE_STATUS_LED = 239
  • BrickStepper::FUNCTION_RESET = 243
  • BrickStepper::FUNCTION_WRITE_BRICKLET_PLUGIN = 246
void BrickStepper::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 BrickStepper::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 BrickStepper::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 BrickStepper::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 BrickStepper::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um einen 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 BrickStepper::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Stepper Brick dar.