C# - Line Bricklet¶

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 Line Bricklet

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

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

        // Get current reflectivity
        int reflectivity = l.GetReflectivity();
        Console.WriteLine("Reflectivity: " + reflectivity);

        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 Line Bricklet

    // Callback function for reflectivity callback
    static void ReflectivityCB(BrickletLine sender, int reflectivity)
    {
        Console.WriteLine("Reflectivity: " + reflectivity);
    }

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

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

        // Register reflectivity callback to function ReflectivityCB
        l.ReflectivityCallback += ReflectivityCB;

        // Set period for reflectivity callback to 1s (1000ms)
        // Note: The reflectivity callback is only called every second
        //       if the reflectivity has changed since the last call!
        l.SetReflectivityCallbackPeriod(1000);

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

Threshold¶

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

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 Line Bricklet

    // Callback function for reflectivity reached callback
    static void ReflectivityReachedCB(BrickletLine sender, int reflectivity)
    {
        Console.WriteLine("Reflectivity: " + reflectivity);
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletLine l = new BrickletLine(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 1 second (1000ms)
        l.SetDebouncePeriod(1000);

        // Register reflectivity reached callback to function ReflectivityReachedCB
        l.ReflectivityReachedCallback += ReflectivityReachedCB;

        // Configure threshold for reflectivity "greater than 2000"
        l.SetReflectivityCallbackThreshold('>', 2000, 0);

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

Grundfunktionen¶

class BrickletLine(string uid, IPConnection ipcon)¶

Parameter:	uid – Typ: string ipcon – Typ: IPConnection
Rückgabe:	line – Typ: BrickletLine

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

BrickletLine line = new BrickletLine("YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

int BrickletLine.GetReflectivity()¶

Rückgabe:	reflectivity – Typ: int, Wertebereich: [0 bis 212 - 1]

Gibt die aktuell gemessene Reflektivität zurück. Die Reflektivität ist ein Wert zwischen 0 (nicht reflektiv) und 4095 (sehr reflektiv).

Normalerweise hat schwarz eine geringe Reflektivität während weiß eine hohe Reflektivität hat.

Wenn die Reflektivität periodisch abgefragt werden soll, wird empfohlen den ReflectivityCallback Callback zu nutzen und die Periode mit SetReflectivityCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen¶

void BrickletLine.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, Wertebereich: ['a' bis 'h', 'z'] hardwareVersion – Typ: byte[], Länge: 3 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255] firmwareVersion – Typ: byte[], Länge: 3 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, 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 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.

Konfigurationsfunktionen für Callbacks¶

void BrickletLine.SetReflectivityCallbackPeriod(long period)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

Der ReflectivityCallback Callback wird nur ausgelöst, wenn sich die Reflektivität seit der letzten Auslösung geändert hat.

long BrickletLine.GetReflectivityCallbackPeriod()¶

Rückgabe:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

void BrickletLine.SetReflectivityCallbackThreshold(char option, int min, int max)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den ReflectivityReachedCallback Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn die Reflektivität außerhalb des min und max Wertes ist
'i'	Callback wird ausgelöst, wenn die Reflektivität innerhalb des min und max Wertes ist
'<'	Callback wird ausgelöst, wenn die Reflektivität kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die Reflektivität größer als der min Wert ist (max wird ignoriert)

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

Für option:

• BrickletLine.THRESHOLD_OPTION_OFF = 'x'
• BrickletLine.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletLine.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletLine.THRESHOLD_OPTION_SMALLER = '<'
• BrickletLine.THRESHOLD_OPTION_GREATER = '>'

void BrickletLine.GetReflectivityCallbackThreshold(out char option, out int min, out int max)¶

Ausgabeparameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von SetReflectivityCallbackThreshold() gesetzt.

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

Für option:

• BrickletLine.THRESHOLD_OPTION_OFF = 'x'
• BrickletLine.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletLine.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletLine.THRESHOLD_OPTION_SMALLER = '<'
• BrickletLine.THRESHOLD_OPTION_GREATER = '>'

void BrickletLine.SetDebouncePeriod(long debounce)¶

Parameter:	debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callback

• ReflectivityReachedCallback

ausgelöst wird, wenn der Schwellwert

• SetReflectivityCallbackThreshold()

weiterhin erreicht bleibt.

long BrickletLine.GetDebouncePeriod()¶

Rückgabe:	debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von SetDebouncePeriod() 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(BrickletLine sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

line.ExampleCallback += MyCallback;

Die verfügbaren Events werden weiter unten beschrieben.

event BrickletLine.ReflectivityCallback(BrickletLine sender, int reflectivity)¶

Callback-Parameter:	sender – Typ: BrickletLine reflectivity – Typ: int, Wertebereich: [0 bis 212 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit SetReflectivityCallbackPeriod(), ausgelöst. Der Parameter ist die Reflektivität des Sensors.

Der ReflectivityCallback Callback wird nur ausgelöst, wenn sich die Reflektivität seit der letzten Auslösung geändert hat.

event BrickletLine.ReflectivityReachedCallback(BrickletLine sender, int reflectivity)¶

Callback-Parameter:	sender – Typ: BrickletLine reflectivity – Typ: int, Wertebereich: [0 bis 212 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetReflectivityCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Reflektivität des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod() gesetzt, ausgelöst.

Virtuelle Funktionen¶

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.

byte[] BrickletLine.GetAPIVersion()¶

Ausgabeparameter:	apiVersion – Typ: byte[], Länge: 3 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255]

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.

bool BrickletLine.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:

• BrickletLine.FUNCTION_SET_REFLECTIVITY_CALLBACK_PERIOD = 2
• BrickletLine.FUNCTION_SET_REFLECTIVITY_CALLBACK_THRESHOLD = 4
• BrickletLine.FUNCTION_SET_DEBOUNCE_PERIOD = 6

void BrickletLine.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:

• BrickletLine.FUNCTION_SET_REFLECTIVITY_CALLBACK_PERIOD = 2
• BrickletLine.FUNCTION_SET_REFLECTIVITY_CALLBACK_THRESHOLD = 4
• BrickletLine.FUNCTION_SET_DEBOUNCE_PERIOD = 6

void BrickletLine.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.

Konstanten¶

int BrickletLine.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Line 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 BrickletLine.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Line Bricklet dar.