MQTT - Hall Effect Bricklet

Dies ist die Beschreibung der MQTT API Bindings für das Hall Effect Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Hall Effect 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).

Simple

Download (example-simple.txt)

1
2
3
4
5
6
# Change XYZ to the UID of your Hall Effect Bricklet

setup:
    # Get current edge count without reset
    subscribe to tinkerforge/response/hall_effect_bricklet/XYZ/get_edge_count
    publish '{"reset_counter": false}' to tinkerforge/request/hall_effect_bricklet/XYZ/get_edge_count

Callback

Download (example-callback.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Change XYZ to the UID of your Hall Effect Bricklet

setup:
    # Handle incoming edge count callbacks
    subscribe to tinkerforge/callback/hall_effect_bricklet/XYZ/edge_count
    publish '{"register": true}' to tinkerforge/register/hall_effect_bricklet/XYZ/edge_count # Register edge_count callback
    
    # Set period for edge count callback to 0.05s (50ms)
    # Note: The edge count callback is only called every 0.05 seconds
    #       if the edge count has changed since the last call!
    publish '{"period": 50}' to tinkerforge/request/hall_effect_bricklet/XYZ/set_edge_count_callback_period

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/hall_effect_bricklet/<UID>/get_value
Anfrage:
  • keine Nutzdaten
Antwort:
  • value – Typ: bool

Gibt true zurück wenn ein Magnetfeld mit 3,5 Millitesla oder größer detektiert wird.

request/hall_effect_bricklet/<UID>/get_edge_count
Anfrage:
  • reset_counter – Typ: bool
Antwort:
  • count – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt den aktuellen Wert des Flankenzählers zurück. Die zu zählenden Flanken (steigend, fallend, beide) können mit request/hall_effect_bricklet/<UID>/set_edge_count_config konfiguriert werden.

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

Fortgeschrittene Funktionen

request/hall_effect_bricklet/<UID>/set_edge_count_config
Anfrage:
  • edge_type – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100
Antwort:
  • keine Antwort

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden. Mögliche Flankentypen sind:

  • 0 = steigend
  • 1 = fallend
  • 2 = beide

Wird ein Magnet in die Nähe des Bricklets gebracht (>3,5 Millitesla) erzeugt dies ein low-Signal (fallende Flanke), wenn ein Magnet vom Bricklet entfernt (<2,5 Millitesla) wird entsteht ein high-Signal (steigende Flanke).

Durch das Konfigurieren wird der Wert des Flankenzählers auf 0 zurückgesetzt.

Falls unklar ist was dies alles bedeutet, kann diese Funktion einfach ignoriert werden. Die Standardwerte sind in fast allen Situationen OK.

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

Für edge_type:

  • "rising" = 0
  • "falling" = 1
  • "both" = 2
request/hall_effect_bricklet/<UID>/get_edge_count_config
Anfrage:
  • keine Nutzdaten
Antwort:
  • edge_type – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

Gibt den Flankentyp sowie die Entprellzeit zurück, wie von request/hall_effect_bricklet/<UID>/set_edge_count_config gesetzt.

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

Für edge_type:

  • "rising" = 0
  • "falling" = 1
  • "both" = 2
request/hall_effect_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", "i", "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 '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. 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.

Konfigurationsfunktionen für Callbacks

request/hall_effect_bricklet/<UID>/set_edge_interrupt
Anfrage:
  • edges – Typ: int, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt die Anzahl der zu zählenden Flanken bis ein Interrupt aufgerufen wird.

Wenn edges auf n gesetzt ist, wird der Interrupt nach jeder n-ten detektierten Flanke aufgerufen.

Wenn edges auf 0 gesetzt ist, wird der Interrupt deaktiviert.

request/hall_effect_bricklet/<UID>/get_edge_interrupt
Anfrage:
  • keine Nutzdaten
Antwort:
  • edges – Typ: int, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt edges zurück, wie von request/hall_effect_bricklet/<UID>/set_edge_interrupt gesetzt.

request/hall_effect_bricklet/<UID>/set_edge_count_callback_period
Anfrage:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt die Periode mit welcher der register/hall_effect_bricklet/<UID>/edge_count Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/hall_effect_bricklet/<UID>/edge_count Callback wird nur ausgelöst, wenn sich die Flankenzählung seit der letzten Auslösung geändert hat.

request/hall_effect_bricklet/<UID>/get_edge_count_callback_period
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von request/hall_effect_bricklet/<UID>/set_edge_count_callback_period 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/hall_effect_bricklet/<UID>/edge_count
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • count – Typ: int, Wertebereich: [0 bis 232 - 1]
  • value – Typ: bool

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

Dieser Callback wird mit der Periode, wie gesetzt mit request/hall_effect_bricklet/<UID>/set_edge_count_callback_period, ausgelöst. Die Payload des Callbacks sind der aktuelle Zählerstand und der aktuelle Wert (siehe request/hall_effect_bricklet/<UID>/get_value and request/hall_effect_bricklet/<UID>/get_edge_count).

Der register/hall_effect_bricklet/<UID>/edge_count Callback wird nur ausgelöst, wenn sich mindestens einer der beiden Werte seit der letzten Auslösung geändert hat.