PHP - DC Bricklet 2.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

<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletDCV2;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your DC Bricklet 2.0

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

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

$dc->setDriveMode(BrickletDCV2::DRIVE_MODE_DRIVE_COAST);
$dc->setPWMFrequency(10000); // Use PWM frequency of 10 kHz
$dc->setMotion(4096,
               16384); // Slow acceleration (12.5 %/s), fast decceleration (50 %/s) for stopping
$dc->setVelocity(32767); // Full speed forward (100 %)
$dc->setEnabled(TRUE); // Enable motor power

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

$dc->setVelocity(0); // Stop motor before disabling motor power
sleep(2); // Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
$dc->setEnabled(FALSE); // 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/BrickletDCV2.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletDCV2;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your DC Bricklet 2.0

// Use velocity reached callback to swing back and forth
// between full speed forward and full speed backward
function cb_velocityReached($velocity, $user_data)
{
    $dc = $user_data;

    if ($velocity == 32767) {
        echo "Velocity: Full speed forward, now turning backward\n";
        $dc->setVelocity(-32767);
    } elseif ($velocity == -32767) {
        echo "Velocity: Full speed backward, now turning forward\n";
        $dc->setVelocity(32767);
    } else {
        echo "Error\n"; // Can only happen if another program sets velocity
    }
}

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

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

// The acceleration has to be smaller or equal to the maximum
// acceleration of the DC motor, otherwise the velocity reached
// callback will be called too early
$dc->setMotion(4096,
               16384); // Slow acceleration (12.5 %/s), fast decceleration (50 %/s) for stopping
$dc->setVelocity(32767); // Full speed forward (100 %)

// Register velocity reached callback to function cb_velocityReached
$dc->registerCallback(BrickletDCV2::CALLBACK_VELOCITY_REACHED, 'cb_velocityReached', $dc);

// Enable motor power
$dc->setEnabled(TRUE);

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

?>

Grundfunktionen¶

class BrickletDCV2(string $uid, IPConnection $ipcon)¶

Parameter:	$uid – Typ: string $ipcon – Typ: IPConnection
Rückgabe:	$dc_v2 – Typ: BrickletDCV2

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

<?php   $dc_v2 = new BrickletDCV2('YOUR_DEVICE_UID', $ipcon);   ?>

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

void BrickletDCV2::setEnabled(bool $enabled)¶

Parameter:	$enabled – Typ: bool

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

bool BrickletDCV2::getEnabled()¶

Rückgabe:	$enabled – Typ: bool, Standardwert: FALSE

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

void BrickletDCV2::setVelocity(int $velocity)¶

Parameter:	$velocity – Typ: int, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1], Standardwert: 0

Setzt die Geschwindigkeit des Motors. Hierbei sind -32767 maximale Geschwindigkeit rückwärts, 0 ist Halt und 32767 maximale Geschwindigkeit vorwärts. In Abhängigkeit von der Beschleunigung (siehe setMotion()) wird der Motor nicht direkt auf die Geschwindigkeit gebracht sondern gleichmäßig beschleunigt.

Die Geschwindigkeit beschreibt das Tastverhältnis der PWM für die Motoransteuerung. Z.B. entspricht ein Geschwindigkeitswert von 3277 einer PWM mit einem Tastverhältnis von 10%. Weiterhin kann neben dem Tastverhältnis auch die Frequenz der PWM verändert werden, siehe setPWMFrequency().

int BrickletDCV2::getVelocity()¶

Rückgabe:	$velocity – Typ: int, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1], Standardwert: 0

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

int BrickletDCV2::getCurrentVelocity()¶

Rückgabe:	$velocity – Typ: int, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1], Standardwert: 0

Gibt die aktuelle Geschwindigkeit des Motors zurück. Dieser Wert unterscheidet sich von getVelocity(), sobald der Motor auf einen neuen Zielwert, wie von setVelocity() vorgegeben, beschleunigt.

void BrickletDCV2::setMotion(int $acceleration, int $deceleration)¶

Parameter:	$acceleration – Typ: int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 10000 $deceleration – Typ: int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 10000

Setzt die Beschleunigung/Debeschleunigung des Motors. Die Einheit dieses Wertes ist Geschwindigkeit/s. Ein Beschleunigungswert von 10000 bedeutet, dass jede Sekunde die Geschwindigkeit um 10000 erhöht wird (entspricht rund 30% Tastverhältnis).

Beispiel: Soll die Geschwindigkeit von 0 auf 16000 (entspricht ungefähr 50% Tastverhältnis) in 10 Sekunden beschleunigt werden, so ist die Beschleunigung auf 1600 einzustellen.

