JavaScript - Segment Display 4x7 Bricklet 2.0

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

Numeric Value (Node.js)

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

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Segment Display 4x7 Bricklet 2.0

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var sd = new Tinkerforge.BrickletSegmentDisplay4x7V2(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) {
        sd.setBrightness(7); // Set to full brightness

        // Show "- 42" on the Display
        sd.setNumericValue([-2, -1, 4, 2]);
    }
);

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

Set Segments (Node.js)

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

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Segment Display 4x7 Bricklet 2.0

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var sd = new Tinkerforge.BrickletSegmentDisplay4x7V2(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) {
        sd.setBrightness(7); // Set to full brightness

        // Activate all segments
        sd.setSegments([true, true, true, true, true, true, true, true],
                       [true, true, true, true, true, true, true, true],
                       [true, true, true, true, true, true, true, true],
                       [true, true, true, true, true, true, true, true], [true, true],
                       true);
    }
);

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

Numeric Value (HTML)

Download (ExampleNumericValue.html), Test (ExampleNumericValue.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
<!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>Segment Display 4x7 Bricklet 2.0 Numeric Value 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 sd = new Tinkerforge.BrickletSegmentDisplay4x7V2(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) {
                        sd.setBrightness(7); // Set to full brightness

                        // Show "- 42" on the Display
                        sd.setNumericValue([-2, -1, 4, 2]);
                    }
                );
            }
        </script>
    </body>
</html>

Set Segments (HTML)

Download (ExampleSetSegments.html), Test (ExampleSetSegments.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
<!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>Segment Display 4x7 Bricklet 2.0 Set Segments 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 sd = new Tinkerforge.BrickletSegmentDisplay4x7V2(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) {
                        sd.setBrightness(7); // Set to full brightness

                        // Activate all segments
                        sd.setSegments([true, true, true, true, true, true, true, true],
                                       [true, true, true, true, true, true, true, true],
                                       [true, true, true, true, true, true, true, true],
                                       [true, true, true, true, true, true, true, true], [true, true],
                                       true);
                    }
                );
            }
        </script>
    </body>
</html>

API

Allgemein kann jede Methode der JavaScript Bindings zwei optionale Parameter haben, returnCallback und errorCallback. Dies sind benutzerdefinierte Callback-Funktionen. Die returnCallback-Funktion wird mit dem Ergebnissen der Methode als Argumente aufgerufen, falls die Methode 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 BrickletSegmentDisplay4x7V2(uid, ipcon)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: IPConnection
Rückgabe:
  • segmentDisplay4x7V2 – Typ: BrickletSegmentDisplay4x7V2

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

var segmentDisplay4x7V2 = new BrickletSegmentDisplay4x7V2("YOUR_DEVICE_UID", ipcon)

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

BrickletSegmentDisplay4x7V2.setSegments(digit0, digit1, digit2, digit3, colon, tick[, returnCallback][, errorCallback])
Parameter:
  • digit0 – Typ: [boolean, ...], Länge: 8
  • digit1 – Typ: [boolean, ...], Länge: 8
  • digit2 – Typ: [boolean, ...], Länge: 8
  • digit3 – Typ: [boolean, ...], Länge: 8
  • colon – Typ: [boolean, ...], Länge: 2
  • tick – Typ: boolean
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Setzt die einzelnen Segmente des Segment Display 4x7 Bricklet 2.0 Segment für Segment.

Die Daten sind aufgeteilt in die vier Ziffern (digit0-3), dem Doppelpunkt (colon) und dem Hochkomma (tick).

Die Indizes der Segmente in den Ziffern und dem Doppelpunkt sind wie folgt aufgeteilt:

Indizes der Segmente
BrickletSegmentDisplay4x7V2.getSegments([returnCallback][, errorCallback])
Callback-Parameter:
  • digit0 – Typ: [boolean, ...], Länge: 8
  • digit1 – Typ: [boolean, ...], Länge: 8
  • digit2 – Typ: [boolean, ...], Länge: 8
  • digit3 – Typ: [boolean, ...], Länge: 8
  • colon – Typ: [boolean, ...], Länge: 2
  • tick – Typ: boolean
