Software / API Bindings / Ruby / API Referenz und Beispiele / Bricklets (Abgekündigt) / LED Strip Bricklet

Ruby - LED Strip Bricklet¶

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

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your LED Strip Bricklet

ipcon = IPConnection.new # Create IP connection
ls = BrickletLEDStrip.new UID, ipcon # Create device object

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

# Set first 10 LEDs to green
ls.set_rgb_values 0, 10, [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], \
                  [255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 0, 0, 0, 0, 0, 0], \
                  [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]

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

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your LED Strip Bricklet
NUM_LEDS = 16

r = [0]*NUM_LEDS
g = [0]*NUM_LEDS
b = [0]*NUM_LEDS
r_index = 0

ipcon = IPConnection.new # Create IP connection
ls = BrickletLEDStrip.new UID, ipcon # Create device object

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

# Set frame duration to 50ms (20 frames per second)
ls.set_frame_duration 50

# Use frame rendered callback to move the active LED every frame
ls.register_callback(BrickletLEDStrip::CALLBACK_FRAME_RENDERED) do |length|
  b[r_index] = 0
  if(r_index == NUM_LEDS-1)
    r_index = 0
  else
    r_index += 1
  end
  b[r_index] = 255

  # Set new data for next render cycle
  ls.set_rgb_values 0, NUM_LEDS, r, g, b
end

# Set initial rgb values to get started
ls.set_rgb_values(0, NUM_LEDS, r, g, b)

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

API¶

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

BrickletLEDStrip::new(uid, ipcon) → led_strip¶

Parameter:	uid – Typ: str ipcon – Typ: IPConnection
Rückgabe:	led_strip – Typ: BrickletLEDStrip

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

led_strip = BrickletLEDStrip.new 'YOUR_DEVICE_UID', ipcon

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

BrickletLEDStrip#set_rgb_values(index, length, r, g, b) → nil¶

Parameter:	index – Typ: int, Wertebereich: [0 bis 319] length – Typ: int, Wertebereich: [0 bis 16] r – Typ: [int, ...], Länge: 16, Wertebereich: [0 bis 255] g – Typ: [int, ...], Länge: 16, Wertebereich: [0 bis 255] b – Typ: [int, ...], Länge: 16, Wertebereich: [0 bis 255]

Setzt length RGB Werte für die LEDs, beginnend vom angegebenen index.

