MQTT - Industrial Counter Bricklet

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.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Callback

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

Simple

Download (example-simple.txt)

 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

API

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

Grundfunktionen

request/industrial_counter_bricklet/<UID>/get_counter
Anfrage:
  • channel – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • counter – Typ: int, Wertebereich: [-140735340871680 bis 140735340871679]

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:

  • "0" = 0
  • "1" = 1
  • "2" = 2
  • "3" = 3
request/industrial_counter_bricklet/<UID>/get_all_counter
Anfrage:
  • keine Nutzdaten
Antwort:
  • counter – Typ: [int, ...], Länge: 4, Wertebereich: [-140735340871680 bis 140735340871679]

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

request/industrial_counter_bricklet/<UID>/set_counter
Anfrage:
  • channel – Typ: int, Wertebereich: Siehe Symbole
  • counter – Typ: int, Wertebereich: [-140735340871680 bis 140735340871679]
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 Symbole sind für diese Funktion verfügbar:

Für channel:

  • "0" = 0
  • "1" = 1
  • "2" = 2
  • "3" = 3
request/industrial_counter_bricklet/<UID>/set_all_counter
Anfrage:
  • counter – Typ: [int, ...], Länge: 4, Wertebereich: [-140735340871680 bis 140735340871679]
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.

request/industrial_counter_bricklet/<UID>/get_signal_data
Anfrage:
  • channel – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • 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:

  • "0" = 0
  • "1" = 1
  • "2" = 2
  • "3" = 3
request/industrial_counter_bricklet/<UID>/get_all_signal_data
Anfrage:
  • keine Nutzdaten
Antwort:
  • duty_cycle – Typ: [int, ...], Länge: 4, Einheit: 1/100 %, Wertebereich: [0 bis 10000]
  • period – Typ: [int, ...], Länge: 4, Einheit: 1 ns, Wertebereich: [0 bis 264 - 1]
  • frequency – Typ: [int, ...], Länge: 4, Einheit: 1/1000 Hz, Wertebereich: [0 bis 232 - 1]
  • value – Typ: [bool, ...], Länge: 4

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:
  • channel – Typ: int, Wertebereich: Siehe Symbole
  • active – Typ: bool, Standardwert: true
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 Symbole sind für diese Funktion verfügbar:

Für channel:

  • "0" = 0
  • "1" = 1
  • "2" = 2
  • "3" = 3
request/industrial_counter_bricklet/<UID>/set_all_counter_active
Anfrage:
  • active – Typ: [bool, ...], Länge: 4, Standardwert: [true,true,true,true]
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.

request/industrial_counter_bricklet/<UID>/get_counter_active
Anfrage:
  • channel – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • 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:

  • "0" = 0
  • "1" = 1
  • "2" = 2
  • "3" = 3
request/industrial_counter_bricklet/<UID>/get_all_counter_active
Anfrage:
  • keine Nutzdaten
Antwort:
  • active – Typ: [bool, ...], Länge: 4, Standardwert: [true,true,true,true]

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

true = aktiviert, false = deaktiviert.

request/industrial_counter_bricklet/<UID>/set_counter_configuration
Anfrage:
  • 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
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.
  • 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:

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

Für count_edge:

  • "rising" = 0
  • "falling" = 1
  • "both" = 2

Für count_direction:

  • "up" = 0
  • "down" = 1
  • "external_up" = 2
  • "external_down" = 3

Für duty_cycle_prescaler:

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

Für frequency_integration_time:

  • "128_ms" = 0
  • "256_ms" = 1
  • "512_ms" = 2
  • "1024_ms" = 3
  • "2048_ms" = 4
  • "4096_ms" = 5
  • "8192_ms" = 6
  • "16384_ms" = 7
  • "32768_ms" = 8
request/industrial_counter_bricklet/<UID>/get_counter_configuration
Anfrage:
  • channel – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • 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 request/industrial_counter_bricklet/<UID>/set_counter_configuration gesetzt wurde.

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

Für channel:

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

Für count_edge:

  • "rising" = 0
  • "falling" = 1
  • "both" = 2

Für count_direction:

  • "up" = 0
  • "down" = 1
  • "external_up" = 2
  • "external_down" = 3

Für duty_cycle_prescaler:

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

