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.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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()
}
|
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()
}
|
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()
}
|
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:
welche den Werten entsprechen, die der Brick oder das Bricklet zurückgeben.
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
imu_v2_brick.
New
(uid string, ipcon *IPConnection) (device IMUV2Brick, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
(*IMUV2Brick)
GetOrientation
() (heading int16, roll int16, pitch int16, err error)¶Rückgabe: |
|
---|
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
OrientationCallback
Callback zu nutzen und die Periode mit
SetOrientationPeriod()
vorzugeben.
(*IMUV2Brick)
GetLinearAcceleration
() (x int16, y int16, z int16, err error)¶Rückgabe: |
|
---|
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 LinearAccelerationCallback
Callback zu nutzen und die Periode mit
SetLinearAccelerationPeriod()
vorzugeben.
(*IMUV2Brick)
GetGravityVector
() (x int16, y int16, z int16, err error)¶Rückgabe: |
|
---|
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 GravityVectorCallback
Callback zu nutzen und die Periode mit
SetGravityVectorPeriod()
vorzugeben.
(*IMUV2Brick)
GetQuaternion
() (w int16, x int16, y int16, z int16, err error)¶Rückgabe: |
|
---|
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
QuaternionCallback
Callback zu nutzen und die Periode mit
SetQuaternionPeriod()
vorzugeben.
(*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: |
|
---|
Gibt alle Daten zurück die dem IMU Brick zur Verfügung stehen.
GetAcceleration()
)GetMagneticField()
)GetAngularVelocity()
)GetOrientation()
)GetQuaternion()
)GetLinearAcceleration()
)GetGravityVector()
)GetTemperature()
)Der Kalibrierungsstatus besteht aus vier Paaren von je zwei Bits. Jedes Paar von Bits repräsentiert den Status der aktuellen Kalibrierung.
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.
(*IMUV2Brick)
LedsOn
() (err error)¶Rückgabe: |
|
---|
Aktiviert die Orientierungs- und Richtungs-LEDs des IMU Brick.
(*IMUV2Brick)
LedsOff
() (err error)¶Rückgabe: |
|
---|
Deaktiviert die Orientierungs- und Richtungs-LEDs des IMU Brick.
(*IMUV2Brick)
AreLedsOn
() (leds bool, err error)¶Rückgabe: |
|
---|
Gibt zurück ob die Orientierungs- und Richtungs-LEDs des IMU Brick aktiv sind.
(*IMUV2Brick)
GetAcceleration
() (x int16, y int16, z int16, err error)¶Rückgabe: |
|
---|
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 AccelerationCallback
Callback zu nutzen und die Periode mit
SetAccelerationPeriod()
vorzugeben.
(*IMUV2Brick)
GetMagneticField
() (x int16, y int16, z int16, err error)¶Rückgabe: |
|
---|
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 MagneticFieldCallback
Callback zu nutzen und die Periode mit
SetMagneticFieldPeriod()
vorzugeben.
(*IMUV2Brick)
GetAngularVelocity
() (x int16, y int16, z int16, err error)¶Rückgabe: |
|
---|
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 AngularVelocityCallback
Callback zu nutzen und die Periode mit
SetAngularVelocityPeriod()
vorzugeben.
(*IMUV2Brick)
GetTemperature
() (temperature int8, err error)¶Rückgabe: |
|
---|
Gibt die Temperatur des IMU Brick zurück. Die Temperatur wird im Kern des BNO055 ICs gemessen, es handelt sich nicht um die Umgebungstemperatur.
(*IMUV2Brick)
SaveCalibration
() (calibrationDone bool, err error)¶Rückgabe: |
|
---|
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.
(*IMUV2Brick)
SetSensorConfiguration
(magnetometerRate uint8, gyroscopeRange uint8, gyroscopeBandwidth uint8, accelerometerRange uint8, accelerometerBandwidth uint8) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
Für gyroscopeRange:
Für gyroscopeBandwidth:
Für accelerometerRange:
Für accelerometerBandwidth:
Neu in Version 2.0.5 (Firmware).
(*IMUV2Brick)
GetSensorConfiguration
() (magnetometerRate uint8, gyroscopeRange uint8, gyroscopeBandwidth uint8, accelerometerRange uint8, accelerometerBandwidth uint8, err error)¶Rückgabe: |
|
---|
Gibt die Sensor-Konfiguration zurück, wie von SetSensorConfiguration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für magnetometerRate:
Für gyroscopeRange:
Für gyroscopeBandwidth:
Für accelerometerRange:
Für accelerometerBandwidth:
Neu in Version 2.0.5 (Firmware).
(*IMUV2Brick)
SetSensorFusionMode
(mode uint8) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
Neu in Version 2.0.5 (Firmware).
(*IMUV2Brick)
GetSensorFusionMode
() (mode uint8, err error)¶Rückgabe: |
|
---|
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:
Neu in Version 2.0.5 (Firmware).
(*IMUV2Brick)
SetSPITFPBaudrateConfig
(enableDynamicBaudrate bool, minimumDynamicBaudrate uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
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).
(*IMUV2Brick)
GetSPITFPBaudrateConfig
() (enableDynamicBaudrate bool, minimumDynamicBaudrate uint32, err error)¶Rückgabe: |
|
---|
Gibt die Baudratenkonfiguration zurück, siehe SetSPITFPBaudrateConfig()
.
Neu in Version 2.0.10 (Firmware).
(*IMUV2Brick)
GetSendTimeoutCount
(communicationMethod uint8) (timeoutCount uint32, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
Neu in Version 2.0.7 (Firmware).
(*IMUV2Brick)
SetSPITFPBaudrate
(brickletPort rune, baudrate uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
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).
(*IMUV2Brick)
GetSPITFPBaudrate
(brickletPort rune) (baudrate uint32, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt die Baudrate für einen Bricklet Port zurück, siehe
SetSPITFPBaudrate()
.
Neu in Version 2.0.5 (Firmware).
(*IMUV2Brick)
GetSPITFPErrorCount
(brickletPort rune) (errorCountACKChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
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).
(*IMUV2Brick)
EnableStatusLED
() (err error)¶Rückgabe: |
|
---|
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.
(*IMUV2Brick)
DisableStatusLED
() (err error)¶Rückgabe: |
|
---|
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.
(*IMUV2Brick)
IsStatusLEDEnabled
() (enabled bool, err error)¶Rückgabe: |
|
---|
Gibt true zurück wenn die Status LED aktiviert ist, false sonst.
(*IMUV2Brick)
GetChipTemperature
() (temperature int16, err error)¶Rückgabe: |
|
---|
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.
(*IMUV2Brick)
Reset
() (err error)¶Rückgabe: |
|
---|
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.
(*IMUV2Brick)
GetIdentity
() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)¶Rückgabe: |
|
---|
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.
(*IMUV2Brick)
SetAccelerationPeriod
(period uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der AccelerationCallback
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
(*IMUV2Brick)
GetAccelerationPeriod
() (period uint32, err error)¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetAccelerationPeriod()
gesetzt.
(*IMUV2Brick)
SetMagneticFieldPeriod
(period uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der MagneticFieldCallback
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
(*IMUV2Brick)
GetMagneticFieldPeriod
() (period uint32, err error)¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetMagneticFieldPeriod()
gesetzt.
(*IMUV2Brick)
SetAngularVelocityPeriod
(period uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der AngularVelocityCallback
Callback
ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.
(*IMUV2Brick)
GetAngularVelocityPeriod
() (period uint32, err error)¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetAngularVelocityPeriod()
gesetzt.
(*IMUV2Brick)
SetTemperaturePeriod
(period uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der TemperatureCallback
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
(*IMUV2Brick)
GetTemperaturePeriod
() (period uint32, err error)¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetTemperaturePeriod()
gesetzt.
(*IMUV2Brick)
SetOrientationPeriod
(period uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der OrientationCallback
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
(*IMUV2Brick)
GetOrientationPeriod
() (period uint32, err error)¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetOrientationPeriod()
gesetzt.
(*IMUV2Brick)
SetLinearAccelerationPeriod
(period uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der LinearAccelerationCallback
Callback
ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.
(*IMUV2Brick)
GetLinearAccelerationPeriod
() (period uint32, err error)¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetLinearAccelerationPeriod()
gesetzt.
(*IMUV2Brick)
SetGravityVectorPeriod
(period uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der GravityVectorCallback
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
(*IMUV2Brick)
GetGravityVectorPeriod
() (period uint32, err error)¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetGravityVectorPeriod()
gesetzt.
(*IMUV2Brick)
SetQuaternionPeriod
(period uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der QuaternionCallback
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
(*IMUV2Brick)
GetQuaternionPeriod
() (period uint32, err error)¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetQuaternionPeriod()
gesetzt.
(*IMUV2Brick)
SetAllDataPeriod
(period uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der AllDataCallback
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
(*IMUV2Brick)
GetAllDataPeriod
() (period uint32, err error)¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetAllDataPeriod()
gesetzt.
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.
(*IMUV2Brick)
RegisterAccelerationCallback
(func(x int16, y int16, z int16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
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.
(*IMUV2Brick)
RegisterMagneticFieldCallback
(func(x int16, y int16, z int16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
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.
(*IMUV2Brick)
RegisterAngularVelocityCallback
(func(x int16, y int16, z int16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
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.
(*IMUV2Brick)
RegisterTemperatureCallback
(func(temperature int8)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetTemperaturePeriod()
, ausgelöst. Der Parameter des Callbacks ist die
Temperatur.
(*IMUV2Brick)
RegisterLinearAccelerationCallback
(func(x int16, y int16, z int16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
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.
(*IMUV2Brick)
RegisterGravityVectorCallback
(func(x int16, y int16, z int16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
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.
(*IMUV2Brick)
RegisterOrientationCallback
(func(heading int16, roll int16, pitch int16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
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.
(*IMUV2Brick)
RegisterQuaternionCallback
(func(w int16, x int16, y int16, z int16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
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.
(*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: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetAllDataPeriod()
, ausgelöst. Die Parameter des Callbacks sind die
gleichen wie bei GetAllData()
.
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.
(*IMUV2Brick)
GetAPIVersion
() (apiVersion [3]uint8, err error)¶Rückgabe: |
|
---|
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.
(*IMUV2Brick)
GetResponseExpected
(functionId uint8) (responseExpected bool, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
(*IMUV2Brick)
SetResponseExpected
(functionId uint8, responseExpected bool) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ä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:
(*IMUV2Brick)
SetResponseExpectedAll
(responseExpected bool) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.
(*IMUV2Brick)
GetProtocol1BrickletName
(port rune) (protocolVersion uint8, firmwareVersion [3]uint8, name string, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
(*IMUV2Brick)
WriteBrickletPlugin
(port rune, offset uint8, chunk [32]uint8) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Schreibt 32 Bytes Firmware auf das Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden an die Position offset * 32 geschrieben.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
(*IMUV2Brick)
ReadBrickletPlugin
(port rune, offset uint8) (chunk [32]uint8, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Liest 32 Bytes Firmware vom Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden ab der Position offset * 32 gelesen.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
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.