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

C# - XMC1400 Breakout Bricklet

This is the description of the C# 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 C# API bindings is part of their general description.

Examples

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

GPIO

Download (ExampleGPIO.cs)

 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
using System;
using System.Threading;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your XMC1400 Breakout Bricklet

    static void Main()
    {
        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);
        }

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

API

Generally, every method of the C# bindings that returns a value can throw a Tinkerforge.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 plugs the device out). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Since C# does not support multiple return values directly, we use the out keyword to return multiple values from a method.

The namespace for all Brick/Bricklet bindings and the IPConnection is 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(byte port, byte pin, byte mode, byte inputHysteresis, bool outputLevel)
Parameters:
  • port – Type: byte, Range: [0 to 4]
  • pin – Type: byte, Range: ?
  • mode – Type: byte, Range: See constants
  • inputHysteresis – Type: byte, Range: See constants
  • outputLevel – Type: bool

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
bool BrickletXMC1400Breakout.GetGPIOInput(byte port, byte pin)
Parameters:
  • port – Type: byte, Range: [0 to 4]
  • pin – Type: byte, Range: ?
Returns:
  • value – Type: bool

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

void BrickletXMC1400Breakout.SetADCChannelConfig(byte channel, bool enable)
Parameters:
  • channel – Type: byte, Range: [0 to 7]
  • enable – Type: bool

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
bool BrickletXMC1400Breakout.GetADCChannelConfig(byte channel)
Parameters:
  • channel – Type: byte, Range: [0 to 7]
Returns:
  • enable – Type: bool

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

int BrickletXMC1400Breakout.GetADCChannelValue(byte channel)
Parameters:
  • channel – Type: byte, 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 callback.

See SetADCValuesCallbackConfiguration() and ADCValuesCallback callback.

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 callback and callback 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 CountCallback callback. You can set the callback configuration with SetCountCallbackConfiguration().

Advanced Functions

void BrickletXMC1400Breakout.GetSPITFPErrorCount(out long errorCountAckChecksum, out long errorCountMessageChecksum, out long errorCountFrame, out long errorCountOverflow)
Output Parameters:
  • 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(byte config)
Parameters:
  • config – Type: byte, 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
byte BrickletXMC1400Breakout.GetStatusLEDConfig()
Returns:
  • config – Type: byte, 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
short BrickletXMC1400Breakout.GetChipTemperature()
Returns:
  • temperature – Type: short, 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!

void BrickletXMC1400Breakout.GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)
Output Parameters:
  • uid – Type: string, Length: up to 8
  • connectedUid – Type: string, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'z']
  • hardwareVersion – Type: byte[], Length: 3
    • 0: major – Type: byte, Range: [0 to 255]
    • 1: minor – Type: byte, Range: [0 to 255]
    • 2: revision – Type: byte, Range: [0 to 255]
  • firmwareVersion – Type: byte[], Length: 3
    • 0: major – Type: byte, Range: [0 to 255]
    • 1: minor – Type: byte, Range: [0 to 255]
    • 2: revision – Type: byte, 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.

Callback Configuration Functions

void BrickletXMC1400Breakout.SetADCValuesCallbackConfiguration(long period, bool valueHasToChange)
Parameters:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: bool, Default: false

The period is the period with which the ADCValuesCallback callback is triggered periodically. A value of 0 turns the callback off.

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

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

void BrickletXMC1400Breakout.GetADCValuesCallbackConfiguration(out long period, out bool valueHasToChange)
Output Parameters:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: bool, Default: false

Returns the callback configuration as set by SetADCValuesCallbackConfiguration().

void BrickletXMC1400Breakout.SetCountCallbackConfiguration(long period, bool valueHasToChange, char option, long min, long max)
Parameters:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: bool, 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 CountCallback callback is triggered periodically. A value of 0 turns the callback off.

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

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

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the CountCallback callback.

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 callback 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 = '>'
void BrickletXMC1400Breakout.GetCountCallbackConfiguration(out long period, out bool valueHasToChange, out char option, out long min, out long max)
Output Parameters:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: bool, 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 callback 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 = '>'

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by appending your callback handler to the corresponding event:

void MyCallback(BrickletXMC1400Breakout sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

xmc1400Breakout.ExampleCallback += MyCallback;

The available events are described below.

Note

Using callbacks 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.

event BrickletXMC1400Breakout.ADCValuesCallback(BrickletXMC1400Breakout sender, int[] values)
Callback Parameters:
  • sender – Type: BrickletXMC1400Breakout
  • values – Type: int[], Length: 8, Range: [0 to 212 - 1]

This callback is triggered periodically according to the configuration set by SetADCValuesCallbackConfiguration().

The parameters are the same as GetADCValues().

event BrickletXMC1400Breakout.CountCallback(BrickletXMC1400Breakout sender, long count)
Callback Parameters:
  • sender – Type: BrickletXMC1400Breakout
  • count – Type: long, Range: [0 to 232 - 1]

This callback 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.

byte[] BrickletXMC1400Breakout.GetAPIVersion()
Output Parameters:
  • apiVersion – Type: byte[], Length: 3
    • 0: major – Type: byte, Range: [0 to 255]
    • 1: minor – Type: byte, Range: [0 to 255]
    • 2: revision – Type: byte, 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.

bool BrickletXMC1400Breakout.GetResponseExpected(byte functionId)
Parameters:
  • functionId – Type: byte, Range: See constants
Returns:
  • responseExpected – Type: bool

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 callback 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, bool responseExpected)
Parameters:
  • functionId – Type: byte, Range: See constants
  • responseExpected – Type: bool

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 callback 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(bool responseExpected)
Parameters:
  • responseExpected – Type: bool

Changes the response expected flag for all setter and callback 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.

byte BrickletXMC1400Breakout.SetBootloaderMode(byte mode)
Parameters:
  • mode – Type: byte, Range: See constants
Returns:
  • status – Type: byte, 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
byte BrickletXMC1400Breakout.GetBootloaderMode()
Returns:
  • mode – Type: byte, 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.

byte BrickletXMC1400Breakout.WriteFirmware(byte[] data)
Parameters:
  • data – Type: byte[], Length: 64, Range: [0 to 255]
Returns:
  • status – Type: byte, 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.EnumerateCallback callback 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.