Für frequency_integration_time:

  • "128_ms" = 0
  • "256_ms" = 1
  • "512_ms" = 2
  • "1024_ms" = 3
  • "2048_ms" = 4
  • "4096_ms" = 5
  • "8192_ms" = 6
  • "16384_ms" = 7
  • "32768_ms" = 8
request/industrial_counter_bricklet/<UID>/set_channel_led_config
Anfrage:
  • channel – Typ: int, Wertebereich: Siehe Symbole
  • config – Typ: int, Wertebereich: Siehe Symbole, 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 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:

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

Für config:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_channel_status" = 3
request/industrial_counter_bricklet/<UID>/get_channel_led_config
Anfrage:
  • channel – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

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:

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

Für config:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_channel_status" = 3

Fortgeschrittene Funktionen

request/industrial_counter_bricklet/<UID>/get_spitfp_error_count
Anfrage:
  • keine Nutzdaten
Antwort:
  • 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.

request/industrial_counter_bricklet/<UID>/set_status_led_config
Anfrage:
  • config – Typ: int, Wertebereich: Siehe Symbole, 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 Symbole sind für diese Funktion verfügbar:

Für config:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_status" = 3
request/industrial_counter_bricklet/<UID>/get_status_led_config
Anfrage:
  • keine Nutzdaten
Antwort:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

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:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_status" = 3
request/industrial_counter_bricklet/<UID>/get_chip_temperature
Anfrage:
  • keine Nutzdaten
Antwort:
  • 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.

request/industrial_counter_bricklet/<UID>/reset
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.

request/industrial_counter_bricklet/<UID>/get_identity
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: string, Länge: bis zu 8
  • connected_uid – Typ: string, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ["a" bis "h", "z"]
  • hardware_version – Typ: [int, ...], 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, ...], 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]
  • _display_name – Typ: string

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.

Konfigurationsfunktionen für Callbacks

request/industrial_counter_bricklet/<UID>/set_all_counter_callback_configuration
Anfrage:
  • period – Typ: int, 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 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:
  • keine Nutzdaten
Antwort:
  • 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 request/industrial_counter_bricklet/<UID>/set_all_counter_callback_configuration gesetzt.

request/industrial_counter_bricklet/<UID>/set_all_signal_data_callback_configuration
Anfrage:
  • period – Typ: int, 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 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:
  • keine Nutzdaten
Antwort:
  • 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 request/industrial_counter_bricklet/<UID>/set_all_signal_data_callback_configuration gesetzt.

Callbacks

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:
  • register – Typ: bool
Callback-Antwort:
  • counter – Typ: [int, ...], Länge: 4, Wertebereich: [-140735340871680 bis 140735340871679]

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:
  • register – Typ: bool
Callback-Antwort:
  • duty_cycle – Typ: [int, ...], Länge: 4, Einheit: 1/100 %, Wertebereich: [0 bis 10000]
  • period – Typ: [int, ...], Länge: 4, Einheit: 1 ns, Wertebereich: [0 bis 264 - 1]
  • frequency – Typ: [int, ...], Länge: 4, Einheit: 1/1000 Hz, Wertebereich: [0 bis 232 - 1]
  • value – Typ: [bool, ...], Länge: 4

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

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:
  • mode – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • 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" = 0
  • "firmware" = 1
  • "bootloader_wait_for_reboot" = 2
  • "firmware_wait_for_reboot" = 3
  • "firmware_wait_for_erase_and_reboot" = 4

Für status:

  • "ok" = 0
  • "invalid_mode" = 1
  • "no_change" = 2
  • "entry_function_not_present" = 3
  • "device_identifier_incorrect" = 4
  • "crc_mismatch" = 5
request/industrial_counter_bricklet/<UID>/get_bootloader_mode
Anfrage:
  • keine Nutzdaten
Antwort:
  • mode – Typ: int, Wertebereich: Siehe Symbole

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:

  • "bootloader" = 0
  • "firmware" = 1
  • "bootloader_wait_for_reboot" = 2
  • "firmware_wait_for_reboot" = 3
  • "firmware_wait_for_erase_and_reboot" = 4
request/industrial_counter_bricklet/<UID>/set_write_firmware_pointer
Anfrage:
  • pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine 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:
  • data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Antwort:
  • status – Typ: int, Wertebereich: [0 bis 255]

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:
  • uid – Typ: int, 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.

request/industrial_counter_bricklet/<UID>/read_uid
Anfrage:
  • keine Nutzdaten
Antwort:
  • 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.