Python - Motion Detector Bricklet¶

Callback¶

Download (example_callback.py)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Motion Detector Bricklet

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_motion_detector import BrickletMotionDetector

# Callback function for motion detected callback
def cb_motion_detected():
    print("Motion Detected")

# Callback function for detection cycle ended callback
def cb_detection_cycle_ended():
    print("Detection Cycle Ended (next detection possible in ~3 seconds)")

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    md = BrickletMotionDetector(UID, ipcon) # Create device object

    ipcon.connect(HOST, PORT) # Connect to brickd
    # Don't use device before ipcon is connected

    # Register motion detected callback to function cb_motion_detected
    md.register_callback(md.CALLBACK_MOTION_DETECTED, cb_motion_detected)

    # Register detection cycle ended callback to function cb_detection_cycle_ended
    md.register_callback(md.CALLBACK_DETECTION_CYCLE_ENDED, cb_detection_cycle_ended)

    input("Press key to exit\n") # Use raw_input() in Python 2
    ipcon.disconnect()

Grundfunktionen¶

BrickletMotionDetector(uid, ipcon)¶

Parameter:	uid – Typ: str ipcon – Typ: IPConnection
Rückgabe:	motion_detector – Typ: BrickletMotionDetector

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

motion_detector = BrickletMotionDetector("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

BrickletMotionDetector.get_motion_detected()¶

Rückgabe:	motion – Typ: int, Wertebereich: Siehe Konstanten

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 Konstanten sind für diese Funktion verfügbar:

Für motion:

• BrickletMotionDetector.MOTION_NOT_DETECTED = 0
• BrickletMotionDetector.MOTION_DETECTED = 1

Fortgeschrittene Funktionen¶

BrickletMotionDetector.set_status_led_config(config)¶

Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 2
Rückgabe:	None

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 Konstanten sind für diese Funktion verfügbar:

Für config:

• BrickletMotionDetector.STATUS_LED_CONFIG_OFF = 0
• BrickletMotionDetector.STATUS_LED_CONFIG_ON = 1
• BrickletMotionDetector.STATUS_LED_CONFIG_SHOW_STATUS = 2

Neu in Version 2.0.1 (Plugin).

BrickletMotionDetector.get_status_led_config()¶

Rückgabe:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 2

Gibt die Konfiguration zurück, wie von set_status_led_config() gesetzt.

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

Für config:

• BrickletMotionDetector.STATUS_LED_CONFIG_OFF = 0
• BrickletMotionDetector.STATUS_LED_CONFIG_ON = 1
• BrickletMotionDetector.STATUS_LED_CONFIG_SHOW_STATUS = 2

Neu in Version 2.0.1 (Plugin).

BrickletMotionDetector.get_identity()¶

Rückgabeobjekt:

uid – Typ: str, Länge: bis zu 8 connected_uid – Typ: str, Länge: bis zu 8 position – Typ: chr, 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]

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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks¶

BrickletMotionDetector.register_callback(callback_id, function)¶

Parameter:	callback_id – Typ: int function – Typ: callable
Rückgabe:	None

Registriert die function für die gegebene callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion register_callback() des Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID und der zweite Parameter die Callback-Funktion:

def my_callback(param):
    print(param)

motion_detector.register_callback(BrickletMotionDetector.CALLBACK_EXAMPLE, my_callback)

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen werden weiter unten beschrieben.

BrickletMotionDetector.CALLBACK_MOTION_DETECTED¶

Callback-Parameter:	keine Parameter

Dieser Callback wird aufgerufen nachdem eine Bewegung detektiert wurde.

BrickletMotionDetector.CALLBACK_DETECTION_CYCLE_ENDED¶

Callback-Parameter:	keine Parameter

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.

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

BrickletMotionDetector.get_api_version()¶

Rückgabeobjekt:	api_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]

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

BrickletMotionDetector.get_response_expected(function_id)¶

Parameter:	function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	response_expected – Typ: bool

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels set_response_expected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für function_id:

• BrickletMotionDetector.FUNCTION_SET_STATUS_LED_CONFIG = 4

BrickletMotionDetector.set_response_expected(function_id, response_expected)¶

Parameter:	function_id – Typ: int, Wertebereich: Siehe Konstanten response_expected – Typ: bool
Rückgabe:	None

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für function_id:

• BrickletMotionDetector.FUNCTION_SET_STATUS_LED_CONFIG = 4

BrickletMotionDetector.set_response_expected_all(response_expected)¶

Parameter:	response_expected – Typ: bool
Rückgabe:	None

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten¶

BrickletMotionDetector.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Motion Detector Bricklet zu identifizieren.

Die get_identity() Funktion und der IPConnection.CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletMotionDetector.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Motion Detector Bricklet dar.