Eine Beschleunigung/Debeschleunigung von 0 bedeutet ein direkter Sprung des Motors auf die Zielgeschwindigkeit. Es Wird keine Rampe gefahren.

array BrickletDCV2::getMotion()¶

Rückgabe-Array:	'acceleration' – Typ: int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 10000 'deceleration' – Typ: int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 10000

Gibt die Beschleunigung/Debeschleunigung zurück, wie gesetzt von setMotion().

void BrickletDCV2::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 setVelocity() mit 0 erlaubt einen normalen Stopp des Motors.

int BrickletDCV2::getPWMFrequency()¶

Rückgabe:	$frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [1 bis 20000], Standardwert: 15000

Gibt die PWM Frequenz zurück, wie gesetzt von setPWMFrequency().

array BrickletDCV2::getPowerStatistics()¶

Rückgabe-Array:	'voltage' – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1] 'current' – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

Gibt die Eingangsspannung und den Stromverbrauch des Treibers zurück.

Fortgeschrittene Funktionen¶

void BrickletDCV2::setDriveMode(int $mode)¶

Parameter:	$mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt den Fahrmodus. Verfügbare Modi sind:

• 0 = Fahren/Bremsen
• 1 = Fahren/Leerlauf

Diese Modi sind verschiedene Arten der Motoransteuerung.

Im Fahren/Bremsen Modus wird der Motor entweder gefahren oder gebremst. Es gibt keinen Leerlauf. Vorteile sind die lineare Korrelation zwischen PWM und Geschwindigkeit, präzisere Beschleunigungen und die Möglichkeit mit geringeren Geschwindigkeiten zu fahren.

Im Fahren/Leerlauf Modus wir der Motor entweder gefahren oder befindet sich im Leerlauf. Vorteile sind die geringere Stromaufnahme und geringere Belastung des Motors und der Treiberstufe.

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

Für $mode:

• BrickletDCV2::DRIVE_MODE_DRIVE_BRAKE = 0
• BrickletDCV2::DRIVE_MODE_DRIVE_COAST = 1

int BrickletDCV2::getDriveMode()¶

Rückgabe:	$mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt den Fahrmodus zurück, wie von setDriveMode() gesetzt.

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

Für $mode:

• BrickletDCV2::DRIVE_MODE_DRIVE_BRAKE = 0
• BrickletDCV2::DRIVE_MODE_DRIVE_COAST = 1

void BrickletDCV2::setPWMFrequency(int $frequency)¶

Parameter:	$frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [1 bis 20000], Standardwert: 15000

Setzt die Frequenz der PWM, welche den Motor steuert. Oftmals ist eine hohe Frequenz geräuschärmer und der Motor läuft dadurch ruhiger. Trotz dessen führt eine geringe Frequenz zu weniger Schaltvorgängen und somit zu weniger Schaltverlusten. Bei einer Vielzahl von Motoren ermöglichen geringere Frequenzen höhere Drehmomente.

Im Allgemeinen kann diese Funktion ignoriert werden, da der Standardwert höchstwahrscheinlich zu einem akzeptablen Ergebnis führt.

void BrickletDCV2::setErrorLEDConfig(int $config)¶

Parameter:	$config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Konfiguriert die Touch-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option den Fehler-Status anzuzeigen.

Wenn die LED konfiguriert ist um Fehler anzuzeigen gibt es drei unterschiedliche Zustände:

• Aus: Es liegt kein Fehler vor.
• 1s Intervall-Blinken: Eingangsspannung zu klein (unter 6V).
• 250ms Intervall-Blinken: Übertemperatur oder Überstrom.

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

Für $config:

• BrickletDCV2::ERROR_LED_CONFIG_OFF = 0
• BrickletDCV2::ERROR_LED_CONFIG_ON = 1
• BrickletDCV2::ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletDCV2::ERROR_LED_CONFIG_SHOW_ERROR = 3

int BrickletDCV2::getErrorLEDConfig()¶

Rückgabe:	$config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für $config:

• BrickletDCV2::ERROR_LED_CONFIG_OFF = 0
• BrickletDCV2::ERROR_LED_CONFIG_ON = 1
• BrickletDCV2::ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletDCV2::ERROR_LED_CONFIG_SHOW_ERROR = 3

array BrickletDCV2::getSPITFPErrorCount()¶

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 Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

void BrickletDCV2::setStatusLEDConfig(int $config)¶

Parameter:	$config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für $config:

