LabVIEW - Particulate Matter Bricklet

Dies ist die Beschreibung der LabVIEW 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 LabVIEW API Bindings ist Teil deren allgemeine Beschreibung.

API

Prinzipiell kann jede Funktion der LabVIEW Bindings, welche einen Wert ausgibt eine Tinkerforge.TimeoutException melden. Dieser Fehler wird gemeldet wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist Tinkerforge.*.

Grundfunktionen

BrickletParticulateMatter(uid, ipcon) → particulateMatter
Eingabe:
  • uid -- String
  • ipcon -- .NET Refnum (IPConnection)
Ausgabe:
  • particulateMatter -- .NET Refnum (BrickletParticulateMatter)

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid. Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

BrickletParticulateMatter.GetPMConcentration() → pm10, pm25, pm100
Ausgabe:
  • pm10 -- Int32
  • pm25 -- Int32
  • pm100 -- Int32

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.

BrickletParticulateMatter.GetPMCount() → greater03um, greater05um, greater10um, greater25um, greater50um, greater100um
Ausgabe:
  • greater03um -- Int32
  • greater05um -- Int32
  • greater10um -- Int32
  • greater25um -- Int32
  • greater50um -- Int32
  • greater100um -- Int32

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.

Fortgeschrittene Funktionen

BrickletParticulateMatter.SetEnable(enable)
Eingabe:
  • enable -- Boolean

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.

BrickletParticulateMatter.GetEnable() → enable
Ausgabe:
  • enable -- Boolean

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

BrickletParticulateMatter.GetSensorInfo() → sensorVersion, lastErrorCode, framingErrorCount, checksumErrorCount
Ausgabe:
  • sensorVersion -- Byte
  • lastErrorCode -- Byte
  • framingErrorCount -- Byte
  • checksumErrorCount -- Byte

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.
BrickletParticulateMatter.GetAPIVersion() → apiVersion
Ausgabe:
  • apiVersion -- Byte[3]

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.

BrickletParticulateMatter.GetResponseExpected(functionId) → responseExpected
Eingabe:
  • functionId -- Byte
Ausgabe:
  • responseExpected -- Boolean

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.

Siehe SetResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

BrickletParticulateMatter.SetResponseExpected(functionId, responseExpected)
Eingabe:
  • functionId -- Byte
  • responseExpected -- Boolean

Ä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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletParticulateMatter.FUNCTION_SET_ENABLE = 3
  • BrickletParticulateMatter.FUNCTION_SET_PM_CONCENTRATION_CALLBACK_CONFIGURATION = 6
  • BrickletParticulateMatter.FUNCTION_SET_PM_COUNT_CALLBACK_CONFIGURATION = 8
  • BrickletParticulateMatter.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletParticulateMatter.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletParticulateMatter.FUNCTION_RESET = 243
  • BrickletParticulateMatter.FUNCTION_WRITE_UID = 248
BrickletParticulateMatter.SetResponseExpectedAll(responseExpected)
Eingabe:
  • responseExpected -- Boolean

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

BrickletParticulateMatter.GetSPITFPErrorCount() → errorCountAckChecksum, errorCountMessageChecksum, errorCountFrame, errorCountOverflow
Ausgabe:
  • errorCountAckChecksum -- Int64
  • errorCountMessageChecksum -- Int64
  • errorCountFrame -- Int64
  • errorCountOverflow -- Int64

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.

BrickletParticulateMatter.SetBootloaderMode(mode) → status
Eingabe:
  • mode -- Byte
Ausgabe:
  • status -- Byte

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:

  • BrickletParticulateMatter.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletParticulateMatter.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletParticulateMatter.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletParticulateMatter.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletParticulateMatter.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletParticulateMatter.BOOTLOADER_STATUS_OK = 0
  • BrickletParticulateMatter.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletParticulateMatter.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletParticulateMatter.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletParticulateMatter.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletParticulateMatter.BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletParticulateMatter.GetBootloaderMode() → mode
Ausgabe:
  • mode -- Byte

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

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

  • BrickletParticulateMatter.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletParticulateMatter.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletParticulateMatter.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletParticulateMatter.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletParticulateMatter.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletParticulateMatter.SetWriteFirmwarePointer(pointer)
Eingabe:
  • pointer -- Int64

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.

BrickletParticulateMatter.WriteFirmware(data) → status
Eingabe:
  • data -- Byte[64]
Ausgabe:
  • status -- Byte

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.

BrickletParticulateMatter.SetStatusLEDConfig(config)
Eingabe:
  • config -- Byte

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:

  • BrickletParticulateMatter.STATUS_LED_CONFIG_OFF = 0
  • BrickletParticulateMatter.STATUS_LED_CONFIG_ON = 1
  • BrickletParticulateMatter.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletParticulateMatter.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletParticulateMatter.GetStatusLEDConfig() → config
Ausgabe:
  • config -- Byte

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

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

  • BrickletParticulateMatter.STATUS_LED_CONFIG_OFF = 0
  • BrickletParticulateMatter.STATUS_LED_CONFIG_ON = 1
  • BrickletParticulateMatter.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletParticulateMatter.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletParticulateMatter.GetChipTemperature() → temperature
Ausgabe:
  • temperature -- Int16

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.

BrickletParticulateMatter.Reset()

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.

BrickletParticulateMatter.WriteUID(uid)
Eingabe:
  • uid -- Int64

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.

BrickletParticulateMatter.ReadUID() → uid
Ausgabe:
  • uid -- Int64

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

BrickletParticulateMatter.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier
Ausgabe:
  • uid -- String
  • connectedUid -- String
  • position -- Char
  • hardwareVersion -- Byte[3]
  • firmwareVersion -- Byte[3]
  • deviceIdentifier -- Int32

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

BrickletParticulateMatter.SetPMConcentrationCallbackConfiguration(period, valueHasToChange)
Eingabe:
  • period -- Int64
  • valueHasToChange -- Boolean

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

BrickletParticulateMatter.GetPMConcentrationCallbackConfiguration() → period, valueHasToChange
Ausgabe:
  • period -- Int64
  • valueHasToChange -- Boolean

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

BrickletParticulateMatter.SetPMCountCallbackConfiguration(period, valueHasToChange)
Eingabe:
  • period -- Int64
  • valueHasToChange -- Boolean

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

BrickletParticulateMatter.GetPMCountCallbackConfiguration() → period, valueHasToChange
Ausgabe:
  • period -- Int64
  • valueHasToChange -- Boolean

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 erfolgt indem eine Funktion einem Callback Property des Geräte Objektes zugewiesen wird. Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten beschrieben.

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.

event BrickletParticulateMatter.PMConcentrationCallback(sender, pm10, pm25, pm100)
Eingabe:
  • sender -- .NET Refnum (BrickletParticulateMatter)
  • pm10 -- Int32
  • pm25 -- Int32
  • pm100 -- Int32

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

Die Parameter sind der gleiche wie GetPMConcentration().

event BrickletParticulateMatter.PMCountCallback(sender, greater03um, greater05um, greater10um, greater25um, greater50um, greater100um)
Eingabe:
  • sender -- .NET Refnum (BrickletParticulateMatter)
  • greater03um -- Int32
  • greater05um -- Int32
  • greater10um -- Int32
  • greater25um -- Int32
  • greater50um -- Int32
  • greater100um -- Int32

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

Die Parameter sind der gleiche wie GetPMCount().

Konstanten

BrickletParticulateMatter.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Particulate Matter Bricklet zu identifizieren.

Die GetIdentity() Funktion und der IPConnection.EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletParticulateMatter.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Particulate Matter Bricklet dar.