C# - Tilt 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
30
31
32
33
34
35
36
37
38

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

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

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

        // Get current tilt state
        byte state = t.GetTiltState();

        if(state == BrickletTilt.TILT_STATE_CLOSED)
        {
            Console.WriteLine("Tilt State: Closed");
        }
        else if(state == BrickletTilt.TILT_STATE_OPEN)
        {
            Console.WriteLine("Tilt State: Open");
        }
        else if(state == BrickletTilt.TILT_STATE_CLOSED_VIBRATING)
        {
            Console.WriteLine("Tilt State: Closed Vibrating");
        }

        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
41
42
43
44
45

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

    // Callback function for tilt state callback
    static void TiltStateCB(BrickletTilt sender, byte state)
    {
        if(state == BrickletTilt.TILT_STATE_CLOSED)
        {
            Console.WriteLine("Tilt State: Closed");
        }
        else if(state == BrickletTilt.TILT_STATE_OPEN)
        {
            Console.WriteLine("Tilt State: Open");
        }
        else if(state == BrickletTilt.TILT_STATE_CLOSED_VIBRATING)
        {
            Console.WriteLine("Tilt State: Closed Vibrating");
        }
    }

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

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

        // Enable tilt state callback
        t.EnableTiltStateCallback();

        // Register tilt state callback to function TiltStateCB
        t.TiltStateCallback += TiltStateCB;

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

Grundfunktionen¶

class BrickletTilt(string uid, IPConnection ipcon)¶

Parameter:	uid – Typ: string ipcon – Typ: IPConnection
Rückgabe:	tilt – Typ: BrickletTilt

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

BrickletTilt tilt = new BrickletTilt("YOUR_DEVICE_UID", ipcon);

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

byte BrickletTilt.GetTiltState()¶

Rückgabe:	state – Typ: byte, Wertebereich: Siehe Konstanten

Gibt den aktuellen Tilt-Zustand zurück. Der Zustand kann folgende Werte annehmen:

• 0 = Closed: Der Ball im Neigungsschalter schließt den Stromkreis.
• 1 = Open: Der Ball im Neigungsschalter schließt den Stromkreis nicht.
• 2 = Closed Vibrating: Der Neigungsschalter ist in Bewegung (schnelle Änderungen zwischen open und close).

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

Für state:

• BrickletTilt.TILT_STATE_CLOSED = 0
• BrickletTilt.TILT_STATE_OPEN = 1
• BrickletTilt.TILT_STATE_CLOSED_VIBRATING = 2

Fortgeschrittene Funktionen¶

void BrickletTilt.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 BrickletTilt.EnableTiltStateCallback()¶

Aktiviert den TiltStateCallback Callback.

void BrickletTilt.DisableTiltStateCallback()¶

Deaktiviert den TiltStateCallback Callback.

bool BrickletTilt.IsTiltStateCallbackEnabled()¶

Rückgabe:	enabled – Typ: bool, Standardwert: false

Gibt true zurück wenn der TiltStateCallback Callback aktiviert ist.

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

tilt.ExampleCallback += MyCallback;

Die verfügbaren Events werden weiter unten beschrieben.

event BrickletTilt.TiltStateCallback(BrickletTilt sender, byte state)¶

Callback-Parameter:	sender – Typ: BrickletTilt state – Typ: byte, Wertebereich: Siehe Konstanten

Dieser Callback übergibt den aktuellen Tilt-Status. Der Callback wird aufgerufen wenn sich der Status ändert.

Siehe GetTiltState() für eine Beschreibung der Zustände.

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

Für state:

• BrickletTilt.TILT_STATE_CLOSED = 0
• BrickletTilt.TILT_STATE_OPEN = 1
• BrickletTilt.TILT_STATE_CLOSED_VIBRATING = 2

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

• BrickletTilt.FUNCTION_ENABLE_TILT_STATE_CALLBACK = 2
• BrickletTilt.FUNCTION_DISABLE_TILT_STATE_CALLBACK = 3

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

• BrickletTilt.FUNCTION_ENABLE_TILT_STATE_CALLBACK = 2
• BrickletTilt.FUNCTION_DISABLE_TILT_STATE_CALLBACK = 3

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

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

Diese Konstante stellt den Anzeigenamen eines Tilt Bricklet dar.