PHP - Motion Detector Bricklet 2.0¶

Indicator¶

Download (ExampleIndicator.php)

 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

<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletMotionDetectorV2.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletMotionDetectorV2;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Motion Detector Bricklet 2.0

$ipcon = new IPConnection(); // Create IP connection
$md = new BrickletMotionDetectorV2(UID, $ipcon); // Create device object

$ipcon->connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected

// Turn blue backlight LEDs on (maximum brightness)
$md->setIndicator(255, 255, 255);

echo "Press key to exit\n";
fgetc(fopen('php://stdin', 'r'));
$ipcon->disconnect();

?>

Callback¶

Download (ExampleCallback.php)

 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
34
35
36
37
38
39
40
41
42

<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletMotionDetectorV2.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletMotionDetectorV2;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Motion Detector Bricklet 2.0

// Callback function for motion detected callback
function cb_motionDetected()
{
    echo "Motion Detected\n";
}

// Callback function for detection cycle ended callback
function cb_detectionCycleEnded()
{
    echo "Detection Cycle Ended (next detection possible in ~2 seconds)\n";
}

$ipcon = new IPConnection(); // Create IP connection
$md = new BrickletMotionDetectorV2(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_motionDetected
$md->registerCallback(BrickletMotionDetectorV2::CALLBACK_MOTION_DETECTED,
                      'cb_motionDetected');

// Register detection cycle ended callback to function cb_detectionCycleEnded
$md->registerCallback(BrickletMotionDetectorV2::CALLBACK_DETECTION_CYCLE_ENDED,
                      'cb_detectionCycleEnded');

echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever

?>

Grundfunktionen¶

class BrickletMotionDetectorV2(string $uid, IPConnection $ipcon)¶

Parameter:	$uid – Typ: string $ipcon – Typ: IPConnection
Rückgabe:	$motion_detector_v2 – Typ: BrickletMotionDetectorV2

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

<?php   $motion_detector_v2 = new BrickletMotionDetectorV2('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletMotionDetectorV2::getMotionDetected()¶

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

Gibt 1 zurück wenn eine Bewegung detektiert wurde. 1 wird für ca. 1,8 Sekunden zurückgegeben bevor der Sensor wieder erneut eine Bewegung detektieren kann.

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

Für $motion:

• BrickletMotionDetectorV2::MOTION_NOT_DETECTED = 0
• BrickletMotionDetectorV2::MOTION_DETECTED = 1

void BrickletMotionDetectorV2::setSensitivity(int $sensitivity)¶

Parameter:	$sensitivity – Typ: int, Wertebereich: [0 bis 100], Standardwert: 50

Setzt die Empfindlichkeit des PIR Sensors. Bei maximaler Empfindlichkeit (100) kann das Bricklet Bewegung bin in ca. 12m Entfernung erkennen.

Die wirkliche Entfernung hängt von vielen Dingen in der Umgebung ab (z.B. Ruflektionen) und der Größe des zu erkennenden Objekts. Während eine große Person bei 10m erkannt werden kann, wird eine Katze vielleicht erst an 2m erkannt mit den gleichen Einstellungen.

Daher muss die passenden Empfindlichkeit je nach Anwendung experimentell bestimmt werden.

int BrickletMotionDetectorV2::getSensitivity()¶

Rückgabe:	$sensitivity – Typ: int, Wertebereich: [0 bis 100], Standardwert: 50

Gibt die Empfindlichkeit zurück, wie von setSensitivity() gesetzt.

void BrickletMotionDetectorV2::setIndicator(int $top_left, int $top_right, int $bottom)¶

Parameter:	$top_left – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0 $top_right – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0 $bottom – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0

Stellt die blaue Beleuchtung der Fresnel-Linse ein. Die Beleuchtung besteht aus drei LEDs. Die Helligkeit jeder LED kann einzeln mit einem 8-Bit Wert (0-255) eingestellt werden. Ein Wert von 0 deaktiviert die LED und ein Wert von 255 aktiviert die LED mit voller Helligkeit.

array BrickletMotionDetectorV2::getIndicator()¶

Rückgabe-Array:	'top_left' – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0 'top_right' – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0 'bottom' – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0

Gibt die Indikatorkonfiguration zurück, wie von setIndicator() gesetzt.

Fortgeschrittene Funktionen¶

array BrickletMotionDetectorV2::getSPITFPErrorCount()¶

Rückgabe-Array:	'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.

void BrickletMotionDetectorV2::setStatusLEDConfig(int $config)¶

Parameter:	$config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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

Für $config:

• BrickletMotionDetectorV2::STATUS_LED_CONFIG_OFF = 0
• BrickletMotionDetectorV2::STATUS_LED_CONFIG_ON = 1
• BrickletMotionDetectorV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletMotionDetectorV2::STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletMotionDetectorV2::getStatusLEDConfig()¶

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

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

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

Für $config:

• BrickletMotionDetectorV2::STATUS_LED_CONFIG_OFF = 0
• BrickletMotionDetectorV2::STATUS_LED_CONFIG_ON = 1
• BrickletMotionDetectorV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletMotionDetectorV2::STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletMotionDetectorV2::getChipTemperature()¶

Rückgabe:	$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.

void BrickletMotionDetectorV2::reset()¶

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.

array BrickletMotionDetectorV2::getIdentity()¶

Rückgabe-Array:

'uid' – Typ: string, Länge: bis zu 8 'connected_uid' – Typ: string, Länge: bis zu 8 'position' – Typ: string, Wertebereich: ['a' bis 'h', 'z'] 'hardware_version' – Typ: array(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: array(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¶

void BrickletMotionDetectorV2::registerCallback(int $callback_id, callable $callback, mixed $user_data=NULL)¶

Parameter:	$callback_id – Typ: int $callback – Typ: callable $user_data – Typ: mixed

Registriert die $function für die gegebene $callback_id. Die optionalen $user_data werden der Funktion als letztes Parameter mit übergeben.

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 registerCallback() des Geräte Objektes durchgeführt werden. Der erste Parameter ist der Callback ID und der zweite die Callback-Funktion:

<?php

function myCallback($param)
{
    echo $param . "\n";
}

$motion_detector_v2->registerCallback(BrickletMotionDetectorV2::CALLBACK_EXAMPLE, 'myCallback');

?>

Die verfügbaren IDs mit den dazugehörigen Funktionssignaturen werden weiter unten beschrieben.

int BrickletMotionDetectorV2::CALLBACK_MOTION_DETECTED¶

<?php   void callback([mixed $user_data])   ?>

Callback-Parameter:	$user_data – Typ: mixed

Dieser Callback wird aufgerufen nachdem eine Bewegung detektiert wurde.

int BrickletMotionDetectorV2::CALLBACK_DETECTION_CYCLE_ENDED¶

<?php   void callback([mixed $user_data])   ?>

Callback-Parameter:	$user_data – Typ: mixed

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.

array BrickletMotionDetectorV2::getAPIVersion()¶

Rückgabe-Array:	$api_version – Typ: array(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.

bool BrickletMotionDetectorV2::getResponseExpected(int $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 setResponseExpected(). 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:

• BrickletMotionDetectorV2::FUNCTION_SET_SENSITIVITY = 2
• BrickletMotionDetectorV2::FUNCTION_SET_INDICATOR = 4
• BrickletMotionDetectorV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletMotionDetectorV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletMotionDetectorV2::FUNCTION_RESET = 243
• BrickletMotionDetectorV2::FUNCTION_WRITE_UID = 248

void BrickletMotionDetectorV2::setResponseExpected(int $function_id, bool $response_expected)¶

Parameter:	$function_id – Typ: int, Wertebereich: Siehe Konstanten $response_expected – Typ: bool

Ä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:

• BrickletMotionDetectorV2::FUNCTION_SET_SENSITIVITY = 2
• BrickletMotionDetectorV2::FUNCTION_SET_INDICATOR = 4
• BrickletMotionDetectorV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletMotionDetectorV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletMotionDetectorV2::FUNCTION_RESET = 243
• BrickletMotionDetectorV2::FUNCTION_WRITE_UID = 248

void BrickletMotionDetectorV2::setResponseExpectedAll(bool $response_expected)¶

Parameter:	$response_expected – Typ: bool

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

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.

int BrickletMotionDetectorV2::setBootloaderMode(int $mode)¶

Parameter:	$mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	$status – Typ: int, Wertebereich: Siehe Konstanten

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

Für $mode:

• BrickletMotionDetectorV2::BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletMotionDetectorV2::BOOTLOADER_MODE_FIRMWARE = 1
• BrickletMotionDetectorV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletMotionDetectorV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletMotionDetectorV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für $status:

• BrickletMotionDetectorV2::BOOTLOADER_STATUS_OK = 0
• BrickletMotionDetectorV2::BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletMotionDetectorV2::BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletMotionDetectorV2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletMotionDetectorV2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletMotionDetectorV2::BOOTLOADER_STATUS_CRC_MISMATCH = 5

int BrickletMotionDetectorV2::getBootloaderMode()¶

Rückgabe:	$mode – Typ: int, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode().

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

Für $mode:

• BrickletMotionDetectorV2::BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletMotionDetectorV2::BOOTLOADER_MODE_FIRMWARE = 1
• BrickletMotionDetectorV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletMotionDetectorV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletMotionDetectorV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

void BrickletMotionDetectorV2::setWriteFirmwarePointer(int $pointer)¶

Parameter:	$pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für writeFirmware(). 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.

int BrickletMotionDetectorV2::writeFirmware(array $data)¶

Parameter:	$data – Typ: array(int, ...), Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:	$status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von setWriteFirmwarePointer() 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.

void BrickletMotionDetectorV2::writeUID(int $uid)¶

Parameter:	$uid – Typ: int, Wertebereich: [0 bis 232 - 1]

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.

int BrickletMotionDetectorV2::readUID()¶

Rückgabe:	$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.

Konstanten¶

int BrickletMotionDetectorV2::DEVICE_IDENTIFIER¶

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

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

string BrickletMotionDetectorV2::DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Motion Detector Bricklet 2.0 dar.