Dies ist die Beschreibung der Visual Basic .NET 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 Visual Basic .NET API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
1Imports System
2Imports Tinkerforge
3
4Module ExampleSimple
5 Const HOST As String = "localhost"
6 Const PORT As Integer = 4223
7 Const UID As String = "XYZ" ' Change XYZ to the UID of your Color Bricklet
8
9 Sub Main()
10 Dim ipcon As New IPConnection() ' Create IP connection
11 Dim c As New BrickletColor(UID, ipcon) ' Create device object
12
13 ipcon.Connect(HOST, PORT) ' Connect to brickd
14 ' Don't use device before ipcon is connected
15
16 ' Get current color
17 Dim r, g, b, c_ As Integer
18
19 c.GetColor(r, g, b, c_)
20
21 Console.WriteLine("Color [R]: " + r.ToString())
22 Console.WriteLine("Color [G]: " + g.ToString())
23 Console.WriteLine("Color [B]: " + b.ToString())
24 Console.WriteLine("Color [C]: " + c_.ToString())
25
26 Console.WriteLine("Press key to exit")
27 Console.ReadLine()
28 ipcon.Disconnect()
29 End Sub
30End Module
1Imports System
2Imports Tinkerforge
3
4Module ExampleCallback
5 Const HOST As String = "localhost"
6 Const PORT As Integer = 4223
7 Const UID As String = "XYZ" ' Change XYZ to the UID of your Color Bricklet
8
9 ' Callback subroutine for color callback
10 Sub ColorCB(ByVal sender As BrickletColor, ByVal r As Integer, ByVal g As Integer, _
11 ByVal b As Integer, ByVal c As Integer)
12 Console.WriteLine("Color [R]: " + r.ToString())
13 Console.WriteLine("Color [G]: " + g.ToString())
14 Console.WriteLine("Color [B]: " + b.ToString())
15 Console.WriteLine("Color [C]: " + c.ToString())
16 Console.WriteLine("")
17 End Sub
18
19 Sub Main()
20 Dim ipcon As New IPConnection() ' Create IP connection
21 Dim c As New BrickletColor(UID, ipcon) ' Create device object
22
23 ipcon.Connect(HOST, PORT) ' Connect to brickd
24 ' Don't use device before ipcon is connected
25
26 ' Register color callback to subroutine ColorCB
27 AddHandler c.ColorCallback, AddressOf ColorCB
28
29 ' Set period for color callback to 1s (1000ms)
30 ' Note: The color callback is only called every second
31 ' if the color has changed since the last call!
32 c.SetColorCallbackPeriod(1000)
33
34 Console.WriteLine("Press key to exit")
35 Console.ReadLine()
36 ipcon.Disconnect()
37 End Sub
38End Module
Download (ExampleThreshold.vb)
1Imports System
2Imports Tinkerforge
3
4Module ExampleThreshold
5 Const HOST As String = "localhost"
6 Const PORT As Integer = 4223
7 Const UID As String = "XYZ" ' Change XYZ to the UID of your Color Bricklet
8
9 ' Callback subroutine for color reached callback
10 Sub ColorReachedCB(ByVal sender As BrickletColor, ByVal r As Integer, _
11 ByVal g As Integer, ByVal b As Integer, ByVal c As Integer)
12 Console.WriteLine("Color [R]: " + r.ToString())
13 Console.WriteLine("Color [G]: " + g.ToString())
14 Console.WriteLine("Color [B]: " + b.ToString())
15 Console.WriteLine("Color [C]: " + c.ToString())
16 Console.WriteLine("")
17 End Sub
18
19 Sub Main()
20 Dim ipcon As New IPConnection() ' Create IP connection
21 Dim c As New BrickletColor(UID, ipcon) ' Create device object
22
23 ipcon.Connect(HOST, PORT) ' Connect to brickd
24 ' Don't use device before ipcon is connected
25
26 ' Get threshold callbacks with a debounce time of 10 seconds (10000ms)
27 c.SetDebouncePeriod(10000)
28
29 ' Register color reached callback to subroutine ColorReachedCB
30 AddHandler c.ColorReachedCallback, AddressOf ColorReachedCB
31
32 ' Configure threshold for color "greater than 100, 200, 300, 400"
33 c.SetColorCallbackThreshold(">"C, 100, 0, 200, 0, 300, 0, 400, 0)
34
35 Console.WriteLine("Press key to exit")
36 Console.ReadLine()
37 ipcon.Disconnect()
38 End Sub
39End Module
Da Visual Basic .NET nicht mehrere Rückgabewerte direkt unterstützt, wird das
ByRef Schlüsselwort genutzt um mehrere Werte von einer Funktion zurückzugeben.
Alle folgend aufgelisteten Funktionen und Prozeduren sind Thread-sicher.
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:
Dim color As New BrickletColor("YOUR_DEVICE_UID", ipcon)
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
| Ausgabeparameter: |
|
|---|
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.
Aktiviert die LED.
Deaktiviert die LED.
| Rückgabe: |
|
|---|
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
| Parameter: |
|
|---|
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
| Ausgabeparameter: |
|
|---|
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
| Rückgabe: |
|
|---|
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.
| Rückgabe: |
|
|---|
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.
| Ausgabeparameter: |
|
|---|
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.
| Parameter: |
|
|---|
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.
| Rückgabe: |
|
|---|
Gibt die Periode zurück, wie von SetColorCallbackPeriod() gesetzt.
| Parameter: |
|
|---|
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"C
BrickletColor.THRESHOLD_OPTION_OUTSIDE = "o"C
BrickletColor.THRESHOLD_OPTION_INSIDE = "i"C
BrickletColor.THRESHOLD_OPTION_SMALLER = "<"C
BrickletColor.THRESHOLD_OPTION_GREATER = ">"C
| Ausgabeparameter: |
|
|---|
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"C
BrickletColor.THRESHOLD_OPTION_OUTSIDE = "o"C
BrickletColor.THRESHOLD_OPTION_INSIDE = "i"C
BrickletColor.THRESHOLD_OPTION_SMALLER = "<"C
BrickletColor.THRESHOLD_OPTION_GREATER = ">"C
| Parameter: |
|
|---|
Setzt die Periode mit welcher die Schwellwert Callback
ausgelöst wird, wenn der Schwellwert
weiterhin erreicht bleibt.
| Rückgabe: |
|
|---|
Gibt die Entprellperiode zurück, wie von SetDebouncePeriod() gesetzt.
| Parameter: |
|
|---|
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.
| Rückgabe: |
|
|---|
Gibt die Periode zurück, wie von SetIlluminanceCallbackPeriod() gesetzt.
| Parameter: |
|
|---|
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.
| Rückgabe: |
|
|---|
Gibt die Periode zurück, wie von SetColorTemperatureCallbackPeriod() gesetzt.
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:
Sub MyCallback(ByVal sender As BrickletColor, ByVal value As Short) Console.WriteLine("Value: {0}", value) End Sub AddHandler color.ExampleCallback, AddressOf MyCallback
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.
| Callback-Parameter: |
|
|---|
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.
| Callback-Parameter: |
|
|---|
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.
| Callback-Parameter: |
|
|---|
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.
| Callback-Parameter: |
|
|---|
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 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.
| Ausgabeparameter: |
|
|---|
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.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
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
| Parameter: |
|
|---|
Ä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
| Parameter: |
|
|---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
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.
Diese Konstante stellt den Anzeigenamen eines Color Bricklet dar.