LabVIEW - Compass Bricklet

Dies ist die Beschreibung der LabVIEW API Bindings für das Compass Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Compass Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die LabVIEW API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

API

Prinzipiell kann jede Funktion der LabVIEW Bindings, welche einen Wert ausgibt eine Tinkerforge.TimeoutException melden. Dieser Fehler wird gemeldet wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist Tinkerforge.*.

Grundfunktionen

BrickletCompass(uid, ipcon) → compass
Eingabe:
  • uid -- String
  • ipcon -- .NET Refnum (IPConnection)
Ausgabe:
  • compass -- .NET Refnum (BrickletCompass)

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid. Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

BrickletCompass.GetHeading() → heading
Ausgabe:
  • heading -- Int16

Gibt die Richtung in 1/10 Grad zurück (Norden = 0 Grad, Osten = 90 Grad).

Alternativ kann die Funktion GetMagneticFluxDensity() genutzt werden um die Richtung per heading = atan2(y, x) * 180 / PI zu bestimmen.

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

BrickletCompass.GetMagneticFluxDensity() → x, y, z
Ausgabe:
  • x -- Int32
  • y -- Int32
  • z -- Int32

Gibt die magnetische Flussdichte (magnetische Induktion) für alle drei Achsen in 1/10 mG (Milligauß) zurück.

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

BrickletCompass.SetConfiguration(dataRate, backgroundCalibration)
Eingabe:
  • dataRate -- Byte
  • backgroundCalibration -- Boolean

Konfiguriert die Datenrate und Hintergrundkalibrierung:

  • Data Rate: Setzt die Datenrate des eingesetzten Magnetometers. Je niedriger die Datenrate ist, desto weniger Rauschen befindet sich auf den Daten.
  • Background Calibration: Aktiviert die automatische Hintergrundkalibrierung, wenn auf true gesetzt. Wenn die Hintergrundkalibrierung aktiviert ist, ändert das Bricklet einmal pro Sekunde die Erfassungspolarität, um damit automatisch temperaturabhängige Offsets zu entfernen. Das Ändern der Polarität dauert ungefähr 20ms. Daher werden einmal pro Sekunde für 20ms keine neuen Daten generiert, wenn die Kalibrierung aktiviert ist. Wir empfehlen die Kalibrierung nur zu deaktivieren, falls diese 20ms Auszeit ein großes Problem in der Anwendung des Bricklets darstellen.

Standardwerte: Datenrate 100Hz und Hintergrundkalibrierung aktiviert.

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

  • BrickletCompass.DATA_RATE_100HZ = 0
  • BrickletCompass.DATA_RATE_200HZ = 1
  • BrickletCompass.DATA_RATE_400HZ = 2
  • BrickletCompass.DATA_RATE_600HZ = 3
BrickletCompass.GetConfiguration() → dataRate, backgroundCalibration
Ausgabe:
  • dataRate -- Byte
  • backgroundCalibration -- Boolean

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

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

  • BrickletCompass.DATA_RATE_100HZ = 0
  • BrickletCompass.DATA_RATE_200HZ = 1
  • BrickletCompass.DATA_RATE_400HZ = 2
  • BrickletCompass.DATA_RATE_600HZ = 3

Fortgeschrittene Funktionen

BrickletCompass.SetCalibration(offset, gain)
Eingabe:
  • offset -- Int16[3]
  • gain -- Int16[3]

Setzt Offset und Gain für alle drei Achsen.

Das Bricklet ist ab Werk kalibriert. Wenn eine Rekalibrierung durchgeführt werden soll, empfehlen wir dafür den Brick Viewer zu nutzen.

Die Kalibrierung wird in nicht-flüchtigem Speicher gespeichert und muss nur einmal durchgeführt werden.

BrickletCompass.GetCalibration() → offset, gain
Ausgabe:
  • offset -- Int16[3]
  • gain -- Int16[3]

Gibt die Kalibrierungsparameter zurück, wie von SetCalibration() gesetzt.

BrickletCompass.GetAPIVersion() → apiVersion
Ausgabe:
  • apiVersion -- Byte[3]

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.

BrickletCompass.GetResponseExpected(functionId) → responseExpected
Eingabe:
  • functionId -- Byte
Ausgabe:
  • responseExpected -- 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:

  • BrickletCompass.FUNCTION_SET_HEADING_CALLBACK_CONFIGURATION = 2
  • BrickletCompass.FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION = 6
  • BrickletCompass.FUNCTION_SET_CONFIGURATION = 9
  • BrickletCompass.FUNCTION_SET_CALIBRATION = 11
  • BrickletCompass.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletCompass.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletCompass.FUNCTION_RESET = 243
  • BrickletCompass.FUNCTION_WRITE_UID = 248
BrickletCompass.SetResponseExpected(functionId, responseExpected)
Eingabe:
  • functionId -- Byte
  • responseExpected -- 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:

  • BrickletCompass.FUNCTION_SET_HEADING_CALLBACK_CONFIGURATION = 2
  • BrickletCompass.FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION = 6
  • BrickletCompass.FUNCTION_SET_CONFIGURATION = 9
  • BrickletCompass.FUNCTION_SET_CALIBRATION = 11
  • BrickletCompass.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletCompass.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletCompass.FUNCTION_RESET = 243
  • BrickletCompass.FUNCTION_WRITE_UID = 248
