Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript. Learn more »

rpi-clusterhat

1.0.0 • Public • Published

rpi-clusterhat for node.js

This library was desgined for usage with the clusterhat. It is a reflection of clusterhat.sh provided by the vendor but in node.js using gpio pins via gpio-utils (for compatability between pi versions). This library is not affiliated in anyway with the vendor of the clusterhat.

properties

  • p1 - Represents PI 1 as a string "p1".
  • p2 - Represents PI 2 as a string "p2".
  • p3 - Represents PI 3 as a string "p3".
  • p4 - Represents PI 4 as a string "p4".
  • all - Represents all pi's as a string "all".

methods

  • led - Turn on, or off the clusterhat alert LED.
  • on - Turn on a pi zero.
  • off - Turn off a pi zero.

led

This method will turn on, or off the clusterhat alert LED (the blue one)

var ClusterHat = require('clusterhat'), clusterhat = new ClusterHat();
 
clusterhat.led(true);
setTimeout(function() { 
    clusterhat.led(false); 
}, 1000);

on

This method will turn on a pi zero.

Note: There is a 2000ms (2 second) delay between turning pi's on. This is to prevent an excessive spike of power when to many pi's are turned on at once. This time was taken from clusterhat.sh.

var ClusterHat = require('clusterhat'), clusterhat = new ClusterHat();
 
clusterhat.on(clusterhat.p1);

off

This method will turn off a pi zero.

Note: There is no delay when turning off pi's.

var ClusterHat = require('clusterhat'), clusterhat = new ClusterHat();
 
clusterhat.off(clusterhat.p1);

all

This is not a method but an example of using the all property rather than specifying 1 pi zero at a time.

Note: There is a 2000ms (2 second) delay between turning all pi's on. There is however no delay when turning all pi's off.

var ClusterHat = require('clusterhat'), clusterhat = new ClusterHat();
 
clusterhat.on(clusterhat.all);
var ClusterHat = require('clusterhat'), clusterhat = new ClusterHat();
 
clusterhat.off(clusterhat.all);

Keywords

none

install

npm i rpi-clusterhat

Downloadsweekly downloads

2

version

1.0.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability