Skip to content

Latest commit

 

History

History
77 lines (54 loc) · 2.79 KB

README.md

File metadata and controls

77 lines (54 loc) · 2.79 KB
Raw

MQTT/Node base home alarm system - OBSOLETE

OBSOLETE, OBSOLETE, OBSOLETE

Replaced by: https://github.com/mhdawson/micro-app-home-alarm

The same home alarm functionality but based on the micro-app-framework so you can also get the look add feel of native desktop and mobile applications

This projects provides a home based alarm system using Node and MQTT. It provides a GUI that allows you to:

  • arm/disarm the alarm
  • see the status of the zones
  • ask that a picture be taken
  • view the last 4 pictures taken
  • view pictures from multiple cameras
  • view the log of alarm events

When the alarm is triggered it will take pictures every 10 second for 5 minutes, pushing them to a remote webserver. It can also be configured to send sms messages to notify the owner than an alarm has occured

picture of alarm main window

The following projects can be used to connect sensors such motion detectors, door contacts and webcams.

Additional views when alarm is active and triggered

picture of alarm when armed picture of alarm when triggered

View when using GUI to display pictures taken by camera

sample camera picture view

The server requires Node with the following modules installed:

  • basic-auth
  • mqtt
  • twilio
  • websocket

It also requires:

  • an mqtt server
  • a remote webserver to serve up the pictures taken
  • twillio account (If you want SMS notifications)

Most configuration is done in the config.txt file which supports the following configuration options:

  • alarmSite=<Name assigned to this instance of the alarm>
  • username=<username that must be provided to acess the alarm>
  • password=<password that must be provided to acess the alarm>
  • port=<port on which alarm GUI is server>
  • mqttServerIP=<IP of mqtt server>
  • mqttRootTopic=<root topic under which events are pubished/subscribed>
  • zone=<topic for sensor>:<zone>:<named assigned to zone> (one or more of these)
  • twilioAccountSID=<twillio account for SMS notifications>
  • twilioAccountAuthToken=<authentication token for twillio account>
  • twilioFromNumber=<twillio from number>
  • twilioToNumber=<twillio to number>
  • cameraTopic=<topic to which to publish requests that a picture be taken>
  • eventLogPrefix=<directory in which log for alarm will be written>

TODOs

  • Add more doc on how to configure, setup and run, including the required mqtt server
  • Add support for day/night sensor
  • Mobile app for gui would be nice.