Software / API Bindings / Ruby / API Referenz und Beispiele / Bricklets (Abgekündigt) / Industrial Dual Analog In Bricklet

Ruby - Industrial Dual Analog In Bricklet¶

Dies ist die Beschreibung der Ruby API Bindings für das Industrial Dual Analog In Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Dual Analog In 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)

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

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_industrial_dual_analog_in'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
idai = BrickletIndustrialDualAnalogIn.new UID, ipcon # Create device object

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

# Get current voltage from channel 1
voltage = idai.get_voltage 1
puts "Voltage (Channel 1): #{voltage/1000.0} V"

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

Callback¶

Download (example_callback.rb)

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

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_industrial_dual_analog_in'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
idai = BrickletIndustrialDualAnalogIn.new UID, ipcon # Create device object

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

# Register voltage callback
idai.register_callback(BrickletIndustrialDualAnalogIn::CALLBACK_VOLTAGE) do |channel,
                                                                             voltage|
  puts "Channel: #{channel}"
  puts "Voltage: #{voltage/1000.0} V"
  puts ''
end

# Set period for voltage (channel 1) callback to 1s (1000ms)
# Note: The voltage (channel 1) callback is only called every second
#       if the voltage (channel 1) has changed since the last call!
idai.set_voltage_callback_period 1, 1000

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

Threshold¶

Download (example_threshold.rb)

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

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_industrial_dual_analog_in'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
idai = BrickletIndustrialDualAnalogIn.new UID, ipcon # Create device object

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

# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
idai.set_debounce_period 10000

# Register voltage reached callback
idai.register_callback(BrickletIndustrialDualAnalogIn::CALLBACK_VOLTAGE_REACHED) do |channel,
                                                                                     voltage|
  puts "Channel: #{channel}"
  puts "Voltage: #{voltage/1000.0} V"
  puts ''
end

# Configure threshold for voltage (channel 1) "greater than 10 V"
idai.set_voltage_callback_threshold 1, '>', 10*1000, 0

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

API¶

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

BrickletIndustrialDualAnalogIn::new(uid, ipcon) → industrial_dual_analog_in¶

Parameter:	uid – Typ: str ipcon – Typ: IPConnection
Rückgabe:	industrial_dual_analog_in – Typ: BrickletIndustrialDualAnalogIn

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

industrial_dual_analog_in = BrickletIndustrialDualAnalogIn.new 'YOUR_DEVICE_UID', ipcon

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

BrickletIndustrialDualAnalogIn#get_voltage(channel) → int¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1]
Rückgabe:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [-35000 bis 35000]

Gibt die Spannung für den übergebenen Kanal zurück.

Wenn die Spannung periodisch abgefragt werden soll, wird empfohlen den ::CALLBACK_VOLTAGE Callback zu nutzen und die Periode mit #set_voltage_callback_period vorzugeben.

Fortgeschrittene Funktionen¶

BrickletIndustrialDualAnalogIn#set_sample_rate(rate) → nil¶

Parameter:	rate – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 6

Setzt die Abtastrate. Der Wertebereich der verfügbare Abtastraten liegt zwischen 1 Wert pro Sekunde und 976 Werte pro Sekunde. Ein Verringern der Abtastrate wird auch das Rauschen auf den Daten verringern.

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

Für rate:

BrickletIndustrialDualAnalogIn::SAMPLE_RATE_976_SPS = 0
BrickletIndustrialDualAnalogIn::SAMPLE_RATE_488_SPS = 1
BrickletIndustrialDualAnalogIn::SAMPLE_RATE_244_SPS = 2
BrickletIndustrialDualAnalogIn::SAMPLE_RATE_122_SPS = 3
BrickletIndustrialDualAnalogIn::SAMPLE_RATE_61_SPS = 4
BrickletIndustrialDualAnalogIn::SAMPLE_RATE_4_SPS = 5
BrickletIndustrialDualAnalogIn::SAMPLE_RATE_2_SPS = 6
BrickletIndustrialDualAnalogIn::SAMPLE_RATE_1_SPS = 7

