C# - IP Connection

Dies ist die Beschreibung der C# API Bindings für die IP Connection. Die IP Connection kümmert sich um die Kommunikation zwischen einem Brick Daemon oder einer WIFI/Ethernet Extension. Bevor Bricks und Bricklets über deren API angesprochen werden können muss eine IP Connection erzeugt und die TCP/IP Verbindung hergestellt werden.

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Enumerate

Download (ExampleEnumerate.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
42
43
44
45
46
47
48
49
50
51
using Tinkerforge;

class ExampleEnumerate
{
    private static string HOST = "localhost";
    private static int PORT = 4223;

    // Print incoming enumeration
    static void EnumerateCB(IPConnection sender,
                            string uid, string connectedUid, char position,
                            short[] hardwareVersion, short[] firmwareVersion,
                            int deviceIdentifier, short enumerationType)
    {
        System.Console.WriteLine("UID:               " + uid);
        System.Console.WriteLine("Enumeration Type:  " + enumerationType);

        if(enumerationType == IPConnection.ENUMERATION_TYPE_DISCONNECTED)
        {
            System.Console.WriteLine("");
            return;
        }

        System.Console.WriteLine("Connected UID:     " + connectedUid);
        System.Console.WriteLine("Position:          " + position);
        System.Console.WriteLine("Hardware Version:  " + hardwareVersion[0] + "." +
                                                         hardwareVersion[1] + "." +
                                                         hardwareVersion[2]);
        System.Console.WriteLine("Firmware Version:  " + firmwareVersion[0] + "." +
                                                         firmwareVersion[1] + "." +
                                                         firmwareVersion[2]);
        System.Console.WriteLine("Device Identifier: " + deviceIdentifier);
        System.Console.WriteLine("");
    }

    static void Main()
    {
        // Create connection and connect to brickd
        IPConnection ipcon = new IPConnection();
        ipcon.Connect(HOST, PORT);

        // Register Enumerate Callback
        ipcon.EnumerateCallback += EnumerateCB;

        // Trigger Enumerate
        ipcon.Enumerate();

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

Authenticate

Download (ExampleAuthenticate.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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
using Tinkerforge;

class ExampleAuthenticate
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string SECRET = "My Authentication Secret!";

    // Authenticate each time the connection got (re-)established
    static void ConnectedCB(IPConnection sender, short connectReason)
    {
        switch(connectReason)
        {
            case IPConnection.CONNECT_REASON_REQUEST:
                System.Console.WriteLine("Connected by request");
                break;

            case IPConnection.CONNECT_REASON_AUTO_RECONNECT:
                System.Console.WriteLine("Auto-Reconnected");
                break;
        }

        // Authenticate first...
        try
        {
            sender.Authenticate(SECRET);
            System.Console.WriteLine("Authentication succeeded");
        }
        catch(TinkerforgeException)
        {
            System.Console.WriteLine("Could not authenticate");
            return;
        }

        // ...reenable auto reconnect mechanism, as described below...
        sender.SetAutoReconnect(true);

        // ...then trigger enumerate
        sender.Enumerate();
    }

    // Print incoming enumeration
    static void EnumerateCB(IPConnection sender,
                            string uid, string connectedUid, char position,
                            short[] hardwareVersion, short[] firmwareVersion,
                            int deviceIdentifier, short enumerationType)
    {
        System.Console.WriteLine("UID: " + uid + ", Enumeration Type: " + enumerationType);
    }

    static void Main()
    {
        // Create IP Connection
        IPConnection ipcon = new IPConnection();

        // Disable auto reconnect mechanism, in case we have the wrong secret.
        // If the authentication is successful, reenable it.
        ipcon.SetAutoReconnect(false);

        // Register Connected Callback
        ipcon.Connected += ConnectedCB;

        // Register Enumerate Callback
        ipcon.EnumerateCallback += EnumerateCB;

        // Connect to brickd
        ipcon.Connect(HOST, PORT);

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

API

Der Namensraum für IPConnection ist Tinkerforge.*.

Grundfunktionen

public class IPConnection()

Erzeugt ein IP Connection Objekt das verwendet werden kann um die verfügbar Geräte zu enumerieren. Es wird auch für den Konstruktor von Bricks und Bricklets benötigt.

public void Connect(String host, int port)

Erstellt eine TCP/IP Verbindung zum gegebenen host und port. Host und Port können auf einen Brick Daemon oder eine WIFI/Ethernet Extension verweisen.

Bricks/Bricklets können erst gesteuert werden, wenn die Verbindung erfolgreich aufgebaut wurde.

Blockiert bis die Verbindung aufgebaut wurde und wirft eine Exception, falls kein Brick Daemon oder WIFI/Ethernet Extension auf dem gegebenen Host und Port horcht.

public void Disconnect()

Trennt die TCP/IP Verbindung zum Brick Daemon oder einer WIFI/Ethernet Extension.

public void Authenticate(string secret)

Führt einen Authentifizierungs-Handshake mit dem verbundenen Brick Daemon oder WIFI/Ethernet Extension durch. Ist der Handshake erfolgreich dann wechselt die Verbindung vom nicht-authentifizierten in den authentifizierten Zustand und die Kommunikation kann normal weitergeführt werden. Schlägt der Handshake fehl wird die Verbindung durch die Gegenseite geschlossen. Die Authentifizierung kann fehlschlagen wenn das Authentifizierungsgeheimnis nicht übereinstimmt oder Authentifizierung für den Brick Daemon oder die WIFI/Ethernet Extension nicht aktiviert ist.

Für mehr Informationen zur Authentifizierung siehe das dazugehörige Tutorial.

Neu in Version 2.1.0.

public short GetConnectionState()

Kann die folgenden Zustände zurückgeben:

  • IPConnection.CONNECTION_STATE_DISCONNECTED (0): Keine Verbindung aufgebaut.
  • IPConnection.CONNECTION_STATE_CONNECTED (1): Eine Verbindung zum Brick Daemon oder der WIFI/Ethernet Extension ist aufgebaut.
  • IPConnection.CONNECTION_STATE_PENDING (2): IP Connection versucht im Moment eine Verbindung aufzubauen.
public void SetAutoReconnect(bool autoReconnect)

Aktiviert oder deaktiviert Auto-Reconnect. Falls Auto-Reconnect aktiviert ist, versucht die IP Connection eine Verbindung zum vorher angegebenen Host und Port wieder herzustellen, falls die aktuell bestehende Verbindung verloren geht. Auto-Reconnect greift also erst nach einem erfolgreichen Aufruf von Connect().

Standardwert ist true.

public bool GetAutoReconnect()

Gibt true zurück wenn Auto-Reconnect aktiviert ist und false sonst.

public void SetTimeout(int timeout)

Setzt den Timeout in Millisekunden für Getter und für Setter die das Response-Expected-Flag aktiviert haben.

Standardwert ist 2500.

public int GetTimeout()

Gibt den Timeout zurück, wie er von SetTimeout() gesetzt wurde.

public void Enumerate()

Broadcast einer Enumerierungsanfrage. Alle Bricks und Bricklets werden mit einem Enumerate Callback antworten.

public void Wait()

Hält den aktuellen Thread an bis Unwait() aufgerufen wird.

Dies ist nützlich falls ausschließlich auf Callbacks reagiert werden soll oder wenn auf einen spezifischen Callback gewartet werden soll oder wenn die IP Connection in einem Thread gestartet wird.

Wait und Unwait agieren auf die gleiche Weise wie Acquire und Release einer Semaphore.

public void Unwait()

Startet einen Thread der vorher mit Wait() angehalten wurde wieder.

Wait und Unwait agieren auf die gleiche Weise wie Acquire und Release einer Semaphore.

Callbacks

Callbacks können registriert werden um über Ereignisse informiert zu werden. Die Registrierung geschieht durch Anhängen des Callback Handlers an den passenden Event:

void MyCallback(IPConnection sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

ipcon.ExampleCallback += MyCallback;

Die verfügbaren Events werden im Folgenden beschrieben.

public event EnumerateCallback(IPConnection sender, string uid, string connectedUid, char position, short[] hardwareVersion, short[] firmwareVersion, int deviceIdentifier, short enumerationType)

Der Event empfängt sieben Parameter:

  • uid: Die UID des Bricks/Bricklets.
  • connectedUid: Die UID des Bricks mit dem das Brick/Bricklet verbunden ist. Für ein Bricklet ist dies die UID des Bricks mit dem es verbunden ist. Für einen Brick ist es die UID des untersten Master Bricks in einem Stapel. Der unterste Master Brick hat die Connected-UID "0". Mit diesen Informationen sollte es möglich sein die komplette Netzwerktopologie zu rekonstruieren.
  • position: Für Bricks: '0' - '8' (Position in Stapel). Für Bricklets: 'a' - 'h' (Position an Brick) oder 'i' (Position des Raspberry Pi (Zero) HAT) oder 'z' (Bricklet an Isolator Bricklet).
  • hardwareVersion: Major, Minor und Release Nummer der Hardwareversion.
  • firmwareVersion: Major, Minor und Release Nummer der Firmwareversion.
  • deviceIdentifier: Eine Zahl, welche den Brick/Bricklet repräsentiert.
  • enumerationType: Art der Enumerierung.

Mögliche Enumerierungsarten sind:

  • IPConnection.ENUMERATION_TYPE_AVAILABLE (0): Gerät ist verfügbar (Enumerierung vom Benutzer ausgelöst: Enumerate()). Diese Enumerierungsart kann mehrfach für das selbe Gerät auftreten.
  • IPConnection.ENUMERATION_TYPE_CONNECTED (1): Gerät wurde neu verbunden (Automatisch vom Brick gesendet nachdem die Kommunikation aufgebaut wurde). Dies kann bedeuten, dass das Gerät die vorher eingestellte Konfiguration verloren hat und neu konfiguriert werden muss.
  • IPConnection.ENUMERATION_TYPE_DISCONNECTED (2): Gerät wurde getrennt (Nur bei USB-Verbindungen möglich). In diesem Fall haben nur uid und enumerationType einen gültigen Wert.

Es sollte möglich sein Plug-and-Play-Funktionalität mit diesem Event zu implementieren (wie es im Brick Viewer geschieht).

Die Device Identifier Werte sind hier zu finden. Es gibt auch Konstanten für diese Werte, welche nach dem folgenden Muster benannt sind:

<device-class>.DEVICE_IDENTIFIER

Zum Beispiel: BrickMaster.DEVICE_IDENTIFIER oder BrickletAmbientLight.DEVICE_IDENTIFIER.

public event ConnectedCallback(IPConnection sender, short connectReason)

Dieser Event wird ausgelöst wenn die IP Connection eine Verbindung zu einem Brick Daemon oder einer WIFI/Ethernet Extension aufgebaut hat, mögliche Gründe sind:

  • IPConnection.CONNECT_REASON_REQUEST (0): Verbindung aufgebaut nach Anfrage vom Benutzer.
  • IPConnection.CONNECT_REASON_AUTO_RECONNECT (1): Verbindung aufgebaut durch Auto-Reconnect.
public event DisconnectedCallback(IPConnection sender, short disconnectReason)

Dieser Event wird aufgerufen wenn die Verbindung der IP Connection zu einem Brick Daemon oder einer WIFI/Ethernet Extension getrennt wurde, mögliche Gründe sind:

  • IPConnection.DISCONNECT_REASON_REQUEST (0): Trennung wurde vom Benutzer angefragt.
  • IPConnection.DISCONNECT_REASON_ERROR (1): Trennung aufgrund eines unlösbaren Problems.
  • IPConnection.DISCONNECT_REASON_SHUTDOWN (2): Trennung wurde vom Brick Daemon oder WIFI/Ethernet Extension eingeleitet.