..
 #############################################################
 # 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-javascript">Software</a> / JavaScript - Segment Display 4x7 Bricklet

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

.. _segment_display_4x7_bricklet_javascript:

JavaScript - Segment Display 4x7 Bricklet
=========================================

This is the description of the :ref:`JavaScript API bindings <api_bindings_javascript>` 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_javascript_install>` for the JavaScript API
bindings is part of their general description.

.. _segment_display_4x7_bricklet_javascript_examples:


Examples
--------

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

Simple (Node.js)
^^^^^^^^^^^^^^^^

`Download (ExampleSimple.js) <https://github.com/Tinkerforge/segment-display-4x7-bricklet/raw/master/software/examples/javascript/ExampleSimple.js>`__

.. literalinclude:: SegmentDisplay4x7_Bricklet_JavaScript_ExampleSimple.js
 :language: javascript
 :linenos:
 :tab-width: 4

Simple (HTML)
^^^^^^^^^^^^^

`Download (ExampleSimple.html) <https://github.com/Tinkerforge/segment-display-4x7-bricklet/raw/master/software/examples/javascript/ExampleSimple.html>`__, `Test (ExampleSimple.html) <http://www.tinkerforge.com/en/doc/Software/Examples/JavaScript/SegmentDisplay4x7_Bricklet_JavaScript_ExampleSimple.html>`__

.. literalinclude:: SegmentDisplay4x7_Bricklet_JavaScript_ExampleSimple.html
 :language: html
 :linenos:
 :tab-width: 4

.. _segment_display_4x7_bricklet_javascript_api:

API
---

Generally, every method of the JavaScript bindings can take two optional
parameters, ``returnCallback`` and ``errorCallback``. These are two user
defined callback functions. The ``returnCallback`` is called with the return
values as parameters, if the method returns something. The ``errorCallback``
is called with an error code in case of an error. The error code can be one
of the following values:

* IPConnection.ERROR_ALREADY_CONNECTED = 11
* IPConnection.ERROR_NOT_CONNECTED = 12
* IPConnection.ERROR_CONNECT_FAILED = 13
* IPConnection.ERROR_INVALID_FUNCTION_ID = 21
* IPConnection.ERROR_TIMEOUT = 31
* IPConnection.ERROR_INVALID_PARAMETER = 41
* IPConnection.ERROR_FUNCTION_NOT_SUPPORTED = 42
* IPConnection.ERROR_UNKNOWN_ERROR = 43

The namespace for the JavaScript bindings is ``Tinkerforge.*``.




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


.. javascript:function:: new BrickletSegmentDisplay4x7(uid, ipcon)

 :param uid: string
 :param ipcon: IPConnection

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

 .. code-block:: javascript

    var segmentDisplay4x7 = new BrickletSegmentDisplay4x7("YOUR_DEVICE_UID", ipcon);

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


.. javascript:function:: BrickletSegmentDisplay4x7.setSegments(segments, brightness, colon, [returnCallback], [errorCallback])

 :param segments: [int, int, int, int]
 :param brightness: int
 :param colon: boolean

 :noreturn: undefined

 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.
 
.. javascript:function:: BrickletSegmentDisplay4x7.getSegments([returnCallback], [errorCallback])


 :return segments: [int, int, int, int]
 :return brightness: int
 :return colon: boolean

 Returns the segment, brightness and color data as set by 
 :javascript:func:`setSegments() <BrickletSegmentDisplay4x7.setSegments>`.
 


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

.. javascript:function:: BrickletSegmentDisplay4x7.startCounter(valueFrom, valueTo, increment, length, [returnCallback], [errorCallback])

 :param valueFrom: int
 :param valueTo: int
 :param increment: int
 :param length: int

 :noreturn: undefined

 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 :javascript:func:`setSegments() <BrickletSegmentDisplay4x7.setSegments>`.
 
.. javascript:function:: BrickletSegmentDisplay4x7.getCounterValue([returnCallback], [errorCallback])


 :return value: int

 Returns the counter value that is currently shown on the display.
 
 If there is no counter running a 0 will be returned.
 
.. javascript:function:: BrickletSegmentDisplay4x7.getAPIVersion()

 :rtype: [int, int, int]

 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.
 
.. javascript:function:: BrickletSegmentDisplay4x7.getResponseExpected(functionId, [errorCallback])

 :param functionId: int
 :rtype: boolean

 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
 :javascript:func:`setResponseExpected() <BrickletSegmentDisplay4x7.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 :javascript:func:`setResponseExpected() <BrickletSegmentDisplay4x7.setResponseExpected>`
 for the list of function ID constants available for this function.
 
.. javascript:function:: BrickletSegmentDisplay4x7.setResponseExpected(functionId, responseExpected, [errorCallback])

 :param functionId: int
 :param responseExpected: boolean

 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:
 
 * BrickletSegmentDisplay4x7.FUNCTION_SET_SEGMENTS = 1
 * BrickletSegmentDisplay4x7.FUNCTION_START_COUNTER = 3
 
.. javascript:function:: BrickletSegmentDisplay4x7.setResponseExpectedAll(responseExpected)

 :param responseExpected: boolean

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. javascript:function:: BrickletSegmentDisplay4x7.getIdentity([returnCallback], [errorCallback])


 :return uid: string
 :return connectedUid: string
 :return position: char
 :return hardwareVersion: [int, int, int]
 :return firmwareVersion: [int, int, int]
 :return deviceIdentifier: int

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


.. javascript:function:: BrickletSegmentDisplay4x7.on(id, callback)

 :param id: int
 :param callback: function

 Registers a callback with ID *id* to the function *callback*. The available
 IDs with corresponding function signatures are listed
 :ref:`below <segment_display_4x7_bricklet_javascript_callbacks>`.




.. _segment_display_4x7_bricklet_javascript_callbacks:

Callbacks
^^^^^^^^^

Callbacks can be registered to receive
time critical or recurring data from the device. The registration is done
with the :javascript:func:`on() <BrickletSegmentDisplay4x7.on>` function of
the device object. The first parameter is the callback ID and the second
parameter the callback function:

.. code-block:: javascript

    segmentDisplay4x7.on(BrickletSegmentDisplay4x7.CALLBACK_EXAMPLE,
        function (param) {
            console.log(param);
        }
    );

The available constants with inherent number and 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.

.. javascript:attribute:: BrickletSegmentDisplay4x7.CALLBACK_COUNTER_FINISHED



 This callback is triggered when the counter (see :javascript:func:`startCounter() <BrickletSegmentDisplay4x7.startCounter>`) is
 finished.
 


.. _segment_display_4x7_bricklet_javascript_constants:

Constants
^^^^^^^^^

.. javascript:attribute:: BrickletSegmentDisplay4x7.DEVICE_IDENTIFIER

 This constant is used to identify a Segment Display 4x7 Bricklet.

 The :javascript:func:`getIdentity() <BrickletSegmentDisplay4x7.getIdentity>` function and the
 :javascript:attr:`CALLBACK_ENUMERATE <IPConnection.CALLBACK_ENUMERATE>`
 callback of the IP Connection have a ``device_identifier`` parameter to specify
 the Brick's or Bricklet's type.

