Software / API Bindings / JavaScript / API Referenz und Beispiele / Bricklets / Industrial Analog Out Bricklet 2.0

JavaScript - Industrial Analog Out Bricklet 2.0¶

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

Simple Current (Node.js)¶

Download (ExampleSimpleCurrent.js)

var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Industrial Analog Out Bricklet 2.0

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var iao = new Tinkerforge.BrickletIndustrialAnalogOutV2(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 output current to 4.5mA
        iao.setCurrent(4500);
        iao.setEnabled(true);
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        iao.setEnabled(false);

        ipcon.disconnect();
        process.exit(0);
    }
);

Simple Voltage (Node.js)¶

Download (ExampleSimpleVoltage.js)

var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Industrial Analog Out Bricklet 2.0

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var iao = new Tinkerforge.BrickletIndustrialAnalogOutV2(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 output voltage to 3.3V
        iao.setVoltage(3300);
        iao.setEnabled(true);
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        iao.setEnabled(false);

        ipcon.disconnect();
        process.exit(0);
    }
);

Simple Current (HTML)¶

Download (ExampleSimpleCurrent.html), Test (ExampleSimpleCurrent.html)

<!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>Industrial Analog Out Bricklet 2.0 Simple Current 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 iao = new Tinkerforge.BrickletIndustrialAnalogOutV2(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 output current to 4.5mA
                        iao.setCurrent(4500);
                        iao.setEnabled(true);
                    }
                );
            }
        </script>
    </body>
</html>

Simple Voltage (HTML)¶

Download (ExampleSimpleVoltage.html), Test (ExampleSimpleVoltage.html)

<!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>Industrial Analog Out Bricklet 2.0 Simple Voltage 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 iao = new Tinkerforge.BrickletIndustrialAnalogOutV2(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 output voltage to 3.3V
                        iao.setVoltage(3300);
                        iao.setEnabled(true);
                    }
                );
            }
        </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
IPConnection.ERROR_WRONG_DEVICE_TYPE = 81
IPConnection.ERROR_DEVICE_REPLACED = 82
IPConnection.ERROR_WRONG_RESPONSE_LENGTH = 83
IPConnection.ERROR_INT64_NOT_SUPPORTED = 91

Der Namespace der JavaScript Bindings ist Tinkerforge.*.

Grundfunktionen¶

new BrickletIndustrialAnalogOutV2(uid, ipcon)¶

Parameter:	uid – Typ: string ipcon – Typ: IPConnection
Rückgabe:	industrialAnalogOutV2 – Typ: BrickletIndustrialAnalogOutV2

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

var industrialAnalogOutV2 = new BrickletIndustrialAnalogOutV2("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

BrickletIndustrialAnalogOutV2.setEnabled(enabled[, returnCallback][, errorCallback])¶

Parameter:	enabled – Typ: boolean, Standardwert: false
Callback-Parameter:	undefined
Rückgabe:	undefined

Aktiviert/deaktiviert die Ausgabe von Spannung und Strom.

BrickletIndustrialAnalogOutV2.getEnabled([returnCallback][, errorCallback])¶

Callback-Parameter:	enabled – Typ: boolean, Standardwert: false
Rückgabe:	undefined

Gibt true zurück falls die Ausgabe von Spannung und Strom aktiviert ist, false sonst.

BrickletIndustrialAnalogOutV2.setVoltage(voltage[, returnCallback][, errorCallback])¶

Parameter:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 10000]
Callback-Parameter:	undefined
Rückgabe:	undefined

Setzt die Ausgangsspannung.

Die Ausgangsspannung und der Ausgangsstrom sind gekoppelt. Eine Änderung der Ausgangsspannung führt auch zu einer Änderung des Ausgangsstroms.

BrickletIndustrialAnalogOutV2.getVoltage([returnCallback][, errorCallback])¶

Callback-Parameter:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 10000]
Rückgabe:	undefined

Gibt die Spannung zurück, wie von setVoltage() gesetzt.

BrickletIndustrialAnalogOutV2.setCurrent(current[, returnCallback][, errorCallback])¶

Parameter:	current – Typ: int, Einheit: 1 µA, Wertebereich: [0 bis 24000]
Callback-Parameter:	undefined
Rückgabe:	undefined

Setzt den Ausgangsstrom.

Der Ausgangsstrom und die Ausgangsspannung sind gekoppelt. Eine Änderung des Ausgangsstroms führt auch zu einer Änderung der Ausgangsspannung.

BrickletIndustrialAnalogOutV2.getCurrent([returnCallback][, errorCallback])¶

Callback-Parameter:	current – Typ: int, Einheit: 1 µA, Wertebereich: [0 bis 24000]
Rückgabe:	undefined

Gibt die Spannung zurück, wie von setCurrent() gesetzt.

BrickletIndustrialAnalogOutV2.setOutLEDConfig(config[, returnCallback][, errorCallback])¶

Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
Callback-Parameter:	undefined
Rückgabe:	undefined

