MQTT - Temperature IR Bricklet 2.0

This is the description of the MQTT API bindings for the Temperature IR Bricklet 2.0. General information and technical specifications for the Temperature IR Bricklet 2.0 are summarized in its hardware description.

An installation guide for the MQTT API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Callback

Download (example-callback.txt)

1
2
3
4
5
6
7
8
9
# Change XYZ to the UID of your Temperature IR Bricklet 2.0

setup:
    # Handle incoming object temperature callbacks
    subscribe to tinkerforge/callback/temperature_ir_v2_bricklet/XYZ/object_temperature
    publish '{"register": true}' to tinkerforge/register/temperature_ir_v2_bricklet/XYZ/object_temperature # Register object_temperature callback
    
    # Set period for object temperature callback to 1s (1000ms) without a threshold
    publish '{"period": 1000, "value_has_to_change": false, "option": "off", "min": 0, "max": 0}' to tinkerforge/request/temperature_ir_v2_bricklet/XYZ/set_object_temperature_callback_configuration

Simple

Download (example-simple.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
# Change XYZ to the UID of your Temperature IR Bricklet 2.0

setup:
    # Get current ambient temperature
    subscribe to tinkerforge/response/temperature_ir_v2_bricklet/XYZ/get_ambient_temperature
    publish '' to tinkerforge/request/temperature_ir_v2_bricklet/XYZ/get_ambient_temperature
    
    # Get current object temperature
    subscribe to tinkerforge/response/temperature_ir_v2_bricklet/XYZ/get_object_temperature
    publish '' to tinkerforge/request/temperature_ir_v2_bricklet/XYZ/get_object_temperature

Water Boiling

Download (example-water-boiling.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
# Change XYZ to the UID of your Temperature IR Bricklet 2.0

setup:
    # Set emissivity to 0.98 (emissivity of water, 65535 * 0.98 = 64224.299)
    publish '{"emissivity": 64224}' to tinkerforge/request/temperature_ir_v2_bricklet/XYZ/set_emissivity 
    
    # Handle incoming object temperature reached callbacks
    subscribe to tinkerforge/callback/temperature_ir_v2_bricklet/XYZ/object_temperature
    publish '{"register": true}' to tinkerforge/register/temperature_ir_v2_bricklet/XYZ/object_temperature # Register object_temperature callback
    
    # Configure threshold for object temperature "greater than 100 °C"
    # with a debounce period of 10s (10000ms)
    publish '{"period": 10000, "value_has_to_change": false, "option": "greater", "min": 1000, "max": 0}' to tinkerforge/request/temperature_ir_v2_bricklet/XYZ/set_object_temperature_callback_configuration

API

All published payloads to and from the MQTT bindings are in JSON format.

If an error occures, the bindings publish a JSON object containing the error message as member _ERROR. It is published on the corresponding response topic: .../response/... for .../request/... and .../callback/... for .../register/....

Basic Functions

request/temperature_ir_v2_bricklet/<UID>/get_ambient_temperature
Request:
  • empty payload
Response:
  • temperature – Type: int, 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 value periodically, it is recommended to use the register/temperature_ir_v2_bricklet/<UID>/ambient_temperature callback. You can set the callback configuration with request/temperature_ir_v2_bricklet/<UID>/set_ambient_temperature_callback_configuration.

request/temperature_ir_v2_bricklet/<UID>/get_object_temperature
Request:
  • empty payload
Response:
  • temperature – Type: int, 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 request/temperature_ir_v2_bricklet/<UID>/set_emissivity.

If you want to get the value periodically, it is recommended to use the register/temperature_ir_v2_bricklet/<UID>/object_temperature callback. You can set the callback configuration with request/temperature_ir_v2_bricklet/<UID>/set_object_temperature_callback_configuration.

Advanced Functions

request/temperature_ir_v2_bricklet/<UID>/set_emissivity
Request:
  • emissivity – Type: int, Range: [0 to 216 - 1]
Response:
  • no response

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

request/temperature_ir_v2_bricklet/<UID>/get_emissivity
Request:
  • empty payload
Response:
  • emissivity – Type: int, Range: [0 to 216 - 1]

Returns the emissivity as set by request/temperature_ir_v2_bricklet/<UID>/set_emissivity.

request/temperature_ir_v2_bricklet/<UID>/get_spitfp_error_count
Request:
  • empty payload
Response:
  • error_count_ack_checksum – Type: int, Range: [0 to 232 - 1]
  • error_count_message_checksum – Type: int, Range: [0 to 232 - 1]
  • error_count_frame – Type: int, Range: [0 to 232 - 1]
  • error_count_overflow – Type: int, Range: [0 to 232 - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

request/temperature_ir_v2_bricklet/<UID>/set_bootloader_mode
Request:
  • mode – Type: int, Range: See symbols
Response:
  • status – Type: int, Range: See symbols

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following symbols are available for this function:

For mode:

  • "Bootloader" = 0
  • "Firmware" = 1
  • "BootloaderWaitForReboot" = 2
  • "FirmwareWaitForReboot" = 3
  • "FirmwareWaitForEraseAndReboot" = 4

For status:

  • "OK" = 0
  • "InvalidMode" = 1
  • "NoChange" = 2
  • "EntryFunctionNotPresent" = 3
  • "DeviceIdentifierIncorrect" = 4
  • "CRCMismatch" = 5
request/temperature_ir_v2_bricklet/<UID>/get_bootloader_mode
Request:
  • empty payload
Response:
  • mode – Type: int, Range: See symbols

Returns the current bootloader mode, see request/temperature_ir_v2_bricklet/<UID>/set_bootloader_mode.

The following symbols are available for this function:

For mode:

  • "Bootloader" = 0
  • "Firmware" = 1
  • "BootloaderWaitForReboot" = 2
  • "FirmwareWaitForReboot" = 3
  • "FirmwareWaitForEraseAndReboot" = 4
request/temperature_ir_v2_bricklet/<UID>/set_write_firmware_pointer
Request:
  • pointer – Type: int, Range: [0 to 232 - 1]
Response:
  • no response

Sets the firmware pointer for request/temperature_ir_v2_bricklet/<UID>/write_firmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

request/temperature_ir_v2_bricklet/<UID>/write_firmware
Request:
  • data – Type: [int, ...], Length: 64, Range: [0 to 255]
Response:
  • status – Type: int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by request/temperature_ir_v2_bricklet/<UID>/set_write_firmware_pointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

request/temperature_ir_v2_bricklet/<UID>/set_status_led_config
Request:
  • config – Type: int, Range: See symbols
Response:
  • no response

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following symbols are available for this function:

For config:

  • "Off" = 0
  • "On" = 1
  • "ShowHeartbeat" = 2
  • "ShowStatus" = 3
request/temperature_ir_v2_bricklet/<UID>/get_status_led_config
Request:
  • empty payload
Response:
  • config – Type: int, Range: See symbols

Returns the configuration as set by request/temperature_ir_v2_bricklet/<UID>/set_status_led_config

The following symbols are available for this function:

For config:

  • "Off" = 0
  • "On" = 1
  • "ShowHeartbeat" = 2
  • "ShowStatus" = 3
request/temperature_ir_v2_bricklet/<UID>/get_chip_temperature
Request:
  • empty payload
Response:
  • temperature – Type: int, Range: [-215 to 215 - 1]

Returns the temperature in °C as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

request/temperature_ir_v2_bricklet/<UID>/reset
Request:
  • empty payload
Response:
  • no response

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

request/temperature_ir_v2_bricklet/<UID>/write_uid
Request:
  • uid – Type: int, Range: [0 to 232 - 1]
Response:
  • no response

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

request/temperature_ir_v2_bricklet/<UID>/read_uid
Request:
  • empty payload
Response:
  • uid – Type: int, Range: [0 to 232 - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

request/temperature_ir_v2_bricklet/<UID>/get_identity
Request:
  • empty payload
Response:
  • uid – Type: string, Length: up to 8
  • connected_uid – Type: string, Length: up to 8
  • position – Type: char
  • hardware_version – Type: [int, ...], Length: 3, Range: [0 to 255]
  • firmware_version – Type: [int, ...], Length: 3, Range: [0 to 255]
  • device_identifier – Type: int, Range: [0 to 216 - 1]
  • _display_name – Type: string

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. If symbolic output is not disabled, the device identifier is mapped to the corresponding name in the format used in topics.

The display name contains the Temperature IR 2.0's name in a human readable form.

Callback Configuration Functions

request/temperature_ir_v2_bricklet/<UID>/set_ambient_temperature_callback_configuration
Request:
  • period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value_has_to_change – Type: bool, Default: false
  • option – Type: char, Range: See symbols, Default: "x"
  • min – Type: int, Range: [-215 to 215 - 1]
  • max – Type: int, Range: [-215 to 215 - 1]
Response:
  • no response

The period is the period with which the register/temperature_ir_v2_bricklet/<UID>/ambient_temperature callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the register/temperature_ir_v2_bricklet/<UID>/ambient_temperature callback.

The following options are possible:

Option Description
'x' Threshold is turned off
'o' Threshold is triggered when the value is outside the min and max values
'i' Threshold is triggered when the value is inside or equal to the min and max values
'<' Threshold is triggered when the value is smaller than the min value (max is ignored)
'>' Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

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

The following symbols are available for this function:

For option:

  • "Off" = "x"
  • "Outside" = "o"
  • "Inside" = "i"
  • "Smaller" = "<"
  • "Greater" = ">"
request/temperature_ir_v2_bricklet/<UID>/get_ambient_temperature_callback_configuration
Request:
  • empty payload
Response:
  • period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value_has_to_change – Type: bool, Default: false
  • option – Type: char, Range: See symbols, Default: "x"
  • min – Type: int, Range: [-215 to 215 - 1]
  • max – Type: int, Range: [-215 to 215 - 1]

Returns the callback configuration as set by request/temperature_ir_v2_bricklet/<UID>/set_ambient_temperature_callback_configuration.

The following symbols are available for this function:

For option:

  • "Off" = "x"
  • "Outside" = "o"
  • "Inside" = "i"
  • "Smaller" = "<"
  • "Greater" = ">"
request/temperature_ir_v2_bricklet/<UID>/set_object_temperature_callback_configuration
Request:
  • period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value_has_to_change – Type: bool, Default: false
  • option – Type: char, Range: See symbols, Default: "x"
  • min – Type: int, Range: [-215 to 215 - 1]
  • max – Type: int, Range: [-215 to 215 - 1]
Response:
  • no response

The period is the period with which the register/temperature_ir_v2_bricklet/<UID>/object_temperature callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the register/temperature_ir_v2_bricklet/<UID>/object_temperature callback.

The following options are possible:

Option Description
'x' Threshold is turned off
'o' Threshold is triggered when the value is outside the min and max values
'i' Threshold is triggered when the value is inside or equal to the min and max values
'<' Threshold is triggered when the value is smaller than the min value (max is ignored)
'>' Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

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

The following symbols are available for this function:

For option:

  • "Off" = "x"
  • "Outside" = "o"
  • "Inside" = "i"
  • "Smaller" = "<"
  • "Greater" = ">"
request/temperature_ir_v2_bricklet/<UID>/get_object_temperature_callback_configuration
Request:
  • empty payload
Response:
  • period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value_has_to_change – Type: bool, Default: false
  • option – Type: char, Range: See symbols, Default: "x"
  • min – Type: int, Range: [-215 to 215 - 1]
  • max – Type: int, Range: [-215 to 215 - 1]

Returns the callback configuration as set by request/temperature_ir_v2_bricklet/<UID>/set_object_temperature_callback_configuration.

The following symbols are available for this function:

For option:

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

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding .../register/... topic and an optional suffix. This suffix can be used to deregister the callback later.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

register/temperature_ir_v2_bricklet/<UID>/ambient_temperature
Register Request:
  • register – Type: bool
Callback Response:
  • temperature – Type: int, Range: [-215 to 215 - 1]

A callback can be registered for this event by publishing to the .../register/temperature_ir_v2_bricklet/<UID>/ambient_temperature[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/temperature_ir_v2_bricklet/<UID>/ambient_temperature[/<SUFFIX>] topic for each registered suffix.

This callback is triggered periodically according to the configuration set by request/temperature_ir_v2_bricklet/<UID>/set_ambient_temperature_callback_configuration.

The callback payload is the same as request/temperature_ir_v2_bricklet/<UID>/get_ambient_temperature.

register/temperature_ir_v2_bricklet/<UID>/object_temperature
Register Request:
  • register – Type: bool
Callback Response:
  • temperature – Type: int, Range: [-215 to 215 - 1]

A callback can be registered for this event by publishing to the .../register/temperature_ir_v2_bricklet/<UID>/object_temperature[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/temperature_ir_v2_bricklet/<UID>/object_temperature[/<SUFFIX>] topic for each registered suffix.

This callback is triggered periodically according to the configuration set by request/temperature_ir_v2_bricklet/<UID>/set_object_temperature_callback_configuration.

The callback payload is the same as request/temperature_ir_v2_bricklet/<UID>/get_object_temperature.