..
 #############################################################
 # This file was automatically generated on 2015-05-19.      #
 #                                                           #
 # 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       #
 #############################################################

:orphan:
:breadcrumbs: <a href="../../index.html">Home</a> / <a href="../../index.html#software-java">Software</a> / Java - RS232 Bricklet

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

.. _rs232_bricklet_java:

Java - RS232 Bricklet
=====================

.. note::
 This Bricklet is currently in the prototype stage and the software/hardware
 as well as the documentation is in an incomplete state.


This is the description of the :ref:`Java API bindings <api_bindings_java>` for the :ref:`RS232 Bricklet <rs232_bricklet>`. General information and technical
specifications for the RS232 Bricklet are summarized in its :ref:`hardware description
<rs232_bricklet_description>`.

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

.. _rs232_bricklet_java_examples:


Examples
--------

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

Loopback
^^^^^^^^

`Download (ExampleLoopback.java) <https://github.com/Tinkerforge/rs232-bricklet/raw/master/software/examples/java/ExampleLoopback.java>`__

.. literalinclude:: RS232_Bricklet_Java_ExampleLoopback.java
 :language: java
 :linenos:
 :tab-width: 4

.. _rs232_bricklet_java_api:

API
---

Generally, every method of the Java bindings that returns a value can
throw a ``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 unplugs the
device). However, if a wireless connection is used, timeouts will occur
if the distance to the device gets too big.

Beside the ``TimeoutException`` there is also a ``NotConnectedException`` that
is thrown if a method needs to communicate with the device while the
IP Connection is not connected.

Since Java does not support multiple return values and return by reference
is not possible for primitive types, we use small classes that
only consist of member variables. The member variables of the returned objects
are described in the corresponding method descriptions.

The package for all Brick/Bricklet bindings and the IP Connection is
``com.tinkerforge.*``

All methods listed below are thread-safe.




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


.. java:function:: class BrickletRS232(String uid, IPConnection ipcon)

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

 .. code-block:: java

  BrickletRS232 rs232 = new BrickletRS232("YOUR_DEVICE_UID", ipcon);

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


.. java:function:: public short BrickletRS232::write(char[] message, short length)

 Writes a string of up to 60 characters to the RS232 interface. The string
 can be binary data, ASCII or similar is not necessary.
 
 The length of the string has to be given as an additional parameter.
 
 The return value is the number of bytes that could be written.
 
 See :func:`SetConfigurations` for configuration possibilities
 regarding baudrate, parity and so on.
 
.. java:function:: public BrickletRS232.Read BrickletRS232::read()

 Returns the currently buffered message. The maximum length
 of message is 60. If the length is given as 0, there was no
 new data available.
 
 Instead of polling with this function, you can also use
 callbacks. See :java:func:`enableCallback() <BrickletRS232::enableCallback>` and :java:func:`ReadCallbackListener <BrickletRS232.ReadCallbackListener>`.
 
 The returned object has the public member variables ``char[] message`` and ``short length``.

.. java:function:: public void BrickletRS232::setConfiguration(short baudrate, short parity, short stopbits, short wordlength, short hardwareFlowcontrol, short softwareFlowcontrol)

 Sets the configuration for the RS232 communication. Available options:
 
 * Baudrate between 300 and 230400 baud.
 * Parity of none, odd, even or forced parity.
 * Stopbits can be 1 or 2.
 * Word length of 5 to 8.
 * Hard-/Software flow control can each be on or off.
 
 The default is: 115200 baud, parity none, 1 stop bit, word length 8, hard-/software flow control off.
 
 The following constants are available for this function:
 
 * BrickletRS232.BAUDRATE_300 = 0
 * BrickletRS232.BAUDRATE_600 = 1
 * BrickletRS232.BAUDRATE_1200 = 2
 * BrickletRS232.BAUDRATE_2400 = 3
 * BrickletRS232.BAUDRATE_4800 = 4
 * BrickletRS232.BAUDRATE_9600 = 5
 * BrickletRS232.BAUDRATE_14400 = 6
 * BrickletRS232.BAUDRATE_28800 = 7
 * BrickletRS232.BAUDRATE_38400 = 8
 * BrickletRS232.BAUDRATE_57600 = 9
 * BrickletRS232.BAUDRATE_115200 = 10
 * BrickletRS232.BAUDRATE_230400 = 11
 * BrickletRS232.PARITY_NONE = 0
 * BrickletRS232.PARITY_ODD = 1
 * BrickletRS232.PARITY_EVEN = 2
 * BrickletRS232.PARITY_FORCED_PARITY_1 = 3
 * BrickletRS232.PARITY_FORCED_PARITY_0 = 4
 * BrickletRS232.STOPBITS_1 = 1
 * BrickletRS232.STOPBITS_2 = 2
 * BrickletRS232.WORDLENGTH_5 = 5
 * BrickletRS232.WORDLENGTH_6 = 6
 * BrickletRS232.WORDLENGTH_7 = 7
 * BrickletRS232.WORDLENGTH_8 = 8
 * BrickletRS232.HARDWARE_FLOWCONTROL_OFF = 0
 * BrickletRS232.HARDWARE_FLOWCONTROL_ON = 1
 * BrickletRS232.SOFTWARE_FLOWCONTROL_OFF = 0
 * BrickletRS232.SOFTWARE_FLOWCONTROL_ON = 1
 