BrickletIndustrialDualAnalogIn#get_sample_rate → int¶

Rückgabe:	rate – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 6

Gibt die Abtastrate zurück, wie von #set_sample_rate gesetzt.

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

Für rate:

BrickletIndustrialDualAnalogIn::SAMPLE_RATE_976_SPS = 0
BrickletIndustrialDualAnalogIn::SAMPLE_RATE_488_SPS = 1
BrickletIndustrialDualAnalogIn::SAMPLE_RATE_244_SPS = 2
BrickletIndustrialDualAnalogIn::SAMPLE_RATE_122_SPS = 3
BrickletIndustrialDualAnalogIn::SAMPLE_RATE_61_SPS = 4
BrickletIndustrialDualAnalogIn::SAMPLE_RATE_4_SPS = 5
BrickletIndustrialDualAnalogIn::SAMPLE_RATE_2_SPS = 6
BrickletIndustrialDualAnalogIn::SAMPLE_RATE_1_SPS = 7

BrickletIndustrialDualAnalogIn#set_calibration(offset, gain) → nil¶

Parameter:	offset – Typ: [int, ...], Länge: 2, Wertebereich: [-2²³ bis 2²³ - 1] gain – Typ: [int, ...], Länge: 2, Wertebereich: [-2²³ bis 2²³ - 1]

Setzt Offset und Gain der MCP3911 internen Kalibrierungsregister.

Siehe MCP3911 Datenblatt 7.7 und 7.8. Das Industrial Dual Analog In Bricklet wird von Tinkerforge werkskalibriert. Ein Aufruf dieser Funktion sollte nicht notwendig sein.

BrickletIndustrialDualAnalogIn#get_calibration → [[int, ...], [int, ...]]¶

Rückgabe-Array:	0: offset – Typ: [int, ...], Länge: 2, Wertebereich: [-2²³ bis 2²³ - 1] 1: gain – Typ: [int, ...], Länge: 2, Wertebereich: [-2²³ bis 2²³ - 1]

Gibt die Kalibrierung zurück, wie von #set_calibration gesetzt.

BrickletIndustrialDualAnalogIn#get_adc_values → [int, ...]¶

Rückgabe:	value – Typ: [int, ...], Länge: 2, Wertebereich: [-2²³ bis 2²³ - 1]

Gibt die ADC-Werte des MCP3911 ICs zurück. Diese Funktion wird für die Kalibrierung benötigt, siehe #set_calibration.

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

Rückgabe-Array:

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 2¹⁶ - 1]

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 2¹⁶ - 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¶

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

BrickletIndustrialDualAnalogIn#set_voltage_callback_period(channel, period) → nil¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1] period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Setzt die Periode mit welcher der ::CALLBACK_VOLTAGE Callback für den übergebenen Kanal ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der ::CALLBACK_VOLTAGE Callback wird nur ausgelöst, wenn sich die Spannung seit der letzten Auslösung geändert hat.

BrickletIndustrialDualAnalogIn#get_voltage_callback_period(channel) → int¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1]
Rückgabe:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von #set_voltage_callback_period gesetzt.

BrickletIndustrialDualAnalogIn#set_voltage_callback_threshold(channel, option, min, max) → nil¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1] option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

Setzt den Schwellwert des ::CALLBACK_VOLTAGE_REACHED Callbacks für den übergebenen Kanal.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn die Spannung außerhalb des min und max Wertes ist
'i'	Callback wird ausgelöst, wenn die Spannung innerhalb des min und max Wertes ist
'<'	Callback wird ausgelöst, wenn die Spannung kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die Spannung größer als der min Wert ist (max wird ignoriert)

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

Für option:

