Modbus - Industrial Digital In 4 Bricklet 2.0

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

API

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen

BrickletIndustrialDigitalIn4V2.get_value
Funktions ID:

1

Anfrage:

keine Nutzdaten

Antwort:
  • value -- bool[4]

Gibt die Eingangswerte als Bools zurück, true bedeutet logisch 1 und false logisch 0.

BrickletIndustrialDigitalIn4V2.set_channel_led_config
Funktions ID:

9

Anfrage:
  • channel -- uint8
  • config -- uint8
Antwort:

keine Antwort

Jeder Kanal hat eine dazugehörige LED. Die LEDs können individuell an oder ausgeschaltet werden. Zusätzlich kann ein Heartbeat oder der Kanalstatus angezeigt werden. Falls Kanalstatus gewählt wird ist die LED an wenn ein High-Signal am Kanal anliegt und sonst aus.

Standardmäßig sind die LEDs für alle Kanäle auf Kanalstatus konfiguriert.

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

  • 0: 0, für channel
  • 1: 1, für channel
  • 2: 2, für channel
  • 3: 3, für channel
  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show channel status, für config
BrickletIndustrialDigitalIn4V2.get_channel_led_config
Funktions ID:

10

Anfrage:
  • channel -- uint8
Antwort:
  • config -- uint8

Gibt die Kanal-LED-Konfiguration zurück, wie von set_channel_led_config gesetzt.

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

  • 0: 0, für channel
  • 1: 1, für channel
  • 2: 2, für channel
  • 3: 3, für channel
  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show channel status, für config

Fortgeschrittene Funktionen

BrickletIndustrialDigitalIn4V2.get_edge_count
Funktions ID:

6

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

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

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

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

  • 0: 0, für channel
  • 1: 1, für channel
  • 2: 2, für channel
  • 3: 3, für channel
BrickletIndustrialDigitalIn4V2.set_edge_count_configuration
Funktions ID:

7

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

keine Antwort

Konfiguriert den Flankenzähler für einen bestimmten Kanal.

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden. 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).

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

  • 0: 0, für channel
  • 1: 1, für channel
  • 2: 2, für channel
  • 3: 3, für channel
  • 0: rising, für edge_type
  • 1: falling, für edge_type
  • 2: both, für edge_type
BrickletIndustrialDigitalIn4V2.get_edge_count_configuration
Funktions ID:

8

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

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

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

  • 0: 0, für channel
  • 1: 1, für channel
  • 2: 2, für channel
  • 3: 3, für channel
  • 0: rising, für edge_type
  • 1: falling, für edge_type
  • 2: both, für edge_type
BrickletIndustrialDigitalIn4V2.get_spitfp_error_count
Funktions ID:

234

Anfrage:

keine Nutzdaten

Antwort:
  • error_count_ack_checksum -- uint32
  • error_count_message_checksum -- uint32
  • error_count_frame -- uint32
  • error_count_overflow -- uint32

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

BrickletIndustrialDigitalIn4V2.set_bootloader_mode
Funktions ID:

235

Anfrage:
  • mode -- uint8
Antwort:
  • status -- uint8

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootlodaer- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

  • 0: bootloader, für mode
  • 1: firmware, für mode
  • 2: bootloader wait for reboot, für mode
  • 3: firmware wait for reboot, für mode
  • 4: firmware wait for erase and reboot, für mode
  • 0: ok, für status
  • 1: invalid mode, für status
  • 2: no change, für status
  • 3: entry function not present, für status
  • 4: device identifier incorrect, für status
  • 5: crc mismatch, für status
BrickletIndustrialDigitalIn4V2.get_bootloader_mode
Funktions ID:

236

Anfrage:

keine Nutzdaten

Antwort:
  • mode -- uint8

Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode.

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

  • 0: bootloader, für mode
  • 1: firmware, für mode
  • 2: bootloader wait for reboot, für mode
  • 3: firmware wait for reboot, für mode
  • 4: firmware wait for erase and reboot, für mode
BrickletIndustrialDigitalIn4V2.set_write_firmware_pointer
Funktions ID:

237

Anfrage:
  • pointer -- uint32
Antwort:

keine Antwort

