Ishraq Ibne Ashraf
and 1 contributors

NAME

Tinkerforge::BrickletCurrent12 - Measures AC/DC current between -12.5A and +12.5A

CONSTANTS

DEVICE_IDENTIFIER

This constant is used to identify a Current12 Bricklet.

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

DEVICE_DISPLAY_NAME

This constant represents the display name of a Current12 Bricklet.

CALLBACK_CURRENT

This constant is used with the register_callback() subroutine to specify the CALLBACK_CURRENT callback.

CALLBACK_ANALOG_VALUE

This constant is used with the register_callback() subroutine to specify the CALLBACK_ANALOG_VALUE callback.

CALLBACK_CURRENT_REACHED

This constant is used with the register_callback() subroutine to specify the CALLBACK_CURRENT_REACHED callback.

CALLBACK_ANALOG_VALUE_REACHED

This constant is used with the register_callback() subroutine to specify the CALLBACK_ANALOG_VALUE_REACHED callback.

CALLBACK_OVER_CURRENT

This constant is used with the register_callback() subroutine to specify the CALLBACK_OVER_CURRENT callback.

FUNCTION_GET_CURRENT

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_CALIBRATE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_IS_OVER_CURRENT

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_ANALOG_VALUE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_CURRENT_CALLBACK_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_CURRENT_CALLBACK_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_CURRENT_CALLBACK_THRESHOLD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_DEBOUNCE_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_DEBOUNCE_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_IDENTITY

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTIONS

new()

Creates an object with the unique device ID *uid* and adds it to the IP Connection *ipcon*.

get_current()

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

If you want to get the current periodically, it is recommended to use the :cb:`Current` callback and set the period with :func:`Set Current Callback Period`.

calibrate()

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.

is_over_current()

Returns *true* if more than 12.5A were measured.

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

get_analog_value()

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 :func:`Get Current` is averaged over several samples to yield less noise, while :func:`Get Analog Value` gives back raw unfiltered analog values. The only reason to use :func:`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 :cb:`Analog Value` callback and set the period with :func:`Set Analog Value Callback Period`.

set_current_callback_period()

Sets the period in ms with which the :cb:`Current` callback is triggered periodically. A value of 0 turns the callback off.

The :cb:`Current` callback is only triggered if the current has changed since the last triggering.

The default value is 0.

get_current_callback_period()

Returns the period as set by :func:`Set Current Callback Period`.

set_analog_value_callback_period()

Sets the period in ms with which the :cb:`Analog Value` callback is triggered periodically. A value of 0 turns the callback off.

The :cb:`Analog Value` callback is only triggered if the analog value has changed since the last triggering.

The default value is 0.

get_analog_value_callback_period()

Returns the period as set by :func:`Set Analog Value Callback Period`.

set_current_callback_threshold()

Sets the thresholds for the :cb:`Current Reached` callback.

The following options are possible:

.. csv-table:: :header: "Option", "Description" :widths: 10, 100

 "'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).

get_current_callback_threshold()

Returns the threshold as set by :func:`Set Current Callback Threshold`.

set_analog_value_callback_threshold()

Sets the thresholds for the :cb:`Analog Value Reached` callback.

The following options are possible:

.. csv-table:: :header: "Option", "Description" :widths: 10, 100

 "'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).

get_analog_value_callback_threshold()

Returns the threshold as set by :func:`Set Analog Value Callback Threshold`.

set_debounce_period()

Sets the period in ms with which the threshold callbacks

* :cb:`Current Reached`, * :cb:`Analog Value Reached`

are triggered, if the thresholds

* :func:`Set Current Callback Threshold`, * :func:`Set Analog Value Callback Threshold`

keep being reached.

The default value is 100.

get_debounce_period()

Returns the debounce period as set by :func:`Set Debounce Period`.

get_identity()

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 :ref:`here <device_identifier>`. |device_identifier_constant|