Mparadis at 16:27, 22 April 2025

2025-04-22T16:27:32Z

← Older revision		Revision as of 16:27, 22 April 2025
Line 41:		Line 41:

	<p>		<p>
	Next, download the Phidget22 <span>[https://~~www~~.phidgets.com/downloads/phidget22/libraries/~~any~~/~~Phidget22AndroidJava~~.zip Android Java libraries]</span>, extract		Next, download the Phidget22 <span>[https://cdn.phidgets.com/downloads/phidget22/libraries/android/phidget22-android.zip Android Java libraries]</span>, extract
	the contents, and open the resulting folder.		the contents, and open the resulting folder.
	</p>		</p>

Patrick at 22:58, 4 January 2024

2024-01-04T22:58:05Z

@@ Line 14: / Line 14: @@
 </div>
 </div>
 </div>

Mparadis: Created page with "

Language - Java

..."

2021-03-08T21:39:15Z

Created page with "<div class="phd-slide-deck" data-deck="PT3_JAVA_ANDROID_AS"> <div class="phd-slide-deck-header"><h3>Language - Java</h3></div> <div class="phd-slides"> <div class="phd-slide">..."

New page

<div class="phd-slide-deck" data-deck="PT3_JAVA_ANDROID_AS">
<div class="phd-slide-deck-header"><h3>Language - Java</h3></div>
<div class="phd-slides">
<div class="phd-slide">
<h2>Android with Android Studio</h2>

<div class="phd-panels">
<div class="phd-panel phd-flex-column-align-center phd-flex-column-justify-middle">
<div class="phd-lazy-image" data-src="https://www.phidgets.com/decks/PT3_JAVA_ANDROID_AS/200x-/50/as.jpg"></div>
</div>
<div class="phd-panel phd-flex-column-align-left phd-flex-column-justify-top">
<p>Welcome to using Phidgets with Java! By using Java, you will have access to the complete Phidget22 API, including events.</p>
<p>Android Studio is a graphical IDE for Android java programs.</p>
</div>
</div>
</div>

<div class="phd-slide">
<h2>Getting Started with Android Java</h2>

<p>If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:</p>

<ul>
<li>Make sure your libraries are properly linked</li>
<li>Go from source code to a test application as quickly as possible</li>
<li>Ensure your Phidget is hooked up properly</li>
</ul>
</div>

<div class="phd-slide">
<h2>Use our Examples</h2>

<p>In order to run the examples in Android Studio, start by downloading the the relevant example project for your device:</p>

<p>● <span>[https://www.phidgets.com/?view=code_samples&os=Android Android Java Examples]</span></p>

<div class="phd-lazy-image" data-src="https://www.phidgets.com/decks/PT3_JAVA_ANDROID_AS/-x290/50/as_codesamples.jpg"></div>
</div>

<div class="phd-slide">
<h2>Use our Examples</h2>

<p>Next, open Android Studio on your development machine. Import the project using <b>File->New->Import Project</b></p>

<div class="phd-lazy-image" data-src="https://www.phidgets.com/decks/PT3_JAVA_ANDROID_AS/Android_studio_import.png"></div>
</div>

<div class="phd-slide">
<h2>Use our Examples</h2>

<p>Navigate to your project in the resulting dialog box and click <b>OK</b></p>

<div class="phd-lazy-image" data-src="https://www.phidgets.com/decks/PT3_JAVA_ANDROID_AS/Android_studio_import_dialog.png"></div>
</div>

<div class="phd-slide">
<h2>Use our Examples</h2>

<p>Once the project has been imported, you can simply click the <b>Run</b> button, and the example will compile and run on your chosen device.</p>

<div class="phd-lazy-image" data-src="https://www.phidgets.com/decks/PT3_JAVA_ANDROID_AS/Android_studio_run.png"></div>
</div>

<div class="phd-slide">
<h2>Use our Examples</h2>

<p>You may be prompted to select the Deployment Target. In this case, select your Android device and click OK.</p>

<div class="phd-lazy-image" data-src="https://www.phidgets.com/decks/PT3_JAVA_ANDROID_AS/Android_deployment_target.png"></div>
</div>

<div class="phd-slide">
<h2>Use our Examples</h2>

<div class="phd-panels">
<div class="phd-panel phd-flex-column-align-left phd-flex-column-justify-top">
<div class="phd-lazy-image" data-src="https://www.phidgets.com/decks/PT3_JAVA_ANDROID_AS/-x360/50/Android_screenshot.png"></div>
</div>
<div class="phd-panel phd-flex-column-align-left phd-flex-column-justify-top">
<p>
Once the app is running on your device, if a Phidget corresponding to the example is attached either directly via USB, or to a computer running the Phidget
Network Service on the same local network as the Android device, then device information and settings should appear on the screen.
</p>
<p>In this case, we've run the <b>Hello World</b> example, so a list of available Phidgets is displayed.</p>
<p>When you are ready, the next step is configuring your project and writing your own code!</p>
</div>
</div>
</div>

<div class="phd-slide">
<h2>Use our Examples</h2>

<p>
<b>Note:</b> The examples provided are designed to be incredibly simplistic in order to highlight the base requirements to run Phidgets on Android. To this end,
we opted to open and close the Phidgets in the onCreate and onDestroy handlers of the main activity respectively. This is likely a bad idea for implementing
apps for any practical use, as the activity is prone to being destroyed and re-created for a wide variety of reasons, from closing the app, to rotating the
screen. In order to ensure your Phidget remains attached through these events, we recommend running your Phidgets in a secondary service.
</p>
</div>

<div class="phd-slide">
<h2>Creating A New Project</h2>

<p>
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.
</p>

<p>To start, create a new project in Android Studio:</p>

<div class="phd-lazy-image" data-src="https://www.phidgets.com/decks/PT3_JAVA_ANDROID_AS/New_Android_Studio_Project.png"></div>
</div>

<div class="phd-slide">
<h2>Creating A New Project</h2>

<p>Once you have a new project, be sure to switch the side bar to Project view.</p>

<div class="phd-lazy-image" data-src="https://www.phidgets.com/decks/PT3_JAVA_ANDROID_AS/Android_Studio_Project_View.png"></div>
</div>

<div class="phd-slide">
<h2>Creating A New Project</h2>

<p>
Next, download the Phidget22 <span>[https://www.phidgets.com/downloads/phidget22/libraries/any/Phidget22AndroidJava.zip Android Java libraries]</span>, extract
the contents, and open the resulting folder.
</p>

<div class="phd-lazy-image" data-src="https://www.phidgets.com/decks/PT3_JAVA_ANDROID_AS/Android_Java_Folder.png"></div>
</div>

<div class="phd-slide">
<h2>Creating A New Project</h2>

<p>
Copy the .jar files into the <b>app/libs/</b> 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.
</p>

<p>Right click the jar files you just copied and select <b>Add As Library</b>.</p>

<div class="phd-lazy-image" data-src="https://www.phidgets.com/decks/PT3_JAVA_ANDROID_AS/-x295/50/Add_As_Library.png"></div>
</div>

<div class="phd-slide">
<h2>Creating A New Project</h2>

<p>Create a directory called <b>jnilibs</b> under <b>app/src/main</b></p>

<div class="phd-lazy-image" data-src="https://www.phidgets.com/decks/PT3_JAVA_ANDROID_AS/-x350/50/Android_Create_jnilibs.png"></div>
</div>

<div class="phd-slide">
<h2>Creating A New Project</h2>

<p>Copy the remaining folders from the Phidget22 library (containing versions of libphidget22java.so) into the directory you just created.</p>

<div class="phd-lazy-image" data-src="https://www.phidgets.com/decks/PT3_JAVA_ANDROID_AS/-x320/50/Jnilib_files.png"></div>
</div>

<div class="phd-slide">
<h2>Creating A New Project</h2>

<p>To allow the use of the network and/or USB connections, the following lines must be added to your AndroidManifest.xml file:</p>

<pre data-syntax-language="c">
<uses-permission android:name="android.permission.INTERNET" />


<uses-feature android:name="android.hardware.usb.host" /></pre>

<p>Finally, to import the Phidget22 library into your code, add the following line to the rest of your imports:</p>

<pre data-syntax-language="java">import com.phidget22.*;</pre>

<p>The project now has access to Phidgets. Next, we'll walk through the steps for writing your own code.</p>
</div>

<div class="phd-slide">
<h2>Write Code</h2>

<p>
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.
</p>

<p>Your main reference for writing Android Java code will be:</p>

<p>● The <span>[https://www.phidgets.com/?view=api Phidget22 API]</span></p>

<p>● The <span>[https://www.phidgets.com/?view=code_samples&lang=Java Java example code]</span></p>
</div>

<div class="phd-slide">
<h2>Write Code</h2>

<h3>Step One: Initialize and Open</h3>

<p>You will need to declare your Phidget object in your code. For example, we can declare a digital input object like this:</p>

<pre data-syntax-language="java">DigitalInput device;</pre>

<p>
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:
</p>

<pre data-syntax-language="java">
//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);</pre
>
</div>

<div class="phd-slide">
<h2>Write Code</h2>

<p>
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:
</p>

<pre data-syntax-language="java">
//Add a specific network server to communicate with Phidgets remotely
Net.addServer("ServerName", "192.168.1.105", 5661, "password", 0);</pre
>

<p>After the connection methods are established, the Phidget object needs to be initialized and opened:</p>

<pre data-syntax-language="java">
device = new DigitalInput();
device.open();</pre
>
</div>

<div class="phd-slide">
<h2>Write Code</h2>

<p>
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:
</p>

<pre data-syntax-language="java">
try{
device = new DigitalInput();
device.open();
}catch (PhidgetException e) {
e.printStackTrace();
}</pre
>

<p>For more information on error handling with Phidgets, see <span>[https://www.phidgets.com/docs/Handling_Errors_and_Logging this page]</span>.</p>
</div>

<div class="phd-slide">
<h2>Write Code</h2>

<h3>Step Two: Wait for Attachment (plugging in) of the Phidget</h3>

<p>
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:
</p>

<pre data-syntax-language="java">
ch = new DigitalInput();
ch.open(5000); //wait for attach for 5 seconds, if not time out</pre
>

<p>Waiting for attachment will block indefinitely until a connection is made, or until the timeout value is exceeded.</p>
</div>

<div class="phd-slide">
<h2>Write Code</h2>

<p>To use events, we have to modify our code:</p>

<pre data-syntax-language="java">
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();</pre
>
</div>

<div class="phd-slide">
<h2>Write Code</h2>

<p>
Next, we have to declare the function that will be called when an attach event is fired - in this case the function <b>AttachEventHandler</b> will be called.
</p>

<pre data-syntax-language="java">
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();
}
}
}</pre
>
</div>

<div class="phd-slide">
<h2>Write Code</h2>

<h3>Step Three: Do Things with the Phidget</h3>

<p>
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:
</p>

<pre data-syntax-language="java">
ch = new DigitalInput();
device.addStateChangeListener(new DigitalInputStateChangeListener() {
public void onStateChange(DigitalInputStateChangeEvent stateChangeEvent) {
DigitalInputStateChangeEventHandler handler =
new DigitalInputStateChangeEventHandler(device, stateChangeEvent);
runOnUiThread(handler);
}
});
ch.open();</pre
>

<p>
This code will connect a function and an event. In this case, the <b>DigitalInputStateChangeEventHandler</b> function will be called when there has been a
change to the devices input.
</p>
</div>

<div class="phd-slide">
<h2>Write Code</h2>

<p>Next, we need to create the <b>DigitalInputStateChangeEventHandler</b> function itself:</p>

<pre data-syntax-language="java">
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());
}
}</pre
>

