The Java API of the ZTEX EZ-USB SDK.

This API is the host-side counterpart of the Firmware-Kit and allows user software to interact with EZ-USB devices running with such firmware. It uses libusbJava, a Java wrapper for the libusb 0.1 and the libusb-win32 USB libraries. This API is known to run on Linux and Windows, but should work on every operating system which supports libusb and Java.

Features

The main features are:

Interaction with the firmware

Firmware built using the Firmware Development Kit supports an additional descriptor, the ZTEX descriptor 1. This descriptor identifies the device and firmware, provides compatibility information (e.g. to avoid that a device is loaded with the wrong firmware) and specifies the communication protocol. A description of the descriptor is given in {@link ztex.ZtexDevice1}.

The communication protocol defines how the functions provided by the firmware (see main features above) can be accessed. Currently there is only one protocol implemented, the so called interface 1. A description of the interface is given in {@link ztex.Ztex1v1}.

The most importand classes for the interaction with the EZ-USB device / firmware are

{@link ztex.ZtexDevice1} Represents an EZ-USB device that supports ZTEX descriptor 1. These devices can be found using {@link ztex.ZtexScanBus1}.
{@link ztex.Ztex1} Implementation of interface-independent part of the communication protocol, e.g. uploading the firmware to the EZ-USB and renumeration management.
{@link ztex.Ztex1v1} Implemenetaion of the Interface 1, i.e. the interface dependent part of the communication protocol.

SDK overview

The following diagram gives an overview about the usage of the different parts of the ZTEX EZ-USB SDK.

ZTEX EZ-USB SDK overview for Linux and Windows

The host software usually consists of a single jar archive which contains

This single jar archive runs on both, Linux and Windows (or other OS's that support libusb and Java).

On Linux this jar archive has no additional software requirements. The libusb(Java) library communicates directly with the EZ-USB device using kernel routines.

On Windows a libusb driver is required. (This driver is a part of the ZTEX SDK package). The libusb(Java) library communicates with the EZ-USB device using that driver.

Related Resources

For more information about this project visit the ZTEX EZ-USB SDK page.