JavaScript - E-Paper 296x128 Bricklet

Dies ist die Beschreibung der JavaScript API Bindings für das E-Paper 296x128 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des E-Paper 296x128 Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Hello World (Node.js)

Download (ExampleHelloWorld.js)

 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
var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your E-Paper 296x128 Bricklet

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var ep = new Tinkerforge.BrickletEPaper296x128(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // Use black background
        ep.fillDisplay(Tinkerforge.BrickletEPaper296x128.COLOR_BLACK);

        // Write big white "Hello World" in the middle of the screen
        ep.drawText(16, 48, Tinkerforge.BrickletEPaper296x128.FONT_24X32,
                    Tinkerforge.BrickletEPaper296x128.COLOR_WHITE,
                    Tinkerforge.BrickletEPaper296x128.ORIENTATION_HORIZONTAL,
                    'Hello World');
        ep.draw();
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Hello World (HTML)

Download (ExampleHelloWorld.html), Test (ExampleHelloWorld.html)

 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
48
49
50
51
52
53
54
55
56
57
58
<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>E-Paper 296x128 Bricklet Hello World Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var ep = new Tinkerforge.BrickletEPaper296x128(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // Use black background
                        ep.fillDisplay(Tinkerforge.BrickletEPaper296x128.COLOR_BLACK);

                        // Write big white "Hello World" in the middle of the screen
                        ep.drawText(16, 48, Tinkerforge.BrickletEPaper296x128.FONT_24X32,
                                    Tinkerforge.BrickletEPaper296x128.COLOR_WHITE,
                                    Tinkerforge.BrickletEPaper296x128.ORIENTATION_HORIZONTAL,
                                    'Hello World');
                        ep.draw();
                    }
                );
            }
        </script>
    </body>
</html>

API

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

Der Namespace der JavaScript Bindings ist Tinkerforge.*.

Grundfunktionen

new BrickletEPaper296x128(uid, ipcon)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: IPConnection
Rückgabe:
  • ePaper296x128 – Typ: BrickletEPaper296x128

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

var ePaper296x128 = new BrickletEPaper296x128("YOUR_DEVICE_UID", ipcon)

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

BrickletEPaper296x128.draw([returnCallback][, errorCallback])
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Zeichnet den aktuellen Schwarz-/Weiß- und Rot- oder Grau-Buffer auf das E-Paper-Display.

Das Bricklet nutzt kein Double-Buffering. Diese Funktion sollte daher nicht aufgerufen werden während in den Buffer geschrieben wird. Siehe getDrawStatus().

BrickletEPaper296x128.getDrawStatus([returnCallback][, errorCallback])
Callback-Parameter:
  • drawStatus – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • undefined

Gibt einen von drei möglichen Status zurück:

  • Idle
  • Copying: Daten werden vom Buffer des Bricklets in den Buffer des Displays kopiert.
  • Drawing: Das Display aktualisiert den Inhalt (während dieser Phase flackert das Display).

Der Buffer kann beschrieben werden (durch eine der write- oder draw-Funktionen) wenn der Status entweder idle oder drawing ist. Der Buffer sollte nicht beschrieben werden während er kopiert wird. Es findet kein Double-Buffering statt.

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

Für draw_status:

  • BrickletEPaper296x128.DRAW_STATUS_IDLE = 0
  • BrickletEPaper296x128.DRAW_STATUS_COPYING = 1
  • BrickletEPaper296x128.DRAW_STATUS_DRAWING = 2
BrickletEPaper296x128.writeBlackWhite(xStart, yStart, xEnd, yEnd, pixels[, returnCallback][, errorCallback])
Parameter:
  • xStart – Typ: int, Wertebereich: [0 bis 295]
  • yStart – Typ: int, Wertebereich: [0 bis 127]
  • xEnd – Typ: int, Wertebereich: [0 bis 295]
  • yEnd – Typ: int, Wertebereich: [0 bis 127]
  • pixels – Typ: [boolean, ...], Länge: variabel
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Schreibt schwarze/weiße Pixel in das angegebene Fenster in den Buffer.

Die Pixel werden zeilenweise von oben nach unten geschrieben und die Zeilen werden jeweils von links nach rechts geschrieben.

