C# - PTC Bricklet

This is the description of the C# API bindings for the PTC Bricklet. General information and technical specifications for the PTC 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
using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your PTC Bricklet

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

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

        // Get current temperature
        int temperature = ptc.GetTemperature();
        Console.WriteLine("Temperature: " + temperature/100.0 + " °C");

        Console.WriteLine("Press enter to exit");
        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
using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your PTC Bricklet

    // Callback function for temperature callback
    static void TemperatureCB(BrickletPTC sender, int temperature)
    {
        Console.WriteLine("Temperature: " + temperature/100.0 + " °C");
    }

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

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

        // Register temperature callback to function TemperatureCB
        ptc.TemperatureCallback += TemperatureCB;

        // Set period for temperature callback to 1s (1000ms)
        // Note: The temperature callback is only called every second
        //       if the temperature has changed since the last call!
        ptc.SetTemperatureCallbackPeriod(1000);

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

Threshold

Download (ExampleThreshold.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
using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your PTC Bricklet

    // Callback function for temperature reached callback
    static void TemperatureReachedCB(BrickletPTC sender, int temperature)
    {
        Console.WriteLine("Temperature: " + temperature/100.0 + " °C");
    }

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

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

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

        // Register temperature reached callback to function TemperatureReachedCB
        ptc.TemperatureReachedCallback += TemperatureReachedCB;

        // Configure threshold for temperature "greater than 30 °C"
        ptc.SetTemperatureCallbackThreshold('>', 30*100, 0);

        Console.WriteLine("Press enter to exit");
        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

class BrickletPTC(String uid, IPConnection ipcon)
Parameters:
  • uid – Type: String
  • ipcon – Type: IPConnection
Returns:
  • ptc – Type: BrickletPTC

Creates an object with the unique device ID uid:

BrickletPTC ptc = new BrickletPTC("YOUR_DEVICE_UID", ipcon);

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

int BrickletPTC.GetTemperature()
Returns:
  • temperature – Type: int, Range: [-231 to 231 - 1]

Returns the temperature of connected sensor. The value has a range of -246 to 849 °C 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 TemperatureCallback callback and set the period with SetTemperatureCallbackPeriod().

bool BrickletPTC.IsSensorConnected()
Returns:
  • connected – Type: bool

Returns true if the sensor is connected correctly.

If this function returns false, there is either no Pt100 or Pt1000 sensor connected, the sensor is connected incorrectly or the sensor itself is faulty.

void BrickletPTC.SetWireMode(byte mode)
Parameters:
  • mode – Type: byte, Range: See constants

Sets the wire mode of the sensor. Possible values are 2, 3 and 4 which correspond to 2-, 3- and 4-wire sensors. The value has to match the jumper configuration on the Bricklet.

The default value is 2 = 2-wire.

The following constants are available for this function:

For mode:

  • BrickletPTC.WIRE_MODE_2 = 2
  • BrickletPTC.WIRE_MODE_3 = 3
  • BrickletPTC.WIRE_MODE_4 = 4
byte BrickletPTC.GetWireMode()
Returns:
  • mode – Type: byte, Range: See constants

Returns the wire mode as set by SetWireMode()

The following constants are available for this function:

For mode:

  • BrickletPTC.WIRE_MODE_2 = 2
  • BrickletPTC.WIRE_MODE_3 = 3
  • BrickletPTC.WIRE_MODE_4 = 4

Advanced Functions

int BrickletPTC.GetResistance()
Returns:
  • resistance – Type: int, Range: [-231 to 231 - 1]

Returns the value as measured by the MAX31865 precision delta-sigma ADC.

The value can be converted with the following formulas:

  • Pt100: resistance = (value * 390) / 32768
  • Pt1000: resistance = (value * 3900) / 32768

If you want to get the resistance periodically, it is recommended to use the ResistanceCallback callback and set the period with SetResistanceCallbackPeriod().

void BrickletPTC.SetNoiseRejectionFilter(byte filter)
Parameters:
  • filter – Type: byte, Range: See constants

Sets the noise rejection filter to either 50Hz (0) or 60Hz (1). Noise from 50Hz or 60Hz power sources (including harmonics of the AC power's fundamental frequency) is attenuated by 82dB.

Default value is 0 = 50Hz.

The following constants are available for this function:

For filter:

  • BrickletPTC.FILTER_OPTION_50HZ = 0
  • BrickletPTC.FILTER_OPTION_60HZ = 1
byte BrickletPTC.GetNoiseRejectionFilter()
Returns:
  • filter – Type: byte, Range: See constants

Returns the noise rejection filter option as set by SetNoiseRejectionFilter()

The following constants are available for this function:

For filter:

  • BrickletPTC.FILTER_OPTION_50HZ = 0
  • BrickletPTC.FILTER_OPTION_60HZ = 1
byte[] BrickletPTC.GetAPIVersion()
Returns:
  • apiVersion – Type: byte[], Length: 3, Range: [0 to 255]

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.

bool BrickletPTC.GetResponseExpected(byte functionId)
Parameters:
  • functionId – Type: byte, Range: See constants
Returns:
  • responseExpected – Type: bool

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.

The following constants are available for this function:

For functionId:

  • BrickletPTC.FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 3
  • BrickletPTC.FUNCTION_SET_RESISTANCE_CALLBACK_PERIOD = 5
  • BrickletPTC.FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 7
  • BrickletPTC.FUNCTION_SET_RESISTANCE_CALLBACK_THRESHOLD = 9
  • BrickletPTC.FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • BrickletPTC.FUNCTION_SET_NOISE_REJECTION_FILTER = 17
  • BrickletPTC.FUNCTION_SET_WIRE_MODE = 20
  • BrickletPTC.FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 22
void BrickletPTC.SetResponseExpected(byte functionId, bool responseExpected)
Parameters:
  • functionId – Type: byte, Range: See constants
  • responseExpected – Type: bool

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.

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 constants are available for this function:

For functionId:

  • BrickletPTC.FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 3
  • BrickletPTC.FUNCTION_SET_RESISTANCE_CALLBACK_PERIOD = 5
  • BrickletPTC.FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 7
  • BrickletPTC.FUNCTION_SET_RESISTANCE_CALLBACK_THRESHOLD = 9
  • BrickletPTC.FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • BrickletPTC.FUNCTION_SET_NOISE_REJECTION_FILTER = 17
  • BrickletPTC.FUNCTION_SET_WIRE_MODE = 20
  • BrickletPTC.FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 22
void BrickletPTC.SetResponseExpectedAll(bool responseExpected)
Parameters:
  • responseExpected – Type: bool

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

void BrickletPTC.GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)
Output Parameters:
  • uid – Type: string, Length: up to 8
  • connectedUid – Type: string, Length: up to 8
  • position – Type: char
  • hardwareVersion – Type: byte[], Length: 3, Range: [0 to 255]
  • firmwareVersion – Type: byte[], Length: 3, Range: [0 to 255]
  • deviceIdentifier – Type: int, 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. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

void BrickletPTC.SetTemperatureCallbackPeriod(long period)
Parameters:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

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

long BrickletPTC.GetTemperatureCallbackPeriod()
Returns:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by SetTemperatureCallbackPeriod().

void BrickletPTC.SetResistanceCallbackPeriod(long period)
Parameters:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

The ResistanceCallback callback is only triggered if the resistance has changed since the last triggering.

long BrickletPTC.GetResistanceCallbackPeriod()
Returns:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by SetResistanceCallbackPeriod().

void BrickletPTC.SetTemperatureCallbackThreshold(char option, int min, int max)
Parameters:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: int, Range: [-231 to 231 - 1]
  • max – Type: int, Range: [-231 to 231 - 1]

Sets the thresholds for the TemperatureReachedCallback 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).

