Go - Particulate Matter Bricklet

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

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

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    pm, _ := particulate_matter_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 PM concentration.
    pm10, pm25, pm100, _ := pm.GetPMConcentration()

    fmt.Printf("PM 1.0:  µg/m³\n", pm10)
    fmt.Printf("PM 2.5:  µg/m³\n", pm25)
    fmt.Printf("PM 10.0:  µg/m³\n", pm100)

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

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

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

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

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

    pm.RegisterPMConcentrationCallback(func(pm10 uint16, pm25 uint16, pm100 uint16) {
        fmt.Printf("PM 1.0: %d µg/m³\n", pm10)
        fmt.Printf("PM 2.5: %d µg/m³\n", pm25)
        fmt.Printf("PM 10.0: %d µg/m³\n", pm100)
        fmt.Println()
    })

    // Set period for PM concentration callback to 1s (1000ms).
    pm.SetPMConcentrationCallbackConfiguration(1000, false)

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

API

Die API des Particulate Matter Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/particulate_matter_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 particulate_matter_bricklet.New(uid string, ipcon *IPConnection) (device ParticulateMatterBricklet, err error)

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

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

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

func (*ParticulateMatterBricklet) GetPMConcentration() (pm10 uint16, pm25 uint16, pm100 uint16, err error)

Gibt die Feinstaub-Konzentration in µg/m³ zurück, aufgeschlüsselt nach:

  • PM1.0,
  • PM2.5 und
  • PM10.0.

Wenn der Sensor deaktiviert ist (siehe SetEnable()), dann wird weiterhin der letzte Sensorwert zurückgegeben.

Wenn die Werte periodisch benötigt werden, kann auch der RegisterPMConcentrationCallback Callback verwendet werden. Der Callback wird mit der Funktion SetPMConcentrationCallbackConfiguration() konfiguriert.

func (*ParticulateMatterBricklet) GetPMCount() (greater03um uint16, greater05um uint16, greater10um uint16, greater25um uint16, greater50um uint16, greater100um uint16, err error)

Gibt die Anzahl der Feinstaub-Teilchen in 100ml Luft zurück, aufgeschlüsselt nach deren Durchmesser:

  • größer 0,3µm,
  • größer 0,5µm,
  • größer 1,0µm,
  • größer 2,5µm,
  • größer 5,0µm und
  • größer 10,0µm.

Wenn der Sensor deaktiviert ist (siehe SetEnable()), dann wird weiterhin der letzte Sensorwert zurückgegeben.

Wenn die Werte periodisch benötigt werden, kann auch der RegisterPMCountCallback Callback verwendet werden. Der Callback wird mit der Funktion SetPMCountCallbackConfiguration() konfiguriert.

Fortgeschrittene Funktionen

func (*ParticulateMatterBricklet) SetEnable(enable bool) (err error)

Aktiviert/deaktiviert den Lüfter und die Laserdiode des Sensors. Der Sensor ist standardmäßig aktiv.

Der Sensor benötigt ca. 30 Sekunden nach der Aktivierung um sich einzuschwingen und stabile Werte zu produzieren.

Die Lebensdauer der Laserdiode beträgt ca. 8000 Stunden. Wenn Messungen in größeren Abständen stattfinden sollen (z.B. stündlich) lohnt es sich die Laserdiode zwischen den Messungen auszumachen.

func (*ParticulateMatterBricklet) GetEnable() (enable bool, err error)

Gibt den Zustand des Sensors zurück, wie von SetEnable() gesetzt.

func (*ParticulateMatterBricklet) GetSensorInfo() (sensorVersion uint8, lastErrorCode uint8, framingErrorCount uint8, checksumErrorCount uint8, err error)

Gibt Informationen über den Sensor zurück:

  • die Versionsnummer des Sensors,
  • den letzten Fehlercode den der Sensor gemeldet (0 bedeute kein Fehler) hat,
  • die Anzahl der Framing und Prüfsummenfehler die in der Kommunikation mit dem Sensor aufgetreten sind.
func (*ParticulateMatterBricklet) 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 (*ParticulateMatterBricklet) 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:

  • particulate_matter_bricklet.FunctionSetEnable = 3
  • particulate_matter_bricklet.FunctionSetPMConcentrationCallbackConfiguration = 6
  • particulate_matter_bricklet.FunctionSetPMCountCallbackConfiguration = 8
  • particulate_matter_bricklet.FunctionSetWriteFirmwarePointer = 237
  • particulate_matter_bricklet.FunctionSetStatusLEDConfig = 239
  • particulate_matter_bricklet.FunctionReset = 243
  • particulate_matter_bricklet.FunctionWriteUID = 248
func (*ParticulateMatterBricklet) 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:

  • particulate_matter_bricklet.FunctionSetEnable = 3
  • particulate_matter_bricklet.FunctionSetPMConcentrationCallbackConfiguration = 6
  • particulate_matter_bricklet.FunctionSetPMCountCallbackConfiguration = 8
  • particulate_matter_bricklet.FunctionSetWriteFirmwarePointer = 237
  • particulate_matter_bricklet.FunctionSetStatusLEDConfig = 239
  • particulate_matter_bricklet.FunctionReset = 243
  • particulate_matter_bricklet.FunctionWriteUID = 248
