Dies ist die Beschreibung der MQTT API Bindings 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.
Eine Installationanleitung für die MQTT API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
1 2 3 4 5 6 | # Change XYZ to the UID of your Industrial Dual Analog In Bricklet 2.0
setup:
# Get current voltage from channel 0
subscribe to tinkerforge/response/industrial_dual_analog_in_v2_bricklet/XYZ/get_voltage
publish '{"channel": 0}' to tinkerforge/request/industrial_dual_analog_in_v2_bricklet/XYZ/get_voltage
|
Download (example-callback.txt)
1 2 3 4 5 6 7 8 9 | # Change XYZ to the UID of your Industrial Dual Analog In Bricklet 2.0
setup:
# Handle incoming voltage callbacks
subscribe to tinkerforge/callback/industrial_dual_analog_in_v2_bricklet/XYZ/voltage
publish '{"register": true}' to tinkerforge/register/industrial_dual_analog_in_v2_bricklet/XYZ/voltage # Register voltage callback
# Set period for voltage (channel 0) callback to 1s (1000ms) without a threshold
publish '{"channel": 0, "period": 1000, "value_has_to_change": false, "option": "off", "min": 0, "max": 0}' to tinkerforge/request/industrial_dual_analog_in_v2_bricklet/XYZ/set_voltage_callback_configuration
|
Download (example-threshold.txt)
1 2 3 4 5 6 7 8 9 10 | # Change XYZ to the UID of your Industrial Dual Analog In Bricklet 2.0
setup:
# Handle incoming voltage callbacks
subscribe to tinkerforge/callback/industrial_dual_analog_in_v2_bricklet/XYZ/voltage
publish '{"register": true}' to tinkerforge/register/industrial_dual_analog_in_v2_bricklet/XYZ/voltage # Register voltage callback
# Configure threshold for voltage (channel 0) "greater than 10 V"
# with a debounce period of 10s (10000ms)
publish '{"channel": 0, "period": 10000, "value_has_to_change": false, "option": "greater", "min": 10000, "max": 0}' to tinkerforge/request/industrial_dual_analog_in_v2_bricklet/XYZ/set_voltage_callback_configuration
|
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/...
.
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.
request/
industrial_dual_analog_in_v2_bricklet/
<UID>/
get_voltage
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Spannung für den übergebenen Kanal zurück.
Wenn der Wert periodisch benötigt wird, kann auch der register/industrial_dual_analog_in_v2_bricklet/<UID>/voltage
Callback
verwendet werden. Der Callback wird mit der Funktion
request/industrial_dual_analog_in_v2_bricklet/<UID>/set_voltage_callback_configuration
konfiguriert.
request/
industrial_dual_analog_in_v2_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 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 request/industrial_dual_analog_in_v2_bricklet/<UID>/set_channel_led_status_config
eingestellt werden.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
request/
industrial_dual_analog_in_v2_bricklet/
<UID>/
get_channel_led_config
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Kanal-LED-Konfiguration zurück, wie von request/industrial_dual_analog_in_v2_bricklet/<UID>/set_channel_led_config
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
request/
industrial_dual_analog_in_v2_bricklet/
<UID>/
set_channel_led_status_config
¶Anfrage: |
|
---|---|
Antwort: |
|
Setzt die Kanal-LED-Status-Konfiguration. Diese Einstellung wird verwendet wenn
die Kanal-LED auf Kanalstatus eingestellt ist, siehe request/industrial_dual_analog_in_v2_bricklet/<UID>/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 Symbole sind für diese Funktion verfügbar:
Für config:
request/
industrial_dual_analog_in_v2_bricklet/
<UID>/
get_channel_led_status_config
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Kanal-LED-Status-Konfiguration zurück, wie von
request/industrial_dual_analog_in_v2_bricklet/<UID>/set_channel_led_status_config
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
request/
industrial_dual_analog_in_v2_bricklet/
<UID>/
set_sample_rate
¶Anfrage: |
|
---|---|
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 Symbole sind für diese Funktion verfügbar:
Für rate:
request/
industrial_dual_analog_in_v2_bricklet/
<UID>/
get_sample_rate
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Abtastrate zurück, wie von request/industrial_dual_analog_in_v2_bricklet/<UID>/set_sample_rate
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für rate:
request/
industrial_dual_analog_in_v2_bricklet/
<UID>/
set_calibration
¶Anfrage: |
|
---|---|
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.
request/
industrial_dual_analog_in_v2_bricklet/
<UID>/
get_calibration
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Kalibrierung zurück, wie von request/industrial_dual_analog_in_v2_bricklet/<UID>/set_calibration
gesetzt.
request/
industrial_dual_analog_in_v2_bricklet/
<UID>/
get_adc_values
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die ADC-Werte des MCP3911 ICs zurück. Diese Funktion
wird für die Kalibrierung benötigt, siehe request/industrial_dual_analog_in_v2_bricklet/<UID>/set_calibration
.
request/
industrial_dual_analog_in_v2_bricklet/
<UID>/
get_all_voltages
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Spannung aller Kanäle zurück.
Wenn der Wert periodisch benötigt wird, kann auch der register/industrial_dual_analog_in_v2_bricklet/<UID>/all_voltages
Callback
verwendet werden. Der Callback wird mit der Funktion
request/industrial_dual_analog_in_v2_bricklet/<UID>/set_all_voltages_callback_configuration
konfiguriert.
Neu in Version 2.0.6 (Plugin).
request/
industrial_dual_analog_in_v2_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_dual_analog_in_v2_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_dual_analog_in_v2_bricklet/
<UID>/
get_status_led_config
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Konfiguration zurück, wie von request/industrial_dual_analog_in_v2_bricklet/<UID>/set_status_led_config
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
request/
industrial_dual_analog_in_v2_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_dual_analog_in_v2_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_dual_analog_in_v2_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 Dual Analog In 2.0.
request/
industrial_dual_analog_in_v2_bricklet/
<UID>/
set_voltage_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Die Periode ist die Periode mit der der register/industrial_dual_analog_in_v2_bricklet/<UID>/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 register/industrial_dual_analog_in_v2_bricklet/<UID>/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 Symbole sind für diese Funktion verfügbar:
Für option:
request/
industrial_dual_analog_in_v2_bricklet/
<UID>/
get_voltage_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Callback-Konfiguration zurück, wie mittels request/industrial_dual_analog_in_v2_bricklet/<UID>/set_voltage_callback_configuration
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für option:
request/
industrial_dual_analog_in_v2_bricklet/
<UID>/
set_all_voltages_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Die Periode ist die Periode mit der der register/industrial_dual_analog_in_v2_bricklet/<UID>/all_voltages
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 sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn ein 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 der Werte.
Neu in Version 2.0.6 (Plugin).
request/
industrial_dual_analog_in_v2_bricklet/
<UID>/
get_all_voltages_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Callback-Konfiguration zurück, wie mittels
request/industrial_dual_analog_in_v2_bricklet/<UID>/set_all_voltages_callback_configuration
gesetzt.
Neu in Version 2.0.6 (Plugin).
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_dual_analog_in_v2_bricklet/
<UID>/
voltage
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/industrial_dual_analog_in_v2_bricklet/<UID>/voltage[/<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_dual_analog_in_v2_bricklet/<UID>/voltage[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
request/industrial_dual_analog_in_v2_bricklet/<UID>/set_voltage_callback_configuration
gesetzten Konfiguration
Der Payload des Callbacks ist der gleiche wie request/industrial_dual_analog_in_v2_bricklet/<UID>/get_voltage
.
register/
industrial_dual_analog_in_v2_bricklet/
<UID>/
all_voltages
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/industrial_dual_analog_in_v2_bricklet/<UID>/all_voltages[/<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_dual_analog_in_v2_bricklet/<UID>/all_voltages[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
request/industrial_dual_analog_in_v2_bricklet/<UID>/set_all_voltages_callback_configuration
gesetzten Konfiguration
Die Payload-Member des Callbacks sind der gleiche wie request/industrial_dual_analog_in_v2_bricklet/<UID>/get_all_voltages
.
Neu in Version 2.0.6 (Plugin).
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_dual_analog_in_v2_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_dual_analog_in_v2_bricklet/
<UID>/
get_bootloader_mode
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt den aktuellen Bootloader-Modus zurück, siehe request/industrial_dual_analog_in_v2_bricklet/<UID>/set_bootloader_mode
.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für mode:
request/
industrial_dual_analog_in_v2_bricklet/
<UID>/
set_write_firmware_pointer
¶Anfrage: |
|
---|---|
Antwort: |
|
Setzt den Firmware-Pointer für request/industrial_dual_analog_in_v2_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_dual_analog_in_v2_bricklet/
<UID>/
write_firmware
¶Anfrage: |
|
---|---|
Antwort: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
request/industrial_dual_analog_in_v2_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_dual_analog_in_v2_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_dual_analog_in_v2_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.