Dies ist die Beschreibung der Ruby API Bindings für das Analog In Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Analog In Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die Ruby API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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'
include Tinkerforge
HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Analog In Bricklet
ipcon = IPConnection.new # Create IP connection
ai = BrickletAnalogIn.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
|
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'
include Tinkerforge
HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Analog In Bricklet
ipcon = IPConnection.new # Create IP connection
ai = BrickletAnalogIn.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(BrickletAnalogIn::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
|
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'
include Tinkerforge
HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Analog In Bricklet
ipcon = IPConnection.new # Create IP connection
ai = BrickletAnalogIn.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(BrickletAnalogIn::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
|
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
BrickletAnalogIn
::
new
(uid, ipcon) → analog_in¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
analog_in = BrickletAnalogIn.new 'YOUR_DEVICE_UID', ipcon
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletAnalogIn
#
get_voltage
→ int¶Rückgabe: |
|
---|
Gibt die gemessene Spannung des Sensors zurück. Die Auflösung im Bereich 0 bis 6V beträgt rund 2mV. Zwischen 6 und 45V ist die Auflösung rund 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.
BrickletAnalogIn
#
set_range
(range) → nil¶Parameter: |
|
---|
Setzt den Messbereich. Mögliche Bereiche:
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für range:
Neu in Version 2.0.1 (Plugin).
BrickletAnalogIn
#
get_range
→ int¶Rückgabe: |
|
---|
Gibt den Messbereich zurück, wie von #set_range
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für range:
Neu in Version 2.0.1 (Plugin).
BrickletAnalogIn
#
get_analog_value
→ int¶Rückgabe: |
|
---|
Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.
Bemerkung
Der von #get_voltage
zurückgegebene Wert ist über mehrere
Messwerte gemittelt um das Rauschen zu vermindern, während #get_analog_value
unverarbeitete Analogwerte zurück gibt. Der einzige Grund #get_analog_value
zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.
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.
BrickletAnalogIn
#
set_averaging
(average) → nil¶Parameter: |
|
---|
Setzt die Länge des Mittelwerts für die Spannung.
Wenn die Länge auf 0 gesetzt wird, ist das Averaging komplett aus. In diesem Fall gibt es mehr Rauschen auf den Daten, allerdings sind die Daten dann ohne Verzögerung.
Neu in Version 2.0.3 (Plugin).
BrickletAnalogIn
#
get_averaging
→ int¶Rückgabe: |
|
---|
Gibt die Averaging-Konfiguration zurück, wie von #set_averaging
gesetzt.
Neu in Version 2.0.3 (Plugin).
BrickletAnalogIn
#
get_identity
→ [str, str, chr, [int, ...], [int, ...], int]¶Rückgabe-Array: |
|
---|
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.
BrickletAnalogIn
#
register_callback
(callback_id) { |param [, ...]| block } → nil¶Parameter: |
|
---|
Registriert den block
für die gegebene callback_id
.
Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.
BrickletAnalogIn
#
set_voltage_callback_period
(period) → nil¶Parameter: |
|
---|
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.
BrickletAnalogIn
#
get_voltage_callback_period
→ int¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von #set_voltage_callback_period
gesetzt.
BrickletAnalogIn
#
set_analog_value_callback_period
(period) → nil¶Parameter: |
|
---|
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.
BrickletAnalogIn
#
get_analog_value_callback_period
→ int¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von #set_analog_value_callback_period
gesetzt.
BrickletAnalogIn
#
set_voltage_callback_threshold
(option, min, max) → nil¶Parameter: |
|
---|
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) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletAnalogIn
#
get_voltage_callback_threshold
→ [chr, int, int]¶Rückgabe-Array: |
|
---|
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:
BrickletAnalogIn
#
set_analog_value_callback_threshold
(option, min, max) → nil¶Parameter: |
|
---|
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) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletAnalogIn
#
get_analog_value_callback_threshold
→ [chr, int, int]¶Rückgabe-Array: |
|
---|
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:
BrickletAnalogIn
#
set_debounce_period
(debounce) → nil¶Parameter: |
|
---|
Setzt die Periode mit welcher die Schwellwert Callbacks
ausgelöst werden, wenn die Schwellwerte
weiterhin erreicht bleiben.
BrickletAnalogIn
#
get_debounce_period
→ int¶Rückgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von #set_debounce_period
gesetzt.
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.register_callback BrickletAnalogIn::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.
BrickletAnalogIn
::
CALLBACK_VOLTAGE
¶Callback-Parameter: |
|
---|
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.
BrickletAnalogIn
::
CALLBACK_ANALOG_VALUE
¶Callback-Parameter: |
|
---|
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.
BrickletAnalogIn
::
CALLBACK_VOLTAGE_REACHED
¶Callback-Parameter: |
|
---|
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.
BrickletAnalogIn
::
CALLBACK_ANALOG_VALUE_REACHED
¶Callback-Parameter: |
|
---|
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.
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.
BrickletAnalogIn
#
get_api_version
→ [int, ...]¶Rückgabe-Array: |
|
---|
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.
BrickletAnalogIn
#
get_response_expected
(function_id) → bool¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
BrickletAnalogIn
#
set_response_expected
(function_id, response_expected) → nil¶Parameter: |
|
---|
Ä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:
BrickletAnalogIn
#
set_response_expected_all
(response_expected) → nil¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
BrickletAnalogIn
::
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein 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.
BrickletAnalogIn
::
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Analog In Bricklet dar.