Shell - Industrial Dual 0-20mA Bricklet¶

Simple¶

Download (example-simple.sh)

1#!/bin/sh
2# Connects to localhost:4223 by default, use --host and --port to change this
3
4uid=XYZ # Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet
5
6# Get current current from sensor 1
7tinkerforge call industrial-dual-0-20ma-bricklet $uid get-current 1

Callback¶

Download (example-callback.sh)

 1#!/bin/sh
 2# Connects to localhost:4223 by default, use --host and --port to change this
 3
 4uid=XYZ # Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet
 5
 6# Handle incoming current callbacks
 7tinkerforge dispatch industrial-dual-0-20ma-bricklet $uid current &
 8
 9# Set period for current (sensor 1) callback to 1s (1000ms)
10# Note: The current (sensor 1) callback is only called every second
11#       if the current (sensor 1) has changed since the last call!
12tinkerforge call industrial-dual-0-20ma-bricklet $uid set-current-callback-period 1 1000
13
14echo "Press key to exit"; read dummy
15
16kill -- -$$ # Stop callback dispatch in background

Threshold¶

Download (example-threshold.sh)

 1#!/bin/sh
 2# Connects to localhost:4223 by default, use --host and --port to change this
 3
 4uid=XYZ # Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet
 5
 6# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
 7tinkerforge call industrial-dual-0-20ma-bricklet $uid set-debounce-period 10000
 8
 9# Handle incoming current reached callbacks
10tinkerforge dispatch industrial-dual-0-20ma-bricklet $uid current-reached &
11
12# Configure threshold for current (sensor 1) "greater than 10 mA"
13tinkerforge call industrial-dual-0-20ma-bricklet $uid set-current-callback-threshold 1 threshold-option-greater 10000000 0
14
15echo "Press key to exit"; read dummy
16
17kill -- -$$ # 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 industrial-dual-0-20ma-bricklet [<option>..] <uid> <function> [<argument>..]¶

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

Der call Befehl wird verwendet um eine Funktion des Industrial Dual 0-20mA 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 Industrial Dual 0-20mA Bricklet an und endet dann

tinkerforge dispatch industrial-dual-0-20ma-bricklet [<option>..] <uid> <callback>¶

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

Der dispatch Befehl wird verwendet um eingehende Callbacks des Industrial Dual 0-20mA 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 Industrial Dual 0-20mA Bricklet an und endet dann

tinkerforge call industrial-dual-0-20ma-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 industrial-dual-0-20ma-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 industrial-dual-0-20ma-bricklet <uid> get-current <sensor>¶

Parameter:	<sensor> – Typ: Int, Wertebereich: [0 bis 1]
Ausgabe:	current – Typ: Int, Einheit: 1 nA, Wertebereich: [0 bis 22505322]

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

Es ist möglich zu erkennen ob ein IEC 60381-1-kompatibler Sensor angeschlossen ist und ob er funktionsfähig ist.

Falls die zurückgegebene Stromstärke kleiner als 4mA ist, ist wahrscheinlich kein Sensor angeschlossen oder der Sensor ist defekt. Falls die zurückgegebene Stromstärke über 20mA ist, besteht entweder ein Kurzschluss oder der Sensor ist defekt. Somit ist erkennbar ob ein Sensor angeschlossen und funktionsfähig ist.

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 industrial-dual-0-20ma-bricklet <uid> set-sample-rate <rate>¶

Parameter:	<rate> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
Ausgabe:	keine Ausgabe

Setzt die Abtastrate auf 240, 60, 15 oder 4 Samples pro Sekunde. Die Auflösung für die Raten sind 12, 14, 16 und 18 Bit respektive.

Wert	Beschreibung
0	240 Samples pro Sekunde, 12 Bit Auflösung
1	60 Samples pro Sekunde, 14 Bit Auflösung
2	15 Samples pro Sekunde, 16 Bit Auflösung
3	4 Samples pro Sekunde, 18 Bit Auflösung

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

Für <rate>:

• sample-rate-240-sps = 0

• sample-rate-60-sps = 1

• sample-rate-15-sps = 2

• sample-rate-4-sps = 3

tinkerforge call industrial-dual-0-20ma-bricklet <uid> get-sample-rate¶

Ausgabe:	rate – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Abtastrate zurück, wie von set-sample-rate gesetzt.

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

Für rate:

• sample-rate-240-sps = 0

• sample-rate-60-sps = 1

• sample-rate-15-sps = 2

• sample-rate-4-sps = 3

tinkerforge call industrial-dual-0-20ma-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 industrial-dual-0-20ma-bricklet <uid> set-current-callback-period <sensor> <period>¶

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

Setzt die Periode mit welcher der current Callback für den übergebenen Sensor 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 industrial-dual-0-20ma-bricklet <uid> get-current-callback-period <sensor>¶

Parameter:	<sensor> – Typ: Int, Wertebereich: [0 bis 1]
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 industrial-dual-0-20ma-bricklet <uid> set-current-callback-threshold <sensor> <option> <min> <max>¶

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

Setzt den Schwellwert des current-reached Callbacks für den übergebenen Sensor.

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 industrial-dual-0-20ma-bricklet <uid> get-current-callback-threshold <sensor>¶

Parameter:	<sensor> – Typ: Int, Wertebereich: [0 bis 1]
Ausgabe:	option – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x min – Typ: Int, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: Int, Einheit: 1 nA, 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 industrial-dual-0-20ma-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 der Schwellwert Callback

• current-reached

ausgelöst werden, wenn der Schwellwert

• set-current-callback-threshold

weiterhin erreicht bleibt.

tinkerforge call industrial-dual-0-20ma-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 industrial-dual-0-20ma-bricklet <uid> example

Die verfügbaren Callbacks werden weiter unten beschrieben.

tinkerforge dispatch industrial-dual-0-20ma-bricklet <uid> current¶

Ausgabe:	sensor – Typ: Int, Wertebereich: [0 bis 1] current – Typ: Int, Einheit: 1 nA, Wertebereich: [0 bis 22505322]

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 industrial-dual-0-20ma-bricklet <uid> current-reached¶

Ausgabe:	sensor – Typ: Int, Wertebereich: [0 bis 1] current – Typ: Int, Einheit: 1 nA, Wertebereich: [0 bis 22505322]

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.