Ruby - Accelerometer Bricklet 2.0

Dies ist die Beschreibung der Ruby API Bindings für das Accelerometer Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Accelerometer Bricklet 2.0 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
 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_v2'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
a = BrickletAccelerometerV2.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]/10000.0} g"
puts "Acceleration [Y]: #{acceleration[1]/10000.0} g"
puts "Acceleration [Z]: #{acceleration[2]/10000.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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_accelerometer_v2'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
a = BrickletAccelerometerV2.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(BrickletAccelerometerV2::CALLBACK_ACCELERATION) do |x, y, z|
  puts "Acceleration [X]: #{x/10000.0} g"
  puts "Acceleration [Y]: #{y/10000.0} g"
  puts "Acceleration [Z]: #{z/10000.0} g"
  puts ''
end

# Set period for acceleration callback to 1s (1000ms)
a.set_acceleration_callback_configuration 1000, false

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

API

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

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

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

accelerometer_v2 = BrickletAccelerometerV2.new 'YOUR_DEVICE_UID', ipcon

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

BrickletAccelerometerV2#get_acceleration → [int, int, int]
Rückgabe-Array:
  • 0: x – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • 1: y – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • 2: z – Typ: int, Wertebereich: [-231 bis 231 - 1]

Gibt die Beschleunigung in X-, Y- und Z-Richtung zurück. Die Werte haben die Einheit g/10000 (1g = 9,80665m/s²), nicht zu verwechseln mit Gramm.

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

BrickletAccelerometerV2#set_configuration(data_rate, full_scale) → nil
Parameter:
  • data_rate – Typ: int, Wertebereich: Siehe Konstanten
  • full_scale – Typ: int, Wertebereich: Siehe Konstanten

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

  • Datenrate zwischen 0,781Hz und 25600Hz.
  • Wertebereich von ±2g bis zu ±8g.

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

Die Standardwerte sind 100Hz Datenrate und ±2g Wertebereich.

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

Für data_rate:

  • BrickletAccelerometerV2::DATA_RATE_0_781HZ = 0
  • BrickletAccelerometerV2::DATA_RATE_1_563HZ = 1
  • BrickletAccelerometerV2::DATA_RATE_3_125HZ = 2
  • BrickletAccelerometerV2::DATA_RATE_6_2512HZ = 3
  • BrickletAccelerometerV2::DATA_RATE_12_5HZ = 4
  • BrickletAccelerometerV2::DATA_RATE_25HZ = 5
  • BrickletAccelerometerV2::DATA_RATE_50HZ = 6
  • BrickletAccelerometerV2::DATA_RATE_100HZ = 7
  • BrickletAccelerometerV2::DATA_RATE_200HZ = 8
  • BrickletAccelerometerV2::DATA_RATE_400HZ = 9
  • BrickletAccelerometerV2::DATA_RATE_800HZ = 10
  • BrickletAccelerometerV2::DATA_RATE_1600HZ = 11
  • BrickletAccelerometerV2::DATA_RATE_3200HZ = 12
  • BrickletAccelerometerV2::DATA_RATE_6400HZ = 13
  • BrickletAccelerometerV2::DATA_RATE_12800HZ = 14
  • BrickletAccelerometerV2::DATA_RATE_25600HZ = 15

Für full_scale:

  • BrickletAccelerometerV2::FULL_SCALE_2G = 0
  • BrickletAccelerometerV2::FULL_SCALE_4G = 1
  • BrickletAccelerometerV2::FULL_SCALE_8G = 2
