Ruby - Accelerometer 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

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

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_accelerometer'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
a = BrickletAccelerometer.new UID, ipcon # Create device object

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

# Get current acceleration as [x, y, z]
acceleration = a.get_acceleration

puts "Acceleration [X]: #{acceleration[0]/1000.0} g"
puts "Acceleration [Y]: #{acceleration[1]/1000.0} g"
puts "Acceleration [Z]: #{acceleration[2]/1000.0} g"

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

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

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_accelerometer'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
a = BrickletAccelerometer.new UID, ipcon # Create device object

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

# Register acceleration callback
a.register_callback(BrickletAccelerometer::CALLBACK_ACCELERATION) do |x, y, z|
  puts "Acceleration [X]: #{x/1000.0} g"
  puts "Acceleration [Y]: #{y/1000.0} g"
  puts "Acceleration [Z]: #{z/1000.0} g"
  puts ''
end

# Set period for acceleration callback to 1s (1000ms)
# Note: The acceleration callback is only called every second
#       if the acceleration has changed since the last call!
a.set_acceleration_callback_period 1000

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

Threshold¶

Download (example_threshold.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_accelerometer'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
a = BrickletAccelerometer.new UID, ipcon # Create device object

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

# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
a.set_debounce_period 10000

# Register acceleration reached callback
a.register_callback(BrickletAccelerometer::CALLBACK_ACCELERATION_REACHED) do |x, y, z|
  puts "Acceleration [X]: #{x/1000.0} g"
  puts "Acceleration [Y]: #{y/1000.0} g"
  puts "Acceleration [Z]: #{z/1000.0} g"
  puts ''
end

# Configure threshold for acceleration "greater than 2 g, 2 g, 2 g"
a.set_acceleration_callback_threshold '>', 2*1000, 0, 2*1000, 0, 2*1000, 0

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

Grundfunktionen¶

BrickletAccelerometer::new(uid, ipcon) → accelerometer¶

Parameter:	uid – Typ: str ipcon – Typ: IPConnection
Rückgabe:	accelerometer – Typ: BrickletAccelerometer

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

accelerometer = BrickletAccelerometer.new 'YOUR_DEVICE_UID', ipcon

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

BrickletAccelerometer#get_acceleration → [int, int, int]¶

Rückgabe-Array:	0: x – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: ? 1: y – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: ? 2: z – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: ?

Gibt die Beschleunigung in X-, Y- und Z-Richtung zurück. Die Werte haben die Einheit gₙ/1000 (1gₙ = 9,80665m/s²). Der Wertebereich wird mit #set_configuration konfiguriert.

Wenn die Beschleunigungswerte periodisch abgefragt werden sollen, wird empfohlen den ::CALLBACK_ACCELERATION Callback zu nutzen und die Periode mit #set_acceleration_callback_period vorzugeben.

BrickletAccelerometer#get_temperature → int¶

Rückgabe:	temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-103 bis 152]

Gibt die Temperatur des Beschleunigungssensors zurück.

BrickletAccelerometer#led_on → nil¶

Aktiviert die LED auf dem Bricklet.

BrickletAccelerometer#led_off → nil¶

Deaktiviert die LED auf dem Bricklet.

BrickletAccelerometer#is_led_on → bool¶

Rückgabe:	on – Typ: bool, Standardwert: false

Gibt true zurück wenn die LED aktiviert ist, false sonst.

Fortgeschrittene Funktionen¶

BrickletAccelerometer#set_configuration(data_rate, full_scale, filter_bandwidth) → nil¶

Parameter:	data_rate – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 6 full_scale – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1 filter_bandwidth – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 2

Konfiguriert die Datenrate, den Wertebereich und die Filterbandbreite. Mögliche Konfigurationswerte sind:

• Datenrate zwischen 0Hz und 1600Hz.
• Wertebereich von ±2gₙ bis zu ±16gₙ.
• Filterbandbreite zwischen 50Hz und 800Hz.

Eine Verringerung der Datenrate oder des Wertebereichs verringert auch automatisch das Rauschen auf den Daten.

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

