Visual Basic .NET - Color Bricklet 2.0

Dies ist die Beschreibung der Visual Basic .NET 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 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 2.0

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim c As New BrickletColorV2(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
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 2.0

    ' Callback subroutine for color callback
    Sub ColorCB(ByVal sender As BrickletColorV2, 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 BrickletColorV2(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 0.1s (100ms)
        c.SetColorCallbackConfiguration(100, False)

        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 BrickletColorV2(ByVal uid As String, ByVal ipcon As IPConnection)

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

Dim colorV2 As New BrickletColorV2("YOUR_DEVICE_UID", ipcon)

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

Sub BrickletColorV2.GetColor(ByRef r As Integer, ByRef g As Integer, ByRef b As Integer, ByRef c As Integer)
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.

Function BrickletColorV2.GetIlluminance() As Long
Rückgabe:
  • illuminance – Typ: Long, 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.

Function BrickletColorV2.GetColorTemperature() As Integer
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.

Sub BrickletColorV2.SetLight(ByVal enable As Boolean)
Parameter:
  • enable – Typ: Boolean

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

Function BrickletColorV2.GetLight() As Boolean
Rückgabe:
  • enable – Typ: Boolean

Gibt den Wert zurück, wie von SetLight() gesetzt.

Sub BrickletColorV2.SetConfiguration(ByVal gain As Byte, ByVal integrationTime As Byte)
Parameter:
  • gain – Typ: Byte, Wertebereich: Siehe Konstanten
  • integrationTime – Typ: Byte, 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.GAIN_1X = 0
  • BrickletColorV2.GAIN_4X = 1
  • BrickletColorV2.GAIN_16X = 2
  • BrickletColorV2.GAIN_60X = 3

Für integrationTime:

  • BrickletColorV2.INTEGRATION_TIME_2MS = 0
  • BrickletColorV2.INTEGRATION_TIME_24MS = 1
  • BrickletColorV2.INTEGRATION_TIME_101MS = 2
  • BrickletColorV2.INTEGRATION_TIME_154MS = 3
  • BrickletColorV2.INTEGRATION_TIME_700MS = 4
Sub BrickletColorV2.GetConfiguration(ByRef gain As Byte, ByRef integrationTime As Byte)
Ausgabeparameter:
  • gain – Typ: Byte, Wertebereich: Siehe Konstanten
  • integrationTime – Typ: Byte, 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.GAIN_1X = 0
  • BrickletColorV2.GAIN_4X = 1
  • BrickletColorV2.GAIN_16X = 2
  • BrickletColorV2.GAIN_60X = 3

Für integrationTime:

  • BrickletColorV2.INTEGRATION_TIME_2MS = 0
  • BrickletColorV2.INTEGRATION_TIME_24MS = 1
  • BrickletColorV2.INTEGRATION_TIME_101MS = 2
  • BrickletColorV2.INTEGRATION_TIME_154MS = 3
  • BrickletColorV2.INTEGRATION_TIME_700MS = 4

Fortgeschrittene Funktionen

Function BrickletColorV2.GetAPIVersion() As Byte()
Rückgabe:
  • apiVersion – Typ: Byte Array, Länge: 3, 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.

Function BrickletColorV2.GetResponseExpected(ByVal functionId As Byte) As Boolean
Parameter:
  • functionId – Typ: Byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: 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:

Für functionId:

  • BrickletColorV2.FUNCTION_SET_COLOR_CALLBACK_CONFIGURATION = 2
  • BrickletColorV2.FUNCTION_SET_ILLUMINANCE_CALLBACK_CONFIGURATION = 6
  • BrickletColorV2.FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_CONFIGURATION = 10
  • BrickletColorV2.FUNCTION_SET_LIGHT = 13
  • BrickletColorV2.FUNCTION_SET_CONFIGURATION = 15
  • BrickletColorV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletColorV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletColorV2.FUNCTION_RESET = 243
  • BrickletColorV2.FUNCTION_WRITE_UID = 248
Sub BrickletColorV2.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)
Parameter:
  • functionId – Typ: Byte, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: 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:

Für functionId:

  • BrickletColorV2.FUNCTION_SET_COLOR_CALLBACK_CONFIGURATION = 2
  • BrickletColorV2.FUNCTION_SET_ILLUMINANCE_CALLBACK_CONFIGURATION = 6
  • BrickletColorV2.FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_CONFIGURATION = 10
  • BrickletColorV2.FUNCTION_SET_LIGHT = 13
  • BrickletColorV2.FUNCTION_SET_CONFIGURATION = 15
  • BrickletColorV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletColorV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletColorV2.FUNCTION_RESET = 243
  • BrickletColorV2.FUNCTION_WRITE_UID = 248
Sub BrickletColorV2.SetResponseExpectedAll(ByVal responseExpected As Boolean)
Parameter:
  • responseExpected – Typ: Boolean

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

Sub BrickletColorV2.GetSPITFPErrorCount(ByRef errorCountAckChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)
Ausgabeparameter:
  • errorCountAckChecksum – Typ: Long, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: Long, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: Long, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: Long, 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.

Function BrickletColorV2.SetBootloaderMode(ByVal mode As Byte) As Byte
Parameter:
  • mode – Typ: Byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: Byte, 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.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletColorV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletColorV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletColorV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletColorV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • BrickletColorV2.BOOTLOADER_STATUS_OK = 0
  • BrickletColorV2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletColorV2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletColorV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletColorV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletColorV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
Function BrickletColorV2.GetBootloaderMode() As Byte
Rückgabe:
  • mode – Typ: Byte, 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.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletColorV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletColorV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletColorV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletColorV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
Sub BrickletColorV2.SetWriteFirmwarePointer(ByVal pointer As Long)
Parameter:
  • pointer – Typ: Long, 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.

Function BrickletColorV2.WriteFirmware(ByVal data() As Byte) As Byte
Parameter:
  • data – Typ: Byte Array, Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: Byte, 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.

Sub BrickletColorV2.SetStatusLEDConfig(ByVal config As Byte)
Parameter:
  • config – Typ: Byte, 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.STATUS_LED_CONFIG_OFF = 0
  • BrickletColorV2.STATUS_LED_CONFIG_ON = 1
  • BrickletColorV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletColorV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
Function BrickletColorV2.GetStatusLEDConfig() As Byte
Rückgabe:
  • config – Typ: Byte, 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.STATUS_LED_CONFIG_OFF = 0
  • BrickletColorV2.STATUS_LED_CONFIG_ON = 1
  • BrickletColorV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletColorV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
Function BrickletColorV2.GetChipTemperature() As Short
Rückgabe:
  • temperature – Typ: Short, 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.

Sub BrickletColorV2.Reset()

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.

Sub BrickletColorV2.WriteUID(ByVal uid As Long)
Parameter:
  • uid – Typ: Long, 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.

Function BrickletColorV2.ReadUID() As Long
Rückgabe:
  • uid – Typ: Long, 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.

Sub BrickletColorV2.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:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: Char
  • hardwareVersion – Typ: Byte Array, Länge: 3, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: Byte Array, Länge: 3, 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

Sub BrickletColorV2.SetColorCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean)
Parameter:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: Boolean, 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.

Sub BrickletColorV2.GetColorCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean)
Ausgabeparameter:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: Boolean, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels SetColorCallbackConfiguration() gesetzt.

