Mathematica - OLED 128x64 Bricklet

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

Hello World

Download (ExampleHelloWorld.nb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your OLED 128x64 Bricklet*)

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

(*Clear display*)
oled@ClearDisplay[]

(*Write "Hello World" starting from upper left corner of the screen*)
oled@WriteLine[0,0,"Hello World"]

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

Pixel Matrix

Download (ExamplePixelMatrix.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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your OLED 128x64 Bricklet*)
width=128
height=64

DrawMatrix[oled_,pixels_]:=
 Module[{pages,row,column,bit,page},
  pages=Table[0,{y,0,height/8-1},{y,0,width-1}];
  For[row=0,row<Floor[height/8],row++,
   For[column=0,column<width,column++,
    page=0;
    For[bit=0,bit<8,bit++,
     If[pixels[[row*8+bit+1]][[column+1]],
      page=BitOr[page,BitShiftLeft[1,bit]]
     ]
    ];
    pages[[row+1]][[column+1]]=page
   ]
  ];
  oled@NewWindow[0,width-1,0,Floor[height/8]-1];
  For[row=0,row<Floor[height/8],row++,
   For[column=0,column<width,column+=64,
    oled@Write[pages[[row+1]][[column+1;;column+64]]]
   ]
  ]
 ]

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

(*Clear display*)
oled@ClearDisplay[]

(*Draw checkerboard pattern*)
pixels=Table[Mod[Floor[h/8],2]==Mod[Floor[w/8],2],{h,0,height-1},{w,0,width-1}];
DrawMatrix[oled,pixels]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[oled]
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

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

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

oled128x64=NETNew["Tinkerforge.BrickletOLED128x64","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.

BrickletOLED128x64@Write[{data1, data2, ..., data64}] → Null
Parameter:
  • datai -- Integer

Fügt 64 Byte Daten zu dem mit NewWindow[] gesetztem Fenster hinzu.

Jede Zeile hat eine Höhe von 8 Pixeln welche einem Byte Daten entsprechen.

Beispiel: Wenn NewWindow[] mit Spalte (Column) von 0 bis 127 und Zeile (Row) von 0 bis 7 (das ganze Display) aufgerufen wird, schreibt jedes Write[] (roter Pfeil) eine halbe Zeile.

Display Pixel Reihenfolge

Das LSB (D0) von jedem Daten-Byte ist in der Zeile oben und das MSB (D7) ist in der Zeile unten.

Der nächste Aufruf von Write[] schreibt die zweite Hälfte der erste Zeile, und die nächsten beiden Aufrufe die zweite Zeile usw. Um das ganze Display zu füllen muss Write[] 16 mal aufgerufen werden.

BrickletOLED128x64@NewWindow[columnFrom, columnTo, rowFrom, rowTo] → Null
Parameter:
  • columnFrom -- Integer
  • columnTo -- Integer
  • rowFrom -- Integer
  • rowTo -- Integer

Setzt das Fenster in welches mit Write[] geschrieben werden kann. Eine Zeile (Row) hat eine Höhe von 8 Pixel.

Die Spalten haben einen Wertebereich von 0 bis 127 und die Zeilen haben einen Wertebereich von 0 bis 7.

BrickletOLED128x64@ClearDisplay[] → Null

Löscht den aktuellen Inhalt des mit NewWindow[] gesetztem Fensters.

BrickletOLED128x64@WriteLine[line, position, text] → Null
Parameter:
  • line -- Integer
  • position -- Integer
  • text -- String

Schreibt einen Text in die angegebene Zeile (0 bis 7) mit einer vorgegebenen Position (0 bis 25). Der Text kann maximal 26 Zeichen lang sein.

Beispiel: (1, 10, "Hallo") schreibt Hallo in die Mitte der zweiten Zeile des Displays.

Es ist möglich zuerst auf das Display mit Write[] zu malen und danach Text hinzuzufügen.

Das Display nutzt einen speziellen 5x7 Pixel Zeichensatz. Der Zeichensatz kann mit Hilfe von Brick Viewer angezeigt werden.

Fortgeschrittene Funktionen

BrickletOLED128x64@SetDisplayConfiguration[contrast, invert] → Null
Parameter:
  • contrast -- Integer
  • invert -- True/False

Setzt die Konfiguration des Displays

Es können der Kontrast mit einem Wertebereich von 0 bis 255 gesetzt, sowie die Farben (schwarz/weiß) des Displays invertiert werden.

Die Standardwerte sind ein Kontrast von 143 und die Invertierung ist aus.

BrickletOLED128x64@GetDisplayConfiguration[out contrast, out invert] → Null
Parameter:
  • contrast -- Integer
  • invert -- True/False

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

BrickletOLED128x64@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.

BrickletOLED128x64@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.

Siehe SetResponseExpected[] für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

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

  • BrickletOLED128x64`FUNCTIONUWRITE = 1
  • BrickletOLED128x64`FUNCTIONUNEWUWINDOW = 2
  • BrickletOLED128x64`FUNCTIONUCLEARUDISPLAY = 3
  • BrickletOLED128x64`FUNCTIONUSETUDISPLAYUCONFIGURATION = 4
  • BrickletOLED128x64`FUNCTIONUWRITEULINE = 6
BrickletOLED128x64@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.

BrickletOLED128x64@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.

Konstanten

BrickletOLED128x64`DEVICEUIDENTIFIER

Diese Konstante wird verwendet um ein OLED 128x64 Bricklet zu identifizieren.

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

BrickletOLED128x64`DEVICEDISPLAYNAME

Diese Konstante stellt den Anzeigenamen eines OLED 128x64 Bricklet dar.