Visual Basic .NET - Distance IR Bricklet 2.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

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 Distance IR Bricklet 2.0

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim dir As New BrickletDistanceIRV2(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Get current distance
        Dim distance As Integer = dir.GetDistance()
        Console.WriteLine("Distance: " + (distance/10.0).ToString() + " cm")

        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

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 Distance IR Bricklet 2.0

    ' Callback subroutine for distance callback
    Sub DistanceCB(ByVal sender As BrickletDistanceIRV2, ByVal distance As Integer)
        Console.WriteLine("Distance: " + (distance/10.0).ToString() + " cm")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim dir As New BrickletDistanceIRV2(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Register distance callback to subroutine DistanceCB
        AddHandler dir.DistanceCallback, AddressOf DistanceCB

        ' Set period for distance callback to 1s (1000ms) without a threshold
        dir.SetDistanceCallbackConfiguration(1000, False, "x"C, 0, 0)

        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

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 Distance IR Bricklet 2.0

    ' Callback subroutine for distance callback
    Sub DistanceCB(ByVal sender As BrickletDistanceIRV2, ByVal distance As Integer)
        Console.WriteLine("Distance: " + (distance/10.0).ToString() + " cm")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim dir As New BrickletDistanceIRV2(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Register distance callback to subroutine DistanceCB
        AddHandler dir.DistanceCallback, AddressOf DistanceCB

        ' Configure threshold for distance "smaller than 30 cm"
        ' with a debounce period of 1s (1000ms)
        dir.SetDistanceCallbackConfiguration(1000, False, "<"C, 30*10, 0)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Grundfunktionen¶

Class BrickletDistanceIRV2(ByVal uid As String, ByVal ipcon As IPConnection)¶

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

Dim distanceIRV2 As New BrickletDistanceIRV2("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

Function BrickletDistanceIRV2.GetDistance() As Integer¶

Rückgabe:	distance – Typ: Integer, Einheit: 1 mm, Wertebereich: [0 bis 216 - 1]

Gibt die gemessene Entfernung des Sensors zurück. Die möglichen Entfernungsbereiche sind 40 bis 300, 100 bis 800 und 200 bis 1500, in Abhängigkeit vom gewählten IR Sensor.

Wenn der Wert periodisch benötigt wird, kann auch der DistanceCallback Callback verwendet werden. Der Callback wird mit der Funktion SetDistanceCallbackConfiguration() konfiguriert.

Function BrickletDistanceIRV2.GetAnalogValue() As Long¶

Rückgabe:	analogValue – Typ: Long, Wertebereich: [0 bis 221 - 1]

Gibt den Analogwert des Analog/Digital-Wandler zurück.

Dieser Wert ist ein unverarbeiteter Rohwert. Wir haben sichergestellt, dass die Integrationszeit des ADCs kleiner ist als das Messintervall des Sensors (10ms vs 16,5ms). Dadurch ist sichergestellt das keine Informationen verloren gehen können.

Der Analogwert kann genutzt werden wenn eine eigene Kalibrierung oder Lookup-Tabelle benötigt wird.

Wenn der Wert periodisch benötigt wird, kann auch der AnalogValueCallback Callback verwendet werden. Der Callback wird mit der Funktion SetAnalogValueCallbackConfiguration() konfiguriert.

Sub BrickletDistanceIRV2.SetMovingAverageConfiguration(ByVal movingAverageLength As Integer)¶

Parameter:	movingAverageLength – Typ: Integer, Wertebereich: [1 bis 1000], Standardwert: 25

Setzt die Länge eines gleitenden Mittelwerts für die Distanz.

Wenn die Länge auf 1 gesetzt wird, ist die Mittelwertbildung deaktiviert. Je kürzer die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Einer neue Wert wird alle ~10ms gemessen. Mit einer Mittelwerts-Länge von 1000 hat das resultierende gleitende Fenster eine Zeitspanne von ca. 10s. Bei Langzeitmessungen gibt ein langer Mittelwert die saubersten Resultate.

Function BrickletDistanceIRV2.GetMovingAverageConfiguration() As Integer¶

Rückgabe:	movingAverageLength – Typ: Integer, Wertebereich: [1 bis 1000], Standardwert: 25

Gibt die Moving Average-Konfiguration zurück, wie von SetMovingAverageConfiguration() gesetzt.

Sub BrickletDistanceIRV2.SetDistanceLEDConfig(ByVal config As Byte)¶

Parameter:	config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Konfiguriert die Distanz-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option mit der LED die Distanz anzuzeigen (heller = Objekt näher).

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

Für config:

• BrickletDistanceIRV2.DISTANCE_LED_CONFIG_OFF = 0
• BrickletDistanceIRV2.DISTANCE_LED_CONFIG_ON = 1
• BrickletDistanceIRV2.DISTANCE_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletDistanceIRV2.DISTANCE_LED_CONFIG_SHOW_DISTANCE = 3

Function BrickletDistanceIRV2.GetDistanceLEDConfig() As Byte¶

Rückgabe:	config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die LED-Konfiguration zurück, wie von SetDistanceLEDConfig() gesetzt.

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

Für config:

• BrickletDistanceIRV2.DISTANCE_LED_CONFIG_OFF = 0
• BrickletDistanceIRV2.DISTANCE_LED_CONFIG_ON = 1
• BrickletDistanceIRV2.DISTANCE_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletDistanceIRV2.DISTANCE_LED_CONFIG_SHOW_DISTANCE = 3

Sub BrickletDistanceIRV2.SetSensorType(ByVal sensor As Byte)¶

Parameter:	sensor – Typ: Byte, Wertebereich: Siehe Konstanten

Setzt den Sensor-Typ.

Das Bricklet kommt vorkonfiguriert mit dem korrektem Sensor und der Sensor-Typ wird im Flash gespeichert (d.h. das Bricklet behält die Einstellung auch wenn es vom Strom getrennt wird).

Die Einstellung kann im Brick Viewer vorgenommen werden. Diese Funktion sollte in einem externen Programm also nicht ausgeführt werden müssen.

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

Für sensor:

• BrickletDistanceIRV2.SENSOR_TYPE_2Y0A41 = 0
• BrickletDistanceIRV2.SENSOR_TYPE_2Y0A21 = 1
• BrickletDistanceIRV2.SENSOR_TYPE_2Y0A02 = 2

Function BrickletDistanceIRV2.GetSensorType() As Byte¶

Rückgabe:	sensor – Typ: Byte, Wertebereich: Siehe Konstanten

Gibt den Sensor-Typ zurück, wie von SetSensorType() gesetzt.

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

Für sensor:

• BrickletDistanceIRV2.SENSOR_TYPE_2Y0A41 = 0
• BrickletDistanceIRV2.SENSOR_TYPE_2Y0A21 = 1
• BrickletDistanceIRV2.SENSOR_TYPE_2Y0A02 = 2

Fortgeschrittene Funktionen¶

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

Sub BrickletDistanceIRV2.SetStatusLEDConfig(ByVal config As Byte)¶

Parameter:	config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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:

• BrickletDistanceIRV2.STATUS_LED_CONFIG_OFF = 0
• BrickletDistanceIRV2.STATUS_LED_CONFIG_ON = 1
• BrickletDistanceIRV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletDistanceIRV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

Function BrickletDistanceIRV2.GetStatusLEDConfig() As Byte¶

Rückgabe:	config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von SetStatusLEDConfig() gesetzt.

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

Für config:

• BrickletDistanceIRV2.STATUS_LED_CONFIG_OFF = 0
• BrickletDistanceIRV2.STATUS_LED_CONFIG_ON = 1
• BrickletDistanceIRV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletDistanceIRV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

Function BrickletDistanceIRV2.GetChipTemperature() As Short¶

Rückgabe:	temperature – Typ: Short, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, 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 BrickletDistanceIRV2.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 BrickletDistanceIRV2.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, Wertebereich: ["a"C bis "h"C, "z"C] hardwareVersion – Typ: Byte Array, Länge: 3 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, Wertebereich: [0 bis 255] firmwareVersion – Typ: Byte Array, Länge: 3 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, 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 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.

Konfigurationsfunktionen für Callbacks¶

Sub BrickletDistanceIRV2.SetDistanceCallbackConfiguration(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, Einheit: 1 mm, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: Integer, Einheit: 1 mm, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

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

Für option:

• BrickletDistanceIRV2.THRESHOLD_OPTION_OFF = "x"C
• BrickletDistanceIRV2.THRESHOLD_OPTION_OUTSIDE = "o"C
• BrickletDistanceIRV2.THRESHOLD_OPTION_INSIDE = "i"C
• BrickletDistanceIRV2.THRESHOLD_OPTION_SMALLER = "<"C
• BrickletDistanceIRV2.THRESHOLD_OPTION_GREATER = ">"C

Sub BrickletDistanceIRV2.GetDistanceCallbackConfiguration(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, Einheit: 1 mm, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: Integer, Einheit: 1 mm, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

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

Für option:

• BrickletDistanceIRV2.THRESHOLD_OPTION_OFF = "x"C
• BrickletDistanceIRV2.THRESHOLD_OPTION_OUTSIDE = "o"C
• BrickletDistanceIRV2.THRESHOLD_OPTION_INSIDE = "i"C
• BrickletDistanceIRV2.THRESHOLD_OPTION_SMALLER = "<"C
• BrickletDistanceIRV2.THRESHOLD_OPTION_GREATER = ">"C

Sub BrickletDistanceIRV2.SetAnalogValueCallbackConfiguration(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], Standardwert: 0 max – Typ: Long, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

Für option:

• BrickletDistanceIRV2.THRESHOLD_OPTION_OFF = "x"C
• BrickletDistanceIRV2.THRESHOLD_OPTION_OUTSIDE = "o"C
• BrickletDistanceIRV2.THRESHOLD_OPTION_INSIDE = "i"C
• BrickletDistanceIRV2.THRESHOLD_OPTION_SMALLER = "<"C
• BrickletDistanceIRV2.THRESHOLD_OPTION_GREATER = ">"C

Sub BrickletDistanceIRV2.GetAnalogValueCallbackConfiguration(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], Standardwert: 0 max – Typ: Long, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

Für option:

• BrickletDistanceIRV2.THRESHOLD_OPTION_OFF = "x"C
• BrickletDistanceIRV2.THRESHOLD_OPTION_OUTSIDE = "o"C
• BrickletDistanceIRV2.THRESHOLD_OPTION_INSIDE = "i"C
• BrickletDistanceIRV2.THRESHOLD_OPTION_SMALLER = "<"C
• BrickletDistanceIRV2.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 BrickletDistanceIRV2, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler distanceIRV2.ExampleCallback, AddressOf MyCallback

Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten beschrieben.

Event BrickletDistanceIRV2.DistanceCallback(ByVal sender As BrickletDistanceIRV2, ByVal distance As Integer)¶

Callback-Parameter:	sender – Typ: BrickletDistanceIRV2 distance – Typ: Integer, Einheit: 1 mm, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels SetDistanceCallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie GetDistance().

Event BrickletDistanceIRV2.AnalogValueCallback(ByVal sender As BrickletDistanceIRV2, ByVal analogValue As Long)¶

Callback-Parameter:	sender – Typ: BrickletDistanceIRV2 analogValue – Typ: Long, Wertebereich: [0 bis 221 - 1]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels SetAnalogValueCallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie GetAnalogValue().

Virtuelle Funktionen¶

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.

Function BrickletDistanceIRV2.GetAPIVersion() As Byte()¶

Ausgabeparameter:	apiVersion – Typ: Byte Array, Länge: 3 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, Wertebereich: [0 bis 255]

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.

Function BrickletDistanceIRV2.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:

• BrickletDistanceIRV2.FUNCTION_SET_DISTANCE_CALLBACK_CONFIGURATION = 2
• BrickletDistanceIRV2.FUNCTION_SET_ANALOG_VALUE_CALLBACK_CONFIGURATION = 6
• BrickletDistanceIRV2.FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 9
• BrickletDistanceIRV2.FUNCTION_SET_DISTANCE_LED_CONFIG = 11
• BrickletDistanceIRV2.FUNCTION_SET_SENSOR_TYPE = 13
• BrickletDistanceIRV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletDistanceIRV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletDistanceIRV2.FUNCTION_RESET = 243
• BrickletDistanceIRV2.FUNCTION_WRITE_UID = 248

Sub BrickletDistanceIRV2.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:

• BrickletDistanceIRV2.FUNCTION_SET_DISTANCE_CALLBACK_CONFIGURATION = 2
• BrickletDistanceIRV2.FUNCTION_SET_ANALOG_VALUE_CALLBACK_CONFIGURATION = 6
• BrickletDistanceIRV2.FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 9
• BrickletDistanceIRV2.FUNCTION_SET_DISTANCE_LED_CONFIG = 11
• BrickletDistanceIRV2.FUNCTION_SET_SENSOR_TYPE = 13
• BrickletDistanceIRV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletDistanceIRV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletDistanceIRV2.FUNCTION_RESET = 243
• BrickletDistanceIRV2.FUNCTION_WRITE_UID = 248

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

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

Function BrickletDistanceIRV2.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 Bootloader- 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:

• BrickletDistanceIRV2.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletDistanceIRV2.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletDistanceIRV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletDistanceIRV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletDistanceIRV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

• BrickletDistanceIRV2.BOOTLOADER_STATUS_OK = 0
• BrickletDistanceIRV2.BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletDistanceIRV2.BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletDistanceIRV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletDistanceIRV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletDistanceIRV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5

Function BrickletDistanceIRV2.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:

• BrickletDistanceIRV2.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletDistanceIRV2.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletDistanceIRV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletDistanceIRV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletDistanceIRV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Sub BrickletDistanceIRV2.SetWriteFirmwarePointer(ByVal pointer As Long)¶

Parameter:	pointer – Typ: Long, Einheit: 1 B, 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 BrickletDistanceIRV2.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 BrickletDistanceIRV2.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 BrickletDistanceIRV2.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.

Konstanten¶

Const BrickletDistanceIRV2.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Distance IR 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 BrickletDistanceIRV2.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Distance IR Bricklet 2.0 dar.