vermon
Formerly the t-motion-detector package, now named vermon
Last updated 9 months ago by tcardoso .
BSD-2-Clause · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install vermon 
SYNC missed versions from official npm registry.

NPM info

Travis build status dependencies

Unit tests

vermon

A NodeJS Motion detector, initially aimed for Raspberry Pi. The Motion Detectors detect changes in the Environment and the Notifiers receive the Motion Detectors' event changes.
NOTE: this code has only been tested in the following Linux OS:

  • Raspbian: using Node ARMv7
  • OSX: Tests and code runs / works where no real sensors are involved

  • STEP 1 : Create your config.js file and define the default profile of your app:
profiles = {
  default: {
    Environment: {},
    PIRMotionDetector: {
      pin: 17
    },
    MotionDetector: [{
      name: "MD 1"
    },
    {
      name: "MD 2"
    }],
    SlackNotifier: {
      name: "My Slack channel",
      key: "https://hooks.slack.com/services/<MySlackURL>"
    },
    HighPassFilter: [{
      val : 8,
      applyTo: "MD 1"
    },
    {
      val : 5,
      applyTo: "MD 2"
    }]    
  }
}

exports.profiles = profiles;
exports.default = profiles.default;
  • STEP 2 : Add your main file
let md = require('t-motion-detector');
let config = new md.Config(__dirname + '/config.js', false);

md.StartWithConfig(config, (e,d,n,f)=>{
  console.log(`Good to go! My environment is ${e}, detectors are ${d}, notifiers ${n} and filters ${f}`);
});

Featured detectors:

PIRMotionDetector

PIRMotionDetector
//Sends a Slack message if the PIR sensor detects movement
profiles = {
  default: {
    Environment: {},
    PIRMotionDetector: {
      pin: 4
    },
    SlackNotifier: {
      name: "My Slack channel",
      key: "https://hooks.slack.com/services/<MySlackURL>"
    }
  }
}
exports.profiles = profiles;
exports.default = profiles.default;

FileDetector

FileDetector
//Sends a Slack message if any file is added, removed or changed in the "photos" folder
profiles = {
  default: {
    Environment: {},
    FileDetector: {
      name: "File Detector",
      path: "photos",
      sendOld: false
    },
    SlackNotifier: {
      name: "My Slack channel",
      key: "https://hooks.slack.com/services/<MySlackURL>"
    }
  }
}
exports.profiles = profiles;
exports.default = profiles.default;

From version 0.3.3 onwards, it is possible to attach a Notifier based on node-raspistill, RaspistillNotifier, which means you can use your Raspberry pi camera to take pictures when movement is detected. Here's an example which takes a snapshot once the Raspberry pi detects movement via the PIRMotionDetector connected to pin 17 (requires a sensor like the Infrared motion sensor HC-SR501):

let md = require('t-motion-detector');

let env = new md.Entities.Environment();
initialMD = new md.Extensions.PIRMotionDetector(17); //Rpi listens on pin 17 for incoming signals from the PIR sensor
md.Start({
	environment: env,
	initialMotionDetector: initialMD
});

camNotifier = new md.Extensions.RaspistillNotifier();
md.AddNotifier(camNotifier); //Rpi will take a picture if the PIR sensor detects movement

Unit tests: t-motion-detector uses mocha unit tests to test the detector, notifier and environment classes. I'll be adding more on the go. to test use "npm test"

Links

Current Tags

  • 0.7.10                                ...           latest (9 months ago)

20 Versions

  • 0.7.10                                ...           9 months ago
  • 0.7.8                                ...           a year ago
  • 0.7.7                                ...           a year ago
  • 0.7.6                                ...           a year ago
  • 0.7.5                                ...           a year ago
  • 0.7.4                                ...           a year ago
  • 0.7.3                                ...           a year ago
  • 0.7.0                                ...           2 years ago
  • 0.6.17                                ...           2 years ago
  • 0.6.15                                ...           2 years ago
  • 0.6.9                                ...           2 years ago
  • 0.6.8                                ...           2 years ago
  • 0.6.7                                ...           2 years ago
  • 0.6.6                                ...           2 years ago
  • 0.6.5                                ...           2 years ago
  • 0.6.4                                ...           2 years ago
  • 0.6.1                                ...           2 years ago
  • 0.6.0                                ...           2 years ago
  • 0.5.46                                ...           2 years ago
  • 0.5.45                                ...           2 years ago
Maintainers (1)
Downloads
Today 0
This Week 1
This Month 1
Last Day 1
Last Week 0
Last Month 0
Dependencies (23)
Dependents (2)

Copyright 2014 - 2016 © taobao.org |