Perl - LED Strip Bricklet 2.0

Dies ist die Beschreibung der Perl API Bindings für das LED Strip Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des LED Strip Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Perl API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example_simple.pl)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletLEDStripV2;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your LED Strip Bricklet 2.0

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $ls = Tinkerforge::BrickletLEDStripV2->new(&UID, $ipcon); # Create device object

$ipcon->connect(&HOST, &PORT); # Connect to brickd
# Don't use device before ipcon is connected

# Set first 3 LEDs to red, green and blue
$ls->set_led_values(0, [255, 0, 0, 0, 255, 0, 0, 0, 255]);

print "Press key to exit\n";
<STDIN>;
$ipcon->disconnect();

Callback

Download (example_callback.pl)

 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/perl

# FIXME: This example is incomplete

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletLEDStripV2;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your LED Strip Bricklet 2.0

# Use frame started callback to move the active LED every frame
sub cb_frame_started
{
    my ($length) = @_;

    print "Length: $length\n";
}

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $ls = Tinkerforge::BrickletLEDStripV2->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);

# Register frame started callback to subroutine cb_frame_started
$ls->register_callback($ls->CALLBACK_FRAME_STARTED, 'cb_frame_started');

print "Press key to exit\n";
<STDIN>;
$ipcon->disconnect();

API

Allgemein kann jede Subroutine der Perl Bindings Fehler als Tinkerforge::Error Objekt mittels croak() melden. Das Objekt hat eine get_code() und eine get_message() Subroutine. Es sind verschiedene Fehlercodes definiert:

  • Error->ALREADY_CONNECTED = 11
  • Error->NOT_CONNECTED = 12
  • Error->CONNECT_FAILED = 13
  • Error->INVALID_FUNCTION_ID = 21
  • Error->TIMEOUT = 31
  • Error->INVALID_PARAMETER = 41
  • Error->FUNCTION_NOT_SUPPORTED = 42
  • Error->UNKNOWN_ERROR = 43
  • Error->STREAM_OUT_OF_SYNC = 51
  • Error->INVALID_UID = 61
  • Error->NON_ASCII_CHAR_IN_SECRET = 71
  • Error->WRONG_DEVICE_TYPE = 81
  • Error->DEVICE_REPLACED = 82

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

BrickletLEDStripV2->new($uid, $ipcon)
Parameter:
  • $uid – Typ: string
  • $ipcon – Typ: IPConnection
Rückgabe:
  • $led_strip_v2 – Typ: BrickletLEDStripV2

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

$led_strip_v2 = BrickletLEDStripV2->new("YOUR_DEVICE_UID", $ipcon);

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

BrickletLEDStripV2->set_led_values($index, @value)
Parameter:
  • $index – Typ: int, Wertebereich: [0 bis 6144]
  • @value – Typ: [int, ...], Länge: variabel, Wertebereich: [0 bis 255]
Rückgabe:
  • undef

Setzt die RGB(W) Werte der LEDs beginnend beim index. Es können bis zu 2048 RGB Werte oder 1536 RGBW Werte (jeweils 6144 Byte) gesetzt werden.

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

Wenn das Channel Mapping 3 Farben hat, müssen die Werte in der Sequenz RGBRGBRGB... übergeben werden. Hat das Mapping 4 Farben, müssen die Werte in der Sequenz RGBWRGBWRGBW... übergeben werden.

Die Daten werden Zwischengespeichert und die Farben werden auf die 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 den CALLBACK_FRAME_STARTED Callback.
  • Setze alle LEDs für den nächsten Frame.
  • Warte auf den CALLBACK_FRAME_STARTED Callback.
  • Und so weiter.

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

BrickletLEDStripV2->get_led_values($index, $length)
Parameter:
  • $index – Typ: int, Wertebereich: [0 bis 6144]
  • $length – Typ: int, Wertebereich: [0 bis 6144]
Rückgabe:
  • @value – Typ: [int, ...], Länge: variabel, Wertebereich: [0 bis 255]

Gibt length RGB(W) Werte zurück, beginnend vom übergebenen index.

Wenn das Channel Mapping 3 Farben hat, werden die Werte in der Sequenz RGBRGBRGB... zurückgegeben, hat das Mapping 4 Farben, werden die Werte in der Sequenz RGBWRGBWRGBW... zurückgegeben (unter der Annahme, dass ein durch 3 (RGB) oder 4 (RGBW) teilbarer Index übergeben wird).

