Go - IMU Brick 2.0

Dies ist die Beschreibung der Go 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 Go API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf godoc.org.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example_simple.go)

 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
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/imu_v2_brick"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
)

const ADDR string = "localhost:4223"
const UID string = "XXYYZZ" // Change XXYYZZ to the UID of your IMU Brick 2.0.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    imu, _ := imu_v2_brick.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    // Get current quaternion.
    w, x, y, z, _ := imu.GetQuaternion()

    fmt.Printf("Quaternion [W]: %f\n", float64(w)/16383.0)
    fmt.Printf("Quaternion [X]: %f\n", float64(x)/16383.0)
    fmt.Printf("Quaternion [Y]: %f\n", float64(y)/16383.0)
    fmt.Printf("Quaternion [Z]: %f\n", float64(z)/16383.0)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

Callback

Download (example_callback.go)

 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
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/imu_v2_brick"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
)

const ADDR string = "localhost:4223"
const UID string = "XXYYZZ" // Change XXYYZZ to the UID of your IMU Brick 2.0.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    imu, _ := imu_v2_brick.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    imu.RegisterQuaternionCallback(func(w int16, x int16, y int16, z int16) {
        fmt.Printf("Quaternion [W]: %f\n", float64(w)/16383.0)
        fmt.Printf("Quaternion [X]: %f\n", float64(x)/16383.0)
        fmt.Printf("Quaternion [Y]: %f\n", float64(y)/16383.0)
        fmt.Printf("Quaternion [Z]: %f\n", float64(z)/16383.0)
        fmt.Println()
    })

    // Set period for quaternion receiver to 0.1s (100ms).
    imu.SetQuaternionPeriod(100)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

All Data

Download (example_all_data.go)

 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
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/imu_v2_brick"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
)

const ADDR string = "localhost:4223"
const UID string = "XXYYZZ" // Change XXYYZZ to the UID of your IMU Brick 2.0.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    imu, _ := imu_v2_brick.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    imu.RegisterAllDataCallback(func(acceleration [3]int16, magneticField [3]int16, angularVelocity [3]int16, eulerAngle [3]int16, quaternion [4]int16, linearAcceleration [3]int16, gravityVector [3]int16, temperature int8, calibrationStatus uint8) {
        fmt.Printf("Acceleration [X]: %f m/s²\n", float64(acceleration[0])/100.0)
        fmt.Printf("Acceleration [Y]: %f m/s²\n", float64(acceleration[1])/100.0)
        fmt.Printf("Acceleration [Z]: %f m/s²\n", float64(acceleration[2])/100.0)
        fmt.Printf("Magnetic Field [X]: %f µT\n", float64(magneticField[0])/16.0)
        fmt.Printf("Magnetic Field [Y]: %f µT\n", float64(magneticField[1])/16.0)
        fmt.Printf("Magnetic Field [Z]: %f µT\n", float64(magneticField[2])/16.0)
        fmt.Printf("Angular Velocity [X]: %f °/s\n", float64(angularVelocity[0])/16.0)
        fmt.Printf("Angular Velocity [Y]: %f °/s\n", float64(angularVelocity[1])/16.0)
        fmt.Printf("Angular Velocity [Z]: %f °/s\n", float64(angularVelocity[2])/16.0)
        fmt.Printf("Euler Angle [Heading]: %f °\n", float64(eulerAngle[0])/16.0)
        fmt.Printf("Euler Angle [Roll]: %f °\n", float64(eulerAngle[1])/16.0)
        fmt.Printf("Euler Angle [Pitch]: %f °\n", float64(eulerAngle[2])/16.0)
        fmt.Printf("Quaternion [W]: %f\n", float64(quaternion[0])/16383.0)
        fmt.Printf("Quaternion [X]: %f\n", float64(quaternion[1])/16383.0)
        fmt.Printf("Quaternion [Y]: %f\n", float64(quaternion[2])/16383.0)
        fmt.Printf("Quaternion [Z]: %f\n", float64(quaternion[3])/16383.0)
        fmt.Printf("Linear Acceleration [X]: %f m/s²\n", float64(linearAcceleration[0])/100.0)
        fmt.Printf("Linear Acceleration [Y]: %f m/s²\n", float64(linearAcceleration[1])/100.0)
        fmt.Printf("Linear Acceleration [Z]: %f m/s²\n", float64(linearAcceleration[2])/100.0)
        fmt.Printf("Gravity Vector [X]: %f m/s²\n", float64(gravityVector[0])/100.0)
        fmt.Printf("Gravity Vector [Y]: %f m/s²\n", float64(gravityVector[1])/100.0)
        fmt.Printf("Gravity Vector [Z]: %f m/s²\n", float64(gravityVector[2])/100.0)
        fmt.Printf("Temperature: %d °C\n", temperature)
        fmt.Printf("Calibration Status: %b\n", calibrationStatus)
        fmt.Println()
    })

    // Set period for all data receiver to 0.1s (100ms).
    imu.SetAllDataPeriod(100)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

