This is the description of the Ruby API bindings for the IP Connection. The IP Connection manages the communication between the API bindings and the Brick Daemon or a WIFI/Ethernet Extension. Before Bricks and Bricklets can be controlled using their API an IP Connection has to be created and its TCP/IP connection has to be established.
An installation guide for the Ruby API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
Download (example_enumerate.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 37 | #!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-
require 'tinkerforge/ip_connection'
include Tinkerforge
HOST = 'localhost'
PORT = 4223
# Create IP connection to brickd
ipcon = IPConnection.new
ipcon.connect HOST, PORT
# Enumerate Bricks and Bricklets
ipcon.register_callback(IPConnection::CALLBACK_ENUMERATE) do |uid, connected_uid, position,
hardware_version, firmware_version,
device_identifier, enumeration_type|
puts "UID: #{uid}"
puts "Enumeration Type: #{enumeration_type}"
if enumeration_type != IPConnection::ENUMERATION_TYPE_DISCONNECTED
puts "Connected UID: #{connected_uid}"
puts "Position: #{position}"
puts "Hardware Version: #{hardware_version}"
puts "Firmware Version: #{firmware_version}"
puts "Device Identifier: #{device_identifier}"
end
puts ''
end
ipcon.enumerate
puts 'Press key to exit'
$stdin.gets
ipcon.disconnect
|
Download (example_authenticate.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 37 38 39 40 41 42 43 44 45 46 47 48 | #!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-
require 'tinkerforge/ip_connection'
include Tinkerforge
HOST = 'localhost'
PORT = 4223
SECRET = 'My Authentication Secret!'
# Create IP connection
ipcon = IPConnection.new
# Authenticate each time the connection got (re-)established
ipcon.register_callback(IPConnection::CALLBACK_CONNECTED) do |connect_reason|
case connect_reason
when IPConnection::CONNECT_REASON_REQUEST
puts 'Connected by request'
when IPConnection::CONNECT_REASON_AUTO_RECONNECT
puts 'Auto-Reconnect'
end
# Authenticate first...
begin
ipcon.authenticate SECRET
puts 'Authentication succeeded'
# ...then trigger enumerate
ipcon.enumerate
rescue
puts 'Could not authenticate'
end
end
# Print incoming enumeration
ipcon.register_callback(IPConnection::CALLBACK_ENUMERATE) do |uid, connected_uid, position,
hardware_version, firmware_version,
device_identifier, enumeration_type|
puts "UID: #{uid}, Enumeration Type: #{enumeration_type}"
end
# Connecte to brickd
ipcon.connect HOST, PORT
puts 'Press key to exit'
$stdin.gets
ipcon.disconnect
|
Creates an IP Connection object that can be used to enumerate the available devices. It is also required for the constructor of Bricks and Bricklets.
Parameters: |
|
---|
Creates a TCP/IP connection to the given host and port. The host and port can refer to a Brick Daemon or to a WIFI/Ethernet Extension.
Devices can only be controlled when the connection was established successfully.
Blocks until the connection is established and throws an exception if there is no Brick Daemon or WIFI/Ethernet Extension listening at the given host and port.
Disconnects the TCP/IP connection from the Brick Daemon or the WIFI/Ethernet Extension.
Parameters: | secret -- str |
---|
Performs an authentication handshake with the connected Brick Daemon or WIFI/Ethernet Extension. If the handshake succeeds the connection switches from non-authenticated to authenticated state and communication can continue as normal. If the handshake fails then the connection gets closed. Authentication can fail if the wrong secret was used or if authentication is not enabled at all on the Brick Daemon or the WIFI/Ethernet Extension.
See the authentication tutorial for more information.
New in version 2.1.0.
Can return the following states:
Parameters: | auto_reconnect -- bool |
---|
Enables or disables auto-reconnect. If auto-reconnect is enabled, the IP Connection will try to reconnect to the previously given host and port, if the connection is lost.
Default value is true.
Returns true if auto-reconnect is enabled, false otherwise.
Parameters: | timeout -- float |
---|
Sets the timeout in seconds for getters and for setters for which the response expected flag is activated.
Default timeout is 2.5.
Returns the timeout as set by #set_timeout.
Broadcasts an enumerate request. All devices will respond with an enumerate callback.
Stops the current thread until #unwait is called.
This is useful if you rely solely on callbacks for events, if you want to wait for a specific callback or if the IP Connection was created in a thread.
wait and unwait act in the same way as acquire and release of a semaphore.
Parameters: | id -- int |
---|
Registers a callback with ID id to the block callback.
The available IDs with corresponding callback function signatures are described below.
Callbacks can be registered to be notified about events. The registration is done with the #register_callback function. The first parameter is the callback ID and the second parameter is a block:
ipcon.register_callback IPConnection::CALLBACK_EXAMPLE, do |param|
puts "#{param}"
end
The available constants with inherent number and type of parameters are described below.
Parameters: |
|
---|
The callback has seven parameters:
Possible enumeration types are:
It should be possible to implement plug-and-play functionality with this (as is done in Brick Viewer).
The device identifier numbers can be found here. There are also constants for these numbers named following this pattern:
<device-class>::DEVICE_IDENTIFIER
For example: BrickMaster::DEVICE_IDENTIFIER or BrickletAmbientLight::DEVICE_IDENTIFIER.
Parameters: | connect_reason -- int |
---|
This callback is called whenever the IP Connection got connected to a Brick Daemon or to a WIFI/Ethernet Extension, possible reasons are:
Parameters: | disconnect_reason -- int |
---|
This callback is called whenever the IP Connection got disconnected from a Brick Daemon or from a WIFI/Ethernet Extension, possible reasons are: