NodeJS Interface for VEC Footpedal
npm install vec-footpedalA Library to use VEC Footpedal in Node.js projects without a driver. This device was originally manufactured by PI Engineering.
_This library supports multiple devices connected at one time via simply including a hash of the device id for each event as the final parameter in the callback._
sh
npm install vec-footpedal
`Usage
javascript
const pedal = require('vec-footpedal');pedal.on('connected', (deviceInfo) => {
console.log('Connected to ' + deviceInfo.name);
});
// Start after 'connect' event listener has been set up
pedal.start();
`API
$3
-
Boolean - whether to monitor for USB devices (true by default)Starts the service and optionally monitors USB device connections for VEC Footpedals. If watchUsb is true, it will find all connected devices.
This should be called after the 'connect' event listener has been declared, otherwise already-connected devices will not be detected.
connect(path)-
String - the device pathIf you're not automatically monitoring for USB devices, use this to connect to a specific device by path.
stop()Stops the service and monitoring. This must be called before your script ends.
Use to retrieve all the devices that are connected.
Returns:
-
- contains the following information:
- id String - either the serial number (if it exists) or the device path, turned into an MD5 hash, used to distinguish between multiple devices that may be connected at once.
- path String - the USB device path
- name String - name of the device ('Footpedal')
- numButtons Integer
getDeviceById(id)-
String - the device idReturns
Object | null:
- id String - either the serial number (if it exists) or the device path, turned into an MD5 hash, used to distinguish between multiple devices that may be connected at once.
- path String - the USB device path
- name String - name of the device ('Footpedal')
- numButtons Integer
getDeviceByPath(path)-
String - the device pathReturns
Object | null:
- id String - either the serial number (if it exists) or the device path, turned into an MD5 hash, used to distinguish between multiple devices that may be connected at once.
- name String - name of the device ('Footpedal')
- numButtons Integer
getRawHidDevice(id)-
String - the device idReturns
Object | null - the raw HID device object
$3
shuttle.on('...', () => {})#### Event:
Emitted when a device has been plugged into a USB port.Returns
:
- id String - either the serial number (if it exists) or the device path, turned into an MD5 hash, used to distinguish between multiple devices that may be connected at once.
- name String - name of the device ('Footpedal')
- numButtons Integer#### Event:
disconnected
Emitted when the device has been unplugged or has failed.Returns
String - either the serial number (if it exists) or the device path, turned into an MD5 hash.#### Event:
buttondown
Emitted when a button is pressed on the device.Returns:
-
Integer - the button number
- id String - either the serial number (if it exists) or the device path, turned into an MD5 hash.#### Event:
buttonup
Emitted when a button is released on the device.Returns:
-
Integer - the button number
- id String - either the serial number (if it exists) or the device path, turned into an MD5 hash.
$3
pedal.vidsAn enumeration of vendor ids for Footpedal devices, namely for VEC:
-
An enumeration of product ids for Footpedal devices:
-
Linux Note
By default, the udev system adds VEC Footpedal as root only access. To fix this, you need to copy 99-VECFootpedal.rules to:
/etc/udev/rules.d