PHP - RS232 Bricklet 2.0¶

Loopback¶

Download (ExampleLoopback.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

<?php

// For this example connect the RX1 and TX pin to receive the send message

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletRS232V2;

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

// Callback function for read callback
function cb_read($message)
{
    // Assume that the message consists of ASCII characters and convert it
    // from an array of chars to a string
    echo "Message: \"" . implode($message) . "\"\n";
}

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

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

// Register read callback to function cb_read
$rs232->registerCallback(BrickletRS232V2::CALLBACK_READ, 'cb_read');

// Enable read callback
$rs232->enableReadCallback();

// Write "test" string
$rs232->write(str_split('test'));

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

?>

Grundfunktionen¶

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

Parameter:	$uid – Typ: string $ipcon – Typ: IPConnection
Rückgabe:	$rs232_v2 – Typ: BrickletRS232V2

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

<?php   $rs232_v2 = new BrickletRS232V2('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletRS232V2::write(array $message)¶

Parameter:	$message – Typ: array(string, ...), Länge: variabel
Rückgabe:	$message_written – Typ: int, Wertebereich: [0 bis 216 - 1]

Schreibt Zeichen auf die RS232-Schnittstelle. Die Zeichen können Binärdaten sein, ASCII o.ä. ist nicht notwendig.

Der Rückgabewert ist die Anzahl der Zeichen die geschrieben wurden.

Siehe setConfiguration() für Konfigurationsmöglichkeiten bezüglich Baudrate, Parität usw.

array BrickletRS232V2::read(int $length)¶

Parameter:	$length – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:	$message – Typ: array(string, ...), Länge: variabel

Gibt bis zu length Zeichen aus dem Empfangsbuffer zurück.

Anstatt mit dieser Funktion zu pollen, ist es auch möglich Callbacks zu nutzen. Diese Funktion gibt nur Daten zurück wenn der Read-Callback nicht aktiv ist. Siehe enableReadCallback() und CALLBACK_READ Callback.

void BrickletRS232V2::setConfiguration(int $baudrate, int $parity, int $stopbits, int $wordlength, int $flowcontrol)¶

Parameter:	$baudrate – Typ: int, Einheit: 1 Bd, Wertebereich: [100 bis 2000000], Standardwert: 115200 $parity – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 $stopbits – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1 $wordlength – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 8 $flowcontrol – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt die Konfiguration für die RS232-Kommunikation.

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

Für $parity:

• BrickletRS232V2::PARITY_NONE = 0
• BrickletRS232V2::PARITY_ODD = 1
• BrickletRS232V2::PARITY_EVEN = 2

Für $stopbits:

• BrickletRS232V2::STOPBITS_1 = 1
• BrickletRS232V2::STOPBITS_2 = 2

Für $wordlength:

• BrickletRS232V2::WORDLENGTH_5 = 5
• BrickletRS232V2::WORDLENGTH_6 = 6
• BrickletRS232V2::WORDLENGTH_7 = 7
• BrickletRS232V2::WORDLENGTH_8 = 8

Für $flowcontrol:

• BrickletRS232V2::FLOWCONTROL_OFF = 0
• BrickletRS232V2::FLOWCONTROL_SOFTWARE = 1
• BrickletRS232V2::FLOWCONTROL_HARDWARE = 2

array BrickletRS232V2::getConfiguration()¶

Rückgabe-Array:	'baudrate' – Typ: int, Einheit: 1 Bd, Wertebereich: [100 bis 2000000], Standardwert: 115200 'parity' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 'stopbits' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1 'wordlength' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 8 'flowcontrol' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

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

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

Für $parity:

• BrickletRS232V2::PARITY_NONE = 0
• BrickletRS232V2::PARITY_ODD = 1
• BrickletRS232V2::PARITY_EVEN = 2

Für $stopbits:

• BrickletRS232V2::STOPBITS_1 = 1
• BrickletRS232V2::STOPBITS_2 = 2

Für $wordlength:

• BrickletRS232V2::WORDLENGTH_5 = 5
• BrickletRS232V2::WORDLENGTH_6 = 6
• BrickletRS232V2::WORDLENGTH_7 = 7
• BrickletRS232V2::WORDLENGTH_8 = 8

Für $flowcontrol:

• BrickletRS232V2::FLOWCONTROL_OFF = 0
• BrickletRS232V2::FLOWCONTROL_SOFTWARE = 1
• BrickletRS232V2::FLOWCONTROL_HARDWARE = 2

Fortgeschrittene Funktionen¶

void BrickletRS232V2::setBufferConfig(int $send_buffer_size, int $receive_buffer_size)¶

Parameter:	$send_buffer_size – Typ: int, Einheit: 1 B, Wertebereich: [210 bis 9216], Standardwert: 5120 $receive_buffer_size – Typ: int, Einheit: 1 B, Wertebereich: [210 bis 9216], Standardwert: 5120

Setzt die Größe des Sende- und Empfangsbuffers. In Summe müssen die Buffer eine Größe von 10240 Byte (10KiB) haben, die Minimalgröße ist 1024 Byte (1KiB) für beide.

Der aktuelle Bufferinhalt geht bei einem Aufruf dieser Funktion verloren.

Der Sendebuffer hält die Daten welche über write() übergeben und noch nicht geschrieben werden konnten. Der Empfangsbuffer hält Daten welche über RS232 empfangen wurden aber noch nicht über read() oder CALLBACK_READ Callback an ein Nutzerprogramm übertragen werden konnten.

array BrickletRS232V2::getBufferConfig()¶

Rückgabe-Array:	'send_buffer_size' – Typ: int, Einheit: 1 B, Wertebereich: [210 bis 9216], Standardwert: 5120 'receive_buffer_size' – Typ: int, Einheit: 1 B, Wertebereich: [210 bis 9216], Standardwert: 5120

Gibt die Buffer-Konfiguration zurück, wie von setBufferConfig() gesetzt.

array BrickletRS232V2::getBufferStatus()¶

Rückgabe-Array:	'send_buffer_used' – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 9216] 'receive_buffer_used' – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 9216]