API

Die API des IMU Brick 2.0 ist im Package github.com/Tinkerforge/go-api-bindings/imu_v2_brick definiert.

Fast alle Funktionen der Go Bindings können einen ipconnection.DeviceError, der das error-Interface implementiert, zurückgeben. Dieser kann folgende Werte annehmen:

  • ipconnection.DeviceErrorSuccess = 0
  • ipconnection.DeviceErrorInvalidParameter = 1
  • ipconnection.DeviceErrorFunctionNotSupported = 2
  • ipconnection.DeviceErrorUnknownError = 3

welche den Werten entsprechen, die der Brick oder das Bricklet zurückgeben.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

func imu_v2_brick.New(uid string, ipcon *IPConnection) (device IMUV2Brick, err error)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: *IPConnection
Rückgabe:
  • device – Typ: IMUV2Brick
  • err – Typ: error

Erzeugt ein neues IMUV2Brick-Objekt mit der eindeutigen Geräte ID uid und fügt es der IPConnection ipcon hinzu:

device, err := imu_v2_brick.New("YOUR_DEVICE_UID", &ipcon)

Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden wurde (siehe Beispiele oben).

func (*IMUV2Brick) GetOrientation() (heading int16, roll int16, pitch int16, err error)
Rückgabe:
  • heading – Typ: int16, Einheit: 1/16 °, Wertebereich: [0 bis 5760]
  • roll – Typ: int16, Einheit: 1/16 °, Wertebereich: [-1440 bis 1440]
  • pitch – Typ: int16, Einheit: 1/16 °, Wertebereich: [-2880 bis 2880]
  • err – Typ: error

Gibt die aktuelle Orientierung (Gier-, Roll-, Nickwinkel) des IMU Brick in unabhängigen Eulerwinkeln 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.

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

func (*IMUV2Brick) GetLinearAcceleration() (x int16, y int16, z int16, err error)
Rückgabe:
  • x – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
  • y – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
  • z – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
  • err – Typ: error

Gibt die lineare Beschleunigungen des IMU Brick für die X-, Y- und Z-Achse zurück. Die Beschleunigungen liegen im Wertebereich, der mit SetSensorConfiguration() konfiguriert wurde.

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 RegisterLinearAccelerationCallback Callback zu nutzen und die Periode mit SetLinearAccelerationPeriod() vorzugeben.

func (*IMUV2Brick) GetGravityVector() (x int16, y int16, z int16, err error)
Rückgabe:
  • x – Typ: int16, Einheit: 1 cm/s, Wertebereich: [-981 bis 981]
  • y – Typ: int16, Einheit: 1 cm/s, Wertebereich: [-981 bis 981]
  • z – Typ: int16, Einheit: 1 cm/s, Wertebereich: [-981 bis 981]
  • err – Typ: error

Gibt den Vektor der Erdbeschleunigung des IMU Brick für die X-, Y- und Z-Achse 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 RegisterGravityVectorCallback Callback zu nutzen und die Periode mit SetGravityVectorPeriod() vorzugeben.

func (*IMUV2Brick) GetQuaternion() (w int16, x int16, y int16, z int16, err error)
Rückgabe:
  • w – Typ: int16, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
  • x – Typ: int16, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
  • y – Typ: int16, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
  • z – Typ: int16, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
  • err – Typ: error

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

Die Rückgabewerte 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 RegisterQuaternionCallback Callback zu nutzen und die Periode mit SetQuaternionPeriod() vorzugeben.

