Software / API Bindings / Ruby / API Referenz und Beispiele / Bricklets / Industrial Dual Analog In Bricklet 2.0

Ruby - Industrial Dual Analog In Bricklet 2.0¶

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

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

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_industrial_dual_analog_in_v2'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
idai = BrickletIndustrialDualAnalogInV2.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 0
voltage = idai.get_voltage 0
puts "Voltage (Channel 0): #{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_v2'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
idai = BrickletIndustrialDualAnalogInV2.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(BrickletIndustrialDualAnalogInV2::CALLBACK_VOLTAGE) do |channel,
                                                                               voltage|
  puts "Channel: #{channel}"
  puts "Voltage: #{voltage/1000.0} V"
  puts ''
end

# Set period for voltage (channel 0) callback to 1s (1000ms) without a threshold
idai.set_voltage_callback_configuration 0, 1000, false, 'x', 0, 0

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

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
idai = BrickletIndustrialDualAnalogInV2.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(BrickletIndustrialDualAnalogInV2::CALLBACK_VOLTAGE) do |channel,
                                                                               voltage|
  puts "Channel: #{channel}"
  puts "Voltage: #{voltage/1000.0} V"
  puts ''
end

# Configure threshold for voltage (channel 0) "greater than 10 V"
# with a debounce period of 10s (10000ms)
idai.set_voltage_callback_configuration 0, 10000, false, '>', 10*1000, 0

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

API¶

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Das Bricklet hat zwei Eingangskanäle. Funktionen die sich direkt auf einen der Kanäle beziehen haben einen channel Parameter, um den Kanal anzugeben. Gültige Werte für der channel Parameter sind 0 und 1.

Grundfunktionen¶

BrickletIndustrialDualAnalogInV2::new(uid, ipcon) → industrial_dual_analog_in_v2¶

Parameter:	uid – Typ: str ipcon – Typ: IPConnection
Rückgabe:	industrial_dual_analog_in_v2 – Typ: BrickletIndustrialDualAnalogInV2

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

industrial_dual_analog_in_v2 = BrickletIndustrialDualAnalogInV2.new 'YOUR_DEVICE_UID', ipcon

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

BrickletIndustrialDualAnalogInV2#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 der Wert periodisch benötigt wird, kann auch der ::CALLBACK_VOLTAGE Callback verwendet werden. Der Callback wird mit der Funktion #set_voltage_callback_configuration konfiguriert.

BrickletIndustrialDualAnalogInV2#set_channel_led_config(channel, config) → nil¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1] config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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 kann die LED entweder ab einem vordefinierten Schwellwert eingeschaltet werden oder ihre Helligkeit anhand des gemessenen Wertes skaliert werden.

Das Verhalten des Kanalstatus kann mittels #set_channel_led_status_config eingestellt werden.

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

Für config:

BrickletIndustrialDualAnalogInV2::CHANNEL_LED_CONFIG_OFF = 0
BrickletIndustrialDualAnalogInV2::CHANNEL_LED_CONFIG_ON = 1
BrickletIndustrialDualAnalogInV2::CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletIndustrialDualAnalogInV2::CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

BrickletIndustrialDualAnalogInV2#get_channel_led_config(channel) → int¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1]
Rückgabe:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

BrickletIndustrialDualAnalogInV2::CHANNEL_LED_CONFIG_OFF = 0
BrickletIndustrialDualAnalogInV2::CHANNEL_LED_CONFIG_ON = 1
BrickletIndustrialDualAnalogInV2::CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletIndustrialDualAnalogInV2::CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

BrickletIndustrialDualAnalogInV2#set_channel_led_status_config(channel, min, max, config) → nil¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1] 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: 10000 config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1

Setzt die Kanal-LED-Status-Konfiguration. Diese Einstellung wird verwendet wenn die Kanal-LED auf Kanalstatus eingestellt ist, siehe #set_channel_led_config.

Für jeden Kanal kann zwischen Schwellwert- und Intensitätsmodus gewählt werden.

Im Schwellwertmodus kann ein positiver oder negativer Schwellwert definiert werden. Für einen positiven Schwellwert muss der "min" Parameter auf den gewünschten Schwellwert in mV gesetzt werden, über dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem positiven Schwellwert von 10V wird die LED eingeschaltet sobald die gemessene Spannung über 10V steigt und wieder ausgeschaltet sobald der Strom unter 10V fällt. Für einen negativen Schwellwert muss der "max" Parameter auf den gewünschten Schwellwert in mV gesetzt werden, unter dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem negativen Schwellwert von 10mA wird die LED eingeschaltet sobald die gemessene Spannung unter 10V fällt und wieder ausgeschaltet sobald der Strom über 10V steigt.

Im Intensitätsmodus kann ein Bereich in mV angegeben werden über den die Helligkeit der LED skaliert wird. Beispiel mit min=4V und max=20V: Die LED ist bei 4V und darunter aus, bei 20V und darüber an und zwischen 4V und 20V wird die Helligkeit linear skaliert. Wenn der min Wert größer als der max Wert ist, dann wird die Helligkeit andersherum skaliert.

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

Für config:

BrickletIndustrialDualAnalogInV2::CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
BrickletIndustrialDualAnalogInV2::CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1

BrickletIndustrialDualAnalogInV2#get_channel_led_status_config(channel) → [int, int, int]¶

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

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

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

Für config:

BrickletIndustrialDualAnalogInV2::CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
BrickletIndustrialDualAnalogInV2::CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1

Fortgeschrittene Funktionen¶

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

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

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

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

BrickletIndustrialDualAnalogInV2#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 2.0 wird von Tinkerforge werkskalibriert. Ein Aufruf dieser Funktion sollte nicht notwendig sein.

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

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

