Mathematica - IO-4 Bricklet 2.0

Dies ist die Beschreibung der Mathematica API Bindings für das IO-4 Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des IO-4 Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Output

Download (ExampleOutput.nb)

 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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your IO-4 Bricklet 2.0*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
io=NETNew["Tinkerforge.BrickletIO4V2",uid,ipcon]
ipcon@Connect[host,port]

(*Configure channel 3 as output low*)
io@SetConfiguration[3,ToCharacterCode["o"][[1]],False]

(*Set channel 3 alternating high/low 10 times with 100 ms delay*)
For[i=0,i<10,i++,
 Pause[0.1];
 io@SetSelectedValue[3,True];
 Pause[0.1];
 io@SetSelectedValue[3,False]
]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[io]
ReleaseNETObject[ipcon]

Interrupt

Download (ExampleInterrupt.nb)

 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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your IO-4 Bricklet 2.0*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
io=NETNew["Tinkerforge.BrickletIO4V2",uid,ipcon]
ipcon@Connect[host,port]

(*Callback function for input value callback*)
InputValueCB[sender_,channel_,changed_,value_]:=
 Module[{},
  Print["Channel: "<>ToString[channel]];
  Print["Changed: "<>ToString[changed]];
  Print["Value: "<>ToString[value]]
 ]

AddEventHandler[io@InputValueCallback,InputValueCB]

(*Set period for input value (channel 1) callback to 0.5s (500ms)*)
io@SetInputValueCallbackConfiguration[1,500,False]

Input["Click OK to exit"]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[io]
ReleaseNETObject[ipcon]

API

Prinzipiell kann jede Funktion der Mathematica Bindings, welche einen Wert zurück gibt eine Tinkerforge.TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Da .NET/Link nicht mehrere Rückgabewerte direkt unterstützt, wird das out Schlüsselwort genutzt, um mehrere Werte aus einer Funktion zurückzugeben. Weitere Informationen über das out Schlüsselwort in .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist Tinkerforge.*.

Grundfunktionen

BrickletIO4V2[uid, ipcon] → io4V2
Parameter:
  • uid -- String
  • ipcon -- NETObject[IPConnection]
Rückgabe:
  • io4V2 -- NETObject[BrickletIO4V2]

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

io4V2=NETNew["Tinkerforge.BrickletIO4V2","YOUR_DEVICE_UID",ipcon]

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

Die .NET Runtime hat eingebauten Garbage Collection welche Objekte wieder freigibt, wenn sie vom Programm nicht mehr verwendet werden. Da Mathematica aber selbst nicht automatisch feststellen kann, wann ein Mathematica "Programm" ein .NET Objekt nicht mehr verwendet, muss sich das Programm selbst darum kümmern. Für diesen Zweck wird die ReleaseNETObject[] Funktion in den Beispielen verwendet.

Weitere Informationen über Objekt-Verwaltung mittels .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

BrickletIO4V2@SetValue[{value1, value2, value3, value4}] → Null
Parameter:
  • valuei -- True/False

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

Mit der Funktionen SetSelectedValue[] können einzelnen Kanäle gesetzt werden.

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

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

Bemerkung

Diese Funktion bewirkt keine Änderung an Kanälen die als Eingang konfiguriert sind. Pull-Up Widerstände können mit SetConfiguration[] zugeschaltet werden.

BrickletIO4V2@GetValue[] → {value1, value2, value3, value4}
Rückgabe:
  • valuei -- True/False

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

BrickletIO4V2@SetSelectedValue[channel, value] → Null
Parameter:
  • channel -- Integer
  • value -- True/False

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

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

Bemerkung

Diese Funktion bewirkt keine Änderung an Kanälen die als Eingang konfiguriert sind. Pull-Up Widerstände können mit SetConfiguration[] zugeschaltet werden.

BrickletIO4V2@SetConfiguration[channel, direction, value] → Null
Parameter:
  • channel -- Integer
  • direction -- Integer
  • value -- True/False

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

  • (0, 'i', true) setzt Kanal 0 als Eingang mit Pull-Up.
  • (1, 'i', false) setzt Kanal 1 als Standard Eingang (potentialfrei wenn nicht verbunden).
  • (2, 'o', true) setzt Kanal 2 als Ausgang im Zustand logisch 1.
  • (3, 'o', false) setzt Kanal 3 als Ausgang im Zustand logisch 0.

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

Die Standardkonfiguration ist Eingang mit Pull-Up.

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

  • BrickletIO4V2`DIRECTIONUIN = ToCharacterCode["i"][[0]]
  • BrickletIO4V2`DIRECTIONUOUT = ToCharacterCode["o"][[0]]
BrickletIO4V2@GetConfiguration[channel, out direction, out value] → Null
Parameter:
  • channel -- Integer
  • direction -- Integer
  • value -- True/False

