..
 #############################################################
 # 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-java">Software</a> / Java - Remote Switch Bricklet

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

.. _remote_switch_bricklet_java:

Java - Remote Switch Bricklet
=============================

This is the description of the :ref:`Java API bindings <api_bindings_java>` for the :ref:`Remote Switch Bricklet <remote_switch_bricklet>`. General information and technical
specifications for the Remote Switch Bricklet are summarized in its :ref:`hardware description
<remote_switch_bricklet_description>`.

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

.. _remote_switch_bricklet_java_examples:


Examples
--------

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

Switch Socket
^^^^^^^^^^^^^

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

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

.. _remote_switch_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 BrickletRemoteSwitch(String uid, IPConnection ipcon)

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

 .. code-block:: java

  BrickletRemoteSwitch remoteSwitch = new BrickletRemoteSwitch("YOUR_DEVICE_UID", ipcon);

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


.. java:function:: public void BrickletRemoteSwitch::switchSocket(short houseCode, short receiverCode, short switchTo)

 This function is deprecated, use :java:func:`switchSocketA() <BrickletRemoteSwitch::switchSocketA>` instead.
 
 The following constants are available for this function:
 
 * BrickletRemoteSwitch.SWITCH_TO_OFF = 0
 * BrickletRemoteSwitch.SWITCH_TO_ON = 1
 
.. java:function:: public short BrickletRemoteSwitch::getSwitchingState()

 Returns the current switching state. If the current state is busy, the
 Bricklet is currently sending a code to switch a socket. It will not
 accept any calls of :java:func:`switchSocket() <BrickletRemoteSwitch::switchSocket>` until the state changes to ready.
 
 How long the switching takes is dependent on the number of repeats, see
 :java:func:`setRepeats() <BrickletRemoteSwitch::setRepeats>`.
 
 The following constants are available for this function:
 
 * BrickletRemoteSwitch.SWITCHING_STATE_READY = 0
 * BrickletRemoteSwitch.SWITCHING_STATE_BUSY = 1
 
.. java:function:: public void BrickletRemoteSwitch::switchSocketA(short houseCode, short receiverCode, short switchTo)

 To switch a type A socket you have to give the house code, receiver code and the
 state (on or off) you want to switch to.
 
 The house code and receiver code have a range of 0 to 31 (5bit).
 
 A detailed description on how you can figure out the house and receiver code
 can be found :ref:`here <remote_switch_bricklet_type_a_house_and_receiver_code>`.
 
 The following constants are available for this function:
 
 * BrickletRemoteSwitch.SWITCH_TO_OFF = 0
 * BrickletRemoteSwitch.SWITCH_TO_ON = 1
 
 .. versionadded:: 2.0.1~(Plugin)
 
.. java:function:: public void BrickletRemoteSwitch::switchSocketB(long address, short unit, short switchTo)

 To switch a type B socket you have to give the address, unit and the state
 (on or off) you want to switch to.
 
 The address has a range of 0 to 67108863 (26bit) and the unit has a range
 of 0 to 15 (4bit). To switch all devices with the same address use 255 for
 the unit.
 
 A detailed description on how you can teach a socket the address and unit can
 be found :ref:`here <remote_switch_bricklet_type_b_address_and_unit>`.
 
 The following constants are available for this function:
 
 * BrickletRemoteSwitch.SWITCH_TO_OFF = 0
 * BrickletRemoteSwitch.SWITCH_TO_ON = 1
 
 .. versionadded:: 2.0.1~(Plugin)
 
.. java:function:: public void BrickletRemoteSwitch::dimSocketB(long address, short unit, short dimValue)

 To control a type B dimmer you have to give the address, unit and the
 dim value you want to set the dimmer to.
 
 The address has a range of 0 to 67108863 (26bit), the unit and the dim value
 has a range of 0 to 15 (4bit).
 
 A detailed description on how you can teach a dimmer the address and unit can
 be found :ref:`here <remote_switch_bricklet_type_b_address_and_unit>`.
 
 .. versionadded:: 2.0.1~(Plugin)
 
.. java:function:: public void BrickletRemoteSwitch::switchSocketC(char systemCode, short deviceCode, short switchTo)

 To switch a type C socket you have to give the system code, device code and the
 state (on or off) you want to switch to.
 
 The system code has a range of 'A' to 'P' (4bit) and the device code has a
 range of 1 to 16 (4bit).
 
 A detailed description on how you can figure out the system and device code
 can be found :ref:`here <remote_switch_bricklet_type_c_system_and_device_code>`.
 
 The following constants are available for this function:
 
 * BrickletRemoteSwitch.SWITCH_TO_OFF = 0
 * BrickletRemoteSwitch.SWITCH_TO_ON = 1
 
 .. versionadded:: 2.0.1~(Plugin)
 


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

.. java:function:: public void BrickletRemoteSwitch::setRepeats(short repeats)

 Sets the number of times the code is send when of the :java:func:`switchSocket() <BrickletRemoteSwitch::switchSocket>`
 functions is called. The repeats basically correspond to the amount of time
 that a button of the remote is pressed.
 
 Some dimmers are controlled by the length of a button pressed,
 this can be simulated by increasing the repeats.
 
 The default value is 5.
 
.. java:function:: public short BrickletRemoteSwitch::getRepeats()

 Returns the number of repeats as set by :java:func:`setRepeats() <BrickletRemoteSwitch::setRepeats>`. 
 
.. java:function:: public short[] BrickletRemoteSwitch::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 BrickletRemoteSwitch::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() <BrickletRemoteSwitch::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() <BrickletRemoteSwitch::setResponseExpected>`
 for the list of function ID constants available for this function.
 
.. java:function:: public void BrickletRemoteSwitch::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:
 
 * BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET = 1
 * BrickletRemoteSwitch.FUNCTION_SET_REPEATS = 4
 * BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_A = 6
 * BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_B = 7
 * BrickletRemoteSwitch.FUNCTION_DIM_SOCKET_B = 8
 * BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_C = 9
 
.. java:function:: public void BrickletRemoteSwitch::setResponseExpectedAll(boolean responseExpected)

 Changes the response expected flag for all setter and listener configuration
 functions of this device at once.
 
.. java:function:: public BrickletRemoteSwitch.Identity BrickletRemoteSwitch::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``.



.. _remote_switch_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 BrickletRemoteSwitch.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 BrickletRemoteSwitch.SwitchingDoneListener()

 This listener can be added with the ``addSwitchingDoneListener()`` function.
 An added listener can be removed with the ``removeSwitchingDoneListener()`` function.

 .. java:function:: public void switchingDone()
  :noindex:


  This listener is called whenever the switching state changes
  from busy to ready, see :java:func:`getSwitchingState() <BrickletRemoteSwitch::getSwitchingState>`.
  


.. _remote_switch_bricklet_java_constants:

Constants
^^^^^^^^^

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

 This constant is used to identify a Remote Switch Bricklet.

 The :java:func:`getIdentity() <BrickletRemoteSwitch::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.

