TCP/IP - Temperature IR Bricklet

This is the description of the TCP/IP protocol for the Temperature IR Bricklet. General information and technical specifications for the Temperature IR Bricklet are summarized in its hardware description.

API

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

Basic Functions

BrickletTemperatureIR.get_ambient_temperature
Function ID:
  • 1
Request:
  • empty payload
Response:
  • temperature – Type: int16, Range: [-215 to 215 - 1]

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 CALLBACK_AMBIENT_TEMPERATURE callback and set the period with set_ambient_temperature_callback_period.

BrickletTemperatureIR.get_object_temperature
Function ID:
  • 2
Request:
  • empty payload
Response:
  • temperature – Type: int16, Range: [-215 to 215 - 1]

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. The emissivity of the material can be set with set_emissivity.

If you want to get the object temperature periodically, it is recommended to use the CALLBACK_OBJECT_TEMPERATURE callback and set the period with set_object_temperature_callback_period.

Advanced Functions

BrickletTemperatureIR.set_emissivity
Function ID:
  • 3
Request:
  • emissivity – Type: uint16, Range: [0 to 216 - 1]
Response:
  • no response

Sets the emissivity that is used to calculate the surface temperature as returned by 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.

The parameter of 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).

The emissivity is stored in non-volatile memory and will still be used after a restart or power cycle of the Bricklet.

BrickletTemperatureIR.get_emissivity
Function ID:
  • 4
Request:
  • empty payload
Response:
  • emissivity – Type: uint16, Range: [0 to 216 - 1]

Returns the emissivity as set by set_emissivity.

BrickletTemperatureIR.get_identity
Function ID:
  • 255
Request:
  • empty payload
Response:
  • uid – Type: char[8]
  • connected_uid – Type: char[8]
  • position – Type: char
  • hardware_version – Type: uint8[3], Range: [0 to 255]
  • firmware_version – Type: uint8[3], 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' or 'd'.

The device identifier numbers can be found here

Callback Configuration Functions

BrickletTemperatureIR.set_ambient_temperature_callback_period
Function ID:
  • 5
Request:
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Response:
  • no response

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

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

BrickletTemperatureIR.get_ambient_temperature_callback_period
Function ID:
  • 6
Request:
  • empty payload
Response:
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by set_ambient_temperature_callback_period.

BrickletTemperatureIR.set_object_temperature_callback_period
Function ID:
  • 7
Request:
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Response:
  • no response

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

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

BrickletTemperatureIR.get_object_temperature_callback_period
Function ID:
  • 8
Request:
  • empty payload
Response:
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by set_object_temperature_callback_period.

BrickletTemperatureIR.set_ambient_temperature_callback_threshold
Function ID:
  • 9
Request:
  • option – Type: char, Range: See meanings, Default: 'x'
  • min – Type: int16, Range: [-215 to 215 - 1]
  • max – Type: int16, Range: [-215 to 215 - 1]
Response:
  • no response

Sets the thresholds for the CALLBACK_AMBIENT_TEMPERATURE_REACHED callback.

The following options are possible:

Option Description
'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).

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

For option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletTemperatureIR.get_ambient_temperature_callback_threshold
Function ID:
  • 10
Request:
  • empty payload
Response:
  • option – Type: char, Range: See meanings, Default: 'x'
  • min – Type: int16, Range: [-215 to 215 - 1]
  • max – Type: int16, Range: [-215 to 215 - 1]

Returns the threshold as set by set_ambient_temperature_callback_threshold.

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

For option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletTemperatureIR.set_object_temperature_callback_threshold
Function ID:
  • 11
Request:
  • option – Type: char, Range: See meanings, Default: 'x'
  • min – Type: int16, Range: [-215 to 215 - 1]
  • max – Type: int16, Range: [-215 to 215 - 1]
Response:
  • no response

Sets the thresholds for the CALLBACK_OBJECT_TEMPERATURE_REACHED callback.

The following options are possible:

Option Description
'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).

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

For option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletTemperatureIR.get_object_temperature_callback_threshold
Function ID:
  • 12
Request:
  • empty payload
Response:
  • option – Type: char, Range: See meanings, Default: 'x'
  • min – Type: int16, Range: [-215 to 215 - 1]
  • max – Type: int16, Range: [-215 to 215 - 1]

Returns the threshold as set by set_object_temperature_callback_threshold.

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

For option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletTemperatureIR.set_debounce_period
Function ID:
  • 13
Request:
  • debounce – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100
Response:
  • no response

Sets the period with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

BrickletTemperatureIR.get_debounce_period
Function ID:
  • 14
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

BrickletTemperatureIR.CALLBACK_AMBIENT_TEMPERATURE
Function ID:
  • 15
Response:
  • temperature – Type: int16, Range: [-215 to 215 - 1]

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

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

BrickletTemperatureIR.CALLBACK_OBJECT_TEMPERATURE
Function ID:
  • 16
Response:
  • temperature – Type: int16, Range: [-215 to 215 - 1]

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

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

BrickletTemperatureIR.CALLBACK_AMBIENT_TEMPERATURE_REACHED
Function ID:
  • 17
Response:
  • temperature – Type: int16, Range: [-215 to 215 - 1]

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

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

BrickletTemperatureIR.CALLBACK_OBJECT_TEMPERATURE_REACHED
Function ID:
  • 18
Response:
  • temperature – Type: int16, Range: [-215 to 215 - 1]

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

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