func (*ParticulateMatterBricklet) SetResponseExpectedAll(responseExpected bool) (err error)

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

func (*ParticulateMatterBricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err 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 (*ParticulateMatterBricklet) SetBootloaderMode(mode BootloaderMode) (status BootloaderStatus, err 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 Bootlodaer- 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:

  • particulate_matter_bricklet.BootloaderModeBootloader = 0
  • particulate_matter_bricklet.BootloaderModeFirmware = 1
  • particulate_matter_bricklet.BootloaderModeBootloaderWaitForReboot = 2
  • particulate_matter_bricklet.BootloaderModeFirmwareWaitForReboot = 3
  • particulate_matter_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4
  • particulate_matter_bricklet.BootloaderStatusOK = 0
  • particulate_matter_bricklet.BootloaderStatusInvalidMode = 1
  • particulate_matter_bricklet.BootloaderStatusNoChange = 2
  • particulate_matter_bricklet.BootloaderStatusEntryFunctionNotPresent = 3
  • particulate_matter_bricklet.BootloaderStatusDeviceIdentifierIncorrect = 4
  • particulate_matter_bricklet.BootloaderStatusCRCMismatch = 5
func (*ParticulateMatterBricklet) GetBootloaderMode() (mode BootloaderMode, err error)

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode().

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

  • particulate_matter_bricklet.BootloaderModeBootloader = 0
  • particulate_matter_bricklet.BootloaderModeFirmware = 1
  • particulate_matter_bricklet.BootloaderModeBootloaderWaitForReboot = 2
  • particulate_matter_bricklet.BootloaderModeFirmwareWaitForReboot = 3
  • particulate_matter_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4
func (*ParticulateMatterBricklet) SetWriteFirmwarePointer(pointer uint32) (err 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 (*ParticulateMatterBricklet) WriteFirmware(data [64]uint8) (status uint8, err 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 (*ParticulateMatterBricklet) SetStatusLEDConfig(config StatusLEDConfig) (err 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:

  • particulate_matter_bricklet.StatusLEDConfigOff = 0
  • particulate_matter_bricklet.StatusLEDConfigOn = 1
  • particulate_matter_bricklet.StatusLEDConfigShowHeartbeat = 2
  • particulate_matter_bricklet.StatusLEDConfigShowStatus = 3
func (*ParticulateMatterBricklet) GetStatusLEDConfig() (config StatusLEDConfig, err error)

Gibt die Konfiguration zurück, wie von SetStatusLEDConfig() gesetzt.

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

  • particulate_matter_bricklet.StatusLEDConfigOff = 0
  • particulate_matter_bricklet.StatusLEDConfigOn = 1
  • particulate_matter_bricklet.StatusLEDConfigShowHeartbeat = 2
  • particulate_matter_bricklet.StatusLEDConfigShowStatus = 3
func (*ParticulateMatterBricklet) GetChipTemperature() (temperature int16, err error)

Gibt die Temperatur in °C, 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 (*ParticulateMatterBricklet) Reset() (err 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 (*ParticulateMatterBricklet) WriteUID(uid uint32) (err 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 (*ParticulateMatterBricklet) ReadUID() (uid uint32, err error)

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

func (*ParticulateMatterBricklet) 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 (*ParticulateMatterBricklet) SetPMConcentrationCallbackConfiguration(period uint32, valueHasToChange bool) (err error)

Die Periode in ms ist die Periode mit der der RegisterPMConcentrationCallback 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.

Der Standardwert ist (0, false).

func (*ParticulateMatterBricklet) GetPMConcentrationCallbackConfiguration() (period uint32, valueHasToChange bool, err error)

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

func (*ParticulateMatterBricklet) SetPMCountCallbackConfiguration(period uint32, valueHasToChange bool) (err error)

Die Periode in ms ist die Periode mit der der RegisterPMCountCallback 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.

Der Standardwert ist (0, false).

func (*ParticulateMatterBricklet) GetPMCountCallbackConfiguration() (period uint32, valueHasToChange bool, err error)

Gibt die Callback-Konfiguration zurück, wie mittels SetPMCountCallbackConfiguration() 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 (*ParticulateMatterBricklet) RegisterPMConcentrationCallback(func(pm10 uint16, pm25 uint16, pm100 uint16)) (registrationId uint64)

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

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

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

func (*ParticulateMatterBricklet) RegisterPMCountCallback(func(greater03um uint16, greater05um uint16, greater10um uint16, greater25um uint16, greater50um uint16, greater100um uint16)) (registrationId uint64)

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

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

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

Konstanten

particulate_matter_bricklet.DeviceIdentifier

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

particulate_matter_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines Particulate Matter Bricklet dar.