Gibt die Kanal-Konfiguration zurück, wie von SetConfiguration[] gesetzt.

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

  • BrickletIO4V2`DIRECTIONUIN = ToCharacterCode["i"][[0]]
  • BrickletIO4V2`DIRECTIONUOUT = ToCharacterCode["o"][[0]]

Fortgeschrittene Funktionen

BrickletIO4V2@SetMonoflop[channel, value, time] → Null
Parameter:
  • channel -- Integer
  • value -- True/False
  • time -- Integer

Der erste Parameter ist der gewünschte Zustand des Kanals (true bedeutet high und false low). Der zweite Parameter stellt die Zeit (in ms) 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 2.0 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.

BrickletIO4V2@GetMonoflop[channel, out value, out time, out timeRemaining] → Null
Parameter:
  • channel -- Integer
  • value -- True/False
  • time -- Integer
  • timeRemaining -- Integer

Gibt (für den angegebenen Kanal) den aktuellen Zustand und die Zeit, wie von SetMonoflop[] gesetzt, sowie die noch verbleibende Zeit bis zum Zustandswechsel, zurück.

Wenn der Timer aktuell nicht läuft, ist die noch verbleibende Zeit 0.

BrickletIO4V2@GetEdgeCount[channel, resetCounter] → count
Parameter:
  • channel -- Integer
  • resetCounter -- True/False
Rückgabe:
  • count -- Integer

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

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

Bemerkung

Aufrufen dieser Funktion ist nur für Kanäle erlaubt, die als Eingang konfiguriert sind.

BrickletIO4V2@SetEdgeCountConfiguration[channel, edgeType, debounce] → Null
Parameter:
  • channel -- Integer
  • edgeType -- Integer
  • debounce -- Integer

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 für Kanäle 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).

Bemerkung

Aufrufen dieser Funktion ist nur für Kanäle erlaubt, die als Eingang konfiguriert sind.

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

  • BrickletIO4V2`EDGEUTYPEURISING = 0
  • BrickletIO4V2`EDGEUTYPEUFALLING = 1
  • BrickletIO4V2`EDGEUTYPEUBOTH = 2
BrickletIO4V2@GetEdgeCountConfiguration[channel, out edgeType, out debounce] → Null
Parameter:
  • channel -- Integer
  • edgeType -- Integer
  • debounce -- Integer

Gibt den Flankentyp sowie die Entprellzeit für den ausgewählten Kanal zurück, wie von SetEdgeCountConfiguration[] gesetzt.

Bemerkung

Aufrufen dieser Funktion ist nur für Kanäle erlaubt, die als Eingang konfiguriert sind.

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

  • BrickletIO4V2`EDGEUTYPEURISING = 0
  • BrickletIO4V2`EDGEUTYPEUFALLING = 1
  • BrickletIO4V2`EDGEUTYPEUBOTH = 2
BrickletIO4V2@SetPWMConfiguration[channel, frequency, dutyCycle] → Null
Parameter:
  • channel -- Integer
  • frequency -- Integer
  • dutyCycle -- Integer

Aktiviert ein PWM auf dem angegebenen Kanal. Die Frequenz wird in 1/10Hz angegeben und die Duty Cycle in 1/100%.

Bevor diese Funktion aufgerufen wird, muss der Kanal als Ausgabe konfiguriert werden, ansonsten wird ein "invalid parameter"-Fehler gemeldet. 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. SetSelectedValue[]).

Der maximale Frequenzwert beträgt 320000000 (32MHz). Der Maximale Duty Cycle-Wert beträgt 10000 (100%).

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

Die Standardwerte sind 0, 0.

BrickletIO4V2@GetPWMConfiguration[channel, out frequency, out dutyCycle] → Null
Parameter:
  • channel -- Integer
  • frequency -- Integer
  • dutyCycle -- Integer

Gibt die PWM Konfiguration zurück, wie von SetPWMConfiguration[] gesetzt.

BrickletIO4V2@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}
Rückgabe:
  • apiVersioni -- Integer

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.

BrickletIO4V2@GetResponseExpected[functionId] → responseExpected
Parameter:
  • functionId -- Integer
