C# - 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
    - C/C++
    - C/C++ (iOS)
    - C#
      - Requirements
      - Installation
      - Testing an Example
      - CLS Compliance
      - API Reference and Examples
        - IP Connection
        - 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
            - Examples
              - Simple
              - Water Boiling
              - Callback
            - API
              - Basic Functions
              - Advanced Functions
              - Callback Configuration Functions
              - Callbacks
              - Constants
          - Tilt Bricklet
          - Voltage Bricklet
          - Voltage/Current Bricklet
    - C# (Windows Phone)
    - Delphi/Lazarus
    - Java
    - Java (Android)
    - JavaScript
    - LabVIEW
    - Mathematica
    - MATLAB/Octave
    - Perl
    - PHP
    - Python
    - Ruby
    - Shell
    - Visual Basic .NET
  - 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
  - Modbus Protocol
  - Wireshark Dissector

# C# - Temperature IR Bricklet

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

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

## Examples

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

### Simple

Download (ExampleSimple.cs)

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28

    using Tinkerforge;

    class Example
    {
        private static string HOST = "localhost";
        private static int PORT = 4223;
        private static string UID = "ABC"; // Change to your UID

        static void Main()
        {
            IPConnection ipcon = new IPConnection(); // Create IP connection
            BrickletTemperatureIR temp = new BrickletTemperatureIR(UID, ipcon); // Create device object

            ipcon.Connect(HOST, PORT); // Connect to brickd
            // Don't use device before ipcon is connected

            // Get current object and ambient temperatures (unit is °C/10)
            short obj = temp.GetObjectTemperature();
            short amb = temp.GetAmbientTemperature();

            System.Console.WriteLine("Object Temperature: " + obj/10.0 + " °C");
            System.Console.WriteLine("Ambient Temperature: " + amb/10.0 + " °C");

            System.Console.WriteLine("Press enter to exit");
            System.Console.ReadLine();
            ipcon.Disconnect();
        }
    }

### Water Boiling

Download (ExampleWaterBoiling.cs)

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41

    using Tinkerforge;

    class Example
    {
        private static string HOST = "localhost";
        private static int PORT = 4223;
        private static string UID = "ABC"; // Change to your UID

        // Callback for object temperature greater than 100 °C (parameter has unit °C/10)
        static void ReachedCB(BrickletTemperatureIR sender, short temperature)
        {
            System.Console.WriteLine("The surface has a temperature of " +
                                     temperature/10.0 + " °C");
            System.Console.WriteLine("The water is boiling!");
        }

        static void Main()
        {
            IPConnection ipcon = new IPConnection(); // Create IP connection
            BrickletTemperatureIR temp = new BrickletTemperatureIR(UID, ipcon); // Create device object

            ipcon.Connect(HOST, PORT); // Connect to brickd
            // Don't use device before ipcon is connected

            // Set emissivity to 0.98 (emissivity of water)
            temp.SetEmissivity((int)(0xFFFF*0.98));

            // Get threshold callbacks with a debounce time of 10 seconds (10000ms)
            temp.SetDebouncePeriod(10000);

            // Register threshold reached callback to function ReachedCB
            temp.ObjectTemperatureReached += ReachedCB;

            // Configure threshold for "greater than 100 °C" (unit is °C/10)
            temp.SetObjectTemperatureCallbackThreshold('>', 100*10, 0);

            System.Console.WriteLine("Press enter to exit");
            System.Console.ReadLine();
            ipcon.Disconnect();
        }
    }

### Callback

