Shell - Industrial Counter Bricklet

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

Eine Installationanleitung für die Shell API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example-simple.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Industrial Counter Bricklet

# Get current counter from channel 0
tinkerforge call industrial-counter-bricklet $uid get-counter channel-0

# Get current signal data from channel 0
tinkerforge call industrial-counter-bricklet $uid get-signal-data channel-0

API

Mögliche Exit Codes für alle tinkerforge Befehle sind:

  • 1: Unterbrochen (Ctrl+C)
  • 2: Syntaxfehler
  • 21: Python 2.5 oder neuer wird benötigt
  • 22: Python argparse Modul fehlt
  • 23: Socket-Fehler
  • 24: Andere Exception
  • 25: Ungültiger Platzhalter in Format-String
  • 26: Authentifizierungsfehler
  • 201: Timeout ist aufgetreten
  • 209: Ungültiger Argumentwert
  • 210: Funktion wird nicht unterstützt
  • 211: Unbekannter Fehler

Befehlsstruktur

Allgemeine Optionen des call und des dispatch Befehls sind hier zu finden. Im Folgenden wird die spezifische Befehlsstruktur dargestellt.

tinkerforge call industrial-counter-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des Industrial Counter Bricklet aufzurufen. Der Befehl kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifischen call Befehl an und endet dann
  • --list-functions zeigt eine Liste der bekannten Funktionen des Industrial Counter Bricklet an und endet dann
tinkerforge dispatch industrial-counter-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des Industrial Counter Bricklet abzufertigen. Der Befehl kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifischen dispatch Befehl an und endet dann
  • --list-callbacks zeigt eine Liste der bekannten Callbacks des Industrial Counter Bricklet an und endet dann
