Software / API Bindings / Python / API Referenz und Beispiele / Bricklets / Industrial Digital In 4 Bricklet 2.0

Python - Industrial Digital In 4 Bricklet 2.0¶

Dies ist die Beschreibung der Python API Bindings 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.

Eine Installationanleitung für die Python API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple¶

Download (example_simple.py)

#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_industrial_digital_in_4_v2 import BrickletIndustrialDigitalIn4V2

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    idi4 = BrickletIndustrialDigitalIn4V2(UID, ipcon) # Create device object

    ipcon.connect(HOST, PORT) # Connect to brickd
    # Don't use device before ipcon is connected

    # Get current value
    value = idi4.get_value()

    print("Channel 0: " + str(value[0]))
    print("Channel 1: " + str(value[1]))
    print("Channel 2: " + str(value[2]))
    print("Channel 3: " + str(value[3]))

    input("Press key to exit\n") # Use raw_input() in Python 2
    ipcon.disconnect()

Edge Count¶

Download (example_edge_count.py)

#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0

import time

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_industrial_digital_in_4_v2 import BrickletIndustrialDigitalIn4V2

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    idi4 = BrickletIndustrialDigitalIn4V2(UID, ipcon) # Create device object

    ipcon.connect(HOST, PORT) # Connect to brickd
    # Don't use device before ipcon is connected

    # Configure rising edge count (channel 3) with 10ms debounce
    idi4.set_edge_count_configuration(3, 0, 10)

    # Get edge count 10 times with 1s delay
    for i in range(10):
        time.sleep(1)

        # Get current edge count
        count = idi4.get_edge_count(3, False)
        print("Count: " + str(count))

    input("Press key to exit\n") # Use raw_input() in Python 2
    ipcon.disconnect()

Callback¶

Download (example_callback.py)

#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_industrial_digital_in_4_v2 import BrickletIndustrialDigitalIn4V2

# Callback function for value callback
def cb_value(channel, changed, value):
    if channel == BrickletIndustrialDigitalIn4V2.CHANNEL_0:
        print("Channel: 0")
    elif channel == BrickletIndustrialDigitalIn4V2.CHANNEL_1:
        print("Channel: 1")
    elif channel == BrickletIndustrialDigitalIn4V2.CHANNEL_2:
        print("Channel: 2")
    elif channel == BrickletIndustrialDigitalIn4V2.CHANNEL_3:
        print("Channel: 3")

    print("Changed: " + str(changed))
    print("Value: " + str(value))
    print("")

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    idi4 = BrickletIndustrialDigitalIn4V2(UID, ipcon) # Create device object

    ipcon.connect(HOST, PORT) # Connect to brickd
    # Don't use device before ipcon is connected

    # Register value callback to function cb_value
    idi4.register_callback(idi4.CALLBACK_VALUE, cb_value)

    # Set period for value (channel 1) callback to 0.1s (100ms)
    idi4.set_value_callback_configuration(1, 100, False)

    input("Press key to exit\n") # Use raw_input() in Python 2
    ipcon.disconnect()

API¶

Prinzipiell kann jede Funktion der Python Bindings tinkerforge.ip_connection.Error Exception werfen, welche ein value und eine description Property hat. value kann verschiende Werte haben:

Error.TIMEOUT = -1
Error.NOT_ADDED = -6 (seit Python Bindings Version 2.0.0 nicht mehr verwendet)
Error.ALREADY_CONNECTED = -7
Error.NOT_CONNECTED = -8
Error.INVALID_PARAMETER = -9
Error.NOT_SUPPORTED = -10
Error.UNKNOWN_ERROR_CODE = -11
Error.STREAM_OUT_OF_SYNC = -12
Error.INVALID_UID = -13
Error.NON_ASCII_CHAR_IN_SECRET = -14
Error.WRONG_DEVICE_TYPE = -15
Error.DEVICE_REPLACED = -16
Error.WRONG_RESPONSE_LENGTH = -17

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

BrickletIndustrialDigitalIn4V2(uid, ipcon)¶

Parameter:	uid – Typ: str ipcon – Typ: IPConnection
Rückgabe:	industrial_digital_in_4_v2 – Typ: BrickletIndustrialDigitalIn4V2

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

