Software / API Bindings / Ruby / API Referenz und Beispiele / Bricklets (Abgekündigt) / Ambient Light Bricklet

Ruby - Ambient Light Bricklet¶

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

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_ambient_light'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Ambient Light Bricklet

ipcon = IPConnection.new # Create IP connection
al = BrickletAmbientLight.new UID, ipcon # Create device object

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

# Get current illuminance
illuminance = al.get_illuminance
puts "Illuminance: #{illuminance/10.0} lx"

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

Callback¶

Download (example_callback.rb)

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_ambient_light'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Ambient Light Bricklet

ipcon = IPConnection.new # Create IP connection
al = BrickletAmbientLight.new UID, ipcon # Create device object

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

# Register illuminance callback
al.register_callback(BrickletAmbientLight::CALLBACK_ILLUMINANCE) do |illuminance|
  puts "Illuminance: #{illuminance/10.0} lx"
end

# Set period for illuminance callback to 1s (1000ms)
# Note: The illuminance callback is only called every second
#       if the illuminance has changed since the last call!
al.set_illuminance_callback_period 1000

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

Threshold¶

Download (example_threshold.rb)

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_ambient_light'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Ambient Light Bricklet

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

# Register illuminance reached callback
al.register_callback(BrickletAmbientLight::CALLBACK_ILLUMINANCE_REACHED) do |illuminance|
  puts "Illuminance: #{illuminance/10.0} lx"
  puts 'Too bright, close the curtains!'
end

# Configure threshold for illuminance "greater than 200 lx"
al.set_illuminance_callback_threshold '>', 200*10, 0

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

API¶

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

BrickletAmbientLight::new(uid, ipcon) → ambient_light¶

Parameter:	uid – Typ: str ipcon – Typ: IPConnection
Rückgabe:	ambient_light – Typ: BrickletAmbientLight

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

ambient_light = BrickletAmbientLight.new 'YOUR_DEVICE_UID', ipcon

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

BrickletAmbientLight#get_illuminance → int¶

Rückgabe:	illuminance – Typ: int, Einheit: 1/10 lx, Wertebereich: [0 bis 9000]

Gibt die Beleuchtungsstärke des Umgebungslichtsensors zurück.

Wenn die Beleuchtungsstärke periodisch abgefragt werden soll, wird empfohlen den ::CALLBACK_ILLUMINANCE Callback zu nutzen und die Periode mit #set_illuminance_callback_period vorzugeben.

Fortgeschrittene Funktionen¶

BrickletAmbientLight#get_analog_value → int¶

Rückgabe:	value – Typ: int, Wertebereich: [0 bis 2¹² - 1]

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

Bemerkung

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

Weiterhin deckt der Analog-Digital-Wandler drei unterschiedliche Bereiche ab, welche dynamisch gewechselt werden abhängig von der Lichtintensität. Es ist nicht möglich, anhand der Analogwerte, zwischen diesen Bereichen zu unterscheiden.

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.

BrickletAmbientLight#get_identity → [str, str, chr, [int, ...], [int, ...], int]¶

Rückgabe-Array:

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 2¹⁶ - 1]

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 2¹⁶ - 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¶

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

BrickletAmbientLight#set_illuminance_callback_period(period) → nil¶

Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

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.

BrickletAmbientLight#get_illuminance_callback_period → int¶

Rückgabe:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

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

BrickletAmbientLight#set_analog_value_callback_period(period) → nil¶

Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 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.

BrickletAmbientLight#get_analog_value_callback_period → int¶

Rückgabe:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

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

BrickletAmbientLight#set_illuminance_callback_threshold(option, min, max) → nil¶

Parameter:	option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1/10 lx, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max – Typ: int, Einheit: 1/10 lx, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0

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

Die folgenden Optionen sind möglich:

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

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

Für option:

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

BrickletAmbientLight#get_illuminance_callback_threshold → [chr, int, int]¶

Rückgabe-Array:	0: option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x' 1: min – Typ: int, Einheit: 1/10 lx, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 2: max – Typ: int, Einheit: 1/10 lx, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0

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

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

Für option:

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

BrickletAmbientLight#set_analog_value_callback_threshold(option, min, max) → nil¶

Parameter:	option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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 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:

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

BrickletAmbientLight#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 2¹⁶ - 1], Standardwert: 0 2: max – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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:

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

BrickletAmbientLight#set_debounce_period(debounce) → nil¶

Parameter:	debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callbacks

::CALLBACK_ILLUMINANCE_REACHED,
::CALLBACK_ANALOG_VALUE_REACHED

ausgelöst werden, wenn die Schwellwerte

#set_illuminance_callback_threshold,
#set_analog_value_callback_threshold

weiterhin erreicht bleiben.

BrickletAmbientLight#get_debounce_period → int¶

Rückgabe:	debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 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:

ambient_light.register_callback BrickletAmbientLight::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.

BrickletAmbientLight::CALLBACK_ILLUMINANCE¶

Callback-Parameter:	illuminance – Typ: int, Einheit: 1/10 lx, Wertebereich: [0 bis 9000]

Dieser Callback wird mit der Periode, wie gesetzt mit #set_illuminance_callback_period, ausgelöst. Der Parameter ist die Beleuchtungsstärke des Umgebungslichtsensors.

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

BrickletAmbientLight::CALLBACK_ANALOG_VALUE¶

Callback-Parameter:	value – Typ: int, Wertebereich: [0 bis 2¹² - 1]

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

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

BrickletAmbientLight::CALLBACK_ILLUMINANCE_REACHED¶

Callback-Parameter:	illuminance – Typ: int, Einheit: 1/10 lx, Wertebereich: [0 bis 9000]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von #set_illuminance_callback_threshold gesetzt, erreicht wird. Der Parameter ist die Beleuchtungsstärke des Umgebungslichtsensors.

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

BrickletAmbientLight::CALLBACK_ANALOG_VALUE_REACHED¶

Callback-Parameter:	value – Typ: int, Wertebereich: [0 bis 2¹² - 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 Umgebungslichtsensors.

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.

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

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

BrickletAmbientLight::FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 3
BrickletAmbientLight::FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
BrickletAmbientLight::FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 7
BrickletAmbientLight::FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
BrickletAmbientLight::FUNCTION_SET_DEBOUNCE_PERIOD = 11

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

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

Für function_id:

BrickletAmbientLight::FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 3
BrickletAmbientLight::FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
BrickletAmbientLight::FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 7
BrickletAmbientLight::FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
BrickletAmbientLight::FUNCTION_SET_DEBOUNCE_PERIOD = 11

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

BrickletAmbientLight::DEVICE_IDENTIFIER¶

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

BrickletAmbientLight::DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Ambient Light Bricklet dar.