Java - Distance IR Bricklet 2.0¶

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.BrickletDistanceIRV2;

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

    // Change XYZ to the UID of your Distance IR Bricklet 2.0
    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
        BrickletDistanceIRV2 dir = new BrickletDistanceIRV2(UID, ipcon); // Create device object

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

        // Get current distance
        int distance = dir.getDistance(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Distance: " + distance/10.0 + " cm");

        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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletDistanceIRV2;

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

    // Change XYZ to the UID of your Distance IR Bricklet 2.0
    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
        BrickletDistanceIRV2 dir = new BrickletDistanceIRV2(UID, ipcon); // Create device object

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

        // Add distance listener
        dir.addDistanceListener(new BrickletDistanceIRV2.DistanceListener() {
            public void distance(int distance) {
                System.out.println("Distance: " + distance/10.0 + " cm");
            }
        });

        // Set period for distance callback to 1s (1000ms) without a threshold
        dir.setDistanceCallbackConfiguration(1000, false, 'x', 0, 0);

        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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletDistanceIRV2;

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

    // Change XYZ to the UID of your Distance IR Bricklet 2.0
    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
        BrickletDistanceIRV2 dir = new BrickletDistanceIRV2(UID, ipcon); // Create device object

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

        // Add distance listener
        dir.addDistanceListener(new BrickletDistanceIRV2.DistanceListener() {
            public void distance(int distance) {
                System.out.println("Distance: " + distance/10.0 + " cm");
            }
        });

        // Configure threshold for distance "smaller than 30 cm"
        // with a debounce period of 1s (1000ms)
        dir.setDistanceCallbackConfiguration(1000, false, '<', 30*10, 0);

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

Basic Functions¶

class BrickletDistanceIRV2(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	distanceIRV2 – Type: BrickletDistanceIRV2

Creates an object with the unique device ID uid:

BrickletDistanceIRV2 distanceIRV2 = new BrickletDistanceIRV2("YOUR_DEVICE_UID", ipcon);

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

int BrickletDistanceIRV2.getDistance()¶

Returns:	distance – Type: int, Unit: 1 mm, Range: [0 to 216 - 1]

Returns the distance measured by the sensor. Possible distance ranges are 40 to 300, 100 to 800 and 200 to 1500, depending on the selected IR sensor.

If you want to get the value periodically, it is recommended to use the DistanceListener listener. You can set the listener configuration with setDistanceCallbackConfiguration().

long BrickletDistanceIRV2.getAnalogValue()¶

Returns:	analogValue – Type: long, Range: [0 to 221 - 1]

Returns the analog value as read by a analog-to-digital converter.

This is unfiltered raw data. We made sure that the integration time of the ADC is shorter then the measurement interval of the sensor (10ms vs 16.5ms). So there is no information lost.

If you want to do your own calibration or create your own lookup table you can use this value.

If you want to get the value periodically, it is recommended to use the AnalogValueListener listener. You can set the listener configuration with setAnalogValueCallbackConfiguration().

void BrickletDistanceIRV2.setMovingAverageConfiguration(int movingAverageLength)¶

Parameters:	movingAverageLength – Type: int, Range: [1 to 1000], Default: 25

Sets the length of a moving averaging for the distance.

Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.

New data is gathered every ~10ms. With a moving average of length 1000 the resulting averaging window has a length of approximately 10s. If you want to do long term measurements the longest moving average will give the cleanest results.

int BrickletDistanceIRV2.getMovingAverageConfiguration()¶

Returns:	movingAverageLength – Type: int, Range: [1 to 1000], Default: 25

Returns the moving average configuration as set by setMovingAverageConfiguration().

void BrickletDistanceIRV2.setDistanceLEDConfig(int config)¶

Parameters:	config – Type: int, Range: See constants, Default: 3

Configures the distance LED to be either turned off, turned on, blink in heartbeat mode or show the distance (brighter = object is nearer).

The following constants are available for this function:

For config:

• BrickletDistanceIRV2.DISTANCE_LED_CONFIG_OFF = 0
• BrickletDistanceIRV2.DISTANCE_LED_CONFIG_ON = 1
• BrickletDistanceIRV2.DISTANCE_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletDistanceIRV2.DISTANCE_LED_CONFIG_SHOW_DISTANCE = 3

int BrickletDistanceIRV2.getDistanceLEDConfig()¶

Returns:	config – Type: int, Range: See constants, Default: 3

Returns the LED configuration as set by setDistanceLEDConfig()

The following constants are available for this function:

For config:

• BrickletDistanceIRV2.DISTANCE_LED_CONFIG_OFF = 0
• BrickletDistanceIRV2.DISTANCE_LED_CONFIG_ON = 1
• BrickletDistanceIRV2.DISTANCE_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletDistanceIRV2.DISTANCE_LED_CONFIG_SHOW_DISTANCE = 3

void BrickletDistanceIRV2.setSensorType(int sensor)¶

Parameters:	sensor – Type: int, Range: See constants

Sets the sensor type.

The Bricklet comes configured with the correct sensor type and the type is saved in flash (i.e. the Bricklet retains the information if power is lost).

If you want to change the sensor you can set the type in Brick Viewer, you will likely never need to call this function from your program.

The following constants are available for this function:

For sensor:

• BrickletDistanceIRV2.SENSOR_TYPE_2Y0A41 = 0
• BrickletDistanceIRV2.SENSOR_TYPE_2Y0A21 = 1
• BrickletDistanceIRV2.SENSOR_TYPE_2Y0A02 = 2

int BrickletDistanceIRV2.getSensorType()¶

Returns:	sensor – Type: int, Range: See constants

Returns the sensor type as set by setSensorType().

The following constants are available for this function:

For sensor:

• BrickletDistanceIRV2.SENSOR_TYPE_2Y0A41 = 0
• BrickletDistanceIRV2.SENSOR_TYPE_2Y0A21 = 1
• BrickletDistanceIRV2.SENSOR_TYPE_2Y0A02 = 2

Advanced Functions¶

BrickletDistanceIRV2.SPITFPErrorCount BrickletDistanceIRV2.getSPITFPErrorCount()¶

Return Object:	errorCountAckChecksum – Type: long, Range: [0 to 232 - 1] errorCountMessageChecksum – Type: long, Range: [0 to 232 - 1] errorCountFrame – Type: long, Range: [0 to 232 - 1] errorCountOverflow – Type: long, Range: [0 to 232 - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

• ACK checksum errors,
• message checksum errors,
• framing errors and
• overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

void BrickletDistanceIRV2.setStatusLEDConfig(int config)¶

Parameters:	config – Type: int, Range: See constants, Default: 3

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

For config:

• BrickletDistanceIRV2.STATUS_LED_CONFIG_OFF = 0
• BrickletDistanceIRV2.STATUS_LED_CONFIG_ON = 1
• BrickletDistanceIRV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletDistanceIRV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletDistanceIRV2.getStatusLEDConfig()¶

Returns:	config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

For config:

• BrickletDistanceIRV2.STATUS_LED_CONFIG_OFF = 0
• BrickletDistanceIRV2.STATUS_LED_CONFIG_ON = 1
• BrickletDistanceIRV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletDistanceIRV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletDistanceIRV2.getChipTemperature()¶

Returns:	temperature – Type: int, Unit: 1 °C, Range: [-215 to 215 - 1]

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

void BrickletDistanceIRV2.reset()¶

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

BrickletDistanceIRV2.Identity BrickletDistanceIRV2.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 BrickletDistanceIRV2.setDistanceCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1 mm, Range: [0 to 216 - 1], Default: 0 max – Type: int, Unit: 1 mm, Range: [0 to 216 - 1], Default: 0

The period is the period with which the DistanceListener listener is triggered periodically. A value of 0 turns the listener off.

If the value has to change-parameter is set to true, the listener is only triggered after the value has changed. If the value didn't change within the period, the listener is triggered immediately on change.

If it is set to false, the listener is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the listener with thresholds.

The option-parameter together with min/max sets a threshold for the DistanceListener listener.

The following options are possible:

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

If the option is set to 'x' (threshold turned off) the listener is triggered with the fixed period.

The following constants are available for this function:

For option:

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

BrickletDistanceIRV2.DistanceCallbackConfiguration BrickletDistanceIRV2.getDistanceCallbackConfiguration()¶

Return Object:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1 mm, Range: [0 to 216 - 1], Default: 0 max – Type: int, Unit: 1 mm, Range: [0 to 216 - 1], Default: 0

Returns the listener configuration as set by setDistanceCallbackConfiguration().

The following constants are available for this function:

For option:

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

void BrickletDistanceIRV2.setAnalogValueCallbackConfiguration(long period, boolean valueHasToChange, char option, long min, long max)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: long, Range: [0 to 232 - 1], Default: 0 max – Type: long, Range: [0 to 232 - 1], Default: 0

The period is the period with which the AnalogValueListener listener is triggered periodically. A value of 0 turns the listener off.

If the value has to change-parameter is set to true, the listener is only triggered after the value has changed. If the value didn't change within the period, the listener is triggered immediately on change.

If it is set to false, the listener is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the listener with thresholds.

The option-parameter together with min/max sets a threshold for the AnalogValueListener listener.

The following options are possible:

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

If the option is set to 'x' (threshold turned off) the listener is triggered with the fixed period.

The following constants are available for this function:

For option:

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

BrickletDistanceIRV2.AnalogValueCallbackConfiguration BrickletDistanceIRV2.getAnalogValueCallbackConfiguration()¶

Return Object:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: long, Range: [0 to 232 - 1], Default: 0 max – Type: long, Range: [0 to 232 - 1], Default: 0

Returns the listener configuration as set by setAnalogValueCallbackConfiguration().

The following constants are available for this function:

For option:

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

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 BrickletDistanceIRV2.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 BrickletDistanceIRV2.DistanceListener()¶

This listener can be added with the addDistanceListener() function. An added listener can be removed with the removeDistanceListener() function.

void distance(int distance)

Parameters:	distance – Type: int, Unit: 1 mm, Range: [0 to 216 - 1]

This listener is triggered periodically according to the configuration set by setDistanceCallbackConfiguration().

The parameter is the same as getDistance().

class BrickletDistanceIRV2.AnalogValueListener()¶

This listener can be added with the addAnalogValueListener() function. An added listener can be removed with the removeAnalogValueListener() function.

void analogValue(long analogValue)

Parameters:	analogValue – Type: long, Range: [0 to 221 - 1]

This listener is triggered periodically according to the configuration set by setAnalogValueCallbackConfiguration().

The parameter is the same as getAnalogValue().

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

• BrickletDistanceIRV2.FUNCTION_SET_DISTANCE_CALLBACK_CONFIGURATION = 2
• BrickletDistanceIRV2.FUNCTION_SET_ANALOG_VALUE_CALLBACK_CONFIGURATION = 6
• BrickletDistanceIRV2.FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 9
• BrickletDistanceIRV2.FUNCTION_SET_DISTANCE_LED_CONFIG = 11
• BrickletDistanceIRV2.FUNCTION_SET_SENSOR_TYPE = 13
• BrickletDistanceIRV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletDistanceIRV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletDistanceIRV2.FUNCTION_RESET = 243
• BrickletDistanceIRV2.FUNCTION_WRITE_UID = 248

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

• BrickletDistanceIRV2.FUNCTION_SET_DISTANCE_CALLBACK_CONFIGURATION = 2
• BrickletDistanceIRV2.FUNCTION_SET_ANALOG_VALUE_CALLBACK_CONFIGURATION = 6
• BrickletDistanceIRV2.FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 9
• BrickletDistanceIRV2.FUNCTION_SET_DISTANCE_LED_CONFIG = 11
• BrickletDistanceIRV2.FUNCTION_SET_SENSOR_TYPE = 13
• BrickletDistanceIRV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletDistanceIRV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletDistanceIRV2.FUNCTION_RESET = 243
• BrickletDistanceIRV2.FUNCTION_WRITE_UID = 248

void BrickletDistanceIRV2.setResponseExpectedAll(boolean responseExpected)¶

Parameters:	responseExpected – Type: boolean

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

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

int BrickletDistanceIRV2.setBootloaderMode(int mode)¶

Parameters:	mode – Type: int, Range: See constants
Returns:	status – Type: int, Range: See constants

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

For mode:

• BrickletDistanceIRV2.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletDistanceIRV2.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletDistanceIRV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletDistanceIRV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletDistanceIRV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

• BrickletDistanceIRV2.BOOTLOADER_STATUS_OK = 0
• BrickletDistanceIRV2.BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletDistanceIRV2.BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletDistanceIRV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletDistanceIRV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletDistanceIRV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5

int BrickletDistanceIRV2.getBootloaderMode()¶

Returns:	mode – Type: int, Range: See constants

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

For mode:

• BrickletDistanceIRV2.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletDistanceIRV2.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletDistanceIRV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletDistanceIRV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletDistanceIRV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

void BrickletDistanceIRV2.setWriteFirmwarePointer(long pointer)¶

Parameters:	pointer – Type: long, Unit: 1 B, Range: [0 to 232 - 1]

Sets the firmware pointer for writeFirmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

int BrickletDistanceIRV2.writeFirmware(int[] data)¶

Parameters:	data – Type: int[], Length: 64, Range: [0 to 255]
Returns:	status – Type: int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by setWriteFirmwarePointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

void BrickletDistanceIRV2.writeUID(long uid)¶

Parameters:	uid – Type: long, Range: [0 to 232 - 1]

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

long BrickletDistanceIRV2.readUID()¶

Returns:	uid – Type: long, Range: [0 to 232 - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

Constants¶

int BrickletDistanceIRV2.DEVICE_IDENTIFIER¶

This constant is used to identify a Distance IR Bricklet 2.0.

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 BrickletDistanceIRV2.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Distance IR Bricklet 2.0.