MATLAB/Octave - Color Bricklet¶

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
22
23
24
25

function matlab_example_simple()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletColor;

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

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

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

    % Get current color
    color = c.getColor();

    fprintf('Color [R]: %i\n', color.r);
    fprintf('Color [G]: %i\n', color.g);
    fprintf('Color [B]: %i\n', color.b);
    fprintf('Color [C]: %i\n', color.c);

    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
29
30
31
32
33
34

function matlab_example_callback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletColor;

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

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

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

    % Register color callback to function cb_color
    set(c, 'ColorCallback', @(h, e) cb_color(e));

    % Set period for color callback to 1s (1000ms)
    % Note: The color callback is only called every second
    %       if the color has changed since the last call!
    c.setColorCallbackPeriod(1000);

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

% Callback function for color callback
function cb_color(e)
    fprintf('Color [R]: %i\n', e.r);
    fprintf('Color [G]: %i\n', e.g);
    fprintf('Color [B]: %i\n', e.b);
    fprintf('Color [C]: %i\n', e.c);
    fprintf('\n');
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
31
32
33
34
35

function matlab_example_threshold()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletColor;

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

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

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

    % Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    c.setDebouncePeriod(10000);

    % Register color reached callback to function cb_color_reached
    set(c, 'ColorReachedCallback', @(h, e) cb_color_reached(e));

    % Configure threshold for color "greater than 100, 200, 300, 400"
    c.setColorCallbackThreshold('>', 100, 0, 200, 0, 300, 0, 400, 0);

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

