Phidgets Support - User contributions [en]

Reading an I2C Color Sensor

2026-04-13T22:09:26Z

Mparadis: Created page with "<metadesc>A step-by-step example writing code to interface a sensor with the ADP0001.</metadesc> ==Introduction== <center>[https://www.phidgets.com/?prodid=1354 I2C Adapter Phidget (ADP0001_0)] The [https://www.phidgets.com/?prodid=1354 I2C Adapter Phidget] allows you to interface with a wide range of I2C-compatible devices, including sensors, displays, and more...."

<metadesc>A step-by-step example writing code to interface a sensor with the ADP0001.</metadesc>

==Introduction==
[[Image:ADP0001_0_169.jpg|link=https://cdn.phidgets.com/docs/images/f/f5/ADP0001_0_169.jpg|thumb| 450px|<center>[https://www.phidgets.com/?prodid=1354 I2C Adapter Phidget (ADP0001_0)]]]
The [https://www.phidgets.com/?prodid=1354 I2C Adapter Phidget] allows you to interface with a wide range of I2C-compatible devices, including sensors, displays, and more.

In this project, we will use it to read data from an RGB Color Sensor.

===Steps===
To complete this project, we will work through the following steps:
# Determine the device's basic configuration parameters
# Identify the sequence of commands expected by the device
# Connect the device to the I2C Adapter Phidget
# Test the device using the Phidget Control Panel
# Create a custom program.

===Resources===
Information from the following resource will be referenced throughout this project.
* [https://cdn.phidgets.com/docs/images/1/13/TCS34725.pdf TCS34725 RGB Color Sensor IC Datasheet]

==Demonstration==
<center>{{#ev:youtube|dYREkxXgjEA|rel=0}}</center>

==Configuration Parameters==
[[Image:Adp0002_rgb_specs2.png|link=https://cdn.phidgets.com/docs/images/0/05/Adp0002_rgb_specs2.png|thumb|<center>Excerpts from Datasheet</center>]]

During this step, we are looking for the following information:
* Supply Voltage
* Communication Frequency
* Device Address

This information is typically found using the device's product page and/or datasheet. In this case, it was all found on pages 3 to 5 of the datasheet:
* Supply Voltage: 3.3V
* Communication Frequency: 400kHz
* I2C Address: 0x29
<div style="clear:both">

==Command Sequence==
Next, we need to determine the sequence of commands the device is expecting. The TCS34725 datasheet provides a state diagram that we can use to create a list of actions:

[[Image:Adp0002_rgb_states.png|link=https://cdn.phidgets.com/docs/images/0/0e/Adp0002_rgb_states.png|200px|right|thumb|<center>From datasheet (page 7)</center>]]

<br>Based on the state diagram, our list of actions should look like this:

'''Power On Steps''':
# Enable PON (power on) to go from sleep to idle state
# Enable AEN (RGB enabled) to go from idle to RGBC state

After these steps, the device should be able to provide data and respond to commands. We're not using WEN (wait enabled) since we don't need this power-saving feature at this time.

===Writing to TCS34725 Registers===
I2C devices typically expect the following format:

[[Image:Adp0002_an_typicalcomms3.png|link=https://cdn.phidgets.com/docs/images/2/29/Adp0002_an_typicalcomms3.png|600px]]

This protocol diagram from page 12 of the datasheet confirms that the TCS34725 behaves as expected:

[[Image:Adp0002_rgb_protocol.png|link=https://cdn.phidgets.com/docs/images/3/38/Adp0002_rgb_protocol.png|700px]]

The Start (S), Stop (P), Acknowledge (A), and W/R (Write/Read) is all handled internally by the I2C Phidget, so we just need to focus on the command code and data.

==== Command Register ====

The command register lets us tell the sensor which register we want to read or write on our next communication.

[[Image:Adp0002_rgb_cmdreg.png|link=https://cdn.phidgets.com/docs/images/0/0d/Adp0002_rgb_cmdreg.png|750px|center]]

* The first bit is always '1'
* The next two bits control the how the device behaves when requesting multiple bytes
* The last five bits hold the register address (we can ignore the special functions for this project)

Here's an abridged list of registers we'll be using:

[[Image:Adp0002_rgb_registers.png|link=https://cdn.phidgets.com/docs/images/4/48/Adp0002_rgb_registers.png|600px|center]]

===Power On Steps===
====Enable the Sensor====
Enable is managed by register '''0x00''', so our command register will look like this:

[[Image:Adp0002_rgb_cmdenable.png|link=https://cdn.phidgets.com/docs/images/0/03/Adp0002_rgb_cmdenable.png|center|850px]]

So we'll send '''0x80''' to select the enable register.

The enable register is defined in the datasheet as follows:

[[Image:Adp0002_rgb_enablereg.png|link=https://cdn.phidgets.com/docs/images/8/89/Adp0002_rgb_enablereg.png|center|850px]]

* Bits 5, 6, and 7 are '''000''', as they're reserved
* Bit 4 will be '''0''', since we're not using interrupts
* Bit 3 will be '''0''', since we're not using the wait feature
* Bit 2 is '''0''', as it's reserved
* Bit 1 will be '''0''', since we're not enabling RGBC yet
* Bit 0 will be '''1''', to enable power

That gives us '''0x01'''. Together with our command register, our first communication will be '''0x8001'''.
The reason we don't enable RGBC yet is because the device requires a 2.4ms delay between PON and RGBC for reliable startup.

====Enable RGBC====

To enable RGBC we will use the same command we used for power on, but both the AEN bit and the PON bit will be 1. This gives us '''0x8003'''.

=== Reading Data ===

Now that the sensor is initialized, we can start getting data from it. We want to read all eight color registers, so we need to set auto-increment in the command register and point it to the first color register which is at 0x14:

[[Image:Adp0002_rgb_cmdreadauto.png|link=https://cdn.phidgets.com/docs/images/8/87/Adp0002_rgb_cmdreadauto.png|center|850px]]

This means we need to send '''B4'''. After that, we can listen for 8 bytes at a time to get all of our color data.

== Connecting to the ADP0001 ==

The pinout for this sensor is printed on the PCB:

[[Image:I2C_rgb_pinout2.png|link=|130px|left]]

*'''VIN''' - Power
*'''GND''' - Ground
*'''3V3''' - 3.3V Output
*'''SCL''' - Serial Clock
*'''SDA''' - Serial Data
*'''INT''' - Interrupt
*'''LED''' - LED toggle

We don't need the 3.3V output or the interrupt pin for this project. The other pins can be connected to the ADP0001 as follows:

[[Image:I2C_rgb_connection.png|800px|link=https://cdn.phidgets.com/docs/images/d/d9/I2C_rgb_connection.png]]

The LED toggle pin is connected to one of the ADP0001's GPIO pins so we can use it to turn off the LED when not in use.

==Testing in the Phidget Control Panel==
Now that we have the command sequence and our sensor connected, we can use the Phidget Control Panel to confirm our device is working as expected.

===Power On Steps===
We can set the voltage to 3.3V, the frequency to 400kHz, and the address to 0x29.

[[Image:I2C_RGB_ControlPanel.png|link=https://cdn.phidgets.com/docs/images/2/20/I2C_RGB_ControlPanel.png|center]]

Now we can enable the sensor with our command sequence:
* 0x8001 (Power on)
* 0x8003 (RGBC on)
* 0xB4 (auto increment and start from register 0x14)

[[Image:I2C_RGB_ControlPanel2.png|link=https://cdn.phidgets.com/docs/images/4/4f/I2C_RGB_ControlPanel2.png|center]]

===Reading Data===
After sending the command register B4, we can read all color registers by reading 8 bytes at a time.

[[Image:I2C_RGB_ControlPanel3.png|link=https://cdn.phidgets.com/docs/images/0/0a/I2C_RGB_ControlPanel3.png|center]]
[[Image:I2C_RGB_responsegraph.png|link=https://wwwdev.int.phidgets.com/docs/images/9/97/I2C_RGB_responsegraph.png|thumb|<center>Sensor response characteristic (pg.6)<center>]]

This sensor ultimately provides us with four 16-bit values: Clear, Red, Green, and Blue. The clear light value is important for providing brightness calibration. Since the responses of the red, green and blue sensors are normalized to match the response of the clear sensor, we can use it as a baseline to determine color in both bright and dim environments.

In the above image, we get roughly the same value when polling the sensor three times, so the value seems stable. We'll use the bottom row to see if the color makes sense. The data bytes received are sent in register order, so our values are:

* Clear: 0x0FFD
* Red: 0x0A96
* Green: 0x0331
* Blue: 0x0271

Converting to decimal, that's 4093, 2710, 817, 625. We can normalize the last three values using the clear value, and then multiply by 255 and round to get a standard RGB value:

* Red: (2710/4093)*255 = 169
* Green: (817/4093)*255 = 51
* Blue: (625/4093)*255 = 39

This RGB value '''<span style="color:#A93327">(#A93327)</span>''' looks to be correct, as the sensor was pointed at a roll of red electrical tape.

==Writing a Custom Program==
To begin writing a custom program for your Phidget device, navigate to the product page and select the [https://www.phidgets.com/?prodid=1354#Tab_Code_Samples Code Samples tab]. From there, you can customize the code for your own purposes. Here we have modified the Python code sample to match our steps from the Phidget Control Panel.

<syntaxhighlight lang=python>
from Phidget22.Phidget import *
from Phidget22.Devices.DataAdapter import *
import time

def convert_rgbc(data):

c = data[1] << 8 | data[0]

if(c <= 0):
return [0,0,0]

# Combine high and low bytes for each color,
# Then normalize and cap at 255
r = min(255,round((data[3] << 8 | data[2]) / c * 255))
g = min(255,round((data[5] << 8 | data[4]) / c * 255))
b = min(255,round((data[7] << 8 | data[6]) / c * 255))
return [r,g,b]

def main():

adp = DataAdapter()
adp.openWaitForAttachment(5000)

# Set properties
adp.setFrequency(DataAdapterFrequency.FREQUENCY_400kHz)
adp.setDataAdapterVoltage(DataAdapterVoltage.DATAADAPTER_VOLTAGE_3_3V)
addr = 0x29

# Power On
adp.i2cSendReceive(addr, [0x8001], 0)
time.sleep(0.01)

# RGBC On
adp.i2cSendReceive(addr, [0x8003], 0)

# Auto-increment starting with CDATAL
adp.i2cSendReceive(addr, [0xB4], 0)

try:
while True:
rgb = convert_rgbc(adp.i2cSendReceive(addr, [], 8))
print("R: " + str(rgb[0]) + " G: " + str(rgb[1]) + " B: " + str(rgb[2]))
time.sleep(0.5)
pass
except KeyboardInterrupt:
print("Closing...")

adp.close()

main()
</syntaxhighlight>

That’s about it, we went from reading the datasheet to a working script. Not all datasheets are created equal, so if you’re struggling with getting your sensor set up, feel free to ask for help by [https://www.phidgets.com/?view=contact sending us an email].

===Python Graphical Example===
Here is a more in-depth script that displays a graph of the raw values and shows the calculated color after gamma and saturation adjustment.

{{UGC-Start}}
{{UGC-Entry|Full Script (Click to expand)||
<syntaxhighlight lang=python>
import tkinter as tk
import math
from Phidget22.Phidget import *
from Phidget22.Devices.DataAdapter import *
import time

class MultiLineGraph(tk.Canvas):
def __init__(self, parent, lines=4, max_points=100, **kwargs):
super().__init__(parent, bg="black", **kwargs)
self.lines = lines
self.max_points = max_points
self.data = [[] for _ in range(lines)]
self.colors = ["white", "red", "green", "blue"]

def add_points(self, *values):
for i, v in enumerate(values):
self.data[i].append(v)
if len(self.data[i]) > self.max_points:
self.data[i].pop(0)
self.draw()

def draw(self):
self.delete("all")
w = self.winfo_width()
h = self.winfo_height()

if w < 10 or h < 10:
return

# Flatten all visible data
all_values = [v for line in self.data for v in line]

if not all_values:
return

min_val = min(all_values)
max_val = max(all_values)

# Prevent divide-by-zero
if max_val == min_val:
max_val += 1

padding = (max_val - min_val) * 0.1 # 10% padding
min_val -= padding
max_val += padding

for i, line in enumerate(self.data):
if len(line) < 2:
continue

points = []
for j, val in enumerate(line):
x = j / (self.max_points - 1) * w

# Normalize to 0–1
norm = (val - min_val) / (max_val - min_val)

# Flip Y (Tkinter origin is top-left)
y = h - (norm * h)

points.extend([x, y])

self.create_line(points, fill=self.colors[i], width=2)

class App:
def __init__(self, root):
self.root = root
self.root.title("I2C RGB Viewer")
self.adp = DataAdapter()
self.addr = 0x29
self.sat = 1.8
self.gamma = 1.3

# --- Define Gamma Table ---
self.gamma_table = [0] * 256
for i in range(256):
self.gamma_table[i] = int(math.pow(i/255.0,self.gamma)*255)

# --- UI ---
self.graph = MultiLineGraph(root, height=300)
self.graph.pack(fill="both", expand=True)

self.rgb_entry = tk.Entry(root, font=("Consolas", 14))
self.rgb_entry.pack(fill="x")

self.color_panel = tk.Frame(root, height=50, bg="black")
self.color_panel.pack(fill="x")

self.adp.openWaitForAttachment(5000)

# Set properties
self.adp.setFrequency(DataAdapterFrequency.FREQUENCY_400kHz)
self.adp.setDataAdapterVoltage(DataAdapterVoltage.DATAADAPTER_VOLTAGE_3_3V)

# Power On
self.adp.i2cSendReceive(self.addr, [0x8001], 0)
time.sleep(0.01)

# RGBC On
self.adp.i2cSendReceive(self.addr, [0x8003], 0)

# Auto-increment starting with CDATAL
self.adp.i2cSendReceive(self.addr, [0xB4], 0)

# --- Timer ---
self.update_loop()

def read_sensor(self):

data = self.adp.i2cSendReceive(self.addr, [], 8)

# Combine high and low bytes for clear register
raw_c = data[1] << 8 | data[0]

if(raw_c <= 0):
return [0,0,0,0]

# Combine high and low bytes for each colour
raw_r = data[3] << 8 | data[2]
raw_g = data[5] << 8 | data[4]
raw_b = data[7] << 8 | data[6]

return raw_c, raw_r, raw_g, raw_b

def update_loop(self):
raw_c, raw_r, raw_g, raw_b = self.read_sensor()

if raw_c > 0:
# Normalize + gamma
norm_r = self.gamma_table[int(raw_r / raw_c * 255)]
norm_g = self.gamma_table[int(raw_g / raw_c * 255)]
norm_b = self.gamma_table[int(raw_b / raw_c * 255)]

avg = (norm_r + norm_g + norm_b) / 3

# Saturation adjust
norm_r = max(0, min(255, avg + (norm_r - avg) * self.sat))
norm_g = max(0, min(255, avg + (norm_g - avg) * self.sat))
norm_b = max(0, min(255, avg + (norm_b - avg) * self.sat))

hex_color = "#{:02X}{:02X}{:02X}".format(
int(norm_r), int(norm_g), int(norm_b)
)

self.rgb_entry.delete(0, tk.END)
self.rgb_entry.insert(0, hex_color)

self.color_panel.config(bg=hex_color)

# Update graph
self.graph.add_points(raw_c, raw_r, raw_g, raw_b)

# Repeat every 50 ms
self.root.after(50, self.update_loop)

if __name__ == "__main__":
root = tk.Tk()
app = App(root)
root.geometry("600x400")
root.mainloop()
</syntaxhighlight>
}}
{{UGC-End}}

File:TCS34725.pdf

2026-04-13T22:09:02Z

Mparadis:

File:I2C RGB responsegraph.png

2026-04-13T22:03:48Z

Mparadis:

File:I2C RGB ControlPanel3.png

2026-04-13T22:03:36Z

Mparadis:

File:I2C RGB ControlPanel2.png

2026-04-13T22:03:28Z

Mparadis:

File:I2C RGB ControlPanel.png

2026-04-13T22:03:14Z

Mparadis:

File:I2C rgb connection.png

2026-04-13T22:02:15Z

Mparadis:

File:I2C rgb pinout2.png

2026-04-13T22:02:04Z

Mparadis:

File:Adp0002 rgb cmdreadauto.png

2026-04-13T22:01:42Z

Mparadis:

File:Adp0002 rgb enablereg.png

2026-04-13T22:01:22Z

Mparadis:

File:Adp0002 rgb cmdenable.png

2026-04-13T22:00:59Z

Mparadis:

File:Adp0002 rgb registers.png

2026-04-13T22:00:35Z

Mparadis:

File:Adp0002 rgb cmdreg.png

2026-04-13T22:00:21Z

Mparadis:

File:Adp0002 rgb protocol.png

2026-04-13T21:59:53Z

Mparadis:

File:Adp0002 rgb states.png

2026-04-13T21:59:38Z

Mparadis:

File:Adp0002 rgb specs2.png

2026-04-13T21:59:22Z

Mparadis:

I2C Adapter API Guide

2026-04-09T18:16:26Z

Mparadis: Created page with "{{#seo:|description=Get started with your I2C Adapter Phidget}} Category:IntroGuide <div class="nonumtoc"> <div class="toclimit-4"> == Introduction == This guide will provide additional details for the DataAdapter API so you can better understand what your I2C Adapter Phidget is doing when communicating with an I2C device. == Address Format == The I2C Adapter Phidget interprets the device address as follows: 550px The read/write bit i..."

{{#seo:|description=Get started with your I2C Adapter Phidget}}
[[Category:IntroGuide]]
<div class="nonumtoc">
<div class="toclimit-4">
== Introduction ==
This guide will provide additional details for the DataAdapter API so you can better understand what your I2C Adapter Phidget is doing when communicating with an I2C device.

== Address Format ==

The I2C Adapter Phidget interprets the device address as follows:

[[Image:I2C_Addr.png|link=|550px]]

The read/write bit is not included in the hexadecimal value for the address, as this bit is handled by the API calls.
You may find that datasheets for some I2C devices include the read/write bit, so a read-only device like a simple temperature sensor might specify the address as '''0xE3''' instead of '''0x71''' in this case. When using such a sensor, be sure to ignore the R/W bit and shift the remaining seven bits down to get the address you need to send to Phidgets API calls.

== Methods ==
=== I2CSendReceive() ===

Parameters:
* int '''address'''
* byte[ ] '''data'''
* int '''receiveLength'''

This is the main function you'll use for simple read and write operations.

* The first parameter is the I2C address of your device, usually specified in the datasheet or printed on the circuit board.
* The second parameter is the data array, which can contain up to 127 bytes. If the data array is empty, the I2C Adapter Phidget will skip sending the write address and bytes.
* The third parameter is the receive length, or the number of bytes you're expecting back from the device for this transaction. Maximum receive length is 127, and if it's zero the I2C Adapter Phidget will skip sending the read address and bytes.

This diagram illustrates the data structure when using {{Code|I2CSendReceive}}:

[[Image:I2C_SendRecv.png|link=|850px]]

''''S'''' represents a start condition, while ''''P'''' represents a stop condition. If your I2C device requires data in a different structure than this, you may need to use {{Code|I2CComplexTransaction()}}, as explained in the next section.

=== I2CComplexTransaction() ===

Parameters:
* int '''address'''
* string '''I2CPacketString'''
* byte[ ] '''data'''

This function gives you more control over the read/write structure for more complex interactions. This is useful for longer commands that make use of repeated start conditions.

* The first parameter is the I2C address of your device, usually specified in the datasheet or printed on the circuit board.
* The second parameter is a string that dictates the read/write sequence to follow.
* The third parameter is the data array, whose length must match the number of writes in the string, up to 127 bytes.

The string is made up of the following characters, case-sensitive with no spaces:
* ''''s'''' for a start condition
* ''''R'''' for a read byte
* ''''T'''' for a write byte
* ''''p'''' for a stop condition

Here's an example:

[[Image:I2C_Complex.png|link=|850px]]

Numerals can also be used after a 'T' or 'R' to make the string compact. In this example, the data array would need to have a length of 3, since a total of three bytes are written in the sequence.

File:I2C Complex.png

2026-04-09T18:16:19Z

Mparadis:

File:I2C SendRecv.png

2026-04-09T18:16:09Z

Mparadis:

File:I2C Addr.png

2026-04-09T18:15:58Z

Mparadis:

Rotary Motion Guide

2026-04-08T20:25:37Z

Mparadis: /* Chain/Sprockets */

{{#seo:|description=Rotary systems involve rotating mechanical parts such as motors, sprockets, and pulleys. Learn the basics about rotary motion here.}}
{{#seo:|keywords=mechanical}}
[[Category:IntroGuide]]
==Introduction==
In rotary systems, you have a rotating shaft which applies torque to do work. Typically this shaft is turned by an electric motor of some kind and then, through a series of belts/chains/couplers transmits that power to a final output shaft or arm or wheel which accomplishes the desired task. Why not just use the output shaft of the motor directly? There are two main reasons:

*You might want to gear the motor down further to increase the torque available by using pulleys or sprockets of differing sizes.
*The shaft on the motor itself isn't really designed for forces other than torque. It is difficult to put anything of significant size on the shaft without putting too much overhung (radial) load on the shaft which will stall the motor.

As a result, the base of any rotary system is the rotating shaft. We have 4 sizes of shaft available: 8mm, 12mm, 17mm, and 25mm. The 12, 17, and 25mm shafts also have a variant available with a keyway machined in the length of the shaft if you don't want to machine it yourself. These shafts need to be suspended on bearings, we do not sell any bearings currently but they are commonly available components that you can find locally. For the larger shaft sizes (17 and 25mm) we recommend using steel bearing housings.

==Motors==
Every system will need a motor or else there will be no motion (without external input). We offer a wide selection of motors of a number of different types that would all be suitable for rotary systems. For more information on this you can check out our guides for [[DC Motor and Controller Guide|DC motors]] and [[Stepper Motor and Controller Guide|Stepper motors]].

==Pulleys/Timing belts==
A belt is simply a loop of tough, flexible material such as rubber and kevlar with a series of teeth that mesh with the teeth on specially designed pulley wheels to synchronize two (or more) rotating shafts. Belts are a cheap option for shafts that are not axially aligned and tend to run quietly and smoothly. Belts are typically tensioned either by adjusting center to center distance between pulleys or via a tensioner/idler pulley. This leads to very low backlash and a high efficiency (as high as 98%).

We have two types of belts available, GT2 (6mm wide) and GT5 (15mm wide). Each comes in loops of varying circumferences. The GT2 belts are rated for 6lbs of working tension while the GT5 are rated for 100lbs. Belt systems are fairly simple, you have 2 or more pulleys and a belt that goes around all of them. One of the pulleys is driven by your motor and the other(s) are either connected to your load or in the case of an idler pulley are simply free spinning to act as a tensioner for the belt. For example, here is a system that uses a belt to transmit power form a stepper motor to a ball screw:

[[image:Belt driven ball screw.JPG|500px|center|link=]]

==Chain/Sprockets==
Pretty much everyone has at least seen a chain system in their life in the form of a bicycle. This system of course is driven by human input rather than a motor. Automated systems behave no differently though, you have several sprockets, and chain that wraps around them. One sprocket is driven and the others perform work on the load. Chain tends to be noisier than belts and cannot be tensioned as tightly meaning there is a bit more backlash inherent in the system. In exchange though, chain can move much heavier loads for their size.

We sell ANSI#25 and #40 chain and sprockets (that is 0.25" pitch and 0.5" pitch). The #25 is rated for 100lbs of working tension while the #40 is rated for 800lbs. Chain is sold by the meter and you can form closed loops of any length you'd like with the link kits that we sell.

There are two ways to connect chain, you can either use a hammer and a pin of some kind to knock out one of the pins which you can then connect up with an offset link:

The other way is if you have a chain breaker tool you can remove an entire link properly and can use a normal split link. This process is a bit more tricky but it is stronger over all and will increase the length of the chain by a standard amount unlike the offset link which adds a sort of half link to your total length. To use a split link you must remove the snap ring and the top plate, then slot it into the chain and replace them both. For example:
[[image:Chain_link_insert_wiki.png|link=|center|800px]]

A good example of a chain system is our MURVV robot. Here is how it's drive mechanism works:
[[Image:Murvv_chain.jpg|link=|center|500px]]

==Worm Gearboxes==
In general, worm gearboxes are just another type of gearbox that can be fitted to a motor. The main benefit of a worm drive is that it is all but impossible to back drive even when not powered. This is due to the steep angle used by the gears as they mesh together. As a result, this type of gearbox is not the most efficient. There is a lot of frictional loss at the mesh point and they will tend to run hot. That being said, in the context of the worm drives we sell, they are a means to substantially increase the output torque of our larger motors for applications where maximum strength is required. All our worm gearboxes have a 30:1 gear ratio and since the bearings built into the gearbox can handle much higher axial and radial loads that motors themselves you can easily direct drive very large loads from these gearboxes without having to set up an external mechanism.

==Bearings==
For the smaller bearings, installation is fairly straight forward. Simply mount the bearing onto your surface, slot the shaft in and tighten the set screws. However, for our larger bearings (12mm, 17mm and 25mm) there is a different system used known as an eccentric locking collar or eccentric collar lock. This is relatively simply to set up but you may not have seen this style of attachment before so lets have a look quickly at how it works and how to install it.

The locking mechanism works by putting a slightly eccentric hole in the bearing and using a collar with a matching hole. This way, when the collar is twisted on the shaft it will bind. Step by step:
[[image:empty_bearing.jpg|center|500px|link=]]

Notice how the wall of the bore is thinner on the right side than the left. This is also true of the collar which slides over the top of the shaft once it is in position. Insert the shaft in the bearing unit to the desired position:

[[image:uncollared_shaft.jpg|center|500px|link=]]

Next, put the collar onto the shaft and slide it down to the bearing. Turn the collar slowly until it seats on the lip of the bearing (i.e. the eccentricity of the holes lines up). Now you will want to tighten the collar by hand by turning it like you would a threaded cap. You will notice that it will bind by turning it in either direction within 180°. Be sure to turn the collar in the same direction the primary direction of rotation for the shaft in operation will be. Once the collar is tight, you will need to use a punch and a hammer to tighten it the last bit. Find the dead hole in the collar (not the set screw) and insert your punch. Angle the punch against the wall of the direction you have tightened the collar and give it a few solid taps with the hammer:

[[image:punch_collar.jpg|center|500px|link=]]

Now just tighten the set screw to ensure it doesn't loosen up with use and you are finished. To quickly demonstrate here is a video, note that I do not tighten the set screw in this video but that is straight forward enough so it was left out:

<center>
{{#ev:youtube|0v6NOY7aRbg|||||rel=0}}
</center>

Language - Java

2026-04-02T19:01:02Z

Mparadis: /* PhidgetSBC Web Interface */

{{#seo:|description=Learn how to use Phidget USB devices with Java.}}
[[Category:Language]]

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

==Java Libraries==
During development, we recommend downloading the appropriate installer or package for your [https://www.phidgets.com/docs/Operating_System_Support operating system]. This will place the required Phidget library files in standard locations where Java will look for them. When [[#Deploying Applications|deploying applications]], you can instead include these files manually as part of your application.

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

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

[[Image:Javascript_networkserver_webusb_spec.png|center|600px|link=https://cdn.phidgets.com/docs/images/8/80/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 [{{SERVER}}/docs/OS_-_Linux#Setting_Udev_Rules set up udev rules] on your system.

==Development Environment Configuration==

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

===Visual Studio Code===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''Instructions'''
| 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]]
|-
| 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]]
|-
| 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]]
|-
| 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].
|-
| 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.
|-
| 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]]
|-
| 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]]
|-
| 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===
{| 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]]
|-
|[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
</syntaxhighlight>
Then, enter the following command to run the program:
<syntaxhighlight>
java -classpath .;phidget22.jar example
</syntaxhighlight>
||
|-
| 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
Main-Class: example
Class-Path: phidget22.jar

</syntaxhighlight>
Make sure there's an empty newline at the bottom of the three lines and a space after each colon.
|-
| colspan="2"| Next, create the .jar file with this command:
<syntaxhighlight>
jar cfm example.jar manifest.mf *.class
</syntaxhighlight>
Once the .jar is created, you can execute it with
<syntaxhighlight>
java -jar example.jar
</syntaxhighlight>

|}

===Netbeans===
{| 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]]
|-
|[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>
|}

===Eclipse===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''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]]
|-
| 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]]
|-
| 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]]
|-
| 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]]
|-
| 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]]
|-
| 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:
<syntaxhighlight>
java -jar phidgetTest.jar
</syntaxhighlight>
|}

=== PhidgetSBC Web Interface ===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+'''Instructions'''
|<center>{{#ev:youtube|gZmWvWXICIA|rel=0}}</center>
'''Note:''' Debian Linux may not have support for the newest JDK by default, so if you're developing your code on another machine, you may have to target an older version of Java in order to run it on the PhidgetSBC.
|}

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

[[Image:Language_java_codesample.png|center|600px|link=https://cdn.phidgets.com/docs/images/a/af/Language_java_codesample.png]]

===Phidget Programming Basics===
{{PhidgetProgrammingBasicsLink}}

== Deploying Applications ==
The following files are required for your Java application:
* phidget22.jar
* phidget22.dll
* phidget22java.dll

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

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

==API==
[{{SERVER}}/?view=api&lang=Python Phidget22 API]

Language - Java

2026-04-01T20:05:59Z

Mparadis: /* Deploying Applications */

{{#seo:|description=Learn how to use Phidget USB devices with Java.}}
[[Category:Language]]

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

==Java Libraries==

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.

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

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

[[Image:Javascript_networkserver_webusb_spec.png|center|600px|link=https://cdn.phidgets.com/docs/images/8/80/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 [{{SERVER}}/docs/OS_-_Linux#Setting_Udev_Rules set up udev rules] on your system.

==Development Environment Configuration==

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

===Visual Studio Code===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''Instructions'''
| 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]]
|-
| 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]]
|-
| 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]]
|-
| 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].
|-
| 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.
|-
| 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]]
|-
| 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]]
|-
| 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===
{| 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]]
|-
|[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
</syntaxhighlight>
Then, enter the following command to run the program:
<syntaxhighlight>
java -classpath .;phidget22.jar example
</syntaxhighlight>
||
|-
| 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
Main-Class: example
Class-Path: phidget22.jar

</syntaxhighlight>
Make sure there's an empty newline at the bottom of the three lines and a space after each colon.
|-
| colspan="2"| Next, create the .jar file with this command:
<syntaxhighlight>
jar cfm example.jar manifest.mf *.class
</syntaxhighlight>
Once the .jar is created, you can execute it with
<syntaxhighlight>
java -jar example.jar
</syntaxhighlight>

|}

===Netbeans===
{| 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]]
|-
|[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>
|}

===Eclipse===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''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]]
|-
| 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]]
|-
| 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]]
|-
| 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]]
|-
| 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]]
|-
| 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:
<syntaxhighlight>
java -jar phidgetTest.jar
</syntaxhighlight>
|}

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

[[Image:Language_java_codesample.png|center|600px|link=https://cdn.phidgets.com/docs/images/a/af/Language_java_codesample.png]]

===Phidget Programming Basics===
{{PhidgetProgrammingBasicsLink}}

==API==
[{{SERVER}}/?view=api&lang=Python 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 [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.

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

Language - Java

2026-04-01T20:02:15Z

Mparadis: /* Eclipse */

{{#seo:|description=Learn how to use Phidget USB devices with Java.}}
[[Category:Language]]

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

==Java Libraries==

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.

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

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

[[Image:Javascript_networkserver_webusb_spec.png|center|600px|link=https://cdn.phidgets.com/docs/images/8/80/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 [{{SERVER}}/docs/OS_-_Linux#Setting_Udev_Rules set up udev rules] on your system.

==Development Environment Configuration==

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

===Visual Studio Code===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''Instructions'''
| 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]]
|-
| 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]]
|-
| 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]]
|-
| 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].
|-
| 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.
|-
| 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]]
|-
| 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]]
|-
| 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===
{| 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]]
|-
|[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
</syntaxhighlight>
Then, enter the following command to run the program:
<syntaxhighlight>
java -classpath .;phidget22.jar example
</syntaxhighlight>
||
|-
| 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
Main-Class: example
Class-Path: phidget22.jar

</syntaxhighlight>
Make sure there's an empty newline at the bottom of the three lines and a space after each colon.
|-
| colspan="2"| Next, create the .jar file with this command:
<syntaxhighlight>
jar cfm example.jar manifest.mf *.class
</syntaxhighlight>
Once the .jar is created, you can execute it with
<syntaxhighlight>
java -jar example.jar
</syntaxhighlight>

|}

===Netbeans===
{| 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]]
|-
|[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>
|}

===Eclipse===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''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]]
|-
| 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]]
|-
| 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]]
|-
| 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]]
|-
| 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]]
|-
| 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:
<syntaxhighlight>
java -jar phidgetTest.jar
</syntaxhighlight>
|}

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

[[Image:Language_java_codesample.png|center|600px|link=https://cdn.phidgets.com/docs/images/a/af/Language_java_codesample.png]]

===Phidget Programming Basics===
{{PhidgetProgrammingBasicsLink}}

==API==
[{{SERVER}}/?view=api&lang=Python 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 gathered from the installation directory on a computer that has our drivers installed (e.g. C:/Program Files/Phidgets/Phidget22). Java will look for these files in several locations, including the classpath and the working folder of the project.

Language - Java

2026-04-01T19:59:46Z

Mparadis: /* Java Libraries */

{{#seo:|description=Learn how to use Phidget USB devices with Java.}}
[[Category:Language]]

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

==Java Libraries==

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.

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

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

[[Image:Javascript_networkserver_webusb_spec.png|center|600px|link=https://cdn.phidgets.com/docs/images/8/80/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 [{{SERVER}}/docs/OS_-_Linux#Setting_Udev_Rules set up udev rules] on your system.

==Development Environment Configuration==

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

===Visual Studio Code===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''Instructions'''
| 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]]
|-
| 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]]
|-
| 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]]
|-
| 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].
|-
| 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.
|-
| 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]]
|-
| 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]]
|-
| 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===
{| 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]]
|-
|[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
</syntaxhighlight>
Then, enter the following command to run the program:
<syntaxhighlight>
java -classpath .;phidget22.jar example
</syntaxhighlight>
||
|-
| 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
Main-Class: example
Class-Path: phidget22.jar

</syntaxhighlight>
Make sure there's an empty newline at the bottom of the three lines and a space after each colon.
|-
| colspan="2"| Next, create the .jar file with this command:
<syntaxhighlight>
jar cfm example.jar manifest.mf *.class
</syntaxhighlight>
Once the .jar is created, you can execute it with
<syntaxhighlight>
java -jar example.jar
</syntaxhighlight>

|}

===Netbeans===
{| 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]]
|-
|[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>
|}

===Eclipse===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''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]]
|-
| 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. || [[Image:java_eclipse_library.png|center|350px|link=https://cdn.phidgets.com/docs/images/1/1b/Java_eclipse_library.png]]
|-
| 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]]
|-
| 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]]
|-
| 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]]
|-
| 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:
<syntaxhighlight>
java -jar phidgetTest.jar
</syntaxhighlight>
|}

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