Der Wert 0 (false) entspricht einem schwarzen Pixel und der Wert 1 (true) einem weißen Pixel.

Diese Funktion schreibt Pixel in den Schwarz-/Weiß-Buffer. Der Buffer kann mit der Funktion draw() auf das Display übertragen werden.

Die Funktion writeColor() kann genutzt werden um rote oder graue Pixel zu schreiben.

BrickletEPaper296x128.readBlackWhite(xStart, yStart, xEnd, yEnd[, returnCallback][, errorCallback])
Parameter:
  • xStart – Typ: int, Wertebereich: [0 bis 295]
  • yStart – Typ: int, Wertebereich: [0 bis 127]
  • xEnd – Typ: int, Wertebereich: [0 bis 295]
  • yEnd – Typ: int, Wertebereich: [0 bis 127]
Callback-Parameter:
  • pixels – Typ: [boolean, ...], Länge: variabel
Rückgabe:
  • undefined

Gibt den aktuellen Inhalt des Schwarz-/Weiß-Buffers für das spezifizierte Fenster zurück.

Die Pixel werden zeilenweise von oben nach unten gelesen und die Zeilen werden jeweils von links nach rechts gelesen.

Der aktuelle Inhalt des Buffers muss nicht dem aktuellen Inhalt des Displays entsprechen. Es ist möglich das der Buffer noch nicht auf das Display übertragen wurde und nach einem Neustart wird der Buffer des Bricklets als schwarz initialisiert, während das Display den Inhalt beibehält.

BrickletEPaper296x128.writeColor(xStart, yStart, xEnd, yEnd, pixels[, returnCallback][, errorCallback])
Parameter:
  • xStart – Typ: int, Wertebereich: [0 bis 295]
  • yStart – Typ: int, Wertebereich: [0 bis 127]
  • xEnd – Typ: int, Wertebereich: [0 bis 295]
  • yEnd – Typ: int, Wertebereich: [0 bis 127]
  • pixels – Typ: [boolean, ...], Länge: variabel
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Das E-Paper 296x128 Bricklet ist in den Farben schwarz/weiß/rot sowie schwarz/weiß/grau verfügbar. Abhängig vom verwendeten Modell schreibt diese Funktion entweder rote oder graue Pixel in das spezifizierte Fenster des Buffers.

Die Pixel werden zeilenweise von oben nach unten geschrieben und die Zeilen werden jeweils von links nach rechts geschrieben.

Der Wert 0 (false) bedeutet dass das Pixel keine Farbe hat. Es ist in diesem Fall entweder schwarz oder weiß (siehe writeBlackWhite()). Der Wert 1 (true) entspricht einem roten oder grauen Pixel, abhängig vom Modell des Bricklets.

Diese Funktion schreibt Pixel in den Rot- oder Grau-Buffer. Der Buffer kann mit der Funktion draw() auf das Display übertragen werden.

Die Funktion writeBlackWhite() kann genutzt werden um schwarze/weiße Pixel zu schreiben.

BrickletEPaper296x128.readColor(xStart, yStart, xEnd, yEnd[, returnCallback][, errorCallback])
Parameter:
  • xStart – Typ: int, Wertebereich: [0 bis 295]
  • yStart – Typ: int, Wertebereich: [0 bis 127]
  • xEnd – Typ: int, Wertebereich: [0 bis 295]
  • yEnd – Typ: int, Wertebereich: [0 bis 127]
Callback-Parameter:
  • pixels – Typ: [boolean, ...], Länge: variabel
Rückgabe:
  • undefined

Gibt den aktuellen Inhalt des Rot- oder Grau-Buffers für das spezifizierte Fenster zurück.

Die Pixel werden zeilenweise von oben nach unten gelesen und die Zeilen werden jeweils von links nach rechts gelesen.

Der aktuelle Inhalt des Buffers muss nicht dem aktuellen Inhalt des Displays entsprechen. Es ist möglich das der Buffer noch nicht auf das Display übertragen wurde und nach einem Neustart wird der Buffer des Bricklets als schwarz initialisiert, während das Display den Inhalt beibehält.

