https://github.com/timothymeadows/rpi-clusterhat
rpi-clusterhat for node.js library designed for https://www.clusterhat.com/
https://github.com/timothymeadows/rpi-clusterhat
Last synced: about 1 year ago
JSON representation
rpi-clusterhat for node.js library designed for https://www.clusterhat.com/
- Host: GitHub
- URL: https://github.com/timothymeadows/rpi-clusterhat
- Owner: TimothyMeadows
- License: mit
- Created: 2017-09-10T00:38:33.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-09-10T04:12:52.000Z (almost 9 years ago)
- Last Synced: 2024-10-30T04:44:15.046Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 9.77 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rpi-clusterhat for node.js
This library was desgined for usage with the [clusterhat](https://clusterhat.com/). 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](#all) - Represents all pi's as a string "all".
# methods
* [led](#led) - Turn on, or off the clusterhat alert LED.
* [on](#on) - Turn on a pi zero.
* [off](#off) - Turn off a pi zero.
# led
This method will turn on, or off the clusterhat alert LED (the blue one)
```javascript
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.
```javascript
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.
```javascript
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.
```javascript
var ClusterHat = require('clusterhat'), clusterhat = new ClusterHat();
clusterhat.on(clusterhat.all);
```
```javascript
var ClusterHat = require('clusterhat'), clusterhat = new ClusterHat();
clusterhat.off(clusterhat.all);
```