PHP - RS232 Bricklet

Dies ist die Beschreibung der PHP API Bindings für das RS232 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des RS232 Bricklet 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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<?php

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

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletRS232;

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

// Convert string to char array with length 60, as needed by write
function stringToCharArray($message)
{
    $chars = str_split($message);

    while (sizeof($chars) < 60)
    {
        array_push($chars, '\0');
    }

    return $chars;
}

// Assume that the message consists of ASCII characters and
// convert it from an array of chars to a string
function charArrayToString($message, $length)
{
    return implode(array_slice($message, 0, $length));
}

// Callback function for read callback
function cb_read($message, $length)
{
    $str = charArrayToString($message, $length);
    echo "Message (Length: " . $length . "): \"" . $str . "\"\n";
}

$ipcon = new IPConnection(); // Create IP connection
$rs232 = new BrickletRS232(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(BrickletRS232::CALLBACK_READ, 'cb_read');

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

// Write "test" string
$message = 'test';
$rs232->write(stringToCharArray($message), strlen($message));

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 BrickletRS232(string $uid, IPConnection $ipcon)
Parameter:
  • $uid – Typ: string
  • $ipcon – Typ: IPConnection
Rückgabe:
  • $rs232 – Typ: BrickletRS232

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

<?php   $rs232 = new BrickletRS232('YOUR_DEVICE_UID', $ipcon);   ?>

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

int BrickletRS232::write(array $message, int $length)
Parameter:
  • $message – Typ: array(string, ...), Länge: 60
  • $length – Typ: int, Wertebereich: [0 bis 60]
Rückgabe:
  • $written – Typ: int, Wertebereich: [0 bis 60]

Schreibt einen String aus bis zu 60 Zeichen auf die RS232-Schnittstelle. Der String kann aus Binärdaten bestehen, ASCII o.ä. ist nicht notwendig.

Die Länge des Strings muss als ein zusätzlicher Parameter angegeben werden.

Der Rückgabewert ist die Anzahl der Zeichen die geschrieben werden konnten.

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

array BrickletRS232::read()
Rückgabe-Array:
  • 'message' – Typ: array(string, ...), Länge: 60
  • 'length' – Typ: int, Wertebereich: [0 bis 60]

Gibt die aktuell gespeicherte Nachricht zurück. Die maximale Länge beträgt 60. Wenn die Länge als 0 gegeben wird, waren keine neuen Daten verfügbar.

Anstatt mit dieser Funktion zu pollen, ist es auch möglich Callbacks zu nutzen. Siehe enableReadCallback() und CALLBACK_READ Callback.

void BrickletRS232::setConfiguration(int $baudrate, int $parity, int $stopbits, int $wordlength, int $hardware_flowcontrol, int $software_flowcontrol)
Parameter:
  • $baudrate – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 11
  • $parity – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
  • $stopbits – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1
  • $wordlength – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 8
  • $hardware_flowcontrol – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
  • $software_flowcontrol – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt die Konfiguration für die RS232-Kommunikation.

Hard-/Software Flow Control kann entweder an oder aus sein aber nicht beides gleichzeitig an.

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

Für $baudrate:

  • BrickletRS232::BAUDRATE_300 = 0
  • BrickletRS232::BAUDRATE_600 = 1
  • BrickletRS232::BAUDRATE_1200 = 2
  • BrickletRS232::BAUDRATE_2400 = 3
  • BrickletRS232::BAUDRATE_4800 = 4
  • BrickletRS232::BAUDRATE_9600 = 5
  • BrickletRS232::BAUDRATE_14400 = 6
  • BrickletRS232::BAUDRATE_19200 = 7
  • BrickletRS232::BAUDRATE_28800 = 8
  • BrickletRS232::BAUDRATE_38400 = 9
  • BrickletRS232::BAUDRATE_57600 = 10
  • BrickletRS232::BAUDRATE_115200 = 11
  • BrickletRS232::BAUDRATE_230400 = 12

Für $parity:

  • BrickletRS232::PARITY_NONE = 0
  • BrickletRS232::PARITY_ODD = 1
  • BrickletRS232::PARITY_EVEN = 2
  • BrickletRS232::PARITY_FORCED_PARITY_1 = 3
  • BrickletRS232::PARITY_FORCED_PARITY_0 = 4

Für $stopbits:

  • BrickletRS232::STOPBITS_1 = 1
  • BrickletRS232::STOPBITS_2 = 2

Für $wordlength:

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

Für $hardware_flowcontrol:

  • BrickletRS232::HARDWARE_FLOWCONTROL_OFF = 0
  • BrickletRS232::HARDWARE_FLOWCONTROL_ON = 1

Für $software_flowcontrol:

  • BrickletRS232::SOFTWARE_FLOWCONTROL_OFF = 0
  • BrickletRS232::SOFTWARE_FLOWCONTROL_ON = 1
array BrickletRS232::getConfiguration()
Rückgabe-Array:
  • 'baudrate' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 11
  • 'parity' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
  • 'stopbits' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1
  • 'wordlength' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 8
  • 'hardware_flowcontrol' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
  • 'software_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 $baudrate:

  • BrickletRS232::BAUDRATE_300 = 0
  • BrickletRS232::BAUDRATE_600 = 1
  • BrickletRS232::BAUDRATE_1200 = 2
  • BrickletRS232::BAUDRATE_2400 = 3
  • BrickletRS232::BAUDRATE_4800 = 4
  • BrickletRS232::BAUDRATE_9600 = 5
  • BrickletRS232::BAUDRATE_14400 = 6
  • BrickletRS232::BAUDRATE_19200 = 7
  • BrickletRS232::BAUDRATE_28800 = 8
  • BrickletRS232::BAUDRATE_38400 = 9
  • BrickletRS232::BAUDRATE_57600 = 10
  • BrickletRS232::BAUDRATE_115200 = 11
  • BrickletRS232::BAUDRATE_230400 = 12

Für $parity:

  • BrickletRS232::PARITY_NONE = 0
  • BrickletRS232::PARITY_ODD = 1
  • BrickletRS232::PARITY_EVEN = 2
  • BrickletRS232::PARITY_FORCED_PARITY_1 = 3
  • BrickletRS232::PARITY_FORCED_PARITY_0 = 4

Für $stopbits:

  • BrickletRS232::STOPBITS_1 = 1
  • BrickletRS232::STOPBITS_2 = 2

Für $wordlength:

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

Für $hardware_flowcontrol:

  • BrickletRS232::HARDWARE_FLOWCONTROL_OFF = 0
  • BrickletRS232::HARDWARE_FLOWCONTROL_ON = 1

Für $software_flowcontrol:

  • BrickletRS232::SOFTWARE_FLOWCONTROL_OFF = 0
  • BrickletRS232::SOFTWARE_FLOWCONTROL_ON = 1
void BrickletRS232::setBreakCondition(int $break_time)
Parameter:
  • $break_time – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]