tinkerforge call industrial-counter-bricklet <uid> <function> [<option>..] [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Abhängig von der Art der aufzurufenden <function> kennt diese verschiedene Optionen. Alle Funktionen kennen die folgenden Optionen:

  • --help zeigt Hilfe für die spezifische <function> an und endet dann

Getter-Funktionen kennen zusätzlich die folgenden Optionen:

  • --execute <command> Shell-Befehl der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Setter-Funktionen kennen zusätzlich die folgenden Optionen:

  • --expect-response fragt Antwort an und wartet auf diese

Mit der --expect-response Option für Setter-Funktionen können Timeouts und andere Fehlerfälle auch für Aufrufe von Setter-Funktionen detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn diese Option für eine Setter-Funktion nicht angegeben ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

tinkerforge dispatch industrial-counter-bricklet <uid> <callback> [<option>..]
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der abzufertigende <callback> kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifische <callback> an und endet dann
  • --execute <command> Shell-Befehlszeile der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Grundfunktionen

tinkerforge call industrial-counter-bricklet <uid> get-counter <channel>
Parameter:
  • <channel> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • counter – Typ: Int, Wertebereich: [-263 bis 263 - 1]

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

Die folgenden Symbole sind für diese Funktion verfügbar:

Für <channel>:

  • channel-0 = 0
  • channel-1 = 1
  • channel-2 = 2
  • channel-3 = 3
tinkerforge call industrial-counter-bricklet <uid> get-all-counter
Ausgabe:
  • counter – Typ: Int Array, Länge: 4, Wertebereich: [-263 bis 263 - 1]

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

tinkerforge call industrial-counter-bricklet <uid> set-counter <channel> <counter>
Parameter:
  • <channel> – Typ: Int, Wertebereich: Siehe Symbole
  • <counter> – Typ: Int, Wertebereich: [-263 bis 263 - 1]
Ausgabe:
  • keine Ausgabe

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

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

Die folgenden Symbole sind für diese Funktion verfügbar:

Für <channel>:

  • channel-0 = 0
  • channel-1 = 1
  • channel-2 = 2
  • channel-3 = 3
tinkerforge call industrial-counter-bricklet <uid> set-all-counter <counter>
Parameter:
  • <counter> – Typ: Int Array, Länge: 4, Wertebereich: [-263 bis 263 - 1]
Ausgabe:
  • keine Ausgabe

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

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

tinkerforge call industrial-counter-bricklet <uid> get-signal-data <channel>
Parameter:
  • <channel> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • duty-cycle – Typ: Int, Einheit: 1/100 %, Wertebereich: [0 bis 10000]
  • period – Typ: Int, Einheit: 1 ns, Wertebereich: [0 bis 264 - 1]
  • frequency – Typ: Int, Einheit: 1/1000 Hz, Wertebereich: [0 bis 232 - 1]
  • value – Typ: Bool

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

Die folgenden Symbole sind für diese Funktion verfügbar:

Für <channel>:

  • channel-0 = 0
  • channel-1 = 1
  • channel-2 = 2
  • channel-3 = 3
tinkerforge call industrial-counter-bricklet <uid> get-all-signal-data
Ausgabe:
  • duty-cycle – Typ: Int Array, Länge: 4, Einheit: 1/100 %, Wertebereich: [0 bis 10000]
  • period – Typ: Int Array, Länge: 4, Einheit: 1 ns, Wertebereich: [0 bis 264 - 1]
  • frequency – Typ: Int Array, Länge: 4, Einheit: 1/1000 Hz, Wertebereich: [0 bis 232 - 1]
  • value – Typ: Bool Array, Länge: 4

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

tinkerforge call industrial-counter-bricklet <uid> set-counter-active <channel> <active>
Parameter:
  • <channel> – Typ: Int, Wertebereich: Siehe Symbole
  • <active> – Typ: Bool, Standardwert: true
Ausgabe:
  • keine Ausgabe

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

true = aktivieren, false = deaktivieren.

Standardmäßig sind alle Kanäle aktiviert.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für <channel>:

  • channel-0 = 0
  • channel-1 = 1
  • channel-2 = 2
  • channel-3 = 3
tinkerforge call industrial-counter-bricklet <uid> set-all-counter-active <active>
Parameter:
  • <active> – Typ: Bool Array, Länge: 4, Standardwert: true,true,true,true
Ausgabe:
  • keine Ausgabe

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

true = aktivieren, false = deaktivieren.

Standardmäßig sind alle Kanäle aktiviert.

tinkerforge call industrial-counter-bricklet <uid> get-counter-active <channel>
Parameter:
  • <channel> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • active – Typ: Bool, Standardwert: true

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

true = aktiviert, false = deaktiviert.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für <channel>:

  • channel-0 = 0
  • channel-1 = 1
  • channel-2 = 2
  • channel-3 = 3
tinkerforge call industrial-counter-bricklet <uid> get-all-counter-active
Ausgabe:
  • active – Typ: Bool Array, Länge: 4, Standardwert: true,true,true,true

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

true = aktiviert, false = deaktiviert.

tinkerforge call industrial-counter-bricklet <uid> set-counter-configuration <channel> <count-edge> <count-direction> <duty-cycle-prescaler> <frequency-integration-time>
Parameter:
  • <channel> – Typ: Int, Wertebereich: Siehe Symbole
  • <count-edge> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
  • <count-direction> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
  • <duty-cycle-prescaler> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
  • <frequency-integration-time> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
Ausgabe:
  • keine Ausgabe

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.
  • 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.
  • Tastverhältnis Prescaler: Setzt einen Teiler für die interne Clock. Siehe hier für weitere Details.
  • Frequenz-Integration: Setzt die Integrationszeit für die Frequenzmessung. Siehe hier für weitere Details.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für <channel>:

  • channel-0 = 0
  • channel-1 = 1
  • channel-2 = 2
  • channel-3 = 3

Für <count-edge>:

  • count-edge-rising = 0
  • count-edge-falling = 1
  • count-edge-both = 2

Für <count-direction>:

  • count-direction-up = 0
  • count-direction-down = 1
  • count-direction-external-up = 2
  • count-direction-external-down = 3

Für <duty-cycle-prescaler>:

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

Für <frequency-integration-time>:

  • frequency-integration-time-128-ms = 0
  • frequency-integration-time-256-ms = 1
  • frequency-integration-time-512-ms = 2
  • frequency-integration-time-1024-ms = 3
  • frequency-integration-time-2048-ms = 4
  • frequency-integration-time-4096-ms = 5
  • frequency-integration-time-8192-ms = 6
  • frequency-integration-time-16384-ms = 7
  • frequency-integration-time-32768-ms = 8
tinkerforge call industrial-counter-bricklet <uid> get-counter-configuration <channel>
Parameter:
  • <channel> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • count-edge – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
  • count-direction – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
  • duty-cycle-prescaler – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
  • frequency-integration-time – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

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

Die folgenden Symbole sind für diese Funktion verfügbar:

Für <channel>:

  • channel-0 = 0
  • channel-1 = 1
  • channel-2 = 2
  • channel-3 = 3

Für count-edge:

  • count-edge-rising = 0
  • count-edge-falling = 1
  • count-edge-both = 2

Für count-direction:

  • count-direction-up = 0
  • count-direction-down = 1
  • count-direction-external-up = 2
  • count-direction-external-down = 3

Für duty-cycle-prescaler:

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

Für frequency-integration-time:

  • frequency-integration-time-128-ms = 0
  • frequency-integration-time-256-ms = 1
  • frequency-integration-time-512-ms = 2
  • frequency-integration-time-1024-ms = 3
  • frequency-integration-time-2048-ms = 4
  • frequency-integration-time-4096-ms = 5
  • frequency-integration-time-8192-ms = 6
  • frequency-integration-time-16384-ms = 7
  • frequency-integration-time-32768-ms = 8
tinkerforge call industrial-counter-bricklet <uid> set-channel-led-config <channel> <config>
Parameter:
  • <channel> – Typ: Int, Wertebereich: Siehe Symbole
  • <config> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
Ausgabe:
  • keine Ausgabe

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.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für <channel>:

  • channel-0 = 0
  • channel-1 = 1
  • channel-2 = 2
  • channel-3 = 3

Für <config>:

  • channel-led-config-off = 0
  • channel-led-config-on = 1
  • channel-led-config-show-heartbeat = 2
  • channel-led-config-show-channel-status = 3
tinkerforge call industrial-counter-bricklet <uid> get-channel-led-config <channel>
Parameter:
  • <channel> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • config – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Kanal-LED-Konfiguration zurück, wie von set-channel-led-config gesetzt.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für <channel>:

  • channel-0 = 0
  • channel-1 = 1
  • channel-2 = 2
  • channel-3 = 3

Für config:

  • channel-led-config-off = 0
  • channel-led-config-on = 1
  • channel-led-config-show-heartbeat = 2
  • channel-led-config-show-channel-status = 3

Fortgeschrittene Funktionen

tinkerforge call industrial-counter-bricklet <uid> get-spitfp-error-count
Ausgabe:
  • error-count-ack-checksum – Typ: Int, Wertebereich: [0 bis 232 - 1]
  • error-count-message-checksum – Typ: Int, Wertebereich: [0 bis 232 - 1]
  • error-count-frame – Typ: Int, Wertebereich: [0 bis 232 - 1]
  • error-count-overflow – Typ: Int, 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.

tinkerforge call industrial-counter-bricklet <uid> set-bootloader-mode <mode>
Parameter:
  • <mode> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • status – Typ: Int, Wertebereich: Siehe Symbole

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 Symbole sind für diese Funktion verfügbar:

Für <mode>:

  • bootloader-mode-bootloader = 0
  • bootloader-mode-firmware = 1
  • bootloader-mode-bootloader-wait-for-reboot = 2
  • bootloader-mode-firmware-wait-for-reboot = 3
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4

Für status:

  • bootloader-status-ok = 0
  • bootloader-status-invalid-mode = 1
  • bootloader-status-no-change = 2
  • bootloader-status-entry-function-not-present = 3
  • bootloader-status-device-identifier-incorrect = 4
  • bootloader-status-crc-mismatch = 5
tinkerforge call industrial-counter-bricklet <uid> get-bootloader-mode
Ausgabe:
  • mode – Typ: Int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe set-bootloader-mode.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für mode:

  • bootloader-mode-bootloader = 0
  • bootloader-mode-firmware = 1
  • bootloader-mode-bootloader-wait-for-reboot = 2
  • bootloader-mode-firmware-wait-for-reboot = 3
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4
tinkerforge call industrial-counter-bricklet <uid> set-write-firmware-pointer <pointer>
Parameter:
  • <pointer> – Typ: Int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Ausgabe:
  • keine Ausgabe

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.

tinkerforge call industrial-counter-bricklet <uid> write-firmware <data>
Parameter:
  • <data> – Typ: Int Array, Länge: 64, Wertebereich: [0 bis 255]
Ausgabe:
  • status – Typ: Int, 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.

tinkerforge call industrial-counter-bricklet <uid> set-status-led-config <config>
Parameter:
  • <config> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
Ausgabe:
  • keine Ausgabe

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 Symbole sind für diese Funktion verfügbar:

Für <config>:

  • status-led-config-off = 0
  • status-led-config-on = 1
  • status-led-config-show-heartbeat = 2
  • status-led-config-show-status = 3
tinkerforge call industrial-counter-bricklet <uid> get-status-led-config
Ausgabe:
  • config – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von set-status-led-config gesetzt.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für config:

  • status-led-config-off = 0
  • status-led-config-on = 1
  • status-led-config-show-heartbeat = 2
  • status-led-config-show-status = 3
tinkerforge call industrial-counter-bricklet <uid> get-chip-temperature
Ausgabe:
  • temperature – Typ: Int, 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.

tinkerforge call industrial-counter-bricklet <uid> reset
Ausgabe:
  • keine Ausgabe

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.

tinkerforge call industrial-counter-bricklet <uid> write-uid <uid>
Parameter:
  • <uid> – Typ: Int, Wertebereich: [0 bis 232 - 1]
Ausgabe:
  • keine Ausgabe

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.

tinkerforge call industrial-counter-bricklet <uid> read-uid
Ausgabe:
  • uid – Typ: Int, 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.

tinkerforge call industrial-counter-bricklet <uid> get-identity
Ausgabe:
  • uid – Typ: String, Länge: bis zu 8
  • connected-uid – Typ: String, Länge: bis zu 8
  • position – Typ: Char, Wertebereich: [a bis h, i, z]
  • hardware-version – Typ: Int Array, Länge: 3
    • 0: major – Typ: Int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Int, Wertebereich: [0 bis 255]
  • firmware-version – Typ: Int Array, Länge: 3
    • 0: major – Typ: Int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Int, Wertebereich: [0 bis 255]
  • device-identifier – Typ: Int, 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

tinkerforge call industrial-counter-bricklet <uid> set-all-counter-callback-configuration <period> <value-has-to-change>
Parameter:
  • <period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • <value-has-to-change> – Typ: Bool, Standardwert: false
Ausgabe:
  • keine Ausgabe

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

tinkerforge call industrial-counter-bricklet <uid> get-all-counter-callback-configuration
Ausgabe:
  • period – Typ: Int, 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.

tinkerforge call industrial-counter-bricklet <uid> set-all-signal-data-callback-configuration <period> <value-has-to-change>
Parameter:
  • <period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • <value-has-to-change> – Typ: Bool, Standardwert: false
Ausgabe:
  • keine Ausgabe

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

tinkerforge call industrial-counter-bricklet <uid> get-all-signal-data-callback-configuration
Ausgabe:
  • period – Typ: Int, 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

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:

tinkerforge dispatch industrial-counter-bricklet <uid> example

Die verfügbaren Callbacks werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

tinkerforge dispatch industrial-counter-bricklet <uid> all-counter
Ausgabe:
  • counter – Typ: Int Array, Länge: 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 Parameter sind der gleiche wie get-all-counter.

tinkerforge dispatch industrial-counter-bricklet <uid> all-signal-data
Ausgabe:
  • duty-cycle – Typ: Int Array, Länge: 4, Einheit: 1/100 %, Wertebereich: [0 bis 10000]
  • period – Typ: Int Array, Länge: 4, Einheit: 1 ns, Wertebereich: [0 bis 264 - 1]
  • frequency – Typ: Int Array, Länge: 4, Einheit: 1/1000 Hz, Wertebereich: [0 bis 232 - 1]
  • value – Typ: Bool Array, Länge: 4

Dieser Callback wird periodisch ausgelöst abhängig von der mittels set-all-signal-data-callback-configuration gesetzten Konfiguration

Die Parameter sind der gleiche wie get-all-signal-data.