BrickletIndustrialDualAnalogIn::THRESHOLD_OPTION_OFF = 'x'
BrickletIndustrialDualAnalogIn::THRESHOLD_OPTION_OUTSIDE = 'o'
BrickletIndustrialDualAnalogIn::THRESHOLD_OPTION_INSIDE = 'i'
BrickletIndustrialDualAnalogIn::THRESHOLD_OPTION_SMALLER = '<'
BrickletIndustrialDualAnalogIn::THRESHOLD_OPTION_GREATER = '>'

BrickletIndustrialDualAnalogIn#get_voltage_callback_threshold(channel) → [chr, int, int]¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1]
Rückgabe-Array:	0: option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x' 1: min – Typ: int, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 2: max – Typ: int, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von #set_voltage_callback_threshold gesetzt.

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

Für option:

BrickletIndustrialDualAnalogIn::THRESHOLD_OPTION_OFF = 'x'
BrickletIndustrialDualAnalogIn::THRESHOLD_OPTION_OUTSIDE = 'o'
BrickletIndustrialDualAnalogIn::THRESHOLD_OPTION_INSIDE = 'i'
BrickletIndustrialDualAnalogIn::THRESHOLD_OPTION_SMALLER = '<'
BrickletIndustrialDualAnalogIn::THRESHOLD_OPTION_GREATER = '>'

BrickletIndustrialDualAnalogIn#set_debounce_period(debounce) → nil¶

Parameter:	debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100

Setzt die Periode mit welcher der Schwellwert Callback

::CALLBACK_VOLTAGE_REACHED

ausgelöst werden, wenn der Schwellwert

#set_voltage_callback_threshold

weiterhin erreicht bleibt.

BrickletIndustrialDualAnalogIn#get_debounce_period → int¶

Rückgabe:	debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von #set_debounce_period 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_dual_analog_in.register_callback BrickletIndustrialDualAnalogIn::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.

BrickletIndustrialDualAnalogIn::CALLBACK_VOLTAGE¶

Callback-Parameter:	channel – Typ: int, Wertebereich: [0 bis 1] voltage – Typ: int, Einheit: 1 mV, Wertebereich: [-35000 bis 35000]

Dieser Callback wird mit der Periode, wie gesetzt mit #set_voltage_callback_period, ausgelöst. Der Parameter ist die Spannung des Kanals.

Der ::CALLBACK_VOLTAGE Callback wird nur ausgelöst, wenn sich die Spannung seit der letzten Auslösung geändert hat.

BrickletIndustrialDualAnalogIn::CALLBACK_VOLTAGE_REACHED¶

Callback-Parameter:	channel – Typ: int, Wertebereich: [0 bis 1] voltage – Typ: int, Einheit: 1 mV, Wertebereich: [-35000 bis 35000]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von #set_voltage_callback_threshold gesetzt, erreicht wird. Der Parameter ist die Spannung des Kanals.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit #set_debounce_period gesetzt, ausgelöst.

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.

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

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

BrickletIndustrialDualAnalogIn::FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 2
BrickletIndustrialDualAnalogIn::FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 4
BrickletIndustrialDualAnalogIn::FUNCTION_SET_DEBOUNCE_PERIOD = 6
BrickletIndustrialDualAnalogIn::FUNCTION_SET_SAMPLE_RATE = 8
BrickletIndustrialDualAnalogIn::FUNCTION_SET_CALIBRATION = 10

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

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

Für function_id:

BrickletIndustrialDualAnalogIn::FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 2
BrickletIndustrialDualAnalogIn::FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 4
BrickletIndustrialDualAnalogIn::FUNCTION_SET_DEBOUNCE_PERIOD = 6
BrickletIndustrialDualAnalogIn::FUNCTION_SET_SAMPLE_RATE = 8
BrickletIndustrialDualAnalogIn::FUNCTION_SET_CALIBRATION = 10

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

BrickletIndustrialDualAnalogIn::DEVICE_IDENTIFIER¶

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

BrickletIndustrialDualAnalogIn::DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Industrial Dual Analog In Bricklet dar.