Software / API Bindings / JavaScript / API Reference and Examples / Bricklets / XMC1400 Breakout Bricklet

JavaScript - XMC1400 Breakout Bricklet¶

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

Examples¶

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

GPIO (Node.js)¶

Download (ExampleGPIO.js)

var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your XMC1400 Breakout Bricklet

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var xb = new Tinkerforge.BrickletXMC1400Breakout(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // Set Port 1, Pin 0 alternating high/low for 5 times with 1s delay
        for(var i = 0; i < 5; ++i) {
            setTimeout(function () {
                xb.setGPIOConfig(1, 0,
                                 Tinkerforge.BrickletXMC1400Breakout.GPIO_MODE_OUTPUT_PUSH_PULL,
                                 0, false);
            }, 2000 * i + 1000);
            setTimeout(function () {
                xb.setGPIOConfig(1, 0,
                                 Tinkerforge.BrickletXMC1400Breakout.GPIO_MODE_OUTPUT_PUSH_PULL,
                                 0, true);
            }, 2000 * i + 2000);
        }
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

GPIO (HTML)¶

Download (ExampleGPIO.html), Test (ExampleGPIO.html)

<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>XMC1400 Breakout Bricklet GPIO Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var xb = new Tinkerforge.BrickletXMC1400Breakout(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // Set Port 1, Pin 0 alternating high/low for 5 times with 1s delay
                        for(var i = 0; i < 5; ++i) {
                            setTimeout(function () {
                                xb.setGPIOConfig(1, 0,
                                                 Tinkerforge.BrickletXMC1400Breakout.GPIO_MODE_OUTPUT_PUSH_PULL,
                                                 0, false);
                            }, 2000 * i + 1000);
                            setTimeout(function () {
                                xb.setGPIOConfig(1, 0,
                                                 Tinkerforge.BrickletXMC1400Breakout.GPIO_MODE_OUTPUT_PUSH_PULL,
                                                 0, true);
                            }, 2000 * i + 2000);
                        }
                    }
                );
            }
        </script>
    </body>
</html>

API¶

Generally, every function of the JavaScript bindings can take two optional parameters, returnCallback and errorCallback. These are two user defined callback functions. The returnCallback function is called with the results as arguments, if the function returns its results asynchronously. The errorCallback is called with an error code in case of an error. The error code can be one of the following values:

IPConnection.ERROR_ALREADY_CONNECTED = 11
IPConnection.ERROR_NOT_CONNECTED = 12
IPConnection.ERROR_CONNECT_FAILED = 13
IPConnection.ERROR_INVALID_FUNCTION_ID = 21
IPConnection.ERROR_TIMEOUT = 31
IPConnection.ERROR_INVALID_PARAMETER = 41
IPConnection.ERROR_FUNCTION_NOT_SUPPORTED = 42
IPConnection.ERROR_UNKNOWN_ERROR = 43
IPConnection.ERROR_STREAM_OUT_OF_SYNC = 51
IPConnection.ERROR_NON_ASCII_CHAR_IN_SECRET = 71
IPConnection.ERROR_WRONG_DEVICE_TYPE = 81
IPConnection.ERROR_DEVICE_REPLACED = 82
IPConnection.ERROR_WRONG_RESPONSE_LENGTH = 83
IPConnection.ERROR_INT64_NOT_SUPPORTED = 91

The namespace for the JavaScript bindings is Tinkerforge.*.

Basic Functions¶

new BrickletXMC1400Breakout(uid, ipcon)¶

Parameters:	uid – Type: string ipcon – Type: IPConnection
Returns:	xmc1400Breakout – Type: BrickletXMC1400Breakout

Creates an object with the unique device ID uid:

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

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

BrickletXMC1400Breakout.setGPIOConfig(port, pin, mode, inputHysteresis, outputLevel[, returnCallback][, errorCallback])¶

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
Callback Parameters:	undefined
Returns:	undefined

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 input_hysteresis:

BrickletXMC1400Breakout.GPIO_INPUT_HYSTERESIS_STANDARD = 0
BrickletXMC1400Breakout.GPIO_INPUT_HYSTERESIS_LARGE = 4

BrickletXMC1400Breakout.getGPIOInput(port, pin[, returnCallback][, errorCallback])¶

Parameters:	port – Type: int, Range: [0 to 4] pin – Type: int, Range: ?
Callback Parameters:	value – Type: boolean
Returns:	undefined

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

BrickletXMC1400Breakout.setADCChannelConfig(channel, enable[, returnCallback][, errorCallback])¶

Parameters:	channel – Type: int, Range: [0 to 7] enable – Type: boolean
Callback Parameters:	undefined
Returns:	undefined

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

BrickletXMC1400Breakout.getADCChannelConfig(channel[, returnCallback][, errorCallback])¶

Parameters:	channel – Type: int, Range: [0 to 7]
Callback Parameters:	enable – Type: boolean
Returns:	undefined

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

BrickletXMC1400Breakout.getADCChannelValue(channel[, returnCallback][, errorCallback])¶

Parameters:	channel – Type: int, Range: [0 to 7]
Callback Parameters:	value – Type: int, Range: [0 to 2¹² - 1]
Returns:	undefined

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

BrickletXMC1400Breakout.getADCValues([returnCallback][, errorCallback])¶

Callback Parameters:	values – Type: [int, ...], Length: 8, Range: [0 to 2¹² - 1]
Returns:	undefined

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

This example function also has a corresponding callback.

See setADCValuesCallbackConfiguration() and CALLBACK_ADC_VALUES callback.

BrickletXMC1400Breakout.getCount([returnCallback][, errorCallback])¶

Callback Parameters:	count – Type: int, Range: [0 to 2³² - 1]
Returns:	undefined

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 CALLBACK_COUNT callback. You can set the callback configuration with setCountCallbackConfiguration().

Advanced Functions¶

BrickletXMC1400Breakout.getSPITFPErrorCount([returnCallback][, errorCallback])¶

Callback Parameters:	errorCountAckChecksum – Type: int, Range: [0 to 2³² - 1] errorCountMessageChecksum – Type: int, Range: [0 to 2³² - 1] errorCountFrame – Type: int, Range: [0 to 2³² - 1] errorCountOverflow – Type: int, Range: [0 to 2³² - 1]
Returns:	undefined

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.

BrickletXMC1400Breakout.setStatusLEDConfig(config[, returnCallback][, errorCallback])¶

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

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

BrickletXMC1400Breakout.getStatusLEDConfig([returnCallback][, errorCallback])¶

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

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

BrickletXMC1400Breakout.getChipTemperature([returnCallback][, errorCallback])¶

Callback Parameters:	temperature – Type: int, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 1]
Returns:	undefined

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.

BrickletXMC1400Breakout.reset([returnCallback][, errorCallback])¶

Callback Parameters:	undefined
Returns:	undefined

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.getIdentity([returnCallback][, errorCallback])¶

Callback Parameters:

Callback 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: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] firmwareVersion – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] deviceIdentifier – Type: int, Range: [0 to 2¹⁶ - 1]
Returns:	undefined

uid – Type: string, Length: up to 8
connectedUid – Type: string, Length: up to 8
position – Type: char, Range: ['a' to 'h', 'z']
hardwareVersion – Type: [int, ...], Length: 3

0: major – Type: int, Range: [0 to 255]
1: minor – Type: int, Range: [0 to 255]
2: revision – Type: int, Range: [0 to 255]

firmwareVersion – Type: [int, ...], Length: 3

0: major – Type: int, Range: [0 to 255]
1: minor – Type: int, Range: [0 to 255]
2: revision – Type: int, Range: [0 to 255]

deviceIdentifier – Type: int, Range: [0 to 2¹⁶ - 1]

Returns:

undefined

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¶

BrickletXMC1400Breakout.on(callback_id, function[, errorCallback])¶

