..
 #############################################################
 # This file was automatically generated on 2015-05-08.      #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #
 # to the generators git repository on tinkerforge.com       #
 #############################################################


:breadcrumbs: <a href="../../index.html">Home</a> / <a href="../../index.html#software-csharp">Software</a> / C# - PTC Bricklet

.. |device_identifier_constant| replace:: There is also a :ref:`constant <ptc_bricklet_csharp_constants>` for the device identifier of this Bricklet.

.. _ptc_bricklet_csharp:

C# - PTC Bricklet
=================

This is the description of the :ref:`C# API bindings <api_bindings_csharp>` for the :ref:`PTC Bricklet <ptc_bricklet>`. General information and technical
specifications for the PTC Bricklet are summarized in its :ref:`hardware description
<ptc_bricklet_description>`.

An :ref:`installation guide <api_bindings_csharp_install>` for the C# API
bindings is part of their general description.

.. _ptc_bricklet_csharp_examples:


Examples
--------

The example code below is `Public Domain (CC0 1.0)
<http://creativecommons.org/publicdomain/zero/1.0/>`__.

Simple
^^^^^^

`Download (ExampleSimple.cs) <https://github.com/Tinkerforge/ptc-bricklet/raw/master/software/examples/csharp/ExampleSimple.cs>`__

.. literalinclude:: PTC_Bricklet_CSharp_ExampleSimple.cs
 :language: csharp
 :linenos:
 :tab-width: 4

Callback
^^^^^^^^

`Download (ExampleCallback.cs) <https://github.com/Tinkerforge/ptc-bricklet/raw/master/software/examples/csharp/ExampleCallback.cs>`__

.. literalinclude:: PTC_Bricklet_CSharp_ExampleCallback.cs
 :language: csharp
 :linenos:
 :tab-width: 4

Threshold
^^^^^^^^^

`Download (ExampleThreshold.cs) <https://github.com/Tinkerforge/ptc-bricklet/raw/master/software/examples/csharp/ExampleThreshold.cs>`__

.. literalinclude:: PTC_Bricklet_CSharp_ExampleThreshold.cs
 :language: csharp
 :linenos:
 :tab-width: 4

.. _ptc_bricklet_csharp_api:

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


.. csharp:function:: class BrickletPTC(String uid, IPConnection ipcon)

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

 .. code-block:: csharp

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

 This object can then be used after the IP Connection is connected
 (see examples :ref:`above <ptc_bricklet_csharp_examples>`).


.. csharp:function:: public int BrickletPTC::GetTemperature()

 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 callback :csharp:func:`Temperature <BrickletPTC::Temperature>` and set the period with 
 :csharp:func:`SetTemperatureCallbackPeriod() <BrickletPTC::SetTemperatureCallbackPeriod>`.
 
.. csharp:function:: public bool BrickletPTC::IsSensorConnected()

 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.
 
.. csharp:function:: public void BrickletPTC::SetWireMode(byte mode)

 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:
 
 * BrickletPTC.WIRE_MODE_2 = 2
 * BrickletPTC.WIRE_MODE_3 = 3
 * BrickletPTC.WIRE_MODE_4 = 4
 
.. csharp:function:: public byte BrickletPTC::GetWireMode()

 Returns the wire mode as set by :csharp:func:`SetWireMode() <BrickletPTC::SetWireMode>`
 
 The following constants are available for this function:
 
 * BrickletPTC.WIRE_MODE_2 = 2
 * BrickletPTC.WIRE_MODE_3 = 3
 * BrickletPTC.WIRE_MODE_4 = 4
 


Advanced Functions
^^^^^^^^^^^^^^^^^^

.. csharp:function:: public int BrickletPTC::GetResistance()

 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 callback :csharp:func:`Resistance <BrickletPTC::Resistance>` and set the period with 
 :csharp:func:`SetResistanceCallbackPeriod() <BrickletPTC::SetResistanceCallbackPeriod>`.
 
