Ruby - Tilt Bricklet

This is the description of the Ruby API bindings for the Tilt Bricklet. General information and technical specifications for the Tilt 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).

Simple

Download (example_simple.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
32
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_tilt'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
t = BrickletTilt.new UID, ipcon # Create device object

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

# Get current tilt state
state = t.get_tilt_state

if state == BrickletTilt::TILT_STATE_CLOSED
  puts "Tilt State: Closed"
elsif state == BrickletTilt::TILT_STATE_OPEN
  puts "Tilt State: Open"
elsif state == BrickletTilt::TILT_STATE_CLOSED_VIBRATING
  puts "Tilt State: Closed Vibrating"
end

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

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
32
33
34
35
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_tilt'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
t = BrickletTilt.new UID, ipcon # Create device object

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

# Enable tilt state callback
t.enable_tilt_state_callback

# Register tilt state callback
t.register_callback(BrickletTilt::CALLBACK_TILT_STATE) do |state|
  if state == BrickletTilt::TILT_STATE_CLOSED
    puts "Tilt State: Closed"
  elsif state == BrickletTilt::TILT_STATE_OPEN
    puts "Tilt State: Open"
  elsif state == BrickletTilt::TILT_STATE_CLOSED_VIBRATING
    puts "Tilt State: Closed Vibrating"
  end
end

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

API

All methods listed below are thread-safe.

Basic Functions

BrickletTilt::new(uid, ipcon) → tilt
Parameters:
  • uid -- str
  • ipcon -- IPConnection

Creates an object with the unique device ID uid:

tilt = BrickletTilt.new 'YOUR_DEVICE_UID', ipcon

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

BrickletTilt#get_tilt_state → int

Returns the current tilt state. The state can either be

  • 0 = Closed: The ball in the tilt switch closes the circuit.
  • 1 = Open: The ball in the tilt switch does not close the circuit.
  • 2 = Closed Vibrating: The tilt switch is in motion (rapid change between open and close).
Tilt states

The following constants are available for this function:

  • BrickletTilt::TILT_STATE_CLOSED = 0
  • BrickletTilt::TILT_STATE_OPEN = 1
  • BrickletTilt::TILT_STATE_CLOSED_VIBRATING = 2

Advanced Functions

BrickletTilt#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.

BrickletTilt#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.

BrickletTilt#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:

  • BrickletTilt::FUNCTION_ENABLE_TILT_STATE_CALLBACK = 2
  • BrickletTilt::FUNCTION_DISABLE_TILT_STATE_CALLBACK = 3
BrickletTilt#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.

BrickletTilt#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

BrickletTilt#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.

BrickletTilt#enable_tilt_state_callback → nil

Enables the ::CALLBACK_TILT_STATE callback.

BrickletTilt#disable_tilt_state_callback → nil

Disables the ::CALLBACK_TILT_STATE callback.

BrickletTilt#is_tilt_state_callback_enabled → bool

Returns true if the ::CALLBACK_TILT_STATE callback is enabled.

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:

tilt.register_callback BrickletTilt::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.

BrickletTilt::CALLBACK_TILT_STATE
Parameters:state -- int

This callback provides the current tilt state. It is called every time the state changes.

See #get_tilt_state for a description of the states.

The following constants are available for this function:

  • BrickletTilt::TILT_STATE_CLOSED = 0
  • BrickletTilt::TILT_STATE_OPEN = 1
  • BrickletTilt::TILT_STATE_CLOSED_VIBRATING = 2

Constants

BrickletTilt::DEVICE_IDENTIFIER

This constant is used to identify a Tilt 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.

BrickletTilt::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Tilt Bricklet.