Damit die Farben richtig angezeigt werden muss den LEDs entsprechend der richtig Chip Type (#set_chip_type) und das richtige 3-Kanal Channel Mapping (#set_channel_mapping) eingestellt werden.

Beispiel: Wenn

index auf 5,
length auf 3,
r auf [255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
g auf [0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0] und
b auf [0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]

gesetzt wird, wird die LED an Index 5 die Farbe Rot annehmen, 6 wird Grün und 7 wird Blau.

Bemerkung

Abhängig von der internen LED Schaltung können die Farben vertauscht sein.

Die Farben werden auf die tatsächlichen LEDs transferiert wenn die nächste frame duration abgelaufen ist, siehe #set_frame_duration.

Genereller Ansatz:

Setze frame duration auf einen Wert welcher der Anzahl der Bilder pro Sekunde entspricht die erreicht werden sollen.
Setze alle LEDs für einen Frame.
Warte auf ::CALLBACK_FRAME_RENDERED Callback.
Setze alle LEDs für den nächsten Frame.
Warte auf ::CALLBACK_FRAME_RENDERED Callback.
Und so weiter.

Dieser Ansatz garantiert, dass die LED Farben mit einer festen Framerate angezeigt werden.

Die effektive Anzahl steuerbarer LEDs ist abhängig von der Anzahl der freien Bricklet Ports (siehe hier). Ein Aufruf von #set_rgb_values mit index + length größer als die Begrenzung werden komplett ingnoriert.

BrickletLEDStrip#get_rgb_values(index, length) → [[int, ...], [int, ...], [int, ...]]¶

Parameter:	index – Typ: int, Wertebereich: [0 bis 319] length – Typ: int, Wertebereich: [0 bis 16]
Rückgabe-Array:	0: r – Typ: [int, ...], Länge: 16, Wertebereich: [0 bis 255] 1: g – Typ: [int, ...], Länge: 16, Wertebereich: [0 bis 255] 2: b – Typ: [int, ...], Länge: 16, Wertebereich: [0 bis 255]

Gibt length R, G und B Werte zurück, beginnend von der übergebenen LED index.

Die Werte sind die letzten von #set_rgb_values gesetzten Werte.

BrickletLEDStrip#set_frame_duration(duration) → nil¶

Parameter:	duration – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 100

Setzt die frame duration (Länge des Frames).

Beispiel: Wenn 20 Frames pro Sekunde erreicht werden sollen, muss die Länge des Frames auf 50ms gesetzt werden (50ms * 20 = 1 Sekunde).

Für eine Erklärung des generellen Ansatzes siehe #set_rgb_values.

BrickletLEDStrip#get_frame_duration → int¶

Rückgabe:	duration – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 100

Gibt die frame duration (Länge des Frames) zurück, wie von #set_frame_duration gesetzt.

BrickletLEDStrip#get_supply_voltage → int¶

Rückgabe:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt die aktuelle Versorgungsspannung der LEDs zurück.

BrickletLEDStrip#set_clock_frequency(frequency) → nil¶

Parameter:	frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [10000 bis 2000000], Standardwert: 1666666

Setzt die Frequenz der Clock-Leitung. Der erlaubte Wertebereich beläuft von sich 10000Hz (10kHz) bis 2000000Hz (2MHz).

Das Bricklet wählt die nächst mögliche erreichbare Frequenz. Diese kann ein paar Hz neben des gesetzten Wertes liegen. Die exakte Frequenz wie sie genutzt wird kann mit #get_clock_frequency erfragt werden.

Wenn Probleme mit flackernden LEDs auftreten kann es daran liegen das Bits auf der Leitung flippen. Dies kann behoben werden in dem man die Verbindung zwischen Bricklet und LEDs verringert oder in dem man die Frequenz reduziert.

Mit abnehmender Frequenz nimmt allerdings auch die maximale Framerate ab.

Bemerkung

Die Frequenz in Firmware Version 2.0.0 ist fest auf 2MHz gesetzt.

Neu in Version 2.0.1 (Plugin).

BrickletLEDStrip#get_clock_frequency → int¶

Rückgabe:	frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [10000 bis 2000000], Standardwert: 1666666

Gibt die aktuell genutzte Clock-Frequenz zurück, wie von #set_clock_frequency gesetzt.

Neu in Version 2.0.1 (Plugin).

BrickletLEDStrip#set_chip_type(chip) → nil¶

Parameter:	chip – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 2801

Setzt den Typ des LED-Treiber-Chips. Aktuell unterstützen wir die folgenden Chips

WS2801,
WS2811,
WS2812 / SK6812 / NeoPixel RGB,
SK6812RGBW / NeoPixel RGBW (Chip Type = WS2812),
LPD8806 and
APA102 / DotStar.

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

Für chip:

BrickletLEDStrip::CHIP_TYPE_WS2801 = 2801
BrickletLEDStrip::CHIP_TYPE_WS2811 = 2811
BrickletLEDStrip::CHIP_TYPE_WS2812 = 2812
BrickletLEDStrip::CHIP_TYPE_LPD8806 = 8806
BrickletLEDStrip::CHIP_TYPE_APA102 = 102

Neu in Version 2.0.2 (Plugin).

BrickletLEDStrip#get_chip_type → int¶

Rückgabe:	chip – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 2801

Gibt den aktuell genutzten Typ des Chips zurück, wie von #set_chip_type gesetzt.

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

Für chip:

BrickletLEDStrip::CHIP_TYPE_WS2801 = 2801
BrickletLEDStrip::CHIP_TYPE_WS2811 = 2811
BrickletLEDStrip::CHIP_TYPE_WS2812 = 2812
BrickletLEDStrip::CHIP_TYPE_LPD8806 = 8806
BrickletLEDStrip::CHIP_TYPE_APA102 = 102

Neu in Version 2.0.2 (Plugin).

BrickletLEDStrip#set_rgbw_values(index, length, r, g, b, w) → nil¶

Parameter:	index – Typ: int, Wertebereich: [0 bis 239] length – Typ: int, Wertebereich: [0 bis 12] r – Typ: [int, ...], Länge: 12, Wertebereich: [0 bis 255] g – Typ: [int, ...], Länge: 12, Wertebereich: [0 bis 255] b – Typ: [int, ...], Länge: 12, Wertebereich: [0 bis 255] w – Typ: [int, ...], Länge: 12, Wertebereich: [0 bis 255]

Setzt length RGBW Werte für die LEDs beginnend vom angegebenen index.

Damit die Farben richtig angezeigt werden muss den LEDs der entsprechende Chip Type (#set_chip_type) und das richtige 4-Kanal Channel Mapping (#set_channel_mapping) eingestellt werden.

Beispiel: Wenn

index auf 5,
length auf 4,
r auf [255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
g auf [0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
b auf [0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0] und
w auf [0, 0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0]

gesetzt wird, wird die LED an Index 5 die Farbe Rot annehmen, 6 wird Grün, 7 wird Blau und 8 wird Weiß.

Bemerkung

Abhängig von der internen LED Schaltung können die Farben vertauscht sein.

Die Farben werden auf die tatsächlichen LEDs transferiert wenn die nächste frame duration abgelaufen ist, siehe #set_frame_duration.

Genereller Ansatz:

Setze frame duration auf einen Wert welcher der Anzahl der Bilder pro Sekunde entspricht die erreicht werden sollen.
Setze alle LEDs für einen Frame.
Warte auf ::CALLBACK_FRAME_RENDERED Callback.
Setze alle LEDs für den nächsten Frame.
Warte auf ::CALLBACK_FRAME_RENDERED Callback.
Und so weiter.

Dieser Ansatz garantiert das die LED Farben mit einer festen Framerate angezeigt werden.

Die effektive Anzahl steuerbarer LEDs ist abhängig von der Anzahl der freien Bricklet Ports (siehe hier). Ein Aufruf von #set_rgbw_values mit index + length größer als die Begrenzung werden komplett ignoriert.

Die LPD8806 LED-Treiber-Chips haben 7-Bit Kanäle für RGB. Intern teilt das LED Strip Bricklet die 8-Bit Werte die mit dieser Funktion gesetzt werden durch 2, um daraus 7-Bit Werte zu machen. Daher kann der normale Wertebereich (0-255) auch für LPD8806 LEDs verwendet werden.

Der Helligkeitskanal der APA102 LED-Treiber-Chips hat 5-Bit. Intern teilt das LED Strip Bricklet die 8-Bit Werte die mit dieser Funktion gesetzt werden durch 8, um daraus 5-Bit Werte zu machen. Daher kann der normale Wertebereich (0-255) auch für den Helligkeitskanal von APA102 LEDs verwendet werden.

Neu in Version 2.0.6 (Plugin).

BrickletLEDStrip#get_rgbw_values(index, length) → [[int, ...], [int, ...], [int, ...], [int, ...]]¶

Parameter:	index – Typ: int, Wertebereich: [0 bis 239] length – Typ: int, Wertebereich: [0 bis 12]
Rückgabe-Array:	0: r – Typ: [int, ...], Länge: 12, Wertebereich: [0 bis 255] 1: g – Typ: [int, ...], Länge: 12, Wertebereich: [0 bis 255] 2: b – Typ: [int, ...], Länge: 12, Wertebereich: [0 bis 255] 3: w – Typ: [int, ...], Länge: 12, Wertebereich: [0 bis 255]

Gibt length RGBW Werte zurück, beginnend vom übergebenen index.

Die Werte sind die letzten von #set_rgbw_values gesetzten Werte.

Neu in Version 2.0.6 (Plugin).

BrickletLEDStrip#set_channel_mapping(mapping) → nil¶

Parameter:	mapping – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 36

Setzt das Channel Mapping für die angeschlossenene LEDs.

#set_rgb_values und #set_rgbw_values nehmen die Daten in RGB(W) Reihenfolge entgegen. Aber die angeschlossenen LED-Treiber-Chips erwarten die Daten für ihre 3 oder 4 Kanäle in einer anderen Reihenfolge. Zum Beispiel verwenden WS2801 Chips typischerweise BGR Reihenfolge, WS2812 Chips verwenden typischerweise GRB Reihenfolge und APA102 verwenden typischerweise WBGR Reihenfolge.

Die APA102 haben eine Besonderheit. Sie haben drei 8-Bit Kanäle für RGB und einen zusätzlichen 5-Bit Kanal für die Helligkeit der RGB LED. Dadurch ist der APA102 insgesamt ein 4-Kanal Chip. Intern ist der Helligkeitskanal der erste Kanal. Daher sollte eines der Wxyz Channel Mappings verwendet werden. Dann kann über den W Kanal die Helligkeit eingestellt werden.

Wenn ein 3-Kanal Mapping ausgewählt wurde, dann muss auch #set_rgb_values für das setzen der Farben verwendet werden. #set_rgbw_values zusammen mit einem 3-Kanal Mapping führt zu falscher Darstellung der Farben. Im Gegenzug muss bei einem 4-Kanal Mapping #set_rgbw_values für das setzen der Farben verwendet werden. #set_rgb_values zusammen mit einem 4-Kanal Mapping führt zu falscher Darstellung der Farben.

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

Für mapping:

BrickletLEDStrip::CHANNEL_MAPPING_RGB = 6
BrickletLEDStrip::CHANNEL_MAPPING_RBG = 9
BrickletLEDStrip::CHANNEL_MAPPING_BRG = 33
BrickletLEDStrip::CHANNEL_MAPPING_BGR = 36
BrickletLEDStrip::CHANNEL_MAPPING_GRB = 18
BrickletLEDStrip::CHANNEL_MAPPING_GBR = 24
BrickletLEDStrip::CHANNEL_MAPPING_RGBW = 27
BrickletLEDStrip::CHANNEL_MAPPING_RGWB = 30
BrickletLEDStrip::CHANNEL_MAPPING_RBGW = 39
BrickletLEDStrip::CHANNEL_MAPPING_RBWG = 45
BrickletLEDStrip::CHANNEL_MAPPING_RWGB = 54
BrickletLEDStrip::CHANNEL_MAPPING_RWBG = 57
BrickletLEDStrip::CHANNEL_MAPPING_GRWB = 78
BrickletLEDStrip::CHANNEL_MAPPING_GRBW = 75
BrickletLEDStrip::CHANNEL_MAPPING_GBWR = 108
BrickletLEDStrip::CHANNEL_MAPPING_GBRW = 99
BrickletLEDStrip::CHANNEL_MAPPING_GWBR = 120
BrickletLEDStrip::CHANNEL_MAPPING_GWRB = 114
BrickletLEDStrip::CHANNEL_MAPPING_BRGW = 135
BrickletLEDStrip::CHANNEL_MAPPING_BRWG = 141
BrickletLEDStrip::CHANNEL_MAPPING_BGRW = 147
BrickletLEDStrip::CHANNEL_MAPPING_BGWR = 156
BrickletLEDStrip::CHANNEL_MAPPING_BWRG = 177
BrickletLEDStrip::CHANNEL_MAPPING_BWGR = 180
BrickletLEDStrip::CHANNEL_MAPPING_WRBG = 201
BrickletLEDStrip::CHANNEL_MAPPING_WRGB = 198
BrickletLEDStrip::CHANNEL_MAPPING_WGBR = 216
BrickletLEDStrip::CHANNEL_MAPPING_WGRB = 210
BrickletLEDStrip::CHANNEL_MAPPING_WBGR = 228
BrickletLEDStrip::CHANNEL_MAPPING_WBRG = 225

Neu in Version 2.0.6 (Plugin).

BrickletLEDStrip#get_channel_mapping → int¶

Rückgabe:	mapping – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 36

Gibt die aktuell genutzten Channel Mapping zurück, wie von #set_channel_mapping gesetzt.

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

Für mapping:

BrickletLEDStrip::CHANNEL_MAPPING_RGB = 6
BrickletLEDStrip::CHANNEL_MAPPING_RBG = 9
BrickletLEDStrip::CHANNEL_MAPPING_BRG = 33
BrickletLEDStrip::CHANNEL_MAPPING_BGR = 36
BrickletLEDStrip::CHANNEL_MAPPING_GRB = 18
BrickletLEDStrip::CHANNEL_MAPPING_GBR = 24
BrickletLEDStrip::CHANNEL_MAPPING_RGBW = 27
BrickletLEDStrip::CHANNEL_MAPPING_RGWB = 30
BrickletLEDStrip::CHANNEL_MAPPING_RBGW = 39
BrickletLEDStrip::CHANNEL_MAPPING_RBWG = 45
BrickletLEDStrip::CHANNEL_MAPPING_RWGB = 54
BrickletLEDStrip::CHANNEL_MAPPING_RWBG = 57
BrickletLEDStrip::CHANNEL_MAPPING_GRWB = 78
BrickletLEDStrip::CHANNEL_MAPPING_GRBW = 75
BrickletLEDStrip::CHANNEL_MAPPING_GBWR = 108
BrickletLEDStrip::CHANNEL_MAPPING_GBRW = 99
BrickletLEDStrip::CHANNEL_MAPPING_GWBR = 120
BrickletLEDStrip::CHANNEL_MAPPING_GWRB = 114
BrickletLEDStrip::CHANNEL_MAPPING_BRGW = 135
BrickletLEDStrip::CHANNEL_MAPPING_BRWG = 141
BrickletLEDStrip::CHANNEL_MAPPING_BGRW = 147
BrickletLEDStrip::CHANNEL_MAPPING_BGWR = 156
BrickletLEDStrip::CHANNEL_MAPPING_BWRG = 177
BrickletLEDStrip::CHANNEL_MAPPING_BWGR = 180
BrickletLEDStrip::CHANNEL_MAPPING_WRBG = 201
BrickletLEDStrip::CHANNEL_MAPPING_WRGB = 198
BrickletLEDStrip::CHANNEL_MAPPING_WGBR = 216
BrickletLEDStrip::CHANNEL_MAPPING_WGRB = 210
BrickletLEDStrip::CHANNEL_MAPPING_WBGR = 228
BrickletLEDStrip::CHANNEL_MAPPING_WBRG = 225

Neu in Version 2.0.6 (Plugin).

Fortgeschrittene Funktionen¶

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

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

BrickletLEDStrip#enable_frame_rendered_callback → nil¶

Aktiviert den ::CALLBACK_FRAME_RENDERED Callback.

Standardmäßig ist der Callback aktiviert.

Neu in Version 2.0.6 (Plugin).

BrickletLEDStrip#disable_frame_rendered_callback → nil¶

Deaktiviert den ::CALLBACK_FRAME_RENDERED Callback.

Standardmäßig ist der Callback aktiviert.

Neu in Version 2.0.6 (Plugin).

BrickletLEDStrip#is_frame_rendered_callback_enabled → bool¶

Rückgabe:	enabled – Typ: bool, Standardwert: true

Gibt true zurück falls der ::CALLBACK_FRAME_RENDERED Callback aktiviert ist, false sonst.

Neu in Version 2.0.6 (Plugin).

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:

led_strip.register_callback BrickletLEDStrip::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.

BrickletLEDStrip::CALLBACK_FRAME_RENDERED¶

Callback-Parameter:	length – Typ: int, Wertebereich: [0 bis 320]

Dieser Callback wird direkt direkt nachdem ein Frame gerendert wurde ausgelöst. Der Parameter ist die Anzahl der RGB oder RGBW LEDs in diesem Frame.

Die Daten für das nächste Frame sollten direkt nach dem Auslösen dieses Callbacks übertragen werden.

Für eine Erklärung des generellen Ansatzes siehe #set_rgb_values.

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.

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

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

BrickletLEDStrip::FUNCTION_SET_RGB_VALUES = 1
BrickletLEDStrip::FUNCTION_SET_FRAME_DURATION = 3
BrickletLEDStrip::FUNCTION_SET_CLOCK_FREQUENCY = 7
BrickletLEDStrip::FUNCTION_SET_CHIP_TYPE = 9
BrickletLEDStrip::FUNCTION_SET_RGBW_VALUES = 11
BrickletLEDStrip::FUNCTION_SET_CHANNEL_MAPPING = 13
BrickletLEDStrip::FUNCTION_ENABLE_FRAME_RENDERED_CALLBACK = 15
BrickletLEDStrip::FUNCTION_DISABLE_FRAME_RENDERED_CALLBACK = 16

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

BrickletLEDStrip::FUNCTION_SET_RGB_VALUES = 1
BrickletLEDStrip::FUNCTION_SET_FRAME_DURATION = 3
BrickletLEDStrip::FUNCTION_SET_CLOCK_FREQUENCY = 7
BrickletLEDStrip::FUNCTION_SET_CHIP_TYPE = 9
BrickletLEDStrip::FUNCTION_SET_RGBW_VALUES = 11
BrickletLEDStrip::FUNCTION_SET_CHANNEL_MAPPING = 13
BrickletLEDStrip::FUNCTION_ENABLE_FRAME_RENDERED_CALLBACK = 15
BrickletLEDStrip::FUNCTION_DISABLE_FRAME_RENDERED_CALLBACK = 16

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

BrickletLEDStrip::DEVICE_IDENTIFIER¶

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

BrickletLEDStrip::DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines LED Strip Bricklet dar.