Die Out LED kann an- oder ausgeschaltet werden. Zusätzlich kann ein Heartbeat oder der "Out-Status" angezeigt werden. Falls Out-Status gewählt wird kann die LED entweder ab einem vordefinierten Schwellwert eingeschaltet werden oder ihre Helligkeit anhand des Ausgabewertes (Spannung oder Strom) skaliert werden.

Das Verhalten des Out-Status kann mittels setOutLEDStatusConfig() eingestellt werden.

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

Für config:

BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_OFF = 0
BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_ON = 1
BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_SHOW_OUT_STATUS = 3

BrickletIndustrialAnalogOutV2.getOutLEDConfig([returnCallback][, errorCallback])¶

Callback-Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	undefined

Gibt die Out-LED-Konfiguration zurück, wie von setOutLEDConfig() gesetzt.

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

Für config:

BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_OFF = 0
BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_ON = 1
BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_SHOW_OUT_STATUS = 3

BrickletIndustrialAnalogOutV2.setOutLEDStatusConfig(min, max, config[, returnCallback][, errorCallback])¶

Parameter:	min – Typ: int, Wertebereich: [0 bis 24000], Standardwert: 0 max – Typ: int, Wertebereich: [0 bis 24000], Standardwert: 10000 config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1
Callback-Parameter:	undefined
Rückgabe:	undefined

Setzt die Out-LED-Status-Konfiguration. Diese Einstellung wird verwendet wenn die Out-LED auf Out-Status eingestellt ist, siehe setOutLEDConfig().

Für jeden Kanal kann zwischen Schwellwert- und Intensitätsmodus gewählt werden.

Im Schwellwertmodus kann ein positiver oder negativer Schwellwert definiert werden. Für einen positiven Schwellwert muss der "min" Parameter auf den gewünschten Schwellwert in mV oder µA gesetzt werden, über dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem positiven Schwellwert von 5V wird die LED eingeschaltet sobald der Ausgabewert über 5V steigt und wieder ausgeschaltet sobald der Ausgabewert unter 5V fällt. Für einen negativen Schwellwert muss der "max" Parameter auf den gewünschten Schwellwert in mV oder µA gesetzt werden, unter dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem negativen Schwellwert von 5V wird die LED eingeschaltet sobald der Ausgabewert unter 5V fällt und wieder ausgeschaltet sobald der Ausgabewert über 5V steigt.

Im Intensitätsmodus kann ein Bereich in mV oder µA angegeben werden über den die Helligkeit der LED skaliert wird. Beispiel mit min=2V und max=8V: Die LED ist bei 2V und darunter aus, bei 8V und darüber an und zwischen 2V und 8V wird die Helligkeit linear skaliert. Wenn der min Wert größer als der max Wert ist, dann wird die Helligkeit andersherum skaliert.

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

Für config:

BrickletIndustrialAnalogOutV2.OUT_LED_STATUS_CONFIG_THRESHOLD = 0
BrickletIndustrialAnalogOutV2.OUT_LED_STATUS_CONFIG_INTENSITY = 1

BrickletIndustrialAnalogOutV2.getOutLEDStatusConfig([returnCallback][, errorCallback])¶

Callback-Parameter:	min – Typ: int, Wertebereich: [0 bis 24000], Standardwert: 0 max – Typ: int, Wertebereich: [0 bis 24000], Standardwert: 10000 config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1
Rückgabe:	undefined

Gibt die Out-LED-Status-Konfiguration zurück, wie von setOutLEDStatusConfig() gesetzt.

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

Für config:

BrickletIndustrialAnalogOutV2.OUT_LED_STATUS_CONFIG_THRESHOLD = 0
BrickletIndustrialAnalogOutV2.OUT_LED_STATUS_CONFIG_INTENSITY = 1

Fortgeschrittene Funktionen¶

BrickletIndustrialAnalogOutV2.setConfiguration(voltageRange, currentRange[, returnCallback][, errorCallback])¶

Parameter:	voltageRange – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1 currentRange – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
Callback-Parameter:	undefined
Rückgabe:	undefined

Konfiguriert die Spannungs- und Stromwertebereiche.

Einstellbare Spannungswertebereiche sind:

0V bis 5V
0V bis 10V

Einstellbare Stromwertebereiche sind:

4mA bis 20mA
0mA bis 20mA
0mA bis 24mA

Die Auflösung ist immer 12 Bit. Dass heißt, die Genauigkeit erhöht sich bei kleineren Wertebereichen.

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

Für voltage_range:

BrickletIndustrialAnalogOutV2.VOLTAGE_RANGE_0_TO_5V = 0
BrickletIndustrialAnalogOutV2.VOLTAGE_RANGE_0_TO_10V = 1

Für current_range:

BrickletIndustrialAnalogOutV2.CURRENT_RANGE_4_TO_20MA = 0
BrickletIndustrialAnalogOutV2.CURRENT_RANGE_0_TO_20MA = 1
BrickletIndustrialAnalogOutV2.CURRENT_RANGE_0_TO_24MA = 2

BrickletIndustrialAnalogOutV2.getConfiguration([returnCallback][, errorCallback])¶

Callback-Parameter:	voltageRange – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1 currentRange – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	undefined

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

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

Für voltage_range:

BrickletIndustrialAnalogOutV2.VOLTAGE_RANGE_0_TO_5V = 0
BrickletIndustrialAnalogOutV2.VOLTAGE_RANGE_0_TO_10V = 1

Für current_range:

BrickletIndustrialAnalogOutV2.CURRENT_RANGE_4_TO_20MA = 0
BrickletIndustrialAnalogOutV2.CURRENT_RANGE_0_TO_20MA = 1
BrickletIndustrialAnalogOutV2.CURRENT_RANGE_0_TO_24MA = 2

BrickletIndustrialAnalogOutV2.getSPITFPErrorCount([returnCallback][, errorCallback])¶

Callback-Parameter:	errorCountAckChecksum – Typ: int, Wertebereich: [0 bis 2³² - 1] errorCountMessageChecksum – Typ: int, Wertebereich: [0 bis 2³² - 1] errorCountFrame – Typ: int, Wertebereich: [0 bis 2³² - 1] errorCountOverflow – Typ: int, Wertebereich: [0 bis 2³² - 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.

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

BrickletIndustrialAnalogOutV2.STATUS_LED_CONFIG_OFF = 0
BrickletIndustrialAnalogOutV2.STATUS_LED_CONFIG_ON = 1
BrickletIndustrialAnalogOutV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletIndustrialAnalogOutV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

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

BrickletIndustrialAnalogOutV2.STATUS_LED_CONFIG_OFF = 0
BrickletIndustrialAnalogOutV2.STATUS_LED_CONFIG_ON = 1
BrickletIndustrialAnalogOutV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletIndustrialAnalogOutV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletIndustrialAnalogOutV2.getChipTemperature([returnCallback][, errorCallback])¶

Callback-Parameter:	temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 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.

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

BrickletIndustrialAnalogOutV2.getIdentity([returnCallback][, errorCallback])¶

Callback-Parameter:

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', '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 2¹⁶ - 1]
Rückgabe:	undefined

uid – Typ: string, Länge: bis zu 8
connectedUid – Typ: string, Länge: bis zu 8
position – Typ: char, Wertebereich: ['a' bis 'h', '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 2¹⁶ - 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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Virtuelle Funktionen¶

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.

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

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

BrickletIndustrialAnalogOutV2.FUNCTION_SET_ENABLED = 1
BrickletIndustrialAnalogOutV2.FUNCTION_SET_VOLTAGE = 3
BrickletIndustrialAnalogOutV2.FUNCTION_SET_CURRENT = 5
BrickletIndustrialAnalogOutV2.FUNCTION_SET_CONFIGURATION = 7
BrickletIndustrialAnalogOutV2.FUNCTION_SET_OUT_LED_CONFIG = 9
BrickletIndustrialAnalogOutV2.FUNCTION_SET_OUT_LED_STATUS_CONFIG = 11
BrickletIndustrialAnalogOutV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletIndustrialAnalogOutV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletIndustrialAnalogOutV2.FUNCTION_RESET = 243
BrickletIndustrialAnalogOutV2.FUNCTION_WRITE_UID = 248

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

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

Für function_id:

BrickletIndustrialAnalogOutV2.FUNCTION_SET_ENABLED = 1
BrickletIndustrialAnalogOutV2.FUNCTION_SET_VOLTAGE = 3
BrickletIndustrialAnalogOutV2.FUNCTION_SET_CURRENT = 5
BrickletIndustrialAnalogOutV2.FUNCTION_SET_CONFIGURATION = 7
BrickletIndustrialAnalogOutV2.FUNCTION_SET_OUT_LED_CONFIG = 9
BrickletIndustrialAnalogOutV2.FUNCTION_SET_OUT_LED_STATUS_CONFIG = 11
BrickletIndustrialAnalogOutV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletIndustrialAnalogOutV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletIndustrialAnalogOutV2.FUNCTION_RESET = 243
BrickletIndustrialAnalogOutV2.FUNCTION_WRITE_UID = 248

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

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

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

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

Für status:

BrickletIndustrialAnalogOutV2.BOOTLOADER_STATUS_OK = 0
BrickletIndustrialAnalogOutV2.BOOTLOADER_STATUS_INVALID_MODE = 1
BrickletIndustrialAnalogOutV2.BOOTLOADER_STATUS_NO_CHANGE = 2
BrickletIndustrialAnalogOutV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BrickletIndustrialAnalogOutV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BrickletIndustrialAnalogOutV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5

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

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

BrickletIndustrialAnalogOutV2.setWriteFirmwarePointer(pointer[, returnCallback][, errorCallback])¶

Parameter:	pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 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.

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

BrickletIndustrialAnalogOutV2.writeUID(uid[, returnCallback][, errorCallback])¶

Parameter:	uid – Typ: int, Wertebereich: [0 bis 2³² - 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.

BrickletIndustrialAnalogOutV2.readUID([returnCallback][, errorCallback])¶

Callback-Parameter:	uid – Typ: int, Wertebereich: [0 bis 2³² - 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.

Konstanten¶

BrickletIndustrialAnalogOutV2.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Industrial Analog Out 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.

BrickletIndustrialAnalogOutV2.DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Industrial Analog Out Bricklet 2.0 dar.