Ruby - Dual Button Bricklet 2.0

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

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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_dual_button_v2'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
db = BrickletDualButtonV2.new UID, ipcon # Create device object

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

# Register state changed callback
db.register_callback(BrickletDualButtonV2::CALLBACK_STATE_CHANGED) do |button_l, button_r,
                                                                       led_l, led_r|
  if button_l == BrickletDualButtonV2::BUTTON_STATE_PRESSED
    puts "Left Button: Pressed"
  elsif button_l == BrickletDualButtonV2::BUTTON_STATE_RELEASED
    puts "Left Button: Released"
  end

  if button_r == BrickletDualButtonV2::BUTTON_STATE_PRESSED
    puts "Right Button: Pressed"
  elsif button_r == BrickletDualButtonV2::BUTTON_STATE_RELEASED
    puts "Right Button: Released"
  end

  puts ''
end

# Enable state changed callback
db.set_state_changed_callback_configuration true

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

API

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

BrickletDualButtonV2::new(uid, ipcon) → dual_button_v2
Parameter:
  • uid -- str
  • ipcon -- IPConnection

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

dual_button_v2 = BrickletDualButtonV2.new 'YOUR_DEVICE_UID', ipcon

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

BrickletDualButtonV2#set_led_state(led_l, led_r) → nil
Parameter:
  • led_l -- int
  • led_r -- int

Setzt den Zustand der LEDs. Möglich Zustände sind:

  • 0 = AutoToggleOn: Aktiviert Auto-Toggle und anfänglich aktiviert LED
  • 1 = AutoToggleOff: Aktiviert Auto-Toggle und anfänglich deaktiviert LED.
  • 2 = On: Aktiviert LED (Auto-Toggle is deaktiviert).
  • 3 = Off: Deaktiviert LED (Auto-Toggle is deaktiviert).

Im Auto-Toggle Modus wechselt die LED automatisch zwischen aus und an bei jedem Tasterdruck.

Wenn nur eine der LEDs gesetzt werden soll und der aktuelle Zustand der anderen LED nicht bekannt ist, dann kann der Zustand mit #get_led_state ausgelesen werden oder es kann #set_selected_led_state genutzt werden.

Der Standardwert ist (1, 1).

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

  • BrickletDualButtonV2::LED_STATE_AUTO_TOGGLE_ON = 0
  • BrickletDualButtonV2::LED_STATE_AUTO_TOGGLE_OFF = 1
  • BrickletDualButtonV2::LED_STATE_ON = 2
  • BrickletDualButtonV2::LED_STATE_OFF = 3
BrickletDualButtonV2#get_led_state → [int, int]

Gibt den aktuellen Zustand der LEDs zurück, wie von #set_led_state gesetzt.

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

  • BrickletDualButtonV2::LED_STATE_AUTO_TOGGLE_ON = 0
  • BrickletDualButtonV2::LED_STATE_AUTO_TOGGLE_OFF = 1
  • BrickletDualButtonV2::LED_STATE_ON = 2
  • BrickletDualButtonV2::LED_STATE_OFF = 3

Das zurückgegebene Array enthält die Werte led_l und led_r.

BrickletDualButtonV2#get_button_state → [int, int]

Gibt den aktuellen Zustand beider Taster zurück. Mögliche Zustände sind:

  • 0 = pressed (gedrückt)
  • 1 = released (losgelassen)

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

  • BrickletDualButtonV2::BUTTON_STATE_PRESSED = 0
  • BrickletDualButtonV2::BUTTON_STATE_RELEASED = 1

Das zurückgegebene Array enthält die Werte button_l und button_r.

Fortgeschrittene Funktionen

BrickletDualButtonV2#set_selected_led_state(led, state) → nil
Parameter:
  • led -- int
  • state -- int

Setzt den Zustand der selektierten LED (0 oder 1).

Die andere LED bleibt unangetastet.

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

  • BrickletDualButtonV2::LED_LEFT = 0
  • BrickletDualButtonV2::LED_RIGHT = 1
  • BrickletDualButtonV2::LED_STATE_AUTO_TOGGLE_ON = 0
  • BrickletDualButtonV2::LED_STATE_AUTO_TOGGLE_OFF = 1
  • BrickletDualButtonV2::LED_STATE_ON = 2
  • BrickletDualButtonV2::LED_STATE_OFF = 3
BrickletDualButtonV2#get_api_version → [int, int, int]

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.

BrickletDualButtonV2#get_response_expected(function_id) → bool
Parameter:function_id -- int

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:

  • BrickletDualButtonV2::FUNCTION_SET_LED_STATE = 1
  • BrickletDualButtonV2::FUNCTION_SET_SELECTED_LED_STATE = 5
  • BrickletDualButtonV2::FUNCTION_SET_STATE_CHANGED_CALLBACK_CONFIGURATION = 6
  • BrickletDualButtonV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletDualButtonV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletDualButtonV2::FUNCTION_RESET = 243
  • BrickletDualButtonV2::FUNCTION_WRITE_UID = 248
