electric_eye 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 681ad7ca61fc217562ed5aadb036c3d234518e5a
-  data.tar.gz: 83c70fdbc5eada7fa3fe7ec1492e60fbb2f89625
+  metadata.gz: b2affb0dc95af7bf5563442e3d984bad0011a6e2
+  data.tar.gz: 71cb8b06d07557218df843b86121cd3e3685a124
 SHA512:
-  metadata.gz: 6c9d1e40e8de47dd9b5773d2cee132912a9c71f432c1c15849622d854a2958c0e00528d51371b15788d53ef037b96455783d5d1b5536b4cf18d961f3babada4b
-  data.tar.gz: dec64f404a955f65b6487cc5fcc7c99fc2d44954b3129770e0486474d9ad37dfdec2f43043343c796dcbb6590622cff00dd5cf0598a1980f81ef0e533a6e1724
+  metadata.gz: b6eef4c40c21ddfcb1f66428e60a9cba2388718d65bbd25d09fb579aebe64500266d795c26cb5dd196fa186372838215d754d9d737f219e631c45d20ea312851
+  data.tar.gz: 258b468cef8ce9839000b1be4b38dab26f4f8345230b76cac884b714ba41ffd3f12c02233b8ef8c1e371e1c34018cb81bc969679f7aa4c91bcbf88a0f47b6bd9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    electric_eye (0.0.2)
+    electric_eye (0.0.4)
       construct
       methadone (~> 1.9.0)
       open4

data/README.org

@@ -2,6 +2,8 @@
 
 A network video recorder for multiple IP cameras using VLC.
 