Gibt die aktuell genutzten Bytes des Sende- und Empfangsbuffers zurück.

Siehe setBufferConfig() zur Konfiguration der Buffergrößen.

array BrickletRS232V2::getErrorCount()¶

Rückgabe-Array:	'error_count_overrun' – Typ: int, Wertebereich: [0 bis 232 - 1] 'error_count_parity' – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle Anzahl an Overrun und Parity Fehlern zurück.

array BrickletRS232V2::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 BrickletRS232V2::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:

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

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

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

int BrickletRS232V2::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 BrickletRS232V2::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 BrickletRS232V2::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 BrickletRS232V2::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 BrickletRS232V2::enableReadCallback()¶

Aktiviert den CALLBACK_READ Callback. Dies deaktiviert den CALLBACK_FRAME_READABLE Callback.

Im Startzustand ist der Callback deaktiviert.

void BrickletRS232V2::disableReadCallback()¶

Deaktiviert den CALLBACK_READ Callback.

Im Startzustand ist der Callback deaktiviert.

bool BrickletRS232V2::isReadCallbackEnabled()¶

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

Gibt true zurück falls CALLBACK_READ Callback aktiviert ist, false sonst.

void BrickletRS232V2::setFrameReadableCallbackConfiguration(int $frame_size)¶

Parameter:	$frame_size – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 9216], Standardwert: 0

Konfiguriert den CALLBACK_FRAME_READABLE Callback. Die Frame Size ist die Anzahl an Bytes, die lesbar sein müssen, damit der Callback auslöst. Eine Frame Size von 0 deaktiviert den Callback. Eine Frame Size größer als 0 aktiviert diesen und deaktiviert den CALLBACK_READ Callback.

Im Startzustand ist der Callback deaktiviert.

Neu in Version 2.0.3 (Plugin).

int BrickletRS232V2::getFrameReadableCallbackConfiguration()¶

Rückgabe:	$frame_size – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 9216], Standardwert: 0

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

Neu in Version 2.0.3 (Plugin).

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";
}

$rs232_v2->registerCallback(BrickletRS232V2::CALLBACK_EXAMPLE, 'myCallback');

?>

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

int BrickletRS232V2::CALLBACK_READ¶

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

Callback-Parameter:	$message – Typ: array(string, ...), Länge: variabel $user_data – Typ: mixed

Dieser Callback wird aufgerufen wenn neue Daten zur Verfügung stehen.

Dieser Callback kann durch enableReadCallback() aktiviert werden.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit NULL für message ausgelöst.

int BrickletRS232V2::CALLBACK_ERROR_COUNT¶

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

Callback-Parameter:	$error_count_overrun – Typ: int, Wertebereich: [0 bis 232 - 1] $error_count_parity – Typ: int, Wertebereich: [0 bis 232 - 1] $user_data – Typ: mixed

Dieser Callback wird aufgerufen wenn ein neuer Fehler auftritt. Er gibt die Anzahl der aufgetreten Overrun und Parity Fehler zurück.

int BrickletRS232V2::CALLBACK_FRAME_READABLE¶

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

Callback-Parameter:	$frame_count – Typ: int, Wertebereich: [0 bis 216 - 1] $user_data – Typ: mixed

Dieser Callback wird ausgelöst, wenn mindestens ein neuer Frame an Daten verfügbar sind. Die Größe eines Frames kann mit setFrameReadableCallbackConfiguration() konfiguriert werden. Frame Count ist die Anzahl an Frames, die zum Lesen bereitstehen. Der Callback wird nur einmal pro read() Aufruf ausgelöst. Das heißt, dass wenn eine Framegröße von X Bytes konfiguriert wird, jedes Mal wenn das Callback ausgelöst wird, X Bytes mit der read()-Funktion gelesen werden können, ohne dass der Frame Count-Parameter geprüft werden muss.

Neu in Version 2.0.3 (Plugin).

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

• BrickletRS232V2::FUNCTION_ENABLE_READ_CALLBACK = 3
• BrickletRS232V2::FUNCTION_DISABLE_READ_CALLBACK = 4
• BrickletRS232V2::FUNCTION_SET_CONFIGURATION = 6
• BrickletRS232V2::FUNCTION_SET_BUFFER_CONFIG = 8
• BrickletRS232V2::FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 14
• BrickletRS232V2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletRS232V2::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletRS232V2::FUNCTION_RESET = 243
• BrickletRS232V2::FUNCTION_WRITE_UID = 248

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

• BrickletRS232V2::FUNCTION_ENABLE_READ_CALLBACK = 3
• BrickletRS232V2::FUNCTION_DISABLE_READ_CALLBACK = 4
• BrickletRS232V2::FUNCTION_SET_CONFIGURATION = 6
• BrickletRS232V2::FUNCTION_SET_BUFFER_CONFIG = 8
• BrickletRS232V2::FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 14
• BrickletRS232V2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletRS232V2::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletRS232V2::FUNCTION_RESET = 243
• BrickletRS232V2::FUNCTION_WRITE_UID = 248

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

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

Für $status:

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

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

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

void BrickletRS232V2::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 BrickletRS232V2::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 BrickletRS232V2::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 BrickletRS232V2::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 BrickletRS232V2::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein RS232 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 BrickletRS232V2::DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines RS232 Bricklet 2.0 dar.