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

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

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

.. _dust_detector_bricklet_csharp:

C# - Dust Detector Bricklet
===========================

.. note::
 This Bricklet is currently in the prototype stage and the software/hardware
 as well as the documentation is in an incomplete state.


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

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

.. _dust_detector_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/dust-detector-bricklet/raw/master/software/examples/csharp/ExampleSimple.cs>`__

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

Callback
^^^^^^^^

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

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

Threshold
^^^^^^^^^

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

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

.. _dust_detector_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 BrickletDustDetector(String uid, IPConnection ipcon)

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

 .. code-block:: csharp

  BrickletDustDetector dustDetector = new BrickletDustDetector("YOUR_DEVICE_UID", ipcon);

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


.. csharp:function:: public int BrickletDustDetector::GetDustDensity()

 Returns the dust density in µg/m³.
 
 If you want to get the dust density periodically, it is recommended 
 to use the callback :csharp:func:`DustDensity <BrickletDustDetector::DustDensity>` and set the period with 
 :csharp:func:`SetDustDensityCallbackPeriod() <BrickletDustDetector::SetDustDensityCallbackPeriod>`.
 


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

.. csharp:function:: public void BrickletDustDetector::SetMovingAverage(byte average)

 Sets the length of a `moving averaging <http://en.wikipedia.org/wiki/Moving_average>`__ 
 for the dust_density.
 
 Setting the length to 0 will turn the averaging completely off. With less
 averaging, there is more noise on the data.
 
 The range for the averaging is 0-100.
 
 The default value is 100.
 
.. csharp:function:: public byte BrickletDustDetector::GetMovingAverage()

 Returns the length moving average as set by :csharp:func:`SetMovingAverage() <BrickletDustDetector::SetMovingAverage>`.
 
.. csharp:function:: public byte[] BrickletDustDetector::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 BrickletDustDetector::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() <BrickletDustDetector::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() <BrickletDustDetector::SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. csharp:function:: public void BrickletDustDetector::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:
 
 * BrickletDustDetector.FUNCTION_SET_DUST_DENSITY_CALLBACK_PERIOD = 2
 * BrickletDustDetector.FUNCTION_SET_DUST_DENSITY_CALLBACK_THRESHOLD = 4
 * BrickletDustDetector.FUNCTION_SET_DEBOUNCE_PERIOD = 6
 * BrickletDustDetector.FUNCTION_SET_MOVING_AVERAGE = 10
 
.. csharp:function:: public void BrickletDustDetector::SetResponseExpectedAll(bool responseExpected)

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. csharp:function:: public void BrickletDustDetector::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 BrickletDustDetector::SetDustDensityCallbackPeriod(long period)

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

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

 Sets the thresholds for the :csharp:func:`DustDensityReached <BrickletDustDetector::DustDensityReached>` 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 dust density value is *outside* the min and max values"
  "'i'",    "Callback is triggered when the dust density value is *inside* the min and max values"
  "'<'",    "Callback is triggered when the dust density value is smaller than the min value (max is ignored)"
  "'>'",    "Callback is triggered when the dust density value is greater than the min value (max is ignored)"
 
 The default value is ('x', 0, 0).
 
 The following constants are available for this function:
 
 * BrickletDustDetector.THRESHOLD_OPTION_OFF = 'x'
 * BrickletDustDetector.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletDustDetector.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletDustDetector.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletDustDetector.THRESHOLD_OPTION_GREATER = '>'
 
.. csharp:function:: public void BrickletDustDetector::GetDustDensityCallbackThreshold(out char option, out int min, out int max)

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

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

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


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

    dustDetector.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 BrickletDustDetector::DustDensity(BrickletDustDetector sender, int dustDensity)


  This callback is triggered periodically with the period that is set by
  :csharp:func:`SetDustDensityCallbackPeriod() <BrickletDustDetector::SetDustDensityCallbackPeriod>`. The parameter is the 
  dust density of the sensor.
  
  :csharp:func:`DustDensity <BrickletDustDetector::DustDensity>` is only triggered if the dust density value has changed since the
  last triggering.
  

.. csharp:function:: public event BrickletDustDetector::DustDensityReached(BrickletDustDetector sender, int dustDensity)


  This callback is triggered when the threshold as set by
  :csharp:func:`SetDustDensityCallbackThreshold() <BrickletDustDetector::SetDustDensityCallbackThreshold>` is reached.
  The parameter is the dust density of the sensor.
  
  If the threshold keeps being reached, the callback is triggered periodically
  with the period as set by :csharp:func:`SetDebouncePeriod() <BrickletDustDetector::SetDebouncePeriod>`.
  


.. _dust_detector_bricklet_csharp_constants:

Constants
^^^^^^^^^

.. csharp:member:: public int BrickletDustDetector::DEVICE_IDENTIFIER

 This constant is used to identify a Dust Detector Bricklet.

 The :csharp:func:`GetIdentity() <BrickletDustDetector::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.

