Perl - Current25 Bricklet

This is the description of the Perl API bindings for the Current25 Bricklet. General information and technical specifications for the Current25 Bricklet 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

Download (example_simple.pl)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletCurrent25;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your Current25 Bricklet

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

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

# Get current current
my $current = $c->get_current();
print "Current: " . $current/1000.0 . " A\n";

print "Press key to exit\n";
<STDIN>;
$ipcon->disconnect();

Callback

Download (example_callback.pl)

 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
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletCurrent25;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your Current25 Bricklet

# Callback subroutine for current callback
sub cb_current
{
    my ($current) = @_;

    print "Current: " . $current/1000.0 . " A\n";
}

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

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

# Register current callback to subroutine cb_current
$c->register_callback($c->CALLBACK_CURRENT, 'cb_current');

# Set period for current callback to 1s (1000ms)
# Note: The current callback is only called every second
#       if the current has changed since the last call!
$c->set_current_callback_period(1000);

print "Press key to exit\n";
<STDIN>;
$ipcon->disconnect();

Threshold

Download (example_threshold.pl)

 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
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletCurrent25;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your Current25 Bricklet

# Callback subroutine for current reached callback
sub cb_current_reached
{
    my ($current) = @_;

    print "Current: " . $current/1000.0 . " A\n";
}

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

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

# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
$c->set_debounce_period(10000);

# Register current reached callback to subroutine cb_current_reached
$c->register_callback($c->CALLBACK_CURRENT_REACHED, 'cb_current_reached');

# Configure threshold for current "greater than 5 A"
$c->set_current_callback_threshold('>', 5*1000, 0);

print "Press key to exit\n";
<STDIN>;
$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

All methods listed below are thread-safe.

Basic Functions

BrickletCurrent25->new($uid, $ipcon)
Parameters:
  • $uid -- string
  • $ipcon -- IPConnection
Return type:

BrickletCurrent25

Creates an object with the unique device ID $uid:

$current25 = BrickletCurrent25->new("YOUR_DEVICE_UID", $ipcon);

This object can then be used after the IP Connection is connected (see examples above).

BrickletCurrent25->get_current()
Return type:int

Returns the current of the sensor. The value is in mA and between -25000mA and 25000mA.

If you want to get the current periodically, it is recommended to use the CALLBACK_CURRENT callback and set the period with set_current_callback_period().

Advanced Functions

BrickletCurrent25->calibrate()
Return type:undef

Calibrates the 0 value of the sensor. You have to call this function when there is no current present.

The zero point of the current sensor is depending on the exact properties of the analog-to-digital converter, the length of the Bricklet cable and the temperature. Thus, if you change the Brick or the environment in which the Bricklet is used, you might have to recalibrate.

The resulting calibration will be saved on the EEPROM of the Current Bricklet.

BrickletCurrent25->is_over_current()
Return type:bool

Returns true if more than 25A were measured.

Note

To reset this value you have to power cycle the Bricklet.

BrickletCurrent25->get_analog_value()
Return type:int

Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.

Note

The value returned by get_current() is averaged over several samples to yield less noise, while get_analog_value() gives back raw unfiltered analog values. The only reason to use get_analog_value() is, if you need the full resolution of the analog-to-digital converter.

If you want the analog value periodically, it is recommended to use the CALLBACK_ANALOG_VALUE callback and set the period with set_analog_value_callback_period().

BrickletCurrent25->get_api_version()
Return type:[int, int, int]

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.

BrickletCurrent25->get_response_expected($function_id)
Parameters:$function_id -- int
Return 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 send and errors are silently ignored, because they cannot be detected.

See set_response_expected() for the list of function ID constants available for this function.

BrickletCurrent25->set_response_expected($function_id, $response_expected)
Parameters:
  • $function_id -- int
  • $response_expected -- bool
Return type:

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.

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

  • BrickletCurrent25->FUNCTION_CALIBRATE = 2
  • BrickletCurrent25->FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 5
  • BrickletCurrent25->FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
  • BrickletCurrent25->FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 9
  • BrickletCurrent25->FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
  • BrickletCurrent25->FUNCTION_SET_DEBOUNCE_PERIOD = 13
BrickletCurrent25->set_response_expected_all($response_expected)
Parameters:$response_expected -- bool
Return type:undef

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