industrial_digital_in_4_v2 = BrickletIndustrialDigitalIn4V2("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

BrickletIndustrialDigitalIn4V2.get_value()¶

Rückgabe:	value – Typ: [bool, ...], Länge: 4

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

BrickletIndustrialDigitalIn4V2.set_channel_led_config(channel, config)¶

Parameter:	channel – Typ: int, Wertebereich: Siehe Konstanten config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	None

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 Konstanten sind für diese Funktion verfügbar:

Für channel:

BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3

Für config:

BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_OFF = 0
BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_ON = 1
BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

BrickletIndustrialDigitalIn4V2.get_channel_led_config(channel)¶

Parameter:	channel – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für channel:

BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3

Für config:

BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_OFF = 0
BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_ON = 1
BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Fortgeschrittene Funktionen¶

BrickletIndustrialDigitalIn4V2.get_edge_count(channel, reset_counter)¶

Parameter:	channel – Typ: int, Wertebereich: Siehe Konstanten reset_counter – Typ: bool
Rückgabe:	count – Typ: int, Wertebereich: [0 bis 2³² - 1]

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 Konstanten sind für diese Funktion verfügbar:

Für channel:

BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3

BrickletIndustrialDigitalIn4V2.set_edge_count_configuration(channel, edge_type, debounce)¶

Parameter:	channel – Typ: int, Wertebereich: Siehe Konstanten edge_type – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100
Rückgabe:	None

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
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 folgenden Konstanten sind für diese Funktion verfügbar:

Für channel:

BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3

Für edge_type:

BrickletIndustrialDigitalIn4V2.EDGE_TYPE_RISING = 0
BrickletIndustrialDigitalIn4V2.EDGE_TYPE_FALLING = 1
BrickletIndustrialDigitalIn4V2.EDGE_TYPE_BOTH = 2

BrickletIndustrialDigitalIn4V2.get_edge_count_configuration(channel)¶

Parameter:	channel – Typ: int, Wertebereich: Siehe Konstanten
Rückgabeobjekt:	edge_type – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

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

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für channel:

BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3

Für edge_type:

BrickletIndustrialDigitalIn4V2.EDGE_TYPE_RISING = 0
BrickletIndustrialDigitalIn4V2.EDGE_TYPE_FALLING = 1
BrickletIndustrialDigitalIn4V2.EDGE_TYPE_BOTH = 2

BrickletIndustrialDigitalIn4V2.get_spitfp_error_count()¶

Rückgabeobjekt:	error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 2³² - 1] error_count_message_checksum – Typ: int, Wertebereich: [0 bis 2³² - 1] error_count_frame – Typ: int, Wertebereich: [0 bis 2³² - 1] error_count_overflow – Typ: int, Wertebereich: [0 bis 2³² - 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.

BrickletIndustrialDigitalIn4V2.set_status_led_config(config)¶

Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	None

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 Konstanten sind für diese Funktion verfügbar:

Für config:

BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_OFF = 0
BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_ON = 1
BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletIndustrialDigitalIn4V2.get_status_led_config()¶

Rückgabe:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für config:

BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_OFF = 0
BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_ON = 1
BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletIndustrialDigitalIn4V2.get_chip_temperature()¶

Rückgabe:	temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 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.

BrickletIndustrialDigitalIn4V2.reset()¶

Rückgabe:	None

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.get_identity()¶

Rückgabeobjekt:

Rückgabeobjekt:	uid – Typ: str, Länge: bis zu 8 connected_uid – Typ: str, Länge: bis zu 8 position – Typ: chr, Wertebereich: ["a" bis "h", "z"] hardware_version – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255] firmware_version – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255] device_identifier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

uid – Typ: str, Länge: bis zu 8
connected_uid – Typ: str, Länge: bis zu 8
position – Typ: chr, Wertebereich: ["a" bis "h", "z"]
hardware_version – Typ: [int, ...], Länge: 3

0: major – Typ: int, Wertebereich: [0 bis 255]
1: minor – Typ: int, Wertebereich: [0 bis 255]
2: revision – Typ: int, Wertebereich: [0 bis 255]

firmware_version – Typ: [int, ...], Länge: 3

0: major – Typ: int, Wertebereich: [0 bis 255]
1: minor – Typ: int, Wertebereich: [0 bis 255]
2: revision – Typ: int, Wertebereich: [0 bis 255]

device_identifier – Typ: int, 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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks¶

BrickletIndustrialDigitalIn4V2.register_callback(callback_id, function)¶

Parameter:	callback_id – Typ: int function – Typ: callable
Rückgabe:	None

Registriert die function für die gegebene callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

BrickletIndustrialDigitalIn4V2.set_value_callback_configuration(channel, period, value_has_to_change)¶

Parameter:	channel – Typ: int, Wertebereich: Siehe Konstanten period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: False
Rückgabe:	None

Dieser Callback kann pro Kanal konfiguriert werden.

Die Periode 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.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für channel:

BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3

BrickletIndustrialDigitalIn4V2.get_value_callback_configuration(channel)¶

Parameter:	channel – Typ: int, Wertebereich: Siehe Konstanten
Rückgabeobjekt:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: False

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

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für channel:

BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3

