Software / API Bindings / JavaScript / API Referenz und Beispiele / Bricklets / One Wire Bricklet

JavaScript - One Wire Bricklet¶

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

Read DS 18B 20Temperature (Node.js)¶

Download (ExampleReadDS18B20Temperature.js)

var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your One Wire Bricklet

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

var writeCommandPromise = function(ow, identifier, command) {
    var promise = new Promise(function(resolve, reject) {
        ow.writeCommand(identifier, command, function(status) {
            resolve(status);
        });
    });

    return promise;
}

var writePromise = function(ow, data) {
    var promise = new Promise(function(resolve, reject) {
        ow.write(data, function(status) {
            resolve(status);
        });
    });

    return promise;
}

var readPromise = function(ow) {
    var promise = new Promise(function(resolve, reject) {
        ow.read(function(data, status) {
            resolve(data, status);
        });
    });

    return promise;
}

var timeoutPromise = function(millis) {
    var promise = new Promise(function(resolve, reject) {
        setTimeout(function () {
            resolve();
        }, millis);
    });

    return promise;
}

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,
    async function (connectReason) {
        await writeCommandPromise(ow, 0, 78); // WRITE SCRATCHPAD
        await writePromise(ow, 0); // ALARM H (unused)
        await writePromise(ow, 0); // ALARM L (unused)
        await writePromise(ow, 127); // CONFIGURATION: 12-bit mode

        // Read temperature 10 times
        for(var i = 0; i < 10; ++i) {
            await writeCommandPromise(ow, 0, 68); // CONVERT T (start temperature conversion)
            await timeoutPromise(1000);
            await writeCommandPromise(ow, 0, 190); // READ SCRATCHPAD

            var t_low = await readPromise(ow);
            var t_high = await readPromise(ow);
            var temperature = t_low | (t_high << 8);

            // Negative 12-bit values are sign-extended to 16-bit two's complement
            if (temperature > (1 << 12)) {
                temperature -= 1 << 16;
            }

            // 12 bit-mode measures in units of 1/16°C
            console.log('Temperature: ' + temperature/16.0 + ' °C');
        }
    }
);

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

Read DS 18B 20Temperature (HTML)¶

Download (ExampleReadDS18B20Temperature.html), Test (ExampleReadDS18B20Temperature.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>One Wire Bricklet Read DS18B20 Temperature 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 ow = new Tinkerforge.BrickletOneWire(UID, ipcon); // Create device object

                var writeCommandPromise = function(ow, identifier, command) {
                    var promise = new Promise(function(resolve, reject) {
                        ow.writeCommand(identifier, command, function(status) {
                            resolve(status);
                        });
                    });

                    return promise;
                }

                var writePromise = function(ow, data) {
                    var promise = new Promise(function(resolve, reject) {
                        ow.write(data, function(status) {
                            resolve(status);
                        });
                    });

                    return promise;
                }

                var readPromise = function(ow) {
                    var promise = new Promise(function(resolve, reject) {
                        ow.read(function(data, status) {
                            resolve(data, status);
                        });
                    });

                    return promise;
                }

                var timeoutPromise = function(millis) {
                    var promise = new Promise(function(resolve, reject) {
                        setTimeout(function () {
                            resolve();
                        }, millis);
                    });

                    return promise;
                }

                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,
                    async function (connectReason) {
                        await writeCommandPromise(ow, 0, 78); // WRITE SCRATCHPAD
                        await writePromise(ow, 0); // ALARM H (unused)
                        await writePromise(ow, 0); // ALARM L (unused)
                        await writePromise(ow, 127); // CONFIGURATION: 12-bit mode

                        // Read temperature 10 times
                        for(var i = 0; i < 10; ++i) {
                            await writeCommandPromise(ow, 0, 68); // CONVERT T (start temperature conversion)
                            await timeoutPromise(1000);
                            await writeCommandPromise(ow, 0, 190); // READ SCRATCHPAD

                            var t_low = await readPromise(ow);
                            var t_high = await readPromise(ow);
                            var temperature = t_low | (t_high << 8);

                            // Negative 12-bit values are sign-extended to 16-bit two's complement
                            if (temperature > (1 << 12)) {
                                temperature -= 1 << 16;
                            }

                            // 12-bit mode measures in units of 1/16°C
                            textArea.value += 'Temperature: ' + temperature/16.0 + ' °C';
                        }
                    }
                );
            }
        </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 BrickletOneWire(uid, ipcon)¶

Parameter:	uid – Typ: string ipcon – Typ: IPConnection
Rückgabe:	oneWire – Typ: BrickletOneWire

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

var oneWire = new BrickletOneWire("YOUR_DEVICE_UID", ipcon)

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

BrickletOneWire.searchBus([returnCallback][, errorCallback])¶

Callback-Parameter:	identifier – Typ: [int, ...], Länge: variabel, Wertebereich: [0 bis 2⁶⁴ - 1] status – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	undefined

