headset/README.md

node library for headsets

# Headset for node
A node.js library for headsets.

## Install
    npm install headset
[*extra steps for node-webkit](#node-webkit)

# Usage
### Get a headset

    var headset = require('headset').get()

Optionally pass you own options to find a headset

    var headset = require('headset').get(options);

### Get all  headsets

    require('headset').devices();

Optionally you can pass true to show all connected USB HID Devices. This can be useful if the Headset is not detected, or if you are trying out this library with unsupported devices.

    require('headset').devices(showUnsupported);

### Events
#### connected
The connected event fires every time a headset connection is made. This will also fire after a automatic / manual reconnect.

    headset.on('connected', function(){
        // it is now safe to write to the headset
    });

    headset.once // use this for code that should only run on the next connect (initialization)

#### disconnected

    headset.on('error', function(err){
        // err contains details
    });

#### Headset specific events
You can also listen to events specified in device configuration. (see supported.json)

    headset.on('accept', function() { //Call accepted });
  
### Methods
#### Connect
The connect method gives you the ability to issue a manual connect. This is done automatically the first time (when you get the headset).

#### Headset specific methods
Methods specficified in a device configuration are also available to use. (see supported.json)
If you are unsure which headset is attached and if it supports a certain method, then check if it exists first.

    if(headset.lightOn)
      headset.lightOn();

### Adding events (handle Reads from USB)
If you test your own unsupported device / features you can add events as follows

    headset.addEvent(name, hexString);


### Adding methods (write to USB)
If you test your own unsupported device / features you can add methods as follows

    headset.addMethod(name, hexString);

### Close method
Use this when you are done using the headset

    headset.close();

# Supports
All USB Headsets with UC or Lync support should work, but only the following have been tested so far.
* Jabra PRO 935
* Jabra PRO 930
* Logitech H820e
* Jabra PRO 9470
* Jabra PRO 9450
* BUA 200M
* Plantronics D100

# Test
Currently testing is just to manually see if a headset works / can be found.
### Trying an unsupported headset
If you want to try an unsupported headset just do npm test and follow the instructions. If a device is found that you can recognize, you can now use the details to manually .get(options) the headset. 
If you find/add a working device it would be great if you report back here under issues or submit a pull request on supported.json.

### <a name="node-webkit"></a>Node-webkit
Headset relies on node-hid. node-hid needs to be built for each platform and specific version of node-webkit, so to make it work you need build node-hid using nw-gyp
https://github.com/rogerwang/node-webkit/wiki/Build-native-modules-with-nw-gyp