..
 #############################################################
 # 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 - Motion Detector Bricklet

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

.. _motion_detector_bricklet_ruby:

Ruby - Motion Detector Bricklet
===============================

This is the description of the :ref:`Ruby API bindings <api_bindings_ruby>` for the :ref:`Motion Detector Bricklet <motion_detector_bricklet>`. General information and technical
specifications for the Motion Detector Bricklet are summarized in its :ref:`hardware description
<motion_detector_bricklet_description>`.

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

.. _motion_detector_bricklet_ruby_examples:


Examples
--------

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

Callback
^^^^^^^^

`Download (example_callback.rb) <https://github.com/Tinkerforge/motion-detector-bricklet/raw/master/software/examples/ruby/example_callback.rb>`__

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

.. _motion_detector_bricklet_ruby_api:

API
---

All methods listed below are thread-safe.




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


.. rb:function:: BrickletMotionDetector::new(uid, ipcon) -> motion_detector

 :param uid: str
 :param ipcon: IPConnection

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

 .. code-block:: ruby

    motion_detector = BrickletMotionDetector.new 'YOUR_DEVICE_UID', ipcon

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


.. rb:function:: BrickletMotionDetector#get_motion_detected -> int


 Returns 1 if a motion was detected. How long this returns 1 after a motion
 was detected can be adjusted with one of the small potentiometers on the
 Motion Detector Bricklet, see :ref:`here
 <motion_detector_bricklet_sensitivity_delay_block_time>`.
 
 There is also a blue LED on the Bricklet that is on as long as the Bricklet is
 in the "motion detected" state.
 
 The following constants are available for this function:
 
 * BrickletMotionDetector::MOTION_NOT_DETECTED = 0
 * BrickletMotionDetector::MOTION_DETECTED = 1
 


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

.. rb:function:: BrickletMotionDetector#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:: BrickletMotionDetector#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 <BrickletMotionDetector#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 <BrickletMotionDetector#set_response_expected>`
 for the list of function ID constants available for this function.
 
.. rb:function:: BrickletMotionDetector#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:
 
 
.. rb:function:: BrickletMotionDetector#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:: BrickletMotionDetector#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:: BrickletMotionDetector#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 <motion_detector_bricklet_ruby_callbacks>`.




.. _motion_detector_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 <BrickletMotionDetector#register_callback>` function of
the device object. The first parameter is the callback ID and the second
parameter is a block:

.. code-block:: ruby

    motion_detector.register_callback BrickletMotionDetector::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:: BrickletMotionDetector::CALLBACK_MOTION_DETECTED



 This callback is called after a motion was detected.
 
.. rb:attribute:: BrickletMotionDetector::CALLBACK_DETECTION_CYCLE_ENDED



 This callback is called when the detection cycle ended. When this
 callback is called, a new motion can be detected again after approximately 2
 seconds.
 


.. _motion_detector_bricklet_ruby_constants:

Constants
^^^^^^^^^

.. rb:attribute:: BrickletMotionDetector::DEVICE_IDENTIFIER

 This constant is used to identify a Motion Detector Bricklet.

 The :rb:func:`#get_identity() <BrickletMotionDetector#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.

