Ruby - IO-16 Bricklet 2.0¶

Interrupt¶

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

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

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_io16_v2'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your IO-16 Bricklet 2.0

ipcon = IPConnection.new # Create IP connection
io = BrickletIO16V2.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Register input value callback
io.register_callback(BrickletIO16V2::CALLBACK_INPUT_VALUE) do |channel, changed, value|
  puts "Channel: #{channel}"
  puts "Changed: #{changed}"
  puts "Value: #{value}"
  puts ''
end

# Set period for input value (channel 4 [A4]) callback to 0.5s (500ms)
io.set_input_value_callback_configuration 4, 500, false

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

Output¶

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

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

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_io16_v2'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your IO-16 Bricklet 2.0

ipcon = IPConnection.new # Create IP connection
io = BrickletIO16V2.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Configure channel 7 [A7] as output low
io.set_configuration 7, 'o', false

# Set channel 7 [A7] alternating high/low 10 times with 100 ms delay
for _ in 0..9
  sleep 0.1
  io.set_selected_value 7, true
  sleep 0.1
  io.set_selected_value 7, false
end

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

Input¶

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

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

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_io16_v2'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your IO-16 Bricklet 2.0

ipcon = IPConnection.new # Create IP connection
io = BrickletIO16V2.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Get current value
value = io.get_value

puts "Channel 0 [A0]: #{value[0]}"
puts "Channel 1 [A1]: #{value[1]}"
puts "Channel 2 [A2]: #{value[2]}"
puts "Channel 3 [A3]: #{value[3]}"
puts "Channel 4 [A4]: #{value[4]}"
puts "Channel 5 [A5]: #{value[5]}"
puts "Channel 6 [A6]: #{value[6]}"
puts "Channel 7 [A7]: #{value[7]}"
puts "Channel 8 [B0]: #{value[8]}"
puts "Channel 9 [B1]: #{value[9]}"
puts "Channel 10 [B2]: #{value[10]}"
puts "Channel 11 [B3]: #{value[11]}"
puts "Channel 12 [B4]: #{value[12]}"
puts "Channel 13 [B5]: #{value[13]}"
puts "Channel 14 [B6]: #{value[14]}"
puts "Channel 15 [B7]: #{value[15]}"

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

Grundfunktionen¶

BrickletIO16V2::new(uid, ipcon) → io16_v2¶

Parameter:	uid – Typ: str ipcon – Typ: IPConnection
Rückgabe:	io16_v2 – Typ: BrickletIO16V2

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

io16_v2 = BrickletIO16V2.new 'YOUR_DEVICE_UID', ipcon

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

BrickletIO16V2#set_value(value) → nil¶

Parameter:	value – Typ: [bool, ...], Länge: 16

Setzt den Zustand aller sechzehn Kanäle. Der Wert true bzw. false erzeugen logisch 1 bzw. logisch 0 auf dem entsprechenden Kanal.

Mittels #set_selected_value können auch einzelnen Kanäle gesetzt werden.

Beispiel: (True, True, False, False, ..., False) setzt die Kanäle 0-1 auf logisch 1 und die Kanäle 2-15 auf logisch 0.

Alle laufenden Monoflop Timer werden abgebrochen, wenn diese Funktion aufgerufen wird.

Bemerkung

Diese Funktion bewirkt keine Änderung an Kanälen die als Eingang konfiguriert sind. Pull-Up Widerstände können mit #set_configuration zugeschaltet werden.

BrickletIO16V2#get_value → [bool, ...]¶

Rückgabe:	value – Typ: [bool, ...], Länge: 16

Gibt die aktuell gemessenen Zustände zurück. Diese Funktion gibt die Zustände aller Kanäle zurück, unabhängig ob diese als Ein- oder Ausgang konfiguriert sind.

BrickletIO16V2#set_selected_value(channel, value) → nil¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 15] value – Typ: bool

Setzt den Ausgabewert des ausgewählten Kanals ohne die anderen Kanäle zu beeinflussen.

Ein laufender Monoflop Timer für den ausgewählten Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.

Bemerkung

Diese Funktion bewirkt keine Änderung an Kanälen die als Eingang konfiguriert sind. Pull-Up Widerstände können mit #set_configuration zugeschaltet werden.

BrickletIO16V2#set_configuration(channel, direction, value) → nil¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 15] direction – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'i' value – Typ: bool, Standardwert: true

Konfiguriert den Zustand und die Richtung eines angegebenen Kanals. Mögliche Richtungen sind 'i' und 'o' für Ein- und Ausgang.

Wenn die Richtung als Ausgang konfiguriert ist, ist der Zustand entweder logisch 1 oder logisch 0 (gesetzt als true oder false).

Wenn die Richtung als Eingang konfiguriert ist, ist der Zustand entweder Pull-Up oder Standard (gesetzt als true oder false).

Beispiele:

• (0, 'i', true) setzt Kanal-0 als Eingang mit Pull-Up.
• (1, 'i', false) setzt Kanal-1 als Standard Eingang (potentialfrei wenn nicht verbunden).
• (2, 'o', true) setzt Kanal-2 als Ausgang im Zustand logisch 1.
• (3, 'o', false) setzt Kanal-3 als Ausgang im Zustand logisch 0.

Ein laufender Monoflop Timer für den angegebenen Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.

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

Für direction:

• BrickletIO16V2::DIRECTION_IN = 'i'
• BrickletIO16V2::DIRECTION_OUT = 'o'

BrickletIO16V2#get_configuration(channel) → [chr, bool]¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 15]
Rückgabe-Array:	0: direction – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'i' 1: value – Typ: bool, Standardwert: true

Gibt die Kanal-Konfiguration zurück, wie von #set_configuration gesetzt.

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

Für direction:

• BrickletIO16V2::DIRECTION_IN = 'i'
• BrickletIO16V2::DIRECTION_OUT = 'o'

Fortgeschrittene Funktionen¶

BrickletIO16V2#set_monoflop(channel, value, time) → nil¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 15] value – Typ: bool time – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

Konfiguriert einen Monoflop für den angegebenen Kanal.

Der zweite Parameter ist eine der gewünschten Zustände des festgelegten Kanals. Eine true bedeutet Relais geschlossen und ein *false bedeutet Relais offen.

Der dritte Parameter ist die Zeit die der Kanal den Zustand halten sollen.

Wenn diese Funktion mit den Parametern (0, 1, 1500) aufgerufen wird, wird Kanal 0 geschlossen und nach 1,5s wieder geöffnet.

Ein Monoflop kann zur Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein IO-16 Bricklet 2.0 ist an ein Slave Stapel verbunden. Jetzt kann diese Funktion sekündlich, mit einem Zeitparameter von 2 Sekunden, aufgerufen werden. Der Kanal wird die gesamte Zeit im Zustand geschlossen sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird der Kanal nach spätestens zwei Sekunden in den Zustand geöffnet wechseln.

BrickletIO16V2#get_monoflop(channel) → [bool, int, int]¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 15]
Rückgabe-Array:	0: value – Typ: bool 1: time – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] 2: time_remaining – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

Gibt (für den angegebenen Kanal) den aktuellen Zustand und die Zeit, wie von #set_monoflop gesetzt, sowie die noch verbleibende Zeit bis zum Zustandswechsel, zurück.

Wenn der Timer aktuell nicht läuft, ist die noch verbleibende Zeit 0.

BrickletIO16V2#get_edge_count(channel, reset_counter) → int¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 15] reset_counter – Typ: bool
Rückgabe:	count – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt den aktuellen Wert des Flankenzählers für den ausgewählten Kanal zurück. Die zu zählenden Flanken können mit #set_edge_count_configuration konfiguriert werden.

Wenn reset counter auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurückgesetzt.

BrickletIO16V2#set_edge_count_configuration(channel, edge_type, debounce) → nil¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 15] edge_type – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

Konfiguriert den Flankenzähler für einen bestimmten Kanal.

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden für Kanäle die als Eingang konfiguriert sind. Mögliche Flankentypen sind:

• 0 = steigend
• 1 = fallend
• 2 = beide

Durch das Konfigurieren wird der Wert des Flankenzählers auf 0 zurückgesetzt.

Falls unklar ist was dies alles bedeutet, kann diese Funktion einfach ignoriert werden. Die Standardwerte sind in fast allen Situationen OK.

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

Für edge_type:

• BrickletIO16V2::EDGE_TYPE_RISING = 0
• BrickletIO16V2::EDGE_TYPE_FALLING = 1
• BrickletIO16V2::EDGE_TYPE_BOTH = 2

BrickletIO16V2#get_edge_count_configuration(channel) → [int, int]¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 15]
Rückgabe-Array:	0: edge_type – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 1: debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

Gibt den Flankentyp sowie die Entprellzeit für den ausgewählten Kanals zurück, wie von #set_edge_count_configuration gesetzt.

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

Für edge_type:

• BrickletIO16V2::EDGE_TYPE_RISING = 0
• BrickletIO16V2::EDGE_TYPE_FALLING = 1
• BrickletIO16V2::EDGE_TYPE_BOTH = 2

BrickletIO16V2#get_spitfp_error_count → [int, int, int, int]¶

Rückgabe-Array:	0: error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1] 1: error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1] 2: error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1] 3: 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.

BrickletIO16V2#set_status_led_config(config) → nil¶

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:

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

BrickletIO16V2#get_status_led_config → int¶

Rückgabe:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von #set_status_led_config gesetzt.

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

Für config:

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

BrickletIO16V2#get_chip_temperature → int¶

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.

BrickletIO16V2#reset → nil¶

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.

