Language - Java: Difference between revisions

From Phidgets Support
No edit summary
No edit summary
 
(18 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{#seo:|description=Learn how to use Phidget USB devices with Java.}}
[[Category:Language]]
[[Category:Language]]
__TOC__


== Quick Downloads ==
==Get Started==
With the Phidget22 library, it's easy to create Java applications that work with Phidget devices.


=== Documentation ===
==Java Libraries==


*{{Phidget22API}} (Select Java from drop-down menu)
===Source Files===
The Phidget22 Java library source files are available [https://cdn.phidgets.com/downloads/phidget22/libraries/windows/Phidget22-windevel.zip here].


=== Example Code ===
==Development Environment Configuration==


*{{SampleCode|Java|Java Examples}}
Before choosing a development environment, make sure you have the [http://www.oracle.com/technetwork/java/index.html Java Development Kit] installed.


=== Libraries===
===Javac===
 
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
{{AllQuickDownloads}}
|+ '''Instructions'''
 
|The easiest way to allow Java to access the Phidgets Java library is to place a copy of '''phidget22.jar''' in the same folder as your .java program. ||[[Image:Language_java_javac_folder.png|center|350px|link=https://cdn.phidgets.com/docs/images/8/89/Language_java_javac_folder.png]]
==Getting Started with Java==
|-
Welcome to using Phidgets with Java! By using Java, you will have access to the complete Phidget22 API, including events. We also provide example code in Java for all Phidget devices.
|[https://www.phidgets.com/downloads/phidget22/libraries/any/Phidget22Java.zip You can download phidget22.jar here].||  
 
|-
If you are developing for Windows, keep reading. Otherwise, select your operating system to jump ahead:
|Once you are ready to run your program, enter the following command in the command prompt or terminal:
*[[#macOS | macOS]]
<syntaxhighlight>
*[[#Linux | Linux]]
 
== Windows ==
{{Windows_Languages}}
===Javac (Command Line)===
====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 the Java Development Kit from [http://www.oracle.com/technetwork/java/index.html Oracle].
 
 
Next, select an example that will work with your Phidget:
*{{SampleCode|Java|Java Examples}}
 
 
Copy phidget22.jar from the following location:
*C:\Program Files\Phidgets\Phidget22\phidget22.jar
 
 
Place both the example file and the phidget22.jar file in the same location. Your folder should now look something like this:
[[Image:Java_javac_folder.png|link= | center]]
 
 
Open the command prompt at the folder location. Next, enter the following command in the command prompt:
<syntaxhighlight lang="java">
javac -classpath .;phidget22.jar example.java
javac -classpath .;phidget22.jar example.java
</syntaxhighlight>
</syntaxhighlight>
Finally, enter the following command to run the program:
Finally, enter the following command to run the program:
<syntaxhighlight lang="java">
<syntaxhighlight>
java -classpath .;phidget22.jar example
java -classpath .;phidget22.jar example  
</syntaxhighlight>
</syntaxhighlight>
||
|-
|}


 
===Netbeans===
[[Image:Java_javac.PNG|link= | center]]
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
 
|+ '''Instructions'''
 
|The easiest way to allow Java to access the Phidgets Java library is to place a copy of '''phidget22.jar''' in the same folder as your .java program. ||[[Image:Language_java_javac_folder.png|center|350px|link=https://cdn.phidgets.com/docs/images/8/89/Language_java_javac_folder.png]]
You should now have the example up and running for your device. Play around with the device and experiment with some of the functionality. When you are ready, the next step is configuring your project and writing your own code!
|-
 
|[https://www.phidgets.com/downloads/phidget22/libraries/any/Phidget22Java.zip You can download phidget22.jar here].||  
====Configure your project====
|-
When you are building a project from scratch, or adding Phidget functionality to an existing project, you'll need to configure your development environment to properly link the Phidget Java library.
| To start, open NetBeans and create a new project. Select Java Application and follow the steps as directed by Netbeans.|| [[Image:Windows_netbeans1.jpg|center|350px|link=https://cdn.phidgets.com/docs/images/c/c9/Windows_netbeans1.jpg]]
 
|-
 
| Next, add a reference to phidget22.jar by right-clicking on the libraries folder. || [[Image:Windows_netbeans2.jpg|center|350px|link=https://cdn.phidgets.com/docs/images/2/2b/Windows_netbeans2.jpg]]
To include the Phidget Java library, add the following line to your code:
|-
<syntaxhighlight lang="java">
| Navigate to the folder where you downloaded phidget22.jar, and select it. || [[Image:Windows_netbeans3.jpg|center|350px|link=https://cdn.phidgets.com/docs/images/7/76/Windows_netbeans3.jpg]]
import com.phidget22.*
|-
</syntaxhighlight>
| The project now has access to Phidgets. ||
 
|}
You can now compile the file as shown in the previous section.
 
 
The project now has access to Phidgets. Next, view the [[#Write Code | write your own code]] section located below.
 
===NetBeans===
====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://netbeans.org/ NetBeans].
 
 
Now that you have NetBeans installed, select an example that will work with your Phidget:
*{{SampleCode|Java|Java Examples}}
 
 
Next, open NetBeans and create a new project:
[[Image:Java_netbeans_newproject.PNG|link=|center]]
 
 
Give your project a name and finish creating the project:
[[Image:Java_netbeans_nameproject.PNG|link= |center]]
 
 
Delete the java file that was generated with the project:
[[Image:Java_netbeans_deletefile.png|link= |center]]
 
 
Replace the deleted file with the example file that you downloaded. Next, add a reference to phidget22.jar by right-clicking on the libraries folder:
[[Image:Java_netbeans_addjar.png|link= |center]]
 
 
 
You can find phidget22.jar at the following location:
*C:\Program Files\Phidgets\Phidget22\phidget22.jar
 
 
[[Image:Java_netbeans_jarpath.png|link=|center]]
 
 
After pressing run and selecting the main class, the example will be up and running for your device. Play around with the device and experiment with some of the functionality. When you are ready, the next step is configuring your project and writing your own code!
 
====Configure your project====
When you are building a project from scratch, or adding Phidget functionality to an existing project, you'll need to configure your development environment to properly link the Phidget Java library.
 
 
To include the Phidget Java library, add the following line to your code:
<syntaxhighlight lang="java">
import com.phidget22.*
</syntaxhighlight>
 
You can now create your project as shown in the previous section.
 
 
The project now has access to Phidgets. Next, view the [[#Write Code | write your own code]] section located below.


===Eclipse===
===Eclipse===
====Use our examples====
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
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://www.eclipse.org/downloads/ Eclipse].
|+ '''Instructions'''
 
|The easiest way to allow Java to access the Phidgets Java library is to place a copy of '''phidget22.jar''' in the same folder as your .java program. ||[[Image:Language_java_javac_folder.png|center|350px|link=https://cdn.phidgets.com/docs/images/8/89/Language_java_javac_folder.png]]
 
|-
Now that you have Eclipse installed, select an example that will work with your Phidget:
|[https://www.phidgets.com/downloads/phidget22/libraries/any/Phidget22Java.zip You can download phidget22.jar here].||  
*{{SampleCode|Java|Java Examples}}
|-
 
| To start, open Eclipse and create a new Java project.|| [[Image:Windows_eclipse1.jpg|center|350px|link=https://cdn.phidgets.com/docs/images/3/3a/Windows_eclipse1.jpg]]
 
|-
Next, create a new Java project. Give it the same name as the example you downloaded above:
| On the Libraries tab, click Add External JARs and add phidget22.jar to your project as an external jar. || [[Image:Windows_eclipse2.jpg|center|350px|link=https://cdn.phidgets.com/docs/images/0/0c/Windows_eclipse2.jpg]]
 
|-
[[Image:Java_eclipse_newproject.PNG|link=| center]]
| Create a new Class in your project. || [[Image:Windows_eclipse3.jpg|center|350px|link=https://cdn.phidgets.com/docs/images/d/d9/Windows_eclipse3.jpg]]
 
|-
 
| Name the class, and be sure to check the '''public static void main''' box. || [[Image:Windows_eclipse4.jpg|center|350px|link=https://cdn.phidgets.com/docs/images/8/87/Windows_eclipse4.jpg]]
Click ''Next>'' and add phidget22.jar to your project. You can find phidget22.jar at the following location:
|-
*C:\Program Files\Phidgets\Phidget22\phidget22.jar
| Your project now has access to Phidgets! ||
 
|-
 
|}
[[Image:Java_eclipse_addjar.png|link=| center]]
 
 
Finally, drag the example java file into the src folder that has been created for you and run the example:
 
[[Image:Java_eclipse_run.png|link=|center]]
 
 
You should now have the example up and running for your device. Play around with the device and experiment with some of the functionality. When you are ready, the next step is configuring your project and writing your own code!
====Configure your project====
When you are building a project from scratch, or adding Phidget functionality to an existing project, you'll need to configure your development environment to properly link the Phidget Java library.
 
 
To include the Phidget Java library, add the following line to your code:
<syntaxhighlight lang="java">
import com.phidget22.*
</syntaxhighlight>
 
You can now create your project as shown in the previous section.
 
 
The project now has access to Phidgets. Next, view the [[#Write Code | write your own code]] section located below.
 
==macOS==
===Javac (Terminal)===
====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 the Java Development Kit from [http://www.oracle.com/technetwork/java/index.html Oracle]. You will also need a copy of [{{SERVER}}/downloads/phidget22/libraries/any/Phidget22Java/.zip phidget22.jar].
 
 
Next, select an example that will work with your Phidget:
*{{SampleCode|Java|Java Examples}}
 
 
Place both the example file and the phidget22.jar file in the same location. Your folder should now look something like this:
[[Image:Java_mac_javac_folder.png|link=|center]]
 
 
Open the terminal at the folder location. Next, enter the following command:
 
<syntaxhighlight lang="java">
javac -classpath .:phidget22.jar example.java
</syntaxhighlight>
 
 
Finally, enter the following command to run the program:
 
<syntaxhighlight lang="java">
java -classpath .:phidget22.jar example
</syntaxhighlight>
 
 
[[Image:Java_mac_javac_run.png|link=|center]]
 
 
You should now have the example up and running for your device. Play around with the device and experiment with some of the functionality. When you are ready, the next step is configuring your project and writing your own code!
 
====Configure your project====
When you are building a project from scratch, or adding Phidget functionality to an existing project, you'll need to configure your development environment to properly link the Phidget Java library.
 
 
To include the Phidget Java library, add the following line to your code:
<syntaxhighlight lang="java">
import com.phidget22.*
</syntaxhighlight>
 
You can now compile your project as shown in the previous section.
 
 
The project now has access to Phidgets. Next, view the [[#Write Code | write your own code]] section located below.
 
===Netbeans===
====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://netbeans.org/ NetBeans]. You will also need a copy of [{{SERVER}}/downloads/phidget22/libraries/any/Phidget22Java/.zip phidget22.jar].
 
 
Now that you have NetBeans installed, select an example that will work with your Phidget:
*{{SampleCode|Java|Java Examples}}
 
 
Next, open NetBeans and create a new project:
[[Image:Java_netbeans_mac_newproject.png|link=|center]]
 
 
Give your project a name and finish creating the project:
[[Image:Java_netbeans_mac_nameproject.png|link=|center]]
 
 
Delete the file that was generated with the project:
[[Image:Java_netbeans_mac_delete.png|link=|center]]
 
 
Replace the deleted file with the example you downloaded:
[[Image:Java_netbeans_mac_replace.png|link=|center]]
 
Next, add a reference to the phidget22.jar you downloaded above by right-clicking on the libraries folder:
[[Image:Java_netbeans_mac_addjar.png|link=|center]]
 
 
After pressing run and selecting the main class, the example will be up and running for your device. Play around with the device and experiment with some of the functionality. When you are ready, the next step is configuring your project and writing your own code!
 
== Linux '''<span style="color:#FF0000">Unsure about information in this section</span>'''==
Java has excellent support on Linux - there is an established implementation of the Java compiler and interpreter, and several Integrated Development Environments (IDEs) including NetBeans and Eclipse.
 
The first step in using Java on Linux is to install the base Phidget libraries. Compile and install them as explained on the main [[OS - Linux|Linux]] page. That Linux page also describes the different basic Phidget library files, their installed locations, and their roles.
 
You will also need the Phidget Java Libraries (phidget22.jar), from the [[#Quick_Downloads| quick downloads]] section.
 
Once downloaded, the phidget22.jar library file does not get 'installed' (i.e. do not run java -jar phidget22.jar). Rather, the library file gets put into the path of whatever program you write, and you will link it via both the java compiler and the java interpreter. We walk you through this below.
 
===Description of Library Files===
The Phidget Java libraries depend on the C libraries being installed as explained on the main Linux page. If you browse around within the phidget22.jar archive, you will find Java class files (too many to reasonably list here) that have names related to the devices they provide an API for.
 
These Java class files use the functions available in the dynamic Phidget22 C-language library on Linux. Dynamic libraries end with .so, and so the C library that the Phidget Java class files use is /usr/lib/libphidget22.so.
 
===Javac (Command Line)===
====Use our examples====
Linux gets somewhat complicated in that two Java compilers exist: openjdk and gcj. Furthermore, a given IDE can usually use either compiler. That being said, we only offer support here for openJDK and IDEs running openJDK.
 
To find out which type of compiler your computer has, use the -version option on the command line. You can use the same option for your runtime environment (interpreter):
 
<syntaxhighlight lang="java">
$> java -version
java version "1.6.0_23"
OpenJDK Runtime Environment (IcedTea6 1.11pre) (6b23~pre11-0ubuntu1.11.10.1)
OpenJDK 64-Bit Server VM (build 20.0-b11, mixed mode)
$> javac -version
javac 1.6.0_23
</syntaxhighlight>
 
The good news is that you can have both openjdk and gcj on your machine, co-habitating happily. There can be only one linked java and javac in /usr/bin/ however, and so this will correspond to whichever java compiler and interpreter you installed last.
 
If you do not have openjdk installed already (this is the default Java installation for most Linux machines, so you will probably know), and you choose to install it for Phidget purposes, it is important is that the java version be greater than the javac version. Otherwise, your runtime environment will consider the stuff your compiler produces to be newfangled nonsense. So when installing Java from a repository, you should install both the jdk and the jre. These are, unfortunately, usually separate packages in a repository (e.g. openjdk-7-jre and openjdk-7-jdk).
 
The simple examples in Java are meant to be compiled and run on the command line. The example package includes a Makefile so you can either make all of the examples at once, with:
 
<syntaxhighlight lang="java">
make all
</syntaxhighlight>
 
...Or you can make them individually. You can either use:
 
*The HelloWorld example, which will work with any Phidget, or
*The example with the name that corresponds to the family (software object) of your Phidget hardware.
 
The source file will be named the same as the software object for your device. If you are not sure what the software object for your device is, find your Phidget on our webpage, and then check the {{Phidget22API}} documentation for it. Once you've identified the right example - say, HelloWorld.java - compile it on the command line with:
 
<syntaxhighlight lang="java">
javac -classpath .:phidget22.jar HelloWorld.java
</syntaxhighlight>
 
To run the example on a Linux machine without your udev USB rules set, you will need to run the Java example as root:
 
<syntaxhighlight lang="java">
javac -classpath .:phidget22.jar HelloWorld.java
</syntaxhighlight>
 
====Write your own code====
 
You'll note that the Phidget Java library file phidget22.jar needs to be explicitly linked at both points in the compile and run process. Alternatively, you can make a jar file which includes the Phidget Java library. This process takes two steps, the first of which is creating a text file called MyProgram.mf, where MyProgram is replaced by the name of your main class in both the filename and the text below:
 
<syntaxhighlight lang="java">
Manifest-Version: 1.0
Class-Path: phidget22.jar
Main-Class: MyProgram
</syntaxhighlight>
 
'''Note:''' The manifest file should end with a carriage return. So, there should be an extra line at the bottom of the file.
After creating the manifest file, you can use the jar function to create one self-contained file with your classes and the correct classpath.
 
<syntaxhighlight lang="java">
jar –cfm MyProgram.jar MyProgram.mf *.class
</syntaxhighlight>
 
If porting this for an external system, such as one that your customer would be running, the Phidget library would need to be compiled and distributed along with the .jar. Although we do not directly support this, if you are interested in how to construct this, we provide both a distribution example and information on cross-compiling:
*The Android Java libraries have an ARM-compiled libphidget22.so file included, as an example of distributing a compiled libphidget22.so with the jar file
*The Linux page has more detail for compiling the Phidget C Libraries for an external target.
 
===NetBeans===
We offer in-depth tutorials on using our examples in NetBeans and Eclipse in the [[#NetBeans|Windows NetBeans]] and [[#Eclipse|Windows Eclipse]] sections.
 
====Installation====
Although Eclipse is standard in the Debian/Ubuntu package repository, NetBeans is no longer standard. What is more, Netbeans does not install by default into a folder within your path.
 
To install NetBeans:
 
1. Download the install script from website: '''<span style="color:#FF0000">http://netbeans.org/downloads/</span>'''
 
2. Change the permissions of the downloaded file to be executable. Usually, this is something like:
 
chmod +x netbeans-7.1-ml-javase-linux.sh
3. Run the downloaded file as a script. (This will result in a GUI interaction that walks you through installation.)
 
4. To find the location where the NetBeans installation occurred, run:
updatedb
locate netbeans
 
5. Usually, the location of the binary is /usr/local/netbeans-7.1/bin/netbeans, where 7.1 is the installed version.
 
====Use our examples====
Once you have NetBeans installed, running our examples will be very similar to the process described in the Windows NetBeans section
 
====Write your own code====
When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your development environment to properly link the Phidget Java library. Please see the Windows NetBeans section for instructions if you are unfamiliar with NetBeans.
In your code, you will need to include the Phidget Java library:
 
<syntaxhighlight lang="java">
import com.phidget22.*
</syntaxhighlight>
 
The project now has access to the Phidget function calls and you are ready to begin coding.
 
== Edit the 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 Java code will be the {{Phidget22API}}.
 
=== Code Snippets ===
 
When programming in Java, you're in luck. All of our code snippet examples on our [[Phidget Programming Basics]] page are in both C++ and Java. Therefore, we do not include any here, because that page is much more in-depth, and you won't have to have two pages open at once. So head over there, and start writing code!
 
== 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.
=== PhidgetSBC Web Interface ===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+'''Instructions'''
|<center>{{#ev:youtube|gZmWvWXICIA|rel=0}}</center>
|}


[[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.
==Example Code==
Navigate to our [https://www.phidgets.com/?view=code_samples&lang=Java Code Sample Generator] to view and download code samples that are tailored to your specific device.


[[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.
[[Image:Language_java_codesample.png|center|600px|link=https://cdn.phidgets.com/docs/images/a/af/Language_java_codesample.png]]


[[Logging, Exceptions, and Errors]] - Learn about all the tools you can use to debug your program.
===Phidget Programming Basics===
{{PhidgetProgrammingBasicsLink}}


[[Phidget Network Server]] - Phidgets can be controlled and communicated with over your network- either wirelessly or over ethernet.
==API==
[{{SERVER}}/?view=api&lang=Python Phidget22 API]

Latest revision as of 22:38, 12 March 2026


Get Started

With the Phidget22 library, it's easy to create Java applications that work with Phidget devices.

Java Libraries

Source Files

The Phidget22 Java library source files are available here.

Development Environment Configuration

Before choosing a development environment, make sure you have the Java Development Kit installed.

Javac

Instructions
The easiest way to allow Java to access the Phidgets Java library is to place a copy of phidget22.jar in the same folder as your .java program.
Language java javac folder.png
You can download phidget22.jar here.
Once you are ready to run your program, enter the following command in the command prompt or terminal: 
javac -classpath .;phidget22.jar example.java

Finally, enter the following command to run the program: 

java -classpath .;phidget22.jar example

Netbeans

Instructions
The easiest way to allow Java to access the Phidgets Java library is to place a copy of phidget22.jar in the same folder as your .java program.
Language java javac folder.png
You can download phidget22.jar here.
To start, open NetBeans and create a new project. Select Java Application and follow the steps as directed by Netbeans.
Windows netbeans1.jpg
Next, add a reference to phidget22.jar by right-clicking on the libraries folder.
Windows netbeans2.jpg
Navigate to the folder where you downloaded phidget22.jar, and select it.
Windows netbeans3.jpg
The project now has access to Phidgets.

Eclipse

Instructions
The easiest way to allow Java to access the Phidgets Java library is to place a copy of phidget22.jar in the same folder as your .java program.
Language java javac folder.png
You can download phidget22.jar here.
To start, open Eclipse and create a new Java project.
Windows eclipse1.jpg
On the Libraries tab, click Add External JARs and add phidget22.jar to your project as an external jar.
Windows eclipse2.jpg
Create a new Class in your project.
Windows eclipse3.jpg
Name the class, and be sure to check the public static void main box.
Windows eclipse4.jpg
Your project now has access to Phidgets!

PhidgetSBC Web Interface

Instructions

Example Code

Navigate to our Code Sample Generator to view and download code samples that are tailored to your specific device.

Language java codesample.png

Phidget Programming Basics

To learn more about the structure of the example code, visit our Phidget Programming Basics guide.

API

Phidget22 API

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