BrickletAccelerometerV2#get_configuration → [int, int]
Rückgabe-Array:
  • 0: data_rate – Typ: int, Wertebereich: Siehe Konstanten
  • 1: full_scale – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für data_rate:

  • BrickletAccelerometerV2::DATA_RATE_0_781HZ = 0
  • BrickletAccelerometerV2::DATA_RATE_1_563HZ = 1
  • BrickletAccelerometerV2::DATA_RATE_3_125HZ = 2
  • BrickletAccelerometerV2::DATA_RATE_6_2512HZ = 3
  • BrickletAccelerometerV2::DATA_RATE_12_5HZ = 4
  • BrickletAccelerometerV2::DATA_RATE_25HZ = 5
  • BrickletAccelerometerV2::DATA_RATE_50HZ = 6
  • BrickletAccelerometerV2::DATA_RATE_100HZ = 7
  • BrickletAccelerometerV2::DATA_RATE_200HZ = 8
  • BrickletAccelerometerV2::DATA_RATE_400HZ = 9
  • BrickletAccelerometerV2::DATA_RATE_800HZ = 10
  • BrickletAccelerometerV2::DATA_RATE_1600HZ = 11
  • BrickletAccelerometerV2::DATA_RATE_3200HZ = 12
  • BrickletAccelerometerV2::DATA_RATE_6400HZ = 13
  • BrickletAccelerometerV2::DATA_RATE_12800HZ = 14
  • BrickletAccelerometerV2::DATA_RATE_25600HZ = 15

Für full_scale:

  • BrickletAccelerometerV2::FULL_SCALE_2G = 0
  • BrickletAccelerometerV2::FULL_SCALE_4G = 1
  • BrickletAccelerometerV2::FULL_SCALE_8G = 2
BrickletAccelerometerV2#set_info_led_config(config) → nil
Parameter:
  • config – Typ: int, Wertebereich: Siehe Konstanten

Konfiguriert die Info-LED (als "Force" auf dem Bricklet gekennzeichnet). Die LED kann ausgeschaltet, eingeschaltet oder im Herzschlagmodus betrieben werden.

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

Für config:

  • BrickletAccelerometerV2::INFO_LED_CONFIG_OFF = 0
  • BrickletAccelerometerV2::INFO_LED_CONFIG_ON = 1
  • BrickletAccelerometerV2::INFO_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletAccelerometerV2#get_info_led_config → int
Rückgabe:
  • config – Typ: int, Wertebereich: Siehe Konstanten

Gibt die LED-Konfiguration zurück, wie von #set_info_led_config gesetzt.

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

Für config:

  • BrickletAccelerometerV2::INFO_LED_CONFIG_OFF = 0
  • BrickletAccelerometerV2::INFO_LED_CONFIG_ON = 1
  • BrickletAccelerometerV2::INFO_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletAccelerometerV2#set_continuous_acceleration_configuration(enable_x, enable_y, enable_z, resolution) → nil
Parameter:
  • enable_x – Typ: bool
  • enable_y – Typ: bool
  • enable_z – Typ: bool
  • resolution – Typ: int, Wertebereich: Siehe Konstanten

Um einen hohen Durchsatz an Beschleunigungswerten zu erreichen (> 1000Hz) müssen die ::CALLBACK_CONTINUOUS_ACCELERATION_16_BIT oder ::CALLBACK_CONTINUOUS_ACCELERATION_8_BIT Callbacks genutzt werden.

Die Callbacks können für die Achsen (x, y, z) individuell aktiviert werden. Des weiteren kann eine Auflösung von 8-Bit oder 16-Bit ausgewählt werden.

Wenn mindestens eine Achse aktiviert ist mit 8-Bit Auflösung, wird der ::CALLBACK_CONTINUOUS_ACCELERATION_8_BIT-Callback aktiviert. Wenn mindestens eine Achse aktiviert ist mit 16-Bit Auflösung, wird der ::CALLBACK_CONTINUOUS_ACCELERATION_16_BIT-Callback aktiviert.

Die zurückgegebenen Werte sind Rohwerte des AD-Wandlers. Wenn die Daten mit einem FFT genutzt werden sollen um Vorkomnisse from Frequenzen zu bestimmen empfehlen wir die Rohwerte direkt zu nutzen. Die Rohwerte beinhalten das Rauschen des AD-Wandlers, in diesem Rauschen können allerdings Frequenzinformation enthalten sein die für einen FFT relevant seien können.

