/ 
Tinkerforge-2.1.9
River stage zero No dependents
/ Tinkerforge::BrickletAnalogIn

NAME

Tinkerforge::BrickletAnalogIn - Measures DC voltage between 0V and 45V

CONSTANTS

DEVICE_IDENTIFIER

This constant is used to identify a Analog In 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 Analog In Bricklet.

CALLBACK_VOLTAGE

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

CALLBACK_ANALOG_VALUE

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

CALLBACK_VOLTAGE_REACHED

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

CALLBACK_ANALOG_VALUE_REACHED

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

FUNCTION_GET_VOLTAGE

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_VOLTAGE_CALLBACK_PERIOD

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

FUNCTION_GET_VOLTAGE_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_VOLTAGE_CALLBACK_THRESHOLD

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

FUNCTION_GET_VOLTAGE_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_SET_RANGE

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

FUNCTION_GET_RANGE

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

FUNCTION_SET_AVERAGING

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

FUNCTION_GET_AVERAGING

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_voltage()

Returns the voltage of the sensor. The value is in mV and between 0V and 45V. The resolution between 0 and 6V is about 2mV. Between 6 and 45V the resolution is about 10mV.

If you want to get the voltage periodically, it is recommended to use the callback :func:`Voltage` and set the period with :func:`SetVoltageCallbackPeriod`.

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:`GetVoltage` is averaged over several samples to yield less noise, while :func:`GetAnalogValue` gives back raw unfiltered analog values. The only reason to use :func:`GetAnalogValue` 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 :func:`AnalogValue` and set the period with :func:`SetAnalogValueCallbackPeriod`.

set_voltage_callback_period()

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

:func:`Voltage` is only triggered if the voltage has changed since the last triggering.

The default value is 0.

get_voltage_callback_period()

Returns the period as set by :func:`SetVoltageCallbackPeriod`.

set_analog_value_callback_period()

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

:func:`AnalogValue` 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:`SetAnalogValueCallbackPeriod`.

set_voltage_callback_threshold()

Sets the thresholds for the :func:`VoltageReached` 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 voltage is *outside* the min and max values"
"'i'",    "Callback is triggered when the voltage is *inside* the min and max values"
"'<'",    "Callback is triggered when the voltage is smaller than the min value (max is ignored)"
"'>'",    "Callback is triggered when the voltage is greater than the min value (max is ignored)"

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

get_voltage_callback_threshold()

Returns the threshold as set by :func:`SetVoltageCallbackThreshold`.

set_analog_value_callback_threshold()

Sets the thresholds for the :func:`AnalogValueReached` 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:`SetAnalogValueCallbackThreshold`.

set_debounce_period()

Sets the period in ms with which the threshold callbacks

* :func:`VoltageReached`, * :func:`AnalogValueReached`

are triggered, if the thresholds

* :func:`SetVoltageCallbackThreshold`, * :func:`SetAnalogValueCallbackThreshold`

keep being reached.

The default value is 100.

get_debounce_period()

Returns the debounce period as set by :func:`SetDebouncePeriod`.

set_range()

Sets the measurement range. Possible ranges:

* 0: Automatically switched * 1: 0V - 6.05V, ~1.48mV resolution * 2: 0V - 10.32V, ~2.52mV resolution * 3: 0V - 36.30V, ~8.86mV resolution * 4: 0V - 45.00V, ~11.25mV resolution * 5: 0V - 3.3V, ~0.81mV resolution, new in version 2.0.3$nbsp;(Plugin)

The default measurement range is 0.

.. versionadded:: 2.0.1$nbsp;(Plugin)

get_range()

Returns the measurement range as set by :func:`SetRange`.

.. versionadded:: 2.0.1$nbsp;(Plugin)

set_averaging()

Set the length of a averaging for the voltage value.

Setting the length to 0 will turn the averaging completely off. If the averaging is off, there is more noise on the data, but the data is without delay.

The default value is 50.

.. versionadded:: 2.0.3$nbsp;(Plugin)

get_averaging()

Returns the averaging configuration as set by :func:`SetAveraging`.

.. versionadded:: 2.0.3$nbsp;(Plugin)

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|