Rückgabe:
  • responseExpected -- True/False

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 SetResponseExpected[]. 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:

  • BrickletIO4V2`FUNCTIONUSETUVALUE = 1
  • BrickletIO4V2`FUNCTIONUSETUSELECTEDUVALUE = 3
  • BrickletIO4V2`FUNCTIONUSETUCONFIGURATION = 4
  • BrickletIO4V2`FUNCTIONUSETUINPUTUVALUEUCALLBACKUCONFIGURATION = 6
  • BrickletIO4V2`FUNCTIONUSETUALLUINPUTUVALUEUCALLBACKUCONFIGURATION = 8
  • BrickletIO4V2`FUNCTIONUSETUMONOFLOP = 10
  • BrickletIO4V2`FUNCTIONUSETUEDGEUCOUNTUCONFIGURATION = 13
  • BrickletIO4V2`FUNCTIONUSETUPWMUCONFIGURATION = 15
  • BrickletIO4V2`FUNCTIONUSETUWRITEUFIRMWAREUPOINTER = 237
  • BrickletIO4V2`FUNCTIONUSETUSTATUSULEDUCONFIG = 239
  • BrickletIO4V2`FUNCTIONURESET = 243
  • BrickletIO4V2`FUNCTIONUWRITEUUID = 248
BrickletIO4V2@SetResponseExpected[functionId, responseExpected] → Null
Parameter:
  • functionId -- Integer
  • responseExpected -- True/False

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

  • BrickletIO4V2`FUNCTIONUSETUVALUE = 1
  • BrickletIO4V2`FUNCTIONUSETUSELECTEDUVALUE = 3
  • BrickletIO4V2`FUNCTIONUSETUCONFIGURATION = 4
  • BrickletIO4V2`FUNCTIONUSETUINPUTUVALUEUCALLBACKUCONFIGURATION = 6
  • BrickletIO4V2`FUNCTIONUSETUALLUINPUTUVALUEUCALLBACKUCONFIGURATION = 8
  • BrickletIO4V2`FUNCTIONUSETUMONOFLOP = 10
  • BrickletIO4V2`FUNCTIONUSETUEDGEUCOUNTUCONFIGURATION = 13
  • BrickletIO4V2`FUNCTIONUSETUPWMUCONFIGURATION = 15
  • BrickletIO4V2`FUNCTIONUSETUWRITEUFIRMWAREUPOINTER = 237
  • BrickletIO4V2`FUNCTIONUSETUSTATUSULEDUCONFIG = 239
  • BrickletIO4V2`FUNCTIONURESET = 243
  • BrickletIO4V2`FUNCTIONUWRITEUUID = 248
BrickletIO4V2@SetResponseExpectedAll[responseExpected] → Null
Parameter:
  • responseExpected -- True/False

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

BrickletIO4V2@GetSPITFPErrorCount[out errorCountAckChecksum, out errorCountMessageChecksum, out errorCountFrame, out errorCountOverflow] → Null
Parameter:
  • errorCountAckChecksum -- Integer
  • errorCountMessageChecksum -- Integer
  • errorCountFrame -- Integer
  • errorCountOverflow -- Integer

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.

BrickletIO4V2@SetBootloaderMode[mode] → status
Parameter:
  • mode -- Integer
Rückgabe:
  • status -- Integer

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

  • BrickletIO4V2`BOOTLOADERUMODEUBOOTLOADER = 0
  • BrickletIO4V2`BOOTLOADERUMODEUFIRMWARE = 1
  • BrickletIO4V2`BOOTLOADERUMODEUBOOTLOADERUWAITUFORUREBOOT = 2
  • BrickletIO4V2`BOOTLOADERUMODEUFIRMWAREUWAITUFORUREBOOT = 3
  • BrickletIO4V2`BOOTLOADERUMODEUFIRMWAREUWAITUFORUERASEUANDUREBOOT = 4
  • BrickletIO4V2`BOOTLOADERUSTATUSUOK = 0
  • BrickletIO4V2`BOOTLOADERUSTATUSUINVALIDUMODE = 1
  • BrickletIO4V2`BOOTLOADERUSTATUSUNOUCHANGE = 2
  • BrickletIO4V2`BOOTLOADERUSTATUSUENTRYUFUNCTIONUNOTUPRESENT = 3
  • BrickletIO4V2`BOOTLOADERUSTATUSUDEVICEUIDENTIFIERUINCORRECT = 4
  • BrickletIO4V2`BOOTLOADERUSTATUSUCRCUMISMATCH = 5
BrickletIO4V2@GetBootloaderMode[] → mode
Rückgabe:
  • mode -- Integer

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode[].

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

  • BrickletIO4V2`BOOTLOADERUMODEUBOOTLOADER = 0
  • BrickletIO4V2`BOOTLOADERUMODEUFIRMWARE = 1
  • BrickletIO4V2`BOOTLOADERUMODEUBOOTLOADERUWAITUFORUREBOOT = 2
  • BrickletIO4V2`BOOTLOADERUMODEUFIRMWAREUWAITUFORUREBOOT = 3
  • BrickletIO4V2`BOOTLOADERUMODEUFIRMWAREUWAITUFORUERASEUANDUREBOOT = 4
BrickletIO4V2@SetWriteFirmwarePointer[pointer] → Null
Parameter:
  • pointer -- Integer

Setzt den Firmware-Pointer für WriteFirmware[]. 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.

