Go - One Wire Bricklet

Dies ist die Beschreibung der Go 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 Go API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf godoc.org.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Read Ds18b20 Temperature

Download (example_read_ds18b20_temperature.go)

 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
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/one_wire_bricklet"
    "time"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your One Wire Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    ow, _ := one_wire_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // 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 i := 0; i < 10; i++ {
        ow.WriteCommand(0, 68)              // CONVERT T (start temperature conversion)
        time.Sleep(1000 * time.Millisecond) // Wait for conversion to finish
        ow.WriteCommand(0, 190)             // READ SCRATCHPAD

        tLow, _, _ := ow.Read()
        tHigh, _, _ := ow.Read()

        temperature := float32(uint16(tLow) | uint16(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
        fmt.Printf("Temperature %f°C\n", temperature/16.0)
    }

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

API

Die API des One Wire Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/one_wire_bricklet definiert.

Fast alle Funktionen der Go Bindings können einen ipconnection.DeviceError, der das error-Interface implementiert, zurückgeben. Dieser kann folgende Werte annehmen:

  • ipconnection.DeviceErrorSuccess = 0
  • ipconnection.DeviceErrorInvalidParameter = 1
  • ipconnection.DeviceErrorFunctionNotSupported = 2
  • ipconnection.DeviceErrorUnknownError = 3

welche den Werten entsprechen, die der Brick oder das Bricklet zurückgeben.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

func one_wire_bricklet.New(uid string, ipcon *IPConnection) (device OneWireBricklet, err error)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: *IPConnection
Rückgabe:
  • device – Typ: OneWireBricklet
  • err – Typ: error

Erzeugt ein neues OneWireBricklet-Objekt mit der eindeutigen Geräte ID uid und fügt es der IPConnection ipcon hinzu:

device, err := one_wire_bricklet.New("YOUR_DEVICE_UID", &ipcon)

Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden wurde (siehe Beispiele oben).

func (*OneWireBricklet) SearchBus() (identifier []uint64, status uint8, err error)
Rückgabe:
  • identifier – Typ: []uint64, Länge: variabel, Wertebereich: [0 bis 264 - 1]
  • status – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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:

  • one_wire_bricklet.StatusOK = 0
  • one_wire_bricklet.StatusBusy = 1
  • one_wire_bricklet.StatusNoPresence = 2
  • one_wire_bricklet.StatusTimeout = 3
  • one_wire_bricklet.StatusError = 4
func (*OneWireBricklet) ResetBus() (status uint8, err error)
Rückgabe:
  • status – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

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

Für status:

  • one_wire_bricklet.StatusOK = 0
  • one_wire_bricklet.StatusBusy = 1
  • one_wire_bricklet.StatusNoPresence = 2
  • one_wire_bricklet.StatusTimeout = 3
  • one_wire_bricklet.StatusError = 4
func (*OneWireBricklet) Write(data uint8) (status uint8, err error)
Parameter:
  • data – Typ: uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

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

Für status:

  • one_wire_bricklet.StatusOK = 0
  • one_wire_bricklet.StatusBusy = 1
  • one_wire_bricklet.StatusNoPresence = 2
  • one_wire_bricklet.StatusTimeout = 3
  • one_wire_bricklet.StatusError = 4
func (*OneWireBricklet) Read() (data uint8, status uint8, err error)
Rückgabe:
  • data – Typ: uint8, Wertebereich: [0 bis 255]
  • status – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

Liest ein Byte an Daten vom 1-Wire Bus.

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

Für status:

  • one_wire_bricklet.StatusOK = 0
  • one_wire_bricklet.StatusBusy = 1
  • one_wire_bricklet.StatusNoPresence = 2
  • one_wire_bricklet.StatusTimeout = 3
  • one_wire_bricklet.StatusError = 4
func (*OneWireBricklet) WriteCommand(identifier uint64, command uint8) (status uint8, err error)
Parameter:
  • identifier – Typ: uint64, Wertebereich: [0 bis 264 - 1]
  • command – Typ: uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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:

  • one_wire_bricklet.StatusOK = 0
  • one_wire_bricklet.StatusBusy = 1
  • one_wire_bricklet.StatusNoPresence = 2
  • one_wire_bricklet.StatusTimeout = 3
  • one_wire_bricklet.StatusError = 4

Fortgeschrittene Funktionen

func (*OneWireBricklet) SetCommunicationLEDConfig(config uint8) (err error)
Parameter:
  • config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • err – Typ: error

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:

  • one_wire_bricklet.CommunicationLEDConfigOff = 0
  • one_wire_bricklet.CommunicationLEDConfigOn = 1
  • one_wire_bricklet.CommunicationLEDConfigShowHeartbeat = 2
  • one_wire_bricklet.CommunicationLEDConfigShowCommunication = 3
func (*OneWireBricklet) GetCommunicationLEDConfig() (config uint8, err error)
Rückgabe:
  • config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
  • err – Typ: error

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

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

Für config:

  • one_wire_bricklet.CommunicationLEDConfigOff = 0
  • one_wire_bricklet.CommunicationLEDConfigOn = 1
  • one_wire_bricklet.CommunicationLEDConfigShowHeartbeat = 2
  • one_wire_bricklet.CommunicationLEDConfigShowCommunication = 3
func (*OneWireBricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)
Rückgabe:
  • errorCountAckChecksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • err – Typ: error

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.

func (*OneWireBricklet) SetBootloaderMode(mode uint8) (status uint8, err error)
Parameter:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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:

  • one_wire_bricklet.BootloaderModeBootloader = 0
  • one_wire_bricklet.BootloaderModeFirmware = 1
  • one_wire_bricklet.BootloaderModeBootloaderWaitForReboot = 2
  • one_wire_bricklet.BootloaderModeFirmwareWaitForReboot = 3
  • one_wire_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4

Für status:

  • one_wire_bricklet.BootloaderStatusOK = 0
  • one_wire_bricklet.BootloaderStatusInvalidMode = 1
  • one_wire_bricklet.BootloaderStatusNoChange = 2
  • one_wire_bricklet.BootloaderStatusEntryFunctionNotPresent = 3
  • one_wire_bricklet.BootloaderStatusDeviceIdentifierIncorrect = 4
  • one_wire_bricklet.BootloaderStatusCRCMismatch = 5
func (*OneWireBricklet) GetBootloaderMode() (mode uint8, err error)
Rückgabe:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

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

Für mode:

  • one_wire_bricklet.BootloaderModeBootloader = 0
  • one_wire_bricklet.BootloaderModeFirmware = 1
  • one_wire_bricklet.BootloaderModeBootloaderWaitForReboot = 2
  • one_wire_bricklet.BootloaderModeFirmwareWaitForReboot = 3
  • one_wire_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4
func (*OneWireBricklet) SetWriteFirmwarePointer(pointer uint32) (err error)
Parameter:
  • pointer – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • err – Typ: error

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.

func (*OneWireBricklet) WriteFirmware(data [64]uint8) (status uint8, err error)
Parameter:
  • data – Typ: [64]uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

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.

func (*OneWireBricklet) SetStatusLEDConfig(config uint8) (err error)
Parameter:
  • config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • err – Typ: error

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:

  • one_wire_bricklet.StatusLEDConfigOff = 0
  • one_wire_bricklet.StatusLEDConfigOn = 1
  • one_wire_bricklet.StatusLEDConfigShowHeartbeat = 2
  • one_wire_bricklet.StatusLEDConfigShowStatus = 3
func (*OneWireBricklet) GetStatusLEDConfig() (config uint8, err error)
Rückgabe:
  • config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
  • err – Typ: error

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

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

Für config:

  • one_wire_bricklet.StatusLEDConfigOff = 0
  • one_wire_bricklet.StatusLEDConfigOn = 1
  • one_wire_bricklet.StatusLEDConfigShowHeartbeat = 2
  • one_wire_bricklet.StatusLEDConfigShowStatus = 3
func (*OneWireBricklet) GetChipTemperature() (temperature int16, err error)
Rückgabe:
  • temperature – Typ: int16, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]
  • err – Typ: error

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.

