A client/server based alarm and monitoring system
Python JavaScript PHP Shell Java CSS
Switch branches/tags
Nothing to show
Clone or download
Latest commit 9c566bc Jul 11, 2018
Permalink
Failed to load latest commit information.
alertClientDbus added note if alertr user is different from normal user Jun 24, 2018
alertClientExecuter renaming from alertR to AlertR May 25, 2018
alertClientMail renaming from alertR to AlertR May 25, 2018
alertClientPushNotification renaming from alertR to AlertR May 25, 2018
alertClientRaspberryPi renaming from alertR to AlertR May 25, 2018
alertClientTemplate renaming from alertR to AlertR May 25, 2018
alertClientXBMC renaming from alertR to AlertR May 25, 2018
docs added magic mirror picture May 26, 2017
helperScripts added setting for pulling the gpio up or down Sep 11, 2014
managerClientConsole renaming from alertR to AlertR May 25, 2018
managerClientDatabase renaming from alertR to AlertR May 25, 2018
managerClientKeypad renaming from alertR to AlertR May 25, 2018
sensorClientDevelopment removed or moved "triggerState" option Jun 6, 2018
sensorClientExecuter added iCalendar sensor client Jul 10, 2018
sensorClientFIFO fixed umask error Jun 17, 2018
sensorClientICalendar syntax fix Jul 11, 2018
sensorClientLightning removed or moved "triggerState" option Jun 6, 2018
sensorClientPing removed or moved "triggerState" option Jun 6, 2018
sensorClientRaspberryPi moved or removed "triggerState" option Jun 6, 2018
sensorClientWeatherService removed or moved "triggerState" option Jun 6, 2018
server only send sensor alerts to clients that handle the triggered alert level Jun 29, 2018
webMobileManager Merge branch 'dev' Oct 16, 2017
.gitignore no comment Aug 11, 2014
CHANGELOG.md updated changelog Nov 25, 2016
LICENSE Update LICENSE Oct 14, 2017
README.md typo May 31, 2018
alertRinstaller.py reverted cheat May 25, 2018
repoInfo.json added iCalendar sensor client Jul 10, 2018

README.md

AlertR

AlertR is a client/server based alarm system and monitoring system which targets developers, tinkers, privacy advocates, and all people that are interested in DIY solutions. Despite the obvious use as a home alarm system, it can also be used to help server administrators to monitor their services (or used in any other cases in which sensors are required). Because of the way it is designed, AlertR can be used in any scenario a sensor with the state triggered and normal has to be monitored. This can be a sensor for a home security or home automation system, but also computer services like a failing HDD drive in a RAID or the availability of a web server.

The vision for AlertR is to have a single service running that gathers all the information someone wants (like temperature data, service states, or bank account transfers) and provides the ability to react on them automatically. In addition, it should serve as single point to let the user look up aggregated information of his/her services. All this should be done in such a way that the user is always in control of his/her data and no one besides him/her is able to access them.

Table of Contents

Version

The current stable version of AlertR is 0.5. The development of AlertR is done in the dev-branch. So if you want to see the next features or just check if the project is still alive, please see the commits in the dev-branch. If you want to see what has changed during the releases, you can check the Changelog File.

Media

If you have no idea what AlertR actually is or how you can use it, this section might give you some ideas.

Pictures

A picture of a MagicMirror showing AlertR system information.


The following shows a screenshot of the Android app introduced in version 0.5.


A screenshot of the console manager in version 0.4.


An overview of the infrastructure a basic AlertR setup has.


Number of active AlertR installations calculated from participants of the voluntary survey.


Number of messages sent by the AlertR push service in the last 12 weeks.


Videos

A short preview of the AlertR alarm and monitoring system in version 0.5. It shows the new AlertR Android app that is able to receive push notifications. Please activate the subtitles to see the description of what I am doing and what is happening.


Part of one release was a rule engine, which allows you to set up rules that must be satisfied before an alarm is triggered. Again, the subtitles have to be activated in order to understand what is happening.


The next video was published in December 2014 and shows version 0.2 of AlertR. It demonstrates the D-Bus and Kodi (aka XBMC) notification capabilities. Again, the subtitles have to be activated in order to understand what is happening.


The following video is a short introduction video of AlertR as a home alarm system. It was the first video showing AlertR. The subtitles have to be activated in order to understand what is happening.


Installation

To install an AlertR client or the AlertR server, please use the installation script. A detailed description of how to install an AlertR instance is given in the Installation section of the wiki.

Update

If you have already a working AlertR system installed and a newer version is available, use the update script to update your AlertR instances. A detailed description of how to update an AlertR instance is given in the Update section of the wiki.

Further Notes

If you are interested in AlertR and its development, you can also read AlertR related articles in my Blog.

Supporting AlertR

If you like this project you can help to support it by contributing to it. You can contribute by writing tutorials, creating and documenting exciting new ideas to use AlertR, writing code for it, and so on.

If you do not know how to do any of it or do not have the time, you can support the project by donating or support me on Patreon. Since services such as the push notification service have a monthly upkeep, the donation helps to keep these services free for everyone.

Patreon

Donate

Bugs and Feedback

For questions, bugs and discussion please use the Github Issues.