[[Image:Language_java_codesample.png|center|600px|link=https://cdn.phidgets.com/docs/images/a/af/Language_java_codesample.png]]

===Phidget Programming Basics===
{{PhidgetProgrammingBasicsLink}}

==API==
[{{SERVER}}/?view=api&lang=Python 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 gathered from the installation directory on a computer that has our drivers installed (e.g. C:/Program Files/Phidgets/Phidget22). Java will look for these files in several locations, including the classpath and the working folder of the project.

Language - Java

2026-04-01T19:48:59Z

Mparadis: /* Netbeans */

{{#seo:|description=Learn how to use Phidget USB devices with Java.}}
[[Category:Language]]

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

==Java Libraries==

You must install the [https://www.phidgets.com/docs/Operating_System_Support Phidget drivers] for your operating system to be able to compile and run Java programs.

Your Java project will also require our Java library file:
* [https://www.phidgets.com/downloads/phidget22/libraries/any/Phidget22Java.zip phidget22.jar].

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

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

[[Image:Javascript_networkserver_webusb_spec.png|center|600px|link=https://cdn.phidgets.com/docs/images/8/80/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 [{{SERVER}}/docs/OS_-_Linux#Setting_Udev_Rules set up udev rules] on your system.

==Development Environment Configuration==

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

===Visual Studio Code===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''Instructions'''
| 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]]
|-
| 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]]
|-
| 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]]
|-
| 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].
|-
| 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.
|-
| 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]]
|-
| 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]]
|-
| 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===
{| 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]]
|-
|[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
</syntaxhighlight>
Then, enter the following command to run the program:
<syntaxhighlight>
java -classpath .;phidget22.jar example
</syntaxhighlight>
||
|-
| 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
Main-Class: example
Class-Path: phidget22.jar

</syntaxhighlight>
Make sure there's an empty newline at the bottom of the three lines and a space after each colon.
|-
| colspan="2"| Next, create the .jar file with this command:
<syntaxhighlight>
jar cfm example.jar manifest.mf *.class
</syntaxhighlight>
Once the .jar is created, you can execute it with
<syntaxhighlight>
java -jar example.jar
</syntaxhighlight>

|}

===Netbeans===
{| 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]]
|-
|[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>
|}

===Eclipse===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''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]]
|-
| 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. || [[Image:java_eclipse_library.png|center|350px|link=https://cdn.phidgets.com/docs/images/1/1b/Java_eclipse_library.png]]
|-
| 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]]
|-
| 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]]
|-
| 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]]
|-
| 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:
<syntaxhighlight>
java -jar phidgetTest.jar
</syntaxhighlight>
|}

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

[[Image:Language_java_codesample.png|center|600px|link=https://cdn.phidgets.com/docs/images/a/af/Language_java_codesample.png]]

===Phidget Programming Basics===
{{PhidgetProgrammingBasicsLink}}

==API==
[{{SERVER}}/?view=api&lang=Python 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 gathered from the installation directory on a computer that has our drivers installed (e.g. C:/Program Files/Phidgets/Phidget22). Java will look for these files in several locations, including the classpath and the working folder of the project.

File:Windows netbeans4.png

2026-04-01T19:48:37Z

Mparadis:

Language - Java

2026-04-01T19:34:01Z

Mparadis: /* Eclipse */

{{#seo:|description=Learn how to use Phidget USB devices with Java.}}
[[Category:Language]]

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

==Java Libraries==

You must install the [https://www.phidgets.com/docs/Operating_System_Support Phidget drivers] for your operating system to be able to compile and run Java programs.

Your Java project will also require our Java library file:
* [https://www.phidgets.com/downloads/phidget22/libraries/any/Phidget22Java.zip phidget22.jar].

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

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

[[Image:Javascript_networkserver_webusb_spec.png|center|600px|link=https://cdn.phidgets.com/docs/images/8/80/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 [{{SERVER}}/docs/OS_-_Linux#Setting_Udev_Rules set up udev rules] on your system.

==Development Environment Configuration==

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

===Visual Studio Code===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''Instructions'''
| 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]]
|-
| 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]]
|-
| 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]]
|-
| 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].
|-
| 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.
|-
| 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]]
|-
| 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]]
|-
| 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===
{| 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]]
|-
|[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
</syntaxhighlight>
Then, enter the following command to run the program:
<syntaxhighlight>
java -classpath .;phidget22.jar example
</syntaxhighlight>
||
|-
| 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
Main-Class: example
Class-Path: phidget22.jar

</syntaxhighlight>
Make sure there's an empty newline at the bottom of the three lines and a space after each colon.
|-
| colspan="2"| Next, create the .jar file with this command:
<syntaxhighlight>
jar cfm example.jar manifest.mf *.class
</syntaxhighlight>
Once the .jar is created, you can execute it with
<syntaxhighlight>
java -jar example.jar
</syntaxhighlight>

|}