BrickletIndustrialDigitalIn4V2.set_all_value_callback_configuration(period, value_has_to_change)¶

Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: False
Rückgabe:	None

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

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

BrickletIndustrialDigitalIn4V2.get_all_value_callback_configuration()¶

Rückgabeobjekt:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: False

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

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion register_callback() des Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID und der zweite Parameter die Callback-Funktion:

def my_callback(param):
    print(param)

industrial_digital_in_4_v2.register_callback(BrickletIndustrialDigitalIn4V2.CALLBACK_EXAMPLE, my_callback)

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

BrickletIndustrialDigitalIn4V2.CALLBACK_VALUE¶

Callback-Parameter:	channel – Typ: int, Wertebereich: Siehe Konstanten changed – Typ: bool value – Typ: bool

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

Die Parameter 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 Konstanten sind für diese Funktion verfügbar:

Für channel:

BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3

BrickletIndustrialDigitalIn4V2.CALLBACK_ALL_VALUE¶

Callback-Parameter:	changed – Typ: [bool, ...], Länge: 4 value – Typ: [bool, ...], Länge: 4

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

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

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

BrickletIndustrialDigitalIn4V2.get_api_version()¶

Rückgabeobjekt:	api_version – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255]

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

BrickletIndustrialDigitalIn4V2.get_response_expected(function_id)¶

Parameter:	function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	response_expected – Typ: bool

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels set_response_expected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für function_id:

BrickletIndustrialDigitalIn4V2.FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
BrickletIndustrialDigitalIn4V2.FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
BrickletIndustrialDigitalIn4V2.FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7
BrickletIndustrialDigitalIn4V2.FUNCTION_SET_CHANNEL_LED_CONFIG = 9
BrickletIndustrialDigitalIn4V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletIndustrialDigitalIn4V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletIndustrialDigitalIn4V2.FUNCTION_RESET = 243
BrickletIndustrialDigitalIn4V2.FUNCTION_WRITE_UID = 248

BrickletIndustrialDigitalIn4V2.set_response_expected(function_id, response_expected)¶

Parameter:	function_id – Typ: int, Wertebereich: Siehe Konstanten response_expected – Typ: bool
Rückgabe:	None

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für function_id:

BrickletIndustrialDigitalIn4V2.FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
BrickletIndustrialDigitalIn4V2.FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
BrickletIndustrialDigitalIn4V2.FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7
BrickletIndustrialDigitalIn4V2.FUNCTION_SET_CHANNEL_LED_CONFIG = 9
BrickletIndustrialDigitalIn4V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletIndustrialDigitalIn4V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletIndustrialDigitalIn4V2.FUNCTION_RESET = 243
BrickletIndustrialDigitalIn4V2.FUNCTION_WRITE_UID = 248

BrickletIndustrialDigitalIn4V2.set_response_expected_all(response_expected)¶

Parameter:	response_expected – Typ: bool
Rückgabe:	None

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

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.

BrickletIndustrialDigitalIn4V2.set_bootloader_mode(mode)¶

Parameter:	mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	status – Typ: int, Wertebereich: Siehe Konstanten

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 Konstanten sind für diese Funktion verfügbar:

Für mode:

BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_BOOTLOADER = 0
BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_FIRMWARE = 1
BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

BrickletIndustrialDigitalIn4V2.BOOTLOADER_STATUS_OK = 0
BrickletIndustrialDigitalIn4V2.BOOTLOADER_STATUS_INVALID_MODE = 1
BrickletIndustrialDigitalIn4V2.BOOTLOADER_STATUS_NO_CHANGE = 2
BrickletIndustrialDigitalIn4V2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BrickletIndustrialDigitalIn4V2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BrickletIndustrialDigitalIn4V2.BOOTLOADER_STATUS_CRC_MISMATCH = 5

BrickletIndustrialDigitalIn4V2.get_bootloader_mode()¶

Rückgabe:	mode – Typ: int, Wertebereich: Siehe Konstanten

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

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für mode:

BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_BOOTLOADER = 0
BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_FIRMWARE = 1
BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

BrickletIndustrialDigitalIn4V2.set_write_firmware_pointer(pointer)¶

Parameter:	pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	None

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(data)¶

Parameter:	data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:	status – Typ: int, 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.

BrickletIndustrialDigitalIn4V2.write_uid(uid)¶

Parameter:	uid – Typ: int, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	None

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()¶

Rückgabe:	uid – Typ: int, Wertebereich: [0 bis 2³² - 1]

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

Konstanten¶

BrickletIndustrialDigitalIn4V2.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Industrial Digital In 4 Bricklet 2.0 zu identifizieren.

Die get_identity() Funktion und der IPConnection.CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletIndustrialDigitalIn4V2.DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Industrial Digital In 4 Bricklet 2.0 dar.