Python - IO-4 Bricklet

Dies ist die Beschreibung der Python API Bindings für das IO-4 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des IO-4 Bricklet 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).

Input

Download (example_input.py)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your IO-4 Bricklet

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_io4 import BrickletIO4

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

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

    # Get current value as bitmask
    value_mask = io.get_value()
    print("Value Mask: " + format(value_mask, "04b"))

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

Output

Download (example_output.py)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your IO-4 Bricklet

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_io4 import BrickletIO4

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

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

    # Set pin 1 to output low
    io.set_configuration(1 << 1, "o", False)

    # Set pin 2 and 3 to output high
    io.set_configuration((1 << 2) | (1 << 3), "o", True)

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

Interrupt

Download (example_interrupt.py)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your IO-4 Bricklet

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_io4 import BrickletIO4

# Callback function for interrupt callback
def cb_interrupt(interrupt_mask, value_mask):
    print("Interrupt Mask: " + format(interrupt_mask, "04b"))
    print("Value Mask: " + format(value_mask, "04b"))
    print("")

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

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

    # Register interrupt callback to function cb_interrupt
    io.register_callback(io.CALLBACK_INTERRUPT, cb_interrupt)

    # Enable interrupt on pin 0
    io.set_interrupt(1 << 0)

    raw_input("Press key to exit\n") # Use input() in Python 3
    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.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

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

BrickletIO4(uid, ipcon)
Parameter:
  • uid -- string
  • ipcon -- IPConnection

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