===Netbeans===
{| 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]]
|-
|[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. ||
|}

===Eclipse===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''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]]
|-
| 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. || [[Image:java_eclipse_library.png|center|350px|link=https://cdn.phidgets.com/docs/images/1/1b/Java_eclipse_library.png]]
|-
| 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]]
|-
| 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]]
|-
| 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]]
|-
| 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:
<syntaxhighlight>
java -jar phidgetTest.jar
</syntaxhighlight>
|}

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

[[Image:Language_java_codesample.png|center|600px|link=https://cdn.phidgets.com/docs/images/a/af/Language_java_codesample.png]]

===Phidget Programming Basics===
{{PhidgetProgrammingBasicsLink}}

==API==
[{{SERVER}}/?view=api&lang=Python 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 gathered from the installation directory on a computer that has our drivers installed (e.g. C:/Program Files/Phidgets/Phidget22). Java will look for these files in several locations, including the classpath and the working folder of the project.

File:Java eclipse export2.png

2026-04-01T19:33:04Z

Mparadis:

File:Java eclipse export.png

2026-04-01T19:25:02Z

Mparadis:

File:Java eclipse newclass2.png

2026-04-01T16:13:45Z

Mparadis:

File:Java eclipse newclass.png

2026-04-01T16:13:38Z

Mparadis:

File:Java eclipse library.png

2026-04-01T16:13:24Z

Mparadis:

File:Java eclipse newproj.png

2026-04-01T16:13:14Z

Mparadis:

Language - Java

2026-03-31T22:21:57Z

Mparadis: /* Javac */

{{#seo:|description=Learn how to use Phidget USB devices with Java.}}
[[Category:Language]]

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

==Java Libraries==

You must install the [https://www.phidgets.com/docs/Operating_System_Support Phidget drivers] for your operating system to be able to compile and run Java programs.

Your Java project will also require our Java library file:
* [https://www.phidgets.com/downloads/phidget22/libraries/any/Phidget22Java.zip phidget22.jar].

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

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

[[Image:Javascript_networkserver_webusb_spec.png|center|600px|link=https://cdn.phidgets.com/docs/images/8/80/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 [{{SERVER}}/docs/OS_-_Linux#Setting_Udev_Rules set up udev rules] on your system.

==Development Environment Configuration==

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

===Visual Studio Code===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''Instructions'''
| 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]]
|-
| 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]]
|-
| 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]]
|-
| 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].
|-
| 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.
|-
| 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]]
|-
| 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]]
|-
| 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===
{| 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]]
|-
|[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
</syntaxhighlight>
Then, enter the following command to run the program:
<syntaxhighlight>
java -classpath .;phidget22.jar example
</syntaxhighlight>
||
|-
| 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
Main-Class: example
Class-Path: phidget22.jar

</syntaxhighlight>
Make sure there's an empty newline at the bottom of the three lines and a space after each colon.
|-
| colspan="2"| Next, create the .jar file with this command:
<syntaxhighlight>
jar cfm example.jar manifest.mf *.class
</syntaxhighlight>
Once the .jar is created, you can execute it with
<syntaxhighlight>
java -jar example.jar
</syntaxhighlight>

|}

===Netbeans===
{| 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]]
|-
|[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. ||
|}

===Eclipse===
{| 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]]
|-
|[https://www.phidgets.com/downloads/phidget22/libraries/any/Phidget22Java.zip You can download phidget22.jar here].||
|-
| 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]]
|-
| 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. || [[Image:Windows_eclipse2.jpg|center|350px|link=https://cdn.phidgets.com/docs/images/0/0c/Windows_eclipse2.jpg]]
|-
| 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. Eclipse may require that you add a package name. Since this isn't a modular project, you must delete the {{code|module-info.java}} file that it creates. || [[Image:Windows_eclipse4.jpg|center|350px|link=https://cdn.phidgets.com/docs/images/8/87/Windows_eclipse4.jpg]]
|-
| Your project now has access to Phidgets! ||
|-
|}

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

[[Image:Language_java_codesample.png|center|600px|link=https://cdn.phidgets.com/docs/images/a/af/Language_java_codesample.png]]

===Phidget Programming Basics===
{{PhidgetProgrammingBasicsLink}}

==API==
[{{SERVER}}/?view=api&lang=Python 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 gathered from the installation directory on a computer that has our drivers installed (e.g. C:/Program Files/Phidgets/Phidget22). Java will look for these files in several locations, including the classpath and the working folder of the project.

Language - Java

2026-03-31T22:20:50Z

Mparadis: /* Javac */

{{#seo:|description=Learn how to use Phidget USB devices with Java.}}
[[Category:Language]]

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

==Java Libraries==

You must install the [https://www.phidgets.com/docs/Operating_System_Support Phidget drivers] for your operating system to be able to compile and run Java programs.

Your Java project will also require our Java library file:
* [https://www.phidgets.com/downloads/phidget22/libraries/any/Phidget22Java.zip phidget22.jar].

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

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

[[Image:Javascript_networkserver_webusb_spec.png|center|600px|link=https://cdn.phidgets.com/docs/images/8/80/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 [{{SERVER}}/docs/OS_-_Linux#Setting_Udev_Rules set up udev rules] on your system.

==Development Environment Configuration==

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

===Visual Studio Code===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''Instructions'''
| 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]]
|-
| 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]]
|-
| 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]]
|-
| 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].
|-
| 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.
|-
| 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]]
|-
| 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]]
|-
| 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===
{| 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]]
|-
|[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
</syntaxhighlight>
Then, enter the following command to run the program:
<syntaxhighlight>
java -classpath .;phidget22.jar example
</syntaxhighlight>
||
|-
| 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
Main-Class: example
Class-Path: phidget22.jar

</syntaxhighlight>
Make sure there's a newline at the bottom of the three lines and a space after each colon.
|-
| colspan="2"| Next, create the .jar file with this command:
<syntaxhighlight>
jar cfm example.jar manifest.mf *.class
</syntaxhighlight>
Once the .jar is created, you can execute it with
<syntaxhighlight>
java -jar example.jar
</syntaxhighlight>

|}

