DEPRECATED PROJECT: note that this project has been replaced by a backward-compatible project located at DMS3, which is a refactor of this project rewritten in Go, and features greater features, stability, and functionality.
Motion-Surveillance is a Ruby-based video surveillance system using the Motion motion detection software package. Motion-Surveillance includes the following package components:
- Motion-Monitor: integrated system services that monitor the status of devices on a given network, and start/stop the Motion package as appropriate.
- Motion-Mail: a configurable component for generating and sending an email with images whenever Motion generates a motion-related event.
-
Motion Software Package
- Movement detection support of video cameras. See this list for video device compatibility.
-
Motion-Monitor Component
-
Automated enabling/disabling of the Motion detection software program based on the presence of Internet of Things (IoT) devices on a network (e.g., LAN).
- MAC address sensing
- Multiple IoT device support
- IPv4 protocol support
- IPv6 protocol support [planned]
- 'Always On' feature enables Motion based on time-of-day (e.g., enable during nighttime hours)
- Bluetooth sensing (RSSI) [planned]
- Optionally play an audio file on surveillance system enable/disable
- Event logging
- MAC address sensing
-
-
Motion-Mail Component
-
Automated email notification on movement detection events
- Configurable message body
- Optionally attach event image or video in email
- SMTP-support for compatibility with most webmail services (e.g., Gmail)
- Event logging
- POP3-support [planned]
-
Each of the Motion-Surveillance package components perform independent services that are integrated with the Motion software package.
Motion-Monitor is responsible for starting/stopping the Motion software package.
It does this by periodically scanning a network for the existence of a monitored device(s). This device can be anything that exposes its MAC address on the network (e.g., a mobile phone on a home LAN). In the default case, if that device is found on the network, it's assumed that "someone is home" and so, Motion is not started (or stopped if already running). If that device MAC is no longer found on the network, it's assumed that "nobody is home" and Motion is started (if not already running). Similar logic is used in the reverse case: when a monitored device is once again "back home," Motion is stopped.
Alternatively, the 'Always On' feature, if enabled, uses time-of-day to start/stop the Motion software package. Motion-Monitor will look at the time range specified, and if the current time falls between the time range, Motion will be activated. Once the current time falls outside of the specified time range, Motion is then stopped. The optional 'Always On' feature works in conjunction with IoT device detection.
Operationally, Motion-Monitor is comprised of three component objects (or actors):
- System: a system cron job that periodically wakes up the MotionMonitorManager component
- MotionMonitorManager: checks to see if MotionMonitorDaemon is running, and if it isn't, determines whether it should. The MotionMonitorManager component is responsible for starting the Motion software package
- MotionMonitorDaemon: while Motion is active, periodically checks to see if it should continue to run, and stops it if necessary
The activity diagram below shows the work flow for each of these components:
Note: additional information about the Motion-Monitor component can be found in the Motion-Surveillance installation file (
INSTALL.md).
Motion-Mail is the Motion-Surveillance component responsible for sending an email whenever a valid movement event is triggered in Motion.
These events are triggered through the on_picture_save command and the on_movie_end command in Motion and are how Motion-Mail gets called.
The syntax for these Motion commands are:
<on_picture_save|on_movie_end> <absolute path to ruby> <absolute path to motion_mail.rb> <%D %f %t>
These commands are managed through the Motion configuration file called motion.conf.
Once configured, Motion-Mail will respond to these Motion event hooks, and an email will be generated and sent along with an optional image file or video clip.
Note: additional information about the Motion-Mail component can be found in the Motion-Surveillance installation file (
INSTALL.md).
- A Linux-based operating system
- While Motion-Surveillance was written and tested under Linux (Ubuntu 14.04 LTS), there should be no reason why this won't work just fine under other Linux distributions. Specific Unix-like tools used by Motion-Surveillance include:
- Motion correctly installed and configured with appropriate video devices
- Ruby (2.0+) correctly installed and configured
For complete details on Motion-Surveillance installation, see the installation file (INSTALL.md).
The MIT License (MIT)
Copyright (c) Business Learning Incorporated
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.