Modbus - Industrial Counter Bricklet

Dies ist die Beschreibung des Modbus Protokolls für das Industrial Counter Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Counter Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen

BrickletIndustrialCounter.get_counter
Funktions-ID:
  • 1
Anfrage:
  • channel – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:
  • counter – Typ: int64, Wertebereich: [-263 bis 263 - 1]

Gibt den aktuellen Zählerstand für den gegebenen Kanal zurück.

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

Für channel:

  • 0 = 0
  • 1 = 1
  • 2 = 2
  • 3 = 3
BrickletIndustrialCounter.get_all_counter
Funktions-ID:
  • 2
Anfrage:
  • keine Nutzdaten
Antwort:
  • counter – Typ: int64[4], Wertebereich: [-263 bis 263 - 1]

Gibt die Zählerstände für alle vier Kanäle zurück.

BrickletIndustrialCounter.set_counter
Funktions-ID:
  • 3
Anfrage:
  • channel – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • counter – Typ: int64, Wertebereich: [-263 bis 263 - 1]
Antwort:
  • keine Antwort

Setzt den Zählerstand für den gegebenen Kanal.

Der Standardwert für alle Zähler nach dem Start ist 0.

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

Für channel:

  • 0 = 0
  • 1 = 1
  • 2 = 2
  • 3 = 3
BrickletIndustrialCounter.set_all_counter
Funktions-ID:
  • 4
Anfrage:
  • counter – Typ: int64[4], Wertebereich: [-263 bis 263 - 1]
Antwort:
  • keine Antwort

Setzt die Zählerstände für alle vier Kanäle.

Der Standardwert für die Zähler nach dem Starten ist 0.

BrickletIndustrialCounter.get_signal_data
Funktions-ID:
  • 5
Anfrage:
  • channel – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:
  • duty_cycle – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • period – Typ: uint64, Wertebereich: [0 bis 264 - 1]
  • frequency – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • value – Typ: bool

Gibt die Signaldaten (Tastverhältnis, Periode, Frequenz und Status) für den gegebenen Kanal.

Die Einheiten sind:

  • Tastverhältnis: 1/100 %
  • Periode: ns
  • Frequenz: mHz (1/1000 Hz)
  • Wert: true = high, false = low

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

Für channel:

  • 0 = 0
  • 1 = 1
  • 2 = 2
  • 3 = 3
BrickletIndustrialCounter.get_all_signal_data
Funktions-ID:
  • 6
Anfrage:
  • keine Nutzdaten
Antwort:
  • duty_cycle – Typ: uint16[4], Wertebereich: [0 bis 216 - 1]
  • period – Typ: uint64[4], Wertebereich: [0 bis 264 - 1]
  • frequency – Typ: uint32[4], Wertebereich: [0 bis 232 - 1]
  • value – Typ: bool[4]

Gibt die Signaldaten (Tastverhältnis, Periode, Frequenz und Status) für alle vier Kanäle zurück.

Die Einheiten sind:

  • Tastverhältnis: 1/100 %
  • Periode: ns
  • Frequenz: mHz (1/1000 Hz)
  • Wert: true = high, false = low
BrickletIndustrialCounter.set_counter_active
Funktions-ID:
  • 7
Anfrage:
  • channel – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • active – Typ: bool
Antwort:
  • keine Antwort

Aktiviert/Deaktiviert den Zähler für den gegebenen Kanal.

true = aktivieren, false = deaktivieren.

Standardmäßig sind alle Kanäle aktiviert.

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

Für channel:

  • 0 = 0
  • 1 = 1
  • 2 = 2
  • 3 = 3
BrickletIndustrialCounter.set_all_counter_active
Funktions-ID:
  • 8
Anfrage:
  • active – Typ: bool[4]
Antwort:
  • keine Antwort

Aktiviert/Deaktiviert den Zähler für alle vier Kanäle.

true = aktivieren, false = deaktivieren.

Standardmäßig sind alle Kanäle aktiviert.

BrickletIndustrialCounter.get_counter_active
Funktions-ID:
  • 9
