Ruby - Ambient Light Bricklet 2.0

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

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
al = BrickletAmbientLightV2.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/100.0} lx"

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

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
al = BrickletAmbientLightV2.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(BrickletAmbientLightV2::CALLBACK_ILLUMINANCE) do |illuminance|
  puts "Illuminance: #{illuminance/100.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)

 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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_ambient_light_v2'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
al = BrickletAmbientLightV2.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(BrickletAmbientLightV2::CALLBACK_ILLUMINANCE_REACHED) do |illuminance|
  puts "Illuminance: #{illuminance/100.0} lx"
  puts 'Too bright, close the curtains!'
end

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

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

API

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

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

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

ambient_light_v2 = BrickletAmbientLightV2.new 'YOUR_DEVICE_UID', ipcon

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

BrickletAmbientLightV2#get_illuminance → int
Rückgabe:
  • illuminance – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die Beleuchtungsstärke des Umgebungslichtsensors zurück. Der Messbereich erstreckt sich bis über 100000Lux, aber ab 64000Lux nimmt die Messgenauigkeit ab. Die Beleuchtungsstärke ist in Lux/100 angegeben, d.h. bei einem Wert von 450000 wurde eine Beleuchtungsstärke von 4500Lux gemessen.

Geändert in Version 2.0.2 (Plugin): Eine Beleuchtungsstärke von 0Lux bedeutet, dass der Sensor gesättigt (saturated) ist und die Konfiguration angepasst werden sollte, siehe #set_configuration.

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

BrickletAmbientLightV2#set_configuration(illuminance_range, integration_time) → nil
Parameter:
  • illuminance_range – Typ: int, Wertebereich: Siehe Konstanten
  • integration_time – Typ: int, Wertebereich: Siehe Konstanten

Setzt die Konfiguration. Es ist möglich den Helligkeitswertebereich zwischen 0-600Lux und 0-64000Lux sowie eine Integrationszeit zwischen 50ms und 400ms zu konfigurieren.

Neu in Version 2.0.2 (Plugin): Der unbeschränkt (unlimited) Helligkeitswertebereich ermöglicht es bis über 100000Lux zu messen, aber ab 64000Lux nimmt die Messgenauigkeit ab.

Ein kleinerer Helligkeitswertebereich erhöht die Auflösung der Daten. Eine längere Integrationszeit verringert das Rauschen auf den Daten.

Geändert in Version 2.0.2 (Plugin): Wenn der eigentliche Messwert außerhalb des eingestellten Helligkeitswertebereichs liegt, dann geben #get_illuminance und der ::CALLBACK_ILLUMINANCE Callback das Maximum des eingestellten Helligkeitswertebereichs +0,01Lux zurück. Also z.B. 800001 für den 0-8000Lux Bereich.

Geändert in Version 2.0.2 (Plugin): Bei einer langen Integrationszeit kann es sein, dass der Sensor gesättigt (saturated) ist bevor der Messwert das Maximum des ausgewählten Helligkeitswertebereichs erreicht hat. In diesem Fall geben #get_illuminance und der ::CALLBACK_ILLUMINANCE Callback 0Lux zurück.

Wenn der Messwert außerhalb des eingestellten Helligkeitswertebereichs liegt oder der Sensor gesättigt ist, dann sollte der nächst höhere Helligkeitswertebereich eingestellt werden. Wenn der höchste Helligkeitswertebereich schon erreicht ist, dann kann noch die Integrationszeit verringert werden.

Die Standardwerte sind 0-8000Lux Helligkeitsbereich und 200ms Integrationszeit.

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

Für illuminance_range:

  • BrickletAmbientLightV2::ILLUMINANCE_RANGE_UNLIMITED = 6
  • BrickletAmbientLightV2::ILLUMINANCE_RANGE_64000LUX = 0
  • BrickletAmbientLightV2::ILLUMINANCE_RANGE_32000LUX = 1
  • BrickletAmbientLightV2::ILLUMINANCE_RANGE_16000LUX = 2
  • BrickletAmbientLightV2::ILLUMINANCE_RANGE_8000LUX = 3
  • BrickletAmbientLightV2::ILLUMINANCE_RANGE_1300LUX = 4
  • BrickletAmbientLightV2::ILLUMINANCE_RANGE_600LUX = 5

