Java - Tilt Bricklet¶

Simple¶

Download (ExampleSimple.java)

 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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletTilt;

public class ExampleSimple {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Tilt Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        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
        short state = t.getTiltState(); // Can throw com.tinkerforge.TimeoutException

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

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Callback¶

Download (ExampleCallback.java)

 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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletTilt;

public class ExampleCallback {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Tilt Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        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();

        // Add tilt state listener
        t.addTiltStateListener(new BrickletTilt.TiltStateListener() {
            public void tiltState(short state) {
                if(state == BrickletTilt.TILT_STATE_CLOSED) {
                    System.out.println("Tilt State: Closed");
                } else if(state == BrickletTilt.TILT_STATE_OPEN) {
                    System.out.println("Tilt State: Open");
                } else if(state == BrickletTilt.TILT_STATE_CLOSED_VIBRATING) {
                    System.out.println("Tilt State: Closed Vibrating");
                }
            }
        });

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Basic Functions¶

class BrickletTilt(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	tilt – Type: BrickletTilt

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.

short BrickletTilt.getTiltState()¶

Returns:	state – Type: short, Range: See constants

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

The following constants are available for this function:

For state:

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

Advanced Functions¶

BrickletTilt.Identity BrickletTilt.getIdentity()¶

Return Object:

uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardwareVersion – Type: short[], Length: 3 0: major – Type: short, Range: [0 to 255] 1: minor – Type: short, Range: [0 to 255] 2: revision – Type: short, Range: [0 to 255] firmwareVersion – Type: short[], Length: 3 0: major – Type: short, Range: [0 to 255] 1: minor – Type: short, Range: [0 to 255] 2: revision – Type: short, Range: [0 to 255] deviceIdentifier – Type: int, Range: [0 to 216 - 1]

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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

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

Listener Configuration Functions¶

void BrickletTilt.enableTiltStateCallback()¶

Enables the TiltStateListener listener.

void BrickletTilt.disableTiltStateCallback()¶

Disables the TiltStateListener listener.

boolean BrickletTilt.isTiltStateCallbackEnabled()¶

Returns:	enabled – Type: boolean, Default: false

Returns true if the TiltStateListener listener is enabled.

Listeners¶

Listeners can be registered to receive time critical or recurring data from the device. The registration is done with add*Listener() functions of the device object.

The parameter is a listener class object, for example:

device.addExampleListener(new BrickletTilt.ExampleListener() {
    public void property(int value) {
        System.out.println("Value: " + value);
    }
});

The available listener classes with inherent methods to be overwritten are described below. It is possible to add several listeners and to remove them with the corresponding remove*Listener() function.

class BrickletTilt.TiltStateListener()¶

This listener can be added with the addTiltStateListener() function. An added listener can be removed with the removeTiltStateListener() function.

void tiltState(short state)

Parameters:	state – Type: short, Range: See constants

This listener 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:

For state:

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

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

short[] BrickletTilt.getAPIVersion()¶

Return Object:	apiVersion – Type: short[], Length: 3 0: major – Type: short, Range: [0 to 255] 1: minor – Type: short, Range: [0 to 255] 2: revision – Type: short, Range: [0 to 255]

Returns the version of the API definition 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.

boolean BrickletTilt.getResponseExpected(byte functionId)¶

Parameters:	functionId – Type: byte, Range: See constants
Returns:	responseExpected – Type: boolean

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 listener 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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

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

void BrickletTilt.setResponseExpected(byte functionId, boolean responseExpected)¶

Parameters:	functionId – Type: byte, Range: See constants responseExpected – Type: boolean

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 listener 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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

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

void BrickletTilt.setResponseExpectedAll(boolean responseExpected)¶

Parameters:	responseExpected – Type: boolean

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

Constants¶

int BrickletTilt.DEVICE_IDENTIFIER¶

This constant is used to identify a Tilt Bricklet.

The getIdentity() function and the IPConnection.EnumerateListener listener of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

String BrickletTilt.DEVICE_DISPLAY_NAME¶

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