Mathematica - Air Quality Bricklet

Dies ist die Beschreibung der Mathematica API Bindings für das Air Quality Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Air Quality Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Mathematica API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.nb)

 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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Air Quality Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
aq=NETNew["Tinkerforge.BrickletAirQuality",uid,ipcon]
ipcon@Connect[host,port]

(*Get current all values*)
iaqIndex=0;iaqIndexAccuracy=0;temperature=0;humidity=0;airPressure=0
aq@GetAllValues[iaqIndex,iaqIndexAccuracy,temperature,humidity,airPressure]

Print["IAQ Index: "<>ToString[iaqIndex]]
If[iaqIndexAccuracy==Tinkerforge`BrickletAirQuality`ACCURACYUUNRELIABLE,Print["IAQ Index Accuracy: Unreliable"]]
If[iaqIndexAccuracy==Tinkerforge`BrickletAirQuality`ACCURACYULOW,Print["IAQ Index Accuracy: Low"]]
If[iaqIndexAccuracy==Tinkerforge`BrickletAirQuality`ACCURACYUMEDIUM,Print["IAQ Index Accuracy: Medium"]]
If[iaqIndexAccuracy==Tinkerforge`BrickletAirQuality`ACCURACYUHIGH,Print["IAQ Index Accuracy: High"]]
Print["Temperature: "<>ToString[N[Quantity[temperature,"°C/100"]]]]
Print["Humidity: "<>ToString[N[Quantity[humidity,"%RH/100"]]]]
Print["Air Pressure: "<>ToString[N[Quantity[airPressure,"mbar/100"]]]]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[aq]
ReleaseNETObject[ipcon]

Callback

Download (ExampleCallback.nb)

 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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Air Quality Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
aq=NETNew["Tinkerforge.BrickletAirQuality",uid,ipcon]
ipcon@Connect[host,port]

(*Callback function for all values callback*)
AllValuesCB[sender_,iaqIndex_,iaqIndexAccuracy_,temperature_,humidity_,airPressure_]:=
 Module[{},
  Print["IAQ Index: "<>ToString[iaqIndex]];
  If[iaqIndexAccuracy==Tinkerforge`BrickletAirQuality`ACCURACYUUNRELIABLE,Print["IAQ Index Accuracy: Unreliable"]];
  If[iaqIndexAccuracy==Tinkerforge`BrickletAirQuality`ACCURACYULOW,Print["IAQ Index Accuracy: Low"]];
  If[iaqIndexAccuracy==Tinkerforge`BrickletAirQuality`ACCURACYUMEDIUM,Print["IAQ Index Accuracy: Medium"]];
  If[iaqIndexAccuracy==Tinkerforge`BrickletAirQuality`ACCURACYUHIGH,Print["IAQ Index Accuracy: High"]];
  Print["Temperature: "<>ToString[N[Quantity[temperature,"°C/100"]]]];
  Print["Humidity: "<>ToString[N[Quantity[humidity,"%RH/100"]]]];
  Print["Air Pressure: "<>ToString[N[Quantity[airPressure,"mbar/100"]]]]
 ]

AddEventHandler[aq@AllValuesCallback,AllValuesCB]

(*Set period for all values callback to 1s (1000ms)*)
aq@SetAllValuesCallbackConfiguration[1000,False]

Input["Click OK to exit"]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[aq]
ReleaseNETObject[ipcon]

API

Prinzipiell kann jede Funktion der Mathematica Bindings, welche einen Wert zurück gibt eine Tinkerforge.TimeoutException werfen. Diese Exception wird geworfen 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.

Da .NET/Link nicht mehrere Rückgabewerte direkt unterstützt, wird das out Schlüsselwort genutzt, um mehrere Werte aus einer Funktion zurückzugeben. Weitere Informationen über das out Schlüsselwort in .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

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

Grundfunktionen

BrickletAirQuality[uid, ipcon] → airQuality
Parameter:
  • uid -- String
  • ipcon -- NETObject[IPConnection]
Rückgabe:
  • airQuality -- NETObject[BrickletAirQuality]

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

airQuality=NETNew["Tinkerforge.BrickletAirQuality","YOUR_DEVICE_UID",ipcon]

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

