Perl - Ambient Light Bricklet 3.0

Dies ist die Beschreibung der Perl API Bindings für das Ambient Light Bricklet 3.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Ambient Light Bricklet 3.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
23
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletAmbientLightV3;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your Ambient Light Bricklet 3.0

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

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

# Get current Illuminance
my $illuminance = $al->get_illuminance();
print "Illuminance: " . $illuminance/100.0 . " lx\n";

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
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletAmbientLightV3;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your Ambient Light Bricklet 3.0

# Callback subroutine for illuminance callback
sub cb_illuminance
{
    my ($illuminance) = @_;

    print "Illuminance: " . $illuminance/100.0 . " lx\n";
}

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

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

# Register illuminance callback to subroutine cb_illuminance
$al->register_callback($al->CALLBACK_ILLUMINANCE, 'cb_illuminance');

# Set period for illuminance callback to 1s (1000ms) without a threshold
$al->set_illuminance_callback_configuration(1000, 0, 'x', 0, 0);

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

Threshold

Download (example_threshold.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

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletAmbientLightV3;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your Ambient Light Bricklet 3.0

# Callback subroutine for illuminance callback
sub cb_illuminance
{
    my ($illuminance) = @_;

    print "Illuminance: " . $illuminance/100.0 . " lx\n";
    print "Too bright, close the curtains!\n";
}

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

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

# Register illuminance callback to subroutine cb_illuminance
$al->register_callback($al->CALLBACK_ILLUMINANCE, 'cb_illuminance');

# Configure threshold for illuminance "greater than 500 lx"
# with a debounce period of 1s (1000ms)
$al->set_illuminance_callback_configuration(1000, 0, '>', 500*100, 0);

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

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

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

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

$ambient_light_v3 = BrickletAmbientLightV3->new("YOUR_DEVICE_UID", $ipcon);

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

BrickletAmbientLightV3->get_illuminance()
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.

Eine Beleuchtungsstärke von 0Lux bedeutet, dass der Sensor gesättigt (saturated) ist und die Konfiguration angepasst werden sollte, siehe set_configuration().

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.

BrickletAmbientLightV3->set_configuration($illuminance_range, $integration_time)
Parameter:
  • $illuminance_range – Typ: int, Wertebereich: Siehe Konstanten
  • $integration_time – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • undef

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

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.

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.

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 150ms Integrationszeit.

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

Für $illuminance_range:

  • BrickletAmbientLightV3->ILLUMINANCE_RANGE_UNLIMITED = 6
  • BrickletAmbientLightV3->ILLUMINANCE_RANGE_64000LUX = 0
  • BrickletAmbientLightV3->ILLUMINANCE_RANGE_32000LUX = 1
  • BrickletAmbientLightV3->ILLUMINANCE_RANGE_16000LUX = 2
  • BrickletAmbientLightV3->ILLUMINANCE_RANGE_8000LUX = 3
  • BrickletAmbientLightV3->ILLUMINANCE_RANGE_1300LUX = 4
  • BrickletAmbientLightV3->ILLUMINANCE_RANGE_600LUX = 5

Für $integration_time:

  • BrickletAmbientLightV3->INTEGRATION_TIME_50MS = 0
  • BrickletAmbientLightV3->INTEGRATION_TIME_100MS = 1
  • BrickletAmbientLightV3->INTEGRATION_TIME_150MS = 2
  • BrickletAmbientLightV3->INTEGRATION_TIME_200MS = 3
  • BrickletAmbientLightV3->INTEGRATION_TIME_250MS = 4
  • BrickletAmbientLightV3->INTEGRATION_TIME_300MS = 5
  • BrickletAmbientLightV3->INTEGRATION_TIME_350MS = 6
  • BrickletAmbientLightV3->INTEGRATION_TIME_400MS = 7
BrickletAmbientLightV3->get_configuration()
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:

  • BrickletAmbientLightV3->ILLUMINANCE_RANGE_UNLIMITED = 6
  • BrickletAmbientLightV3->ILLUMINANCE_RANGE_64000LUX = 0
  • BrickletAmbientLightV3->ILLUMINANCE_RANGE_32000LUX = 1
  • BrickletAmbientLightV3->ILLUMINANCE_RANGE_16000LUX = 2
  • BrickletAmbientLightV3->ILLUMINANCE_RANGE_8000LUX = 3
  • BrickletAmbientLightV3->ILLUMINANCE_RANGE_1300LUX = 4
  • BrickletAmbientLightV3->ILLUMINANCE_RANGE_600LUX = 5

Für $integration_time:

  • BrickletAmbientLightV3->INTEGRATION_TIME_50MS = 0
  • BrickletAmbientLightV3->INTEGRATION_TIME_100MS = 1
  • BrickletAmbientLightV3->INTEGRATION_TIME_150MS = 2
  • BrickletAmbientLightV3->INTEGRATION_TIME_200MS = 3
  • BrickletAmbientLightV3->INTEGRATION_TIME_250MS = 4
  • BrickletAmbientLightV3->INTEGRATION_TIME_300MS = 5
  • BrickletAmbientLightV3->INTEGRATION_TIME_350MS = 6
  • BrickletAmbientLightV3->INTEGRATION_TIME_400MS = 7

Fortgeschrittene Funktionen

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

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

  • BrickletAmbientLightV3->FUNCTION_SET_ILLUMINANCE_CALLBACK_CONFIGURATION = 2
  • BrickletAmbientLightV3->FUNCTION_SET_CONFIGURATION = 5
  • BrickletAmbientLightV3->FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletAmbientLightV3->FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletAmbientLightV3->FUNCTION_RESET = 243
  • BrickletAmbientLightV3->FUNCTION_WRITE_UID = 248
BrickletAmbientLightV3->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:

  • BrickletAmbientLightV3->FUNCTION_SET_ILLUMINANCE_CALLBACK_CONFIGURATION = 2
  • BrickletAmbientLightV3->FUNCTION_SET_CONFIGURATION = 5
  • BrickletAmbientLightV3->FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletAmbientLightV3->FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletAmbientLightV3->FUNCTION_RESET = 243
  • BrickletAmbientLightV3->FUNCTION_WRITE_UID = 248
BrickletAmbientLightV3->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.

BrickletAmbientLightV3->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.

BrickletAmbientLightV3->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 Bootlodaer- 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:

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

Für $status:

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

  • BrickletAmbientLightV3->BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletAmbientLightV3->BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletAmbientLightV3->BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletAmbientLightV3->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletAmbientLightV3->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletAmbientLightV3->set_write_firmware_pointer($pointer)
Parameter:
  • $pointer – Typ: int, 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.

BrickletAmbientLightV3->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.

BrickletAmbientLightV3->set_status_led_config($config)
Parameter:
  • $config – Typ: int, Wertebereich: Siehe Konstanten
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:

  • BrickletAmbientLightV3->STATUS_LED_CONFIG_OFF = 0
  • BrickletAmbientLightV3->STATUS_LED_CONFIG_ON = 1
  • BrickletAmbientLightV3->STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletAmbientLightV3->STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletAmbientLightV3->get_status_led_config()
Rückgabe:
  • $config – Typ: int, Wertebereich: Siehe Konstanten

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:

  • BrickletAmbientLightV3->STATUS_LED_CONFIG_OFF = 0
  • BrickletAmbientLightV3->STATUS_LED_CONFIG_ON = 1
  • BrickletAmbientLightV3->STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletAmbientLightV3->STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletAmbientLightV3->get_chip_temperature()
Rückgabe:
  • $temperature – Typ: int, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur in °C, 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.

BrickletAmbientLightV3->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.

BrickletAmbientLightV3->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.

BrickletAmbientLightV3->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.

BrickletAmbientLightV3->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
  • 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

BrickletAmbientLightV3->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.

BrickletAmbientLightV3->set_illuminance_callback_configuration($period, $value_has_to_change, $option, $min, $max)
Parameter:
  • $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • $value_has_to_change – Typ: bool, Standardwert: 0
  • $option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • $min – Typ: int, Wertebereich: [0 bis 232 - 1]
  • $max – Typ: int, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • undef

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.

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

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

Für $option:

  • BrickletAmbientLightV3->THRESHOLD_OPTION_OFF = 'x'
  • BrickletAmbientLightV3->THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAmbientLightV3->THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAmbientLightV3->THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAmbientLightV3->THRESHOLD_OPTION_GREATER = '>'
BrickletAmbientLightV3->get_illuminance_callback_configuration()
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: 0
  • 2: $option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • 3: $min – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 4: $max – Typ: int, Wertebereich: [0 bis 232 - 1]

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:

  • BrickletAmbientLightV3->THRESHOLD_OPTION_OFF = 'x'
  • BrickletAmbientLightV3->THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAmbientLightV3->THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAmbientLightV3->THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAmbientLightV3->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 die Callback ID und der zweite Parameter ist der Name der Callback-Funktion:

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

$ambient_light_v3->register_callback(BrickletAmbientLightV3->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.

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

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

Konstanten

BrickletAmbientLightV3->DEVICE_IDENTIFIER

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

BrickletAmbientLightV3->DEVICE_DISPLAY_NAME

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