Software / API Bindings / Perl / API Reference and Examples / Bricklets / Industrial Analog Out Bricklet 2.0

Perl - Industrial Analog Out Bricklet 2.0¶

This is the description of the Perl 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 Perl 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.pl)

#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletIndustrialAnalogOutV2;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your Industrial Analog Out Bricklet 2.0

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $iao = Tinkerforge::BrickletIndustrialAnalogOutV2->new(&UID, $ipcon); # Create device object

$ipcon->connect(&HOST, &PORT); # Connect to brickd
# Don't use device before ipcon is connected

# Set output current to 4.5mA
$iao->set_current(4500);
$iao->set_enabled(1);

print "Press key to exit\n";
<STDIN>;

$iao->set_enabled(0);

$ipcon->disconnect();

Simple Voltage¶

Download (example_simple_voltage.pl)

#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletIndustrialAnalogOutV2;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your Industrial Analog Out Bricklet 2.0

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $iao = Tinkerforge::BrickletIndustrialAnalogOutV2->new(&UID, $ipcon); # Create device object

$ipcon->connect(&HOST, &PORT); # Connect to brickd
# Don't use device before ipcon is connected

# Set output voltage to 3.3V
$iao->set_voltage(3300);
$iao->set_enabled(1);

print "Press key to exit\n";
<STDIN>;

$iao->set_enabled(0);

$ipcon->disconnect();

API¶

Generally, every subroutine of the Perl bindings can report an error as Tinkerforge::Error object via croak(). The object has a get_code() and a get_message() subroutine. There are different error code:

Error->ALREADY_CONNECTED = 11
Error->NOT_CONNECTED = 12
Error->CONNECT_FAILED = 13
Error->INVALID_FUNCTION_ID = 21
Error->TIMEOUT = 31
Error->INVALID_PARAMETER = 41
Error->FUNCTION_NOT_SUPPORTED = 42
Error->UNKNOWN_ERROR = 43
Error->STREAM_OUT_OF_SYNC = 51
Error->INVALID_UID = 61
Error->NON_ASCII_CHAR_IN_SECRET = 71
Error->WRONG_DEVICE_TYPE = 81
Error->DEVICE_REPLACED = 82
Error->WRONG_RESPONSE_LENGTH = 83

All functions listed below are thread-safe.

Basic Functions¶

BrickletIndustrialAnalogOutV2->new($uid, $ipcon)¶

Parameters:	$uid – Type: string $ipcon – Type: IPConnection
Returns:	$industrial_analog_out_v2 – Type: BrickletIndustrialAnalogOutV2

Creates an object with the unique device ID $uid:

$industrial_analog_out_v2 = BrickletIndustrialAnalogOutV2->new("YOUR_DEVICE_UID", $ipcon);

This object can then be used after the IP Connection is connected.

BrickletIndustrialAnalogOutV2->set_enabled($enabled)¶

Parameters:	$enabled – Type: bool, Default: 0
Returns:	undef

Enables/disables the output of voltage and current.

BrickletIndustrialAnalogOutV2->get_enabled()¶

Returns:	$enabled – Type: bool, Default: 0

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

BrickletIndustrialAnalogOutV2->set_voltage($voltage)¶

Parameters:	$voltage – Type: int, Unit: 1 mV, Range: [0 to 10000]
Returns:	undef

Sets the output voltage.

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

BrickletIndustrialAnalogOutV2->get_voltage()¶

Returns:	$voltage – Type: int, Unit: 1 mV, Range: [0 to 10000]

Returns the voltage as set by set_voltage().

BrickletIndustrialAnalogOutV2->set_current($current)¶

Parameters:	$current – Type: int, Unit: 1 µA, Range: [0 to 24000]
Returns:	undef

Sets the output current.

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

BrickletIndustrialAnalogOutV2->get_current()¶

Returns:	$current – Type: int, Unit: 1 µA, Range: [0 to 24000]

Returns the current as set by set_current().

BrickletIndustrialAnalogOutV2->set_out_led_config($config)¶

Parameters:	$config – Type: int, Range: See constants, Default: 3
Returns:	undef

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 set_out_led_status_config().

The following constants are available for this function:

For $config:

