Modbus - Industrial Dual Analog In Bricklet 2.0

Dies ist die Beschreibung des Modbus Protokolls für das Industrial Dual Analog In Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Dual Analog In Bricklet 2.0 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 der channel Parameter sind 0 und 1.

Grundfunktionen

BrickletIndustrialDualAnalogInV2.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 der Wert periodisch benötigt wird, kann auch der CALLBACK_VOLTAGE Callback verwendet werden. Der Callback wird mit der Funktion set_voltage_callback_configuration konfiguriert.

BrickletIndustrialDualAnalogInV2.set_channel_led_config
Funktions-ID:
  • 10
Anfrage:
  • channel – Typ: uint8, Wertebereich: [0 bis 1]
  • config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3
Antwort:
  • keine Antwort

Jeder Kanal hat eine dazugehörige LED. Die LEDs können individuell an- oder ausgeschaltet werden. Zusätzlich kann ein Heartbeat oder der Kanalstatus angezeigt werden. Falls Kanalstatus gewählt wird kann die LED entweder ab einem vordefinierten Schwellwert eingeschaltet werden oder ihre Helligkeit anhand des gemessenen Wertes skaliert werden.

Das Verhalten des Kanalstatus kann mittels set_channel_led_status_config eingestellt werden.

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

Für config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Channel Status
BrickletIndustrialDualAnalogInV2.get_channel_led_config
Funktions-ID:
  • 11
Anfrage:
  • channel – Typ: uint8, Wertebereich: [0 bis 1]
Antwort:
  • config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3

Gibt die Kanal-LED-Konfiguration zurück, wie von set_channel_led_config gesetzt.

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

Für config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Channel Status
BrickletIndustrialDualAnalogInV2.set_channel_led_status_config
Funktions-ID:
  • 12
Anfrage:
  • channel – Typ: uint8, Wertebereich: [0 bis 1]
  • min – Typ: int32, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 10000
  • config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 1
Antwort:
  • keine Antwort

Setzt die Kanal-LED-Status-Konfiguration. Diese Einstellung wird verwendet wenn die Kanal-LED auf Kanalstatus eingestellt ist, siehe set_channel_led_config.

Für jeden Kanal kann zwischen Schwellwert- und Intensitätsmodus gewählt werden.

Im Schwellwertmodus kann ein positiver oder negativer Schwellwert definiert werden. Für einen positiven Schwellwert muss der "min" Parameter auf den gewünschten Schwellwert in mV gesetzt werden, über dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem positiven Schwellwert von 10V wird die LED eingeschaltet sobald die gemessene Spannung über 10V steigt und wieder ausgeschaltet sobald der Strom unter 10V fällt. Für einen negativen Schwellwert muss der "max" Parameter auf den gewünschten Schwellwert in mV gesetzt werden, unter dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem negativen Schwellwert von 10mA wird die LED eingeschaltet sobald die gemessene Spannung unter 10V fällt und wieder ausgeschaltet sobald der Strom über 10V steigt.

Im Intensitätsmodus kann ein Bereich in mV angegeben werden über den die Helligkeit der LED skaliert wird. Beispiel mit min=4V und max=20V: Die LED ist bei 4V und darunter aus, bei 20V und darüber an und zwischen 4V und 20V wird die Helligkeit linear skaliert. Wenn der min Wert größer als der max Wert ist, dann wird die Helligkeit andersherum skaliert.

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

Für config:

  • 0 = Threshold
  • 1 = Intensity
BrickletIndustrialDualAnalogInV2.get_channel_led_status_config
Funktions-ID:
  • 13
Anfrage:
  • channel – Typ: uint8, Wertebereich: [0 bis 1]
Antwort:
  • min – Typ: int32, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 10000
  • config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 1

Gibt die Kanal-LED-Status-Konfiguration zurück, wie von set_channel_led_status_config gesetzt.

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

Für config:

  • 0 = Threshold
  • 1 = Intensity

Fortgeschrittene Funktionen

BrickletIndustrialDualAnalogInV2.set_sample_rate
Funktions-ID:
  • 5
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
BrickletIndustrialDualAnalogInV2.get_sample_rate
Funktions-ID:
  • 6
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
BrickletIndustrialDualAnalogInV2.set_calibration
Funktions-ID:
  • 7
Anfrage:
  • offset – Typ: int32[2], Wertebereich: [-8388608 bis 8388607]
  • gain – Typ: int32[2], Wertebereich: [-8388608 bis 8388607]
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 2.0 wird von Tinkerforge werkskalibriert. Ein Aufruf dieser Funktion sollte nicht notwendig sein.