Rückgabe:
  • undefined

Gibt die Segmentdaten zurück, wie von setSegments() gesetzt.

BrickletSegmentDisplay4x7V2.setBrightness(brightness[, returnCallback][, errorCallback])
Parameter:
  • brightness – Typ: int, Wertebereich: [0 bis 255]
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Die Helligkeit kann zwischen 0 (dunkel) und 7 (hell) gesetzt werden.

Der Standardwert ist 7.

BrickletSegmentDisplay4x7V2.getBrightness([returnCallback][, errorCallback])
Callback-Parameter:
  • brightness – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:
  • undefined

Gibt die Helligkeit zurück, wie von setBrightness() gesetzt.

BrickletSegmentDisplay4x7V2.setNumericValue(value[, returnCallback][, errorCallback])
Parameter:
  • value – Typ: [int, ...], Länge: 4, Wertebereich: [-128 bis 127]
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Setzt einen numerischen Wert für jede Ziffer. Die Werte können zwischen -2 und 15 seien. Die Werte repräsentieren:

  • -2: Minuszeichen
  • -1: Leerstelle
  • 0-9: 0-9
  • 10: A
  • 11: b
  • 12: C
  • 13: d
  • 14: E
  • 15: F

Beispiel: Ein Aufruf mit [-2, -1, 4, 2] erzeugt eine Anzeige auf dem Display von "- 42".

BrickletSegmentDisplay4x7V2.setSelectedSegment(segment, value[, returnCallback][, errorCallback])
Parameter:
  • segment – Typ: int, Wertebereich: [0 bis 255]
  • value – Typ: boolean
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Aktiviert/deaktiviert ein selektiertes Segment.

Die Indizes sind wie folgt aufgeteilt:

Indizes für einzeln selektierte Segmente
BrickletSegmentDisplay4x7V2.getSelectedSegment(segment[, returnCallback][, errorCallback])
Parameter:
  • segment – Typ: int, Wertebereich: [0 bis 255]
Callback-Parameter:
  • value – Typ: boolean
Rückgabe:
  • undefined

Gibt den Wert eines einzelnen Segments zurück.

Fortgeschrittene Funktionen

BrickletSegmentDisplay4x7V2.startCounter(valueFrom, valueTo, increment, length[, returnCallback][, errorCallback])
Parameter:
  • valueFrom – Typ: int, Wertebereich: [-215 bis 215 - 1]
  • valueTo – Typ: int, Wertebereich: [-215 bis 215 - 1]
  • increment – Typ: int, Wertebereich: [-215 bis 215 - 1]
  • length – Typ: int, Wertebereich: [0 bis 232 - 1]
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Starter einen Zähler mit dem from Wert der bis zum to Wert zählt mit einer Schrittweite von increment. Das Argument length gibt die Pause zwischen den Erhöhungen in ms an.

Beispiel: Wenn from auf 0, to auf 100, increment auf 1 und length auf 1000 gesetzt wird, wird ein Zähler gestartet der von 0 bis 100 zählt mit Rate von einer Sekunde zwischen jeder Erhöhung.

Der Maximalwert für from, to und increment ist 9999, der Minimalwert ist -999.

Wenn increment negativ ist läuft der Zähler rückwärts.

Der Zähler kann jederzeit durch einen Aufruf von setSegments() oder setNumericValue() gestoppt werden.

BrickletSegmentDisplay4x7V2.getCounterValue([returnCallback][, errorCallback])
Callback-Parameter:
  • value – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • undefined

Gibt den aktuellen Zählerstand zurück der auf der Anzeige angezeigt wird.

Wenn kein Zähler läuft wird eine 0 zurückgegeben.

BrickletSegmentDisplay4x7V2.getAPIVersion()
Rückgabe:
  • apiVersion – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]

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.

