Dies ist die Beschreibung der C# API Bindings für das Accelerometer Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Accelerometer Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die C# API Bindings ist Teil deren allgemeine Beschreibung.
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 | using System;
using Tinkerforge;
class Example
{
private static string HOST = "localhost";
private static int PORT = 4223;
private static string UID = "XYZ"; // Change XYZ to the UID of your Accelerometer Bricklet 2.0
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletAccelerometerV2 a =
new BrickletAccelerometerV2(UID, ipcon); // Create device object
ipcon.Connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Get current acceleration
int x, y, z;
a.GetAcceleration(out x, out y, out z);
Console.WriteLine("Acceleration [X]: " + x/10000.0 + " g");
Console.WriteLine("Acceleration [Y]: " + y/10000.0 + " g");
Console.WriteLine("Acceleration [Z]: " + z/10000.0 + " g");
Console.WriteLine("Press enter to exit");
Console.ReadLine();
ipcon.Disconnect();
}
}
|
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 | using System;
using Tinkerforge;
class Example
{
private static string HOST = "localhost";
private static int PORT = 4223;
private static string UID = "XYZ"; // Change XYZ to the UID of your Accelerometer Bricklet 2.0
// Callback function for acceleration callback
static void AccelerationCB(BrickletAccelerometerV2 sender, int x, int y, int z)
{
Console.WriteLine("Acceleration [X]: " + x/10000.0 + " g");
Console.WriteLine("Acceleration [Y]: " + y/10000.0 + " g");
Console.WriteLine("Acceleration [Z]: " + z/10000.0 + " g");
Console.WriteLine("");
}
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletAccelerometerV2 a =
new BrickletAccelerometerV2(UID, ipcon); // Create device object
ipcon.Connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Register acceleration callback to function AccelerationCB
a.AccelerationCallback += AccelerationCB;
// Set period for acceleration callback to 1s (1000ms)
a.SetAccelerationCallbackConfiguration(1000, false);
Console.WriteLine("Press enter to exit");
Console.ReadLine();
ipcon.Disconnect();
}
}
|
Prinzipiell kann jede Funktion der C# Bindings, welche einen Wert zurück gibt
eine Tinkerforge.TimeoutException
werfen. Diese Exception wird
geworfen 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.
Da C# nicht mehrere Rückgabewerte direkt unterstützt, wird das out
Schlüsselwort
genutzt, um mehrere Werte aus einer Funktion zurückzugeben.
Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist
Tinkerforge.*
.
Alle folgend aufgelisteten Methoden sind Thread-sicher.
BrickletAccelerometerV2
(string uid, IPConnection ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
BrickletAccelerometerV2 accelerometerV2 = new BrickletAccelerometerV2("YOUR_DEVICE_UID", ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletAccelerometerV2.
GetAcceleration
(out int x, out int y, out int z)¶Ausgabeparameter: |
|
---|
Gibt die Beschleunigung in X-, Y- und Z-Richtung zurück. Die Werte
haben die Einheit gₙ/10000 (1gₙ = 9,80665m/s²). Der Wertebereich
wird mit SetConfiguration()
konfiguriert.
Wenn die Beschleunigungswerte periodisch abgefragt werden sollen, wird empfohlen
den AccelerationCallback
Callback zu nutzen und die Periode mit
SetAccelerationCallbackConfiguration()
vorzugeben.
BrickletAccelerometerV2.
SetConfiguration
(byte dataRate, byte fullScale)¶Parameter: |
|
---|
Konfiguriert die Datenrate und den Wertebereich. Mögliche Konfigurationswerte sind:
Eine Verringerung der Datenrate oder des Wertebereichs verringert auch automatisch das Rauschen auf den Daten.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für dataRate:
Für fullScale:
BrickletAccelerometerV2.
GetConfiguration
(out byte dataRate, out byte fullScale)¶Ausgabeparameter: |
|
---|
Gibt die Konfiguration zurück, wie von SetConfiguration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für dataRate:
Für fullScale:
BrickletAccelerometerV2.
SetInfoLEDConfig
(byte config)¶Parameter: |
|
---|
Konfiguriert die Info-LED (als "Force" auf dem Bricklet gekennzeichnet). Die LED kann ausgeschaltet, eingeschaltet oder im Herzschlagmodus betrieben werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletAccelerometerV2.
GetInfoLEDConfig
()¶Rückgabe: |
|
---|
Gibt die LED-Konfiguration zurück, wie von SetInfoLEDConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletAccelerometerV2.
SetFilterConfiguration
(byte iirBypass, byte lowPassFilter)¶Parameter: |
|
---|
Konfiguriert den IIR Bypass Filter Modus und die Grenzfrequenz des Tiefpassfilters.
Der Filter kann angewendet oder umgangen werden und die Frequenz kann die halbe oder ein Neuntel der Ausgabe-Datenrate sein.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für iirBypass:
Für lowPassFilter:
Neu in Version 2.0.2 (Plugin).
BrickletAccelerometerV2.
GetFilterConfiguration
(out byte iirBypass, out byte lowPassFilter)¶Ausgabeparameter: |
|
---|
Gibt die Konfiguration zurück, wie von SetFilterConfiguration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für iirBypass:
Für lowPassFilter:
Neu in Version 2.0.2 (Plugin).
BrickletAccelerometerV2.
GetSPITFPErrorCount
(out long errorCountAckChecksum, out long errorCountMessageChecksum, out long errorCountFrame, out long errorCountOverflow)¶Ausgabeparameter: |
|
---|
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 Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.
BrickletAccelerometerV2.
SetStatusLEDConfig
(byte config)¶Parameter: |
|
---|
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:
Für config:
BrickletAccelerometerV2.
GetStatusLEDConfig
()¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von SetStatusLEDConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletAccelerometerV2.
GetChipTemperature
()¶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 hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.
BrickletAccelerometerV2.
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.
BrickletAccelerometerV2.
GetIdentity
(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)¶Ausgabeparameter: |
|
---|
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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.
Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.
BrickletAccelerometerV2.
SetAccelerationCallbackConfiguration
(long period, bool valueHasToChange)¶Parameter: |
|
---|
Die Periode ist die Periode mit der der AccelerationCallback
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.
Wenn dieser Callback aktiviert ist, werden der
ContinuousAcceleration16BitCallback
Callback und
ContinuousAcceleration8BitCallback
Callback automatisch deaktiviert.
BrickletAccelerometerV2.
GetAccelerationCallbackConfiguration
(out long period, out bool valueHasToChange)¶Ausgabeparameter: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels
SetAccelerationCallbackConfiguration()
gesetzt.
BrickletAccelerometerV2.
SetContinuousAccelerationConfiguration
(bool enableX, bool enableY, bool enableZ, byte resolution)¶Parameter: |
|
---|
Um einen hohen Durchsatz an Beschleunigungswerten zu erreichen (> 1000Hz) müssen
die ContinuousAcceleration16BitCallback
oder ContinuousAcceleration8BitCallback
Callbacks genutzt werden.
Die Callbacks können für die Achsen (x, y, z) individuell aktiviert werden. Des weiteren kann eine Auflösung von 8-Bit oder 16-Bit ausgewählt werden.
Wenn mindestens eine Achse aktiviert ist mit 8-Bit Auflösung,
wird der ContinuousAcceleration8BitCallback
-Callback aktiviert.
Wenn mindestens eine Achse aktiviert ist mit 16-Bit Auflösung,
wird der ContinuousAcceleration16BitCallback
-Callback aktiviert.
Die zurückgegebenen Werte sind Rohwerte des AD-Wandlers. Wenn die Daten mit einem FFT genutzt werden sollen um Vorkomnisse from Frequenzen zu bestimmen empfehlen wir die Rohwerte direkt zu nutzen. Die Rohwerte beinhalten das Rauschen des AD-Wandlers, in diesem Rauschen können allerdings Frequenzinformation enthalten sein die für einen FFT relevant seien können.
Andernfalls können die folgenden Formeln benutzt werden um die Daten wieder
in der Einheit gₙ/10000 (gleiche Einheit wie von GetAcceleration()
zurückgegeben)
umzuwandeln. Die Formeln hängen ab von der eingestelleten Auflösung (8/16-Bit) und dem
eingestellten Wertebereich (siehe SetConfiguration()
):
Bei einer Auflösung von 8-Bit werden nur die 8 höchstwertigen Bits übertragen, daher sehen die Formeln wie folgt aus:
Wenn keine Achse aktiviert is, sind beide Callbacks deaktiviert. Wenn einer der
"Continuous Callbacks" genutzt wird, wird der AccelerationCallback
-Callback
automatisch deaktiviert.
Der maximale Durchsatz hängt von der Konfiguration ab:
Anzahl aktiviert Achsen | Durchsatz 8-Bit | Durchsatz 16-Bit |
---|---|---|
1 | 25600Hz | 25600Hz |
2 | 25600Hz | 15000Hz |
3 | 20000Hz | 10000Hz |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für resolution:
BrickletAccelerometerV2.
GetContinuousAccelerationConfiguration
(out bool enableX, out bool enableY, out bool enableZ, out byte resolution)¶Ausgabeparameter: |
|
---|
Gibt die Konfiguration für kontinuierliche Beschleunigungswerte zurück, wie mittels
SetContinuousAccelerationConfiguration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für resolution:
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung geschieht durch Anhängen des Callback Handlers an den passenden Event:
void MyCallback(BrickletAccelerometerV2 sender, int value)
{
System.Console.WriteLine("Value: " + value);
}
accelerometerV2.ExampleCallback += MyCallback;
Die verfügbaren Events 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.
BrickletAccelerometerV2.
AccelerationCallback
(BrickletAccelerometerV2 sender, int x, int y, int z)¶Callback-Parameter: |
|
---|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
SetAccelerationCallbackConfiguration()
gesetzten Konfiguration.
Die Parameter sind die gleichen wie GetAcceleration()
.
BrickletAccelerometerV2.
ContinuousAcceleration16BitCallback
(BrickletAccelerometerV2 sender, short[] acceleration)¶Callback-Parameter: |
|
---|
Gibt 30 Beschleunigungswerte mit 16 bit Auflösung zurück. Die Datenrate
kann mit der Funktion SetConfiguration()
eingestellt werden und
der Callback kann per SetContinuousAccelerationConfiguration()
aktiviert werden.
Die zurückgegebenen Werte sind Rohwerte des AD-Wandlers. Wenn die Daten mit einem FFT genutzt werden sollen um Vorkomnisse from Frequenzen zu bestimmen empfehlen wir die Rohwerte direkt zu nutzen. Die Rohwerte beinhalten das Rauschen des AD-Wandlers, in diesem Rauschen können allerdings Frequenzinformation enthalten sein die für einen FFT relevant seien können.
Andernfalls können die folgenden Formeln benutzt werden um die Daten wieder
in der Einheit gₙ/10000 (gleiche Einheit wie von GetAcceleration()
zurückgegeben)
umzuwandeln. Die Formeln hängen ab von dem
eingestellten Wertebereich (siehe SetConfiguration()
):
Die Daten sind in der Sequenz "x, y, z, x, y, z, ..." formatiert, abhängig von den aktivierten Achsen. Beispiele:
BrickletAccelerometerV2.
ContinuousAcceleration8BitCallback
(BrickletAccelerometerV2 sender, short[] acceleration)¶Callback-Parameter: |
|
---|
Gibt 60 Beschleunigungswerte mit 8 bit Auflösung zurück. Die Datenrate
kann mit der Funktion SetConfiguration()
eingestellt werden und
der Callback kann per SetContinuousAccelerationConfiguration()
aktiviert werden.
Die zurückgegebenen Werte sind Rohwerte des AD-Wandlers. Wenn die Daten mit einem FFT genutzt werden sollen um Vorkomnisse from Frequenzen zu bestimmen empfehlen wir die Rohwerte direkt zu nutzen. Die Rohwerte beinhalten das Rauschen des AD-Wandlers, in diesem Rauschen können allerdings Frequenzinformation enthalten sein die für einen FFT relevant seien können.
Andernfalls können die folgenden Formeln benutzt werden um die Daten wieder
in der Einheit gₙ/10000 (gleiche Einheit wie von GetAcceleration()
zurückgegeben)
umzuwandeln. Die Formeln hängen ab von dem
eingestellten Wertebereich (siehe SetConfiguration()
):
Die Daten sind in der Sequenz "x, y, z, x, y, z, ..." formatiert, abhängig von den aktivierten Achsen. Beispiele:
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.
BrickletAccelerometerV2.
GetAPIVersion
()¶Ausgabeparameter: |
|
---|
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.
BrickletAccelerometerV2.
GetResponseExpected
(byte functionId)¶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:
BrickletAccelerometerV2.
SetResponseExpected
(byte functionId, bool responseExpected)¶Parameter: |
|
---|
Ä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:
BrickletAccelerometerV2.
SetResponseExpectedAll
(bool responseExpected)¶Parameter: |
|
---|
Ä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.
BrickletAccelerometerV2.
SetBootloaderMode
(byte mode)¶Parameter: |
|
---|---|
Rückgabe: |
|
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 Bootloader- 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:
Für mode:
Für status:
BrickletAccelerometerV2.
GetBootloaderMode
()¶Rückgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode()
.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletAccelerometerV2.
SetWriteFirmwarePointer
(long pointer)¶Parameter: |
|
---|
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.
BrickletAccelerometerV2.
WriteFirmware
(byte[] data)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
BrickletAccelerometerV2.
WriteUID
(long uid)¶Parameter: |
|
---|
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.
BrickletAccelerometerV2.
ReadUID
()¶Rückgabe: |
|
---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.
BrickletAccelerometerV2.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Accelerometer Bricklet 2.0 zu identifizieren.
Die GetIdentity()
Funktion und der
IPConnection.EnumerateCallback
Callback der IP Connection haben ein deviceIdentifier
Parameter um den Typ
des Bricks oder Bricklets anzugeben.
BrickletAccelerometerV2.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Accelerometer Bricklet 2.0 dar.