Shell - PTC Bricklet

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

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

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 PTC Bricklet

# Get current temperature
tinkerforge call ptc-bricklet $uid get-temperature

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 PTC Bricklet

# Handle incoming temperature callbacks
tinkerforge dispatch ptc-bricklet $uid temperature &

# Set period for temperature callback to 1s (1000ms)
# Note: The temperature callback is only called every second
#       if the temperature has changed since the last call!
tinkerforge call ptc-bricklet $uid set-temperature-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 PTC Bricklet

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

# Handle incoming temperature reached callbacks
tinkerforge dispatch ptc-bricklet $uid temperature-reached &

# Configure threshold for temperature "greater than 30 °C"
tinkerforge call ptc-bricklet $uid set-temperature-callback-threshold threshold-option-greater 3000 0

echo "Press key to exit"; read dummy

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

API

Mögliche Exit Codes für alle tinkerforge Befehle sind:

  • 1: Unterbrochen (Ctrl+C)
  • 2: Syntaxfehler
  • 21: Python 2.5 oder neuer wird benötigt
  • 22: Python argparse Modul fehlt
  • 23: Socket-Fehler
  • 24: Andere Exception
  • 25: Ungültiger Platzhalter in Format-String
  • 26: Authentifizierungsfehler
  • 201: Timeout ist aufgetreten
  • 209: Ungültiger Argumentwert
  • 210: Funktion wird nicht unterstützt
  • 211: Unbekannter Fehler

Befehlsstruktur

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

tinkerforge call ptc-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des PTC 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 PTC Bricklet an und endet dann
tinkerforge dispatch ptc-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des PTC 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 PTC Bricklet an und endet dann
tinkerforge call ptc-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 ptc-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 ptc-bricklet <uid> get-temperature
Ausgabe:
  • temperature – Typ: Int, Einheit: 1/100 °C, Wertebereich: [-24600 bis 84900]

Gibt die Temperatur des verbundenen Sensors zurück.

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

tinkerforge call ptc-bricklet <uid> is-sensor-connected
Ausgabe:
  • connected – Typ: Bool

Gibt true zurück wenn ein Sensor korrekt verbunden ist.

Falls diese Funktion false zurück gibt, ist entweder kein Pt100 oder Pt1000 Sensor verbunden, der Sensor ist inkorrekt verbunden oder der Sensor selbst ist fehlerhaft.

tinkerforge call ptc-bricklet <uid> set-wire-mode <mode>
Parameter:
  • <mode> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 2
Ausgabe:
  • keine Ausgabe

Stellt die Leiter-Konfiguration des Sensors ein. Mögliche Werte sind 2, 3 und 4, dies entspricht 2-, 3- und 4-Leiter-Sensoren. Der Wert muss er Jumper-Konfiguration am Bricklet entsprechen.

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

Für <mode>:

  • wire-mode-2 = 2
  • wire-mode-3 = 3
  • wire-mode-4 = 4
tinkerforge call ptc-bricklet <uid> get-wire-mode
Ausgabe:
  • mode – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 2

Gibt die Leiter-Konfiguration zurück, wie von set-wire-mode gesetzt.

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

Für mode:

  • wire-mode-2 = 2
  • wire-mode-3 = 3
  • wire-mode-4 = 4

Fortgeschrittene Funktionen

tinkerforge call ptc-bricklet <uid> get-resistance
Ausgabe:
  • resistance – Typ: Int, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1]

Gibt den Wert zurück, wie vom "MAX31865 Präzisions Delta-Sigma ADC" berechnet.

Der Wert kann mit den folgenden Formeln in einen Widerstand konvertiert werden:

  • Pt100: Widerstand = (Wert * 390) / 32768
  • Pt1000: Widerstand = (Wert * 3900) / 32768

Wenn der Widerstand periodisch abgefragt werden soll, wird empfohlen den resistance Callback zu nutzen und die Periode mit set-resistance-callback-period vorzugeben.

tinkerforge call ptc-bricklet <uid> set-noise-rejection-filter <filter>
Parameter:
  • <filter> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
Ausgabe:
  • keine Ausgabe

Setzt den Entstörfilter auf 50Hz (0) oder 60Hz (1). Störungen von 50Hz oder 60Hz Stromquellen (inklusive Oberwellen der Stromquellen-Grundfrequenz) werden um 82dB abgeschwächt.

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

Für <filter>:

  • filter-option-50hz = 0
  • filter-option-60hz = 1
tinkerforge call ptc-bricklet <uid> get-noise-rejection-filter
Ausgabe:
  • filter – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt die Einstellung des Entstörfilters zurück, wie von set-noise-rejection-filter gesetzt.

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