Für data_rate:

• BrickletAccelerometer::DATA_RATE_OFF = 0
• BrickletAccelerometer::DATA_RATE_3HZ = 1
• BrickletAccelerometer::DATA_RATE_6HZ = 2
• BrickletAccelerometer::DATA_RATE_12HZ = 3
• BrickletAccelerometer::DATA_RATE_25HZ = 4
• BrickletAccelerometer::DATA_RATE_50HZ = 5
• BrickletAccelerometer::DATA_RATE_100HZ = 6
• BrickletAccelerometer::DATA_RATE_400HZ = 7
• BrickletAccelerometer::DATA_RATE_800HZ = 8
• BrickletAccelerometer::DATA_RATE_1600HZ = 9

Für full_scale:

• BrickletAccelerometer::FULL_SCALE_2G = 0
• BrickletAccelerometer::FULL_SCALE_4G = 1
• BrickletAccelerometer::FULL_SCALE_6G = 2
• BrickletAccelerometer::FULL_SCALE_8G = 3
• BrickletAccelerometer::FULL_SCALE_16G = 4

Für filter_bandwidth:

• BrickletAccelerometer::FILTER_BANDWIDTH_800HZ = 0
• BrickletAccelerometer::FILTER_BANDWIDTH_400HZ = 1
• BrickletAccelerometer::FILTER_BANDWIDTH_200HZ = 2
• BrickletAccelerometer::FILTER_BANDWIDTH_50HZ = 3

BrickletAccelerometer#get_configuration → [int, int, int]¶

Rückgabe-Array:	0: data_rate – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 6 1: full_scale – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1 2: filter_bandwidth – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 2

Gibt die Konfiguration zurück, wie von #set_configuration gesetzt.

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

Für data_rate:

• BrickletAccelerometer::DATA_RATE_OFF = 0
• BrickletAccelerometer::DATA_RATE_3HZ = 1
• BrickletAccelerometer::DATA_RATE_6HZ = 2
• BrickletAccelerometer::DATA_RATE_12HZ = 3
• BrickletAccelerometer::DATA_RATE_25HZ = 4
• BrickletAccelerometer::DATA_RATE_50HZ = 5
• BrickletAccelerometer::DATA_RATE_100HZ = 6
• BrickletAccelerometer::DATA_RATE_400HZ = 7
• BrickletAccelerometer::DATA_RATE_800HZ = 8
• BrickletAccelerometer::DATA_RATE_1600HZ = 9

Für full_scale:

• BrickletAccelerometer::FULL_SCALE_2G = 0
• BrickletAccelerometer::FULL_SCALE_4G = 1
• BrickletAccelerometer::FULL_SCALE_6G = 2
• BrickletAccelerometer::FULL_SCALE_8G = 3
• BrickletAccelerometer::FULL_SCALE_16G = 4

Für filter_bandwidth:

• BrickletAccelerometer::FILTER_BANDWIDTH_800HZ = 0
• BrickletAccelerometer::FILTER_BANDWIDTH_400HZ = 1
• BrickletAccelerometer::FILTER_BANDWIDTH_200HZ = 2
• BrickletAccelerometer::FILTER_BANDWIDTH_50HZ = 3

BrickletAccelerometer#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¶

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

BrickletAccelerometer#set_acceleration_callback_period(period) → nil¶

Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der ::CALLBACK_ACCELERATION Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der ::CALLBACK_ACCELERATION Callback wird nur ausgelöst, wenn sich die Acceleration seit der letzten Auslösung geändert hat.

BrickletAccelerometer#get_acceleration_callback_period → int¶

Rückgabe:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von #set_acceleration_callback_period gesetzt.

BrickletAccelerometer#set_acceleration_callback_threshold(option, min_x, max_x, min_y, max_y, min_z, max_z) → nil¶

Parameter:

