Perl - RS232 Bricklet

Dies ist die Beschreibung der Perl 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 Perl API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Loopback

Download (example_loopback.pl)

 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
62
63
64
#!/usr/bin/perl

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

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletRS232;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your RS232 Bricklet

# Convert string to char array with length 60, as needed by write
sub string_to_char_array
{
    my ($message) = @_;

    my @chars = split('', $message);
    my @array = ("\0") x 60;

    for my $i (0..(scalar(@chars) - 1)) {
        $array[$i] = $chars[$i];
    }

    return \@array;
}

# Assume that the message consists of ASCII characters and
# convert it from an array of chars to a string
sub char_array_to_string
{
    my ($message, $length) = @_;

    return substr(join('', @{$message}), 0, $length);
}

# Callback subroutine for read callback
sub cb_read
{
    my ($message, $length) = @_;

    my $str = char_array_to_string($message, $length);
    print "Message (Length: " . $length . "): \"" . $str . "\"\n";
}

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $rs232 = Tinkerforge::BrickletRS232->new(&UID, $ipcon); # Create device object

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

# Register read callback to subroutine cb_read
$rs232->register_callback($rs232->CALLBACK_READ, 'cb_read');

# Enable read callback
$rs232->enable_read_callback();

# Write "test" string
my $message = string_to_char_array('test');
$rs232->write($message, 4);

print "Press key to exit\n";
<STDIN>;
$ipcon->disconnect();

API

Allgemein kann jede Subroutine der Perl Bindings Fehler als Tinkerforge::Error Objekt mittels croak() melden. Das Objekt hat eine get_code() und eine get_message() Subroutine. Es sind verschiedene Fehlercodes definiert:

  • Error->ALREADY_CONNECTED = 11
  • Error->NOT_CONNECTED = 12
  • Error->CONNECT_FAILED = 13
  • Error->INVALID_FUNCTION_ID = 21
  • Error->TIMEOUT = 31
  • Error->INVALID_PARAMETER = 41
  • Error->FUNCTION_NOT_SUPPORTED = 42
  • Error->UNKNOWN_ERROR = 43
  • Error->STREAM_OUT_OF_SYNC = 51
  • Error->INVALID_UID = 61
  • Error->NON_ASCII_CHAR_IN_SECRET = 71

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

BrickletRS232->new($uid, $ipcon)
Parameter:
  • $uid – Typ: string
  • $ipcon – Typ: IPConnection
Rückgabe:
  • $rs232 – Typ: BrickletRS232

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

$rs232 = BrickletRS232->new("YOUR_DEVICE_UID", $ipcon);

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

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

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 set_configuration() für Konfigurationsmöglichkeiten bezüglich Baudrate, Parität usw.

BrickletRS232->read()
Rückgabe-Array:
  • 0: @message – Typ: [char, ...], Länge: 60
  • 1: $length – Typ: int, Wertebereich: [0 bis 255]

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 enable_read_callback() und CALLBACK_READ Callback.

BrickletRS232->set_configuration($baudrate, $parity, $stopbits, $wordlength, $hardware_flowcontrol, $software_flowcontrol)
Parameter:
  • $baudrate – Typ: int, Wertebereich: Siehe Konstanten
  • $parity – Typ: int, Wertebereich: Siehe Konstanten
  • $stopbits – Typ: int, Wertebereich: Siehe Konstanten
  • $wordlength – Typ: int, Wertebereich: Siehe Konstanten
  • $hardware_flowcontrol – Typ: int, Wertebereich: Siehe Konstanten
  • $software_flowcontrol – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • undef

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

  • Baudrate zwischen 300 und 230400 Baud.
  • Parität von None, Odd, Even und Forced Parity.
  • Stop Bits von 1 oder 2.
  • Wortlänge zwischen 5 und 8.
  • Hard-/Software Flow Control kann entweder an oder aus sein aber nicht beides gleichzeitig an.