Anfrage:
  • channel – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:
  • active – Typ: bool

Gibt den Zustand (aktiviert/deaktiviert) des gegebenen Zähler zurück.

true = aktiviert, false = deaktiviert.

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

Für channel:

  • 0 = 0
  • 1 = 1
  • 2 = 2
  • 3 = 3
BrickletIndustrialCounter.get_all_counter_active
Funktions-ID:
  • 10
Anfrage:
  • keine Nutzdaten
Antwort:
  • active – Typ: bool[4]

Gibt den Zustand (aktiviert/deaktiviert) aller vier Zähler zurück.

true = aktiviert, false = deaktiviert.

BrickletIndustrialCounter.set_counter_configuration
Funktions-ID:
  • 11
Anfrage:
  • channel – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • count_edge – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • count_direction – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • duty_cycle_prescaler – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • frequency_integration_time – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:
  • keine Antwort

Setzt die Zähler-Konfiguration für den gegebenen Kanal.

  • Zählflanke: Der Zähler kann bei der steigenden, fallenden oder beiden Flanken zählen. Standardwert ist steigend.
  • Zählrichtung: Der Zähler kann hoch- oder runterzählen. Es kann auch ein weiterer Kanal als Richtungseingang genutzt werden. Siehe hier für weitere Details. Standardwert ist hochzählend.
  • Tastverhältnis Prescaler: Setzt einen Teiler für die interne Clock. Siehe hier für weitere Details. Standardwert ist 1.
  • Frequenz-Integration: Setzt die Integrationszeit für die Frequenzmessung. Siehe hier für weitere Details. Standardwert ist 1024ms.

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

Für channel:

  • 0 = 0
  • 1 = 1
  • 2 = 2
  • 3 = 3

Für count_edge:

  • 0 = Rising
  • 1 = Falling
  • 2 = Both

Für count_direction:

  • 0 = Up
  • 1 = Down
  • 2 = External Up
  • 3 = External Down

Für duty_cycle_prescaler:

  • 0 = 1
  • 1 = 2
  • 2 = 4
  • 3 = 8
  • 4 = 16
  • 5 = 32
  • 6 = 64
  • 7 = 128
  • 8 = 256
  • 9 = 512
  • 10 = 1024
  • 11 = 2048
  • 12 = 4096
  • 13 = 8192
  • 14 = 16384
  • 15 = 32768

Für frequency_integration_time:

  • 0 = 128 MS
  • 1 = 256 MS
  • 2 = 512 MS
  • 3 = 1024 MS
  • 4 = 2048 MS
  • 5 = 4096 MS
  • 6 = 8192 MS
  • 7 = 16384 MS
  • 8 = 32768 MS
BrickletIndustrialCounter.get_counter_configuration
Funktions-ID:
  • 12
Anfrage:
  • channel – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:
  • count_edge – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • count_direction – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • duty_cycle_prescaler – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • frequency_integration_time – Typ: uint8, Wertebereich: Siehe Bedeutungen

Gibt die Zähler-Konfiguration zurück, wie Sie mittels set_counter_configuration gesetzt wurde.

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

Für channel:

  • 0 = 0
  • 1 = 1
  • 2 = 2
  • 3 = 3

Für count_edge:

  • 0 = Rising
  • 1 = Falling
  • 2 = Both

Für count_direction:

  • 0 = Up
  • 1 = Down
  • 2 = External Up
  • 3 = External Down

Für duty_cycle_prescaler:

  • 0 = 1
  • 1 = 2
  • 2 = 4
  • 3 = 8
  • 4 = 16
  • 5 = 32
  • 6 = 64
  • 7 = 128
  • 8 = 256
  • 9 = 512
  • 10 = 1024
  • 11 = 2048
  • 12 = 4096
  • 13 = 8192
  • 14 = 16384
  • 15 = 32768

Für frequency_integration_time:

  • 0 = 128 MS
  • 1 = 256 MS
  • 2 = 512 MS
  • 3 = 1024 MS
  • 4 = 2048 MS
  • 5 = 4096 MS
  • 6 = 8192 MS
  • 7 = 16384 MS
  • 8 = 32768 MS