BrickletIO4V2@WriteFirmware[{data1, data2, ..., data64}] → status
Parameter:
  • datai -- Integer
Rückgabe:
  • status -- Integer

Schreibt 64 Bytes Firmware an die Position die vorher von SetWriteFirmwarePointer[] 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.

BrickletIO4V2@SetStatusLEDConfig[config] → Null
Parameter:
  • config -- Integer

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:

  • BrickletIO4V2`STATUSULEDUCONFIGUOFF = 0
  • BrickletIO4V2`STATUSULEDUCONFIGUON = 1
  • BrickletIO4V2`STATUSULEDUCONFIGUSHOWUHEARTBEAT = 2
  • BrickletIO4V2`STATUSULEDUCONFIGUSHOWUSTATUS = 3
BrickletIO4V2@GetStatusLEDConfig[] → config
Rückgabe:
  • config -- Integer

Gibt die Konfiguration zurück, wie von SetStatusLEDConfig[] gesetzt.

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

  • BrickletIO4V2`STATUSULEDUCONFIGUOFF = 0
  • BrickletIO4V2`STATUSULEDUCONFIGUON = 1
  • BrickletIO4V2`STATUSULEDUCONFIGUSHOWUHEARTBEAT = 2
  • BrickletIO4V2`STATUSULEDUCONFIGUSHOWUSTATUS = 3
BrickletIO4V2@GetChipTemperature[] → temperature
Rückgabe:
  • temperature -- Integer

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.

BrickletIO4V2@Reset[] → Null

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.

BrickletIO4V2@WriteUID[uid] → Null
Parameter:
  • uid -- Integer

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.

BrickletIO4V2@ReadUID[] → uid
Rückgabe:
  • uid -- Integer

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

BrickletIO4V2@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null
Parameter:
  • uid -- String
  • connectedUid -- String
  • position -- Integer
  • hardwareVersioni -- Integer
  • firmwareVersioni -- Integer
  • deviceIdentifier -- Integer

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.

Konfigurationsfunktionen für Callbacks

BrickletIO4V2@SetInputValueCallbackConfiguration[channel, period, valueHasToChange] → Null
Parameter:
  • channel -- Integer
  • period -- Integer
  • valueHasToChange -- True/False

Dieser Callback kann pro Kanal konfiguriert werden.

Die Periode in ms ist die Periode mit der der InputValueCallback 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).

BrickletIO4V2@GetInputValueCallbackConfiguration[channel, out period, out valueHasToChange] → Null
Parameter:
  • channel -- Integer
  • period -- Integer
  • valueHasToChange -- True/False

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

BrickletIO4V2@SetAllInputValueCallbackConfiguration[period, valueHasToChange] → Null
Parameter:
  • period -- Integer
  • valueHasToChange -- True/False

Die Periode in ms ist die Periode mit der der AllInputValueCallback 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).

BrickletIO4V2@GetAllInputValueCallbackConfiguration[out period, out valueHasToChange] → Null
Parameter:
  • period -- Integer
  • valueHasToChange -- True/False

Gibt die Callback-Konfiguration zurück, wie mittels SetAllInputValueCallbackConfiguration[] gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Funktion einem Callback Property des Geräte Objektes zugewiesen wird:

MyCallback[sender_,value_]:=Print["Value: "<>ToString[value]]

AddEventHandler[io4V2@ExampleCallback,MyCallback]

Weitere Informationen über Event-Behandlung mittels .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

Die verfügbaren Callback Properties und ihre Parametertypen 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.

event BrickletIO4V2@InputValueCallback[sender, channel, changed, value]
Parameter:
  • sender -- NETObject[BrickletIO4V2]
  • channel -- Integer
  • changed -- True/False
  • value -- True/False

Dieser Callback wird periodisch ausgelöst abhängig von der mittels SetInputValueCallbackConfiguration[] 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.

event BrickletIO4V2@AllInputValueCallback[sender, {changed1, changed2, changed3, changed4}, {value1, value2, value3, value4}]
Parameter:
  • sender -- NETObject[BrickletIO4V2]
  • changedi -- True/False
  • valuei -- True/False

Dieser Callback wird periodisch ausgelöst abhängig von der mittels SetAllInputValueCallbackConfiguration[] gesetzten Konfiguration

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

event BrickletIO4V2@MonoflopDoneCallback[sender, channel, value]
Parameter:
  • sender -- NETObject[BrickletIO4V2]
  • channel -- Integer
  • value -- True/False

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

Konstanten

BrickletIO4V2`DEVICEUIDENTIFIER

Diese Konstante wird verwendet um ein IO-4 Bricklet 2.0 zu identifizieren.

Die GetIdentity[] Funktion und der IPConnection@EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletIO4V2`DEVICEDISPLAYNAME

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