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)

 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_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)

 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
#!/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)

 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
#!/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 Methoden 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 das channel Parameter sind 0 und 1.

Grundfunktionen

BrickletIndustrialDualAnalogIn::new(uid, ipcon) → industrial_dual_analog_in
Parameter:
  • uid -- str
  • ipcon -- IPConnection

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 (siehe Beispiele oben).

BrickletIndustrialDualAnalogIn#get_voltage(channel) → int
Parameter:channel -- int

Gibt die Spannung für den übergebenen Kanal in mV 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 -- int

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.

Der Standardwert ist 6 (2 Werte pro Sekunde).

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

  • 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

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

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

  • 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 -- [int, int]
  • gain -- [int, int]

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], [int, int]]

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

Das zurückgegebene Array enthält die Werte offset und gain.

BrickletIndustrialDualAnalogIn#get_adc_values → [int, int]

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

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

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

Siehe #set_response_expected für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

BrickletIndustrialDualAnalogIn#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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • 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 -- bool

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

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

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

BrickletIndustrialDualAnalogIn#set_voltage_callback_period(channel, period) → nil
Parameter:
  • channel -- int
  • period -- int

Setzt die Periode in ms 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.

Der Standardwert ist 0.

BrickletIndustrialDualAnalogIn#get_voltage_callback_period(channel) → int
Parameter:channel -- int

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

BrickletIndustrialDualAnalogIn#set_voltage_callback_threshold(channel, option, min, max) → nil
Parameter:
  • channel -- int
  • option -- str
  • min -- int
  • max -- int

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)

Der Standardwert ist ('x', 0, 0).

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

  • 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) → [str, int, int]
Parameter:channel -- int

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

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

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

Das zurückgegebene Array enthält die Werte option, min und max.

BrickletIndustrialDualAnalogIn#set_debounce_period(debounce) → nil
Parameter:debounce -- int

Setzt die Periode in ms mit welcher der Schwellwert Callback

ausgelöst werden, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

BrickletIndustrialDualAnalogIn#get_debounce_period → int

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
Parameter:
  • channel -- int
  • voltage -- int

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
Parameter:
  • channel -- int
  • voltage -- int

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.

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.