BrickletIndustrialDualAnalogInV2.get_calibration
Funktions-ID:
  • 8
Anfrage:
  • keine Nutzdaten
Antwort:
  • offset – Typ: int32[2], Wertebereich: [-8388608 bis 8388607]
  • gain – Typ: int32[2], Wertebereich: [-8388608 bis 8388607]

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

BrickletIndustrialDualAnalogInV2.get_adc_values
Funktions-ID:
  • 9
Anfrage:
  • keine Nutzdaten
Antwort:
  • value – Typ: int32[2], Wertebereich: [-8388608 bis 8388607]

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

BrickletIndustrialDualAnalogInV2.get_spitfp_error_count
Funktions-ID:
  • 234
Anfrage:
  • keine Nutzdaten
Antwort:
  • error_count_ack_checksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: uint32, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

BrickletIndustrialDualAnalogInV2.set_bootloader_mode
Funktions-ID:
  • 235
Anfrage:
  • mode – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:
  • status – Typ: uint8, Wertebereich: Siehe Bedeutungen

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Für mode:

  • 0 = Bootloader
  • 1 = Firmware
  • 2 = Bootloader Wait For Reboot
  • 3 = Firmware Wait For Reboot
  • 4 = Firmware Wait For Erase And Reboot

Für status:

  • 0 = OK
  • 1 = Invalid Mode
  • 2 = No Change
  • 3 = Entry Function Not Present
  • 4 = Device Identifier Incorrect
  • 5 = CRC Mismatch
BrickletIndustrialDualAnalogInV2.get_bootloader_mode
Funktions-ID:
  • 236
Anfrage:
  • keine Nutzdaten
Antwort:
  • mode – Typ: uint8, Wertebereich: Siehe Bedeutungen

Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode.

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

Für mode:

  • 0 = Bootloader
  • 1 = Firmware
  • 2 = Bootloader Wait For Reboot
  • 3 = Firmware Wait For Reboot
  • 4 = Firmware Wait For Erase And Reboot
BrickletIndustrialDualAnalogInV2.set_write_firmware_pointer
Funktions-ID:
  • 237
Anfrage:
  • pointer – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

Setzt den Firmware-Pointer für write_firmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletIndustrialDualAnalogInV2.write_firmware
Funktions-ID:
  • 238
Anfrage:
  • data – Typ: uint8[64], Wertebereich: [0 bis 255]
Antwort:
  • status – Typ: uint8, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von set_write_firmware_pointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletIndustrialDualAnalogInV2.set_status_led_config
Funktions-ID:
  • 239
Anfrage:
  • config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3
Antwort:
  • keine Antwort

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Status
BrickletIndustrialDualAnalogInV2.get_status_led_config
Funktions-ID:
  • 240
Anfrage:
  • keine Nutzdaten
Antwort:
  • config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3

Gibt die Konfiguration zurück, wie von set_status_led_config gesetzt.

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

Für config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Status
BrickletIndustrialDualAnalogInV2.get_chip_temperature
Funktions-ID:
  • 242
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int16, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

BrickletIndustrialDualAnalogInV2.reset
Funktions-ID:
  • 243
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

BrickletIndustrialDualAnalogInV2.write_uid
Funktions-ID:
  • 248
Anfrage:
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

BrickletIndustrialDualAnalogInV2.read_uid
Funktions-ID:
  • 249
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

BrickletIndustrialDualAnalogInV2.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', 'i', '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 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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. 

Konfigurationsfunktionen für Callbacks

BrickletIndustrialDualAnalogInV2.set_voltage_callback_configuration
Funktions-ID:
  • 2
Anfrage:
  • channel – Typ: uint8, Wertebereich: [0 bis 1]
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: int32, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Die Periode ist die Periode mit der der CALLBACK_VOLTAGE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den CALLBACK_VOLTAGE Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletIndustrialDualAnalogInV2.get_voltage_callback_configuration
Funktions-ID:
  • 3
Anfrage:
  • channel – Typ: uint8, Wertebereich: [0 bis 1]
Antwort:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: int32, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels set_voltage_callback_configuration gesetzt.

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

Für option:

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

Callbacks

BrickletIndustrialDualAnalogInV2.CALLBACK_VOLTAGE
Funktions-ID:
  • 4
Antwort:
  • channel – Typ: uint8, Wertebereich: [0 bis 1]
  • voltage – Typ: int32, Einheit: 1 mV, Wertebereich: [-35000 bis 35000]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels set_voltage_callback_configuration gesetzten Konfiguration

Der Rückgabewert ist der gleiche wie get_voltage.