Ruby - Analog In Bricklet 2.0

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

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

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
ai = BrickletAnalogInV2.new UID, ipcon # Create device object

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

# Get current voltage
voltage = ai.get_voltage
puts "Voltage: #{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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_analog_in_v2'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
ai = BrickletAnalogInV2.new UID, ipcon # Create device object

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

# Register voltage callback
ai.register_callback(BrickletAnalogInV2::CALLBACK_VOLTAGE) do |voltage|
  puts "Voltage: #{voltage/1000.0} V"
end

# Set period for voltage callback to 1s (1000ms)
# Note: The voltage callback is only called every second
#       if the voltage has changed since the last call!
ai.set_voltage_callback_period 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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_analog_in_v2'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
ai = BrickletAnalogInV2.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)
ai.set_debounce_period 10000

# Register voltage reached callback
ai.register_callback(BrickletAnalogInV2::CALLBACK_VOLTAGE_REACHED) do |voltage|
  puts "Voltage: #{voltage/1000.0} V"
end

# Configure threshold for voltage "smaller than 5 V"
ai.set_voltage_callback_threshold '<', 5*1000, 0

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

API

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

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

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

analog_in_v2 = BrickletAnalogInV2.new 'YOUR_DEVICE_UID', ipcon

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

BrickletAnalogInV2#get_voltage → int
Rückgabe:
  • voltage – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die gemessene Spannung zurück. Der Wert ist in mV und im Bereich von 0 bis 42V. Die Auflösung ca. 10mV.

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

BrickletAnalogInV2#get_analog_value → int
Rückgabe:
  • value – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück. Der Wertebereich ist 0 bis 4095.

Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen den ::CALLBACK_ANALOG_VALUE Callback zu nutzen und die Periode mit #set_analog_value_callback_period vorzugeben.

BrickletAnalogInV2#set_moving_average(average) → nil
Parameter:
  • average – Typ: int, Wertebereich: [0 bis 255]

Setzt die Länge eines gleitenden Mittelwerts für die Spannung.

Wenn die Länge auf 1 gesetzt wird, ist das Averaging aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Der Wertebereich liegt bei 1-50.

Der Standardwert ist 50.

BrickletAnalogInV2#get_moving_average → int
Rückgabe:
  • average – Typ: int, Wertebereich: [0 bis 255]

Gibt die Länge des gleitenden Mittelwerts zurück, wie von #set_moving_average gesetzt.

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

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

  • BrickletAnalogInV2::FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 3
  • BrickletAnalogInV2::FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BrickletAnalogInV2::FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 7
  • BrickletAnalogInV2::FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BrickletAnalogInV2::FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • BrickletAnalogInV2::FUNCTION_SET_MOVING_AVERAGE = 13
BrickletAnalogInV2#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:

  • BrickletAnalogInV2::FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 3
  • BrickletAnalogInV2::FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BrickletAnalogInV2::FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 7
  • BrickletAnalogInV2::FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BrickletAnalogInV2::FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • BrickletAnalogInV2::FUNCTION_SET_MOVING_AVERAGE = 13
BrickletAnalogInV2#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.

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

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

BrickletAnalogInV2#set_voltage_callback_period(period) → nil
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der ::CALLBACK_VOLTAGE Callback 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.

BrickletAnalogInV2#get_voltage_callback_period → int
Rückgabe:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

BrickletAnalogInV2#set_analog_value_callback_period(period) → nil
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der ::CALLBACK_ANALOG_VALUE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

BrickletAnalogInV2#get_analog_value_callback_period → int
Rückgabe:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

BrickletAnalogInV2#set_voltage_callback_threshold(option, min, max) → nil
Parameter:
  • option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Wertebereich: [0 bis 216 - 1]
  • max – Typ: int, Wertebereich: [0 bis 216 - 1]

Setzt den Schwellwert für den ::CALLBACK_VOLTAGE_REACHED Callback.

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:

Für option:

  • BrickletAnalogInV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletAnalogInV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAnalogInV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAnalogInV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAnalogInV2::THRESHOLD_OPTION_GREATER = '>'
BrickletAnalogInV2#get_voltage_callback_threshold → [chr, int, int]
Rückgabe-Array:
  • 0: option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • 1: min – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 2: max – Typ: int, Wertebereich: [0 bis 216 - 1]

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:

  • BrickletAnalogInV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletAnalogInV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAnalogInV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAnalogInV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAnalogInV2::THRESHOLD_OPTION_GREATER = '>'
BrickletAnalogInV2#set_analog_value_callback_threshold(option, min, max) → nil
Parameter:
  • option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Wertebereich: [0 bis 216 - 1]
  • max – Typ: int, Wertebereich: [0 bis 216 - 1]

Setzt den Schwellwert für den ::CALLBACK_ANALOG_VALUE_REACHED Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn der Analogwert außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn der Analogwert innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn der Analogwert kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn der Analogwert 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:

Für option:

  • BrickletAnalogInV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletAnalogInV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAnalogInV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAnalogInV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAnalogInV2::THRESHOLD_OPTION_GREATER = '>'
BrickletAnalogInV2#get_analog_value_callback_threshold → [chr, int, int]
Rückgabe-Array:
  • 0: option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • 1: min – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 2: max – Typ: int, Wertebereich: [0 bis 216 - 1]

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

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

Für option:

  • BrickletAnalogInV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletAnalogInV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAnalogInV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAnalogInV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAnalogInV2::THRESHOLD_OPTION_GREATER = '>'
BrickletAnalogInV2#set_debounce_period(debounce) → nil
Parameter:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

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

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:

analog_in_v2.register_callback BrickletAnalogInV2::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.

BrickletAnalogInV2::CALLBACK_VOLTAGE
Callback-Parameter:
  • voltage – Typ: int, Wertebereich: [0 bis 216 - 1]

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

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

BrickletAnalogInV2::CALLBACK_ANALOG_VALUE
Callback-Parameter:
  • value – Typ: int, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit #set_analog_value_callback_period, ausgelöst. Der Parameter ist der Analogwert des Sensors.

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

BrickletAnalogInV2::CALLBACK_VOLTAGE_REACHED
Callback-Parameter:
  • voltage – Typ: int, Wertebereich: [0 bis 216 - 1]

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

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

BrickletAnalogInV2::CALLBACK_ANALOG_VALUE_REACHED
Callback-Parameter:
  • value – Typ: int, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von #set_analog_value_callback_threshold gesetzt, erreicht wird. Der Parameter ist der Analogwert des Sensors.

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

Konstanten

BrickletAnalogInV2::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein 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.

BrickletAnalogInV2::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Analog In Bricklet 2.0 dar.