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

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

.. _tilt_bricklet_shell:

Shell - Tilt Bricklet
=====================

This is the description of the :ref:`Shell API bindings <api_bindings_shell>` 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_shell_install>` for the Shell API
bindings is part of their general description.

.. _tilt_bricklet_shell_examples:


Examples
--------

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

Simple
^^^^^^

`Download (example-simple.sh) <https://github.com/Tinkerforge/tilt-bricklet/raw/master/software/examples/shell/example-simple.sh>`__

.. literalinclude:: Tilt_Bricklet_Shell_example-simple.sh
 :language: bash
 :linenos:
 :tab-width: 4

Callback
^^^^^^^^

`Download (example-callback.sh) <https://github.com/Tinkerforge/tilt-bricklet/raw/master/software/examples/shell/example-callback.sh>`__

.. literalinclude:: Tilt_Bricklet_Shell_example-callback.sh
 :language: bash
 :linenos:
 :tab-width: 4

.. _tilt_bricklet_shell_api:

API
---

Possible exit codes for all ``tinkerforge`` commands are:

* 1: interrupted (ctrl+c)
* 2: syntax error
* 21: Python 2.5 or newer is required
* 22: Python ``argparse`` module is missing
* 23: socket error
* 24: other exception
* 25: invalid placeholder in format string
* 26: authentication error
* 201: timeout occurred
* 209: invalid argument value
* 210: function is not supported
* 211: unknown error



Command Structure
^^^^^^^^^^^^^^^^^

The common options of the ``call`` and ``dispatch`` commands are documented
:ref:`here <ipcon_shell_api>`. The specific command structure is shown below.

.. sh:function:: X Stinkerforge Pcall Ntilt-bricklet A[<option>..] L<uid> L<function> L[<argument>..]

 :param <uid>: string
 :param <function>: string

 The ``call`` command is used to call a function of the Tilt Bricklet. It can take several
 options:

 * ``--help`` shows help for the specific ``call`` command and exits
 * ``--list-functions`` shows a list of known functions of the Tilt Bricklet and exits


.. sh:function:: X Stinkerforge Pdispatch Ntilt-bricklet A[<option>..] L<uid> L<callback>

 :param <uid>: string
 :param <callback>: string

 The ``dispatch`` command is used to dispatch a callback of the Tilt Bricklet. It can
 take several options:

 * ``--help`` shows help for the specific ``dispatch`` command and exits
 * ``--list-callbacks`` shows a list of known callbacks of the Tilt Bricklet and exits


.. sh:function:: X Stinkerforge Scall Ptilt-bricklet L<uid> N<function> A[<option>..] L[<argument>..]

 :param <uid>: string
 :param <function>: string

 The ``<function>`` to be called can take different options depending of its
 kind. All functions can take the following options:

 * ``--help`` shows help for the specific function and exits

 Getter functions can take the following options:

 * ``--execute <command>`` shell command line to execute for each incoming
   response (see section about :ref:`output formatting <ipcon_shell_output>`
   for details)

 Setter functions can take the following options:

 * ``--expect-response`` requests response and waits for it

 The ``--expect-response`` option for setter functions allows to detect
 timeouts and other error conditions calls of setters as well. The device will
 then send a response for this purpose. If this option is not given for a
 setter function then no response is send and errors are silently ignored,
 because they cannot be detected.


.. sh:function:: X Stinkerforge Sdispatch Ptilt-bricklet L<uid> N<callback> A[<option>..]

 :param <uid>: string
 :param <callback>: string

 The ``<callback>`` to be dispatched can take several options:

 * ``--help`` shows help for the specific callback and exits
 * ``--execute <command>`` shell command line to execute for each incoming
   response (see section about :ref:`output formatting <ipcon_shell_output>`
   for details)



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



.. sh:function:: tinkerforge call tilt-bricklet <uid> get-tilt-state  


 :returns state: int (has symbols)

 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 symbols are available for this function:
 
 * ``closed`` = 0, for state
 * ``open`` = 1, for state
 * ``closed-vibrating`` = 2, for state
 


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

.. sh:function:: tinkerforge call tilt-bricklet <uid> get-identity  


 :returns uid: string
 :returns connected-uid: string
 :returns position: char
 :returns hardware-version: int,int,int
 :returns firmware-version: int,int,int
 :returns device-identifier: int (has symbols)

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



.. sh:function:: tinkerforge call tilt-bricklet <uid> enable-tilt-state-callback  


 :noreturn: no output

 Enables the :sh:func:`tilt-state <tilt-bricklet tilt-state>` callback.
 
.. sh:function:: tinkerforge call tilt-bricklet <uid> disable-tilt-state-callback  


 :noreturn: no output

 Disables the :sh:func:`tilt-state <tilt-bricklet tilt-state>` callback.
 
.. sh:function:: tinkerforge call tilt-bricklet <uid> is-tilt-state-callback-enabled  


 :returns enabled: bool

 Returns *true* if the :sh:func:`tilt-state <tilt-bricklet tilt-state>` callback is enabled.
 


.. _tilt_bricklet_shell_callbacks:

Callbacks
^^^^^^^^^

Callbacks can be used to receive time critical or recurring data from the
device:

.. code-block:: bash

    tinkerforge dispatch tilt-bricklet <uid> example

The available callbacks 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.

.. sh:function::  tinkerforge dispatch tilt-bricklet <uid> tilt-state

 :returns state: int (has symbols)


 This callback provides the current tilt state. It is called every time the
 state changes.
 
 See :sh:func:`get-tilt-state <tilt-bricklet get-tilt-state>` for a description of the states.
 
 The following symbols are available for this function:
 
 * ``closed`` = 0, for state
 * ``open`` = 1, for state
 * ``closed-vibrating`` = 2, for state
 