Setzt den Firmware-Pointer für write_firmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletIndustrialDigitalIn4V2.write_firmware
Funktions ID:

238

Anfrage:
  • data -- uint8[64]
Antwort:
  • status -- uint8

Schreibt 64 Bytes Firmware an die Position die vorher von set_write_firmware_pointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletIndustrialDigitalIn4V2.set_status_led_config
Funktions ID:

239

Anfrage:
  • config -- uint8
Antwort:

keine Antwort

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show status, für config
BrickletIndustrialDigitalIn4V2.get_status_led_config
Funktions ID:

240

Anfrage:

keine Nutzdaten

Antwort:
  • config -- uint8

Gibt die Konfiguration zurück, wie von set_status_led_config gesetzt.

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

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show status, für config
BrickletIndustrialDigitalIn4V2.get_chip_temperature
Funktions ID:

242

Anfrage:

keine Nutzdaten

Antwort:
  • temperature -- int16

Gibt die Temperatur in °C, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

BrickletIndustrialDigitalIn4V2.reset
Funktions ID:243
Anfrage:keine Nutzdaten
Antwort:keine Antwort

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

BrickletIndustrialDigitalIn4V2.write_uid
Funktions ID:

248

Anfrage:
  • uid -- uint32
Antwort:

keine Antwort

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

BrickletIndustrialDigitalIn4V2.read_uid
Funktions ID:

249

Anfrage:

keine Nutzdaten

Antwort:
  • uid -- uint32

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

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

BrickletIndustrialDigitalIn4V2.set_value_callback_configuration
Funktions ID:

2

Anfrage:
  • channel -- uint8
  • period -- uint32
  • value_has_to_change -- bool
Antwort:

keine Antwort

Dieser Callback kann pro Kanal konfiguriert werden.

Die Periode in ms ist die Periode mit der der CALLBACK_VALUE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Der Standardwert ist (0, false).

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

  • 0: 0, für channel
  • 1: 1, für channel
  • 2: 2, für channel
  • 3: 3, für channel
BrickletIndustrialDigitalIn4V2.get_value_callback_configuration
Funktions ID:

3

Anfrage:
  • channel -- uint8
Antwort:
  • period -- uint32
  • value_has_to_change -- bool

Gibt die Callback-Konfiguration für den gegebenen Kanal zurück, wie mittels set_value_callback_configuration gesetzt.

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

  • 0: 0, für channel
  • 1: 1, für channel
  • 2: 2, für channel
  • 3: 3, für channel
BrickletIndustrialDigitalIn4V2.set_all_value_callback_configuration
Funktions ID:

4

Anfrage:
  • period -- uint32
  • value_has_to_change -- bool
Antwort:

keine Antwort

Dieser Callback kann pro Kanal konfiguriert werden.

Die Periode in ms ist die Periode mit der der CALLBACK_ALL_VALUE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Der Standardwert ist (0, false).

BrickletIndustrialDigitalIn4V2.get_all_value_callback_configuration
Funktions ID:

5

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32
  • value_has_to_change -- bool

Gibt die Callback-Konfiguration zurück, wie mittels set_all_value_callback_configuration gesetzt.

Callbacks

BrickletIndustrialDigitalIn4V2.CALLBACK_VALUE
Funktions ID:

11

Antwort:
  • channel -- uint8
  • changed -- bool
  • value -- bool

Dieser Callback wird periodisch ausgelöst abhängig von der mittels set_value_callback_configuration gesetzten Konfiguration

Die Rückgabewerte sind der Kanal, Changed und der Wert. Der changed-Parameter ist True wenn sich der Wert seit dem letzten Callback geändert hat.

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

  • 0: 0, für channel
  • 1: 1, für channel
  • 2: 2, für channel
  • 3: 3, für channel
BrickletIndustrialDigitalIn4V2.CALLBACK_ALL_VALUE
Funktions ID:

12

Antwort:
  • changed -- bool[4]
  • value -- bool[4]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels set_all_value_callback_configuration gesetzten Konfiguration

Die Rückgabewerte sind der gleiche wie get_value. Zusätzlich ist der changed-Parameter True wenn sich der Wert seit dem letzten Callback geändert hat.