BrickletEPaper296x128.fillDisplay(color[, returnCallback][, errorCallback])
Parameter:
  • color – Typ: int, Wertebereich: Siehe Konstanten
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Füllt den kompletten Inhalt des Displays mit der gegebenen Farbe.

Diese Funktion schreibt Pixel in den Schwarz-/Weiß-/Grau|Rot-Buffer. Der Buffer kann mit der Funktion draw() auf das Display übertragen werden.

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

Für color:

  • BrickletEPaper296x128.COLOR_BLACK = 0
  • BrickletEPaper296x128.COLOR_WHITE = 1
  • BrickletEPaper296x128.COLOR_RED = 2
  • BrickletEPaper296x128.COLOR_GRAY = 2
BrickletEPaper296x128.drawText(positionX, positionY, font, color, orientation, text[, returnCallback][, errorCallback])
Parameter:
  • positionX – Typ: int, Wertebereich: [0 bis 295]
  • positionY – Typ: int, Wertebereich: [0 bis 127]
  • font – Typ: int, Wertebereich: Siehe Konstanten
  • color – Typ: int, Wertebereich: Siehe Konstanten
  • orientation – Typ: int, Wertebereich: Siehe Konstanten
  • text – Typ: string, Länge: bis zu 50
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Zeichnet einen Text mit bis zu 50 Buchstaben an die Pixelposition (x, y).

Es können 9 unterschiedliche Font-Größen genutzt werden und der Text kann in schwarz/weiß/rot|grau gezeichnet werden. Der Text kann horizontal oder vertikal gezeichnet werden.

Diese Funktion schreibt Pixel in den Schwarz-/Weiß-/Grau|Rot-Buffer. Der Buffer kann mit der Funktion draw() auf das Display übertragen werden.

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

Für font:

  • BrickletEPaper296x128.FONT_6X8 = 0
  • BrickletEPaper296x128.FONT_6X16 = 1
  • BrickletEPaper296x128.FONT_6X24 = 2
  • BrickletEPaper296x128.FONT_6X32 = 3
  • BrickletEPaper296x128.FONT_12X16 = 4
  • BrickletEPaper296x128.FONT_12X24 = 5
  • BrickletEPaper296x128.FONT_12X32 = 6
  • BrickletEPaper296x128.FONT_18X24 = 7
  • BrickletEPaper296x128.FONT_18X32 = 8
  • BrickletEPaper296x128.FONT_24X32 = 9

Für color:

  • BrickletEPaper296x128.COLOR_BLACK = 0
  • BrickletEPaper296x128.COLOR_WHITE = 1
  • BrickletEPaper296x128.COLOR_RED = 2
  • BrickletEPaper296x128.COLOR_GRAY = 2

Für orientation:

  • BrickletEPaper296x128.ORIENTATION_HORIZONTAL = 0
  • BrickletEPaper296x128.ORIENTATION_VERTICAL = 1
BrickletEPaper296x128.drawLine(positionXStart, positionYStart, positionXEnd, positionYEnd, color[, returnCallback][, errorCallback])
Parameter:
  • positionXStart – Typ: int, Wertebereich: [0 bis 295]
  • positionYStart – Typ: int, Wertebereich: [0 bis 127]
  • positionXEnd – Typ: int, Wertebereich: [0 bis 295]
  • positionYEnd – Typ: int, Wertebereich: [0 bis 127]
  • color – Typ: int, Wertebereich: Siehe Konstanten
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Zeichnet eine Linie von (x, y)-Start nach (x, y)-Ende in der eingestellten Farbe.

Diese Funktion schreibt Pixel in den Schwarz-/Weiß-/Grau|Rot-Buffer. Der Buffer kann mit der Funktion draw() auf das Display übertragen werden.

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

Für color:

  • BrickletEPaper296x128.COLOR_BLACK = 0
  • BrickletEPaper296x128.COLOR_WHITE = 1
  • BrickletEPaper296x128.COLOR_RED = 2
  • BrickletEPaper296x128.COLOR_GRAY = 2
