Java - Sound Intensity 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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletSoundIntensity;

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

    // Change XYZ to the UID of your Sound Intensity 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
        BrickletSoundIntensity si = new BrickletSoundIntensity(UID, ipcon); // Create device object

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

        // Get current intensity
        int intensity = si.getIntensity(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Intensity: " + intensity);

        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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletSoundIntensity;

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

    // Change XYZ to the UID of your Sound Intensity 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
        BrickletSoundIntensity si = new BrickletSoundIntensity(UID, ipcon); // Create device object

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

        // Add intensity listener
        si.addIntensityListener(new BrickletSoundIntensity.IntensityListener() {
            public void intensity(int intensity) {
                System.out.println("Intensity: " + intensity);
            }
        });

        // Set period for intensity callback to 0.05s (50ms)
        // Note: The intensity callback is only called every 0.05 seconds
        //       if the intensity has changed since the last call!
        si.setIntensityCallbackPeriod(50);

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

Threshold¶

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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletSoundIntensity;

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

    // Change XYZ to the UID of your Sound Intensity 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
        BrickletSoundIntensity si = new BrickletSoundIntensity(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 1 second (1000ms)
        si.setDebouncePeriod(1000);

        // Add intensity reached listener
        si.addIntensityReachedListener(new BrickletSoundIntensity.IntensityReachedListener() {
            public void intensityReached(int intensity) {
                System.out.println("Intensity: " + intensity);
            }
        });

        // Configure threshold for intensity "greater than 2000"
        si.setIntensityCallbackThreshold('>', 2000, 0);

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

Basic Functions¶

class BrickletSoundIntensity(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	soundIntensity – Type: BrickletSoundIntensity

Creates an object with the unique device ID uid:

BrickletSoundIntensity soundIntensity = new BrickletSoundIntensity("YOUR_DEVICE_UID", ipcon);

This object can then be used after the IP Connection is connected.

int BrickletSoundIntensity.getIntensity()¶

Returns:	intensity – Type: int, Range: [0 to 212 - 1]

Returns the current sound intensity.

The value corresponds to the upper envelop of the signal of the microphone capsule.

If you want to get the intensity periodically, it is recommended to use the IntensityListener listener and set the period with setIntensityCallbackPeriod().

Advanced Functions¶

BrickletSoundIntensity.Identity BrickletSoundIntensity.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 BrickletSoundIntensity.setIntensityCallbackPeriod(long period)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Sets the period with which the IntensityListener listener is triggered periodically. A value of 0 turns the listener off.

The IntensityListener listener is only triggered if the intensity has changed since the last triggering.

long BrickletSoundIntensity.getIntensityCallbackPeriod()¶

Returns:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by setIntensityCallbackPeriod().

void BrickletSoundIntensity.setIntensityCallbackThreshold(char option, int min, int max)¶

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Range: [0 to 216 - 1], Default: 0 max – Type: int, Range: [0 to 216 - 1], Default: 0

Sets the thresholds for the IntensityReachedListener listener.

The following options are possible:

Option	Description
'x'	Listener is turned off
'o'	Listener is triggered when the intensity is outside the min and max values
'i'	Listener is triggered when the intensity is inside the min and max values
'<'	Listener is triggered when the intensity is smaller than the min value (max is ignored)
'>'	Listener is triggered when the intensity is greater than the min value (max is ignored)

The following constants are available for this function:

For option:

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

BrickletSoundIntensity.IntensityCallbackThreshold BrickletSoundIntensity.getIntensityCallbackThreshold()¶

Return Object:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Range: [0 to 216 - 1], Default: 0 max – Type: int, Range: [0 to 216 - 1], Default: 0

Returns the threshold as set by setIntensityCallbackThreshold().

The following constants are available for this function:

For option:

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

void BrickletSoundIntensity.setDebouncePeriod(long debounce)¶

Parameters:	debounce – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Sets the period with which the threshold listener

• IntensityReachedListener

is triggered, if the thresholds

• setIntensityCallbackThreshold()

keeps being reached.

long BrickletSoundIntensity.getDebouncePeriod()¶

Returns:	debounce – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by setDebouncePeriod().

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 BrickletSoundIntensity.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 BrickletSoundIntensity.IntensityListener()¶

This listener can be added with the addIntensityListener() function. An added listener can be removed with the removeIntensityListener() function.

void intensity(int intensity)

Parameters:	intensity – Type: int, Range: [0 to 212 - 1]

This listener is triggered periodically with the period that is set by setIntensityCallbackPeriod(). The parameter is the intensity of the sensor.

The IntensityListener listener is only triggered if the intensity has changed since the last triggering.

class BrickletSoundIntensity.IntensityReachedListener()¶

This listener can be added with the addIntensityReachedListener() function. An added listener can be removed with the removeIntensityReachedListener() function.

void intensityReached(int intensity)

Parameters:	intensity – Type: int, Range: [0 to 212 - 1]

This listener is triggered when the threshold as set by setIntensityCallbackThreshold() is reached. The parameter is the intensity of the encoder.

If the threshold keeps being reached, the listener is triggered periodically with the period as set by setDebouncePeriod().

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

• BrickletSoundIntensity.FUNCTION_SET_INTENSITY_CALLBACK_PERIOD = 2
• BrickletSoundIntensity.FUNCTION_SET_INTENSITY_CALLBACK_THRESHOLD = 4
• BrickletSoundIntensity.FUNCTION_SET_DEBOUNCE_PERIOD = 6

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

• BrickletSoundIntensity.FUNCTION_SET_INTENSITY_CALLBACK_PERIOD = 2
• BrickletSoundIntensity.FUNCTION_SET_INTENSITY_CALLBACK_THRESHOLD = 4
• BrickletSoundIntensity.FUNCTION_SET_DEBOUNCE_PERIOD = 6

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

This constant is used to identify a Sound Intensity 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 BrickletSoundIntensity.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Sound Intensity Bricklet.