Visual Basic .NET - One Wire Bricklet¶

Read DS 18B 20Temperature¶

Download (ExampleReadDS18B20Temperature.vb)

 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

Imports System
Imports System.Threading
Imports Tinkerforge

Module ExampleReadDS18B20Temperature
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your One Wire Bricklet

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim ow As 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
        Dim i As Integer
        For i = 0 To 9
            ow.WriteCommand(0, 68) ' CONVERT T (start temperature conversion)
            Thread.Sleep(1000) ' Wait for conversion to finish
            ow.WriteCommand(0, 190) ' READ SCRATCHPAD

            Dim tLow, tHigh, status As Byte
            ow.Read(tLow, status)
            ow.Read(tHigh, status)

            Dim temperature As Single = tLow or (Convert.ToUInt32(tHigh) << 8)

            ' Negative 12-bit values are sign-extended to 16-bit two's complement
            If temperature > 1 << 12 Then
                temperature -= 1 << 16
            End If

            ' 12-bit mode measures in units of 1/16°C.
            Console.WriteLine("Temperature: " + (temperature/16.0).ToString() + " °C")
        Next i

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Grundfunktionen¶

Class BrickletOneWire(ByVal uid As String, ByVal ipcon As IPConnection)¶

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

Dim oneWire As New BrickletOneWire("YOUR_DEVICE_UID", ipcon)

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

Sub BrickletOneWire.SearchBus(ByRef identifier() As Long, ByRef status As Byte)¶

Ausgabeparameter:	identifier – Typ: Long Array, Länge: variabel, Wertebereich: [0 bis 264 - 1] status – Typ: Byte, Wertebereich: Siehe Konstanten

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

Function BrickletOneWire.ResetBus() As Byte¶

Rückgabe:	status – Typ: Byte, Wertebereich: Siehe Konstanten

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

Function BrickletOneWire.Write(ByVal data As Byte) As Byte¶

Parameter:	data – Typ: Byte, Wertebereich: [0 bis 255]
Rückgabe:	status – Typ: Byte, Wertebereich: Siehe Konstanten

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

Sub BrickletOneWire.Read(ByRef data As Byte, ByRef status As Byte)¶

Ausgabeparameter:	data – Typ: Byte, Wertebereich: [0 bis 255] status – Typ: Byte, Wertebereich: Siehe Konstanten

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

Function BrickletOneWire.WriteCommand(ByVal identifier As Long, ByVal command As Byte) As Byte¶

Parameter:	identifier – Typ: Long, Wertebereich: [0 bis 264 - 1] command – Typ: Byte, Wertebereich: [0 bis 255]
Rückgabe:	status – Typ: Byte, Wertebereich: Siehe Konstanten

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¶

Sub BrickletOneWire.SetCommunicationLEDConfig(ByVal config As Byte)¶

Parameter:	config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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

Function BrickletOneWire.GetCommunicationLEDConfig() As Byte¶

Rückgabe:	config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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

Sub BrickletOneWire.GetSPITFPErrorCount(ByRef errorCountAckChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)¶

Ausgabeparameter:	errorCountAckChecksum – Typ: Long, Wertebereich: [0 bis 232 - 1] errorCountMessageChecksum – Typ: Long, Wertebereich: [0 bis 232 - 1] errorCountFrame – Typ: Long, Wertebereich: [0 bis 232 - 1] errorCountOverflow – Typ: Long, Wertebereich: [0 bis 232 - 1]

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.

Sub BrickletOneWire.SetStatusLEDConfig(ByVal config As Byte)¶

Parameter:	config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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

Function BrickletOneWire.GetStatusLEDConfig() As Byte¶

Rückgabe:	config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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

Function BrickletOneWire.GetChipTemperature() As Short¶

Rückgabe:	temperature – Typ: Short, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

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.

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

Sub BrickletOneWire.GetIdentity(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)¶

Ausgabeparameter:

uid – Typ: String, Länge: bis zu 8 connectedUid – Typ: String, Länge: bis zu 8 position – Typ: Char, Wertebereich: ["a"C bis "h"C, "z"C] hardwareVersion – Typ: Byte Array, Länge: 3 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, Wertebereich: [0 bis 255] firmwareVersion – Typ: Byte Array, Länge: 3 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, Wertebereich: [0 bis 255] deviceIdentifier – Typ: Integer, Wertebereich: [0 bis 216 - 1]

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.

Function BrickletOneWire.GetAPIVersion() As Byte()¶

Ausgabeparameter:	apiVersion – Typ: Byte Array, Länge: 3 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, 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.

Function BrickletOneWire.GetResponseExpected(ByVal functionId As Byte) As Boolean¶

Parameter:	functionId – Typ: Byte, 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 functionId:

• 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

Sub BrickletOneWire.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)¶

Parameter:	functionId – Typ: Byte, Wertebereich: Siehe Konstanten responseExpected – Typ: Boolean

Ä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 functionId:

• 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

Sub BrickletOneWire.SetResponseExpectedAll(ByVal responseExpected As Boolean)¶

Parameter:	responseExpected – Typ: Boolean

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

Function BrickletOneWire.SetBootloaderMode(ByVal mode As Byte) As Byte¶

Parameter:	mode – Typ: Byte, Wertebereich: Siehe Konstanten
Rückgabe:	status – Typ: Byte, Wertebereich: Siehe Konstanten

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

Function BrickletOneWire.GetBootloaderMode() As Byte¶

Rückgabe:	mode – Typ: Byte, Wertebereich: Siehe Konstanten

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

Sub BrickletOneWire.SetWriteFirmwarePointer(ByVal pointer As Long)¶

Parameter:	pointer – Typ: Long, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

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.

Function BrickletOneWire.WriteFirmware(ByVal data() As Byte) As Byte¶

Parameter:	data – Typ: Byte Array, Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:	status – Typ: Byte, Wertebereich: [0 bis 255]

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.

Sub BrickletOneWire.WriteUID(ByVal uid As Long)¶

Parameter:	uid – Typ: Long, Wertebereich: [0 bis 232 - 1]

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.

Function BrickletOneWire.ReadUID() As Long¶

Rückgabe:	uid – Typ: Long, Wertebereich: [0 bis 232 - 1]

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

Konstanten¶

Const BrickletOneWire.DEVICE_IDENTIFIER¶

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

Die GetIdentity() Funktion und der IPConnection.EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

Const BrickletOneWire.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines One Wire Bricklet dar.