Go - Barometer Bricklet 2.0

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

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

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/barometer_v2_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 2.0.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    b, _ := barometer_v2_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 hPa\n", float64(airPressure)/1000.0)
    })

    // Set period for air pressure callback to 1s (1000ms) without a threshold.
    b.SetAirPressureCallbackConfiguration(1000, false, 'x', 0, 0)

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

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_v2_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 2.0.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    b, _ := barometer_v2_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 hPa\n", float64(airPressure)/1000.0)

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

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

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/barometer_v2_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 2.0.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    b, _ := barometer_v2_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 hPa\n", float64(airPressure)/1000.0)
        fmt.Println("Enjoy the potentially good weather!")
    })

    // Configure threshold for air pressure "greater than 1025 hPa"
    // with a debounce period of 1s (1000ms).
    b.SetAirPressureCallbackConfiguration(1000, false, '>', 1025*1000, 0)

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

API

Die API des Barometer Bricklet 2.0 ist im Package github.com/Tinkerforge/go-api-bindings/barometer_v2_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 barometer_v2_bricklet.New(uid string, ipcon *IPConnection) (device BarometerV2Bricklet, err error)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: *IPConnection
Rückgabe:
  • device – Typ: BarometerV2Bricklet
  • err – Typ: error

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

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

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

func (*BarometerV2Bricklet) GetAirPressure() (airPressure int32, err error)
Rückgabe:
  • airPressure – Typ: int32, Einheit: 1/1000 hPa, Wertebereich: [260000 bis 1260000]
  • err – Typ: error

Gibt den Luftdruck des Luftdrucksensors zurück.

Wenn der Wert periodisch benötigt wird, kann auch der RegisterAirPressureCallback Callback verwendet werden. Der Callback wird mit der Funktion SetAirPressureCallbackConfiguration() konfiguriert.

func (*BarometerV2Bricklet) GetAltitude() (altitude int32, err error)
Rückgabe:
  • altitude – Typ: int32, Einheit: 1 mm, Wertebereich: [-231 bis 231 - 1]
  • err – Typ: error

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

Wenn der Wert periodisch benötigt wird, kann auch der RegisterAltitudeCallback Callback verwendet werden. Der Callback wird mit der Funktion SetAltitudeCallbackConfiguration() konfiguriert.

func (*BarometerV2Bricklet) GetTemperature() (temperature int32, err error)
Rückgabe:
  • temperature – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-4000 bis 8500]
  • err – Typ: error

Gibt die Temperatur des Luftdrucksensors zurück.

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

Wenn der Wert periodisch benötigt wird, kann auch der RegisterTemperatureCallback Callback verwendet werden. Der Callback wird mit der Funktion SetTemperatureCallbackConfiguration() konfiguriert.

func (*BarometerV2Bricklet) SetMovingAverageConfiguration(movingAverageLengthAirPressure uint16, movingAverageLengthTemperature uint16) (err error)
Parameter:
  • movingAverageLengthAirPressure – Typ: uint16, Wertebereich: [1 bis 1000], Standardwert: 100
  • movingAverageLengthTemperature – Typ: uint16, Wertebereich: [1 bis 1000], Standardwert: 100
Rückgabe:
  • err – Typ: error

Setzt die Länge eines gleitenden Mittelwerts für die Luftdruck- und Temperaturmessung.

Wenn die Länge auf 1 gesetzt wird, ist die Mittelwertbildung deaktiviert. Je kürzer die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Bei Langzeitmessungen gibt ein langer Mittelwert die saubersten Resultate.

func (*BarometerV2Bricklet) GetMovingAverageConfiguration() (movingAverageLengthAirPressure uint16, movingAverageLengthTemperature uint16, err error)
Rückgabe:
  • movingAverageLengthAirPressure – Typ: uint16, Wertebereich: [1 bis 1000], Standardwert: 100
  • movingAverageLengthTemperature – Typ: uint16, Wertebereich: [1 bis 1000], Standardwert: 100
  • err – Typ: error

Gibt die Moving Average-Konfiguration zurück, wie von SetMovingAverageConfiguration() gesetzt.

func (*BarometerV2Bricklet) SetReferenceAirPressure(airPressure int32) (err error)
Parameter:
  • airPressure – Typ: int32, Einheit: 1/1000 hPa, Wertebereich: [0, 260000 bis 1260000], Standardwert: 1013250
Rückgabe:
  • err – Typ: error

Setzt den Referenzluftdruck für die Höhenberechnung. Wenn der aktuelle Luftdruckwert als Referenz übergeben wird dann gibt die Höhenberechnung 0mm 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.

func (*BarometerV2Bricklet) GetReferenceAirPressure() (airPressure int32, err error)
Rückgabe:
  • airPressure – Typ: int32, Einheit: 1/1000 hPa, Wertebereich: [260000 bis 1260000], Standardwert: 1013250
  • err – Typ: error

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

