Language - Java: Difference between revisions

From Phidgets Support
No edit summary
 
(22 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)
We recommend installing the [https://www.phidgets.com/docs/Operating_System_Support Phidget drivers] for your operating system. Installing the drivers will put required .dll files in the proper place where Java will look for them. If you want to run your application on a computer without installing our drivers, see the [[#Deploying Applications|Deploying Applications]] section.


=== Example Code ===
====macOS Considerations====
Legacy Phidgets running a HID USB stack require a driver extension (macOS 10.15 and newer) or a kernel extension (macOS 10.14 and earlier). During development, we recommend downloading the appropriate [https://www.phidgets.com/docs/OS_-_macOS#Quick_Downloads package] which will install the extension. When deploying applications, review the README in the [https://cdn.phidgets.com/downloads/phidget22/libraries/macos/Phidget22_macosdevel.zip macOS Development Files] for information about bundling the extension with your application.


*{{SampleCode|Java|Java Examples}}
=====Determining USB Stack=====
To determine which USB stack your device is running, navigate to the product page and then to the specification tab, and look for the ''USB Stack'' specification. If you are using a VINT device, navigate to the product page for the VINT Hub you are using.


=== Libraries===
[[Image:Javascript_networkserver_webusb_spec.png|center|600px|link=https://cdn.phidgets.com/docs/images/8/80/Javascript_networkserver_webusb_spec.png]]
*[{{SERVER}}/downloads/phidget22/libraries/any/Phidget22Java.zip Java Library Download]
{{AllQuickDownloads}}


==Getting Started with Java==
====Linux Considerations====
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.
Linux restricts access to USB devices to the root user. To run your Python application as a regular user, you'll need to [{{SERVER}}/docs/OS_-_Linux#Setting_Udev_Rules set up udev rules] on your system.


Phidget22 supports Java SE versions 7 and up.
==Development Environment Configuration==


If you are developing for Windows, keep reading. Otherwise, select your operating system to jump ahead:
Before choosing a development environment, make sure you have the [http://www.oracle.com/technetwork/java/index.html Java Development Kit] installed.
*[[#macOS | macOS]]
*[[#Linux | Linux]]


== Windows ==
===Visual Studio Code===
{{Windows_Languages}}
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
===Javac (Command Line)===
|+ '''Instructions'''
====Use Our Examples====
| To start developing with Java in VSCode, open it up and install the '''Extension Pack for Java'''.||[[Image:Language_java_vscode_extension2.png|center|350px|link=https://cdn.phidgets.com/docs/images/b/b4/Language_java_vscode_extension2.png]]
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, press '''Ctrl+Shift+P''' to open the command palette, type "java" and select '''Java: Create Java Project'''.  || [[Image:Language_java_vscode_createproj.png|center|360px|link=https://cdn.phidgets.com/docs/images/7/78/Language_java_vscode_createproj.png]]
 
|-
Next, select an example that will work with your Phidget:
| Select "No Build Tools" and select a directory for the new project. You'll be asked for a project name, and  VSCode will create the directory structure. || [[Image:Language_java_vscode_emptyproj.png|center|350px|link=https://cdn.phidgets.com/docs/images/c/c1/Language_java_vscode_emptyproj.png]]
*{{SampleCode|Java|Java Examples}}
|-
 
| colspan="2"|You'll need to get a copy of '''phidget22.jar''' to put inside the "lib" folder. [https://www.phidgets.com/downloads/phidget22/libraries/any/Phidget22Java.zip You can download phidget22.jar here].
 
|-
Copy phidget22.jar from the following location:
| colspan="2"| You can now begin writing code in the newly created "App.java" file, or you can download a [[#Example_Code|sample program]] for your device and place it in the "src" folder.
*C:\Program Files\Phidgets\Phidget22\phidget22.jar
|-
 
| Compile and run by pressing '''F5''' or by clicking the play button in the top right. || [[Image:Language_java_vscode_run.png|center|350px|link=https://cdn.phidgets.com/docs/images/e/ea/Language_java_vscode_run.png]]
 
|-
Place both the example file and the phidget22.jar file in the same location. Your folder should now look something like this:
| Once you're ready to compile your project into a .jar executable, click on the '''Java Projects''' section in the explorer. || [[Image:Language_java_vscode_jar.png|center|350px|link=https://cdn.phidgets.com/docs/images/6/65/Language_java_vscode_jar.png]]
[[Image:Java_javac_folder.png|link= | center]]
|-
| Click on the export icon, and then select your main class and click OK. || [[Image:Language_java_vscode_jar2.png|center|350px|link=https://cdn.phidgets.com/docs/images/7/74/Language_java_vscode_jar2.png]]
|-
| colspan="2"| Now you can run your new .jar file with the following command:
<syntaxhighlight>
java -jar Example.jar
</syntaxhighlight>
|}


 
===Javac===
Open the command prompt at the folder location. Next, enter the following command in the command prompt:
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
<syntaxhighlight lang="java">
|+ '''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]]
|-
|[https://www.phidgets.com/downloads/phidget22/libraries/any/Phidget22Java.zip You can download phidget22.jar here].||
|-
|colspan="2"|To run your program, enter the following command in the command prompt or terminal:
<syntaxhighlight>
javac -classpath .;phidget22.jar example.java
javac -classpath .;phidget22.jar example.java
</syntaxhighlight>
</syntaxhighlight>
 
Then, enter the following command to run the program:
 
<syntaxhighlight>
Finally, enter the following command to run the program:
java -classpath .;phidget22.jar example  
<syntaxhighlight lang="java">
java -classpath .;phidget22.jar example
</syntaxhighlight>
 
 
[[Image:Java_javac.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 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===
====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://www.eclipse.org/downloads/ Eclipse].
 
 
Now that you have Eclipse installed, select an example that will work with your Phidget:
*{{SampleCode|Java|Java Examples}}
 
 
Next, create a new Java project:
[[Image:Java_eclipse_newproject.PNG|link=| center]]
 
 
Click ''Next >'' and add phidget22.jar to your project as an external jar:
[[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==
{{macOS_Languages}}
===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!
 
====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===
====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://www.eclipse.org/downloads/ Eclipse].You will also need a copy of [{{SERVER}}/downloads/phidget22/libraries/any/Phidget22Java.zip phidget22.jar].
 
 
Now that you have Eclipse installed, select an example that will work with your Phidget:
*{{SampleCode|Java|Java Examples}}
 
 
Next, create a new Java project. Give it the same name as the example you downloaded above:
 
[[Image:Java_eclipse_mac_newproject.png|link=|center]]
 
 
Click ''Next >'' and add phidget22.jar to your project as an external jar:
[[Image:Java_eclipse_mac_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_mac_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.
 
== Linux ==
{{Linux_Languages}}
===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 JDK. You can do this by entering the following command in the terminal (where VERSION is replaced with your preferred version number):
<syntaxhighlight lang='bash'>
apt-get install openjdk-VERSION-jdk
</syntaxhighlight>
 
Before continuing, ensure your JDK version matches your JRE version:
<syntaxhighlight lang='bash'>
javac -version
java -version
</syntaxhighlight>
</syntaxhighlight>
 
||  
 
|-
You will also need a copy of [{{SERVER}}/downloads/phidget22/libraries/any/Phidget22Java.zip phidget22.jar].
| colspan="2"| Once you're ready to compile your project into a .jar executable, create a '''manifest.mf''' file with the following contents:
 
<syntaxhighlight>
 
Manifest-Version: 1.0
Now that you have the JDK installed and phidget22.jar on hand, select an example that will work with your Phidget:
Main-Class: example
*{{SampleCode|Java|Java Examples}}
Class-Path: phidget22.jar
 
 
 
Your project folder should now look something like this:
[[Image:Java_javac_linux_folder.PNG|link=|center]]
 
 
Next, open the terminal at the folder location and enter the following command:
<syntaxhighlight lang='bash'>
javac -classpath .:phidget22.jar example.java
</syntaxhighlight>
</syntaxhighlight>
 
Make sure there's an empty newline at the bottom of the three lines and a space after each colon.
Finally, enter the following command to run the program:
|-
<syntaxhighlight lang='bash'>
| colspan="2"| Next, create the .jar file with this command:
java -classpath .:phidget22.jar example
<syntaxhighlight>
jar cfm example.jar manifest.mf *.class
</syntaxhighlight>
</syntaxhighlight>
 
Once the .jar is created, you can execute it with
 
<syntaxhighlight>
[[Image:Java_javac_linux_run.PNG|link=|center]]
java -jar example.jar
 
 
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>
</syntaxhighlight>


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]. 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_linux_newproject.PNG|link=|center]]
 
 
Give your project a name and finish creating the project:
[[Image:Java_netbeans_linux_nameproject.PNG|link= |center]]
 
 
Delete the java file that was generated with the project:
[[Image:Java_netbeans_linux_delete.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_linux_addjar.png|link= |center]]
 
 
[[Image:Java_netbeans_linux_jarpath.png|link=|center]]
 
 
Before you run the example, you may need to set up your Udev rules. An explanation on how to do this is provided on the Linux OS page, which can be accessed [[OS - Linux#Setting udev Rules | here]].
 
 
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:
===Netbeans===
<syntaxhighlight lang="java">
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
import com.phidget22.*
|+ '''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]]
|-
|[https://www.phidgets.com/downloads/phidget22/libraries/any/Phidget22Java.zip 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.|| [[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]]
|-
| 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]]
|-
| The project now has access to Phidgets. By default, Netbeans should create an executable .jar file in the '''dist''' folder of the project directory when it's built. If it didn't, go to '''Build -> Packaging''' in the project properties and make sure "Build JAR after compiling" is checked.|| [[Image:Windows_netbeans4.png|center|350px|link=https://cdn.phidgets.com/docs/images/7/78/Windows_netbeans4.png]]
|-
| colspan="2"| You can now run the .jar file from the command prompt with:
<syntaxhighlight>
java -jar phidgetTest.jar
</syntaxhighlight>
</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]. You will also need a copy of [{{SERVER}}/downloads/phidget22/libraries/any/Phidget22Java.zip phidget22.jar].  
|+ '''Instructions'''
 
| To start, open Eclipse and create a new Java project. Name the project and uncheck the '''create module-info.java file''' box.|| [[Image:java_eclipse_newproj.png|center|350px|link=https://cdn.phidgets.com/docs/images/9/97/Java_eclipse_newproj.png]]
 
|-
Now that you have Eclipse installed, select an example that will work with your Phidget:
| On the Libraries tab, click Add External JARs and add [https://www.phidgets.com/downloads/phidget22/libraries/any/Phidget22Java.zip phidget22.jar]. to your project as an external jar. Be sure it's being added to the '''Classpath''' and not the module path. || [[Image:java_eclipse_library.png|center|350px|link=https://cdn.phidgets.com/docs/images/1/1b/Java_eclipse_library.png]]
*{{SampleCode|Java|Java Examples}}
|-
 
| Create a new Class in your project. || [[Image:java_eclipse_newclass.png|center|350px|link=https://cdn.phidgets.com/docs/images/0/02/Java_eclipse_newclass.png]]
 
|-
Next, create a new Java project. Give it the same name as the example you downloaded above:
| Name the class, and be sure to check the '''public static void main''' box. Eclipse may require that you add a package name. || [[Image:java_eclipse_newclass2.png|center|350px|link=https://cdn.phidgets.com/docs/images/c/ca/Java_eclipse_newclass2.png]]
 
|-
[[Image:Java_eclipse_linux_newproject.PNG|link=| center]]
| Your project now has access to Phidgets! ||
 
|-
 
| Once you're ready to compile your project into a .jar executable, right click on the project in the package explorer and choose '''Export'''. Select '''Runnable JAR file'''. || [[Image:java_eclipse_export.png|center|350px|link=https://cdn.phidgets.com/docs/images/8/8c/Java_eclipse_export.png]]
Click ''Next >'' and add phidget22.jar to your project as an external jar:
|-
[[Image:Java_eclipse_linux_addjar.PNG|link=| center]]
| Choose the main class and a destination for the .jar file and click finish. || [[Image:java_eclipse_export2.png|center|350px|link=https://cdn.phidgets.com/docs/images/8/8d/Java_eclipse_export2.png]]
 
|-
 
| colspan="2"| You can now run the .jar file from the command prompt with:
Finally, drag the example java file into the src folder that has been created for you and run the example:
<syntaxhighlight>
 
java -jar phidgetTest.jar
[[Image:Java_eclipse_linux_run.png|link=|center]]
 
 
Before you run the example, you may need to set up your Udev rules. An explanation on how to do this is provided on the Linux OS page, which can be accessed [[OS - Linux#Setting udev Rules | here]].
 
 
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>
</syntaxhighlight>
|}


You can now create your project as shown in the previous section.
=== PhidgetSBC Web Interface ===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+'''Instructions'''
|<center>{{#ev:youtube|gZmWvWXICIA|rel=0}}</center>
|}


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


The project now has access to Phidgets. Next, view the [[#Write Code | write your own code]] section located below.
[[Image:Language_java_codesample.png|center|600px|link=https://cdn.phidgets.com/docs/images/a/af/Language_java_codesample.png]]


==Write Code==
===Phidget Programming Basics===
You've followed the instructions above for your operating system and now have a working example. Next, we will show you how the example was created and how it works by getting into the code. When you are ready, head to our [[Phidget Programming Basics]] page. There you will find code examples writen in Java and you will be writing your own code in no time!
{{PhidgetProgrammingBasicsLink}}


== Further Reading ==
==API==
[[Phidget Programming Basics]] - Here you can find the basic concepts to help you get started with making your own programs that use Phidgets.
[{{SERVER}}/?view=api&lang=Python Phidget22 API]


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


[[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.
If you're planning to deploy your application, it should be noted that you don't strictly need the Phidget Drivers installed.  


[[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.
At a minimum, these three files are required:
* phidget22.jar
* phidget22.dll
* phidget22java.dll


[[Logging, Exceptions, and Errors]] - Learn about all the tools you can use to debug your program.
All three files can be found in the [https://cdn.phidgets.com/downloads/phidget22/libraries/windows/Phidget22-windevel.zip Development Files]. The .jar file is in lib/java, and the .dll files are in lib/c/x64.  


[[Phidget Network Server]] - Phidgets can be controlled and communicated with over your network- either wirelessly or over ethernet.
Java will look for these files in several locations, including the classpath and the working folder of the project.

Latest revision as of 20:05, 1 April 2026


Get Started

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

Java Libraries

We recommend installing the Phidget drivers for your operating system. Installing the drivers will put required .dll files in the proper place where Java will look for them. If you want to run your application on a computer without installing our drivers, see the Deploying Applications section.

macOS Considerations

Legacy Phidgets running a HID USB stack require a driver extension (macOS 10.15 and newer) or a kernel extension (macOS 10.14 and earlier). During development, we recommend downloading the appropriate package which will install the extension. When deploying applications, review the README in the macOS Development Files for information about bundling the extension with your application.

Determining USB Stack

To determine which USB stack your device is running, navigate to the product page and then to the specification tab, and look for the USB Stack specification. If you are using a VINT device, navigate to the product page for the VINT Hub you are using.

Javascript networkserver webusb spec.png

Linux Considerations

Linux restricts access to USB devices to the root user. To run your Python application as a regular user, you'll need to set up udev rules on your system.

Development Environment Configuration

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

Visual Studio Code

Instructions
To start developing with Java in VSCode, open it up and install the Extension Pack for Java.
Language java vscode extension2.png
Next, press Ctrl+Shift+P to open the command palette, type "java" and select Java: Create Java Project.
Language java vscode createproj.png
Select "No Build Tools" and select a directory for the new project. You'll be asked for a project name, and VSCode will create the directory structure.
Language java vscode emptyproj.png
You'll need to get a copy of phidget22.jar to put inside the "lib" folder. You can download phidget22.jar here.
You can now begin writing code in the newly created "App.java" file, or you can download a sample program for your device and place it in the "src" folder.
Compile and run by pressing F5 or by clicking the play button in the top right.
Language java vscode run.png
Once you're ready to compile your project into a .jar executable, click on the Java Projects section in the explorer.
Language java vscode jar.png
Click on the export icon, and then select your main class and click OK.
Language java vscode jar2.png
Now you can run your new .jar file with the following command: 
java -jar Example.jar

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.
To run your program, enter the following command in the command prompt or terminal: 
javac -classpath .;phidget22.jar example.java

Then, enter the following command to run the program: 

java -classpath .;phidget22.jar example
Once you're ready to compile your project into a .jar executable, create a manifest.mf file with the following contents: 
Manifest-Version: 1.0
Main-Class: example
Class-Path: phidget22.jar
 

Make sure there's an empty newline at the bottom of the three lines and a space after each colon.

Next, create the .jar file with this command: 
jar cfm example.jar manifest.mf *.class

Once the .jar is created, you can execute it with 

java -jar example.jar

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. By default, Netbeans should create an executable .jar file in the dist folder of the project directory when it's built. If it didn't, go to Build -> Packaging in the project properties and make sure "Build JAR after compiling" is checked.
Windows netbeans4.png
You can now run the .jar file from the command prompt with: 
java -jar phidgetTest.jar

Eclipse

Instructions
To start, open Eclipse and create a new Java project. Name the project and uncheck the create module-info.java file box.
Java eclipse newproj.png
On the Libraries tab, click Add External JARs and add phidget22.jar. to your project as an external jar. Be sure it's being added to the Classpath and not the module path.
Java eclipse library.png
Create a new Class in your project.
Java eclipse newclass.png
Name the class, and be sure to check the public static void main box. Eclipse may require that you add a package name.
Java eclipse newclass2.png
Your project now has access to Phidgets!
Once you're ready to compile your project into a .jar executable, right click on the project in the package explorer and choose Export. Select Runnable JAR file.
Java eclipse export.png
Choose the main class and a destination for the .jar file and click finish.
Java eclipse export2.png
You can now run the .jar file from the command prompt with: 
java -jar phidgetTest.jar

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

Deploying Applications

If you're planning to deploy your application, it should be noted that you don't strictly need the Phidget Drivers installed.

At a minimum, these three files are required:

  • phidget22.jar
  • phidget22.dll
  • phidget22java.dll

All three files can be found in the Development Files. The .jar file is in lib/java, and the .dll files are in lib/c/x64.

Java will look for these files in several locations, including the classpath and the working folder of the project.

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