TCP/IP - Industrial Digital In 4 Bricklet

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

API

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

Grundfunktionen

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

Gibt die Ausgabewerte mit einer Bitmaske zurück. Die Bitmaske ist 16Bit lang. true bedeutet logisch 1 und false logisch 0.

Zum Beispiel: Der Wert 3 bzw. 0b0011 bedeutet, dass die Pins 0-1 auf logisch 1 und alle anderen auf logisch 0 sind.

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

BrickletIndustrialDigitalIn4.get_edge_count
Funktions-ID:
  • 10
Anfrage:
  • pin – Typ: uint8, Wertebereich: [0 bis 3]
  • reset_counter – Typ: bool
Antwort:
  • count – Typ: uint32, Wertebereich: [0 bis 232 - 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.

Die Flankenzähler benutzen die Gruppierung, wie von set_group gesetzt.

Neu in Version 2.0.1 (Plugin).

Fortgeschrittene Funktionen

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

Setzt eine Gruppe von Digital In 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 In 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 get_value beide Bricklets gleichzeitig auszulesen.

Änderungen an der Gruppeneinteilung setzt die Konfiguration und Zählerwerte aller Flankenzähler zurück.

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

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

BrickletIndustrialDigitalIn4.get_available_for_group
Funktions-ID:
  • 4
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.

BrickletIndustrialDigitalIn4.set_edge_count_config
Funktions-ID:
  • 11
Anfrage:
  • selection_mask – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • 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. Eine Bitmaske von 9 bzw. 0b1001 aktiviert den Flankenzähler für die Pins 0 und 3.

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

Die Flankenzähler benutzen die Gruppierung, wie von set_group gesetzt.

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

Für edge_type:

  • 0 = Rising
  • 1 = Falling
  • 2 = Both

Neu in Version 2.0.1 (Plugin).

BrickletIndustrialDigitalIn4.get_edge_count_config
Funktions-ID:
  • 12
Anfrage:
  • pin – Typ: uint8, Wertebereich: [0 bis 255]
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.

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

Für edge_type:

  • 0 = Rising
  • 1 = Falling
  • 2 = Both

Neu in Version 2.0.1 (Plugin).

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

Konfigurationsfunktionen für Callbacks

BrickletIndustrialDigitalIn4.set_debounce_period
Funktions-ID:
  • 5
Anfrage:
  • debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 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 Digital In 4 Bricklet angeschlossen ist, wie z.B. einen Schalter.

BrickletIndustrialDigitalIn4.get_debounce_period
Funktions-ID:
  • 6
Anfrage:
  • keine Nutzdaten
Antwort:
  • debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

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

BrickletIndustrialDigitalIn4.set_interrupt
Funktions-ID:
  • 7
Anfrage:
  • interrupt_mask – Typ: uint16, Wertebereich: [0 bis 216 - 1]
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 9 bzw. 0b1001 aktiviert den Interrupt für die Pins 0 und 3.

Die Interrupts benutzen die Gruppierung, wie von set_group gesetzt.

Der Interrupt wird mit dem CALLBACK_INTERRUPT Callback zugestellt.

BrickletIndustrialDigitalIn4.get_interrupt
Funktions-ID:
  • 8
Anfrage:
  • keine Nutzdaten
Antwort:
  • interrupt_mask – Typ: uint16, Wertebereich: [0 bis 216 - 1]

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

Callbacks

BrickletIndustrialDigitalIn4.CALLBACK_INTERRUPT
Funktions-ID:
  • 9
Antwort:
  • interrupt_mask – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • value_mask – Typ: uint16, Wertebereich: [0 bis 216 - 1]

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.

Die Interrupts benutzen die Gruppierung, wie von set_group gesetzt.