func (*IMUV2Brick) GetAllData() (acceleration [3]int16, magneticField [3]int16, angularVelocity [3]int16, eulerAngle [3]int16, quaternion [4]int16, linearAcceleration [3]int16, gravityVector [3]int16, temperature int8, calibrationStatus uint8, err error)
Rückgabe:
  • acceleration – Typ: [3]int16
    • 0: x – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
    • 1: y – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
    • 2: z – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
  • magneticField – Typ: [3]int16
    • 0: x – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800]
    • 1: y – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800]
    • 2: z – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-40000 bis 40000]
  • angularVelocity – Typ: [3]int16
    • 0: x – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ?
    • 1: y – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ?
    • 2: z – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ?
  • eulerAngle – Typ: [3]int16
    • 0: heading – Typ: int16, Einheit: 1/16 °, Wertebereich: [0 bis 5760]
    • 1: roll – Typ: int16, Einheit: 1/16 °, Wertebereich: [-1440 bis 1440]
    • 2: pitch – Typ: int16, Einheit: 1/16 °, Wertebereich: [-2880 bis 2880]
  • quaternion – Typ: [4]int16
    • 0: w – Typ: int16, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
    • 1: x – Typ: int16, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
    • 2: y – Typ: int16, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
    • 3: z – Typ: int16, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
  • linearAcceleration – Typ: [3]int16
    • 0: x – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
    • 1: y – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
    • 2: z – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
  • gravityVector – Typ: [3]int16
    • 0: x – Typ: int16, Einheit: 1 cm/s, Wertebereich: [-981 bis 981]
    • 1: y – Typ: int16, Einheit: 1 cm/s, Wertebereich: [-981 bis 981]
    • 2: z – Typ: int16, Einheit: 1 cm/s, Wertebereich: [-981 bis 981]
  • temperature – Typ: int8, Einheit: 1 °C, Wertebereich: [-128 bis 127]
  • calibrationStatus – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

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 RegisterAllDataCallback Callback zu nutzen und die Periode mit SetAllDataPeriod() vorzugeben.

func (*IMUV2Brick) LedsOn() (err error)
Rückgabe:
  • err – Typ: error

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

func (*IMUV2Brick) LedsOff() (err error)
Rückgabe:
  • err – Typ: error

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

func (*IMUV2Brick) AreLedsOn() (leds bool, err error)
Rückgabe:
  • leds – Typ: bool, Standardwert: true
  • err – Typ: error

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

Fortgeschrittene Funktionen

func (*IMUV2Brick) GetAcceleration() (x int16, y int16, z int16, err error)
Rückgabe:
  • x – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
  • y – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
  • z – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
  • err – Typ: error

Gibt die kalibrierten Beschleunigungen des Beschleunigungsmessers für die X-, Y- und Z-Achse zurück. Die Beschleunigungen liegen im Wertebereich, der mit SetSensorConfiguration() konfiguriert wurde.

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

func (*IMUV2Brick) GetMagneticField() (x int16, y int16, z int16, err error)
Rückgabe:
  • x – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800]
  • y – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800]
  • z – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-40000 bis 40000]
  • err – Typ: error

Gibt das kalibrierte Magnetfeld des Magnetometers für die X-, Y- und Z-Komponenten zurück.

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

func (*IMUV2Brick) GetAngularVelocity() (x int16, y int16, z int16, err error)
Rückgabe:
  • x – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ?
  • y – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ?
  • z – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ?
  • err – Typ: error

Gibt die kalibrierte Winkelgeschwindigkeiten des Gyroskops für die X-, Y- und Z-Achse zurück. Die Winkelgeschwindigkeiten liegen im Wertebereich, der mit SetSensorConfiguration() konfiguriert wurde.

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

func (*IMUV2Brick) GetTemperature() (temperature int8, err error)
Rückgabe:
  • temperature – Typ: int8, Einheit: 1 °C, Wertebereich: [-128 bis 127]
  • err – Typ: error

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

func (*IMUV2Brick) SaveCalibration() (calibrationDone bool, err error)
Rückgabe:
  • calibrationDone – Typ: bool
  • err – Typ: error

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.

func (*IMUV2Brick) SetSensorConfiguration(magnetometerRate uint8, gyroscopeRange uint8, gyroscopeBandwidth uint8, accelerometerRange uint8, accelerometerBandwidth uint8) (err error)
Parameter:
  • magnetometerRate – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 5
  • gyroscopeRange – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • gyroscopeBandwidth – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 7
  • accelerometerRange – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 1
  • accelerometerBandwidth – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • err – Typ: error

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 folgenden Konstanten sind für diese Funktion verfügbar:

