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.
The example code below is Public Domain (CC0 1.0).
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 | #!/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 to your UID
ipcon = IPConnection.new # Create IP connection
tilt = 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
tilt_state = tilt.get_tilt_state
case tilt_state
when BrickletTilt::TILT_STATE_CLOSED
puts 'closed'
when BrickletTilt::TILT_STATE_OPEN
puts 'open'
when BrickletTilt::TILT_STATE_CLOSED_VIBRATING
puts 'closed vibrating'
end
puts 'Press key to exit'
$stdin.gets
ipcon.disconnect
|
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 36 | #!/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 to your UID
ipcon = IPConnection.new # Create IP connection
tilt = 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
tilt.enable_tilt_state_callback
# Register tilt state callback
tilt.register_callback(BrickletTilt::CALLBACK_TILT_STATE) do |tilt_state|
case tilt_state
when BrickletTilt::TILT_STATE_CLOSED
puts 'closed'
when BrickletTilt::TILT_STATE_OPEN
puts 'open'
when BrickletTilt::TILT_STATE_CLOSED_VIBRATING
puts 'closed vibrating'
end
end
puts 'Press key to exit'
$stdin.gets
ipcon.disconnect
|
All methods listed below are thread-safe.
Parameters: |
|
---|
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).
Returns the current tilt state. The state can either be
The following constants are available for this function:
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.
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.
Parameters: |
|
---|
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:
Parameters: | response_expected -- bool |
---|
Changes the response expected flag for all setter and callback configuration functions of this device at once.
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.
Parameters: | id -- int |
---|
Registers a callback with ID id to the given block. The available IDs with corresponding function signatures are listed below.
Enables the ::CALLBACK_TILT_STATE callback.
Disables the ::CALLBACK_TILT_STATE callback.
Returns true if the ::CALLBACK_TILT_STATE callback is enabled.
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.
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:
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.