Ruby - Motion Detector Bricklet

This is the description of the Ruby API bindings for the Motion Detector Bricklet. General information and technical specifications for the Motion Detector Bricklet are summarized in its hardware description.

An installation guide for the Ruby API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Callback

Download (example_callback.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_motion_detector'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Motion Detector Bricklet

ipcon = IPConnection.new # Create IP connection
md = BrickletMotionDetector.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Register motion detected callback
md.register_callback(BrickletMotionDetector::CALLBACK_MOTION_DETECTED) do
  puts 'Motion Detected'
end

# Register detection cycle ended callback
md.register_callback(BrickletMotionDetector::CALLBACK_DETECTION_CYCLE_ENDED) do
  puts 'Detection Cycle Ended (next detection possible in ~3 seconds)'
end

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

API

All methods listed below are thread-safe.

Basic Functions

BrickletMotionDetector::new(uid, ipcon) → motion_detector
Parameters:
  • uid -- str
  • ipcon -- IPConnection

Creates an object with the unique device ID uid:

motion_detector = BrickletMotionDetector.new 'YOUR_DEVICE_UID', ipcon

This object can then be used after the IP Connection is connected (see examples above).

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 here.

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

BrickletMotionDetector#set_status_led_config(config) → nil
Parameters:config -- int

Sets the status led configuration.

By default the status LED turns on if a motion is detected and off is no motion is detected.

You can also turn the LED permanently on/off.

The following constants are available for this function:

  • BrickletMotionDetector::STATUS_LED_CONFIG_OFF = 0
  • BrickletMotionDetector::STATUS_LED_CONFIG_ON = 1
  • BrickletMotionDetector::STATUS_LED_CONFIG_SHOW_STATUS = 2

New in version 2.0.1 (Plugin).

BrickletMotionDetector#get_status_led_config → int

Returns the configuration as set by #set_status_led_config.

The following constants are available for this function:

  • BrickletMotionDetector::STATUS_LED_CONFIG_OFF = 0
  • BrickletMotionDetector::STATUS_LED_CONFIG_ON = 1
  • BrickletMotionDetector::STATUS_LED_CONFIG_SHOW_STATUS = 2

New in version 2.0.1 (Plugin).

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.

BrickletMotionDetector#get_response_expected(function_id) → bool
Parameters: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 #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 #set_response_expected for the list of function ID constants available for this function.

BrickletMotionDetector#set_response_expected(function_id, response_expected) → nil
Parameters:
  • function_id -- int
  • 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.

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:

  • BrickletMotionDetector::FUNCTION_SET_STATUS_LED_CONFIG = 4
BrickletMotionDetector#set_response_expected_all(response_expected) → nil
Parameters:response_expected -- bool

Changes the response expected flag for all setter and callback configuration functions of this device at once.

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 here. There is also a constant for the device identifier of this Bricklet.

The returned array has the values uid, connected_uid, position, hardware_version, firmware_version and device_identifier.

Callback Configuration Functions

BrickletMotionDetector#register_callback(callback_id) { |param [, ...]| block } → nil
Parameters:callback_id -- int

Registers the given block with the given callback_id.

The available callback IDs with corresponding function signatures are listed below.

Callbacks

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

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.

BrickletMotionDetector::CALLBACK_MOTION_DETECTED

This callback is called after a motion was detected.

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.

Constants

BrickletMotionDetector::DEVICE_IDENTIFIER

This constant is used to identify a Motion Detector Bricklet.

The #get_identity() function and the ::CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickletMotionDetector::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Motion Detector Bricklet.