Dies ist die Beschreibung der JavaScript 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 JavaScript API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (ExampleHelloWorld.js)
1var Tinkerforge = require('tinkerforge');
2
3var HOST = 'localhost';
4var PORT = 4223;
5var UID = 'XYZ'; // Change XYZ to the UID of your OLED 128x64 Bricklet
6
7var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
8var oled = new Tinkerforge.BrickletOLED128x64(UID, ipcon); // Create device object
9
10ipcon.connect(HOST, PORT,
11 function (error) {
12 console.log('Error: ' + error);
13 }
14); // Connect to brickd
15// Don't use device before ipcon is connected
16
17ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
18 function (connectReason) {
19 // Clear display
20 oled.clearDisplay();
21
22 // Write "Hello World" starting from upper left corner of the screen
23 oled.writeLine(0, 0, 'Hello World');
24 }
25);
26
27console.log('Press key to exit');
28process.stdin.on('data',
29 function (data) {
30 ipcon.disconnect();
31 process.exit(0);
32 }
33);
Download (ExamplePixelMatrix.js)
1var Tinkerforge = require('tinkerforge');
2
3var HOST = 'localhost';
4var PORT = 4223;
5var UID = 'XYZ'; // Change XYZ to the UID of your OLED 128x64 Bricklet
6var SCREEN_WIDTH = 128;
7var SCREEN_HEIGHT = 64;
8
9var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
10var oled = new Tinkerforge.BrickletOLED128x64(UID, ipcon); // Create device object
11
12function drawMatrix(oled, pixels) {
13 column = [];
14 column_write = [];
15
16 for (var i = 0; i < SCREEN_HEIGHT/8; i++) {
17 column[i] = [];
18 }
19
20 for (var i = 0; i < SCREEN_HEIGHT/8; i++) {
21 for (var j = 0; j < SCREEN_WIDTH; j++) {
22 page = 0;
23
24 for (var k = 0; k < 8; k++) {
25 if (pixels[i*8 + k][j]) {
26 page |= 1 << k;
27 }
28 }
29
30 column[i][j] = page;
31 }
32 }
33
34 oled.newWindow(0, SCREEN_WIDTH-1, 0, 7)
35
36 for (var i = 0; i < SCREEN_HEIGHT/8; i++) {
37 l = 0;
38 for (j = 0; j < SCREEN_WIDTH/2; j++) {
39 column_write[l] = column[i][j];
40 l++;
41 }
42
43 oled.write(column_write);
44
45 l = 0;
46 for (k = SCREEN_WIDTH/2; k < SCREEN_WIDTH; k++) {
47 column_write[l] = column[i][k];
48 l++;
49 }
50
51 oled.write(column_write);
52 }
53}
54
55ipcon.connect(HOST, PORT,
56 function (error) {
57 console.log('Error: ' + error);
58 }
59); // Connect to brickd
60// Don't use device before ipcon is connected
61
62ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
63 function (connectReason) {
64 // Clear display
65 oled.clearDisplay();
66
67 // Draw checkerboard pattern
68 var pixelMatrix = [];
69 for (var h = 0; h < SCREEN_HEIGHT; h++) {
70 pixelMatrix[h] = [];
71 for (var w = 0; w < SCREEN_WIDTH; w++) {
72 pixelMatrix[h][w] = Math.floor(h / 8) % 2 == Math.floor(w / 8) % 2;
73 }
74 }
75
76 drawMatrix(oled, pixelMatrix);
77 }
78);
79
80console.log('Press key to exit');
81process.stdin.on('data',
82 function (data) {
83 ipcon.disconnect();
84 process.exit(0);
85 }
86);
1var Tinkerforge = require('tinkerforge');
2var GM = require('gm'); // FIXME: maybe use node-gd instead
3var getPixels = require('get-pixels');
4
5var HOST = 'localhost';
6var PORT = 4223;
7var UID = 'XYZ'; // Change XYZ to the UID of your OLED 128x64 Bricklet
8var WIDTH = 128;
9var HEIGHT = 64;
10
11var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
12var oled = new Tinkerforge.BrickletOLED128x64(UID, ipcon); // Create device object
13var originX = WIDTH / 2;
14var originY = HEIGHT / 2;
15var length = HEIGHT / 2 - 2;
16var angle = 0;
17
18function drawImage(oled, image) {
19 // FIXME: GraphicsMagick doesn't seem to have a way to access the individual
20 // pixels. Convert to PNG and then used get-pixels to read the pixels back.
21 // This is far from ideal, but better than nothing.
22 image.toBuffer('PNG', function (err, buffer) {
23 if (err) {
24 console.log('toBuffer: ' + err);
25 return;
26 }
27
28 getPixels(buffer, 'image/png', function(err, pixels) {
29 if (err) {
30 console.log('getPixels: ' + err);
31 return;
32 }
33
34 column = [];
35 column_write = [];
36
37 for (var i = 0; i < HEIGHT/8; i++) {
38 column[i] = [];
39 }
40
41 for (var i = 0; i < HEIGHT/8; i++) {
42 for (var j = 0; j < WIDTH; j++) {
43 page = 0;
44
45 for (var k = 0; k < 8; k++) {
46 if (pixels.get(j, i*8 + k, 0) > 0) {
47 page |= 1 << k;
48 }
49 }
50
51 column[i][j] = page;
52 }
53 }
54
55 oled.newWindow(0, WIDTH-1, 0, 7)
56
57 for (var i = 0; i < HEIGHT/8; i++) {
58 l = 0;
59 for (j = 0; j < WIDTH/2; j++) {
60 column_write[l] = column[i][j];
61 l++;
62 }
63
64 oled.write(column_write);
65
66 l = 0;
67 for (k = WIDTH/2; k < WIDTH; k++) {
68 column_write[l] = column[i][k];
69 l++;
70 }
71
72 oled.write(column_write);
73 }
74 });
75 });
76}
77
78ipcon.connect(HOST, PORT,
79 function (error) {
80 console.log('Error: ' + error);
81 }
82); // Connect to brickd
83// Don't use device before ipcon is connected
84
85ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
86 function (connectReason) {
87 // Clear display
88 oled.clearDisplay();
89
90 // Draw rotating line
91 function render() {
92 // FIXME: Creating the image once and reusing it would be better, but
93 // on the second call toBuffer() fails with "Stream yields empty buffer"
94 var image = GM(WIDTH, HEIGHT, '#000');
95 var radians = angle * Math.PI / 180;
96 var x = Math.floor(originX + length * Math.cos(radians));
97 var y = Math.floor(originY + length * Math.sin(radians));
98
99 image.fill('#FFF').drawLine(originX, originY, x, y);
100
101 drawImage(oled, image);
102
103 angle++;
104 }
105
106 setInterval(render, 25);
107 }
108);
109
110console.log('Press key to exit');
111process.stdin.on('data',
112 function (data) {
113 ipcon.disconnect();
114 process.exit(0);
115 }
116);
Download (ExampleHelloWorld.html), Test (ExampleHelloWorld.html)
1<!DOCTYPE html>
2<html>
3 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
4 <head>
5 <title>Tinkerforge | JavaScript Example</title>
6 </head>
7 <body>
8 <div style="text-align:center;">
9 <h1>OLED 128x64 Bricklet Hello World Example</h1>
10 <p>
11 <input value="localhost" id="host" type="text" size="20">:
12 <input value="4280" id="port" type="text" size="5">,
13 <input value="uid" id="uid" type="text" size="5">
14 <input value="Start Example" id="start" type="button" onclick="startExample();">
15 </p>
16 <p>
17 <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
18 >Press "Start Example" to begin ...</textarea>
19 </p>
20 </div>
21 <script src="./Tinkerforge.js" type='text/javascript'></script>
22 <script type='text/javascript'>
23 var ipcon;
24 var textArea = document.getElementById("text");
25 function startExample() {
26 textArea.value = "";
27 var HOST = document.getElementById("host").value;
28 var PORT = parseInt(document.getElementById("port").value);
29 var UID = document.getElementById("uid").value;
30 if(ipcon !== undefined) {
31 ipcon.disconnect();
32 }
33 ipcon = new Tinkerforge.IPConnection(); // Create IP connection
34 var oled = new Tinkerforge.BrickletOLED128x64(UID, ipcon); // Create device object
35 ipcon.connect(HOST, PORT,
36 function(error) {
37 textArea.value += 'Error: ' + error + '\n';
38 }
39 ); // Connect to brickd
40 // Don't use device before ipcon is connected
41
42 ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
43 function (connectReason) {
44 // Clear display
45 oled.clearDisplay();
46
47 // Write "Hello World" starting from upper left corner of the screen
48 oled.writeLine(0, 0, 'Hello World');
49 }
50 );
51 }
52 </script>
53 </body>
54</html>
Download (ExamplePixelMatrix.html), Test (ExamplePixelMatrix.html)
1<!DOCTYPE html>
2<html>
3 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
4 <head>
5 <title>Tinkerforge | JavaScript Example</title>
6 </head>
7 <body>
8 <div style="text-align:center;">
9 <h1>OLED 128x64 Bricklet Pixel Matrix Example</h1>
10 <p>
11 <input value="localhost" id="host" type="text" size="20">:
12 <input value="4280" id="port" type="text" size="5">,
13 <input value="uid" id="uid" type="text" size="5">
14 <input value="Start Example" id="start" type="button" onclick="startExample();">
15 </p>
16 <p>
17 <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
18 >Press "Start Example" to begin ...</textarea>
19 </p>
20 </div>
21 <script src="./Tinkerforge.js" type='text/javascript'></script>
22 <script type='text/javascript'>
23 var ipcon;
24 var textArea = document.getElementById("text");
25 var SCREEN_WIDTH = 128;
26 var SCREEN_HEIGHT = 64;
27
28 function drawMatrix(oled, pixels) {
29 column = [];
30 column_write = [];
31 for (var i = 0; i < SCREEN_HEIGHT/8; i++) {
32 column[i] = [];
33 }
34
35 for (var i = 0; i < SCREEN_HEIGHT/8; i++) {
36 for (var j = 0; j < SCREEN_WIDTH; j++) {
37 page = 0;
38
39 for (var k = 0; k < 8; k++) {
40 if (pixels[i*8 + k][j] == true) {
41 page |= 1 << k;
42 }
43 }
44 column[i][j] = page;
45 }
46 }
47
48 oled.newWindow(0, SCREEN_WIDTH-1, 0, 7)
49
50 for (var i = 0; i < SCREEN_HEIGHT/8; i++) {
51 l = 0;
52 for (j = 0; j < SCREEN_WIDTH/2; j++) {
53 column_write[l] = column[i][j];
54 l++;
55 }
56
57 oled.write(column_write);
58
59 l = 0;
60 for (k = SCREEN_WIDTH/2; k < SCREEN_WIDTH; k++) {
61 column_write[l] = column[i][k];
62 l++;
63 }
64
65 oled.write(column_write);
66 }
67 }
68
69 function startExample() {
70 textArea.value = "";
71 var HOST = document.getElementById("host").value;
72 var PORT = parseInt(document.getElementById("port").value);
73 var UID = document.getElementById("uid").value;
74 if(ipcon !== undefined) {
75 ipcon.disconnect();
76 }
77 ipcon = new Tinkerforge.IPConnection(); // Create IP connection
78 var oled = new Tinkerforge.BrickletOLED128x64(UID, ipcon); // Create device object
79 ipcon.connect(HOST, PORT,
80 function(error) {
81 textArea.value += 'Error: ' + error + '\n';
82 }
83 ); // Connect to brickd
84 // Don't use device before ipcon is connected
85
86 ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
87 function (connectReason) {
88 // Clear display
89 oled.clearDisplay();
90
91 // Draw checkerboard pattern
92 var pixelMatrix = [];
93 for (var h = 0; h < SCREEN_HEIGHT; h++) {
94 pixelMatrix[h] = [];
95 for (var w = 0; w < SCREEN_WIDTH; w++) {
96 pixelMatrix[h][w] = Math.floor(h / 8) % 2 == Math.floor(w / 8) % 2;
97 }
98 }
99
100 drawMatrix(oled, pixelMatrix);
101 }
102 );
103 }
104 </script>
105 </body>
106</html>
Allgemein kann jede Funktion der JavaScript Bindings zwei optionale Parameter
haben, returnCallback und errorCallback. Dies sind benutzerdefinierte
Callback-Funktionen. Die returnCallback-Funktion wird mit dem Ergebnissen
der Funktion als Argumente aufgerufen, falls die Funktion ihre
Ergebnisse asynchron zurückgibt. Die errorCallback-Funktion wird im
Fehlerfall mit einem Fehlercode aufgerufen. Der Fehlercode kann einer der
folgenden Werte sein:
IPConnection.ERROR_ALREADY_CONNECTED = 11
IPConnection.ERROR_NOT_CONNECTED = 12
IPConnection.ERROR_CONNECT_FAILED = 13
IPConnection.ERROR_INVALID_FUNCTION_ID = 21
IPConnection.ERROR_TIMEOUT = 31
IPConnection.ERROR_INVALID_PARAMETER = 41
IPConnection.ERROR_FUNCTION_NOT_SUPPORTED = 42
IPConnection.ERROR_UNKNOWN_ERROR = 43
IPConnection.ERROR_STREAM_OUT_OF_SYNC = 51
IPConnection.ERROR_NON_ASCII_CHAR_IN_SECRET = 71
IPConnection.ERROR_WRONG_DEVICE_TYPE = 81
IPConnection.ERROR_DEVICE_REPLACED = 82
IPConnection.ERROR_WRONG_RESPONSE_LENGTH = 83
IPConnection.ERROR_INT64_NOT_SUPPORTED = 91
Der Namespace der JavaScript Bindings ist Tinkerforge.*.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:
var oled128x64 = new BrickletOLED128x64("YOUR_DEVICE_UID", ipcon)
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
| Parameter: |
|
|---|---|
| Callback-Parameter: |
|
| Rückgabe: |
|
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.
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.
| Parameter: |
|
|---|---|
| Callback-Parameter: |
|
| Rückgabe: |
|
Setzt das Fenster in welches mit write() geschrieben
werden kann. Eine Zeile (Row) hat eine Höhe von 8 Pixel.
| Callback-Parameter: |
|
|---|---|
| Rückgabe: |
|
Löscht den aktuellen Inhalt des mit newWindow() gesetztem Fensters.
| Parameter: |
|
|---|---|
| Callback-Parameter: |
|
| Rückgabe: |
|
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.
Der der Zeichensatz entspricht Codepage 437.
| Parameter: |
|
|---|---|
| Callback-Parameter: |
|
| Rückgabe: |
|
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.
| Callback-Parameter: |
|
|---|---|
| Rückgabe: |
|
Gibt die Konfiguration zurück, wie von setDisplayConfiguration() gesetzt.
| Callback-Parameter: |
|
|---|---|
| Rückgabe: |
|
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.
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.
| Rückgabe: |
|
|---|
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.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
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:
Für function_id:
BrickletOLED128x64.FUNCTION_WRITE = 1
BrickletOLED128x64.FUNCTION_NEW_WINDOW = 2
BrickletOLED128x64.FUNCTION_CLEAR_DISPLAY = 3
BrickletOLED128x64.FUNCTION_SET_DISPLAY_CONFIGURATION = 4
BrickletOLED128x64.FUNCTION_WRITE_LINE = 6
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Ä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:
Für function_id:
BrickletOLED128x64.FUNCTION_WRITE = 1
BrickletOLED128x64.FUNCTION_NEW_WINDOW = 2
BrickletOLED128x64.FUNCTION_CLEAR_DISPLAY = 3
BrickletOLED128x64.FUNCTION_SET_DISPLAY_CONFIGURATION = 4
BrickletOLED128x64.FUNCTION_WRITE_LINE = 6
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
Diese Konstante wird verwendet um ein OLED 128x64 Bricklet zu identifizieren.
Die getIdentity() Funktion und der
IPConnection.CALLBACK_ENUMERATE
Callback der IP Connection haben ein device_identifier Parameter um den Typ
des Bricks oder Bricklets anzugeben.
Diese Konstante stellt den Anzeigenamen eines OLED 128x64 Bricklet dar.