..
 #############################################################
 # 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-delphi">Software</a> / Delphi/Lazarus - Remote Switch Bricklet

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

.. _remote_switch_bricklet_delphi:

Delphi/Lazarus - Remote Switch Bricklet
=======================================

This is the description of the :ref:`Delphi/Lazarus API bindings <api_bindings_delphi>` 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_delphi_install>` for the Delphi/Lazarus API
bindings is part of their general description.

.. _remote_switch_bricklet_delphi_examples:


Examples
--------

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

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

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

.. literalinclude:: RemoteSwitch_Bricklet_Delphi_ExampleSwitchSocket.pas
 :language: delphi
 :linenos:
 :tab-width: 4

.. _remote_switch_bricklet_delphi_api:

API
---

Since Delphi does not support multiple return values directly, we use the
``out`` keyword to return multiple values from a function.

All functions and procedures listed below are thread-safe.




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


.. delphi:function:: constructor TBrickletRemoteSwitch.Create(const uid: string; ipcon: TIPConnection)

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

 .. code-block:: delphi

    remoteSwitch := TBrickletRemoteSwitch.Create('YOUR_DEVICE_UID', ipcon);

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


.. delphi:function:: procedure TBrickletRemoteSwitch.SwitchSocket(const houseCode: byte; const receiverCode: byte; const switchTo: byte)

 This function is deprecated, use :delphi:func:`SwitchSocketA <TBrickletRemoteSwitch.SwitchSocketA>` instead.
 
 The following constants are available for this function:
 
 * BRICKLET_REMOTE_SWITCH_SWITCH_TO_OFF = 0
 * BRICKLET_REMOTE_SWITCH_SWITCH_TO_ON = 1
 
.. delphi:function:: function TBrickletRemoteSwitch.GetSwitchingState(): byte

 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 :delphi:func:`SwitchSocket <TBrickletRemoteSwitch.SwitchSocket>` until the state changes to ready.
 
 How long the switching takes is dependent on the number of repeats, see
 :delphi:func:`SetRepeats <TBrickletRemoteSwitch.SetRepeats>`.
 
 The following constants are available for this function:
 
 * BRICKLET_REMOTE_SWITCH_SWITCHING_STATE_READY = 0
 * BRICKLET_REMOTE_SWITCH_SWITCHING_STATE_BUSY = 1
 
.. delphi:function:: procedure TBrickletRemoteSwitch.SwitchSocketA(const houseCode: byte; const receiverCode: byte; const switchTo: byte)

 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:
 
 * BRICKLET_REMOTE_SWITCH_SWITCH_TO_OFF = 0
 * BRICKLET_REMOTE_SWITCH_SWITCH_TO_ON = 1
 
 .. versionadded:: 2.0.1~(Plugin)
 
.. delphi:function:: procedure TBrickletRemoteSwitch.SwitchSocketB(const address: longword; const unit: byte; const switchTo: byte)

 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:
 
 * BRICKLET_REMOTE_SWITCH_SWITCH_TO_OFF = 0
 * BRICKLET_REMOTE_SWITCH_SWITCH_TO_ON = 1
 
 .. versionadded:: 2.0.1~(Plugin)
 
.. delphi:function:: procedure TBrickletRemoteSwitch.DimSocketB(const address: longword; const unit: byte; const dimValue: byte)

 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)
 
.. delphi:function:: procedure TBrickletRemoteSwitch.SwitchSocketC(const systemCode: char; const deviceCode: byte; const switchTo: byte)

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


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

.. delphi:function:: procedure TBrickletRemoteSwitch.SetRepeats(const repeats: byte)

 Sets the number of times the code is send when of the :delphi:func:`SwitchSocket <TBrickletRemoteSwitch.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.
 
.. delphi:function:: function TBrickletRemoteSwitch.GetRepeats(): byte

 Returns the number of repeats as set by :delphi:func:`SetRepeats <TBrickletRemoteSwitch.SetRepeats>`. 
 
.. delphi:function:: function TBrickletRemoteSwitch.GetAPIVersion(): array [0..2] of byte

 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.
 
.. delphi:function:: function TBrickletRemoteSwitch.GetResponseExpected(const functionId: byte): 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
 :delphi:func:`SetResponseExpected <TBrickletRemoteSwitch.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 :delphi:func:`SetResponseExpected <TBrickletRemoteSwitch.SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. delphi:function:: procedure TBrickletRemoteSwitch.SetResponseExpected(const functionId: byte; const 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:
 
 * BRICKLET_REMOTE_SWITCH_FUNCTION_SWITCH_SOCKET = 1
 * BRICKLET_REMOTE_SWITCH_FUNCTION_SET_REPEATS = 4
 * BRICKLET_REMOTE_SWITCH_FUNCTION_SWITCH_SOCKET_A = 6
 * BRICKLET_REMOTE_SWITCH_FUNCTION_SWITCH_SOCKET_B = 7
 * BRICKLET_REMOTE_SWITCH_FUNCTION_DIM_SOCKET_B = 8
 * BRICKLET_REMOTE_SWITCH_FUNCTION_SWITCH_SOCKET_C = 9
 
.. delphi:function:: procedure TBrickletRemoteSwitch.SetResponseExpectedAll(const responseExpected: boolean)

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. delphi:function:: procedure TBrickletRemoteSwitch.GetIdentity(out uid: string; out connectedUid: string; out position: char; out hardwareVersion: array [0..2] of byte; out firmwareVersion: array [0..2] of byte; out deviceIdentifier: word)

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





.. _remote_switch_bricklet_delphi_callbacks:

Callbacks
^^^^^^^^^

Callbacks can be registered to receive time critical or recurring data from
the device. The registration is done by assigning a procedure to an callback
property of the device object:

 .. code-block:: delphi

  procedure TExample.MyCallback(sender: TBrickletRemoteSwitch; const param: word);
  begin
    WriteLn(param);
  end;

  remoteSwitch.OnExample := {$ifdef FPC}@{$endif}example.MyCallback;

The available callback property and their 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.

.. delphi:function:: property TBrickletRemoteSwitch.OnSwitchingDone

 .. code-block:: delphi

  procedure(sender: TBrickletRemoteSwitch) of object;


 This callback is called whenever the switching state changes
 from busy to ready, see :delphi:func:`GetSwitchingState <TBrickletRemoteSwitch.GetSwitchingState>`.
 


.. _remote_switch_bricklet_delphi_constants:

Constants
^^^^^^^^^

.. delphi:function:: const BRICKLET_REMOTE_SWITCH_DEVICE_IDENTIFIER

 This constant is used to identify a Remote Switch Bricklet.

 The :delphi:func:`GetIdentity <TBrickletRemoteSwitch.GetIdentity>` function and the
 :delphi:func:`OnEnumerate <TIPConnection.OnEnumerate>`
 callback of the IP Connection have a ``deviceIdentifier`` parameter to specify
 the Brick's or Bricklet's type.

