Deutsch
English
Menu
Software / API Bindings / Java / API Reference and Examples / Bricklets / XMC1400 Breakout Bricklet

Java - XMC1400 Breakout Bricklet

This is the description of the Java API bindings for the XMC1400 Breakout Bricklet. General information and technical specifications for the XMC1400 Breakout Bricklet are summarized in its hardware description.

An installation guide for the Java API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

GPIO

Download (ExampleGPIO.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.BrickletXMC1400Breakout;

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

    // Change XYZ to the UID of your XMC1400 Breakout 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
        BrickletXMC1400Breakout xb =
          new BrickletXMC1400Breakout(UID, ipcon); // Create device object

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

        // Set Port 1, Pin 0 alternating high/low for 5 times with 1s delay
        for(int i = 0; i < 5; i++) {
            Thread.sleep(1000);
            xb.setGPIOConfig(1, 0, BrickletXMC1400Breakout.GPIO_MODE_OUTPUT_PUSH_PULL, 0, false);
            Thread.sleep(1000);
            xb.setGPIOConfig(1, 0, BrickletXMC1400Breakout.GPIO_MODE_OUTPUT_PUSH_PULL, 0, true);
        }

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

API

Generally, every method of the Java bindings that returns a value can throw a TimeoutException. This exception gets thrown if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody unplugs the device). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Beside the TimeoutException there is also a NotConnectedException that is thrown if a method needs to communicate with the device while the IP Connection is not connected.

Since Java does not support multiple return values and return by reference is not possible for primitive types, we use small classes that only consist of member variables. The member variables of the returned objects are described in the corresponding method descriptions.

The package for all Brick/Bricklet bindings and the IP Connection is com.tinkerforge.*

All methods listed below are thread-safe.

Basic Functions

class BrickletXMC1400Breakout(String uid, IPConnection ipcon)
Parameters:
  • uid – Type: String
  • ipcon – Type: IPConnection
Returns:
  • xmc1400Breakout – Type: BrickletXMC1400Breakout

Creates an object with the unique device ID uid:

BrickletXMC1400Breakout xmc1400Breakout = new BrickletXMC1400Breakout("YOUR_DEVICE_UID", ipcon);

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

void BrickletXMC1400Breakout.setGPIOConfig(int port, int pin, int mode, int inputHysteresis, boolean outputLevel)
Parameters:
  • port – Type: int, Range: [0 to 4]
  • pin – Type: int, Range: ?
  • mode – Type: int, Range: See constants
  • inputHysteresis – Type: int, Range: See constants
  • outputLevel – Type: boolean

Example for a setter function. The values are the values that can be given to the XMC_GPIO_Init function. See communication.c in the firmware.

The following constants are available for this function:

For mode:

  • BrickletXMC1400Breakout.GPIO_MODE_INPUT_TRISTATE = 0
  • BrickletXMC1400Breakout.GPIO_MODE_INPUT_PULL_DOWN = 1
  • BrickletXMC1400Breakout.GPIO_MODE_INPUT_PULL_UP = 2
  • BrickletXMC1400Breakout.GPIO_MODE_INPUT_SAMPLING = 3
  • BrickletXMC1400Breakout.GPIO_MODE_INPUT_INVERTED_TRISTATE = 4
  • BrickletXMC1400Breakout.GPIO_MODE_INPUT_INVERTED_PULL_DOWN = 5
  • BrickletXMC1400Breakout.GPIO_MODE_INPUT_INVERTED_PULL_UP = 6
  • BrickletXMC1400Breakout.GPIO_MODE_INPUT_INVERTED_SAMPLING = 7
  • BrickletXMC1400Breakout.GPIO_MODE_OUTPUT_PUSH_PULL = 8
  • BrickletXMC1400Breakout.GPIO_MODE_OUTPUT_OPEN_DRAIN = 9

For inputHysteresis:

  • BrickletXMC1400Breakout.GPIO_INPUT_HYSTERESIS_STANDARD = 0
  • BrickletXMC1400Breakout.GPIO_INPUT_HYSTERESIS_LARGE = 4
boolean BrickletXMC1400Breakout.getGPIOInput(int port, int pin)
Parameters:
  • port – Type: int, Range: [0 to 4]
  • pin – Type: int, Range: ?
Returns:
  • value – Type: boolean

Example for a getter function. Returns the result of a XMC_GPIO_GetInput call for the given port/pin.

void BrickletXMC1400Breakout.setADCChannelConfig(int channel, boolean enable)
Parameters:
  • channel – Type: int, Range: [0 to 7]
  • enable – Type: boolean

Enables a ADC channel for the ADC driver example (adc.c/adc.h).

There are 8 ADC channels and they correspond to the following pins:

  • Channel 0: P2_6
  • Channel 1: P2_8
  • Channel 2: P2_9
  • Channel 3: P2_10
  • Channel 4: P2_11
  • Channel 5: P2_0
  • Channel 6: P2_1
  • Channel 7: P2_2
boolean BrickletXMC1400Breakout.getADCChannelConfig(int channel)
Parameters:
  • channel – Type: int, Range: [0 to 7]
Returns:
  • enable – Type: boolean

Returns the config for the given channel as set by setADCChannelConfig().

int BrickletXMC1400Breakout.getADCChannelValue(int channel)
Parameters:
  • channel – Type: int, Range: [0 to 7]
Returns:
  • value – Type: int, Range: [0 to 212 - 1]

Returns the 12-bit value of the given ADC channel of the ADC driver example.

