Software / API Bindings / Ruby / API Referenz und Beispiele / Bricklets / Industrial Dual Relay Bricklet

Ruby - Industrial Dual Relay Bricklet¶

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

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

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_industrial_dual_relay'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
idr = BrickletIndustrialDualRelay.new UID, ipcon # Create device object

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

# Turn relays alternating on/off 10 times with 1 second delay
for _ in 0..4
  sleep 1
  idr.set_value true, false
  sleep 1
  idr.set_value false, true
end

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

API¶

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

BrickletIndustrialDualRelay::new(uid, ipcon) → industrial_dual_relay¶

Parameter:	uid – Typ: str ipcon – Typ: IPConnection
Rückgabe:	industrial_dual_relay – Typ: BrickletIndustrialDualRelay

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

industrial_dual_relay = BrickletIndustrialDualRelay.new 'YOUR_DEVICE_UID', ipcon

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

BrickletIndustrialDualRelay#set_value(channel0, channel1) → nil¶

Parameter:	channel0 – Typ: bool, Standardwert: false channel1 – Typ: bool, Standardwert: false

Setzt den Zustand der Relais, true bedeutet ein und false aus. Beispiel: (true, false) schaltet Relais 0 ein und Relais 1 aus.

Wenn nur eines der Relais gesetzt werden soll und der aktuelle Zustand des anderen Relais nicht bekannt ist, dann kann der Zustand mit #get_value ausgelesen werden oder es kann #set_selected_value genutzt werden.

Alle laufenden Monoflop Timer werden abgebrochen, wenn diese Funktion aufgerufen wird.

BrickletIndustrialDualRelay#get_value → [bool, bool]¶

Rückgabe-Array:	0: channel0 – Typ: bool, Standardwert: false 1: channel1 – Typ: bool, Standardwert: false

Gibt den Zustand der Relais zurück, true bedeutet ein und false aus.

Fortgeschrittene Funktionen¶

BrickletIndustrialDualRelay#set_monoflop(channel, value, time) → nil¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1] value – Typ: bool time – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1]

Der erste Parameter kann 0 oder 1 sein (Relais 0 oder Relais 1). Der zweite Parameter ist der gewünschte Zustand des Relais (true bedeutet ein und false aus). Der dritte Parameter stellt die Zeit dar, welche das Relais den Zustand halten soll.

Wenn diese Funktion mit den Parametern (1, true, 1500) aufgerufen wird: Relais 1 wird angeschaltet und nach 1,5s wieder ausgeschaltet.

Ein Monoflop kann als Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein Industrial Dual Relay Bricklet ist an ein Slave Stapel verbunden. Jetzt kann diese Funktion sekündlich, mit einem Zeitparameter von 2 Sekunden, aufgerufen werden. Das Relais wird die gesamte Zeit ein sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird das Relais nach spätestens zwei Sekunden ausschalten.

BrickletIndustrialDualRelay#get_monoflop(channel) → [bool, int, int]¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1]
Rückgabe-Array:	0: value – Typ: bool 1: time – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1] 2: time_remaining – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1]

Gibt (für das angegebene Relais) den aktuellen Zustand und die Zeit, wie von #set_monoflop gesetzt, sowie die noch verbleibende Zeit bis zum Zustandswechsel, zurück.

Wenn der Timer aktuell nicht läuft, ist die noch verbleibende Zeit 0.

BrickletIndustrialDualRelay#set_selected_value(channel, value) → nil¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1] value – Typ: bool

Setzt den Zustand des ausgewählten Relais, true bedeutet ein und false aus.

Ein laufender Monoflop Timer für das ausgewählte Relais wird abgebrochen, wenn diese Funktion aufgerufen wird.

Das andere Relais bleibt unverändert.

BrickletIndustrialDualRelay#get_spitfp_error_count → [int, int, int, int]¶

Rückgabe-Array:	0: error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 2³² - 1] 1: error_count_message_checksum – Typ: int, Wertebereich: [0 bis 2³² - 1] 2: error_count_frame – Typ: int, Wertebereich: [0 bis 2³² - 1] 3: error_count_overflow – Typ: int, Wertebereich: [0 bis 2³² - 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.

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

BrickletIndustrialDualRelay::STATUS_LED_CONFIG_OFF = 0
BrickletIndustrialDualRelay::STATUS_LED_CONFIG_ON = 1
BrickletIndustrialDualRelay::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletIndustrialDualRelay::STATUS_LED_CONFIG_SHOW_STATUS = 3

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

BrickletIndustrialDualRelay::STATUS_LED_CONFIG_OFF = 0
BrickletIndustrialDualRelay::STATUS_LED_CONFIG_ON = 1
BrickletIndustrialDualRelay::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletIndustrialDualRelay::STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletIndustrialDualRelay#get_chip_temperature → int¶

Rückgabe:	temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 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.

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

BrickletIndustrialDualRelay#get_identity → [str, str, chr, [int, ...], [int, ...], int]¶

Rückgabe-Array:

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 2¹⁶ - 1]

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 2¹⁶ - 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¶

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

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:

industrial_dual_relay.register_callback BrickletIndustrialDualRelay::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.

BrickletIndustrialDualRelay::CALLBACK_MONOFLOP_DONE¶

Callback-Parameter:	channel – Typ: int, Wertebereich: [0 bis 1] value – Typ: bool

Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Die Parameter enthalten das auslösende Relais und den aktuellen Zustand des Relais (der Zustand nach dem Monoflop).

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.

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

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

BrickletIndustrialDualRelay::FUNCTION_SET_VALUE = 1
BrickletIndustrialDualRelay::FUNCTION_SET_MONOFLOP = 3
BrickletIndustrialDualRelay::FUNCTION_SET_SELECTED_VALUE = 6
BrickletIndustrialDualRelay::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletIndustrialDualRelay::FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletIndustrialDualRelay::FUNCTION_RESET = 243
BrickletIndustrialDualRelay::FUNCTION_WRITE_UID = 248

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

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

Für function_id:

BrickletIndustrialDualRelay::FUNCTION_SET_VALUE = 1
BrickletIndustrialDualRelay::FUNCTION_SET_MONOFLOP = 3
BrickletIndustrialDualRelay::FUNCTION_SET_SELECTED_VALUE = 6
BrickletIndustrialDualRelay::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletIndustrialDualRelay::FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletIndustrialDualRelay::FUNCTION_RESET = 243
BrickletIndustrialDualRelay::FUNCTION_WRITE_UID = 248

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

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

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

Für status:

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

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

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

BrickletIndustrialDualRelay#set_write_firmware_pointer(pointer) → nil¶

Parameter:	pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 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.

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

BrickletIndustrialDualRelay#write_uid(uid) → nil¶

Parameter:	uid – Typ: int, Wertebereich: [0 bis 2³² - 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.

BrickletIndustrialDualRelay#read_uid → int¶

Rückgabe:	uid – Typ: int, Wertebereich: [0 bis 2³² - 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¶

BrickletIndustrialDualRelay::DEVICE_IDENTIFIER¶

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

BrickletIndustrialDualRelay::DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Industrial Dual Relay Bricklet dar.