Ruby - Industrial Digital In 4 Bricklet 2.0

Dies ist die Beschreibung der Ruby API Bindings für das Industrial Digital In 4 Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Digital In 4 Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Ruby API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example_simple.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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_industrial_digital_in_4_v2'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0

ipcon = IPConnection.new # Create IP connection
idi4 = BrickletIndustrialDigitalIn4V2.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 = idi4.get_value

puts "Channel 0: #{value[0]}"
puts "Channel 1: #{value[1]}"
puts "Channel 2: #{value[2]}"
puts "Channel 3: #{value[3]}"

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

Edge Count

Download (example_edge_count.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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_industrial_digital_in_4_v2'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0

ipcon = IPConnection.new # Create IP connection
idi4 = BrickletIndustrialDigitalIn4V2.new UID, ipcon # Create device object

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

# Configure rising edge count (channel 3) with 10ms debounce
idi4.set_edge_count_configuration 3, 0, 10

# Get edge count 10 times with 1s delay
for _ in 0..9
  sleep 1

  # Get current edge count
  count = idi4.get_edge_count 3, false
  puts "Count: #{count}"
end

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

Callback

Download (example_callback.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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_industrial_digital_in_4_v2'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0

ipcon = IPConnection.new # Create IP connection
idi4 = BrickletIndustrialDigitalIn4V2.new UID, ipcon # Create device object

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

# Register value callback
idi4.register_callback(BrickletIndustrialDigitalIn4V2::CALLBACK_VALUE) do |channel,
                                                                           changed, value|
  if channel == BrickletIndustrialDigitalIn4V2::CHANNEL_0
    puts "Channel: 0"
  elsif channel == BrickletIndustrialDigitalIn4V2::CHANNEL_1
    puts "Channel: 1"
  elsif channel == BrickletIndustrialDigitalIn4V2::CHANNEL_2
    puts "Channel: 2"
  elsif channel == BrickletIndustrialDigitalIn4V2::CHANNEL_3
    puts "Channel: 3"
  end

  puts "Changed: #{changed}"
  puts "Value: #{value}"
  puts ''
end

# Set period for value (channel 1) callback to 0.1s (100ms)
idi4.set_value_callback_configuration 1, 100, false

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

API

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

BrickletIndustrialDigitalIn4V2::new(uid, ipcon) → industrial_digital_in_4_v2
Parameter:
  • uid -- str
  • ipcon -- IPConnection

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

industrial_digital_in_4_v2 = BrickletIndustrialDigitalIn4V2.new 'YOUR_DEVICE_UID', ipcon

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

BrickletIndustrialDigitalIn4V2#get_value → [bool, bool, bool, bool]

Gibt die Eingangswerte als Bools zurück, true bedeutet logisch 1 und false logisch 0.

BrickletIndustrialDigitalIn4V2#set_channel_led_config(channel, config) → nil
Parameter:
  • channel -- int
  • config -- int

Jeder Kanal hat eine dazugehörige LED. Die LEDs können individuell an oder ausgeschaltet werden. Zusätzlich kann ein Heartbeat oder der Kanalstatus angezeigt werden. Falls Kanalstatus gewählt wird ist die LED an wenn ein High-Signal am Kanal anliegt und sonst aus.

Standardmäßig sind die LEDs für alle Kanäle auf Kanalstatus konfiguriert.

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

  • BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3
  • BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
BrickletIndustrialDigitalIn4V2#get_channel_led_config(channel) → int
Parameter:channel -- int

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

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

  • BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3
  • BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Fortgeschrittene Funktionen

BrickletIndustrialDigitalIn4V2#get_edge_count(channel, reset_counter) → int
Parameter:
  • channel -- int
  • reset_counter -- bool

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.

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

  • BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3
BrickletIndustrialDigitalIn4V2#set_edge_count_configuration(channel, edge_type, debounce) → nil
Parameter:
  • channel -- int
  • edge_type -- int
  • debounce -- int

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. Mögliche Flankentypen sind:

  • 0 = steigend (Standard)
  • 1 = fallend
  • 2 = beide

Die Entprellzeit (debounce) wird in ms angegeben.

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.

Standardwerte: 0 (edge type) und 100ms (debounce).

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

  • BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3
  • BrickletIndustrialDigitalIn4V2::EDGE_TYPE_RISING = 0
  • BrickletIndustrialDigitalIn4V2::EDGE_TYPE_FALLING = 1
  • BrickletIndustrialDigitalIn4V2::EDGE_TYPE_BOTH = 2
BrickletIndustrialDigitalIn4V2#get_edge_count_configuration(channel) → [int, int]
Parameter:channel -- int

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:

  • BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3
  • BrickletIndustrialDigitalIn4V2::EDGE_TYPE_RISING = 0
  • BrickletIndustrialDigitalIn4V2::EDGE_TYPE_FALLING = 1
  • BrickletIndustrialDigitalIn4V2::EDGE_TYPE_BOTH = 2

Das zurückgegebene Array enthält die Werte edge_type und debounce.

BrickletIndustrialDigitalIn4V2#get_api_version → [int, int, int]

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.

BrickletIndustrialDigitalIn4V2#get_response_expected(function_id) → bool
Parameter:function_id -- int

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:

  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7
  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_CHANNEL_LED_CONFIG = 9
  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialDigitalIn4V2::FUNCTION_RESET = 243
  • BrickletIndustrialDigitalIn4V2::FUNCTION_WRITE_UID = 248
BrickletIndustrialDigitalIn4V2#set_response_expected(function_id, response_expected) → nil
Parameter:
  • function_id -- int
  • response_expected -- 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:

  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7
  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_CHANNEL_LED_CONFIG = 9
  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialDigitalIn4V2::FUNCTION_RESET = 243
  • BrickletIndustrialDigitalIn4V2::FUNCTION_WRITE_UID = 248
BrickletIndustrialDigitalIn4V2#set_response_expected_all(response_expected) → nil
Parameter:response_expected -- bool

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

BrickletIndustrialDigitalIn4V2#get_spitfp_error_count → [int, int, int, int]

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 Werte error_count_ack_checksum, error_count_message_checksum, error_count_frame und error_count_overflow.

BrickletIndustrialDigitalIn4V2#set_bootloader_mode(mode) → int
Parameter:mode -- int

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:

  • BrickletIndustrialDigitalIn4V2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIndustrialDigitalIn4V2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIndustrialDigitalIn4V2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIndustrialDigitalIn4V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIndustrialDigitalIn4V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletIndustrialDigitalIn4V2::BOOTLOADER_STATUS_OK = 0
  • BrickletIndustrialDigitalIn4V2::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletIndustrialDigitalIn4V2::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletIndustrialDigitalIn4V2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletIndustrialDigitalIn4V2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletIndustrialDigitalIn4V2::BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletIndustrialDigitalIn4V2#get_bootloader_mode → int

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

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

  • BrickletIndustrialDigitalIn4V2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIndustrialDigitalIn4V2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIndustrialDigitalIn4V2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIndustrialDigitalIn4V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIndustrialDigitalIn4V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletIndustrialDigitalIn4V2#set_write_firmware_pointer(pointer) → nil
Parameter:pointer -- int

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.

BrickletIndustrialDigitalIn4V2#write_firmware(data) → int
Parameter:data -- [int, int, ..61x.., int]

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.

BrickletIndustrialDigitalIn4V2#set_status_led_config(config) → nil
Parameter:config -- int

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:

  • BrickletIndustrialDigitalIn4V2::STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalIn4V2::STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalIn4V2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalIn4V2::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletIndustrialDigitalIn4V2#get_status_led_config → int

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

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

  • BrickletIndustrialDigitalIn4V2::STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalIn4V2::STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalIn4V2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalIn4V2::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletIndustrialDigitalIn4V2#get_chip_temperature → int

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.

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

BrickletIndustrialDigitalIn4V2#write_uid(uid) → nil
Parameter:uid -- int

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.

BrickletIndustrialDigitalIn4V2#read_uid → int

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

BrickletIndustrialDigitalIn4V2#get_identity → [str, str, str, [int, int, int], [int, int, int], int]

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.

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

Konfigurationsfunktionen für Callbacks

BrickletIndustrialDigitalIn4V2#register_callback(callback_id) { |param [, ...]| block } → nil
Parameter:callback_id -- int

Registriert den block für die gegebene callback_id.

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

BrickletIndustrialDigitalIn4V2#set_value_callback_configuration(channel, period, value_has_to_change) → nil
Parameter:
  • channel -- int
  • period -- int
  • value_has_to_change -- bool

Dieser Callback kann pro Kanal konfiguriert werden.

Die Periode in ms ist die Periode mit der der ::CALLBACK_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.

Der Standardwert ist (0, false).

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

  • BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3
BrickletIndustrialDigitalIn4V2#get_value_callback_configuration(channel) → [int, bool]
Parameter:channel -- int

Gibt die Callback-Konfiguration für den gegebenen Kanal zurück, wie mittels #set_value_callback_configuration gesetzt.

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

  • BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3

Das zurückgegebene Array enthält die Werte period und value_has_to_change.

BrickletIndustrialDigitalIn4V2#set_all_value_callback_configuration(period, value_has_to_change) → nil
Parameter:
  • period -- int
  • value_has_to_change -- bool

Dieser Callback kann pro Kanal konfiguriert werden.

Die Periode in ms ist die Periode mit der der ::CALLBACK_ALL_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.

Der Standardwert ist (0, false).

BrickletIndustrialDigitalIn4V2#get_all_value_callback_configuration → [int, bool]

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

Das zurückgegebene Array enthält die Werte period und value_has_to_change.

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:

industrial_digital_in_4_v2.register_callback BrickletIndustrialDigitalIn4V2::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

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.

BrickletIndustrialDigitalIn4V2::CALLBACK_VALUE
Parameter:
  • channel -- int
  • changed -- bool
  • value -- bool

Dieser Callback wird periodisch ausgelöst abhängig von der mittels #set_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.

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

  • BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3
BrickletIndustrialDigitalIn4V2::CALLBACK_ALL_VALUE
Parameter:
  • changed -- [bool, bool, bool, bool]
  • value -- [bool, bool, bool, bool]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels #set_all_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.

Konstanten

BrickletIndustrialDigitalIn4V2::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Industrial Digital In 4 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.

BrickletIndustrialDigitalIn4V2::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Industrial Digital In 4 Bricklet 2.0 dar.