option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x' min_x – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max_x – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 min_y – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max_y – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 min_z – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max_z – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Setzt den Schwellwert für den ::CALLBACK_ACCELERATION_REACHED Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn die Beschleunigung außerhalb des min und max Wertes ist
'i'	Callback wird ausgelöst, wenn die Beschleunigung innerhalb des min und max Wertes ist
'<'	Callback wird ausgelöst, wenn die Beschleunigung kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die Beschleunigung größer als der min Wert ist (max wird ignoriert)

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

Für option:

• BrickletAccelerometer::THRESHOLD_OPTION_OFF = 'x'
• BrickletAccelerometer::THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletAccelerometer::THRESHOLD_OPTION_INSIDE = 'i'
• BrickletAccelerometer::THRESHOLD_OPTION_SMALLER = '<'
• BrickletAccelerometer::THRESHOLD_OPTION_GREATER = '>'

BrickletAccelerometer#get_acceleration_callback_threshold → [chr, int, int, int, int, int, int]¶

Rückgabe-Array:

0: option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x' 1: min_x – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 2: max_x – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 3: min_y – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 4: max_y – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 5: min_z – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 6: max_z – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von #set_acceleration_callback_threshold gesetzt.

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

Für option:

• BrickletAccelerometer::THRESHOLD_OPTION_OFF = 'x'
• BrickletAccelerometer::THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletAccelerometer::THRESHOLD_OPTION_INSIDE = 'i'
• BrickletAccelerometer::THRESHOLD_OPTION_SMALLER = '<'
• BrickletAccelerometer::THRESHOLD_OPTION_GREATER = '>'

BrickletAccelerometer#set_debounce_period(debounce) → nil¶

Parameter:	debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callback

• ::CALLBACK_ACCELERATION_REACHED

ausgelöst wird, wenn der Schwellwert

• #set_acceleration_callback_threshold

weiterhin erreicht bleibt.

BrickletAccelerometer#get_debounce_period → int¶

Rückgabe:	debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von #set_debounce_period gesetzt.

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:

accelerometer.register_callback BrickletAccelerometer::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

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

BrickletAccelerometer::CALLBACK_ACCELERATION¶

Callback-Parameter:	x – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: ? y – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: ? z – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: ?

Dieser Callback wird mit der Periode, wie gesetzt mit #set_acceleration_callback_period, ausgelöst. Die Parameter sind die Beschleunigungen der X-, Y- und Z-Achse. Der Wertebereich wird mit #set_configuration konfiguriert.

Der ::CALLBACK_ACCELERATION Callback wird nur ausgelöst, wenn sich die Beschleunigung seit der letzten Auslösung geändert hat.

BrickletAccelerometer::CALLBACK_ACCELERATION_REACHED¶

Callback-Parameter:	x – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: ? y – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: ? z – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: ?

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von #set_acceleration_callback_threshold gesetzt, erreicht wird. Die Parameter sind die Beschleunigungen der X-, Y- und Z-Achse. Der Wertebereich wird mit #set_configuration konfiguriert.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit #set_debounce_period gesetzt, ausgelöst.

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.

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

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

• BrickletAccelerometer::FUNCTION_SET_ACCELERATION_CALLBACK_PERIOD = 2
• BrickletAccelerometer::FUNCTION_SET_ACCELERATION_CALLBACK_THRESHOLD = 4
• BrickletAccelerometer::FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletAccelerometer::FUNCTION_SET_CONFIGURATION = 9
• BrickletAccelerometer::FUNCTION_LED_ON = 11
• BrickletAccelerometer::FUNCTION_LED_OFF = 12

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

• BrickletAccelerometer::FUNCTION_SET_ACCELERATION_CALLBACK_PERIOD = 2
• BrickletAccelerometer::FUNCTION_SET_ACCELERATION_CALLBACK_THRESHOLD = 4
• BrickletAccelerometer::FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletAccelerometer::FUNCTION_SET_CONFIGURATION = 9
• BrickletAccelerometer::FUNCTION_LED_ON = 11
• BrickletAccelerometer::FUNCTION_LED_OFF = 12

BrickletAccelerometer#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¶

BrickletAccelerometer::DEVICE_IDENTIFIER¶

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

BrickletAccelerometer::DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Accelerometer Bricklet dar.