..
 #############################################################
 # 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-mathematica">Software</a> / Mathematica - Tilt Bricklet

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

.. _tilt_bricklet_mathematica:

Mathematica - Tilt Bricklet
===========================

This is the description of the :ref:`Mathematica API bindings <api_bindings_mathematica>` for the :ref:`Tilt Bricklet <tilt_bricklet>`. General information and technical
specifications for the Tilt Bricklet are summarized in its :ref:`hardware description
<tilt_bricklet_description>`.

An :ref:`installation guide <api_bindings_mathematica_install>` for the Mathematica API
bindings is part of their general description.

.. _tilt_bricklet_mathematica_examples:


Examples
--------

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

Simple
^^^^^^

`Download (ExampleSimple.nb) <https://github.com/Tinkerforge/tilt-bricklet/raw/master/software/examples/mathematica/ExampleSimple.nb>`__

.. literalinclude:: Tilt_Bricklet_Mathematica_ExampleSimple.nb.txt
 :language: mathematica
 :linenos:
 :tab-width: 4

Callback
^^^^^^^^

`Download (ExampleCallback.nb) <https://github.com/Tinkerforge/tilt-bricklet/raw/master/software/examples/mathematica/ExampleCallback.nb>`__

.. literalinclude:: Tilt_Bricklet_Mathematica_ExampleCallback.nb.txt
 :language: mathematica
 :linenos:
 :tab-width: 4

.. _tilt_bricklet_mathematica_api:

API
---

Generally, every method of the Mathematica 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 .NET/Link does not support multiple return values directly, we use the
``out`` keyword to return multiple values from a method. For further
information about the ``out`` keyword in .NET/Link see the corresponding
Mathematica `.NET/Link documentation
<http://reference.wolfram.com/language/NETLink/tutorial/CallingNETFromTheWolframLanguage.html#15993>`__.

The namespace for all Brick/Bricklet bindings and the IPConnection is
``Tinkerforge.*``.




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


.. mathematica:function:: BrickletTilt[uid, ipcon] -> tilt

 :param uid: String
 :param ipcon: NETObject[IPConnection]
 :ret tilt: NETObject[BrickletTilt]

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

 .. code-block:: mathematica

    tilt=NETNew["Tinkerforge.BrickletTilt","YOUR_DEVICE_UID",ipcon]

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

 The .NET runtime has built-in garbage collection that frees objects that are
 no longer in use by a program. But because Mathematica can not automatically
 tell when a Mathematica "program" doesn't use a .NET object anymore, this has
 to be done by the program. For this the `ReleaseNETObject[]
 <http://reference.wolfram.com/language/NETLink/ref/ReleaseNETObject.html>`__
 function is used in the examples.

 For further information about object management in .NET/Link see the
 corresponding Mathematica `.NET/Link documentation
 <http://reference.wolfram.com/language/NETLink/tutorial/CallingNETFromTheWolframLanguage.html#14400>`__.


.. mathematica:function:: BrickletTilt@GetTiltState[] -> state

 :ret state: Integer

 Returns the current tilt state. The state can either be
 
 * 0 = Closed: The ball in the tilt switch closes the circuit.
 * 1 = Open: The ball in the tilt switch does not close the circuit.
 * 2 = Closed Vibrating: The tilt switch is in motion (rapid change between open and close).
 
 .. image:: /Images/Bricklets/bricklet_tilt_mechanics.jpg
    :scale: 100 %
    :alt: Tilt states
    :align: center
    :target: ../../_images/Bricklets/bricklet_tilt_mechanics.jpg
 
 
 The following constants are available for this function:
 
 * BrickletTilt`TILTUSTATEUCLOSED = 0
 * BrickletTilt`TILTUSTATEUOPEN = 1
 * BrickletTilt`TILTUSTATEUCLOSEDUVIBRATING = 2
 


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

.. mathematica:function:: BrickletTilt@GetAPIVersion[] -> {apiVersion1, apiVersion2, apiVersion3}

 :ret apiVersioni: Integer

 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.
 
.. mathematica:function:: BrickletTilt@GetResponseExpected[functionId] -> responseExpected

 :param functionId: Integer
 :ret responseExpected: True/False

 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
 :mathematica:func:`SetResponseExpected[] <BrickletTilt@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 :mathematica:func:`SetResponseExpected[] <BrickletTilt@SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. mathematica:function:: BrickletTilt@SetResponseExpected[functionId, responseExpected] -> Null

 :param functionId: Integer
 :param responseExpected: True/False

 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:
 
 * BrickletTilt`FUNCTIONUENABLEUTILTUSTATEUCALLBACK = 2
 * BrickletTilt`FUNCTIONUDISABLEUTILTUSTATEUCALLBACK = 3
 
.. mathematica:function:: BrickletTilt@SetResponseExpectedAll[responseExpected] -> Null

 :param responseExpected: True/False

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. mathematica:function:: BrickletTilt@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] -> Null

 :param uid: String
 :param connectedUid: String
 :param position: Integer
 :param hardwareVersioni: Integer
 :param firmwareVersioni: Integer
 :param deviceIdentifier: 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|
 


Callback Configuration Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



.. mathematica:function:: BrickletTilt@EnableTiltStateCallback[] -> Null


 Enables the :mathematica:func:`TiltState <BrickletTilt@TiltState>` callback.
 
.. mathematica:function:: BrickletTilt@DisableTiltStateCallback[] -> Null


 Disables the :mathematica:func:`TiltState <BrickletTilt@TiltState>` callback.
 
.. mathematica:function:: BrickletTilt@IsTiltStateCallbackEnabled[] -> enabled

 :ret enabled: True/False

 Returns *true* if the :mathematica:func:`TiltState <BrickletTilt@TiltState>` callback is enabled.
 


.. _tilt_bricklet_mathematica_callbacks:

Callbacks
^^^^^^^^^

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

 .. code-block:: mathematica

    Callback[sender_,value_]:=Print["Value: "<>ToString[value]]

    AddEventHandler[tilt@Example,Callback]

For further information about event handling using .NET/Link see the
corresponding Mathematica `.NET/Link documentation
<http://reference.wolfram.com/language/NETLink/tutorial/CallingNETFromTheWolframLanguage.html#17034>`__.

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.


.. mathematica:function:: event BrickletTilt@TiltState[sender, state]

 :param sender: NETObject[BrickletTilt]
 :param state: Integer

 This callback provides the current tilt state. It is called every time the
 state changes.
 
 See :mathematica:func:`GetTiltState[] <BrickletTilt@GetTiltState>` for a description of the states.
 
 The following constants are available for this function:
 
 * BrickletTilt`TILTUSTATEUCLOSED = 0
 * BrickletTilt`TILTUSTATEUOPEN = 1
 * BrickletTilt`TILTUSTATEUCLOSEDUVIBRATING = 2
 


.. _tilt_bricklet_mathematica_constants:

Constants
^^^^^^^^^

.. mathematica:symbol:: BrickletTilt`DEVICEUIDENTIFIER

 This constant is used to identify a Tilt Bricklet.

 The :mathematica:func:`GetIdentity[] <BrickletTilt@GetIdentity>` function and the
 :mathematica:func:`EnumerateCallback <IPConnection@EnumerateCallback>`
 callback of the IP Connection have a ``deviceIdentifier`` parameter to specify
 the Brick's or Bricklet's type.