Setzt eine Break Condition (die TX-Ausgabe wird fest of logisch 0 gezwungen). Der Parameter setzt die Haltezeit der Break Condition.

Neu in Version 2.0.2 (Plugin).

Fortgeschrittene Funktionen

array BrickletRS232::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', 'i', '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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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 BrickletRS232::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 BrickletRS232::enableReadCallback()

Aktiviert den CALLBACK_READ Callback.

Im Startzustand ist der Callback deaktiviert

void BrickletRS232::disableReadCallback()

Deaktiviert den CALLBACK_READ Callback.

Im Startzustand ist der Callback deaktiviert

bool BrickletRS232::isReadCallbackEnabled()
Rückgabe:
  • $enabled – Typ: bool, Standardwert: FALSE

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->registerCallback(BrickletRS232::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 BrickletRS232::CALLBACK_READ
<?php   void callback(array $message, int $length [, mixed $user_data])   ?>
Callback-Parameter:
  • $message – Typ: array(string, ...), Länge: 60
  • $length – Typ: int, Wertebereich: [1 bis 60]
  • $user_data – Typ: mixed

Dieser Callback wird aufgerufen wenn neue Daten zur Verfügung stehen. Die Nachricht hat eine Maximalgröße von 60 Zeichen. Die Länge der Nachricht wird zusätzlich übergeben.

Dieser Callback kann durch enableReadCallback() aktiviert werden.

int BrickletRS232::CALLBACK_ERROR
<?php   void callback(int $error [, mixed $user_data])   ?>
Callback-Parameter:
  • $error – Typ: int, Wertebereich: Siehe Konstanten
  • $user_data – Typ: mixed

Dieser Callback wird aufgerufen wenn ein Fehler auftritt. Mögliche Fehler sind Overrun-, Parity- oder Framing-Fehler.

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

Für $error:

  • BrickletRS232::ERROR_OVERRUN = 1
  • BrickletRS232::ERROR_PARITY = 2
  • BrickletRS232::ERROR_FRAMING = 4

Neu in Version 2.0.1 (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 BrickletRS232::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 BrickletRS232::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:

  • BrickletRS232::FUNCTION_ENABLE_READ_CALLBACK = 3
  • BrickletRS232::FUNCTION_DISABLE_READ_CALLBACK = 4
  • BrickletRS232::FUNCTION_SET_CONFIGURATION = 6
  • BrickletRS232::FUNCTION_SET_BREAK_CONDITION = 10
void BrickletRS232::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:

  • BrickletRS232::FUNCTION_ENABLE_READ_CALLBACK = 3
  • BrickletRS232::FUNCTION_DISABLE_READ_CALLBACK = 4
  • BrickletRS232::FUNCTION_SET_CONFIGURATION = 6
  • BrickletRS232::FUNCTION_SET_BREAK_CONDITION = 10
void BrickletRS232::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.

Konstanten

int BrickletRS232::DEVICE_IDENTIFIER

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

Diese Konstante stellt den Anzeigenamen eines RS232 Bricklet dar.