C# - Joystick 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
27
28
29

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

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

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

        // Get current position
        short x, y;
        j.GetPosition(out x, out y);

        Console.WriteLine("Position [X]: " + x);
        Console.WriteLine("Position [Y]: " + y);

        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
37
38
39
40

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

    // Callback function for pressed callback
    static void PressedCB(BrickletJoystick sender)
    {
        Console.WriteLine("Pressed");
    }

    // Callback function for released callback
    static void ReleasedCB(BrickletJoystick sender)
    {
        Console.WriteLine("Released");
    }

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

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

        // Register pressed callback to function PressedCB
        j.PressedCallback += PressedCB;

        // Register released callback to function ReleasedCB
        j.ReleasedCallback += ReleasedCB;

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

Find Borders¶

Download (ExampleFindBorders.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

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

    // Callback function for position reached callback
    static void PositionReachedCB(BrickletJoystick sender, short x, short y)
    {
        if(y == 100)
        {
            Console.WriteLine("Top");
        }
        else if(y == -100)
        {
            Console.WriteLine("Bottom");
        }

        if(x == 100)
        {
            Console.WriteLine("Right");
        }
        else if(x == -100)
        {
            Console.WriteLine("Left");
        }

        Console.WriteLine("");
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletJoystick j = new BrickletJoystick(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 0.2 seconds (200ms)
        j.SetDebouncePeriod(200);

        // Register position reached callback to function PositionReachedCB
        j.PositionReachedCallback += PositionReachedCB;

        // Configure threshold for position "outside of -99, -99 to 99, 99"
        j.SetPositionCallbackThreshold('o', -99, 99, -99, 99);

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

Grundfunktionen¶

class BrickletJoystick(string uid, IPConnection ipcon)¶

Parameter:	uid – Typ: string ipcon – Typ: IPConnection
Rückgabe:	joystick – Typ: BrickletJoystick

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

BrickletJoystick joystick = new BrickletJoystick("YOUR_DEVICE_UID", ipcon);

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

void BrickletJoystick.GetPosition(out short x, out short y)¶

Ausgabeparameter:	x – Typ: short, Wertebereich: [-100 bis 100] y – Typ: short, Wertebereich: [-100 bis 100]

Gibt die Position des Joystick zurück. Die Mittelposition des Joysticks ist x=0, y=0. Die zurückgegebenen Werte sind gemittelt und kalibriert (siehe Calibrate()).

Wenn die Position periodisch abgefragt werden sollen, wird empfohlen den PositionCallback Callback zu nutzen und die Periode mit SetPositionCallbackPeriod() vorzugeben.

bool BrickletJoystick.IsPressed()¶

Rückgabe:	pressed – Typ: bool

Gibt true zurück wenn die Taste gedrückt ist und sonst false.

Es wird empfohlen die PressedCallback und ReleasedCallback Callbacks zu nutzen, um die Taste programmatisch zu behandeln.

Fortgeschrittene Funktionen¶

void BrickletJoystick.GetAnalogValue(out int x, out int y)¶

Ausgabeparameter:	x – Typ: int, Wertebereich: [0 bis 212 - 1] y – Typ: int, Wertebereich: [0 bis 212 - 1]

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.

Bemerkung

Der von GetPosition() zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während GetAnalogValue() unverarbeitete Analogwerte zurück gibt. Der einzige Grund GetAnalogValue() zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

Wenn die Analogwerte periodisch abgefragt werden sollen, wird empfohlen den AnalogValueCallback Callback zu nutzen und die Periode mit SetAnalogValueCallbackPeriod() vorzugeben.

void BrickletJoystick.Calibrate()¶

Kalibriert die Mittelposition des Joysticks. Sollte der Joystick Bricklet nicht x=0 und y=0 in der Mittelposition zurückgeben, kann diese Funktion aufgerufen werden wenn der Joystick sich unbewegt in der Mittelposition befindet.

Die resultierende Kalibrierung wird in den EEPROM des Joystick Bricklet gespeichert, somit ist die Kalibrierung nur einmalig notwendig.

void BrickletJoystick.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 BrickletJoystick.SetPositionCallbackPeriod(long period)¶

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

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

The PositionCallback Callback wird nur ausgelöst, wenn sich die Position seit der letzten Auslösung geändert hat.

long BrickletJoystick.GetPositionCallbackPeriod()¶

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

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

void BrickletJoystick.SetAnalogValueCallbackPeriod(long period)¶

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

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

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

long BrickletJoystick.GetAnalogValueCallbackPeriod()¶

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

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

void BrickletJoystick.SetPositionCallbackThreshold(char option, short minX, short maxX, short minY, short maxY)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' minX – Typ: short, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 maxX – Typ: short, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 minY – Typ: short, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 maxY – Typ: short, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Setzt den Schwellwert für den PositionReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

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

void BrickletJoystick.GetPositionCallbackThreshold(out char option, out short minX, out short maxX, out short minY, out short maxY)¶

Ausgabeparameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' minX – Typ: short, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 maxX – Typ: short, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 minY – Typ: short, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 maxY – Typ: short, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

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

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

Für option:

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

void BrickletJoystick.SetAnalogValueCallbackThreshold(char option, int minX, int maxX, int minY, int maxY)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' minX – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 maxX – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 minY – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 maxY – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den AnalogValueReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

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

void BrickletJoystick.GetAnalogValueCallbackThreshold(out char option, out int minX, out int maxX, out int minY, out int maxY)¶

Ausgabeparameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' minX – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 maxX – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 minY – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 maxY – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

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

Für option:

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

void BrickletJoystick.SetDebouncePeriod(long debounce)¶

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

Setzt die Periode mit welcher die Schwellwert Callbacks

• PositionReachedCallback,
• AnalogValueReachedCallback

ausgelöst werden, wenn die Schwellwerte

• SetPositionCallbackThreshold(),
• SetAnalogValueCallbackThreshold()

weiterhin erreicht bleiben.

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

joystick.ExampleCallback += MyCallback;

Die verfügbaren Events werden weiter unten beschrieben.

event BrickletJoystick.PositionCallback(BrickletJoystick sender, short x, short y)¶

Callback-Parameter:	sender – Typ: BrickletJoystick x – Typ: short, Wertebereich: [-100 bis 100] y – Typ: short, Wertebereich: [-100 bis 100]

Dieser Callback wird mit der Periode, wie gesetzt mit SetPositionCallbackPeriod(), ausgelöst. Der Parameter ist die Position des Joysticks.

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

event BrickletJoystick.AnalogValueCallback(BrickletJoystick sender, int x, int y)¶

Callback-Parameter:	sender – Typ: BrickletJoystick x – Typ: int, Wertebereich: [0 bis 212 - 1] y – Typ: int, Wertebereich: [0 bis 212 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit SetAnalogValueCallbackPeriod(), ausgelöst. Der Parameter sind die Analogwerte des Joysticks.

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

event BrickletJoystick.PositionReachedCallback(BrickletJoystick sender, short x, short y)¶

Callback-Parameter:	sender – Typ: BrickletJoystick x – Typ: short, Wertebereich: [-100 bis 100] y – Typ: short, Wertebereich: [-100 bis 100]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetPositionCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Position des Joysticks.

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

event BrickletJoystick.AnalogValueReachedCallback(BrickletJoystick sender, int x, int y)¶

Callback-Parameter:	sender – Typ: BrickletJoystick x – Typ: int, Wertebereich: [0 bis 212 - 1] y – Typ: int, Wertebereich: [0 bis 212 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetAnalogValueCallbackThreshold() gesetzt, erreicht wird. Der Parameter sind die Analogwerte des Joystick.

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

event BrickletJoystick.PressedCallback(BrickletJoystick sender)¶

Callback-Parameter:	sender – Typ: BrickletJoystick

Dieser Callback wird ausgelöst, wenn die Taste gedrückt wird.

event BrickletJoystick.ReleasedCallback(BrickletJoystick sender)¶

Callback-Parameter:	sender – Typ: BrickletJoystick

Dieser Callback wird ausgelöst, wenn die Taste losgelassen wird.

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[] BrickletJoystick.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 BrickletJoystick.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:

• BrickletJoystick.FUNCTION_CALIBRATE = 4
• BrickletJoystick.FUNCTION_SET_POSITION_CALLBACK_PERIOD = 5
• BrickletJoystick.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
• BrickletJoystick.FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 9
• BrickletJoystick.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
• BrickletJoystick.FUNCTION_SET_DEBOUNCE_PERIOD = 13

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

• BrickletJoystick.FUNCTION_CALIBRATE = 4
• BrickletJoystick.FUNCTION_SET_POSITION_CALLBACK_PERIOD = 5
• BrickletJoystick.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
• BrickletJoystick.FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 9
• BrickletJoystick.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
• BrickletJoystick.FUNCTION_SET_DEBOUNCE_PERIOD = 13

void BrickletJoystick.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 BrickletJoystick.DEVICE_IDENTIFIER¶

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

Diese Konstante stellt den Anzeigenamen eines Joystick Bricklet dar.