===Netbeans===
{| 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]]
|-
|[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. ||
|}

===Eclipse===
{| 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]]
|-
|[https://www.phidgets.com/downloads/phidget22/libraries/any/Phidget22Java.zip You can download phidget22.jar here].||
|-
| 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]]
|-
| 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. || [[Image:Windows_eclipse2.jpg|center|350px|link=https://cdn.phidgets.com/docs/images/0/0c/Windows_eclipse2.jpg]]
|-
| 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. Eclipse may require that you add a package name. Since this isn't a modular project, you must delete the {{code|module-info.java}} file that it creates. || [[Image:Windows_eclipse4.jpg|center|350px|link=https://cdn.phidgets.com/docs/images/8/87/Windows_eclipse4.jpg]]
|-
| Your project now has access to Phidgets! ||
|-
|}

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

[[Image:Language_java_codesample.png|center|600px|link=https://cdn.phidgets.com/docs/images/a/af/Language_java_codesample.png]]

===Phidget Programming Basics===
{{PhidgetProgrammingBasicsLink}}

==API==
[{{SERVER}}/?view=api&lang=Python 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 gathered from the installation directory on a computer that has our drivers installed (e.g. C:/Program Files/Phidgets/Phidget22). Java will look for these files in several locations, including the classpath and the working folder of the project.

Language - Java

2026-03-31T15:18:28Z

Mparadis: /* Visual Studio Code */

{{#seo:|description=Learn how to use Phidget USB devices with Java.}}
[[Category:Language]]

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

==Java Libraries==

You must install the [https://www.phidgets.com/docs/Operating_System_Support Phidget drivers] for your operating system to be able to compile and run Java programs.

Your Java project will also require our Java library file:
* [https://www.phidgets.com/downloads/phidget22/libraries/any/Phidget22Java.zip phidget22.jar].

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

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

[[Image:Javascript_networkserver_webusb_spec.png|center|600px|link=https://cdn.phidgets.com/docs/images/8/80/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 [{{SERVER}}/docs/OS_-_Linux#Setting_Udev_Rules set up udev rules] on your system.

==Development Environment Configuration==

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

===Visual Studio Code===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''Instructions'''
| 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]]
|-
| 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]]
|-
| 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]]
|-
| 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].
|-
| 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.
|-
| 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]]
|-
| 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]]
|-
| 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===
{| 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]]
|-
|[https://www.phidgets.com/downloads/phidget22/libraries/any/Phidget22Java.zip You can download phidget22.jar here].||
|-
|Once you are ready to run your program, enter the following command in the command prompt or terminal:
<syntaxhighlight>
javac -classpath .;phidget22.jar example.java
</syntaxhighlight>
Finally, enter the following command to run the program:
<syntaxhighlight>
java -classpath .;phidget22.jar example
</syntaxhighlight>
||
|-
|}

===Netbeans===
{| 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]]
|-
|[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. ||
|}

===Eclipse===
{| 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]]
|-
|[https://www.phidgets.com/downloads/phidget22/libraries/any/Phidget22Java.zip You can download phidget22.jar here].||
|-
| 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]]
|-
| 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. || [[Image:Windows_eclipse2.jpg|center|350px|link=https://cdn.phidgets.com/docs/images/0/0c/Windows_eclipse2.jpg]]
|-
| 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. Eclipse may require that you add a package name. Since this isn't a modular project, you must delete the {{code|module-info.java}} file that it creates. || [[Image:Windows_eclipse4.jpg|center|350px|link=https://cdn.phidgets.com/docs/images/8/87/Windows_eclipse4.jpg]]
|-
| Your project now has access to Phidgets! ||
|-
|}

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

[[Image:Language_java_codesample.png|center|600px|link=https://cdn.phidgets.com/docs/images/a/af/Language_java_codesample.png]]

===Phidget Programming Basics===
{{PhidgetProgrammingBasicsLink}}

==API==
[{{SERVER}}/?view=api&lang=Python 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 gathered from the installation directory on a computer that has our drivers installed (e.g. C:/Program Files/Phidgets/Phidget22). Java will look for these files in several locations, including the classpath and the working folder of the project.

File:Language java vscode jar2.png

2026-03-31T15:16:45Z

Mparadis:

File:Language java vscode jar.png

2026-03-31T15:16:29Z

Mparadis:

Language - Java

2026-03-23T22:28:14Z

Mparadis:

{{#seo:|description=Learn how to use Phidget USB devices with Java.}}
[[Category:Language]]

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

==Java Libraries==

You must install the [https://www.phidgets.com/docs/Operating_System_Support Phidget drivers] for your operating system to be able to compile and run Java programs.

Your Java project will also require our Java library file:
* [https://www.phidgets.com/downloads/phidget22/libraries/any/Phidget22Java.zip phidget22.jar].

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

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

[[Image:Javascript_networkserver_webusb_spec.png|center|600px|link=https://cdn.phidgets.com/docs/images/8/80/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 [{{SERVER}}/docs/OS_-_Linux#Setting_Udev_Rules set up udev rules] on your system.

==Development Environment Configuration==

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

===Visual Studio Code===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''Instructions'''
| 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]]
|-
| 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]]
|-
| 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]]
|-
| 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].
|-
| 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.
|-
| 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]]
|}

