Go - Barometer Bricklet

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

 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/barometer_bricklet"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
)

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    b, _ := barometer_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 air pressure.
    airPressure, _ := b.GetAirPressure()
    fmt.Printf("Air Pressure: %f mbar\n", float64(airPressure)/1000.0)

    // Get current altitude.
    altitude, _ := b.GetAltitude()
    fmt.Printf("Altitude: %f m\n", float64(altitude)/100.0)

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

Callback

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/barometer_bricklet"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
)

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

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

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

    b.RegisterAirPressureCallback(func(airPressure int32) {
        fmt.Printf("Air Pressure: %f mbar\n", float64(airPressure)/1000.0)
    })

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

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

Threshold

Download (example_threshold.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
package main

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

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    b, _ := barometer_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).
    b.SetDebouncePeriod(10000)

    b.RegisterAirPressureReachedCallback(func(airPressure int32) {
        fmt.Printf("Air Pressure: %f mbar\n", float64(airPressure)/1000.0)
        fmt.Println("Enjoy the potentially good weather!")
    })

    // Configure threshold for air pressure "greater than 1025 mbar".
    b.SetAirPressureCallbackThreshold('>', 1025*1000, 0)

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

API

Die API des Barometer Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/barometer_bricklet definiert.

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

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

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

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

func barometer_bricklet.New(uid string, ipcon *IPConnection) (device BarometerBricklet, err error)

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

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

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

func (*BarometerBricklet) GetAirPressure() (airPressure int32, err error)

Gibt den Luftdruck des Luftdrucksensors zurück. Der Wertbereich geht von 10000 bis 1200000 und ist in mbar/1000 angegeben, d.h. bei einem Wert von 1001092 wurde ein Luftdruck von 1001,092 mbar gemessen.

Wenn der Luftdruck periodisch abgefragt werden soll, wird empfohlen den RegisterAirPressureCallback Callback zu nutzen und die Periode mit SetAirPressureCallbackPeriod() vorzugeben.

func (*BarometerBricklet) GetAltitude() (altitude int32, err error)

Gibt die relative Höhe des Luftdrucksensors zurück. Der Wert ist in cm angegeben und wird auf Basis der Differenz zwischen dem aktuellen Luftdruck und dem Referenzluftdruck berechnet, welcher mit SetReferenceAirPressure() gesetzt werden kann.

Wenn die Höhe periodisch abgefragt werden soll, wird empfohlen den RegisterAltitudeCallback Callback zu nutzen und die Periode mit SetAltitudeCallbackPeriod() vorzugeben.

func (*BarometerBricklet) SetReferenceAirPressure(airPressure int32) (err error)

Setzt den Referenzluftdruck in mbar/1000 für die Höhenberechnung. Gültige Werte liegen zwischen 10000 und 1200000. Wenn der aktuelle Luftdruckwert als Referenz übergeben wird dann gibt die Höhenberechnung 0cm aus. Als Abkürzung kann auch 0 übergeben werden, dadurch wird der Referenzluftdruck intern auf den aktuellen Luftdruckwert gesetzt.

Wohl bekannte Referenzluftdruckwerte, die in der Luftfahrt verwendet werden, sind QNH und QFE aus dem Q-Schlüssel.

Der Standardwert ist 1013,25mbar.

func (*BarometerBricklet) GetReferenceAirPressure() (airPressure int32, err error)

Gibt den Referenzluftdruckwert zurück, wie von SetReferenceAirPressure() gesetzt.

Fortgeschrittene Funktionen

func (*BarometerBricklet) GetChipTemperature() (temperature int16, err error)

Gibt die Temperatur des Luftdrucksensors zurück. Der Wertbereich ist von -4000 bis 8500 und ist in °C/100 angegeben, d.h. bei einem Wert von 2007 wurde eine Temperatur von 20,07 °C gemessen.

Diese Temperatur wird intern zur Temperaturkompensation der Luftdruckmessung verwendet. Sie ist nicht so genau wie die Temperatur die vom Temperature Bricklet oder dem Temperature IR Bricklet gemessen wird.

func (*BarometerBricklet) SetAveraging(movingAveragePressure uint8, averagePressure uint8, averageTemperature uint8) (err error)