Für filter:

  • filter-option-50hz = 0
  • filter-option-60hz = 1
tinkerforge call ptc-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, i, 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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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 ptc-bricklet <uid> set-temperature-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 temperature Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der temperature Callback wird nur ausgelöst, wenn sich die Temperatur seit der letzten Auslösung geändert hat.

tinkerforge call ptc-bricklet <uid> get-temperature-callback-period
Ausgabe:
  • period – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

tinkerforge call ptc-bricklet <uid> set-resistance-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 resistance Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der resistance Callback wird nur ausgelöst, wenn sich der Widerstand seit der letzten Auslösung geändert hat.

tinkerforge call ptc-bricklet <uid> get-resistance-callback-period
Ausgabe:
  • period – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

tinkerforge call ptc-bricklet <uid> set-temperature-callback-threshold <option> <min> <max>
Parameter:
  • <option> – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x
  • <min> – Typ: Int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • <max> – Typ: Int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Ausgabe:
  • keine Ausgabe

Setzt den Schwellwert für den temperature-reached Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Temperatur außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Temperatur innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Temperatur kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Temperatur 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 ptc-bricklet <uid> get-temperature-callback-threshold
Ausgabe:
  • option – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x
  • min – Typ: Int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: Int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von set-temperature-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 ptc-bricklet <uid> set-resistance-callback-threshold <option> <min> <max>
Parameter:
  • <option> – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x
  • <min> – Typ: Int, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • <max> – Typ: Int, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Ausgabe:
  • keine Ausgabe

Setzt den Schwellwert für den resistance-reached Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Temperatur außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Temperatur innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Temperatur kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Temperatur 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 ptc-bricklet <uid> get-resistance-callback-threshold
Ausgabe:
  • option – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x
  • min – Typ: Int, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: Int, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von set-resistance-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 ptc-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

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

tinkerforge call ptc-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.

tinkerforge call ptc-bricklet <uid> set-sensor-connected-callback-configuration <enabled>
Parameter:
  • <enabled> – Typ: Bool, Standardwert: false
Ausgabe:
  • keine Ausgabe

Wenn dieser Callback aktiviert ist, wird der sensor-connected Callback jedes mal ausgelöst, wenn ein Pt-Sensor verbunden/getrennt wird.

Neu in Version 2.0.2 (Plugin).

tinkerforge call ptc-bricklet <uid> get-sensor-connected-callback-configuration
Ausgabe:
  • enabled – Typ: Bool, Standardwert: false

Gibt die Konfiguration zurück, wie von set-sensor-connected-callback-configuration gesetzt.

Neu in Version 2.0.2 (Plugin).

Callbacks

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

tinkerforge dispatch ptc-bricklet <uid> example

Die verfügbaren Callbacks 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.

tinkerforge dispatch ptc-bricklet <uid> temperature
Ausgabe:
  • temperature – Typ: Int, Einheit: 1/100 °C, Wertebereich: [-24600 bis 84900]

Dieser Callback wird mit der Periode, wie gesetzt mit set-temperature-callback-period, ausgelöst. Der Parameter ist die Temperatur des verbundenen Sensors.

Der temperature Callback wird nur ausgelöst, wenn sich die Temperatur seit der letzten Auslösung geändert hat.

tinkerforge dispatch ptc-bricklet <uid> temperature-reached
Ausgabe:
  • temperature – Typ: Int, Einheit: 1/100 °C, Wertebereich: [-24600 bis 84900]

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

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

tinkerforge dispatch ptc-bricklet <uid> resistance
Ausgabe:
  • resistance – Typ: Int, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit set-resistance-callback-period, ausgelöst. Der Parameter ist der Widerstand des verbundenen Sensors.

Der resistance Callback wird nur ausgelöst, wenn sich der Widerstand seit der letzten Auslösung geändert hat.

tinkerforge dispatch ptc-bricklet <uid> resistance-reached
Ausgabe:
  • resistance – Typ: Int, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set-resistance-callback-threshold gesetzt, erreicht wird. Der Parameter ist der Widerstand des verbundenen Sensors.

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

tinkerforge dispatch ptc-bricklet <uid> sensor-connected
Ausgabe:
  • connected – Typ: Bool

Dieser Callback wird periodisch ausgelöst abhängig von der mittels set-sensor-connected-callback-configuration gesetzten Konfiguration

Der Parameter ist der gleiche wie bei is-sensor-connected.

Neu in Version 2.0.2 (Plugin).