Andernfalls können die folgenden Formeln benutzt werden um die Daten wieder in der Einheit g/10000 (gleiche Einheit wie von #get_acceleration zurückgegeben) umzuwandeln. Die Formeln hängen ab von der eingestelleten Auflösung (8/16-Bit) und dem eingestellten Wertebereich (siehe #set_configuration):

  • 16-Bit, Wertebereich 2g: Beschleunigung = Rohwert*625/1024
  • 16-Bit, Wertebereich 4g: Beschleunigung = Rohwert*1250/1024
  • 16-Bit, Wertebereich 8g: Beschleunigung = Rohwert*2500/1024

Bei einer Auflösung von 8-Bit werden nur die 8 höchstwertigen Bits übertragen, daher sehen die Formeln wie folgt aus:

  • 8-Bit, Wertebereich 2g: Beschleunigung = Rohwert*256*625/1024
  • 8-Bit, Wertebereich 4g: Beschleunigung = Rohwert*256*1250/1024
  • 8-Bit, Wertebereich 8g: Beschleunigung = Rohwert*256*2500/1024

Wenn keine Achse aktiviert is, sind beide Callbacks deaktiviert. Wenn einer der "Continuous Callbacks" genutzt wird, wird der ::CALLBACK_ACCELERATION-Callback automatisch deaktiviert.

Der maximale Durchsatz hängt von der Konfiguration ab:

Anzahl aktiviert Achsen Durchsatz 8-Bit Durchsatz 16-Bit
1 25600Hz 25600Hz
2 25600Hz 15000Hz
3 20000Hz 10000Hz

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

Für resolution:

  • BrickletAccelerometerV2::RESOLUTION_8BIT = 0
  • BrickletAccelerometerV2::RESOLUTION_16BIT = 1
BrickletAccelerometerV2#get_continuous_acceleration_configuration → [bool, bool, bool, int]
Rückgabe-Array:
  • 0: enable_x – Typ: bool
  • 1: enable_y – Typ: bool
  • 2: enable_z – Typ: bool
  • 3: resolution – Typ: int, Wertebereich: Siehe Konstanten

Gibt die Konfiguration für kontinuierliche Beschleunigungswerte zurück, wie mittels #set_continuous_acceleration_configuration gesetzt.

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

Für resolution:

  • BrickletAccelerometerV2::RESOLUTION_8BIT = 0
  • BrickletAccelerometerV2::RESOLUTION_16BIT = 1

Fortgeschrittene Funktionen

BrickletAccelerometerV2#set_filter_configuration(iir_bypass, low_pass_filter) → nil
Parameter:
  • iir_bypass – Typ: int, Wertebereich: Siehe Konstanten
  • low_pass_filter – Typ: int, Wertebereich: Siehe Konstanten

Konfiguriert den IIR Bypass Filter Modus und die Low Pass Filter Roll Off Corner Frequenz.

Der Filter kann angewendet oder umgangen werden und die Frequenz kann die halbe ein ein Neuntel der Ausgabe-Datenrate sein.

Accelerometer filter

Standardmäßig wird der Filter angewendet und die Frequenz ist ein Neuntel der Ausgabe-Datenrate.

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

Für iir_bypass:

  • BrickletAccelerometerV2::IIR_BYPASS_APPLIED = 0
  • BrickletAccelerometerV2::IIR_BYPASS_BYPASSED = 1

Für low_pass_filter:

  • BrickletAccelerometerV2::LOW_PASS_FILTER_NINTH = 0
  • BrickletAccelerometerV2::LOW_PASS_FILTER_HALF = 1

Neu in Version 2.0.2 (Plugin).

BrickletAccelerometerV2#get_filter_configuration → [int, int]
Rückgabe-Array:
  • 0: iir_bypass – Typ: int, Wertebereich: Siehe Konstanten
  • 1: low_pass_filter – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für iir_bypass:

  • BrickletAccelerometerV2::IIR_BYPASS_APPLIED = 0
  • BrickletAccelerometerV2::IIR_BYPASS_BYPASSED = 1

Für low_pass_filter:

  • BrickletAccelerometerV2::LOW_PASS_FILTER_NINTH = 0
  • BrickletAccelerometerV2::LOW_PASS_FILTER_HALF = 1

Neu in Version 2.0.2 (Plugin).

BrickletAccelerometerV2#get_api_version → [int, ...]
Rückgabe:
  • api_version – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]