<p>If events do not suit your needs, you can also poll the device directly for data using code like this:</p>

<pre data-syntax-language="java">boolean state = ch.getState();</pre>
</div>

<div class="phd-slide">
<h2>Write Code</h2>

<h3>Step Four: Close and Delete</h3>

<p>At the end of your program, be sure to close your device.</p>

<pre data-syntax-language="java">ch.close();</pre>

<p>Once the device is closed, to completely clean up after using Phidgets, you must uninitialize the USB connection as follows:</p>

<pre data-syntax-language="java">
//Disable USB connection to Phidgets
com.phidget22.usb.Manager.Uninitialize();</pre
>
</div>

<div class="phd-slide">
<h2>What's Next?</h2>

<p>{{Slide_Deck_PT3_Outro}}</p>

<h3>Common Problems, Solutions and Workarounds</h3>

<p>
{{UGC-Entry|My Phidget Detached When I Rotated My Phone||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 [https://developer.android.com/guide/components/services.html#CreatingStartedService Started Service] or a
[https://developer.android.com/guide/components/services.html#Foreground Foreground Service], depending on your application, and open your Phidgets there.}}
</p>
</div>
</div>

<div class="phd-navigation-buttons">
<div class="phd-simple-button phd-to-slide-button" data-navigation-direction="prev">«</div>
<div class="phd-progress-container">
<div class="phd-progress-bar">
<div class="phd-progress-slide-info"></div>
</div>
</div>

<div class="phd-simple-button phd-to-slide-button" data-navigation-direction="next">»</div>
</div>
<div hidden class="phd-hidden-breadcrumb-label" data-label="Android Studio"></div>
</div>

Template:PT3 JAVA ANDROID AS - Revision history

Mparadis at 16:27, 22 April 2025

Patrick at 22:58, 4 January 2024

Mparadis: Created page with " Language - Java ..."

Language - Java

Mparadis: Created page with "

Language - Java

..."