Software / API Bindings / MQTT / API Referenz und Beispiele / Bricklets / Particulate Matter Bricklet

MQTT - Particulate Matter Bricklet¶

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

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple¶

Download (example-simple.txt)

# Change XYZ to the UID of your Particulate Matter Bricklet

setup:
    # Get current PM concentration
    subscribe to tinkerforge/response/particulate_matter_bricklet/XYZ/get_pm_concentration
    publish '' to tinkerforge/request/particulate_matter_bricklet/XYZ/get_pm_concentration

Callback¶

Download (example-callback.txt)

# Change XYZ to the UID of your Particulate Matter Bricklet

setup:
    # Handle incoming PM concentration callbacks
    subscribe to tinkerforge/callback/particulate_matter_bricklet/XYZ/pm_concentration
    publish '{"register": true}' to tinkerforge/register/particulate_matter_bricklet/XYZ/pm_concentration # Register pm_concentration callback

    # Set period for PM concentration callback to 1s (1000ms)
    publish '{"period": 1000, "value_has_to_change": false}' to tinkerforge/request/particulate_matter_bricklet/XYZ/set_pm_concentration_callback_configuration

API¶

Alle veröffentlichten Payloads an die und von den MQTT-Bindings sind im JSON Format.

Falls ein Fehler auftritt, veröffentlichen die Bindings ein JSON-Objekt, das die Fehlermeldung als _ERROR-Member enthält. Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/... für .../request/... und .../callback/... für .../register/....

Grundfunktionen¶

request/particulate_matter_bricklet/<UID>/get_pm_concentration¶

Anfrage:	keine Nutzdaten
Antwort:	pm10 – Typ: int, Einheit: 1 µg/m³, Wertebereich: [0 bis 2¹⁶ - 1] pm25 – Typ: int, Einheit: 1 µg/m³, Wertebereich: [0 bis 2¹⁶ - 1] pm100 – Typ: int, Einheit: 1 µg/m³, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt die Feinstaub-Konzentration zurück, aufgeschlüsselt nach:

PM_1.0,
PM_2.5 und
PM_10.0.

Wenn der Sensor deaktiviert ist (siehe request/particulate_matter_bricklet/<UID>/set_enable), dann wird weiterhin der letzte Sensorwert zurückgegeben.

Wenn die Werte periodisch benötigt werden, kann auch der register/particulate_matter_bricklet/<UID>/pm_concentration Callback verwendet werden. Der Callback wird mit der Funktion request/particulate_matter_bricklet/<UID>/set_pm_concentration_callback_configuration konfiguriert.

request/particulate_matter_bricklet/<UID>/get_pm_count¶

Anfrage:

keine Nutzdaten

Antwort:

greater03um – Typ: int, Einheit: 10000 1/m³, Wertebereich: [0 bis 2¹⁶ - 1]
greater05um – Typ: int, Einheit: 10000 1/m³, Wertebereich: [0 bis 2¹⁶ - 1]
greater10um – Typ: int, Einheit: 10000 1/m³, Wertebereich: [0 bis 2¹⁶ - 1]
greater25um – Typ: int, Einheit: 10000 1/m³, Wertebereich: [0 bis 2¹⁶ - 1]
greater50um – Typ: int, Einheit: 10000 1/m³, Wertebereich: [0 bis 2¹⁶ - 1]
greater100um – Typ: int, Einheit: 10000 1/m³, Wertebereich: [0 bis 2¹⁶ - 1]

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 request/particulate_matter_bricklet/<UID>/set_enable), dann wird weiterhin der letzte Sensorwert zurückgegeben.

Wenn die Werte periodisch benötigt werden, kann auch der register/particulate_matter_bricklet/<UID>/pm_count Callback verwendet werden. Der Callback wird mit der Funktion request/particulate_matter_bricklet/<UID>/set_pm_count_callback_configuration konfiguriert.

Fortgeschrittene Funktionen¶

request/particulate_matter_bricklet/<UID>/set_enable¶

Anfrage:	enable – Typ: bool, Standardwert: true
Antwort:	keine Antwort

Aktiviert/deaktiviert den Lüfter und die Laserdiode des Sensors.

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.

