..
 #############################################################
 # 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-tcpip">Software</a> / TCP/IP - Multi Touch Bricklet

.. |device_identifier_constant| unicode:: 0xA0
   :trim:

.. _multi_touch_bricklet_tcpip:

TCP/IP - Multi Touch Bricklet
=============================

This is the description of the :ref:`TCP/IP protocol <llproto_tcpip>` for the :ref:`Multi Touch Bricklet <multi_touch_bricklet>`. General information and technical
specifications for the Multi Touch Bricklet are summarized in its :ref:`hardware description
<multi_touch_bricklet_description>`.

.. _multi_touch_bricklet_tcpip_api:

API
---

A general description of the TCP/IP protocol structure can be found
:ref:`here <llproto_tcpip>`.




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



.. tcpip:function:: BrickletMultiTouch.get_touch_state

 :functionid: 1
 :emptyrequest: empty payload

 :response state: uint16

 Returns the current touch state. The state is given as a bitfield.
 
 Bits 0 to 11 represent the 12 electrodes and bit 12 represents
 the proximity.
 
 If an electrode is touched, the corresponding bit is true. If
 a hand or similar is in proximity to the electrodes, bit 12 is
 *true*.
 
 Example: The state 4103 = 0x1007 = 0b1000000000111 means that
 electrodes 0, 1 and 2 are touched and that something is in the
 proximity of the electrodes.
 
 The proximity is activated with a distance of 1-2cm. An electrode
 is already counted as touched if a finger is nearly touching the
 electrode. This means that you can put a piece of paper or foil
 or similar on top of a electrode to build a touch panel with
 a professional look.
 
.. tcpip:function:: BrickletMultiTouch.recalibrate

 :functionid: 2
 :emptyrequest: empty payload

 :noresponse: no response

 Recalibrates the electrodes. Call this function whenever you changed
 or moved you electrodes.
 
.. tcpip:function:: BrickletMultiTouch.set_electrode_config

 :functionid: 3
 :request enabled_electrodes: uint16

 :noresponse: no response

 Enables/disables electrodes with a bitfield (see :tcpip:func:`get_touch_state <BrickletMultiTouch.get_touch_state>`).
 
 *True* enables the electrode, *false* disables the electrode. A
 disabled electrode will always return *false* as its state. If you
 don't need all electrodes you can disable the electrodes that are
 not needed.
 
 It is recommended that you disable the proximity bit (bit 12) if
 the proximity feature is not needed. This will reduce the amount of
 traffic that is produced by the :tcpip:func:`CALLBACK_TOUCH_STATE <BrickletMultiTouch.CALLBACK_TOUCH_STATE>` callback.
 
 Disabling electrodes will also reduce power consumption.
 
 Default: 8191 = 0x1FFF = 0b1111111111111 (all electrodes enabled)
 
.. tcpip:function:: BrickletMultiTouch.get_electrode_config

 :functionid: 4
 :emptyrequest: empty payload

 :response enabled_electrodes: uint16

 Returns the electrode configuration, as set by :tcpip:func:`set_electrode_config <BrickletMultiTouch.set_electrode_config>`.
 
.. tcpip:function:: BrickletMultiTouch.set_electrode_sensitivity

 :functionid: 6
 :request sensitivity: uint8

 :noresponse: no response

 Sets the sensitivity of the electrodes. An electrode with a high sensitivity
 will register a touch earlier then an electrode with a low sensitivity.
 
 If you build a big electrode you might need to decrease the sensitivity, since
 the area that can be charged will get bigger. If you want to be able to
 activate an electrode from further away you need to increase the sensitivity.
 
 After a new sensitivity is set, you likely want to call :tcpip:func:`recalibrate <BrickletMultiTouch.recalibrate>`
 to calibrate the electrodes with the newly defined sensitivity.
 
 The valid sensitivity value range is 5-201.
 
 The default sensitivity value is 181.
 
.. tcpip:function:: BrickletMultiTouch.get_electrode_sensitivity

 :functionid: 7
 :emptyrequest: empty payload

 :response sensitivity: uint8

 Returns the current sensitivity, as set by :tcpip:func:`set_electrode_sensitivity <BrickletMultiTouch.set_electrode_sensitivity>`.
 


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

.. tcpip:function:: BrickletMultiTouch.get_identity

 :functionid: 255
 :emptyrequest: empty payload

 :response uid: char[8]
 :response connected_uid: char[8]
 :response position: char
 :response hardware_version: uint8[3]
 :response firmware_version: uint8[3]
 :response device_identifier: uint16

 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|
 


.. _multi_touch_bricklet_tcpip_callbacks:

Callbacks
^^^^^^^^^

.. tcpip:function:: BrickletMultiTouch.CALLBACK_TOUCH_STATE

 :functionid: 5

 :response state: uint16


 Returns the current touch state, see :tcpip:func:`get_touch_state <BrickletMultiTouch.get_touch_state>` for
 information about the state.
 
 This callback is triggered every time the touch state changes.
 


