Visual Basic .NET - Accelerometer Bricklet

Dies ist die Beschreibung der Visual Basic .NET API Bindings für das Accelerometer Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Accelerometer 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
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 Accelerometer Bricklet

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

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

        ' Get current acceleration
        Dim x, y, z As Short

        a.GetAcceleration(x, y, z)

        Console.WriteLine("Acceleration [X]: " + (x/1000.0).ToString() + " g")
        Console.WriteLine("Acceleration [Y]: " + (y/1000.0).ToString() + " g")
        Console.WriteLine("Acceleration [Z]: " + (z/1000.0).ToString() + " g")

        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
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 Accelerometer Bricklet

    ' Callback subroutine for acceleration callback
    Sub AccelerationCB(ByVal sender As BrickletAccelerometer, ByVal x As Short, _
                       ByVal y As Short, ByVal z As Short)
        Console.WriteLine("Acceleration [X]: " + (x/1000.0).ToString() + " g")
        Console.WriteLine("Acceleration [Y]: " + (y/1000.0).ToString() + " g")
        Console.WriteLine("Acceleration [Z]: " + (z/1000.0).ToString() + " g")
        Console.WriteLine("")
    End Sub

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

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

        ' Register acceleration callback to subroutine AccelerationCB
        AddHandler a.AccelerationCallback, AddressOf AccelerationCB

        ' Set period for acceleration callback to 1s (1000ms)
        ' Note: The acceleration callback is only called every second
        '       if the acceleration has changed since the last call!
        a.SetAccelerationCallbackPeriod(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
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 Accelerometer Bricklet

    ' Callback subroutine for acceleration reached callback
    Sub AccelerationReachedCB(ByVal sender As BrickletAccelerometer, ByVal x As Short, _
                              ByVal y As Short, ByVal z As Short)
        Console.WriteLine("Acceleration [X]: " + (x/1000.0).ToString() + " g")
        Console.WriteLine("Acceleration [Y]: " + (y/1000.0).ToString() + " g")
        Console.WriteLine("Acceleration [Z]: " + (z/1000.0).ToString() + " g")
        Console.WriteLine("")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim a As New BrickletAccelerometer(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)
        a.SetDebouncePeriod(10000)

        ' Register acceleration reached callback to subroutine AccelerationReachedCB
        AddHandler a.AccelerationReachedCallback, AddressOf AccelerationReachedCB

        ' Configure threshold for acceleration "greater than 2 g, 2 g, 2 g"
        a.SetAccelerationCallbackThreshold(">"C, 2*1000, 0, 2*1000, 0, 2*1000, 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 BrickletAccelerometer(ByVal uid As String, ByVal ipcon As IPConnection)

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

Dim accelerometer As New BrickletAccelerometer("YOUR_DEVICE_UID", ipcon)

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

Sub BrickletAccelerometer.GetAcceleration(ByRef x As Short, ByRef y As Short, ByRef z As Short)

Gibt die Beschleunigung in X-, Y- und Z-Richtung zurück. Die Werte haben die Einheit g/1000 (1g = 9,80665m/s²), nicht zu verwechseln mit Gramm.

Wenn die Beschleunigungswerte periodisch abgefragt werden sollen, wird empfohlen den AccelerationCallback Callback zu nutzen und die Periode mit SetAccelerationCallbackPeriod() vorzugeben.

Function BrickletAccelerometer.GetTemperature() As Short

Gibt die Temperatur des Beschleunigungssensors in °C zurück.

Sub BrickletAccelerometer.LEDOn()

Aktiviert die LED auf dem Bricklet.

Sub BrickletAccelerometer.LEDOff()

Deaktiviert die LED auf dem Bricklet.

Function BrickletAccelerometer.IsLEDOn() As Boolean

Gibt true zurück wenn die LED aktiviert ist, false sonst.

Fortgeschrittene Funktionen

Sub BrickletAccelerometer.SetConfiguration(ByVal dataRate As Byte, ByVal fullScale As Byte, ByVal filterBandwidth As Byte)

Konfiguriert die Datenrate, den Wertebereich und die Filterbandbreite. Mögliche Konfigurationswerte sind:

  • Datenrate zwischen 0Hz und 1600Hz.
  • Wertebereich von -2G bis +2G bis zu -16G bis +16G.
  • Filterbandbreite zwischen 50Hz und 800Hz.

Eine Verringerung der Datenrate oder des Wertebereichs verringert auch automatisch das Rauschen auf den Daten.

Die Standardwerte sind 100Hz Datenrate, -4G bis +4G Wertebereich und 200Hz Filterbandbreite.

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

  • BrickletAccelerometer.DATA_RATE_OFF = 0
  • BrickletAccelerometer.DATA_RATE_3HZ = 1
  • BrickletAccelerometer.DATA_RATE_6HZ = 2
  • BrickletAccelerometer.DATA_RATE_12HZ = 3
  • BrickletAccelerometer.DATA_RATE_25HZ = 4
  • BrickletAccelerometer.DATA_RATE_50HZ = 5
  • BrickletAccelerometer.DATA_RATE_100HZ = 6
  • BrickletAccelerometer.DATA_RATE_400HZ = 7
  • BrickletAccelerometer.DATA_RATE_800HZ = 8
  • BrickletAccelerometer.DATA_RATE_1600HZ = 9
  • BrickletAccelerometer.FULL_SCALE_2G = 0
  • BrickletAccelerometer.FULL_SCALE_4G = 1
  • BrickletAccelerometer.FULL_SCALE_6G = 2
  • BrickletAccelerometer.FULL_SCALE_8G = 3
  • BrickletAccelerometer.FULL_SCALE_16G = 4
  • BrickletAccelerometer.FILTER_BANDWIDTH_800HZ = 0
  • BrickletAccelerometer.FILTER_BANDWIDTH_400HZ = 1
  • BrickletAccelerometer.FILTER_BANDWIDTH_200HZ = 2
  • BrickletAccelerometer.FILTER_BANDWIDTH_50HZ = 3
Sub BrickletAccelerometer.GetConfiguration(ByRef dataRate As Byte, ByRef fullScale As Byte, ByRef filterBandwidth As Byte)

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

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

  • BrickletAccelerometer.DATA_RATE_OFF = 0
  • BrickletAccelerometer.DATA_RATE_3HZ = 1
  • BrickletAccelerometer.DATA_RATE_6HZ = 2
  • BrickletAccelerometer.DATA_RATE_12HZ = 3
  • BrickletAccelerometer.DATA_RATE_25HZ = 4
  • BrickletAccelerometer.DATA_RATE_50HZ = 5
  • BrickletAccelerometer.DATA_RATE_100HZ = 6
  • BrickletAccelerometer.DATA_RATE_400HZ = 7
  • BrickletAccelerometer.DATA_RATE_800HZ = 8
  • BrickletAccelerometer.DATA_RATE_1600HZ = 9
  • BrickletAccelerometer.FULL_SCALE_2G = 0
  • BrickletAccelerometer.FULL_SCALE_4G = 1
  • BrickletAccelerometer.FULL_SCALE_6G = 2
  • BrickletAccelerometer.FULL_SCALE_8G = 3
  • BrickletAccelerometer.FULL_SCALE_16G = 4
  • BrickletAccelerometer.FILTER_BANDWIDTH_800HZ = 0
  • BrickletAccelerometer.FILTER_BANDWIDTH_400HZ = 1
  • BrickletAccelerometer.FILTER_BANDWIDTH_200HZ = 2
  • BrickletAccelerometer.FILTER_BANDWIDTH_50HZ = 3
Function BrickletAccelerometer.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 BrickletAccelerometer.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.

Siehe SetResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

Sub BrickletAccelerometer.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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletAccelerometer.FUNCTION_SET_ACCELERATION_CALLBACK_PERIOD = 2
  • BrickletAccelerometer.FUNCTION_SET_ACCELERATION_CALLBACK_THRESHOLD = 4
  • BrickletAccelerometer.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletAccelerometer.FUNCTION_SET_CONFIGURATION = 9
  • BrickletAccelerometer.FUNCTION_LED_ON = 11
  • BrickletAccelerometer.FUNCTION_LED_OFF = 12
Sub BrickletAccelerometer.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

Sub BrickletAccelerometer.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 BrickletAccelerometer.SetAccelerationCallbackPeriod(ByVal period As Long)

Setzt die Periode in ms mit welcher der AccelerationCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

Der Standardwert ist 0.

Function BrickletAccelerometer.GetAccelerationCallbackPeriod() As Long

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

Sub BrickletAccelerometer.SetAccelerationCallbackThreshold(ByVal option As Char, ByVal minX As Short, ByVal maxX As Short, ByVal minY As Short, ByVal maxY As Short, ByVal minZ As Short, ByVal maxZ As Short)

Setzt den Schwellwert für den AccelerationReachedCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst wenn die Beschleunigung außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst wenn die Beschleunigung innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst wenn die Beschleunigung kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst wenn die Beschleunigung 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:

  • BrickletAccelerometer.THRESHOLD_OPTION_OFF = "x"C
  • BrickletAccelerometer.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletAccelerometer.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletAccelerometer.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletAccelerometer.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletAccelerometer.GetAccelerationCallbackThreshold(ByRef option As Char, ByRef minX As Short, ByRef maxX As Short, ByRef minY As Short, ByRef maxY As Short, ByRef minZ As Short, ByRef maxZ As Short)

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

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

  • BrickletAccelerometer.THRESHOLD_OPTION_OFF = "x"C
  • BrickletAccelerometer.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletAccelerometer.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletAccelerometer.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletAccelerometer.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletAccelerometer.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 BrickletAccelerometer.GetDebouncePeriod() As Long

Gibt die Entprellperiode zurück, wie von SetDebouncePeriod() 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 BrickletAccelerometer, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler accelerometer.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 BrickletAccelerometer.AccelerationCallback(ByVal sender As BrickletAccelerometer, ByVal x As Short, ByVal y As Short, ByVal z As Short)

Dieser Callback wird mit der Periode, wie gesetzt mit SetAccelerationCallbackPeriod(), ausgelöst. Die Parameter sind die Beschleunigungen der X-, Y- und Z-Achse.

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

Event BrickletAccelerometer.AccelerationReachedCallback(ByVal sender As BrickletAccelerometer, ByVal x As Short, ByVal y As Short, ByVal z As Short)

Dieser Callback wird ausgelöst wenn der Schwellwert, wie von SetAccelerationCallbackThreshold() gesetzt, erreicht wird. Die Parameter sind die Beschleunigungen der X-, Y- und Z-Achse.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod() gesetzt, ausgelöst.

Konstanten

Const BrickletAccelerometer.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Accelerometer Bricklet zu identifizieren.

Die GetIdentity() Funktion und der EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

Const BrickletAccelerometer.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Accelerometer Bricklet dar.