• BrickletDCV2::STATUS_LED_CONFIG_OFF = 0
• BrickletDCV2::STATUS_LED_CONFIG_ON = 1
• BrickletDCV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletDCV2::STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletDCV2::getStatusLEDConfig()¶

Rückgabe:	$config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für $config:

• BrickletDCV2::STATUS_LED_CONFIG_OFF = 0
• BrickletDCV2::STATUS_LED_CONFIG_ON = 1
• BrickletDCV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletDCV2::STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletDCV2::getChipTemperature()¶

Rückgabe:	$temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

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

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

void BrickletDCV2::reset()¶

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

array BrickletDCV2::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: ['a' bis 'h', 'z'] '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 das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

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

Konfigurationsfunktionen für Callbacks¶

void BrickletDCV2::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 BrickletDCV2::setEmergencyShutdownCallbackConfiguration(bool $enabled)¶

Parameter:	$enabled – Typ: bool, Standardwert: FALSE

Aktiviert/Deaktiviert CALLBACK_EMERGENCY_SHUTDOWN Callback.

bool BrickletDCV2::getEmergencyShutdownCallbackConfiguration()¶

Rückgabe:	$enabled – Typ: bool, Standardwert: TRUE

Gibt die Callback-Konfiguration zurück, wie mittels setEmergencyShutdownCallbackConfiguration() gesetzt.

void BrickletDCV2::setVelocityReachedCallbackConfiguration(bool $enabled)¶

Parameter:	$enabled – Typ: bool, Standardwert: FALSE

Aktiviert/Deaktiviert CALLBACK_VELOCITY_REACHED Callback.

bool BrickletDCV2::getVelocityReachedCallbackConfiguration()¶

Rückgabe:	$enabled – Typ: bool, Standardwert: FALSE

Gibt die Callback-Konfiguration zurück, wie mittels setVelocityReachedCallbackConfiguration() gesetzt.

void BrickletDCV2::setCurrentVelocityCallbackConfiguration(int $period, bool $value_has_to_change)¶

Parameter:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 $value_has_to_change – Typ: bool, Standardwert: FALSE

Die Periode ist die Periode mit der der CALLBACK_CURRENT_VELOCITY Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

array BrickletDCV2::getCurrentVelocityCallbackConfiguration()¶

Rückgabe-Array:	'period' – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 'value_has_to_change' – Typ: bool, Standardwert: FALSE

Gibt die Callback-Konfiguration zurück, wie mittels setCurrentVelocityCallbackConfiguration() 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";
}

$dc_v2->registerCallback(BrickletDCV2::CALLBACK_EXAMPLE, 'myCallback');

?>

Die verfügbaren IDs mit den dazugehörigen Funktionssignaturen werden weiter unten beschrieben.

int BrickletDCV2::CALLBACK_EMERGENCY_SHUTDOWN¶

<?php   void callback([mixed $user_data])   ?>

Callback-Parameter:	$user_data – Typ: mixed

Dieser Callback wird ausgelöst, wenn entweder der Stromverbrauch (über 5A) oder die Temperatur der Treiberstufe zu hoch ist (über 175°C). Beide Möglichkeiten sind letztendlich gleichbedeutend, da die Temperatur ihren Schwellwert überschreitet sobald der Motor zu viel Strom verbraucht. Im Falle einer Spannung unter 3,3V (Stapel- oder externe Spannungsversorgung) wird dieser Callback auch ausgelöst.

Sobald dieser Callback ausgelöst wird, wird die Treiberstufe deaktiviert. Das bedeutet setEnabled() muss aufgerufen werden, um den Motor erneut zu fahren.

Bemerkung

Dieser Callback funktioniert nur im Fahren/Bremsen Modus (siehe setDriveMode()). Im Fahren/Leerlauf Modus ist es leider nicht möglich das Überstrom/Übertemperatur-Signal zuverlässig aus dem Chip der Treiberstufe auszulesen.

int BrickletDCV2::CALLBACK_VELOCITY_REACHED¶

<?php   void callback(int $velocity [, mixed $user_data])   ?>

Callback-Parameter:	$velocity – Typ: int, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1] $user_data – Typ: mixed

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Geschwindigkeit erreicht wird. Beispiel: Wenn die aktuelle Geschwindigkeit 0 ist, die Beschleunigung auf 5000 und die Geschwindigkeit auf 10000 konfiguriert ist, wird der CALLBACK_VELOCITY_REACHED Callback nach ungefähr 2 Sekunden ausgelöst, wenn die konfigurierte Geschwindigkeit letztendlich erreicht ist.

Bemerkung

