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

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

.. _remote_switch_bricklet_python:

Python - Remote Switch Bricklet
===============================

This is the description of the :ref:`Python API bindings <api_bindings_python>` 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_python_install>` for the Python API
bindings is part of their general description.

.. _remote_switch_bricklet_python_examples:


Examples
--------

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

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

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

.. literalinclude:: RemoteSwitch_Bricklet_Python_example_switch_socket.py
 :language: python
 :linenos:
 :tab-width: 4

.. _remote_switch_bricklet_python_api:

API
---

Generally, every method of the Python bindings can throw an
``tinkerforge.ip_connection.Error`` exception that has a ``value`` and a
``description`` property. ``value`` can have different values:

* Error.TIMEOUT = -1
* Error.ALREADY_CONNECTED = -7
* Error.NOT_CONNECTED = -8
* Error.INVALID_PARAMETER = -9
* Error.NOT_SUPPORTED = -10
* Error.UNKNOWN_ERROR_CODE = -11

All methods listed below are thread-safe.




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


.. py:function:: RemoteSwitch(uid, ipcon)

 :param uid: string
 :param ipcon: IPConnection

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

 .. code-block:: python

    remote_switch = RemoteSwitch("YOUR_DEVICE_UID", ipcon)

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


.. py:function:: RemoteSwitch.switch_socket(house_code, receiver_code, switch_to)

 :param house_code: int
 :param receiver_code: int
 :param switch_to: int
 :rtype: None

 This function is deprecated, use :py:func:`switch_socket_a() <RemoteSwitch.switch_socket_a>` instead.
 
 The following constants are available for this function:
 
 * RemoteSwitch.SWITCH_TO_OFF = 0
 * RemoteSwitch.SWITCH_TO_ON = 1
 
.. py:function:: RemoteSwitch.get_switching_state()

 :rtype: int

 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 :py:func:`switch_socket() <RemoteSwitch.switch_socket>` until the state changes to ready.
 
 How long the switching takes is dependent on the number of repeats, see
 :py:func:`set_repeats() <RemoteSwitch.set_repeats>`.
 
 The following constants are available for this function:
 
 * RemoteSwitch.SWITCHING_STATE_READY = 0
 * RemoteSwitch.SWITCHING_STATE_BUSY = 1
 
.. py:function:: RemoteSwitch.switch_socket_a(house_code, receiver_code, switch_to)

 :param house_code: int
 :param receiver_code: int
 :param switch_to: int
 :rtype: None

 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:
 
 * RemoteSwitch.SWITCH_TO_OFF = 0
 * RemoteSwitch.SWITCH_TO_ON = 1
 
 .. versionadded:: 2.0.1~(Plugin)
 
.. py:function:: RemoteSwitch.switch_socket_b(address, unit, switch_to)

 :param address: int
 :param unit: int
 :param switch_to: int
 :rtype: None

 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:
 
 * RemoteSwitch.SWITCH_TO_OFF = 0
 * RemoteSwitch.SWITCH_TO_ON = 1
 
 .. versionadded:: 2.0.1~(Plugin)
 
.. py:function:: RemoteSwitch.dim_socket_b(address, unit, dim_value)

 :param address: int
 :param unit: int
 :param dim_value: int
 :rtype: None

 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)
 
.. py:function:: RemoteSwitch.switch_socket_c(system_code, device_code, switch_to)

 :param system_code: chr
 :param device_code: int
 :param switch_to: int
 :rtype: None

 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:
 
 * RemoteSwitch.SWITCH_TO_OFF = 0
 * RemoteSwitch.SWITCH_TO_ON = 1
 
 .. versionadded:: 2.0.1~(Plugin)
 


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

.. py:function:: RemoteSwitch.set_repeats(repeats)

 :param repeats: int
 :rtype: None

 Sets the number of times the code is send when of the :py:func:`switch_socket() <RemoteSwitch.switch_socket>`
 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.
 
.. py:function:: RemoteSwitch.get_repeats()

 :rtype: int

 Returns the number of repeats as set by :py:func:`set_repeats() <RemoteSwitch.set_repeats>`. 
 
.. py:function:: RemoteSwitch.get_api_version()

 :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.
 
.. py:function:: RemoteSwitch.get_response_expected(function_id)

 :param function_id: int
 :rtype: bool

 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
 :py:func:`set_response_expected() <RemoteSwitch.set_response_expected>`. 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 :py:func:`set_response_expected() <RemoteSwitch.set_response_expected>`
 for the list of function ID constants available for this function.
 
.. py:function:: RemoteSwitch.set_response_expected(function_id, response_expected)

 :param function_id: int
 :param response_expected: bool
 :rtype: None

 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:
 
 * RemoteSwitch.FUNCTION_SWITCH_SOCKET = 1
 * RemoteSwitch.FUNCTION_SET_REPEATS = 4
 * RemoteSwitch.FUNCTION_SWITCH_SOCKET_A = 6
 * RemoteSwitch.FUNCTION_SWITCH_SOCKET_B = 7
 * RemoteSwitch.FUNCTION_DIM_SOCKET_B = 8
 * RemoteSwitch.FUNCTION_SWITCH_SOCKET_C = 9
 
.. py:function:: RemoteSwitch.set_response_expected_all(response_expected)

 :param response_expected: bool
 :rtype: None

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. py:function:: RemoteSwitch.get_identity()

 :rtype: (str, str, chr, [int, int, int], [int, int, int], 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|
 
 The returned namedtuple has the variables ``uid``, ``connected_uid``, ``position``, ``hardware_version``, ``firmware_version`` and ``device_identifier``.



Callback Configuration Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


.. py:function:: RemoteSwitch.register_callback(id, callback)

 :param id: int
 :param callback: callable
 :rtype: None

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




.. _remote_switch_bricklet_python_callbacks:

Callbacks
^^^^^^^^^

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

.. code-block:: python

    def my_callback(param):
        print(param)

    remote_switch.register_callback(RemoteSwitch.CALLBACK_EXAMPLE, my_callback)

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.

.. py:attribute:: RemoteSwitch.CALLBACK_SWITCHING_DONE



 This callback is called whenever the switching state changes
 from busy to ready, see :py:func:`get_switching_state() <RemoteSwitch.get_switching_state>`.
 


.. _remote_switch_bricklet_python_constants:

Constants
^^^^^^^^^

.. py:attribute:: RemoteSwitch.DEVICE_IDENTIFIER

 This constant is used to identify a Remote Switch Bricklet.

 The :py:func:`get_identity() <RemoteSwitch.get_identity>` function and the
 :py: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.

