Mathematica - Color Bricklet

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

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.nb)

 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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Color Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
c=NETNew["Tinkerforge.BrickletColor",uid,ipcon]
ipcon@Connect[host,port]

(*Get current color*)
r=0;g=0;b=0;cU=0
c@GetColor[r,g,b,cU]

Print["Color [R]: "<>ToString[r]]
Print["Color [G]: "<>ToString[g]]
Print["Color [B]: "<>ToString[b]]
Print["Color [C]: "<>ToString[cU]]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[c]
ReleaseNETObject[ipcon]

Callback

Download (ExampleCallback.nb)

 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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Color Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
c=NETNew["Tinkerforge.BrickletColor",uid,ipcon]
ipcon@Connect[host,port]

(*Callback function for color callback*)
ColorCB[sender_,r_,g_,b_,c_]:=
 Module[{},
  Print["Color [R]: "<>ToString[r]];
  Print["Color [G]: "<>ToString[g]];
  Print["Color [B]: "<>ToString[b]];
  Print["Color [C]: "<>ToString[c]]
 ]

AddEventHandler[c@ColorCallback,ColorCB]

(*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["Click OK to exit"]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[c]
ReleaseNETObject[ipcon]

Threshold

Download (ExampleThreshold.nb)

 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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Color Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
c=NETNew["Tinkerforge.BrickletColor",uid,ipcon]
ipcon@Connect[host,port]

(*Get threshold callbacks with a debounce time of 10 seconds (10000ms)*)
c@SetDebouncePeriod[10000]

(*Callback function for color reached callback*)
ColorReachedCB[sender_,r_,g_,b_,c_]:=
 Module[{},
  Print["Color [R]: "<>ToString[r]];
  Print["Color [G]: "<>ToString[g]];
  Print["Color [B]: "<>ToString[b]];
  Print["Color [C]: "<>ToString[c]]
 ]

AddEventHandler[c@ColorReachedCallback,ColorReachedCB]

(*Configure threshold for color "greater than 100, 200, 300, 400"*)
option=Tinkerforge`BrickletColor`THRESHOLDUOPTIONUGREATER
c@SetColorCallbackThreshold[option,100,0,200,0,300,0,400,0]

Input["Click OK to exit"]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[c]
ReleaseNETObject[ipcon]

API

Prinzipiell kann jede Funktion der Mathematica Bindings, welche einen Wert zurück gibt eine Tinkerforge.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.

Da .NET/Link nicht mehrere Rückgabewerte direkt unterstützt, wird das out Schlüsselwort genutzt, um mehrere Werte aus einer Funktion zurückzugeben. Weitere Informationen über das out Schlüsselwort in .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist Tinkerforge.*.

Grundfunktionen

BrickletColor[uid, ipcon] → color
Parameter:
  • uid – Typ: String
  • ipcon – Typ: NETObject[IPConnection]
Rückgabe:
  • color – Typ: NETObject[BrickletColor]

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

color=NETNew["Tinkerforge.BrickletColor","YOUR_DEVICE_UID",ipcon]

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

Die .NET Runtime hat eingebauten Garbage Collection welche Objekte wieder freigibt, wenn sie vom Programm nicht mehr verwendet werden. Da Mathematica aber selbst nicht automatisch feststellen kann, wann ein Mathematica "Programm" ein .NET Objekt nicht mehr verwendet, muss sich das Programm selbst darum kümmern. Für diesen Zweck wird die ReleaseNETObject[] Funktion in den Beispielen verwendet.

Weitere Informationen über Objekt-Verwaltung mittels .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

BrickletColor@GetColor[out r, out g, out b, out c] → Null
Ausgabeparameter:
  • r – Typ: Integer, Wertebereich: [0 bis 216 - 1]
  • g – Typ: Integer, Wertebereich: [0 bis 216 - 1]
  • b – Typ: Integer, Wertebereich: [0 bis 216 - 1]
  • c – Typ: Integer, 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:

Chart Responsivity / Wavelength

Wenn die Farbe periodisch abgefragt werden soll, wird empfohlen den ColorCallback Callback zu nutzen und die Periode mit SetColorCallbackPeriod[] vorzugeben.

BrickletColor@LightOn[] → Null

Aktiviert die LED.

BrickletColor@LightOff[] → Null

Deaktiviert die LED.

BrickletColor@IsLightOn[] → light
Rückgabe:
  • light – Typ: Integer, 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`LIGHTUON = 0
  • BrickletColor`LIGHTUOFF = 1
BrickletColor@SetConfig[gain, integrationTime] → Null
Parameter:
  • gain – Typ: Integer, Wertebereich: Siehe Konstanten, Standardwert: 3
  • integrationTime – Typ: Integer, 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`GAINU1X = 0
  • BrickletColor`GAINU4X = 1
  • BrickletColor`GAINU16X = 2
  • BrickletColor`GAINU60X = 3

Für integrationTime:

  • BrickletColor`INTEGRATIONUTIMEU2MS = 0
  • BrickletColor`INTEGRATIONUTIMEU24MS = 1
  • BrickletColor`INTEGRATIONUTIMEU101MS = 2
  • BrickletColor`INTEGRATIONUTIMEU154MS = 3
  • BrickletColor`INTEGRATIONUTIMEU700MS = 4
BrickletColor@GetConfig[out gain, out integrationTime] → Null
Ausgabeparameter:
  • gain – Typ: Integer, Wertebereich: Siehe Konstanten, Standardwert: 3
  • integrationTime – Typ: Integer, 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`GAINU1X = 0
  • BrickletColor`GAINU4X = 1
  • BrickletColor`GAINU16X = 2
  • BrickletColor`GAINU60X = 3

Für integrationTime:

  • BrickletColor`INTEGRATIONUTIMEU2MS = 0
  • BrickletColor`INTEGRATIONUTIMEU24MS = 1
  • BrickletColor`INTEGRATIONUTIMEU101MS = 2
  • BrickletColor`INTEGRATIONUTIMEU154MS = 3
  • BrickletColor`INTEGRATIONUTIMEU700MS = 4
BrickletColor@GetIlluminance[] → illuminance
Rückgabe:
  • illuminance – Typ: Integer, 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.

BrickletColor@GetColorTemperature[] → colorTemperature
Rückgabe:
  • colorTemperature – Typ: Integer, 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@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null
Ausgabeparameter:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: Integer, Wertebereich: [ToCharacterCode["a"][[0]] bis ToCharacterCode["h"][[0]], ToCharacterCode["i"][[0]], ToCharacterCode["z"][[0]]]
  • hardwareVersioni – Typ: Integer
    • 1: major – Typ: Integer, Wertebereich: [0 bis 255]
    • 2: minor – Typ: Integer, Wertebereich: [0 bis 255]
    • 3: revision – Typ: Integer, Wertebereich: [0 bis 255]
  • firmwareVersioni – Typ: Integer
    • 1: major – Typ: Integer, Wertebereich: [0 bis 255]
    • 2: minor – Typ: Integer, Wertebereich: [0 bis 255]
    • 3: revision – Typ: Integer, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: Integer, 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

BrickletColor@SetColorCallbackPeriod[period] → Null
Parameter:
  • period – Typ: Integer, 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.

BrickletColor@GetColorCallbackPeriod[] → period
Rückgabe:
  • period – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetColorCallbackPeriod[] gesetzt.

BrickletColor@SetColorCallbackThreshold[option, minR, maxR, minG, maxG, minB, maxB, minC, maxC] → Null
Parameter:
  • option – Typ: Integer, Wertebereich: Siehe Konstanten, Standardwert: ToCharacterCode["x"][[0]]
  • minR – Typ: Integer, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxR – Typ: Integer, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • minG – Typ: Integer, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxG – Typ: Integer, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • minB – Typ: Integer, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxB – Typ: Integer, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • minC – Typ: Integer, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxC – Typ: Integer, 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`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletColor`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletColor`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletColor`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletColor`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletColor@GetColorCallbackThreshold[out option, out minR, out maxR, out minG, out maxG, out minB, out maxB, out minC, out maxC] → Null
Ausgabeparameter:
  • option – Typ: Integer, Wertebereich: Siehe Konstanten, Standardwert: ToCharacterCode["x"][[0]]
  • minR – Typ: Integer, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxR – Typ: Integer, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • minG – Typ: Integer, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxG – Typ: Integer, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • minB – Typ: Integer, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxB – Typ: Integer, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • minC – Typ: Integer, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxC – Typ: Integer, 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`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletColor`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletColor`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletColor`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletColor`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletColor@SetDebouncePeriod[debounce] → Null
Parameter:
  • debounce – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

BrickletColor@GetDebouncePeriod[] → debounce
Rückgabe:
  • debounce – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von SetDebouncePeriod[] gesetzt.

BrickletColor@SetIlluminanceCallbackPeriod[period] → Null
Parameter:
  • period – Typ: Integer, 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.

BrickletColor@GetIlluminanceCallbackPeriod[] → period
Rückgabe:
  • period – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetIlluminanceCallbackPeriod[] gesetzt.

BrickletColor@SetColorTemperatureCallbackPeriod[period] → Null
Parameter:
  • period – Typ: Integer, 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.

BrickletColor@GetColorTemperatureCallbackPeriod[] → period
Rückgabe:
  • period – Typ: Integer, 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 erfolgt indem eine Funktion einem Callback Property des Geräte Objektes zugewiesen wird:

MyCallback[sender_,value_]:=Print["Value: "<>ToString[value]]

AddEventHandler[color@ExampleCallback,MyCallback]

Weitere Informationen über Event-Behandlung mittels .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

Die verfügbaren Callback Properties und ihre Parametertypen 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.

event BrickletColor@ColorCallback[sender, r, g, b, c]
Callback-Parameter:
  • sender – Typ: NETObject[BrickletColor]
  • r – Typ: Integer, Wertebereich: [0 bis 216 - 1]
  • g – Typ: Integer, Wertebereich: [0 bis 216 - 1]
  • b – Typ: Integer, Wertebereich: [0 bis 216 - 1]
  • c – Typ: Integer, 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.

event BrickletColor@ColorReachedCallback[sender, r, g, b, c]
Callback-Parameter:
  • sender – Typ: NETObject[BrickletColor]
  • r – Typ: Integer, Wertebereich: [0 bis 216 - 1]
  • g – Typ: Integer, Wertebereich: [0 bis 216 - 1]
  • b – Typ: Integer, Wertebereich: [0 bis 216 - 1]
  • c – Typ: Integer, 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.

event BrickletColor@IlluminanceCallback[sender, illuminance]
Callback-Parameter:
  • sender – Typ: NETObject[BrickletColor]
  • illuminance – Typ: Integer, 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.

event BrickletColor@ColorTemperatureCallback[sender, colorTemperature]
Callback-Parameter:
  • sender – Typ: NETObject[BrickletColor]
  • colorTemperature – Typ: Integer, 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.

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.

BrickletColor@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}
Ausgabeparameter:
  • apiVersioni – Typ: Integer
    • 1: major – Typ: Integer, Wertebereich: [0 bis 255]
    • 2: minor – Typ: Integer, Wertebereich: [0 bis 255]
    • 3: revision – Typ: Integer, 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.

