Mathematica - Color Bricklet 2.0

Dies ist die Beschreibung der Mathematica API Bindings für das Color Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Color Bricklet 2.0 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 2.0*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
c=NETNew["Tinkerforge.BrickletColorV2",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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

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

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
c=NETNew["Tinkerforge.BrickletColorV2",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 0.1s (100ms)*)
c@SetColorCallbackConfiguration[100,False]

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

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

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

colorV2=NETNew["Tinkerforge.BrickletColorV2","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.

BrickletColorV2@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. Der Wertebereich ist von 0 bis 65535.

Die rot (r), grün (g), blau (b) und clear (c) Farbanteile 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 SetColorCallbackConfiguration[] vorzugeben.

BrickletColorV2@GetIlluminance[] → illuminance
Rückgabe:
  • illuminance – Typ: Integer, Wertebereich: [0 bis 232 - 1]

Gibt die Beleuchtungsstärke beeinflusst durch die Verstärkung und die Integrationszeit zurück. Verstärkung und Integrationszeit können mit SetConfiguration[] 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 SetConfiguration[] reduziert werden.

Wenn der Wert periodisch benötigt wird, kann auch der IlluminanceCallback Callback verwendet werden. Der Callback wird mit der Funktion SetIlluminanceCallbackConfiguration[] konfiguriert.

BrickletColorV2@GetColorTemperature[] → colorTemperature
Rückgabe:
  • colorTemperature – Typ: Integer, Wertebereich: [0 bis 216 - 1]

Gibt die Farbtemperatur in Kelvin zurück.

Für eine korrekte Messung der Farbtemperatur 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 SetConfiguration[] reduziert werden.

Wenn der Wert periodisch benötigt wird, kann auch der ColorTemperatureCallback Callback verwendet werden. Der Callback wird mit der Funktion SetColorTemperatureCallbackConfiguration[] konfiguriert.

BrickletColorV2@SetLight[enable] → Null
Parameter:
  • enable – Typ: True/False

Aktiviert/deaktiviert die weiße LED auf dem Bricklet.

BrickletColorV2@GetLight[] → enable
Rückgabe:
  • enable – Typ: True/False

Gibt den Wert zurück, wie von SetLight[] gesetzt.

BrickletColorV2@SetConfiguration[gain, integrationTime] → Null
Parameter:
  • gain – Typ: Integer, Wertebereich: Siehe Konstanten
  • integrationTime – Typ: Integer, Wertebereich: Siehe Konstanten

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 Standardwerte sind 60x Verstärkung und 154ms Integrationszeit.

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

Für gain:

  • BrickletColorV2`GAINU1X = 0
  • BrickletColorV2`GAINU4X = 1
  • BrickletColorV2`GAINU16X = 2
  • BrickletColorV2`GAINU60X = 3

Für integrationTime:

  • BrickletColorV2`INTEGRATIONUTIMEU2MS = 0
  • BrickletColorV2`INTEGRATIONUTIMEU24MS = 1
  • BrickletColorV2`INTEGRATIONUTIMEU101MS = 2
  • BrickletColorV2`INTEGRATIONUTIMEU154MS = 3
  • BrickletColorV2`INTEGRATIONUTIMEU700MS = 4
BrickletColorV2@GetConfiguration[out gain, out integrationTime] → Null
Ausgabeparameter:
  • gain – Typ: Integer, Wertebereich: Siehe Konstanten
  • integrationTime – Typ: Integer, Wertebereich: Siehe Konstanten

Gibt die Einstellungen zurück, wie von SetConfiguration[] gesetzt.

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

Für gain:

  • BrickletColorV2`GAINU1X = 0
  • BrickletColorV2`GAINU4X = 1
  • BrickletColorV2`GAINU16X = 2
  • BrickletColorV2`GAINU60X = 3

Für integrationTime:

  • BrickletColorV2`INTEGRATIONUTIMEU2MS = 0
  • BrickletColorV2`INTEGRATIONUTIMEU24MS = 1
  • BrickletColorV2`INTEGRATIONUTIMEU101MS = 2
  • BrickletColorV2`INTEGRATIONUTIMEU154MS = 3
  • BrickletColorV2`INTEGRATIONUTIMEU700MS = 4

Fortgeschrittene Funktionen

BrickletColorV2@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}
Rückgabe:
  • apiVersioni – Typ: Integer, 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.

BrickletColorV2@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:

  • BrickletColorV2`FUNCTIONUSETUCOLORUCALLBACKUCONFIGURATION = 2
  • BrickletColorV2`FUNCTIONUSETUILLUMINANCEUCALLBACKUCONFIGURATION = 6
  • BrickletColorV2`FUNCTIONUSETUCOLORUTEMPERATUREUCALLBACKUCONFIGURATION = 10
  • BrickletColorV2`FUNCTIONUSETULIGHT = 13
  • BrickletColorV2`FUNCTIONUSETUCONFIGURATION = 15
  • BrickletColorV2`FUNCTIONUSETUWRITEUFIRMWAREUPOINTER = 237
  • BrickletColorV2`FUNCTIONUSETUSTATUSULEDUCONFIG = 239
  • BrickletColorV2`FUNCTIONURESET = 243
  • BrickletColorV2`FUNCTIONUWRITEUUID = 248
BrickletColorV2@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:

  • BrickletColorV2`FUNCTIONUSETUCOLORUCALLBACKUCONFIGURATION = 2
  • BrickletColorV2`FUNCTIONUSETUILLUMINANCEUCALLBACKUCONFIGURATION = 6
  • BrickletColorV2`FUNCTIONUSETUCOLORUTEMPERATUREUCALLBACKUCONFIGURATION = 10
  • BrickletColorV2`FUNCTIONUSETULIGHT = 13
  • BrickletColorV2`FUNCTIONUSETUCONFIGURATION = 15
  • BrickletColorV2`FUNCTIONUSETUWRITEUFIRMWAREUPOINTER = 237
  • BrickletColorV2`FUNCTIONUSETUSTATUSULEDUCONFIG = 239
  • BrickletColorV2`FUNCTIONURESET = 243
  • BrickletColorV2`FUNCTIONUWRITEUUID = 248
BrickletColorV2@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.

BrickletColorV2@GetSPITFPErrorCount[out errorCountAckChecksum, out errorCountMessageChecksum, out errorCountFrame, out errorCountOverflow] → Null
Ausgabeparameter:
  • errorCountAckChecksum – Typ: Integer, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: Integer, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: Integer, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: Integer, 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.

BrickletColorV2@SetBootloaderMode[mode] → status
Parameter:
  • mode – Typ: Integer, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: Integer, 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:

  • BrickletColorV2`BOOTLOADERUMODEUBOOTLOADER = 0
  • BrickletColorV2`BOOTLOADERUMODEUFIRMWARE = 1
  • BrickletColorV2`BOOTLOADERUMODEUBOOTLOADERUWAITUFORUREBOOT = 2
  • BrickletColorV2`BOOTLOADERUMODEUFIRMWAREUWAITUFORUREBOOT = 3
  • BrickletColorV2`BOOTLOADERUMODEUFIRMWAREUWAITUFORUERASEUANDUREBOOT = 4

Für status:

  • BrickletColorV2`BOOTLOADERUSTATUSUOK = 0
  • BrickletColorV2`BOOTLOADERUSTATUSUINVALIDUMODE = 1
  • BrickletColorV2`BOOTLOADERUSTATUSUNOUCHANGE = 2
  • BrickletColorV2`BOOTLOADERUSTATUSUENTRYUFUNCTIONUNOTUPRESENT = 3
  • BrickletColorV2`BOOTLOADERUSTATUSUDEVICEUIDENTIFIERUINCORRECT = 4
  • BrickletColorV2`BOOTLOADERUSTATUSUCRCUMISMATCH = 5
BrickletColorV2@GetBootloaderMode[] → mode
Rückgabe:
  • mode – Typ: Integer, 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:

  • BrickletColorV2`BOOTLOADERUMODEUBOOTLOADER = 0
  • BrickletColorV2`BOOTLOADERUMODEUFIRMWARE = 1
  • BrickletColorV2`BOOTLOADERUMODEUBOOTLOADERUWAITUFORUREBOOT = 2
  • BrickletColorV2`BOOTLOADERUMODEUFIRMWAREUWAITUFORUREBOOT = 3
  • BrickletColorV2`BOOTLOADERUMODEUFIRMWAREUWAITUFORUERASEUANDUREBOOT = 4
BrickletColorV2@SetWriteFirmwarePointer[pointer] → Null
Parameter:
  • pointer – Typ: Integer, 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.

BrickletColorV2@WriteFirmware[{data1, data2, ..., data64}] → status
Parameter:
  • datai – Typ: Integer, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: Integer, 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.

BrickletColorV2@SetStatusLEDConfig[config] → Null
Parameter:
  • config – Typ: Integer, Wertebereich: Siehe Konstanten

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:

  • BrickletColorV2`STATUSULEDUCONFIGUOFF = 0
  • BrickletColorV2`STATUSULEDUCONFIGUON = 1
  • BrickletColorV2`STATUSULEDUCONFIGUSHOWUHEARTBEAT = 2
  • BrickletColorV2`STATUSULEDUCONFIGUSHOWUSTATUS = 3
BrickletColorV2@GetStatusLEDConfig[] → config
Rückgabe:
  • config – Typ: Integer, Wertebereich: Siehe Konstanten

Gibt die Konfiguration zurück, wie von SetStatusLEDConfig[] gesetzt.

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

Für config:

  • BrickletColorV2`STATUSULEDUCONFIGUOFF = 0
  • BrickletColorV2`STATUSULEDUCONFIGUON = 1
  • BrickletColorV2`STATUSULEDUCONFIGUSHOWUHEARTBEAT = 2
  • BrickletColorV2`STATUSULEDUCONFIGUSHOWUSTATUS = 3
BrickletColorV2@GetChipTemperature[] → temperature
Rückgabe:
  • temperature – Typ: Integer, 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.

BrickletColorV2@Reset[] → Null

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.

BrickletColorV2@WriteUID[uid] → Null
Parameter:
  • uid – Typ: Integer, 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.

BrickletColorV2@ReadUID[] → uid
Rückgabe:
  • uid – Typ: Integer, 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.

BrickletColorV2@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
  • hardwareVersioni – Typ: Integer, Wertebereich: [0 bis 255]
  • firmwareVersioni – 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 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

BrickletColorV2@SetColorCallbackConfiguration[period, valueHasToChange] → Null
Parameter:
  • period – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: True/False, Standardwert: False

Die Periode ist die Periode mit der der ColorCallback 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.

BrickletColorV2@GetColorCallbackConfiguration[out period, out valueHasToChange] → Null
Ausgabeparameter:
  • period – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: True/False, Standardwert: False

Gibt die Callback-Konfiguration zurück, wie mittels SetColorCallbackConfiguration[] gesetzt.

BrickletColorV2@SetIlluminanceCallbackConfiguration[period, valueHasToChange, option, min, max] → Null
Parameter:
  • period – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: True/False, Standardwert: False
  • option – Typ: Integer, Wertebereich: Siehe Konstanten, Standardwert: ToCharacterCode["x"][[0]]
  • min – Typ: Integer, Wertebereich: [0 bis 232 - 1]
  • max – Typ: Integer, Wertebereich: [0 bis 232 - 1]

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.

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

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

Für option:

  • BrickletColorV2`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletColorV2`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletColorV2`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletColorV2`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletColorV2`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletColorV2@GetIlluminanceCallbackConfiguration[out period, out valueHasToChange, out option, out min, out max] → Null
Ausgabeparameter:
  • period – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: True/False, Standardwert: False
  • option – Typ: Integer, Wertebereich: Siehe Konstanten, Standardwert: ToCharacterCode["x"][[0]]
  • min – Typ: Integer, Wertebereich: [0 bis 232 - 1]
  • max – Typ: Integer, Wertebereich: [0 bis 232 - 1]

Gibt die Callback-Konfiguration zurück, wie mittels SetIlluminanceCallbackConfiguration[] gesetzt.

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

Für option:

  • BrickletColorV2`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletColorV2`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletColorV2`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletColorV2`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletColorV2`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletColorV2@SetColorTemperatureCallbackConfiguration[period, valueHasToChange, option, min, max] → Null
Parameter:
  • period – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: True/False, Standardwert: False
  • option – Typ: Integer, Wertebereich: Siehe Konstanten, Standardwert: ToCharacterCode["x"][[0]]
  • min – Typ: Integer, Wertebereich: [0 bis 216 - 1]
  • max – Typ: Integer, Wertebereich: [0 bis 216 - 1]

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

  • BrickletColorV2`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletColorV2`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletColorV2`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletColorV2`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletColorV2`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletColorV2@GetColorTemperatureCallbackConfiguration[out period, out valueHasToChange, out option, out min, out max] → Null
Ausgabeparameter:
  • period – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: True/False, Standardwert: False
  • option – Typ: Integer, Wertebereich: Siehe Konstanten, Standardwert: ToCharacterCode["x"][[0]]
  • min – Typ: Integer, Wertebereich: [0 bis 216 - 1]
  • max – Typ: Integer, Wertebereich: [0 bis 216 - 1]

Gibt die Callback-Konfiguration zurück, wie mittels SetColorTemperatureCallbackConfiguration[] gesetzt.

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

Für option:

  • BrickletColorV2`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletColorV2`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletColorV2`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletColorV2`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletColorV2`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]

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[colorV2@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 BrickletColorV2@ColorCallback[sender, r, g, b, c]
Callback-Parameter:
  • sender – Typ: NETObject[BrickletColorV2]
  • 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 SetColorCallbackConfiguration[], 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 BrickletColorV2@IlluminanceCallback[sender, illuminance]
Callback-Parameter:
  • sender – Typ: NETObject[BrickletColorV2]
  • illuminance – Typ: Integer, 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[].

event BrickletColorV2@ColorTemperatureCallback[sender, colorTemperature]
Callback-Parameter:
  • sender – Typ: NETObject[BrickletColorV2]
  • colorTemperature – Typ: Integer, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels SetColorTemperatureCallbackConfiguration[] gesetzten Konfiguration

Der Parameter ist der gleiche wie GetColorTemperature[].

Konstanten

BrickletColorV2`DEVICEUIDENTIFIER

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

BrickletColorV2`DEVICEDISPLAYNAME

Diese Konstante stellt den Anzeigenamen eines Color Bricklet 2.0 dar.