+[[http://mlug-au.org/doku.php/workshops/electric_eye_mpd][MLUG presentation slides on electric_eye]]
+
 ** History
 
 I've been using Zoneminder & motion and these programs are either too large for my requirements (zoneminder) or don't work with the cameras I own (motion). What I did notice is all my cameras work through VLC with high resolution and VLC can record. 
@@ -10,7 +12,8 @@ The problem was though VLC doesn't automate the recordings or handle the file st
 
 ** Requirements
 
-- VLC
+- VLC  - recording & motion detection
+- xvfb - Running virtual frame buffers (ie: desktops)
 - ruby
 - Linux (Tested on Debian 7)
 
@@ -62,15 +65,19 @@ The default is going to be 10 minute blocks, this can be overridden with the dur
 
 First make sure you add your cameras
 
-: electric_eye add Reception <url>
+: electric_eye -a Reception <url>
 
 Now start the daemon to start the recording process
 
-: electric_eye start
+: electric_eye -s
+
+Start with debug messages
+
+: electric_eye -s --log-level=debug
 
 Stop all recordings
 
-: electric_eye stop
+: electric_eye -k
 
 Usage in development mode
 
@@ -143,18 +150,23 @@ Example for cleaning up reception after 60days at 7pm everynight.
 5. Create a new Pull Request
 
 ** TODO
+   :PROPERTIES:
+   :CREATED:  [2015-07-01 Wed 16:37]
+   :END:
 
-- [ ] Add more testing
+- [X] Add more testing
 
-- [ ] Add post recording motion detection (using [rmotion](https://github.com/rikiji/rmotion))
+- [X] Add post recording motion detection (use vlc)
+
+- [X] Make sure we cannot add blank cameras
+
+- [X] Create threshold as a variable
 
 - [ ] Add a feature to clean up old recordings using a "period" setting
   EG: 60 day period which could be set in the config file how many days you want to keep
   Then just call 'electric_eye --remove-recordings' within crontab
   This would iterate over all my cameras and remove old recordings to keep a rolling set of days.
 
-- [ ] Make sure we cannot add blank cameras
-
 - [ ] Allow different recording programs like raspicam
 
 - [ ] Do inline motion detection (using activevlc)

data/bin/electric_eye

@@ -28,6 +28,10 @@ class App
       @record.start
     elsif options[:k]           # Stop recordings
       @record.stop
+    elsif options[:t]
+      @configEye.set_threshold(options[:threshold])
+    else
+      puts opts.help
     end
     
     exit 0
@@ -41,10 +45,11 @@ class App
   on("-a", "--add", "Add a camera") 
   on("-r", "--remove", "Remove a camera")
   on("-l", "--list", "List cameras")
-  on("-d", "--duration SECONDS", "Set recording duration in seconds")
+  on("-d", "--duration SECONDS", "Set recording duration in seconds (default: 600)")
   on("-p", "--path DIR", "Set recordings path")
   on("-s", "--start", "Start recordings")
   on("-k", "--stop", "Stop recordings")
+  on("-t", "--threshold LEVEL", "Set threshold for motion detection (default: 2)")
 
   # Arguments
   arg :camera, :optional

data/features/electric_eye.feature

@@ -13,11 +13,12 @@ Feature: Electric Eye
     | camera | which is optional |
     | url    | which is optional |
     And the following options should be documented:
-    | --add      |
-    | --remove   |
-    | --duration |
-    | --path     |
-    | --list     |
-    | --start    |
-    | --stop     |
+    | --add       |
+    | --remove    |
+    | --duration  |
+    | --path      |
+    | --list      |
+    | --start     |
+    | --stop      |
+    | --threshold |
 

data/lib/electric_eye/config_eye.rb

@@ -19,7 +19,7 @@ module ElectricEye
       if File.exist?(CONFIG_FILE)
         Construct.load File.read(CONFIG_FILE)
       else
-        Construct.new({duration: 600, path: '~/recordings', cameras: []})
+        Construct.new({duration: 600, path: '~/recordings', threshold: 2, cameras: []})
       end
     end
 
@@ -30,9 +30,15 @@ module ElectricEye
 
     # Add camera
     def add_camera(camera, url)
-      @config.cameras.push({name: camera, url: url})
-      save
-      info "Camera added"
+      if camera.nil?
+        warn "NO camera given"
+      elsif url.nil?
+        warn "NO url given"        
+      else
+        @config.cameras.push({name: camera, url: url})
+        save
+        info "Camera added"
+      end
     end
 
     # Remove camera
@@ -58,6 +64,13 @@ module ElectricEye
       info "Duration set to #{seconds} seconds"
     end
 
+    # Set threshold
+    def set_threshold(level)
+      @config.threshold = level.to_i
+      save
+      info "Threshold set to #{level} objects"
+    end
+
     # Set path
     def set_path(dir)
       @config.path = dir

data/lib/electric_eye/motion.rb

@@ -0,0 +1,44 @@
+require 'methadone'
+require 'open4'
+require 'fileutils'
+
+module ElectricEye
+  class Motion
+    include Methadone::CLILogging
+
+    # Detect if there is motion given the results
+    #
+    # path = the log file which is created by vlc with the movementdetect lines in.
+    # threshold is how many objects are moving at once expressed by vlc.
+    #
+    def detect(path, threshold = 2)
+      results = read_log(path)
+      results.each {|line| return true if movement(line) >= threshold}
+      return false
+    end
+
+    # Create the log file using vlc
+    def create_log(path)
+      # Use Xvfb which opens up a virtual desktop to dump a GUI screen we don't want to see.
+      # -a = select the next available display
+      `xvfb-run -a cvlc --no-loop --play-and-exit --video-filter=motiondetect -vvv #{path}.mjpeg > #{path}.log 2>&1`
+    end
+
+    # Read in the log file and return the motiondetect lines
+    def read_log(path)
+      results = []
+      if File.exists?(path)
+        File.readlines(path).each do |line|
+          results.push line.chomp if line =~ /motiondetect filter/
+        end
+      end
+      results
+    end
+
+    # Get the movement amount from the string
+    def movement(line)
+      line.slice!(/\[.*\]/)   # Remove the number in brackets at the start of the string
+      line.slice(/\d+/).to_i  # Get the movement
+    end
+  end
+end

data/lib/electric_eye/record.rb

@@ -12,6 +12,8 @@ module ElectricEye
     end
 
     def start
+      @motion = Motion.new      # Create a new instance method to our motion library
+      
       pids = []
       # Step through each camera
       @configEye.config.cameras.each do |camera|
@@ -21,10 +23,11 @@ module ElectricEye
           stop_recording = false
           Signal.trap('INT') { stop_recording = true }
           until stop_recording
-            debug "Recording #{camera[:name]} to #{path(camera)}..."
-
+            path = "#{path(camera)}"
+            debug "Recording #{camera[:name]} to #{path}.mjpeg..."
+            
             # Set a recording going using vlc, hold onto the process till it's finished.
-            cmd="cvlc --qt-minimal-view --no-audio -R #{camera[:url]} --sout file/ts:#{path(camera)}"
+            cmd="cvlc #{camera[:url]} --sout file/ts:#{path}.mjpeg"
             pid,stdin,stdout,stderr=Open4::popen4(cmd)
 
             # Wait for a defined duration from the config file.
@@ -37,14 +40,34 @@ module ElectricEye
             
             Process.kill 9, pid # Stop current recording.
             Process.wait pid    # Wait around so we don't get Zombies
+
+            # Look for any motion
+            Thread.new(path) do |threadPath| 
+              @motion.create_log(threadPath) # Create the motion detection log file.
+
+              # Remove the log & recording if there is no motion
+              if @motion.detect("#{threadPath}.log", @configEye.config.threshold)
+                debug "KEEP #{threadPath}.mjpeg (motion)"
+              else
+                remove(threadPath)
+              end
+            end
           end
         end
+        
       end
 
       store_pids(pids)
       info "Cameras recording"
     end
 
+    # Remove a recording
+    def remove(path)
+      debug "REMOVE #{path}.mjpeg (no motion)"
+      File.delete("#{path}.log")
+      File.delete("#{path}.mjpeg")
+    end
+    
     def stop
       stop_recordings(get_pids) if File.exist?(PID_FILE)
     end
@@ -62,7 +85,7 @@ module ElectricEye
     def path(camera)
       dir = "#{@configEye.config.path}/#{camera[:name]}"
       FileUtils.mkdir_p(dir) unless Dir.exist?(dir)
-      "#{dir}/#{Time.now.strftime('%Y%m%d-%H%M')}-#{camera[:name]}.mjpeg"
+      "#{dir}/#{Time.now.strftime('%Y%m%d-%H%M')}-#{camera[:name]}"
     end
 
     def initialize(configEye)

data/lib/electric_eye/version.rb

@@ -1,3 +1,3 @@
 module ElectricEye
-  VERSION = "0.0.3"
+  VERSION = "0.0.5"
 end

data/lib/electric_eye.rb

@@ -2,6 +2,7 @@ require "electric_eye/version"
 require "electric_eye/settings"
 require "electric_eye/config_eye"
 require "electric_eye/record"
+require "electric_eye/motion"
 
 module ElectricEye
 

data/man/electric_eye.1

@@ -79,7 +79,7 @@ Stop recordings
 $ electric_eye \-k
 .
 .SH "AUTHOR"
-Michael Pope (map7777@gmail\.com)
+Michael Pope \fImap7777@gmail\.com\fR
 .
 .SH "SEE ALSO"
-VLC (https://www\.videolan\.org/vlc/)
+VLC \fIhttps://www\.videolan\.org/vlc/\fR

data/man/electric_eye.1.html

@@ -120,11 +120,11 @@ duration of the recordings is set by the user (default is 10minutes).</p>
 
 <h2 id="AUTHOR">AUTHOR</h2>
 
-<p>Michael Pope (map7777@gmail.com)</p>
+<p>Michael Pope <a href="&#x6d;&#x61;&#x69;&#x6c;&#x74;&#x6f;&#58;&#x6d;&#x61;&#112;&#x37;&#x37;&#x37;&#55;&#x40;&#x67;&#x6d;&#97;&#105;&#x6c;&#x2e;&#x63;&#x6f;&#109;" data-bare-link="true">&#x6d;&#x61;&#112;&#55;&#55;&#x37;&#x37;&#64;&#103;&#109;&#x61;&#x69;&#x6c;&#x2e;&#x63;&#111;&#x6d;</a></p>
 
 <h2 id="SEE-ALSO">SEE ALSO</h2>
 
-<p>VLC (https://www.videolan.org/vlc/)</p>
+<p><a href="https://www.videolan.org/vlc/">VLC</a></p>
 
 
   <ol class='man-decor man-foot man foot'>

data/man/electric_eye.1.ronn

@@ -51,9 +51,9 @@ Stop recordings<br>
 
 ## AUTHOR
 
-Michael Pope (map7777@gmail.com)
+Michael Pope <map7777@gmail.com>
 
 ## SEE ALSO
 
-VLC (https://www.videolan.org/vlc/)
+[VLC](https://www.videolan.org/vlc/)
 

data/spec/config_spec.rb

@@ -89,15 +89,27 @@ describe "add camera" do
   before do
     @configEye = ConfigEye.new
   end
-  
-  it "adds camera to array" do
-    @configEye.add_camera("Reception", "http://user:pass@my.camera.org/live2.sdp")
-    expect(@configEye.config.cameras.length).to equal(1)
+
+  context "when both name & url provided" do
+    it "adds camera to array" do
+      @configEye.add_camera("Reception", "http://user:pass@my.camera.org/live2.sdp")
+      expect(@configEye.config.cameras.length).to equal(1)
+    end
+
+    it "calls save" do
+      expect(@configEye).to receive(:save).once
+      @configEye.add_camera("Reception", "http://user:pass@my.camera.org/live2.sdp")
+    end
   end
 
-  it "calls save" do
-    expect(@configEye).to receive(:save).once
-    @configEye.add_camera("Reception", "http://user:pass@my.camera.org/live2.sdp")
+  context "when only name provided" do
+    it "returns an error" do
+    end
+
+    it "doesn't call save" do 
+      expect(@configEye).to receive(:save).never
+      @configEye.add_camera("Reception", nil)
+    end
   end
 end
 
@@ -188,3 +200,30 @@ describe "set_path" do
   end
 end
 
+describe "set_threshold" do
+  include FakeFS::SpecHelpers
+
+  before do
+    @configEye = ConfigEye.new
+  end
+
+  context "when no threshold has been set" do
+    it "returns the default of 2 objects" do
+      expect(@configEye.config.threshold).to equal(2)
+    end
+  end
+
+  context "when calling with -d 3" do
+    it "returns 3" do
+      @configEye.set_threshold(3)
+      expect(@configEye.config.threshold).to equal(3)
+    end
+
+    it "calls save" do
+      expect(@configEye).to receive(:save).once
+      @configEye.set_threshold(3)
+    end
+  end
+end
+
+