BrickletColor@GetResponseExpected[functionId] → responseExpected
Parameter:
  • functionId – Typ: Integer, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: True/False

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`FUNCTIONUSETUCOLORUCALLBACKUPERIOD = 2
  • BrickletColor`FUNCTIONUSETUCOLORUCALLBACKUTHRESHOLD = 4
  • BrickletColor`FUNCTIONUSETUDEBOUNCEUPERIOD = 6
  • BrickletColor`FUNCTIONULIGHTUON = 10
  • BrickletColor`FUNCTIONULIGHTUOFF = 11
  • BrickletColor`FUNCTIONUSETUCONFIG = 13
  • BrickletColor`FUNCTIONUSETUILLUMINANCEUCALLBACKUPERIOD = 17
  • BrickletColor`FUNCTIONUSETUCOLORUTEMPERATUREUCALLBACKUPERIOD = 19
BrickletColor@SetResponseExpected[functionId, responseExpected] → Null
Parameter:
  • functionId – Typ: Integer, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: True/False

Ä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`FUNCTIONUSETUCOLORUCALLBACKUPERIOD = 2
  • BrickletColor`FUNCTIONUSETUCOLORUCALLBACKUTHRESHOLD = 4
  • BrickletColor`FUNCTIONUSETUDEBOUNCEUPERIOD = 6
  • BrickletColor`FUNCTIONULIGHTUON = 10
  • BrickletColor`FUNCTIONULIGHTUOFF = 11
  • BrickletColor`FUNCTIONUSETUCONFIG = 13
  • BrickletColor`FUNCTIONUSETUILLUMINANCEUCALLBACKUPERIOD = 17
  • BrickletColor`FUNCTIONUSETUCOLORUTEMPERATUREUCALLBACKUPERIOD = 19
BrickletColor@SetResponseExpectedAll[responseExpected] → Null
Parameter:
  • responseExpected – Typ: True/False

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

Konstanten

BrickletColor`DEVICEUIDENTIFIER

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.

BrickletColor`DEVICEDISPLAYNAME

Diese Konstante stellt den Anzeigenamen eines Color Bricklet dar.