Dies ist die Beschreibung der C# API Bindings für das Accelerometer Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Accelerometer Bricklet 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 | 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
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletAccelerometer a = new BrickletAccelerometer(UID, ipcon); // Create device object
ipcon.Connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Get current acceleration
short x, y, z;
a.GetAcceleration(out x, out y, out z);
Console.WriteLine("Acceleration [X]: " + x/1000.0 + " g");
Console.WriteLine("Acceleration [Y]: " + y/1000.0 + " g");
Console.WriteLine("Acceleration [Z]: " + z/1000.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 39 | 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
// Callback function for acceleration callback
static void AccelerationCB(BrickletAccelerometer sender, short x, short y, short z)
{
Console.WriteLine("Acceleration [X]: " + x/1000.0 + " g");
Console.WriteLine("Acceleration [Y]: " + y/1000.0 + " g");
Console.WriteLine("Acceleration [Z]: " + z/1000.0 + " g");
Console.WriteLine("");
}
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletAccelerometer a = new BrickletAccelerometer(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)
// Note: The acceleration callback is only called every second
// if the acceleration has changed since the last call!
a.SetAccelerationCallbackPeriod(1000);
Console.WriteLine("Press enter to exit");
Console.ReadLine();
ipcon.Disconnect();
}
}
|
Download (ExampleThreshold.cs)
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 | 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
// Callback function for acceleration reached callback
static void AccelerationReachedCB(BrickletAccelerometer sender, short x, short y,
short z)
{
Console.WriteLine("Acceleration [X]: " + x/1000.0 + " g");
Console.WriteLine("Acceleration [Y]: " + y/1000.0 + " g");
Console.WriteLine("Acceleration [Z]: " + z/1000.0 + " g");
Console.WriteLine("");
}
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletAccelerometer a = new BrickletAccelerometer(UID, ipcon); // Create device object
ipcon.Connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Get threshold callbacks with a debounce time of 10 seconds (10000ms)
a.SetDebouncePeriod(10000);
// Register acceleration reached callback to function AccelerationReachedCB
a.AccelerationReachedCallback += AccelerationReachedCB;
// Configure threshold for acceleration "greater than 2 g, 2 g, 2 g"
a.SetAccelerationCallbackThreshold('>', 2*1000, 0, 2*1000, 0, 2*1000, 0);
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.
BrickletAccelerometer
(string uid, IPConnection ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
BrickletAccelerometer accelerometer = new BrickletAccelerometer("YOUR_DEVICE_UID", ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletAccelerometer.
GetAcceleration
(out short x, out short y, out short z)¶Ausgabeparameter: |
|
---|
Gibt die Beschleunigung in X-, Y- und Z-Richtung zurück. Die Werte
haben die Einheit gₙ/1000 (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
SetAccelerationCallbackPeriod()
vorzugeben.
BrickletAccelerometer.
GetTemperature
()¶Rückgabe: |
|
---|
Gibt die Temperatur des Beschleunigungssensors zurück.
BrickletAccelerometer.
LEDOn
()¶Aktiviert die LED auf dem Bricklet.
BrickletAccelerometer.
LEDOff
()¶Deaktiviert die LED auf dem Bricklet.
BrickletAccelerometer.
IsLEDOn
()¶Rückgabe: |
|
---|
Gibt true zurück wenn die LED aktiviert ist, false sonst.
BrickletAccelerometer.
SetConfiguration
(byte dataRate, byte fullScale, byte filterBandwidth)¶Parameter: |
|
---|
Konfiguriert die Datenrate, den Wertebereich und die Filterbandbreite. 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:
Für filterBandwidth:
BrickletAccelerometer.
GetConfiguration
(out byte dataRate, out byte fullScale, out byte filterBandwidth)¶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:
Für filterBandwidth:
BrickletAccelerometer.
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.
BrickletAccelerometer.
SetAccelerationCallbackPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der AccelerationCallback
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
Der AccelerationCallback
Callback wird nur ausgelöst, wenn sich die Acceleration
seit der letzten Auslösung geändert hat.
BrickletAccelerometer.
GetAccelerationCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetAccelerationCallbackPeriod()
gesetzt.
BrickletAccelerometer.
SetAccelerationCallbackThreshold
(char option, short minX, short maxX, short minY, short maxY, short minZ, short maxZ)¶Parameter: |
|
---|
Setzt den Schwellwert für den AccelerationReachedCallback
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn die Beschleunigung außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn die Beschleunigung innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn die Beschleunigung kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Beschleunigung größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletAccelerometer.
GetAccelerationCallbackThreshold
(out char option, out short minX, out short maxX, out short minY, out short maxY, out short minZ, out short maxZ)¶Ausgabeparameter: |
|
---|
Gibt den Schwellwert zurück, wie von SetAccelerationCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletAccelerometer.
SetDebouncePeriod
(long debounce)¶Parameter: |
|
---|
Setzt die Periode mit welcher die Schwellwert Callback
ausgelöst wird, wenn der Schwellwert
weiterhin erreicht bleibt.
BrickletAccelerometer.
GetDebouncePeriod
()¶Rückgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von SetDebouncePeriod()
gesetzt.
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(BrickletAccelerometer sender, int value)
{
System.Console.WriteLine("Value: " + value);
}
accelerometer.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.
BrickletAccelerometer.
AccelerationCallback
(BrickletAccelerometer sender, short x, short y, short z)¶Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetAccelerationCallbackPeriod()
, ausgelöst. Die Parameter
sind die Beschleunigungen der X-, Y- und Z-Achse. Der Wertebereich
wird mit SetConfiguration()
konfiguriert.
Der AccelerationCallback
Callback wird nur ausgelöst, wenn sich die Beschleunigung
seit der letzten Auslösung geändert hat.
BrickletAccelerometer.
AccelerationReachedCallback
(BrickletAccelerometer sender, short x, short y, short z)¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
SetAccelerationCallbackThreshold()
gesetzt, erreicht wird.
Die Parameter sind die Beschleunigungen der X-, Y- und Z-Achse. Der Wertebereich
wird mit SetConfiguration()
konfiguriert.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit SetDebouncePeriod()
gesetzt, ausgelöst.
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.
BrickletAccelerometer.
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.
BrickletAccelerometer.
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:
BrickletAccelerometer.
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:
BrickletAccelerometer.
SetResponseExpectedAll
(bool responseExpected)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
BrickletAccelerometer.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Accelerometer 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.
BrickletAccelerometer.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Accelerometer Bricklet dar.