===Javac===
{| 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]]
|-
|[https://www.phidgets.com/downloads/phidget22/libraries/any/Phidget22Java.zip You can download phidget22.jar here].||
|-
|Once you are ready to run your program, enter the following command in the command prompt or terminal:
<syntaxhighlight>
javac -classpath .;phidget22.jar example.java
</syntaxhighlight>
Finally, enter the following command to run the program:
<syntaxhighlight>
java -classpath .;phidget22.jar example
</syntaxhighlight>
||
|-
|}

===Netbeans===
{| 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]]
|-
|[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. ||
|}

===Eclipse===
{| 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]]
|-
|[https://www.phidgets.com/downloads/phidget22/libraries/any/Phidget22Java.zip You can download phidget22.jar here].||
|-
| 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]]
|-
| 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. || [[Image:Windows_eclipse2.jpg|center|350px|link=https://cdn.phidgets.com/docs/images/0/0c/Windows_eclipse2.jpg]]
|-
| 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. Eclipse may require that you add a package name. Since this isn't a modular project, you must delete the {{code|module-info.java}} file that it creates. || [[Image:Windows_eclipse4.jpg|center|350px|link=https://cdn.phidgets.com/docs/images/8/87/Windows_eclipse4.jpg]]
|-
| Your project now has access to Phidgets! ||
|-
|}

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

[[Image:Language_java_codesample.png|center|600px|link=https://cdn.phidgets.com/docs/images/a/af/Language_java_codesample.png]]

===Phidget Programming Basics===
{{PhidgetProgrammingBasicsLink}}

==API==
[{{SERVER}}/?view=api&lang=Python 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 gathered from the installation directory on a computer that has our drivers installed (e.g. C:/Program Files/Phidgets/Phidget22). Java will look for these files in several locations, including the classpath and the working folder of the project.

Language - Java

2026-03-23T22:11:16Z

Mparadis: /* Java Libraries */

{{#seo:|description=Learn how to use Phidget USB devices with Java.}}
[[Category:Language]]

==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 [https://cdn.phidgets.com/downloads/phidget22/libraries/windows/Phidget22-windevel.zip here].

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

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

[[Image:Javascript_networkserver_webusb_spec.png|center|600px|link=https://cdn.phidgets.com/docs/images/8/80/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 [{{SERVER}}/docs/OS_-_Linux#Setting_Udev_Rules set up udev rules] on your system.

==Development Environment Configuration==

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

===Visual Studio Code===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''Instructions'''
| 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]]
|-
| 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]]
|-
| 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]]
|-
| 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].
|-
| 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.
|-
| 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]]
|}

===Javac===
{| 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]]
|-
|[https://www.phidgets.com/downloads/phidget22/libraries/any/Phidget22Java.zip You can download phidget22.jar here].||
|-
|Once you are ready to run your program, enter the following command in the command prompt or terminal:
<syntaxhighlight>
javac -classpath .;phidget22.jar example.java
</syntaxhighlight>
Finally, enter the following command to run the program:
<syntaxhighlight>
java -classpath .;phidget22.jar example
</syntaxhighlight>
||
|-
|}

===Netbeans===
{| 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]]
|-
|[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. ||
|}

===Eclipse===
{| 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]]
|-
|[https://www.phidgets.com/downloads/phidget22/libraries/any/Phidget22Java.zip You can download phidget22.jar here].||
|-
| 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]]
|-
| 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. || [[Image:Windows_eclipse2.jpg|center|350px|link=https://cdn.phidgets.com/docs/images/0/0c/Windows_eclipse2.jpg]]
|-
| 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. Eclipse may require that you add a package name. Since this isn't a modular project, you must delete the {{code|module-info.java}} file that it creates. || [[Image:Windows_eclipse4.jpg|center|350px|link=https://cdn.phidgets.com/docs/images/8/87/Windows_eclipse4.jpg]]
|-
| Your project now has access to Phidgets! ||
|-
|}

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

[[Image:Language_java_codesample.png|center|600px|link=https://cdn.phidgets.com/docs/images/a/af/Language_java_codesample.png]]

===Phidget Programming Basics===
{{PhidgetProgrammingBasicsLink}}

==API==
[{{SERVER}}/?view=api&lang=Python Phidget22 API]

Language - Java

2026-03-23T22:04:48Z

Mparadis: /* Eclipse */

{{#seo:|description=Learn how to use Phidget USB devices with Java.}}
[[Category:Language]]

==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 [https://cdn.phidgets.com/downloads/phidget22/libraries/windows/Phidget22-windevel.zip here].

==Development Environment Configuration==

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

===Visual Studio Code===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''Instructions'''
| 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]]
|-
| 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]]
|-
| 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]]
|-
| 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].
|-
| 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.
|-
| 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]]
|}

