Java - Motion Detector Bricklet¶

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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletMotionDetector;

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

    // Change XYZ to the UID of your Motion Detector 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
        BrickletMotionDetector md = new BrickletMotionDetector(UID, ipcon); // Create device object

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

        // Add motion detected listener
        md.addMotionDetectedListener(new BrickletMotionDetector.MotionDetectedListener() {
            public void motionDetected() {
                System.out.println("Motion Detected");
            }
        });

        // Add detection cycle ended listener
        md.addDetectionCycleEndedListener(new BrickletMotionDetector.DetectionCycleEndedListener() {
            public void detectionCycleEnded() {
                System.out.println("Detection Cycle Ended (next detection possible in ~3 seconds)");
            }
        });

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

Basic Functions¶

class BrickletMotionDetector(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	motionDetector – Type: BrickletMotionDetector

Creates an object with the unique device ID uid:

BrickletMotionDetector motionDetector = new BrickletMotionDetector("YOUR_DEVICE_UID", ipcon);

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

short BrickletMotionDetector.getMotionDetected()¶

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

Returns 1 if a motion was detected. How long this returns 1 after a motion was detected can be adjusted with one of the small potentiometers on the Motion Detector Bricklet, see here.

There is also a blue LED on the Bricklet that is on as long as the Bricklet is in the "motion detected" state.

The following constants are available for this function:

For motion:

• BrickletMotionDetector.MOTION_NOT_DETECTED = 0
• BrickletMotionDetector.MOTION_DETECTED = 1

Advanced Functions¶

void BrickletMotionDetector.setStatusLEDConfig(short config)¶

Parameters:	config – Type: short, Range: See constants, Default: 2

Sets the status led configuration.

By default the status LED turns on if a motion is detected and off is no motion is detected.

You can also turn the LED permanently on/off.

The following constants are available for this function:

For config:

• BrickletMotionDetector.STATUS_LED_CONFIG_OFF = 0
• BrickletMotionDetector.STATUS_LED_CONFIG_ON = 1
• BrickletMotionDetector.STATUS_LED_CONFIG_SHOW_STATUS = 2

New in version 2.0.1 (Plugin).

short BrickletMotionDetector.getStatusLEDConfig()¶

Returns:	config – Type: short, Range: See constants, Default: 2

Returns the configuration as set by setStatusLEDConfig().

The following constants are available for this function:

For config:

• BrickletMotionDetector.STATUS_LED_CONFIG_OFF = 0
• BrickletMotionDetector.STATUS_LED_CONFIG_ON = 1
• BrickletMotionDetector.STATUS_LED_CONFIG_SHOW_STATUS = 2

New in version 2.0.1 (Plugin).

BrickletMotionDetector.Identity BrickletMotionDetector.getIdentity()¶

Return Object:

uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'i', '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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.

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

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 BrickletMotionDetector.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 BrickletMotionDetector.MotionDetectedListener()¶

This listener can be added with the addMotionDetectedListener() function. An added listener can be removed with the removeMotionDetectedListener() function.

void motionDetected()

This listener is called after a motion was detected.

class BrickletMotionDetector.DetectionCycleEndedListener()¶

This listener can be added with the addDetectionCycleEndedListener() function. An added listener can be removed with the removeDetectionCycleEndedListener() function.

void detectionCycleEnded()

This listener is called when the detection cycle ended. When this listener is called, a new motion can be detected again after approximately 2 seconds.

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[] BrickletMotionDetector.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 BrickletMotionDetector.getResponseExpected(short functionId)¶

Parameters:	functionId – Type: short, 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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

• BrickletMotionDetector.FUNCTION_SET_STATUS_LED_CONFIG = 4

void BrickletMotionDetector.setResponseExpected(short functionId, boolean responseExpected)¶

Parameters:	functionId – Type: short, 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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

• BrickletMotionDetector.FUNCTION_SET_STATUS_LED_CONFIG = 4

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

This constant is used to identify a Motion Detector 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 BrickletMotionDetector.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Motion Detector Bricklet.