Visual Basic .NET - IMU Brick 2.0

Dies ist die Beschreibung der Visual Basic .NET API Bindings für den IMU Brick 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des IMU Brick 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 = "XXYYZZ" ' Change XXYYZZ to the UID of your IMU Brick 2.0

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

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

        ' Get current quaternion
        Dim w, x, y, z As Short

        imu.GetQuaternion(w, x, y, z)

        Console.WriteLine("Quaternion [W]: " + (w/16383.0).ToString())
        Console.WriteLine("Quaternion [X]: " + (x/16383.0).ToString())
        Console.WriteLine("Quaternion [Y]: " + (y/16383.0).ToString())
        Console.WriteLine("Quaternion [Z]: " + (z/16383.0).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 = "XXYYZZ" ' Change XXYYZZ to the UID of your IMU Brick 2.0

    ' Callback subroutine for quaternion callback
    Sub QuaternionCB(ByVal sender As BrickIMUV2, ByVal w As Short, ByVal x As Short, _
                     ByVal y As Short, ByVal z As Short)
        Console.WriteLine("Quaternion [W]: " + (w/16383.0).ToString())
        Console.WriteLine("Quaternion [X]: " + (x/16383.0).ToString())
        Console.WriteLine("Quaternion [Y]: " + (y/16383.0).ToString())
        Console.WriteLine("Quaternion [Z]: " + (z/16383.0).ToString())
        Console.WriteLine("")
    End Sub

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

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

        ' Register quaternion callback to subroutine QuaternionCB
        AddHandler imu.QuaternionCallback, AddressOf QuaternionCB

        ' Set period for quaternion callback to 0.1s (100ms)
        imu.SetQuaternionPeriod(100)

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

All Data

Download (ExampleAllData.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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
Imports System
Imports Tinkerforge

Module ExampleAllData
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XXYYZZ" ' Change XXYYZZ to the UID of your IMU Brick 2.0

    ' Callback subroutine for all data callback
    Sub AllDataCB(ByVal sender As BrickIMUV2, ByVal acceleration As Short(), _
                  ByVal magneticField As Short(), ByVal angularVelocity As Short(), _
                  ByVal eulerAngle As Short(), ByVal quaternion As Short(), _
                  ByVal linearAcceleration As Short(), ByVal gravityVector As Short(), _
                  ByVal temperature As Short, ByVal calibrationStatus As Byte)
        Console.WriteLine("Acceleration [X]: " + (acceleration(0)/100.0).ToString() + " m/s²")
        Console.WriteLine("Acceleration [Y]: " + (acceleration(1)/100.0).ToString() + " m/s²")
        Console.WriteLine("Acceleration [Z]: " + (acceleration(2)/100.0).ToString() + " m/s²")
        Console.WriteLine("Magnetic Field [X]: " + (magneticField(0)/16.0).ToString() + " µT")
        Console.WriteLine("Magnetic Field [Y]: " + (magneticField(1)/16.0).ToString() + " µT")
        Console.WriteLine("Magnetic Field [Z]: " + (magneticField(2)/16.0).ToString() + " µT")
        Console.WriteLine("Angular Velocity [X]: " + (angularVelocity(0)/16.0).ToString() + " °/s")
        Console.WriteLine("Angular Velocity [Y]: " + (angularVelocity(1)/16.0).ToString() + " °/s")
        Console.WriteLine("Angular Velocity [Z]: " + (angularVelocity(2)/16.0).ToString() + " °/s")
        Console.WriteLine("Euler Angle [X]: " + (eulerAngle(0)/16.0).ToString() + " °")
        Console.WriteLine("Euler Angle [Y]: " + (eulerAngle(1)/16.0).ToString() + " °")
        Console.WriteLine("Euler Angle [Z]: " + (eulerAngle(2)/16.0).ToString() + " °")
        Console.WriteLine("Quaternion [W]: " + (quaternion(0)/16383.0).ToString())
        Console.WriteLine("Quaternion [X]: " + (quaternion(1)/16383.0).ToString())
        Console.WriteLine("Quaternion [Y]: " + (quaternion(2)/16383.0).ToString())
        Console.WriteLine("Quaternion [Z]: " + (quaternion(3)/16383.0).ToString())
        Console.WriteLine("Linear Acceleration [X]: " + (linearAcceleration(0)/100.0).ToString() + " m/s²")
        Console.WriteLine("Linear Acceleration [Y]: " + (linearAcceleration(1)/100.0).ToString() + " m/s²")
        Console.WriteLine("Linear Acceleration [Z]: " + (linearAcceleration(2)/100.0).ToString() + " m/s²")
        Console.WriteLine("Gravity Vector [X]: " + (gravityVector(0)/100.0).ToString() + " m/s²")
        Console.WriteLine("Gravity Vector [Y]: " + (gravityVector(1)/100.0).ToString() + " m/s²")
        Console.WriteLine("Gravity Vector [Z]: " + (gravityVector(2)/100.0).ToString() + " m/s²")
        Console.WriteLine("Temperature: " + temperature.ToString() + " °C")
        Console.WriteLine("Calibration Status: " + Convert.ToString(calibrationStatus, 2))
        Console.WriteLine("")
    End Sub

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

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

        ' Register all data callback to subroutine AllDataCB
        AddHandler imu.AllDataCallback, AddressOf AllDataCB

        ' Set period for all data callback to 0.1s (100ms)
        imu.SetAllDataPeriod(100)

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

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

Dim imuV2 As New BrickIMUV2("YOUR_DEVICE_UID", ipcon)

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

Sub BrickIMUV2.GetOrientation(ByRef heading As Short, ByRef roll As Short, ByRef pitch As Short)

Gibt die aktuelle Orientierung (Gier-, Roll-, Nickwinkel) des IMU Brick in unabhängigen Eulerwinkeln (in 1/16 °) zurück. Zu beachten ist, dass Eulerwinkel immer eine kardanische Blockade erfahren. Wir empfehlen daher stattdessen Quaternionen zu verwenden, wenn die absolute Lage im Raum bestimmt werden soll.

Die Rotationswinkel haben den folgenden Wertebereich:

  • Gierwinkel: 0° bis 360°
  • Rollwinkel: -90° bis +90°
  • Nickwinkel: -180° bis +180°

Wenn die Orientierung periodisch abgefragt werden sollen, wird empfohlen den OrientationCallback Callback zu nutzen und die Periode mit SetOrientationPeriod() vorzugeben.

Sub BrickIMUV2.GetLinearAcceleration(ByRef x As Short, ByRef y As Short, ByRef z As Short)

Gibt die lineare Beschleunigungen des IMU Brick für die X-, Y- und Z-Achse in 1/100 m/s² zurück.

Die lineare Beschleunigung ist die Beschleunigung in jede der drei Achsen. Der Einfluss von Erdbeschleunigung ist entfernt.

Es ist auch möglich einen Vektor der Erdbeschleunigung zu bekommen, siehe GetGravityVector()

Wenn die Beschleunigungen periodisch abgefragt werden soll, wird empfohlen den LinearAccelerationCallback Callback zu nutzen und die Periode mit SetLinearAccelerationPeriod() vorzugeben.

Sub BrickIMUV2.GetGravityVector(ByRef x As Short, ByRef y As Short, ByRef z As Short)

Gibt den Vektor der Erdbeschleunigung des IMU Brick für die X-, Y- und Z-Achse in 1/100 m/s² zurück.

Die Erdbeschleunigung ist die Beschleunigung die auf Grund von Schwerkraft entsteht. Einflüsse von linearen Beschleunigungen sind entfernt.

Es ist auch möglich die lineare Beschleunigung zu bekommen, siehe GetLinearAcceleration()

Wenn die Erdbeschleunigungen periodisch abgefragt werden soll, wird empfohlen den GravityVectorCallback Callback zu nutzen und die Periode mit SetGravityVectorPeriod() vorzugeben.

Sub BrickIMUV2.GetQuaternion(ByRef w As Short, ByRef x As Short, ByRef y As Short, ByRef z As Short)

Gibt die aktuelle Orientierung (w, x, y, z) des IMU Brick als Quaterinonen zurück.

Die zurückgegebenen Werte müssen mit 16383 (14 Bit) dividiert werden um in den üblichen Wertebereich für Quaternionen (-1,0 bis +1,0) gebracht zu werden.

Wenn die Quaternionen periodisch abgefragt werden sollen, wird empfohlen den QuaternionCallback Callback zu nutzen und die Periode mit SetQuaternionPeriod() vorzugeben.

Sub BrickIMUV2.GetAllData(ByRef acceleration() As Short, ByRef magneticField() As Short, ByRef angularVelocity() As Short, ByRef eulerAngle() As Short, ByRef quaternion() As Short, ByRef linearAcceleration() As Short, ByRef gravityVector() As Short, ByRef temperature As Short, ByRef calibrationStatus As Byte)

Gibt alle Daten zurück die dem IMU Brick zur Verfügung stehen.

Der Kalibrierungsstatus besteht aus vier paaren von je zwei Bits. Jedes Paar von Bits repräsentiert den Status der aktuellen Kalibrierung.

  • Bit 0-1: Magnetometer
  • Bit 2-3: Beschleunigungsmesser
  • Bit 4-5: Gyroskop
  • Bit 6-7: System

Ein Wert von 0 bedeutet "nicht kalibriert" und ein Wert von 3 bedeutet "vollständig kalibriert". Normalerweise kann der Kalibrierungsstatus vollständig ignoriert werden. Er wird vom Brick Viewer im Kalibrierungsfenster benutzt und nur für die initiale Kalibrierung benötigt. Mehr Information zur Kalibrierung des IMU Bricks gibt es im Kalibrierungsfenster.

Wenn die Daten periodisch abgefragt werden sollen, wird empfohlen den AllDataCallback Callback zu nutzen und die Periode mit SetAllDataPeriod() vorzugeben.

Sub BrickIMUV2.LedsOn()

Aktiviert die Orientierungs- und Richtungs-LEDs des IMU Brick.

Sub BrickIMUV2.LedsOff()

Deaktiviert die Orientierungs- und Richtungs-LEDs des IMU Brick.

Function BrickIMUV2.AreLedsOn() As Boolean

Gibt zurück ob die Orientierungs- und Richtungs-LEDs des IMU Brick aktiv sind.

Fortgeschrittene Funktionen

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

Gibt die kalibrierten Beschleunigungen des Beschleunigungsmessers für die X-, Y- und Z-Achse in 1/100 m/s².

Wenn die Beschleunigungen periodisch abgefragt werden soll, wird empfohlen den AccelerationCallback Callback zu nutzen und die Periode mit SetAccelerationPeriod() vorzugeben.

Sub BrickIMUV2.GetMagneticField(ByRef x As Short, ByRef y As Short, ByRef z As Short)

Gibt das kalibrierte magnetische Feld des Magnetometers mit den X-, Y- und Z-Komponenten in 1/16 µT zurück (Microtesla).

Wenn das magnetische Feld periodisch abgefragt werden soll, wird empfohlen den MagneticFieldCallback Callback zu nutzen und die Periode mit SetMagneticFieldPeriod() vorzugeben.

Sub BrickIMUV2.GetAngularVelocity(ByRef x As Short, ByRef y As Short, ByRef z As Short)

Gibt die kalibrierte Winkelgeschwindigkeiten des Gyroskops für die X-, Y- und Z-Achse in 1/16 °/s zurück.

Wenn die Winkelgeschwindigkeiten periodisch abgefragt werden sollen, wird empfohlen den AngularVelocityCallback Callback zu nutzen und die Periode mit SetAngularVelocityPeriod() vorzugeben.

Function BrickIMUV2.GetTemperature() As Short

Gibt die Temperatur (in °C) des IMU Brick zurück. Die Temperatur wird im Kern des BNO055 ICs gemessen, es handelt sich nicht um die Umgebungstemperatur.

Function BrickIMUV2.SaveCalibration() As Boolean

Ein Aufruf dieser Funktion speichert die aktuelle Kalibrierung damit sie beim nächsten Neustart des IMU Brick als Startpunkt für die kontinuierliche Kalibrierung genutzt werden kann.

Ein Rückgabewert von true bedeutet das die Kalibrierung genutzt werden konnte und false bedeutet das die Kalibrierung nicht genutzt werden konnte (dies passiert wenn der Kalibrierungsstatus nicht "fully calibrated" ist).

Diese Funktion wird vom Kalibrierungsfenster des Brick Viewer benutzt. Sie sollte in einem normalen Benutzerprogramm nicht aufgerufen werden müssen.

Sub BrickIMUV2.SetSensorConfiguration(ByVal magnetometerRate As Byte, ByVal gyroscopeRange As Byte, ByVal gyroscopeBandwidth As Byte, ByVal accelerometerRange As Byte, ByVal accelerometerBandwidth As Byte)

Setzt die verfügbaren Sensor-Konfigurationen für Magnetometer, Gyroskop und Beschleunigungssensor. Der Beschleunigungssensor-Wertebereich ist in allen Fusion-Modi wählbar, während alle anderen Konfigurationen im Fusion-Modus automatisch kontrolliert werden.

Die Standardwerte sind:

  • Magnetometer-Rate 20Hz
  • Gyroskop-Wertebereich 2000°/s
  • Gyroskop-Bandweite 32Hz
  • Beschleunigungssensor-Wertebereich +/-4G
  • Beschleunigungssensor-Bandweite 62.5Hz

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

  • BrickIMUV2.MAGNETOMETER_RATE_2HZ = 0
  • BrickIMUV2.MAGNETOMETER_RATE_6HZ = 1
  • BrickIMUV2.MAGNETOMETER_RATE_8HZ = 2
  • BrickIMUV2.MAGNETOMETER_RATE_10HZ = 3
  • BrickIMUV2.MAGNETOMETER_RATE_15HZ = 4
  • BrickIMUV2.MAGNETOMETER_RATE_20HZ = 5
  • BrickIMUV2.MAGNETOMETER_RATE_25HZ = 6
  • BrickIMUV2.MAGNETOMETER_RATE_30HZ = 7
  • BrickIMUV2.GYROSCOPE_RANGE_2000DPS = 0
  • BrickIMUV2.GYROSCOPE_RANGE_1000DPS = 1
  • BrickIMUV2.GYROSCOPE_RANGE_500DPS = 2
  • BrickIMUV2.GYROSCOPE_RANGE_250DPS = 3
  • BrickIMUV2.GYROSCOPE_RANGE_125DPS = 4
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_523HZ = 0
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_230HZ = 1
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_116HZ = 2
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_47HZ = 3
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_23HZ = 4
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_12HZ = 5
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_64HZ = 6
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_32HZ = 7
  • BrickIMUV2.ACCELEROMETER_RANGE_2G = 0
  • BrickIMUV2.ACCELEROMETER_RANGE_4G = 1
  • BrickIMUV2.ACCELEROMETER_RANGE_8G = 2
  • BrickIMUV2.ACCELEROMETER_RANGE_16G = 3
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_7_81HZ = 0
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_15_63HZ = 1
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_31_25HZ = 2
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_62_5HZ = 3
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_125HZ = 4
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_250HZ = 5
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_500HZ = 6
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_1000HZ = 7

Neu in Version 2.0.5 (Firmware).

Sub BrickIMUV2.GetSensorConfiguration(ByRef magnetometerRate As Byte, ByRef gyroscopeRange As Byte, ByRef gyroscopeBandwidth As Byte, ByRef accelerometerRange As Byte, ByRef accelerometerBandwidth As Byte)

Gibt die Sensor-Konfiguration zurück, wie von SetSensorConfiguration() gesetzt.

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

  • BrickIMUV2.MAGNETOMETER_RATE_2HZ = 0
  • BrickIMUV2.MAGNETOMETER_RATE_6HZ = 1
  • BrickIMUV2.MAGNETOMETER_RATE_8HZ = 2
  • BrickIMUV2.MAGNETOMETER_RATE_10HZ = 3
  • BrickIMUV2.MAGNETOMETER_RATE_15HZ = 4
  • BrickIMUV2.MAGNETOMETER_RATE_20HZ = 5
  • BrickIMUV2.MAGNETOMETER_RATE_25HZ = 6
  • BrickIMUV2.MAGNETOMETER_RATE_30HZ = 7
  • BrickIMUV2.GYROSCOPE_RANGE_2000DPS = 0
  • BrickIMUV2.GYROSCOPE_RANGE_1000DPS = 1
  • BrickIMUV2.GYROSCOPE_RANGE_500DPS = 2
  • BrickIMUV2.GYROSCOPE_RANGE_250DPS = 3
  • BrickIMUV2.GYROSCOPE_RANGE_125DPS = 4
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_523HZ = 0
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_230HZ = 1
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_116HZ = 2
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_47HZ = 3
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_23HZ = 4
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_12HZ = 5
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_64HZ = 6
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_32HZ = 7
  • BrickIMUV2.ACCELEROMETER_RANGE_2G = 0
  • BrickIMUV2.ACCELEROMETER_RANGE_4G = 1
  • BrickIMUV2.ACCELEROMETER_RANGE_8G = 2
  • BrickIMUV2.ACCELEROMETER_RANGE_16G = 3
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_7_81HZ = 0
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_15_63HZ = 1
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_31_25HZ = 2
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_62_5HZ = 3
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_125HZ = 4
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_250HZ = 5
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_500HZ = 6
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_1000HZ = 7

Neu in Version 2.0.5 (Firmware).

Sub BrickIMUV2.SetSensorFusionMode(ByVal mode As Byte)

Wenn der Fusion-Modus deaktiviert wird, geben die Funktionen GetAcceleration(), GetMagneticField() und GetAngularVelocity() unkalibrierte und umkompensierte Sensorwerte zurück. Alle anderen Sensordaten-Getter geben keine Daten zurück.

Seit Firmware Version 2.0.6 kann auch ein Fusion-Modus ohne Magnetometer ausgewählt werden. In diesem Modus wird die Orientierung relativ berechnet (mit Magnetometer ist sie absolut in Bezug auf die Erde). Allerdings kann die Berechnung in diesem Fall nicht von störenden Magnetfeldern beeinflusst werden.

Seit Firmware Version 2.0.13 kann auch ein Fusion-Modus ohne schnelle Magnetometer-Kalibrierung ausgewählt werden. Dieser Modus ist der gleiche wie der "normale" Fusion-Modus, aber die schnelle Magnetometer-Kalibrierung ist aus. D.h. die Orientierung zu finden mag beim ersten start länger dauern, allerdings mag es sein das kleine magnetische einflüsse die automatische Kalibrierung nicht so stark stören.

Standardmäßig ist der Fusion-Modus aktiviert.

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

  • BrickIMUV2.SENSOR_FUSION_OFF = 0
  • BrickIMUV2.SENSOR_FUSION_ON = 1
  • BrickIMUV2.SENSOR_FUSION_ON_WITHOUT_MAGNETOMETER = 2
  • BrickIMUV2.SENSOR_FUSION_ON_WITHOUT_FAST_MAGNETOMETER_CALIBRATION = 3

Neu in Version 2.0.5 (Firmware).

Function BrickIMUV2.GetSensorFusionMode() As Byte

Gibt den aktuellen Sensor-Fusion-Modus zurück, wie von SetSensorFusionMode() gesetzt.

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

  • BrickIMUV2.SENSOR_FUSION_OFF = 0
  • BrickIMUV2.SENSOR_FUSION_ON = 1
  • BrickIMUV2.SENSOR_FUSION_ON_WITHOUT_MAGNETOMETER = 2
  • BrickIMUV2.SENSOR_FUSION_ON_WITHOUT_FAST_MAGNETOMETER_CALIBRATION = 3

Neu in Version 2.0.5 (Firmware).

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

  • BrickIMUV2.FUNCTION_LEDS_ON = 10
  • BrickIMUV2.FUNCTION_LEDS_OFF = 11
  • BrickIMUV2.FUNCTION_SET_ACCELERATION_PERIOD = 14
  • BrickIMUV2.FUNCTION_SET_MAGNETIC_FIELD_PERIOD = 16
  • BrickIMUV2.FUNCTION_SET_ANGULAR_VELOCITY_PERIOD = 18
  • BrickIMUV2.FUNCTION_SET_TEMPERATURE_PERIOD = 20
  • BrickIMUV2.FUNCTION_SET_ORIENTATION_PERIOD = 22
  • BrickIMUV2.FUNCTION_SET_LINEAR_ACCELERATION_PERIOD = 24
  • BrickIMUV2.FUNCTION_SET_GRAVITY_VECTOR_PERIOD = 26
  • BrickIMUV2.FUNCTION_SET_QUATERNION_PERIOD = 28
  • BrickIMUV2.FUNCTION_SET_ALL_DATA_PERIOD = 30
  • BrickIMUV2.FUNCTION_SET_SENSOR_CONFIGURATION = 41
  • BrickIMUV2.FUNCTION_SET_SENSOR_FUSION_MODE = 43
  • BrickIMUV2.FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • BrickIMUV2.FUNCTION_SET_SPITFP_BAUDRATE = 234
  • BrickIMUV2.FUNCTION_ENABLE_STATUS_LED = 238
  • BrickIMUV2.FUNCTION_DISABLE_STATUS_LED = 239
  • BrickIMUV2.FUNCTION_RESET = 243
Sub BrickIMUV2.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:

  • BrickIMUV2.FUNCTION_LEDS_ON = 10
  • BrickIMUV2.FUNCTION_LEDS_OFF = 11
  • BrickIMUV2.FUNCTION_SET_ACCELERATION_PERIOD = 14
  • BrickIMUV2.FUNCTION_SET_MAGNETIC_FIELD_PERIOD = 16
  • BrickIMUV2.FUNCTION_SET_ANGULAR_VELOCITY_PERIOD = 18
  • BrickIMUV2.FUNCTION_SET_TEMPERATURE_PERIOD = 20
  • BrickIMUV2.FUNCTION_SET_ORIENTATION_PERIOD = 22
  • BrickIMUV2.FUNCTION_SET_LINEAR_ACCELERATION_PERIOD = 24
  • BrickIMUV2.FUNCTION_SET_GRAVITY_VECTOR_PERIOD = 26
  • BrickIMUV2.FUNCTION_SET_QUATERNION_PERIOD = 28
  • BrickIMUV2.FUNCTION_SET_ALL_DATA_PERIOD = 30
  • BrickIMUV2.FUNCTION_SET_SENSOR_CONFIGURATION = 41
  • BrickIMUV2.FUNCTION_SET_SENSOR_FUSION_MODE = 43
  • BrickIMUV2.FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • BrickIMUV2.FUNCTION_SET_SPITFP_BAUDRATE = 234
  • BrickIMUV2.FUNCTION_ENABLE_STATUS_LED = 238
  • BrickIMUV2.FUNCTION_DISABLE_STATUS_LED = 239
  • BrickIMUV2.FUNCTION_RESET = 243
Sub BrickIMUV2.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

Sub BrickIMUV2.SetSPITFPBaudrateConfig(ByVal enableDynamicBaudrate As Boolean, ByVal minimumDynamicBaudrate As Long)

Das SPITF-Protokoll kann mit einer dynamischen Baudrate genutzt werden. Wenn die dynamische Baudrate aktiviert ist, versucht der Brick die Baudrate anhand des Datenaufkommens zwischen Brick und Bricklet anzupassen.

Die Baudrate wird exponentiell erhöht wenn viele Daten gesendet/empfangen werden und linear verringert wenn wenig Daten gesendet/empfangen werden.

Diese Vorgehensweise verringert die Baudrate in Anwendungen wo nur wenig Daten ausgetauscht werden müssen (z.B. eine Wetterstation) und erhöht die Robustheit. Wenn immer viele Daten ausgetauscht werden (z.B. Thermal Imaging Bricklet), wird die Baudrate automatisch erhöht.

In Fällen wo wenige Daten all paar Sekunden so schnell wie Möglich übertragen werden sollen (z.B. RS485 Bricklet mit hoher Baudrate aber kleinem Payload) kann die dynamische Baudrate zum maximieren der Performance ausgestellt werden.

Die maximale Baudrate kann pro Port mit der Funktion SetSPITFPBaudrate(). gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von SetSPITFPBaudrate() gesetzt statisch verwendet.

Die minimale dynamische Baudrate hat einen Wertebereich von 400000 bis 2000000 Baud.

Standardmäßig ist die dynamische Baudrate aktiviert und die minimale dynamische Baudrate ist 400000.

Neu in Version 2.0.10 (Firmware).

Sub BrickIMUV2.GetSPITFPBaudrateConfig(ByRef enableDynamicBaudrate As Boolean, ByRef minimumDynamicBaudrate As Long)

Gibt die Baudratenkonfiguration zurück, siehe SetSPITFPBaudrateConfig().

Neu in Version 2.0.10 (Firmware).

Function BrickIMUV2.GetSendTimeoutCount(ByVal communicationMethod As Byte) As Long

Gibt den Timeout-Zähler für die verschiedenen Kommunikationsmöglichkeiten zurück

Die Kommunikationsmöglichkeiten 0-2 stehen auf allen Bricks zur verfügung, 3-7 nur auf Master Bricks.

Diese Funktion ist hauptsächlich zum debuggen während der Entwicklung gedacht. Im normalen Betrieb sollten alle Zähler fast immer auf 0 stehen bleiben.

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

  • BrickIMUV2.COMMUNICATION_METHOD_NONE = 0
  • BrickIMUV2.COMMUNICATION_METHOD_USB = 1
  • BrickIMUV2.COMMUNICATION_METHOD_SPI_STACK = 2
  • BrickIMUV2.COMMUNICATION_METHOD_CHIBI = 3
  • BrickIMUV2.COMMUNICATION_METHOD_RS485 = 4
  • BrickIMUV2.COMMUNICATION_METHOD_WIFI = 5
  • BrickIMUV2.COMMUNICATION_METHOD_ETHERNET = 6
  • BrickIMUV2.COMMUNICATION_METHOD_WIFI_V2 = 7

Neu in Version 2.0.7 (Firmware).

Sub BrickIMUV2.SetSPITFPBaudrate(ByVal brickletPort As Char, ByVal baudrate As Long)

Setzt die Baudrate eines spezifischen Bricklet Ports ('a' - 'd'). Die Baudrate hat einen möglichen Wertebereich von 400000 bis 2000000.

Für einen höheren Durchsatz der Bricklets kann die Baudrate erhöht werden. Wenn der Fehlerzähler auf Grund von lokaler Störeinstrahlung hoch ist (siehe GetSPITFPErrorCount()) kann die Baudrate verringert werden.

Wenn das Feature der dynamische Baudrate aktiviert ist, setzt diese Funktion die maximale Baudrate (siehe SetSPITFPBaudrateConfig()).

EMV Tests werden mit der Standardbaudrate durchgeführt. Falls eine CE-Kompatibilität o.ä. in der Anwendung notwendig ist empfehlen wir die Baudrate nicht zu ändern.

Die Standardbaudrate für alle Ports ist 1400000.

Neu in Version 2.0.5 (Firmware).

Function BrickIMUV2.GetSPITFPBaudrate(ByVal brickletPort As Char) As Long

Gibt die Baudrate für einen Bricklet Port zurück, siehe SetSPITFPBaudrate().

Neu in Version 2.0.5 (Firmware).

Sub BrickIMUV2.GetSPITFPErrorCount(ByVal brickletPort As Char, ByRef errorCountACKChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)

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 Bricks auftreten. Jedes Bricklet hat eine ähnliche Funktion welche die Fehler auf Brickletseite ausgibt.

Neu in Version 2.0.5 (Firmware).

Sub BrickIMUV2.EnableStatusLED()

Aktiviert die Status LED.

Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.

Der Standardzustand ist aktiviert.

Sub BrickIMUV2.DisableStatusLED()

Deaktiviert die Status LED.

Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.

Der Standardzustand ist aktiviert.

Function BrickIMUV2.IsStatusLEDEnabled() As Boolean

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

Sub BrickIMUV2.GetProtocol1BrickletName(ByVal port As Char, ByRef protocolVersion As Byte, ByRef firmwareVersion() As Byte, ByRef name As String)

Gibt die Firmware und Protokoll Version und den Namen des Bricklets für einen gegebenen Port zurück.

Der einzige Zweck dieser Funktion ist es, automatischen Flashen von Bricklet v1.x.y Plugins zu ermöglichen.

Function BrickIMUV2.GetChipTemperature() As Short

Gibt die Temperatur in °C/10, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine Genauigkeit von ±15%. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

Sub BrickIMUV2.Reset()

Ein Aufruf dieser Funktion setzt den Brick zurück. Befindet sich der Brick innerhalb eines Stapels wird der gesamte Stapel zurück gesetzt.

Nach dem Zurücksetzen ist es notwendig neue Geräteobjekte zu erzeugen, Funktionsaufrufe auf bestehende führt zu undefiniertem Verhalten.

Sub BrickIMUV2.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 der Brick verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position kann '0'-'8' (Stack Position) sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricks.

Konfigurationsfunktionen für Callbacks

Sub BrickIMUV2.SetAccelerationPeriod(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 Standardwert ist 0.

Function BrickIMUV2.GetAccelerationPeriod() As Long

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

Sub BrickIMUV2.SetMagneticFieldPeriod(ByVal period As Long)

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

Function BrickIMUV2.GetMagneticFieldPeriod() As Long

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

Sub BrickIMUV2.SetAngularVelocityPeriod(ByVal period As Long)

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

Function BrickIMUV2.GetAngularVelocityPeriod() As Long

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

Sub BrickIMUV2.SetTemperaturePeriod(ByVal period As Long)

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

Function BrickIMUV2.GetTemperaturePeriod() As Long

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

Sub BrickIMUV2.SetOrientationPeriod(ByVal period As Long)

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

Function BrickIMUV2.GetOrientationPeriod() As Long

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

Sub BrickIMUV2.SetLinearAccelerationPeriod(ByVal period As Long)

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

Function BrickIMUV2.GetLinearAccelerationPeriod() As Long

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

Sub BrickIMUV2.SetGravityVectorPeriod(ByVal period As Long)

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

Function BrickIMUV2.GetGravityVectorPeriod() As Long

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

Sub BrickIMUV2.SetQuaternionPeriod(ByVal period As Long)

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

Function BrickIMUV2.GetQuaternionPeriod() As Long

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

Sub BrickIMUV2.SetAllDataPeriod(ByVal period As Long)

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

Function BrickIMUV2.GetAllDataPeriod() As Long

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

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

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

Event BrickIMUV2.MagneticFieldCallback(ByVal sender As BrickIMUV2, ByVal x As Short, ByVal y As Short, ByVal z As Short)

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

Event BrickIMUV2.AngularVelocityCallback(ByVal sender As BrickIMUV2, ByVal x As Short, ByVal y As Short, ByVal z As Short)

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

Event BrickIMUV2.TemperatureCallback(ByVal sender As BrickIMUV2, ByVal temperature As Short)

Dieser Callback wird mit der Periode, wie gesetzt mit SetTemperaturePeriod(), ausgelöst. Der Parameter ist die Temperatur.

Event BrickIMUV2.LinearAccelerationCallback(ByVal sender As BrickIMUV2, ByVal x As Short, ByVal y As Short, ByVal z As Short)

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

Event BrickIMUV2.GravityVectorCallback(ByVal sender As BrickIMUV2, ByVal x As Short, ByVal y As Short, ByVal z As Short)

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

Event BrickIMUV2.OrientationCallback(ByVal sender As BrickIMUV2, ByVal heading As Short, ByVal roll As Short, ByVal pitch As Short)

Dieser Callback wird mit der Periode, wie gesetzt mit SetOrientationPeriod(), ausgelöst. Die Parameter sind die Orientierung (Gier-, Roll-, Nickwinkel) des IMU Brick in Eulerwinkeln. Siehe GetOrientation() für Details.

Event BrickIMUV2.QuaternionCallback(ByVal sender As BrickIMUV2, ByVal w As Short, ByVal x As Short, ByVal y As Short, ByVal z As Short)

Dieser Callback wird mit der Periode, wie gesetzt mit SetQuaternionPeriod(), ausgelöst. Die Parameter sind die Orientierung (x, y, z, w) des IMU Brick in Quaternionen. Siehe GetQuaternion() für Details.

Event BrickIMUV2.AllDataCallback(ByVal sender As BrickIMUV2, ByVal acceleration() As Short, ByVal magneticField() As Short, ByVal angularVelocity() As Short, ByVal eulerAngle() As Short, ByVal quaternion() As Short, ByVal linearAcceleration() As Short, ByVal gravityVector() As Short, ByVal temperature As Short, ByVal calibrationStatus As Byte)

Dieser Callback wird mit der Periode, wie gesetzt mit SetAllDataPeriod(), ausgelöst. Die Parameter sind die gleichen wie bei GetAllData().

Konstanten

Const BrickIMUV2.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um einen IMU Brick 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 BrickIMUV2.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines IMU Brick 2.0 dar.