Go - CO2 Bricklet

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

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

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    co2, _ := co2_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 CO2 concentration.
    co2Concentration, _ := co2.GetCO2Concentration()
    fmt.Printf("CO2 Concentration:  ppm\n", co2Concentration)

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

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

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

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

    co2.RegisterCO2ConcentrationCallback(func(co2Concentration uint16) {
        fmt.Printf("CO2 Concentration: %d ppm\n", co2Concentration)
    })

    // Set period for CO2 concentration receiver to 1s (1000ms).
    // Note: The CO2 concentration callback is only called every second
    //       if the CO2 concentration has changed since the last call!
    co2.SetCO2ConcentrationCallbackPeriod(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
package main

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

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

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

    co2.RegisterCO2ConcentrationReachedCallback(func(co2Concentration uint16) {
        fmt.Printf("CO2 Concentration: %d ppm\n", co2Concentration)
    })

    // Configure threshold for CO2 concentration "greater than 750 ppm".
    co2.SetCO2ConcentrationCallbackThreshold('>', 750, 0)

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

API

Die API des CO2 Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/co2_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 co2_bricklet.New(uid string, ipcon *IPConnection) (device CO2Bricklet, err error)

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

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

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

func (*CO2Bricklet) GetCO2Concentration() (co2Concentration uint16, err error)

Gibt die gemessene CO2-Konzentration zurück. Der Wert ist in ppm (Teile pro Million) und im Bereich von 0 bis 10000.

Wenn die CO2-Konzentration periodisch abgefragt werden soll, wird empfohlen den RegisterCO2ConcentrationCallback Callback zu nutzen und die Periode mit SetCO2ConcentrationCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

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

  • co2_bricklet.FunctionSetCO2ConcentrationCallbackPeriod = 2
  • co2_bricklet.FunctionSetCO2ConcentrationCallbackThreshold = 4
  • co2_bricklet.FunctionSetDebouncePeriod = 6
func (*CO2Bricklet) 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:

  • co2_bricklet.FunctionSetCO2ConcentrationCallbackPeriod = 2
  • co2_bricklet.FunctionSetCO2ConcentrationCallbackThreshold = 4
  • co2_bricklet.FunctionSetDebouncePeriod = 6
func (*CO2Bricklet) SetResponseExpectedAll(responseExpected bool) (err error)

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

func (*CO2Bricklet) 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 (*CO2Bricklet) SetCO2ConcentrationCallbackPeriod(period uint32) (err error)

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

Der RegisterCO2ConcentrationCallback Callback wird nur ausgelöst, wenn sich die CO2-Konzentration seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

func (*CO2Bricklet) GetCO2ConcentrationCallbackPeriod() (period uint32, err error)

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

func (*CO2Bricklet) SetCO2ConcentrationCallbackThreshold(option ThresholdOption, min uint16, max uint16) (err error)

Setzt den Schwellwert für den RegisterCO2ConcentrationReachedCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die CO2-Konzentration außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die CO2-Konzentration innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die CO2-Konzentration kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die CO2-Konzentration 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:

  • co2_bricklet.ThresholdOptionOff = 'x'
  • co2_bricklet.ThresholdOptionOutside = 'o'
  • co2_bricklet.ThresholdOptionInside = 'i'
  • co2_bricklet.ThresholdOptionSmaller = '<'
  • co2_bricklet.ThresholdOptionGreater = '>'
func (*CO2Bricklet) GetCO2ConcentrationCallbackThreshold() (option ThresholdOption, min uint16, max uint16, err error)

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

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

  • co2_bricklet.ThresholdOptionOff = 'x'
  • co2_bricklet.ThresholdOptionOutside = 'o'
  • co2_bricklet.ThresholdOptionInside = 'i'
  • co2_bricklet.ThresholdOptionSmaller = '<'
  • co2_bricklet.ThresholdOptionGreater = '>'
func (*CO2Bricklet) 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 (*CO2Bricklet) 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 (*CO2Bricklet) RegisterCO2ConcentrationCallback(func(co2Concentration uint16)) (registrationId uint64)

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

Dieser Callback wird mit der Periode, wie gesetzt mit SetCO2ConcentrationCallbackPeriod(), ausgelöst. Der Parameter des Callbacks ist die gemessene CO2-Konzentration des Sensors.

Der RegisterCO2ConcentrationCallback Callback wird nur ausgelöst, wenn sich die CO2-Konzentration seit der letzten Auslösung geändert hat.

func (*CO2Bricklet) RegisterCO2ConcentrationReachedCallback(func(co2Concentration uint16)) (registrationId uint64)

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetCO2ConcentrationCallbackThreshold() gesetzt, erreicht wird. Der Parameter des Callbacks ist die gemessene CO2-Konzentration.

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

Konstanten

co2_bricklet.DeviceIdentifier

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

co2_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines CO2 Bricklet dar.