Da es nicht möglich ist eine Rückmeldung vom Gleichstrommotor zu erhalten, funktioniert dies nur wenn die konfigurierte Beschleunigung (siehe setMotion()) 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 BrickletDCV2::CALLBACK_CURRENT_VELOCITY¶

<?php   void callback(int $velocity [, mixed $user_data])   ?>

Callback-Parameter:	$velocity – Typ: int, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1] $user_data – Typ: mixed

Dieser Callback wird mit der Periode, wie gesetzt mit setCurrentVelocityCallbackConfiguration(), ausgelöst. Der Parameter ist die aktuelle vom Motor genutzte Geschwindigkeit.

Der CALLBACK_CURRENT_VELOCITY Callback wird nur nach Ablauf der Periode ausgelöst, wenn sich die Geschwindigkeit geändert hat.

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

• BrickletDCV2::FUNCTION_SET_ENABLED = 1
• BrickletDCV2::FUNCTION_SET_VELOCITY = 3
• BrickletDCV2::FUNCTION_SET_MOTION = 6
• BrickletDCV2::FUNCTION_FULL_BRAKE = 8
• BrickletDCV2::FUNCTION_SET_DRIVE_MODE = 9
• BrickletDCV2::FUNCTION_SET_PWM_FREQUENCY = 11
• BrickletDCV2::FUNCTION_SET_ERROR_LED_CONFIG = 14
• BrickletDCV2::FUNCTION_SET_EMERGENCY_SHUTDOWN_CALLBACK_CONFIGURATION = 16
• BrickletDCV2::FUNCTION_SET_VELOCITY_REACHED_CALLBACK_CONFIGURATION = 18
• BrickletDCV2::FUNCTION_SET_CURRENT_VELOCITY_CALLBACK_CONFIGURATION = 20
• BrickletDCV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletDCV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletDCV2::FUNCTION_RESET = 243
• BrickletDCV2::FUNCTION_WRITE_UID = 248

void BrickletDCV2::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:

• BrickletDCV2::FUNCTION_SET_ENABLED = 1
• BrickletDCV2::FUNCTION_SET_VELOCITY = 3
• BrickletDCV2::FUNCTION_SET_MOTION = 6
• BrickletDCV2::FUNCTION_FULL_BRAKE = 8
• BrickletDCV2::FUNCTION_SET_DRIVE_MODE = 9
• BrickletDCV2::FUNCTION_SET_PWM_FREQUENCY = 11
• BrickletDCV2::FUNCTION_SET_ERROR_LED_CONFIG = 14
• BrickletDCV2::FUNCTION_SET_EMERGENCY_SHUTDOWN_CALLBACK_CONFIGURATION = 16
• BrickletDCV2::FUNCTION_SET_VELOCITY_REACHED_CALLBACK_CONFIGURATION = 18
• BrickletDCV2::FUNCTION_SET_CURRENT_VELOCITY_CALLBACK_CONFIGURATION = 20
• BrickletDCV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletDCV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletDCV2::FUNCTION_RESET = 243
• BrickletDCV2::FUNCTION_WRITE_UID = 248

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

int BrickletDCV2::setBootloaderMode(int $mode)¶

Parameter:	$mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	$status – Typ: int, Wertebereich: Siehe Konstanten

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

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

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

Für $mode:

• BrickletDCV2::BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletDCV2::BOOTLOADER_MODE_FIRMWARE = 1
• BrickletDCV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletDCV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletDCV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für $status:

• BrickletDCV2::BOOTLOADER_STATUS_OK = 0
• BrickletDCV2::BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletDCV2::BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletDCV2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletDCV2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletDCV2::BOOTLOADER_STATUS_CRC_MISMATCH = 5

int BrickletDCV2::getBootloaderMode()¶

Rückgabe:	$mode – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für $mode:

• BrickletDCV2::BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletDCV2::BOOTLOADER_MODE_FIRMWARE = 1
• BrickletDCV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletDCV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletDCV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

void BrickletDCV2::setWriteFirmwarePointer(int $pointer)¶

Parameter:	$pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für writeFirmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

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

int BrickletDCV2::writeFirmware(array $data)¶

Parameter:	$data – Typ: array(int, ...), Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:	$status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von setWriteFirmwarePointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

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

void BrickletDCV2::writeUID(int $uid)¶

Parameter:	$uid – Typ: int, Wertebereich: [0 bis 232 - 1]

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

int BrickletDCV2::readUID()¶

Rückgabe:	$uid – Typ: int, Wertebereich: [0 bis 232 - 1]

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

Konstanten¶

int BrickletDCV2::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein DC Bricklet 2.0 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 BrickletDCV2::DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines DC Bricklet 2.0 dar.