Shell - Voltage/Current Bricklet¶

Simple¶

Download (example-simple.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

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

uid=XYZ # Change XYZ to the UID of your Voltage/Current Bricklet

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

# Get current current
tinkerforge call voltage-current-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 Voltage/Current Bricklet

# Handle incoming current callbacks
tinkerforge dispatch voltage-current-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 voltage-current-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 Voltage/Current Bricklet

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

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

# Configure threshold for power "greater than 10 W"
tinkerforge call voltage-current-bricklet $uid set-power-callback-threshold threshold-option-greater 10000 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 voltage-current-bricklet [<option>..] <uid> <function> [<argument>..]¶

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

Der call Befehl wird verwendet um eine Funktion des Voltage/Current 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 Voltage/Current Bricklet an und endet dann

tinkerforge dispatch voltage-current-bricklet [<option>..] <uid> <callback>¶

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

Der dispatch Befehl wird verwendet um eingehende Callbacks des Voltage/Current 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 Voltage/Current Bricklet an und endet dann

tinkerforge call voltage-current-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 voltage-current-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 voltage-current-bricklet <uid> get-current¶

Ausgabe:	current – Typ: Int, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

Gibt die gemessenen Stromstärke 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.

tinkerforge call voltage-current-bricklet <uid> get-voltage¶

Ausgabe:	voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 36000]

Gibt die gemessenen Spannung zurück.

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

tinkerforge call voltage-current-bricklet <uid> get-power¶

Ausgabe:	power – Typ: Int, Einheit: 1 mW, Wertebereich: [0 bis 720000]

Gibt die gemessenen Leistung zurück.

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

tinkerforge call voltage-current-bricklet <uid> set-configuration <averaging> <voltage-conversion-time> <current-conversion-time>¶

Parameter:	<averaging> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3 <voltage-conversion-time> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 4 <current-conversion-time> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 4
Ausgabe:	keine Ausgabe

Setzt die Konfiguration des Voltage/Current Bricklet. Es ist möglich die Anzahl für die Durchschnittsbildung, und die Wandlungszeit für Spannung und Stromstärke zu definieren.

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

Für <averaging>:

• averaging-1 = 0
• averaging-4 = 1
• averaging-16 = 2
• averaging-64 = 3
• averaging-128 = 4
• averaging-256 = 5
• averaging-512 = 6
• averaging-1024 = 7

Für <voltage-conversion-time>:

• conversion-time-140us = 0
• conversion-time-204us = 1
• conversion-time-332us = 2
• conversion-time-588us = 3
• conversion-time-1-1ms = 4
• conversion-time-2-116ms = 5
• conversion-time-4-156ms = 6
• conversion-time-8-244ms = 7

Für <current-conversion-time>:

• conversion-time-140us = 0
• conversion-time-204us = 1
• conversion-time-332us = 2
• conversion-time-588us = 3
• conversion-time-1-1ms = 4
• conversion-time-2-116ms = 5
• conversion-time-4-156ms = 6
• conversion-time-8-244ms = 7

tinkerforge call voltage-current-bricklet <uid> get-configuration¶

Ausgabe:	averaging – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3 voltage-conversion-time – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 4 current-conversion-time – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 4

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

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

Für averaging:

• averaging-1 = 0
• averaging-4 = 1
• averaging-16 = 2
• averaging-64 = 3
• averaging-128 = 4
• averaging-256 = 5
• averaging-512 = 6
• averaging-1024 = 7

Für voltage-conversion-time:

• conversion-time-140us = 0
• conversion-time-204us = 1
• conversion-time-332us = 2
• conversion-time-588us = 3
• conversion-time-1-1ms = 4
• conversion-time-2-116ms = 5
• conversion-time-4-156ms = 6
• conversion-time-8-244ms = 7

Für current-conversion-time:

• conversion-time-140us = 0
• conversion-time-204us = 1
• conversion-time-332us = 2
• conversion-time-588us = 3
• conversion-time-1-1ms = 4
• conversion-time-2-116ms = 5
• conversion-time-4-156ms = 6
• conversion-time-8-244ms = 7

Fortgeschrittene Funktionen¶

tinkerforge call voltage-current-bricklet <uid> set-calibration <gain-multiplier> <gain-divisor>¶

