Ruby - Multi Touch Bricklet¶

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
33
34
35
36
37
38
39
40
41
42
43

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_multi_touch'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
mt = BrickletMultiTouch.new UID, ipcon # Create device object

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

# Get current touch state
state = mt.get_touch_state
s = ''

if (state & (1 << 12)) == (1 << 12)
  s += 'In proximity, '
end

if (state & 0xfff) == 0
  s += 'No electrodes touched'
else
  s += 'Electrodes '
  for i in 0..11
    if (state & (1 << i)) == (1 << i)
      s += i.to_s() + ' '
    end
  end
  s += 'touched'
end

puts s

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
36
37
38
39
40
41
42
43
44

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_multi_touch'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
mt = BrickletMultiTouch.new UID, ipcon # Create device object

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

# Register touch state callback
mt.register_callback(BrickletMultiTouch::CALLBACK_TOUCH_STATE) do |state|
  s = ''

  if (state & (1 << 12)) == (1 << 12)
    s += 'In proximity, '
  end

  if (state & 0xfff) == 0
    s += 'No electrodes touched'
  else
    s += 'Electrodes '
    for i in 0..11
      if (state & (1 << i)) == (1 << i)
        s += i.to_s() + ' '
      end
    end
    s += 'touched'
  end

  puts s
end

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

Grundfunktionen¶

BrickletMultiTouch::new(uid, ipcon) → multi_touch¶

Parameter:	uid – Typ: str ipcon – Typ: IPConnection
Rückgabe:	multi_touch – Typ: BrickletMultiTouch

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

multi_touch = BrickletMultiTouch.new 'YOUR_DEVICE_UID', ipcon

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

BrickletMultiTouch#get_touch_state → int¶

Rückgabe:	state – Typ: int, Wertebereich: [0 bis 213 - 1]

Gibt den aktuellen Tastzustand zurück. Der Zustand ist als ein Bitfeld repräsentiert.

Bits 0 bis 11 repräsentieren die 12 Elektroden und Bit 12 repräsentiert die Proximity (Nähe).

Wird eine Elektrode berührt, ist das korrespondierende Bit true. Wenn eine Hand oder vergleichbares in der Nähe der Elektroden ist wird Bit 12 auf true gesetzt.

Beispiel: Der Zustand 4103 = 0x1007 = 0b1000000000111 bedeutet dass die Elektroden 0, 1 und 2 berührt werden und das sich etwas in der nähe der Elektroden befindet.

Das Proximity Bit wird ab einer Distanz von ca. 1-2cm aktiviert. Eine Elektrode wird schon als berührt gezählt wenn ein Finger sie beinahe berührt. Dadurch ist es möglich ein Stück Papier oder Folie über die Elektrode zu kleben um damit ein Touchpanel mit einem professionellen Aussehen zu bauen.

BrickletMultiTouch#recalibrate → nil¶

Rekalibriert die Elektroden. Rufe diese Funktion auf wenn die Elektroden verändert oder bewegt wurden.

BrickletMultiTouch#set_electrode_config(enabled_electrodes) → nil¶

Parameter:	enabled_electrodes – Typ: int, Wertebereich: [0 bis 213 - 1], Standardwert: 213 - 1