int[] BrickletXMC1400Breakout.getADCValues()
Returns:
  • values – Type: int[], Length: 8, Range: [0 to 212 - 1]

Returns the values for all 8 ADC channels of the adc driver example.

This example function also has a corresponding listener.

See setADCValuesCallbackConfiguration() and ADCValuesListener listener.

long BrickletXMC1400Breakout.getCount()
Returns:
  • count – Type: long, Range: [0 to 232 - 1]

Returns the value of the example count (see example.c).

This example function uses the "add_callback_value_function"-helper in the generator. The getter as well as the listener and listener configuration functions are auto-generated for the API as well as the firmware.

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

Advanced Functions

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

  • BrickletXMC1400Breakout.STATUS_LED_CONFIG_OFF = 0
  • BrickletXMC1400Breakout.STATUS_LED_CONFIG_ON = 1
  • BrickletXMC1400Breakout.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletXMC1400Breakout.STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletXMC1400Breakout.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:

  • BrickletXMC1400Breakout.STATUS_LED_CONFIG_OFF = 0
  • BrickletXMC1400Breakout.STATUS_LED_CONFIG_ON = 1
  • BrickletXMC1400Breakout.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletXMC1400Breakout.STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletXMC1400Breakout.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 BrickletXMC1400Breakout.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!

BrickletXMC1400Breakout.Identity BrickletXMC1400Breakout.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 BrickletXMC1400Breakout.setADCValuesCallbackConfiguration(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 ADCValuesListener 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.

BrickletXMC1400Breakout.ADCValuesCallbackConfiguration BrickletXMC1400Breakout.getADCValuesCallbackConfiguration()
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 setADCValuesCallbackConfiguration().

void BrickletXMC1400Breakout.setCountCallbackConfiguration(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 CountListener 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 CountListener 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:

  • BrickletXMC1400Breakout.THRESHOLD_OPTION_OFF = 'x'
  • BrickletXMC1400Breakout.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletXMC1400Breakout.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletXMC1400Breakout.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletXMC1400Breakout.THRESHOLD_OPTION_GREATER = '>'
BrickletXMC1400Breakout.CountCallbackConfiguration BrickletXMC1400Breakout.getCountCallbackConfiguration()
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 setCountCallbackConfiguration().

The following constants are available for this function:

For option:

  • BrickletXMC1400Breakout.THRESHOLD_OPTION_OFF = 'x'
  • BrickletXMC1400Breakout.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletXMC1400Breakout.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletXMC1400Breakout.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletXMC1400Breakout.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 BrickletXMC1400Breakout.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.

Note

Using listeners for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

class BrickletXMC1400Breakout.ADCValuesListener()

This listener can be added with the addADCValuesListener() function. An added listener can be removed with the removeADCValuesListener() function.

void adcValues(int[] values)
Parameters:
  • values – Type: int[], Length: 8, Range: [0 to 212 - 1]

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

The parameters are the same as getADCValues().

class BrickletXMC1400Breakout.CountListener()

This listener can be added with the addCountListener() function. An added listener can be removed with the removeCountListener() function.

void count(long count)
Parameters:
  • count – Type: long, Range: [0 to 232 - 1]

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

The parameter is the same as getCount().

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

  • BrickletXMC1400Breakout.FUNCTION_SET_GPIO_CONFIG = 1
  • BrickletXMC1400Breakout.FUNCTION_SET_ADC_CHANNEL_CONFIG = 3
  • BrickletXMC1400Breakout.FUNCTION_SET_ADC_VALUES_CALLBACK_CONFIGURATION = 7
  • BrickletXMC1400Breakout.FUNCTION_SET_COUNT_CALLBACK_CONFIGURATION = 11
  • BrickletXMC1400Breakout.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletXMC1400Breakout.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletXMC1400Breakout.FUNCTION_RESET = 243
  • BrickletXMC1400Breakout.FUNCTION_WRITE_UID = 248
void BrickletXMC1400Breakout.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:

  • BrickletXMC1400Breakout.FUNCTION_SET_GPIO_CONFIG = 1
  • BrickletXMC1400Breakout.FUNCTION_SET_ADC_CHANNEL_CONFIG = 3
  • BrickletXMC1400Breakout.FUNCTION_SET_ADC_VALUES_CALLBACK_CONFIGURATION = 7
  • BrickletXMC1400Breakout.FUNCTION_SET_COUNT_CALLBACK_CONFIGURATION = 11
  • BrickletXMC1400Breakout.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletXMC1400Breakout.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletXMC1400Breakout.FUNCTION_RESET = 243
  • BrickletXMC1400Breakout.FUNCTION_WRITE_UID = 248
void BrickletXMC1400Breakout.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 BrickletXMC1400Breakout.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:

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

For status:

  • BrickletXMC1400Breakout.BOOTLOADER_STATUS_OK = 0
  • BrickletXMC1400Breakout.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletXMC1400Breakout.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletXMC1400Breakout.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletXMC1400Breakout.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletXMC1400Breakout.BOOTLOADER_STATUS_CRC_MISMATCH = 5
int BrickletXMC1400Breakout.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:

  • BrickletXMC1400Breakout.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletXMC1400Breakout.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletXMC1400Breakout.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletXMC1400Breakout.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletXMC1400Breakout.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletXMC1400Breakout.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 BrickletXMC1400Breakout.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 BrickletXMC1400Breakout.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 BrickletXMC1400Breakout.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 BrickletXMC1400Breakout.DEVICE_IDENTIFIER

This constant is used to identify a XMC1400 Breakout 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 BrickletXMC1400Breakout.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a XMC1400 Breakout Bricklet.