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

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

.. _segment_display_4x7_bricklet_shell:

Shell - Segment Display 4x7 Bricklet
====================================

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

.. _segment_display_4x7_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/segment-display-4x7-bricklet/raw/master/software/examples/shell/example-simple.sh>`__

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

.. _segment_display_4x7_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 Nsegment-display-4x7-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 Segment Display 4x7 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 Segment Display 4x7 Bricklet and exits


.. sh:function:: X Stinkerforge Pdispatch Nsegment-display-4x7-bricklet A[<option>..] L<uid> L<callback>

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

 The ``dispatch`` command is used to dispatch a callback of the Segment Display 4x7 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 Segment Display 4x7 Bricklet and exits


.. sh:function:: X Stinkerforge Scall Psegment-display-4x7-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 Psegment-display-4x7-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 segment-display-4x7-bricklet <uid> set-segments <segments> <brightness> <colon> 

 :param <segments>: int,int,int,int
 :param <brightness>: int
 :param <colon>: bool

 :noreturn: no output

 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.
 
.. sh:function:: tinkerforge call segment-display-4x7-bricklet <uid> get-segments  


 :returns segments: int,int,int,int
 :returns brightness: int
 :returns colon: bool

 Returns the segment, brightness and color data as set by 
 :sh:func:`set-segments <segment-display-4x7-bricklet set-segments>`.
 


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

.. sh:function:: tinkerforge call segment-display-4x7-bricklet <uid> start-counter <value-from> <value-to> <increment> <length> 

 :param <value-from>: int
 :param <value-to>: int
 :param <increment>: int
 :param <length>: int

 :noreturn: no output

 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 :sh:func:`set-segments <segment-display-4x7-bricklet set-segments>`.
 
.. sh:function:: tinkerforge call segment-display-4x7-bricklet <uid> get-counter-value  


 :returns value: int

 Returns the counter value that is currently shown on the display.
 
 If there is no counter running a 0 will be returned.
 
.. sh:function:: tinkerforge call segment-display-4x7-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|
 


.. _segment_display_4x7_bricklet_shell_callbacks:

Callbacks
^^^^^^^^^

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

.. code-block:: bash

    tinkerforge dispatch segment-display-4x7-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 segment-display-4x7-bricklet <uid> counter-finished

 :noreturn: no output


 This callback is triggered when the counter (see :sh:func:`start-counter <segment-display-4x7-bricklet start-counter>`) is
 finished.
 


