Ruby - Industrial Digital In 4 Bricklet

Dies ist die Beschreibung der Ruby API Bindings für das Industrial Digital In 4 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Digital In 4 Bricklet 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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_industrial_digital_in_4'

include Tinkerforge

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

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

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

# Get current value as bitmask
value_mask = idi4.get_value
puts "Value Mask: #{'%04b' % value_mask}"

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

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_industrial_digital_in_4'

include Tinkerforge

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

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

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

# Register interrupt callback
idi4.register_callback(BrickletIndustrialDigitalIn4::CALLBACK_INTERRUPT) do |interrupt_mask,
                                                                             value_mask|
  puts "Interrupt Mask: #{'%04b' % interrupt_mask}"
  puts "Value Mask: #{'%04b' % value_mask}"
  puts ''
end

# Enable interrupt on pin 0
idi4.set_interrupt 1 << 0

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

API

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

BrickletIndustrialDigitalIn4::new(uid, ipcon) → industrial_digital_in_4
Parameter:
  • uid – Typ: str
  • ipcon – Typ: IPConnection
Rückgabe:
  • industrial_digital_in_4 – Typ: BrickletIndustrialDigitalIn4

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

industrial_digital_in_4 = BrickletIndustrialDigitalIn4.new 'YOUR_DEVICE_UID', ipcon

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

BrickletIndustrialDigitalIn4#get_value → int
Rückgabe:
  • value_mask – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die Ausgabewerte mit einer Bitmaske zurück. Die Bitmaske ist 16Bit lang. true bedeutet logisch 1 und false logisch 0.

Zum Beispiel: Der Wert 3 bzw. 0b0011 bedeutet, dass die Pins 0-1 auf logisch 1 und alle anderen auf logisch 0 sind.

