Java - One Wire Bricklet

Dies ist die Beschreibung der Java 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 Java API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Read DS 18B 20Temperature

Download (ExampleReadDS18B20Temperature.java)

 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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletOneWire;

public class ExampleReadDS18B20Temperature {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your One Wire Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletOneWire ow = new BrickletOneWire(UID, ipcon); // Create device object

        ipcon.connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        ow.writeCommand(0, 78); // WRITE SCRATCHPAD
        ow.write(0); // ALARM H (unused)
        ow.write(0); // ALARM L (unused)
        ow.write(127); // CONFIGURATION: 12-bit mode

        // Read temperature 10 times
        for(int i = 0; i < 10; i++) {
            ow.writeCommand(0, 68); // CONVERT T (start temperature conversion)
            Thread.sleep(1000); // Wait for conversion to finish
            ow.writeCommand(0, 190); // READ SCRATCHPAD

            int tLow = ow.read().data;
            int tHigh = ow.read().data;

            float temperature = tLow | (tHigh << 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
            System.out.println("Temperature: " + temperature/16.0 + " °C");
        }

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

API

Prinzipiell kann jede Methode der Java Bindings eine TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Neben der TimeoutException kann auch noch eine NotConnectedException geworfen werden, wenn versucht wird mit einem Brick oder Bricklet zu kommunizieren, aber die IP Connection nicht verbunden ist.

Da Java nicht mehrere Rückgabewerte unterstützt und eine Referenzrückgabe für elementare Type nicht möglich ist, werden kleine Klassen verwendet, die nur aus Member-Variablen bestehen. Die Member-Variablen des zurückgegebenen Objektes werden in der jeweiligen Methodenbeschreibung erläutert.

Das Package für alle Brick/Bricklet Bindings und die IP Connection ist com.tinkerforge.*

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

class BrickletOneWire(String uid, IPConnection ipcon)

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

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

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

BrickletOneWire.SearchBus BrickletOneWire.searchBus()

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:

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

Das zurückgegebene Objekt enthält die Public-Member-Variablen long[] identifier und int status.

int BrickletOneWire.resetBus()

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

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

  • BrickletOneWire.STATUS_OK = 0
  • BrickletOneWire.STATUS_BUSY = 1
  • BrickletOneWire.STATUS_NO_PRESENCE = 2
  • BrickletOneWire.STATUS_TIMEOUT = 3
  • BrickletOneWire.STATUS_ERROR = 4
int BrickletOneWire.write(int data)

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

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

  • BrickletOneWire.STATUS_OK = 0
  • BrickletOneWire.STATUS_BUSY = 1
  • BrickletOneWire.STATUS_NO_PRESENCE = 2
  • BrickletOneWire.STATUS_TIMEOUT = 3
  • BrickletOneWire.STATUS_ERROR = 4
BrickletOneWire.Read BrickletOneWire.read()

Liest ein Byte an Daten vom 1-Wire Bus.

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

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

Das zurückgegebene Objekt enthält die Public-Member-Variablen int data und int status.

int BrickletOneWire.writeCommand(long identifier, int command)

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:

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

Fortgeschrittene Funktionen

void BrickletOneWire.setCommunicationLEDConfig(int config)

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 Bootlodermodus befindet ist die LED aus.

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

  • 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
int BrickletOneWire.getCommunicationLEDConfig()

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

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

  • 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
int[] BrickletOneWire.getAPIVersion()

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.

boolean BrickletOneWire.getResponseExpected(int functionId)

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 Listeners 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:

  • 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
void BrickletOneWire.setResponseExpected(int functionId, boolean responseExpected)

Ä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 Listeners (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:

  • 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
void BrickletOneWire.setResponseExpectedAll(boolean responseExpected)

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Listeners diese Gerätes.

BrickletOneWire.SPITFPErrorCount BrickletOneWire.getSPITFPErrorCount()

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.

Das zurückgegebene Objekt enthält die Public-Member-Variablen long errorCountAckChecksum, long errorCountMessageChecksum, long errorCountFrame und long errorCountOverflow.

int BrickletOneWire.setBootloaderMode(int mode)

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:

  • 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.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
int BrickletOneWire.getBootloaderMode()

Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode().

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

  • 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
void BrickletOneWire.setWriteFirmwarePointer(long pointer)

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.

int BrickletOneWire.writeFirmware(int[] data)

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.

void BrickletOneWire.setStatusLEDConfig(int config)

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:

  • 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
int BrickletOneWire.getStatusLEDConfig()

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

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

  • 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
int BrickletOneWire.getChipTemperature()

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.

void BrickletOneWire.reset()

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.

void BrickletOneWire.writeUID(long uid)

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.

long BrickletOneWire.readUID()

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

BrickletOneWire.Identity BrickletOneWire.getIdentity()

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.

Das zurückgegebene Objekt enthält die Public-Member-Variablen String uid, String connectedUid, char position, int[] hardwareVersion, int[] firmwareVersion und int deviceIdentifier.

Konstanten

static final int BrickletOneWire.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein One Wire Bricklet zu identifizieren.

Die getIdentity() Funktion und der IPConnection.EnumerateListener Listener der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

static final String BrickletOneWire.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines One Wire Bricklet dar.