Für magnetometerRate:

  • imu_v2_brick.MagnetometerRate2Hz = 0
  • imu_v2_brick.MagnetometerRate6Hz = 1
  • imu_v2_brick.MagnetometerRate8Hz = 2
  • imu_v2_brick.MagnetometerRate10Hz = 3
  • imu_v2_brick.MagnetometerRate15Hz = 4
  • imu_v2_brick.MagnetometerRate20Hz = 5
  • imu_v2_brick.MagnetometerRate25Hz = 6
  • imu_v2_brick.MagnetometerRate30Hz = 7

Für gyroscopeRange:

  • imu_v2_brick.GyroscopeRange2000DPS = 0
  • imu_v2_brick.GyroscopeRange1000DPS = 1
  • imu_v2_brick.GyroscopeRange500DPS = 2
  • imu_v2_brick.GyroscopeRange250DPS = 3
  • imu_v2_brick.GyroscopeRange125DPS = 4

Für gyroscopeBandwidth:

  • imu_v2_brick.GyroscopeBandwidth523Hz = 0
  • imu_v2_brick.GyroscopeBandwidth230Hz = 1
  • imu_v2_brick.GyroscopeBandwidth116Hz = 2
  • imu_v2_brick.GyroscopeBandwidth47Hz = 3
  • imu_v2_brick.GyroscopeBandwidth23Hz = 4
  • imu_v2_brick.GyroscopeBandwidth12Hz = 5
  • imu_v2_brick.GyroscopeBandwidth64Hz = 6
  • imu_v2_brick.GyroscopeBandwidth32Hz = 7

Für accelerometerRange:

  • imu_v2_brick.AccelerometerRange2G = 0
  • imu_v2_brick.AccelerometerRange4G = 1
  • imu_v2_brick.AccelerometerRange8G = 2
  • imu_v2_brick.AccelerometerRange16G = 3

Für accelerometerBandwidth:

  • imu_v2_brick.AccelerometerBandwidth7_81Hz = 0
  • imu_v2_brick.AccelerometerBandwidth15_63Hz = 1
  • imu_v2_brick.AccelerometerBandwidth31_25Hz = 2
  • imu_v2_brick.AccelerometerBandwidth62_5Hz = 3
  • imu_v2_brick.AccelerometerBandwidth125Hz = 4
  • imu_v2_brick.AccelerometerBandwidth250Hz = 5
  • imu_v2_brick.AccelerometerBandwidth500Hz = 6
  • imu_v2_brick.AccelerometerBandwidth1000Hz = 7

Neu in Version 2.0.5 (Firmware).

func (*IMUV2Brick) GetSensorConfiguration() (magnetometerRate uint8, gyroscopeRange uint8, gyroscopeBandwidth uint8, accelerometerRange uint8, accelerometerBandwidth uint8, err error)
Rückgabe:
  • magnetometerRate – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 5
  • gyroscopeRange – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • gyroscopeBandwidth – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 7
  • accelerometerRange – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 1
  • accelerometerBandwidth – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
  • err – Typ: error

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

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

Für magnetometerRate:

  • imu_v2_brick.MagnetometerRate2Hz = 0
  • imu_v2_brick.MagnetometerRate6Hz = 1
  • imu_v2_brick.MagnetometerRate8Hz = 2
  • imu_v2_brick.MagnetometerRate10Hz = 3
  • imu_v2_brick.MagnetometerRate15Hz = 4
  • imu_v2_brick.MagnetometerRate20Hz = 5
  • imu_v2_brick.MagnetometerRate25Hz = 6
  • imu_v2_brick.MagnetometerRate30Hz = 7

Für gyroscopeRange:

  • imu_v2_brick.GyroscopeRange2000DPS = 0
  • imu_v2_brick.GyroscopeRange1000DPS = 1
  • imu_v2_brick.GyroscopeRange500DPS = 2
  • imu_v2_brick.GyroscopeRange250DPS = 3
  • imu_v2_brick.GyroscopeRange125DPS = 4