Die .NET Runtime hat eingebauten Garbage Collection welche Objekte wieder freigibt, wenn sie vom Programm nicht mehr verwendet werden. Da Mathematica aber selbst nicht automatisch feststellen kann, wann ein Mathematica "Programm" ein .NET Objekt nicht mehr verwendet, muss sich das Programm selbst darum kümmern. Für diesen Zweck wird die ReleaseNETObject[] Funktion in den Beispielen verwendet.

Weitere Informationen über Objekt-Verwaltung mittels .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

BrickletAirQuality@GetAllValues[out iaqIndex, out iaqIndexAccuracy, out temperature, out humidity, out airPressure] → Null
Parameter:
  • iaqIndex -- Integer
  • iaqIndexAccuracy -- Integer
  • temperature -- Integer
  • humidity -- Integer
  • airPressure -- Integer

Gibt alle Werte zurück, die das Air Quality Bricklet misst. Diese Werte umfassen: IAQ (Indoor Air Quality = Innenraumluftqualität) Index, IAQ Index Genauigkeit, Temperatur, Luftfeuchte und Luftdruck.

Air Quality Index description

Die Werte haben diese Bereiche und Einheiten:

  • IAQ Index: 0 bis 500, ein höhere Werte bedeutet eine stärkere Luftverschmutzung
  • IAQ Index Genauigkeit: 0 = unzuverlässig bis 3 = hoch
  • Temperatur: in 0,01 °C Schritten
  • Luftfeuchte: in 0,01 %RH Schritten
  • Luftdruck: in 0,01 mbar Schritten

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

  • BrickletAirQuality`ACCURACYUUNRELIABLE = 0
  • BrickletAirQuality`ACCURACYULOW = 1
  • BrickletAirQuality`ACCURACYUMEDIUM = 2
  • BrickletAirQuality`ACCURACYUHIGH = 3
BrickletAirQuality@SetTemperatureOffset[offset] → Null
Parameter:
  • offset -- Integer

Setzt ein Temperatur-Offset mit Auflösung 1/100°C. 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.

BrickletAirQuality@GetTemperatureOffset[] → offset
Rückgabe:
  • offset -- Integer

Gibt das Temperatur-Offset zurück, wie mittels SetTemperatureOffset[] gesetzt.

BrickletAirQuality@GetIAQIndex[out iaqIndex, out iaqIndexAccuracy] → Null
Parameter:
  • iaqIndex -- Integer
  • iaqIndexAccuracy -- Integer

Gibt den IAQ Index und dessen Genaugkeit zurück. Der IAQ Index hate einen Wertebereich von 0 bis 500, ein höhere Werte bedeutet eine stärkere Luftverschmutzung.

IAQ Index Beschreibung

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:

  • BrickletAirQuality`ACCURACYUUNRELIABLE = 0
  • BrickletAirQuality`ACCURACYULOW = 1
  • BrickletAirQuality`ACCURACYUMEDIUM = 2
  • BrickletAirQuality`ACCURACYUHIGH = 3
BrickletAirQuality@GetTemperature[] → temperature
Rückgabe:
  • temperature -- Integer

Gibt die Temperatur in 0,01 °C Schritten zurück.

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

BrickletAirQuality@GetHumidity[] → humidity
Rückgabe:
  • humidity -- Integer

Gibt die relative Luftfeuchtigkeit in 0,01 %RH Schritten zurück.

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

BrickletAirQuality@GetAirPressure[] → airPressure
Rückgabe:
  • airPressure -- Integer

Gibt den Luftdruck in 0,01 mbar 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

BrickletAirQuality@RemoveCalibration[] → Null

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).

BrickletAirQuality@SetBackgroundCalibrationDuration[duration] → Null
Parameter:
  • duration -- Integer

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:

  • BrickletAirQuality`DURATIONU4UDAYS = 0
  • BrickletAirQuality`DURATIONU28UDAYS = 1

Neu in Version 2.0.3 (Plugin).

BrickletAirQuality@GetBackgroundCalibrationDuration[] → duration
Rückgabe:
  • duration -- Integer

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

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

  • BrickletAirQuality`DURATIONU4UDAYS = 0
  • BrickletAirQuality`DURATIONU28UDAYS = 1