BrickletCompass.SetResponseExpectedAll(responseExpected)
Eingabe:
  • responseExpected -- Boolean

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

BrickletCompass.GetSPITFPErrorCount() → errorCountAckChecksum, errorCountMessageChecksum, errorCountFrame, errorCountOverflow
Ausgabe:
  • errorCountAckChecksum -- Int64
  • errorCountMessageChecksum -- Int64
  • errorCountFrame -- Int64
  • errorCountOverflow -- Int64

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

BrickletCompass.SetBootloaderMode(mode) → status
Eingabe:
  • mode -- Byte
Ausgabe:
  • status -- Byte

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootlodaer- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

  • BrickletCompass.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletCompass.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletCompass.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletCompass.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletCompass.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletCompass.BOOTLOADER_STATUS_OK = 0
  • BrickletCompass.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletCompass.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletCompass.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletCompass.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletCompass.BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletCompass.GetBootloaderMode() → mode
Ausgabe:
  • mode -- Byte

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode().

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

  • BrickletCompass.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletCompass.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletCompass.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletCompass.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletCompass.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletCompass.SetWriteFirmwarePointer(pointer)
Eingabe:
  • pointer -- Int64

Setzt den Firmware-Pointer für WriteFirmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletCompass.WriteFirmware(data) → status
Eingabe:
  • data -- Byte[64]
Ausgabe:
  • status -- Byte

Schreibt 64 Bytes Firmware an die Position die vorher von SetWriteFirmwarePointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletCompass.SetStatusLEDConfig(config)
Eingabe:
  • config -- Byte

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

  • BrickletCompass.STATUS_LED_CONFIG_OFF = 0
  • BrickletCompass.STATUS_LED_CONFIG_ON = 1
  • BrickletCompass.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletCompass.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletCompass.GetStatusLEDConfig() → config
Ausgabe:
  • config -- Byte

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

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

  • BrickletCompass.STATUS_LED_CONFIG_OFF = 0
  • BrickletCompass.STATUS_LED_CONFIG_ON = 1
  • BrickletCompass.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletCompass.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletCompass.GetChipTemperature() → temperature
Ausgabe:
  • temperature -- Int16

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

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

BrickletCompass.Reset()

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

BrickletCompass.WriteUID(uid)
Eingabe:
  • uid -- Int64

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

BrickletCompass.ReadUID() → uid
Ausgabe:
  • uid -- Int64

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

BrickletCompass.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier
Ausgabe:
  • uid -- String
  • connectedUid -- String
  • position -- Char
  • hardwareVersion -- Byte[3]
  • firmwareVersion -- Byte[3]
  • deviceIdentifier -- Int32

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position kann 'a', 'b', 'c' oder 'd' sein.

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

Konfigurationsfunktionen für Callbacks

BrickletCompass.SetHeadingCallbackConfiguration(period, valueHasToChange, option, min, max)
Eingabe:
  • period -- Int64
  • valueHasToChange -- Boolean
  • option -- Char
  • min -- Int16
  • max -- Int16

Die Periode in ms ist die Periode mit der der HeadingCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter`zusammen mit min/max setzt einen Threshold für den HeadingCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, 'x', 0, 0).

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

  • BrickletCompass.THRESHOLD_OPTION_OFF = 'x'
  • BrickletCompass.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletCompass.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletCompass.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletCompass.THRESHOLD_OPTION_GREATER = '>'
BrickletCompass.GetHeadingCallbackConfiguration() → period, valueHasToChange, option, min, max
Ausgabe:
  • period -- Int64
  • valueHasToChange -- Boolean
  • option -- Char
  • min -- Int16
  • max -- Int16

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

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

  • BrickletCompass.THRESHOLD_OPTION_OFF = 'x'
  • BrickletCompass.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletCompass.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletCompass.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletCompass.THRESHOLD_OPTION_GREATER = '>'
BrickletCompass.SetMagneticFluxDensityCallbackConfiguration(period, valueHasToChange)
Eingabe:
  • period -- Int64
  • valueHasToChange -- Boolean

Die Periode in ms ist die Periode mit der der MagneticFluxDensityCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Der Standardwert ist (0, false).

BrickletCompass.GetMagneticFluxDensityCallbackConfiguration() → period, valueHasToChange
Ausgabe:
  • period -- Int64
  • valueHasToChange -- Boolean

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

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Funktion einem Callback Property des Geräte Objektes zugewiesen wird. 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 BrickletCompass.HeadingCallback(sender, heading)
Eingabe:
  • sender -- .NET Refnum (BrickletCompass)
  • heading -- Int16

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

Der Parameter ist der gleiche wie GetHeading().

event BrickletCompass.MagneticFluxDensityCallback(sender, x, y, z)
Eingabe:
  • sender -- .NET Refnum (BrickletCompass)
  • x -- Int32
  • y -- Int32
  • z -- Int32

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

Die Parameter sind der gleichen wie GetMagneticFluxDensity().

Konstanten

BrickletCompass.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Compass Bricklet 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.

BrickletCompass.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Compass Bricklet dar.