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).
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 | Imports System
Imports Tinkerforge
Module ExampleSimple
Const HOST As String = "localhost"
Const PORT As Integer = 4223
Const UID As String = "XYZ" ' Change XYZ to the UID of your Color Bricklet
Sub Main()
Dim ipcon As New IPConnection() ' Create IP connection
Dim c As New BrickletColor(UID, ipcon) ' Create device object
ipcon.Connect(HOST, PORT) ' Connect to brickd
' Don't use device before ipcon is connected
' Get current color
Dim r, g, b, c_ As Integer
c.GetColor(r, g, b, c_)
Console.WriteLine("Color [R]: " + r.ToString())
Console.WriteLine("Color [G]: " + g.ToString())
Console.WriteLine("Color [B]: " + b.ToString())
Console.WriteLine("Color [C]: " + c_.ToString())
Console.WriteLine("Press key to exit")
Console.ReadLine()
ipcon.Disconnect()
End Sub
End Module
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 | Imports System
Imports Tinkerforge
Module ExampleCallback
Const HOST As String = "localhost"
Const PORT As Integer = 4223
Const UID As String = "XYZ" ' Change XYZ to the UID of your Color Bricklet
' Callback subroutine for color callback
Sub ColorCB(ByVal sender As BrickletColor, ByVal r As Integer, ByVal g As Integer, _
ByVal b As Integer, ByVal c As Integer)
Console.WriteLine("Color [R]: " + r.ToString())
Console.WriteLine("Color [G]: " + g.ToString())
Console.WriteLine("Color [B]: " + b.ToString())
Console.WriteLine("Color [C]: " + c.ToString())
Console.WriteLine("")
End Sub
Sub Main()
Dim ipcon As New IPConnection() ' Create IP connection
Dim c As New 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 subroutine ColorCB
AddHandler c.ColorCallback, AddressOf 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)
Console.WriteLine("Press key to exit")
Console.ReadLine()
ipcon.Disconnect()
End Sub
End Module
|
Download (ExampleThreshold.vb)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 | Imports System
Imports Tinkerforge
Module ExampleThreshold
Const HOST As String = "localhost"
Const PORT As Integer = 4223
Const UID As String = "XYZ" ' Change XYZ to the UID of your Color Bricklet
' Callback subroutine for color reached callback
Sub ColorReachedCB(ByVal sender As BrickletColor, ByVal r As Integer, _
ByVal g As Integer, ByVal b As Integer, ByVal c As Integer)
Console.WriteLine("Color [R]: " + r.ToString())
Console.WriteLine("Color [G]: " + g.ToString())
Console.WriteLine("Color [B]: " + b.ToString())
Console.WriteLine("Color [C]: " + c.ToString())
Console.WriteLine("")
End Sub
Sub Main()
Dim ipcon As New IPConnection() ' Create IP connection
Dim c As New 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 subroutine ColorReachedCB
AddHandler c.ColorReachedCallback, AddressOf ColorReachedCB
' Configure threshold for color "greater than 100, 200, 300, 400"
c.SetColorCallbackThreshold(">"C, 100, 0, 200, 0, 300, 0, 400, 0)
Console.WriteLine("Press key to exit")
Console.ReadLine()
ipcon.Disconnect()
End Sub
End 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.
BrickletColor
(ByVal uid As String, ByVal ipcon As IPConnection)¶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.
BrickletColor.
GetColor
(ByRef r As Integer, ByRef g As Integer, ByRef b As Integer, ByRef c As Integer)¶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.
BrickletColor.
LightOn
()¶Aktiviert die LED.
BrickletColor.
LightOff
()¶Deaktiviert die LED.
BrickletColor.
IsLightOn
() As Byte¶Rückgabe: |
|
---|
Gibt den Zustand der LED zurück. Mögliche Werte sind:
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für light:
BrickletColor.
SetConfig
(ByVal gain As Byte, ByVal integrationTime As Byte)¶Parameter: |
|
---|
Setzt die Konfiguration des Sensors. Verstärkung und Integrationszeit können eingestellt werden.
Für die Konfiguration der Verstärkung:
Für die Konfiguration der Integrationszeit:
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:
Für integrationTime:
BrickletColor.
GetConfig
(ByRef gain As Byte, ByRef integrationTime As Byte)¶Ausgabeparameter: |
|
---|
Gibt die Einstellungen zurück, wie von SetConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für gain:
Für integrationTime:
BrickletColor.
GetIlluminance
() As Long¶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.
BrickletColor.
GetColorTemperature
() As Integer¶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.
BrickletColor.
GetIdentity
(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)¶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.
BrickletColor.
SetColorCallbackPeriod
(ByVal period As Long)¶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.
BrickletColor.
GetColorCallbackPeriod
() As Long¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetColorCallbackPeriod()
gesetzt.
BrickletColor.
SetColorCallbackThreshold
(ByVal option As Char, ByVal minR As Integer, ByVal maxR As Integer, ByVal minG As Integer, ByVal maxG As Integer, ByVal minB As Integer, ByVal maxB As Integer, ByVal minC As Integer, ByVal maxC As Integer)¶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.
GetColorCallbackThreshold
(ByRef option As Char, ByRef minR As Integer, ByRef maxR As Integer, ByRef minG As Integer, ByRef maxG As Integer, ByRef minB As Integer, ByRef maxB As Integer, ByRef minC As Integer, ByRef maxC As Integer)¶Ausgabeparameter: |
|
---|
Gibt den Schwellwert zurück, wie von SetColorCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletColor.
SetDebouncePeriod
(ByVal debounce As Long)¶Parameter: |
|
---|
Setzt die Periode mit welcher die Schwellwert Callback
ausgelöst wird, wenn der Schwellwert
weiterhin erreicht bleibt.
BrickletColor.
GetDebouncePeriod
() As Long¶Rückgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von SetDebouncePeriod()
gesetzt.
BrickletColor.
SetIlluminanceCallbackPeriod
(ByVal period As Long)¶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.
BrickletColor.
GetIlluminanceCallbackPeriod
() As Long¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetIlluminanceCallbackPeriod()
gesetzt.
BrickletColor.
SetColorTemperatureCallbackPeriod
(ByVal period As Long)¶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.
BrickletColor.
GetColorTemperatureCallbackPeriod
() As Long¶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.
BrickletColor.
ColorCallback
(ByVal sender As BrickletColor, ByVal r As Integer, ByVal g As Integer, ByVal b As Integer, ByVal c As Integer)¶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.
BrickletColor.
ColorReachedCallback
(ByVal sender As BrickletColor, ByVal r As Integer, ByVal g As Integer, ByVal b As Integer, ByVal c As Integer)¶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.
BrickletColor.
IlluminanceCallback
(ByVal sender As BrickletColor, ByVal illuminance As Long)¶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.
BrickletColor.
ColorTemperatureCallback
(ByVal sender As BrickletColor, ByVal colorTemperature As Integer)¶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.
BrickletColor.
GetAPIVersion
() As Byte()¶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.
BrickletColor.
GetResponseExpected
(ByVal functionId As Byte) As Boolean¶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.
SetResponseExpected
(ByVal functionId As Byte, ByVal responseExpected As Boolean)¶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.
SetResponseExpectedAll
(ByVal responseExpected As Boolean)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
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.
BrickletColor.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Color Bricklet dar.