Ruby - Joystick Bricklet 2.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

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

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_joystick_v2'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
j = BrickletJoystickV2.new UID, ipcon # Create device object

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

# Get current position as [x, y]
position = j.get_position

puts "Position [X]: #{position[0]}"
puts "Position [Y]: #{position[1]}"

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

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

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_joystick_v2'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
j = BrickletJoystickV2.new UID, ipcon # Create device object

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

# Register pressed callback
j.register_callback(BrickletJoystickV2::CALLBACK_PRESSED) do |pressed|
  puts "Pressed: #{pressed}"
end

# Set period for pressed callback to 0.01s (10ms)
j.set_pressed_callback_configuration 10, true

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

Grundfunktionen¶

BrickletJoystickV2::new(uid, ipcon) → joystick_v2¶

Parameter:	uid – Typ: str ipcon – Typ: IPConnection
Rückgabe:	joystick_v2 – Typ: BrickletJoystickV2

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

joystick_v2 = BrickletJoystickV2.new 'YOUR_DEVICE_UID', ipcon

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

BrickletJoystickV2#get_position → [int, int]¶

Rückgabe-Array:	0: x – Typ: int, Wertebereich: [-100 bis 100] 1: y – Typ: int, Wertebereich: [-100 bis 100]

Gibt die Position des Joystick zurück. Die Mittelposition des Joysticks ist x=0, y=0. Die zurückgegebenen Werte sind gemittelt und kalibriert (siehe #calibrate).

Wenn die Position periodisch abgefragt werden sollen, wird empfohlen den ::CALLBACK_POSITION Callback zu nutzen und die Periode mit #set_position_callback_configuration vorzugeben.

BrickletJoystickV2#is_pressed → bool¶

Rückgabe:	pressed – Typ: bool

Gibt true zurück wenn die Taste gedrückt ist und sonst false.

Wenn der Tastendruck periodisch abgefragt werden sollen, wird empfohlen den ::CALLBACK_PRESSED Callback zu nutzen und die Periode mit #set_pressed_callback_configuration vorzugeben.

Fortgeschrittene Funktionen¶

BrickletJoystickV2#calibrate → nil¶

Kalibriert die Mittelposition des Joysticks. Sollte der Joystick Bricklet 2.0 nicht x=0 und y=0 in der Mittelposition zurückgeben, kann diese Funktion aufgerufen werden wenn der Joystick sich unbewegt in der Mittelposition befindet.

Die resultierende Kalibrierung wird in nicht-flüchtigem Speicher gespeichert, somit ist die Kalibrierung nur einmalig notwendig.

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

BrickletJoystickV2#set_status_led_config(config) → nil¶

Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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:

• BrickletJoystickV2::STATUS_LED_CONFIG_OFF = 0
• BrickletJoystickV2::STATUS_LED_CONFIG_ON = 1
• BrickletJoystickV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletJoystickV2::STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletJoystickV2#get_status_led_config → int¶

Rückgabe:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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:

• BrickletJoystickV2::STATUS_LED_CONFIG_OFF = 0
• BrickletJoystickV2::STATUS_LED_CONFIG_ON = 1
• BrickletJoystickV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletJoystickV2::STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletJoystickV2#get_chip_temperature → int¶

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

Gibt die Temperatur, 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.

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

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

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

BrickletJoystickV2#set_position_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_POSITION 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 sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn ein 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 der Werte.

BrickletJoystickV2#get_position_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_position_callback_configuration gesetzt.

BrickletJoystickV2#set_pressed_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_PRESSED 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 sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn ein 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 der Werte.

BrickletJoystickV2#get_pressed_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_pressed_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:

joystick_v2.register_callback BrickletJoystickV2::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

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

BrickletJoystickV2::CALLBACK_POSITION¶

Callback-Parameter:	x – Typ: int, Wertebereich: [-100 bis 100] y – Typ: int, Wertebereich: [-100 bis 100]

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

Die Parameter sind die gleichen wie bei #get_position.

BrickletJoystickV2::CALLBACK_PRESSED¶

Callback-Parameter:	pressed – Typ: bool

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

Der Parameter ist der gleiche wie bei #is_pressed.

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.

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

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

• BrickletJoystickV2::FUNCTION_CALIBRATE = 3
• BrickletJoystickV2::FUNCTION_SET_POSITION_CALLBACK_CONFIGURATION = 4
• BrickletJoystickV2::FUNCTION_SET_PRESSED_CALLBACK_CONFIGURATION = 7
• BrickletJoystickV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletJoystickV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletJoystickV2::FUNCTION_RESET = 243
• BrickletJoystickV2::FUNCTION_WRITE_UID = 248

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

• BrickletJoystickV2::FUNCTION_CALIBRATE = 3
• BrickletJoystickV2::FUNCTION_SET_POSITION_CALLBACK_CONFIGURATION = 4
• BrickletJoystickV2::FUNCTION_SET_PRESSED_CALLBACK_CONFIGURATION = 7
• BrickletJoystickV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletJoystickV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletJoystickV2::FUNCTION_RESET = 243
• BrickletJoystickV2::FUNCTION_WRITE_UID = 248

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

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

BrickletJoystickV2#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 Bootloader- 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:

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

Für status:

• BrickletJoystickV2::BOOTLOADER_STATUS_OK = 0
• BrickletJoystickV2::BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletJoystickV2::BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletJoystickV2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletJoystickV2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletJoystickV2::BOOTLOADER_STATUS_CRC_MISMATCH = 5

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

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

BrickletJoystickV2#set_write_firmware_pointer(pointer) → nil¶

Parameter:	pointer – Typ: int, Einheit: 1 B, 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.

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

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

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

Konstanten¶

BrickletJoystickV2::DEVICE_IDENTIFIER¶

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

BrickletJoystickV2::DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Joystick Bricklet 2.0 dar.