Neu in Version 2.0.3 (Plugin).

BrickletAirQuality@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}
Rückgabe:
  • apiVersioni -- Integer

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.

BrickletAirQuality@GetResponseExpected[functionId] → responseExpected
Parameter:
  • functionId -- Integer
Rückgabe:
  • responseExpected -- True/False

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.

BrickletAirQuality@SetResponseExpected[functionId, responseExpected] → Null
Parameter:
  • functionId -- Integer
  • responseExpected -- True/False

Ä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:

  • BrickletAirQuality`FUNCTIONUSETUTEMPERATUREUOFFSET = 2
  • BrickletAirQuality`FUNCTIONUSETUALLUVALUESUCALLBACKUCONFIGURATION = 4
  • BrickletAirQuality`FUNCTIONUSETUIAQUINDEXUCALLBACKUCONFIGURATION = 8
  • BrickletAirQuality`FUNCTIONUSETUTEMPERATUREUCALLBACKUCONFIGURATION = 12
  • BrickletAirQuality`FUNCTIONUSETUHUMIDITYUCALLBACKUCONFIGURATION = 16
  • BrickletAirQuality`FUNCTIONUSETUAIRUPRESSUREUCALLBACKUCONFIGURATION = 20
  • BrickletAirQuality`FUNCTIONUREMOVEUCALIBRATION = 23
  • BrickletAirQuality`FUNCTIONUSETUBACKGROUNDUCALIBRATIONUDURATION = 24
  • BrickletAirQuality`FUNCTIONUSETUWRITEUFIRMWAREUPOINTER = 237
  • BrickletAirQuality`FUNCTIONUSETUSTATUSULEDUCONFIG = 239
  • BrickletAirQuality`FUNCTIONURESET = 243
  • BrickletAirQuality`FUNCTIONUWRITEUUID = 248
BrickletAirQuality@SetResponseExpectedAll[responseExpected] → Null
Parameter:
  • responseExpected -- True/False

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

BrickletAirQuality@GetSPITFPErrorCount[out errorCountAckChecksum, out errorCountMessageChecksum, out errorCountFrame, out errorCountOverflow] → Null
Parameter:
  • errorCountAckChecksum -- Integer
  • errorCountMessageChecksum -- Integer
  • errorCountFrame -- Integer
  • errorCountOverflow -- Integer

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.

BrickletAirQuality@SetBootloaderMode[mode] → status
Parameter:
  • mode -- Integer
Rückgabe:
  • status -- Integer

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:

  • BrickletAirQuality`BOOTLOADERUMODEUBOOTLOADER = 0
  • BrickletAirQuality`BOOTLOADERUMODEUFIRMWARE = 1
  • BrickletAirQuality`BOOTLOADERUMODEUBOOTLOADERUWAITUFORUREBOOT = 2
  • BrickletAirQuality`BOOTLOADERUMODEUFIRMWAREUWAITUFORUREBOOT = 3
  • BrickletAirQuality`BOOTLOADERUMODEUFIRMWAREUWAITUFORUERASEUANDUREBOOT = 4
  • BrickletAirQuality`BOOTLOADERUSTATUSUOK = 0
  • BrickletAirQuality`BOOTLOADERUSTATUSUINVALIDUMODE = 1
  • BrickletAirQuality`BOOTLOADERUSTATUSUNOUCHANGE = 2
  • BrickletAirQuality`BOOTLOADERUSTATUSUENTRYUFUNCTIONUNOTUPRESENT = 3
  • BrickletAirQuality`BOOTLOADERUSTATUSUDEVICEUIDENTIFIERUINCORRECT = 4
  • BrickletAirQuality`BOOTLOADERUSTATUSUCRCUMISMATCH = 5
BrickletAirQuality@GetBootloaderMode[] → mode
Rückgabe:
  • mode -- Integer

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode[].

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

  • BrickletAirQuality`BOOTLOADERUMODEUBOOTLOADER = 0
  • BrickletAirQuality`BOOTLOADERUMODEUFIRMWARE = 1
  • BrickletAirQuality`BOOTLOADERUMODEUBOOTLOADERUWAITUFORUREBOOT = 2
  • BrickletAirQuality`BOOTLOADERUMODEUFIRMWAREUWAITUFORUREBOOT = 3
  • BrickletAirQuality`BOOTLOADERUMODEUFIRMWAREUWAITUFORUERASEUANDUREBOOT = 4
