Ruby - Linear Poti Bricklet

Dies ist die Beschreibung der Ruby API Bindings für das Linear Poti Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Linear Poti 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_linear_poti'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Linear Poti Bricklet

ipcon = IPConnection.new # Create IP connection
lp = BrickletLinearPoti.new UID, ipcon # Create device object

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

# Get current position
position = lp.get_position
puts "Position: #{position}" # Range: 0 to 100

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

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Linear Poti Bricklet

ipcon = IPConnection.new # Create IP connection
lp = BrickletLinearPoti.new UID, ipcon # Create device object

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

# Register position callback
lp.register_callback(BrickletLinearPoti::CALLBACK_POSITION) do |position|
  puts "Position: #{position}" # Range: 0 to 100
end

# Set period for position callback to 0.05s (50ms)
# Note: The position callback is only called every 0.05 seconds
#       if the position has changed since the last call!
lp.set_position_callback_period 50

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

API

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

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

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

linear_poti = BrickletLinearPoti.new 'YOUR_DEVICE_UID', ipcon

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

BrickletLinearPoti#get_position → int
Rückgabe:
  • position – Typ: int, Wertebereich: [0 bis 100]

Gibt die Position des Linearpotentiometers zurück. Der Wertebereich ist von 0 (Schieberegler unten) und 100 (Schieberegler oben).

Wenn die Position periodisch abgefragt werden soll, wird empfohlen den ::CALLBACK_POSITION Callback zu nutzen und die Periode mit #set_position_callback_period vorzugeben.

Fortgeschrittene Funktionen

BrickletLinearPoti#get_analog_value → int
Rückgabe:
  • value – Typ: int, Wertebereich: [0 bis 4095]

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.

Bemerkung

Der von #get_position 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.

BrickletLinearPoti#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', 'i', '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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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

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

BrickletLinearPoti#set_position_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_POSITION Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

BrickletLinearPoti#get_position_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_position_callback_period gesetzt.

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

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

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

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

Die folgenden Optionen sind möglich:

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

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

Für option:

  • BrickletLinearPoti::THRESHOLD_OPTION_OFF = 'x'
  • BrickletLinearPoti::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletLinearPoti::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletLinearPoti::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletLinearPoti::THRESHOLD_OPTION_GREATER = '>'
BrickletLinearPoti#get_position_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], Standardwert: 0
  • 2: max – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

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

Für option:

  • BrickletLinearPoti::THRESHOLD_OPTION_OFF = 'x'
  • BrickletLinearPoti::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletLinearPoti::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletLinearPoti::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletLinearPoti::THRESHOLD_OPTION_GREATER = '>'
BrickletLinearPoti#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], Standardwert: 0
  • max – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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 der min und max Werte ist
'i' Callback wird ausgelöst, wenn der Analogwert innerhalb der min und max Werte 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:

  • BrickletLinearPoti::THRESHOLD_OPTION_OFF = 'x'
  • BrickletLinearPoti::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletLinearPoti::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletLinearPoti::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletLinearPoti::THRESHOLD_OPTION_GREATER = '>'
BrickletLinearPoti#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], Standardwert: 0
  • 2: max – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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:

  • BrickletLinearPoti::THRESHOLD_OPTION_OFF = 'x'
  • BrickletLinearPoti::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletLinearPoti::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletLinearPoti::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletLinearPoti::THRESHOLD_OPTION_GREATER = '>'
BrickletLinearPoti#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.

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

linear_poti.register_callback BrickletLinearPoti::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.

BrickletLinearPoti::CALLBACK_POSITION
Callback-Parameter:
  • position – Typ: int, Wertebereich: [0 bis 100]

Dieser Callback wird mit der Periode, wie gesetzt mit #set_position_callback_period, ausgelöst. Der Parameter ist die Position des Linearpotentiometers.

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

BrickletLinearPoti::CALLBACK_ANALOG_VALUE
Callback-Parameter:
  • value – Typ: int, Wertebereich: [0 bis 4095]

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

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

BrickletLinearPoti::CALLBACK_POSITION_REACHED
Callback-Parameter:
  • position – Typ: int, Wertebereich: [0 bis 100]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von #set_position_callback_threshold gesetzt, erreicht wird. Der Parameter ist die Position des Linearpotentiometers.

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

BrickletLinearPoti::CALLBACK_ANALOG_VALUE_REACHED
Callback-Parameter:
  • value – Typ: int, Wertebereich: [0 bis 4095]

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

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.

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

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

  • BrickletLinearPoti::FUNCTION_SET_POSITION_CALLBACK_PERIOD = 3
  • BrickletLinearPoti::FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BrickletLinearPoti::FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 7
  • BrickletLinearPoti::FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BrickletLinearPoti::FUNCTION_SET_DEBOUNCE_PERIOD = 11
BrickletLinearPoti#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:

  • BrickletLinearPoti::FUNCTION_SET_POSITION_CALLBACK_PERIOD = 3
  • BrickletLinearPoti::FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BrickletLinearPoti::FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 7
  • BrickletLinearPoti::FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BrickletLinearPoti::FUNCTION_SET_DEBOUNCE_PERIOD = 11
BrickletLinearPoti#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

BrickletLinearPoti::DEVICE_IDENTIFIER

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

BrickletLinearPoti::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Linear Poti Bricklet dar.