Aktiviert/deaktiviert Elektroden mit einem Bitfeld (siehe #get_touch_state).

True aktiviert eine Elektrode, false deaktiviert eine Elektrode. Eine deaktivierte Elektrode hat immer den Zustand false. Wenn nicht alle Elektroden gebraucht werden können die ungebrauchten deaktiviert werden.

Wir empfehlen das Proximity Bit (Bit 12) zu deaktivieren wenn das Proximity-Feature nicht benötigt wird. Das verringert den Datenverkehr der durch den ::CALLBACK_TOUCH_STATE Callback ausgelöst wird.

Eine deaktivierte Elektrode verringert zusätzlich den Stromverbrauch.

Standardwert: 8191 = 0x1FFF = 0b1111111111111 (alle Elektroden und Proximity-Feature aktiviert)

BrickletMultiTouch#get_electrode_config → int¶

Rückgabe:	enabled_electrodes – Typ: int, Wertebereich: [0 bis 213 - 1], Standardwert: 213 - 1

Gibt die Elektrodenkonfiguration zurück, wie von #set_electrode_config gesetzt.

BrickletMultiTouch#set_electrode_sensitivity(sensitivity) → nil¶

Parameter:	sensitivity – Typ: int, Wertebereich: [5 bis 201], Standardwert: 181

Setzt die Empfindlichkeit der Elektrode. Eine Elektrode mit einer hohen Empfindlichkeit registriert eine Berührung früher als eine Elektrode mit einer niedrigen Empfindlichkeit.

Wenn eine große Elektrode verwendet wird sollte die Empfindlichkeit verringert werden, da eine größere Fläche aufgeladen werden kann. Wenn eine Elektrode aus größerem Abstand aktivierbar seien soll, muss die Empfindlichkeit vergrößert werden.

Nachdem eine neue Empfindlichkeit gesetzt wurde, macht es Sinn #recalibrate aufzurufen damit die Elektroden mit der neu definierten Empfindlichkeit kalibriert werden.

BrickletMultiTouch#get_electrode_sensitivity → int¶

Rückgabe:	sensitivity – Typ: int, Wertebereich: [5 bis 201], Standardwert: 181

Gibt die aktuelle Empfindlichkeit zurück, wie von #set_electrode_sensitivity gesetzt.

Fortgeschrittene Funktionen¶

BrickletMultiTouch#get_identity → [str, str, chr, [int, ...], [int, ...], int]¶

Rückgabe-Array:

0: uid – Typ: str, Länge: bis zu 8 1: connected_uid – Typ: str, Länge: bis zu 8 2: position – Typ: chr, Wertebereich: ['a' bis 'h', 'z'] 3: hardware_version – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255] 4: firmware_version – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255] 5: device_identifier – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks¶

BrickletMultiTouch#register_callback(callback_id) { |param [, ...]| block } → nil¶

Parameter:	callback_id – Typ: int

Registriert den block für die gegebene callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion #register_callback des Geräte Objektes durchgeführt werden. Der erste Parameter ist der Callback ID und der zweite Parameter der Block:

multi_touch.register_callback BrickletMultiTouch::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen werden weiter unten beschrieben.

BrickletMultiTouch::CALLBACK_TOUCH_STATE¶

Callback-Parameter:	state – Typ: int, Wertebereich: [0 bis 213 - 1]

Gibt den aktuellen Tastzustand zurück, siehe #get_touch_state für mehr Informationen über den Zustand.

Dieser Callback wird ausgelöst, wenn sich ein Tastzustand ändert.

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

BrickletMultiTouch#get_api_version → [int, ...]¶

Rückgabe-Array:	0: api_version – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255]

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

BrickletMultiTouch#get_response_expected(function_id) → bool¶

Parameter:	function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	response_expected – Typ: bool

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels #set_response_expected. Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für function_id:

• BrickletMultiTouch::FUNCTION_RECALIBRATE = 2
• BrickletMultiTouch::FUNCTION_SET_ELECTRODE_CONFIG = 3
• BrickletMultiTouch::FUNCTION_SET_ELECTRODE_SENSITIVITY = 6

BrickletMultiTouch#set_response_expected(function_id, response_expected) → nil¶

Parameter:	function_id – Typ: int, Wertebereich: Siehe Konstanten response_expected – Typ: bool

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für function_id:

• BrickletMultiTouch::FUNCTION_RECALIBRATE = 2
• BrickletMultiTouch::FUNCTION_SET_ELECTRODE_CONFIG = 3
• BrickletMultiTouch::FUNCTION_SET_ELECTRODE_SENSITIVITY = 6

BrickletMultiTouch#set_response_expected_all(response_expected) → nil¶

Parameter:	response_expected – Typ: bool

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten¶

BrickletMultiTouch::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Multi Touch Bricklet zu identifizieren.

Die #get_identity() Funktion und der IPConnection::CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletMultiTouch::DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Multi Touch Bricklet dar.