Software / API Bindings / C/C++ / API Reference and Examples / Bricklets / Analog Out Bricklet 2.0

C/C++ - Analog Out Bricklet 2.0¶

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

Download (example_simple.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_analog_out_v2.h"

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

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

    // Create device object
    AnalogOutV2 ao;
    analog_out_v2_create(&ao, 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
    analog_out_v2_set_output_voltage(&ao, 3300);

    printf("Press key to exit\n");
    getchar();
    analog_out_v2_destroy(&ao);
    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 analog_out_v2_create(AnalogOutV2 *analog_out_v2, const char *uid, IPConnection *ipcon)¶

Parameters:	analog_out_v2 – Type: AnalogOutV2 * uid – Type: const char * ipcon – Type: IPConnection *

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

AnalogOutV2 analog_out_v2;
analog_out_v2_create(&analog_out_v2, "YOUR_DEVICE_UID", &ipcon);

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

void analog_out_v2_destroy(AnalogOutV2 *analog_out_v2)¶

Parameters:	analog_out_v2 – Type: AnalogOutV2 *

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

int analog_out_v2_set_output_voltage(AnalogOutV2 *analog_out_v2, uint16_t voltage)¶

Parameters:	analog_out_v2 – Type: AnalogOutV2 * voltage – Type: uint16_t, Unit: 1 mV, Range: [0 to 12000], Default: 0
Returns:	e_code – Type: int

Sets the voltage.

int analog_out_v2_get_output_voltage(AnalogOutV2 *analog_out_v2, uint16_t *ret_voltage)¶

Parameters:	analog_out_v2 – Type: AnalogOutV2 *
Output Parameters:	ret_voltage – Type: uint16_t, Unit: 1 mV, Range: [0 to 12000], Default: 0
Returns:	e_code – Type: int

Returns the voltage as set by analog_out_v2_set_output_voltage().

Advanced Functions¶

int analog_out_v2_get_input_voltage(AnalogOutV2 *analog_out_v2, uint16_t *ret_voltage)¶

Parameters:	analog_out_v2 – Type: AnalogOutV2 *
Output Parameters:	ret_voltage – Type: uint16_t, Unit: 1 mV, Range: [0 to 15000]
Returns:	e_code – Type: int

Returns the input voltage.

int analog_out_v2_get_identity(AnalogOutV2 *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)¶

Parameters:	analog_out_v2 – Type: AnalogOutV2 *
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.

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 analog_out_v2_get_api_version(AnalogOutV2 *analog_out_v2, uint8_t ret_api_version[3])¶

Parameters:	analog_out_v2 – Type: AnalogOutV2 *
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 analog_out_v2_get_response_expected(AnalogOutV2 *analog_out_v2, uint8_t function_id, bool *ret_response_expected)¶

Parameters:	analog_out_v2 – Type: AnalogOutV2 * 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 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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

ANALOG_OUT_V2_FUNCTION_SET_OUTPUT_VOLTAGE = 1

int analog_out_v2_set_response_expected(AnalogOutV2 *analog_out_v2, uint8_t function_id, bool response_expected)¶

Parameters:	analog_out_v2 – Type: AnalogOutV2 * 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:

ANALOG_OUT_V2_FUNCTION_SET_OUTPUT_VOLTAGE = 1

int analog_out_v2_set_response_expected_all(AnalogOutV2 *analog_out_v2, bool response_expected)¶

Parameters:	analog_out_v2 – Type: AnalogOutV2 * 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.

Constants¶

ANALOG_OUT_V2_DEVICE_IDENTIFIER¶

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

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

ANALOG_OUT_V2_DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Analog Out Bricklet 2.0.