..
 #############################################################
 # 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# - Segment Display 4x7 Bricklet

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

.. _segment_display_4x7_bricklet_csharp:

C# - Segment Display 4x7 Bricklet
=================================

This is the description of the :ref:`C# API bindings <api_bindings_csharp>` for the :ref:`Segment Display 4x7 Bricklet <segment_display_4x7_bricklet>`. General information and technical
specifications for the Segment Display 4x7 Bricklet are summarized in its :ref:`hardware description
<segment_display_4x7_bricklet_description>`.

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

.. _segment_display_4x7_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/segment-display-4x7-bricklet/raw/master/software/examples/csharp/ExampleSimple.cs>`__

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

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

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

 .. code-block:: csharp

  BrickletSegmentDisplay4x7 segmentDisplay4x7 = new BrickletSegmentDisplay4x7("YOUR_DEVICE_UID", ipcon);

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


.. csharp:function:: public void BrickletSegmentDisplay4x7::SetSegments(byte[] segments, byte brightness, bool colon)

 The 7-segment display can be set with bitmaps. Every bit controls one
 segment:
 
 .. image:: /Images/Bricklets/bricklet_segment_display_4x7_bit_order.png
    :scale: 100 %
    :alt: Bit order of one segment
    :align: center
 
 For example to set a "5" you would want to activate segments 0, 2, 3, 5 and 6.
 This is represented by the number 0b01101101 = 0x6d = 109.
 
 The brightness can be set between 0 (dark) and 7 (bright). The colon
 parameter turns the colon of the display on or off.
 
.. csharp:function:: public void BrickletSegmentDisplay4x7::GetSegments(out byte[] segments, out byte brightness, out bool colon)

 Returns the segment, brightness and color data as set by 
 :csharp:func:`SetSegments() <BrickletSegmentDisplay4x7::SetSegments>`.
 


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

.. csharp:function:: public void BrickletSegmentDisplay4x7::StartCounter(short valueFrom, short valueTo, short increment, long length)

 Starts a counter with the *from* value that counts to the *to*
 value with the each step incremented by *increment*.
 The *length* of the increment is given in ms.
 
 Example: If you set *from* to 0, *to* to 100, *increment* to 1 and
 *length* to 1000, a counter that goes from 0 to 100 with one second
 pause between each increment will be started.
 
 The maximum values for *from*, *to* and *increment* is 9999, 
 the minimum value is -999.
 
 Using a negative increment allows to count backwards.
 
 You can stop the counter at every time by calling :csharp:func:`SetSegments() <BrickletSegmentDisplay4x7::SetSegments>`.
 
.. csharp:function:: public int BrickletSegmentDisplay4x7::GetCounterValue()

 Returns the counter value that is currently shown on the display.
 
 If there is no counter running a 0 will be returned.
 
.. csharp:function:: public byte[] BrickletSegmentDisplay4x7::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 BrickletSegmentDisplay4x7::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() <BrickletSegmentDisplay4x7::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() <BrickletSegmentDisplay4x7::SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. csharp:function:: public void BrickletSegmentDisplay4x7::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:
 
 * BrickletSegmentDisplay4x7.FUNCTION_SET_SEGMENTS = 1
 * BrickletSegmentDisplay4x7.FUNCTION_START_COUNTER = 3
 
.. csharp:function:: public void BrickletSegmentDisplay4x7::SetResponseExpectedAll(bool responseExpected)

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


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

    segmentDisplay4x7.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 BrickletSegmentDisplay4x7::CounterFinished(BrickletSegmentDisplay4x7 sender)


  This callback is triggered when the counter (see :csharp:func:`StartCounter() <BrickletSegmentDisplay4x7::StartCounter>`) is
  finished.
  


.. _segment_display_4x7_bricklet_csharp_constants:

Constants
^^^^^^^^^

.. csharp:member:: public int BrickletSegmentDisplay4x7::DEVICE_IDENTIFIER

 This constant is used to identify a Segment Display 4x7 Bricklet.

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

