Ruby - RS232 Bricklet¶

Loopback¶

Download (example_loopback.rb)

 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

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

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

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_rs232'

include Tinkerforge

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

# Convert string to char array with length 60, as needed by write
def string_to_char_array(message)
  chars = message.split(//)
  chars += ['\0']*(60 - message.length)
  return chars
end

# Assume that the message consists of ASCII characters and
# convert it from an array of chars to a string
def char_array_to_string(message, length)
  return message.slice(0, length).join('')
end

ipcon = IPConnection.new # Create IP connection
rs232 = 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
rs232.register_callback(BrickletRS232::CALLBACK_READ) do |message, length|
  puts "Message (Length: #{length}): #{char_array_to_string message, length}"
end

# Enable read callback
rs232.enable_read_callback

# Write "test" string
message = "test"
rs232.write string_to_char_array(message), message.length

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Grundfunktionen¶

BrickletRS232::new(uid, ipcon) → rs232¶

Parameter:	uid – Typ: str 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.

BrickletRS232#write(message, length) → int¶

Parameter:	message – Typ: [chr, ...], 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 #set_configuration für Konfigurationsmöglichkeiten bezüglich Baudrate, Parität usw.

BrickletRS232#read → [[chr, ...], int]¶

Rückgabe-Array:	0: message – Typ: [chr, ...], Länge: 60 1: length – Typ: int, Wertebereich: [0 bis 60]

Gibt die aktuell gespeicherte Nachricht zurück. Die maximale Länge beträgt 60. Wenn die zurückgegebene Länge 0 ist, 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) → nil¶

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

BrickletRS232#get_configuration → [int, int, int, int, int, int]¶

Rückgabe-Array:

0: baudrate – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 11 1: parity – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 2: stopbits – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1 3: wordlength – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 8 4: hardware_flowcontrol – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 5: software_flowcontrol – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

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) → nil¶

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

BrickletRS232#read_frame → [[chr, ...], int]¶

Rückgabe-Array:	0: message – Typ: [chr, ...], Länge: 60 1: length – Typ: int, Wertebereich: [0 bis 60]

Gibt bis zu einem Frame an Daten aus dem Lesebuffer zurück. Die Größe eines Frames kann mit #set_frame_readable_callback_configuration konfiguriert werden. Wenn die zurückgegebene Länge 0 ist, waren keine neuen Daten verfügbar.

Neu in Version 2.0.4 (Plugin).

Fortgeschrittene Funktionen¶

BrickletRS232#get_identity → [str, str, chr, [int, ...], [int, ...], int]¶

Rückgabe-Array:

0: uid – Typ: str, Länge: bis zu 8 1: connected_uid – Typ: str, Länge: bis zu 8 2: position – Typ: chr, Wertebereich: ['a' bis 'h', 'z'] 3: hardware_version – Typ: [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] 4: firmware_version – Typ: [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] 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 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¶

BrickletRS232#register_callback(callback_id) { |param [, ...]| block } → nil¶

Parameter:	callback_id – Typ: int

Registriert den block für die gegebene callback_id.

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

BrickletRS232#enable_read_callback → nil¶

Aktiviert den ::CALLBACK_READ Callback. Dies deaktiviert den ::CALLBACK_FRAME_READABLE Callback.

Im Startzustand ist der Callback deaktiviert

BrickletRS232#disable_read_callback → nil¶

Deaktiviert den ::CALLBACK_READ Callback.

Im Startzustand ist der Callback deaktiviert

BrickletRS232#is_read_callback_enabled → bool¶

Rückgabe:	enabled – Typ: bool, Standardwert: false

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

BrickletRS232#set_frame_readable_callback_configuration(frame_size) → nil¶

Parameter:	frame_size – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 100], 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.4 (Plugin).

BrickletRS232#get_frame_readable_callback_configuration → int¶

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

Gibt die Callback-Konfiguration zurück, wie mittels #set_frame_readable_callback_configuration gesetzt.

Neu in Version 2.0.4 (Plugin).

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 der Callback ID und der zweite Parameter der Block:

rs232.register_callback BrickletRS232::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen werden weiter unten beschrieben.

BrickletRS232::CALLBACK_READ¶

Callback-Parameter:	message – Typ: [chr, ...], Länge: 60 length – Typ: int, Wertebereich: [1 bis 60]

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

BrickletRS232::CALLBACK_FRAME_READABLE¶

Callback-Parameter:	frame_count – Typ: int, Wertebereich: [0 bis 255]

Dieser Callback wird ausgelöst, wenn mindestens ein neuer Frame an Daten verfügbar sind. Die Größe eines Frames kann mit #set_frame_readable_callback_configuration konfiguriert werden. Frame Count ist die Anzahl an Frames, die zum Lesen bereitstehen. Der Callback wird nur einmal pro #read oder #read_frame 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_frame-Funktion gelesen werden können, ohne dass der Frame Count-Parameter geprüft werden muss.

Neu in Version 2.0.4 (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.

BrickletRS232#get_api_version → [int, ...]¶

Rückgabe-Array:	0: api_version – Typ: [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.

BrickletRS232#get_response_expected(function_id) → bool¶

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::FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 11

BrickletRS232#set_response_expected(function_id, response_expected) → nil¶

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
• BrickletRS232::FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 11

BrickletRS232#set_response_expected_all(response_expected) → nil¶

Parameter:	response_expected – Typ: bool

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

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.