Go - Air Quality Bricklet¶

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
32
33
34
35
36
37
38
39
40
41
42

package main

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

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    aq, _ := air_quality_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 all values.
    iaqIndex, iaqIndexAccuracy, temperature, humidity, airPressure, _ := aq.GetAllValues()

    fmt.Printf("IAQ Index: %d\n", iaqIndex)

    if iaqIndexAccuracy == air_quality_bricklet.AccuracyUnreliable {
        fmt.Println("IAQ Index Accuracy: Unreliable")
    } else if iaqIndexAccuracy == air_quality_bricklet.AccuracyLow {
        fmt.Println("IAQ Index Accuracy: Low")
    } else if iaqIndexAccuracy == air_quality_bricklet.AccuracyMedium {
        fmt.Println("IAQ Index Accuracy: Medium")
    } else if iaqIndexAccuracy == air_quality_bricklet.AccuracyHigh {
        fmt.Println("IAQ Index Accuracy: High")
    }

    fmt.Printf("Temperature: %f °C\n", float64(temperature)/100.0)
    fmt.Printf("Humidity: %f %%RH\n", float64(humidity)/100.0)
    fmt.Printf("Air Pressure: %f hPa\n", float64(airPressure)/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
33
34
35
36
37
38
39
40
41
42
43
44
45

package main

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

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

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

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

    aq.RegisterAllValuesCallback(func(iaqIndex int32, iaqIndexAccuracy air_quality_bricklet.Accuracy, temperature int32, humidity int32, airPressure int32) {
        fmt.Printf("IAQ Index: %d\n", iaqIndex)

        if iaqIndexAccuracy == air_quality_bricklet.AccuracyUnreliable {
            fmt.Println("IAQ Index Accuracy: Unreliable")
        } else if iaqIndexAccuracy == air_quality_bricklet.AccuracyLow {
            fmt.Println("IAQ Index Accuracy: Low")
        } else if iaqIndexAccuracy == air_quality_bricklet.AccuracyMedium {
            fmt.Println("IAQ Index Accuracy: Medium")
        } else if iaqIndexAccuracy == air_quality_bricklet.AccuracyHigh {
            fmt.Println("IAQ Index Accuracy: High")
        }

        fmt.Printf("Temperature: %f °C\n", float64(temperature)/100.0)
        fmt.Printf("Humidity: %f %%RH\n", float64(humidity)/100.0)
        fmt.Printf("Air Pressure: %f hPa\n", float64(airPressure)/100.0)
        fmt.Println()
    })

    // Set period for all values callback to 1s (1000ms).
    aq.SetAllValuesCallbackConfiguration(1000, false)

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

Grundfunktionen¶

func air_quality_bricklet.New(uid string, ipcon *IPConnection) (device AirQualityBricklet, err error)¶

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

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

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

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

func (*AirQualityBricklet) GetAllValues() (iaqIndex int32, iaqIndexAccuracy uint8, temperature int32, humidity int32, airPressure int32, err error)¶

Rückgabe:	iaqIndex – Typ: int32, Wertebereich: [0 bis 500] iaqIndexAccuracy – Typ: uint8, Wertebereich: Siehe Konstanten temperature – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1] humidity – Typ: int32, Einheit: 1/100 %, Wertebereich: [-231 bis 231 - 1] airPressure – Typ: int32, Einheit: 1/100 hPa, Wertebereich: [-231 bis 231 - 1] err – Typ: error

Gibt alle Werte zurück, die das Air Quality Bricklet misst. Diese Werte umfassen: IAQ (Indoor Air Quality = Innenraumluftqualität) Index (ein höherer Werte bedeutet eine stärkere Luftverschmutzung), IAQ Index Genauigkeit, Temperatur, Luftfeuchte und Luftdruck.

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

Für iaqIndexAccuracy:

• air_quality_bricklet.AccuracyUnreliable = 0
• air_quality_bricklet.AccuracyLow = 1
• air_quality_bricklet.AccuracyMedium = 2
• air_quality_bricklet.AccuracyHigh = 3

func (*AirQualityBricklet) SetTemperatureOffset(offset int32) (err error)¶

Parameter:	offset – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1]
Rückgabe:	err – Typ: error

Setzt ein Temperatur-Offset. Ein Offset von 10 verringert die gemessene Temperatur um 0,1 °C.

