/ 
Tinkerforge-2.1.20
River stage zero No dependents
/ Tinkerforge::BrickletPTC

NAME

Tinkerforge::BrickletPTC - Reads temperatures from Pt100 und Pt1000 sensors

CONSTANTS

DEVICE_IDENTIFIER

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

CALLBACK_TEMPERATURE

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

CALLBACK_TEMPERATURE_REACHED

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

CALLBACK_RESISTANCE

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

CALLBACK_RESISTANCE_REACHED

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

CALLBACK_SENSOR_CONNECTED

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

FUNCTION_GET_TEMPERATURE

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

FUNCTION_GET_RESISTANCE

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

FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD

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

FUNCTION_GET_TEMPERATURE_CALLBACK_PERIOD

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

FUNCTION_SET_RESISTANCE_CALLBACK_PERIOD

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

FUNCTION_GET_RESISTANCE_CALLBACK_PERIOD

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

FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD

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

FUNCTION_GET_TEMPERATURE_CALLBACK_THRESHOLD

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

FUNCTION_SET_RESISTANCE_CALLBACK_THRESHOLD

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

FUNCTION_GET_RESISTANCE_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_NOISE_REJECTION_FILTER

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

FUNCTION_GET_NOISE_REJECTION_FILTER

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

FUNCTION_IS_SENSOR_CONNECTED

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

FUNCTION_SET_WIRE_MODE

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

FUNCTION_GET_WIRE_MODE

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

FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION

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

FUNCTION_GET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION

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

Returns the temperature of connected sensor. The value has a range of -246 to 849 °C and is given in °C/100, e.g. a value of 4223 means that a temperature of 42.23 °C is measured.

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

get_resistance()

Returns the value as measured by the MAX31865 precision delta-sigma ADC.

The value can be converted with the following formulas:

* Pt100: resistance = (value * 390) / 32768 * Pt1000: resistance = (value * 3900) / 32768

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

set_temperature_callback_period()

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

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

The default value is 0.

get_temperature_callback_period()

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

set_resistance_callback_period()

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

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

The default value is 0.

get_resistance_callback_period()

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

set_temperature_callback_threshold()

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

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

get_temperature_callback_threshold()

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

set_resistance_callback_threshold()

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

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

get_resistance_callback_threshold()

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

set_debounce_period()

Sets the period in ms with which the threshold callback

* :cb:`Temperature Reached`, * :cb:`Resistance Reached`

is triggered, if the threshold

* :func:`Set Temperature Callback Threshold`, * :func:`Set Resistance Callback Threshold`

keeps being reached.

The default value is 100.

get_debounce_period()

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

set_noise_rejection_filter()

Sets the noise rejection filter to either 50Hz (0) or 60Hz (1). Noise from 50Hz or 60Hz power sources (including harmonics of the AC power's fundamental frequency) is attenuated by 82dB.

Default value is 0 = 50Hz.

get_noise_rejection_filter()

Returns the noise rejection filter option as set by :func:`Set Noise Rejection Filter`

is_sensor_connected()

Returns *true* if the sensor is connected correctly.

If this function returns *false*, there is either no Pt100 or Pt1000 sensor connected, the sensor is connected incorrectly or the sensor itself is faulty.

set_wire_mode()

Sets the wire mode of the sensor. Possible values are 2, 3 and 4 which correspond to 2-, 3- and 4-wire sensors. The value has to match the jumper configuration on the Bricklet.

The default value is 2 = 2-wire.

get_wire_mode()

Returns the wire mode as set by :func:`Set Wire Mode`

set_sensor_connected_callback_configuration()

If you enable this callback, the :cb:`Sensor Connected` callback is triggered every time a Pt sensor is connected/disconnected.

By default this callback is disabled.

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

get_sensor_connected_callback_configuration()

Returns the configuration as set by :func:`Set Sensor Connected Callback Configuration`.

.. versionadded:: 2.0.2$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|