C# - Hall Effect Bricklet

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

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.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
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 Hall Effect Bricklet

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletHallEffect he = new BrickletHallEffect(UID, ipcon); // Create device object

        ipcon.Connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Get current edge count without reset
        long count = he.GetEdgeCount(false);
        Console.WriteLine("Count: " + count);

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Callback

Download (ExampleCallback.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
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 Hall Effect Bricklet

    // Callback function for edge count callback
    static void EdgeCountCB(BrickletHallEffect sender, long count, bool value)
    {
        Console.WriteLine("Count: " + count);
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletHallEffect he = new BrickletHallEffect(UID, ipcon); // Create device object

        ipcon.Connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Register edge count callback to function EdgeCountCB
        he.EdgeCountCallback += EdgeCountCB;

        // Set period for edge count callback to 0.05s (50ms)
        // Note: The edge count callback is only called every 0.05 seconds
        //       if the edge count has changed since the last call!
        he.SetEdgeCountCallbackPeriod(50);

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

API

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.

Grundfunktionen

class BrickletHallEffect(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • hallEffect – Typ: BrickletHallEffect

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

BrickletHallEffect hallEffect = new BrickletHallEffect("YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

bool BrickletHallEffect.GetValue()
Rückgabe:
  • value – Typ: bool

Gibt true zurück wenn ein Magnetfeld mit 35 Gauss (3,5mT) oder größer detektiert wird.

long BrickletHallEffect.GetEdgeCount(bool resetCounter)
Parameter:
  • resetCounter – Typ: bool
Rückgabe:
  • count – Typ: long, Wertebereich: [0 bis 232 - 1]

Gibt den aktuellen Wert des Flankenzählers zurück. Die zu zählenden Flanken (steigend, fallend, beide) können mit SetEdgeCountConfig() konfiguriert werden.

Wenn reset counter auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurückgesetzt.

Fortgeschrittene Funktionen

void BrickletHallEffect.SetEdgeCountConfig(byte edgeType, byte debounce)
Parameter:
  • edgeType – Typ: byte, Wertebereich: Siehe Konstanten
  • debounce – Typ: byte, Wertebereich: [0 bis 255]

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden. Mögliche Flankentypen sind:

  • 0 = steigend (Standard)
  • 1 = fallend
  • 2 = beide

Wird ein Magnet in die Nähe des Bricklets gebracht (>35 Gauss) erzeugt dies ein low-Signal (fallende Flanke), wenn ein Magnet vom Bricklet entfernt (<25 Gauss) wird entsteht ein high-Signal (steigende Flanke).

Die Entprellzeit (debounce) wird in ms angegeben.

Durch das Konfigurieren wird der Wert des Flankenzählers auf 0 zurückgesetzt.

Falls unklar ist was dies alles bedeutet, kann diese Funktion einfach ignoriert werden. Die Standardwerte sind in fast allen Situationen OK.

Standardwerte: 0 (edge type) und 100ms (debounce).

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

Für edgeType:

  • BrickletHallEffect.EDGE_TYPE_RISING = 0
  • BrickletHallEffect.EDGE_TYPE_FALLING = 1
  • BrickletHallEffect.EDGE_TYPE_BOTH = 2
void BrickletHallEffect.GetEdgeCountConfig(out byte edgeType, out byte debounce)
Ausgabeparameter:
  • edgeType – Typ: byte, Wertebereich: Siehe Konstanten
  • debounce – Typ: byte, Wertebereich: [0 bis 255]

Gibt den Flankentyp sowie die Entprellzeit zurück, wie von SetEdgeCountConfig() gesetzt.

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

Für edgeType:

  • BrickletHallEffect.EDGE_TYPE_RISING = 0
  • BrickletHallEffect.EDGE_TYPE_FALLING = 1
  • BrickletHallEffect.EDGE_TYPE_BOTH = 2
byte[] BrickletHallEffect.GetAPIVersion()
Rückgabe:
  • apiVersion – Typ: byte[], Länge: 3, Wertebereich: [0 bis 255]

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.

bool BrickletHallEffect.GetResponseExpected(byte functionId)
Parameter:
  • functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: bool

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:

  • BrickletHallEffect.FUNCTION_SET_EDGE_COUNT_CONFIG = 3
  • BrickletHallEffect.FUNCTION_SET_EDGE_INTERRUPT = 5
  • BrickletHallEffect.FUNCTION_SET_EDGE_COUNT_CALLBACK_PERIOD = 7
void BrickletHallEffect.SetResponseExpected(byte functionId, bool responseExpected)
Parameter:
  • functionId – Typ: byte, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: bool

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

  • BrickletHallEffect.FUNCTION_SET_EDGE_COUNT_CONFIG = 3
  • BrickletHallEffect.FUNCTION_SET_EDGE_INTERRUPT = 5
  • BrickletHallEffect.FUNCTION_SET_EDGE_COUNT_CALLBACK_PERIOD = 7
void BrickletHallEffect.SetResponseExpectedAll(bool responseExpected)
Parameter:
  • responseExpected – Typ: bool

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

void BrickletHallEffect.GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)
Ausgabeparameter:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: char
  • hardwareVersion – Typ: byte[], Länge: 3, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: byte[], Länge: 3, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: int, Wertebereich: [0 bis 216 - 1]

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

void BrickletHallEffect.SetEdgeInterrupt(long edges)
Parameter:
  • edges – Typ: long, Wertebereich: [0 bis 232 - 1]

Setzt die Anzahl der zu zählenden Flanken bis ein Interrupt aufgerufen wird.

Wenn edges auf n gesetzt ist, wird der Interrupt nach jeder n-ten detektierten Flanke aufgerufen.

Wenn edges auf 0 gesetzt ist, wird der Interrupt deaktiviert.

Standardwert ist 0.

long BrickletHallEffect.GetEdgeInterrupt()
Rückgabe:
  • edges – Typ: long, Wertebereich: [0 bis 232 - 1]

Gibt edges zurück, wie von SetEdgeInterrupt() gesetzt.

void BrickletHallEffect.SetEdgeCountCallbackPeriod(long period)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

Der EdgeCountCallback Callback wird nur ausgelöst, wenn sich die Flankenzählung seit der letzten Auslösung geändert hat.

long BrickletHallEffect.GetEdgeCountCallbackPeriod()
Rückgabe:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

Callbacks

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(BrickletHallEffect sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

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

event BrickletHallEffect.EdgeCountCallback(BrickletHallEffect sender, long count, bool value)
Callback-Parameter:
  • sender – Typ: BrickletHallEffect
  • count – Typ: long, Wertebereich: [0 bis 232 - 1]
  • value – Typ: bool

Dieser Callback wird mit der Periode, wie gesetzt mit SetEdgeCountCallbackPeriod(), ausgelöst. Die Parameter sind der aktuelle Zählerstand und der aktuelle Wert (siehe GetValue() and GetEdgeCount()).

Der EdgeCountCallback Callback wird nur ausgelöst, wenn sich mindestens einer der beiden Werte seit der letzten Auslösung geändert hat.

Konstanten

int BrickletHallEffect.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Hall Effect 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.

string BrickletHallEffect.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Hall Effect Bricklet dar.