Shell - Dust Detector Bricklet¶

Simple¶

Download (example-simple.sh)

1
2
3
4
5
6
7

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Dust Detector Bricklet

# Get current dust density
tinkerforge call dust-detector-bricklet $uid get-dust-density

Callback¶

Download (example-callback.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Dust Detector Bricklet

# Handle incoming dust density callbacks
tinkerforge dispatch dust-detector-bricklet $uid dust-density &

# Set period for dust density callback to 1s (1000ms)
# Note: The dust density callback is only called every second
#       if the dust density has changed since the last call!
tinkerforge call dust-detector-bricklet $uid set-dust-density-callback-period 1000

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

Threshold¶

Download (example-threshold.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Dust Detector Bricklet

# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
tinkerforge call dust-detector-bricklet $uid set-debounce-period 10000

# Handle incoming dust density reached callbacks
tinkerforge dispatch dust-detector-bricklet $uid dust-density-reached &

# Configure threshold for dust density "greater than 10 µg/m³"
tinkerforge call dust-detector-bricklet $uid set-dust-density-callback-threshold threshold-option-greater 10 0

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

Befehlsstruktur¶

Allgemeine Optionen des call und des dispatch Befehls sind hier zu finden. Im Folgenden wird die spezifische Befehlsstruktur dargestellt.

tinkerforge call dust-detector-bricklet [<option>..] <uid> <function> [<argument>..]¶

Parameter:	<uid> – Typ: String <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des Dust Detector Bricklet aufzurufen. Der Befehl kennt mehrere Optionen:

• --help zeigt Hilfe für den spezifischen call Befehl an und endet dann
• --list-functions zeigt eine Liste der bekannten Funktionen des Dust Detector Bricklet an und endet dann

tinkerforge dispatch dust-detector-bricklet [<option>..] <uid> <callback>¶

Parameter:	<uid> – Typ: String <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des Dust Detector Bricklet abzufertigen. Der Befehl kennt mehrere Optionen:

• --help zeigt Hilfe für den spezifischen dispatch Befehl an und endet dann
• --list-callbacks zeigt eine Liste der bekannten Callbacks des Dust Detector Bricklet an und endet dann

tinkerforge call dust-detector-bricklet <uid> <function> [<option>..] [<argument>..]¶

Parameter:	<uid> – Typ: String <function> – Typ: String

Abhängig von der Art der aufzurufenden <function> kennt diese verschiedene Optionen. Alle Funktionen kennen die folgenden Optionen:

• --help zeigt Hilfe für die spezifische <function> an und endet dann

Getter-Funktionen kennen zusätzlich die folgenden Optionen:

• --execute <command> Shell-Befehl der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Setter-Funktionen kennen zusätzlich die folgenden Optionen:

• --expect-response fragt Antwort an und wartet auf diese

Mit der --expect-response Option für Setter-Funktionen können Timeouts und andere Fehlerfälle auch für Aufrufe von Setter-Funktionen detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn diese Option für eine Setter-Funktion nicht angegeben ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

tinkerforge dispatch dust-detector-bricklet <uid> <callback> [<option>..]¶

Parameter:	<uid> – Typ: String <callback> – Typ: String

Der abzufertigende <callback> kennt mehrere Optionen:

• --help zeigt Hilfe für den spezifische <callback> an und endet dann
• --execute <command> Shell-Befehlszeile der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Grundfunktionen¶

tinkerforge call dust-detector-bricklet <uid> get-dust-density¶

Ausgabe:	dust-density – Typ: Int, Einheit: 1 µg/m³, Wertebereich: [0 bis 500]

Gibt die Staubdichte zurück.

Wenn die Staubdichte periodisch abgefragt werden soll, wird empfohlen den dust-density Callback zu nutzen und die Periode mit set-dust-density-callback-period vorzugeben.

Fortgeschrittene Funktionen¶

tinkerforge call dust-detector-bricklet <uid> set-moving-average <average>¶

Parameter:	<average> – Typ: Int, Wertebereich: [0 bis 100], Standardwert: 100
Ausgabe:	keine Ausgabe

Setzt die Länge eines gleitenden Mittelwerts für die Staubdichte.

Wenn die Länge auf 0 gesetzt wird, ist das Averaging komplett aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

tinkerforge call dust-detector-bricklet <uid> get-moving-average¶

Ausgabe:	average – Typ: Int, Wertebereich: [0 bis 100], Standardwert: 100

Gibt die Länge des gleitenden Mittelwerts zurück, wie von set-moving-average gesetzt.

tinkerforge call dust-detector-bricklet <uid> get-identity¶

Ausgabe:

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 Array, 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 Array, 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 216 - 1]

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. 

Konfigurationsfunktionen für Callbacks¶

tinkerforge call dust-detector-bricklet <uid> set-dust-density-callback-period <period>¶

Parameter:	<period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Ausgabe:	keine Ausgabe

Setzt die Periode mit welcher der dust-density Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der dust-density Callback wird nur ausgelöst, wenn sich die Staubdichte seit der letzten Auslösung geändert hat.

tinkerforge call dust-detector-bricklet <uid> get-dust-density-callback-period¶

Ausgabe:	period – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von set-dust-density-callback-period gesetzt.

tinkerforge call dust-detector-bricklet <uid> set-dust-density-callback-threshold <option> <min> <max>¶

Parameter:	<option> – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x <min> – Typ: Int, Einheit: 1 µg/m³, Wertebereich: [0 bis 216 - 1], Standardwert: 0 <max> – Typ: Int, Einheit: 1 µg/m³, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Ausgabe:	keine Ausgabe

Setzt den Schwellwert für den dust-density-reached Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn die Staubdichte außerhalb des min und max Wertes ist
'i'	Callback wird ausgelöst, wenn der Staubdichte innerhalb des min und max Wertes ist
'<'	Callback wird ausgelöst, wenn der Staubdichte kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn der Staubdichte größer als der min Wert ist (max wird ignoriert)

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

Für <option>:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call dust-detector-bricklet <uid> get-dust-density-callback-threshold¶

Ausgabe:	option – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x min – Typ: Int, Einheit: 1 µg/m³, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: Int, Einheit: 1 µg/m³, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von set-dust-density-callback-threshold gesetzt.

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

Für option:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call dust-detector-bricklet <uid> set-debounce-period <debounce>¶

Parameter:	<debounce> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Ausgabe:	keine Ausgabe

Setzt die Periode mit welcher die Schwellwert Callback

• dust-density-reached

ausgelöst wird, wenn der Schwellwert

• set-dust-density-callback-threshold

weiterhin erreicht bleibt.

tinkerforge call dust-detector-bricklet <uid> get-debounce-period¶

Ausgabe:	debounce – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von set-debounce-period gesetzt.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:

tinkerforge dispatch dust-detector-bricklet <uid> example

Die verfügbaren Callbacks werden weiter unten beschrieben.

tinkerforge dispatch dust-detector-bricklet <uid> dust-density¶

Ausgabe:	dust-density – Typ: Int, Einheit: 1 µg/m³, Wertebereich: [0 bis 500]

Dieser Callback wird mit der Periode, wie gesetzt mit set-dust-density-callback-period, ausgelöst. Der Parameter ist die Staubdichte des Sensors.

Der dust-density Callback wird nur ausgelöst, wenn sich die Staubdichte seit der letzten Auslösung geändert hat.

tinkerforge dispatch dust-detector-bricklet <uid> dust-density-reached¶

Ausgabe:	dust-density – Typ: Int, Einheit: 1 µg/m³, Wertebereich: [0 bis 500]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set-dust-density-callback-threshold gesetzt, erreicht wird. Der Parameter ist die Staubdichte des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit set-debounce-period gesetzt, ausgelöst.