Software / API Bindings / Go / API Referenz und Beispiele / Bricklets (Abgekündigt) / Thermocouple Bricklet

Go - Thermocouple Bricklet¶

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

Simple¶

Download (example_simple.go)

package main

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

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

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

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    // Get current temperature.
    temperature, _ := t.GetTemperature()
    fmt.Printf("Temperature: %f °C\n", float64(temperature)/100.0)

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

Callback¶

Download (example_callback.go)

package main

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

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

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

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    t.RegisterTemperatureCallback(func(temperature int32) {
        fmt.Printf("Temperature: %f °C\n", float64(temperature)/100.0)
    })

    // Set period for temperature receiver to 1s (1000ms).
    // Note: The temperature callback is only called every second
    //       if the temperature has changed since the last call!
    t.SetTemperatureCallbackPeriod(1000)

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

Threshold¶

Download (example_threshold.go)

package main

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

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

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

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    // Get threshold receivers with a debounce time of 10 seconds (10000ms).
    t.SetDebouncePeriod(10000)

    t.RegisterTemperatureReachedCallback(func(temperature int32) {
        fmt.Printf("Temperature: %f °C\n", float64(temperature)/100.0)
    })

    // Configure threshold for temperature "greater than 30 °C".
    t.SetTemperatureCallbackThreshold('>', 30*100, 0)

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

API¶

Die API des Thermocouple Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/thermocouple_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 thermocouple_bricklet.New(uid string, ipcon *IPConnection) (device ThermocoupleBricklet, err error)¶

Parameter:	uid – Typ: string ipcon – Typ: *IPConnection
Rückgabe:	device – Typ: ThermocoupleBricklet err – Typ: error

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

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

Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden.

func (*ThermocoupleBricklet) GetTemperature() (temperature int32, err error)¶

Rückgabe:	temperature – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-21000 bis 180000] err – Typ: error

Gibt die Temperatur des Thermoelements zurück.

Wenn die Temperatur periodisch abgefragt werden soll, wird empfohlen den TemperatureCallback Callback zu nutzen und die Periode mit SetTemperatureCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen¶

func (*ThermocoupleBricklet) SetConfiguration(averaging uint8, thermocoupleType uint8, filter uint8) (err error)¶

Parameter:	averaging – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 16 thermocoupleType – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3 filter – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	err – Typ: error

Konfiguriert werden können Averaging-Größe, Thermoelement-Typ und Frequenz-Filterung.

Mögliche Averaging-Größen sind 1, 2, 4, 8 und 16 Samples.

Als Thermoelement-Typ stehen B, E, J, K, N, R, S und T zur Verfügung. Falls ein anderes Thermoelement benutzt werden soll, können G8 und G32 genutzt werden. Mit diesen Typen wird der Wert nicht in °C/100 zurückgegeben sondern er wird durch folgende Formeln bestimmt:

G8: Wert = 8 * 1.6 * 2^17 * Vin
G32: Wert = 32 * 1.6 * 2^17 * Vin

dabei ist Vin die Eingangsspannung des Thermoelements.

Der Frequenz-Filter kann auf 50Hz und 60Hz konfiguriert werden. Er sollte abhängig von der lokalen Netzfrequenz gewählt werden.

Die Konvertierungszeit ist abhängig von der Averaging-Größe und der Frequenz-Filter-Konfiguration. Sie kann wie folgt bestimmt werden:

60Hz: Zeit = 82 + (Samples - 1) * 16.67
50Hz: Zeit = 98 + (Samples - 1) * 20

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

Für averaging:

thermocouple_bricklet.Averaging1 = 1
thermocouple_bricklet.Averaging2 = 2
thermocouple_bricklet.Averaging4 = 4
thermocouple_bricklet.Averaging8 = 8
thermocouple_bricklet.Averaging16 = 16

Für thermocoupleType:

thermocouple_bricklet.TypeB = 0
thermocouple_bricklet.TypeE = 1
thermocouple_bricklet.TypeJ = 2
thermocouple_bricklet.TypeK = 3
thermocouple_bricklet.TypeN = 4
thermocouple_bricklet.TypeR = 5
thermocouple_bricklet.TypeS = 6
thermocouple_bricklet.TypeT = 7
thermocouple_bricklet.TypeG8 = 8
thermocouple_bricklet.TypeG32 = 9

Für filter:

thermocouple_bricklet.FilterOption50Hz = 0
thermocouple_bricklet.FilterOption60Hz = 1

func (*ThermocoupleBricklet) GetConfiguration() (averaging uint8, thermocoupleType uint8, filter uint8, err error)¶

Rückgabe:	averaging – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 16 thermocoupleType – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3 filter – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0 err – Typ: error

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

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

Für averaging:

thermocouple_bricklet.Averaging1 = 1
thermocouple_bricklet.Averaging2 = 2
thermocouple_bricklet.Averaging4 = 4
thermocouple_bricklet.Averaging8 = 8
thermocouple_bricklet.Averaging16 = 16

Für thermocoupleType:

thermocouple_bricklet.TypeB = 0
thermocouple_bricklet.TypeE = 1
thermocouple_bricklet.TypeJ = 2
thermocouple_bricklet.TypeK = 3
thermocouple_bricklet.TypeN = 4
thermocouple_bricklet.TypeR = 5
thermocouple_bricklet.TypeS = 6
thermocouple_bricklet.TypeT = 7
thermocouple_bricklet.TypeG8 = 8
thermocouple_bricklet.TypeG32 = 9

Für filter:

thermocouple_bricklet.FilterOption50Hz = 0
thermocouple_bricklet.FilterOption60Hz = 1

func (*ThermocoupleBricklet) GetErrorState() (overUnder bool, openCircuit bool, err error)¶

Rückgabe:	overUnder – Typ: bool openCircuit – Typ: bool err – Typ: error

Gibt den aktuellen Error-Status zurück. Es gibt zwei mögliche Status:

Over/Under Voltage und
Open Circuit.

Over/Under Voltage bei Spannungen unter 0V oder über 3.3V ausgelöst. In diesem Fall ist mit hoher Wahrscheinlichkeit das Thermoelement defekt. Ein Open Circuit-Error deutet darauf hin, das kein Thermoelement angeschlossen ist.

Der ErrorStateCallback Callback wird automatisch jedes mal ausgelöst, wenn sich der Error-Status ändert.

func (*ThermocoupleBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)¶

Rückgabe:

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', '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 2¹⁶ - 1] err – Typ: error

