Ruby - Isolator Bricklet

Dies ist die Beschreibung der Ruby API Bindings für das Isolator Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Isolator Bricklet 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
29
30
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_isolator'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
i = BrickletIsolator.new UID, ipcon # Create device object

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

# Get current statistics as [messages_from_brick, messages_from_bricklet,
#                            connected_bricklet_device_identifier, connected_bricklet_uid]
statistics = i.get_statistics

puts "Messages From Brick: #{statistics[0]}"
puts "Messages From Bricklet: #{statistics[1]}"
puts "Connected Bricklet Device Identifier: #{statistics[2]}"
puts "Connected Bricklet UID: #{statistics[3]}"

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

API

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

BrickletIsolator::new(uid, ipcon) → isolator
Parameter:
  • uid -- str
  • ipcon -- IPConnection

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

isolator = BrickletIsolator.new 'YOUR_DEVICE_UID', ipcon

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

BrickletIsolator#get_statistics → [int, int, int, str]

Gibt Statistken des Isolator Bricklets zurück.

Das zurückgegebene Array enthält die Werte messages_from_brick, messages_from_bricklet, connected_bricklet_device_identifier und connected_bricklet_uid.

Fortgeschrittene Funktionen

BrickletIsolator#set_spitfp_baudrate_config(enable_dynamic_baudrate, minimum_dynamic_baudrate) → nil
Parameter:
  • enable_dynamic_baudrate -- bool
  • minimum_dynamic_baudrate -- int

Das SPITF-Protokoll kann mit einer dynamischen Baudrate genutzt werden. Wenn die dynamische Baudrate aktiviert ist, versucht das Isolator Bricklet die Baudrate anhand des Datenaufkommens zwischen Isolator Bricklet und Bricklet anzupassen.

Die Baudratenkonfiguration für die Kommunikation zwischen Brick und Isolator Bricklet kann in der API des Bricks eingestellt werden.

Die Baudrate wird exponentiell erhöht wenn viele Daten gesendet/empfangen werden und linear verringert wenn wenig Daten gesendet/empfangen werden.

Diese Vorgehensweise verringert die Baudrate in Anwendungen wo nur wenig Daten ausgetauscht werden müssen (z.B. eine Wetterstation) und erhöht die Robustheit. Wenn immer viele Daten ausgetauscht werden (z.B. Thermal Imaging Bricklet), wird die Baudrate automatisch erhöht.

In Fällen wo wenige Daten all paar Sekunden so schnell wie Möglich übertragen werden sollen (z.B. RS485 Bricklet mit hoher Baudrate aber kleinem Payload) kann die dynamische Baudrate zum maximieren der Performance ausgestellt werden.

Die maximale Baudrate kann pro Port mit der Funktion #set_spitfp_baudrate. gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von #set_spitfp_baudrate gesetzt statisch verwendet.

Die minimale dynamische Baudrate hat einen Wertebereich von 400000 bis 2000000 Baud.

Standardmäßig ist die dynamische Baudrate aktiviert und die minimale dynamische Baudrate ist 400000.

BrickletIsolator#get_spitfp_baudrate_config → [bool, int]

Gibt die Baudratenkonfiguration zurück, siehe #set_spitfp_baudrate_config.

Das zurückgegebene Array enthält die Werte enable_dynamic_baudrate und minimum_dynamic_baudrate.

BrickletIsolator#set_spitfp_baudrate(baudrate) → nil
Parameter:baudrate -- int

Setzt die Baudrate für die Kommunikation zwischen Isolator Bricklet und angeschlossenem Bricklet. Die Baudrate für die Kommunikation zwischen Brick und Isolator Bricklet kann in der API des Bricks eingestellt werden.

Die Baudrate hat einen möglichen Wertebereich von 400000 bis 2000000.

Für einen höheren Durchsatz der Bricklets kann die Baudrate erhöht werden. Wenn der Fehlerzähler auf Grund von lokaler Störeinstrahlung hoch ist (siehe #get_spitfp_error_count) kann die Baudrate verringert werden.

Wenn das Feature der dynamische Baudrate aktiviert ist, setzt diese Funktion die maximale Baudrate (siehe #set_spitfp_baudrate_config).

EMV Tests werden mit der Standardbaudrate durchgeführt. Falls eine CE-Kompatibilität o.ä. in der Anwendung notwendig ist empfehlen wir die Baudrate nicht zu ändern.

Die Standardbaudrate für alle Ports ist 1400000.

BrickletIsolator#get_spitfp_baudrate → int

Gibt die Baudrate zurück, siehe #set_spitfp_baudrate.

BrickletIsolator#get_isolator_spitfp_error_count → [int, int, int, int]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Isolator Bricklet und Bricklet aufgetreten sind zurück. Rufe #get_spitfp_error_count um die Anzahl der Fehler zwischen Isolator Bricklet und Brick zu bekommen.

Die Fehler sind aufgeteilt in

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

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

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

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

Siehe #set_response_expected für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

BrickletIsolator#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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletIsolator::FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 2
  • BrickletIsolator::FUNCTION_SET_SPITFP_BAUDRATE = 4
  • BrickletIsolator::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIsolator::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIsolator::FUNCTION_RESET = 243
  • BrickletIsolator::FUNCTION_WRITE_UID = 248
BrickletIsolator#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.

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

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

  • BrickletIsolator::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIsolator::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIsolator::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIsolator::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIsolator::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletIsolator::BOOTLOADER_STATUS_OK = 0
  • BrickletIsolator::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletIsolator::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletIsolator::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletIsolator::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletIsolator::BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletIsolator#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:

  • BrickletIsolator::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIsolator::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIsolator::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIsolator::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIsolator::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletIsolator#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.

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

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

  • BrickletIsolator::STATUS_LED_CONFIG_OFF = 0
  • BrickletIsolator::STATUS_LED_CONFIG_ON = 1
  • BrickletIsolator::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIsolator::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletIsolator#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:

  • BrickletIsolator::STATUS_LED_CONFIG_OFF = 0
  • BrickletIsolator::STATUS_LED_CONFIG_ON = 1
  • BrickletIsolator::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIsolator::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletIsolator#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.

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

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

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

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

Konstanten

BrickletIsolator::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Isolator Bricklet zu identifizieren.

Die #get_identity() Funktion und der ::CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletIsolator::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Isolator Bricklet dar.