gpio-components v1.0.4

GPIO Components

A collection of GPIO components written for Node in TypeScript. Supports Linux boards like the Raspberry Pi or BeagleBone.

Contents

• Requirements
• Installation
• Usage
• Documentation
  • LED
  • LEDSwitch
  • RotaryEncoder
  • SevenSegmentDisplay
  • Switch
• Notes
• Special Thanks

Requirements

NodeJS 12.0+

Installation

npm install gpio-components

Usage

const { LED, Switch } = require('gpio-components');

const led = new LED({
  pin: 1
});

const isOn = led.isOn(); // false

led.turnOn();

const isOn = led.isOn(); // true

// ...

const mySwitch = new Switch({
  pin: 2,
  onPress: () => console.log('Pressed!')
});

mySwitch.watch(); // Begin watching for any interrupts

Documentation

LED

Constructor

const { LED } = require('gpio-components');

const led = new LED({ pin: 1 });

LEDConfig:

Methods

LEDSwitch

Constructor

const { LEDSwitch } = require('gpio-components');

const ledSwitchConfig = {
  ledPin: 1,
  switchPin: 2,
  onPress: () => console.log('Pressed!')
};

const ledSwitch = new LEDSwitch(ledSwitchConfig);

LEDSwitchConfig:

Methods

RotaryEncoder

Note:

This implementation of a Rotary Encoder is for a three pin Rotary Encoder.

Constructor

const { RotaryEncoder } = require('gpio-components');

const rotaryEncoderConfig = {
  pinA: 1,
  pinB: 2,
  onIncrement: () => console.log('Incremented!'),
  onDecrement: () => console.log('Decremented!'),
  onAlways: () => console.log('Turned!')
};

const encoder = new RotaryEncoder(rotaryEncoderConfig);

RotaryEncoderConfig:

Methods

SevenSegmentDisplay

Note:

This implementation of a Seven Segment Display assumes usage along side of single-digit BCD-to-7-segment decoder circuit (e.g CD4055).

Constructor

const { SevenSegmentDisplay } = require('gpio-components');

const sevenSegmentDisplayConfig = {
  pinZero: 1,
  pinOne: 2,
  pinTwo: 3,
  pinThree: 4
};

const display = new SevenSegmentDisplay(sevenSegmentDisplayConfig);

SevenSegmentDisplayConfig:

Methods

Switch

Constructor

const { Switch } = require('gpio-components');

const switchConfig = {
  pin: 1,
  onPress: () => console.log('Pressed!')
};

const mySwitch = new Switch(switchConfig);

SwitchConfig:

Methods

switchOptions

Notes

Each component has a function called cleanUp which should only be called when the program is terminated or if the component is no longer expected to be interacted with. Generally, you'd use it like this:

const { LED } = require('gpio-components');

const led = new LED({ pin: 1 });

// ...

process.on('SIGINT', _ => {
  led.cleanUp();
});

Special Thanks

Many thanks to Brian Cooke for his excellent library onoff which without would have made this library not possible -- or at least much more difficult. Also thanks for my friend Gene Crocetti for his help with the hardware-side of this project. Without him as well, this would not have been possible.