/ 
Tinkerforge-2.1.12
River stage zero No dependents
/ Tinkerforge::BrickletTemperatureIR

NAME

Tinkerforge::BrickletTemperatureIR - Measures contactless object temperature between -70°C and +380°C

CONSTANTS

DEVICE_IDENTIFIER

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

CALLBACK_AMBIENT_TEMPERATURE

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

CALLBACK_OBJECT_TEMPERATURE

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

CALLBACK_AMBIENT_TEMPERATURE_REACHED

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

CALLBACK_OBJECT_TEMPERATURE_REACHED

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

FUNCTION_GET_AMBIENT_TEMPERATURE

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

FUNCTION_GET_OBJECT_TEMPERATURE

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

FUNCTION_SET_EMISSIVITY

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

FUNCTION_GET_EMISSIVITY

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

FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD

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

FUNCTION_GET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD

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

FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_PERIOD

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

FUNCTION_GET_OBJECT_TEMPERATURE_CALLBACK_PERIOD

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

FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_THRESHOLD

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

FUNCTION_GET_AMBIENT_TEMPERATURE_CALLBACK_THRESHOLD

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

FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_THRESHOLD

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

FUNCTION_GET_OBJECT_TEMPERATURE_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_ambient_temperature()

Returns the ambient temperature of the sensor. The value has a range of -400 to 1250 and is given in °C/10, e.g. a value of 423 means that an ambient temperature of 42.3 °C is measured.

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

get_object_temperature()

Returns the object temperature of the sensor, i.e. the temperature of the surface of the object the sensor is aimed at. The value has a range of -700 to 3800 and is given in °C/10, e.g. a value of 3001 means that a temperature of 300.1 °C is measured on the surface of the object.

The temperature of different materials is dependent on their `emissivity <https://en.wikipedia.org/wiki/Emissivity>`__. The emissivity of the material can be set with :func:`Set Emissivity`.

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

set_emissivity()

Sets the `emissivity <https://en.wikipedia.org/wiki/Emissivity>`__ that is used to calculate the surface temperature as returned by :func:`Get Object Temperature`.

The emissivity is usually given as a value between 0.0 and 1.0. A list of emissivities of different materials can be found `here <http://www.infrared-thermography.com/material.htm>`__.

The parameter of :func:`Set Emissivity` has to be given with a factor of 65535 (16-bit). For example: An emissivity of 0.1 can be set with the value 6553, an emissivity of 0.5 with the value 32767 and so on.

.. note:: If you need a precise measurement for the object temperature, it is absolutely crucial that you also provide a precise emissivity.

The default emissivity is 1.0 (value of 65535) and the minimum emissivity the sensor can handle is 0.1 (value of 6553).

get_emissivity()

Returns the emissivity as set by :func:`Set Emissivity`.

set_ambient_temperature_callback_period()

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

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

The default value is 0.

get_ambient_temperature_callback_period()

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

set_object_temperature_callback_period()

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

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

The default value is 0.

get_object_temperature_callback_period()

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

set_ambient_temperature_callback_threshold()

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

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

get_ambient_temperature_callback_threshold()

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

set_object_temperature_callback_threshold()

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

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

get_object_temperature_callback_threshold()

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

set_debounce_period()

Sets the period in ms with which the threshold callbacks

* :cb:`Ambient Temperature Reached`, * :cb:`Object Temperature Reached`

are triggered, if the thresholds

* :func:`Set Ambient Temperature Callback Threshold`, * :func:`Set Object Temperature 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|