Language - JavaScript: Difference between revisions

From Phidgets Support
No edit summary
Line 418: Line 418:


== Edit 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.
{{WriteCode_Intro|JavaScript}}
 
 
Remember: your main reference for writing Objective-C code will be the {{Phidget22API}} Manual and the example code.


=== Step One: Connect===
=== Step One: Connect===

Revision as of 19:12, 11 December 2017

Quick Downloads

Documentation

Example Code

Libraries

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:

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:

Windows networkserver.PNG


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):

Javascript windows localhost.png


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:

Javascript windows controlpanel.png


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

  • C:/Program Files/Phidgets/Phidget22/html


Javascript windows filelocation.png


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:

Javascript windows folderlibraries.png


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:

Javascript windows folder.png


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

Javascript windows docrootchange.png


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

Javascript windows example.png


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

Javascript windows devconsole.png


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:


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

Windows networkserver.PNG


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

npm update

Javascript windows npmupdate.png


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

node Accelerometer localhost
Javacsript windows nodeexample.png


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:

Macos networkserver run.png


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).

Javascript macos viewinbrowswer.png


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:

Javascript macos browserexample.png


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

  • /Library/Application Support/Phidgets/Phidget22NetworkServer/html


Javascript macos filelocation.png


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:

Javascript macos folderlibraries.png


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:

Javascript macos folder.png


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

Javascript macos docrootchange.png


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

Javascript macos example.png


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

Javascript macos devconsole.png


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:


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

Macos networkserver run.png


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

sudo npm update

Javascript macos npmupdate.png


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

node Accelerometer localhost
Javascript macos nodeexample.png


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:


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:

Javacsript linux networkconfig.PNG


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
Javascript linux mkdir.PNG


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:

Javascript linux graphicalexample.PNG


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:

Javascript linux folderlibraries.PNG


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:

link


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:

Javascript linux modifydocroot.PNG


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:

Javascript linux example.PNG


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:


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

npm update
Javascript linux npmupdate.PNG


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

node Accelerometer localhost
Javascript macos nodeexample.png


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();

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.

Data Interval/Change Trigger - Learn about these two properties that control how much data comes in from your sensors.

Using Multiple Phidgets - It can be difficult to figure out how to use more than one Phidget in your program. This page will guide you through the steps.

Polling vs. Events - Your program can gather data in either a polling-driven or event-driven manner. Learn the difference to determine which is best for your application.

Logging, Exceptions, and Errors - Learn about all the tools you can use to debug your program.

Phidget Network Server - Phidgets can be controlled and communicated with over your network- either wirelessly or over ethernet.

Retrieved from "https://www.phidgets.com/docs/index.php?title=Language_-_JavaScript&oldid=28789"