Java - Isolator 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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIsolator;
import com.tinkerforge.BrickletIsolator.Statistics;

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

    // Change XYZ to the UID of your Isolator 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
        BrickletIsolator i = new BrickletIsolator(UID, ipcon); // Create device object

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

        // Get current statistics
        Statistics statistics = i.getStatistics(); // Can throw com.tinkerforge.TimeoutException

        System.out.println("Messages From Brick: " + statistics.messagesFromBrick);
        System.out.println("Messages From Bricklet: " + statistics.messagesFromBricklet);
        System.out.println("Connected Bricklet Device Identifier: " + statistics.connectedBrickletDeviceIdentifier);
        System.out.println("Connected Bricklet UID: " + statistics.connectedBrickletUID);

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

Basic Functions¶

class BrickletIsolator(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	isolator – Type: BrickletIsolator

Creates an object with the unique device ID uid:

BrickletIsolator isolator = new BrickletIsolator("YOUR_DEVICE_UID", ipcon);

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

BrickletIsolator.Statistics BrickletIsolator.getStatistics()¶

Return Object:	messagesFromBrick – Type: long, Range: [0 to 232 - 1] messagesFromBricklet – Type: long, Range: [0 to 232 - 1] connectedBrickletDeviceIdentifier – Type: int, Range: [0 to 216 - 1] connectedBrickletUID – Type: String, Length: up to 8

Returns statistics for the Isolator Bricklet.

Advanced Functions¶

void BrickletIsolator.setSPITFPBaudrateConfig(boolean enableDynamicBaudrate, long minimumDynamicBaudrate)¶

Parameters:	enableDynamicBaudrate – Type: boolean, Default: true minimumDynamicBaudrate – Type: long, Unit: 1 Bd, Range: [400000 to 2000000], Default: 400000

The SPITF protocol can be used with a dynamic baudrate. If the dynamic baudrate is enabled, the Isolator Bricklet will try to adapt the baudrate for the communication between Bricks and Bricklets according to the amount of data that is transferred.

The baudrate for communication config between Brick and Isolator Bricklet can be set through the API of the Brick.

The baudrate will be increased exponentially if lots of data is sent/received and decreased linearly if little data is sent/received.

This lowers the baudrate in applications where little data is transferred (e.g. a weather station) and increases the robustness. If there is lots of data to transfer (e.g. Thermal Imaging Bricklet) it automatically increases the baudrate as needed.

In cases where some data has to transferred as fast as possible every few seconds (e.g. RS485 Bricklet with a high baudrate but small payload) you may want to turn the dynamic baudrate off to get the highest possible performance.

The maximum value of the baudrate can be set per port with the function setSPITFPBaudrate(). If the dynamic baudrate is disabled, the baudrate as set by setSPITFPBaudrate() will be used statically.

BrickletIsolator.SPITFPBaudrateConfig BrickletIsolator.getSPITFPBaudrateConfig()¶

Return Object:	enableDynamicBaudrate – Type: boolean, Default: true minimumDynamicBaudrate – Type: long, Unit: 1 Bd, Range: [400000 to 2000000], Default: 400000

Returns the baudrate config, see setSPITFPBaudrateConfig().

void BrickletIsolator.setSPITFPBaudrate(long baudrate)¶

Parameters:	baudrate – Type: long, Unit: 1 Bd, Range: [400000 to 2000000], Default: 1400000

Sets the baudrate for a the communication between Isolator Bricklet and the connected Bricklet. The baudrate for communication between Brick and Isolator Bricklet can be set through the API of the Brick.

If you want to increase the throughput of Bricklets you can increase the baudrate. If you get a high error count because of high interference (see getSPITFPErrorCount()) you can decrease the baudrate.

If the dynamic baudrate feature is enabled, the baudrate set by this function corresponds to the maximum baudrate (see setSPITFPBaudrateConfig()).

Regulatory testing is done with the default baudrate. If CE compatibility or similar is necessary in your applications we recommend to not change the baudrate.

long BrickletIsolator.getSPITFPBaudrate()¶

Returns:	baudrate – Type: long, Unit: 1 Bd, Range: [400000 to 2000000], Default: 1400000

Returns the baudrate, see setSPITFPBaudrate().

BrickletIsolator.IsolatorSPITFPErrorCount BrickletIsolator.getIsolatorSPITFPErrorCount()¶

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 Isolator Bricklet and the connected Bricklet. Call getSPITFPErrorCount() to get the error count between Isolator Bricklet and Brick.

The errors are divided into

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

BrickletIsolator.SPITFPErrorCount BrickletIsolator.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 BrickletIsolator.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:

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

int BrickletIsolator.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:

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

int BrickletIsolator.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 BrickletIsolator.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!

BrickletIsolator.Identity BrickletIsolator.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 BrickletIsolator.setStatisticsCallbackConfiguration(long period, boolean valueHasToChange)¶

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

The period is the period with which the StatisticsListener 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.

New in version 2.0.2 (Plugin).

BrickletIsolator.StatisticsCallbackConfiguration BrickletIsolator.getStatisticsCallbackConfiguration()¶

Return Object:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: boolean, Default: false

Returns the listener configuration as set by setStatisticsCallbackConfiguration().

New in version 2.0.2 (Plugin).

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 BrickletIsolator.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 BrickletIsolator.StatisticsListener()¶

This listener can be added with the addStatisticsListener() function. An added listener can be removed with the removeStatisticsListener() function.

void statistics(long messagesFromBrick, long messagesFromBricklet, int connectedBrickletDeviceIdentifier, String connectedBrickletUID)

Parameters:	messagesFromBrick – Type: long, Range: [0 to 232 - 1] messagesFromBricklet – Type: long, Range: [0 to 232 - 1] connectedBrickletDeviceIdentifier – Type: int, Range: [0 to 216 - 1] connectedBrickletUID – Type: String, Length: up to 8

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

The parameters are the same as getStatistics().

New in version 2.0.2 (Plugin).

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

• BrickletIsolator.FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 2
• BrickletIsolator.FUNCTION_SET_SPITFP_BAUDRATE = 4
• BrickletIsolator.FUNCTION_SET_STATISTICS_CALLBACK_CONFIGURATION = 7
• BrickletIsolator.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletIsolator.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletIsolator.FUNCTION_RESET = 243
• BrickletIsolator.FUNCTION_WRITE_UID = 248

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

• BrickletIsolator.FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 2
• BrickletIsolator.FUNCTION_SET_SPITFP_BAUDRATE = 4
• BrickletIsolator.FUNCTION_SET_STATISTICS_CALLBACK_CONFIGURATION = 7
• BrickletIsolator.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletIsolator.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletIsolator.FUNCTION_RESET = 243
• BrickletIsolator.FUNCTION_WRITE_UID = 248

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

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

For status:

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

int BrickletIsolator.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:

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

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

This constant is used to identify a Isolator 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 BrickletIsolator.DEVICE_DISPLAY_NAME¶

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