Gibt eine Liste mit bis zu 64 Identifiern von angeschlossenen 1-Wire Geräten zurück. Jeder Identifier ist 64-Bit und besteht aus 8-Bit Familien-Code, 48-Bit ID und 8-Bit CRC.

Um diese Liste zu erhalten führt das Bricklet den SEARCH ROM Algorithmus von Maxim aus.

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

Für status:

BrickletOneWire.STATUS_OK = 0
BrickletOneWire.STATUS_BUSY = 1
BrickletOneWire.STATUS_NO_PRESENCE = 2
BrickletOneWire.STATUS_TIMEOUT = 3
BrickletOneWire.STATUS_ERROR = 4

BrickletOneWire.resetBus([returnCallback][, errorCallback])¶

Callback-Parameter:	status – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	undefined

Setzt den Bus mit einer 1-Wire Reset Operation zurück.

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

Für status:

BrickletOneWire.STATUS_OK = 0
BrickletOneWire.STATUS_BUSY = 1
BrickletOneWire.STATUS_NO_PRESENCE = 2
BrickletOneWire.STATUS_TIMEOUT = 3
BrickletOneWire.STATUS_ERROR = 4

BrickletOneWire.write(data[, returnCallback][, errorCallback])¶

Parameter:	data – Typ: int, Wertebereich: [0 bis 255]
Callback-Parameter:	status – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	undefined

Schreibt ein Byte an Daten auf den 1-Wire Bus.

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

Für status:

BrickletOneWire.STATUS_OK = 0
BrickletOneWire.STATUS_BUSY = 1
BrickletOneWire.STATUS_NO_PRESENCE = 2
BrickletOneWire.STATUS_TIMEOUT = 3
BrickletOneWire.STATUS_ERROR = 4

BrickletOneWire.read([returnCallback][, errorCallback])¶

Callback-Parameter:	data – Typ: int, Wertebereich: [0 bis 255] status – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	undefined

Liest ein Byte an Daten vom 1-Wire Bus.

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

Für status:

BrickletOneWire.STATUS_OK = 0
BrickletOneWire.STATUS_BUSY = 1
BrickletOneWire.STATUS_NO_PRESENCE = 2
BrickletOneWire.STATUS_TIMEOUT = 3
BrickletOneWire.STATUS_ERROR = 4

BrickletOneWire.writeCommand(identifier, command[, returnCallback][, errorCallback])¶

Parameter:	identifier – Typ: int, Wertebereich: [0 bis 2⁶⁴ - 1] command – Typ: int, Wertebereich: [0 bis 255]
Callback-Parameter:	status – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	undefined

Sendet einen Befehl an das 1-Wire Gerät mit der angegebenen Identifier. Die Liste der Identifier können mittels searchBus() ermittelt werden. Die MATCH ROM Operation wird verwendet, um den Befehl zu übertragen.

Wenn nur ein Gerät angeschlossen ist, oder der Befehl an alle Geräte gesendet werden soll kann als Identifier 0 verwendet werden. Dann wird die SKIP ROM Operation verwendet, um den Befehl zu übertragen.

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

Für status:

BrickletOneWire.STATUS_OK = 0
BrickletOneWire.STATUS_BUSY = 1
BrickletOneWire.STATUS_NO_PRESENCE = 2
BrickletOneWire.STATUS_TIMEOUT = 3
BrickletOneWire.STATUS_ERROR = 4

Fortgeschrittene Funktionen¶

BrickletOneWire.setCommunicationLEDConfig(config[, returnCallback][, errorCallback])¶

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

Setzt die Konfiguration der Kommunikations-LED. Standardmäßig zeigt die LED die 1-Wire Kommunikation durch Aufblinken an.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootloadermodus befindet ist die LED aus.

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

Für config:

BrickletOneWire.COMMUNICATION_LED_CONFIG_OFF = 0
BrickletOneWire.COMMUNICATION_LED_CONFIG_ON = 1
BrickletOneWire.COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletOneWire.COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

BrickletOneWire.getCommunicationLEDConfig([returnCallback][, errorCallback])¶

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

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

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

Für config:

BrickletOneWire.COMMUNICATION_LED_CONFIG_OFF = 0
BrickletOneWire.COMMUNICATION_LED_CONFIG_ON = 1
BrickletOneWire.COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletOneWire.COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

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

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

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

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

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

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

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

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

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

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

BrickletOneWire.FUNCTION_SET_COMMUNICATION_LED_CONFIG = 6
BrickletOneWire.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletOneWire.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletOneWire.FUNCTION_RESET = 243
BrickletOneWire.FUNCTION_WRITE_UID = 248

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

BrickletOneWire.FUNCTION_SET_COMMUNICATION_LED_CONFIG = 6
BrickletOneWire.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletOneWire.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletOneWire.FUNCTION_RESET = 243
BrickletOneWire.FUNCTION_WRITE_UID = 248

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

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

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

Für status:

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

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

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

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

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

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

BrickletOneWire.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¶

BrickletOneWire.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein One Wire 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.

BrickletOneWire.DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines One Wire Bricklet dar.