Setzt die unterschiedlichen Averaging-Parameter (Mittelwertbildung). Es ist möglich die Länge des Mittelwerts für Temperatur und Luftdruck anzugeben. Zusätzlich gibt kann die Länge für einen gleitenden Mittelwert für den Luftdruck angegeben werden. Der gleitende Mittelwert wird mit den Werten des normalen Mittelwerts berechnet. Es gibt keinen gleitenden Mittelwert für die Temperatur.

Die maximale Länge des Luftdruckmittelwerts ist 10, des Temperaturmittelwerts 255 und des gleitenden Mittelwertes 25.

Wenn alle drei Parameter auf 0 gesetzt werden, ist das Averaging komplett aus. In diesem Fall gibt es viel Rauschen auf den Daten, allerdings sind die Daten dann ohne Verzögerung. Wir empfehlen das Averaging auszustellen wenn die Daten des Barometer Bricklets zusammen mit anderen Sensordaten fusioniert werden sollen.

Der Standardwert ist 10 für die normalen Mittelwerte und 25 für den gleitenden Mittelwert

Neu in Version 2.0.1 (Plugin).

func (*BarometerBricklet) GetAveraging() (movingAveragePressure uint8, averagePressure uint8, averageTemperature uint8, err error)

Gibt die Averaging-Konfiguration zurück, wie von SetAveraging() gesetzt.

Neu in Version 2.0.1 (Plugin).

func (*BarometerBricklet) GetAPIVersion() (apiVersion [3]uint8, err error)

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.

