Spezifikationen / Modbus Protokoll / API / Bricklets (Abgekündigt) / IO-4 Bricklet

Modbus - IO-4 Bricklet¶

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

API¶

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen¶

BrickletIO4.set_value¶

Funktions-ID:	1
Anfrage:	value_mask – Typ: uint8, Wertebereich: [0 bis 15]
Antwort:	keine Antwort

Setzt den Ausgangszustand (logisch 1 oder logisch 0) mittels einer Bitmaske (4Bit). Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

Beispiel: Der Wert 3 bzw. 0b0011 setzt die Pins 0-1 auf logisch 1 und die Pins 2-3 auf logisch 0.

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

Bemerkung

Diese Funktion bewirkt keine Änderung an Pins die als Eingang konfiguriert sind. Pull-Up Widerstände können mit set_configuration zugeschaltet werden.

BrickletIO4.get_value¶

Funktions-ID:	2
Anfrage:	keine Nutzdaten
Antwort:	value_mask – Typ: uint8, Wertebereich: [0 bis 15]

Gibt eine Bitmaske der aktuell gemessenen Zustände zurück. Diese Funktion gibt die Zustände aller Pins zurück, unabhängig ob diese als Ein- oder Ausgang konfiguriert sind.

BrickletIO4.set_configuration¶

Funktions-ID:	3
Anfrage:	selection_mask – Typ: uint8, Wertebereich: [0 bis 15] direction – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'i' value – Typ: bool, Standardwert: true
Antwort:	keine Antwort

Konfiguriert den Zustand und die Richtung eines angegebenen Pins. Mögliche Richtungen sind 'i' und 'o' für Ein- und Ausgang.

Wenn die Richtung als Ausgang konfiguriert ist, ist der Zustand entweder logisch 1 oder logisch 0 (gesetzt als true oder false).

Wenn die Richtung als Eingang konfiguriert ist, ist der Zustand entweder Pull-Up oder Standard (gesetzt als true oder false).

Beispiele:

(15, 'i', true) bzw. (0b1111, 'i', true) setzt alle Pins als Eingang mit Pull-Up.
(8, 'i', false) bzw. (0b1000, 'i', false) setzt Pin 3 als Standard Eingang (potentialfrei wenn nicht verbunden).
(3, 'o', false) bzw. (0b0011, 'o', false) setzt die Pins 0 und 1 als Ausgang im Zustand logisch 0.
(4, 'o', true) bzw. (0b0100, 'o', true) setzt Pin 2 als Ausgang im Zustand logisch 1.

Laufende Monoflop Timer für die angegebenen Pins werden abgebrochen, wenn diese Funktion aufgerufen wird.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für direction:

'i' = In
'o' = Out

BrickletIO4.get_configuration¶

Funktions-ID:	4
Anfrage:	keine Nutzdaten
Antwort:	direction_mask – Typ: uint8, Wertebereich: [0 bis 15] value_mask – Typ: uint8, Wertebereich: [0 bis 15]

Gibt eine Bitmaske für die Richtung und eine Bitmaske für den Zustand der Pins zurück. Eine 1 in der Bitmaske für die Richtung bedeutet Eingang und eine 0 in der Bitmaske bedeutet Ausgang.

Beispiel: Ein Rückgabewert von (3, 5) bzw. (0b0011, 0b0101) für Richtung und Zustand bedeutet:

Pin 0 ist als Eingang mit Pull-Up konfiguriert,
Pin 1 ist als Standard Eingang konfiguriert,
Pin 2 ist als Ausgang im Zustand logisch 1 konfiguriert und
Pin 3 ist als Ausgang im Zustand logisch 0 konfiguriert.

BrickletIO4.get_edge_count¶

Funktions-ID:	14
Anfrage:	pin – Typ: uint8, Wertebereich: [0 bis 3] reset_counter – Typ: bool
Antwort:	count – Typ: uint32, Wertebereich: [0 bis 2³² - 1]

Gibt den aktuellen Wert des Flankenzählers für den ausgewählten Pin zurück. Die zu zählenden Flanken können mit set_edge_count_config konfiguriert werden.

Wenn reset counter auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurückgesetzt.

Neu in Version 2.0.1 (Plugin).

Fortgeschrittene Funktionen¶

BrickletIO4.set_monoflop¶

Funktions-ID:	10
Anfrage:	selection_mask – Typ: uint8, Wertebereich: [0 bis 15] value_mask – Typ: uint8, Wertebereich: [0 bis 15] time – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1]
Antwort:	keine Antwort

Konfiguriert einen Monoflop für die Pins, wie mittels der 4 Bit langen Bitmaske des ersten Parameters festgelegt. Die festgelegten Pins müssen als Ausgänge konfiguriert sein. Als Eingänge konfigurierte Pins werden ignoriert.

Der zweite Parameter ist eine Bitmaske mit den gewünschten Zustanden der festgelegten Ausgangspins. Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

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 logisch 1 und Pin 3 auf logisch 0 gesetzt. Nach 1,5s wird Pin 0 wieder logisch 0 und Pin 3 logisch 1 gesetzt.

Ein Monoflop kann zur Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein IO-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.

BrickletIO4.get_monoflop¶

Funktions-ID:	11
Anfrage:	pin – Typ: uint8, Wertebereich: [0 bis 3]
Antwort:	value – Typ: uint8, Wertebereich: [0 bis 1] time – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1] time_remaining – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 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.