BrickletLEDStripV2->set_frame_duration($duration)
Parameter:
  • $duration – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 100
Rückgabe:
  • undef

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_led_values().

Standardwert: 100ms (10 Frames pro Sekunde).

BrickletLEDStripV2->get_frame_duration()
Rückgabe:
  • $duration – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 100

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

BrickletLEDStripV2->get_supply_voltage()
Rückgabe:
  • $voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Gibt die aktuelle Versorgungsspannung der LEDs zurück.

BrickletLEDStripV2->set_clock_frequency($frequency)
Parameter:
  • $frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [10000 bis 2000000], Standardwert: 1666666
Rückgabe:
  • undef

Setzt die Frequenz der Clock-Leitung.

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.

BrickletLEDStripV2->get_clock_frequency()
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.

BrickletLEDStripV2->set_chip_type($chip)
Parameter:
  • $chip – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 2801
Rückgabe:
  • undef

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),
  • WS2813 / WS2815 (Chip Type = WS2812)
  • LPD8806 and
  • APA102 / DotStar.

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

Für $chip:

  • BrickletLEDStripV2->CHIP_TYPE_WS2801 = 2801
  • BrickletLEDStripV2->CHIP_TYPE_WS2811 = 2811
  • BrickletLEDStripV2->CHIP_TYPE_WS2812 = 2812
  • BrickletLEDStripV2->CHIP_TYPE_LPD8806 = 8806
  • BrickletLEDStripV2->CHIP_TYPE_APA102 = 102
BrickletLEDStripV2->get_chip_type()
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:

  • BrickletLEDStripV2->CHIP_TYPE_WS2801 = 2801
  • BrickletLEDStripV2->CHIP_TYPE_WS2811 = 2811
  • BrickletLEDStripV2->CHIP_TYPE_WS2812 = 2812
  • BrickletLEDStripV2->CHIP_TYPE_LPD8806 = 8806
  • BrickletLEDStripV2->CHIP_TYPE_APA102 = 102
BrickletLEDStripV2->set_channel_mapping($mapping)
Parameter:
  • $mapping – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 36
Rückgabe:
  • undef

Setzt das Channel Mapping für die angeschlossenen LEDs.

Falls das Mapping 4 Farben hat, erwartet die Funktion set_led_values() 4 Werte pro Pixel. Bei einem Mapping mit 3 Farben werden 3 Werte pro Pixel erwartet.

Die Funktion erwartet immer die Reihenfolge RGB(W). Die angeschlossenen LED-Treiber-Chips können die Daten für ihre 3 oder 4 Kanäle in einer anderen Reihenfolge erwarten. 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.

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

Für $mapping:

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

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

Fortgeschrittene Funktionen

BrickletLEDStripV2->get_spitfp_error_count()
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.

BrickletLEDStripV2->set_status_led_config($config)
Parameter:
  • $config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • undef

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:

  • BrickletLEDStripV2->STATUS_LED_CONFIG_OFF = 0
  • BrickletLEDStripV2->STATUS_LED_CONFIG_ON = 1
  • BrickletLEDStripV2->STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletLEDStripV2->STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletLEDStripV2->get_status_led_config()
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:

  • BrickletLEDStripV2->STATUS_LED_CONFIG_OFF = 0
  • BrickletLEDStripV2->STATUS_LED_CONFIG_ON = 1
  • BrickletLEDStripV2->STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletLEDStripV2->STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletLEDStripV2->get_chip_temperature()
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.

BrickletLEDStripV2->reset()
Rückgabe:
  • undef

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.

BrickletLEDStripV2->get_identity()
Rückgabe-Array:
  • 0: $uid – Typ: string, Länge: bis zu 8
  • 1: $connected_uid – Typ: string, Länge: bis zu 8
  • 2: $position – Typ: char, 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

BrickletLEDStripV2->register_callback($callback_id, $function)
Parameter:
  • $callback_id – Typ: int
  • $function – Typ: string
Rückgabe:
  • undef

Registriert den $function Namen für die gegebene $callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

BrickletLEDStripV2->set_frame_started_callback_configuration($enable)
Parameter:
  • $enable – Typ: bool, Standardwert: 1
Rückgabe:
  • undef

Aktiviert/deaktiviert den CALLBACK_FRAME_STARTED Callback.

BrickletLEDStripV2->get_frame_started_callback_configuration()
Rückgabe:
  • $enable – Typ: bool, Standardwert: 1

