Dies ist die Beschreibung der MQTT 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 MQTT API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (example-callback.txt)
1 2 3 4 5 6 7 8 9 | # Change XYZ to the UID of your Industrial Counter Bricklet
setup:
# Handle incoming all counter callbacks
subscribe to tinkerforge/callback/industrial_counter_bricklet/XYZ/all_counter
publish '{"register": true}' to tinkerforge/register/industrial_counter_bricklet/XYZ/all_counter # Register all_counter callback
# Set period for all counter callback to 1s (1000ms)
publish '{"period": 1000, "value_has_to_change": true}' to tinkerforge/request/industrial_counter_bricklet/XYZ/set_all_counter_callback_configuration
|
1 2 3 4 5 6 7 8 9 10 | # Change XYZ to the UID of your Industrial Counter Bricklet
setup:
# Get current counter from channel 0
subscribe to tinkerforge/response/industrial_counter_bricklet/XYZ/get_counter
publish '{"channel": "0"}' to tinkerforge/request/industrial_counter_bricklet/XYZ/get_counter
# Get current signal data from channel 0
subscribe to tinkerforge/response/industrial_counter_bricklet/XYZ/get_signal_data
publish '{"channel": "0"}' to tinkerforge/request/industrial_counter_bricklet/XYZ/get_signal_data
|
Alle veröffentlichten Payloads an die und von den MQTT-Bindings sind im JSON Format.
Falls ein Fehler auftritt, veröffentlichen die Bindings ein JSON-Objekt, das die Fehlermeldung als _ERROR
-Member enthält.
Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/...
für .../request/...
und .../callback/...
für .../register/...
.
request/
industrial_counter_bricklet/
<UID>/
get_counter
¶Anfrage: |
|
---|---|
Antwort: |
|
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:
request/
industrial_counter_bricklet/
<UID>/
get_all_counter
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Zählerstände für alle vier Kanäle zurück.
request/
industrial_counter_bricklet/
<UID>/
set_counter
¶Anfrage: |
|
---|---|
Antwort: |
|
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:
request/
industrial_counter_bricklet/
<UID>/
set_all_counter
¶Anfrage: |
|
---|---|
Antwort: |
|
Setzt die Zählerstände für alle vier Kanäle.
Der Standardwert für die Zähler nach dem Starten ist 0.
request/
industrial_counter_bricklet/
<UID>/
get_signal_data
¶Anfrage: |
|
---|---|
Antwort: |
|
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:
request/
industrial_counter_bricklet/
<UID>/
get_all_signal_data
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Signaldaten (Tastverhältnis, Periode, Frequenz und Status) für alle vier Kanäle zurück.
request/
industrial_counter_bricklet/
<UID>/
set_counter_active
¶Anfrage: |
|
---|---|
Antwort: |
|
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:
request/
industrial_counter_bricklet/
<UID>/
set_all_counter_active
¶Anfrage: |
|
---|---|
Antwort: |
|
Aktiviert/Deaktiviert den Zähler für alle vier Kanäle.
true = aktivieren, false = deaktivieren.
Standardmäßig sind alle Kanäle aktiviert.
request/
industrial_counter_bricklet/
<UID>/
get_counter_active
¶Anfrage: |
|
---|---|
Antwort: |
|
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:
request/
industrial_counter_bricklet/
<UID>/
get_all_counter_active
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt den Zustand (aktiviert/deaktiviert) aller vier Zähler zurück.
true = aktiviert, false = deaktiviert.
request/
industrial_counter_bricklet/
<UID>/
set_counter_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Setzt die Zähler-Konfiguration für den gegebenen Kanal.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für channel:
Für count_edge:
Für count_direction:
Für duty_cycle_prescaler:
Für frequency_integration_time:
request/
industrial_counter_bricklet/
<UID>/
get_counter_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Zähler-Konfiguration zurück, wie Sie mittels
request/industrial_counter_bricklet/<UID>/set_counter_configuration
gesetzt wurde.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für channel:
Für count_edge:
Für count_direction:
Für duty_cycle_prescaler:
Für frequency_integration_time:
request/
industrial_counter_bricklet/
<UID>/
set_channel_led_config
¶Anfrage: |
|
---|---|
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.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für channel:
Für config:
request/
industrial_counter_bricklet/
<UID>/
get_channel_led_config
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Kanal-LED-Konfiguration zurück, wie von request/industrial_counter_bricklet/<UID>/set_channel_led_config
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für channel:
Für config:
request/
industrial_counter_bricklet/
<UID>/
get_spitfp_error_count
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
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.
request/
industrial_counter_bricklet/
<UID>/
set_status_led_config
¶Anfrage: |
|
---|---|
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 Symbole sind für diese Funktion verfügbar:
Für config:
request/
industrial_counter_bricklet/
<UID>/
get_status_led_config
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Konfiguration zurück, wie von request/industrial_counter_bricklet/<UID>/set_status_led_config
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
request/
industrial_counter_bricklet/
<UID>/
get_chip_temperature
¶Anfrage: |
|
---|---|
Antwort: |
|
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.
request/
industrial_counter_bricklet/
<UID>/
reset
¶Anfrage: |
|
---|---|
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.
request/
industrial_counter_bricklet/
<UID>/
get_identity
¶Anfrage: |
|
---|---|
Antwort: |
|
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. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.
Der Display Name enthält den Anzeigenamen des Industrial Counter.
request/
industrial_counter_bricklet/
<UID>/
set_all_counter_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Die Periode ist die Periode mit der der register/industrial_counter_bricklet/<UID>/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.
request/
industrial_counter_bricklet/
<UID>/
get_all_counter_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Callback-Konfiguration zurück, wie mittels
request/industrial_counter_bricklet/<UID>/set_all_counter_callback_configuration
gesetzt.
request/
industrial_counter_bricklet/
<UID>/
set_all_signal_data_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Die Periode ist die Periode mit der der register/industrial_counter_bricklet/<UID>/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.
request/
industrial_counter_bricklet/
<UID>/
get_all_signal_data_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Callback-Konfiguration zurück, wie mittels
request/industrial_counter_bricklet/<UID>/set_all_signal_data_callback_configuration
gesetzt.
Callbacks können registriert werden um zeitkritische
oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann
mit dem entsprechenden .../register/...
-Topic und einem optionalen Suffix durchgeführt werden.
Mit diesem Suffix kann das Callback später deregistriert werden.
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.
register/
industrial_counter_bricklet/
<UID>/
all_counter
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/industrial_counter_bricklet/<UID>/all_counter[/<SUFFIX>]
-Topic hinzugefügt werden.
Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden.
Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.
Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/industrial_counter_bricklet/<UID>/all_counter[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
request/industrial_counter_bricklet/<UID>/set_all_counter_callback_configuration
gesetzten Konfiguration
Die Payload-Member des Callbacks sind der gleiche wie request/industrial_counter_bricklet/<UID>/get_all_counter
.
register/
industrial_counter_bricklet/
<UID>/
all_signal_data
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/industrial_counter_bricklet/<UID>/all_signal_data[/<SUFFIX>]
-Topic hinzugefügt werden.
Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden.
Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.
Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/industrial_counter_bricklet/<UID>/all_signal_data[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
request/industrial_counter_bricklet/<UID>/set_all_signal_data_callback_configuration
gesetzten Konfiguration
Die Payload-Member des Callbacks sind der gleiche wie request/industrial_counter_bricklet/<UID>/get_all_signal_data
.
Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.
request/
industrial_counter_bricklet/
<UID>/
set_bootloader_mode
¶Anfrage: |
|
---|---|
Antwort: |
|
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:
Für status:
request/
industrial_counter_bricklet/
<UID>/
get_bootloader_mode
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt den aktuellen Bootloader-Modus zurück, siehe request/industrial_counter_bricklet/<UID>/set_bootloader_mode
.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für mode:
request/
industrial_counter_bricklet/
<UID>/
set_write_firmware_pointer
¶Anfrage: |
|
---|---|
Antwort: |
|
Setzt den Firmware-Pointer für request/industrial_counter_bricklet/<UID>/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.
request/
industrial_counter_bricklet/
<UID>/
write_firmware
¶Anfrage: |
|
---|---|
Antwort: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
request/industrial_counter_bricklet/<UID>/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.
request/
industrial_counter_bricklet/
<UID>/
write_uid
¶Anfrage: |
|
---|---|
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.
request/
industrial_counter_bricklet/
<UID>/
read_uid
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.