uid – Typ: string, Länge: bis zu 8
connectedUid – Typ: string, Länge: bis zu 8
position – Typ: rune, Wertebereich: ['a' bis 'h', '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 2¹⁶ - 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 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.

Konfigurationsfunktionen für Callbacks¶

func (*ThermocoupleBricklet) SetTemperatureCallbackPeriod(period uint32) (err error)¶

Parameter:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	err – Typ: error

Setzt die Periode mit welcher der TemperatureCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der TemperatureCallback Callback wird nur ausgelöst, wenn sich die Temperatur seit der letzten Auslösung geändert hat.

func (*ThermocoupleBricklet) GetTemperatureCallbackPeriod() (period uint32, err error)¶

Rückgabe:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 err – Typ: error

Gibt die Periode zurück, wie von SetTemperatureCallbackPeriod() gesetzt.

func (*ThermocoupleBricklet) SetTemperatureCallbackThreshold(option rune, min int32, max int32) (err error)¶

Parameter:	option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
Rückgabe:	err – Typ: error

Setzt den Schwellwert für den TemperatureReachedCallback Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn die Temperatur außerhalb des min und max Wertes ist
'i'	Callback wird ausgelöst, wenn die Temperatur innerhalb des min und max Wertes ist
'<'	Callback wird ausgelöst, wenn die Temperatur kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die Temperatur größer als der min Wert ist (max wird ignoriert)

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

Für option:

thermocouple_bricklet.ThresholdOptionOff = 'x'
thermocouple_bricklet.ThresholdOptionOutside = 'o'
thermocouple_bricklet.ThresholdOptionInside = 'i'
thermocouple_bricklet.ThresholdOptionSmaller = '<'
thermocouple_bricklet.ThresholdOptionGreater = '>'

func (*ThermocoupleBricklet) GetTemperatureCallbackThreshold() (option rune, min int32, max int32, err error)¶

Rückgabe:	option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 err – Typ: error

Gibt den Schwellwert zurück, wie von SetTemperatureCallbackThreshold() gesetzt.

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

Für option:

thermocouple_bricklet.ThresholdOptionOff = 'x'
thermocouple_bricklet.ThresholdOptionOutside = 'o'
thermocouple_bricklet.ThresholdOptionInside = 'i'
thermocouple_bricklet.ThresholdOptionSmaller = '<'
thermocouple_bricklet.ThresholdOptionGreater = '>'

func (*ThermocoupleBricklet) SetDebouncePeriod(debounce uint32) (err error)¶

Parameter:	debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100
Rückgabe:	err – Typ: error

Setzt die Periode mit welcher die Schwellwert Callback

TemperatureReachedCallback

ausgelöst wird, wenn der Schwellwert

SetTemperatureCallbackThreshold()

weiterhin erreicht bleibt.

func (*ThermocoupleBricklet) GetDebouncePeriod() (debounce uint32, err error)¶

Rückgabe:	debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100 err – Typ: error

Gibt die Entprellperiode zurück, wie von SetDebouncePeriod() gesetzt.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden Register*Callback-Function durchgeführt werden, welche eine eindeutige Callback-ID zurück gibt. Mit dieser ID kann das Callback später deregistriert werden.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

func (*ThermocoupleBricklet) RegisterTemperatureCallback(func(temperature int32)) (registrationId uint64)¶

Callback-Parameter:	temperature – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-21000 bis 180000]
Rückgabe:	registrationId – Typ: uint64

Dieser Callback wird mit der Periode, wie gesetzt mit SetTemperatureCallbackPeriod(), ausgelöst. Der Parameter des Callbacks ist die Temperatur des Thermoelements.

Der TemperatureCallback Callback wird nur ausgelöst, wenn sich die Temperatur seit der letzten Auslösung geändert hat.

func (*ThermocoupleBricklet) RegisterTemperatureReachedCallback(func(temperature int32)) (registrationId uint64)¶

Callback-Parameter:	temperature – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-21000 bis 180000]
Rückgabe:	registrationId – Typ: uint64

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetTemperatureCallbackThreshold() gesetzt, erreicht wird. Der Parameter des Callbacks ist die Temperatur des Thermoelements.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod() gesetzt, ausgelöst.

func (*ThermocoupleBricklet) RegisterErrorStateCallback(func(overUnder bool, openCircuit bool)) (registrationId uint64)¶

Callback-Parameter:	overUnder – Typ: bool openCircuit – Typ: bool
Rückgabe:	registrationId – Typ: uint64

Dieser Callback wird ausgelöst, wenn der Error-Status sich verändert (siehe GetErrorState()).

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 (*ThermocoupleBricklet) 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 (*ThermocoupleBricklet) 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:

thermocouple_bricklet.FunctionSetTemperatureCallbackPeriod = 2
thermocouple_bricklet.FunctionSetTemperatureCallbackThreshold = 4
thermocouple_bricklet.FunctionSetDebouncePeriod = 6
thermocouple_bricklet.FunctionSetConfiguration = 10

func (*ThermocoupleBricklet) 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.

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

Für functionId:

thermocouple_bricklet.FunctionSetTemperatureCallbackPeriod = 2
thermocouple_bricklet.FunctionSetTemperatureCallbackThreshold = 4
thermocouple_bricklet.FunctionSetDebouncePeriod = 6
thermocouple_bricklet.FunctionSetConfiguration = 10

func (*ThermocoupleBricklet) 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¶

thermocouple_bricklet.DeviceIdentifier¶

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

thermocouple_bricklet.DeviceDisplayName¶: Diese Konstante stellt den Anzeigenamen eines Thermocouple Bricklet dar.