BrickletAirQuality@SetWriteFirmwarePointer[pointer] → Null
Parameter:
  • pointer -- Integer

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.

BrickletAirQuality@WriteFirmware[{data1, data2, ..., data64}] → status
Parameter:
  • datai -- Integer
Rückgabe:
  • status -- Integer

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.

BrickletAirQuality@SetStatusLEDConfig[config] → Null
Parameter:
  • config -- Integer

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:

  • BrickletAirQuality`STATUSULEDUCONFIGUOFF = 0
  • BrickletAirQuality`STATUSULEDUCONFIGUON = 1
  • BrickletAirQuality`STATUSULEDUCONFIGUSHOWUHEARTBEAT = 2
  • BrickletAirQuality`STATUSULEDUCONFIGUSHOWUSTATUS = 3
BrickletAirQuality@GetStatusLEDConfig[] → config
Rückgabe:
  • config -- Integer

Gibt die Konfiguration zurück, wie von SetStatusLEDConfig[] gesetzt.

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

  • BrickletAirQuality`STATUSULEDUCONFIGUOFF = 0
  • BrickletAirQuality`STATUSULEDUCONFIGUON = 1
  • BrickletAirQuality`STATUSULEDUCONFIGUSHOWUHEARTBEAT = 2
  • BrickletAirQuality`STATUSULEDUCONFIGUSHOWUSTATUS = 3
BrickletAirQuality@GetChipTemperature[] → temperature
Rückgabe:
  • temperature -- Integer

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.

BrickletAirQuality@Reset[] → Null

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.

BrickletAirQuality@WriteUID[uid] → Null
Parameter:
  • uid -- Integer

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.

BrickletAirQuality@ReadUID[] → uid
Rückgabe:
  • uid -- Integer

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

BrickletAirQuality@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null
Parameter:
  • uid -- String
  • connectedUid -- String
  • position -- Integer
  • hardwareVersioni -- Integer
  • firmwareVersioni -- Integer
  • deviceIdentifier -- Integer

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

BrickletAirQuality@SetAllValuesCallbackConfiguration[period, valueHasToChange] → Null
Parameter:
  • period -- Integer
  • valueHasToChange -- True/False

Die Periode in ms 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.

Der Standardwert ist (0, false).

BrickletAirQuality@GetAllValuesCallbackConfiguration[out period, out valueHasToChange] → Null
Parameter:
  • period -- Integer
  • valueHasToChange -- True/False

Gibt die Callback-Konfiguration zurück, wie mittels SetAllValuesCallbackConfiguration[] gesetzt.

BrickletAirQuality@SetIAQIndexCallbackConfiguration[period, valueHasToChange] → Null
Parameter:
  • period -- Integer
  • valueHasToChange -- True/False

Die Periode in ms 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.

Der Standardwert ist (0, false).

BrickletAirQuality@GetIAQIndexCallbackConfiguration[out period, out valueHasToChange] → Null
Parameter:
  • period -- Integer
  • valueHasToChange -- True/False

Gibt die Callback-Konfiguration zurück, wie mittels SetIAQIndexCallbackConfiguration[] gesetzt.

BrickletAirQuality@SetTemperatureCallbackConfiguration[period, valueHasToChange, option, min, max] → Null
Parameter:
  • period -- Integer
  • valueHasToChange -- True/False
  • option -- Integer
  • min -- Integer
  • max -- Integer

Die Periode in ms 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.

Der Standardwert ist (0, false, 'x', 0, 0).

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

  • BrickletAirQuality`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletAirQuality@GetTemperatureCallbackConfiguration[out period, out valueHasToChange, out option, out min, out max] → Null
Parameter:
  • period -- Integer
  • valueHasToChange -- True/False
  • option -- Integer
  • min -- Integer
  • max -- Integer

Gibt die Callback-Konfiguration zurück, wie mittels SetTemperatureCallbackConfiguration[] gesetzt.

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

  • BrickletAirQuality`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletAirQuality@SetHumidityCallbackConfiguration[period, valueHasToChange, option, min, max] → Null
