C# - RS232 Bricklet

Dies ist die Beschreibung der C# API Bindings für das RS232 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des RS232 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).

Loopback

Download (ExampleLoopback.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
using System;
using Tinkerforge;

// For this example connect the RX1 and TX pin to receive the send message

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your RS232 Bricklet

    // Convert message to array of length 60 as needed by write
    static char[] StringToCharArray(string message)
    {
        char[] array = message.ToCharArray();

        Array.Resize(ref array, 60);

        return array;
    }

    // Assume that the message consists of ASCII characters and
    // convert it from an array of chars to a string
    static string CharArrayToString(char[] message, byte length)
    {
        return new string(message, 0, length);
    }

    // Callback function for read callback
    static void ReadCB(BrickletRS232 sender, char[] message, byte length)
    {
        string str = CharArrayToString(message, length);
        Console.WriteLine("Message (Length: " + length + "): \"" + str + "\"");
    }

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

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

        // Register read callback to function ReadCB
        rs232.ReadCallback += ReadCB;

        // Enable read callback
        rs232.EnableReadCallback();

        // Write "test" string
        rs232.Write(StringToCharArray("test"), 4);

        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

public class BrickletRS232(String uid, IPConnection ipcon)

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

BrickletRS232 rs232 = new BrickletRS232("YOUR_DEVICE_UID", ipcon);

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

public byte Write(char[] message, byte length)

Schreibt einen String aus bis zu 60 Zeichen auf die RS232-Schnittstelle. Der String kann aus Binärdaten bestehen, ASCII o.ä. ist nicht notwendig.

Die Länge des Strings muss als ein zusätzlicher Parameter angegeben werden.

Der Rückgabewert ist die Anzahl der Zeichen die geschrieben werden konnten.

Siehe SetConfiguration() für Konfigurationsmöglichkeiten bezüglich Baudrate, Parität usw.

public void Read(out char[] message, out byte length)

Gibt die aktuell gespeicherte Nachricht zurück. Die maximale Länge beträgt 60. Wenn die Länge als 0 gegeben wird, waren keine neuen Daten verfügbar.

Anstatt mit dieser Funktion zu pollen, ist es auch möglich Callbacks zu nutzen. Siehe EnableReadCallback() und ReadCallback Callback.

public void SetConfiguration(byte baudrate, byte parity, byte stopbits, byte wordlength, byte hardwareFlowcontrol, byte softwareFlowcontrol)

Setzt die Konfiguration für die RS232-Kommunikation. Verfügbare Optionen sind:

  • Baudrate zwischen 300 und 230400 Baud.
  • Parität von None, Odd, Even und Forced Parity.
  • Stop Bits von 1 oder 2.
  • Wortlänge zwischen 5 und 8.
  • Hard-/Software Flow Control kann entweder an oder aus sein aber nicht beides gleichzeitig an.

Der Standard ist: 115200 Baud, Parität None, 1 Stop Bits, Wortlänge 8, Hard-/Software Flow Control aus.

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

  • BrickletRS232.BAUDRATE_300 = 0
  • BrickletRS232.BAUDRATE_600 = 1
  • BrickletRS232.BAUDRATE_1200 = 2
  • BrickletRS232.BAUDRATE_2400 = 3
  • BrickletRS232.BAUDRATE_4800 = 4
  • BrickletRS232.BAUDRATE_9600 = 5
  • BrickletRS232.BAUDRATE_14400 = 6
  • BrickletRS232.BAUDRATE_19200 = 7
  • BrickletRS232.BAUDRATE_28800 = 8
  • BrickletRS232.BAUDRATE_38400 = 9
  • BrickletRS232.BAUDRATE_57600 = 10
  • BrickletRS232.BAUDRATE_115200 = 11
  • BrickletRS232.BAUDRATE_230400 = 12
  • BrickletRS232.PARITY_NONE = 0
  • BrickletRS232.PARITY_ODD = 1
  • BrickletRS232.PARITY_EVEN = 2
  • BrickletRS232.PARITY_FORCED_PARITY_1 = 3
  • BrickletRS232.PARITY_FORCED_PARITY_0 = 4
  • BrickletRS232.STOPBITS_1 = 1
  • BrickletRS232.STOPBITS_2 = 2
  • BrickletRS232.WORDLENGTH_5 = 5
  • BrickletRS232.WORDLENGTH_6 = 6
  • BrickletRS232.WORDLENGTH_7 = 7
  • BrickletRS232.WORDLENGTH_8 = 8
  • BrickletRS232.HARDWARE_FLOWCONTROL_OFF = 0
  • BrickletRS232.HARDWARE_FLOWCONTROL_ON = 1
  • BrickletRS232.SOFTWARE_FLOWCONTROL_OFF = 0
  • BrickletRS232.SOFTWARE_FLOWCONTROL_ON = 1
public void GetConfiguration(out byte baudrate, out byte parity, out byte stopbits, out byte wordlength, out byte hardwareFlowcontrol, out byte softwareFlowcontrol)

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

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

  • BrickletRS232.BAUDRATE_300 = 0
  • BrickletRS232.BAUDRATE_600 = 1
  • BrickletRS232.BAUDRATE_1200 = 2
  • BrickletRS232.BAUDRATE_2400 = 3
  • BrickletRS232.BAUDRATE_4800 = 4
  • BrickletRS232.BAUDRATE_9600 = 5
  • BrickletRS232.BAUDRATE_14400 = 6
  • BrickletRS232.BAUDRATE_19200 = 7
  • BrickletRS232.BAUDRATE_28800 = 8
  • BrickletRS232.BAUDRATE_38400 = 9
  • BrickletRS232.BAUDRATE_57600 = 10
  • BrickletRS232.BAUDRATE_115200 = 11
  • BrickletRS232.BAUDRATE_230400 = 12
  • BrickletRS232.PARITY_NONE = 0
  • BrickletRS232.PARITY_ODD = 1
  • BrickletRS232.PARITY_EVEN = 2
  • BrickletRS232.PARITY_FORCED_PARITY_1 = 3
  • BrickletRS232.PARITY_FORCED_PARITY_0 = 4
  • BrickletRS232.STOPBITS_1 = 1
  • BrickletRS232.STOPBITS_2 = 2
  • BrickletRS232.WORDLENGTH_5 = 5
  • BrickletRS232.WORDLENGTH_6 = 6
  • BrickletRS232.WORDLENGTH_7 = 7
  • BrickletRS232.WORDLENGTH_8 = 8
  • BrickletRS232.HARDWARE_FLOWCONTROL_OFF = 0
  • BrickletRS232.HARDWARE_FLOWCONTROL_ON = 1
  • BrickletRS232.SOFTWARE_FLOWCONTROL_OFF = 0
  • BrickletRS232.SOFTWARE_FLOWCONTROL_ON = 1
public void SetBreakCondition(int breakTime)

Setzt eine Break Condition (die TX-Ausgabe wird fest of logisch 0 gezwungen). Der Parameter setzt die Haltezeit der Break Condition (in ms).

Neu in Version 2.0.2 (Plugin).

Fortgeschrittene Funktionen

public byte[] GetAPIVersion()

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.

public bool GetResponseExpected(byte functionId)

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.

Siehe SetResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

public void SetResponseExpected(byte functionId, bool responseExpected)

Ä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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletRS232.FUNCTION_ENABLE_READ_CALLBACK = 3
  • BrickletRS232.FUNCTION_DISABLE_READ_CALLBACK = 4
  • BrickletRS232.FUNCTION_SET_CONFIGURATION = 6
  • BrickletRS232.FUNCTION_SET_BREAK_CONDITION = 10
public void SetResponseExpectedAll(bool responseExpected)

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

public void GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)

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

