TCP/IP - Industrial Quad Relay Bricklet

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

API

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

Grundfunktionen

BrickletIndustrialQuadRelay.set_value
Funktions-ID:
  • 1
Anfrage:
  • value_mask – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • keine Antwort

Setzt die Ausgabewerte mit einer Bitmaske (16Bit). Eine 1 in der Bitmaske bedeutet Relais geschlossen und eine 0 in der Bitmaske bedeutet Relais offen.

Zum Beispiel: Der Wert 3 bzw. 0b0011 wird die Relais 0-1 schließen und alle anderen öffnen.

Falls keine Gruppen verwendet werden (siehe set_group), entsprechen die Pins der Beschriftung auf dem Industrial Quad Relay Bricklet.

Falls Gruppen verwendet werden, entsprechen die Pins den Elementen der Gruppe. Element 1 in der Gruppe bekommt Pins 0-3, Element 2 Pins 4-7, Element 3 Pins 8-11 und Element 4 Pins 12-15.

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

BrickletIndustrialQuadRelay.get_value
Funktions-ID:
  • 2
Anfrage:
  • keine Nutzdaten
Antwort:
  • value_mask – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Gibt die Bitmaske zurück, wie von set_value gesetzt.

Fortgeschrittene Funktionen

BrickletIndustrialQuadRelay.set_monoflop
Funktions-ID:
  • 3
Anfrage:
  • selection_mask – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • value_mask – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • time – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

Konfiguriert einen Monoflop für die Pins, wie mittels der Bitmaske des ersten Parameters festgelegt.

Der zweite Parameter ist eine Bitmaske mit den gewünschten Zuständen der festgelegten Pins. Eine 1 in der Bitmaske bedeutet Relais geschlossen und eine 0 in der Bitmaske bedeutet Relais offen.

Der dritte Parameter stellt die Zeit dar, welche die Pins den Zustand halten sollen.

Wenn diese Funktion mit den Parametern (9, 1, 1500) bzw. (0b1001, 0b0001, 1500) aufgerufen wird: Pin 0 wird auf geschlossen und Pin 3 auf geöffnet gesetzt. Nach 1,5s wird Pin 0 wieder geöffnet und Pin 3 geschlossen.

Ein Monoflop kann zur Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein Quad Relay Bricklet ist an ein Slave Stapel verbunden. Jetzt kann diese Funktion sekündlich, mit einem Zeitparameter von 2 Sekunden, aufgerufen werden. Der Pin wird die gesamte Zeit im Zustand geschlossen sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird der Pin nach spätestens zwei Sekunden in den Zustand geöffnet wechseln.

BrickletIndustrialQuadRelay.get_monoflop
Funktions-ID:
  • 4
Anfrage:
  • pin – Typ: uint8, Wertebereich: [0 bis 15]
Antwort:
  • value – Typ: uint16, Wertebereich: [0 bis 1]
  • time – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]
  • time_remaining – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

Gibt (für den angegebenen Pin) 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.

BrickletIndustrialQuadRelay.set_group
Funktions-ID:
  • 5
Anfrage:
  • group – Typ: char[4], Wertebereich: ['a' bis 'd', 'n']
Antwort:
  • keine Antwort

Setzt eine Gruppe von Quad Relay Bricklets die zusammenarbeiten sollen. Mögliche Gruppierungen können mit der Funktion get_available_for_group gefunden werden.

Eine Gruppe besteht aus 4 Element. Element 1 in der Gruppe bekommt Pins 0-3, Element 2 Pins 4-7, Element 3 Pins 8-11 und Element 4 Pins 12-15.

Jedes Element kann entweder auf einen der Ports ('a' bis 'd') gesetzt werden oder falls nicht genutzt 'n' gesetzt werden.

Zum Beispiel: Falls zwei Quad Relay Bricklets mit Port A und Port B verbunden sind, könnte diese Funktion mit ['a', 'b', 'n', 'n'] aufgerufen werden.

In diesem Fall wären die Pins von Port A den Werten 0-3 zugewiesen und die Pins von Port B den Werten 4-7. Es ist jetzt möglich mit der Funktion set_value beide Bricklets gleichzeitig zu kontrollieren.

BrickletIndustrialQuadRelay.get_group
Funktions-ID:
  • 6
Anfrage:
  • keine Nutzdaten
Antwort:
  • group – Typ: char[4], Wertebereich: ['a' bis 'd', 'n']

Gibt die Gruppierung zurück, wie von set_group gesetzt.

BrickletIndustrialQuadRelay.get_available_for_group
Funktions-ID:
  • 7
Anfrage:
  • keine Nutzdaten
Antwort:
  • available – Typ: uint8, Wertebereich: [0 bis 15]

Gibt eine Bitmaske von Ports zurück die für die Gruppierung zur Verfügung stehen. Zum Beispiel bedeutet der Wert 5 bzw. 0b0101: Port A und Port C sind mit Bricklets verbunden die zusammen gruppiert werden können.

BrickletIndustrialQuadRelay.set_selected_values
Funktions-ID:
  • 9
Anfrage:
  • selection_mask – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • value_mask – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • keine Antwort

Setzt die Ausgabewerte mit einer Bitmaske, entsprechend der Selektionsmaske. Die Bitmaske ist 16 Bit lang. true steht für ein geschlossenes Relais und false für ein offenes Relay.

Zum Beispiel: Die Werte (3, 1) bzw. (0b0011, 0b0001) wird das Relais 0 schließen, das Relais 1 öffnen und alle anderen unangetastet lassen.

Falls keine Gruppen verwendet werden (siehe set_group), entsprechen die Pins der Beschriftung auf dem Industrial Quad Relay Bricklet.

Falls Gruppen verwendet werden, entsprechen die Pins den Elementen der Gruppe. Element 1 in der Gruppe bekommt Pins 0-3, Element 2 Pins 4-7, Element 3 Pins 8-11 und Element 4 Pins 12-15.

Laufende Monoflop Timer für die ausgewählten Relais werden abgebrochen, wenn diese Funktion aufgerufen wird.

BrickletIndustrialQuadRelay.get_identity
Funktions-ID:
  • 255
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: char[8]
  • connected_uid – Typ: char[8]
  • position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • firmware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • device_identifier – Typ: uint16, Wertebereich: [0 bis 216 - 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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. 

Callbacks

BrickletIndustrialQuadRelay.CALLBACK_MONOFLOP_DONE
Funktions-ID:
  • 8
Antwort:
  • selection_mask – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • value_mask – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Rückgabewerte enthalten die beteiligten Pins als Bitmaske und den aktuellen Zustand als Bitmaske (der Zustand nach dem Monoflop).