Download (ExampleCallback.cs)

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44

    using Tinkerforge;

    class Example
    {
        private static string HOST = "localhost";
        private static int PORT = 4223;
        private static string UID = "ABC"; // Change to your UID

        // Callback functions for object/ambient temperature callback
        // (parameters have unit °C/10)
        static void ObjectCB(BrickletTemperatureIR sender, short temperature)
        {
            System.Console.WriteLine("Object Temperature: " + temperature/10.0 + " °C");
        }

        static void AmbientCB(BrickletTemperatureIR sender, short temperature)
        {
            System.Console.WriteLine("Ambient Temperature: " + temperature/10.0 + " °C");
        }

        static void Main()
        {
            IPConnection ipcon = new IPConnection(); // Create IP connection
            BrickletTemperatureIR temp = new BrickletTemperatureIR(UID, ipcon); // Create device object

            ipcon.Connect(HOST, PORT); // Connect to brickd
            // Don't use device before ipcon is connected

            // Set Period for temperature callbacks to 1s (1000ms)
            // Note: The callbacks are only called every second if the
            //       value has changed since the last call!
            temp.SetObjectTemperatureCallbackPeriod(1000);
            temp.SetAmbientTemperatureCallbackPeriod(1000);

            // Register object temperature callback to function ObjectCB
            temp.ObjectTemperature += ObjectCB;
            // Register ambient temperature callback to function AmbientCB
            temp.AmbientTemperature += AmbientCB;

            System.Console.WriteLine("Press enter to exit");
            System.Console.ReadLine();
            ipcon.Disconnect();
        }
    }

## API

Generally, every method of the C# bindings that returns a value can throw a `Tinkerforge.TimeoutException`. This exception gets thrown if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody plugs the device out). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Since C# does not support multiple return values directly, we use the `out` keyword to return multiple values from a method.

The namespace for all Brick/Bricklet bindings and the IPConnection is `Tinkerforge.*`.

All methods listed below are thread-safe.

### Basic Functions

public class `BrickletTemperatureIR`(String uid, IPConnection ipcon)

  Creates an object with the unique device ID `uid`:

      BrickletTemperatureIR temperatureIR = new BrickletTemperatureIR("YOUR_DEVICE_UID", ipcon);

  This object can then be used after the IP Connection is connected (see examples above).

public short `GetAmbientTemperature`()

  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 `AmbientTemperature` and set the period with `SetAmbientTemperatureCallbackPeriod()`.

public short `GetObjectTemperature`()

  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 `SetEmissivity()`.

  If you want to get the object temperature periodically, it is recommended to use the callback `ObjectTemperature` and set the period with `SetObjectTemperatureCallbackPeriod()`.

### Advanced Functions

public void `SetEmissivity`(int emissivity)

  Sets the emissivity that is used to calculate the surface temperature as returned by `GetObjectTemperature()`.

  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 `SetEmissivity()` 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).

public int `GetEmissivity`()

  Returns the emissivity as set by `SetEmissivity()`.

public byte[] `GetAPIVersion`()

  Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

public bool `GetResponseExpected`(byte functionId)

  Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

  For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by `SetResponseExpected()`. For setter functions it is disabled by default and can be enabled.

  Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

  See `SetResponseExpected()` for the list of function ID constants available for this function.

public void `SetResponseExpected`(byte functionId, bool responseExpected)

  Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled and callbacks it is always disabled.

  Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

  The following function ID constants are available for this function:

  - BrickletTemperatureIR.FUNCTION_SET_EMISSIVITY = 3
  - BrickletTemperatureIR.FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD = 5
  - BrickletTemperatureIR.FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_PERIOD = 7
  - BrickletTemperatureIR.FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_THRESHOLD = 9
  - BrickletTemperatureIR.FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_THRESHOLD = 11
  - BrickletTemperatureIR.FUNCTION_SET_DEBOUNCE_PERIOD = 13

public void `SetResponseExpectedAll`(bool responseExpected)

  Changes the response expected flag for all setter and callback configuration functions of this device at once.

public void `GetIdentity`(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)

  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. There is also a constant for the device identifier of this Bricklet.

### Callback Configuration Functions

public void `SetAmbientTemperatureCallbackPeriod`(long period)

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

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

  The default value is 0.

public long `GetAmbientTemperatureCallbackPeriod`()

  Returns the period as set by `SetAmbientTemperatureCallbackPeriod()`.