Wenn das Bricklet in einem Gehäuse verbaut wird, aber die Umgebungstemperatur außerhalb des Gehäuses gemessen werden soll, dann muss vom gemessenen Temperatur ein bestimmter Wert abgezogen werden, um den Messfehler durch das Aufheizen des Gehäuses zu kompensieren.

Wir empfehlen den Messaufbau im Gehäuse mindestens 24 Stunden laufen zu lassen, damit sich ein Temperaturgleichgewicht einstellt. Danach muss die Temperatur außerhalb des Gehäuses gemessen werden und die Differenz zur Temperatur innerhalb des Gehäuses als Offset eingestellt werden.

Dieses Temperatur-Offset geht in die Berechnung der Luftfeuchte und des IAQ Index mit ein. Um die Genauigkeit der Messwerte innerhalb eines Gehäuses zu verbessern sollte der Temperatur-Offset unbedingt bestimmt und eingestellt werden.

func (*AirQualityBricklet) GetTemperatureOffset() (offset int32, err error)¶

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

Gibt das Temperatur-Offset zurück, wie mittels SetTemperatureOffset() gesetzt.

func (*AirQualityBricklet) GetIAQIndex() (iaqIndex int32, iaqIndexAccuracy uint8, err error)¶

Rückgabe:	iaqIndex – Typ: int32, Wertebereich: [0 bis 500] iaqIndexAccuracy – Typ: uint8, Wertebereich: Siehe Konstanten err – Typ: error

Gibt den IAQ Index und dessen Genaugkeit zurück. Ein höherer Werte bedeutet eine stärkere Luftverschmutzung.

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

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

Für iaqIndexAccuracy:

• air_quality_bricklet.AccuracyUnreliable = 0
• air_quality_bricklet.AccuracyLow = 1
• air_quality_bricklet.AccuracyMedium = 2
• air_quality_bricklet.AccuracyHigh = 3

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

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

Gibt die Temperatur zurück.

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

func (*AirQualityBricklet) GetHumidity() (humidity int32, err error)¶

Rückgabe:	humidity – Typ: int32, Einheit: 1/100 %, Wertebereich: [-231 bis 231 - 1] err – Typ: error

Gibt die relative Luftfeuchtigkeit zurück.

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

func (*AirQualityBricklet) GetAirPressure() (airPressure int32, err error)¶

Rückgabe:	airPressure – Typ: int32, Einheit: 1/100 hPa, Wertebereich: [-231 bis 231 - 1] err – Typ: error

Gibt den Luftdruck Schritten zurück.

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

Fortgeschrittene Funktionen¶

func (*AirQualityBricklet) RemoveCalibration() (err error)¶

Rückgabe:	err – Typ: error

Löscht die Kalibrierung auf dem Flash. Nach dem diese Funktion aufgerufen wird muss das Air Quality Bricklet vom Strom getrennt werden.

Beim nächsten starten des Bricklet wird eine komplett neue Kalibrierung gestartet, wie beim allerersten Starten des Bricklets.

Die Kalibrierung basiert auf den Daten der letzten vier Tage, daher dauert es vier Tage bis eine volle Kalibrierung wieder hergestellt ist.

Neu in Version 2.0.3 (Plugin).

func (*AirQualityBricklet) SetBackgroundCalibrationDuration(duration uint8) (err error)¶

Parameter:	duration – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 1
Rückgabe:	err – Typ: error

Das Air Quality Bricklet nutzt eine automatische Hintergrundkalibrierung um den IAQ-Index zu bestimmen. Der Kalibrierungsmechanismus nutzt eine Historie von gemessenen Werte. Die Länge dieser Historie kann zwischen 4 und 28 Tagen konfiguriert werden.

Wenn das Bricklet hauptsächlich am gleichen Ort bleibt und die Umgebung nicht oft verändert wird, empfehlen wir eine Länge von 28 Tagen zu verwenden.

Wenn die Länge geändert wird,wird die aktuelle Kalibrierung verworfen und die Kalibrierung beginnt von vorne. Die Konfiguration der Länge wird im Flash gespeichert, diese Funktion sollte also nur einmal in der Lebenszeit des Bricklets aufgerufen werden müssen.

Eine Änderung der Kalibrierungslänge wird beim nächsten Start des Bricklets übernommen.

