Modbus - Industrial Dual Analog In Bricklet

Dies ist die Beschreibung des Modbus 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 Modbus Protokollstruktur findet sich hier.

Das Bricklet hat zwei Eingangskanäle. Funktionen die sich direkt auf einen der Kanäle beziehen haben einen channel Parameter, um den Kanal anzugeben. Gültige Werte für das channel Parameter sind 0 und 1.

Grundfunktionen

BrickletIndustrialDualAnalogIn.get_voltage
Funktions ID:

1

Anfrage:
  • channel -- uint8
Antwort:
  • voltage -- int32

Gibt die Spannung für den übergebenen Kanal in mV 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 -- uint8
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.

Der Standardwert ist 6 (2 Werte pro Sekunde).

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

  • 0: 976 sps, für rate
  • 1: 488 sps, für rate
  • 2: 244 sps, für rate
  • 3: 122 sps, für rate
  • 4: 61 sps, für rate
  • 5: 4 sps, für rate
  • 6: 2 sps, für rate
  • 7: 1 sps, für rate
BrickletIndustrialDualAnalogIn.get_sample_rate
Funktions ID:

9

Anfrage:

keine Nutzdaten

Antwort:
  • rate -- uint8

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

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

  • 0: 976 sps, für rate
  • 1: 488 sps, für rate
  • 2: 244 sps, für rate
  • 3: 122 sps, für rate
  • 4: 61 sps, für rate
  • 5: 4 sps, für rate
  • 6: 2 sps, für rate
  • 7: 1 sps, für rate
BrickletIndustrialDualAnalogIn.set_calibration
Funktions ID:

10

Anfrage:
  • offset -- int32[2]
  • gain -- int32[2]
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 -- int32[2]
  • gain -- int32[2]

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

BrickletIndustrialDualAnalogIn.get_adc_values
Funktions ID:

12

Anfrage:

keine Nutzdaten

Antwort:
  • value -- int32[2]

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 -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. 

Konfigurationsfunktionen für Callbacks

BrickletIndustrialDualAnalogIn.set_voltage_callback_period
Funktions ID:

2

Anfrage:
  • channel -- uint8
  • period -- uint32
Antwort:

keine Antwort

Setzt die Periode in ms 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.

Der Standardwert ist 0.

BrickletIndustrialDualAnalogIn.get_voltage_callback_period
Funktions ID:

3

Anfrage:
  • channel -- uint8
Antwort:
  • period -- uint32

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

BrickletIndustrialDualAnalogIn.set_voltage_callback_threshold
Funktions ID:

4

Anfrage:
  • channel -- uint8
  • option -- char
  • min -- int32
  • max -- int32
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)

Der Standardwert ist ('x', 0, 0).

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

  • x: off, für option
  • o: outside, für option
  • i: inside, für option
  • <: smaller, für option
  • >: greater, für option
BrickletIndustrialDualAnalogIn.get_voltage_callback_threshold
Funktions ID:

5

Anfrage:
  • channel -- uint8
Antwort:
  • option -- char
  • min -- int32
  • max -- int32

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

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

  • x: off, für option
  • o: outside, für option
  • i: inside, für option
  • <: smaller, für option
  • >: greater, für option
BrickletIndustrialDualAnalogIn.set_debounce_period
Funktions ID:

6

Anfrage:
  • debounce -- uint32
Antwort:

keine Antwort

Setzt die Periode in ms mit welcher der Schwellwert Callback

ausgelöst werden, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

BrickletIndustrialDualAnalogIn.get_debounce_period
Funktions ID:

7

Anfrage:

keine Nutzdaten

Antwort:
  • debounce -- uint32

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

Callbacks

BrickletIndustrialDualAnalogIn.CALLBACK_VOLTAGE
Funktions ID:

13

Antwort:
  • channel -- uint8
  • voltage -- int32

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 -- uint8
  • voltage -- int32

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.