Dies ist die Beschreibung der Ruby API Bindings für den HAT Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des HAT Brick sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die Ruby API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | #!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-
require 'tinkerforge/ip_connection'
require 'tinkerforge/brick_hat'
include Tinkerforge
HOST = 'localhost'
PORT = 4223
UID = 'XXYYZZ' # Change XXYYZZ to the UID of your HAT Brick
ipcon = IPConnection.new # Create IP connection
hat = BrickHAT.new UID, ipcon # Create device object
ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected
# Turn Raspberry Pi and Bricklets off in 2 seconds for 30 minutes with sleep indicator enabled
hat.set_sleep_mode 2, 1800, true, true, true
puts 'Press key to exit'
$stdin.gets
ipcon.disconnect
|
Download (example_print_voltages.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/brick_hat'
include Tinkerforge
HOST = 'localhost'
PORT = 4223
UID = 'XXYYZZ' # Change XXYYZZ to the UID of your HAT Brick
ipcon = IPConnection.new # Create IP connection
hat = BrickHAT.new UID, ipcon # Create device object
ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected
# Get current get voltages as [voltage_usb, voltage_dc]
voltages = hat.get_voltages
puts "Voltage USB: #{voltages[0]/1000.0} V"
puts "Voltage DC: #{voltages[1]/1000.0} V"
puts 'Press key to exit'
$stdin.gets
ipcon.disconnect
|
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
BrickHAT
::
new
(uid, ipcon) → hat¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
hat = BrickHAT.new 'YOUR_DEVICE_UID', ipcon
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickHAT
#
set_sleep_mode
(power_off_delay, power_off_duration, raspberry_pi_off, bricklets_off, enable_sleep_indicator) → nil¶Parameter: |
|
---|
Setzt den Schlaf-Modus.
Bemerkung
Diese Funktion schaltet die Stromversorgung des Raspberry Pis nach Power Off Delay Sekunden ab. Das Betriebssystem muss manuell heruntergefahren werden, zum Beispiel durch Ausführen von 'sudo shutdown -h now'.
Parameter:
Beispiel: Um den RPi und die Bricklets in 5 Sekunden für 10 Minuten mit aktivierter Status-LED auszuschalten, rufe (5, 60*10, true, true, true) auf.
Diese Funktion kann auch genutzt werden um einen Watchdog zu implementieren. Dazu kann ein Programm geschrieben werden, welches in einer Schleife einmal pro Sekunde folgendes aufruft: (10, 2, true, false, false). Dies führt dazu, dass das HAT den RPi nach 10 Sekunden neustartet, wenn dieser abgestürzt oder stecken geblieben ist.
BrickHAT
#
get_sleep_mode
→ [int, int, bool, bool, bool]¶Rückgabe-Array: |
|
---|
Gibt die Sleep-Mode-Einstellungen zurück, wie von #set_sleep_mode
gesetzt.
BrickHAT
#
set_bricklet_power
(bricklet_power) → nil¶Parameter: |
|
---|
Kann auf true/false gesetzt werden um die Spannungsversorgung der angeschlossenen Bricklets an/aus zu stellen.
BrickHAT
#
get_bricklet_power
→ bool¶Rückgabe: |
|
---|
Gibt den Status der Stromversorgung der angeschlossenen Bricklets zurück, wie von
#set_bricklet_power
gesetzt.
BrickHAT
#
get_voltages
→ [int, int]¶Rückgabe-Array: |
|
---|
Gibt die USB- und DC-Input-Versorgungsspannung zurück.
Es gibt drei mögliche Kombinationen:
BrickHAT
#
set_rtc_driver
(rtc_driver) → nil¶Parameter: |
|
---|
Konfiguriert den RTC-Treiber der dem Raspberry Pi zur Nutzung gegeben wird. Aktuell werden zwei unterschiedliche RTCs verbaut:
Der korrekte Treiber wird während dem ersten Flashens von Tinkerforge gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für rtc_driver:
Neu in Version 2.0.3 (Firmware).
BrickHAT
#
get_rtc_driver
→ int¶Rückgabe: |
|
---|
Gibt den RTC-Treiber zurück, wie von #set_rtc_driver
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für rtc_driver:
Neu in Version 2.0.3 (Firmware).
BrickHAT
#
get_spitfp_error_count
→ [int, int, int, int]¶Rückgabe-Array: |
|
---|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
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.
BrickHAT
#
set_status_led_config
(config) → nil¶Parameter: |
|
---|
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:
BrickHAT
#
get_status_led_config
→ int¶Rückgabe: |
|
---|
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:
BrickHAT
#
get_chip_temperature
→ int¶Rückgabe: |
|
---|
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.
BrickHAT
#
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.
BrickHAT
#
get_identity
→ [str, str, chr, [int, ...], [int, ...], int]¶Rückgabe-Array: |
|
---|
Gibt die UID, die UID zu der das HAT verbunden ist (typischerweise '0' da das HAT das Wurzelgerät der Topologie ist), die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.
Der HAT (Zero) Brick ist immer an Position 'i'.
Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricks.
BrickHAT
#
register_callback
(callback_id) { |param [, ...]| block } → nil¶Parameter: |
|
---|
Registriert den block
für die gegebene callback_id
.
Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.
BrickHAT
#
set_voltages_callback_configuration
(period, value_has_to_change) → nil¶Parameter: |
|
---|
Die Periode ist die Periode mit der der ::CALLBACK_VOLTAGES
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.
Neu in Version 2.0.1 (Firmware).
BrickHAT
#
get_voltages_callback_configuration
→ [int, bool]¶Rückgabe-Array: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels
#set_voltages_callback_configuration
gesetzt.
Neu in Version 2.0.1 (Firmware).
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:
hat.register_callback BrickHAT::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.
BrickHAT
::
CALLBACK_VOLTAGES
¶Callback-Parameter: |
|
---|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
#set_voltages_callback_configuration
gesetzten Konfiguration
Die Parameter sind der gleiche wie #get_voltages
.
Neu in Version 2.0.1 (Firmware).
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.
BrickHAT
#
get_api_version
→ [int, ...]¶Rückgabe-Array: |
|
---|
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.
BrickHAT
#
get_response_expected
(function_id) → bool¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
BrickHAT
#
set_response_expected
(function_id, response_expected) → nil¶Parameter: |
|
---|
Ä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:
BrickHAT
#
set_response_expected_all
(response_expected) → nil¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
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.
BrickHAT
#
set_bootloader_mode
(mode) → int¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
Für status:
BrickHAT
#
get_bootloader_mode
→ int¶Rückgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe #set_bootloader_mode
.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickHAT
#
set_write_firmware_pointer
(pointer) → nil¶Parameter: |
|
---|
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.
BrickHAT
#
write_firmware
(data) → int¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
BrickHAT
#
write_uid
(uid) → nil¶Parameter: |
|
---|
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.
BrickHAT
#
read_uid
→ int¶Rückgabe: |
|
---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.
BrickHAT
::
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um einen HAT Brick 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.
BrickHAT
::
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines HAT Brick dar.