Falls keine Gruppen verwendet werden (siehe #set_group), entsprechen die Pins der Beschriftung auf dem Industrial Digital In 4 Bricklet.

Falls Gruppen verwendet werden, entsprechen die Pins den Elementen der Gruppe. Element 1 in der Gruppe bekommt Pins 0-3, Element 2 Pins 4-7, Element 3 Pins 8-11 und Element 4 Pins 12-15.

BrickletIndustrialDigitalIn4#get_edge_count(pin, reset_counter) → int
Parameter:
  • pin – Typ: int, Wertebereich: [0 bis 255]
  • 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 Pin zurück. Die zu zählenden Flanken können mit #set_edge_count_config konfiguriert werden.

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

Neu in Version 2.0.1 (Plugin).

Fortgeschrittene Funktionen

BrickletIndustrialDigitalIn4#set_group(group) → nil
Parameter:
  • group – Typ: [chr, ...], Länge: 4

Setzt eine Gruppe von Digital In 4 Bricklets die zusammenarbeiten sollen. Mögliche Gruppierungen können mit der Funktion #get_available_for_group gefunden werden.

Eine Gruppe besteht aus 4 Element. Element 1 in der Gruppe bekommt Pins 0-3, Element 2 Pins 4-7, Element 3 Pins 8-11 und Element 4 Pins 12-15.

Jedes Element kann entweder auf einen der Ports ('a' bis 'd') gesetzt werden oder falls nicht genutzt 'n' gesetzt werden.

Zum Beispiel: Falls zwei Digital In 4 Bricklets mit Port A und Port B verbunden sind, könnte diese Funktion mit ['a', 'b', 'n', 'n'] aufgerufen werden.

In diesem Fall wären die Pins von Port A den Werten 0-3 zugewiesen und die Pins von Port B den Werten 4-7. Es ist jetzt möglich mit der Funktion #get_value beide Bricklets gleichzeitig auszulesen.

Änderungen an der Gruppeneinteilung setzt die Konfiguration und Zählerwerte aller Flankenzähler zurück.

BrickletIndustrialDigitalIn4#get_group → [chr, ...]
Rückgabe:
  • group – Typ: [chr, ...], Länge: 4

Gibt die Gruppierung zurück, wie von #set_group gesetzt.

BrickletIndustrialDigitalIn4#get_available_for_group → int
Rückgabe:
  • available – Typ: int, Wertebereich: [0 bis 255]

Gibt eine Bitmaske von Ports zurück die für die Gruppierung zur Verfügung stehen. Zum Beispiel bedeutet der Wert 5 bzw. 0b0101: Port A und Port C sind mit Bricklets verbunden die zusammen gruppiert werden können.

BrickletIndustrialDigitalIn4#set_edge_count_config(selection_mask, edge_type, debounce) → nil
Parameter:
  • selection_mask – Typ: int, Wertebereich: [0 bis 216 - 1]
  • edge_type – Typ: int, Wertebereich: Siehe Konstanten
  • debounce – Typ: int, Wertebereich: [0 bis 255]

Konfiguriert den Flankenzähler für die ausgewählten Pins. Eine Bitmaske von 9 bzw. 0b1001 aktiviert den Flankenzähler für die Pins 0 und 3.

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden für Pins die als Eingang konfiguriert sind. 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:

Für edge_type:

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

Neu in Version 2.0.1 (Plugin).

BrickletIndustrialDigitalIn4#get_edge_count_config(pin) → [int, int]
Parameter:
  • pin – Typ: int, Wertebereich: [0 bis 255]
Rückgabe-Array:
  • 0: edge_type – Typ: int, Wertebereich: Siehe Konstanten
  • 1: debounce – Typ: int, Wertebereich: [0 bis 255]

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

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

Für edge_type:

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

Neu in Version 2.0.1 (Plugin).

BrickletIndustrialDigitalIn4#get_api_version → [int, ...]
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.

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

  • BrickletIndustrialDigitalIn4::FUNCTION_SET_GROUP = 2
  • BrickletIndustrialDigitalIn4::FUNCTION_SET_DEBOUNCE_PERIOD = 5
  • BrickletIndustrialDigitalIn4::FUNCTION_SET_INTERRUPT = 7
  • BrickletIndustrialDigitalIn4::FUNCTION_SET_EDGE_COUNT_CONFIG = 11
BrickletIndustrialDigitalIn4#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:

  • BrickletIndustrialDigitalIn4::FUNCTION_SET_GROUP = 2
  • BrickletIndustrialDigitalIn4::FUNCTION_SET_DEBOUNCE_PERIOD = 5
  • BrickletIndustrialDigitalIn4::FUNCTION_SET_INTERRUPT = 7
  • BrickletIndustrialDigitalIn4::FUNCTION_SET_EDGE_COUNT_CONFIG = 11
BrickletIndustrialDigitalIn4#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.

BrickletIndustrialDigitalIn4#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
  • 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

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

BrickletIndustrialDigitalIn4#set_debounce_period(debounce) → nil
Parameter:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Entprellperiode der ::CALLBACK_INTERRUPT Callback.

Beispiel: Wenn dieser Wert auf 100 gesetzt wird, erhält man den Interrupt maximal alle 100ms. Dies ist notwendig falls etwas prellendes an das Digital In 4 Bricklet angeschlossen ist, wie z.B. einen Schalter.

BrickletIndustrialDigitalIn4#get_debounce_period → int
Rückgabe:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von #set_debounce_period gesetzt.

BrickletIndustrialDigitalIn4#set_interrupt(interrupt_mask) → nil
Parameter:
  • interrupt_mask – Typ: int, Wertebereich: [0 bis 216 - 1]

Setzt durch eine Bitmaske die Pins für welche der Interrupt aktiv ist. Interrupts werden ausgelöst bei Änderung des Spannungspegels eines Pins, z.B. ein Wechsel von logisch 1 zu logisch 0 und logisch 0 zu logisch 1.

Beispiel: Eine Interrupt Bitmaske von 9 bzw. 0b1001 aktiviert den Interrupt für die Pins 0 und 3.

Die Interrupts benutzen die Gruppierung, wie von #set_group gesetzt.

Der Interrupt wird mit dem ::CALLBACK_INTERRUPT Callback zugestellt.

BrickletIndustrialDigitalIn4#get_interrupt → int
Rückgabe:
  • interrupt_mask – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die Interrupt Bitmaske zurück, wie von #set_interrupt 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:

industrial_digital_in_4.register_callback BrickletIndustrialDigitalIn4::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.

BrickletIndustrialDigitalIn4::CALLBACK_INTERRUPT
Callback-Parameter:
  • interrupt_mask – Typ: int, Wertebereich: [0 bis 216 - 1]
  • value_mask – Typ: int, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird ausgelöst sobald eine Änderung des Spannungspegels detektiert wird, an Pins für welche der Interrupt mit #set_interrupt aktiviert wurde.

Die Rückgabewerte sind eine Bitmaske der aufgetretenen Interrupts und der aktuellen Zustände.

Beispiele:

  • (1, 1) bzw. (0b0001, 0b0001) bedeutet, dass ein Interrupt am Pin 0 aufgetreten ist und aktuell Pin 0 logisch 1 ist und die Pins 1-3 logisch 0 sind.
  • (9, 14) bzw. (0b1001, 0b1110) bedeutet, dass Interrupts an den Pins 0 und 3 aufgetreten sind und aktuell Pin 0 logisch 0 ist und die Pins 1-3 logisch 1 sind.

Konstanten

BrickletIndustrialDigitalIn4::DEVICE_IDENTIFIER

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

BrickletIndustrialDigitalIn4::DEVICE_DISPLAY_NAME

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