BrickletIndustrialAnalogOutV2->OUT_LED_CONFIG_OFF = 0
BrickletIndustrialAnalogOutV2->OUT_LED_CONFIG_ON = 1
BrickletIndustrialAnalogOutV2->OUT_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletIndustrialAnalogOutV2->OUT_LED_CONFIG_SHOW_OUT_STATUS = 3

BrickletIndustrialAnalogOutV2->get_out_led_config()¶

Returns:	$config – Type: int, Range: See constants, Default: 3

Returns the Out LED configuration as set by set_out_led_config()

The following constants are available for this function:

For $config:

BrickletIndustrialAnalogOutV2->OUT_LED_CONFIG_OFF = 0
BrickletIndustrialAnalogOutV2->OUT_LED_CONFIG_ON = 1
BrickletIndustrialAnalogOutV2->OUT_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletIndustrialAnalogOutV2->OUT_LED_CONFIG_SHOW_OUT_STATUS = 3

BrickletIndustrialAnalogOutV2->set_out_led_status_config($min, $max, $config)¶

Parameters:	$min – Type: int, Range: [0 to 24000], Default: 0 $max – Type: int, Range: [0 to 24000], Default: 10000 $config – Type: int, Range: See constants, Default: 1
Returns:	undef

Sets the Out LED status config. This config is used if the Out LED is configured as "Out Status", see 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.

The following constants are available for this function:

For $config:

BrickletIndustrialAnalogOutV2->OUT_LED_STATUS_CONFIG_THRESHOLD = 0
BrickletIndustrialAnalogOutV2->OUT_LED_STATUS_CONFIG_INTENSITY = 1

BrickletIndustrialAnalogOutV2->get_out_led_status_config()¶

Return Array:	0: $min – Type: int, Range: [0 to 24000], Default: 0 1: $max – Type: int, Range: [0 to 24000], Default: 10000 2: $config – Type: int, Range: See constants, Default: 1

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

The following constants are available for this function:

For $config:

BrickletIndustrialAnalogOutV2->OUT_LED_STATUS_CONFIG_THRESHOLD = 0
BrickletIndustrialAnalogOutV2->OUT_LED_STATUS_CONFIG_INTENSITY = 1

Advanced Functions¶

BrickletIndustrialAnalogOutV2->set_configuration($voltage_range, $current_range)¶

Parameters:	$voltage_range – Type: int, Range: See constants, Default: 1 $current_range – Type: int, Range: See constants, Default: 0
Returns:	undef

Configures the voltage and current range.

Possible voltage ranges are:

0V to 5V
0V to 10V

Possible current ranges are:

4mA to 20mA
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 constants are available for this function:

For $voltage_range:

BrickletIndustrialAnalogOutV2->VOLTAGE_RANGE_0_TO_5V = 0
BrickletIndustrialAnalogOutV2->VOLTAGE_RANGE_0_TO_10V = 1

For $current_range:

BrickletIndustrialAnalogOutV2->CURRENT_RANGE_4_TO_20MA = 0
BrickletIndustrialAnalogOutV2->CURRENT_RANGE_0_TO_20MA = 1
BrickletIndustrialAnalogOutV2->CURRENT_RANGE_0_TO_24MA = 2

BrickletIndustrialAnalogOutV2->get_configuration()¶

Return Array:	0: $voltage_range – Type: int, Range: See constants, Default: 1 1: $current_range – Type: int, Range: See constants, Default: 0

Returns the configuration as set by set_configuration().

The following constants are available for this function:

For $voltage_range:

BrickletIndustrialAnalogOutV2->VOLTAGE_RANGE_0_TO_5V = 0
BrickletIndustrialAnalogOutV2->VOLTAGE_RANGE_0_TO_10V = 1

For $current_range:

BrickletIndustrialAnalogOutV2->CURRENT_RANGE_4_TO_20MA = 0
BrickletIndustrialAnalogOutV2->CURRENT_RANGE_0_TO_20MA = 1
BrickletIndustrialAnalogOutV2->CURRENT_RANGE_0_TO_24MA = 2

BrickletIndustrialAnalogOutV2->get_spitfp_error_count()¶

