Modbus - Industrial Digital Out 4 Bricklet 2.0¶

Grundfunktionen¶

BrickletIndustrialDigitalOut4V2.set_value¶

Funktions-ID:	1
Anfrage:	value – Typ: bool[4]
Antwort:	keine Antwort

Setzt den Zustand aller vier Kanäle. Der Wert true bzw. false erzeugen logisch 1 bzw. logisch 0 auf dem entsprechenden Kanal.

Mittels set_selected_value können auch einzelnen Kanäle gesetzt werden.

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

Beispiel: (True, True, False, False) setzt die Kanäle 0-1 auf logisch 1 und die Kanäle 2-3 auf logisch 0.

BrickletIndustrialDigitalOut4V2.get_value¶

Funktions-ID:	2
Anfrage:	keine Nutzdaten
Antwort:	value – Typ: bool[4]

Gibt die aktuellen Zustände der Kanäle zurück.

BrickletIndustrialDigitalOut4V2.set_selected_value¶

Funktions-ID:	3
Anfrage:	channel – Typ: uint8, Wertebereich: [0 bis 3] value – Typ: bool
Antwort:	keine Antwort

Setzt den Ausgabewert des spezifizierten Kanals ohne die anderen Kanäle zu beeinflussen.

Ein laufender Monoflop Timer oder PWM für den spezifizierten Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.

BrickletIndustrialDigitalOut4V2.set_channel_led_config¶

Funktions-ID:	7
Anfrage:	channel – Typ: uint8, Wertebereich: [0 bis 3] config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3
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.

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

Für config:

• 0 = Off
• 1 = On
• 2 = Show Heartbeat
• 3 = Show Channel Status

BrickletIndustrialDigitalOut4V2.get_channel_led_config¶

Funktions-ID:	8
Anfrage:	channel – Typ: uint8, Wertebereich: [0 bis 3]
Antwort:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3

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

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

Für config:

• 0 = Off
• 1 = On
• 2 = Show Heartbeat
• 3 = Show Channel Status

Fortgeschrittene Funktionen¶

BrickletIndustrialDigitalOut4V2.set_monoflop¶

Funktions-ID:	4
Anfrage:	channel – Typ: uint8, Wertebereich: [0 bis 3] value – Typ: bool time – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]
Antwort:	keine Antwort

Der erste Parameter ist der gewünschte Zustand des Kanals (true bedeutet high und false low). Der zweite Parameter stellt die Zeit dar, in welcher der Kanal den Zustand halten soll.

Wenn diese Funktion mit den Parametern (true, 1500) aufgerufen wird: Der Kanal wird angeschaltet und nach 1,5s wieder ausgeschaltet.

Ein PWM für den ausgewählten Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.

Ein Monoflop kann als 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 Kanal wird die gesamte Zeit eingeschaltet sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird der Kanal nach spätestens zwei Sekunden ausschalten.

BrickletIndustrialDigitalOut4V2.get_monoflop¶

Funktions-ID:	5
Anfrage:	channel – Typ: uint8, Wertebereich: [0 bis 3]
Antwort:	value – Typ: bool time – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] time_remaining – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

Gibt (für den angegebenen Kanal) 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.

BrickletIndustrialDigitalOut4V2.set_pwm_configuration¶

Funktions-ID:	9
Anfrage:	channel – Typ: uint8, Wertebereich: [0 bis 3] frequency – Typ: uint32, Einheit: 1/10 Hz, Wertebereich: [0 bis 232 - 1], Standardwert: 0 duty_cycle – Typ: uint16, Einheit: 1/100 %, Wertebereich: [0 bis 10000], Standardwert: 0
Antwort:	keine Antwort

Aktiviert ein PWM auf dem angegebenen Kanal.

Um die PWM wieder auszustellen, kann die Frequenz auf 0 gesetzt werden oder eine andere Funktion aufgerufen werden die Einstellungen am Kanal verändert (z.B. set_selected_value).

Der auf dem Industrial Digital Out 4 Bricklet 2.0 verwendete Optokoppler hat eine Anstiegszeit und Abfallzeit von jeweils 11.5us bei einer Spannung von 24V. Dadurch ist ergibt sich ein maximaler Frequenzwert von ca. 400000 (40kHz).