BrickletDualButtonV2#set_response_expected(function_id, response_expected) → nil
Parameter:
  • function_id -- int
  • response_expected -- 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:

  • BrickletDualButtonV2::FUNCTION_SET_LED_STATE = 1
  • BrickletDualButtonV2::FUNCTION_SET_SELECTED_LED_STATE = 5
  • BrickletDualButtonV2::FUNCTION_SET_STATE_CHANGED_CALLBACK_CONFIGURATION = 6
  • BrickletDualButtonV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletDualButtonV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletDualButtonV2::FUNCTION_RESET = 243
  • BrickletDualButtonV2::FUNCTION_WRITE_UID = 248
BrickletDualButtonV2#set_response_expected_all(response_expected) → nil
Parameter:response_expected -- bool

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

BrickletDualButtonV2#get_spitfp_error_count → [int, int, int, int]

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.

Das zurückgegebene Array enthält die Werte error_count_ack_checksum, error_count_message_checksum, error_count_frame und error_count_overflow.

BrickletDualButtonV2#set_bootloader_mode(mode) → int
Parameter:mode -- int

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:

  • BrickletDualButtonV2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletDualButtonV2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletDualButtonV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletDualButtonV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletDualButtonV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletDualButtonV2::BOOTLOADER_STATUS_OK = 0
  • BrickletDualButtonV2::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletDualButtonV2::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletDualButtonV2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletDualButtonV2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletDualButtonV2::BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletDualButtonV2#get_bootloader_mode → int

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

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

  • BrickletDualButtonV2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletDualButtonV2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletDualButtonV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletDualButtonV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletDualButtonV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletDualButtonV2#set_write_firmware_pointer(pointer) → nil
Parameter:pointer -- int

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.

BrickletDualButtonV2#write_firmware(data) → int
Parameter:data -- [int, int, ..61x.., int]

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.

BrickletDualButtonV2#set_status_led_config(config) → nil
Parameter:config -- int

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:

  • BrickletDualButtonV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletDualButtonV2::STATUS_LED_CONFIG_ON = 1
  • BrickletDualButtonV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletDualButtonV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletDualButtonV2#get_status_led_config → int

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

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

  • BrickletDualButtonV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletDualButtonV2::STATUS_LED_CONFIG_ON = 1
  • BrickletDualButtonV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletDualButtonV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletDualButtonV2#get_chip_temperature → int

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.

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

BrickletDualButtonV2#write_uid(uid) → nil
Parameter:uid -- int

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.

BrickletDualButtonV2#read_uid → int

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

BrickletDualButtonV2#get_identity → [str, str, str, [int, int, int], [int, int, int], int]

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.

Das zurückgegebene Array enthält die Werte uid, connected_uid, position, hardware_version, firmware_version und device_identifier.

Konfigurationsfunktionen für Callbacks

BrickletDualButtonV2#register_callback(callback_id) { |param [, ...]| block } → nil
Parameter:callback_id -- int

Registriert den block für die gegebene callback_id.

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

BrickletDualButtonV2#set_state_changed_callback_configuration(enabled) → nil
Parameter:enabled -- bool

Wenn dieser Callback aktiviert ist, wird der ::CALLBACK_STATE_CHANGED Callback jedes mal ausgelöst, wenn ein Taster gedrückt/losgelassen wird.

Standardmäßig ist dieser Callback deaktiviert.

BrickletDualButtonV2#get_state_changed_callback_configuration → bool

Gibt die Konfiguration zurück, wie von #set_state_changed_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:

dual_button_v2.register_callback BrickletDualButtonV2::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.

BrickletDualButtonV2::CALLBACK_STATE_CHANGED
Parameter:
  • button_l -- int
  • button_r -- int
  • led_l -- int
  • led_r -- int

Dieser Callback wird aufgerufen wenn einer der Taster gedrückt wird.

Mögliche Zustände der Taster sind:

  • 0 = pressed (gedrückt)
  • 1 = released (losgelassen)

Mögliche Zustände der LEDs sind:

  • 0 = AutoToggleOn: Auto-Toggle aktiv und LED an.
  • 1 = AutoToggleOff: Auto-Toggle aktiv und LED aus.
  • 2 = On: Aktiviert LED (Auto-Toggle ist deaktiviert).
  • 3 = Off: Deaktiviert LED (Auto-Toggle ist deaktiviert).

Dieser Callback kann über #set_state_changed_callback_configuration aktiviert werden.

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

  • BrickletDualButtonV2::BUTTON_STATE_PRESSED = 0
  • BrickletDualButtonV2::BUTTON_STATE_RELEASED = 1
  • BrickletDualButtonV2::LED_STATE_AUTO_TOGGLE_ON = 0
  • BrickletDualButtonV2::LED_STATE_AUTO_TOGGLE_OFF = 1
  • BrickletDualButtonV2::LED_STATE_ON = 2
  • BrickletDualButtonV2::LED_STATE_OFF = 3

Konstanten

BrickletDualButtonV2::DEVICE_IDENTIFIER

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

BrickletDualButtonV2::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Dual Button Bricklet 2.0 dar.