JavaScript in Node.js
Welcome to using Phidgets with JavaScript! By using JavaScript, you will have access to the complete Phidget22 API, including events.
Node.js is an open-source, cross-platform JavaScript run-time environment that allows programs written in JavaScript to be run locally.
Requirements
If you're on MacOS and plan on using any USB Phidgets that use the HID stack, you'll need to install the
Phidget drivers for MacOS. You can check which stack your USB Phidgets use by checking the 'USB Stack'
in the product specifications. If all of your Phidgets use the PHIDUSB stack or you're on Windows or Linux, you can skip installing the drivers since they're
packaged with the Javascript libraries.
● Node.js
Version History
1.x.x - Initial Release (unstable- highly recommend updating to 2.x.x or newer)
2.x.x - Fixed stability issues
3.x.x - Added WebUSB support for VINT devices
Each release has potential breaking changes, so you should always revisit your code when updating to a new major release.
JavaScript using the Phidget Network Server
Go to the this page and select the tab with your OS to get the
Network Server set up.
The Phidget Server includes a built-in Webserver. This must be enabled when using the JavaScript library in browser, but can be left disabled when using the
library from Node.js.
The Phidget Server Webserver can be used to serve files - such as the Phidget JavaScript library, or your own projects. By default, it serves the JavaScript
control panel files.
In order to connect remotely, you need to use the NetworkConnection object. When you download a code sample later in this guide, make sure the
Remote box is checked.
JavaScript using WebUSB
For library version 3.x.x or newer, you can connect to Phidgets plugged in locally via USB without having the Network Server running. This feature is only
supported on Phidgets that use the PHIDUSB stack. You can see which stack your USB Phidgets use by checking the specifications table.
In order to connect using USB, you need to use the USBConnection object. When you download a code sample later in this guide, make sure the
Remote box is unchecked.
JavaScript Control Panel
The JavaScript control panel is a Browser version of our Phidget control panel. This can be used to view and control all Phidgets attached to a Phidget server.
The JavaScript control panel is installed by default on Windows, macOS and PhidgetSBC. You can also download the source
here.
Make sure the Phidget Server - Webserver is enabled, and running, then navigate to http://localhost:8989. (If you changed
the port setting on the Webserver, replace '8989' with your selected port)
JavaScript Control Panel
You will now see a program written with JavaScript/HTML that mimics the Phidget Control Panel. It will show all the Phidgets attached to your machine. By
double-clicking on the Phidgets, and example will launch.
Using the Code Samples
Now that you've confirmed the webserver is running properly by testing your Phidgets through the JavaScript Control Panel, you can try running some of our
sample code. On the Code Samples page and select your device from the drop-down menu.
Using the Code Samples
If it's unclear what any of the options do, click on the nearby '?' for more info.
Once you've made your selections, click the Download Example button to download a sample script.
Using the Code Samples
Next, unpack the example and open the command prompt in the folder you extracted to and enter the following commands:
npm install phidget22
npm update
Then enter the following command to run the example (replacing example.js with your example name):
node example.js
Success! Your program is now running with Phidgets.
What's Next?
Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.