Return Array:	0: $error_count_ack_checksum – Type: int, Range: [0 to 2³² - 1] 1: $error_count_message_checksum – Type: int, Range: [0 to 2³² - 1] 2: $error_count_frame – Type: int, Range: [0 to 2³² - 1] 3: $error_count_overflow – Type: int, Range: [0 to 2³² - 1]

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.

BrickletIndustrialAnalogOutV2->set_status_led_config($config)¶

Parameters:	$config – Type: int, Range: See constants, Default: 3
Returns:	undef

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

For $config:

BrickletIndustrialAnalogOutV2->STATUS_LED_CONFIG_OFF = 0
BrickletIndustrialAnalogOutV2->STATUS_LED_CONFIG_ON = 1
BrickletIndustrialAnalogOutV2->STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletIndustrialAnalogOutV2->STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletIndustrialAnalogOutV2->get_status_led_config()¶

Returns:	$config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by set_status_led_config()

The following constants are available for this function:

For $config:

BrickletIndustrialAnalogOutV2->STATUS_LED_CONFIG_OFF = 0
BrickletIndustrialAnalogOutV2->STATUS_LED_CONFIG_ON = 1
BrickletIndustrialAnalogOutV2->STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletIndustrialAnalogOutV2->STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletIndustrialAnalogOutV2->get_chip_temperature()¶

Returns:	$temperature – Type: int, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 1]

Returns the temperature 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.

BrickletIndustrialAnalogOutV2->reset()¶

Returns:	undef

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!

BrickletIndustrialAnalogOutV2->get_identity()¶

Return Array:

Return Array:	0: $uid – Type: string, Length: up to 8 1: $connected_uid – Type: string, Length: up to 8 2: $position – Type: char, Range: ['a' to 'h', 'z'] 3: \@hardware_version – Type: [int, ...], Length: 3 0: $major – Type: int, Range: [0 to 255] 1: $minor – Type: int, Range: [0 to 255] 2: $revision – Type: int, Range: [0 to 255] 4: \@firmware_version – Type: [int, ...], Length: 3 0: $major – Type: int, Range: [0 to 255] 1: $minor – Type: int, Range: [0 to 255] 2: $revision – Type: int, Range: [0 to 255] 5: $device_identifier – Type: int, Range: [0 to 2¹⁶ - 1]

0: $uid – Type: string, Length: up to 8
1: $connected_uid – Type: string, Length: up to 8
2: $position – Type: char, Range: ['a' to 'h', 'z']
3: \@hardware_version – Type: [int, ...], Length: 3

0: $major – Type: int, Range: [0 to 255]
1: $minor – Type: int, Range: [0 to 255]
2: $revision – Type: int, Range: [0 to 255]

4: \@firmware_version – Type: [int, ...], Length: 3

0: $major – Type: int, Range: [0 to 255]
1: $minor – Type: int, Range: [0 to 255]
2: $revision – Type: int, Range: [0 to 255]

5: $device_identifier – Type: int, Range: [0 to 2¹⁶ - 1]

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.

BrickletIndustrialAnalogOutV2->get_api_version()¶

Return Array:	0: \@api_version – Type: [int, ...], Length: 3 0: $major – Type: int, Range: [0 to 255] 1: $minor – Type: int, Range: [0 to 255] 2: $revision – Type: int, Range: [0 to 255]

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.

BrickletIndustrialAnalogOutV2->get_response_expected($function_id)¶

Parameters:	$function_id – Type: int, Range: See constants
Returns:	$response_expected – Type: bool

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 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:

BrickletIndustrialAnalogOutV2->FUNCTION_SET_ENABLED = 1
BrickletIndustrialAnalogOutV2->FUNCTION_SET_VOLTAGE = 3
BrickletIndustrialAnalogOutV2->FUNCTION_SET_CURRENT = 5
BrickletIndustrialAnalogOutV2->FUNCTION_SET_CONFIGURATION = 7
BrickletIndustrialAnalogOutV2->FUNCTION_SET_OUT_LED_CONFIG = 9
BrickletIndustrialAnalogOutV2->FUNCTION_SET_OUT_LED_STATUS_CONFIG = 11
BrickletIndustrialAnalogOutV2->FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletIndustrialAnalogOutV2->FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletIndustrialAnalogOutV2->FUNCTION_RESET = 243
BrickletIndustrialAnalogOutV2->FUNCTION_WRITE_UID = 248