Für gyroscopeBandwidth:

  • imu_v2_brick.GyroscopeBandwidth523Hz = 0
  • imu_v2_brick.GyroscopeBandwidth230Hz = 1
  • imu_v2_brick.GyroscopeBandwidth116Hz = 2
  • imu_v2_brick.GyroscopeBandwidth47Hz = 3
  • imu_v2_brick.GyroscopeBandwidth23Hz = 4
  • imu_v2_brick.GyroscopeBandwidth12Hz = 5
  • imu_v2_brick.GyroscopeBandwidth64Hz = 6
  • imu_v2_brick.GyroscopeBandwidth32Hz = 7

Für accelerometerRange:

  • imu_v2_brick.AccelerometerRange2G = 0
  • imu_v2_brick.AccelerometerRange4G = 1
  • imu_v2_brick.AccelerometerRange8G = 2
  • imu_v2_brick.AccelerometerRange16G = 3

Für accelerometerBandwidth:

  • imu_v2_brick.AccelerometerBandwidth7_81Hz = 0
  • imu_v2_brick.AccelerometerBandwidth15_63Hz = 1
  • imu_v2_brick.AccelerometerBandwidth31_25Hz = 2
  • imu_v2_brick.AccelerometerBandwidth62_5Hz = 3
  • imu_v2_brick.AccelerometerBandwidth125Hz = 4
  • imu_v2_brick.AccelerometerBandwidth250Hz = 5
  • imu_v2_brick.AccelerometerBandwidth500Hz = 6
  • imu_v2_brick.AccelerometerBandwidth1000Hz = 7

Neu in Version 2.0.5 (Firmware).

func (*IMUV2Brick) SetSensorFusionMode(mode uint8) (err error)
Parameter:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 1
Rückgabe:
  • err – Typ: error

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.

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

Für mode:

  • imu_v2_brick.SensorFusionOff = 0
  • imu_v2_brick.SensorFusionOn = 1
  • imu_v2_brick.SensorFusionOnWithoutMagnetometer = 2
  • imu_v2_brick.SensorFusionOnWithoutFastMagnetometerCalibration = 3

Neu in Version 2.0.5 (Firmware).

func (*IMUV2Brick) GetSensorFusionMode() (mode uint8, err error)
Rückgabe:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 1
  • err – Typ: error

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

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

Für mode:

  • imu_v2_brick.SensorFusionOff = 0
  • imu_v2_brick.SensorFusionOn = 1
  • imu_v2_brick.SensorFusionOnWithoutMagnetometer = 2
  • imu_v2_brick.SensorFusionOnWithoutFastMagnetometerCalibration = 3

Neu in Version 2.0.5 (Firmware).

func (*IMUV2Brick) SetSPITFPBaudrateConfig(enableDynamicBaudrate bool, minimumDynamicBaudrate uint32) (err error)
Parameter:
  • enableDynamicBaudrate – Typ: bool, Standardwert: true
  • minimumDynamicBaudrate – Typ: uint32, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000
Rückgabe:
  • err – Typ: error

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.

Neu in Version 2.0.10 (Firmware).

func (*IMUV2Brick) GetSPITFPBaudrateConfig() (enableDynamicBaudrate bool, minimumDynamicBaudrate uint32, err error)
Rückgabe:
  • enableDynamicBaudrate – Typ: bool, Standardwert: true
  • minimumDynamicBaudrate – Typ: uint32, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000
  • err – Typ: error

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

Neu in Version 2.0.10 (Firmware).

func (*IMUV2Brick) GetSendTimeoutCount(communicationMethod uint8) (timeoutCount uint32, err error)
Parameter:
  • communicationMethod – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • timeoutCount – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • err – Typ: error

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:

Für communicationMethod:

  • imu_v2_brick.CommunicationMethodNone = 0
  • imu_v2_brick.CommunicationMethodUSB = 1
  • imu_v2_brick.CommunicationMethodSPIStack = 2
  • imu_v2_brick.CommunicationMethodChibi = 3
  • imu_v2_brick.CommunicationMethodRS485 = 4
  • imu_v2_brick.CommunicationMethodWIFI = 5
  • imu_v2_brick.CommunicationMethodEthernet = 6
  • imu_v2_brick.CommunicationMethodWIFIV2 = 7

Neu in Version 2.0.7 (Firmware).

func (*IMUV2Brick) SetSPITFPBaudrate(brickletPort rune, baudrate uint32) (err error)
Parameter:
  • brickletPort – Typ: rune, Wertebereich: ['a' bis 'b']
  • baudrate – Typ: uint32, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000
Rückgabe:
  • err – Typ: error

