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.
The example code below is Public Domain (CC0 1.0).
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 37 38 | #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;
}
|
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 37 38 | #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;
}
|
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:
as defined in ip_connection.h
.
All functions listed below are thread-safe.
industrial_analog_out_create
(IndustrialAnalogOut *industrial_analog_out, const char *uid, IPConnection *ipcon)¶Parameters: |
|
---|
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.
industrial_analog_out_destroy
(IndustrialAnalogOut *industrial_analog_out)¶Parameters: |
|
---|
Removes the device object industrial_analog_out
from its IPConnection and destroys it.
The device object cannot be used anymore afterwards.
industrial_analog_out_enable
(IndustrialAnalogOut *industrial_analog_out)¶Parameters: |
|
---|---|
Returns: |
|
Enables the output of voltage and current.
The default is disabled.
industrial_analog_out_disable
(IndustrialAnalogOut *industrial_analog_out)¶Parameters: |
|
---|---|
Returns: |
|
Disables the output of voltage and current.
The default is disabled.
industrial_analog_out_is_enabled
(IndustrialAnalogOut *industrial_analog_out, bool *ret_enabled)¶Parameters: |
|
---|---|
Output Parameters: |
|
Returns: |
|
Returns true if output of voltage and current is enabled, false otherwise.
industrial_analog_out_set_voltage
(IndustrialAnalogOut *industrial_analog_out, uint16_t voltage)¶Parameters: |
|
---|---|
Returns: |
|
Sets the output voltage.
The output voltage and output current are linked. Changing the output voltage also changes the output current.
industrial_analog_out_get_voltage
(IndustrialAnalogOut *industrial_analog_out, uint16_t *ret_voltage)¶Parameters: |
|
---|---|
Output Parameters: |
|
Returns: |
|
Returns the voltage as set by industrial_analog_out_set_voltage()
.
industrial_analog_out_set_current
(IndustrialAnalogOut *industrial_analog_out, uint16_t current)¶Parameters: |
|
---|---|
Returns: |
|
Sets the output current.
The output current and output voltage are linked. Changing the output current also changes the output voltage.
industrial_analog_out_get_current
(IndustrialAnalogOut *industrial_analog_out, uint16_t *ret_current)¶Parameters: |
|
---|---|
Output Parameters: |
|
Returns: |
|
Returns the current as set by industrial_analog_out_set_current()
.
industrial_analog_out_set_configuration
(IndustrialAnalogOut *industrial_analog_out, uint8_t voltage_range, uint8_t current_range)¶Parameters: |
|
---|---|
Returns: |
|
Configures the voltage and current range.
Possible voltage ranges are:
Possible current ranges are:
The resolution will always be 12 bit. This means, that the precision is higher with a smaller range.
The following constants are available for this function:
For voltage_range:
For current_range:
industrial_analog_out_get_configuration
(IndustrialAnalogOut *industrial_analog_out, uint8_t *ret_voltage_range, uint8_t *ret_current_range)¶Parameters: |
|
---|---|
Output Parameters: |
|
Returns: |
|
Returns the configuration as set by industrial_analog_out_set_configuration()
.
The following constants are available for this function:
For ret_voltage_range:
For ret_current_range:
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)¶Parameters: |
|
---|---|
Output Parameters: |
|
Returns: |
|
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 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.
industrial_analog_out_get_api_version
(IndustrialAnalogOut *industrial_analog_out, uint8_t ret_api_version[3])¶Parameters: |
|
---|---|
Output Parameters: |
|
Returns: |
|
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.
industrial_analog_out_get_response_expected
(IndustrialAnalogOut *industrial_analog_out, uint8_t function_id, bool *ret_response_expected)¶Parameters: |
|
---|---|
Output Parameters: |
|
Returns: |
|
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 sent and errors are silently ignored, because they cannot be detected.
The following constants are available for this function:
For function_id:
industrial_analog_out_set_response_expected
(IndustrialAnalogOut *industrial_analog_out, uint8_t function_id, bool response_expected)¶Parameters: |
|
---|---|
Returns: |
|
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 sent and errors are silently ignored, because they cannot be detected.
The following constants are available for this function:
For function_id:
industrial_analog_out_set_response_expected_all
(IndustrialAnalogOut *industrial_analog_out, bool response_expected)¶Parameters: |
|
---|---|
Returns: |
|
Changes the response expected flag for all setter and callback configuration functions of this device at once.
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.