.. csharp:function:: public void BrickletPTC::SetNoiseRejectionFilter(byte filter)

 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:
 
 * BrickletPTC.FILTER_OPTION_50HZ = 0
 * BrickletPTC.FILTER_OPTION_60HZ = 1
 
.. csharp:function:: public byte BrickletPTC::GetNoiseRejectionFilter()

 Returns the noise rejection filter option as set by 
 :csharp:func:`SetNoiseRejectionFilter() <BrickletPTC::SetNoiseRejectionFilter>`
 
 The following constants are available for this function:
 
 * BrickletPTC.FILTER_OPTION_50HZ = 0
 * BrickletPTC.FILTER_OPTION_60HZ = 1
 
.. csharp:function:: public byte[] BrickletPTC::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.
 
.. csharp:function:: public bool BrickletPTC::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
 :csharp:func:`SetResponseExpected() <BrickletPTC::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 :csharp:func:`SetResponseExpected() <BrickletPTC::SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. csharp:function:: public void BrickletPTC::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:
 
 * 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
 
.. csharp:function:: public void BrickletPTC::SetResponseExpectedAll(bool responseExpected)

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. csharp:function:: public void BrickletPTC::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 :ref:`here <device_identifier>`.
 |device_identifier_constant|
 


Callback Configuration Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



.. csharp:function:: public void BrickletPTC::SetTemperatureCallbackPeriod(long period)

 Sets the period in ms with which the :csharp:func:`Temperature <BrickletPTC::Temperature>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :csharp:func:`Temperature <BrickletPTC::Temperature>` is only triggered if the temperature has changed since the
 last triggering.
 
 The default value is 0.
 
.. csharp:function:: public long BrickletPTC::GetTemperatureCallbackPeriod()

 Returns the period as set by :csharp:func:`SetTemperatureCallbackPeriod() <BrickletPTC::SetTemperatureCallbackPeriod>`.
 
.. csharp:function:: public void BrickletPTC::SetResistanceCallbackPeriod(long period)

 Sets the period in ms with which the :csharp:func:`Resistance <BrickletPTC::Resistance>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :csharp:func:`Resistance <BrickletPTC::Resistance>` is only triggered if the resistance has changed since the
 last triggering.
 
 The default value is 0.
 
.. csharp:function:: public long BrickletPTC::GetResistanceCallbackPeriod()

 Returns the period as set by :csharp:func:`SetResistanceCallbackPeriod() <BrickletPTC::SetResistanceCallbackPeriod>`.
 
.. csharp:function:: public void BrickletPTC::SetTemperatureCallbackThreshold(char option, int min, int max)

 Sets the thresholds for the :csharp:func:`TemperatureReached <BrickletPTC::TemperatureReached>` callback. 
 
 The following options are possible:
 
 .. csv-table::
  :header: "Option", "Description"
  :widths: 10, 100
 
  "'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:
 
 * BrickletPTC.THRESHOLD_OPTION_OFF = 'x'
 * BrickletPTC.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletPTC.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletPTC.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletPTC.THRESHOLD_OPTION_GREATER = '>'
 
.. csharp:function:: public void BrickletPTC::GetTemperatureCallbackThreshold(out char option, out int min, out int max)

 Returns the threshold as set by :csharp:func:`SetTemperatureCallbackThreshold() <BrickletPTC::SetTemperatureCallbackThreshold>`.
 
 The following constants are available for this function:
 
 * BrickletPTC.THRESHOLD_OPTION_OFF = 'x'
 * BrickletPTC.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletPTC.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletPTC.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletPTC.THRESHOLD_OPTION_GREATER = '>'
 
.. csharp:function:: public void BrickletPTC::SetResistanceCallbackThreshold(char option, int min, int max)

 Sets the thresholds for the :csharp:func:`ResistanceReached <BrickletPTC::ResistanceReached>` callback. 
 
 The following options are possible:
 
 .. csv-table::
  :header: "Option", "Description"
  :widths: 10, 100
 
  "'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:
 
 * BrickletPTC.THRESHOLD_OPTION_OFF = 'x'
 * BrickletPTC.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletPTC.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletPTC.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletPTC.THRESHOLD_OPTION_GREATER = '>'
 