Vor Firmware-Version 2.0.3 war die Hintergrundkalibrierungslänge 4 Tage und nicht konfigurierbare.

Der Standardwert (seit Firmware-Version 2.0.3) beträgt 28 Tage.

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

Für duration:

• air_quality_bricklet.Duration4Days = 0
• air_quality_bricklet.Duration28Days = 1

Neu in Version 2.0.3 (Plugin).

func (*AirQualityBricklet) GetBackgroundCalibrationDuration() (duration uint8, err error)¶

Rückgabe:	duration – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 1 err – Typ: error

Gibt die Länge der Hintergrundkalibrierung zurück, wie von SetBackgroundCalibrationDuration() gesetzt.

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

Für duration:

• air_quality_bricklet.Duration4Days = 0
• air_quality_bricklet.Duration28Days = 1

Neu in Version 2.0.3 (Plugin).

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

• air_quality_bricklet.StatusLEDConfigOff = 0
• air_quality_bricklet.StatusLEDConfigOn = 1
• air_quality_bricklet.StatusLEDConfigShowHeartbeat = 2
• air_quality_bricklet.StatusLEDConfigShowStatus = 3

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

• air_quality_bricklet.StatusLEDConfigOff = 0
• air_quality_bricklet.StatusLEDConfigOn = 1
• air_quality_bricklet.StatusLEDConfigShowHeartbeat = 2
• air_quality_bricklet.StatusLEDConfigShowStatus = 3

func (*AirQualityBricklet) 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 (*AirQualityBricklet) 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 (*AirQualityBricklet) 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', '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 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 (*AirQualityBricklet) SetAllValuesCallbackConfiguration(period uint32, valueHasToChange bool) (err error)¶

Parameter:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false
Rückgabe:	err – Typ: error

Die Periode ist die Periode mit der der AllValuesCallback 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 sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn ein 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 der Werte.

func (*AirQualityBricklet) GetAllValuesCallbackConfiguration() (period uint32, valueHasToChange bool, err error)¶

Rückgabe:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false err – Typ: error

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

func (*AirQualityBricklet) SetIAQIndexCallbackConfiguration(period uint32, valueHasToChange bool) (err error)¶

Parameter:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false
Rückgabe:	err – Typ: error

Die Periode ist die Periode mit der der IAQIndexCallback 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 sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn ein 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 der Werte.

func (*AirQualityBricklet) GetIAQIndexCallbackConfiguration() (period uint32, valueHasToChange bool, err error)¶

Rückgabe:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false err – Typ: error

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

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

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

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

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

func (*AirQualityBricklet) SetHumidityCallbackConfiguration(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 %, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: int32, Einheit: 1/100 %, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Rückgabe:	err – Typ: error

Die Periode ist die Periode mit der der HumidityCallback 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 HumidityCallback 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:

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

func (*AirQualityBricklet) GetHumidityCallbackConfiguration() (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 %, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: int32, Einheit: 1/100 %, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 err – Typ: error

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

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

Für option:

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

func (*AirQualityBricklet) 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/100 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: int32, Einheit: 1/100 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Rückgabe:	err – Typ: error

Die Periode ist die Periode mit der der AirPressureCallback 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 AirPressureCallback 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:

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

func (*AirQualityBricklet) 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/100 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: int32, Einheit: 1/100 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:

• air_quality_bricklet.ThresholdOptionOff = 'x'
• air_quality_bricklet.ThresholdOptionOutside = 'o'
• air_quality_bricklet.ThresholdOptionInside = 'i'
• air_quality_bricklet.ThresholdOptionSmaller = '<'
• air_quality_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.

func (*AirQualityBricklet) RegisterAllValuesCallback(func(iaqIndex int32, iaqIndexAccuracy uint8, temperature int32, humidity int32, airPressure int32)) (registrationId uint64)¶

Callback-Parameter:	iaqIndex – Typ: int32, Wertebereich: [0 bis 500] iaqIndexAccuracy – Typ: uint8, Wertebereich: Siehe Konstanten temperature – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1] humidity – Typ: int32, Einheit: 1/100 %, Wertebereich: [-231 bis 231 - 1] airPressure – Typ: int32, Einheit: 1/100 hPa, Wertebereich: [-231 bis 231 - 1]
Rückgabe:	registrationId – Typ: uint64

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

Die Parameter des Callbacks sind der gleiche wie GetAllValues().

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

Für iaqIndexAccuracy:

• air_quality_bricklet.AccuracyUnreliable = 0
• air_quality_bricklet.AccuracyLow = 1
• air_quality_bricklet.AccuracyMedium = 2
• air_quality_bricklet.AccuracyHigh = 3

func (*AirQualityBricklet) RegisterIAQIndexCallback(func(iaqIndex int32, iaqIndexAccuracy uint8)) (registrationId uint64)¶

Callback-Parameter:	iaqIndex – Typ: int32, Wertebereich: [0 bis 500] iaqIndexAccuracy – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:	registrationId – Typ: uint64

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

Die Parameter des Callbacks sind die gleichen wie GetIAQIndex().

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

Für iaqIndexAccuracy:

• air_quality_bricklet.AccuracyUnreliable = 0
• air_quality_bricklet.AccuracyLow = 1
• air_quality_bricklet.AccuracyMedium = 2
• air_quality_bricklet.AccuracyHigh = 3

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

Callback-Parameter:	temperature – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1]
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().

