C/C++ - Industrial Analog Out Bricklet

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

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

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

    // Create device object
    IndustrialAnalogOut iao;
    industrial_analog_out_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_set_current(&iao, 4500);
    industrial_analog_out_enable(&iao);

    printf("Press key to exit\n");
    getchar();
    industrial_analog_out_disable(&iao);
    industrial_analog_out_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.h"

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

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

    // Create device object
    IndustrialAnalogOut iao;
    industrial_analog_out_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_set_voltage(&iao, 3300);
    industrial_analog_out_enable(&iao);

    printf("Press key to exit\n");
    getchar();
    industrial_analog_out_disable(&iao);
    industrial_analog_out_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_create(IndustrialAnalogOut *industrial_analog_out, const char *uid, IPConnection *ipcon)

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

IndustrialAnalogOut industrial_analog_out;
industrial_analog_out_create(&industrial_analog_out, "YOUR_DEVICE_UID", &ipcon);

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

void industrial_analog_out_destroy(IndustrialAnalogOut *industrial_analog_out)

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

int industrial_analog_out_enable(IndustrialAnalogOut *industrial_analog_out)

Enables the output of voltage and current.

The default is disabled.

int industrial_analog_out_disable(IndustrialAnalogOut *industrial_analog_out)

Disables the output of voltage and current.

The default is disabled.

int industrial_analog_out_is_enabled(IndustrialAnalogOut *industrial_analog_out, bool *ret_enabled)

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

int industrial_analog_out_set_voltage(IndustrialAnalogOut *industrial_analog_out, 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_get_voltage(IndustrialAnalogOut *industrial_analog_out, uint16_t *ret_voltage)

Returns the voltage as set by industrial_analog_out_set_voltage().

int industrial_analog_out_set_current(IndustrialAnalogOut *industrial_analog_out, 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_get_current(IndustrialAnalogOut *industrial_analog_out, uint16_t *ret_current)

Returns the current as set by industrial_analog_out_set_current().

Advanced Functions

int industrial_analog_out_set_configuration(IndustrialAnalogOut *industrial_analog_out, 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_VOLTAGE_RANGE_0_TO_5V = 0
  • INDUSTRIAL_ANALOG_OUT_VOLTAGE_RANGE_0_TO_10V = 1
  • INDUSTRIAL_ANALOG_OUT_CURRENT_RANGE_4_TO_20MA = 0
  • INDUSTRIAL_ANALOG_OUT_CURRENT_RANGE_0_TO_20MA = 1
  • INDUSTRIAL_ANALOG_OUT_CURRENT_RANGE_0_TO_24MA = 2
int industrial_analog_out_get_configuration(IndustrialAnalogOut *industrial_analog_out, uint8_t *ret_voltage_range, uint8_t *ret_current_range)

Returns the configuration as set by industrial_analog_out_set_configuration().

The following defines are available for this function:

  • INDUSTRIAL_ANALOG_OUT_VOLTAGE_RANGE_0_TO_5V = 0
  • INDUSTRIAL_ANALOG_OUT_VOLTAGE_RANGE_0_TO_10V = 1
  • INDUSTRIAL_ANALOG_OUT_CURRENT_RANGE_4_TO_20MA = 0
  • INDUSTRIAL_ANALOG_OUT_CURRENT_RANGE_0_TO_20MA = 1
  • INDUSTRIAL_ANALOG_OUT_CURRENT_RANGE_0_TO_24MA = 2
int industrial_analog_out_get_api_version(IndustrialAnalogOut *industrial_analog_out, 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_get_response_expected(IndustrialAnalogOut *industrial_analog_out, 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_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_set_response_expected() for the list of function ID defines available for this function.

int industrial_analog_out_set_response_expected(IndustrialAnalogOut *industrial_analog_out, 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_FUNCTION_ENABLE = 1
  • INDUSTRIAL_ANALOG_OUT_FUNCTION_DISABLE = 2
  • INDUSTRIAL_ANALOG_OUT_FUNCTION_SET_VOLTAGE = 4
  • INDUSTRIAL_ANALOG_OUT_FUNCTION_SET_CURRENT = 6
  • INDUSTRIAL_ANALOG_OUT_FUNCTION_SET_CONFIGURATION = 8
int industrial_analog_out_set_response_expected_all(IndustrialAnalogOut *industrial_analog_out, bool response_expected)

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

int industrial_analog_out_get_identity(IndustrialAnalogOut *industrial_analog_out, 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_DEVICE_IDENTIFIER

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

The industrial_analog_out_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_DEVICE_DISPLAY_NAME

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