.. java:function:: public BrickletRS232.Configuration BrickletRS232::getConfiguration()

 Returns the configuration as set by :java:func:`setConfiguration() <BrickletRS232::setConfiguration>`.
 
 The following constants are available for this function:
 
 * BrickletRS232.BAUDRATE_300 = 0
 * BrickletRS232.BAUDRATE_600 = 1
 * BrickletRS232.BAUDRATE_1200 = 2
 * BrickletRS232.BAUDRATE_2400 = 3
 * BrickletRS232.BAUDRATE_4800 = 4
 * BrickletRS232.BAUDRATE_9600 = 5
 * BrickletRS232.BAUDRATE_14400 = 6
 * BrickletRS232.BAUDRATE_28800 = 7
 * BrickletRS232.BAUDRATE_38400 = 8
 * BrickletRS232.BAUDRATE_57600 = 9
 * BrickletRS232.BAUDRATE_115200 = 10
 * BrickletRS232.BAUDRATE_230400 = 11
 * BrickletRS232.PARITY_NONE = 0
 * BrickletRS232.PARITY_ODD = 1
 * BrickletRS232.PARITY_EVEN = 2
 * BrickletRS232.PARITY_FORCED_PARITY_1 = 3
 * BrickletRS232.PARITY_FORCED_PARITY_0 = 4
 * BrickletRS232.STOPBITS_1 = 1
 * BrickletRS232.STOPBITS_2 = 2
 * BrickletRS232.WORDLENGTH_5 = 5
 * BrickletRS232.WORDLENGTH_6 = 6
 * BrickletRS232.WORDLENGTH_7 = 7
 * BrickletRS232.WORDLENGTH_8 = 8
 * BrickletRS232.HARDWARE_FLOWCONTROL_OFF = 0
 * BrickletRS232.HARDWARE_FLOWCONTROL_ON = 1
 * BrickletRS232.SOFTWARE_FLOWCONTROL_OFF = 0
 * BrickletRS232.SOFTWARE_FLOWCONTROL_ON = 1
 
 The returned object has the public member variables ``short baudrate``, ``short parity``, ``short stopbits``, ``short wordlength``, ``short hardwareFlowcontrol`` and ``short softwareFlowcontrol``.



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

.. java:function:: public short[] BrickletRS232::getAPIVersion()

 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.
 
.. java:function:: public boolean BrickletRS232::getResponseExpected(short functionId)

 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 listener configuration
 functions it is enabled by default too, but can be disabled by
 :java:func:`setResponseExpected() <BrickletRS232::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 :java:func:`setResponseExpected() <BrickletRS232::setResponseExpected>`
 for the list of function ID constants available for this function.
 
.. java:function:: public void BrickletRS232::setResponseExpected(short functionId, boolean responseExpected)

 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 listener configuration functions (default value: *true*). For
 getter functions it is always enabled and listeners 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:
 
 * BrickletRS232.FUNCTION_ENABLE_CALLBACK = 3
 * BrickletRS232.FUNCTION_DISABLE_CALLBACK = 4
 * BrickletRS232.FUNCTION_SET_CONFIGURATION = 6
 
.. java:function:: public void BrickletRS232::setResponseExpectedAll(boolean responseExpected)

 Changes the response expected flag for all setter and listener configuration
 functions of this device at once.
 
.. java:function:: public BrickletRS232.Identity BrickletRS232::getIdentity()

 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|
 
 The returned object has the public member variables ``String uid``, ``String connectedUid``, ``char position``, ``short[] hardwareVersion``, ``short[] firmwareVersion`` and ``int deviceIdentifier``.



Listener Configuration Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. java:function:: public void BrickletRS232::enableCallback()

 Enables the :java:func:`ReadCallbackListener <BrickletRS232.ReadCallbackListener>`.
 
 By default the listener is disabled.
 
.. java:function:: public void BrickletRS232::disableCallback()

 Disables the :java:func:`ReadCallbackListener <BrickletRS232.ReadCallbackListener>`.
 
 By default the listener is disabled.
 
.. java:function:: public boolean BrickletRS232::isCallbackEnabled()

 Returns *true* if the :java:func:`ReadCallbackListener <BrickletRS232.ReadCallbackListener>` is enabled,
 *false* otherwise.
 


.. _rs232_bricklet_java_callbacks:

Listeners
^^^^^^^^^

Listeners can be registered to receive
time critical or recurring data from the device. The registration is done
with "add*Listener" functions of the device object.

The parameter is a listener class object, for example:

.. code-block:: java

    device.addExampleListener(new BrickletRS232.ExampleListener() {
        public void property(int value) {
            System.out.println("Value: " + value);
        }
    });

The available listener classes with inherent methods to be overwritten
are described below. It is possible to add several listeners and
to remove them with the corresponding "remove*Listener" function.

.. note::
 Using listeners 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.


.. java:function:: public class BrickletRS232.ReadCallbackListener()

 This listener can be added with the ``addReadCallbackListener()`` function.
 An added listener can be removed with the ``removeReadCallbackListener()`` function.

 .. java:function:: public void readCallback(char[] message, short length)
  :noindex:


  This listener is called if new data is available. The message has
  a maximum size of 60 characters. The actual length of the message
  is given in addition.
  
  To enable this listener, use :java:func:`enableCallback() <BrickletRS232::enableCallback>`.
  


.. _rs232_bricklet_java_constants:

Constants
^^^^^^^^^

.. java:member:: public static final int BrickletRS232.DEVICE_IDENTIFIER

 This constant is used to identify a RS232 Bricklet.

 The :java:func:`getIdentity() <BrickletRS232::getIdentity>` function and the
 :java:func:`EnumerateListener <IPConnection.EnumerateListener>`
 listener of the IP Connection have a ``deviceIdentifier`` parameter to specify
 the Brick's or Bricklet's type.