BrickletEPaper296x128.drawBox(positionXStart, positionYStart, positionXEnd, positionYEnd, fill, color[, returnCallback][, errorCallback])
Parameter:
  • positionXStart – Typ: int, Wertebereich: [0 bis 295]
  • positionYStart – Typ: int, Wertebereich: [0 bis 127]
  • positionXEnd – Typ: int, Wertebereich: [0 bis 295]
  • positionYEnd – Typ: int, Wertebereich: [0 bis 127]
  • fill – Typ: boolean
  • color – Typ: int, Wertebereich: Siehe Konstanten
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Zeichnet ein Rechteck von (x, y)-Start nach (x, y)-Ende in der eingestellten Farbe.

Wenn fill auf true gesetzt wird, wird das Rechteck mit der angegebenen Farbe ausgefüllt. Ansonsten wird nur der Umriss gezeichnet.

Diese Funktion schreibt Pixel in den Schwarz-/Weiß-/Grau|Rot-Buffer. Der Buffer kann mit der Funktion draw() auf das Display übertragen werden.

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

Für color:

  • BrickletEPaper296x128.COLOR_BLACK = 0
  • BrickletEPaper296x128.COLOR_WHITE = 1
  • BrickletEPaper296x128.COLOR_RED = 2
  • BrickletEPaper296x128.COLOR_GRAY = 2

Fortgeschrittene Funktionen

BrickletEPaper296x128.setUpdateMode(updateMode[, returnCallback][, errorCallback])
Parameter:
  • updateMode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Bemerkung

Der Default Update-Modus basiert auf den Standardeinstellungen des E-Paper-Display Herstellers. Alle anderen Modi sind experimentell und es tritt mehr Ghosting sowie mögliche Langzeiteffekte auf.

Für einen Überblick über die Funktionsweise eines E-Paper-Displays können wir das exzellente Video von Ben Krasnow empfehlen: https://www.youtube.com/watch?v=MsbiO8EAsGw.

Falls es nicht klar ist was diese Optionen bedeuten, empfehlen wir den Update-Modus auf Default zu belassen.

Aktuell gibt es drei unterschiedliche Update-Modi:

  • Default: Einstellungen wie vom Hersteller vorgegeben. Eine Bildschirmaktualisierung dauert ungefähr 7,5 Sekunden und während der Aktualisierung flackert der Bildschirm mehrfach.
  • Black/White: In diesem Modus werden nur die schwarzen und weißen Pixel aktualisiert. Es werden die Herstellereinstellungen für schwarz/weiß genutzt, allerdings wird der rote oder graue Buffer ignoriert. Mit diesem Modus flackert das Display bei einer Aktualisierung einmal und es dauert in etwa 2,5 Sekunden. Verglichen zu der Standardeinstellung entsteht mehr Ghosting.
  • Delta: In diesem Modus werden auch nur die schwarzen und weißen Pixel aktualisiert. Es wird eine aggressive Aktualisierungsmethode genutzt. Änderungen werden nicht auf dem kompletten Buffer angewendet, sondern nur auf dem Unterschied (Delta) zwischen dem letzten und dem nächsten Buffer. Mit diesem Modus flackert das Display nicht und eine Aktualisierung dauert 900-950ms. Verglichen zu den anderen beiden Modi gibt es mehr Ghosting. Dieser Modus ist gut geeignet um z.B. flackerfrei einen regelmäßig aktualisierten Text darzustellen.

Wenn der Black/White- oder Delta-Modus zusammen mit dem schwarz/weiß/rot-Bildschirm verwendet wird, bekommt die weiße Farbe nach mehrmaligem Wechsel zwischen schwarz und weiß einen rötlichen Stich.

Wenn der Delta-Modus mit schnell Aktualisierungen verwendet wird, empfehlen wir in regelmäßigen Abständen zurück zum Default-Modus zu wechseln um dort vollflächig zwischen den drei Farben hin und her zu wechseln. Dadurch wird das Ghosting welches durch die Verwendung des Delta-Modus entsteht wieder entfernt. Danach kann dann wieder in den Delta-Modus gewechselt werden für flackerfreie Aktualisierungen.

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

Für update_mode:

  • BrickletEPaper296x128.UPDATE_MODE_DEFAULT = 0
  • BrickletEPaper296x128.UPDATE_MODE_BLACK_WHITE = 1
  • BrickletEPaper296x128.UPDATE_MODE_DELTA = 2
