MQTT - Motion Detector Bricklet¶

Callback¶

Download (example-callback.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

# Change XYZ to the UID of your Motion Detector Bricklet

setup:
    # Handle incoming motion detected callbacks
    subscribe to tinkerforge/callback/motion_detector_bricklet/XYZ/motion_detected
    publish '{"register": true}' to tinkerforge/register/motion_detector_bricklet/XYZ/motion_detected # Register motion_detected callback

    # Handle incoming detection cycle ended callbacks
    subscribe to tinkerforge/callback/motion_detector_bricklet/XYZ/detection_cycle_ended
    publish '{"register": true}' to tinkerforge/register/motion_detector_bricklet/XYZ/detection_cycle_ended # Register detection_cycle_ended callback

Grundfunktionen¶

request/motion_detector_bricklet/<UID>/get_motion_detected¶

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

Gibt 1 zurück wenn eine Bewegung detektiert wurde. Wie lange 1 zurückgegeben wird nachdem eine Bewegung detektiert wurde kann mit einem kleinen Poti auf dem Motion Detector Bricklet eingestellt werden, siehe hier.

Auf dem Bricklet selbst ist eine blaue LED, die leuchtet solange das Bricklet im "Bewegung detektiert" Zustand ist.

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

Für motion:

• "not_detected" = 0
• "detected" = 1

Fortgeschrittene Funktionen¶

request/motion_detector_bricklet/<UID>/set_status_led_config¶

Anfrage:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 2
Antwort:	keine Antwort

Setzt die Konfiguration der Status-LED.

Standardmäßig geht die LED an, wenn eine Bewegung erkannt wird und aus wenn keine Bewegung erkannt wird.

Die LED kann auch permanent an/aus gestellt werden.

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

Für config:

• "off" = 0
• "on" = 1
• "show_status" = 2

Neu in Version 2.0.1 (Plugin).

request/motion_detector_bricklet/<UID>/get_status_led_config¶

Anfrage:	keine Nutzdaten
Antwort:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 2

Gibt die Konfiguration zurück, wie von request/motion_detector_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_status" = 2

Neu in Version 2.0.1 (Plugin).

request/motion_detector_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 Motion Detector.

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/motion_detector_bricklet/<UID>/motion_detected¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	keine Nutzdaten

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

Dieser Callback wird aufgerufen nachdem eine Bewegung detektiert wurde.

register/motion_detector_bricklet/<UID>/detection_cycle_ended¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	keine Nutzdaten

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

Dieser Callback wird aufgerufen wenn ein Bewegungserkennungszyklus beendet ist. Wenn dieser Callback aufgerufen wurde kann wieder eine weitere Bewegung erkannt werden nach ungefähr 2 Sekunden.