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

NAME

Tinkerforge::BrickletTemperature - Measures ambient temperature with 0.5°C accuracy

CONSTANTS

DEVICE_IDENTIFIER

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

FUNCTION_GET_TEMPERATURE

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_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_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_I2C_MODE

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

FUNCTION_GET_I2C_MODE

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 the sensor. The value has a range of -2500 to 8500 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 callback :func:`Temperature` and set the period with :func:`SetTemperatureCallbackPeriod`.

set_temperature_callback_period()

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

:func:`Temperature` 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:`SetTemperatureCallbackPeriod`.

set_temperature_callback_threshold()

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

set_debounce_period()

Sets the period in ms with which the threshold callback

* :func:`TemperatureReached`

is triggered, if the threshold

* :func:`SetTemperatureCallbackThreshold`

keeps being reached.

The default value is 100.

get_debounce_period()

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

set_i2c_mode()

Sets the I2C mode. Possible modes are:

* 0: Fast (400kHz, default) * 1: Slow (100kHz)

If you have problems with obvious outliers in the Temperature Bricklet measurements, they may be caused by EMI issues. In this case it may be helpful to lower the I2C speed.

It is however not recommended to lower the I2C speed in applications where a high throughput needs to be achieved.

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

get_i2c_mode()

Returns the I2C mode as set by :func:`SetI2CMode`.

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