BrickletEPaper296x128.getUpdateMode([returnCallback][, errorCallback])
Callback-Parameter:
  • updateMode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:
  • undefined

Gibt den Update Mode zurück, wie von setUpdateMode() gesetzt.

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

Für update_mode:

  • BrickletEPaper296x128.UPDATE_MODE_DEFAULT = 0
  • BrickletEPaper296x128.UPDATE_MODE_BLACK_WHITE = 1
  • BrickletEPaper296x128.UPDATE_MODE_DELTA = 2
BrickletEPaper296x128.setDisplayType(displayType[, returnCallback][, errorCallback])
Parameter:
  • displayType – Typ: int, Wertebereich: Siehe Konstanten
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Setzt den Typ des Displays. Das E-Paper Display ist in den Farben schwarz/weiß/rot und schwarz/weiß/grau verfügbar. Das korrekte Display wird bereits werksseitig während des Flashens und Testens gesetzt. Der Wert wird in nicht-flüchtigem Speicher gespeichert und bleibt bei einem Neustart unverändert.

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

Für display_type:

  • BrickletEPaper296x128.DISPLAY_TYPE_BLACK_WHITE_RED = 0
  • BrickletEPaper296x128.DISPLAY_TYPE_BLACK_WHITE_GRAY = 1
BrickletEPaper296x128.getDisplayType([returnCallback][, errorCallback])
Callback-Parameter:
  • displayType – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • undefined

Gibt den Typ des E-Paper Displays zurück. Der Typ kann entweder schwarz/weiß/rot oder schwarz/weiß/grau sein.

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

Für display_type:

  • BrickletEPaper296x128.DISPLAY_TYPE_BLACK_WHITE_RED = 0
  • BrickletEPaper296x128.DISPLAY_TYPE_BLACK_WHITE_GRAY = 1
BrickletEPaper296x128.getSPITFPErrorCount([returnCallback][, errorCallback])
Callback-Parameter:
  • errorCountAckChecksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: int, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: int, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • undefined

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.

BrickletEPaper296x128.setBootloaderMode(mode[, returnCallback][, errorCallback])
Parameter:
  • mode – Typ: int, Wertebereich: Siehe Konstanten
Callback-Parameter:
  • status – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • undefined

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:

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

Für status:

  • BrickletEPaper296x128.BOOTLOADER_STATUS_OK = 0
  • BrickletEPaper296x128.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletEPaper296x128.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletEPaper296x128.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletEPaper296x128.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletEPaper296x128.BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletEPaper296x128.getBootloaderMode([returnCallback][, errorCallback])
Callback-Parameter:
  • mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • undefined

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

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

Für mode:

  • BrickletEPaper296x128.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletEPaper296x128.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletEPaper296x128.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletEPaper296x128.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletEPaper296x128.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletEPaper296x128.setWriteFirmwarePointer(pointer[, returnCallback][, errorCallback])
Parameter:
  • pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

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.

BrickletEPaper296x128.writeFirmware(data[, returnCallback][, errorCallback])
Parameter:
  • data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Callback-Parameter:
  • status – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:
  • undefined

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.

BrickletEPaper296x128.setStatusLEDConfig(config[, returnCallback][, errorCallback])
Parameter:
  • config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

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:

  • BrickletEPaper296x128.STATUS_LED_CONFIG_OFF = 0
  • BrickletEPaper296x128.STATUS_LED_CONFIG_ON = 1
  • BrickletEPaper296x128.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletEPaper296x128.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletEPaper296x128.getStatusLEDConfig([returnCallback][, errorCallback])
Callback-Parameter:
  • config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • undefined

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

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

Für config:

  • BrickletEPaper296x128.STATUS_LED_CONFIG_OFF = 0
  • BrickletEPaper296x128.STATUS_LED_CONFIG_ON = 1
  • BrickletEPaper296x128.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletEPaper296x128.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletEPaper296x128.getChipTemperature([returnCallback][, errorCallback])
Callback-Parameter:
  • temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]
Rückgabe:
  • undefined

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.

BrickletEPaper296x128.reset([returnCallback][, errorCallback])
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

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.

