Dies ist die Beschreibung der JavaScript API Bindings für das Line Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Line 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).
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 Line Bricklet
var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var l = new Tinkerforge.BrickletLine(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) {
// Get current reflectivity
l.getReflectivity(
function (reflectivity) {
console.log('Reflectivity: ' + reflectivity);
},
function (error) {
console.log('Error: ' + error);
}
);
}
);
console.log('Press key to exit');
process.stdin.on('data',
function (data) {
ipcon.disconnect();
process.exit(0);
}
);
|
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 | var Tinkerforge = require('tinkerforge');
var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Line Bricklet
var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var l = new Tinkerforge.BrickletLine(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) {
// Set period for reflectivity callback to 1s (1000ms)
// Note: The reflectivity callback is only called every second
// if the reflectivity has changed since the last call!
l.setReflectivityCallbackPeriod(1000);
}
);
// Register reflectivity callback
l.on(Tinkerforge.BrickletLine.CALLBACK_REFLECTIVITY,
// Callback function for reflectivity callback
function (reflectivity) {
console.log('Reflectivity: ' + reflectivity);
}
);
console.log('Press key to exit');
process.stdin.on('data',
function (data) {
ipcon.disconnect();
process.exit(0);
}
);
|
Download (ExampleThreshold.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 38 39 40 41 | var Tinkerforge = require('tinkerforge');
var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Line Bricklet
var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var l = new Tinkerforge.BrickletLine(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) {
// Get threshold callbacks with a debounce time of 1 second (1000ms)
l.setDebouncePeriod(1000);
// Configure threshold for reflectivity "greater than 2000"
l.setReflectivityCallbackThreshold('>', 2000, 0);
}
);
// Register reflectivity reached callback
l.on(Tinkerforge.BrickletLine.CALLBACK_REFLECTIVITY_REACHED,
// Callback function for reflectivity reached callback
function (reflectivity) {
console.log('Reflectivity: ' + reflectivity);
}
);
console.log('Press key to exit');
process.stdin.on('data',
function (data) {
ipcon.disconnect();
process.exit(0);
}
);
|
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 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>Line 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();
}
ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var l = new Tinkerforge.BrickletLine(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) {
// Get current reflectivity
l.getReflectivity(
function (reflectivity) {
textArea.value += 'Reflectivity: ' + reflectivity + '\n';
},
function (error) {
textArea.value += 'Error: ' + error + '\n';
}
);
}
);
}
</script>
</body>
</html>
|
Download (ExampleCallback.html), Test (ExampleCallback.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 59 60 61 62 | <!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>Line Bricklet Callback 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 l = new Tinkerforge.BrickletLine(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) {
// Set period for reflectivity callback to 1s (1000ms)
// Note: The reflectivity callback is only called every second
// if the reflectivity has changed since the last call!
l.setReflectivityCallbackPeriod(1000);
}
);
// Register reflectivity callback
l.on(Tinkerforge.BrickletLine.CALLBACK_REFLECTIVITY,
// Callback function for reflectivity callback
function (reflectivity) {
textArea.value += 'Reflectivity: ' + reflectivity + '\n';
textArea.scrollTop = textArea.scrollHeight;
}
);
}
</script>
</body>
</html>
|
Download (ExampleThreshold.html), Test (ExampleThreshold.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 59 60 61 62 63 | <!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>Line Bricklet Threshold 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 l = new Tinkerforge.BrickletLine(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) {
// Get threshold callbacks with a debounce time of 1 second (1000ms)
l.setDebouncePeriod(1000);
// Configure threshold for reflectivity "greater than 2000"
l.setReflectivityCallbackThreshold('>', 2000, 0);
}
);
// Register reflectivity reached callback
l.on(Tinkerforge.BrickletLine.CALLBACK_REFLECTIVITY_REACHED,
// Callback function for reflectivity reached callback
function (reflectivity) {
textArea.value += 'Reflectivity: ' + reflectivity + '\n';
textArea.scrollTop = textArea.scrollHeight;
}
);
}
</script>
</body>
</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:
Der Namespace der JavaScript Bindings ist Tinkerforge.*
.
BrickletLine
(uid, ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
var line = new BrickletLine("YOUR_DEVICE_UID", ipcon)
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletLine.
getReflectivity
([returnCallback][, errorCallback])¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Gibt die aktuell gemessene Reflektivität zurück. Die Reflektivität ist ein Wert zwischen 0 (nicht reflektiv) und 4095 (sehr reflektiv).
Normalerweise hat schwarz eine geringe Reflektivität während weiß eine hohe Reflektivität hat.
Wenn die Reflektivität periodisch abgefragt werden soll, wird empfohlen
den CALLBACK_REFLECTIVITY
Callback zu nutzen und die Periode mit
setReflectivityCallbackPeriod()
vorzugeben.
BrickletLine.
getIdentity
([returnCallback][, errorCallback])¶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.
BrickletLine.
on
(callback_id, function[, errorCallback])¶Parameter: |
|
---|---|
Rückgabe: |
|
Registriert die function
für die gegebene callback_id
.
Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.
BrickletLine.
setReflectivityCallbackPeriod
(period[, returnCallback][, errorCallback])¶Parameter: |
|
---|---|
Callback-Parameter: |
|
Rückgabe: |
|
Setzt die Periode mit welcher der CALLBACK_REFLECTIVITY
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
Der CALLBACK_REFLECTIVITY
Callback wird nur ausgelöst, wenn sich die Reflektivität
seit der letzten Auslösung geändert hat.
BrickletLine.
getReflectivityCallbackPeriod
([returnCallback][, errorCallback])¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Gibt die Periode zurück, wie von setReflectivityCallbackPeriod()
gesetzt.
BrickletLine.
setReflectivityCallbackThreshold
(option, min, max[, returnCallback][, errorCallback])¶Parameter: |
|
---|---|
Callback-Parameter: |
|
Rückgabe: |
|
Setzt den Schwellwert für den CALLBACK_REFLECTIVITY_REACHED
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn die Reflektivität außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn die Reflektivität innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn die Reflektivität kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Reflektivität größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletLine.
getReflectivityCallbackThreshold
([returnCallback][, errorCallback])¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Gibt den Schwellwert zurück, wie von setReflectivityCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletLine.
setDebouncePeriod
(debounce[, returnCallback][, errorCallback])¶Parameter: |
|
---|---|
Callback-Parameter: |
|
Rückgabe: |
|
Setzt die Periode mit welcher die Schwellwert Callback
ausgelöst wird, wenn der Schwellwert
weiterhin erreicht bleibt.
BrickletLine.
getDebouncePeriod
([returnCallback][, errorCallback])¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Gibt die Entprellperiode zurück, wie von setDebouncePeriod()
gesetzt.
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:
line.on(BrickletLine.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.
BrickletLine.
CALLBACK_REFLECTIVITY
¶Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit setReflectivityCallbackPeriod()
,
ausgelöst. Der Parameter ist die Reflektivität des Sensors.
Der CALLBACK_REFLECTIVITY
Callback wird nur ausgelöst, wenn sich die Reflektivität
seit der letzten Auslösung geändert hat.
BrickletLine.
CALLBACK_REFLECTIVITY_REACHED
¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
setReflectivityCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter ist die Reflektivität des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit setDebouncePeriod()
gesetzt, ausgelöst.
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.
BrickletLine.
getAPIVersion
()¶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.
BrickletLine.
getResponseExpected
(functionId[, errorCallback])¶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:
BrickletLine.
setResponseExpected
(functionId, responseExpected[, errorCallback])¶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:
BrickletLine.
setResponseExpectedAll
(responseExpected)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
BrickletLine.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Line 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.
BrickletLine.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Line Bricklet dar.