Deutsch
English
Menu

Ruby - Tilt Bricklet

Dies ist die Beschreibung der Ruby API Bindings für das Tilt Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Tilt Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Ruby API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example_simple.rb)

 1#!/usr/bin/env ruby
 2# -*- ruby encoding: utf-8 -*-
 3
 4require 'tinkerforge/ip_connection'
 5require 'tinkerforge/bricklet_tilt'
 6
 7include Tinkerforge
 8
 9HOST = 'localhost'
10PORT = 4223
11UID = 'XYZ' # Change XYZ to the UID of your Tilt Bricklet
12
13ipcon = IPConnection.new # Create IP connection
14t = BrickletTilt.new UID, ipcon # Create device object
15
16ipcon.connect HOST, PORT # Connect to brickd
17# Don't use device before ipcon is connected
18
19# Get current tilt state
20state = t.get_tilt_state
21
22if state == BrickletTilt::TILT_STATE_CLOSED
23  puts "Tilt State: Closed"
24elsif state == BrickletTilt::TILT_STATE_OPEN
25  puts "Tilt State: Open"
26elsif state == BrickletTilt::TILT_STATE_CLOSED_VIBRATING
27  puts "Tilt State: Closed Vibrating"
28end
29
30puts 'Press key to exit'
31$stdin.gets
32ipcon.disconnect

Callback

Download (example_callback.rb)

 1#!/usr/bin/env ruby
 2# -*- ruby encoding: utf-8 -*-
 3
 4require 'tinkerforge/ip_connection'
 5require 'tinkerforge/bricklet_tilt'
 6
 7include Tinkerforge
 8
 9HOST = 'localhost'
10PORT = 4223
11UID = 'XYZ' # Change XYZ to the UID of your Tilt Bricklet
12
13ipcon = IPConnection.new # Create IP connection
14t = BrickletTilt.new UID, ipcon # Create device object
15
16ipcon.connect HOST, PORT # Connect to brickd
17# Don't use device before ipcon is connected
18
19# Enable tilt state callback
20t.enable_tilt_state_callback
21
22# Register tilt state callback
23t.register_callback(BrickletTilt::CALLBACK_TILT_STATE) do |state|
24  if state == BrickletTilt::TILT_STATE_CLOSED
25    puts "Tilt State: Closed"
26  elsif state == BrickletTilt::TILT_STATE_OPEN
27    puts "Tilt State: Open"
28  elsif state == BrickletTilt::TILT_STATE_CLOSED_VIBRATING
29    puts "Tilt State: Closed Vibrating"
30  end
31end
32
33puts 'Press key to exit'
34$stdin.gets
35ipcon.disconnect

API

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

BrickletTilt::new(uid, ipcon) → tilt
Parameter:
  • uid – Typ: str
  • ipcon – Typ: IPConnection
Rückgabe:
  • tilt – Typ: BrickletTilt

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

tilt = BrickletTilt.new 'YOUR_DEVICE_UID', ipcon

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

BrickletTilt#get_tilt_state → int
Rückgabe:
  • state – Typ: int, Wertebereich: Siehe Konstanten

Gibt den aktuellen Tilt-Zustand zurück. Der Zustand kann folgende Werte annehmen:

  • 0 = Closed: Der Ball im Neigungsschalter schließt den Stromkreis.

  • 1 = Open: Der Ball im Neigungsschalter schließt den Stromkreis nicht.

  • 2 = Closed Vibrating: Der Neigungsschalter ist in Bewegung (schnelle Änderungen zwischen open und close).

Tilt-Zustände

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

Für state:

  • BrickletTilt::TILT_STATE_CLOSED = 0

  • BrickletTilt::TILT_STATE_OPEN = 1

  • BrickletTilt::TILT_STATE_CLOSED_VIBRATING = 2

Fortgeschrittene Funktionen

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

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

BrickletTilt#enable_tilt_state_callback → nil

Aktiviert den ::CALLBACK_TILT_STATE Callback.

BrickletTilt#disable_tilt_state_callback → nil

Deaktiviert den ::CALLBACK_TILT_STATE Callback.

BrickletTilt#is_tilt_state_callback_enabled → bool
Rückgabe:
  • enabled – Typ: bool, Standardwert: false

Gibt true zurück wenn der ::CALLBACK_TILT_STATE Callback aktiviert ist.

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:

tilt.register_callback BrickletTilt::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

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

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

BrickletTilt::CALLBACK_TILT_STATE
Callback-Parameter:
  • state – Typ: int, Wertebereich: Siehe Konstanten

Dieser Callback übergibt den aktuellen Tilt-Status. Der Callback wird aufgerufen wenn sich der Status ändert.

Siehe #get_tilt_state für eine Beschreibung der Zustände.

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

Für state:

  • BrickletTilt::TILT_STATE_CLOSED = 0

  • BrickletTilt::TILT_STATE_OPEN = 1

  • BrickletTilt::TILT_STATE_CLOSED_VIBRATING = 2

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.

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

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

  • BrickletTilt::FUNCTION_ENABLE_TILT_STATE_CALLBACK = 2

  • BrickletTilt::FUNCTION_DISABLE_TILT_STATE_CALLBACK = 3

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

  • BrickletTilt::FUNCTION_ENABLE_TILT_STATE_CALLBACK = 2

  • BrickletTilt::FUNCTION_DISABLE_TILT_STATE_CALLBACK = 3

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

BrickletTilt::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Tilt 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.

BrickletTilt::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Tilt Bricklet dar.