Ein laufender Monoflop Timer für den angegebenen Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.

BrickletIndustrialDigitalOut4V2.get_pwm_configuration¶

Funktions-ID:	10
Anfrage:	channel – Typ: uint8, Wertebereich: [0 bis 3]
Antwort:	frequency – Typ: uint32, Einheit: 1/10 Hz, Wertebereich: [0 bis 232 - 1], Standardwert: 0 duty_cycle – Typ: uint16, Einheit: 1/100 %, Wertebereich: [0 bis 10000], Standardwert: 0

Gibt die PWM Konfiguration zurück, wie von set_pwm_configuration gesetzt.

BrickletIndustrialDigitalOut4V2.get_spitfp_error_count¶

Funktions-ID:	234
Anfrage:	keine Nutzdaten
Antwort:	error_count_ack_checksum – Typ: uint32, Wertebereich: [0 bis 232 - 1] error_count_message_checksum – Typ: uint32, Wertebereich: [0 bis 232 - 1] error_count_frame – Typ: uint32, Wertebereich: [0 bis 232 - 1] error_count_overflow – Typ: uint32, Wertebereich: [0 bis 232 - 1]

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.

BrickletIndustrialDigitalOut4V2.set_status_led_config¶

Funktions-ID:	239
Anfrage:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3
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 Elemente dieser Funktion definiert:

Für config:

• 0 = Off
• 1 = On
• 2 = Show Heartbeat
• 3 = Show Status

BrickletIndustrialDigitalOut4V2.get_status_led_config¶

Funktions-ID:	240
Anfrage:	keine Nutzdaten
Antwort:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3

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

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

Für config:

• 0 = Off
• 1 = On
• 2 = Show Heartbeat
• 3 = Show Status

BrickletIndustrialDigitalOut4V2.get_chip_temperature¶

Funktions-ID:	242
Anfrage:	keine Nutzdaten
Antwort:	temperature – Typ: int16, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, 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.

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

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

Callbacks¶

BrickletIndustrialDigitalOut4V2.CALLBACK_MONOFLOP_DONE¶

Funktions-ID:	6
Antwort:	channel – Typ: uint8, Wertebereich: [0 bis 3] value – Typ: bool

Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Rückgabewerte enthalten den Kanal und den aktuellen Zustand des Kanals (der Zustand nach dem Monoflop).

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

BrickletIndustrialDigitalOut4V2.set_bootloader_mode¶

Funktions-ID:	235
Anfrage:	mode – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:	status – Typ: uint8, Wertebereich: Siehe Bedeutungen

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 Bootloader- 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 Elemente dieser Funktion definiert:

Für mode:

• 0 = Bootloader
• 1 = Firmware
• 2 = Bootloader Wait For Reboot
• 3 = Firmware Wait For Reboot
• 4 = Firmware Wait For Erase And Reboot

Für status:

• 0 = OK
• 1 = Invalid Mode
• 2 = No Change
• 3 = Entry Function Not Present
• 4 = Device Identifier Incorrect
• 5 = CRC Mismatch

BrickletIndustrialDigitalOut4V2.get_bootloader_mode¶

Funktions-ID:	236
Anfrage:	keine Nutzdaten
Antwort:	mode – Typ: uint8, Wertebereich: Siehe Bedeutungen

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

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

Für mode:

• 0 = Bootloader
• 1 = Firmware
• 2 = Bootloader Wait For Reboot
• 3 = Firmware Wait For Reboot
• 4 = Firmware Wait For Erase And Reboot

BrickletIndustrialDigitalOut4V2.set_write_firmware_pointer¶

Funktions-ID:	237
Anfrage:	pointer – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
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.

BrickletIndustrialDigitalOut4V2.write_firmware¶

Funktions-ID:	238
Anfrage:	data – Typ: uint8[64], Wertebereich: [0 bis 255]
Antwort:	status – Typ: uint8, Wertebereich: [0 bis 255]

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.

BrickletIndustrialDigitalOut4V2.write_uid¶

Funktions-ID:	248
Anfrage:	uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
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.

BrickletIndustrialDigitalOut4V2.read_uid¶

Funktions-ID:	249
Anfrage:	keine Nutzdaten
Antwort:	uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]

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