io4 = BrickletIO4("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

BrickletIO4.set_value(value_mask)
Parameter:value_mask -- int
Rückgabetyp:None

Setzt den Ausgangszustand (logisch 1 oder logisch 0) mittels einer Bitmaske (4Bit). Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

Beispiel: Der Wert 3 bzw. 0b0011 setzt die Pins 0-1 auf logisch 1 und die Pins 2-3 auf logisch 0.

Alle laufenden Monoflop Timer 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_configuration() zugeschaltet werden.

BrickletIO4.get_value()
Rückgabetyp:int

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

BrickletIO4.set_configuration(selection_mask, direction, value)
Parameter:
  • selection_mask -- int
  • direction -- chr
  • value -- bool
Rückgabetyp:

None

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

  • (15, 'i', true) bzw. (0b1111, 'i', true) setzt alle Pins als Eingang mit Pull-Up.
  • (8, 'i', false) bzw. (0b1000, 'i', false) setzt Pin 3 als Standard Eingang (potentialfrei wenn nicht verbunden).
  • (3, 'o', false) bzw. (0b0011, 'o', false) setzt die Pins 0 und 1 als Ausgang im Zustand logisch 0.
  • (4, 'o', true) bzw. (0b0100, 'o', true) setzt Pin 2 als Ausgang im Zustand logisch 1.

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

Die Standardkonfiguration ist Eingang mit Pull-Up.

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

  • BrickletIO4.DIRECTION_IN = 'i'
  • BrickletIO4.DIRECTION_OUT = 'o'
BrickletIO4.get_configuration()
Rückgabetyp:(int, int)

Gibt eine Bitmaske für die Richtung und eine Bitmaske für den Zustand der Pins 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 (3, 5) bzw. (0b0011, 0b0101) für Richtung und Zustand bedeutet:

  • Pin 0 ist als Eingang mit Pull-Up konfiguriert,
  • Pin 1 ist als Standard Eingang konfiguriert,
  • Pin 2 ist als Ausgang im Zustand logisch 1 konfiguriert und
  • Pin 3 ist als Ausgang im Zustand logisch 0 konfiguriert.

Das zurückgegebene namedtuple enthält die Variablen direction_mask und value_mask.

BrickletIO4.get_edge_count(pin, reset_counter)
Parameter:
  • pin -- int
  • reset_counter -- bool
Rückgabetyp:

int

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.

Neu in Version 2.0.1 (Plugin).

Fortgeschrittene Funktionen

BrickletIO4.set_monoflop(selection_mask, value_mask, time)
Parameter:
  • selection_mask -- int
  • value_mask -- int
  • time -- int
Rückgabetyp:

None

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

Der zweite Parameter ist eine Bitmaske mit den gewünschten Zustanden der festgelegten Ausgangspins. Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

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

Wenn diese Funktion mit den Parametern (9, 1, 1500) bzw. (0b1001, 0b0001, 1500) aufgerufen wird: Pin 0 wird auf logisch 1 und Pin 3 auf logisch 0 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-4 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.

BrickletIO4.get_monoflop(pin)
Parameter:pin -- int
Rückgabetyp:(int, int, int)

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

Das zurückgegebene namedtuple enthält die Variablen value, time und time_remaining.

BrickletIO4.set_selected_values(selection_mask, value_mask)
Parameter:
  • selection_mask -- int
  • value_mask -- int
Rückgabetyp:

None

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

Beispiel: Die Parameter (9, 4) bzw (0b0110, 0b0100) setzen den Pin 1 auf logisch 0 und den Pin 2 auf logisch 1. Die Pins 0 und 3 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_configuration() zugeschaltet werden.

BrickletIO4.set_edge_count_config(selection_mask, edge_type, debounce)
Parameter:
  • selection_mask -- int
  • edge_type -- int
  • debounce -- int
Rückgabetyp:

None

Konfiguriert den Flankenzähler für die ausgewählten Pins.

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

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

  • BrickletIO4.EDGE_TYPE_RISING = 0
  • BrickletIO4.EDGE_TYPE_FALLING = 1
  • BrickletIO4.EDGE_TYPE_BOTH = 2

Neu in Version 2.0.1 (Plugin).

BrickletIO4.get_edge_count_config(pin)
Parameter:pin -- int
Rückgabetyp:(int, int)

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

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

  • BrickletIO4.EDGE_TYPE_RISING = 0
  • BrickletIO4.EDGE_TYPE_FALLING = 1
  • BrickletIO4.EDGE_TYPE_BOTH = 2

Neu in Version 2.0.1 (Plugin).

Das zurückgegebene namedtuple enthält die Variablen edge_type und debounce.

BrickletIO4.get_api_version()
Rückgabetyp:[int, int, int]

Gibt die Version der API Definition (Major, Minor, Revision) 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.

BrickletIO4.get_response_expected(function_id)
Parameter:function_id -- int
Rückgabetyp: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.

Siehe set_response_expected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

BrickletIO4.set_response_expected(function_id, response_expected)
Parameter:
  • function_id -- int
  • response_expected -- bool
Rückgabetyp:

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.

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

  • BrickletIO4.FUNCTION_SET_VALUE = 1
  • BrickletIO4.FUNCTION_SET_CONFIGURATION = 3
  • BrickletIO4.FUNCTION_SET_DEBOUNCE_PERIOD = 5
  • BrickletIO4.FUNCTION_SET_INTERRUPT = 7
  • BrickletIO4.FUNCTION_SET_MONOFLOP = 10
  • BrickletIO4.FUNCTION_SET_SELECTED_VALUES = 13
  • BrickletIO4.FUNCTION_SET_EDGE_COUNT_CONFIG = 15
BrickletIO4.set_response_expected_all(response_expected)
Parameter:response_expected -- bool
Rückgabetyp:None

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

BrickletIO4.get_identity()
Rückgabetyp:(str, str, chr, [int, int, int], [int, int, int], int)

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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Das zurückgegebene namedtuple enthält die Variablen uid, connected_uid, position, hardware_version, firmware_version und device_identifier.

Konfigurationsfunktionen für Callbacks

BrickletIO4.register_callback(callback_id, function)
Parameter:
  • callback_id -- int
  • function -- callable
Rückgabetyp:

None

Registriert die function für die gegebene callback_id.

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

BrickletIO4.set_debounce_period(debounce)
Parameter:debounce -- int
Rückgabetyp:None

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

Der Standardwert ist 100.

BrickletIO4.get_debounce_period()
Rückgabetyp:int

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

BrickletIO4.set_interrupt(interrupt_mask)
Parameter:interrupt_mask -- int
Rückgabetyp:None

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 10 bzw. 0b1010 aktiviert den Interrupt für die Pins 1 und 3.

Der Interrupt wird mit dem CALLBACK_INTERRUPT Callback zugestellt.

BrickletIO4.get_interrupt()
Rückgabetyp:int

Gibt die Interrupt Bitmaske zurück, wie von set_interrupt() 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)

io4.register_callback(BrickletIO4.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.

BrickletIO4.CALLBACK_INTERRUPT
Parameter:
  • interrupt_mask -- int
  • value_mask -- int

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.
BrickletIO4.CALLBACK_MONOFLOP_DONE
Parameter:
  • selection_mask -- int
  • value_mask -- int

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

Konstanten

BrickletIO4.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein IO-4 Bricklet 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.

BrickletIO4.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines IO-4 Bricklet dar.