phidget

Node.js bindings for the Phidget line of USB sensor and control interfaces.

npm install phidget
3 downloads in the last month

Phidget

Node.js bindings for the Phidget line of USB sensor and control interfaces.

The phidget module provides a simple way to to communicate with Phidget boards via Node. Rather than rely on Phidget's webserver interface, the module is based on Phidget's own C++ library using a series of C++ bindings leveraging node-gyp which make it both easy to configure and pretty speedy when compaired to using TCP/IP.

To Install

First, make sure you have installed the Phidgets driver on your system. Then,

npm install phidget

Basic Use

In meatspace:

- Attach a servo to connector "0" on your [Phidget Advanced Servo](http://www.phidgets.com/products.php?category=11&product_id=1066_0) board
- Plug-in your board via USB

Meanwhile, in javascript land:

var phidget = require('phidget');

var servo = new phidget.servo();
servo.attach(function (err) {
    servo.setEngaged(0, true, function (err) {
        servo.setPosition(0, 90, function (err) {
            servo.setPosition(0, 180, function (err) {
                // It's alive!
            });
        });
    });
});

Documentation

The JS and C++ is pretty thoroughly commented and furthermore tries to follow the Phidget21 C API conventions where reasonable. While the project is in this early state, reading through the source code comments is a good way to get up and running with each device as it becomes available. That said, I have started a wiki with examples for each device.

Currently Supported Devices

In Progress

  • RFID
  • 8/8/8 Interface Kit
  • Bipolar Stepper Controller

To Test

npm test

Contribution

Want to contribute? OMGFTWBBQ you're awesome! ...but, please try to follow these common sense guidelines:

  • Write a test
  • Follow the established format conventions
  • Comment your code

FAQ

  • Will this work with the Arduino? Nope. But there are already a couple really great Node.js projects for the Arduino that you should check out.

  • Why Phidgets? I've used Phidgets for a number of strange things over the years – from installations in football stadiums to traveling exhibits to even toy prototypes and have found them to be particularly easy to work with and generally robust given how inexpensive they are. The phidget21 C library is also well documented and provides a good base on which to build bindings.

npm loves you