npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

pir

v0.2.0

Published

Node library for PIR motion detector

Downloads

6

Readme

PIR Motion Detector

Node library for PIR sensor

For Tessel 1, use version 0.1.0 of this package.

I used this one from Adafruit.

Adafruit has a lovely writeup on how PIRs work; I encourage you to read the details here. Here are some of the key pieces of information:

  • IR detects warm bodies.
  • There are two beams of IR sensitivity on the PIR.
  • If both beams detect the same amount of IR, the sensor records that no warm bodies are present.
  • When a warm body enters the field, the sensor records a positive charge differential.
  • When a warm body leaves the field, the sensor records a negative charge differential.

Materials

Connecting

The PIR I used has three pins. Here's how you connect it to Tessel:

  • +5V on the PIR goes to 5V. Here is a post on how to access 5V on Tessel 2.
  • GND goes to GND on the Tessel port you are using.
  • OUT, the signal pin, goes to any of Tessel's various digital pins. Note that the signal works on a maximum of 3.3V.

I've left the PIR sensor in the retriggering position (H for the Adafruit one), so the signal pin will be pulled high as long as the sensor detects movement.

Installation

npm install pir

Example

/*********************************************
This basic PIR example emits events when
a body is detected and when a body exits
the field.
*********************************************/

const tessel = require('tessel');
const pir = require('pir').use(tessel.port.A.pin[2]);

pir.on('ready', pir => {
  console.log('Ready and waiting...');
  pir.on('movement:start', time => {
    console.log(`Something moved! Time ${time}`);
  });
  pir.on('movement:end', time => {
    console.log(`All is still. Time ${time}`);
  });
});

Methods

# pir.read( [callback(data)] )
Reads the value of the pin: 1 for movement; 0 for stillness. Returns the value or outputs to callback.

Events

# pir.on( 'ready', callback(err, pir) )
Emitted when the pir object is first initialized

# pir.on( 'movement', callback(time) )
Emitted when movement is first detected.

# pir.on( 'movement:start', callback(time) )
Alias of movement.

# pir.on( 'stillness', callback(time) )
Emitted at the onset of stillness.

# pir.on( 'movement:end', callback(time) )
Alias of stillness.

# pir.on( 'change', callback(time, value) )
Emitted whenever the state changes. value is the pin.read value after the change.

Properties

# pir.movement
true while movement detected; false while no movement detected

Licensing

Copyright Kelsey Breseman, Apache 2.0 Licensed.