BrickletIndustrialCounter.set_channel_led_config
Funktions-ID:
  • 17
Anfrage:
  • channel – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • config – Typ: uint8, Wertebereich: Siehe Bedeutungen
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 ist die LED an wenn ein High-Signal am Kanal anliegt und sonst aus.

Standardmäßig sind die LEDs für alle Kanäle auf Kanalstatus konfiguriert.

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

Für channel:

  • 0 = 0
  • 1 = 1
  • 2 = 2
  • 3 = 3

Für config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Channel Status
BrickletIndustrialCounter.get_channel_led_config
Funktions-ID:
  • 18
Anfrage:
  • channel – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:
  • config – Typ: uint8, Wertebereich: Siehe Bedeutungen

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 channel:

  • 0 = 0
  • 1 = 1
  • 2 = 2
  • 3 = 3

Für config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Channel Status

Fortgeschrittene Funktionen

BrickletIndustrialCounter.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.

BrickletIndustrialCounter.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 Bootlodaer- 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
BrickletIndustrialCounter.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
BrickletIndustrialCounter.set_write_firmware_pointer
Funktions-ID:
  • 237
Anfrage:
  • pointer – Typ: uint32, 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.

BrickletIndustrialCounter.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.

BrickletIndustrialCounter.set_status_led_config
Funktions-ID:
  • 239
Anfrage:
  • config – Typ: uint8, Wertebereich: Siehe Bedeutungen
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
BrickletIndustrialCounter.get_status_led_config
Funktions-ID:
  • 240
Anfrage:
  • keine Nutzdaten
Antwort:
  • config – Typ: uint8, Wertebereich: Siehe Bedeutungen

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
BrickletIndustrialCounter.get_chip_temperature
Funktions-ID:
  • 242
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int16, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur in °C, 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.

BrickletIndustrialCounter.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.

BrickletIndustrialCounter.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.

BrickletIndustrialCounter.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.

BrickletIndustrialCounter.get_identity
Funktions-ID:
  • 255
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: char[8]
  • connected_uid – Typ: char[8]
  • position – Typ: char
  • hardware_version – Typ: uint8[3], Wertebereich: [0 bis 255]
  • firmware_version – Typ: uint8[3], 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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. 

Konfigurationsfunktionen für Callbacks

BrickletIndustrialCounter.set_all_counter_callback_configuration
Funktions-ID:
  • 13
Anfrage:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
Antwort:
  • keine Antwort

Die Periode ist die Periode mit der der CALLBACK_ALL_COUNTER 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.

BrickletIndustrialCounter.get_all_counter_callback_configuration
Funktions-ID:
  • 14
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false

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

BrickletIndustrialCounter.set_all_signal_data_callback_configuration
Funktions-ID:
  • 15
Anfrage:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
Antwort:
  • keine Antwort

Die Periode ist die Periode mit der der CALLBACK_ALL_SIGNAL_DATA 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.

BrickletIndustrialCounter.get_all_signal_data_callback_configuration
Funktions-ID:
  • 16
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false

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

Callbacks

BrickletIndustrialCounter.CALLBACK_ALL_COUNTER
Funktions-ID:
  • 19
Antwort:
  • counter – Typ: int64[4], Wertebereich: [-263 bis 263 - 1]

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

Die Rückgabewerte sind der gleiche wie get_all_counter.

BrickletIndustrialCounter.CALLBACK_ALL_SIGNAL_DATA
Funktions-ID:
  • 20
Antwort:
  • duty_cycle – Typ: uint16[4], Wertebereich: [0 bis 216 - 1]
  • period – Typ: uint64[4], Wertebereich: [0 bis 264 - 1]
  • frequency – Typ: uint32[4], Wertebereich: [0 bis 232 - 1]
  • value – Typ: bool[4]

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

Die Rückgabewerte sind der gleiche wie get_all_signal_data.