request/particulate_matter_bricklet/<UID>/get_enable¶

Anfrage:	keine Nutzdaten
Antwort:	enable – Typ: bool, Standardwert: true

Gibt den Zustand des Sensors zurück, wie von request/particulate_matter_bricklet/<UID>/set_enable gesetzt.

request/particulate_matter_bricklet/<UID>/get_sensor_info¶

Anfrage:	keine Nutzdaten
Antwort:	sensor_version – Typ: int, Wertebereich: [0 bis 255] last_error_code – Typ: int, Wertebereich: [0 bis 255] framing_error_count – Typ: int, Wertebereich: [0 bis 255] checksum_error_count – Typ: int, Wertebereich: [0 bis 255]

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.

request/particulate_matter_bricklet/<UID>/get_spitfp_error_count¶

Anfrage:	keine Nutzdaten
Antwort:	error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 2³² - 1] error_count_message_checksum – Typ: int, Wertebereich: [0 bis 2³² - 1] error_count_frame – Typ: int, Wertebereich: [0 bis 2³² - 1] error_count_overflow – Typ: int, Wertebereich: [0 bis 2³² - 1]

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.

request/particulate_matter_bricklet/<UID>/set_status_led_config¶

Anfrage:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
Antwort:	keine Antwort

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 Symbole sind für diese Funktion verfügbar:

Für config:

"off" = 0
"on" = 1
"show_heartbeat" = 2
"show_status" = 3

request/particulate_matter_bricklet/<UID>/get_status_led_config¶

Anfrage:	keine Nutzdaten
Antwort:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von request/particulate_matter_bricklet/<UID>/set_status_led_config gesetzt.

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

Für config:

"off" = 0
"on" = 1
"show_heartbeat" = 2
"show_status" = 3

request/particulate_matter_bricklet/<UID>/get_chip_temperature¶

Anfrage:	keine Nutzdaten
Antwort:	temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]

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.

request/particulate_matter_bricklet/<UID>/reset¶

Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

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.

request/particulate_matter_bricklet/<UID>/get_identity¶

Anfrage:

keine Nutzdaten

Antwort:

uid – Typ: string, Länge: bis zu 8
connected_uid – Typ: string, Länge: bis zu 8
position – Typ: char, Wertebereich: ["a" bis "h", "z"]
hardware_version – Typ: [int, ...], Länge: 3

0: major – Typ: int, Wertebereich: [0 bis 255]
1: minor – Typ: int, Wertebereich: [0 bis 255]
2: revision – Typ: int, Wertebereich: [0 bis 255]

firmware_version – Typ: [int, ...], Länge: 3

0: major – Typ: int, Wertebereich: [0 bis 255]
1: minor – Typ: int, Wertebereich: [0 bis 255]
2: revision – Typ: int, Wertebereich: [0 bis 255]

device_identifier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
_display_name – Typ: string

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. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.

Der Display Name enthält den Anzeigenamen des Particulate Matter.

Konfigurationsfunktionen für Callbacks¶

request/particulate_matter_bricklet/<UID>/set_pm_concentration_callback_configuration¶

Anfrage:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false
Antwort:	keine Antwort

Die Periode ist die Periode mit der der register/particulate_matter_bricklet/<UID>/pm_concentration 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.

request/particulate_matter_bricklet/<UID>/get_pm_concentration_callback_configuration¶

Anfrage:	keine Nutzdaten
Antwort:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels request/particulate_matter_bricklet/<UID>/set_pm_concentration_callback_configuration gesetzt.

request/particulate_matter_bricklet/<UID>/set_pm_count_callback_configuration¶

Anfrage:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false
Antwort:	keine Antwort

Die Periode ist die Periode mit der der register/particulate_matter_bricklet/<UID>/pm_count Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

request/particulate_matter_bricklet/<UID>/get_pm_count_callback_configuration¶

Anfrage:	keine Nutzdaten
Antwort:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels request/particulate_matter_bricklet/<UID>/set_pm_count_callback_configuration gesetzt.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit dem entsprechenden .../register/...-Topic und einem optionalen Suffix durchgeführt werden. Mit diesem Suffix 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.