Setzt die Baudrate eines spezifischen Bricklet Ports .

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.

Neu in Version 2.0.5 (Firmware).

func (*IMUV2Brick) GetSPITFPBaudrate(brickletPort rune) (baudrate uint32, err error)
Parameter:
  • brickletPort – Typ: rune, Wertebereich: ['a' bis 'b']
Rückgabe:
  • baudrate – Typ: uint32, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000
  • err – Typ: error

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

Neu in Version 2.0.5 (Firmware).

func (*IMUV2Brick) GetSPITFPErrorCount(brickletPort rune) (errorCountACKChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)
Parameter:
  • brickletPort – Typ: rune, Wertebereich: ['a' bis 'b']
Rückgabe:
  • errorCountACKChecksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • err – Typ: error

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

func (*IMUV2Brick) EnableStatusLED() (err error)
Rückgabe:
  • err – Typ: error

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.

func (*IMUV2Brick) DisableStatusLED() (err error)
Rückgabe:
  • err – Typ: error

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.

func (*IMUV2Brick) IsStatusLEDEnabled() (enabled bool, err error)
Rückgabe:
  • enabled – Typ: bool, Standardwert: true
  • err – Typ: error

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

func (*IMUV2Brick) GetProtocol1BrickletName(port rune) (protocolVersion uint8, firmwareVersion [3]uint8, name string, err error)
Parameter:
  • port – Typ: rune, Wertebereich: ['a' bis 'b']
Rückgabe:
  • protocolVersion – Typ: uint8, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • name – Typ: string, Länge: bis zu 40
  • err – Typ: error

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.

func (*IMUV2Brick) GetChipTemperature() (temperature int16, err error)
Rückgabe:
  • temperature – Typ: int16, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1]
  • err – Typ: error

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 Genauigkeit von ±15%. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

func (*IMUV2Brick) Reset() (err error)
Rückgabe:
  • err – Typ: error

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.

func (*IMUV2Brick) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)
Rückgabe:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: rune, Wertebereich: ['0' bis '8']
  • hardwareVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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 ist die Position im Stack von '0' (unterster Brick) bis '8' (oberster Brick).

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

func (*IMUV2Brick) SetAccelerationPeriod(period uint32) (err error)
Parameter:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • err – Typ: error

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

func (*IMUV2Brick) GetAccelerationPeriod() (period uint32, err error)
Rückgabe:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • err – Typ: error

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

func (*IMUV2Brick) SetMagneticFieldPeriod(period uint32) (err error)
Parameter:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • err – Typ: error

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

func (*IMUV2Brick) GetMagneticFieldPeriod() (period uint32, err error)
Rückgabe:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • err – Typ: error

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

func (*IMUV2Brick) SetAngularVelocityPeriod(period uint32) (err error)
Parameter:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • err – Typ: error

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

func (*IMUV2Brick) GetAngularVelocityPeriod() (period uint32, err error)
Rückgabe:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • err – Typ: error

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

func (*IMUV2Brick) SetTemperaturePeriod(period uint32) (err error)
Parameter:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • err – Typ: error

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

func (*IMUV2Brick) GetTemperaturePeriod() (period uint32, err error)
Rückgabe:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • err – Typ: error

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

func (*IMUV2Brick) SetOrientationPeriod(period uint32) (err error)
Parameter:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • err – Typ: error

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

func (*IMUV2Brick) GetOrientationPeriod() (period uint32, err error)
Rückgabe:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • err – Typ: error

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

func (*IMUV2Brick) SetLinearAccelerationPeriod(period uint32) (err error)
Parameter:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • err – Typ: error

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

func (*IMUV2Brick) GetLinearAccelerationPeriod() (period uint32, err error)
Rückgabe:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • err – Typ: error

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

func (*IMUV2Brick) SetGravityVectorPeriod(period uint32) (err error)
Parameter:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • err – Typ: error

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

func (*IMUV2Brick) GetGravityVectorPeriod() (period uint32, err error)
Rückgabe:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • err – Typ: error

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

func (*IMUV2Brick) SetQuaternionPeriod(period uint32) (err error)
Parameter:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • err – Typ: error

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

func (*IMUV2Brick) GetQuaternionPeriod() (period uint32, err error)
Rückgabe:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • err – Typ: error

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

func (*IMUV2Brick) SetAllDataPeriod(period uint32) (err error)
Parameter:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • err – Typ: error

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

