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

home-one

v1.5.0

Published

An npm package for Node.js to setup notifcations for simple Raspberry Pi home automation devices

Downloads

10

Readme

home-one.js

Connecting Raspberry Pi devices to your HomeOne portal.

Setup

This module can be installed with npm:

npm install home-one

Also, globally install forever:

sudo npm install forever -g

Usage

Firstly, make sure you are running your application as root or with sudo, else the Raspberry Pi will not output to your HomeOne portal.

Secondly, make sure you have ready the same pubnub keys used on your Home One account.

Before you can read or write, you must create a new object using the "new" keyword, then pass in an object with the following parameters: your pubnub subscribe key, your pubnub publish key, your Home One channel name and the nickname of your HomeOne device.

Example

var homeOne = require('home-one');

var myDevice = new homeOne({
  subscribeKey: "my pubnub subscribe key",
  publishKey: "my pubnub publish key",
  channel: "my Home One channel",
  nickname: "my Home One device title"
});

Methods

switch(pin)

This method takes one parameter that is the GPIO pin number on the Raspberry Pi, and is used for simple on/off sensors.

Example

var homeOne = require('home-one');

var myDevice = new homeOne({
  subscribeKey: "my pubnub subscribe key",
  publishKey: "my pubnub publish key",
  channel: "my Home One channel",
  nickname: "my Home One device title"
});

myDevice.switch(18);

Server

Once the file is ready, we'll be using crontab to start your server using forever. Here are the steps:

  1. From your terminal, type "crontab -u root -e"
  2. Select the editor of your choice
  3. Add the following line to the crontab: "@reboot sudo forever start /your/path/to/your/app.js"
  4. Save the file
  5. From your terminal, type "sudo forever start /your/path/to/your/app.js"

Crontab Example


@reboot sudo forever start /opt/smarthome/index.js