..
 #############################################################
 # 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# - Piezo Buzzer Bricklet

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

.. _piezo_buzzer_bricklet_csharp:

C# - Piezo Buzzer Bricklet
==========================

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

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

.. _piezo_buzzer_bricklet_csharp_examples:


Examples
--------

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

Beep
^^^^

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

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

Morse Code
^^^^^^^^^^

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

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

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

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

 .. code-block:: csharp

  BrickletPiezoBuzzer piezoBuzzer = new BrickletPiezoBuzzer("YOUR_DEVICE_UID", ipcon);

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


.. csharp:function:: public void BrickletPiezoBuzzer::Beep(long duration)

 Beeps with the duration in ms. For example: If you set a value of 1000,
 the piezo buzzer will beep for one second.
 
.. csharp:function:: public void BrickletPiezoBuzzer::MorseCode(string morse)

 Sets morse code that will be played by the piezo buzzer. The morse code
 is given as a string consisting of "." (dot), "-" (minus) and " " (space)
 for *dits*, *dahs* and *pauses*. Every other character is ignored.
 
 For example: If you set the string "...---...", the piezo buzzer will beep
 nine times with the durations "short short short long long long short 
 short short".
 
 The maximum string size is 60.
 


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

.. csharp:function:: public byte[] BrickletPiezoBuzzer::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 BrickletPiezoBuzzer::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() <BrickletPiezoBuzzer::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() <BrickletPiezoBuzzer::SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. csharp:function:: public void BrickletPiezoBuzzer::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:
 
 * BrickletPiezoBuzzer.FUNCTION_BEEP = 1
 * BrickletPiezoBuzzer.FUNCTION_MORSE_CODE = 2
 
.. csharp:function:: public void BrickletPiezoBuzzer::SetResponseExpectedAll(bool responseExpected)

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


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

    piezoBuzzer.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 BrickletPiezoBuzzer::BeepFinished(BrickletPiezoBuzzer sender)


  This callback is triggered if a beep set by :csharp:func:`Beep() <BrickletPiezoBuzzer::Beep>` is finished
  

.. csharp:function:: public event BrickletPiezoBuzzer::MorseCodeFinished(BrickletPiezoBuzzer sender)


  This callback is triggered if the playback of the morse code set by
  :csharp:func:`MorseCode() <BrickletPiezoBuzzer::MorseCode>` is finished.
  


.. _piezo_buzzer_bricklet_csharp_constants:

Constants
^^^^^^^^^

.. csharp:member:: public int BrickletPiezoBuzzer::DEVICE_IDENTIFIER

 This constant is used to identify a Piezo Buzzer Bricklet.

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

