C/C++ - Analog Out Bricklet 3.0

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

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

#include "ip_connection.h"
#include "bricklet_analog_out_v3.h"

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

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

    // Create device object
    AnalogOutV3 ao;
    analog_out_v3_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_v3_set_output_voltage(&ao, 3300);

    printf("Press key to exit\n");
    getchar();
    analog_out_v3_destroy(&ao);
    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 analog_out_v3_create(AnalogOutV3 *analog_out_v3, const char *uid, IPConnection *ipcon)

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

AnalogOutV3 analog_out_v3;
analog_out_v3_create(&analog_out_v3, "YOUR_DEVICE_UID", &ipcon);

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

void analog_out_v3_destroy(AnalogOutV3 *analog_out_v3)

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

int analog_out_v3_set_output_voltage(AnalogOutV3 *analog_out_v3, uint16_t voltage)

Sets the voltage in mV. The possible range is 0V to 12V (0-12000).

int analog_out_v3_get_output_voltage(AnalogOutV3 *analog_out_v3, uint16_t *ret_voltage)

Returns the voltage as set by analog_out_v3_set_output_voltage().

Advanced Functions

int analog_out_v3_get_input_voltage(AnalogOutV3 *analog_out_v3, uint16_t *ret_voltage)

Returns the input voltage in mV.

int analog_out_v3_get_api_version(AnalogOutV3 *analog_out_v3, 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 analog_out_v3_get_response_expected(AnalogOutV3 *analog_out_v3, 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 analog_out_v3_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 analog_out_v3_set_response_expected() for the list of function ID defines available for this function.

int analog_out_v3_set_response_expected(AnalogOutV3 *analog_out_v3, 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:

  • ANALOG_OUT_V3_FUNCTION_SET_OUTPUT_VOLTAGE = 1
  • ANALOG_OUT_V3_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • ANALOG_OUT_V3_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • ANALOG_OUT_V3_FUNCTION_RESET = 243
  • ANALOG_OUT_V3_FUNCTION_WRITE_UID = 248
int analog_out_v3_set_response_expected_all(AnalogOutV3 *analog_out_v3, bool response_expected)

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

int analog_out_v3_get_spitfp_error_count(AnalogOutV3 *analog_out_v3, 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 analog_out_v3_set_bootloader_mode(AnalogOutV3 *analog_out_v3, 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:

  • ANALOG_OUT_V3_BOOTLOADER_MODE_BOOTLOADER = 0
  • ANALOG_OUT_V3_BOOTLOADER_MODE_FIRMWARE = 1
  • ANALOG_OUT_V3_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • ANALOG_OUT_V3_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • ANALOG_OUT_V3_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • ANALOG_OUT_V3_BOOTLOADER_STATUS_OK = 0
  • ANALOG_OUT_V3_BOOTLOADER_STATUS_INVALID_MODE = 1
  • ANALOG_OUT_V3_BOOTLOADER_STATUS_NO_CHANGE = 2
  • ANALOG_OUT_V3_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • ANALOG_OUT_V3_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • ANALOG_OUT_V3_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int analog_out_v3_get_bootloader_mode(AnalogOutV3 *analog_out_v3, uint8_t *ret_mode)

Returns the current bootloader mode, see analog_out_v3_set_bootloader_mode().

The following defines are available for this function:

  • ANALOG_OUT_V3_BOOTLOADER_MODE_BOOTLOADER = 0
  • ANALOG_OUT_V3_BOOTLOADER_MODE_FIRMWARE = 1
  • ANALOG_OUT_V3_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • ANALOG_OUT_V3_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • ANALOG_OUT_V3_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int analog_out_v3_set_write_firmware_pointer(AnalogOutV3 *analog_out_v3, uint32_t pointer)

Sets the firmware pointer for analog_out_v3_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 analog_out_v3_write_firmware(AnalogOutV3 *analog_out_v3, uint8_t data[64], uint8_t *ret_status)

Writes 64 Bytes of firmware at the position as written by analog_out_v3_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 analog_out_v3_set_status_led_config(AnalogOutV3 *analog_out_v3, 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:

  • ANALOG_OUT_V3_STATUS_LED_CONFIG_OFF = 0
  • ANALOG_OUT_V3_STATUS_LED_CONFIG_ON = 1
  • ANALOG_OUT_V3_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • ANALOG_OUT_V3_STATUS_LED_CONFIG_SHOW_STATUS = 3
int analog_out_v3_get_status_led_config(AnalogOutV3 *analog_out_v3, uint8_t *ret_config)

Returns the configuration as set by analog_out_v3_set_status_led_config()

The following defines are available for this function:

  • ANALOG_OUT_V3_STATUS_LED_CONFIG_OFF = 0
  • ANALOG_OUT_V3_STATUS_LED_CONFIG_ON = 1
  • ANALOG_OUT_V3_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • ANALOG_OUT_V3_STATUS_LED_CONFIG_SHOW_STATUS = 3
int analog_out_v3_get_chip_temperature(AnalogOutV3 *analog_out_v3, 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 analog_out_v3_reset(AnalogOutV3 *analog_out_v3)

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 analog_out_v3_write_uid(AnalogOutV3 *analog_out_v3, 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 analog_out_v3_read_uid(AnalogOutV3 *analog_out_v3, uint32_t *ret_uid)

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

int analog_out_v3_get_identity(AnalogOutV3 *analog_out_v3, 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

ANALOG_OUT_V3_DEVICE_IDENTIFIER

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

The analog_out_v3_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_V3_DEVICE_DISPLAY_NAME

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