Modbus - Particulate Matter Bricklet

Dies ist die Beschreibung des Modbus Protokolls für das Particulate Matter Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Particulate Matter Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen

BrickletParticulateMatter.get_pm_concentration
Funktions ID:

1

Anfrage:

keine Nutzdaten

Antwort:
  • pm10 -- uint16
  • pm25 -- uint16
  • pm100 -- uint16

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

Wenn die Werte periodisch benötigt werden, kann auch der CALLBACK_PM_CONCENTRATION Callback verwendet werden. Der Callback wird mit der Funktion set_pm_concentration_callback_configuration konfiguriert.

BrickletParticulateMatter.get_pm_count
Funktions ID:

2

Anfrage:

keine Nutzdaten

Antwort:
  • greater03um -- uint16
  • greater05um -- uint16
  • greater10um -- uint16
  • greater25um -- uint16
  • greater50um -- uint16
  • greater100um -- uint16

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

Wenn die Werte periodisch benötigt werden, kann auch der CALLBACK_PM_COUNT Callback verwendet werden. Der Callback wird mit der Funktion set_pm_count_callback_configuration konfiguriert.

Fortgeschrittene Funktionen

BrickletParticulateMatter.set_enable
Funktions ID:

3

Anfrage:
  • enable -- bool
Antwort:

keine Antwort

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.get_enable
Funktions ID:

4

Anfrage:

keine Nutzdaten

Antwort:
  • enable -- bool

Gibt den Zustand des Sensors zurück, wie von set_enable gesetzt.

BrickletParticulateMatter.get_sensor_info
Funktions ID:

5

Anfrage:

keine Nutzdaten

Antwort:
  • sensor_version -- uint8
  • last_error_code -- uint8
  • framing_error_count -- uint8
  • checksum_error_count -- uint8

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.get_spitfp_error_count
Funktions ID:

234

Anfrage:

keine Nutzdaten

Antwort:
  • error_count_ack_checksum -- uint32
  • error_count_message_checksum -- uint32
  • error_count_frame -- uint32
  • error_count_overflow -- uint32

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.set_bootloader_mode
Funktions ID:

235

Anfrage:
  • mode -- uint8
Antwort:
  • status -- uint8

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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: bootloader, für mode
  • 1: firmware, für mode
  • 2: bootloader wait for reboot, für mode
  • 3: firmware wait for reboot, für mode
  • 4: firmware wait for erase and reboot, für mode
  • 0: ok, für status
  • 1: invalid mode, für status
  • 2: no change, für status
  • 3: entry function not present, für status
  • 4: device identifier incorrect, für status
  • 5: crc mismatch, für status
BrickletParticulateMatter.get_bootloader_mode
Funktions ID:

236

Anfrage:

keine Nutzdaten

Antwort:
  • mode -- uint8

Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: bootloader, für mode
  • 1: firmware, für mode
  • 2: bootloader wait for reboot, für mode
  • 3: firmware wait for reboot, für mode
  • 4: firmware wait for erase and reboot, für mode
BrickletParticulateMatter.set_write_firmware_pointer
Funktions ID:

237

Anfrage:
  • pointer -- uint32
Antwort:

keine Antwort

Setzt den Firmware-Pointer für 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.

BrickletParticulateMatter.write_firmware
Funktions ID:

238

Anfrage:
  • data -- uint8[64]
Antwort:
  • status -- uint8

Schreibt 64 Bytes Firmware an die Position die vorher von 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.

BrickletParticulateMatter.set_status_led_config
Funktions ID:

239

Anfrage:
  • config -- uint8
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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show status, für config
BrickletParticulateMatter.get_status_led_config
Funktions ID:

240

Anfrage:

keine Nutzdaten

Antwort:
  • config -- uint8

Gibt die Konfiguration zurück, wie von set_status_led_config gesetzt.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show status, für config
BrickletParticulateMatter.get_chip_temperature
Funktions ID:

242

Anfrage:

keine Nutzdaten

Antwort:
  • 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
Funktions ID:243
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.

BrickletParticulateMatter.write_uid
Funktions ID:

248

Anfrage:
  • uid -- uint32
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.

BrickletParticulateMatter.read_uid
Funktions ID:

249

Anfrage:

keine Nutzdaten

Antwort:
  • uid -- uint32

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

BrickletParticulateMatter.get_identity
Funktions ID:

255

Anfrage:

keine Nutzdaten

Antwort:
  • uid -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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. 

Konfigurationsfunktionen für Callbacks

BrickletParticulateMatter.set_pm_concentration_callback_configuration
Funktions ID:

6

Anfrage:
  • period -- uint32
  • value_has_to_change -- bool
Antwort:

keine Antwort

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

Der Standardwert ist (0, false).

BrickletParticulateMatter.get_pm_concentration_callback_configuration
Funktions ID:

7

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32
  • value_has_to_change -- bool

Gibt die Callback-Konfiguration zurück, wie mittels set_pm_concentration_callback_configuration gesetzt.

BrickletParticulateMatter.set_pm_count_callback_configuration
Funktions ID:

8

Anfrage:
  • period -- uint32
  • value_has_to_change -- bool
Antwort:

keine Antwort

Die Periode in ms ist die Periode mit der der CALLBACK_PM_COUNT 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.get_pm_count_callback_configuration
Funktions ID:

9

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32
  • value_has_to_change -- bool

Gibt die Callback-Konfiguration zurück, wie mittels set_pm_count_callback_configuration gesetzt.

Callbacks

BrickletParticulateMatter.CALLBACK_PM_CONCENTRATION
Funktions ID:

10

Antwort:
  • pm10 -- uint16
  • pm25 -- uint16
  • pm100 -- uint16

Dieser Callback wird periodisch ausgelöst abhängig von der mittels set_pm_concentration_callback_configuration gesetzten Konfiguration

Die Rückgabewerte sind der gleiche wie get_pm_concentration.

BrickletParticulateMatter.CALLBACK_PM_COUNT
Funktions ID:

11

Antwort:
  • greater03um -- uint16
  • greater05um -- uint16
  • greater10um -- uint16
  • greater25um -- uint16
  • greater50um -- uint16
  • greater100um -- uint16

Dieser Callback wird periodisch ausgelöst abhängig von der mittels set_pm_count_callback_configuration gesetzten Konfiguration

Die Rückgabewerte sind der gleiche wie get_pm_count.