Software / API Bindings / C/C++ / API Reference and Examples / Bricklets / Isolator Bricklet

C/C++ - Isolator Bricklet¶

This is the description of the C/C++ API bindings for the Isolator Bricklet. General information and technical specifications for the Isolator Bricklet are summarized in its hardware description.

An installation guide for the C/C++ API bindings is part of their general description.

Examples¶

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

Simple¶

Download (example_simple.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_isolator.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Isolator Bricklet

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    Isolator i;
    isolator_create(&i, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Get current statistics
    uint32_t messages_from_brick, messages_from_bricklet;
    uint16_t connected_bricklet_device_identifier; char connected_bricklet_uid[8];
    if(isolator_get_statistics(&i, &messages_from_brick, &messages_from_bricklet,
                               &connected_bricklet_device_identifier,
                               connected_bricklet_uid) < 0) {
        fprintf(stderr, "Could not get statistics, probably timeout\n");
        return 1;
    }

    printf("Messages From Brick: %u\n", messages_from_brick);
    printf("Messages From Bricklet: %u\n", messages_from_bricklet);
    printf("Connected Bricklet Device Identifier: %u\n", connected_bricklet_device_identifier);
    printf("Connected Bricklet UID: %s\n", connected_bricklet_uid);

    printf("Press key to exit\n");
    getchar();
    isolator_destroy(&i);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

API¶

Most functions of the C/C++ bindings return an error code (e_code). Data returned from the device, when a getter is called, is handled via output parameters. These parameters are labeled with the ret_ prefix.

Possible error codes are:

E_OK = 0
E_TIMEOUT = -1
E_NO_STREAM_SOCKET = -2
E_HOSTNAME_INVALID = -3
E_NO_CONNECT = -4
E_NO_THREAD = -5
E_NOT_ADDED = -6 (unused since C/C++ bindings version 2.0.0)
E_ALREADY_CONNECTED = -7
E_NOT_CONNECTED = -8
E_INVALID_PARAMETER = -9
E_NOT_SUPPORTED = -10
E_UNKNOWN_ERROR_CODE = -11
E_STREAM_OUT_OF_SYNC = -12
E_INVALID_UID = -13
E_NON_ASCII_CHAR_IN_SECRET = -14
E_WRONG_DEVICE_TYPE = -15
E_DEVICE_REPLACED = -16
E_WRONG_RESPONSE_LENGTH = -17

as defined in ip_connection.h.

All functions listed below are thread-safe.

Basic Functions¶

void isolator_create(Isolator *isolator, const char *uid, IPConnection *ipcon)¶

Parameters:	isolator – Type: Isolator * uid – Type: const char * ipcon – Type: IPConnection *

Creates the device object isolator with the unique device ID uid and adds it to the IPConnection ipcon:

Isolator isolator;
isolator_create(&isolator, "YOUR_DEVICE_UID", &ipcon);

This device object can be used after the IP connection has been connected.

void isolator_destroy(Isolator *isolator)¶

Parameters:	isolator – Type: Isolator *

Removes the device object isolator from its IPConnection and destroys it. The device object cannot be used anymore afterwards.

int isolator_get_statistics(Isolator *isolator, uint32_t *ret_messages_from_brick, uint32_t *ret_messages_from_bricklet, uint16_t *ret_connected_bricklet_device_identifier, char ret_connected_bricklet_uid[8])¶

Parameters:	isolator – Type: Isolator *
Output Parameters:	ret_messages_from_brick – Type: uint32_t, Range: [0 to 2³² - 1] ret_messages_from_bricklet – Type: uint32_t, Range: [0 to 2³² - 1] ret_connected_bricklet_device_identifier – Type: uint16_t, Range: [0 to 2¹⁶ - 1] ret_connected_bricklet_uid – Type: char[8]
Returns:	e_code – Type: int

Returns statistics for the Isolator Bricklet.

Advanced Functions¶

int isolator_set_spitfp_baudrate_config(Isolator *isolator, bool enable_dynamic_baudrate, uint32_t minimum_dynamic_baudrate)¶

Parameters:	isolator – Type: Isolator * enable_dynamic_baudrate – Type: bool, Default: true minimum_dynamic_baudrate – Type: uint32_t, Unit: 1 Bd, Range: [400000 to 2000000], Default: 400000
Returns:	e_code – Type: int

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 isolator_set_spitfp_baudrate(). If the dynamic baudrate is disabled, the baudrate as set by isolator_set_spitfp_baudrate() will be used statically.

int isolator_get_spitfp_baudrate_config(Isolator *isolator, bool *ret_enable_dynamic_baudrate, uint32_t *ret_minimum_dynamic_baudrate)¶

Parameters:	isolator – Type: Isolator *
Output Parameters:	ret_enable_dynamic_baudrate – Type: bool, Default: true ret_minimum_dynamic_baudrate – Type: uint32_t, Unit: 1 Bd, Range: [400000 to 2000000], Default: 400000
Returns:	e_code – Type: int

Returns the baudrate config, see isolator_set_spitfp_baudrate_config().

int isolator_set_spitfp_baudrate(Isolator *isolator, uint32_t baudrate)¶

Parameters:	isolator – Type: Isolator * baudrate – Type: uint32_t, Unit: 1 Bd, Range: [400000 to 2000000], Default: 1400000
Returns:	e_code – Type: int

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 isolator_get_spitfp_error_count()) you can decrease the baudrate.

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

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.

int isolator_get_spitfp_baudrate(Isolator *isolator, uint32_t *ret_baudrate)¶

Parameters:	isolator – Type: Isolator *
Output Parameters:	ret_baudrate – Type: uint32_t, Unit: 1 Bd, Range: [400000 to 2000000], Default: 1400000
Returns:	e_code – Type: int

Returns the baudrate, see isolator_set_spitfp_baudrate().

int isolator_get_isolator_spitfp_error_count(Isolator *isolator, uint32_t *ret_error_count_ack_checksum, uint32_t *ret_error_count_message_checksum, uint32_t *ret_error_count_frame, uint32_t *ret_error_count_overflow)¶

Parameters:	isolator – Type: Isolator *
Output Parameters:	ret_error_count_ack_checksum – Type: uint32_t, Range: [0 to 2³² - 1] ret_error_count_message_checksum – Type: uint32_t, Range: [0 to 2³² - 1] ret_error_count_frame – Type: uint32_t, Range: [0 to 2³² - 1] ret_error_count_overflow – Type: uint32_t, Range: [0 to 2³² - 1]
Returns:	e_code – Type: int

Returns the error count for the communication between Isolator Bricklet and the connected Bricklet. Call isolator_get_spitfp_error_count() 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.

int isolator_get_spitfp_error_count(Isolator *isolator, uint32_t *ret_error_count_ack_checksum, uint32_t *ret_error_count_message_checksum, uint32_t *ret_error_count_frame, uint32_t *ret_error_count_overflow)¶

Parameters:	isolator – Type: Isolator *
Output Parameters:	ret_error_count_ack_checksum – Type: uint32_t, Range: [0 to 2³² - 1] ret_error_count_message_checksum – Type: uint32_t, Range: [0 to 2³² - 1] ret_error_count_frame – Type: uint32_t, Range: [0 to 2³² - 1] ret_error_count_overflow – Type: uint32_t, Range: [0 to 2³² - 1]
Returns:	e_code – Type: int

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.

int isolator_set_status_led_config(Isolator *isolator, uint8_t config)¶

Parameters:	isolator – Type: Isolator * config – Type: uint8_t, Range: See constants, Default: 3
Returns:	e_code – Type: int

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:

ISOLATOR_STATUS_LED_CONFIG_OFF = 0
ISOLATOR_STATUS_LED_CONFIG_ON = 1
ISOLATOR_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
ISOLATOR_STATUS_LED_CONFIG_SHOW_STATUS = 3

int isolator_get_status_led_config(Isolator *isolator, uint8_t *ret_config)¶

Parameters:	isolator – Type: Isolator *
Output Parameters:	ret_config – Type: uint8_t, Range: See constants, Default: 3
Returns:	e_code – Type: int

Returns the configuration as set by isolator_set_status_led_config()

The following constants are available for this function:

For ret_config:

ISOLATOR_STATUS_LED_CONFIG_OFF = 0
ISOLATOR_STATUS_LED_CONFIG_ON = 1
ISOLATOR_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
ISOLATOR_STATUS_LED_CONFIG_SHOW_STATUS = 3

int isolator_get_chip_temperature(Isolator *isolator, int16_t *ret_temperature)¶

Parameters:	isolator – Type: Isolator *
Output Parameters:	ret_temperature – Type: int16_t, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 1]
Returns:	e_code – Type: int

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.

