Dies ist die Beschreibung der Go API Bindings für das Temperature IR Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Temperature IR 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.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
"github.com/Tinkerforge/go-api-bindings/temperature_ir_bricklet"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Temperature IR Bricklet.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
tir, _ := temperature_ir_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 ambient temperature.
ambientTemperature, _ := tir.GetAmbientTemperature()
fmt.Printf("Ambient Temperature: %f °C\n", float64(ambientTemperature)/10.0)
// Get current object temperature.
objectTemperature, _ := tir.GetObjectTemperature()
fmt.Printf("Object Temperature: %f °C\n", float64(objectTemperature)/10.0)
fmt.Print("Press enter to exit.")
fmt.Scanln()
}
|
Download (example_callback.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 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
"github.com/Tinkerforge/go-api-bindings/temperature_ir_bricklet"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Temperature IR Bricklet.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
tir, _ := temperature_ir_bricklet.New(UID, &ipcon) // Create device object.
ipcon.Connect(ADDR) // Connect to brickd.
defer ipcon.Disconnect()
// Don't use device before ipcon is connected.
tir.RegisterObjectTemperatureCallback(func(temperature int16) {
fmt.Printf("Object Temperature: %f °C\n", float64(temperature)/10.0)
})
// Set period for object temperature receiver to 1s (1000ms).
// Note: The object temperature callback is only called every second
// if the object temperature has changed since the last call!
tir.SetObjectTemperatureCallbackPeriod(1000)
fmt.Print("Press enter to exit.")
fmt.Scanln()
}
|
Download (example_water_boiling.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 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
"github.com/Tinkerforge/go-api-bindings/temperature_ir_bricklet"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Temperature IR Bricklet.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
tir, _ := temperature_ir_bricklet.New(UID, &ipcon) // Create device object.
ipcon.Connect(ADDR) // Connect to brickd.
defer ipcon.Disconnect()
// Don't use device before ipcon is connected.
// Set emissivity to 0.98 (emissivity of water, 65535 * 0.98 = 64224.299)
tir.SetEmissivity(64224)
// Get threshold receivers with a debounce time of 10 seconds (10000ms).
tir.SetDebouncePeriod(10000)
tir.RegisterObjectTemperatureReachedCallback(func(temperature int16) {
fmt.Printf("Object Temperature: %f °C\n", float64(temperature)/10.0)
fmt.Println("The water is boiling!")
})
// Configure threshold for object temperature "greater than 100 °C".
tir.SetObjectTemperatureCallbackThreshold('>', 100*10, 0)
fmt.Print("Press enter to exit.")
fmt.Scanln()
}
|
Die API des Temperature IR Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/temperature_ir_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:
welche den Werten entsprechen, die der Brick oder das Bricklet zurückgeben.
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
temperature_ir_bricklet.
New
(uid string, ipcon *IPConnection) (device TemperatureIRBricklet, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein neues TemperatureIRBricklet
-Objekt mit der eindeutigen Geräte ID uid
und
fügt es der IPConnection ipcon
hinzu:
device, err := temperature_ir_bricklet.New("YOUR_DEVICE_UID", &ipcon)
Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden.
(*TemperatureIRBricklet)
GetAmbientTemperature
() (temperature int16, err error)¶Rückgabe: |
|
---|
Gibt die Umgebungstemperatur des Sensors zurück.
Wenn die Umgebungstemperatur periodisch abgefragt werden soll, wird empfohlen
den AmbientTemperatureCallback
Callback zu nutzen und die Periode mit
SetAmbientTemperatureCallbackPeriod()
vorzugeben.
(*TemperatureIRBricklet)
GetObjectTemperature
() (temperature int16, err error)¶Rückgabe: |
|
---|
Gibt die Objekttemperatur des Sensors zurück, z.B. die Temperatur der Oberfläche auf welche der Sensor zielt.
Die Temperatur von unterschiedlichen Materialien ist abhängig von ihrem
Emissionsgrad. Der
Emissionsgrad des Materials kann mit SetEmissivity()
gesetzt werden.
Wenn die Objekttemperatur periodisch abgefragt werden soll, wird empfohlen
den ObjectTemperatureCallback
Callback zu nutzen und die Periode mit
SetObjectTemperatureCallbackPeriod()
vorzugeben.
(*TemperatureIRBricklet)
SetEmissivity
(emissivity uint16) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Emissionsgrad,
welcher zur Berechnung der Oberflächentemperatur benutzt wird, wie von
GetObjectTemperature()
zurückgegeben.
Der Emissionsgrad wird normalerweise als Wert zwischen 0,0 und 1,0 angegeben. Eine Liste von Emissionsgraden unterschiedlicher Materialien ist hier zu finden.
Der Parameter von SetEmissivity()
muss mit eine Faktor von 65535 (16-Bit)
vorgegeben werden. Beispiel: Ein Emissionsgrad von 0,1 kann mit dem Wert
6553 gesetzt werden, ein Emissionsgrad von 0,5 mit dem Wert 32767 und so weiter.
Bemerkung
Wenn eine exakte Messung der Objekttemperatur notwendig ist, ist es entscheidend eine exakten Emissionsgrad anzugeben.
Der Emissionsgrad wird in nicht-flüchtigem Speicher gespeichert und wird auch noch einem Neustart weiter genutzt.
(*TemperatureIRBricklet)
GetEmissivity
() (emissivity uint16, err error)¶Rückgabe: |
|
---|
Gibt den Emissionsgrad zurück, wie von SetEmissivity()
gesetzt.
(*TemperatureIRBricklet)
GetIdentity
() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)¶Rückgabe: |
|
---|
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.
(*TemperatureIRBricklet)
SetAmbientTemperatureCallbackPeriod
(period uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der AmbientTemperatureCallback
Callback
ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.
Der AmbientTemperatureCallback
Callback wird nur ausgelöst, wenn sich die
Temperatur seit der letzten Auslösung geändert hat.
(*TemperatureIRBricklet)
GetAmbientTemperatureCallbackPeriod
() (period uint32, err error)¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetAmbientTemperatureCallbackPeriod()
gesetzt.
(*TemperatureIRBricklet)
SetObjectTemperatureCallbackPeriod
(period uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der ObjectTemperatureCallback
Callback
ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.
Der ObjectTemperatureCallback
Callback wird nur ausgelöst, wenn sich die
Temperatur seit der letzten Auslösung geändert hat.
(*TemperatureIRBricklet)
GetObjectTemperatureCallbackPeriod
() (period uint32, err error)¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetObjectTemperatureCallbackPeriod()
gesetzt.
(*TemperatureIRBricklet)
SetAmbientTemperatureCallbackThreshold
(option rune, min int16, max int16) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Schwellwert für den AmbientTemperatureReachedCallback
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn die Umgebungstemperatur außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn die Umgebungstemperatur innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn die Umgebungstemperatur kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Umgebungstemperatur größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
(*TemperatureIRBricklet)
GetAmbientTemperatureCallbackThreshold
() (option rune, min int16, max int16, err error)¶Rückgabe: |
|
---|
Gibt den Schwellwert zurück, wie von SetAmbientTemperatureCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
(*TemperatureIRBricklet)
SetObjectTemperatureCallbackThreshold
(option rune, min int16, max int16) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Schwellwert für den ObjectTemperatureReachedCallback
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn die Objekttemperatur außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn die Objekttemperatur innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn die Objekttemperatur kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Objekttemperatur größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
(*TemperatureIRBricklet)
GetObjectTemperatureCallbackThreshold
() (option rune, min int16, max int16, err error)¶Rückgabe: |
|
---|
Gibt den Schwellwert zurück, wie von SetObjectTemperatureCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
(*TemperatureIRBricklet)
SetDebouncePeriod
(debounce uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher die Schwellwert Callbacks
ausgelöst werden, wenn die Schwellwerte
weiterhin erreicht bleiben.
(*TemperatureIRBricklet)
GetDebouncePeriod
() (debounce uint32, err error)¶Rückgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von SetDebouncePeriod()
gesetzt.
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.
(*TemperatureIRBricklet)
RegisterAmbientTemperatureCallback
(func(temperature int16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird mit der Periode, wie gesetzt mit SetAmbientTemperatureCallbackPeriod()
,
ausgelöst. Der Parameter des Callbacks ist die Temperatur des Sensors.
Der AmbientTemperatureCallback
Callback wird nur ausgelöst, wenn sich die
Temperatur seit der letzten Auslösung geändert hat.
(*TemperatureIRBricklet)
RegisterObjectTemperatureCallback
(func(temperature int16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetObjectTemperatureCallbackPeriod()
, ausgelöst. Der
Parameter des Callbacks ist die Objekttemperatur des Sensors.
Der ObjectTemperatureCallback
Callback wird nur ausgelöst, wenn sich die
Objekttemperatur seit der letzten Auslösung geändert hat.
(*TemperatureIRBricklet)
RegisterAmbientTemperatureReachedCallback
(func(temperature int16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
SetAmbientTemperatureCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter des Callbacks ist die Umgebungstemperatur des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit SetDebouncePeriod()
gesetzt, ausgelöst.
(*TemperatureIRBricklet)
RegisterObjectTemperatureReachedCallback
(func(temperature int16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
SetObjectTemperatureCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter des Callbacks ist die Objekttemperatur des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit SetDebouncePeriod()
gesetzt, ausgelöst.
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.
(*TemperatureIRBricklet)
GetAPIVersion
() (apiVersion [3]uint8, err error)¶Rückgabe: |
|
---|
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.
(*TemperatureIRBricklet)
GetResponseExpected
(functionId uint8) (responseExpected bool, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
(*TemperatureIRBricklet)
SetResponseExpected
(functionId uint8, responseExpected bool) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ä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:
(*TemperatureIRBricklet)
SetResponseExpectedAll
(responseExpected bool) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
temperature_ir_bricklet.
DeviceIdentifier
¶Diese Konstante wird verwendet um ein Temperature IR 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.
temperature_ir_bricklet.
DeviceDisplayName
¶Diese Konstante stellt den Anzeigenamen eines Temperature IR Bricklet dar.