func (*OneWireBricklet) Reset() (err error)
Rückgabe:
  • err – Typ: error

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.

func (*OneWireBricklet) WriteUID(uid uint32) (err error)
Parameter:
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • err – Typ: error

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.

func (*OneWireBricklet) ReadUID() (uid uint32, err error)
Rückgabe:
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • err – Typ: error

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

func (*OneWireBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)
Rückgabe:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: rune, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardwareVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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.

func (*OneWireBricklet) GetAPIVersion() (apiVersion [3]uint8, err error)
Rückgabe:
  • apiVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

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.

func (*OneWireBricklet) GetResponseExpected(functionId uint8) (responseExpected bool, err error)
Parameter:
  • functionId – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: bool
  • err – Typ: error

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:

  • one_wire_bricklet.FunctionSetCommunicationLEDConfig = 6
  • one_wire_bricklet.FunctionSetWriteFirmwarePointer = 237
  • one_wire_bricklet.FunctionSetStatusLEDConfig = 239
  • one_wire_bricklet.FunctionReset = 243
  • one_wire_bricklet.FunctionWriteUID = 248
func (*OneWireBricklet) SetResponseExpected(functionId uint8, responseExpected bool) (err error)
Parameter:
  • functionId – Typ: uint8, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: bool
Rückgabe:
  • err – Typ: error

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

  • one_wire_bricklet.FunctionSetCommunicationLEDConfig = 6
  • one_wire_bricklet.FunctionSetWriteFirmwarePointer = 237
  • one_wire_bricklet.FunctionSetStatusLEDConfig = 239
  • one_wire_bricklet.FunctionReset = 243
  • one_wire_bricklet.FunctionWriteUID = 248
func (*OneWireBricklet) SetResponseExpectedAll(responseExpected bool) (err error)
Parameter:
  • responseExpected – Typ: bool
Rückgabe:
  • err – Typ: error

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

Konstanten

one_wire_bricklet.DeviceIdentifier

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

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

one_wire_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines One Wire Bricklet dar.