JavaScript - Segment Display 4x7 Bricklet

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

Simple (Node.js)

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

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Segment Display 4x7 Bricklet
var DIGITS = [0x3f,0x06,0x5b,0x4f,
              0x66,0x6d,0x7d,0x07,
              0x7f,0x6f,0x77,0x7c,
              0x39,0x5e,0x79,0x71]; // 0~9,A,b,C,d,E,F

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var sd = new Tinkerforge.BrickletSegmentDisplay4x7(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) {
        // Write "4223" to the display with full brightness without colon
        var segments = [DIGITS[4], DIGITS[2], DIGITS[2], DIGITS[3]];
        sd.setSegments(segments, 7, false);
    }
);

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

Simple (HTML)

Download (ExampleSimple.html), Test (ExampleSimple.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
<!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 Simple 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();
                }
                var DIGITS = [0x3f,0x06,0x5b,0x4f,
                              0x66,0x6d,0x7d,0x07,
                              0x7f,0x6f,0x77,0x7c,
                              0x39,0x5e,0x79,0x71]; // 0~9,A,b,C,d,E,F
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var sd = new Tinkerforge.BrickletSegmentDisplay4x7(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) {
                        // Write "4223" to the display with full brightness without colon
                        var segments = [DIGITS[4], DIGITS[2], DIGITS[2], DIGITS[3]];
                        sd.setSegments(segments, 7, false);
                    }
                );
            }
        </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 BrickletSegmentDisplay4x7(uid, ipcon)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: IPConnection
Rückgabe:
  • segmentDisplay4x7 – Typ: BrickletSegmentDisplay4x7

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

var segmentDisplay4x7 = new BrickletSegmentDisplay4x7("YOUR_DEVICE_UID", ipcon)

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

BrickletSegmentDisplay4x7.setSegments(segments, brightness, colon[, returnCallback][, errorCallback])
Parameter:
  • segments – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • brightness – Typ: int, Wertebereich: [0 bis 255]
  • colon – Typ: boolean
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Die 7-Segment-Anzeige kann mit Bitmaps gesetzt werden. Jedes Bit kontrolliert ein Segment:

Bitreihenfolge eines Segments

Beispiel: Um eine "5" auf der Anzeige darzustellen müssen die Segment 0, 2, 3, 5 und 6 aktiviert werden. Dies kann mit der Zahl 0b01101101 = 0x6d = 109 repräsentiert werden.

Die Helligkeit kann zwischen 0 (dunkel) und 7 (hell) gesetzt werden. Der dritte Parameter aktiviert/deaktiviert den Doppelpunkt auf der Anzeige.

BrickletSegmentDisplay4x7.getSegments([returnCallback][, errorCallback])
Callback-Parameter:
  • segments – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • brightness – Typ: int, Wertebereich: [0 bis 255]
  • colon – Typ: boolean
Rückgabe:
  • undefined

Gibt die Segment-, Helligkeit- und Doppelpunktdaten zurück, wie von setSegments() gesetzt.

Fortgeschrittene Funktionen

BrickletSegmentDisplay4x7.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 das increment negativ ist läuft der Zähler rückwärts.

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

BrickletSegmentDisplay4x7.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 am laufen ist wird eine 0 zurückgegeben.

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

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

  • BrickletSegmentDisplay4x7.FUNCTION_SET_SEGMENTS = 1
  • BrickletSegmentDisplay4x7.FUNCTION_START_COUNTER = 3
BrickletSegmentDisplay4x7.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:

  • BrickletSegmentDisplay4x7.FUNCTION_SET_SEGMENTS = 1
  • BrickletSegmentDisplay4x7.FUNCTION_START_COUNTER = 3
BrickletSegmentDisplay4x7.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.

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

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

segmentDisplay4x7.on(BrickletSegmentDisplay4x7.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.

BrickletSegmentDisplay4x7.CALLBACK_COUNTER_FINISHED
Callback-Parameter:
  • undefined

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

Konstanten

BrickletSegmentDisplay4x7.DEVICE_IDENTIFIER

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

BrickletSegmentDisplay4x7.DEVICE_DISPLAY_NAME

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