Modbus - IO-16 Bricklet

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

API

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen

BrickletIO16.set_port
Funktions ID:

1

Anfrage:
  • port -- char
  • value_mask -- uint8
Antwort:

keine Antwort

Setzt den Ausgangszustand (logisch 1 oder logisch 0) für einen Port ("a" oder "b") mittels einer Bitmaske (8Bit). Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

Beispiel: Der Wert 15 bzw. 0b00001111 setzt die Pins 0-3 auf logisch 1 und die Pins 4-7 auf logisch 0.

Alle laufenden Monoflop Timer für den angegebenen Port 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_port_configuration zugeschaltet werden.

BrickletIO16.get_port
Funktions ID:

2

Anfrage:
  • port -- char
Antwort:
  • value_mask -- uint8

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

BrickletIO16.set_port_configuration
Funktions ID:

3

Anfrage:
  • port -- char
  • selection_mask -- uint8
  • direction -- char
  • value -- bool
Antwort:

keine Antwort

Konfiguriert den Zustand und die Richtung des angegebenen Ports. 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:

  • ('a', 255, 'i', true) bzw. ('a', 0b11111111, 'i', true) setzt alle Pins des Ports a als Eingang mit Pull-Up.
  • ('a', 128, 'i', false) bzw. ('a', 0b10000000, 'i', false) setzt Pin 7 des Ports A als Standard Eingang (potentialfrei wenn nicht verbunden).
  • ('b', 3, 'o', false) bzw. ('b', 0b00000011, 'o', false) setzt die Pins 0 und 1 des Ports B als Ausgang im Zustand logisch 0.
  • ('b', 4, 'o', true) bzw. ('b', 0b00000100, 'o', true) setzt Pin 2 des Ports B als Ausgang im Zustand logisch 1.

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

Die Standardkonfiguration ist Eingang mit Pull-Up.

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

  • i: in, für direction
  • o: out, für direction
BrickletIO16.get_port_configuration
Funktions ID:

4

Anfrage:
  • port -- char
Antwort:
  • direction_mask -- uint8
  • value_mask -- uint8

Gibt eine Bitmaske für die Richtung und eine Bitmaske für den Zustand der Pins des gewählten Ports 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 (15, 51) bzw. (0b00001111, 0b00110011) für Richtung und Zustand bedeutet:

  • Pin 0 und 1 sind als Eingang mit Pull-Up konfiguriert,
  • Pin 2 und 3 sind als Standard Eingang konfiguriert,
  • Pin 4 und 5 sind als Ausgang im Zustand logisch 1 konfiguriert
  • und Pin 6 und 7 sind als Ausgang im Zustand logisch 0 konfiguriert.
BrickletIO16.get_edge_count
Funktions ID:

14

Anfrage:
  • pin -- uint8
  • reset_counter -- bool
Antwort:
  • count -- uint32

Gibt den aktuellen Wert des Flankenzählers für den ausgewählten Pin von Port A 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.3 (Plugin).

Fortgeschrittene Funktionen

BrickletIO16.set_port_monoflop
Funktions ID:

10

Anfrage:
  • port -- char
  • selection_mask -- uint8
  • value_mask -- uint8
  • time -- uint32
Antwort:

keine Antwort

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

Der dritte Parameter ist eine Bitmaske mit den gewünschten Zuständen der festgelegten Ausgangspins. Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

Der vierte Parameter stellt die Zeit (in ms) dar, welche die Pins den Zustand halten sollen.

Wenn diese Funktion mit den Parametern ('a', 9, 1, 1500) bzw. ('a', 0b00001001, 0b00000001, 1500) aufgerufen wird: Pin 0 wird auf logisch 1 und Pin 3 auf logisch 0 am Port 'a' 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-16 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.

BrickletIO16.get_port_monoflop
Funktions ID:

11

Anfrage:
  • port -- char
  • pin -- uint8
Antwort:
  • value -- uint8
  • time -- uint32
  • time_remaining -- uint32

Gibt (für den angegebenen Pin) den aktuellen Zustand und die Zeit, wie von set_port_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.

BrickletIO16.set_selected_values
Funktions ID:

13

Anfrage:
  • port -- char
  • selection_mask -- uint8
  • value_mask -- uint8
Antwort:

keine Antwort

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

Beispiel: Die Parameter ('a', 192, 128) bzw. ('a', 0b11000000, 0b10000000) setzen den Pin 7 auf logisch 1 und den Pin 6 auf logisch 0 an Port A. Die Pins 0-6 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_port_configuration zugeschaltet werden.

BrickletIO16.set_edge_count_config
Funktions ID:

15

Anfrage:
  • pin -- uint8
  • edge_type -- uint8
  • debounce -- uint8
Antwort:

keine Antwort

Konfiguriert den Flankenzähler für den ausgewählten Pin von Port A. Der Flankenzähler steht für Pins 0 und 1 zur Verfügung.

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

Die Entprellzeit (debounce) wird in ms angegeben.

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.

Standardwerte: 0 (edge type) und 100ms (debounce).

Neu in Version 2.0.3 (Plugin).

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

  • 0: rising, für edge_type
  • 1: falling, für edge_type
  • 2: both, für edge_type
BrickletIO16.get_edge_count_config
Funktions ID:

16

Anfrage:
  • pin -- uint8
Antwort:
  • edge_type -- uint8
  • debounce -- uint8

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

Neu in Version 2.0.3 (Plugin).

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

  • 0: rising, für edge_type
  • 1: falling, für edge_type
  • 2: both, für edge_type
BrickletIO16.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. 

Konfigurationsfunktionen für Callbacks

BrickletIO16.set_debounce_period
Funktions ID:

5

Anfrage:
  • debounce -- uint32
Antwort:

keine Antwort

Setzt die Entprellperiode der CALLBACK_INTERRUPT Callback in ms.

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-16 Bricklet angeschlossen ist, wie z.B. eine Taste.

Der Standardwert ist 100.

BrickletIO16.get_debounce_period
Funktions ID:

6

Anfrage:

keine Nutzdaten

Antwort:
  • debounce -- uint32

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

BrickletIO16.set_port_interrupt
Funktions ID:

7

Anfrage:
  • port -- char
  • interrupt_mask -- uint8
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: ('a', 129) bzw. ('a', 0b10000001) aktiviert den Interrupt für die Pins 0 und 7 des Ports a.

Der Interrupt wird mit dem CALLBACK_INTERRUPT Callback zugestellt.

BrickletIO16.get_port_interrupt
Funktions ID:

8

Anfrage:
  • port -- char
Antwort:
  • interrupt_mask -- uint8

Gibt die Interrupt Bitmaske für den angegebenen Port zurück, wie von set_port_interrupt gesetzt.

Callbacks

BrickletIO16.CALLBACK_INTERRUPT
Funktions ID:

9

Antwort:
  • port -- char
  • interrupt_mask -- uint8
  • value_mask -- uint8

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

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

Beispiele:

  • ('a', 1, 1) bzw. ('a', 0b00000001, 0b00000001) bedeutet, dass an Port A ein Interrupt am Pin 0 aufgetreten ist und aktuell ist Pin 0 logisch 1 und die Pins 1-7 sind logisch 0.
  • ('b', 129, 254) bzw. ('b', 0b10000001, 0b11111110) bedeutet, dass an Port B Interrupts an den Pins 0 und 7 aufgetreten sind und aktuell ist Pin 0 logisch 0 und die Pins 1-7 sind logisch 1.
BrickletIO16.CALLBACK_MONOFLOP_DONE
Funktions ID:

12

Antwort:
  • port -- char
  • selection_mask -- uint8
  • value_mask -- uint8

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