Skip to content

Latest commit

 

History

History
57 lines (43 loc) · 1.87 KB

README.md

File metadata and controls

57 lines (43 loc) · 1.87 KB
Raw

node-pi-motion

This module uses pi-motion-lite to detect movement on a RaspberryPi.

Installation

To install type

npm install node-pi-motion

EXAMPLE USAGE

var PiMotion = require('node-pi-motion');

var options = {
  verbose: true,
  throttle: 200
}

var nodePiMotion = new PiMotion(options);

nodePiMotion.on('DetectedMotion', function() {
  console.log('Motion detected! Now do something.');
});

OPTIONS

General

  • verbose - If true the pi-motion-lite script will output its debug info. (default: false)
  • pythonPath - The path where python is installed on your machine (default: /usr/bin/python)
  • autorestart - If true the pi-motion-lite script will automatically keep getting restarted on exit (default: false)
  • debug - Assign a value in ms and the DetectedMotion event will be automatically triggered with that interval. When in debug mode the node-motion-lite script is never actually ran (default: false)

Camera

  • throttle - Set a value in ms to enable throttling on motion detection events. (default: 0)
  • night - If true the script will apply night modifiers to the camera. (default: false)
  • sensitivity - How Many pixels need to change for motion detection. (default: 200)
  • threshold - How Much a pixel has to change. (default: 10)
  • sleep - Time between photos comparisons in seconds (default: 1)

Usage

Simply create a new nodePiMotion instance and start listening on events.

Once you are done you can terminate the python script with

nodePiMotion.close();

Events

nodePiMotion.on('ready', function(){})    // called when the script is ready and is starting to detect motion
nodePiMotion.on('DetectedMotion', function(){})   // called when the script detects motion 
nodePiMotion.on('error', function(err){})   // called when the script errors