register/particulate_matter_bricklet/<UID>/pm_concentration¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	pm10 – Typ: int, Einheit: 1 µg/m³, Wertebereich: [0 bis 2¹⁶ - 1] pm25 – Typ: int, Einheit: 1 µg/m³, Wertebereich: [0 bis 2¹⁶ - 1] pm100 – Typ: int, Einheit: 1 µg/m³, Wertebereich: [0 bis 2¹⁶ - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/particulate_matter_bricklet/<UID>/pm_concentration[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/particulate_matter_bricklet/<UID>/pm_concentration[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird periodisch ausgelöst abhängig von der mittels request/particulate_matter_bricklet/<UID>/set_pm_concentration_callback_configuration gesetzten Konfiguration

Die Payload-Member des Callbacks sind der gleiche wie request/particulate_matter_bricklet/<UID>/get_pm_concentration.

register/particulate_matter_bricklet/<UID>/pm_count¶

Registrierungsanfrage:

register – Typ: bool

Callback-Antwort:

greater03um – Typ: int, Einheit: 10000 1/m³, Wertebereich: [0 bis 2¹⁶ - 1]
greater05um – Typ: int, Einheit: 10000 1/m³, Wertebereich: [0 bis 2¹⁶ - 1]
greater10um – Typ: int, Einheit: 10000 1/m³, Wertebereich: [0 bis 2¹⁶ - 1]
greater25um – Typ: int, Einheit: 10000 1/m³, Wertebereich: [0 bis 2¹⁶ - 1]
greater50um – Typ: int, Einheit: 10000 1/m³, Wertebereich: [0 bis 2¹⁶ - 1]
greater100um – Typ: int, Einheit: 10000 1/m³, Wertebereich: [0 bis 2¹⁶ - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/particulate_matter_bricklet/<UID>/pm_count[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/particulate_matter_bricklet/<UID>/pm_count[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird periodisch ausgelöst abhängig von der mittels request/particulate_matter_bricklet/<UID>/set_pm_count_callback_configuration gesetzten Konfiguration

Die Payload-Member des Callbacks sind der gleiche wie request/particulate_matter_bricklet/<UID>/get_pm_count.

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.

request/particulate_matter_bricklet/<UID>/set_bootloader_mode¶

Anfrage:	mode – Typ: int, Wertebereich: Siehe Symbole
Antwort:	status – Typ: int, Wertebereich: Siehe Symbole

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 Symbole sind für diese Funktion verfügbar:

Für mode:

"bootloader" = 0
"firmware" = 1
"bootloader_wait_for_reboot" = 2
"firmware_wait_for_reboot" = 3
"firmware_wait_for_erase_and_reboot" = 4

Für status:

"ok" = 0
"invalid_mode" = 1
"no_change" = 2
"entry_function_not_present" = 3
"device_identifier_incorrect" = 4
"crc_mismatch" = 5

request/particulate_matter_bricklet/<UID>/get_bootloader_mode¶

Anfrage:	keine Nutzdaten
Antwort:	mode – Typ: int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe request/particulate_matter_bricklet/<UID>/set_bootloader_mode.

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

Für mode:

"bootloader" = 0
"firmware" = 1
"bootloader_wait_for_reboot" = 2
"firmware_wait_for_reboot" = 3
"firmware_wait_for_erase_and_reboot" = 4

request/particulate_matter_bricklet/<UID>/set_write_firmware_pointer¶

Anfrage:	pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Antwort:	keine Antwort

Setzt den Firmware-Pointer für request/particulate_matter_bricklet/<UID>/write_firmware. 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.

request/particulate_matter_bricklet/<UID>/write_firmware¶

Anfrage:	data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Antwort:	status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von request/particulate_matter_bricklet/<UID>/set_write_firmware_pointer 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.

request/particulate_matter_bricklet/<UID>/write_uid¶

Anfrage:	uid – Typ: int, Wertebereich: [0 bis 2³² - 1]
Antwort:	keine Antwort

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.

request/particulate_matter_bricklet/<UID>/read_uid¶

Anfrage:	keine Nutzdaten
Antwort:	uid – Typ: int, Wertebereich: [0 bis 2³² - 1]

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