BrickletIndustrialAnalogOutV2->set_response_expected($function_id, $response_expected)¶

Parameters:	$function_id – Type: int, Range: See constants $response_expected – Type: bool
Returns:	undef

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:

BrickletIndustrialAnalogOutV2->FUNCTION_SET_ENABLED = 1
BrickletIndustrialAnalogOutV2->FUNCTION_SET_VOLTAGE = 3
BrickletIndustrialAnalogOutV2->FUNCTION_SET_CURRENT = 5
BrickletIndustrialAnalogOutV2->FUNCTION_SET_CONFIGURATION = 7
BrickletIndustrialAnalogOutV2->FUNCTION_SET_OUT_LED_CONFIG = 9
BrickletIndustrialAnalogOutV2->FUNCTION_SET_OUT_LED_STATUS_CONFIG = 11
BrickletIndustrialAnalogOutV2->FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletIndustrialAnalogOutV2->FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletIndustrialAnalogOutV2->FUNCTION_RESET = 243
BrickletIndustrialAnalogOutV2->FUNCTION_WRITE_UID = 248

BrickletIndustrialAnalogOutV2->set_response_expected_all($response_expected)¶

Parameters:	$response_expected – Type: bool
Returns:	undef

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

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

BrickletIndustrialAnalogOutV2->set_bootloader_mode($mode)¶

Parameters:	$mode – Type: int, Range: See constants
Returns:	$status – Type: int, Range: See constants

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

For $mode:

BrickletIndustrialAnalogOutV2->BOOTLOADER_MODE_BOOTLOADER = 0
BrickletIndustrialAnalogOutV2->BOOTLOADER_MODE_FIRMWARE = 1
BrickletIndustrialAnalogOutV2->BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletIndustrialAnalogOutV2->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletIndustrialAnalogOutV2->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For $status:

BrickletIndustrialAnalogOutV2->BOOTLOADER_STATUS_OK = 0
BrickletIndustrialAnalogOutV2->BOOTLOADER_STATUS_INVALID_MODE = 1
BrickletIndustrialAnalogOutV2->BOOTLOADER_STATUS_NO_CHANGE = 2
BrickletIndustrialAnalogOutV2->BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BrickletIndustrialAnalogOutV2->BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BrickletIndustrialAnalogOutV2->BOOTLOADER_STATUS_CRC_MISMATCH = 5

BrickletIndustrialAnalogOutV2->get_bootloader_mode()¶

Returns:	$mode – Type: int, Range: See constants

Returns the current bootloader mode, see set_bootloader_mode().

The following constants are available for this function:

For $mode:

BrickletIndustrialAnalogOutV2->BOOTLOADER_MODE_BOOTLOADER = 0
BrickletIndustrialAnalogOutV2->BOOTLOADER_MODE_FIRMWARE = 1
BrickletIndustrialAnalogOutV2->BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletIndustrialAnalogOutV2->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletIndustrialAnalogOutV2->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

BrickletIndustrialAnalogOutV2->set_write_firmware_pointer($pointer)¶

Parameters:	$pointer – Type: int, Unit: 1 B, Range: [0 to 2³² - 1]
Returns:	undef

Sets the firmware pointer for 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.

BrickletIndustrialAnalogOutV2->write_firmware(\@data)¶

Parameters:	\@data – Type: [int, ...], Length: 64, Range: [0 to 255]
Returns:	$status – Type: int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by 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.

BrickletIndustrialAnalogOutV2->write_uid($uid)¶

Parameters:	$uid – Type: int, Range: [0 to 2³² - 1]
Returns:	undef

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.

BrickletIndustrialAnalogOutV2->read_uid()¶

Returns:	$uid – Type: int, Range: [0 to 2³² - 1]

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

Constants¶

BrickletIndustrialAnalogOutV2->DEVICE_IDENTIFIER¶

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

The get_identity() function and the IPConnection->CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickletIndustrialAnalogOutV2->DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Industrial Analog Out Bricklet 2.0.