Parameter:
  • period -- Integer
  • valueHasToChange -- True/False
  • option -- Integer
  • min -- Integer
  • max -- Integer

Die Periode in ms 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.

Der Standardwert ist (0, false, 'x', 0, 0).

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

  • BrickletAirQuality`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletAirQuality@GetHumidityCallbackConfiguration[out period, out valueHasToChange, out option, out min, out max] → Null
Parameter:
  • period -- Integer
  • valueHasToChange -- True/False
  • option -- Integer
  • min -- Integer
  • max -- Integer

Gibt die Callback-Konfiguration zurück, wie mittels SetHumidityCallbackConfiguration[] gesetzt.

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

  • BrickletAirQuality`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletAirQuality@SetAirPressureCallbackConfiguration[period, valueHasToChange, option, min, max] → Null
Parameter:
  • period -- Integer
  • valueHasToChange -- True/False
  • option -- Integer
  • min -- Integer
  • max -- Integer

Die Periode in ms 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.

Der Standardwert ist (0, false, 'x', 0, 0).

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

  • BrickletAirQuality`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletAirQuality@GetAirPressureCallbackConfiguration[out period, out valueHasToChange, out option, out min, out max] → Null
Parameter:
  • period -- Integer
  • valueHasToChange -- True/False
  • option -- Integer
  • min -- Integer
  • max -- Integer

Gibt die Callback-Konfiguration zurück, wie mittels SetAirPressureCallbackConfiguration[] gesetzt.

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

  • BrickletAirQuality`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]

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:

MyCallback[sender_,value_]:=Print["Value: "<>ToString[value]]

AddEventHandler[airQuality@ExampleCallback,MyCallback]

Weitere Informationen über Event-Behandlung mittels .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

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 BrickletAirQuality@AllValuesCallback[sender, iaqIndex, iaqIndexAccuracy, temperature, humidity, airPressure]
Parameter:
  • sender -- NETObject[BrickletAirQuality]
  • iaqIndex -- Integer
  • iaqIndexAccuracy -- Integer
  • temperature -- Integer
  • humidity -- Integer
  • airPressure -- Integer

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

Die Parameter sind der gleiche wie GetAllValues[].

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

  • BrickletAirQuality`ACCURACYUUNRELIABLE = 0
  • BrickletAirQuality`ACCURACYULOW = 1
  • BrickletAirQuality`ACCURACYUMEDIUM = 2
  • BrickletAirQuality`ACCURACYUHIGH = 3
event BrickletAirQuality@IAQIndexCallback[sender, iaqIndex, iaqIndexAccuracy]
Parameter:
  • sender -- NETObject[BrickletAirQuality]
  • iaqIndex -- Integer
  • iaqIndexAccuracy -- Integer

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

Die Parameter sind die gleichen wie GetIAQIndex[].

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

  • BrickletAirQuality`ACCURACYUUNRELIABLE = 0
  • BrickletAirQuality`ACCURACYULOW = 1
  • BrickletAirQuality`ACCURACYUMEDIUM = 2
  • BrickletAirQuality`ACCURACYUHIGH = 3
event BrickletAirQuality@TemperatureCallback[sender, temperature]
Parameter:
  • sender -- NETObject[BrickletAirQuality]
  • temperature -- Integer

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

Der Parameter ist der gleiche wie GetTemperature[].

event BrickletAirQuality@HumidityCallback[sender, humidity]
Parameter:
  • sender -- NETObject[BrickletAirQuality]
  • humidity -- Integer

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

Der Parameter ist der gleiche wie GetHumidity[].

event BrickletAirQuality@AirPressureCallback[sender, airPressure]
Parameter:
  • sender -- NETObject[BrickletAirQuality]
  • airPressure -- Integer

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

Der Parameter ist der gleiche wie GetAirPressure[].

Konstanten

BrickletAirQuality`DEVICEUIDENTIFIER

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

BrickletAirQuality`DEVICEDISPLAYNAME

Diese Konstante stellt den Anzeigenamen eines Air Quality Bricklet dar.