func (*BarometerBricklet) GetResponseExpected(functionId Function) (responseExpected bool, err 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:

  • barometer_bricklet.FunctionSetAirPressureCallbackPeriod = 3
  • barometer_bricklet.FunctionSetAltitudeCallbackPeriod = 5
  • barometer_bricklet.FunctionSetAirPressureCallbackThreshold = 7
  • barometer_bricklet.FunctionSetAltitudeCallbackThreshold = 9
  • barometer_bricklet.FunctionSetDebouncePeriod = 11
  • barometer_bricklet.FunctionSetReferenceAirPressure = 13
  • barometer_bricklet.FunctionSetAveraging = 20
func (*BarometerBricklet) SetResponseExpected(functionId Function, responseExpected bool) (err 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:

  • barometer_bricklet.FunctionSetAirPressureCallbackPeriod = 3
  • barometer_bricklet.FunctionSetAltitudeCallbackPeriod = 5
  • barometer_bricklet.FunctionSetAirPressureCallbackThreshold = 7
  • barometer_bricklet.FunctionSetAltitudeCallbackThreshold = 9
  • barometer_bricklet.FunctionSetDebouncePeriod = 11
  • barometer_bricklet.FunctionSetReferenceAirPressure = 13
  • barometer_bricklet.FunctionSetAveraging = 20
func (*BarometerBricklet) SetResponseExpectedAll(responseExpected bool) (err error)

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

func (*BarometerBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err 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 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.

Konfigurationsfunktionen für Callbacks

func (*BarometerBricklet) SetAirPressureCallbackPeriod(period uint32) (err error)

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

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

Der Standardwert ist 0.

func (*BarometerBricklet) GetAirPressureCallbackPeriod() (period uint32, err error)

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

func (*BarometerBricklet) SetAltitudeCallbackPeriod(period uint32) (err error)

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

Der RegisterAltitudeCallback Callback wird nur ausgelöst, wenn sich Höhe seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

func (*BarometerBricklet) GetAltitudeCallbackPeriod() (period uint32, err error)

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

func (*BarometerBricklet) SetAirPressureCallbackThreshold(option ThresholdOption, min int32, max int32) (err error)

Setzt den Schwellwert für den RegisterAirPressureReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

Der Standardwert ist ('x', 0, 0).

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

  • barometer_bricklet.ThresholdOptionOff = 'x'
  • barometer_bricklet.ThresholdOptionOutside = 'o'
  • barometer_bricklet.ThresholdOptionInside = 'i'
  • barometer_bricklet.ThresholdOptionSmaller = '<'
  • barometer_bricklet.ThresholdOptionGreater = '>'
func (*BarometerBricklet) GetAirPressureCallbackThreshold() (option ThresholdOption, min int32, max int32, err error)

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

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

  • barometer_bricklet.ThresholdOptionOff = 'x'
  • barometer_bricklet.ThresholdOptionOutside = 'o'
  • barometer_bricklet.ThresholdOptionInside = 'i'
  • barometer_bricklet.ThresholdOptionSmaller = '<'
  • barometer_bricklet.ThresholdOptionGreater = '>'
func (*BarometerBricklet) SetAltitudeCallbackThreshold(option ThresholdOption, min int32, max int32) (err error)

Setzt den Schwellwert für den RegisterAltitudeReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

Der Standardwert ist ('x', 0, 0).

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

  • barometer_bricklet.ThresholdOptionOff = 'x'
  • barometer_bricklet.ThresholdOptionOutside = 'o'
  • barometer_bricklet.ThresholdOptionInside = 'i'
  • barometer_bricklet.ThresholdOptionSmaller = '<'
  • barometer_bricklet.ThresholdOptionGreater = '>'
func (*BarometerBricklet) GetAltitudeCallbackThreshold() (option ThresholdOption, min int32, max int32, err error)

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

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

  • barometer_bricklet.ThresholdOptionOff = 'x'
  • barometer_bricklet.ThresholdOptionOutside = 'o'
  • barometer_bricklet.ThresholdOptionInside = 'i'
  • barometer_bricklet.ThresholdOptionSmaller = '<'
  • barometer_bricklet.ThresholdOptionGreater = '>'
func (*BarometerBricklet) SetDebouncePeriod(debounce uint32) (err error)

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

func (*BarometerBricklet) GetDebouncePeriod() (debounce uint32, err 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 (*BarometerBricklet) RegisterAirPressureCallback(func(airPressure int32)) (registrationId uint64)

Ein Callback für dieses Event kann mit der Funktion RegisterAirPressureCallback() hinzugefügt werden. Diese gibt die ID des registrierten Callbacks zurück. Ein hinzugefügtes Callback kann mit der Funktion DeregisterAirPressureCallback(registrationId uint64) wieder entfernt werden.

Dieser Callback wird mit der Periode, wie gesetzt mit SetAirPressureCallbackPeriod(), ausgelöst. Der Parameter des Callbacks ist der Luftdruck des Luftdrucksensors.

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

func (*BarometerBricklet) RegisterAltitudeCallback(func(altitude int32)) (registrationId uint64)

Ein Callback für dieses Event kann mit der Funktion RegisterAltitudeCallback() hinzugefügt werden. Diese gibt die ID des registrierten Callbacks zurück. Ein hinzugefügtes Callback kann mit der Funktion DeregisterAltitudeCallback(registrationId uint64) wieder entfernt werden.

Dieser Callback wird mit der Periode, wie gesetzt mit SetAltitudeCallbackPeriod(), ausgelöst. Der Parameter des Callbacks ist die Höhe des Luftdrucksensors.

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

func (*BarometerBricklet) RegisterAirPressureReachedCallback(func(airPressure int32)) (registrationId uint64)

Ein Callback für dieses Event kann mit der Funktion RegisterAirPressureReachedCallback() hinzugefügt werden. Diese gibt die ID des registrierten Callbacks zurück. Ein hinzugefügtes Callback kann mit der Funktion DeregisterAirPressureReachedCallback(registrationId uint64) wieder entfernt werden.

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetAirPressureCallbackThreshold() gesetzt, erreicht wird. Der Parameter des Callbacks ist der Luftdruck des Luftdrucksensors.

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

func (*BarometerBricklet) RegisterAltitudeReachedCallback(func(altitude int32)) (registrationId uint64)

Ein Callback für dieses Event kann mit der Funktion RegisterAltitudeReachedCallback() hinzugefügt werden. Diese gibt die ID des registrierten Callbacks zurück. Ein hinzugefügtes Callback kann mit der Funktion DeregisterAltitudeReachedCallback(registrationId uint64) wieder entfernt werden.

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetAltitudeCallbackThreshold() gesetzt, erreicht wird. Der Parameter des Callbacks ist die Höhe des Luftdrucksensors.

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

Konstanten

barometer_bricklet.DeviceIdentifier

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

barometer_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines Barometer Bricklet dar.