..
 #############################################################
 # 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# - IO-16 Bricklet

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

.. _io16_bricklet_csharp:

C# - IO-16 Bricklet
===================

This is the description of the :ref:`C# API bindings <api_bindings_csharp>` for the :ref:`IO-16 Bricklet <io16_bricklet>`. General information and technical
specifications for the IO-16 Bricklet are summarized in its :ref:`hardware description
<io16_bricklet_description>`.

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

.. _io16_bricklet_csharp_examples:


Examples
--------

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

Output
^^^^^^

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

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

Interrupt
^^^^^^^^^

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

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

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

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

 .. code-block:: csharp

  BrickletIO16 io16 = new BrickletIO16("YOUR_DEVICE_UID", ipcon);

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


.. csharp:function:: public void BrickletIO16::SetPort(char port, byte valueMask)

 Sets the output value (high or low) for a port ("a" or "b") with a bitmask
 (8bit). A 1 in the bitmask means high and a 0 in the bitmask means low.
 
 For example: The value 15 or 0b00001111 will turn the pins 0-3 high and the
 pins 4-7 low for the specified port.
 
 .. note::
  This function does nothing for pins that are configured as input.
  Pull-up resistors can be switched on with :csharp:func:`SetPortConfiguration() <BrickletIO16::SetPortConfiguration>`.
 
.. csharp:function:: public byte BrickletIO16::GetPort(char port)

 Returns a bitmask of the values that are currently measured on the
 specified port. This function works if the pin is configured to input
 as well as if it is configured to output.
 
.. csharp:function:: public void BrickletIO16::SetPortConfiguration(char port, byte selectionMask, char direction, bool value)

 Configures the value and direction of a specified port. Possible directions
 are 'i' and 'o' for input and output.
 
 If the direction is configured as output, the value is either high or low
 (set as *true* or *false*).
 
 If the direction is configured as input, the value is either pull-up or
 default (set as *true* or *false*).
 
 For example:
 
 * ('a', 255, 'i', true) or ('a', 0b11111111, 'i', true) will set all pins of port A as input pull-up.
 * ('a', 128, 'i', false) or ('a', 0b10000000, 'i', false) will set pin 7 of port A as input default (floating if nothing is connected).
 * ('b', 3, 'o', false) or ('b', 0b00000011, 'o', false) will set pins 0 and 1 of port B as output low.
 * ('b', 4, 'o', true) or ('b', 0b00000100, 'o', true) will set pin 2 of port B as output high.
 
 The default configuration is input with pull-up.
 
 The following constants are available for this function:
 
 * BrickletIO16.DIRECTION_IN = 'i'
 * BrickletIO16.DIRECTION_OUT = 'o'
 
.. csharp:function:: public void BrickletIO16::GetPortConfiguration(char port, out byte directionMask, out byte valueMask)

 Returns a direction bitmask and a value bitmask for the specified port. A 1 in
 the direction bitmask means input and a 0 in the bitmask means output.
 
 For example: A return value of (15, 51) or (0b00001111, 0b00110011) for
 direction and value means that:
 
 * pins 0 and 1 are configured as input pull-up,
 * pins 2 and 3 are configured as input default,
 * pins 4 and 5 are configured as output high
 * and pins 6 and 7 are configured as output low.
 
.. csharp:function:: public long BrickletIO16::GetEdgeCount(byte pin, bool resetCounter)

 Returns the current value of the edge counter for the selected pin on port A.
 You can configure the edges that are counted with :csharp:func:`SetEdgeCountConfig() <BrickletIO16::SetEdgeCountConfig>`.
 
 If you set the reset counter to *true*, the count is set back to 0
 directly after it is read.
 
 .. versionadded:: 2.0.3~(Plugin)
 


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

.. csharp:function:: public void BrickletIO16::SetPortMonoflop(char port, byte selectionMask, byte valueMask, long time)

 Configures a monoflop of the pins specified by the second parameter as 8 bit
 long bitmask. The specified pins must be configured for output. Non-output
 pins will be ignored.
 
 The third parameter is a bitmask with the desired value of the specified
 output pins. A 1 in the bitmask means high and a 0 in the bitmask means low.
 
 The forth parameter indicates the time (in ms) that the pins should hold
 the value.
 
 If this function is called with the parameters ('a', 9, 1, 1500) or
 ('a', 0b00001001, 0b00000001, 1500): Pin 0 will get high and pin 3 will get
 low on port 'a'. In 1.5s pin 0 will get low and pin 3 will get high again.
 
 A monoflop can be used as a fail-safe mechanism. For example: Lets assume you
 have a RS485 bus and an IO-16 Bricklet connected to one of the slave
 stacks. You can now call this function every second, with a time parameter
 of two seconds and pin 0 set to high. Pin 0 will be high all the time. If now
 the RS485 connection is lost, then pin 0 will get low in at most two seconds.
 
.. csharp:function:: public void BrickletIO16::GetPortMonoflop(char port, byte pin, out byte value, out long time, out long timeRemaining)

 Returns (for the given pin) the current value and the time as set by
 :csharp:func:`SetPortMonoflop() <BrickletIO16::SetPortMonoflop>` as well as the remaining time until the value flips.
 
 If the timer is not running currently, the remaining time will be returned
 as 0.
 
