..
 #############################################################
 # 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-ruby">Software</a> / Ruby - Solid State Relay Bricklet

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

.. _solid_state_relay_bricklet_ruby:

Ruby - Solid State Relay Bricklet
=================================

This is the description of the :ref:`Ruby API bindings <api_bindings_ruby>` for the :ref:`Solid State Relay Bricklet <solid_state_relay_bricklet>`. General information and technical
specifications for the Solid State Relay Bricklet are summarized in its :ref:`hardware description
<solid_state_relay_bricklet_description>`.

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

.. _solid_state_relay_bricklet_ruby_examples:


Examples
--------

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

Simple
^^^^^^

`Download (example_simple.rb) <https://github.com/Tinkerforge/solid-state-relay-bricklet/raw/master/software/examples/ruby/example_simple.rb>`__

.. literalinclude:: SolidStateRelay_Bricklet_Ruby_example_simple.rb
 :language: ruby
 :linenos:
 :tab-width: 4

.. _solid_state_relay_bricklet_ruby_api:

API
---

All methods listed below are thread-safe.




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


.. rb:function:: BrickletSolidStateRelay::new(uid, ipcon) -> solid_state_relay

 :param uid: str
 :param ipcon: IPConnection

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

 .. code-block:: ruby

    solid_state_relay = BrickletSolidStateRelay.new 'YOUR_DEVICE_UID', ipcon

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


.. rb:function:: BrickletSolidStateRelay#set_state(state) -> nil

 :param state: bool

 Sets the state of the relays *true* means on and *false* means off. 
 
 Running monoflop timers will be overwritten if this function is called.
 
 The default value is *false*.
 
.. rb:function:: BrickletSolidStateRelay#get_state -> bool


 Returns the state of the relay, *true* means on and *false* means off. 
 


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

.. rb:function:: BrickletSolidStateRelay#set_monoflop(state, time) -> nil

 :param state: bool
 :param time: int

 The first parameter  is the desired state of the relay (*true* means on 
 and *false* means off). The second parameter indicates the time (in ms) that 
 the relay should hold the state.
 
 If this function is called with the parameters (true, 1500):
 The relay will turn on and in 1.5s it will turn off again.
 
 A monoflop can be used as a failsafe mechanism. For example: Lets assume you 
 have a RS485 bus and a Solid State Relay Bricklet connected to one of the slave 
 stacks. You can now call this function every second, with a time parameter
 of two seconds. The relay will be on all the time. If now the RS485 
 connection is lost, the relay will turn off in at most two seconds.
 
.. rb:function:: BrickletSolidStateRelay#get_monoflop -> [bool, int, int]


 Returns the current state and the time as set by 
 :rb:func:`#set_monoflop <BrickletSolidStateRelay#set_monoflop>` as well as the remaining time until the state flips.
 
 If the timer is not running currently, the remaining time will be returned
 as 0.
 
 The returned array has the values ``state``, ``time`` and ``time_remaining``.

.. rb:function:: BrickletSolidStateRelay#get_api_version -> [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.
 
.. rb:function:: BrickletSolidStateRelay#get_response_expected(function_id) -> bool

 :param function_id: int

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

 :param function_id: int
 :param response_expected: bool

 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:
 
 * BrickletSolidStateRelay::FUNCTION_SET_STATE = 1
 * BrickletSolidStateRelay::FUNCTION_SET_MONOFLOP = 3
 
.. rb:function:: BrickletSolidStateRelay#set_response_expected_all(response_expected) -> nil

 :param response_expected: bool

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. rb:function:: BrickletSolidStateRelay#get_identity -> [str, str, str, [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 array has the values ``uid``, ``connected_uid``, ``position``, ``hardware_version``, ``firmware_version`` and ``device_identifier``.



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


.. rb:function:: BrickletSolidStateRelay#register_callback(id) { |param [, ...]| block } -> nil

 :param id: int

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




.. _solid_state_relay_bricklet_ruby_callbacks:

Callbacks
^^^^^^^^^

Callbacks can be registered to receive time critical or recurring data from
the device. The registration is done with the
:rb:func:`#register_callback <BrickletSolidStateRelay#register_callback>` function of
the device object. The first parameter is the callback ID and the second
parameter is a block:

.. code-block:: ruby

    solid_state_relay.register_callback BrickletSolidStateRelay::CALLBACK_EXAMPLE, do |param|
      puts "#{param}"
    end

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.

.. rb:attribute:: BrickletSolidStateRelay::CALLBACK_MONOFLOP_DONE

 :param state: bool


 This callback is triggered whenever the monoflop timer reaches 0. 
 The parameter is the current state of the relay 
 (the state after the monoflop).
 


.. _solid_state_relay_bricklet_ruby_constants:

Constants
^^^^^^^^^

.. rb:attribute:: BrickletSolidStateRelay::DEVICE_IDENTIFIER

 This constant is used to identify a Solid State Relay Bricklet.

 The :rb:func:`#get_identity() <BrickletSolidStateRelay#get_identity>` function and the
 :rb: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.