BrickletIO4.set_selected_values¶

Funktions-ID:	13
Anfrage:	selection_mask – Typ: uint8, Wertebereich: [0 bis 15] value_mask – Typ: uint8, Wertebereich: [0 bis 15]
Antwort:	keine Antwort

Setzt den Ausgangszustand (logisch 1 oder logisch 0) mittels einer Bitmaske, entsprechend der Selektionsmaske. Die Bitmaske hat eine Länge von 4 Bit, true bedeutet logisch 1 und false logisch 0.

Beispiel: Die Parameter (9, 4) bzw (0b0110, 0b0100) setzen den Pin 1 auf logisch 0 und den Pin 2 auf logisch 1. Die Pins 0 und 3 bleiben unangetastet.

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

Bemerkung

Diese Funktion bewirkt keine Änderung an Pins die als Eingang konfiguriert sind. Pull-Up Widerstände können mit set_configuration zugeschaltet werden.

BrickletIO4.set_edge_count_config¶

Funktions-ID:	15
Anfrage:	selection_mask – Typ: uint8, Wertebereich: [0 bis 15] edge_type – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0 debounce – Typ: uint8, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100
Antwort:	keine Antwort

Konfiguriert den Flankenzähler für die ausgewählten Pins.

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden für Pins die als Eingang konfiguriert sind. Mögliche Flankentypen sind:

0 = steigend (Standard)
1 = fallend
2 = beide

Durch das Konfigurieren wird der Wert des Flankenzählers auf 0 zurückgesetzt.

Falls unklar ist was dies alles bedeutet, kann diese Funktion einfach ignoriert werden. Die Standardwerte sind in fast allen Situationen OK.

Neu in Version 2.0.1 (Plugin).

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für edge_type:

0 = Rising
1 = Falling
2 = Both

BrickletIO4.get_edge_count_config¶

Funktions-ID:	16
Anfrage:	pin – Typ: uint8, Wertebereich: [0 bis 3]
Antwort:	edge_type – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0 debounce – Typ: uint8, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

Gibt den Flankentyp sowie die Entprellzeit für den ausgewählten Pin zurück, wie von set_edge_count_config gesetzt.

Neu in Version 2.0.1 (Plugin).

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für edge_type:

0 = Rising
1 = Falling
2 = Both

BrickletIO4.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', '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 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.

Konfigurationsfunktionen für Callbacks¶

BrickletIO4.set_debounce_period¶

Funktions-ID:	5
Anfrage:	debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100
Antwort:	keine Antwort

Setzt die Entprellperiode der CALLBACK_INTERRUPT Callback.

Beispiel: Wenn dieser Wert auf 100 gesetzt wird, erhält man den Interrupt maximal alle 100ms. Dies ist notwendig falls etwas prellendes an das IO-4 Bricklet angeschlossen ist, wie z.B. eine Taste.

BrickletIO4.get_debounce_period¶

Funktions-ID:	6
Anfrage:	keine Nutzdaten
Antwort:	debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von set_debounce_period gesetzt.

BrickletIO4.set_interrupt¶

Funktions-ID:	7
Anfrage:	interrupt_mask – Typ: uint8, Wertebereich: [0 bis 15]
Antwort:	keine Antwort

Setzt durch eine Bitmaske die Pins für welche der Interrupt aktiv ist. Interrupts werden ausgelöst bei Änderung des Spannungspegels eines Pins, z.B. ein Wechsel von logisch 1 zu logisch 0 und logisch 0 zu logisch 1.

Beispiel: Eine Interrupt Bitmaske von 10 bzw. 0b1010 aktiviert den Interrupt für die Pins 1 und 3.

Der Interrupt wird mit dem CALLBACK_INTERRUPT Callback zugestellt.

BrickletIO4.get_interrupt¶

Funktions-ID:	8
Anfrage:	keine Nutzdaten
Antwort:	interrupt_mask – Typ: uint8, Wertebereich: [0 bis 15]

Gibt die Interrupt Bitmaske zurück, wie von set_interrupt gesetzt.

Callbacks¶

BrickletIO4.CALLBACK_INTERRUPT¶

Funktions-ID:	9
Antwort:	interrupt_mask – Typ: uint8, Wertebereich: [0 bis 15] value_mask – Typ: uint8, Wertebereich: [0 bis 15]

Dieser Callback wird ausgelöst sobald eine Änderung des Spannungspegels detektiert wird, an Pins für welche der Interrupt mit set_interrupt aktiviert wurde.

Die Rückgabewerte sind eine Bitmaske der aufgetretenen Interrupts und der aktuellen Zustände.

Beispiele:

(1, 1) bzw. (0b0001, 0b0001) bedeutet, dass ein Interrupt am Pin 0 aufgetreten ist und aktuell Pin 0 logisch 1 ist und die Pins 1-3 logisch 0 sind.
(9, 14) bzw. (0b1001, 0b1110) bedeutet, dass Interrupts an den Pins 0 und 3 aufgetreten sind und aktuell Pin 0 logisch 0 ist und die Pins 1-3 logisch 1 sind.

BrickletIO4.CALLBACK_MONOFLOP_DONE¶

Funktions-ID:	12
Antwort:	selection_mask – Typ: uint8, Wertebereich: [0 bis 15] value_mask – Typ: uint8, Wertebereich: [0 bis 15]

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