C/C++ - Industrial Analog Out Bricklet 2.0

This is the description of the C/C++ API bindings for the Industrial Analog Out Bricklet 2.0. General information and technical specifications for the Industrial Analog Out Bricklet 2.0 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 Current

Download (example_simple_current.c)

 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
34
35
36
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_industrial_analog_out_v2.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Industrial Analog Out Bricklet 2.0

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

    // Create device object
    IndustrialAnalogOutV2 iao;
    industrial_analog_out_v2_create(&iao, 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

    // Set output current to 4.5mA
    industrial_analog_out_v2_set_current(&iao, 4500);
    industrial_analog_out_v2_set_enabled(&iao, true);

    printf("Press key to exit\n");
    getchar();
    industrial_analog_out_v2_set_enabled(&iao, false);
    industrial_analog_out_v2_destroy(&iao);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Simple Voltage

Download (example_simple_voltage.c)

 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
34
35
36
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_industrial_analog_out_v2.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Industrial Analog Out Bricklet 2.0

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

    // Create device object
    IndustrialAnalogOutV2 iao;
    industrial_analog_out_v2_create(&iao, 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

    // Set output voltage to 3.3V
    industrial_analog_out_v2_set_voltage(&iao, 3300);
    industrial_analog_out_v2_set_enabled(&iao, true);

    printf("Press key to exit\n");
    getchar();
    industrial_analog_out_v2_set_enabled(&iao, false);
    industrial_analog_out_v2_destroy(&iao);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

API

Every function of the C/C++ bindings returns an integer which describes an error code. Data returned from the device, when a getter is called, is handled via call by reference. 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 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

as defined in ip_connection.h.

All functions listed below are thread-safe.

Basic Functions

void industrial_analog_out_v2_create(IndustrialAnalogOutV2 *industrial_analog_out_v2, const char *uid, IPConnection *ipcon)

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

IndustrialAnalogOutV2 industrial_analog_out_v2;
industrial_analog_out_v2_create(&industrial_analog_out_v2, "YOUR_DEVICE_UID", &ipcon);

This device object can be used after the IP connection has been connected (see examples above).

void industrial_analog_out_v2_destroy(IndustrialAnalogOutV2 *industrial_analog_out_v2)

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

int industrial_analog_out_v2_set_enabled(IndustrialAnalogOutV2 *industrial_analog_out_v2, bool enabled)

Enables/disables the output of voltage and current.

The default is disabled.

int industrial_analog_out_v2_get_enabled(IndustrialAnalogOutV2 *industrial_analog_out_v2, bool *ret_enabled)

Returns true if output of voltage and current is enabled, false otherwise.

int industrial_analog_out_v2_set_voltage(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint16_t voltage)

Sets the output voltage in mV.

The output voltage and output current are linked. Changing the output voltage also changes the output current.

int industrial_analog_out_v2_get_voltage(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint16_t *ret_voltage)

Returns the voltage as set by industrial_analog_out_v2_set_voltage().

int industrial_analog_out_v2_set_current(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint16_t current)

Sets the output current in µA.

The output current and output voltage are linked. Changing the output current also changes the output voltage.

int industrial_analog_out_v2_get_current(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint16_t *ret_current)

Returns the current as set by industrial_analog_out_v2_set_current().

int industrial_analog_out_v2_set_out_led_config(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint8_t config)

You can turn the Out LED off, on or show a heartbeat. You can also set the LED to "Out Status". In this mode the LED can either be turned on with a pre-defined threshold or the intensity of the LED can change with the output value (voltage or current).

You can configure the channel status behavior with industrial_analog_out_v2_set_out_led_status_config().

By default the LED is configured as "Out Status"

The following defines are available for this function:

  • INDUSTRIAL_ANALOG_OUT_V2_OUT_LED_CONFIG_OFF = 0
  • INDUSTRIAL_ANALOG_OUT_V2_OUT_LED_CONFIG_ON = 1
  • INDUSTRIAL_ANALOG_OUT_V2_OUT_LED_CONFIG_SHOW_HEARTBEAT = 2
  • INDUSTRIAL_ANALOG_OUT_V2_OUT_LED_CONFIG_SHOW_OUT_STATUS = 3
int industrial_analog_out_v2_get_out_led_config(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint8_t *ret_config)

Returns the Out LED configuration as set by industrial_analog_out_v2_set_out_led_config()

The following defines are available for this function:

  • INDUSTRIAL_ANALOG_OUT_V2_OUT_LED_CONFIG_OFF = 0
  • INDUSTRIAL_ANALOG_OUT_V2_OUT_LED_CONFIG_ON = 1
  • INDUSTRIAL_ANALOG_OUT_V2_OUT_LED_CONFIG_SHOW_HEARTBEAT = 2
  • INDUSTRIAL_ANALOG_OUT_V2_OUT_LED_CONFIG_SHOW_OUT_STATUS = 3
int industrial_analog_out_v2_set_out_led_status_config(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint16_t min, uint16_t max, uint8_t config)

Sets the Out LED status config. This config is used if the Out LED is configured as "Out Status", see industrial_analog_out_v2_set_out_led_config().

For each channel you can choose between threshold and intensity mode.

In threshold mode you can define a positive or a negative threshold. For a positive threshold set the "min" parameter to the threshold value in mV or µA above which the LED should turn on and set the "max" parameter to 0. Example: If you set a positive threshold of 5V, the LED will turn on as soon as the output value exceeds 5V and turn off again if it goes below 5V. For a negative threshold set the "max" parameter to the threshold value in mV or µA below which the LED should turn on and set the "min" parameter to 0. Example: If you set a negative threshold of 5V, the LED will turn on as soon as the output value goes below 5V and the LED will turn off when the output value exceeds 5V.

In intensity mode you can define a range mV or µA that is used to scale the brightness of the LED. Example with min=2V, max=8V: The LED is off at 2V and below, on at 8V and above and the brightness is linearly scaled between the values 2V and 8V. If the min value is greater than the max value, the LED brightness is scaled the other way around.

By default the channel LED status config is set to intensity with min=0V and max=10V.

The following defines are available for this function:

  • INDUSTRIAL_ANALOG_OUT_V2_OUT_LED_STATUS_CONFIG_THRESHOLD = 0
  • INDUSTRIAL_ANALOG_OUT_V2_OUT_LED_STATUS_CONFIG_INTENSITY = 1
int industrial_analog_out_v2_get_out_led_status_config(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint16_t *ret_min, uint16_t *ret_max, uint8_t *ret_config)

Returns the Out LED status configuration as set by industrial_analog_out_v2_set_out_led_status_config().

The following defines are available for this function:

  • INDUSTRIAL_ANALOG_OUT_V2_OUT_LED_STATUS_CONFIG_THRESHOLD = 0
  • INDUSTRIAL_ANALOG_OUT_V2_OUT_LED_STATUS_CONFIG_INTENSITY = 1

Advanced Functions

int industrial_analog_out_v2_set_configuration(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint8_t voltage_range, uint8_t current_range)

Configures the voltage and current range.

Possible voltage ranges are:

  • 0V to 5V
  • 0V to 10V (default)

Possible current ranges are:

  • 4mA to 20mA (default)
  • 0mA to 20mA
  • 0mA to 24mA

The resolution will always be 12 bit. This means, that the precision is higher with a smaller range.

The following defines are available for this function:

  • INDUSTRIAL_ANALOG_OUT_V2_VOLTAGE_RANGE_0_TO_5V = 0
  • INDUSTRIAL_ANALOG_OUT_V2_VOLTAGE_RANGE_0_TO_10V = 1
  • INDUSTRIAL_ANALOG_OUT_V2_CURRENT_RANGE_4_TO_20MA = 0
  • INDUSTRIAL_ANALOG_OUT_V2_CURRENT_RANGE_0_TO_20MA = 1
  • INDUSTRIAL_ANALOG_OUT_V2_CURRENT_RANGE_0_TO_24MA = 2
int industrial_analog_out_v2_get_configuration(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint8_t *ret_voltage_range, uint8_t *ret_current_range)

Returns the configuration as set by industrial_analog_out_v2_set_configuration().

The following defines are available for this function:

  • INDUSTRIAL_ANALOG_OUT_V2_VOLTAGE_RANGE_0_TO_5V = 0
  • INDUSTRIAL_ANALOG_OUT_V2_VOLTAGE_RANGE_0_TO_10V = 1
  • INDUSTRIAL_ANALOG_OUT_V2_CURRENT_RANGE_4_TO_20MA = 0
  • INDUSTRIAL_ANALOG_OUT_V2_CURRENT_RANGE_0_TO_20MA = 1
  • INDUSTRIAL_ANALOG_OUT_V2_CURRENT_RANGE_0_TO_24MA = 2
int industrial_analog_out_v2_get_api_version(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint8_t ret_api_version[3])

Returns the version of the API definition (major, minor, revision) 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 industrial_analog_out_v2_get_response_expected(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint8_t function_id, bool *ret_response_expected)

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 industrial_analog_out_v2_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 send and errors are silently ignored, because they cannot be detected.

See industrial_analog_out_v2_set_response_expected() for the list of function ID defines available for this function.

int industrial_analog_out_v2_set_response_expected(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint8_t function_id, bool response_expected)

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 send and errors are silently ignored, because they cannot be detected.

The following function ID defines are available for this function:

  • INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_SET_ENABLED = 1
  • INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_SET_VOLTAGE = 3
  • INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_SET_CURRENT = 5
  • INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_SET_CONFIGURATION = 7
  • INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_SET_OUT_LED_CONFIG = 9
  • INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_SET_OUT_LED_STATUS_CONFIG = 11
  • INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_RESET = 243
  • INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_WRITE_UID = 248
int industrial_analog_out_v2_set_response_expected_all(IndustrialAnalogOutV2 *industrial_analog_out_v2, bool response_expected)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

int industrial_analog_out_v2_get_spitfp_error_count(IndustrialAnalogOutV2 *industrial_analog_out_v2, 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)

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 industrial_analog_out_v2_set_bootloader_mode(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint8_t mode, uint8_t *ret_status)

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 defines are available for this function:

  • INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_STATUS_OK = 0
  • INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int industrial_analog_out_v2_get_bootloader_mode(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint8_t *ret_mode)

Returns the current bootloader mode, see industrial_analog_out_v2_set_bootloader_mode().

The following defines are available for this function:

  • INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int industrial_analog_out_v2_set_write_firmware_pointer(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint32_t pointer)

Sets the firmware pointer for industrial_analog_out_v2_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 industrial_analog_out_v2_write_firmware(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint8_t data[64], uint8_t *ret_status)

Writes 64 Bytes of firmware at the position as written by industrial_analog_out_v2_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 industrial_analog_out_v2_set_status_led_config(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint8_t config)

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 defines are available for this function:

  • INDUSTRIAL_ANALOG_OUT_V2_STATUS_LED_CONFIG_OFF = 0
  • INDUSTRIAL_ANALOG_OUT_V2_STATUS_LED_CONFIG_ON = 1
  • INDUSTRIAL_ANALOG_OUT_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • INDUSTRIAL_ANALOG_OUT_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int industrial_analog_out_v2_get_status_led_config(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint8_t *ret_config)

Returns the configuration as set by industrial_analog_out_v2_set_status_led_config()

The following defines are available for this function:

  • INDUSTRIAL_ANALOG_OUT_V2_STATUS_LED_CONFIG_OFF = 0
  • INDUSTRIAL_ANALOG_OUT_V2_STATUS_LED_CONFIG_ON = 1
  • INDUSTRIAL_ANALOG_OUT_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • INDUSTRIAL_ANALOG_OUT_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int industrial_analog_out_v2_get_chip_temperature(IndustrialAnalogOutV2 *industrial_analog_out_v2, int16_t *ret_temperature)

Returns the temperature in °C 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 industrial_analog_out_v2_reset(IndustrialAnalogOutV2 *industrial_analog_out_v2)

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 industrial_analog_out_v2_write_uid(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint32_t uid)

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 industrial_analog_out_v2_read_uid(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint32_t *ret_uid)

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

int industrial_analog_out_v2_get_identity(IndustrialAnalogOutV2 *industrial_analog_out_v2, 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)

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' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Constants

INDUSTRIAL_ANALOG_OUT_V2_DEVICE_IDENTIFIER

This constant is used to identify a Industrial Analog Out Bricklet 2.0.

The industrial_analog_out_v2_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.

INDUSTRIAL_ANALOG_OUT_V2_DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Industrial Analog Out Bricklet 2.0.