The following constants are available for this function:

For option:

  • BrickletPTC.THRESHOLD_OPTION_OFF = 'x'
  • BrickletPTC.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletPTC.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletPTC.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletPTC.THRESHOLD_OPTION_GREATER = '>'
void BrickletPTC.GetTemperatureCallbackThreshold(out char option, out int min, out int max)
Output Parameters:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: int, Range: [-231 to 231 - 1]
  • max – Type: int, Range: [-231 to 231 - 1]

Returns the threshold as set by SetTemperatureCallbackThreshold().

The following constants are available for this function:

For option:

  • BrickletPTC.THRESHOLD_OPTION_OFF = 'x'
  • BrickletPTC.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletPTC.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletPTC.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletPTC.THRESHOLD_OPTION_GREATER = '>'
void BrickletPTC.SetResistanceCallbackThreshold(char option, int min, int max)
Parameters:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: int, Range: [-231 to 231 - 1]
  • max – Type: int, Range: [-231 to 231 - 1]

Sets the thresholds for the ResistanceReachedCallback 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).

The following constants are available for this function:

For option:

  • BrickletPTC.THRESHOLD_OPTION_OFF = 'x'
  • BrickletPTC.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletPTC.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletPTC.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletPTC.THRESHOLD_OPTION_GREATER = '>'