Fortgeschrittene Funktionen

func (*BarometerV2Bricklet) SetCalibration(measuredAirPressure int32, actualAirPressure int32) (err error)
Parameter:
  • measuredAirPressure – Typ: int32, Einheit: 1/1000 hPa, Wertebereich: [0, 260000 bis 1260000]
  • actualAirPressure – Typ: int32, Einheit: 1/1000 hPa, Wertebereich: [0, 260000 bis 1260000]
Rückgabe:
  • err – Typ: error

Setzt den One Point Calibration (OPC) Werte für die Luftdruckmessung.

Bevor das Bricklet kalibriert werden kann muss die möglicherweise vorhandene Kalibierung gelöschet werden, dazu muss Measured Air Pressure und Actual Air Pressure auf 0 gesetzt werden.

Dann muss der aktuelle Luftdruck gleichzeitig mit dem Bricklet (Measured Air Pressure) und einem genauen Referenzbarometer (Actual Air Pressure) gemessen und die Werte an diese Funktion übergeben werden.

Nach einer ordentlichen Kalibrierung kann der Luftdruck mit bis zu 0,2 hPa Genauigkeit gemessen werden

Die Kalibrierung wird im EEPROM des Bricklets gespeichert und muss nur einmal gesetzt werden.

func (*BarometerV2Bricklet) GetCalibration() (measuredAirPressure int32, actualAirPressure int32, err error)
Rückgabe:
  • measuredAirPressure – Typ: int32, Einheit: 1/1000 hPa, Wertebereich: [0, 260000 bis 1260000]
  • actualAirPressure – Typ: int32, Einheit: 1/1000 hPa, Wertebereich: [0, 260000 bis 1260000]
  • err – Typ: error

Gibt die Luftdruck One Point Calibration Werte zurück, wie von SetCalibration() gesetzt.

func (*BarometerV2Bricklet) SetSensorConfiguration(dataRate uint8, airPressureLowPassFilter uint8) (err error)
Parameter:
  • dataRate – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 4
  • airPressureLowPassFilter – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 1
Rückgabe:
  • err – Typ: error

Konfiguriert die Datenrate und des Luftdrucktiefpassfilter. Die Grenzfrequenz des Tiefpassfilters (falls aktiviert) kann auf 1/9tel oder 1/20stel der eingestellten Datenrate gesetzt werden, um das Rauschen auf den Luftdruckdaten zu verringert.

Die Tiefpassfiltereinstellung gilt nur für die Luftdruckmessung. Es gibt keinen Tiefpassfilter für die Temperaturmessung.

Eine Verringerung der Datenrate oder des Wertebereichs verringert auch automatisch das Rauschen auf den Daten. Eine hohe Datenrate erhöht zusätzlich die Selbsterhitzung des Sensors. Wenn eine hohe Temperaturgenauigkeit wichtig ist empfehlen wir eine Datenrate von 1Hz.

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

Für dataRate:

  • barometer_v2_bricklet.DataRateOff = 0
  • barometer_v2_bricklet.DataRate1Hz = 1
  • barometer_v2_bricklet.DataRate10Hz = 2
  • barometer_v2_bricklet.DataRate25Hz = 3
  • barometer_v2_bricklet.DataRate50Hz = 4
  • barometer_v2_bricklet.DataRate75Hz = 5

Für airPressureLowPassFilter:

  • barometer_v2_bricklet.LowPassFilterOff = 0
  • barometer_v2_bricklet.LowPassFilter1_9th = 1
  • barometer_v2_bricklet.LowPassFilter1_20th = 2
func (*BarometerV2Bricklet) GetSensorConfiguration() (dataRate uint8, airPressureLowPassFilter uint8, err error)
Rückgabe:
  • dataRate – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 4
  • airPressureLowPassFilter – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 1
  • err – Typ: error

Gibt die Sensor-Konfiguration zurück, wie von SetSensorConfiguration() gesetzt.

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

Für dataRate:

  • barometer_v2_bricklet.DataRateOff = 0
  • barometer_v2_bricklet.DataRate1Hz = 1
  • barometer_v2_bricklet.DataRate10Hz = 2
  • barometer_v2_bricklet.DataRate25Hz = 3
  • barometer_v2_bricklet.DataRate50Hz = 4
  • barometer_v2_bricklet.DataRate75Hz = 5

Für airPressureLowPassFilter:

  • barometer_v2_bricklet.LowPassFilterOff = 0
  • barometer_v2_bricklet.LowPassFilter1_9th = 1
  • barometer_v2_bricklet.LowPassFilter1_20th = 2
