upb

usb-panic-button

A simple node.js module for interfacing with USB Panic Button hardware.

Showing:

Popularity

Downloads/wk

1

GitHub Stars

1

Maintenance

Last Commit

5yrs ago

Contributors

0

Package

Dependencies

2

Size (min+gzip)

28.8KB

License

ISC

Type Definitions

Tree-Shakeable

No?

Categories

Readme

usb-panic-button

A node.js module for interfacing with the cool-looking USB Panic Button hardware like this one.

Installation

npm install usb-panic-button

Dependencies

This module needs usb module (which depends on libusb) in order to access the button hardware. On macOS, you can install libusb using homebrew by running:

brew install libusb

Getting Started

Initialize a new PanicButton object and attach listeners to its "pressed" event. A simple example is shown below:

const PanicButton = require('usb-panic-button');
const panicButton = new PanicButton();

panicButton.on('pressed', () => {
  console.log('button pressed!');
});

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100