void BrickletPTC.GetResistanceCallbackThreshold(out char option, out int min, out int max)
Output Parameters:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: int, Range: [-231 to 231 - 1]
  • max – Type: int, Range: [-231 to 231 - 1]

Returns the threshold as set by SetResistanceCallbackThreshold().

The following constants are available for this function:

For option:

  • BrickletPTC.THRESHOLD_OPTION_OFF = 'x'
  • BrickletPTC.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletPTC.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletPTC.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletPTC.THRESHOLD_OPTION_GREATER = '>'
void BrickletPTC.SetDebouncePeriod(long debounce)
Parameters:
  • debounce – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Sets the period with which the threshold callback

is triggered, if the threshold

keeps being reached.

long BrickletPTC.GetDebouncePeriod()
Returns:
  • debounce – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by SetDebouncePeriod().

void BrickletPTC.SetSensorConnectedCallbackConfiguration(bool enabled)
Parameters:
  • enabled – Type: bool

If you enable this callback, the SensorConnectedCallback callback is triggered every time a Pt sensor is connected/disconnected.

By default this callback is disabled.

New in version 2.0.2 (Plugin).

bool BrickletPTC.GetSensorConnectedCallbackConfiguration()
Returns:
  • enabled – Type: bool

Returns the configuration as set by SetSensorConnectedCallbackConfiguration().

New in version 2.0.2 (Plugin).

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 MyCallback(BrickletPTC sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

ptc.ExampleCallback += MyCallback;

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.

event BrickletPTC.TemperatureCallback(BrickletPTC sender, int temperature)
Callback Parameters:
  • sender – Type: BrickletPTC
  • temperature – Type: int, Range: [-231 to 231 - 1]

This callback is triggered periodically with the period that is set by SetTemperatureCallbackPeriod(). The parameter is the temperature of the connected sensor.

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

event BrickletPTC.TemperatureReachedCallback(BrickletPTC sender, int temperature)
Callback Parameters:
  • sender – Type: BrickletPTC
  • temperature – Type: int, Range: [-231 to 231 - 1]

This callback is triggered when the threshold as set by SetTemperatureCallbackThreshold() is reached. The parameter is the temperature of the connected sensor.

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

event BrickletPTC.ResistanceCallback(BrickletPTC sender, int resistance)
Callback Parameters:
  • sender – Type: BrickletPTC
  • resistance – Type: int, Range: [-231 to 231 - 1]

This callback is triggered periodically with the period that is set by SetResistanceCallbackPeriod(). The parameter is the resistance of the connected sensor.

The ResistanceCallback callback is only triggered if the resistance has changed since the last triggering.

event BrickletPTC.ResistanceReachedCallback(BrickletPTC sender, int resistance)
Callback Parameters:
  • sender – Type: BrickletPTC
  • resistance – Type: int, Range: [-231 to 231 - 1]

This callback is triggered when the threshold as set by SetResistanceCallbackThreshold() is reached. The parameter is the resistance of the connected sensor.

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

event BrickletPTC.SensorConnectedCallback(BrickletPTC sender, bool connected)
Callback Parameters:
  • sender – Type: BrickletPTC
  • connected – Type: bool

This callback is triggered periodically according to the configuration set by SetSensorConnectedCallbackConfiguration().

The parameter is the same as IsSensorConnected().

New in version 2.0.2 (Plugin).

Constants

int BrickletPTC.DEVICE_IDENTIFIER

This constant is used to identify a PTC Bricklet.

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

string BrickletPTC.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a PTC Bricklet.