Dies ist die Beschreibung der Ruby API Bindings für das Color Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Color 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 26 27 28 29 | #!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-
require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_color'
include Tinkerforge
HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Color Bricklet
ipcon = IPConnection.new # Create IP connection
c = BrickletColor.new UID, ipcon # Create device object
ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected
# Get current color as [r, g, b, c]
color = c.get_color
puts "Color [R]: #{color[0]}"
puts "Color [G]: #{color[1]}"
puts "Color [B]: #{color[2]}"
puts "Color [C]: #{color[3]}"
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 32 33 34 35 | #!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-
require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_color'
include Tinkerforge
HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Color Bricklet
ipcon = IPConnection.new # Create IP connection
c = BrickletColor.new UID, ipcon # Create device object
ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected
# Register color callback
c.register_callback(BrickletColor::CALLBACK_COLOR) do |r, g, b, c_|
puts "Color [R]: #{r}"
puts "Color [G]: #{g}"
puts "Color [B]: #{b}"
puts "Color [C]: #{c_}"
puts ''
end
# Set period for color callback to 1s (1000ms)
# Note: The color callback is only called every second
# if the color has changed since the last call!
c.set_color_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 33 34 35 36 | #!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-
require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_color'
include Tinkerforge
HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Color Bricklet
ipcon = IPConnection.new # Create IP connection
c = BrickletColor.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)
c.set_debounce_period 10000
# Register color reached callback
c.register_callback(BrickletColor::CALLBACK_COLOR_REACHED) do |r, g, b, c_|
puts "Color [R]: #{r}"
puts "Color [G]: #{g}"
puts "Color [B]: #{b}"
puts "Color [C]: #{c_}"
puts ''
end
# Configure threshold for color "greater than 100, 200, 300, 400"
c.set_color_callback_threshold '>', 100, 0, 200, 0, 300, 0, 400, 0
puts 'Press key to exit'
$stdin.gets
ipcon.disconnect
|
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
BrickletColor
::
new
(uid, ipcon) → color¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
color = BrickletColor.new 'YOUR_DEVICE_UID', ipcon
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletColor
#
get_color
→ [int, int, int, int]¶Rückgabe-Array: |
|
---|
Gibt die gemessene Farbe des Sensors zurück.
Die rot (r), grün (g), blau (b) und clear (c) werden mit vier unterschiedlichen Fotodioden gemessen. Diese sind Empfindlich in unterschiedlichen Wellenlängen:
Wenn die Farbe periodisch abgefragt werden soll, wird empfohlen
den ::CALLBACK_COLOR
Callback zu nutzen und die Periode mit
#set_color_callback_period
vorzugeben.
BrickletColor
#
light_on
→ nil¶Aktiviert die LED.
BrickletColor
#
light_off
→ nil¶Deaktiviert die LED.
BrickletColor
#
is_light_on
→ int¶Rückgabe: |
|
---|
Gibt den Zustand der LED zurück. Mögliche Werte sind:
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für light:
BrickletColor
#
set_config
(gain, integration_time) → nil¶Parameter: |
|
---|
Setzt die Konfiguration des Sensors. Verstärkung und Integrationszeit können eingestellt werden.
Für die Konfiguration der Verstärkung:
Für die Konfiguration der Integrationszeit:
Eine Erhöhung der Verstärkung ermöglicht es dem Sensor Farben aus größeren Entfernungen zu erkennen.
Die Integrationszeit ist ein Trade-off zwischen Konvertierungszeit und Genauigkeit. Mit einer höheren Integrationszeit werden die Werte genauer, es dauert allerdings länger bis ein Resultat bereitsteht.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für gain:
Für integration_time:
BrickletColor
#
get_config
→ [int, int]¶Rückgabe-Array: |
|
---|
Gibt die Einstellungen zurück, wie von #set_config
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für gain:
Für integration_time:
BrickletColor
#
get_illuminance
→ int¶Rückgabe: |
|
---|
Gibt die Beleuchtungsstärke beeinflusst durch die Verstärkung und die
Integrationszeit zurück. Verstärkung und Integrationszeit können mit
#set_config
eingestellt werden. Um die Beleuchtungsstärke in Lux zu
ermitteln muss folgende Formel angewendet werden:
lux = illuminance * 700 / gain / integration_time
Für eine korrekte Messung der Beleuchtungsstärke muss sichergestellt
sein, dass die Farbwerte (R, G oder B) nicht saturiert sind. Ein
Farbwert ist saturiert wenn der Wert 65535 beträgt. In diesem Fall
kann die Verstärkung per #set_config
reduziert werden.
BrickletColor
#
get_color_temperature
→ int¶Rückgabe: |
|
---|
Gibt die Farbtemperatur zurück.
Für eine korrekte Messung der Farbtemperatur muss sichergestellt
sein das die Farbwerte (R, G oder B) nicht saturiert sind. Ein
Farbwert ist saturiert wenn der Wert 65535 beträgt. In diesem Fall
kann die Verstärkung per #set_config
reduziert werden.
BrickletColor
#
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.
BrickletColor
#
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.
BrickletColor
#
set_color_callback_period
(period) → nil¶Parameter: |
|
---|
Setzt die Periode mit welcher der ::CALLBACK_COLOR
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der ::CALLBACK_COLOR
Callback wird nur ausgelöst, wenn sich die Color seit der
letzten Auslösung geändert hat.
BrickletColor
#
get_color_callback_period
→ int¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von #set_color_callback_period
gesetzt.
BrickletColor
#
set_color_callback_threshold
(option, min_r, max_r, min_g, max_g, min_b, max_b, min_c, max_c) → nil¶Parameter: |
|
---|
Setzt den Schwellwert für den ::CALLBACK_COLOR_REACHED
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn die Temperatur außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn die Temperatur innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn die Temperatur kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Temperatur größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletColor
#
get_color_callback_threshold
→ [chr, int, int, int, int, int, int, int, int]¶Rückgabe-Array: |
|
---|
Gibt den Schwellwert zurück, wie von #set_color_callback_threshold
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletColor
#
set_debounce_period
(debounce) → nil¶Parameter: |
|
---|
Setzt die Periode mit welcher die Schwellwert Callback
ausgelöst wird, wenn der Schwellwert
weiterhin erreicht bleibt.
BrickletColor
#
get_debounce_period
→ int¶Rückgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von #set_debounce_period
gesetzt.
BrickletColor
#
set_illuminance_callback_period
(period) → nil¶Parameter: |
|
---|
Setzt die Periode mit welcher der ::CALLBACK_ILLUMINANCE
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
Der ::CALLBACK_ILLUMINANCE
Callback wird nur ausgelöst, wenn sich die
Beleuchtungsstärke seit der letzten Auslösung geändert hat.
BrickletColor
#
get_illuminance_callback_period
→ int¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von #set_illuminance_callback_period
gesetzt.
BrickletColor
#
set_color_temperature_callback_period
(period) → nil¶Parameter: |
|
---|
Setzt die Periode mit welcher der ::CALLBACK_COLOR_TEMPERATURE
Callback
ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.
Der ::CALLBACK_COLOR_TEMPERATURE
Callback wird nur ausgelöst, wenn sich die
Farbtemperatur seit der letzten Auslösung geändert hat.
BrickletColor
#
get_color_temperature_callback_period
→ int¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von #set_color_temperature_callback_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:
color.register_callback BrickletColor::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.
BrickletColor
::
CALLBACK_COLOR
¶Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit #set_color_callback_period
,
ausgelöst. Der Parameter ist die Farbe des Sensors als RGBC.
Der ::CALLBACK_COLOR
Callback wird nur ausgelöst, wenn sich die Farbe seit der
letzten Auslösung geändert hat.
BrickletColor
::
CALLBACK_COLOR_REACHED
¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
#set_color_callback_threshold
gesetzt, erreicht wird.
Der Parameter ist die Farbe des Sensors als RGBC.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit #set_debounce_period
gesetzt, ausgelöst.
BrickletColor
::
CALLBACK_ILLUMINANCE
¶Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit #set_illuminance_callback_period
,
ausgelöst. Der Parameter ist die Beleuchtungsstärke des Sensors.
Siehe #get_illuminance
für eine Erklärung wie dieser zu interpretieren ist.
Der ::CALLBACK_ILLUMINANCE
Callback wird nur ausgelöst, wenn sich die
Beleuchtungsstärke seit der letzten Auslösung geändert hat.
BrickletColor
::
CALLBACK_COLOR_TEMPERATURE
¶Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
#set_color_temperature_callback_period
, ausgelöst. Der Parameter
ist die Farbtemperatur des Sensors.
Der ::CALLBACK_COLOR_TEMPERATURE
Callback wird nur ausgelöst, wenn sich die
Farbtemperatur seit der letzten Auslösung geändert hat.
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.
BrickletColor
#
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.
BrickletColor
#
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:
BrickletColor
#
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:
BrickletColor
#
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.
BrickletColor
::
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Color 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.
BrickletColor
::
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Color Bricklet dar.