Für integration_time:

  • BrickletAmbientLightV2::INTEGRATION_TIME_50MS = 0
  • BrickletAmbientLightV2::INTEGRATION_TIME_100MS = 1
  • BrickletAmbientLightV2::INTEGRATION_TIME_150MS = 2
  • BrickletAmbientLightV2::INTEGRATION_TIME_200MS = 3
  • BrickletAmbientLightV2::INTEGRATION_TIME_250MS = 4
  • BrickletAmbientLightV2::INTEGRATION_TIME_300MS = 5
  • BrickletAmbientLightV2::INTEGRATION_TIME_350MS = 6
  • BrickletAmbientLightV2::INTEGRATION_TIME_400MS = 7
BrickletAmbientLightV2#get_configuration → [int, int]
Rückgabe-Array:
  • 0: illuminance_range – Typ: int, Wertebereich: Siehe Konstanten
  • 1: integration_time – Typ: int, Wertebereich: Siehe Konstanten

Gibt die Konfiguration zurück, wie von #set_configuration gesetzt.

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

Für illuminance_range:

  • BrickletAmbientLightV2::ILLUMINANCE_RANGE_UNLIMITED = 6
  • BrickletAmbientLightV2::ILLUMINANCE_RANGE_64000LUX = 0
  • BrickletAmbientLightV2::ILLUMINANCE_RANGE_32000LUX = 1
  • BrickletAmbientLightV2::ILLUMINANCE_RANGE_16000LUX = 2
  • BrickletAmbientLightV2::ILLUMINANCE_RANGE_8000LUX = 3
  • BrickletAmbientLightV2::ILLUMINANCE_RANGE_1300LUX = 4
  • BrickletAmbientLightV2::ILLUMINANCE_RANGE_600LUX = 5

Für integration_time:

  • BrickletAmbientLightV2::INTEGRATION_TIME_50MS = 0
  • BrickletAmbientLightV2::INTEGRATION_TIME_100MS = 1
  • BrickletAmbientLightV2::INTEGRATION_TIME_150MS = 2
  • BrickletAmbientLightV2::INTEGRATION_TIME_200MS = 3
  • BrickletAmbientLightV2::INTEGRATION_TIME_250MS = 4
  • BrickletAmbientLightV2::INTEGRATION_TIME_300MS = 5
  • BrickletAmbientLightV2::INTEGRATION_TIME_350MS = 6
  • BrickletAmbientLightV2::INTEGRATION_TIME_400MS = 7
BrickletAmbientLightV2#get_api_version → [int, ...]
Rückgabe:
  • api_version – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]

Gibt die Version der API Definition (Major, Minor, Revision) 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.

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

  • BrickletAmbientLightV2::FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 2
  • BrickletAmbientLightV2::FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 4
  • BrickletAmbientLightV2::FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletAmbientLightV2::FUNCTION_SET_CONFIGURATION = 8
BrickletAmbientLightV2#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:

  • BrickletAmbientLightV2::FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 2
  • BrickletAmbientLightV2::FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 4
  • BrickletAmbientLightV2::FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletAmbientLightV2::FUNCTION_SET_CONFIGURATION = 8
BrickletAmbientLightV2#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.

BrickletAmbientLightV2#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
  • 3: hardware_version – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]
  • 4: firmware_version – Typ: [int, ...], Länge: 3, 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 kann 'a', 'b', 'c' oder 'd' sein.

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

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

BrickletAmbientLightV2#set_illuminance_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_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.

BrickletAmbientLightV2#get_illuminance_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_illuminance_callback_period gesetzt.

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

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)

Der Standardwert ist ('x', 0, 0).

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

Für option:

  • BrickletAmbientLightV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletAmbientLightV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAmbientLightV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAmbientLightV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAmbientLightV2::THRESHOLD_OPTION_GREATER = '>'
BrickletAmbientLightV2#get_illuminance_callback_threshold → [chr, int, int]
Rückgabe-Array:
  • 0: option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • 1: min – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 2: max – Typ: int, Wertebereich: [0 bis 232 - 1]

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:

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

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

ambient_light_v2.register_callback BrickletAmbientLightV2::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.

BrickletAmbientLightV2::CALLBACK_ILLUMINANCE
Callback-Parameter:
  • illuminance – Typ: int, Wertebereich: [0 bis 232 - 1]

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.

BrickletAmbientLightV2::CALLBACK_ILLUMINANCE_REACHED
Callback-Parameter:
  • illuminance – Typ: int, Wertebereich: [0 bis 232 - 1]

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.

Konstanten

BrickletAmbientLightV2::DEVICE_IDENTIFIER

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

BrickletAmbientLightV2::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Ambient Light Bricklet 2.0 dar.