MQTT - Hall Effect Bricklet 2.0¶

Counter¶

Download (example-counter.txt)

1
2
3
4
5
6

# Change XYZ to the UID of your Hall Effect Bricklet 2.0

setup:
    # Get current count without counter reset
    subscribe to tinkerforge/response/hall_effect_v2_bricklet/XYZ/get_counter
    publish '{"reset_counter": false}' to tinkerforge/request/hall_effect_v2_bricklet/XYZ/get_counter

Magnetic Flux Density¶

Download (example-magnetic-flux-density.txt)

1
2
3
4
5
6

# Change XYZ to the UID of your Hall Effect Bricklet 2.0

setup:
    # Get current Magnetic Flux Density
    subscribe to tinkerforge/response/hall_effect_v2_bricklet/XYZ/get_magnetic_flux_density
    publish '' to tinkerforge/request/hall_effect_v2_bricklet/XYZ/get_magnetic_flux_density

Counter Callback¶

Download (example-counter-callback.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

# Change XYZ to the UID of your Hall Effect Bricklet 2.0

setup:
    # Configure counter with ±3000µT threshold and 10ms debounce
    publish '{"high_threshold": 3000, "low_threshold": -3000, "debounce": 10000}' to tinkerforge/request/hall_effect_v2_bricklet/XYZ/set_counter_config

    # Handle incoming counter callbacks
    subscribe to tinkerforge/callback/hall_effect_v2_bricklet/XYZ/counter
    publish '{"register": true}' to tinkerforge/register/hall_effect_v2_bricklet/XYZ/counter # Register counter callback

    # Set period for counter callback to 0.1s (100ms)
    publish '{"period": 100, "value_has_to_change": true}' to tinkerforge/request/hall_effect_v2_bricklet/XYZ/set_counter_callback_configuration

Grundfunktionen¶

request/hall_effect_v2_bricklet/<UID>/get_magnetic_flux_density¶

Anfrage:	keine Nutzdaten
Antwort:	magnetic_flux_density – Typ: int, Einheit: 1 µT, Wertebereich: [-7000 bis 7000]

Gibt die magnetische Flussdichte (magnetische Induktion) zurück.

Wenn der Wert periodisch benötigt wird, kann auch der register/hall_effect_v2_bricklet/<UID>/magnetic_flux_density Callback verwendet werden. Der Callback wird mit der Funktion request/hall_effect_v2_bricklet/<UID>/set_magnetic_flux_density_callback_configuration konfiguriert.

request/hall_effect_v2_bricklet/<UID>/get_counter¶

Anfrage:	reset_counter – Typ: bool
Antwort:	count – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt den aktuellen Wert des Zählers zurück.

Die Schwellwerte (low/high) und Entprellzeit können per request/hall_effect_v2_bricklet/<UID>/set_counter_config eingestellt werden.

Wenn reset counter auf true gesetzt wird, wird der Zählerstand direkt nach dem Auslesen auf 0 zurückgesetzt.

Wenn der Zähler periodisch benötigt wird, kann auch der register/hall_effect_v2_bricklet/<UID>/counter Callback verwendet werden. Der Callback wird mit der Funktion request/hall_effect_v2_bricklet/<UID>/set_counter_callback_configuration konfiguriert.

request/hall_effect_v2_bricklet/<UID>/set_counter_config¶

Anfrage:	high_threshold – Typ: int, Einheit: 1 µT, Wertebereich: [-215 bis 215 - 1], Standardwert: 2000 low_threshold – Typ: int, Einheit: 1 µT, Wertebereich: [-215 bis 215 - 1], Standardwert: -2000 debounce – Typ: int, Einheit: 1 µs, Wertebereich: [0 bis 1000000], Standardwert: 100000
Antwort:	keine Antwort

Setzt einen unteren und einen oberen Schwellwert (threshold) sowie eine Entprellzeit (debounce).

Wenn die gemessene magnetische Flussdichte über den oberen Schwellwert oder unter den unteren Schwellwert wandert, wird der Zählerstand des Zählers (siehe request/hall_effect_v2_bricklet/<UID>/get_counter) um 1 erhöht.

Die Entprellzeit ist die Minimalzeit zwischen zwei Zählererhöhungen.

request/hall_effect_v2_bricklet/<UID>/get_counter_config¶

Anfrage:	keine Nutzdaten
Antwort:	high_threshold – Typ: int, Einheit: 1 µT, Wertebereich: [-215 bis 215 - 1], Standardwert: 2000 low_threshold – Typ: int, Einheit: 1 µT, Wertebereich: [-215 bis 215 - 1], Standardwert: -2000 debounce – Typ: int, Einheit: 1 µs, Wertebereich: [0 bis 1000000], Standardwert: 100000

Gibt die Zähler-Konfiguration zurück, wie von request/hall_effect_v2_bricklet/<UID>/set_counter_config gesetzt.

Fortgeschrittene Funktionen¶

request/hall_effect_v2_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/hall_effect_v2_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/hall_effect_v2_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/hall_effect_v2_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/hall_effect_v2_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/hall_effect_v2_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/hall_effect_v2_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 Hall Effect 2.0.

Konfigurationsfunktionen für Callbacks¶

request/hall_effect_v2_bricklet/<UID>/set_magnetic_flux_density_callback_configuration¶

Anfrage:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x" min – Typ: int, Einheit: 1 µT, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: int, Einheit: 1 µT, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Antwort:	keine Antwort

Die Periode ist die Periode mit der der register/hall_effect_v2_bricklet/<UID>/magnetic_flux_density 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/hall_effect_v2_bricklet/<UID>/magnetic_flux_density 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:

• "off" = "x"
• "outside" = "o"
• "inside" = "i"
• "smaller" = "<"
• "greater" = ">"

request/hall_effect_v2_bricklet/<UID>/get_magnetic_flux_density_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 option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x" min – Typ: int, Einheit: 1 µT, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: int, Einheit: 1 µT, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels request/hall_effect_v2_bricklet/<UID>/set_magnetic_flux_density_callback_configuration gesetzt.

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

Für option:

• "off" = "x"
• "outside" = "o"
• "inside" = "i"
• "smaller" = "<"
• "greater" = ">"

request/hall_effect_v2_bricklet/<UID>/set_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/hall_effect_v2_bricklet/<UID>/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 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.

request/hall_effect_v2_bricklet/<UID>/get_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/hall_effect_v2_bricklet/<UID>/set_counter_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.

register/hall_effect_v2_bricklet/<UID>/magnetic_flux_density¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	magnetic_flux_density – Typ: int, Einheit: 1 µT, Wertebereich: [-7000 bis 7000]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/hall_effect_v2_bricklet/<UID>/magnetic_flux_density[/<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/hall_effect_v2_bricklet/<UID>/magnetic_flux_density[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird periodisch ausgelöst abhängig von der mittels request/hall_effect_v2_bricklet/<UID>/set_magnetic_flux_density_callback_configuration gesetzten Konfiguration

Der Payload des Callbacks ist der gleiche wie request/hall_effect_v2_bricklet/<UID>/get_magnetic_flux_density.

register/hall_effect_v2_bricklet/<UID>/counter¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	count – Typ: int, Wertebereich: [0 bis 232 - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/hall_effect_v2_bricklet/<UID>/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/hall_effect_v2_bricklet/<UID>/counter[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird periodisch ausgelöst abhängig von der mittels request/hall_effect_v2_bricklet/<UID>/set_counter_callback_configuration gesetzten Konfiguration

Der Zählerstand ist der gleiche, der auch per request/hall_effect_v2_bricklet/<UID>/get_counter abgefragt werden kann.

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/hall_effect_v2_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/hall_effect_v2_bricklet/<UID>/get_bootloader_mode¶

Anfrage:	keine Nutzdaten
Antwort:	mode – Typ: int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe request/hall_effect_v2_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/hall_effect_v2_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/hall_effect_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/hall_effect_v2_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/hall_effect_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/hall_effect_v2_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/hall_effect_v2_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.