.. csharp:function:: public void BrickletIO16::SetSelectedValues(char port, byte selectionMask, byte valueMask)

 Sets the output value (high or low) for a port ("a" or "b" with a bitmask, 
 according to the selection mask. The bitmask is 8 bit long and a 1 in the
 bitmask means high and a 0 in the bitmask means low.
 
 For example: The parameters ('a', 192, 128) or ('a', 0b11000000, 0b10000000)
 will turn pin 7 high and pin 6 low on port A, pins 0-6 will remain untouched.
 
 .. note::
  This function does nothing for pins that are configured as input.
  Pull-up resistors can be switched on with :func:`SetConfiguration`.
 
.. csharp:function:: public void BrickletIO16::SetEdgeCountConfig(byte pin, byte edgeType, byte debounce)

 Configures the edge counter for the selected pin of port A. Pins 0 and 1
 are available for edge counting.
 
 The edge type parameter configures if rising edges, falling edges or
 both are counted if the pin is configured for input. Possible edge types are:
 
 * 0 = rising (default)
 * 1 = falling
 * 2 = both
 
 The debounce time is given in ms.
 
 Configuring an edge counter resets its value to 0.
 
 If you don't know what any of this means, just leave it at default. The
 default configuration is very likely OK for you.
 
 Default values: 0 (edge type) and 100ms (debounce time)
 
 The following constants are available for this function:
 
 * BrickletIO16.EDGE_TYPE_RISING = 0
 * BrickletIO16.EDGE_TYPE_FALLING = 1
 * BrickletIO16.EDGE_TYPE_BOTH = 2
 
 .. versionadded:: 2.0.3~(Plugin)
 
.. csharp:function:: public void BrickletIO16::GetEdgeCountConfig(byte pin, out byte edgeType, out byte debounce)

 Returns the edge type and debounce time for the selected pin of port A as set by
 :csharp:func:`SetEdgeCountConfig() <BrickletIO16::SetEdgeCountConfig>`.
 
 The following constants are available for this function:
 
 * BrickletIO16.EDGE_TYPE_RISING = 0
 * BrickletIO16.EDGE_TYPE_FALLING = 1
 * BrickletIO16.EDGE_TYPE_BOTH = 2
 
 .. versionadded:: 2.0.3~(Plugin)
 
.. csharp:function:: public byte[] BrickletIO16::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 BrickletIO16::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() <BrickletIO16::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() <BrickletIO16::SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. csharp:function:: public void BrickletIO16::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:
 
 * BrickletIO16.FUNCTION_SET_PORT = 1
 * BrickletIO16.FUNCTION_SET_PORT_CONFIGURATION = 3
 * BrickletIO16.FUNCTION_SET_DEBOUNCE_PERIOD = 5
 * BrickletIO16.FUNCTION_SET_PORT_INTERRUPT = 7
 * BrickletIO16.FUNCTION_SET_PORT_MONOFLOP = 10
 * BrickletIO16.FUNCTION_SET_SELECTED_VALUES = 13
 * BrickletIO16.FUNCTION_SET_EDGE_COUNT_CONFIG = 15
 
.. csharp:function:: public void BrickletIO16::SetResponseExpectedAll(bool responseExpected)

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

 Sets the debounce period of the :csharp:func:`Interrupt <BrickletIO16::Interrupt>` callback in ms.
 
 For example: If you set this value to 100, you will get the interrupt
 maximal every 100ms. This is necessary if something that bounces is
 connected to the IO-16 Bricklet, such as a button.
 
 The default value is 100.
 
.. csharp:function:: public long BrickletIO16::GetDebouncePeriod()

 Returns the debounce period as set by :csharp:func:`SetDebouncePeriod() <BrickletIO16::SetDebouncePeriod>`.
 
.. csharp:function:: public void BrickletIO16::SetPortInterrupt(char port, byte interruptMask)

 Sets the pins on which an interrupt is activated with a bitmask.
 Interrupts are triggered on changes of the voltage level of the pin,
 i.e. changes from high to low and low to high.
 
 For example: ('a', 129) or ('a', 0b10000001) will enable the interrupt for
 pins 0 and 7 of port a.
 
 The interrupt is delivered with the callback :csharp:func:`Interrupt <BrickletIO16::Interrupt>`.
 
.. csharp:function:: public byte BrickletIO16::GetPortInterrupt(char port)

 Returns the interrupt bitmask for the specified port as set by
 :csharp:func:`SetPortInterrupt() <BrickletIO16::SetPortInterrupt>`.
 


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

    io16.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 BrickletIO16::Interrupt(BrickletIO16 sender, char port, byte interruptMask, byte valueMask)


  This callback is triggered whenever a change of the voltage level is detected
  on pins where the interrupt was activated with :csharp:func:`SetPortInterrupt() <BrickletIO16::SetPortInterrupt>`.
  
  The values are the port, a bitmask that specifies which interrupts occurred
  and the current value bitmask of the port.
  
  For example:
  
  * ('a', 1, 1) or ('a', 0b00000001, 0b00000001) means that on port A an
    interrupt on pin 0 occurred and currently pin 0 is high and pins 1-7 are low.
  * ('b', 129, 254) or ('b', 0b10000001, 0b11111110) means that on port B
    interrupts on pins 0 and 7 occurred and currently pin 0 is low and pins 1-7
    are high.
  

.. csharp:function:: public event BrickletIO16::MonoflopDone(BrickletIO16 sender, char port, byte selectionMask, byte valueMask)


  This callback is triggered whenever a monoflop timer reaches 0. The
  parameters contain the port, the involved pins and the current value of
  the pins (the value after the monoflop).
  


.. _io16_bricklet_csharp_constants:

Constants
^^^^^^^^^

.. csharp:member:: public int BrickletIO16::DEVICE_IDENTIFIER

 This constant is used to identify a IO-16 Bricklet.

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