Gibt die Konfiguration zurück, wie von set_frame_started_callback_configuration() 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 die Callback ID und der zweite Parameter ist der Name der Callback-Funktion:

sub my_callback
{
    print "@_[0]";
}

$led_strip_v2->register_callback(BrickletLEDStripV2->CALLBACK_EXAMPLE, 'my_callback')

Die Callback Funktion wird dann von einem internen Thread der IP Connection aufgerufen werden. Im Gegensatz zu vielen anderen Programmiersprachen werden Variablen nicht automatisch zwischen Threads geteilt. Wenn eine Variable gleichzeitig in einer Callback Funktion und dem Rest des Programms genutzt werden soll, dann muss diese als :shared markiert werden. Siehe dazu auch die Dokumentation des threads::shared Perl Moduls für weitere Details.

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.

BrickletLEDStripV2->CALLBACK_FRAME_STARTED
Callback-Parameter:
  • $length – Typ: int, Wertebereich: [0 bis 6144]

Dieser Callback wird direkt nachdem dem start eines Frames ausgelöst. Der Parameter ist die Anzahl der 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_led_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.

BrickletLEDStripV2->get_api_version()
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.

BrickletLEDStripV2->get_response_expected($function_id)
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:

  • BrickletLEDStripV2->FUNCTION_SET_LED_VALUES = 1
  • BrickletLEDStripV2->FUNCTION_SET_FRAME_DURATION = 3
  • BrickletLEDStripV2->FUNCTION_SET_CLOCK_FREQUENCY = 7
  • BrickletLEDStripV2->FUNCTION_SET_CHIP_TYPE = 9
  • BrickletLEDStripV2->FUNCTION_SET_CHANNEL_MAPPING = 11
  • BrickletLEDStripV2->FUNCTION_SET_FRAME_STARTED_CALLBACK_CONFIGURATION = 13
  • BrickletLEDStripV2->FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletLEDStripV2->FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletLEDStripV2->FUNCTION_RESET = 243
  • BrickletLEDStripV2->FUNCTION_WRITE_UID = 248
BrickletLEDStripV2->set_response_expected($function_id, $response_expected)
Parameter:
  • $function_id – Typ: int, Wertebereich: Siehe Konstanten
  • $response_expected – Typ: bool
Rückgabe:
  • undef

Ä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:

  • BrickletLEDStripV2->FUNCTION_SET_LED_VALUES = 1
  • BrickletLEDStripV2->FUNCTION_SET_FRAME_DURATION = 3
  • BrickletLEDStripV2->FUNCTION_SET_CLOCK_FREQUENCY = 7
  • BrickletLEDStripV2->FUNCTION_SET_CHIP_TYPE = 9
  • BrickletLEDStripV2->FUNCTION_SET_CHANNEL_MAPPING = 11
  • BrickletLEDStripV2->FUNCTION_SET_FRAME_STARTED_CALLBACK_CONFIGURATION = 13
  • BrickletLEDStripV2->FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletLEDStripV2->FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletLEDStripV2->FUNCTION_RESET = 243
  • BrickletLEDStripV2->FUNCTION_WRITE_UID = 248
BrickletLEDStripV2->set_response_expected_all($response_expected)
Parameter:
  • $response_expected – Typ: bool
Rückgabe:
  • undef

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Interne Funktionen

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

BrickletLEDStripV2->set_bootloader_mode($mode)
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:

  • BrickletLEDStripV2->BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletLEDStripV2->BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletLEDStripV2->BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletLEDStripV2->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletLEDStripV2->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für $status:

  • BrickletLEDStripV2->BOOTLOADER_STATUS_OK = 0
  • BrickletLEDStripV2->BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletLEDStripV2->BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletLEDStripV2->BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletLEDStripV2->BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletLEDStripV2->BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletLEDStripV2->get_bootloader_mode()
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:

  • BrickletLEDStripV2->BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletLEDStripV2->BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletLEDStripV2->BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletLEDStripV2->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletLEDStripV2->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletLEDStripV2->set_write_firmware_pointer($pointer)
Parameter:
  • $pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • undef

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.

BrickletLEDStripV2->write_firmware(@data)
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.

BrickletLEDStripV2->write_uid($uid)
Parameter:
  • $uid – Typ: int, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • undef

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.

BrickletLEDStripV2->read_uid()
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.

Konstanten

BrickletLEDStripV2->DEVICE_IDENTIFIER

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

BrickletLEDStripV2->DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines LED Strip Bricklet 2.0 dar.