TCP/IP - Dual Relay Bricklet

Dies ist die Beschreibung des TCP/IP Protokolls für das Dual Relay Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Dual Relay Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API

Eine allgemeine Beschreibung der TCP/IP Protokollstruktur findet sich hier.

Grundfunktionen

BrickletDualRelay.set_state
Funktions ID:

1

Anfrage:
  • relay1 -- bool
  • relay2 -- bool
Antwort:

keine Antwort

Setzt den Zustand der Relais, true bedeutet ein und false aus. Beispiel: (true, false) schaltet Relais 1 ein und Relais 2 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_state ausgelesen werden oder es kann set_selected_state genutzt werden.

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

Der Standardwert ist (false, false).

BrickletDualRelay.get_state
Funktions ID:

2

Anfrage:

keine Nutzdaten

Antwort:
  • relay1 -- bool
  • relay2 -- bool

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

Fortgeschrittene Funktionen

BrickletDualRelay.set_monoflop
Funktions ID:

3

Anfrage:
  • relay -- uint8
  • state -- bool
  • time -- uint32
Antwort:

keine Antwort

Der erste Parameter kann 1 oder 2 sein (Relais 1 oder Relais 2). Der zweite Parameter ist der gewünschte Zustand des Relais (true bedeutet ein und false aus). Der dritte Parameter stellt die Zeit (in ms) 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 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.

BrickletDualRelay.get_monoflop
Funktions ID:

4

Anfrage:
  • relay -- uint8
Antwort:
  • state -- bool
  • time -- uint32
  • time_remaining -- uint32

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.

BrickletDualRelay.set_selected_state
Funktions ID:

6

Anfrage:
  • relay -- uint8
  • state -- bool
Antwort:

keine Antwort

Setzt den Zustand des ausgewählte Relais (1 oder 2), 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 unangetastet.

BrickletDualRelay.get_identity
Funktions ID:

255

Anfrage:

keine Nutzdaten

Antwort:
  • uid -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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. 

Callbacks

BrickletDualRelay.CALLBACK_MONOFLOP_DONE
Funktions ID:

5

Antwort:
  • relay -- uint8
  • state -- bool

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