BrickletCurrent25->get_identity()
Return type:[string, string, char, [int, int, int], [int, int, int], 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' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

The returned array contains the elements uid, connected_uid, position, hardware_version, firmware_version and device_identifier.

Callback Configuration Functions

BrickletCurrent25->register_callback($id, $callback)
Parameters:
  • $id -- int
  • $callback -- string
Return type:

undef

Registers the given $function name with the given $callback_id.

The available callback IDs with corresponding function signatures are listed below.

BrickletCurrent25->set_current_callback_period($period)
Parameters:$period -- int
Return type:undef

Sets the period in ms with which the CALLBACK_CURRENT callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_CURRENT callback is only triggered if the current has changed since the last triggering.

The default value is 0.

BrickletCurrent25->get_current_callback_period()
Return type:int

Returns the period as set by set_current_callback_period().

BrickletCurrent25->set_analog_value_callback_period($period)
Parameters:$period -- int
Return type:undef

Sets the period in ms with which the CALLBACK_ANALOG_VALUE callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_ANALOG_VALUE callback is only triggered if the analog value has changed since the last triggering.

The default value is 0.

BrickletCurrent25->get_analog_value_callback_period()
Return type:int

Returns the period as set by set_analog_value_callback_period().

BrickletCurrent25->set_current_callback_threshold($option, $min, $max)
Parameters:
  • $option -- char
  • $min -- int
  • $max -- int
Return type:

undef

Sets the thresholds for the CALLBACK_CURRENT_REACHED callback.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the current is outside the min and max values
'i' Callback is triggered when the current is inside the min and max values
'<' Callback is triggered when the current is smaller than the min value (max is ignored)
'>' Callback is triggered when the current is greater than the min value (max is ignored)

The default value is ('x', 0, 0).

The following constants are available for this function:

  • BrickletCurrent25->THRESHOLD_OPTION_OFF = 'x'
  • BrickletCurrent25->THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletCurrent25->THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletCurrent25->THRESHOLD_OPTION_SMALLER = '<'
  • BrickletCurrent25->THRESHOLD_OPTION_GREATER = '>'
BrickletCurrent25->get_current_callback_threshold()
Return type:[char, int, int]

Returns the threshold as set by set_current_callback_threshold().

The following constants are available for this function:

  • BrickletCurrent25->THRESHOLD_OPTION_OFF = 'x'
  • BrickletCurrent25->THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletCurrent25->THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletCurrent25->THRESHOLD_OPTION_SMALLER = '<'
  • BrickletCurrent25->THRESHOLD_OPTION_GREATER = '>'

The returned array contains the elements option, min and max.

BrickletCurrent25->set_analog_value_callback_threshold($option, $min, $max)
Parameters:
  • $option -- char
  • $min -- int
  • $max -- int
Return type:

undef

Sets the thresholds for the CALLBACK_ANALOG_VALUE_REACHED callback.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the analog value is outside the min and max values
'i' Callback is triggered when the analog value is inside the min and max values
'<' Callback is triggered when the analog value is smaller than the min value (max is ignored)
'>' Callback is triggered when the analog value is greater than the min value (max is ignored)

The default value is ('x', 0, 0).

The following constants are available for this function:

  • BrickletCurrent25->THRESHOLD_OPTION_OFF = 'x'
  • BrickletCurrent25->THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletCurrent25->THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletCurrent25->THRESHOLD_OPTION_SMALLER = '<'
  • BrickletCurrent25->THRESHOLD_OPTION_GREATER = '>'
BrickletCurrent25->get_analog_value_callback_threshold()
Return type:[char, int, int]

Returns the threshold as set by set_analog_value_callback_threshold().

The following constants are available for this function:

  • BrickletCurrent25->THRESHOLD_OPTION_OFF = 'x'
  • BrickletCurrent25->THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletCurrent25->THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletCurrent25->THRESHOLD_OPTION_SMALLER = '<'
  • BrickletCurrent25->THRESHOLD_OPTION_GREATER = '>'

The returned array contains the elements option, min and max.

BrickletCurrent25->set_debounce_period($debounce)
Parameters:$debounce -- int
Return type:undef

Sets the period in ms with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

The default value is 100.

BrickletCurrent25->get_debounce_period()
Return type:int

Returns the debounce period as set by set_debounce_period().

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the register_callback() function of the device object. The first parameter is the callback ID and the second parameter the callback function name:

sub my_callback
{
    print "@_[0]";
}

$current25->register_callback(BrickletCurrent25->CALLBACK_EXAMPLE, 'my_callback')

The callback function will be called from an internal thread of the IP Connection. In contrast to many other programming languages, variables are not automatically shared between threads in Perl. If you want to share a global variable between a callback function and the rest for your program it has to be marked as :shared. See the documentation of the threads::shared Perl module for more details.

The available constants with inherent number and type of parameters are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

BrickletCurrent25->CALLBACK_CURRENT
Parameters:$current -- int

This callback is triggered periodically with the period that is set by set_current_callback_period(). The parameter is the current of the sensor.

The CALLBACK_CURRENT callback is only triggered if the current has changed since the last triggering.

BrickletCurrent25->CALLBACK_ANALOG_VALUE
Parameters:$value -- int

This callback is triggered periodically with the period that is set by set_analog_value_callback_period(). The parameter is the analog value of the sensor.

The CALLBACK_ANALOG_VALUE callback is only triggered if the current has changed since the last triggering.

BrickletCurrent25->CALLBACK_CURRENT_REACHED
Parameters:$current -- int

This callback is triggered when the threshold as set by set_current_callback_threshold() is reached. The parameter is the current of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by set_debounce_period().

BrickletCurrent25->CALLBACK_ANALOG_VALUE_REACHED
Parameters:$value -- int

This callback is triggered when the threshold as set by set_analog_value_callback_threshold() is reached. The parameter is the analog value of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by set_debounce_period().

BrickletCurrent25->CALLBACK_OVER_CURRENT

This callback is triggered when an over current is measured (see is_over_current()).

Constants

BrickletCurrent25->DEVICE_IDENTIFIER

This constant is used to identify a Current25 Bricklet.

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.

BrickletCurrent25->DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Current25 Bricklet.