BrickletSegmentDisplay4x7V2.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:

  • BrickletSegmentDisplay4x7V2.FUNCTION_SET_SEGMENTS = 1
  • BrickletSegmentDisplay4x7V2.FUNCTION_SET_BRIGHTNESS = 3
  • BrickletSegmentDisplay4x7V2.FUNCTION_SET_NUMERIC_VALUE = 5
  • BrickletSegmentDisplay4x7V2.FUNCTION_SET_SELECTED_SEGMENT = 6
  • BrickletSegmentDisplay4x7V2.FUNCTION_START_COUNTER = 8
  • BrickletSegmentDisplay4x7V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletSegmentDisplay4x7V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletSegmentDisplay4x7V2.FUNCTION_RESET = 243
  • BrickletSegmentDisplay4x7V2.FUNCTION_WRITE_UID = 248
BrickletSegmentDisplay4x7V2.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:

  • BrickletSegmentDisplay4x7V2.FUNCTION_SET_SEGMENTS = 1
  • BrickletSegmentDisplay4x7V2.FUNCTION_SET_BRIGHTNESS = 3
  • BrickletSegmentDisplay4x7V2.FUNCTION_SET_NUMERIC_VALUE = 5
  • BrickletSegmentDisplay4x7V2.FUNCTION_SET_SELECTED_SEGMENT = 6
  • BrickletSegmentDisplay4x7V2.FUNCTION_START_COUNTER = 8
  • BrickletSegmentDisplay4x7V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletSegmentDisplay4x7V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletSegmentDisplay4x7V2.FUNCTION_RESET = 243
  • BrickletSegmentDisplay4x7V2.FUNCTION_WRITE_UID = 248
BrickletSegmentDisplay4x7V2.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.

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

BrickletSegmentDisplay4x7V2.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 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:

Für mode:

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

Für status:

  • BrickletSegmentDisplay4x7V2.BOOTLOADER_STATUS_OK = 0
  • BrickletSegmentDisplay4x7V2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletSegmentDisplay4x7V2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletSegmentDisplay4x7V2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletSegmentDisplay4x7V2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletSegmentDisplay4x7V2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletSegmentDisplay4x7V2.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:

  • BrickletSegmentDisplay4x7V2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletSegmentDisplay4x7V2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletSegmentDisplay4x7V2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletSegmentDisplay4x7V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletSegmentDisplay4x7V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletSegmentDisplay4x7V2.setWriteFirmwarePointer(pointer[, returnCallback][, errorCallback])
Parameter:
  • pointer – Typ: int, 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.

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

BrickletSegmentDisplay4x7V2.setStatusLEDConfig(config[, returnCallback][, errorCallback])
Parameter:
  • config – Typ: int, Wertebereich: Siehe Konstanten
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:

  • BrickletSegmentDisplay4x7V2.STATUS_LED_CONFIG_OFF = 0
  • BrickletSegmentDisplay4x7V2.STATUS_LED_CONFIG_ON = 1
  • BrickletSegmentDisplay4x7V2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletSegmentDisplay4x7V2.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletSegmentDisplay4x7V2.getStatusLEDConfig([returnCallback][, errorCallback])
Callback-Parameter:
  • config – Typ: int, Wertebereich: Siehe Konstanten
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:

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

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.

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

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

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

BrickletSegmentDisplay4x7V2.getIdentity([returnCallback][, errorCallback])
Callback-Parameter:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: char
  • hardwareVersion – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: [int, ...], Länge: 3, 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 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

BrickletSegmentDisplay4x7V2.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:

segmentDisplay4x7V2.on(BrickletSegmentDisplay4x7V2.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.

BrickletSegmentDisplay4x7V2.CALLBACK_COUNTER_FINISHED
Callback-Parameter:
  • undefined

Diese Callback wird ausgelöst, wenn der Zähler (siehe startCounter()) fertig ist.

Konstanten

BrickletSegmentDisplay4x7V2.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Segment Display 4x7 Bricklet 2.0 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.

BrickletSegmentDisplay4x7V2.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Segment Display 4x7 Bricklet 2.0 dar.