MATLAB/Octave - Ambient Light Bricklet 3.0

Dies ist die Beschreibung der MATLAB/Octave 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 MATLAB/Octave API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple (MATLAB)

Download (matlab_example_simple.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
function matlab_example_simple()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletAmbientLightV3;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Ambient Light Bricklet 3.0

    ipcon = IPConnection(); % Create IP connection
    al = handle(BrickletAmbientLightV3(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Get current Illuminance
    illuminance = al.getIlluminance();
    fprintf('Illuminance: %g lx\n', illuminance/100.0);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

Callback (MATLAB)

Download (matlab_example_callback.m)

 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
function matlab_example_callback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletAmbientLightV3;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Ambient Light Bricklet 3.0

    ipcon = IPConnection(); % Create IP connection
    al = handle(BrickletAmbientLightV3(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Register illuminance callback to function cb_illuminance
    set(al, 'IlluminanceCallback', @(h, e) cb_illuminance(e));

    % Set period for illuminance callback to 1s (1000ms) without a threshold
    al.setIlluminanceCallbackConfiguration(1000, false, 'x', 0, 0);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for illuminance callback
function cb_illuminance(e)
    fprintf('Illuminance: %g lx\n', e.illuminance/100.0);
end

Threshold (MATLAB)

Download (matlab_example_threshold.m)

 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
function matlab_example_threshold()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletAmbientLightV3;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Ambient Light Bricklet 3.0

    ipcon = IPConnection(); % Create IP connection
    al = handle(BrickletAmbientLightV3(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Register illuminance callback to function cb_illuminance
    set(al, 'IlluminanceCallback', @(h, e) cb_illuminance(e));

    % Configure threshold for illuminance "greater than 500 lx"
    % with a debounce period of 1s (1000ms)
    al.setIlluminanceCallbackConfiguration(1000, false, '>', 500*100, 0);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for illuminance callback
function cb_illuminance(e)
    fprintf('Illuminance: %g lx\n', e.illuminance/100.0);
    fprintf('Too bright, close the curtains!\n');
end

Simple (Octave)

Download (octave_example_simple.m)

 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
function octave_example_simple()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Ambient Light Bricklet 3.0

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    al = javaObject("com.tinkerforge.BrickletAmbientLightV3", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Get current Illuminance
    illuminance = al.getIlluminance();
    fprintf("Illuminance: %g lx\n", java2int(illuminance)/100.0);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
end

Callback (Octave)

Download (octave_example_callback.m)

 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
function octave_example_callback()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Ambient Light Bricklet 3.0

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    al = javaObject("com.tinkerforge.BrickletAmbientLightV3", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Register illuminance callback to function cb_illuminance
    al.addIlluminanceCallback(@cb_illuminance);

    % Set period for illuminance callback to 1s (1000ms) without a threshold
    al.setIlluminanceCallbackConfiguration(1000, false, "x", 0, 0);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for illuminance callback
function cb_illuminance(e)
    fprintf("Illuminance: %g lx\n", java2int(e.illuminance)/100.0);
end

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
end

Threshold (Octave)

Download (octave_example_threshold.m)

 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
36
37
function octave_example_threshold()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Ambient Light Bricklet 3.0

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    al = javaObject("com.tinkerforge.BrickletAmbientLightV3", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Register illuminance callback to function cb_illuminance
    al.addIlluminanceCallback(@cb_illuminance);

    % Configure threshold for illuminance "greater than 500 lx"
    % with a debounce period of 1s (1000ms)
    al.setIlluminanceCallbackConfiguration(1000, false, ">", 500*100, 0);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for illuminance callback
function cb_illuminance(e)
    fprintf("Illuminance: %g lx\n", java2int(e.illuminance)/100.0);
    fprintf("Too bright, close the curtains!\n");
end

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
end

API

Prinzipiell kann jede Methode der MATLAB Bindings eine TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Neben der TimeoutException kann auch noch eine NotConnectedException geworfen werden, wenn versucht wird mit einem Brick oder Bricklet zu kommunizieren, aber die IP Connection nicht verbunden ist.

Da die MATLAB Bindings auf Java basieren und Java nicht mehrere Rückgabewerte unterstützt und eine Referenzrückgabe für elementare Type nicht möglich ist, werden kleine Klassen verwendet, die nur aus Member-Variablen bestehen. Die Member-Variablen des zurückgegebenen Objektes werden in der jeweiligen Methodenbeschreibung erläutert.

Das Package für alle Brick/Bricklet Bindings und die IP Connection ist com.tinkerforge.*

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

class BrickletAmbientLightV3(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • ambientLightV3 – Typ: BrickletAmbientLightV3

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

In MATLAB:

import com.tinkerforge.BrickletAmbientLightV3;

ambientLightV3 = BrickletAmbientLightV3("YOUR_DEVICE_UID", ipcon);

In Octave:

ambientLightV3 = java_new("com.tinkerforge.BrickletAmbientLightV3", "YOUR_DEVICE_UID", ipcon);

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

long BrickletAmbientLightV3.getIlluminance()
Rückgabe:
  • illuminance – Typ: long, Einheit: 1/100 lx, 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 eine Ausnahmesituation in der der Sensor keine sinnvolle Messung durchführen kann. Dies kann bei sehr schwacher oder sehr starker Beleuchtung auftreten. Bei starker Beleuchtung bedeutet diese möglicherweise, dass der Sensor gesättigt (saturated) ist und die Konfiguration angepasst werden sollte (setConfiguration()), um besser der Beleuchtung zu entsprechen.

Wenn der Wert periodisch benötigt wird, kann auch der IlluminanceCallback Callback verwendet werden. Der Callback wird mit der Funktion setIlluminanceCallbackConfiguration() konfiguriert.

void BrickletAmbientLightV3.setConfiguration(int illuminanceRange, int integrationTime)
Parameter:
  • illuminanceRange – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
  • integrationTime – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 2

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 getIlluminance() und der IlluminanceCallback 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 getIlluminance() und der IlluminanceCallback 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 folgenden Konstanten sind für diese Funktion verfügbar:

Für illuminanceRange:

  • 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 integrationTime:

  • 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.Configuration BrickletAmbientLightV3.getConfiguration()
Rückgabeobjekt:
  • illuminanceRange – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
  • integrationTime – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 2

Gibt die Konfiguration zurück, wie von setConfiguration() gesetzt.

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

Für illuminanceRange:

  • 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 integrationTime:

  • 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.SPITFPErrorCount BrickletAmbientLightV3.getSPITFPErrorCount()
Rückgabeobjekt:
  • errorCountAckChecksum – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: long, 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.

void BrickletAmbientLightV3.setStatusLEDConfig(int config)
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:

  • 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
int BrickletAmbientLightV3.getStatusLEDConfig()
Rückgabe:
  • config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von setStatusLEDConfig() 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
int BrickletAmbientLightV3.getChipTemperature()
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.

void BrickletAmbientLightV3.reset()

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.Identity BrickletAmbientLightV3.getIdentity()
Rückgabeobjekt:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ['a' bis 'h', 'z']
  • hardwareVersion – Typ: short[], Länge: 3
    • 1: major – Typ: short, Wertebereich: [0 bis 255]
    • 2: minor – Typ: short, Wertebereich: [0 bis 255]
    • 3: revision – Typ: short, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: short[], Länge: 3
    • 1: major – Typ: short, Wertebereich: [0 bis 255]
    • 2: minor – Typ: short, Wertebereich: [0 bis 255]
    • 3: revision – Typ: short, Wertebereich: [0 bis 255]
  • deviceIdentifier – 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 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

void BrickletAmbientLightV3.setIlluminanceCallbackConfiguration(long period, boolean valueHasToChange, char option, long min, long max)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: long, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • max – Typ: long, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Die Periode ist die Periode mit der der IlluminanceCallback 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 IlluminanceCallback 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:

  • BrickletAmbientLightV3.THRESHOLD_OPTION_OFF = 'x'
  • BrickletAmbientLightV3.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAmbientLightV3.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAmbientLightV3.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAmbientLightV3.THRESHOLD_OPTION_GREATER = '>'
BrickletAmbientLightV3.IlluminanceCallbackConfiguration BrickletAmbientLightV3.getIlluminanceCallbackConfiguration()
Rückgabeobjekt:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: long, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • max – Typ: long, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels setIlluminanceCallbackConfiguration() 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 wird mit MATLABs "set" Funktion durchgeführt. Die Parameter sind ein Gerätobjekt, der Callback-Name und die Callback-Funktion. Hier ein Beispiel in MATLAB:

function my_callback(e)
    fprintf('Parameter: %s\n', e.param);
end

set(device, 'ExampleCallback', @(h, e) my_callback(e));

Die Octave Java Unterstützung unterscheidet sich hier von MATLAB, die "set" Funktion kann hier nicht verwendet werden. Die Registrierung wird in Octave mit "add*Callback" Funktionen des Gerätobjekts durchgeführt. Hier ein Beispiel in Octave:

function my_callback(e)
    fprintf("Parameter: %s\n", e.param);
end

device.addExampleCallback(@my_callback);

Es ist möglich mehrere Callback-Funktion hinzuzufügen und auch mit einem korrespondierenden "remove*Callback" wieder zu entfernen.

Die Parameter des Callbacks werden der Callback-Funktion als Felder der Struktur e übergeben. Diese ist von der java.util.EventObject Klasse abgeleitete. Die verfügbaren Callback-Namen mit den entsprechenden Strukturfeldern werden unterhalb 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.

callback BrickletAmbientLightV3.IlluminanceCallback
Event-Objekt:
  • illuminance – Typ: long, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels setIlluminanceCallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie getIlluminance().

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addIlluminanceCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeIlluminanceCallback() wieder entfernt werden.

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.

short[] BrickletAmbientLightV3.getAPIVersion()
Rückgabeobjekt:
  • apiVersion – Typ: short[], Länge: 3
    • 1: major – Typ: short, Wertebereich: [0 bis 255]
    • 2: minor – Typ: short, Wertebereich: [0 bis 255]
    • 3: revision – Typ: short, 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.

boolean BrickletAmbientLightV3.getResponseExpected(byte functionId)
Parameter:
  • functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: boolean

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 setResponseExpected(). 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 functionId:

  • 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
void BrickletAmbientLightV3.setResponseExpected(byte functionId, boolean responseExpected)
Parameter:
  • functionId – Typ: byte, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: boolean

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

  • 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
void BrickletAmbientLightV3.setResponseExpectedAll(boolean responseExpected)
Parameter:
  • responseExpected – Typ: boolean

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

int BrickletAmbientLightV3.setBootloaderMode(int 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:

  • 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
int BrickletAmbientLightV3.getBootloaderMode()
Rückgabe:
  • mode – Typ: int, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode().

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
void BrickletAmbientLightV3.setWriteFirmwarePointer(long pointer)
Parameter:
  • pointer – Typ: long, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für writeFirmware(). 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.

int BrickletAmbientLightV3.writeFirmware(int[] 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 setWriteFirmwarePointer() 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.

void BrickletAmbientLightV3.writeUID(long uid)
Parameter:
  • uid – Typ: long, 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.

long BrickletAmbientLightV3.readUID()
Rückgabe:
  • uid – Typ: long, 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

int BrickletAmbientLightV3.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Ambient Light Bricklet 3.0 zu identifizieren.

Die getIdentity() Funktion und der IPConnection.EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

String BrickletAmbientLightV3.DEVICE_DISPLAY_NAME

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