Gibt die Version der API Definition (Major, Minor, Revision) 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.

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

  • BrickletAccelerometerV2::FUNCTION_SET_CONFIGURATION = 2
  • BrickletAccelerometerV2::FUNCTION_SET_ACCELERATION_CALLBACK_CONFIGURATION = 4
  • BrickletAccelerometerV2::FUNCTION_SET_INFO_LED_CONFIG = 6
  • BrickletAccelerometerV2::FUNCTION_SET_CONTINUOUS_ACCELERATION_CONFIGURATION = 9
  • BrickletAccelerometerV2::FUNCTION_SET_FILTER_CONFIGURATION = 13
  • BrickletAccelerometerV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletAccelerometerV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletAccelerometerV2::FUNCTION_RESET = 243
  • BrickletAccelerometerV2::FUNCTION_WRITE_UID = 248
BrickletAccelerometerV2#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:

  • BrickletAccelerometerV2::FUNCTION_SET_CONFIGURATION = 2
  • BrickletAccelerometerV2::FUNCTION_SET_ACCELERATION_CALLBACK_CONFIGURATION = 4
  • BrickletAccelerometerV2::FUNCTION_SET_INFO_LED_CONFIG = 6
  • BrickletAccelerometerV2::FUNCTION_SET_CONTINUOUS_ACCELERATION_CONFIGURATION = 9
  • BrickletAccelerometerV2::FUNCTION_SET_FILTER_CONFIGURATION = 13
  • BrickletAccelerometerV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletAccelerometerV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletAccelerometerV2::FUNCTION_RESET = 243
  • BrickletAccelerometerV2::FUNCTION_WRITE_UID = 248
BrickletAccelerometerV2#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.

BrickletAccelerometerV2#get_spitfp_error_count → [int, int, int, int]
Rückgabe-Array:
  • 0: error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 1: error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 2: error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 3: error_count_overflow – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

BrickletAccelerometerV2#set_bootloader_mode(mode) → int
Parameter:
  • mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: int, Wertebereich: Siehe Konstanten

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootlodaer- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Für mode:

  • BrickletAccelerometerV2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletAccelerometerV2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletAccelerometerV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletAccelerometerV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletAccelerometerV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • BrickletAccelerometerV2::BOOTLOADER_STATUS_OK = 0
  • BrickletAccelerometerV2::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletAccelerometerV2::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletAccelerometerV2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletAccelerometerV2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletAccelerometerV2::BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletAccelerometerV2#get_bootloader_mode → int
Rückgabe:
  • mode – Typ: int, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe #set_bootloader_mode.

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

Für mode:

  • BrickletAccelerometerV2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletAccelerometerV2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletAccelerometerV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletAccelerometerV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletAccelerometerV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletAccelerometerV2#set_write_firmware_pointer(pointer) → nil
Parameter:
  • pointer – Typ: int, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für #write_firmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletAccelerometerV2#write_firmware(data) → int
Parameter:
  • data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von #set_write_firmware_pointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletAccelerometerV2#set_status_led_config(config) → nil
Parameter:
  • config – Typ: int, Wertebereich: Siehe Konstanten

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für config:

  • BrickletAccelerometerV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletAccelerometerV2::STATUS_LED_CONFIG_ON = 1
  • BrickletAccelerometerV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletAccelerometerV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletAccelerometerV2#get_status_led_config → int
Rückgabe:
  • config – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für config:

  • BrickletAccelerometerV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletAccelerometerV2::STATUS_LED_CONFIG_ON = 1
  • BrickletAccelerometerV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletAccelerometerV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletAccelerometerV2#get_chip_temperature → int
Rückgabe:
  • temperature – Typ: int, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur in °C, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

BrickletAccelerometerV2#reset → nil

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

BrickletAccelerometerV2#write_uid(uid) → nil
Parameter:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

BrickletAccelerometerV2#read_uid → int
Rückgabe:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

BrickletAccelerometerV2#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
  • 3: hardware_version – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]
  • 4: firmware_version – Typ: [int, ...], Länge: 3, 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 kann 'a', 'b', 'c' oder 'd' sein.

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

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

BrickletAccelerometerV2#set_acceleration_callback_configuration(period, value_has_to_change) → nil
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false

Die Periode ist die Periode mit der der ::CALLBACK_ACCELERATION Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Wenn dieser Callback aktiviert ist, werden der ::CALLBACK_CONTINUOUS_ACCELERATION_16_BIT Callback und ::CALLBACK_CONTINUOUS_ACCELERATION_8_BIT Callback automatisch deaktiviert.