func (*AirQualityBricklet) RegisterHumidityCallback(func(humidity int32)) (registrationId uint64)¶

Callback-Parameter:	humidity – Typ: int32, Einheit: 1/100 %, Wertebereich: [-231 bis 231 - 1]
Rückgabe:	registrationId – Typ: uint64

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

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

func (*AirQualityBricklet) RegisterAirPressureCallback(func(airPressure int32)) (registrationId uint64)¶

Callback-Parameter:	airPressure – Typ: int32, Einheit: 1/100 hPa, Wertebereich: [-231 bis 231 - 1]
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().

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

• air_quality_bricklet.FunctionSetTemperatureOffset = 2
• air_quality_bricklet.FunctionSetAllValuesCallbackConfiguration = 4
• air_quality_bricklet.FunctionSetIAQIndexCallbackConfiguration = 8
• air_quality_bricklet.FunctionSetTemperatureCallbackConfiguration = 12
• air_quality_bricklet.FunctionSetHumidityCallbackConfiguration = 16
• air_quality_bricklet.FunctionSetAirPressureCallbackConfiguration = 20
• air_quality_bricklet.FunctionRemoveCalibration = 23
• air_quality_bricklet.FunctionSetBackgroundCalibrationDuration = 24
• air_quality_bricklet.FunctionSetWriteFirmwarePointer = 237
• air_quality_bricklet.FunctionSetStatusLEDConfig = 239
• air_quality_bricklet.FunctionReset = 243
• air_quality_bricklet.FunctionWriteUID = 248

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

• air_quality_bricklet.FunctionSetTemperatureOffset = 2
• air_quality_bricklet.FunctionSetAllValuesCallbackConfiguration = 4
• air_quality_bricklet.FunctionSetIAQIndexCallbackConfiguration = 8
• air_quality_bricklet.FunctionSetTemperatureCallbackConfiguration = 12
• air_quality_bricklet.FunctionSetHumidityCallbackConfiguration = 16
• air_quality_bricklet.FunctionSetAirPressureCallbackConfiguration = 20
• air_quality_bricklet.FunctionRemoveCalibration = 23
• air_quality_bricklet.FunctionSetBackgroundCalibrationDuration = 24
• air_quality_bricklet.FunctionSetWriteFirmwarePointer = 237
• air_quality_bricklet.FunctionSetStatusLEDConfig = 239
• air_quality_bricklet.FunctionReset = 243
• air_quality_bricklet.FunctionWriteUID = 248

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

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

Für status:

• air_quality_bricklet.BootloaderStatusOK = 0
• air_quality_bricklet.BootloaderStatusInvalidMode = 1
• air_quality_bricklet.BootloaderStatusNoChange = 2
• air_quality_bricklet.BootloaderStatusEntryFunctionNotPresent = 3
• air_quality_bricklet.BootloaderStatusDeviceIdentifierIncorrect = 4
• air_quality_bricklet.BootloaderStatusCRCMismatch = 5

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

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

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

air_quality_bricklet.DeviceIdentifier¶

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

air_quality_bricklet.DeviceDisplayName¶

Diese Konstante stellt den Anzeigenamen eines Air Quality Bricklet dar.