TCP/IP - Temperature Bricklet¶

Basic Functions¶

BrickletTemperature.get_temperature¶

Function ID:	1
Request:	empty payload
Response:	temperature – Type: int16, Unit: 1/100 °C, Range: [-2500 to 8500]

Returns the temperature of the sensor.

If you want to get the temperature periodically, it is recommended to use the CALLBACK_TEMPERATURE callback and set the period with set_temperature_callback_period.

Advanced Functions¶

BrickletTemperature.set_i2c_mode¶

Function ID:	10
Request:	mode – Type: uint8, Range: See meanings, Default: 0
Response:	no response

Sets the I2C mode. Possible modes are:

• 0: Fast (400kHz)
• 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.

The following meanings are defined for the elements of this function:

For mode:

• 0 = Fast
• 1 = Slow

New in version 2.0.1 (Plugin).

BrickletTemperature.get_i2c_mode¶

Function ID:	11
Request:	empty payload
Response:	mode – Type: uint8, Range: See meanings, Default: 0

Returns the I2C mode as set by set_i2c_mode.

The following meanings are defined for the elements of this function:

For mode:

• 0 = Fast
• 1 = Slow

New in version 2.0.1 (Plugin).

BrickletTemperature.get_identity¶

Function ID:	255
Request:	empty payload
Response:	uid – Type: char[8] connected_uid – Type: char[8] position – Type: char, Range: ['a' to 'h', 'z'] hardware_version – Type: uint8[3] 0: major – Type: uint8, Range: [0 to 255] 1: minor – Type: uint8, Range: [0 to 255] 2: revision – Type: uint8, Range: [0 to 255] firmware_version – Type: uint8[3] 0: major – Type: uint8, Range: [0 to 255] 1: minor – Type: uint8, Range: [0 to 255] 2: revision – Type: uint8, Range: [0 to 255] device_identifier – Type: uint16, Range: [0 to 216 - 1]

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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. 

Callback Configuration Functions¶

BrickletTemperature.set_temperature_callback_period¶

Function ID:	2
Request:	period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Response:	no response

Sets the period with which the CALLBACK_TEMPERATURE callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_TEMPERATURE callback is only triggered if the temperature has changed since the last triggering.

BrickletTemperature.get_temperature_callback_period¶

Function ID:	3
Request:	empty payload
Response:	period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by set_temperature_callback_period.

BrickletTemperature.set_temperature_callback_threshold¶

Function ID:	4
Request:	option – Type: char, Range: See meanings, Default: 'x' min – Type: int16, Unit: 1/100 °C, Range: [-215 to 215 - 1], Default: 0 max – Type: int16, Unit: 1/100 °C, Range: [-215 to 215 - 1], Default: 0
Response:	no response

Sets the thresholds for the CALLBACK_TEMPERATURE_REACHED callback.

The following options are possible:

Option	Description
'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 following meanings are defined for the elements of this function:

For option:

• 'x' = Off
• 'o' = Outside
• 'i' = Inside
• '<' = Smaller
• '>' = Greater

BrickletTemperature.get_temperature_callback_threshold¶

Function ID:	5
Request:	empty payload
Response:	option – Type: char, Range: See meanings, Default: 'x' min – Type: int16, Unit: 1/100 °C, Range: [-215 to 215 - 1], Default: 0 max – Type: int16, Unit: 1/100 °C, Range: [-215 to 215 - 1], Default: 0

Returns the threshold as set by set_temperature_callback_threshold.

The following meanings are defined for the elements of this function:

For option:

• 'x' = Off
• 'o' = Outside
• 'i' = Inside
• '<' = Smaller
• '>' = Greater

BrickletTemperature.set_debounce_period¶

Function ID:	6
Request:	debounce – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100
Response:	no response

Sets the period with which the threshold callback

• CALLBACK_TEMPERATURE_REACHED

is triggered, if the threshold

• set_temperature_callback_threshold

keeps being reached.

BrickletTemperature.get_debounce_period¶

Function ID:	7
Request:	empty payload
Response:	debounce – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by set_debounce_period.

Callbacks¶

BrickletTemperature.CALLBACK_TEMPERATURE¶

Function ID:	8
Response:	temperature – Type: int16, Unit: 1/100 °C, Range: [-2500 to 8500]

This callback is triggered periodically with the period that is set by set_temperature_callback_period. The response value is the temperature of the sensor.

The CALLBACK_TEMPERATURE callback is only triggered if the temperature has changed since the last triggering.

BrickletTemperature.CALLBACK_TEMPERATURE_REACHED¶

Function ID:	9
Response:	temperature – Type: int16, Unit: 1/100 °C, Range: [-2500 to 8500]

This callback is triggered when the threshold as set by set_temperature_callback_threshold is reached. The response value is the temperature of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by set_debounce_period.