Der Standard ist: 115200 Baud, Parität None, 1 Stop Bits, Wortlänge 8, Hard-/Software Flow Control aus.

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
BrickletRS232->get_configuration()
Rückgabe-Array:
  • 0: $baudrate – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $parity – Typ: int, Wertebereich: Siehe Konstanten
  • 2: $stopbits – Typ: int, Wertebereich: Siehe Konstanten
  • 3: $wordlength – Typ: int, Wertebereich: Siehe Konstanten
  • 4: $hardware_flowcontrol – Typ: int, Wertebereich: Siehe Konstanten
  • 5: $software_flowcontrol – Typ: int, Wertebereich: Siehe Konstanten

Gibt die Konfiguration zurück, wie von set_configuration() 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
BrickletRS232->set_break_condition($break_time)
Parameter:
  • $break_time – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • undef

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

Neu in Version 2.0.2 (Plugin).

Fortgeschrittene Funktionen

BrickletRS232->get_api_version()
Rückgabe:
  • @api_version – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]

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.

BrickletRS232->get_response_expected($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 set_response_expected(). 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
BrickletRS232->set_response_expected($function_id, $response_expected)
Parameter:
  • $function_id – Typ: int, Wertebereich: Siehe Konstanten
  • $response_expected – Typ: bool
Rückgabe:
  • undef

Ä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
BrickletRS232->set_response_expected_all($response_expected)
Parameter:
  • $response_expected – Typ: bool
Rückgabe:
  • undef

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

BrickletRS232->get_identity()
Rückgabe-Array:
  • 0: $uid – Typ: string, Länge: bis zu 8
  • 1: $connected_uid – Typ: string, Länge: bis zu 8
  • 2: $position – Typ: char
  • 3: @hardware_version – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]
  • 4: @firmware_version – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]
  • 5: $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 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 Bricklets.

Konfigurationsfunktionen für Callbacks

BrickletRS232->register_callback($callback_id, $function)
Parameter:
  • $callback_id – Typ: int
  • $function – Typ: string
Rückgabe:
  • undef

Registriert den $function Namen für die gegebene $callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

BrickletRS232->enable_read_callback()
Rückgabe:
  • undef

Aktiviert den CALLBACK_READ Callback.

Im Startzustand ist der Callback deaktiviert

BrickletRS232->disable_read_callback()
Rückgabe:
  • undef

Deaktiviert den CALLBACK_READ Callback.

Im Startzustand ist der Callback deaktiviert

BrickletRS232->is_read_callback_enabled()
Rückgabe:
  • $enabled – Typ: bool

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 register_callback() des Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID und der zweite Parameter ist der Name der Callback-Funktion:

sub my_callback
{
    print "@_[0]";
}

$rs232->register_callback(BrickletRS232->CALLBACK_EXAMPLE, 'my_callback')

Die Callback Funktion wird dann von einem internen Thread der IP Connection aufgerufen werden. Im Gegensatz zu vielen anderen Programmiersprachen werden Variablen nicht automatisch zwischen Threads geteilt. Wenn eine Variable gleichzeitig in einer Callback Funktion und dem Rest des Programms genutzt werden soll, dann muss diese als :shared markiert werden. Siehe dazu auch die Dokumentation des threads::shared Perl Moduls für weitere Details.

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen 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.

BrickletRS232->CALLBACK_READ
Callback-Parameter:
  • @message – Typ: [char, ...], Länge: 60
  • $length – Typ: int, Wertebereich: [0 bis 255]

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 enable_read_callback() aktiviert werden.

BrickletRS232->CALLBACK_ERROR
Callback-Parameter:
  • $error – Typ: int, Wertebereich: Siehe Konstanten

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

Konstanten

BrickletRS232->DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein RS232 Bricklet zu identifizieren.

Die get_identity() Funktion und der IPConnection->CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletRS232->DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines RS232 Bricklet dar.