Modbus - Industrial Digital Out 4 Bricklet

Dies ist die Beschreibung des Modbus Protokolls für das Industrial Digital Out 4 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Digital Out 4 Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen

BrickletIndustrialDigitalOut4.set_value
Funktions ID:

1

Anfrage:
  • value_mask -- uint16
Antwort:

keine Antwort

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

Zum Beispiel: Der Wert 3 bzw. 0b0011 wird die Pins 0-1 auf logisch 1 und alle anderen auf logisch 0 setzen.

Falls keine Gruppen verwendet werden (siehe set_group), entsprechen die Pins der Beschriftung auf dem Digital Out 4 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.

BrickletIndustrialDigitalOut4.get_value
Funktions ID:

2

Anfrage:

keine Nutzdaten

Antwort:
  • value_mask -- uint16

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

BrickletIndustrialDigitalOut4.set_selected_values
Funktions ID:

9

Anfrage:
  • selection_mask -- uint16
  • value_mask -- uint16
Antwort:

keine Antwort

Setzt die Ausgabewerte mit einer Bitmaske, entsprechend der Selektionsmaske. Die Bitmaske ist 16 Bit lang. true bedeutet logisch 1 und false logisch 0.

Zum Beispiel: Die Werte (3, 1) bzw. (0b0011, 0b0001) werden den Pin 0 auf logisch 1 und den Pin 1 auf logisch 0 setzen. Alle anderen Pins bleiben unangetastet.

Falls keine Gruppen verwendet werden (siehe set_group), entsprechen die Pins der Beschriftung auf dem Digital Out 4 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.

Fortgeschrittene Funktionen

BrickletIndustrialDigitalOut4.set_monoflop
Funktions ID:

3

Anfrage:
  • selection_mask -- uint16
  • value_mask -- uint16
  • time -- uint32
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 logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

Der dritte Parameter stellt die Zeit (in ms) 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 logisch 1 und Pin 3 auf logisch 0 gesetzt. Nach 1,5s wird Pin 0 wieder auf logisch 0 und Pin 3 auf logisch 1 gesetzt.

Ein Monoflop kann zur Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein Digital Out 4 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 logisch 1 sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird der Pin nach spätestens zwei Sekunden in den Zustand logisch 0 wechseln.

BrickletIndustrialDigitalOut4.get_monoflop
Funktions ID:

4

Anfrage:
  • pin -- uint8
Antwort:
  • value -- uint16
  • time -- uint32
  • time_remaining -- uint32

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.

BrickletIndustrialDigitalOut4.set_group
Funktions ID:

5

Anfrage:
  • group -- char[4]
Antwort:

keine Antwort

Setzt eine Gruppe von Digital Out 4 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 Digital Out 4 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.

BrickletIndustrialDigitalOut4.get_group
Funktions ID:

6

Anfrage:

keine Nutzdaten

Antwort:
  • group -- char[4]

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

BrickletIndustrialDigitalOut4.get_available_for_group
Funktions ID:

7

Anfrage:

keine Nutzdaten

Antwort:
  • available -- uint8

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.

BrickletIndustrialDigitalOut4.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

BrickletIndustrialDigitalOut4.CALLBACK_MONOFLOP_DONE
Funktions ID:

8

Antwort:
  • selection_mask -- uint16
  • value_mask -- uint16

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).