public void EnableReadCallback()

Aktiviert den ReadCallback Callback.

Im Startzustand ist der Callback deaktiviert

public void DisableReadCallback()

Deaktiviert den ReadCallback Callback.

Im Startzustand ist der Callback deaktiviert

public bool IsReadCallbackEnabled()

Gibt true zurück falls ReadCallback Callback aktiviert ist, false sonst.

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

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

public event ReadCallback(BrickletRS232 sender, char[] message, byte length)

Dieser Callback wird aufgerufen wenn neue Daten zur Verfügung stehen. Die Nachricht hat eine Maximalgröße von 60 Zeichen. Die Länge der Nachricht wird zusätzlich übergeben.

Dieser Callback kann durch EnableReadCallback() aktiviert werden.

public event ErrorCallback(BrickletRS232 sender, byte error)

Dieser Callback wird aufgerufen wenn ein Fehler auftritt. Mögliche Fehler sind Overrun-, Parity- oder Framing-Fehler.

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

  • BrickletRS232.ERROR_OVERRUN = 1
  • BrickletRS232.ERROR_PARITY = 2
  • BrickletRS232.ERROR_FRAMING = 4

Neu in Version 2.0.1 (Plugin).

Konstanten

public int DEVICE_IDENTIFIER

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

public string DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines RS232 Bricklet dar.