BrickletIndustrialDualAnalogInV2#get_all_voltages → [int, ...]¶

Rückgabe:	voltages – Typ: [int, ...], Länge: 2, Einheit: 1 mV, Wertebereich: [-35000 bis 35000]

Gibt die Spannung aller Kanäle zurück.

Wenn der Wert periodisch benötigt wird, kann auch der ::CALLBACK_ALL_VOLTAGES Callback verwendet werden. Der Callback wird mit der Funktion #set_all_voltages_callback_configuration konfiguriert.

Neu in Version 2.0.6 (Plugin).

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

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

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

BrickletIndustrialDualAnalogInV2::STATUS_LED_CONFIG_OFF = 0
BrickletIndustrialDualAnalogInV2::STATUS_LED_CONFIG_ON = 1
BrickletIndustrialDualAnalogInV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletIndustrialDualAnalogInV2::STATUS_LED_CONFIG_SHOW_STATUS = 3

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

BrickletIndustrialDualAnalogInV2::STATUS_LED_CONFIG_OFF = 0
BrickletIndustrialDualAnalogInV2::STATUS_LED_CONFIG_ON = 1
BrickletIndustrialDualAnalogInV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletIndustrialDualAnalogInV2::STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletIndustrialDualAnalogInV2#get_chip_temperature → int¶

Rückgabe:	temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 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.

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

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

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

BrickletIndustrialDualAnalogInV2#set_voltage_callback_configuration(channel, period, value_has_to_change, option, min, max) → nil¶

Parameter:

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1] period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false 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

channel – Typ: int, Wertebereich: [0 bis 1]
period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
value_has_to_change – Typ: bool, Standardwert: false
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

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

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den ::CALLBACK_VOLTAGE Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Threshold ist abgeschaltet
'o'	Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i'	Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<'	Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>'	Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

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

BrickletIndustrialDualAnalogInV2#get_voltage_callback_configuration(channel) → [int, bool, chr, int, int]¶

Parameter:

channel – Typ: int, Wertebereich: [0 bis 1]

Rückgabe-Array:

0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
1: value_has_to_change – Typ: bool, Standardwert: false
2: option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
3: min – Typ: int, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
4: max – Typ: int, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

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

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

Für option:

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

BrickletIndustrialDualAnalogInV2#set_all_voltages_callback_configuration(period, value_has_to_change) → nil¶

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

Die Periode ist die Periode mit der der ::CALLBACK_ALL_VOLTAGES 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 sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn ein 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 der Werte.

Neu in Version 2.0.6 (Plugin).

BrickletIndustrialDualAnalogInV2#get_all_voltages_callback_configuration → [int, bool]¶

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

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

Neu in Version 2.0.6 (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:

industrial_dual_analog_in_v2.register_callback BrickletIndustrialDualAnalogInV2::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.

BrickletIndustrialDualAnalogInV2::CALLBACK_VOLTAGE¶

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

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

Der Parameter ist der gleiche wie #get_voltage.

BrickletIndustrialDualAnalogInV2::CALLBACK_ALL_VOLTAGES¶

Callback-Parameter:	voltages – Typ: [int, ...], Länge: 2, Einheit: 1 mV, Wertebereich: [-35000 bis 35000]

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

Die Parameter sind der gleiche wie #get_all_voltages.

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

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

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

BrickletIndustrialDualAnalogInV2::FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 2
BrickletIndustrialDualAnalogInV2::FUNCTION_SET_SAMPLE_RATE = 5
BrickletIndustrialDualAnalogInV2::FUNCTION_SET_CALIBRATION = 7
BrickletIndustrialDualAnalogInV2::FUNCTION_SET_CHANNEL_LED_CONFIG = 10
BrickletIndustrialDualAnalogInV2::FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 12
BrickletIndustrialDualAnalogInV2::FUNCTION_SET_ALL_VOLTAGES_CALLBACK_CONFIGURATION = 15
BrickletIndustrialDualAnalogInV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletIndustrialDualAnalogInV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletIndustrialDualAnalogInV2::FUNCTION_RESET = 243
BrickletIndustrialDualAnalogInV2::FUNCTION_WRITE_UID = 248

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

BrickletIndustrialDualAnalogInV2::FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 2
BrickletIndustrialDualAnalogInV2::FUNCTION_SET_SAMPLE_RATE = 5
BrickletIndustrialDualAnalogInV2::FUNCTION_SET_CALIBRATION = 7
BrickletIndustrialDualAnalogInV2::FUNCTION_SET_CHANNEL_LED_CONFIG = 10
BrickletIndustrialDualAnalogInV2::FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 12
BrickletIndustrialDualAnalogInV2::FUNCTION_SET_ALL_VOLTAGES_CALLBACK_CONFIGURATION = 15
BrickletIndustrialDualAnalogInV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletIndustrialDualAnalogInV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletIndustrialDualAnalogInV2::FUNCTION_RESET = 243
BrickletIndustrialDualAnalogInV2::FUNCTION_WRITE_UID = 248

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

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

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

Für status:

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

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

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

BrickletIndustrialDualAnalogInV2#set_write_firmware_pointer(pointer) → nil¶

Parameter:	pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 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.

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

BrickletIndustrialDualAnalogInV2#write_uid(uid) → nil¶

Parameter:	uid – Typ: int, Wertebereich: [0 bis 2³² - 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.

BrickletIndustrialDualAnalogInV2#read_uid → int¶

Rückgabe:	uid – Typ: int, Wertebereich: [0 bis 2³² - 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¶

BrickletIndustrialDualAnalogInV2::DEVICE_IDENTIFIER¶

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

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