Visual Basic .NET - Color Bricklet

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.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.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
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

Callback

Download (ExampleCallback.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
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

Threshold

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

API

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.

Grundfunktionen

Class 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 (siehe Beispiele oben).

Sub BrickletColor.GetColor(ByRef r As Integer, ByRef g As Integer, ByRef b As Integer, ByRef c As Integer)

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) 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.

Sub BrickletColor.LightOn()

Aktiviert die LED.

Sub BrickletColor.LightOff()

Deaktiviert die LED.

Function BrickletColor.IsLightOn() As Byte

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:

  • BrickletColor.LIGHT_ON = 0
  • BrickletColor.LIGHT_OFF = 1
Sub BrickletColor.SetConfig(ByVal gain As Byte, ByVal integrationTime As Byte)

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:

  • BrickletColor.GAIN_1X = 0
  • BrickletColor.GAIN_4X = 1
  • BrickletColor.GAIN_16X = 2
  • BrickletColor.GAIN_60X = 3
  • 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
Sub BrickletColor.GetConfig(ByRef gain As Byte, ByRef integrationTime As Byte)

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

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

  • BrickletColor.GAIN_1X = 0
  • BrickletColor.GAIN_4X = 1
  • BrickletColor.GAIN_16X = 2
  • BrickletColor.GAIN_60X = 3
  • 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
Function BrickletColor.GetIlluminance() As Long

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.

Function BrickletColor.GetColorTemperature() As Integer

Gibt die Farbtemperatur in Kelvin 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

Function BrickletColor.GetAPIVersion() As Byte()

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.

Function BrickletColor.GetResponseExpected(ByVal functionId As Byte) As 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:

  • 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
Sub BrickletColor.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As 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:

  • 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
Sub BrickletColor.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

Sub 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)

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

Sub BrickletColor.SetColorCallbackPeriod(ByVal period As Long)

Setzt die Periode in ms 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.

Der Standardwert ist 0.

Function BrickletColor.GetColorCallbackPeriod() As Long

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

Sub 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)

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)

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

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

  • 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
Sub 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)

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

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

  • 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
Sub BrickletColor.SetDebouncePeriod(ByVal debounce As Long)

Setzt die Periode in ms mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

Function BrickletColor.GetDebouncePeriod() As Long

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

Sub BrickletColor.SetIlluminanceCallbackPeriod(ByVal period As Long)

Setzt die Periode in ms 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.

Der Standardwert ist 0.

Function BrickletColor.GetIlluminanceCallbackPeriod() As Long

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

Sub BrickletColor.SetColorTemperatureCallbackPeriod(ByVal period As Long)

Setzt die Periode in ms 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.

Der Standardwert ist 0.

Function BrickletColor.GetColorTemperatureCallbackPeriod() As Long

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

Event BrickletColor.ColorCallback(ByVal sender As BrickletColor, ByVal r As Integer, ByVal g As Integer, ByVal b As Integer, ByVal c As Integer)

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(ByVal sender As BrickletColor, ByVal r As Integer, ByVal g As Integer, ByVal b As Integer, ByVal c As Integer)

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(ByVal sender As BrickletColor, ByVal illuminance As Long)

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(ByVal sender As BrickletColor, ByVal colorTemperature As Integer)

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

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

Konstanten

Const 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.

Const BrickletColor.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Color Bricklet dar.