int isolator_reset(Isolator *isolator)¶

Parameters:	isolator – Type: Isolator *
Returns:	e_code – Type: int

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!

int isolator_get_identity(Isolator *isolator, char ret_uid[8], char ret_connected_uid[8], char *ret_position, uint8_t ret_hardware_version[3], uint8_t ret_firmware_version[3], uint16_t *ret_device_identifier)¶

Parameters:	isolator – Type: Isolator *
Output Parameters:	ret_uid – Type: char[8] ret_connected_uid – Type: char[8] ret_position – Type: char, Range: ['a' to 'h', 'z'] ret_hardware_version – Type: uint8_t[3] 0: major – Type: uint8_t, Range: [0 to 255] 1: minor – Type: uint8_t, Range: [0 to 255] 2: revision – Type: uint8_t, Range: [0 to 255] ret_firmware_version – Type: uint8_t[3] 0: major – Type: uint8_t, Range: [0 to 255] 1: minor – Type: uint8_t, Range: [0 to 255] 2: revision – Type: uint8_t, Range: [0 to 255] ret_device_identifier – Type: uint16_t, Range: [0 to 2¹⁶ - 1]
Returns:	e_code – Type: int

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 isolator_register_callback(Isolator *isolator, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameters:	isolator – Type: Isolator * callback_id – Type: int16_t function – Type: void ()(void) user_data* – Type: void *

Registers the given function with the given callback_id. The user_data will be passed as the last parameter to the function.

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

int isolator_set_statistics_callback_configuration(Isolator *isolator, uint32_t period, bool value_has_to_change)¶

Parameters:	isolator – Type: Isolator * period – Type: uint32_t, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false
Returns:	e_code – Type: int

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

New in version 2.0.2 (Plugin).

int isolator_get_statistics_callback_configuration(Isolator *isolator, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameters:	isolator – Type: Isolator *
Output Parameters:	ret_period – Type: uint32_t, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 ret_value_has_to_change – Type: bool, Default: false
Returns:	e_code – Type: int

Returns the callback configuration as set by isolator_set_statistics_callback_configuration().

New in version 2.0.2 (Plugin).

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the isolator_register_callback() function:

void my_callback(int value, void *user_data) {
    printf("Value: %d\n", value);
}

isolator_register_callback(&isolator,
                           ISOLATOR_CALLBACK_EXAMPLE,
                           (void (*)(void))my_callback,
                           NULL);

The available constants with corresponding function signatures 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.

ISOLATOR_CALLBACK_STATISTICS¶

void callback(uint32_t messages_from_brick, uint32_t messages_from_bricklet, uint16_t connected_bricklet_device_identifier, char connected_bricklet_uid[8], void *user_data)

Callback Parameters:	messages_from_brick – Type: uint32_t, Range: [0 to 2³² - 1] messages_from_bricklet – Type: uint32_t, Range: [0 to 2³² - 1] connected_bricklet_device_identifier – Type: uint16_t, Range: [0 to 2¹⁶ - 1] connected_bricklet_uid – Type: char[8] user_data – Type: void *

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

The parameters are the same as isolator_get_statistics().

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.

int isolator_get_api_version(Isolator *isolator, uint8_t ret_api_version[3])¶

Parameters:	isolator – Type: Isolator *
Output Parameters:	ret_api_version – Type: uint8_t[3] 0: major – Type: uint8_t, Range: [0 to 255] 1: minor – Type: uint8_t, Range: [0 to 255] 2: revision – Type: uint8_t, Range: [0 to 255]
Returns:	e_code – Type: int

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.

int isolator_get_response_expected(Isolator *isolator, uint8_t function_id, bool *ret_response_expected)¶

Parameters:	isolator – Type: Isolator * function_id – Type: uint8_t, Range: See constants
Output Parameters:	ret_response_expected – Type: bool
Returns:	e_code – Type: int

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 isolator_set_response_expected(). 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:

ISOLATOR_FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 2
ISOLATOR_FUNCTION_SET_SPITFP_BAUDRATE = 4
ISOLATOR_FUNCTION_SET_STATISTICS_CALLBACK_CONFIGURATION = 7
ISOLATOR_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
ISOLATOR_FUNCTION_SET_STATUS_LED_CONFIG = 239
ISOLATOR_FUNCTION_RESET = 243
ISOLATOR_FUNCTION_WRITE_UID = 248

int isolator_set_response_expected(Isolator *isolator, uint8_t function_id, bool response_expected)¶

Parameters:	isolator – Type: Isolator * function_id – Type: uint8_t, Range: See constants response_expected – Type: bool
Returns:	e_code – Type: int

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:

ISOLATOR_FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 2
ISOLATOR_FUNCTION_SET_SPITFP_BAUDRATE = 4
ISOLATOR_FUNCTION_SET_STATISTICS_CALLBACK_CONFIGURATION = 7
ISOLATOR_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
ISOLATOR_FUNCTION_SET_STATUS_LED_CONFIG = 239
ISOLATOR_FUNCTION_RESET = 243
ISOLATOR_FUNCTION_WRITE_UID = 248

int isolator_set_response_expected_all(Isolator *isolator, bool response_expected)¶

Parameters:	isolator – Type: Isolator * response_expected – Type: bool
Returns:	e_code – Type: int

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.

int isolator_set_bootloader_mode(Isolator *isolator, uint8_t mode, uint8_t *ret_status)¶

Parameters:	isolator – Type: Isolator * mode – Type: uint8_t, Range: See constants
Output Parameters:	ret_status – Type: uint8_t, Range: See constants
Returns:	e_code – Type: int

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:

ISOLATOR_BOOTLOADER_MODE_BOOTLOADER = 0
ISOLATOR_BOOTLOADER_MODE_FIRMWARE = 1
ISOLATOR_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
ISOLATOR_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
ISOLATOR_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For ret_status:

ISOLATOR_BOOTLOADER_STATUS_OK = 0
ISOLATOR_BOOTLOADER_STATUS_INVALID_MODE = 1
ISOLATOR_BOOTLOADER_STATUS_NO_CHANGE = 2
ISOLATOR_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
ISOLATOR_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
ISOLATOR_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int isolator_get_bootloader_mode(Isolator *isolator, uint8_t *ret_mode)¶

Parameters:	isolator – Type: Isolator *
Output Parameters:	ret_mode – Type: uint8_t, Range: See constants
Returns:	e_code – Type: int

Returns the current bootloader mode, see isolator_set_bootloader_mode().

The following constants are available for this function:

For ret_mode:

ISOLATOR_BOOTLOADER_MODE_BOOTLOADER = 0
ISOLATOR_BOOTLOADER_MODE_FIRMWARE = 1
ISOLATOR_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
ISOLATOR_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
ISOLATOR_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int isolator_set_write_firmware_pointer(Isolator *isolator, uint32_t pointer)¶

Parameters:	isolator – Type: Isolator * pointer – Type: uint32_t, Unit: 1 B, Range: [0 to 2³² - 1]
Returns:	e_code – Type: int

Sets the firmware pointer for isolator_write_firmware(). 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 isolator_write_firmware(Isolator *isolator, uint8_t data[64], uint8_t *ret_status)¶

Parameters:	isolator – Type: Isolator * data – Type: uint8_t[64], Range: [0 to 255]
Output Parameters:	ret_status – Type: uint8_t, Range: [0 to 255]
Returns:	e_code – Type: int

Writes 64 Bytes of firmware at the position as written by isolator_set_write_firmware_pointer() 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.

int isolator_write_uid(Isolator *isolator, uint32_t uid)¶

Parameters:	isolator – Type: Isolator * uid – Type: uint32_t, Range: [0 to 2³² - 1]
Returns:	e_code – Type: int

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.

int isolator_read_uid(Isolator *isolator, uint32_t *ret_uid)¶

Parameters:	isolator – Type: Isolator *
Output Parameters:	ret_uid – Type: uint32_t, Range: [0 to 2³² - 1]
Returns:	e_code – Type: int

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

Constants¶

ISOLATOR_DEVICE_IDENTIFIER¶

This constant is used to identify a Isolator Bricklet.

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

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