Parameter:	<gain-multiplier> – Typ: Int, Wertebereich: [0 bis 216 - 1] <gain-divisor> – Typ: Int, Wertebereich: [0 bis 216 - 1]
Ausgabe:	keine Ausgabe

Da der Shunt-Widerstand über den die Stromstärke gemessen wird keine perfekte Genauigkeit hat, ist es nötig einen Multiplikator und einen Divisor zu setzen, falls sehr genaue Messwerte nötig sind.

Zum Beispiel: Wenn eine Messung von 1000mA erwartet wird, das Voltage/Current Bricklet aber 1023mA zurück gibt, sollte der Multiplikator auf 1000 und der Divisor auf 1023 gesetzt werden.

tinkerforge call voltage-current-bricklet <uid> get-calibration¶

Ausgabe:	gain-multiplier – Typ: Int, Wertebereich: [0 bis 216 - 1] gain-divisor – Typ: Int, Wertebereich: [0 bis 216 - 1]

Gibt die Kalibrierung zurück, wie von set-calibration gesetzt.

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

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

tinkerforge call voltage-current-bricklet <uid> get-voltage-callback-period¶

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

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

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

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

tinkerforge call voltage-current-bricklet <uid> get-power-callback-period¶

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

Gibt die Periode zurück, wie von get-power-callback-period gesetzt

tinkerforge call voltage-current-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: [-231 bis 231 - 1], Standardwert: 0 <max> – Typ: Int, Einheit: 1 mA, Wertebereich: [-231 bis 231 - 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 voltage-current-bricklet <uid> get-current-callback-threshold¶

Ausgabe:	option – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x min – Typ: Int, Einheit: 1 mA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: Int, Einheit: 1 mA, Wertebereich: [-231 bis 231 - 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 voltage-current-bricklet <uid> set-voltage-callback-threshold <option> <min> <max>¶

Parameter:	<option> – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x <min> – Typ: Int, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 <max> – Typ: Int, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Ausgabe:	keine Ausgabe

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

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn die Spannung außerhalb des min und max Wertes ist
'i'	Callback wird ausgelöst, wenn die Spannung innerhalb des min und max Wertes ist
'<'	Callback wird ausgelöst, wenn die Spannung kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die Spannung 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 voltage-current-bricklet <uid> get-voltage-callback-threshold¶

Ausgabe:	option – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x min – Typ: Int, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: Int, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von set-voltage-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 voltage-current-bricklet <uid> set-power-callback-threshold <option> <min> <max>¶

Parameter:	<option> – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x <min> – Typ: Int, Einheit: 1 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 <max> – Typ: Int, Einheit: 1 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Ausgabe:	keine Ausgabe

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

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn die Leistung außerhalb des min und max Wertes ist
'i'	Callback wird ausgelöst, wenn die Leistung innerhalb des min und max Wertes ist
'<'	Callback wird ausgelöst, wenn die Leistung kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die Leistung 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 voltage-current-bricklet <uid> get-power-callback-threshold¶

Ausgabe:	option – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x min – Typ: Int, Einheit: 1 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: Int, Einheit: 1 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von set-power-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 voltage-current-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

• current-reached,
• voltage-reached,
• power-reached

ausgelöst werden, wenn die Schwellwerte

• set-current-callback-threshold,
• set-voltage-callback-threshold,
• set-power-callback-threshold

weiterhin erreicht bleiben.

tinkerforge call voltage-current-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 voltage-current-bricklet <uid> example

Die verfügbaren Callbacks werden weiter unten beschrieben.

tinkerforge dispatch voltage-current-bricklet <uid> current¶

Ausgabe:	current – Typ: Int, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

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 voltage-current-bricklet <uid> voltage¶

Ausgabe:	voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 36000]

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

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

tinkerforge dispatch voltage-current-bricklet <uid> power¶

Ausgabe:	power – Typ: Int, Einheit: 1 mW, Wertebereich: [0 bis 720000]

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

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

tinkerforge dispatch voltage-current-bricklet <uid> current-reached¶

Ausgabe:	current – Typ: Int, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

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 voltage-current-bricklet <uid> voltage-reached¶

Ausgabe:	voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 36000]

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

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

tinkerforge dispatch voltage-current-bricklet <uid> power-reached¶

Ausgabe:	power – Typ: Int, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

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

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