func (*IMUV2Brick) GetAllDataPeriod() (period uint32, err error)
Rückgabe:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • err – Typ: error

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 kann mit der entsprechenden Register*Callback-Function durchgeführt werden, welche eine eindeutige Callback-ID zurück gibt. Mit dieser ID kann das Callback später deregistriert werden.

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.

func (*IMUV2Brick) RegisterAccelerationCallback(func(x int16, y int16, z int16)) (registrationId uint64)
Callback-Parameter:
  • x – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
  • y – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
  • z – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
Rückgabe:
  • registrationId – Typ: uint64

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

func (*IMUV2Brick) RegisterMagneticFieldCallback(func(x int16, y int16, z int16)) (registrationId uint64)
Callback-Parameter:
  • x – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800]
  • y – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800]
  • z – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-40000 bis 40000]
Rückgabe:
  • registrationId – Typ: uint64

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

func (*IMUV2Brick) RegisterAngularVelocityCallback(func(x int16, y int16, z int16)) (registrationId uint64)
Callback-Parameter:
  • x – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ?
  • y – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ?
  • z – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ?
Rückgabe:
  • registrationId – Typ: uint64

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

func (*IMUV2Brick) RegisterTemperatureCallback(func(temperature int8)) (registrationId uint64)
Callback-Parameter:
  • temperature – Typ: int8, Einheit: 1 °C, Wertebereich: [-128 bis 127]
Rückgabe:
  • registrationId – Typ: uint64

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

func (*IMUV2Brick) RegisterLinearAccelerationCallback(func(x int16, y int16, z int16)) (registrationId uint64)
Callback-Parameter:
  • x – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
  • y – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
  • z – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
Rückgabe:
  • registrationId – Typ: uint64

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

func (*IMUV2Brick) RegisterGravityVectorCallback(func(x int16, y int16, z int16)) (registrationId uint64)
Callback-Parameter:
  • x – Typ: int16, Einheit: 1 cm/s, Wertebereich: [-981 bis 981]
  • y – Typ: int16, Einheit: 1 cm/s, Wertebereich: [-981 bis 981]
  • z – Typ: int16, Einheit: 1 cm/s, Wertebereich: [-981 bis 981]
Rückgabe:
  • registrationId – Typ: uint64

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

func (*IMUV2Brick) RegisterOrientationCallback(func(heading int16, roll int16, pitch int16)) (registrationId uint64)
Callback-Parameter:
  • heading – Typ: int16, Einheit: 1/16 °, Wertebereich: [0 bis 5760]
  • roll – Typ: int16, Einheit: 1/16 °, Wertebereich: [-1440 bis 1440]
  • pitch – Typ: int16, Einheit: 1/16 °, Wertebereich: [-2880 bis 2880]
Rückgabe:
  • registrationId – Typ: uint64

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

func (*IMUV2Brick) RegisterQuaternionCallback(func(w int16, x int16, y int16, z int16)) (registrationId uint64)
Callback-Parameter:
  • w – Typ: int16, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
  • x – Typ: int16, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
  • y – Typ: int16, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
  • z – Typ: int16, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
Rückgabe:
  • registrationId – Typ: uint64

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

func (*IMUV2Brick) RegisterAllDataCallback(func(acceleration [3]int16, magneticField [3]int16, angularVelocity [3]int16, eulerAngle [3]int16, quaternion [4]int16, linearAcceleration [3]int16, gravityVector [3]int16, temperature int8, calibrationStatus uint8)) (registrationId uint64)
Callback-Parameter:
  • acceleration – Typ: [3]int16
    • 0: x – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
    • 1: y – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
    • 2: z – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
  • magneticField – Typ: [3]int16
    • 0: x – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800]
    • 1: y – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800]
    • 2: z – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-40000 bis 40000]
  • angularVelocity – Typ: [3]int16
    • 0: x – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ?
    • 1: y – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ?
    • 2: z – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ?
  • eulerAngle – Typ: [3]int16
    • 0: heading – Typ: int16, Einheit: 1/16 °, Wertebereich: [0 bis 5760]
    • 1: roll – Typ: int16, Einheit: 1/16 °, Wertebereich: [-1440 bis 1440]
    • 2: pitch – Typ: int16, Einheit: 1/16 °, Wertebereich: [-2880 bis 2880]
  • quaternion – Typ: [4]int16
    • 0: w – Typ: int16, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
    • 1: x – Typ: int16, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
    • 2: y – Typ: int16, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
    • 3: z – Typ: int16, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
  • linearAcceleration – Typ: [3]int16
    • 0: x – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
    • 1: y – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
    • 2: z – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
  • gravityVector – Typ: [3]int16
    • 0: x – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
    • 1: y – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
    • 2: z – Typ: int16, Einheit: 1 cm/s, Wertebereich: ?
  • temperature – Typ: int8, Einheit: 1 °C, Wertebereich: [-128 bis 127]
  • calibrationStatus – Typ: uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • registrationId – Typ: uint64

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

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.