% Callback function for color reached callback
function cb_color_reached(e)
    fprintf('Color [R]: %i\n', e.r);
    fprintf('Color [G]: %i\n', e.g);
    fprintf('Color [B]: %i\n', e.b);
    fprintf('Color [C]: %i\n', e.c);
    fprintf('\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

function octave_example_simple()
    more off;

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

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

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

    % Get current color
    color = c.getColor();

    fprintf("Color [R]: %d\n", color.r);
    fprintf("Color [G]: %d\n", color.g);
    fprintf("Color [B]: %d\n", color.b);
    fprintf("Color [C]: %d\n", color.c);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
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

function octave_example_callback()
    more off;

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

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

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

    % Register color callback to function cb_color
    c.addColorCallback(@cb_color);

    % Set period for color callback to 1s (1000ms)
    % Note: The color callback is only called every second
    %       if the color has changed since the last call!
    c.setColorCallbackPeriod(1000);

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

% Callback function for color callback
function cb_color(e)
    fprintf("Color [R]: %d\n", e.r);
    fprintf("Color [G]: %d\n", e.g);
    fprintf("Color [B]: %d\n", e.b);
    fprintf("Color [C]: %d\n", e.c);
    fprintf("\n");
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

function octave_example_threshold()
    more off;

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

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

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

    % Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    c.setDebouncePeriod(10000);

    % Register color reached callback to function cb_color_reached
    c.addColorReachedCallback(@cb_color_reached);

    % Configure threshold for color "greater than 100, 200, 300, 400"
    c.setColorCallbackThreshold(">", 100, 0, 200, 0, 300, 0, 400, 0);

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

% Callback function for color reached callback
function cb_color_reached(e)
    fprintf("Color [R]: %d\n", e.r);
    fprintf("Color [G]: %d\n", e.g);
    fprintf("Color [B]: %d\n", e.b);
    fprintf("Color [C]: %d\n", e.c);
    fprintf("\n");
end

Grundfunktionen¶

class BrickletColor(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	color – Typ: BrickletColor

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

In MATLAB:

import com.tinkerforge.BrickletColor;

color = BrickletColor("YOUR_DEVICE_UID", ipcon);

In Octave:

color = java_new("com.tinkerforge.BrickletColor", "YOUR_DEVICE_UID", ipcon);

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

BrickletColor.Color BrickletColor.getColor()¶

Rückgabeobjekt:	r – Typ: int, Wertebereich: [0 bis 216 - 1] g – Typ: int, Wertebereich: [0 bis 216 - 1] b – Typ: int, Wertebereich: [0 bis 216 - 1] c – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die gemessene Farbe des Sensors zurück.

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

Wenn die Farbe periodisch abgefragt werden soll, wird empfohlen den ColorCallback Callback zu nutzen und die Periode mit setColorCallbackPeriod() vorzugeben.

void BrickletColor.lightOn()¶

Aktiviert die LED.

void BrickletColor.lightOff()¶

Deaktiviert die LED.

short BrickletColor.isLightOn()¶

Rückgabe:	light – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 1

Gibt den Zustand der LED zurück. Mögliche Werte sind:

• 0: On
• 1: Off

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

Für light:

• BrickletColor.LIGHT_ON = 0
• BrickletColor.LIGHT_OFF = 1

void BrickletColor.setConfig(short gain, short integrationTime)¶

Parameter:	gain – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 3 integrationTime – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 3

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

Für die Konfiguration der Verstärkung:

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

Für die Konfiguration der Integrationszeit:

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

Eine Erhöhung der Verstärkung ermöglicht es dem Sensor Farben aus größeren Entfernungen zu erkennen.

Die Integrationszeit ist ein Trade-off zwischen Konvertierungszeit und Genauigkeit. Mit einer höheren Integrationszeit werden die Werte genauer, es dauert allerdings länger bis ein Resultat bereitsteht.

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

Für gain:

• BrickletColor.GAIN_1X = 0
• BrickletColor.GAIN_4X = 1
• BrickletColor.GAIN_16X = 2
• BrickletColor.GAIN_60X = 3

Für integrationTime:

• BrickletColor.INTEGRATION_TIME_2MS = 0
• BrickletColor.INTEGRATION_TIME_24MS = 1
• BrickletColor.INTEGRATION_TIME_101MS = 2
• BrickletColor.INTEGRATION_TIME_154MS = 3
• BrickletColor.INTEGRATION_TIME_700MS = 4

BrickletColor.Config BrickletColor.getConfig()¶

Rückgabeobjekt:	gain – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 3 integrationTime – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Einstellungen zurück, wie von setConfig() gesetzt.

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

Für gain:

• BrickletColor.GAIN_1X = 0
• BrickletColor.GAIN_4X = 1
• BrickletColor.GAIN_16X = 2
• BrickletColor.GAIN_60X = 3

Für integrationTime:

• BrickletColor.INTEGRATION_TIME_2MS = 0
• BrickletColor.INTEGRATION_TIME_24MS = 1
• BrickletColor.INTEGRATION_TIME_101MS = 2
• BrickletColor.INTEGRATION_TIME_154MS = 3
• BrickletColor.INTEGRATION_TIME_700MS = 4

long BrickletColor.getIlluminance()¶

Rückgabe:	illuminance – Typ: long, Einheit: ? lx, Wertebereich: [0 bis 103438]

Gibt die Beleuchtungsstärke beeinflusst durch die Verstärkung und die Integrationszeit zurück. Verstärkung und Integrationszeit können mit setConfig() eingestellt werden. Um die Beleuchtungsstärke in Lux zu ermitteln muss folgende Formel angewendet werden:

lux = illuminance * 700 / gain / integration_time

Für eine korrekte Messung der Beleuchtungsstärke muss sichergestellt sein, dass die Farbwerte (R, G oder B) nicht saturiert sind. Ein Farbwert ist saturiert wenn der Wert 65535 beträgt. In diesem Fall kann die Verstärkung per setConfig() reduziert werden.

int BrickletColor.getColorTemperature()¶

Rückgabe:	colorTemperature – Typ: int, Einheit: 1 K, Wertebereich: [0 bis 216 - 1]

Gibt die Farbtemperatur zurück.

Für eine korrekte Messung der Farbtemperatur muss sichergestellt sein das die Farbwerte (R, G oder B) nicht saturiert sind. Ein Farbwert ist saturiert wenn der Wert 65535 beträgt. In diesem Fall kann die Verstärkung per setConfig() reduziert werden.

Fortgeschrittene Funktionen¶

BrickletColor.Identity BrickletColor.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 BrickletColor.setColorCallbackPeriod(long period)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der ColorCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der ColorCallback Callback wird nur ausgelöst, wenn sich die Color seit der letzten Auslösung geändert hat.

long BrickletColor.getColorCallbackPeriod()¶

Rückgabe:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von setColorCallbackPeriod() gesetzt.

void BrickletColor.setColorCallbackThreshold(char option, int minR, int maxR, int minG, int maxG, int minB, int maxB, int minC, int maxC)¶

Parameter:

option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' minR – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 maxR – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 minG – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 maxG – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 minB – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 maxB – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 minC – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 maxC – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den ColorReachedCallback Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn die Temperatur außerhalb des min und max Wertes ist
'i'	Callback wird ausgelöst, wenn die Temperatur innerhalb des min und max Wertes ist
'<'	Callback wird ausgelöst, wenn die Temperatur kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die Temperatur größer als der min Wert ist (max wird ignoriert)

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

Für option:

• BrickletColor.THRESHOLD_OPTION_OFF = 'x'
• BrickletColor.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletColor.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletColor.THRESHOLD_OPTION_SMALLER = '<'
• BrickletColor.THRESHOLD_OPTION_GREATER = '>'

BrickletColor.ColorCallbackThreshold BrickletColor.getColorCallbackThreshold()¶

Rückgabeobjekt:

option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' minR – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 maxR – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 minG – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 maxG – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 minB – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 maxB – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 minC – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 maxC – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von setColorCallbackThreshold() gesetzt.

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

Für option:

• BrickletColor.THRESHOLD_OPTION_OFF = 'x'
• BrickletColor.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletColor.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletColor.THRESHOLD_OPTION_SMALLER = '<'
• BrickletColor.THRESHOLD_OPTION_GREATER = '>'

void BrickletColor.setDebouncePeriod(long debounce)¶

Parameter:	debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callback

• ColorReachedCallback

ausgelöst wird, wenn der Schwellwert

• setColorCallbackThreshold()

weiterhin erreicht bleibt.

long BrickletColor.getDebouncePeriod()¶

Rückgabe:	debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von setDebouncePeriod() gesetzt.

void BrickletColor.setIlluminanceCallbackPeriod(long period)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der IlluminanceCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der IlluminanceCallback Callback wird nur ausgelöst, wenn sich die Beleuchtungsstärke seit der letzten Auslösung geändert hat.

long BrickletColor.getIlluminanceCallbackPeriod()¶

Rückgabe:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von setIlluminanceCallbackPeriod() gesetzt.

void BrickletColor.setColorTemperatureCallbackPeriod(long period)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der ColorTemperatureCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der ColorTemperatureCallback Callback wird nur ausgelöst, wenn sich die Farbtemperatur seit der letzten Auslösung geändert hat.

long BrickletColor.getColorTemperatureCallbackPeriod()¶

Rückgabe:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von setColorTemperatureCallbackPeriod() gesetzt.

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.

callback BrickletColor.ColorCallback¶

Event-Objekt:	r – Typ: int, Wertebereich: [0 bis 216 - 1] g – Typ: int, Wertebereich: [0 bis 216 - 1] b – Typ: int, Wertebereich: [0 bis 216 - 1] c – Typ: int, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit setColorCallbackPeriod(), ausgelöst. Der Parameter ist die Farbe des Sensors als RGBC.

Der ColorCallback Callback wird nur ausgelöst, wenn sich die Farbe seit der letzten Auslösung geändert hat.

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

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

callback BrickletColor.ColorReachedCallback¶

Event-Objekt:	r – Typ: int, Wertebereich: [0 bis 216 - 1] g – Typ: int, Wertebereich: [0 bis 216 - 1] b – Typ: int, Wertebereich: [0 bis 216 - 1] c – Typ: int, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setColorCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Farbe des Sensors als RGBC.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit setDebouncePeriod() gesetzt, ausgelöst.

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

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

callback BrickletColor.IlluminanceCallback¶

Event-Objekt:	illuminance – Typ: long, Einheit: ? lx, Wertebereich: [0 bis 103438]

Dieser Callback wird mit der Periode, wie gesetzt mit setIlluminanceCallbackPeriod(), ausgelöst. Der Parameter ist die Beleuchtungsstärke des Sensors. Siehe getIlluminance() für eine Erklärung wie dieser zu interpretieren ist.

Der IlluminanceCallback Callback wird nur ausgelöst, wenn sich die Beleuchtungsstärke seit der letzten Auslösung geändert hat.

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.

callback BrickletColor.ColorTemperatureCallback¶

Event-Objekt:	colorTemperature – Typ: int, Einheit: 1 K, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit setColorTemperatureCallbackPeriod(), ausgelöst. Der Parameter ist die Farbtemperatur des Sensors.

Der ColorTemperatureCallback Callback wird nur ausgelöst, wenn sich die Farbtemperatur seit der letzten Auslösung geändert hat.

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

In Octave kann diesem Callback mit addColorTemperatureCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeColorTemperatureCallback() 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[] BrickletColor.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 BrickletColor.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:

• BrickletColor.FUNCTION_SET_COLOR_CALLBACK_PERIOD = 2
• BrickletColor.FUNCTION_SET_COLOR_CALLBACK_THRESHOLD = 4
• BrickletColor.FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletColor.FUNCTION_LIGHT_ON = 10
• BrickletColor.FUNCTION_LIGHT_OFF = 11
• BrickletColor.FUNCTION_SET_CONFIG = 13
• BrickletColor.FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 17
• BrickletColor.FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_PERIOD = 19

void BrickletColor.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:

• BrickletColor.FUNCTION_SET_COLOR_CALLBACK_PERIOD = 2
• BrickletColor.FUNCTION_SET_COLOR_CALLBACK_THRESHOLD = 4
• BrickletColor.FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletColor.FUNCTION_LIGHT_ON = 10
• BrickletColor.FUNCTION_LIGHT_OFF = 11
• BrickletColor.FUNCTION_SET_CONFIG = 13
• BrickletColor.FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 17
• BrickletColor.FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_PERIOD = 19

void BrickletColor.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.

Konstanten¶

int BrickletColor.DEVICE_IDENTIFIER¶

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

Diese Konstante stellt den Anzeigenamen eines Color Bricklet dar.