.. csharp:function:: public void BrickletPTC::GetResistanceCallbackThreshold(out char option, out int min, out int max)

 Returns the threshold as set by :csharp:func:`SetResistanceCallbackThreshold() <BrickletPTC::SetResistanceCallbackThreshold>`.
 
 The following constants are available for this function:
 
 * BrickletPTC.THRESHOLD_OPTION_OFF = 'x'
 * BrickletPTC.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletPTC.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletPTC.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletPTC.THRESHOLD_OPTION_GREATER = '>'
 
.. csharp:function:: public void BrickletPTC::SetDebouncePeriod(long debounce)

 Sets the period in ms with which the threshold callback
 
 * :csharp:func:`TemperatureReached <BrickletPTC::TemperatureReached>`,
 * :csharp:func:`ResistanceReached <BrickletPTC::ResistanceReached>`
 
 is triggered, if the threshold
 
 * :csharp:func:`SetTemperatureCallbackThreshold() <BrickletPTC::SetTemperatureCallbackThreshold>`,
 * :csharp:func:`SetResistanceCallbackThreshold() <BrickletPTC::SetResistanceCallbackThreshold>`
 
 keeps being reached.
 
 The default value is 100.
 
.. csharp:function:: public long BrickletPTC::GetDebouncePeriod()

 Returns the debounce period as set by :csharp:func:`SetDebouncePeriod() <BrickletPTC::SetDebouncePeriod>`.
 


.. _ptc_bricklet_csharp_callbacks:

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:

.. code-block:: csharp

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

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


.. csharp:function:: public event BrickletPTC::Temperature(BrickletPTC sender, int temperature)


  This callback is triggered periodically with the period that is set by
  :csharp:func:`SetTemperatureCallbackPeriod() <BrickletPTC::SetTemperatureCallbackPeriod>`. The parameter is the temperature
  of the connected sensor.
  
  :csharp:func:`Temperature <BrickletPTC::Temperature>` is only triggered if the temperature has changed since the
  last triggering.
  

.. csharp:function:: public event BrickletPTC::TemperatureReached(BrickletPTC sender, int temperature)


  This callback is triggered when the threshold as set by
  :csharp:func:`SetTemperatureCallbackThreshold() <BrickletPTC::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 :csharp:func:`SetDebouncePeriod() <BrickletPTC::SetDebouncePeriod>`.
  

.. csharp:function:: public event BrickletPTC::Resistance(BrickletPTC sender, int resistance)


  This callback is triggered periodically with the period that is set by
  :csharp:func:`SetResistanceCallbackPeriod() <BrickletPTC::SetResistanceCallbackPeriod>`. The parameter is the resistance
  of the connected sensor.
  
  :csharp:func:`Resistance <BrickletPTC::Resistance>` is only triggered if the resistance has changed since the
  last triggering.
  

.. csharp:function:: public event BrickletPTC::ResistanceReached(BrickletPTC sender, int resistance)


  This callback is triggered when the threshold as set by
  :csharp:func:`SetResistanceCallbackThreshold() <BrickletPTC::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 :csharp:func:`SetDebouncePeriod() <BrickletPTC::SetDebouncePeriod>`.
  


.. _ptc_bricklet_csharp_constants:

Constants
^^^^^^^^^

.. csharp:member:: public int BrickletPTC::DEVICE_IDENTIFIER

 This constant is used to identify a PTC Bricklet.

 The :csharp:func:`GetIdentity() <BrickletPTC::GetIdentity>` function and the
 :csharp:func:`EnumerateCallback <IPConnection::EnumerateCallback>`
 callback of the IP Connection have a ``deviceIdentifier`` parameter to specify
 the Brick's or Bricklet's type.

