Ruby - Distance US Bricklet¶

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

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Distance US Bricklet

ipcon = IPConnection.new # Create IP connection
dus = BrickletDistanceUS.new UID, ipcon # Create device object

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

# Get current distance value
distance = dus.get_distance_value
puts "Distance Value: #{distance}"

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

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Distance US Bricklet

ipcon = IPConnection.new # Create IP connection
dus = BrickletDistanceUS.new UID, ipcon # Create device object

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

# Register distance value callback
dus.register_callback(BrickletDistanceUS::CALLBACK_DISTANCE) do |distance|
  puts "Distance Value: #{distance}"
end

# Set period for distance value callback to 0.2s (200ms)
# Note: The distance value callback is only called every 0.2 seconds
#       if the distance value has changed since the last call!
dus.set_distance_callback_period 200

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

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Distance US Bricklet

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

# Register distance value reached callback
dus.register_callback(BrickletDistanceUS::CALLBACK_DISTANCE_REACHED) do |distance|
  puts "Distance Value: #{distance}"
end

# Configure threshold for distance value "smaller than 200"
dus.set_distance_callback_threshold '<', 200, 0

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

Grundfunktionen¶

BrickletDistanceUS::new(uid, ipcon) → distance_us¶

Parameter:	uid – Typ: str ipcon – Typ: IPConnection
Rückgabe:	distance_us – Typ: BrickletDistanceUS

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

distance_us = BrickletDistanceUS.new 'YOUR_DEVICE_UID', ipcon

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

BrickletDistanceUS#get_distance_value → int¶

Rückgabe:	distance – Typ: int, Wertebereich: [0 bis 212 - 1]

Gibt den aktuellen Entfernungswert zurück. Ein kleiner Wert entspricht einer kleinen Entfernung, ein großer Wert entspricht einer großen Entfernung. Das Verhältnis zwischen gemessenem Entfernungswert und wirklicher Entfernung wird durch die 5V Versorgungsspannung beeinflusst (Abweichungen der Versorgungsspannung führen zu Abweichungen in den Entfernungswerten) und ist nicht-linear (Auflösung ist größer im Nahbereich).

Wenn der Entfernungswert periodisch abgefragt werden soll, wird empfohlen den ::CALLBACK_DISTANCE Callback zu nutzen und die Periode mit #set_distance_callback_period vorzugeben.

Fortgeschrittene Funktionen¶

BrickletDistanceUS#set_moving_average(average) → nil¶

Parameter:	average – Typ: int, Wertebereich: [0 bis 100], Standardwert: 20

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

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

BrickletDistanceUS#get_moving_average → int¶

Rückgabe:	average – Typ: int, Wertebereich: [0 bis 100], Standardwert: 20

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

BrickletDistanceUS#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, 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 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 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¶

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

BrickletDistanceUS#set_distance_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_DISTANCE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

BrickletDistanceUS#get_distance_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_distance_callback_period gesetzt.

BrickletDistanceUS#set_distance_callback_threshold(option, min, max) → nil¶

Parameter:	option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Wertebereich: [0 bis 212 - 1] max – Typ: int, Wertebereich: [0 bis 212 - 1]

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

Die folgenden Optionen sind möglich:

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

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

Für option:

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

BrickletDistanceUS#get_distance_callback_threshold → [chr, int, int]¶

Rückgabe-Array:	0: option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x' 1: min – Typ: int, Wertebereich: [0 bis 212 - 1] 2: max – Typ: int, Wertebereich: [0 bis 212 - 1]

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

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

Für option:

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

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

• ::CALLBACK_DISTANCE_REACHED,

ausgelöst werden, wenn die Schwellwerte

• #set_distance_callback_threshold,

weiterhin erreicht bleiben.

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

distance_us.register_callback BrickletDistanceUS::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen werden weiter unten beschrieben.

BrickletDistanceUS::CALLBACK_DISTANCE¶

Callback-Parameter:	distance – Typ: int, Wertebereich: [0 bis 212 - 1]

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

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

BrickletDistanceUS::CALLBACK_DISTANCE_REACHED¶

Callback-Parameter:	distance – Typ: int, Wertebereich: [0 bis 212 - 1]

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

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.

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

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

• BrickletDistanceUS::FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 2
• BrickletDistanceUS::FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 4
• BrickletDistanceUS::FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletDistanceUS::FUNCTION_SET_MOVING_AVERAGE = 10

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

• BrickletDistanceUS::FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 2
• BrickletDistanceUS::FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 4
• BrickletDistanceUS::FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletDistanceUS::FUNCTION_SET_MOVING_AVERAGE = 10

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

BrickletDistanceUS::DEVICE_IDENTIFIER¶

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

BrickletDistanceUS::DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Distance US Bricklet dar.