PHP - RS232 Bricklet 2.0

Dies ist die Beschreibung der PHP API Bindings für das RS232 Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des RS232 Bricklet 2.0 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).

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 RX pin to the TX pin on the same Bricklet

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

?>

API

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

Grundfunktionen

class BrickletRS232V2(string $uid, IPConnection $ipcon)

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 (siehe Beispiele oben).

int BrickletRS232V2::write(array $message)

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)

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)

Setzt die Konfiguration für die RS232-Kommunikation. Verfügbare Optionen sind:

  • Baudrate zwischen 100 und 2000000 Baud.
  • Parität von None, Odd und Even.
  • Stopp-Bits von 1 oder 2.
  • Wortlänge zwischen 5 und 8.
  • Flow Control kann aus, Software oder Hardware sein.

Der Standard ist: 115200 Baud, Parität None, 1 Stop Bits, Wortlänge 8.

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

  • BrickletRS232V2::PARITY_NONE = 0
  • BrickletRS232V2::PARITY_ODD = 1
  • BrickletRS232V2::PARITY_EVEN = 2
  • BrickletRS232V2::STOPBITS_1 = 1
  • BrickletRS232V2::STOPBITS_2 = 2
  • BrickletRS232V2::WORDLENGTH_5 = 5
  • BrickletRS232V2::WORDLENGTH_6 = 6
  • BrickletRS232V2::WORDLENGTH_7 = 7
  • BrickletRS232V2::WORDLENGTH_8 = 8
  • BrickletRS232V2::FLOWCONTROL_OFF = 0
  • BrickletRS232V2::FLOWCONTROL_SOFTWARE = 1
  • BrickletRS232V2::FLOWCONTROL_HARDWARE = 2
array BrickletRS232V2::getConfiguration()

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

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

  • BrickletRS232V2::PARITY_NONE = 0
  • BrickletRS232V2::PARITY_ODD = 1
  • BrickletRS232V2::PARITY_EVEN = 2
  • BrickletRS232V2::STOPBITS_1 = 1
  • BrickletRS232V2::STOPBITS_2 = 2
  • BrickletRS232V2::WORDLENGTH_5 = 5
  • BrickletRS232V2::WORDLENGTH_6 = 6
  • BrickletRS232V2::WORDLENGTH_7 = 7
  • BrickletRS232V2::WORDLENGTH_8 = 8
  • BrickletRS232V2::FLOWCONTROL_OFF = 0
  • BrickletRS232V2::FLOWCONTROL_SOFTWARE = 1
  • BrickletRS232V2::FLOWCONTROL_HARDWARE = 2

Das zurückgegebene Array enthält die Keys baudrate, parity, stopbits, wordlength und flowcontrol.

Fortgeschrittene Funktionen

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

Setzt die Größe des Sende- und Empfangsbuffers. In Summe müssen die Buffer eine Größe von 10240 Byte (10kb) haben, die Minimalgröße ist 1024 Byte (1kb) 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.

Die Standardkonfiguration ist 5120 Byte (5kb) pro Buffer.

array BrickletRS232V2::getBufferConfig()

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

Das zurückgegebene Array enthält die Keys send_buffer_size und receive_buffer_size.

array BrickletRS232V2::getBufferStatus()

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

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

Das zurückgegebene Array enthält die Keys send_buffer_used und receive_buffer_used.

array BrickletRS232V2::getErrorCount()

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

Das zurückgegebene Array enthält die Keys error_count_overrun und error_count_parity.

array BrickletRS232V2::getAPIVersion()

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

bool BrickletRS232V2::getResponseExpected(int $function_id)

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.

Siehe setResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

void BrickletRS232V2::setResponseExpected(int $function_id, bool $response_expected)

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

  • 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_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)

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

array BrickletRS232V2::getSPITFPErrorCount()

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.

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

int BrickletRS232V2::setBootloaderMode(int $mode)

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

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

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

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

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

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)

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::setStatusLEDConfig(int $config)

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:

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

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

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

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

Gibt die Temperatur in °C, 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 bestehende führt zu undefiniertem Verhalten.

void BrickletRS232V2::writeUID(int $uid)

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

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

array BrickletRS232V2::getIdentity()

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 kann 'a', 'b', 'c' oder 'd' sein.

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

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

Konfigurationsfunktionen für Callbacks

void BrickletRS232V2::registerCallback(int $callback_id, callable $callback, mixed $user_data=NULL)

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.

Im Startzustand ist der Callback deaktiviert.

void BrickletRS232V2::disableReadCallback()

Deaktiviert den CALLBACK_READ Callback.

Im Startzustand ist der Callback deaktiviert.

bool BrickletRS232V2::isReadCallbackEnabled()

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

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.

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 BrickletRS232V2::CALLBACK_READ
<?php   void callback(array $message [, mixed $user_data])   ?>

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

Dieser Callback kann durch enableReadCallback() aktiviert werden.

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

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

Konstanten

int BrickletRS232V2::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein RS232 Bricklet 2.0 zu identifizieren.

Die getIdentity() Funktion und der 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.