Shell - Current12 Bricklet

Dies ist die Beschreibung der Shell API Bindings für das Current12 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Current12 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 Current12 Bricklet

# Get current current
tinkerforge call current12-bricklet $uid get-current

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

# Handle incoming current callbacks
tinkerforge dispatch current12-bricklet $uid current &

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

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

# Handle incoming current reached callbacks
tinkerforge dispatch current12-bricklet $uid current-reached &

# Configure threshold for current "greater than 5 A"
tinkerforge call current12-bricklet $uid set-current-callback-threshold threshold-option-greater 5000 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 current12-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

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

Der dispatch Befehl wird verwendet um eingehende Callbacks des Current12 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 Current12 Bricklet an und endet dann
tinkerforge call current12-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 current12-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 current12-bricklet <uid> get-current
Ausgabe:
  • current – Typ: Int, Einheit: 1 mA, Wertebereich: [-12500 bis 12500]

Gibt die gemessenen Stromstärke des Sensors zurück.

Wenn die Stromstärke periodisch abgefragt werden soll, wird empfohlen den current Callback zu nutzen und die Periode mit set-current-callback-period vorzugeben.

Fortgeschrittene Funktionen

tinkerforge call current12-bricklet <uid> calibrate
Ausgabe:
  • keine Ausgabe

Kalibriert den Nullwert des Sensors. Diese Funktion muss aufgerufen werden, wenn kein Strom fließt.

Der Nullwert des Stromsensors ist abhängig von den exakten Eigenschaften des Analog-Digital-Wandlers, der Länge des Bricklet Kabels und der Temperatur. Daher ist es, bei Wechsel des Brick oder bei Veränderung der Umgebung in welcher das Bricklet genutzt wird, ratsam erneut zu kalibrieren.

Die resultierende Kalibrierung wird in den EEPROM des Current Bricklet gespeichert.

tinkerforge call current12-bricklet <uid> is-over-current
Ausgabe:
  • over – Typ: Bool

Gibt true zurück wenn mehr als 12,5A gemessen wurden.

Bemerkung

Um diesen Wert zurückzusetzen ist ein Aus- und Wiedereinschalten des Bricklet notwendig.

tinkerforge call current12-bricklet <uid> get-analog-value
Ausgabe:
  • value – Typ: Int, Wertebereich: [0 bis 212 - 1]

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.

Bemerkung

Der von get-current zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während get-analog-value unverarbeitete Analogwerte zurück gibt. Der einzige Grund get-analog-value zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

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

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

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

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

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

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

Der analog-value Callback wird nur ausgelöst, wenn sich der Analogwert seit der letzten Auslösung geändert hat.

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

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

tinkerforge call current12-bricklet <uid> set-current-callback-threshold <option> <min> <max>
Parameter:
  • <option> – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x
  • <min> – Typ: Int, Einheit: 1 mA, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • <max> – Typ: Int, Einheit: 1 mA, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Ausgabe:
  • keine Ausgabe

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

Die folgenden Optionen sind möglich:

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

Gibt den Schwellwert zurück, wie von set-current-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 current12-bricklet <uid> set-analog-value-callback-threshold <option> <min> <max>
Parameter:
  • <option> – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x
  • <min> – Typ: Int, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • <max> – Typ: Int, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Ausgabe:
  • keine Ausgabe

Setzt den Schwellwert für den analog-value-reached Callback.

Die folgenden Optionen sind möglich:

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

Gibt den Schwellwert zurück, wie von set-analog-value-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 current12-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 Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

tinkerforge call current12-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 current12-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 current12-bricklet <uid> current
Ausgabe:
  • current – Typ: Int, Einheit: 1 mA, Wertebereich: [-12500 bis 12500]

Dieser Callback wird mit der Periode, wie gesetzt mit set-current-callback-period, ausgelöst. Der Parameter ist die Stromstärke des Sensors.

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

tinkerforge dispatch current12-bricklet <uid> analog-value
Ausgabe:
  • value – Typ: Int, Wertebereich: [0 bis 212 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit set-analog-value-callback-period, ausgelöst. Der Parameter ist der Analogwert des Umgebungslichtsensors.

Der analog-value Callback wird nur ausgelöst, wenn sich der Analogwert seit der letzten Auslösung geändert hat.

tinkerforge dispatch current12-bricklet <uid> current-reached
Ausgabe:
  • current – Typ: Int, Einheit: 1 mA, Wertebereich: [-12500 bis 12500]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set-current-callback-threshold gesetzt, erreicht wird. Der Parameter ist die Stromstärke des Sensors.

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

tinkerforge dispatch current12-bricklet <uid> analog-value-reached
Ausgabe:
  • value – Typ: Int, Wertebereich: [0 bis 212 - 1]

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

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

tinkerforge dispatch current12-bricklet <uid> over-current
Ausgabe:
  • keine Ausgabe

Dieser Callback wird ausgelöst, wenn ein Überstrom gemessen wurde (siehe is-over-current).