func (*IMUV2Brick) GetAPIVersion() (apiVersion [3]uint8, err error)
Rückgabe:
  • apiVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

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.

func (*IMUV2Brick) GetResponseExpected(functionId uint8) (responseExpected bool, err error)
Parameter:
  • functionId – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: bool
  • err – Typ: error

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:

  • imu_v2_brick.FunctionLedsOn = 10
  • imu_v2_brick.FunctionLedsOff = 11
  • imu_v2_brick.FunctionSetAccelerationPeriod = 14
  • imu_v2_brick.FunctionSetMagneticFieldPeriod = 16
  • imu_v2_brick.FunctionSetAngularVelocityPeriod = 18
  • imu_v2_brick.FunctionSetTemperaturePeriod = 20
  • imu_v2_brick.FunctionSetOrientationPeriod = 22
  • imu_v2_brick.FunctionSetLinearAccelerationPeriod = 24
  • imu_v2_brick.FunctionSetGravityVectorPeriod = 26
  • imu_v2_brick.FunctionSetQuaternionPeriod = 28
  • imu_v2_brick.FunctionSetAllDataPeriod = 30
  • imu_v2_brick.FunctionSetSensorConfiguration = 41
  • imu_v2_brick.FunctionSetSensorFusionMode = 43
  • imu_v2_brick.FunctionSetSPITFPBaudrateConfig = 231
  • imu_v2_brick.FunctionSetSPITFPBaudrate = 234
  • imu_v2_brick.FunctionEnableStatusLED = 238
  • imu_v2_brick.FunctionDisableStatusLED = 239
  • imu_v2_brick.FunctionReset = 243
func (*IMUV2Brick) SetResponseExpected(functionId uint8, responseExpected bool) (err error)
Parameter:
  • functionId – Typ: uint8, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: bool
Rückgabe:
  • err – Typ: error

Ä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:

  • imu_v2_brick.FunctionLedsOn = 10
  • imu_v2_brick.FunctionLedsOff = 11
  • imu_v2_brick.FunctionSetAccelerationPeriod = 14
  • imu_v2_brick.FunctionSetMagneticFieldPeriod = 16
  • imu_v2_brick.FunctionSetAngularVelocityPeriod = 18
  • imu_v2_brick.FunctionSetTemperaturePeriod = 20
  • imu_v2_brick.FunctionSetOrientationPeriod = 22
  • imu_v2_brick.FunctionSetLinearAccelerationPeriod = 24
  • imu_v2_brick.FunctionSetGravityVectorPeriod = 26
  • imu_v2_brick.FunctionSetQuaternionPeriod = 28
  • imu_v2_brick.FunctionSetAllDataPeriod = 30
  • imu_v2_brick.FunctionSetSensorConfiguration = 41
  • imu_v2_brick.FunctionSetSensorFusionMode = 43
  • imu_v2_brick.FunctionSetSPITFPBaudrateConfig = 231
  • imu_v2_brick.FunctionSetSPITFPBaudrate = 234
  • imu_v2_brick.FunctionEnableStatusLED = 238
  • imu_v2_brick.FunctionDisableStatusLED = 239
  • imu_v2_brick.FunctionReset = 243
func (*IMUV2Brick) SetResponseExpectedAll(responseExpected bool) (err error)
Parameter:
  • responseExpected – Typ: bool
Rückgabe:
  • err – Typ: error

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

Konstanten

imu_v2_brick.DeviceIdentifier

Diese Konstante wird verwendet um einen IMU Brick 2.0 zu identifizieren.

Die GetIdentity() Funktion und der (*IPConnection) RegisterEnumerateCallback Callback der IPConnection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

imu_v2_brick.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines IMU Brick 2.0 dar.