Parameters:	callback_id – Type: int function – Type: function
Returns:	undefined

Registers the given function with the given callback_id.

The available callback IDs with corresponding function signatures are listed below.

BrickletXMC1400Breakout.setADCValuesCallbackConfiguration(period, valueHasToChange[, returnCallback][, errorCallback])¶

Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false
Callback Parameters:	undefined
Returns:	undefined

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

BrickletXMC1400Breakout.getADCValuesCallbackConfiguration([returnCallback][, errorCallback])¶

Callback Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false
Returns:	undefined

Returns the callback configuration as set by setADCValuesCallbackConfiguration().

BrickletXMC1400Breakout.setCountCallbackConfiguration(period, valueHasToChange, option, min, max[, returnCallback][, errorCallback])¶

Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: int, Range: [0 to 2³² - 1], Default: 0 max – Type: int, Range: [0 to 2³² - 1], Default: 0
Callback Parameters:	undefined
Returns:	undefined

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

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 CALLBACK_COUNT 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 = '>'

BrickletXMC1400Breakout.getCountCallbackConfiguration([returnCallback][, errorCallback])¶

Callback Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: int, Range: [0 to 2³² - 1], Default: 0 max – Type: int, Range: [0 to 2³² - 1], Default: 0
Returns:	undefined

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 with the on() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

xmc1400Breakout.on(BrickletXMC1400Breakout.CALLBACK_EXAMPLE,
    function (param) {
        console.log(param);
    }
);

The available constants with inherent number and type of parameters 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.

BrickletXMC1400Breakout.CALLBACK_ADC_VALUES¶

Callback Parameters:	values – Type: [int, ...], Length: 8, Range: [0 to 2¹² - 1]

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

The parameters are the same as getADCValues().

BrickletXMC1400Breakout.CALLBACK_COUNT¶

Callback Parameters:	count – Type: int, Range: [0 to 2³² - 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.

BrickletXMC1400Breakout.getAPIVersion()¶

Returns:	apiVersion – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, 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.

BrickletXMC1400Breakout.getResponseExpected(functionId[, errorCallback])¶

Parameters:	functionId – Type: int, 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 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 function_id:

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

BrickletXMC1400Breakout.setResponseExpected(functionId, responseExpected[, errorCallback])¶

Parameters:	functionId – Type: int, Range: See constants responseExpected – Type: boolean
Returns:	undefined

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.

The following constants are available for this function:

For function_id:

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

BrickletXMC1400Breakout.setResponseExpectedAll(responseExpected)¶

Parameters:	responseExpected – Type: boolean
Returns:	undefined

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.

BrickletXMC1400Breakout.setBootloaderMode(mode[, returnCallback][, errorCallback])¶

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

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

BrickletXMC1400Breakout.getBootloaderMode([returnCallback][, errorCallback])¶

Callback Parameters:	mode – Type: int, Range: See constants
Returns:	undefined

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

BrickletXMC1400Breakout.setWriteFirmwarePointer(pointer[, returnCallback][, errorCallback])¶

Parameters:	pointer – Type: int, Unit: 1 B, Range: [0 to 2³² - 1]
Callback Parameters:	undefined
Returns:	undefined

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.

BrickletXMC1400Breakout.writeFirmware(data[, returnCallback][, errorCallback])¶

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

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.

BrickletXMC1400Breakout.writeUID(uid[, returnCallback][, errorCallback])¶

Parameters:	uid – Type: int, Range: [0 to 2³² - 1]
Callback Parameters:	undefined
Returns:	undefined

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.

BrickletXMC1400Breakout.readUID([returnCallback][, errorCallback])¶

Callback Parameters:	uid – Type: int, Range: [0 to 2³² - 1]
Returns:	undefined

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

Constants¶

BrickletXMC1400Breakout.DEVICE_IDENTIFIER¶

This constant is used to identify a XMC1400 Breakout Bricklet.

The getIdentity() function and the IPConnection.CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickletXMC1400Breakout.DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a XMC1400 Breakout Bricklet.