C# - Tilt Bricklet

This is the description of the C# API bindings for the Tilt Bricklet. General information and technical specifications for the Tilt Bricklet are summarized in its hardware description.

An installation guide for the C# API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

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();
    }
}

API

Generally, every method of the C# bindings that returns a value can throw a Tinkerforge.TimeoutException. This exception gets thrown if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody plugs the device out). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Since C# does not support multiple return values directly, we use the out keyword to return multiple values from a method.

The namespace for all Brick/Bricklet bindings and the IPConnection is Tinkerforge.*.

All methods listed below are thread-safe.

Basic Functions

public class BrickletTilt(String uid, IPConnection ipcon)

Creates an object with the unique device ID uid:

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

This object can then be used after the IP Connection is connected (see examples above).

public byte GetTiltState()

Returns the current tilt state. The state can either be

  • 0 = Closed: The ball in the tilt switch closes the circuit.
  • 1 = Open: The ball in the tilt switch does not close the circuit.
  • 2 = Closed Vibrating: The tilt switch is in motion (rapid change between open and close).
Tilt states

The following constants are available for this function:

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

Advanced Functions

public byte[] GetAPIVersion()

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

public bool GetResponseExpected(byte functionId)

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

See SetResponseExpected() for the list of function ID constants available for this function.

public void SetResponseExpected(byte functionId, bool responseExpected)

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • BrickletTilt.FUNCTION_ENABLE_TILT_STATE_CALLBACK = 2
  • BrickletTilt.FUNCTION_DISABLE_TILT_STATE_CALLBACK = 3
public void SetResponseExpectedAll(bool responseExpected)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

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

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

public void EnableTiltStateCallback()

Enables the TiltStateCallback callback.

public void DisableTiltStateCallback()

Disables the TiltStateCallback callback.

public bool IsTiltStateCallbackEnabled()

Returns true if the TiltStateCallback callback is enabled.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by appending your callback handler to the corresponding event:

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

tilt.ExampleCallback += MyCallback;

The available events are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

public event TiltStateCallback(BrickletTilt sender, byte state)

This callback provides the current tilt state. It is called every time the state changes.

See GetTiltState() for a description of the states.

The following constants are available for this function:

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

Constants

public int DEVICE_IDENTIFIER

This constant is used to identify a Tilt Bricklet.

The GetIdentity() function and the EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

public string DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Tilt Bricklet.