Spezifikationen / TCP/IP Protokoll / API / Bricks und Bricklets / Bricklets / Industrial Dual 0-20mA Bricklet

TCP/IP - Industrial Dual 0-20mA Bricklet¶

Dies ist die Beschreibung des TCP/IP Protokolls für das Industrial Dual 0-20mA Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Dual 0-20mA Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API¶

Eine allgemeine Beschreibung der TCP/IP Protokollstruktur findet sich hier.

Grundfunktionen¶

BrickletIndustrialDual020mA.get_current¶

Funktions-ID:	1
Anfrage:	sensor – Typ: uint8, Wertebereich: [0 bis 1]
Antwort:	current – Typ: int32, 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 CALLBACK_CURRENT Callback zu nutzen und die Periode mit set_current_callback_period vorzugeben.

Fortgeschrittene Funktionen¶

BrickletIndustrialDual020mA.set_sample_rate¶

Funktions-ID:	8
Anfrage:	rate – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3
Antwort:	keine Antwort

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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für rate:

0 = 240 SPS
1 = 60 SPS
2 = 15 SPS
3 = 4 SPS

BrickletIndustrialDual020mA.get_sample_rate¶

Funktions-ID:	9
Anfrage:	keine Nutzdaten
Antwort:	rate – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3

Gibt die Abtastrate zurück, wie von set_sample_rate gesetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für rate:

0 = 240 SPS
1 = 60 SPS
2 = 15 SPS
3 = 4 SPS

BrickletIndustrialDual020mA.get_identity¶

Funktions-ID:	255
Anfrage:	keine Nutzdaten
Antwort:	uid – Typ: char[8] connected_uid – Typ: char[8] position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardware_version – Typ: uint8[3] 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] firmware_version – Typ: uint8[3] 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] device_identifier – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 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¶

BrickletIndustrialDual020mA.set_current_callback_period¶

Funktions-ID:	2
Anfrage:	sensor – Typ: uint8, Wertebereich: [0 bis 1] period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt die Periode mit welcher der CALLBACK_CURRENT Callback für den übergebenen Sensor ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

BrickletIndustrialDual020mA.get_current_callback_period¶

Funktions-ID:	3
Anfrage:	sensor – Typ: uint8, Wertebereich: [0 bis 1]
Antwort:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von set_current_callback_period gesetzt.

BrickletIndustrialDual020mA.set_current_callback_threshold¶

Funktions-ID:	4
Anfrage:	sensor – Typ: uint8, Wertebereich: [0 bis 1] option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x' min – Typ: int32, Einheit: 1 nA, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int32, Einheit: 1 nA, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt den Schwellwert des CALLBACK_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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für option:

'x' = Off
'o' = Outside
'i' = Inside
'<' = Smaller
'>' = Greater

BrickletIndustrialDual020mA.get_current_callback_threshold¶

Funktions-ID:	5
Anfrage:	sensor – Typ: uint8, Wertebereich: [0 bis 1]
Antwort:	option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x' min – Typ: int32, Einheit: 1 nA, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int32, Einheit: 1 nA, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von set_current_callback_threshold gesetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für option:

'x' = Off
'o' = Outside
'i' = Inside
'<' = Smaller
'>' = Greater

BrickletIndustrialDual020mA.set_debounce_period¶

Funktions-ID:	6
Anfrage:	debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100
Antwort:	keine Antwort

Setzt die Periode mit welcher der Schwellwert Callback

CALLBACK_CURRENT_REACHED

ausgelöst werden, wenn der Schwellwert

set_current_callback_threshold

weiterhin erreicht bleibt.

BrickletIndustrialDual020mA.get_debounce_period¶

Funktions-ID:	7
Anfrage:	keine Nutzdaten
Antwort:	debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von set_debounce_period gesetzt.

Callbacks¶

BrickletIndustrialDual020mA.CALLBACK_CURRENT¶

Funktions-ID:	10
Antwort:	sensor – Typ: uint8, Wertebereich: [0 bis 1] current – Typ: int32, Einheit: 1 nA, Wertebereich: [0 bis 22505322]

Dieser Callback wird mit der Periode, wie gesetzt mit set_current_callback_period, ausgelöst. Der Rückgabewert ist die Stromstärke des Sensors.

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

BrickletIndustrialDual020mA.CALLBACK_CURRENT_REACHED¶

Funktions-ID:	11
Antwort:	sensor – Typ: uint8, Wertebereich: [0 bis 1] current – Typ: int32, 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 Rückgabewert 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.