Sub BrickletColorV2.SetIlluminanceCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean, ByVal option As Char, ByVal min As Long, ByVal max As Long)
Parameter:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: Boolean, Standardwert: false
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C
  • min – Typ: Long, Wertebereich: [0 bis 232 - 1]
  • max – Typ: Long, 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.THRESHOLD_OPTION_OFF = "x"C
  • BrickletColorV2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletColorV2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletColorV2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletColorV2.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletColorV2.GetIlluminanceCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean, ByRef option As Char, ByRef min As Long, ByRef max As Long)
Ausgabeparameter:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: Boolean, Standardwert: false
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C
  • min – Typ: Long, Wertebereich: [0 bis 232 - 1]
  • max – Typ: Long, 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.THRESHOLD_OPTION_OFF = "x"C
  • BrickletColorV2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletColorV2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletColorV2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletColorV2.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletColorV2.SetColorTemperatureCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean, ByVal option As Char, ByVal min As Integer, ByVal max As Integer)
Parameter:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: Boolean, Standardwert: false
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C
  • 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.THRESHOLD_OPTION_OFF = "x"C
  • BrickletColorV2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletColorV2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletColorV2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletColorV2.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletColorV2.GetColorTemperatureCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean, ByRef option As Char, ByRef min As Integer, ByRef max As Integer)
Ausgabeparameter:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: Boolean, Standardwert: false
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C
  • 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.THRESHOLD_OPTION_OFF = "x"C
  • BrickletColorV2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletColorV2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletColorV2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletColorV2.THRESHOLD_OPTION_GREATER = ">"C

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 BrickletColorV2, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler colorV2.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 BrickletColorV2.ColorCallback(ByVal sender As BrickletColorV2, ByVal r As Integer, ByVal g As Integer, ByVal b As Integer, ByVal c As Integer)
Callback-Parameter:
  • sender – Typ: 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(ByVal sender As BrickletColorV2, ByVal illuminance As Long)
Callback-Parameter:
  • sender – Typ: BrickletColorV2
  • illuminance – Typ: Long, 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(ByVal sender As BrickletColorV2, ByVal colorTemperature As Integer)
Callback-Parameter:
  • sender – Typ: 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

Const BrickletColorV2.DEVICE_IDENTIFIER

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.

Const BrickletColorV2.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Color Bricklet 2.0 dar.