From 10037044d9407d6bc23e8a3dcc68946eca0fca06 Mon Sep 17 00:00:00 2001 From: Alistair Young Date: Sat, 4 Feb 2017 12:05:18 -0600 Subject: [PATCH] Updated for hardware change. --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index be6f826..584bae5 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,16 @@ Arduino code for the Dogtector, a passive IR sensor coupled to an ESP8266 along The function of the Dogtector is to detect when one of our dogs approaches the back door of the house to be let in, and then both sound a local alert (a beep from the buzzer), and send a notification that they have been -detected there to our home automation server via MQTT (using the topic _sensors/dogtector_ ). The home +detected there to our home automation server via MQTT (using the topic _dogtector/alert_ ). The home automation server is also able to enable and disable the Dogtector remotely using messages sent to the topic -_enable/dogtector_ . +_dogtector/command_ , and request enable status, which will be returned on the topic _dogtector/status_ . -The Dogtector also makes use of the LEDs built onto the ESP8266. The red LED (pin 0) indicates current status, +The Dogtector also includes a (magnetic reed switch) door sensor, which sends the current open/closed status of +the door to the home automation server via the topic _dogtector/door_ . (While usable as a simple door monitor, +our automation server uses this information to _not_ send Dogtector notifications when the door is open, because +there's no need to let us know when we've just let the dogs out...) + +The Dogtector also also makes use of the LEDs built onto the ESP8266. The red LED (pin 0) indicates current status, illuminating steadily when the Dogtector is on but disabled, and flashing when the Dogtector is active. When active, the blue LED (pin 2) illuminates when a detection has taken place.