TCP/IP - Temperature Bricklet

This is the API description for the TCP/IP protocol of the Temperature Bricklet. General information on what this device does and the technical specifications can be found here.

A tutorial on how to test the Temperature Bricklet and get the first examples running can be found here.

API

A general description of the TCP/IP protocol structure can be found here.

Basic Functions

Temperature.get_temperature

Function ID:

1

Request:

empty payload

Response:

• temperature – int16

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 CALLBACK_TEMPERATURE and set the period with set_temperature_callback_period.

Advanced Functions

Temperature.set_i2c_mode

Function ID:

10

Request:

• mode – uint8

Response:

no response

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.

New in version 2.0.1 (Plugin).

Temperature.get_i2c_mode

Function ID:

11

Request:

empty payload

Response:

• mode – uint8

Returns the I2C mode as set by set_i2c_mode.

New in version 2.0.1 (Plugin).

Temperature.get_identity

Function ID:

255

Request:

empty payload

Response:

• uid – char[8]
• connected_uid – char[8]
• position – char
• hardware_version – uint8[3]
• firmware_version – uint8[3]
• device_identifier – uint16

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 identifiers can be found here.

New in version 2.0.0 (Plugin).

Callback Configuration Functions

Temperature.set_temperature_callback_period

Function ID:

2

Request:

• period – uint32

Response:

no response

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

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

The default value is 0.

Temperature.get_temperature_callback_period

Function ID:

3

Request:

empty payload

Response:

• period – uint32

Returns the period as set by set_temperature_callback_period.

Temperature.set_temperature_callback_threshold

Function ID:

4

Request:

• option – char
• min – int16
• max – int16

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 default value is (‘x’, 0, 0).

Temperature.get_temperature_callback_threshold

Function ID:

5

Request:

empty payload

Response:

• option – char
• min – int16
• max – int16

Returns the threshold as set by set_temperature_callback_threshold.

Temperature.set_debounce_period

Function ID:

6

Request:

• debounce – uint32

Response:

no response

Sets the period in ms with which the threshold callback

CALLBACK_TEMPERATURE_REACHED

is triggered, if the threshold

set_temperature_callback_threshold

keeps being reached.

The default value is 100.

Temperature.get_debounce_period

Function ID:

7

Request:

empty payload

Response:

• debounce – uint32

Returns the debounce period as set by set_debounce_period.

Callbacks

Temperature.CALLBACK_TEMPERATURE

Function ID:

8

Response:

• temperature – int16

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.

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

Temperature.CALLBACK_TEMPERATURE_REACHED

Function ID:

9

Response:

• temperature – int16

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.

Constants

Temperature.DEVICE_IDENTIFIER

Value:216

This constant is used to identify a Temperature Bricklet.

The get_identity function and the CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick’s or Bricklet’s type.