Spezifikationen / TCP/IP Protokoll / API / Bricks und Bricklets / Bricklets (Abgekündigt) / Industrial Dual Analog In Bricklet

TCP/IP - Industrial Dual Analog In Bricklet¶

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

API¶

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

Grundfunktionen¶

BrickletIndustrialDualAnalogIn.get_voltage¶

Funktions-ID:	1
Anfrage:	channel – Typ: uint8, Wertebereich: [0 bis 1]
Antwort:	voltage – Typ: int32, Einheit: 1 mV, Wertebereich: [-35000 bis 35000]

Gibt die Spannung für den übergebenen Kanal zurück.

Wenn die Spannung periodisch abgefragt werden soll, wird empfohlen den CALLBACK_VOLTAGE Callback zu nutzen und die Periode mit set_voltage_callback_period vorzugeben.

Fortgeschrittene Funktionen¶

BrickletIndustrialDualAnalogIn.set_sample_rate¶

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

Setzt die Abtastrate. Der Wertebereich der verfügbare Abtastraten liegt zwischen 1 Wert pro Sekunde und 976 Werte pro Sekunde. Ein Verringern der Abtastrate wird auch das Rauschen auf den Daten verringern.

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

Für rate:

0 = 976 SPS
1 = 488 SPS
2 = 244 SPS
3 = 122 SPS
4 = 61 SPS
5 = 4 SPS
6 = 2 SPS
7 = 1 SPS

BrickletIndustrialDualAnalogIn.get_sample_rate¶

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

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 = 976 SPS
1 = 488 SPS
2 = 244 SPS
3 = 122 SPS
4 = 61 SPS
5 = 4 SPS
6 = 2 SPS
7 = 1 SPS

BrickletIndustrialDualAnalogIn.set_calibration¶

Funktions-ID:	10
Anfrage:	offset – Typ: int32[2], Wertebereich: [-2²³ bis 2²³ - 1] gain – Typ: int32[2], Wertebereich: [-2²³ bis 2²³ - 1]
Antwort:	keine Antwort

Setzt Offset und Gain der MCP3911 internen Kalibrierungsregister.

Siehe MCP3911 Datenblatt 7.7 und 7.8. Das Industrial Dual Analog In Bricklet wird von Tinkerforge werkskalibriert. Ein Aufruf dieser Funktion sollte nicht notwendig sein.

BrickletIndustrialDualAnalogIn.get_calibration¶

Funktions-ID:	11
Anfrage:	keine Nutzdaten
Antwort:	offset – Typ: int32[2], Wertebereich: [-2²³ bis 2²³ - 1] gain – Typ: int32[2], Wertebereich: [-2²³ bis 2²³ - 1]

Gibt die Kalibrierung zurück, wie von set_calibration gesetzt.

BrickletIndustrialDualAnalogIn.get_adc_values¶

Funktions-ID:	12
Anfrage:	keine Nutzdaten
Antwort:	value – Typ: int32[2], Wertebereich: [-2²³ bis 2²³ - 1]

Gibt die ADC-Werte des MCP3911 ICs zurück. Diese Funktion wird für die Kalibrierung benötigt, siehe set_calibration.

BrickletIndustrialDualAnalogIn.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¶

BrickletIndustrialDualAnalogIn.set_voltage_callback_period¶

Funktions-ID:	2
Anfrage:	channel – 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_VOLTAGE Callback für den übergebenen Kanal ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

BrickletIndustrialDualAnalogIn.get_voltage_callback_period¶

Funktions-ID:	3
Anfrage:	channel – 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_voltage_callback_period gesetzt.

BrickletIndustrialDualAnalogIn.set_voltage_callback_threshold¶

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

Setzt den Schwellwert des CALLBACK_VOLTAGE_REACHED Callbacks für den übergebenen Kanal.

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

Für option:

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

BrickletIndustrialDualAnalogIn.get_voltage_callback_threshold¶

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

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

BrickletIndustrialDualAnalogIn.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_VOLTAGE_REACHED

ausgelöst werden, wenn der Schwellwert

set_voltage_callback_threshold

weiterhin erreicht bleibt.

BrickletIndustrialDualAnalogIn.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¶

BrickletIndustrialDualAnalogIn.CALLBACK_VOLTAGE¶

Funktions-ID:	13
Antwort:	channel – Typ: uint8, Wertebereich: [0 bis 1] voltage – Typ: int32, Einheit: 1 mV, Wertebereich: [-35000 bis 35000]

Dieser Callback wird mit der Periode, wie gesetzt mit set_voltage_callback_period, ausgelöst. Der Rückgabewert ist die Spannung des Kanals.

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

BrickletIndustrialDualAnalogIn.CALLBACK_VOLTAGE_REACHED¶

Funktions-ID:	14
Antwort:	channel – Typ: uint8, Wertebereich: [0 bis 1] voltage – Typ: int32, Einheit: 1 mV, Wertebereich: [-35000 bis 35000]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set_voltage_callback_threshold gesetzt, erreicht wird. Der Rückgabewert ist die Spannung des Kanals.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit set_debounce_period gesetzt, ausgelöst.