Kits / Starterkit: Hardware Hacking / Beispiele / Rauchmelder auslesen / Mit PHP

Rauchmelder mit PHP auslesen¶

Für diese Projekt setzen wir voraus, dass eine PHP Entwicklungsumgebung eingerichtet ist und ein grundsätzliches Verständnis der PHP Programmiersprache vorhanden ist.

Falls dies nicht der Fall ist sollte hier begonnen werden. Informationen über die Tinkerforge API sind dann hier zu finden.

Wir setzen weiterhin voraus, dass ein passender Rauchmelder mit einem Industrial Digital In 4 Bricklet verbunden wurde wie hier beschrieben.

Ziele¶

Wir setzen uns folgendes Ziel für dieses Projekt:

Alarmstatus eines Rauchmelders auslesen
und auf dessen Alarmsignal reagieren.

Da dieses Projekt wahrscheinlich 24/7 laufen wird, wollen wir sicherstellen, dass das Programm möglichst robust gegen externe Einflüsse ist. Das Programm sollte weiterhin funktionieren falls

Bricklets ausgetauscht werden (z.B. verwenden wir keine fixen UIDs),
Brick Daemon läuft nicht oder wird neu gestartet,
WIFI Extension ist außer Reichweite oder
Brick wurde neu gestartet (Stromausfall oder USB getrennt).

Im Folgenden werden wir Schritt für Schritt zeigen wie diese Ziele erreicht werden können.

Schritt 1: Bricks und Bricklets dynamisch erkennen¶

Als Erstes legen wir fest wohin unser Programm sich verbinden soll:

<?php

const HOST = 'localhost';
const PORT = 4223;

?>

Falls eine WIFI Extension verwendet wird, oder der Brick Daemon auf einem anderen PC läuft, dann muss "localhost" durch die IP Adresse oder den Hostnamen der WIFI Extension oder des anderen PCs ersetzt werden.

Nach dem Start des Programms müssen der CALLBACK_ENUMERATE Callback und der CALLBACK_CONNECTED Callback registriert und ein erstes Enumerate ausgelöst werden:

<?php

public function __construct()
{
    $this->ipcon = new IPConnection();
    $this->ipcon->connect(self::HOST, self::PORT);

    $this->ipcon->registerCallback(IPConnection::CALLBACK_ENUMERATE,
                                   array($this, 'cb_enumerate'));
    $this->ipcon->registerCallback(IPConnection::CALLBACK_CONNECTED,
                                   array($this, 'cb_connected'));

    $this->ipcon->enumerate();
}

?>

Der Enumerate Callback wird ausgelöst wenn ein Brick per USB angeschlossen wird oder wenn die enumerate() Funktion aufgerufen wird. Dies ermöglicht es die Bricks und Bricklets im Stapel zu erkennen ohne im Voraus ihre UIDs kennen zu müssen.

Der Connected Callback wird ausgelöst wenn die Verbindung zur WIFI Extension oder zum Brick Daemon hergestellt wurde. In diesem Callback muss wiederum ein Enumerate angestoßen werden, wenn es sich um ein Auto-Reconnect handelt:

<?php

function cb_connected($connectedReason)
{
    if($connectedReason == IPConnection::CONNECT_REASON_AUTO_RECONNECT) {
        $this->ipcon->enumerate();
    }
}

?>

Ein Auto-Reconnect bedeutet, dass die Verbindung zur WIFI Extension oder zum Brick Daemon verloren gegangen ist und automatisch wiederhergestellt werden konnte. In diesem Fall kann es sein, dass die Bricklets ihre Konfiguration verloren haben und wir sie neu konfigurieren müssen. Da die Konfiguration beim Enumerate (siehe unten) durchgeführt wird, lösen wir einfach noch ein Enumerate aus.

Schritt 1 zusammengefügt:

<?php

class SmokeDetector
{
    const HOST = 'localhost';
    const PORT = 4223;

    public function __construct()
    {
        $this->ipcon = new IPConnection();
        $this->ipcon->connect(self::HOST, self::PORT);

        $this->ipcon->registerCallback(IPConnection::CALLBACK_ENUMERATE,
                                       array($this, 'cb_enumerate'));
        $this->ipcon->registerCallback(IPConnection::CALLBACK_CONNECTED,
                                       array($this, 'cb_connected'));

        $this->ipcon->enumerate();
    }

    function cb_connected($connectedReason)
    {
        if($connectedReason == IPConnection::CONNECT_REASON_AUTO_RECONNECT) {
            $this->ipcon->enumerate();
        }
    }
}

?>

