TCP/IP - Temperature IR Bricklet – Tinkerforge

- Getting Started
  - Primer
  - Tutorials
  - FAQ
- Hardware
  - Bricks
  - Bricklets
  - Master Extensions
  - Power Supplies
  - Accessories
  - Timeline
- Software
  - Brick Daemon (brickd)
  - Brick Viewer (brickv)
  - API Bindings
  - Firmwares and Plugins
  - Device Identifier
  - Source Code and Bug Tracking
  - Programming Interface
- Starter Kits
  - Weather Station
  - Hardware Hacking
  - Server Room Monitoring
  - Blinkenlights
  - Internet of Things
  - Camera Slider
- Embedded Boards
  - Raspberry Pi
- Specifications
  - Technical Data
  - TCP/IP Protocol
    - Protocol
    - API
      - Brick Daemon Functions
      - Broadcast Functions
      - General Callbacks
      - Bricks and Bricklets
        - Bricks
        - Bricklets
          - Ambient Light Bricklet
          - Analog In Bricklet
          - Analog Out Bricklet
          - Barometer Bricklet
          - Color Bricklet
          - Current12 Bricklet
          - Current25 Bricklet
          - Distance IR Bricklet
          - Distance US Bricklet
          - Dual Button Bricklet
          - Dual Relay Bricklet
          - GPS Bricklet
          - Hall Effect Bricklet
          - Humidity Bricklet
          - Industrial Digital In 4 Bricklet
          - Industrial Digital Out 4 Bricklet
          - Industrial Dual 0-20mA Bricklet
          - Industrial Quad Relay Bricklet
          - IO-16 Bricklet
          - IO-4 Bricklet
          - Joystick Bricklet
          - LCD 16x2 Bricklet
          - LCD 20x4 Bricklet
          - LED Strip Bricklet
          - Line Bricklet
          - Linear Poti Bricklet
          - Moisture Bricklet
          - Motion Detector Bricklet
          - Multi Touch Bricklet
          - NFC/RFID Bricklet
          - Piezo Buzzer Bricklet
          - Piezo Speaker Bricklet
          - PTC Bricklet
          - Remote Switch Bricklet
          - Rotary Encoder Bricklet
          - Rotary Poti Bricklet
          - Segment Display 4x7 Bricklet
          - Solid State Relay Bricklet
          - Sound Intensity Bricklet
          - Temperature Bricklet
          - Temperature IR Bricklet
            - API
              - Basic Functions
              - Advanced Functions
              - Callback Configuration Functions
              - Callbacks
          - Tilt Bricklet
          - Voltage Bricklet
          - Voltage/Current Bricklet
  - Modbus Protocol
  - Wireshark Dissector

# 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 -- int16

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

`BrickletTemperatureIR.``get_object_temperature`

  Function ID: | 2
  Request: | empty payload

  Response:

  - temperature -- int16

  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 `CALLBACK_OBJECT_TEMPERATURE` and set the period with `set_object_temperature_callback_period`.

### Advanced Functions

`BrickletTemperatureIR.``set_emissivity`

  Function ID: | 3

  Request:

  - emissivity -- uint16

  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).

`BrickletTemperatureIR.``get_emissivity`

  Function ID: | 4
  Request: | empty payload

  Response:

  - emissivity -- uint16

  Returns the emissivity as set by `set_emissivity`.

`BrickletTemperatureIR.``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 identifier numbers can be found here.

### Callback Configuration Functions

`BrickletTemperatureIR.``set_ambient_temperature_callback_period`

  Function ID: | 5

  Request:

  - period -- uint32

  Response: | no response

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

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

  The default value is 0.

`BrickletTemperatureIR.``get_ambient_temperature_callback_period`

  Function ID: | 6
  Request: | empty payload

  Response:

  - period -- uint32

  Returns the period as set by `set_ambient_temperature_callback_period`.

`BrickletTemperatureIR.``set_object_temperature_callback_period`

  Function ID: | 7

  Request:

  - period -- uint32

  Response: | no response

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

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

  The default value is 0.

`BrickletTemperatureIR.``get_object_temperature_callback_period`

  Function ID: | 8
  Request: | empty payload

  Response:

  - period -- uint32

  Returns the period as set by `set_object_temperature_callback_period`.

`BrickletTemperatureIR.``set_ambient_temperature_callback_threshold`

  Function ID: | 9

  Request:

  - option -- char
  - min -- int16
  - max -- int16

  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).

`BrickletTemperatureIR.``get_ambient_temperature_callback_threshold`

  Function ID: | 10
  Request: | empty payload

  Response:

  - option -- char
  - min -- int16
  - max -- int16

  Returns the threshold as set by `set_ambient_temperature_callback_threshold`.

`BrickletTemperatureIR.``set_object_temperature_callback_threshold`

  Function ID: | 11

  Request:

  - option -- char
  - min -- int16
  - max -- int16

  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).

`BrickletTemperatureIR.``get_object_temperature_callback_threshold`

  Function ID: | 12
  Request: | empty payload

  Response:

  - option -- char
  - min -- int16
  - max -- int16

  Returns the threshold as set by `set_object_temperature_callback_threshold`.

`BrickletTemperatureIR.``set_debounce_period`

  Function ID: | 13

  Request:

  - debounce -- uint32

  Response: | no response

  Sets the period in ms with which the threshold callbacks

  - `CALLBACK_AMBIENT_TEMPERATURE_REACHED`,
  - `CALLBACK_OBJECT_TEMPERATURE_REACHED`

  are triggered, if the thresholds

  - `set_ambient_temperature_callback_threshold`,
  - `set_object_temperature_callback_threshold`

  keep being reached.

  The default value is 100.

`BrickletTemperatureIR.``get_debounce_period`

  Function ID: | 14
  Request: | empty payload

  Response:

  - debounce -- uint32

  Returns the debounce period as set by `set_debounce_period`.

### Callbacks

`BrickletTemperatureIR.``CALLBACK_AMBIENT_TEMPERATURE`

  Function ID: | 15

  Response:

  - temperature -- int16

  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.

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

`BrickletTemperatureIR.``CALLBACK_OBJECT_TEMPERATURE`

  Function ID: | 16

  Response:

  - temperature -- int16

  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.

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

`BrickletTemperatureIR.``CALLBACK_AMBIENT_TEMPERATURE_REACHED`

  Function ID: | 17

  Response:

  - temperature -- int16

  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 -- int16

  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`.

The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.