func (*BarometerV2Bricklet) 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 (*BarometerV2Bricklet) 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:

  • barometer_v2_bricklet.StatusLEDConfigOff = 0
  • barometer_v2_bricklet.StatusLEDConfigOn = 1
  • barometer_v2_bricklet.StatusLEDConfigShowHeartbeat = 2
  • barometer_v2_bricklet.StatusLEDConfigShowStatus = 3
func (*BarometerV2Bricklet) 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:

  • barometer_v2_bricklet.StatusLEDConfigOff = 0
  • barometer_v2_bricklet.StatusLEDConfigOn = 1
  • barometer_v2_bricklet.StatusLEDConfigShowHeartbeat = 2
  • barometer_v2_bricklet.StatusLEDConfigShowStatus = 3
func (*BarometerV2Bricklet) 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 (*BarometerV2Bricklet) 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 (*BarometerV2Bricklet) 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.

Konfigurationsfunktionen für Callbacks

func (*BarometerV2Bricklet) SetAirPressureCallbackConfiguration(period uint32, valueHasToChange bool, option rune, min int32, max int32) (err error)
Parameter:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: bool, Standardwert: false
  • option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int32, Einheit: 1/1000 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32, Einheit: 1/1000 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Rückgabe:
  • err – Typ: error

Die Periode ist die Periode mit der der RegisterAirPressureCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den RegisterAirPressureCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

  • barometer_v2_bricklet.ThresholdOptionOff = 'x'
  • barometer_v2_bricklet.ThresholdOptionOutside = 'o'
  • barometer_v2_bricklet.ThresholdOptionInside = 'i'
  • barometer_v2_bricklet.ThresholdOptionSmaller = '<'
  • barometer_v2_bricklet.ThresholdOptionGreater = '>'
func (*BarometerV2Bricklet) GetAirPressureCallbackConfiguration() (period uint32, valueHasToChange bool, option rune, min int32, max int32, err error)
Rückgabe:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: bool, Standardwert: false
  • option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int32, Einheit: 1/1000 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32, Einheit: 1/1000 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • err – Typ: error

Gibt die Callback-Konfiguration zurück, wie mittels SetAirPressureCallbackConfiguration() gesetzt.

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

Für option:

  • barometer_v2_bricklet.ThresholdOptionOff = 'x'
  • barometer_v2_bricklet.ThresholdOptionOutside = 'o'
  • barometer_v2_bricklet.ThresholdOptionInside = 'i'
  • barometer_v2_bricklet.ThresholdOptionSmaller = '<'
  • barometer_v2_bricklet.ThresholdOptionGreater = '>'
func (*BarometerV2Bricklet) SetAltitudeCallbackConfiguration(period uint32, valueHasToChange bool, option rune, min int32, max int32) (err error)
Parameter:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: bool, Standardwert: false
  • option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int32, Einheit: 1 mm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32, Einheit: 1 mm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Rückgabe:
  • err – Typ: error

Die Periode ist die Periode mit der der RegisterAltitudeCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den RegisterAltitudeCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

  • barometer_v2_bricklet.ThresholdOptionOff = 'x'
  • barometer_v2_bricklet.ThresholdOptionOutside = 'o'
  • barometer_v2_bricklet.ThresholdOptionInside = 'i'
  • barometer_v2_bricklet.ThresholdOptionSmaller = '<'
  • barometer_v2_bricklet.ThresholdOptionGreater = '>'
func (*BarometerV2Bricklet) GetAltitudeCallbackConfiguration() (period uint32, valueHasToChange bool, option rune, min int32, max int32, err error)
Rückgabe:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: bool, Standardwert: false
  • option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int32, Einheit: 1 mm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32, Einheit: 1 mm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • err – Typ: error

Gibt die Callback-Konfiguration zurück, wie mittels SetAltitudeCallbackConfiguration() gesetzt.

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

Für option:

  • barometer_v2_bricklet.ThresholdOptionOff = 'x'
  • barometer_v2_bricklet.ThresholdOptionOutside = 'o'
  • barometer_v2_bricklet.ThresholdOptionInside = 'i'
  • barometer_v2_bricklet.ThresholdOptionSmaller = '<'
  • barometer_v2_bricklet.ThresholdOptionGreater = '>'
func (*BarometerV2Bricklet) SetTemperatureCallbackConfiguration(period uint32, valueHasToChange bool, option rune, min int32, max int32) (err error)
Parameter:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: bool, Standardwert: false
  • option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Rückgabe:
  • err – Typ: error

Die Periode ist die Periode mit der der RegisterTemperatureCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den RegisterTemperatureCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

  • barometer_v2_bricklet.ThresholdOptionOff = 'x'
  • barometer_v2_bricklet.ThresholdOptionOutside = 'o'
  • barometer_v2_bricklet.ThresholdOptionInside = 'i'
  • barometer_v2_bricklet.ThresholdOptionSmaller = '<'
  • barometer_v2_bricklet.ThresholdOptionGreater = '>'