BrickletIO16V2#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¶

BrickletIO16V2#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.

BrickletIO16V2#set_input_value_callback_configuration(channel, period, value_has_to_change) → nil¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 15] period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false

Dieser Callback kann pro Kanal konfiguriert werden.

Die Periode ist die Periode mit der der ::CALLBACK_INPUT_VALUE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

BrickletIO16V2#get_input_value_callback_configuration(channel) → [int, bool]¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 15]
Rückgabe-Array:	0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 1: value_has_to_change – Typ: bool, Standardwert: false

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

BrickletIO16V2#set_all_input_value_callback_configuration(period, value_has_to_change) → nil¶

Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false

Die Periode ist die Periode mit der der ::CALLBACK_ALL_INPUT_VALUE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

BrickletIO16V2#get_all_input_value_callback_configuration → [int, bool]¶

Rückgabe-Array:	0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 1: value_has_to_change – Typ: bool, Standardwert: false

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

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:

io16_v2.register_callback BrickletIO16V2::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

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

BrickletIO16V2::CALLBACK_INPUT_VALUE¶

Callback-Parameter:	channel – Typ: int, Wertebereich: [0 bis 15] changed – Typ: bool value – Typ: bool

Dieser Callback wird periodisch ausgelöst abhängig von der mittels #set_input_value_callback_configuration gesetzten Konfiguration

Die Parameter sind der Kanal, Changed und der Wert. Der changed-Parameter ist True wenn sich der Wert seit dem letzten Callback geändert hat.

BrickletIO16V2::CALLBACK_ALL_INPUT_VALUE¶

Callback-Parameter:	changed – Typ: [bool, ...], Länge: 16 value – Typ: [bool, ...], Länge: 16

Dieser Callback wird periodisch ausgelöst abhängig von der mittels #set_all_input_value_callback_configuration gesetzten Konfiguration

Die Parameter sind der gleiche wie #get_value. Zusätzlich ist der changed-Parameter True wenn sich der Wert seit dem letzten Callback geändert hat.

BrickletIO16V2::CALLBACK_MONOFLOP_DONE¶

Callback-Parameter:	channel – Typ: int, Wertebereich: [0 bis 15] value – Typ: bool

Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Parameter enthalten den Kanal und den aktuellen Zustand des Kanals (der Zustand nach dem Monoflop).

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.

BrickletIO16V2#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.

BrickletIO16V2#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:

• BrickletIO16V2::FUNCTION_SET_VALUE = 1
• BrickletIO16V2::FUNCTION_SET_SELECTED_VALUE = 3
• BrickletIO16V2::FUNCTION_SET_CONFIGURATION = 4
• BrickletIO16V2::FUNCTION_SET_INPUT_VALUE_CALLBACK_CONFIGURATION = 6
• BrickletIO16V2::FUNCTION_SET_ALL_INPUT_VALUE_CALLBACK_CONFIGURATION = 8
• BrickletIO16V2::FUNCTION_SET_MONOFLOP = 10
• BrickletIO16V2::FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 13
• BrickletIO16V2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletIO16V2::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletIO16V2::FUNCTION_RESET = 243
• BrickletIO16V2::FUNCTION_WRITE_UID = 248

BrickletIO16V2#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:

• BrickletIO16V2::FUNCTION_SET_VALUE = 1
• BrickletIO16V2::FUNCTION_SET_SELECTED_VALUE = 3
• BrickletIO16V2::FUNCTION_SET_CONFIGURATION = 4
• BrickletIO16V2::FUNCTION_SET_INPUT_VALUE_CALLBACK_CONFIGURATION = 6
• BrickletIO16V2::FUNCTION_SET_ALL_INPUT_VALUE_CALLBACK_CONFIGURATION = 8
• BrickletIO16V2::FUNCTION_SET_MONOFLOP = 10
• BrickletIO16V2::FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 13
• BrickletIO16V2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletIO16V2::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletIO16V2::FUNCTION_RESET = 243
• BrickletIO16V2::FUNCTION_WRITE_UID = 248

BrickletIO16V2#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.

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.

BrickletIO16V2#set_bootloader_mode(mode) → int¶

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:

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

Für status:

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

BrickletIO16V2#get_bootloader_mode → int¶

Rückgabe:	mode – Typ: int, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe #set_bootloader_mode.

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

Für mode:

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

BrickletIO16V2#set_write_firmware_pointer(pointer) → nil¶

Parameter:	pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für #write_firmware. 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.

BrickletIO16V2#write_firmware(data) → int¶

Parameter:	data – Typ: [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 #set_write_firmware_pointer 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.

BrickletIO16V2#write_uid(uid) → nil¶

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.

BrickletIO16V2#read_uid → int¶

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¶

BrickletIO16V2::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein IO-16 Bricklet 2.0 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.

BrickletIO16V2::DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines IO-16 Bricklet 2.0 dar.