Language - JavaScript: Difference between revisions

Revision as of 18:52, 7 February 2018

Quick Downloads

Documentation

Phidget22 API (Select JavaScript from drop-down menu)

Example Code

Libraries

JavaScript Library Download

Getting Started with JavaScript

Welcome to using Phidgets with JavaScript! By using JavaScript, you will have access to the complete Phidget22 API, including events. We also provide example code in JavaScript for all Phidget devices.

If you are developing for Windows, keep reading. Otherwise, select your operating system to jump ahead:

macOS
Linux

Windows

If you haven't already, please visit the Windows page before you continue reading. There you will be instructed on how to properly set up your Windows machine so you can follow the guides below!

Browser

Use Our Examples

One of the best ways to start programming with Phidgets is to use our example code as a guide. Our browser examples are graphical and are installed with the Phidget libraries. In order to check them out, first open the Phidget Control Panel and navigate to the Network Server tab:

Next, make sure the Webserver is enabled (Enabled checkbox in Webserver section), and start the Phidget Network Server by clicking on the Start button at the bottom of the window. Click on the hyperlink as shown in the image below (or navigate to http://localhost:8989):

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:

To view the source code that drives the examples, navigate to the following location:

C:/Program Files/Phidgets/Phidget22/html

Here you can view the code that was written to create the main webpage as well as all of the examples.

Write Your Own Code

Let's start by writing a simple HTML page that makes a dynamic list of attached Phidgets visible to the user. We will be using the JavaScript library jQuery in these examples. jQuery is not required in order to use Phidgets, however, it will make it easier for us to access elements on an HTML page.

To start, create a new folder that looks like this:

The referenced libraries are installed with the Phidget libraries and can be found at the following location:

C:/Program Files/Phidgets/Phidget22/html

Next, create a file called index.html and copy the following code into it (Note: if you have newer JavaScript libraries, modify the code below to match your version numbers):

<!DOCTYPE html>
<html>
<head>
<title>Javascript Test Program</title>
<script src="jquery-2.1.4.min.js"></script>
<script src="sha256.js"></script>
<script src="jphidgets22.1.0.0.min.js"></script>

<script>

	$(document).ready(function () {
		var conn = new jPhidgets.Connection('ws://' + window.location.host + '/phidgets', { name: window.location.host });

		conn.connect().then(function () {
			console.log('connected');
		}).catch(function (err) {
			alert('failed to connect to server:' + err);
		});;

		conn.onattach = function(dev) {
			$('#list').append(new Option(dev.name,dev.phid));
		}

		conn.ondetach = function(dev) {
			$("#list option[value='" + dev.phid + "']").remove();
		}
	});

</script>
</head>

<body>
	<label> Attached Phidgets: </label>
	<div>
		<select multiple id="list" style="width: 500px;"></select>
	</div>
</body>
</html>

After copying the code above into your index.html file, your folder should look like this:

Next, open the Network Server tab in the Phidget Control Panel and modify the Webserver Docroot to your folders location:

Finally, click on the hyperlink to see the example (or navigate to http://localhost:8989):

Open the developer console to get a better idea what is going on:

For information about the Node.js examples, keep reading. Otherwise, skip ahead to the edit the examples section located below.

Node.js

Use Our Examples

One of the best ways to start programming with Phidgets is to use our example code as a guide. In order to run the examples, you will need to download and install Node.js.

Now that you have Node.js installed, select an example that will work with your Phidget:

JavaScript Examples

Next, navigate to the Network Server tab in the Phidget Control Panel and press the Start button after ensuring the Phidget Server is enabled (Enabled checkbox in Phidget Server section).

Navigate to the example folder that you previously downloaded, open the command prompt at this location and enter the following command:

npm update

Next, enter the following command to run the example (replacing Accelerometer with your example name):

node Accelerometer localhost

You should now have the example up and running. When you are ready, the next step is editing the examples.

macOS

Browser Example

Use Our Examples

One of the best ways to start programming with Phidgets is to use our example code as a guide. Our browser examples are graphical and are installed with the Phidget libraries. In order to check them out, first open the Phidget Control Panel and navigate to the Network Server tab:

Next, make sure the Webserver is enabled (Enabled checkbox in Webserver section), and start the Phidget Network Server by clicking on the Start button at the top of the window. A button labelled View in Browser... will appear. Click on it now (or navigate to http://localhost:8989).

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:

To view the source code that drives the examples, navigate to the following location:

/Library/Application Support/Phidgets/Phidget22NetworkServer/html

Here you can view the code that was written to create the main webpage as well as all of the examples.

Write Your Own Code

Let's start by writing a simple HTML page that makes a dynamic list of attached Phidgets visible to the user. We will be using the JavaScript library jQuery in these examples. jQuery is not required in order to use Phidgets, however, it will make it easier for us to access elements on an HTML page.

To start, create a new folder that looks like this:

The referenced libraries are installed with the Phidget libraries and can be found at the following location:

/Library/Application Support/Phidgets/Phidget22NetworkServer/html

Next, create a file called index.html and copy the following code into it (Note: if you have newer JavaScript libraries, modify the code below to match your version numbers):

<!DOCTYPE html>
<html>
<head>
<title>Javascript Test Program</title>
<script src="jquery-2.1.4.min.js"></script>
<script src="sha256.js"></script>
<script src="jphidgets22.1.0.0.min.js"></script>

<script>

	$(document).ready(function () {
		var conn = new jPhidgets.Connection('ws://' + window.location.host + '/phidgets', { name: window.location.host });

		conn.connect().then(function () {
			console.log('connected');
		}).catch(function (err) {
			alert('failed to connect to server:' + err);
		});;

		conn.onattach = function(dev) {
			$('#list').append(new Option(dev.name,dev.phid));
		}

		conn.ondetach = function(dev) {
			$("#list option[value='" + dev.phid + "']").remove();
		}
	});

</script>
</head>

<body>
	<label> Attached Phidgets: </label>
	<div>
		<select multiple id="list" style="width: 500px;"></select>
	</div>
</body>
</html>

After copying the code above into your index.html file, your folder should look like this:

Next, open the Network Server tab in the Phidget Control Panel and modify the Webserver Docroot to your folders location:

Finally, click on the hyperlink (or navigate to http://localhost:8989) to see the example:

Open the developer console to get a better idea what is going on:

For information about the Node.js example, keep reading. Otherwise, skip ahead to the edit the examples section located below.

Node.js

Use Our Examples

One of the best ways to start programming with Phidgets is to use our example code as a guide. In order to run the examples, you will need to download and install Node.js.

Now that you have Node.js installed, select an example that will work with your Phidget:

JavaScript Examples

Next, navigate to the Network Server tab in the Phidget Control Panel and press the Start Network Server button after ensuring the Phidget Server is enabled (Enabled checkbox in Phidget Server section).

Navigate to the example folder that you previously downloaded, open the command prompt at this location and enter the following command:

sudo npm update

Next, enter the following command to run the example (replacing Accelerometer with your example name):

node Accelerometer localhost

You should now have the example up and running. When you are ready, the next step is editing the examples.

Linux

Browser Example

Use Our Examples

One of the best ways to start programming with Phidgets is to use our example code as a guide. Our browser examples are graphical and can be downloaded here: Javascript Examples (HTML)

or they can be unpacked using

 apt-get install phidget22wwwjs

After unpacking the examples, navigate to the following location:

/etc/phidgets

Open the file named phidget22networkserver.pc and navigate to the www section, you should see something like this:

As you can see from the image above, our docroot location is defined as the following location:

/var/phidgets/www

Create the docroot location (if it doesn't exist already) and copy the contents of the example you downloaded into it by entering the following commands into the terminal:

mkdir /var/phidgets
mkdir /var/phidgets/www
cp -a YOUR_SOURCE_FOLDER/. /var/phidgets/www

Now that the example code is located at the docroot location, and the Phidget Webserver is enabled (can be seen in www section of phidget22networkserver.pc), navigate to http://localhost:8080. You will see a program written with JavaScript/HTML that mimics the Phidget Control Panel (available on macOS and Windows). It will show all the Phidgets attached to your machine. By double-clicking on the Phidgets, and example will launch:

Take a look at the source files that are now located at /var/phidgets/www

Write Your Own Code

Let's start by writing a simple HTML page that makes a dynamic list of attached Phidgets visible to the user. We will be using the JavaScript library jQuery in these examples. jQuery is not required in order to use Phidgets, however, it will make it easier for us to access elements on an HTML page.

To start, create a new folder that looks like this:

The referenced libraries can be found in the Javascript Examples (HTML) that we provide.

Next, create a file called index.html and copy the following code into it (Note: if you have newer JavaScript libraries, modify the code below to match your version numbers):

<!DOCTYPE html>
<html>
<head>
<title>Javascript Test Program</title>
<script src="jquery-2.1.4.min.js"></script>
<script src="sha256.js"></script>
<script src="jphidgets22.1.0.0.min.js"></script>

<script>

	$(document).ready(function () {
		var conn = new jPhidgets.Connection('ws://' + window.location.host + '/phidgets', { name: window.location.host });

		conn.connect().then(function () {
			console.log('connected');
		}).catch(function (err) {
			alert('failed to connect to server:' + err);
		});;

		conn.onattach = function(dev) {
			$('#list').append(new Option(dev.name,dev.phid));
		}

		conn.ondetach = function(dev) {
			$("#list option[value='" + dev.phid + "']").remove();
		}
	});

</script>
</head>

<body>
	<label> Attached Phidgets: </label>
	<div>
		<select multiple id="list" style="width: 500px;"></select>
	</div>
</body>
</html>

After copying the code above into your index.html file, your folder should look like this:

Next, modify the phidget22networkserver.pc file that is located at /etc/phidgets. Navigate to the www section and change the docroot location to match the location of your index.html file:

After modifying the docroot location, ensure you restart the Phidget Network Server. After restarting the Phidget Network Server, navigate to http://localhost:8080 to view the example:

Try opening the developer console for your web browser to see the Phidget JavaScript code executing and to get a better feel for the program.

Node.js

One of the best ways to start programming with Phidgets is to use our example code as a guide. In order to run the examples, you will need to download and install Node.js.

Now that you have Node.js installed, select an example that will work with your Phidget:

JavaScript Examples

Navigate to the example folder that you previously downloaded, open the terminal at this location and enter the following command:

npm update

Next, enter the following command to run the example (replacing Accelerometer with your example name):

node Accelerometer localhost

You should now have the example up and running. When you are ready, the next step is editing the examples.

Edit the Examples

By following the instructions for your operating system and compiler above, you now have working examples and a project that is configured. This teaching section will help you understand how the examples were written so you can start writing your own code.

Remember: your main reference for writing JavaScript code will be the Phidget22 API Manual and the example code.

Step One: Connect

In Javascript, you must first connect to the Phidget server using the Connection object.

function main() {

	...

	var conn = new jPhidget22.Connection(url, { name: n, passwd: p });
	conn.connect()
	  .then(runCode);
}

Where url, n, and p are variables defined elsewhere in the program. If the connection is successful, we call another function that contains the rest of our code.

Step Two: Create and Open

After connecting, the Open() function opens the software object, and once it has successfully opened we can interact with it and start receiving data from it. We can also set up event handlers just before opening.

For example, if we were using an Digital Input as our device, it would look like this:

function runCode() {
	var ch = new jPhidget22.DigitalInput();

	ch.onAttach = digitalInput_attach;
	ch.onStateChange = digitalInput_change;

	ch.open().then(function() {
		// code to execute after open succeeds
	}).catch(function (err) {
		// code to execute if open fails
	});

}

Once the object successfully opens, you can access it and you will start to get events from it. We can define the event handler functions :

function digitalInput_attach(ch) {
	console.log(ch + ' attached');
}

function digitalInput_change(state) {
	console.log('state changed:' + state);
}

Now that they've been registered in the runCode() function and the device has been opened, these event handlers will be able to trigger. The first one triggers when the DigitalInput channel attaches, and the second one will trigger whenever the state of the attached DigitalInput changes.

Step Three: Do Things with the Phidget

Some values can be directly read and set on the Phidget. These functions can be used inside a polling loop as an alternative to event driven programming. The lines inside the loop would be something like this, after which you could do something with the value:

var di_state = ch.getState(); // get the state of the digital input

ch.setState(1); // set the state of the digital input

Step Four: Close

At the end of your program (or at least, at the end of the part that uses the Phidget), it is advisable to close your device. This ensures that the Phidget will be available to other programs that want to use it, since a channel can only be in use by one program at a time unless it's opened remotely. It's not necessary to delete the object after closing in Javascript.

ch.close();

Personal tools

Views

More

Tools

Language - JavaScript: Difference between revisions

Revision as of 18:52, 7 February 2018

Contents

Quick Downloads

Documentation

Example Code

Libraries

Getting Started with JavaScript

Windows

Browser

Use Our Examples

Write Your Own Code

Node.js

Use Our Examples

macOS

Browser Example

Use Our Examples

Write Your Own Code

Node.js

Use Our Examples

Linux

Browser Example

Use Our Examples

Write Your Own Code

Node.js

Edit the Examples

Step One: Connect

Step Two: Create and Open

Step Three: Do Things with the Phidget

Step Four: Close

Further Reading

Navigation menu

@@ Line 1: / Line 1: @@
+<metadesc>Communicate over USB with sensors, controllers and relays with Phidgets! Our JavaScript API supports Windows/MacOS/Linux using html or Node.js.</metadesc>
 [[Category:Language]]
-{{OSLang|[[File:icon-Javascript.png|64x64px|link=|left|alt=]]|Javascript is a high-level object-oriented programming language ideal for use in web applications.}}
 __TOC__
-== Introduction ==
+== Quick Downloads ==
+=== Documentation ===
-If this is your first time working with a Phidget, we suggest starting with the Getting Started page for your specific device. This can be found in the user guide for your device. That page will walk you through installing drivers and libraries for your operating system, and will then bring you back here to use Javascript specifically.
+*{{Phidget22API}} (Select JavaScript from drop-down menu)
-Javascript is capable of using the complete {{Phidget22API}}, including events. We also provide example code in Javascript for all Phidget objects.
+=== Example Code ===
-Javascript does not require any special programming environment to write. Just use your favourite text editor to write .html and .js files.
+*{{SampleCode|JavaScript|JavaScript Examples (Node.js)}}
+*[{{SERVER}}/downloads/phidget22/tools/any/Phidget22JavaScriptControlPanel.zip Javascript Examples (HTML)]
-== Quick Downloads ==
+=== Libraries ===
+*[{{SERVER}}/downloads/phidget22/libraries/any/Phidget22JavaScript.zip JavaScript Library Download]
+{{AllQuickDownloads}}
+== Getting Started with JavaScript ==
+Welcome to using Phidgets with JavaScript! By using JavaScript, you will have access to the complete {{Phidget22API}}, including events. We also provide example code in JavaScript for all Phidget devices.
+If you are developing for Windows, keep reading. Otherwise, select your operating system to jump ahead:
+*[[#macOS | macOS]]
+*[[#Linux | Linux]]
+== Windows ==
+{{Windows_Languages}}
-'''<span style="color:#FF0000">List of download links, to be added once files are available</span>'''
+===Browser===
+====Use Our Examples====
+One of the best ways to start programming with Phidgets is to use our example code as a guide. Our browser examples are graphical and are installed with the Phidget libraries. In order to check them out, first open the Phidget Control Panel and navigate to the Network Server tab:
+[[File:Windows_networkserver.PNG|link=|center]]
-=== Documentation ===
-=== Example Code ===
-=== Libraries and Drivers ===
-== Getting Started with Javascript ==
+Next, make sure the Webserver is enabled (''Enabled'' checkbox in ''Webserver'' section), and start the Phidget Network Server by clicking on the ''Start'' button at the bottom of the window. Click on the hyperlink as shown in the image below (or navigate to http://localhost:8989):
+[[File:Javascript_windows_localhost.png|link=|center]]
-If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
-{{ExampleCodeReasons}}
-Instructions are divided up by operating system. Choose:
+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:
-*[[#Windows|Windows XP / Vista / 7]]
+[[File:Javascript_windows_controlpanel.png|link=|center]]
-*[[#OS X |OS X]]
-*[[#Linux | Linux]] (including PhidgetSBC)
-== Windows ==
-===Description of Library Files===
-Javascript  programs depend on the following files, which the installers above put onto your system:
-*'''jphidgets22.x.x.x.min.js''' is the Javascript library for Phidget22. The x's in the filename denote the version of the library.
+To view the source code that drives the examples, navigate to the following location:
+*C:/Program Files/Phidgets/Phidget22/html
-===Browser Example (Visual Studio Code)===
-This section will outline how to get a Javascript example running in an internet browser. Javascript can be written in any text editor. If you don't have one yet, [https://code.visualstudio.com/ Visual Studio Code] is recommended because it's free and simple.
+[[File:Javascript_windows_filelocation.png|link=|center]]
-====Use Our Examples====
-The Javascript examples that we provide are designed to work with [[Language_-_JavaScript#node.js|node.js]], but you can easily modify them to work in a browser. Follow the steps in the next section below, and once you get the HTML page working, copy the contents of the {{Code|runExample()}} function from the example of your choice into the function in your code that is called after connecting. Then, change any instance of {{Code|jPhidget22}} with {{Code|jPhidgets}}. When you visit the page, open up the developer's console (F12 is the hotkey for Chrome) and you'll be able to see the normal output for the examples in the console window.
+Here you can view the code that was written to create the main webpage as well as all of the examples.
 ====Write Your Own Code====
+Let's start by writing a simple HTML page that makes a dynamic list of attached Phidgets visible to the user.
+We will be using the JavaScript library [https://jquery.com/download/ jQuery] in these examples. jQuery is not required in order to use Phidgets, however, it will make it easier for us to access elements on an HTML page.
+To start, create a new folder that looks like this:
+[[File:Javascript_windows_folderlibraries.png|link=|center]]
+The referenced libraries are installed with the Phidget libraries and can be found at the following location:
+*C:/Program Files/Phidgets/Phidget22/html
-We'll be using the Javascript library [https://jquery.com/download/ jQuery] in these examples. While it's not required in order to use Phidgets, jQuery will make it easier for us to access elements on an html page.
-Let's start by writing a simple html page that makes a dynamic list of attached Phidgets visible to the user. Create a new folder and put the required library files inside. Then create a new HTML file and fill it with the following code:
+Next, create a file called ''index.html'' and copy the following code into it (Note: if you have newer JavaScript libraries, modify the code below to match your version numbers):
-<div class="source">
 <syntaxhighlight lang=javascript>
 <!DOCTYPE html>
 <html>
 <head>
@@ Line 93: / Line 107: @@
 </syntaxhighlight>
-</div>
-Pages that employ the use of Javascript are divided into two parts: HTML and Javascript. Code in {{Code|<script>}} tags is Javascript, and everything else is HTML. HTML will handle the parts of our program that will be visible to the user, and the Javascript will handle all of the behind-the-scenes processing. First, we list all of the Javascript libraries we're including. Next, we have our main script which makes a Phidget connection as soon as the page is ready and loaded. It also sets an attach handler and detach handler which will trigger any time a Phidget is connected or disconnected to the computer. Below this, we have a tiny bit of HTML which will display a select list that our Javascript code will interact with.
+After copying the code above into your ''index.html'' file, your folder should look like this:
+[[File:Javascript windows folder.png|link=|center]]
-Now, in order to test our new program we have to run it on a server.
-==== Setting up the Phidget Network Server ====
+Next, open the Network Server tab in the Phidget Control Panel and modify the Webserver ''Docroot'' to your folders location:
+[[File:Javascript_windows_docrootchange.png|link=|center]]
-The easiest way to get our code up and running is to host it using the Phidget Network Server. Go to {{Code|C:\Program Files\Phidgets\Phidget22}} and open {{Code|networkserver.cfg}}.
-Find the {{Code|[webserver]}} section and change the docroot to the path of the HTML file you just wrote.
+Finally, click on the hyperlink to see the example (or navigate to http://localhost:8989):
+[[File:Javascript_windows_example.png|link=|center]]
-Save, and then run NetworkServer.exe.
-[[image:js_networkservice.jpg|link=]]
+Open the developer console to get a better idea what is going on:
+[[File:Javascript_windows_devconsole.png|link=|center]]
-A window like the one pictured should open.
-====Running the Program====
+For information about the Node.js examples, keep reading. Otherwise, skip ahead to the [[#Edit the Examples | edit the examples]] section located below.
-Now, open a web browser and type {{Code|localhost:8080}} in the address bar. You should see the HTML of the page we just wrote:
-[[image:js-testpage.jpg|link=]]
+===Node.js===
+====Use Our Examples====
+One of the best ways to start programming with Phidgets is to use our example code as a guide. In order to run the examples, you will need to download and install [https://nodejs.org/ Node.js].
-Plugging in any Phidget should result in having an entry appear in the list. You will also see any [[Phidget Dictionary|Phidget dictionaries]] that are running on this network server. Unplugging the Phidgets should cause them to disappear from the list. You can open the browser's developer console to see the various messages we've been printing out and to set breakpoints in our Javascript code. In Chrome, for example, you can open the developer console with '''F12''':
-[[image:js-chromedev.jpg|900px|link=]]
+Now that you have Node.js installed, select an example that will work with your Phidget:
+*{{SampleCode|JavaScript|JavaScript Examples}}
-Now, let's change the program so that we can access a specific channel on a Phidget. In this example we'll read the voltage of a VoltageInput channel on the Phidget 1018_2. Insert a new function to run when the Phidget connection is made:
-<div class="source">
+Next, navigate to the Network Server tab in the Phidget Control Panel and press the ''Start'' button after ensuring the Phidget Server is enabled (''Enabled'' checkbox in ''Phidget Server'' section).
-<syntaxhighlight lang=javascript>
+[[File:Windows_networkserver.PNG|link=|center]]
+Navigate to the example folder that you previously downloaded, open the command prompt at this location and enter the following command:
+<syntaxhighlight lang='bash'>
+npm update
+</syntaxhighlight>
-		conn.connect().then(function () {
+[[File:Javascript_windows_npmupdate.png]]
-			console.log('connected');
-			readVoltage();
-		}).catch(function (err) {
-			alert('failed to connect to server:' + err);
-		});;
+Next, enter the following command to run the example (replacing Accelerometer with your example name):
+<syntaxhighlight lang='bash'>
+node Accelerometer localhost
 </syntaxhighlight>
-</div>
+[[File:Javacsript_windows_nodeexample.png|link=|center]]
-Then, define the function just below this one, but still inside the {{Code|<script>}} tags.
-<div class="source">
+You should now have the example up and running. When you are ready, the next step is [[#Edit the Examples | editing the examples]].
-<syntaxhighlight lang=javascript>
+==macOS==
+=== Browser Example===
+====Use Our Examples====
+One of the best ways to start programming with Phidgets is to use our example code as a guide. Our browser examples are graphical and are installed with the Phidget libraries. In order to check them out, first open the Phidget Control Panel and navigate to the Network Server tab:
+[[File:Macos_networkserver_run.png|link=|center]]
+Next, make sure the Webserver is enabled (''Enabled'' checkbox in ''Webserver'' section), and start the Phidget Network Server by clicking on the ''Start'' button at the top of the window. A button labelled ''View in Browser...'' will appear. Click on it now (or navigate to http://localhost:8989).
+[[File:Javascript_macos_viewinbrowswer.png|link=|center]]
+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:
+[[File:Javascript_macos_browserexample.png|link=|center]]
+To view the source code that drives the examples, navigate to the following location:
+*/Library/Application Support/Phidgets/Phidget22NetworkServer/html
+[[File:Javascript_macos_filelocation.png|link=|center]]
+Here you can view the code that was written to create the main webpage as well as all of the examples.
-function readVoltage() {
+====Write Your Own Code====
+Let's start by writing a simple HTML page that makes a dynamic list of attached Phidgets visible to the user.
+We will be using the JavaScript library [https://jquery.com/download/ jQuery] in these examples. jQuery is not required in order to use Phidgets, however, it will make it easier for us to access elements on an HTML page.
-		var ch = new jPhidgets.VoltageInput();
-		ch.onVoltageChange = function (voltage) {
+To start, create a new folder that looks like this:
-			$('#res').text(this.getVoltage());
+[[File:Javascript_macos_folderlibraries.png|link=|center]]
-		};
-		ch.open();
-	}
-</syntaxhighlight>
+The referenced libraries are installed with the Phidget libraries and can be found at the following location:
-</div>
+*/Library/Application Support/Phidgets/Phidget22NetworkServer/html
-This function sets up a change handler which will update a piece of text every time the voltage changes. It will match to the first VoltageInput object that it finds.
-Lastly, add a line in the HTML section that adds an element where we can change the text to match the present voltage value:
+Next, create a file called ''index.html'' and copy the following code into it (Note: if you have newer JavaScript libraries, modify the code below to match your version numbers):
-<div class="source">
 <syntaxhighlight lang=javascript>
+<!DOCTYPE html>
+<html>
+<head>
+<title>Javascript Test Program</title>
+<script src="jquery-2.1.4.min.js"></script>
+<script src="sha256.js"></script>
+<script src="jphidgets22.1.0.0.min.js"></script>
+<script>
+	$(document).ready(function () {
+		var conn = new jPhidgets.Connection('ws://' + window.location.host + '/phidgets', { name: window.location.host });
+		conn.connect().then(function () {
+			console.log('connected');
+		}).catch(function (err) {
+			alert('failed to connect to server:' + err);
+		});;
+		conn.onattach = function(dev) {
+			$('#list').append(new Option(dev.name,dev.phid));
+		}
+		conn.ondetach = function(dev) {
+			$("#list option[value='" + dev.phid + "']").remove();
+		}
+	});
+</script>
+</head>
 <body>
@@ Line 168: / Line 233: @@
 		<select multiple id="list" style="width: 500px;"></select>
 	</div>
-	<label> Voltage Input Value: </label> <label id="res"></label>
 </body>
+</html>
 </syntaxhighlight>
-</div>
-Now save your HTML file and refresh your browser. When you plug in a device with a VoltageInput channel, you should see the voltage value constantly update on the page.
+After copying the code above into your ''index.html'' file, your folder should look like this:
+[[File:Javascript_macos_folder.png|link=|center]]
+Next, open the Network Server tab in the Phidget Control Panel and modify the Webserver ''Docroot'' to your folders location:
+[[File:Javascript_macos_docrootchange.png|link=|center]]
+Finally, click on the hyperlink (or navigate to http://localhost:8989) to see the example:
+[[File:Javascript_macos_example.png|link=|center]]
+Open the developer console to get a better idea what is going on:
+[[File:Javascript_macos_devconsole.png|link=|center]]
+For information about the Node.js example, keep reading. Otherwise, skip ahead to the [[#Edit the Examples | edit the examples]] section located below.
+===Node.js===
+====Use Our Examples====
+One of the best ways to start programming with Phidgets is to use our example code as a guide. In order to run the examples, you will need to download and install [https://nodejs.org/ Node.js].
+Now that you have Node.js installed, select an example that will work with your Phidget:
+*{{SampleCode|JavaScript|JavaScript Examples}}
+Next, navigate to the Network Server tab in the Phidget Control Panel and press the ''Start Network Server'' button after ensuring the Phidget Server is enabled (''Enabled'' checkbox in ''Phidget Server'' section).
+[[File:Macos_networkserver_run.png|link=|center]]
-If you wanted to open the VoltageInput object on a VINT Hub port, you would have to add the following two lines just before the {{Code|open()}} call:
-<div class="source">
+Navigate to the example folder that you previously downloaded, open the command prompt at this location and enter the following command:
-<syntaxhighlight lang=javascript>
+<syntaxhighlight lang='bash'>
-		ch.setHubPort(0); // open hub port 0
+sudo npm update
-		ch.setIsHubPort(true);
 </syntaxhighlight>
-</div>
-===node.js===
+[[File:Javascript_macos_npmupdate.png ‎]]
-node.js is a Javascript runtime that will allow us to run Javascript code via the Windows command prompt. Download the latest version of node.js [https://nodejs.org/ here]. The installer will also set the class path and install '''npm''' (the node.js package manager), both of which are necessary for the next steps. Once it's been installed, open up a command prompt by searching for "cmd" in the start menu.
-You can download our Javascript examples [[#Quick Downloads|here]].
+Next, enter the following command to run the example (replacing Accelerometer with your example name):
+<syntaxhighlight lang='bash'>
+node Accelerometer localhost
+</syntaxhighlight>
-In the command prompt, navigate to the folder that contains the Phidgets Javascript examples. There, type the following command:
+[[File:Javascript_macos_nodeexample.png|link=|center]]
-{{Code|npm update}}
-This will cause the package manager to look at {{Code|package.json}} and update the Phidgets libraries.
+You should now have the example up and running. When you are ready, the next step is [[#Edit the Examples | editing the examples]].
+== Linux ==
+===Browser Example===
 ====Use Our Examples====
+One of the best ways to start programming with Phidgets is to use our example code as a guide. Our browser examples are graphical and can be downloaded here:
+[{{SERVER}}/downloads/phidget22/tools/any/Phidget22JavaScriptControlPanel.zip Javascript Examples (HTML)]
+or they can be unpacked using  <syntaxhighlight lang=bash> apt-get install phidget22wwwjs </syntaxhighlight>
-To run the examples, go to {{Code|C:\Program Files\Phidgets\Phidget22\}} and run {{Code|NetworkServer.exe}}. A window like the one below should open:
-[[image:js_networkservice.jpg|link=]]
-In the other command prompt window, navigate to the folder that contains the Phidgets Javascript examples and type
+After unpacking the examples, navigate to the following location:
+*/etc/phidgets
-{{Code|node <example> <address>}}
-where {{Code|<example>}} is the filename of the example you want to run (i.e. DigitalInput.js) and {{Code|<address>}} is the address of the Phidget server. In our case, it will be "localhost" because we're hosting it on the same computer:
+Open the file named ''phidget22networkserver.pc'' and navigate to the ''www'' section, you should see something like this:
+[[File:Javacsript_linux_networkconfig.PNG|link=|center]]
+As you can see from the image above, our ''docroot'' location is defined as the following location:
+*/var/phidgets/www
+Create the docroot location (if it doesn't exist already) and copy the contents of the example you downloaded into it by entering the following commands into the terminal:
+<syntaxhighlight lang='bash'>
+mkdir /var/phidgets
+mkdir /var/phidgets/www
+cp -a YOUR_SOURCE_FOLDER/. /var/phidgets/www
+</syntaxhighlight>
+[[File:Javascript_linux_mkdir.PNG|link=|center]]
-{{Code|node DigitalInput localhost}}
-This should result in a simple text-based example to be launched:
+Now that the example code is located at the ''docroot'' location, and the Phidget Webserver is enabled (can be seen in ''www'' section of ''phidget22networkserver.pc''), navigate to http://localhost:8080. You will see a program written with JavaScript/HTML that mimics the Phidget Control Panel (available on macOS and Windows). It will show all the Phidgets attached to your machine. By double-clicking on the Phidgets, and example will launch:
+[[File:Javascript_linux_graphicalexample.PNG|link=|center]]
-[[image:js_nodeexample.jpg|link=]]
-====Write Your Own Code====
+Take a look at the source files that are now located at /var/phidgets/www
-After testing with our node.js examples, it will be easy for you to write your own programs. Open up one of the examples and edit the {{Code|runExample()}} function to suit your needs:
+===Write Your Own Code===
+Let's start by writing a simple HTML page that makes a dynamic list of attached Phidgets visible to the user.
+We will be using the JavaScript library [https://jquery.com/download/ jQuery] in these examples. jQuery is not required in order to use Phidgets, however, it will make it easier for us to access elements on an HTML page.
-# Change {{Code|jPhidget22.VoltageInput}} to the object you want to open.
+To start, create a new folder that looks like this:
-# Set new handlers for this channel (for example, {{Code|ch.onIlluminanceChange}} if you're using a light sensor).
+[[File:Javascript_linux_folderlibraries.PNG|link=|center]]
-# Set new parameters to open a specific channel (for example, {{Code|ch.setDeviceSerialNumber()}} or {{Code|ch.setIsHubPort()}}).
-# You can open multiple channels by declaring different variables for each one and repeating the same process of assigning handlers and calling {{Code|open()}} on the channel.
-# Edit the contents of the event handlers to do different things with the data. Instead of printing the data to console, you could log it to a .csv file, or perform custom processing on the data (i.e. rolling average).
-When you're done writing your program, you'll be able to run it in the same way as described in the previous section.
-== OS X ==
+The referenced libraries can be found in the [{{SERVER}}/downloads/phidget22/tools/any/Phidget22JavaScriptControlPanel.zip Javascript Examples (HTML)] that we provide.
-=== Browser Example (Visual Studio Code) ===
-=== node.js ===
+Next, create a file called index.html and copy the following code into it (Note: if you have newer JavaScript libraries, modify the code below to match your version numbers):
+<syntaxhighlight lang=javascript>
+<!DOCTYPE html>
+<html>
+<head>
+<title>Javascript Test Program</title>
+<script src="jquery-2.1.4.min.js"></script>
+<script src="sha256.js"></script>
+<script src="jphidgets22.1.0.0.min.js"></script>
-== Linux ==
+<script>
-=== Browser Example ===
+	$(document).ready(function () {
+		var conn = new jPhidgets.Connection('ws://' + window.location.host + '/phidgets', { name: window.location.host });
-Download our Javascript libraries [[#Quick Downloads|here]] and follow the instructions in the README to get in-browser Javascript running.
+		conn.connect().then(function () {
+			console.log('connected');
+		}).catch(function (err) {
+			alert('failed to connect to server:' + err);
+		});;
-=== node.js ===
+		conn.onattach = function(dev) {
+			$('#list').append(new Option(dev.name,dev.phid));
+		}
-node.js is a Javascript runtime that will allow us to run Javascript code via the terminal. Download the latest version of node.js [https://nodejs.org/ here]. The installer will also set the class path and install '''npm''' (the node.js package manager), both of which are necessary for the next steps.
+		conn.ondetach = function(dev) {
+			$("#list option[value='" + dev.phid + "']").remove();
+		}
+	});
-Download our Javascript examples [[#Quick Downloads|here]].
+</script>
+</head>
-In the terminal, navigate to the folder that contains the Phidgets Javascript examples. There, type the following command:
+<body>
+	<label> Attached Phidgets: </label>
+	<div>
+		<select multiple id="list" style="width: 500px;"></select>
+	</div>
+</body>
+</html>
+</syntaxhighlight>
-{{Code|npm update}}
-This will cause the package manager to look at {{Code|package.json}} and update the Phidgets libraries.
+After copying the code above into your ''index.html'' file, your folder should look like this:
+[[File:Javascript_linux_folder.PNG|link|center]]
-Follow the README in the Javascript libraries to get the Phidget network server running.
-In the terminal, navigate to the folder that contains the Phidgets Javascript examples and type
+Next, modify the ''phidget22networkserver.pc'' file that is located at ''/etc/phidgets''. Navigate to the ''www'' section and change the ''docroot'' location to match the location of your ''index.html'' file:
+[[File:Javascript_linux_modifydocroot.PNG|link=|center]]
-{{Code|node <example> <address>}}
-where {{Code|<example>}} is the filename of the example you want to run (i.e. DigitalInput.js) and {{Code|<address>}} is the address of the Phidget server. In our case, it will be "localhost" because we're hosting it on the same computer:
+After modifying the docroot location, ensure you restart the Phidget Network Server. After restarting the Phidget Network Server, navigate to http://localhost:8080 to view the example:
+[[File:Javascript_linux_example.PNG|link=|center]]
-{{Code|node DigitalInput localhost}}
-This should result in a simple text-based example to be launched inside the terminal.
+Try opening the developer console for your web browser to see the Phidget JavaScript code executing and to get a better feel for the program.
-== Edit the Examples ==
+====Node.js====
+One of the best ways to start programming with Phidgets is to use our example code as a guide. In order to run the examples, you will need to download and install [https://nodejs.org/ Node.js].
+Now that you have Node.js installed, select an example that will work with your Phidget:
+*{{SampleCode|JavaScript|JavaScript Examples}}
-By following the instructions for your operating system and compiler above, you probably now have a working example and want to understand it better so you can change it to do what you want. This teaching section has resources for you to learn from the examples and write your own.
-Your main reference for writing C# code will be the {{Phidget22API}} Manual.
-=== Example Flow ===
+Navigate to the example folder that you previously downloaded, open the terminal at this location and enter the following command:
+<syntaxhighlight lang='bash'>
+npm update
+</syntaxhighlight>
-{{ExamplePseudocode|In C#, you can name these '''event''' functions whatever you like.  You will add them to the Phidget library in the Main Code section.  This hooks them into the actual events when they occur.
+[[File:Javascript_linux_npmupdate.PNG|link=|center]]
-In the example code, the event functions common to all Phidgets are things like attach, detach, and error handling.
+Next, enter the following command to run the example (replacing Accelerometer with your example name):
+<syntaxhighlight lang='bash'>
+node Accelerometer localhost
+</syntaxhighlight>
-Other event functions will be specific to each device, like when a tag is read on an RFID board, or when a sensor value changes on an Interface Kit.
+[[File:Javascript_macos_nodeexample.png|link=|center]]
-|Creating a Phidget software object in C# is specific to the Phidget.  For a Phidget Spatial, for example, this would involve creating a {{Code|Spatial}} object.  The examples show how to do this and other API functions.
-The object provides device specific methods and properties which are available from the API for your specific Phidget.|
+You should now have the example up and running. When you are ready, the next step is [[#Edit the Examples | editing the examples]].
-[{{SERVER}}/documentation/Phidget22.NET.zip .NET API]}}
-=== Code Snippets ===
+== Edit the Examples ==
+{{WriteCode_Intro|JavaScript}}
-==== Step One: Connect====
+=== Step One: Connect===
 In Javascript, you must first connect to the Phidget server using the {{Code|Connection}} object.
-<div class="source">
 <syntaxhighlight lang=javascript>
@@ Line 300: / Line 436: @@
 </syntaxhighlight>
-</div>
 Where {{Code|url}}, {{Code|n}}, and {{Code|p}} are variables defined elsewhere in the program. If the connection is successful, we call another function that contains the rest of our code.
-==== Step Two: Create and Open====
+=== Step Two: Create and Open===
 After connecting, the {{Code|Open()}} function opens the software object, and once it has successfully opened we can interact with it and start receiving data from it. We can also set up event handlers just before opening.
 For example, if we were using an Digital Input as our device, it would look like this:
-<div class="source">
 <syntaxhighlight lang=javascript>
@@ Line 328: / Line 461: @@
 </syntaxhighlight>
-</div>
 Once the object successfully opens, you can access it and you will start to get events from it. We can define the event handler functions :
-<div class="source">
 <syntaxhighlight lang=javascript>
@@ Line 344: / Line 475: @@
 </syntaxhighlight>
-</div>
 Now that they've been registered in the {{Code|runCode()}} function and the device has been opened, these event handlers will be able to trigger. The first one triggers when the DigitalInput channel attaches, and the second one will trigger whenever the state of the attached DigitalInput changes.
-==== Step Three: Do Things with the Phidget ====
+=== Step Three: Do Things with the Phidget ===
 Some values can be directly read and set on the Phidget. These functions can be used inside a polling loop as an alternative to event driven programming. The lines inside the loop would be something like this, after which you could do something with the value:
-<div class="source">
 <syntaxhighlight lang=javascript>
@@ Line 359: / Line 488: @@
 </syntaxhighlight>
-</div>
-==== Step Four: Close ====
+=== Step Four: Close ===
 At the end of your program (or at least, at the end of the part that uses the Phidget), it is advisable to close your device. This ensures that the Phidget will be available to other programs that want to use it, since a channel can only be in use by one program at a time unless it's opened remotely. It's not necessary to delete the object after closing in Javascript.
-<div class="source">
 <syntaxhighlight lang=javascript>
@@ Line 370: / Line 497: @@
 </syntaxhighlight>
-</div>
 == Further Reading ==
 [[Phidget Programming Basics]] - Here you can find the basic concepts to help you get started with making your own programs that use Phidgets.
@@ Line 384: / Line 509: @@
 [[Logging, Exceptions, and Errors]] - Learn about all the tools you can use to debug your program.
-[[Phidget Network Service]] - Phidgets can be controlled and communicated with over your network- either wirelessly or over ethernet.
+[[Phidget Network Server]] - Phidgets can be controlled and communicated with over your network- either wirelessly or over ethernet.