Schritt 2: Bricklets beim Enumerate initialisieren¶

Während des Enumerierungsprozesses soll das Industrial Digital In 4 Bricklet konfiguriert werden. Dadurch ist sichergestellt, dass es neu konfiguriert wird nach einem Verbindungsabbruch oder einer Unterbrechung der Stromversorgung.

Die Konfiguration soll beim ersten Start (ENUMERATION_TYPE_CONNECTED) durchgeführt werden und auch bei jedem extern ausgelösten Enumerate (ENUMERATION_TYPE_AVAILABLE):

<?php

function cb_enumerate($uid, $connectedUid, $position, $hardwareVersion,
                      $firmwareVersion, $deviceIdentifier, $enumerationType)
{
    if($enumerationType == IPConnection::ENUMERATION_TYPE_CONNECTED ||
       $enumerationType == IPConnection::ENUMERATION_TYPE_AVAILABLE) {

?>

Das Industrial Digital In 4 Bricklet wird so eingestellt, dass es die cb_interrupt Callback-Funktion aufruft wenn sich die Spannung an einem der Eingänge verändert. Die Entprellperiode wird auf 10s (10000ms) gestellt, um zu vermeiden zu viele Callback zu erhalten. Interrupt-Erkennung wird für alle Eingänge aktiviert (15 = 0b1111).

<?php

if($deviceIdentifier == BrickletIndustrialDigitalIn4::DEVICE_IDENTIFIER) {
    $this->brickletIndustrialDigitalIn4 = new BrickletIndustrialDigitalIn4($uid, $this->ipcon);
    $this->brickletIndustrialDigitalIn4->setDebouncePeriod(10000);
    $this->brickletIndustrialDigitalIn4->setInterrupt(15);
    $this->brickletIndustrialDigitalIn4->registerCallback(BrickletIndustrialDigitalIn4::CALLBACK_INTERRUPT,
                                                          array($this, 'cb_interrupt'));
}

?>

Schritt 2 zusammengefügt:

<?php

function cb_enumerate($uid, $connectedUid, $position, $hardwareVersion,
                      $firmwareVersion, $deviceIdentifier, $enumerationType)
{
    if($deviceIdentifier == BrickletIndustrialDigitalIn4::DEVICE_IDENTIFIER) {
        $this->brickletIndustrialDigitalIn4 = new BrickletIndustrialDigitalIn4($uid, $this->ipcon);
        $this->brickletIndustrialDigitalIn4->setDebouncePeriod(10000);
        $this->brickletIndustrialDigitalIn4->setInterrupt(15);
        $this->brickletIndustrialDigitalIn4->registerCallback(BrickletIndustrialDigitalIn4::CALLBACK_INTERRUPT,
                                                              array($this, 'cb_interrupt'));
    }
}

?>

Schritt 3: Auf Alarmsignal reagieren¶

Jetzt müssen wir noch auf das Alarmsignal des Rauchmelders reagieren. Es soll aber nur auf das Einschalten der LED reagiert werden, nicht auf das Ausschalten. Dazu wird $valueMask auf > 0 geprüft, in diesem Fall liegt an mindesten einem Eingang eine Spannung an, sprich die LED leuchtet.

<?php

function cb_interrupt($interruptMask, $valueMask)
{
    if ($valueMask > 0) {
        echo "Fire! Fire!\n";
    }
}

?>

Das ist es. Wenn wir diese drei Schritte zusammen in eine Datei kopieren und ausführen, dann hätten wir jetzt eine funktionierendes Programm, das den Alarmstatus eines Rauchmelders ausließt und auf dessen Alarmsignal reagiert.

In der jetzigen Form gibt das Programm nur eine Meldung aus. Dies kann auf verschiedene Weise verbessert werden. Zum Beispiel könnte das Programm jemanden per E-Mail oder SMS über den Alarm informieren.

Wie dem auch sei, wir haben noch nicht alle Ziele erreicht. Das Programm ist noch nicht robust genug. Was passiert wenn die Verbindung beim Start des Programms nicht hergestellt werden kann, oder wenn das Enumerate nach einem Auto-Reconnect nicht funktioniert?

Wir brauchen noch Fehlerbehandlung!

Schritt 4: Fehlerbehandlung und Logging¶

Beim Start des Programms versuchen wir solange die Verbindung herzustellen, bis es klappt:

<?php

while(true) {
    try {
        $this->ipcon->connect(self::HOST, self::PORT);
        break;
    } catch(Exception $e) {
        sleep(1);
    }
}

?>

und es wird solange versucht ein Enumerate zu starten bis auch dies geklappt hat:

<?php

while(true) {
    try {
        $this->ipcon->enumerate();
        break;
    } catch(Exception $e) {
        sleep(1);
    }
}

?>

Mit diesen Änderungen kann das Programm schon gestartet werden bevor der Master Brick angeschlossen ist.

Es müssen auch noch mögliche Fehler während des Enumerierungsprozesses behandelt werden:

<?php

if($deviceIdentifier == BrickletIndustrialDigitalIn4::DEVICE_IDENTIFIER) {
    try {
        $this->brickletIndustrialDigitalIn4 = new BrickletIndustrialDigitalIn4($uid, $this->ipcon);
        $this->brickletIndustrialDigitalIn4->setDebouncePeriod(10000);
        $this->brickletIndustrialDigitalIn4->setInterrupt(15);
        $this->brickletIndustrialDigitalIn4->registerCallback(BrickletIndustrialDigitalIn4::CALLBACK_INTERRUPT,
                                                              array($this, 'cb_interrupt'));
        echo "Industrial Digital In 4 initialized\n";
    } catch(Exception $e) {
        $this->brickletIndustrialDigitalIn4 = null;
        echo "Industrial Digital In 4 init failed: $e\n";
    }
}

?>

Zusätzlich wollen wir noch ein paar Logausgaben einfügen. Diese ermöglichen es später herauszufinden was ein mögliches Problem ausgelöst hat.

Zum Beispiel, wenn der Master Brick über WLAN angebunden ist und häufig Auto-Reconnects auftreten, dann ist wahrscheinlich die WLAN Verbindung nicht sehr stabil.

Schritt 5: Alles zusammen¶

Jetzt sind alle für gesteckten Ziele für unseren gehackten Rauchmelder erreicht.

Das gesamte Programm für den gehackten Rauchmelder (download):

<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIndustrialDigitalIn4;

class SmokeDetector
{
    const HOST = 'localhost';
    const PORT = 4223;

    public function __construct()
    {
        $this->ipcon = new IPConnection();
        $this->brickletIndustrialDigitalIn4 = null;

        while(true) {
            try {
                $this->ipcon->connect(self::HOST, self::PORT);
                break;
            } catch(Exception $e) {
                sleep(1);
            }
        }

        $this->ipcon->registerCallback(IPConnection::CALLBACK_ENUMERATE,
                                       array($this, 'cb_enumerate'));
        $this->ipcon->registerCallback(IPConnection::CALLBACK_CONNECTED,
                                       array($this, 'cb_connected'));

        while(true) {
            try {
                $this->ipcon->enumerate();
                break;
            } catch(Exception $e) {
                sleep(1);
            }
        }
    }

    function cb_interrupt($interruptMask, $valueMask)
    {
        if ($valueMask > 0) {
            echo "Fire! Fire!\n";
        }
    }

    function cb_enumerate($uid, $connectedUid, $position, $hardwareVersion,
                          $firmwareVersion, $deviceIdentifier, $enumerationType)
    {
        if($enumerationType == IPConnection::ENUMERATION_TYPE_CONNECTED ||
           $enumerationType == IPConnection::ENUMERATION_TYPE_AVAILABLE) {
            if($deviceIdentifier == BrickletIndustrialDigitalIn4::DEVICE_IDENTIFIER) {
                try {
                    $this->brickletIndustrialDigitalIn4 = new BrickletIndustrialDigitalIn4($uid, $this->ipcon);
                    $this->brickletIndustrialDigitalIn4->setDebouncePeriod(10000);
                    $this->brickletIndustrialDigitalIn4->setInterrupt(15);
                    $this->brickletIndustrialDigitalIn4->registerCallback(BrickletIndustrialDigitalIn4::CALLBACK_INTERRUPT,
                                                                          array($this, 'cb_interrupt'));
                    echo "Industrial Digital In 4 initialized\n";
                } catch(Exception $e) {
                    $this->brickletIndustrialDigitalIn4 = null;
                    echo "Industrial Digital In 4 init failed: $e\n";
                }
            }
        }
    }

    function cb_connected($connectedReason)
    {
        if($connectedReason == IPConnection::CONNECT_REASON_AUTO_RECONNECT) {
            echo "Auto Reconnect\n";

            while(true) {
                try {
                    $this->ipcon->enumerate();
                    break;
                } catch(Exception $e) {
                    sleep(1);
                }
            }
        }
    }
}

$smokeDetector = new SmokeDetector();
echo "Press ctrl+c to exit\n";
$smokeDetector->ipcon->dispatchCallbacks(-1);

?>