..
 #############################################################
 # 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-vbnet">Software</a> / Visual Basic .NET - Piezo Buzzer Bricklet

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

.. _piezo_buzzer_bricklet_vbnet:

Visual Basic .NET - Piezo Buzzer Bricklet
=========================================

This is the description of the :ref:`Visual Basic .NET API bindings <api_bindings_vbnet>` 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_vbnet_install>` for the Visual Basic .NET API
bindings is part of their general description.

.. _piezo_buzzer_bricklet_vbnet_examples:


Examples
--------

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

Beep
^^^^

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

.. literalinclude:: PiezoBuzzer_Bricklet_VBNET_ExampleBeep.vb
 :language: vbnet
 :linenos:
 :tab-width: 4

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

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

.. literalinclude:: PiezoBuzzer_Bricklet_VBNET_ExampleMorseCode.vb
 :language: vbnet
 :linenos:
 :tab-width: 4

.. _piezo_buzzer_bricklet_vbnet_api:

API
---

Since Visual Basic .NET does not support multiple return values directly, we
use the ``ByRef`` keyword to return multiple values from a function.

All functions and procedures listed below are thread-safe.




Basic Functions
^^^^^^^^^^^^^^^


.. vbnet:function:: Class BrickletPiezoBuzzer(ByVal uid As String, ByVal ipcon As IPConnection)

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

 .. code-block:: vbnet

    Dim piezoBuzzer As 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_vbnet_examples>`).


.. vbnet:function:: Sub BrickletPiezoBuzzer.Beep(ByVal duration As Long)

 Beeps with the duration in ms. For example: If you set a value of 1000,
 the piezo buzzer will beep for one second.
 
.. vbnet:function:: Sub BrickletPiezoBuzzer.MorseCode(ByVal morse As String)

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

.. vbnet:function:: Function BrickletPiezoBuzzer.GetAPIVersion() As Byte[]

 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.
 
.. vbnet:function:: Function BrickletPiezoBuzzer.GetResponseExpected(ByVal functionId As Byte) As Boolean

 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
 :vbnet: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 :vbnet:func:`SetResponseExpected() <BrickletPiezoBuzzer.SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. vbnet:function:: Sub BrickletPiezoBuzzer.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)

 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
 
.. vbnet:function:: Sub BrickletPiezoBuzzer.SetResponseExpectedAll(ByVal responseExpected As Boolean)

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. vbnet:function:: Sub BrickletPiezoBuzzer.GetIdentity(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion[] As Byte, ByRef firmwareVersion[] As Byte, ByRef deviceIdentifier As Integer)

 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_vbnet_callbacks:

Callbacks
^^^^^^^^^

Callbacks can be registered to receive time critical or recurring data from
the device. The registration is done by assigning a procedure to an callback
property of the device object:

 .. code-block:: vbnet

    Sub Callback(ByVal sender As BrickletPiezoBuzzer, ByVal value As Short)
        Console.WriteLine("Value: {0}", value)
    End Sub

    AddHandler piezoBuzzer.Example, AddressOf Callback

The available callback property and their type of parameters 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.


.. vbnet:function:: Event BrickletPiezoBuzzer.BeepFinished(ByVal sender As BrickletPiezoBuzzer)


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

.. vbnet:function:: Event BrickletPiezoBuzzer.MorseCodeFinished(ByVal sender As BrickletPiezoBuzzer)


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


.. _piezo_buzzer_bricklet_vbnet_constants:

Constants
^^^^^^^^^

.. vbnet:attribute:: Const BrickletPiezoBuzzer.DEVICE_IDENTIFIER

 This constant is used to identify a Piezo Buzzer Bricklet.

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