BrickletEPaper296x128.writeUID(uid[, returnCallback][, errorCallback])
Parameter:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

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.

BrickletEPaper296x128.readUID([returnCallback][, errorCallback])
Callback-Parameter:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • undefined

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

BrickletEPaper296x128.getIdentity([returnCallback][, errorCallback])
Callback-Parameter:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardwareVersion – 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]
  • firmwareVersion – 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]
  • deviceIdentifier – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • undefined

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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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

BrickletEPaper296x128.on(callback_id, function)
Parameter:
  • callback_id – Typ: int
  • function – Typ: function
Rückgabe:
  • undefined

Registriert die function für die gegebene callback_id.

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

Callbacks

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

ePaper296x128.on(BrickletEPaper296x128.CALLBACK_EXAMPLE,
    function (param) {
        console.log(param);
    }
);

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.

BrickletEPaper296x128.CALLBACK_DRAW_STATUS
Callback-Parameter:
  • drawStatus – Typ: int, Wertebereich: Siehe Konstanten

Callback für den aktuellen Draw Status. Diese Callback wird jedes mal ausgelöst, wenn sich der Draw Status ändert (siehe getDrawStatus()).

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

Für draw_status:

  • BrickletEPaper296x128.DRAW_STATUS_IDLE = 0
  • BrickletEPaper296x128.DRAW_STATUS_COPYING = 1
  • BrickletEPaper296x128.DRAW_STATUS_DRAWING = 2

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.

BrickletEPaper296x128.getAPIVersion()
Rückgabe:
  • apiVersion – 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.

BrickletEPaper296x128.getResponseExpected(functionId[, errorCallback])
Parameter:
  • functionId – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: boolean

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:

  • BrickletEPaper296x128.FUNCTION_DRAW = 1
  • BrickletEPaper296x128.FUNCTION_WRITE_BLACK_WHITE = 3
  • BrickletEPaper296x128.FUNCTION_WRITE_COLOR = 5
  • BrickletEPaper296x128.FUNCTION_FILL_DISPLAY = 7
  • BrickletEPaper296x128.FUNCTION_DRAW_TEXT = 8
  • BrickletEPaper296x128.FUNCTION_DRAW_LINE = 9
  • BrickletEPaper296x128.FUNCTION_DRAW_BOX = 10
  • BrickletEPaper296x128.FUNCTION_SET_UPDATE_MODE = 12
  • BrickletEPaper296x128.FUNCTION_SET_DISPLAY_TYPE = 14
  • BrickletEPaper296x128.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletEPaper296x128.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletEPaper296x128.FUNCTION_RESET = 243
  • BrickletEPaper296x128.FUNCTION_WRITE_UID = 248
BrickletEPaper296x128.setResponseExpected(functionId, responseExpected[, errorCallback])
Parameter:
  • functionId – Typ: int, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: boolean
Rückgabe:
  • undefined

Ä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:

  • BrickletEPaper296x128.FUNCTION_DRAW = 1
  • BrickletEPaper296x128.FUNCTION_WRITE_BLACK_WHITE = 3
  • BrickletEPaper296x128.FUNCTION_WRITE_COLOR = 5
  • BrickletEPaper296x128.FUNCTION_FILL_DISPLAY = 7
  • BrickletEPaper296x128.FUNCTION_DRAW_TEXT = 8
  • BrickletEPaper296x128.FUNCTION_DRAW_LINE = 9
  • BrickletEPaper296x128.FUNCTION_DRAW_BOX = 10
  • BrickletEPaper296x128.FUNCTION_SET_UPDATE_MODE = 12
  • BrickletEPaper296x128.FUNCTION_SET_DISPLAY_TYPE = 14
  • BrickletEPaper296x128.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletEPaper296x128.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletEPaper296x128.FUNCTION_RESET = 243
  • BrickletEPaper296x128.FUNCTION_WRITE_UID = 248
BrickletEPaper296x128.setResponseExpectedAll(responseExpected)
Parameter:
  • responseExpected – Typ: boolean
Rückgabe:
  • undefined

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

Konstanten

BrickletEPaper296x128.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein E-Paper 296x128 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.

BrickletEPaper296x128.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines E-Paper 296x128 Bricklet dar.