Ruby - Color Bricklet 2.0

Dies ist die Beschreibung der Ruby API Bindings für das Color Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Color 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
26
27
28
29
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_color_v2'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
c = BrickletColorV2.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

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

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_color_v2'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
c = BrickletColorV2.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(BrickletColorV2::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 0.1s (100ms)
c.set_color_callback_configuration 100, false

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

API

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

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

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

color_v2 = BrickletColorV2.new 'YOUR_DEVICE_UID', ipcon

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

BrickletColorV2#get_color → [int, int, int, int]
Rückgabe-Array:
  • 0: r – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 1: g – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 2: b – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 3: c – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die gemessene Farbe des Sensors zurück.

Die rot (r), grün (g), blau (b) und clear (c) Farbanteile werden mit vier unterschiedlichen Fotodioden gemessen. Diese sind Empfindlich in unterschiedlichen Wellenlängen:

Chart Responsivity / Wavelength

Wenn die Farbe periodisch abgefragt werden soll, wird empfohlen den ::CALLBACK_COLOR Callback zu nutzen und die Periode mit #set_color_callback_configuration vorzugeben.

BrickletColorV2#get_illuminance → int
Rückgabe:
  • illuminance – Typ: int, Einheit: ? lx, Wertebereich: [0 bis 103438]

Gibt die Beleuchtungsstärke beeinflusst durch die Verstärkung und die Integrationszeit zurück. Verstärkung und Integrationszeit können mit #set_configuration 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_configuration reduziert werden.

Wenn der Wert periodisch benötigt wird, kann auch der ::CALLBACK_ILLUMINANCE Callback verwendet werden. Der Callback wird mit der Funktion #set_illuminance_callback_configuration konfiguriert.

BrickletColorV2#get_color_temperature → int
Rückgabe:
  • color_temperature – Typ: int, Einheit: 1 K, Wertebereich: [0 bis 216 - 1]

Gibt die Farbtemperatur zurück.

Für eine korrekte Messung der Farbtemperatur 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_configuration reduziert werden.

Wenn der Wert periodisch benötigt wird, kann auch der ::CALLBACK_COLOR_TEMPERATURE Callback verwendet werden. Der Callback wird mit der Funktion #set_color_temperature_callback_configuration konfiguriert.

BrickletColorV2#set_light(enable) → nil
Parameter:
  • enable – Typ: bool, Standardwert: false

Aktiviert/deaktiviert die weiße LED auf dem Bricklet.

BrickletColorV2#get_light → bool
Rückgabe:
  • enable – Typ: bool, Standardwert: false

Gibt den Wert zurück, wie von #set_light gesetzt.

BrickletColorV2#set_configuration(gain, integration_time) → nil
Parameter:
  • gain – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
  • integration_time – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Konfiguration des Sensors. Verstärkung und Integrationszeit können eingestellt werden.

Für die Konfiguration der Verstärkung:

  • 0: 1x Gain
  • 1: 4x Gain
  • 2: 16x Gain
  • 3: 60x Gain

Für die Konfiguration der Integrationszeit:

  • 0: 2,4ms
  • 1: 24ms
  • 2: 101ms
  • 3: 154ms
  • 4: 700ms

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:

  • BrickletColorV2::GAIN_1X = 0
  • BrickletColorV2::GAIN_4X = 1
  • BrickletColorV2::GAIN_16X = 2
  • BrickletColorV2::GAIN_60X = 3

Für integration_time:

  • BrickletColorV2::INTEGRATION_TIME_2MS = 0
  • BrickletColorV2::INTEGRATION_TIME_24MS = 1
  • BrickletColorV2::INTEGRATION_TIME_101MS = 2
  • BrickletColorV2::INTEGRATION_TIME_154MS = 3
  • BrickletColorV2::INTEGRATION_TIME_700MS = 4
BrickletColorV2#get_configuration → [int, int]
Rückgabe-Array:
  • 0: gain – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
  • 1: integration_time – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für gain:

  • BrickletColorV2::GAIN_1X = 0
  • BrickletColorV2::GAIN_4X = 1
  • BrickletColorV2::GAIN_16X = 2
  • BrickletColorV2::GAIN_60X = 3

Für integration_time:

  • BrickletColorV2::INTEGRATION_TIME_2MS = 0
  • BrickletColorV2::INTEGRATION_TIME_24MS = 1
  • BrickletColorV2::INTEGRATION_TIME_101MS = 2
  • BrickletColorV2::INTEGRATION_TIME_154MS = 3
  • BrickletColorV2::INTEGRATION_TIME_700MS = 4

Fortgeschrittene Funktionen

BrickletColorV2#get_spitfp_error_count → [int, int, int, int]
Rückgabe-Array:
  • 0: error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 1: error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 2: error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 3: error_count_overflow – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

BrickletColorV2#set_bootloader_mode(mode) → int
Parameter:
  • mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: int, Wertebereich: Siehe Konstanten

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Für mode:

  • BrickletColorV2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletColorV2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletColorV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletColorV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletColorV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • BrickletColorV2::BOOTLOADER_STATUS_OK = 0
  • BrickletColorV2::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletColorV2::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletColorV2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletColorV2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletColorV2::BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletColorV2#get_bootloader_mode → int
Rückgabe:
  • mode – Typ: int, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe #set_bootloader_mode.

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

Für mode:

  • BrickletColorV2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletColorV2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletColorV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletColorV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletColorV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletColorV2#set_write_firmware_pointer(pointer) → nil
Parameter:
  • pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für #write_firmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletColorV2#write_firmware(data) → int
Parameter:
  • data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von #set_write_firmware_pointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletColorV2#set_status_led_config(config) → nil
Parameter:
  • config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für config:

  • BrickletColorV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletColorV2::STATUS_LED_CONFIG_ON = 1
  • BrickletColorV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletColorV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletColorV2#get_status_led_config → int
Rückgabe:
  • config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

  • BrickletColorV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletColorV2::STATUS_LED_CONFIG_ON = 1
  • BrickletColorV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletColorV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletColorV2#get_chip_temperature → int
Rückgabe:
  • temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

BrickletColorV2#reset → nil

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

BrickletColorV2#write_uid(uid) → nil
Parameter:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

BrickletColorV2#read_uid → int
Rückgabe:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

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

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

BrickletColorV2#set_color_callback_configuration(period, value_has_to_change) → nil
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false

Die Periode ist die Periode mit der der ::CALLBACK_COLOR Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

BrickletColorV2#get_color_callback_configuration → [int, bool]
Rückgabe-Array:
  • 0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • 1: value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels #set_color_callback_configuration gesetzt.

BrickletColorV2#set_illuminance_callback_configuration(period, value_has_to_change, option, min, max) → nil
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: ? lx, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • max – Typ: int, Einheit: ? lx, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Die Periode ist die Periode mit der der ::CALLBACK_ILLUMINANCE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den ::CALLBACK_ILLUMINANCE Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

  • BrickletColorV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletColorV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletColorV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletColorV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletColorV2::THRESHOLD_OPTION_GREATER = '>'
BrickletColorV2#get_illuminance_callback_configuration → [int, bool, chr, int, int]
Rückgabe-Array:
  • 0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • 1: value_has_to_change – Typ: bool, Standardwert: false
  • 2: option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • 3: min – Typ: int, Einheit: ? lx, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • 4: max – Typ: int, Einheit: ? lx, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels #set_illuminance_callback_configuration gesetzt.

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

Für option:

  • BrickletColorV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletColorV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletColorV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletColorV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletColorV2::THRESHOLD_OPTION_GREATER = '>'
BrickletColorV2#set_color_temperature_callback_configuration(period, value_has_to_change, option, min, max) → nil
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1 K, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 K, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Die Periode ist die Periode mit der der ::CALLBACK_COLOR_TEMPERATURE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den ::CALLBACK_COLOR_TEMPERATURE Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

  • BrickletColorV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletColorV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletColorV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletColorV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletColorV2::THRESHOLD_OPTION_GREATER = '>'
BrickletColorV2#get_color_temperature_callback_configuration → [int, bool, chr, int, int]
Rückgabe-Array:
  • 0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • 1: value_has_to_change – Typ: bool, Standardwert: false
  • 2: option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • 3: min – Typ: int, Einheit: 1 K, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • 4: max – Typ: int, Einheit: 1 K, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels #set_color_temperature_callback_configuration gesetzt.

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

Für option:

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

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:

color_v2.register_callback BrickletColorV2::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.

BrickletColorV2::CALLBACK_COLOR
Callback-Parameter:
  • r – Typ: int, Wertebereich: [0 bis 216 - 1]
  • g – Typ: int, Wertebereich: [0 bis 216 - 1]
  • b – Typ: int, Wertebereich: [0 bis 216 - 1]
  • c – Typ: int, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit #set_color_callback_configuration, 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.

BrickletColorV2::CALLBACK_ILLUMINANCE
Callback-Parameter:
  • illuminance – Typ: int, Einheit: ? lx, Wertebereich: [0 bis 103438]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels #set_illuminance_callback_configuration gesetzten Konfiguration

Der Parameter ist der gleiche wie #get_illuminance.

BrickletColorV2::CALLBACK_COLOR_TEMPERATURE
Callback-Parameter:
  • color_temperature – Typ: int, Einheit: 1 K, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels #set_color_temperature_callback_configuration gesetzten Konfiguration

Der Parameter ist der gleiche wie #get_color_temperature.

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.

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

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

  • BrickletColorV2::FUNCTION_SET_COLOR_CALLBACK_CONFIGURATION = 2
  • BrickletColorV2::FUNCTION_SET_ILLUMINANCE_CALLBACK_CONFIGURATION = 6
  • BrickletColorV2::FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_CONFIGURATION = 10
  • BrickletColorV2::FUNCTION_SET_LIGHT = 13
  • BrickletColorV2::FUNCTION_SET_CONFIGURATION = 15
  • BrickletColorV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletColorV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletColorV2::FUNCTION_RESET = 243
  • BrickletColorV2::FUNCTION_WRITE_UID = 248
BrickletColorV2#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:

  • BrickletColorV2::FUNCTION_SET_COLOR_CALLBACK_CONFIGURATION = 2
  • BrickletColorV2::FUNCTION_SET_ILLUMINANCE_CALLBACK_CONFIGURATION = 6
  • BrickletColorV2::FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_CONFIGURATION = 10
  • BrickletColorV2::FUNCTION_SET_LIGHT = 13
  • BrickletColorV2::FUNCTION_SET_CONFIGURATION = 15
  • BrickletColorV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletColorV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletColorV2::FUNCTION_RESET = 243
  • BrickletColorV2::FUNCTION_WRITE_UID = 248
BrickletColorV2#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

BrickletColorV2::DEVICE_IDENTIFIER

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

BrickletColorV2::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Color Bricklet 2.0 dar.