public void `SetObjectTemperatureCallbackPeriod`(long period)

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

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

  The default value is 0.

public long `GetObjectTemperatureCallbackPeriod`()

  Returns the period as set by `SetObjectTemperatureCallbackPeriod()`.

public void `SetAmbientTemperatureCallbackThreshold`(char option, short min, short max)

  Sets the thresholds for the `AmbientTemperatureReached` 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 constants are available for this function:

  - BrickletTemperatureIR.THRESHOLD_OPTION_OFF = 'x'
  - BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = 'o'
  - BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = 'i'
  - BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = '<'
  - BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = '>'

public void `GetAmbientTemperatureCallbackThreshold`(out char option, out short min, out short max)

  Returns the threshold as set by `SetAmbientTemperatureCallbackThreshold()`.

  The following constants are available for this function:

  - BrickletTemperatureIR.THRESHOLD_OPTION_OFF = 'x'
  - BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = 'o'
  - BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = 'i'
  - BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = '<'
  - BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = '>'

public void `SetObjectTemperatureCallbackThreshold`(char option, short min, short max)

  Sets the thresholds for the `ObjectTemperatureReached` 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 constants are available for this function:

  - BrickletTemperatureIR.THRESHOLD_OPTION_OFF = 'x'
  - BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = 'o'
  - BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = 'i'
  - BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = '<'
  - BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = '>'

public void `GetObjectTemperatureCallbackThreshold`(out char option, out short min, out short max)

  Returns the threshold as set by `SetObjectTemperatureCallbackThreshold()`.

  The following constants are available for this function:

  - BrickletTemperatureIR.THRESHOLD_OPTION_OFF = 'x'
  - BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = 'o'
  - BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = 'i'
  - BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = '<'
  - BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = '>'

public void `SetDebouncePeriod`(long debounce)

  Sets the period in ms with which the threshold callbacks

  - `AmbientTemperatureReached`,
  - `ObjectTemperatureReached`

  are triggered, if the thresholds

  - `SetAmbientTemperatureCallbackThreshold()`,
  - `SetObjectTemperatureCallbackThreshold()`

  keep being reached.

  The default value is 100.

public long `GetDebouncePeriod`()

  Returns the debounce period as set by `SetDebouncePeriod()`.

### Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by appending your callback handler to the corresponding event:

    void Callback(BrickletTemperatureIR sender, int value)
    {
        System.Console.WriteLine("Value: " + value);
    }

    temperatureIR.ExampleCallback += Callback;

The available events are described below.

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.

public event `AmbientTemperature`(BrickletTemperatureIR sender, short temperature)

  This callback is triggered periodically with the period that is set by `SetAmbientTemperatureCallbackPeriod()`. The parameter is the ambient temperature of the sensor.

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

public event `ObjectTemperature`(BrickletTemperatureIR sender, short temperature)

  This callback is triggered periodically with the period that is set by `SetObjectTemperatureCallbackPeriod()`. The parameter is the object temperature of the sensor.

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

public event `AmbientTemperatureReached`(BrickletTemperatureIR sender, short temperature)

  This callback is triggered when the threshold as set by `SetAmbientTemperatureCallbackThreshold()` is reached. The parameter is the ambient temperature of the sensor.

  If the threshold keeps being reached, the callback is triggered periodically with the period as set by `SetDebouncePeriod()`.

public event `ObjectTemperatureReached`(BrickletTemperatureIR sender, short temperature)

  This callback is triggered when the threshold as set by `SetObjectTemperatureCallbackThreshold()` is reached. The parameter is the object temperature of the sensor.

  If the threshold keeps being reached, the callback is triggered periodically with the period as set by `SetDebouncePeriod()`.

### Constants

public int `DEVICE_IDENTIFIER`

  This constant is used to identify a Temperature IR Bricklet.

  The `GetIdentity()` function and the `EnumerateCallback` callback of the IP Connection have a `deviceIdentifier` parameter to specify the Brick's or Bricklet's type.

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