func (*BarometerV2Bricklet) GetTemperatureCallbackConfiguration() (period uint32, valueHasToChange bool, option rune, min int32, max int32, err error)
Rückgabe:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: bool, Standardwert: false
  • option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • err – Typ: error

Gibt die Callback-Konfiguration zurück, wie mittels SetTemperatureCallbackConfiguration() gesetzt.

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

Für option:

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

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 (*BarometerV2Bricklet) RegisterAirPressureCallback(func(airPressure int32)) (registrationId uint64)
Callback-Parameter:
  • airPressure – Typ: int32, Einheit: 1/1000 hPa, Wertebereich: [260000 bis 1260000]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird periodisch ausgelöst abhängig von der mittels SetAirPressureCallbackConfiguration() gesetzten Konfiguration

Der Parameter des Callbacks ist der gleiche wie GetAirPressure().

func (*BarometerV2Bricklet) RegisterAltitudeCallback(func(altitude int32)) (registrationId uint64)
Callback-Parameter:
  • altitude – Typ: int32, Einheit: 1 mm, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird periodisch ausgelöst abhängig von der mittels SetAltitudeCallbackConfiguration() gesetzten Konfiguration

Der Parameter des Callbacks ist der gleiche wie GetAltitude().

func (*BarometerV2Bricklet) RegisterTemperatureCallback(func(temperature int32)) (registrationId uint64)
Callback-Parameter:
  • temperature – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-4000 bis 8500]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird periodisch ausgelöst abhängig von der mittels SetTemperatureCallbackConfiguration() gesetzten Konfiguration

Der Parameter des Callbacks ist der gleiche wie GetTemperature().

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

  • barometer_v2_bricklet.FunctionSetAirPressureCallbackConfiguration = 2
  • barometer_v2_bricklet.FunctionSetAltitudeCallbackConfiguration = 6
  • barometer_v2_bricklet.FunctionSetTemperatureCallbackConfiguration = 10
  • barometer_v2_bricklet.FunctionSetMovingAverageConfiguration = 13
  • barometer_v2_bricklet.FunctionSetReferenceAirPressure = 15
  • barometer_v2_bricklet.FunctionSetCalibration = 17
  • barometer_v2_bricklet.FunctionSetSensorConfiguration = 19
  • barometer_v2_bricklet.FunctionSetWriteFirmwarePointer = 237
  • barometer_v2_bricklet.FunctionSetStatusLEDConfig = 239
  • barometer_v2_bricklet.FunctionReset = 243
  • barometer_v2_bricklet.FunctionWriteUID = 248
func (*BarometerV2Bricklet) 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:

  • barometer_v2_bricklet.FunctionSetAirPressureCallbackConfiguration = 2
  • barometer_v2_bricklet.FunctionSetAltitudeCallbackConfiguration = 6
  • barometer_v2_bricklet.FunctionSetTemperatureCallbackConfiguration = 10
  • barometer_v2_bricklet.FunctionSetMovingAverageConfiguration = 13
  • barometer_v2_bricklet.FunctionSetReferenceAirPressure = 15
  • barometer_v2_bricklet.FunctionSetCalibration = 17
  • barometer_v2_bricklet.FunctionSetSensorConfiguration = 19
  • barometer_v2_bricklet.FunctionSetWriteFirmwarePointer = 237
  • barometer_v2_bricklet.FunctionSetStatusLEDConfig = 239
  • barometer_v2_bricklet.FunctionReset = 243
  • barometer_v2_bricklet.FunctionWriteUID = 248
func (*BarometerV2Bricklet) 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.

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.

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

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

Für status:

  • barometer_v2_bricklet.BootloaderStatusOK = 0
  • barometer_v2_bricklet.BootloaderStatusInvalidMode = 1
  • barometer_v2_bricklet.BootloaderStatusNoChange = 2
  • barometer_v2_bricklet.BootloaderStatusEntryFunctionNotPresent = 3
  • barometer_v2_bricklet.BootloaderStatusDeviceIdentifierIncorrect = 4
  • barometer_v2_bricklet.BootloaderStatusCRCMismatch = 5
func (*BarometerV2Bricklet) 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:

  • barometer_v2_bricklet.BootloaderModeBootloader = 0
  • barometer_v2_bricklet.BootloaderModeFirmware = 1
  • barometer_v2_bricklet.BootloaderModeBootloaderWaitForReboot = 2
  • barometer_v2_bricklet.BootloaderModeFirmwareWaitForReboot = 3
  • barometer_v2_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4
func (*BarometerV2Bricklet) 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 (*BarometerV2Bricklet) 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 (*BarometerV2Bricklet) 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 (*BarometerV2Bricklet) 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.

Konstanten

barometer_v2_bricklet.DeviceIdentifier

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

Diese Konstante stellt den Anzeigenamen eines Barometer Bricklet 2.0 dar.