===Javac===
{| 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]]
|-
|[https://www.phidgets.com/downloads/phidget22/libraries/any/Phidget22Java.zip You can download phidget22.jar here].||
|-
|Once you are ready to run your program, enter the following command in the command prompt or terminal:
<syntaxhighlight>
javac -classpath .;phidget22.jar example.java
</syntaxhighlight>
Finally, enter the following command to run the program:
<syntaxhighlight>
java -classpath .;phidget22.jar example
</syntaxhighlight>
||
|-
|}

===Netbeans===
{| 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]]
|-
|[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. ||
|}

===Eclipse===
{| 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]]
|-
|[https://www.phidgets.com/downloads/phidget22/libraries/any/Phidget22Java.zip You can download phidget22.jar here].||
|-
| 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]]
|-
| 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. || [[Image:Windows_eclipse2.jpg|center|350px|link=https://cdn.phidgets.com/docs/images/0/0c/Windows_eclipse2.jpg]]
|-
| 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. Eclipse may require that you add a package name. Since this isn't a modular project, you must delete the {{code|module-info.java}} file that it creates. || [[Image:Windows_eclipse4.jpg|center|350px|link=https://cdn.phidgets.com/docs/images/8/87/Windows_eclipse4.jpg]]
|-
| Your project now has access to Phidgets! ||
|-
|}

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

[[Image:Language_java_codesample.png|center|600px|link=https://cdn.phidgets.com/docs/images/a/af/Language_java_codesample.png]]

===Phidget Programming Basics===
{{PhidgetProgrammingBasicsLink}}

==API==
[{{SERVER}}/?view=api&lang=Python Phidget22 API]

Language - Java

2026-03-23T19:18:12Z

Mparadis:

{{#seo:|description=Learn how to use Phidget USB devices with Java.}}
[[Category:Language]]

==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 [https://cdn.phidgets.com/downloads/phidget22/libraries/windows/Phidget22-windevel.zip here].

==Development Environment Configuration==

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

===Visual Studio Code===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''Instructions'''
| 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]]
|-
| 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]]
|-
| 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]]
|-
| 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].
|-
| 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.
|-
| 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]]
|}

===Javac===
{| 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]]
|-
|[https://www.phidgets.com/downloads/phidget22/libraries/any/Phidget22Java.zip You can download phidget22.jar here].||
|-
|Once you are ready to run your program, enter the following command in the command prompt or terminal:
<syntaxhighlight>
javac -classpath .;phidget22.jar example.java
</syntaxhighlight>
Finally, enter the following command to run the program:
<syntaxhighlight>
java -classpath .;phidget22.jar example
</syntaxhighlight>
||
|-
|}

===Netbeans===
{| 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]]
|-
|[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. ||
|}

===Eclipse===
{| 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]]
|-
|[https://www.phidgets.com/downloads/phidget22/libraries/any/Phidget22Java.zip You can download phidget22.jar here].||
|-
| 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]]
|-
| 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]]
|-
| 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]]
|-
| Your project now has access to Phidgets! ||
|-
|}

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

[[Image:Language_java_codesample.png|center|600px|link=https://cdn.phidgets.com/docs/images/a/af/Language_java_codesample.png]]

===Phidget Programming Basics===
{{PhidgetProgrammingBasicsLink}}

==API==
[{{SERVER}}/?view=api&lang=Python Phidget22 API]

File:Language java vscode extension2.png

2026-03-23T19:14:54Z

Mparadis:

File:Language java vscode run.png

2026-03-23T19:13:58Z

Mparadis:

File:Language java vscode emptyproj.png

2026-03-23T19:13:47Z

Mparadis:

File:Language java vscode extension.png

2026-03-23T19:13:12Z

Mparadis:

File:Language java vscode createproj.png

2026-03-23T19:11:28Z

Mparadis:

Controlling an SPI Encoder

2026-03-19T19:58:49Z

Mparadis: /* Full Script */

<metadesc>A step-by-step example writing code to interface a sensor with the ADP0002.</metadesc>

[[Image:ADP0002_0.jpg|link=|thumb| 400px|<center>[https://www.phidgets.com/?prodid=1355 SPI Adapter Phidget (ADP0002_0)]]]
==Introduction==
The [https://www.phidgets.com/?prodid=1355 SPI Adapter Phidget] allows you to interface with a wide range of SPI-compatible devices, including sensors, displays, and more.

In this project, we will use it to control an absolute position magnetic encoder.

===Steps===
To complete this project, we will work through the following steps:
# Determine the device's basic configuration parameters
# Identify the sequence of commands expected by the device
# Connect the device to the SPI Adapter Phidget
# Test the device using the Phidget Control Panel
# Create a custom program.

===Resources===
Information from the following datasheet will be referenced throughout this project:
* [https://ams-osram.com/products/boards-kits-accessories/boards/ams-as5048a-ts-evm-ab-evaluation-board Device Product Page]
* [https://cdn.phidgets.com/docs/images/f/fd/AS5048A.pdf AS5048A Encoder Datasheet]

==Demonstration==
<center>{{#ev:youtube|-TkTykk1Ris|rel=0}}</center>

===Additional Information===
[[Image:Adp0002_magnet.png|link=https://cdn.phidgets.com/docs/images/2/2e/Adp0002_magnet.png|thumb]]
The encoder is designed to be used with a small magnet, magnetized with the poles on the edges of the cylinder instead of the top and bottom. The magnet can be attached to the exposed rear shaft of a motor, and this sensor can use the position of the magnetic field to determine the absolute position of the shaft.

==Configuration Parameters==
During this step, we are looking for the following information:
* Supply Voltage
* Communication Frequency
* Endianness (MSB-first or LSB-first)
* Chip Select Polarity
* SPI Wire Mode

This information is typically found using the device's product page and/or any relevant datasheets.
Based on the AS5048A datasheet, we will use the following parameters:
* Supply Voltage: 3.3V or 5V (we'll use 5V)
* Communication Frequency: The clock period is 100ns minimum (10MHz maximum)
* Endianness: MSB-first
* Chip Select: Active Low
* SPI Wire Mode: Mode = 1

==Command Sequence==
Next, we need to determine the sequence of commands the device is expecting. Some devices have certain commands that must be sent to configure the device, but this one is ready to provide sensor data as soon as it's powered up.

[[Image:SPI_commandflow.png|link=|center|800px]]
<center>''AS5048A datasheet (page 11)''</center>

This diagram explains that each command we send will have its response delivered during the next transaction. Since our first goal is to get a stream of angle data from the encoder, we can just continuously send the Read Angle command.

===Reading from AS5048A Registers===

Commands sent to the encoder must follow the following format:
[[Image:SPI_command_package.png|link=|center|800px]]
<center>''AS5048A datasheet (page 14)''</center>
This table tells us that the 16-bit command package consists of a parity bit, a read/write bit, and then a 14-bit register address.

There are three data readout registers we can access. Here is the definition for the angle register:

[[Image:SPI_command_angle_readout.png|link=|center|800px]]
<center>''AS5048A datasheet (page 17)''</center>

The register address for the angle data is '''0x3FFF''', but this is not the complete 16-bit value we need to transmit. First, we must add the R/W bit (Read=1) and then calculate the parity bit for even parity.

[[Image:SPI_command_parity.png|link=|center|700px]]
<center>''Calculating the parity bit''</center>

This results in '''0xFFFF''', which is the command we need to send with the SPI Phidget.

== Connecting to the ADP0002 ==

The wiring for this sensor is very straightforward with the ADP0002:
[[Image:SPI_encoder_pinout.png|link=|120px|left]]
* '''5V''' - VCC
* '''3.3V''' - Not connected
* '''PWM''' - Not connected
* '''SDA/CSn''' - CS
* '''SCL/SCK''' - SCLK
* '''A1/MOSI''' - MOSI
* '''A2/MISO''' - MISO
* '''GND''' - GND

[[Image:SPI_wiring_diagram.png|link=|center|800px]]

== Testing in the Phidget Control Panel ==
Now that we have the configuration parameters and the command sequence, we can use the Phidget Control Panel to confirm our device is working as expected.

=== Reading the Angle ===

==== Reading the Angle in the Control Panel ====
Set the voltage to 5V, the chip select to Active Low, the wire mode to Mode_1, and the frequency to any value as they are all within the stated range.

We can try sending our '''0xFFFF''' command we calculated in the previous step:

[[Image:SPI_angle_send.png|link=|center|800px]]

The first response is an empty '''0x0000''', because responses are always sent in the next transaction. After that, we start getting data back from the encoder. In order to decode these values, we must go back to the datasheet and pay attention to the read package format.

==== Decoding the Read Data Package ====
[[Image:SPI_read_package.png|link=|center|800px]]
<center>''AS5048A datasheet (page 15)''</center>

Similar to the command package, it's made up of two control bits and one 14-bit value. The control bits are a parity bit to ensure communication fidelity, and an error flag that activates if there's a problem with the previous transaction. In this example we'll ignore these bits, but in an actual deployment you'd want to be checking both of these bits on each transaction.

So to decode the response for our angle command, '''0x9048''', we need to strip the top two bits:

[[Image:SPI_decode_response.png|link=|center|800px]]

This leaves us with '''0x1048''', or 4168 in decimal. The encoder has 14-bit precision, so the formula is as follows:

::<math>\text{Angle(°)} = \frac{\text{n}}{2^{14}} \times 360 \!</math>

Where 'n' is the response in decimal. Using this equation, our angle works out to '''91.58 degrees'''. When we eventually write our own program, we'll handle all of this bit manipulation and unit conversion in code.

=== Zeroing the Encoder ===

The advantage of an absolute encoder is that the actual angle of the shaft will be known as soon as the system is powered, without need for calibration or homing. This also means that the "home position" of our rotary system will be an arbitrary angle. We could zero this by keeping track of the initial angle in our program, but this chip has its own zeroing feature, so let's take a look.

==== Zeroing Command Registers and Sequence ====

We can find the zeroing process in the datasheet:
# Clear zero position registers by writing '0' into them
# Read the current angle
# Write the angle into the zero position registers
# (optional) Burn the value into the register so it persists across power cycles

For now we'll only do the steps 2 and 3, since the zero position registers will already be zero on startup by default since we haven't burned a value into the register. In our final program we'll be using the zero as a sort of 'tare' function so we will have to do the first step there. Here are the zero register definitions:

[[Image:SPI_zero_registers.png|link=|center|800px]]
<center>''AS5048A datasheet (page 17)''</center>

Just as before, we need to add the proper control bits to these address values before we send them.
* Write to Zero Position Hi: 0x0016 -> '''0x8016'''
* Write to Zero Position Lo: 0x0017 -> '''0x0017'''

For each of these registers, we'll follow this flow:
* Write to the zero position command
* Send the angle data
* Send a NOP (empty command) to confirm data sent

==== Zeroing in the Control Panel ====

In this example, our received data is '''0xBB99'''. Stripping the control bits, we get '''0x3B99''' or '''11 1011 1001 1001''' in binary. According to the zero register definitions, we need the 6 least significant bits in the low register, and the other 8 in the high register. This gives us:

* LSB: '''0b011001''' '''(0x19)''' -> '''0x8019'''
* MSB: '''0b11101110''' '''(0xEE)''' -> '''0x00EE'''

Again, since we need to set the write bits and proper parity, we end up with '''0x8019''' and '''0x00EE'''. Here's what the zeroing process looks like in the control panel (annotations added for clarity):

[[Image:SPI_controlpanel_zero.png|link=|center|850px]]

There are no error bits set in the responses, and each register we set echoed back the correct value when we wrote to it. The angle response we got after zeroing is '''0xBFF7'''.

* Strip control bits -> 0x3FF7
* Convert to decimal -> 16375
* Angle formula -> 359.80°

Since our new angle is close to 360° (the same as 0°), it looks like the zeroing process was successful.

== Writing a Custom Python Script ==

To begin writing a custom program for your Phidget device, navigate to the product page and select the [https://www.phidgets.com/?prodid=1354#Tab_Code_Samples Code Samples tab]. From there, you can customize the code for your own purposes. Here we have modified the code sample to demonstrate a simple readout of the encoder angle:

<syntaxhighlight lang=python>
from Phidget22.Phidget import *
from Phidget22.Devices.DataAdapter import *
import time

def hex2angle(hex):
bytes = (hex[0] << 8) | hex[1] # Combine MSB and LSB
bytes = bytes & 0b0011111111111111 # Discard top two bits (parity and error flag bits)
angle = round(bytes / 16348*360,3) # Divide by 2^14, multiply by 360 to get degrees
return angle

def main():
# Open ADP0002
adp = DataAdapter()
adp.openWaitForAttachment(5000)

# Set properties
adp.setEndianness(DataAdapterEndianness.ENDIANNESS_MSB_FIRST)
adp.setFrequency(DataAdapterFrequency.FREQUENCY_1500kHz)
adp.setDataAdapterVoltage(DataAdapterVoltage.DATAADAPTER_VOLTAGE_5_0V)
adp.setSPIChipSelect(DataAdapterSPIChipSelect.SPI_CHIP_SELECT_ACTIVE_LOW)
adp.setSPIMode(DataAdapterSPIMode.SPI_MODE_1)
time.sleep(0.5)

# Read and print angle until keyboard interrupt
print("Printing encoder data. Press CTRL+C to quit.")
try:
while True:
recvData = adp.sendPacketWaitResponse([0xFF,0xFF])
print(f"\rEncoder Angle: {hex2angle(recvData)} ",end="",flush=True)
time.sleep(0.1)

except KeyboardInterrupt:
pass

adp.close()

main()
</syntaxhighlight>

That’s about it, we went from reading the datasheet to a working script. Not all datasheets are created equal, so if you’re struggling with getting your sensor set up, feel free to ask for help by [https://www.phidgets.com/?view=contact sending us an email].

===Full Script===
Here is the full Python script that was used in the demonstration video. It displays the encoder angle and also provides the option to zero the encoder.

{{UGC-Entry|Full Script (Click to expand)||
<syntaxhighlight lang=python>
from Phidget22.Phidget import *
from Phidget22.Devices.DataAdapter import *
import time
import threading

# Register definitions from datasheet
ANGLE = [0x3F,0xFF]
MAGNITUDE = [0x3F,0xFE]
DIAGNOSTIC = [0x3F,0xFD]
CLEAR_ERR = [0x00,0x01]
NOP = [0x00,0x00]
ZERO_POS_HI = [0x00,0x16]
ZERO_POS_LO = [0x00,0x17]
READ = 1
WRITE = 0

adp = DataAdapter()

# Listener for keypress during main loop
running = True
def keyboard_listener():
global running
while running:
cmd = input().strip().lower()
if cmd == "z":
zero()
elif cmd == "q":
running = False

# Adds the required RW and parity bits
def addBits(packet,rw):
bits = ((packet[0] << 8) | packet[1]) & 0x3FFF

if(rw):
bits = bits | 0b0100000000000000
else:
bits = bits & 0b1011111111111111

if(bits.bit_count()%2 == 0):
bits = bits & 0b0111111111111111
else:
bits = bits | 0b1000000000000000

res = [(bits >> 8)& 0xFF,(bits & 0xFF)]
return res

def zero():
# Clear zero registers - this is needed to be able to zero more than once per run
adp.sendPacket(addBits(ZERO_POS_HI,WRITE))
adp.sendPacket(addBits([0x00,0x00],WRITE))
adp.sendPacket(addBits(NOP,WRITE))
adp.sendPacket(addBits(ZERO_POS_LO,WRITE))
adp.sendPacket(addBits([0x00,0x00],WRITE))
adp.sendPacket(addBits(NOP,WRITE))

# Read current angle
adp.sendPacket(addBits(ANGLE,READ))
resp = adp.sendPacketWaitResponse(addBits(NOP,WRITE))

# Combine angle bytes and mask out err/parity bits
angle = ((resp[0] << 8) | resp[1]) & 0x3FFF

# Split out angle for sending to zero registers
zposm = (angle >> 6) & 0xFF
zposl = angle & 0x3F

# write ZPOSM (0x0016)
resp = adp.sendPacketWaitResponse(addBits(ZERO_POS_HI,WRITE))
resp = adp.sendPacketWaitResponse(addBits([0x00,zposm],WRITE))
resp = adp.sendPacketWaitResponse(addBits(NOP,WRITE))

# write ZPOSL (0x0017)
resp = adp.sendPacketWaitResponse(addBits(ZERO_POS_LO,WRITE))
resp = adp.sendPacketWaitResponse(addBits([0x00,zposl],WRITE))
resp = adp.sendPacketWaitResponse(addBits(NOP,WRITE))

def hex2angle(hex):
bytes = (hex[0] << 8) | hex[1] # Combine MSB and LSB
bytes = bytes & 0b0011111111111111 # Discard top two bits (parity and error flag bits)
angle = round(bytes / 16348*360,3) # Divide by 2^14, multiply by 360 to get degrees
return angle

def main():
# Open ADP0002
adp.openWaitForAttachment(5000)

# Set properties
adp.setEndianness(DataAdapterEndianness.ENDIANNESS_MSB_FIRST)
adp.setFrequency(DataAdapterFrequency.FREQUENCY_1500kHz)
adp.setDataAdapterVoltage(DataAdapterVoltage.DATAADAPTER_VOLTAGE_5_0V)
adp.setSPIChipSelect(DataAdapterSPIChipSelect.SPI_CHIP_SELECT_ACTIVE_LOW)
adp.setSPIMode(DataAdapterSPIMode.SPI_MODE_1)
time.sleep(0.5)

# Start thread for keypress detection during the loop
threading.Thread(target=keyboard_listener, daemon=True).start()
print("Printing encoder data. Press 'z' to zero and 'q' to quit.")

# Read and print angle until 'q' pressed
try:
while running:
recvData = adp.sendPacketWaitResponse(addBits(ANGLE,READ))
print(f"\rEncoder Angle: {hex2angle(recvData)} ",end="",flush=True)
time.sleep(0.1)

except KeyboardInterrupt:
pass

adp.close()

main()
</syntaxhighlight>
}}
{{UGC-End}}

Controlling an SPI Encoder

2026-03-19T19:57:39Z

Mparadis: Created page with "<metadesc>A step-by-step example writing code to interface a sensor with the ADP0002.</metadesc> <center>[https://www.phidgets.com/?prodid=1355 SPI Adapter Phidget (ADP0002_0)] ==Introduction== The [https://www.phidgets.com/?prodid=1355 SPI Adapter Phidget] allows you to interface with a wide range of SPI-compatible devices, including sensors, displays, and more. In this project, we will use it to control an absolute position..."

<metadesc>A step-by-step example writing code to interface a sensor with the ADP0002.</metadesc>

[[Image:ADP0002_0.jpg|link=|thumb| 400px|<center>[https://www.phidgets.com/?prodid=1355 SPI Adapter Phidget (ADP0002_0)]]]
==Introduction==
The [https://www.phidgets.com/?prodid=1355 SPI Adapter Phidget] allows you to interface with a wide range of SPI-compatible devices, including sensors, displays, and more.

In this project, we will use it to control an absolute position magnetic encoder.

===Steps===
To complete this project, we will work through the following steps:
# Determine the device's basic configuration parameters
# Identify the sequence of commands expected by the device
# Connect the device to the SPI Adapter Phidget
# Test the device using the Phidget Control Panel
# Create a custom program.

===Resources===
Information from the following datasheet will be referenced throughout this project:
* [https://ams-osram.com/products/boards-kits-accessories/boards/ams-as5048a-ts-evm-ab-evaluation-board Device Product Page]
* [https://cdn.phidgets.com/docs/images/f/fd/AS5048A.pdf AS5048A Encoder Datasheet]

==Demonstration==
<center>{{#ev:youtube|-TkTykk1Ris|rel=0}}</center>

===Additional Information===
[[Image:Adp0002_magnet.png|link=https://cdn.phidgets.com/docs/images/2/2e/Adp0002_magnet.png|thumb]]
The encoder is designed to be used with a small magnet, magnetized with the poles on the edges of the cylinder instead of the top and bottom. The magnet can be attached to the exposed rear shaft of a motor, and this sensor can use the position of the magnetic field to determine the absolute position of the shaft.

==Configuration Parameters==
During this step, we are looking for the following information:
* Supply Voltage
* Communication Frequency
* Endianness (MSB-first or LSB-first)
* Chip Select Polarity
* SPI Wire Mode

This information is typically found using the device's product page and/or any relevant datasheets.
Based on the AS5048A datasheet, we will use the following parameters:
* Supply Voltage: 3.3V or 5V (we'll use 5V)
* Communication Frequency: The clock period is 100ns minimum (10MHz maximum)
* Endianness: MSB-first
* Chip Select: Active Low
* SPI Wire Mode: Mode = 1

==Command Sequence==
Next, we need to determine the sequence of commands the device is expecting. Some devices have certain commands that must be sent to configure the device, but this one is ready to provide sensor data as soon as it's powered up.

[[Image:SPI_commandflow.png|link=|center|800px]]
<center>''AS5048A datasheet (page 11)''</center>

This diagram explains that each command we send will have its response delivered during the next transaction. Since our first goal is to get a stream of angle data from the encoder, we can just continuously send the Read Angle command.

===Reading from AS5048A Registers===

Commands sent to the encoder must follow the following format:
[[Image:SPI_command_package.png|link=|center|800px]]
<center>''AS5048A datasheet (page 14)''</center>
This table tells us that the 16-bit command package consists of a parity bit, a read/write bit, and then a 14-bit register address.

There are three data readout registers we can access. Here is the definition for the angle register:

[[Image:SPI_command_angle_readout.png|link=|center|800px]]
<center>''AS5048A datasheet (page 17)''</center>

The register address for the angle data is '''0x3FFF''', but this is not the complete 16-bit value we need to transmit. First, we must add the R/W bit (Read=1) and then calculate the parity bit for even parity.

[[Image:SPI_command_parity.png|link=|center|700px]]
<center>''Calculating the parity bit''</center>

This results in '''0xFFFF''', which is the command we need to send with the SPI Phidget.

== Connecting to the ADP0002 ==

The wiring for this sensor is very straightforward with the ADP0002:
[[Image:SPI_encoder_pinout.png|link=|120px|left]]
* '''5V''' - VCC
* '''3.3V''' - Not connected
* '''PWM''' - Not connected
* '''SDA/CSn''' - CS
* '''SCL/SCK''' - SCLK
* '''A1/MOSI''' - MOSI
* '''A2/MISO''' - MISO
* '''GND''' - GND

[[Image:SPI_wiring_diagram.png|link=|center|800px]]

== Testing in the Phidget Control Panel ==
Now that we have the configuration parameters and the command sequence, we can use the Phidget Control Panel to confirm our device is working as expected.

=== Reading the Angle ===

==== Reading the Angle in the Control Panel ====
Set the voltage to 5V, the chip select to Active Low, the wire mode to Mode_1, and the frequency to any value as they are all within the stated range.

We can try sending our '''0xFFFF''' command we calculated in the previous step:

[[Image:SPI_angle_send.png|link=|center|800px]]

The first response is an empty '''0x0000''', because responses are always sent in the next transaction. After that, we start getting data back from the encoder. In order to decode these values, we must go back to the datasheet and pay attention to the read package format.

==== Decoding the Read Data Package ====
[[Image:SPI_read_package.png|link=|center|800px]]
<center>''AS5048A datasheet (page 15)''</center>

Similar to the command package, it's made up of two control bits and one 14-bit value. The control bits are a parity bit to ensure communication fidelity, and an error flag that activates if there's a problem with the previous transaction. In this example we'll ignore these bits, but in an actual deployment you'd want to be checking both of these bits on each transaction.

So to decode the response for our angle command, '''0x9048''', we need to strip the top two bits:

[[Image:SPI_decode_response.png|link=|center|800px]]

This leaves us with '''0x1048''', or 4168 in decimal. The encoder has 14-bit precision, so the formula is as follows:

::<math>\text{Angle(°)} = \frac{\text{n}}{2^{14}} \times 360 \!</math>

Where 'n' is the response in decimal. Using this equation, our angle works out to '''91.58 degrees'''. When we eventually write our own program, we'll handle all of this bit manipulation and unit conversion in code.

=== Zeroing the Encoder ===

The advantage of an absolute encoder is that the actual angle of the shaft will be known as soon as the system is powered, without need for calibration or homing. This also means that the "home position" of our rotary system will be an arbitrary angle. We could zero this by keeping track of the initial angle in our program, but this chip has its own zeroing feature, so let's take a look.

==== Zeroing Command Registers and Sequence ====

We can find the zeroing process in the datasheet:
# Clear zero position registers by writing '0' into them
# Read the current angle
# Write the angle into the zero position registers
# (optional) Burn the value into the register so it persists across power cycles

For now we'll only do the steps 2 and 3, since the zero position registers will already be zero on startup by default since we haven't burned a value into the register. In our final program we'll be using the zero as a sort of 'tare' function so we will have to do the first step there. Here are the zero register definitions:

[[Image:SPI_zero_registers.png|link=|center|800px]]
<center>''AS5048A datasheet (page 17)''</center>

Just as before, we need to add the proper control bits to these address values before we send them.
* Write to Zero Position Hi: 0x0016 -> '''0x8016'''
* Write to Zero Position Lo: 0x0017 -> '''0x0017'''

For each of these registers, we'll follow this flow:
* Write to the zero position command
* Send the angle data
* Send a NOP (empty command) to confirm data sent

==== Zeroing in the Control Panel ====

In this example, our received data is '''0xBB99'''. Stripping the control bits, we get '''0x3B99''' or '''11 1011 1001 1001''' in binary. According to the zero register definitions, we need the 6 least significant bits in the low register, and the other 8 in the high register. This gives us:

* LSB: '''0b011001''' '''(0x19)''' -> '''0x8019'''
* MSB: '''0b11101110''' '''(0xEE)''' -> '''0x00EE'''

Again, since we need to set the write bits and proper parity, we end up with '''0x8019''' and '''0x00EE'''. Here's what the zeroing process looks like in the control panel (annotations added for clarity):

[[Image:SPI_controlpanel_zero.png|link=|center|850px]]

There are no error bits set in the responses, and each register we set echoed back the correct value when we wrote to it. The angle response we got after zeroing is '''0xBFF7'''.

* Strip control bits -> 0x3FF7
* Convert to decimal -> 16375
* Angle formula -> 359.80°

Since our new angle is close to 360° (the same as 0°), it looks like the zeroing process was successful.

== Writing a Custom Python Script ==

To begin writing a custom program for your Phidget device, navigate to the product page and select the [https://www.phidgets.com/?prodid=1354#Tab_Code_Samples Code Samples tab]. From there, you can customize the code for your own purposes. Here we have modified the code sample to demonstrate a simple readout of the encoder angle:

<syntaxhighlight lang=python>
from Phidget22.Phidget import *
from Phidget22.Devices.DataAdapter import *
import time

def hex2angle(hex):
bytes = (hex[0] << 8) | hex[1] # Combine MSB and LSB
bytes = bytes & 0b0011111111111111 # Discard top two bits (parity and error flag bits)
angle = round(bytes / 16348*360,3) # Divide by 2^14, multiply by 360 to get degrees
return angle

def main():
# Open ADP0002
adp = DataAdapter()
adp.openWaitForAttachment(5000)

# Set properties
adp.setEndianness(DataAdapterEndianness.ENDIANNESS_MSB_FIRST)
adp.setFrequency(DataAdapterFrequency.FREQUENCY_1500kHz)
adp.setDataAdapterVoltage(DataAdapterVoltage.DATAADAPTER_VOLTAGE_5_0V)
adp.setSPIChipSelect(DataAdapterSPIChipSelect.SPI_CHIP_SELECT_ACTIVE_LOW)
adp.setSPIMode(DataAdapterSPIMode.SPI_MODE_1)
time.sleep(0.5)

# Read and print angle until keyboard interrupt
print("Printing encoder data. Press CTRL+C to quit.")
try:
while True:
recvData = adp.sendPacketWaitResponse([0xFF,0xFF])
print(f"\rEncoder Angle: {hex2angle(recvData)} ",end="",flush=True)
time.sleep(0.1)

except KeyboardInterrupt:
pass

adp.close()

main()
</syntaxhighlight>

That’s about it, we went from reading the datasheet to a working script. Not all datasheets are created equal, so if you’re struggling with getting your sensor set up, feel free to ask for help by [https://www.phidgets.com/?view=contact sending us an email].

===Full Script===
Here is the full Python script that was used in the demonstration video. It displays the encoder angle and also provides the option to zero the encoder.

{{UGC-Start}}
{{UGC-Entry|Full Script (Click to expand)||
<syntaxhighlight lang=python>
from Phidget22.Phidget import *
from Phidget22.Devices.DataAdapter import *
import time
import threading

# Register definitions from datasheet
ANGLE = [0x3F,0xFF]
MAGNITUDE = [0x3F,0xFE]
DIAGNOSTIC = [0x3F,0xFD]
CLEAR_ERR = [0x00,0x01]
NOP = [0x00,0x00]
ZERO_POS_HI = [0x00,0x16]
ZERO_POS_LO = [0x00,0x17]
READ = 1
WRITE = 0

adp = DataAdapter()

# Listener for keypress during main loop
running = True
def keyboard_listener():
global running
while running:
cmd = input().strip().lower()
if cmd == "z":
zero()
elif cmd == "q":
running = False

# Adds the required RW and parity bits
def addBits(packet,rw):
bits = ((packet[0] << 8) | packet[1]) & 0x3FFF

if(rw):
bits = bits | 0b0100000000000000
else:
bits = bits & 0b1011111111111111

if(bits.bit_count()%2 == 0):
bits = bits & 0b0111111111111111
else:
bits = bits | 0b1000000000000000

res = [(bits >> 8)& 0xFF,(bits & 0xFF)]
return res

def zero():
# Clear zero registers - this is needed to be able to zero more than once per run
adp.sendPacket(addBits(ZERO_POS_HI,WRITE))
adp.sendPacket(addBits([0x00,0x00],WRITE))
adp.sendPacket(addBits(NOP,WRITE))
adp.sendPacket(addBits(ZERO_POS_LO,WRITE))
adp.sendPacket(addBits([0x00,0x00],WRITE))
adp.sendPacket(addBits(NOP,WRITE))

# Read current angle
adp.sendPacket(addBits(ANGLE,READ))
resp = adp.sendPacketWaitResponse(addBits(NOP,WRITE))

# Combine angle bytes and mask out err/parity bits
angle = ((resp[0] << 8) | resp[1]) & 0x3FFF

# Split out angle for sending to zero registers
zposm = (angle >> 6) & 0xFF
zposl = angle & 0x3F

# write ZPOSM (0x0016)
resp = adp.sendPacketWaitResponse(addBits(ZERO_POS_HI,WRITE))
resp = adp.sendPacketWaitResponse(addBits([0x00,zposm],WRITE))
resp = adp.sendPacketWaitResponse(addBits(NOP,WRITE))

# write ZPOSL (0x0017)
resp = adp.sendPacketWaitResponse(addBits(ZERO_POS_LO,WRITE))
resp = adp.sendPacketWaitResponse(addBits([0x00,zposl],WRITE))
resp = adp.sendPacketWaitResponse(addBits(NOP,WRITE))

def hex2angle(hex):
bytes = (hex[0] << 8) | hex[1] # Combine MSB and LSB
bytes = bytes & 0b0011111111111111 # Discard top two bits (parity and error flag bits)
angle = round(bytes / 16348*360,3) # Divide by 2^14, multiply by 360 to get degrees
return angle

def main():
# Open ADP0002
adp.openWaitForAttachment(5000)

# Set properties
adp.setEndianness(DataAdapterEndianness.ENDIANNESS_MSB_FIRST)
adp.setFrequency(DataAdapterFrequency.FREQUENCY_1500kHz)
adp.setDataAdapterVoltage(DataAdapterVoltage.DATAADAPTER_VOLTAGE_5_0V)
adp.setSPIChipSelect(DataAdapterSPIChipSelect.SPI_CHIP_SELECT_ACTIVE_LOW)
adp.setSPIMode(DataAdapterSPIMode.SPI_MODE_1)
time.sleep(0.5)

# Start thread for keypress detection during the loop
threading.Thread(target=keyboard_listener, daemon=True).start()
print("Printing encoder data. Press 'z' to zero and 'q' to quit.")

# Read and print angle until 'q' pressed
try:
while running:
recvData = adp.sendPacketWaitResponse(addBits(ANGLE,READ))
print(f"\rEncoder Angle: {hex2angle(recvData)} ",end="",flush=True)
time.sleep(0.1)

except KeyboardInterrupt:
pass

adp.close()

main()
</syntaxhighlight>
}}
{{UGC-End}}