BrickletAccelerometerV2#get_acceleration_callback_configuration → [int, bool]
Rückgabe-Array:
  • 0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • 1: value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels #set_acceleration_callback_configuration 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_v2.register_callback BrickletAccelerometerV2::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.

BrickletAccelerometerV2::CALLBACK_ACCELERATION
Callback-Parameter:
  • x – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • y – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • z – Typ: int, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels #set_acceleration_callback_configuration gesetzten Konfiguration

Die Parameter sind der gleiche wie #get_acceleration.

BrickletAccelerometerV2::CALLBACK_CONTINUOUS_ACCELERATION_16_BIT
Callback-Parameter:
  • acceleration – Typ: [int, ...], Länge: 30, Wertebereich: [-215 bis 215 - 1]

Gibt 30 Beschleunigungswerte mit 16 bit Auflösung zurück. Die Datenrate kann mit der Funktion #set_configuration eingestellt werden und der Callback kann per #set_continuous_acceleration_configuration aktiviert werden.

Die zurückgegebenen Werte sind Rohwerte des AD-Wandlers. Wenn die Daten mit einem FFT genutzt werden sollen um Vorkomnisse from Frequenzen zu bestimmen empfehlen wir die Rohwerte direkt zu nutzen. Die Rohwerte beinhalten das Rauschen des AD-Wandlers, in diesem Rauschen können allerdings Frequenzinformation enthalten sein die für einen FFT relevant seien können.

Andernfalls können die folgenden Formeln benutzt werden um die Daten wieder in der Einheit g/10000 (gleiche Einheit wie von #get_acceleration zurückgegeben) umzuwandeln. Die Formeln hängen ab von dem eingestellten Wertebereich (siehe #set_configuration):

  • Wertebereich 2g: Beschleunigung = Rohwert*625/1024
  • Wertebereich 4g: Beschleunigung = Rohwert*1250/1024
  • Wertebereich 8g: Beschleunigung = Rohwert*2500/1024

Die Daten sind in der Sequenz "x, y, z, x, y, z, ..." formatiert, abhängig von den aktivierten Achsen. Beispiele:

  • x, y, z aktiviert: "x, y, z, ... 10x ..., x, y, z"
  • x, z aktiviert: "x, z, ... 15x ..., x, z"
  • y aktiviert: "y, ... 30x ..., y"
BrickletAccelerometerV2::CALLBACK_CONTINUOUS_ACCELERATION_8_BIT
Callback-Parameter:
  • acceleration – Typ: [int, ...], Länge: 60, Wertebereich: [-128 bis 127]

Gibt 60 Beschleunigungswerte mit 8 bit Auflösung zurück. Die Datenrate kann mit der Funktion #set_configuration eingestellt werden und der Callback kann per #set_continuous_acceleration_configuration aktiviert werden.

Die zurückgegebenen Werte sind Rohwerte des AD-Wandlers. Wenn die Daten mit einem FFT genutzt werden sollen um Vorkomnisse from Frequenzen zu bestimmen empfehlen wir die Rohwerte direkt zu nutzen. Die Rohwerte beinhalten das Rauschen des AD-Wandlers, in diesem Rauschen können allerdings Frequenzinformation enthalten sein die für einen FFT relevant seien können.

Andernfalls können die folgenden Formeln benutzt werden um die Daten wieder in der Einheit g/10000 (gleiche Einheit wie von #get_acceleration zurückgegeben) umzuwandeln. Die Formeln hängen ab von dem eingestellten Wertebereich (siehe #set_configuration):

  • Wertebereich 2g: Beschleunigung = Rohwert*256*625/1024
  • Wertebereich 4g: Beschleunigung = Rohwert*256*1250/1024
  • Wertebereich 8g: Beschleunigung = Rohwert*256*2500/1024

Die Daten sind in der Sequenz "x, y, z, x, y, z, ..." formatiert, abhängig von den aktivierten Achsen. Beispiele:

  • x, y, z aktiviert: "x, y, z, ... 20x ..., x, y, z"
  • x, z aktiviert: "x, z, ... 30x ..., x, z"
  • y aktiviert: "y, ... 60x ..., y"

Konstanten

BrickletAccelerometerV2::DEVICE_IDENTIFIER

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

BrickletAccelerometerV2::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Accelerometer Bricklet 2.0 dar.