Language - Java: Difference between revisions
No edit summary |
|||
(282 intermediate revisions by 10 users not shown) | |||
Line 1: | Line 1: | ||
[[Category:Language]] | |||
__NOTOC__ | |||
We provide support for the Java language in all major operating systems. We also provide instructions on how to get your project started in a number of common development environments. Select your operating system and preferred development environment below, and follow the instructions to get your project running with Phidgets. | |||
If you do not know which development environment you want to use, or your development environment of choice is not listed, we recommend starting with javac as the simplest path to getting your code running. | |||
Once you have set up your development environment to run with Phidgets, we recommend you follow our guide on [[Phidget Programming Basics]]. The guide will showcase the fundamentals of programming with Phidgets, with examples in Java. | |||
== | == Setup Guide == | ||
= | <div class="phd-deck-sequence"> | ||
{{PT3_JAVA_CHOOSE}}{{PT3_JAVA_WIN_JAVAC}}{{PT3_JAVA_MAC_JAVAC}}{{PT3_JAVA_LNX_JAVAC}}{{PT3_JAVA_SBC_JAVAC}}{{PT3_JAVA_WIN_NETBEANS}}{{PT3_JAVA_MAC_NETBEANS}}{{PT3_JAVA_LNX_NETBEANS}}{{PT3_JAVA_WIN_ECLIPSE}}{{PT3_JAVA_MAC_ECLIPSE}}{{PT3_JAVA_LNX_ECLIPSE}}{{PT3_JAVA_ANDROID_AS}} | |||
</div> | |||
== Quick Downloads == | |||
If you already know what you're doing and just need the files, you can find them all below. | |||
=== Documentation === | |||
*{{Phidget22API}} (select Java from the drop-down menu) | |||
== | === Example Code === | ||
== | *{{SampleCode|Java|Java Examples}} | ||
===Libraries=== | |||
*[https://cdn.phidgets.com/downloads/phidget22/libraries/any/Phidget22Java.zip phidget22.jar] | |||
{{AllQuickDownloads}} |
Latest revision as of 22:07, 17 October 2023
We provide support for the Java language in all major operating systems. We also provide instructions on how to get your project started in a number of common development environments. Select your operating system and preferred development environment below, and follow the instructions to get your project running with Phidgets.
If you do not know which development environment you want to use, or your development environment of choice is not listed, we recommend starting with javac as the simplest path to getting your code running.
Once you have set up your development environment to run with Phidgets, we recommend you follow our guide on Phidget Programming Basics. The guide will showcase the fundamentals of programming with Phidgets, with examples in Java.
Setup Guide
Java - Select Development Environment
Select your Development Environment:
Windows
MacOS
Linux
PhidgetSBC
Android
Language - Java
Windows with Javac
Welcome to using Phidgets with Java! By using Java, you will have access to the complete Phidget22 API, including events.
Javac is a command line-based compiler for java programs that compiles java code into bytecode class files.
Requirements
First, make sure you have the following installed:
● Phidgets Drivers for Windows (see Part 1 of this user guide)
● The Java Development Kit from Oracle
Finding Code Samples
To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.
Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.
Using the Code Samples
If it's unclear what any of the options do, click on the nearby '?' for more info.
Once you've made your selections, click the Download Example button to download a sample Java file.
Setting up a New Project
Whether you are running our examples or adding Phidget functionality to an existing project, you'll need to configure your development environment to properly link the Phidget Java library.
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 program. We recommend you copy phidget22.jar from the following location:
C:\Program Files\Phidgets\Phidget22\phidget22.jar
Your folder should look something like this:
Compile and Run
Once you are ready to run your program, open the command prompt at the folder location. Next, enter the following command in the command prompt:
javac -classpath .;phidget22.jar example.java
Finally, enter the following command to run the program:
java -classpath .;phidget22.jar example
The project is now using Phidgets!
What's Next?
Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.
Continue reading below for advanced information and troubleshooting for your device.
Language - Java
MacOS with Javac
Welcome to using Phidgets with Java! By using Java, you will have access to the complete Phidget22 API, including events.
Javac is a command line-based compiler for java programs that compiles java code into bytecode class files.
Requirements
First, make sure you have the following installed:
● Phidgets Drivers for MacOS (see Part 1 of this user guide)
● The Java Development Kit from Oracle
● A copy of phidget22.jar
Finding Code Samples
To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.
Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.
Using the Code Samples
If it's unclear what any of the options do, click on the nearby '?' for more info.
Once you've made your selections, click the Download Example button to download a sample Java file.
Setting up a New Project
Whether you are running our examples or adding Phidget functionality to an existing project, you'll need to configure your development environment to properly link the Phidget Java library.
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 program:
Compile and Run
Once you are ready to run your program, open the terminal at the folder location. Next, enter the following command in the terminal:
javac -classpath .:phidget22.jar example.java
Finally, enter the following command to run the program:
java -classpath .:phidget22.jar example
The project is now using Phidgets!
What's Next?
Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.
Continue reading below for advanced information and troubleshooting for your device.
Language - Java
Linux with Javac
Welcome to using Phidgets with Java! By using Java, you will have access to the complete Phidget22 API, including events.
Javac is a command line-based compiler for java programs that compiles java code into bytecode class files.
Requirements
First, make sure you have the following installed:
● Phidgets Drivers for Linux (see Part 1 of this user guide)
● The Java Development Kit from Oracle
● A copy of phidget22.jar
Installing Java
In order to use Java, 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):
apt-get install openjdk-VERSION-jdk
Before continuing, ensure your JDK version matches your JRE version:
javac -version
java -version
Finding Code Samples
To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.
Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.
Using the Code Samples
If it's unclear what any of the options do, click on the nearby '?' for more info.
Once you've made your selections, click the Download Example button to download a sample Java file.
Setting up a New Project
Whether you are running our examples or adding Phidget functionality to an existing project, you'll need to configure your development environment to properly link the Phidget Java library.
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 program:
Compile and Run
Once you are ready to run your program, open the terminal at the folder location. Next, enter the following command in the terminal:
javac -classpath .:phidget22.jar example.java
Finally, enter the following command to run the program:
java -classpath .:phidget22.jar example
The project is now using Phidgets!
What's Next?
Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.
Continue reading below for advanced information and troubleshooting for your device.
Language - Java
PhidgetSBC with Javac
Welcome to using Phidgets with Java! By using Java, you will have access to the complete Phidget22 API, including events.
Javac is a command line-based compiler for java programs that compiles java code into bytecode class files.
Requirements
If you haven't already, check out the user guide in order to set up the following:
● Networking
● Administrator password
This guide will cover development using an external machine. For development using the SBC itself, go back and select Javac - Linux as your environment.
Introduction
To begin, this video will help you get started:
Developing With An External Computer
There are two main ways in which you can access your SBC from an external computer:
● SBC Web Interface
● Secure Shell (SSH)
Since the SBC User Guide covers the web interface in detail, this guide will cover SSH.
SSH
If you are unfamiliar with SSH, it is a simple yet powerful tool that allows you to log into a remote machine in order to execute commands. You can also transfer files using the associated SCP tool.
In order to use SSH, you need the following:
● The SBC's IP address (e.g. 192.168.3.195) or the link local address (e.g. phidgetsbc.local)
● The administrator password
● SSH enabled on the SBC
SSH
You can enable SSH on the SBC Web Interface as shown below:
SSH on Windows
To use SSH on Windows, we recommend PuTTY. Use the images below as a guide for configuring PuTTY (use the IP address or the link local address interchangeably):
SSH on Windows
After clicking open, simply login as root and provide the administrator password:
To transfer files between your SBC and Windows machine, we recommend either of these programs:
● WinSCP
You will follow a similar process to access the SBC as described for SSH.
SSH on Linux and macOS
SSH is available on Linux and macOS by default. To run SSH, open the terminal and type:
ssh root@phidgetsbc.local
Or, something like this (you will need to know the IP address of your SBC):
ssh root@192.168.3.195
You will then be prompted for the password in order to gain access to the SBC:
SSH on Linux and macOS
To copy a file from the SBC to your development machine using SCP, open the terminal and type:
scp root@phidgetsbc.local:/path/to/source /path/to/destination
You can reverse this if you want to transfer a file from your development machine to your SBC:
scp /path/to/source root@phidgetsbc.local:/path/to/destination
Installing Packages For Development
The simplest way to set up Java on the SBC is via the install buttons on located on the SBC Web Interface (System->Packages). Check Include full Debian Package Repository before installing.
You will need to run commands on the SBC to install support for Python. You can either use SSH to issue the commands, or you can connect directly to the SBC via a monitor and keyboard.
Installing Packages For Development
When developing for Java, ensure your development machine and your SBC have the same version of Java. Check your Java version by entering this command:
java -version
If you need to update the version of Java on your SBC, use the following commands:
apt-get install default-jre-headless
su
update-alternatives --config java
You're now ready to begin programming! Continue through this guide for code examples and directions on where to go next.
Finding Code Samples
To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.
Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.
Using the Code Samples
If it's unclear what any of the options do, click on the nearby '?' for more info.
Once you've made your selections, click the Download Example button to download a sample Java file.
Setting up a New 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.
When developing on an external computer, you will write, compile, and test your programs on that machine. When you are ready, you will then upload your programs to the SBC to run them.
Setting up a New Project
Once your code is written, follow these steps to get your program running on the SBC:
1. Place phidget22.jar on your development machine in a directory that you will use to compile your Java files.
2. Compile your ProgramName.java file. If you are using a Windows machine, type the following into the command prompt:
javac -classpath .;phidget22.jar ProgramName.java
3. If you are using a Linux or macOS machine, type the following into the terminal:
javac -classpath .:phidget22.jar ProgramName.java
You should now have a number of .class files in your project directory
Setting up a New Project
4. Using the SBC Web Interface, create a new project:
Setting up a New Project
5. Transfer all the .class files from the development machine to the SBC, either using the SBC Web Interface or a tool like WinSCP.
The project directory will be:
/usr/userapps/ProjectName
Setting up a New Project
6. Use SSH to access the SBC terminal and go to the project folder:
cd /usr/userapps/ProjectName
You can now run the program with the command:
java ExampleName
Success! The program is running on your SBC.
Running a Program Automatically
Click on the sections below for various automation options:
-----
To quickly test whether a program can be run automatically, you can try starting it from the SBC Web Interface.
1. To start the program, navigate to Projects->ProjectName->Startup Settings in the SBC Web Interface.
2. Select your program in the drop-down menu labeled Executable/Class Name
.
3. Click the Start button on the SBC web interface.
4. You'll note that as it runs, there are two links below the Stop button which can be used to view the program output:
- stdout: view the program output like you would in a terminal or command prompt
- stderr: view the program error output
Running on boot ensures that your program will never miss an event. As long as the SBC is running, your code will be running. This section assumes you have written and compiled your program on an external computer, and have uploaded it to the SBC Web Interface.
To have your program run on boot, navigate to Projects->ProjectName->Startup Settings in the SBC Web Interface. After selecting your project, copy the settings from the image below:
We will review some of the options that are shown in the image above:
- Startup Order: lower numbers boot first. Booting later means more programs are available for use, booting earlier means other programs can use your program.
- Run as a daemon: starts the program as a daemon. Unless you have explicitly written your program as a daemon, leave this checked, or else your SBC may hang on boot.
- Executable/Class name: your main Java class or C file.
- Arguments: any command line arguments the program needs.
After saving your changes, your program will run automatically whenever your SBC boots.
Running your program on a schedule allows you to perform your task once a week, or once a minute without worrying about memory management issues or instability problems that may arise. It executes, and then gets cleaned up. To run your program on a schedule, we recommend using Cron. Cron can automatically schedule programs (known as jobs, or cron jobs). Cron simply reads a crontab file and runs whatever programs are listed, with whatever timing they are listed with. Cron runs continuously in the background, but the cron jobs only run as long as they naturally would, and then they exit.
Let's set up your first cron job. We will use nano to edit the crontab file, but feel free to use whatever editor you prefer.
First, set your editor to nano:
export EDITOR=nano
Next, edit your crontab file:
crontab -e
Finally, schedule your cron job:
#cron job that will run at 5AM every week:
0 5 * * 1 /root/code/myprogram argument1
After entering your task, simply save and exit the file.
What's Next?
Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.
Continue reading below for advanced information and troubleshooting for your device.
Language - Java
Windows with NetBeans
Welcome to using Phidgets with Java! By using Java, you will have access to the complete Phidget22 API, including events.
NetBeans is an IDE used to write, compile, and run Java applications.
Requirements
First, make sure you have the following installed:
● Phidgets Drivers for Windows (see Part 1 of this user guide)
● The Java Development Kit from Oracle
Setting up a New Project
Whether you are running our examples 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 then click Next:
Setting up a New Project
If necessary, download and activate the recommended features:
Setting up a New Project
Follow the steps to install the plugins:
Setting up a New Project
Give your project a name and finish creating the project:
Setting up a New Project
Next, add a reference to phidget22.jar by right-clicking on the libraries folder:
Setting up a New Project
You can find phidget22.jar at the following location:
C:\Program Files\Phidgets\Phidget22\phidget22.jar
Your project now has access to Phidgets!
Finding Code Samples
To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.
Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.
Using the Code Samples
If it's unclear what any of the options do, click on the nearby '?' for more info.
Once you've made your selections, click the copy button and paste the code into your new project.
Be sure to change the name of the top class to match the name of the file in your project.
What's Next?
Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.
Continue reading below for advanced information and troubleshooting for your device.
Language - Java
MacOS with NetBeans
Welcome to using Phidgets with Java! By using Java, you will have access to the complete Phidget22 API, including events.
NetBeans is an IDE used to write, compile, and run Java applications.
Requirements
First, make sure you have the following installed:
● Phidgets Drivers for MacOS (see Part 1 of this user guide)
● The Java Development Kit from Oracle
● You will need a copy of phidget22.jar
Setting up a New Project
Whether you are running our examples 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 then click Next:
Setting up a New Project
Give your project a name and finish creating the project:
Setting up a New Project
Next, add a reference to the phidget22.jar you downloaded above by right-clicking on the libraries folder:
The project now has access to Phidgets.
Finding Code Samples
To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.
Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.
Using the Code Samples
If it's unclear what any of the options do, click on the nearby '?' for more info.
Once you've made your selections, click the copy button and paste the code into your new project.
Be sure to change the name of the top class to match the name of the file in your project.
What's Next?
Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.
Continue reading below for advanced information and troubleshooting for your device.
Language - Java
Linux with NetBeans
Welcome to using Phidgets with Java! By using Java, you will have access to the complete Phidget22 API, including events.
NetBeans is an IDE used to write, compile, and run Java applications.
Requirements
First, make sure you have the following installed:
● Phidgets Drivers for Linux (see Part 1 of this user guide)
● The Java Development Kit from Oracle
● You will need a copy of phidget22.jar
Setting up a New Project
Whether you are running our examples 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 then click Next:
Setting up a New Project
Give your project a name and finish creating the project:
Setting up a New Project
Next, add a reference to phidget22.jar by right-clicking on the libraries folder:
Setting up a New Project
Locate phidget22.jar and click OK.
The project now has access to Phidgets.
Finding Code Samples
To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.
Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.
Using the Code Samples
If it's unclear what any of the options do, click on the nearby '?' for more info.
Once you've made your selections, click the copy button and paste the code into your new project.
Be sure to change the name of the top class to match the name of the file in your project.
What's Next?
Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.
Continue reading below for advanced information and troubleshooting for your device.
Language - Java
Windows with Eclipse
Welcome to using Phidgets with Java! By using Java, you will have access to the complete Phidget22 API, including events.
Eclipse is an IDE used to write, compile, and run Java applications.
Requirements
First, make sure you have the following installed:
● Phidgets Drivers for Windows (see Part 1 of this user guide)
● The Java Development Kit from Oracle
Setting up a New Project
To start, open Eclipse and create a new Java project. Give it a name and click Next:
Setting up a New Project
On the Libraries tab, click Add External JARs and add phidget22.jar to your project as an external jar:
Setting up a New Project
Create a new Class in your project:
Setting up a New Project
Name the class, and be sure to check the public static void main box.
Your project now has access to Phidgets!
Finding Code Samples
To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.
Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.
Using the Code Samples
If it's unclear what any of the options do, click on the nearby '?' for more info.
Once you've made your selections, click the copy button and paste the code into your new project.
Be sure to change the name of the top class to match the name of the file in your project.
What's Next?
Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.
Continue reading below for advanced information and troubleshooting for your device.
Language - Java
MacOS with Eclipse
Welcome to using Phidgets with Java! By using Java, you will have access to the complete Phidget22 API, including events.
Eclipse is an IDE used to write, compile, and run Java applications.
Requirements
First, make sure you have the following installed:
● Phidgets Drivers for MacOS (see Part 1 of this user guide)
● The Java Development Kit from Oracle
● You will need a copy of phidget22.jar
Setting up a New Project
To start, open Eclipse and create a new Java project. Give it a name and click Next:
Setting up a New Project
On the Libraries tab, click Add External JARs and add phidget22.jar to your project as an external jar:
Setting up a New Project
Create a new Class in your project:
Setting up a New Project
Name the class, and be sure to check the public static void main box.
Your project now has access to Phidgets!
Finding Code Samples
To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.
Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.
Using the Code Samples
If it's unclear what any of the options do, click on the nearby '?' for more info.
Once you've made your selections, click the copy button and paste the code into your new project.
Be sure to change the name of the top class to match the name of the file in your project.
What's Next?
Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.
Continue reading below for advanced information and troubleshooting for your device.
Language - Java
Linux with Eclipse
Welcome to using Phidgets with Java! By using Java, you will have access to the complete Phidget22 API, including events.
Eclipse is an IDE used to write, compile, and run Java applications.
Requirements
First, make sure you have the following installed:
● Phidgets Drivers for Linux (see Part 1 of this user guide)
● The Java Development Kit from Oracle
● You will need a copy of phidget22.jar
Setting up a New Project
To start, open Eclipse and create a new Java project. Give it a name and click Next:
Setting up a New Project
On the Libraries tab, click Add External JARs and add phidget22.jar to your project as an external jar:
Setting up a New Project
Create a new Class in your project:
Setting up a New Project
Name the class, and be sure to check the public static void main box.
Your project now has access to Phidgets!
Finding Code Samples
To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.
Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.
Using the Code Samples
If it's unclear what any of the options do, click on the nearby '?' for more info.
Once you've made your selections, click the copy button and paste the code into your new project.
Be sure to change the name of the top class to match the name of the file in your project.
What's Next?
Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.
Continue reading below for advanced information and troubleshooting for your device.
Language - Java
Android with Android Studio
Welcome to using Phidgets with Java! By using Java, you will have access to the complete Phidget22 API, including events.
Android Studio is a graphical IDE for Android java programs.
Creating A New 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 libraries for Android Java.
To start, create a new project in Android Studio:
Creating A New Project
Once you have a new project, be sure to switch the side bar to Project view.
Creating A New Project
Next, download the Phidget22 Android Java libraries, extract the contents, and open the resulting folder.
Creating A New Project
Copy the .jar files into the app/libs/ folder of your project. If you are only going to use network Phidgets in your app, then you don't need to copy Phidget22usb.jar into your project.
Right click the jar files you just copied and select Add As Library.
Creating A New Project
Create a directory called jnilibs under app/src/main
Creating A New Project
Copy the remaining folders from the Phidget22 library (containing versions of libphidget22java.so) into the directory you just created.
Creating A New Project
To allow the use of the network and/or USB connections, the following lines must be added to your AndroidManifest.xml file:
<!-- Required for network access --> <uses-permission android:name="android.permission.INTERNET" /> <!-- Required for USB access --> <uses-feature android:name="android.hardware.usb.host" />
Finally, to import the Phidget22 library into your code, add the following line to the rest of your imports:
import com.phidget22.*;
The project now has access to Phidgets. Next, we'll walk through the steps for writing your own code.
Write Code
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.
Your main reference for writing Android Java code will be:
● The Phidget22 API
● The Java example code
Write Code
Step One: Initialize and Open
You will need to declare your Phidget object in your code. For example, we can declare a digital input object like this:
DigitalInput device;
Next, we need to initialize the method(s) that the Android device can communicate with the Phidget. This is done either by enabling Network Server Discovery, and/or allowing direct USB connections as follows:
//Enable server discovery to list remote Phidgets this.getSystemService(Context.NSD_SERVICE); Net.enableServerDiscovery(ServerType.DEVICE_REMOTE); //Allow direct USB connection of Phidgets com.phidget22.usb.Manager.Initialize(this);
Write Code
To support remote (network) Phidgets on Android API versions earlier than API version 16, or to connect to Phidget Network Servers with passwords, you will need to add the specific server to your program:
//Add a specific network server to communicate with Phidgets remotely Net.addServer("ServerName", "192.168.1.105", 5661, "password", 0);
After the connection methods are established, the Phidget object needs to be initialized and opened:
device = new DigitalInput(); device.open();
Write Code
Although we are not including it on this page, you should include error handling for all Phidget functions. Here is an example of the previous code with error handling:
try{ device = new DigitalInput(); device.open(); }catch (PhidgetException e) { e.printStackTrace(); }
For more information on error handling with Phidgets, see this page.
Write Code
Step Two: Wait for Attachment (plugging in) of the Phidget
Simply calling open does not guarantee you can use the Phidget immediately. To use a Phidget, it must be plugged in (attached). We can handle this by using event driven programming and tracking the attach events. Alternatively, we can modify our code so we wait for an attachment:
ch = new DigitalInput(); ch.open(5000); //wait for attach for 5 seconds, if not time out
Waiting for attachment will block indefinitely until a connection is made, or until the timeout value is exceeded.
Write Code
To use events, we have to modify our code:
ch = new DigitalInput(); device.addAttachListener(new AttachListener() { public void onAttach(final AttachEvent attachEvent) { AttachEventHandler handler = new AttachEventHandler(device); synchronized(handler) { runOnUiThread(handler); try { handler.wait(); } catch (InterruptedException e) { e.printStackTrace(); } } } }); ch.open();
Write Code
Next, we have to declare the function that will be called when an attach event is fired - in this case the function AttachEventHandler will be called.
class AttachEventHandler implements Runnable { Phidget device; public AttachEventHandler(Phidget device) { this.device = device; } public void run() { TextView attachedTxt = (TextView) findViewById(R.id.attachedTxt); attachedTxt.setText("Attached"); //notify that we're done synchronized(this) { this.notify(); } } }
Write Code
Step Three: Do Things with the Phidget
We recommend the use of event driven programming when working with Phidgets. In a similar way to handling an attach event as described above, we can also add an event handler for a state change event:
ch = new DigitalInput(); device.addStateChangeListener(new DigitalInputStateChangeListener() { public void onStateChange(DigitalInputStateChangeEvent stateChangeEvent) { DigitalInputStateChangeEventHandler handler = new DigitalInputStateChangeEventHandler(device, stateChangeEvent); runOnUiThread(handler); } }); ch.open();
This code will connect a function and an event. In this case, the DigitalInputStateChangeEventHandler function will be called when there has been a change to the devices input.
Write Code
Next, we need to create the DigitalInputStateChangeEventHandler function itself:
class DigitalInputStateChangeEventHandler implements Runnable { Phidget device; DigitalInputStateChangeEvent stateChangeEvent; public DigitalInputStateChangeEventHandler(Phidget device, DigitalInputStateChangeEvent stateChangeEvent) { this.device = device; this.stateChangeEvent = stateChangeEvent; } public void run() { CheckBox stateBox = (CheckBox) findViewById(R.id.stateBox); stateBox.setChecked(stateChangeEvent.getState()); } }
If events do not suit your needs, you can also poll the device directly for data using code like this:
boolean state = ch.getState();
Write Code
Step Four: Close and Delete
At the end of your program, be sure to close your device.
ch.close();
Once the device is closed, to completely clean up after using Phidgets, you must uninitialize the USB connection as follows:
//Disable USB connection to Phidgets com.phidget22.usb.Manager.Uninitialize();
What's Next?
Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.
Continue reading below for advanced information and troubleshooting for your device.
Common Problems, Solutions and Workarounds
You are likely using one of our examples, or handling the opening and closing of Phidgets in a similar way. In either case, chances are you are opening and closing Phidgets in your main activity. This is not recommended for practical applications, as the entire activity can be destroyed and re-created many times through its lifecycle due to configuration changes such as rotating the screen. This is a reality of the Android operating system, and must be addressed in whatever way best suits your application. A good option to keep your Phidgets connected would be to implement a Started Service or a Foreground Service, depending on your application, and open your Phidgets there.
Quick Downloads
If you already know what you're doing and just need the files, you can find them all below.
Documentation
- Phidget22 API (select Java from the drop-down menu)