URL
https://opencores.org/ocsvn/usb_fpga_2_14/usb_fpga_2_14/trunk
Subversion Repositories usb_fpga_2_14
[/] [usb_fpga_2_14/] [trunk/] [docs/] [java/] [ztex/] [ZtexDevice1.html] - Rev 2
Compare with Previous | Blame | View Log
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (version 1.7.0_79) on Wed Mar 22 19:20:13 CET 2017 -->
<title>ZtexDevice1</title>
<meta name="date" content="2017-03-22">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ZtexDevice1";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../ztex/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../ztex/ZtexContext.html" title="class in ztex"><span class="strong">Prev Class</span></a></li>
<li><a href="../ztex/ZtexEventHandler.html" title="class in ztex"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?ztex/ZtexDevice1.html" target="_top">Frames</a></li>
<li><a href="ZtexDevice1.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">ztex</div>
<h2 title="Class ZtexDevice1" class="title">Class ZtexDevice1</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>ztex.ZtexDevice1</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">ZtexDevice1</span>
extends java.lang.Object</pre>
<div class="block">A class representing an EZ-USB device that supports the ZTEX descriptor 1 or an unconfigured EZ-USB device.<br>
Instances of this class are usually created by <a href="../ztex/ZtexScanBus1.html" title="class in ztex"><code>ZtexScanBus1</code></a>.
The following table describes the ZTEX descriptor 1.
<a name="descriptor"></a>
<table bgcolor="#404040" cellspacing=1 cellpadding=4>
<tr>
<td bgcolor="#d0d0d0" valign="top"><b>Field name</b></td>
<td bgcolor="#d0d0d0" valign="top"><b>Offset</b></td>
<td bgcolor="#d0d0d0" valign="top"><b>Size</b></td>
<td bgcolor="#d0d0d0" valign="top"><b>Description</b></td>
</tr>
<tr>
<td bgcolor="#ffffff" valign="top">ZTEX_DESCRIPTOR_SIZE</td>
<td bgcolor="#ffffff" valign="top">0</td>
<td bgcolor="#ffffff" valign="top">1</td>
<td bgcolor="#ffffff" valign="top">Size of the descriptor in bytes; must be 40 for descriptor version 1</td>
</tr>
<tr>
<td bgcolor="#ffffff" valign="top">ZTEX_DESCRIPTOR_VERSION</td>
<td bgcolor="#ffffff" valign="top">1</td>
<td bgcolor="#ffffff" valign="top">1</td>
<td bgcolor="#ffffff" valign="top">Descriptor version; 1 for version 1</td>
</tr>
<tr>
<td bgcolor="#ffffff" valign="top">ZTEXID</td>
<td bgcolor="#ffffff" valign="top">2</td>
<td bgcolor="#ffffff" valign="top">4</td>
<td bgcolor="#ffffff" valign="top">ID; must be "ZTEX"</td>
</tr>
<tr>
<td bgcolor="#ffffff" valign="top">PRODUCT_ID</td>
<td bgcolor="#ffffff" valign="top">6</td>
<td bgcolor="#ffffff" valign="top">4</td>
<td bgcolor="#ffffff" valign="top">Four numbers (0..255) representing the product ID and firmware compatibility information.<br>
A firmware can overwrite an installed one<br>
<pre>if ( INSTALLED.PRODUCTID[0]==0 || PRODUCTID[0]==0 || INSTALLED.PRODUCTID[0]==PRODUCTID[0] ) &&
( INSTALLED.PRODUCTID[1]==0 || PRODUCTID[1]==0 || INSTALLED.PRODUCTID[1]==PRODUCTID[1] ) &&
( INSTALLED.PRODUCTID[2]==0 || PRODUCTID[2]==0 || INSTALLED.PRODUCTID[2]==PRODUCTID[2] ) &&
( INSTALLED.PRODUCTID[3]==0 || PRODUCTID[3]==0 || INSTALLED.PRODUCTID[3]==PRODUCTID[3] ) </pre>
Here is a list of the preserved product ID's:
<table><tr><td> </td><td>
<table>
<tr><td>0.0.0.0</td> <td>default Product ID (no product specified)</td></tr>
<tr><td>1.*.*.*</td> <td>may be used for experimental purposes</td></tr>
<tr><td>10.*.*.*</td> <td>used for ZTEX products</td></tr>
<tr><td>10.11.*.*</td> <td>ZTEX USB-FPGA-Module 1.2</td></tr>
<tr><td>10.12.*.*</td> <td>ZTEX USB-FPGA-Module 1.11</td></tr>
<tr><td>10.12.2.1..4</td> <td>NIT (http://www.niteurope.com/)</td></tr>
<tr><td>10.13.*.*</td> <td>ZTEX USB-FPGA-Module 1.15 (not 1.15y)</td></tr>
<tr><td>10.14.*.*</td> <td>ZTEX USB-FPGA-Module 1.15x</td></tr>
<tr><td>10.15.*.*</td> <td>ZTEX USB-FPGA-Module 1.15y</td></tr>
<tr><td>10.16.*.*</td> <td> ZTEX USB-FPGA-Module 2.16</td></tr>
<tr><td>10.17.*.*</td> <td>ZTEX USB-FPGA-Module 2.13</td></tr>
<tr><td>10.18.*.*</td> <td>ZTEX USB-FPGA-Module 2.01</td></tr>
<tr><td>10.19.*.*</td> <td>ZTEX USB-FPGA-Module 2.04</td></tr>
<tr><td>10.20.*.*</td> <td>ZTEX USB-Module 1.0</td></tr>
<tr><td>10.30.*.*</td> <td>ZTEX USB-XMEGA-Module 1.0</td></tr>
<tr><td>10.40.*.*</td> <td>ZTEX USB-FPGA-Module 2.02</td></tr>
<tr><td>10.41.*.*</td> <td>ZTEX USB-FPGA-Module 2.14</td></tr>
<tr><td>10.0.1.1</td> <td>ZTEX BTCMiner firmware</td></tr>
</table></td></tr></table>
Please contact us (<a href="http://www.ztex.de/contact.e.html">http://www.ztex.de/contact.e.html</a>) if you want to register or reserve a Product ID (range).
</td>
</tr>
<tr>
<td bgcolor="#ffffff" valign="top">FW_VERSION</td>
<td bgcolor="#ffffff" valign="top">10</td>
<td bgcolor="#ffffff" valign="top">1</td>
<td bgcolor="#ffffff" valign="top">May be used to specify the firmware version.</td>
</tr>
<tr>
<td bgcolor="#ffffff" valign="top">INTERFACE_VERSION</td>
<td bgcolor="#ffffff" valign="top">11</td>
<td bgcolor="#ffffff" valign="top">1</td>
<td bgcolor="#ffffff" valign="top">The interface version. This number specifies the protocol that is used for interfacing the host software. A description of interface version 1 can be found in <a href="../ztex/Ztex1v1.html" title="class in ztex"><code>Ztex1v1</code></a> </td>
</tr>
<tr>
<td bgcolor="#ffffff" valign="top">INTERFACE_CAPABILITIES</td>
<td bgcolor="#ffffff" valign="top">12</td>
<td bgcolor="#ffffff" valign="top">6</td>
<td bgcolor="#ffffff" valign="top">6 bytes, each bit represents a capability. If set, the capability is supported. A description of the capabilities of interface version 1 can be found in <a href="../ztex/Ztex1v1.html" title="class in ztex"><code>Ztex1v1</code></a> </td>
</tr>
<tr>
<td bgcolor="#ffffff" valign="top">MODULE_RESERVED</td>
<td bgcolor="#ffffff" valign="top">18</td>
<td bgcolor="#ffffff" valign="top">12</td>
<td bgcolor="#ffffff" valign="top">12 bytes for application specific use, i.e. they depend from the PRODUCT_ID </td>
</tr>
<tr>
<td bgcolor="#ffffff" valign="top">SN_STRING</td>
<td bgcolor="#ffffff" valign="top">30</td>
<td bgcolor="#ffffff" valign="top">10</td>
<td bgcolor="#ffffff" valign="top">A serial number string of 10 characters. The default SN is "0000000000"</td> </td>
</tr>
</table></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../ztex/Ztex1.html" title="class in ztex"><code>Ztex1</code></a>,
<a href="../ztex/Ztex1v1.html" title="class in ztex"><code>Ztex1v1</code></a>,
<a href="../ztex/ZtexScanBus1.html" title="class in ztex"><code>ZtexScanBus1</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#cypressProductIdBuggy">cypressProductIdBuggy</a></strong></code>
<div class="block">Product ID of buggy FX3 devices (datecode 1149)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#cypressProductIdFx2">cypressProductIdFx2</a></strong></code>
<div class="block">EZ-USB USB FX2 product ID: 0x8613</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#cypressProductIdFx3">cypressProductIdFx3</a></strong></code>
<div class="block">EZ-USB USB FX3 product ID: 0x00f3</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#cypressVendorId">cypressVendorId</a></strong></code>
<div class="block">Cypress vendor ID: 0x4b4</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#cypressVendorIdBuggy">cypressVendorIdBuggy</a></strong></code>
<div class="block">Vendor ID of buggy FX3 devices (datecode 1149)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#ztexProductId">ztexProductId</a></strong></code>
<div class="block">USB product ID for ZTEX devices that support ZTEX descriptor 1: 0x100.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#ztexProductIdMax">ztexProductIdMax</a></strong></code>
<div class="block">Largest USB product ID for ZTEX devices that support ZTEX descriptor 1: 0x1ff.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#ztexVendorId">ztexVendorId</a></strong></code>
<div class="block">ZTEX vendor ID: 0x221a</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../ztex/ZtexDevice1.html#ZtexDevice1(ztex.ZtexContext,%20org.usb4java.Device,%20int,%20int,%20boolean)">ZtexDevice1</a></strong>(<a href="../ztex/ZtexContext.html" title="class in ztex">ZtexContext</a> p_context,
org.usb4java.Device p_dev,
int pUsbVendorId,
int pUsbProductId,
boolean allowUnconfigured)</code>
<div class="block">Constructs an instance from a given USB device.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#byteArrayString(byte[])">byteArrayString</a></strong>(byte[] buf)</code>
<div class="block">Produces a nice string representation of an array of bytes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#compatible(int,%20int,%20int,%20int)">compatible</a></strong>(int productId0,
int productId1,
int productId2,
int productId3)</code>
<div class="block">Checks whether the given product ID is compatible to the device.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../ztex/ZtexContext.html" title="class in ztex">ZtexContext</a></code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#context()">context</a></strong>()</code>
<div class="block">Returns the USB context of the device.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.usb4java.Device</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#dev()">dev</a></strong>()</code>
<div class="block">Returns the USB device.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#finalize()">finalize</a></strong>()</code>
<div class="block">Releases all resources.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#fwVersion()">fwVersion</a></strong>()</code>
<div class="block">Returns the firmware version.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#fx3()">fx3</a></strong>()</code>
<div class="block">Returns true if device is an FX3</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#interfaceCapabilities()">interfaceCapabilities</a></strong>()</code>
<div class="block">Returns the interface capabilities (all 6 bytes).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#interfaceCapabilities(int)">interfaceCapabilities</a></strong>(int i)</code>
<div class="block">Returns byte i of the interface capabilities.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#interfaceCapabilities(int,%20int)">interfaceCapabilities</a></strong>(int i,
int j)</code>
<div class="block">Returns byte i, bit j of the interface capabilities.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#interfaceVersion()">interfaceVersion</a></strong>()</code>
<div class="block">Returns the interface version.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#manufacturerString()">manufacturerString</a></strong>()</code>
<div class="block">Returns the manufacturer string of the device.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#moduleReserved()">moduleReserved</a></strong>()</code>
<div class="block">Returns the application specific information (all 12 bytes).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#moduleReserved(int)">moduleReserved</a></strong>(int i)</code>
<div class="block">Returns byte i of the application specific information.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#name()">name</a></strong>()</code>
<div class="block">Returns a name that identifies the device.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#name(org.usb4java.Device)">name</a></strong>(org.usb4java.Device p_dev)</code>
<div class="block">Returns a name that identifies a device.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#productId()">productId</a></strong>()</code>
<div class="block">Returns the product ID (all 4 bytes).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#productId(int)">productId</a></strong>(int i)</code>
<div class="block">Returns byte i of the product ID.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#productString()">productString</a></strong>()</code>
<div class="block">Returns the product string of the device.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#ref()">ref</a></strong>()</code>
<div class="block">Increases reference counter.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#snString()">snString</a></strong>()</code>
<div class="block">Returns the serial number string of the device.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#toString()">toString</a></strong>()</code>
<div class="block">Returns a string representation if the device with a lot of useful information.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#unref()">unref</a></strong>()</code>
<div class="block">Decreases reference counter and rleases resources if 0 is reached.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#usbProductId()">usbProductId</a></strong>()</code>
<div class="block">Returns the USB product ID of the device.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#usbVendorId()">usbVendorId</a></strong>()</code>
<div class="block">Returns the USB vendor ID of the device.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexDevice1.html#valid()">valid</a></strong>()</code>
<div class="block">Returns true if ZTEX descriptor 1 is available.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="cypressVendorId">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cypressVendorId</h4>
<pre>public static final int cypressVendorId</pre>
<div class="block">Cypress vendor ID: 0x4b4</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#ztex.ZtexDevice1.cypressVendorId">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="cypressProductIdFx2">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cypressProductIdFx2</h4>
<pre>public static final int cypressProductIdFx2</pre>
<div class="block">EZ-USB USB FX2 product ID: 0x8613</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#ztex.ZtexDevice1.cypressProductIdFx2">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="cypressProductIdFx3">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cypressProductIdFx3</h4>
<pre>public static final int cypressProductIdFx3</pre>
<div class="block">EZ-USB USB FX3 product ID: 0x00f3</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#ztex.ZtexDevice1.cypressProductIdFx3">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="cypressVendorIdBuggy">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cypressVendorIdBuggy</h4>
<pre>public static final int cypressVendorIdBuggy</pre>
<div class="block">Vendor ID of buggy FX3 devices (datecode 1149)</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#ztex.ZtexDevice1.cypressVendorIdBuggy">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="cypressProductIdBuggy">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cypressProductIdBuggy</h4>
<pre>public static final int cypressProductIdBuggy</pre>
<div class="block">Product ID of buggy FX3 devices (datecode 1149)</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#ztex.ZtexDevice1.cypressProductIdBuggy">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="ztexVendorId">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ztexVendorId</h4>
<pre>public static final int ztexVendorId</pre>
<div class="block">ZTEX vendor ID: 0x221a</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#ztex.ZtexDevice1.ztexVendorId">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="ztexProductId">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ztexProductId</h4>
<pre>public static final int ztexProductId</pre>
<div class="block">USB product ID for ZTEX devices that support ZTEX descriptor 1: 0x100.
This product ID is intended for general purpose use and can be shared by all devices that base on ZTEX modules.
Different products are identified by a second product ID, namely the PRODUCT_ID field of the <a href="#descriptor"> ZTEX descriptor 1</a>.
<p>
Please read the <a href="http://www.ztex.de/firmware-kit/usb_ids.e.html">informations about USB vendor and product ID's</a>.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../ztex/ZtexDevice1.html#ztexProductIdMax"><code>ztexProductIdMax</code></a>,
<a href="../constant-values.html#ztex.ZtexDevice1.ztexProductId">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="ztexProductIdMax">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ztexProductIdMax</h4>
<pre>public static final int ztexProductIdMax</pre>
<div class="block">Largest USB product ID for ZTEX devices that support ZTEX descriptor 1: 0x1ff.
USB product ID's from <a href="../ztex/ZtexDevice1.html#ztexProductId"><code>ztexProductId</code></a>+1 to ztexProductIdMax (0x101 to 0x1ff) are reserved for ZTEX devices and allow to identify products without reading the ZTEX descriptor.
<p>
Please read the <a href="http://www.ztex.de/firmware-kit/usb_ids.e.html">informations about USB vendor and product ID's</a>.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../ztex/ZtexDevice1.html#ztexProductId"><code>ztexProductId</code></a>,
<a href="../constant-values.html#ztex.ZtexDevice1.ztexProductIdMax">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ZtexDevice1(ztex.ZtexContext, org.usb4java.Device, int, int, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ZtexDevice1</h4>
<pre>public ZtexDevice1(<a href="../ztex/ZtexContext.html" title="class in ztex">ZtexContext</a> p_context,
org.usb4java.Device p_dev,
int pUsbVendorId,
int pUsbProductId,
boolean allowUnconfigured)
throws <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a>,
<a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a>,
<a href="../ztex/DeviceNotSupportedException.html" title="class in ztex">DeviceNotSupportedException</a></pre>
<div class="block">Constructs an instance from a given USB device.<br>
If the given vendor and product id's match to the vendor and product id's of the given USB device,
the ZTEX descriptor 1 is attempted to read. If this fails, an <a href="../ztex/InvalidFirmwareException.html" title="class in ztex"><code>InvalidFirmwareException</code></a> is thrown.
To suppress this behavior (e.g. if the EZ-USB device is known to be unconfigured) the vendor and product id's
can be set to -1.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>p_context</code> - The USB context.</dd><dd><code>p_dev</code> - The USB device.</dd><dd><code>pUsbVendorId</code> - The given vendor ID.</dd><dd><code>pUsbProductId</code> - The given product ID.</dd><dd><code>allowUnconfigured</code> - If true, unconfigured devices are allowed.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - if an USB communication error occurs.</dd>
<dd><code><a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a></code> - if no valid ZTEX descriptor 1 is found.</dd>
<dd><code>DeviceNotSupported</code> - if the device has the wrong USB ID's.</dd>
<dd><code><a href="../ztex/DeviceNotSupportedException.html" title="class in ztex">DeviceNotSupportedException</a></code></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="byteArrayString(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>byteArrayString</h4>
<pre>public static java.lang.String byteArrayString(byte[] buf)</pre>
<div class="block">Produces a nice string representation of an array of bytes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buf</code> - A byte array.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a nice string</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<div class="block">Returns a string representation if the device with a lot of useful information.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a string representation if the device with a lot of useful information.</dd></dl>
</li>
</ul>
<a name="name(org.usb4java.Device)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre>public static java.lang.String name(org.usb4java.Device p_dev)</pre>
<div class="block">Returns a name that identifies a device.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>p_dev</code> - the device.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a name that identifies a device.</dd></dl>
</li>
</ul>
<a name="name()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre>public java.lang.String name()</pre>
<div class="block">Returns a name that identifies the device.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a name that identifies the device.</dd></dl>
</li>
</ul>
<a name="compatible(int, int, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compatible</h4>
<pre>public final boolean compatible(int productId0,
int productId1,
int productId2,
int productId3)</pre>
<div class="block">Checks whether the given product ID is compatible to the device.<br>
The given product ID is compatible
<pre>if ( this.productId(0)==0 || productId0<=0 || this.productId(0)==productId0 ) &&
( this.productId(0)==0 || productId1<=0 || this.productId(1)==productId1 ) &&
( this.productId(2)==0 || productId2<=0 || this.productId(2)==productId2 ) &&
( this.productId(3)==0 || productId3<=0 || this.productId(3)==productId3 ) </pre></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>productId0</code> - Byte 0 of the given product ID</dd><dd><code>productId1</code> - Byte 1 of the given product ID</dd><dd><code>productId2</code> - Byte 2 of the given product ID</dd><dd><code>productId3</code> - Byte 3 of the given product ID</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the given product ID is compatible</dd></dl>
</li>
</ul>
<a name="dev()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dev</h4>
<pre>public final org.usb4java.Device dev()</pre>
<div class="block">Returns the USB device.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the USB device.</dd></dl>
</li>
</ul>
<a name="context()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>context</h4>
<pre>public final <a href="../ztex/ZtexContext.html" title="class in ztex">ZtexContext</a> context()</pre>
<div class="block">Returns the USB context of the device.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the USB context of the device.</dd></dl>
</li>
</ul>
<a name="valid()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valid</h4>
<pre>public final boolean valid()</pre>
<div class="block">Returns true if ZTEX descriptor 1 is available.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if ZTEX descriptor 1 is available.</dd></dl>
</li>
</ul>
<a name="usbVendorId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>usbVendorId</h4>
<pre>public final int usbVendorId()</pre>
<div class="block">Returns the USB vendor ID of the device.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the USB vendor ID of the device.</dd></dl>
</li>
</ul>
<a name="usbProductId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>usbProductId</h4>
<pre>public final int usbProductId()</pre>
<div class="block">Returns the USB product ID of the device.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the USB product ID of the device.</dd></dl>
</li>
</ul>
<a name="manufacturerString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>manufacturerString</h4>
<pre>public final java.lang.String manufacturerString()</pre>
<div class="block">Returns the manufacturer string of the device.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the manufacturer string of the device.</dd></dl>
</li>
</ul>
<a name="productString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>productString</h4>
<pre>public final java.lang.String productString()</pre>
<div class="block">Returns the product string of the device.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the product string of the device.</dd></dl>
</li>
</ul>
<a name="snString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>snString</h4>
<pre>public final java.lang.String snString()</pre>
<div class="block">Returns the serial number string of the device.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the serial number string of the device.</dd></dl>
</li>
</ul>
<a name="productId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>productId</h4>
<pre>public final byte[] productId()</pre>
<div class="block">Returns the product ID (all 4 bytes).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>PRODUCT_ID, see above.</dd></dl>
</li>
</ul>
<a name="productId(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>productId</h4>
<pre>public int productId(int i)</pre>
<div class="block">Returns byte i of the product ID.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - index</dd>
<dt><span class="strong">Returns:</span></dt><dd>PRODUCT_ID[i], see above.</dd></dl>
</li>
</ul>
<a name="fwVersion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fwVersion</h4>
<pre>public final int fwVersion()</pre>
<div class="block">Returns the firmware version.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>FW_VERSION, see above.</dd></dl>
</li>
</ul>
<a name="interfaceVersion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>interfaceVersion</h4>
<pre>public final int interfaceVersion()</pre>
<div class="block">Returns the interface version.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>INTERFACE_VERSION, see above.</dd></dl>
</li>
</ul>
<a name="interfaceCapabilities()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>interfaceCapabilities</h4>
<pre>public final byte[] interfaceCapabilities()</pre>
<div class="block">Returns the interface capabilities (all 6 bytes).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>INTERFACE_CAPABILITIES, see above.</dd></dl>
</li>
</ul>
<a name="interfaceCapabilities(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>interfaceCapabilities</h4>
<pre>public final int interfaceCapabilities(int i)</pre>
<div class="block">Returns byte i of the interface capabilities.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - index</dd>
<dt><span class="strong">Returns:</span></dt><dd>INTERFACE_CAPABILITIES[i], see above.</dd></dl>
</li>
</ul>
<a name="interfaceCapabilities(int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>interfaceCapabilities</h4>
<pre>public final boolean interfaceCapabilities(int i,
int j)</pre>
<div class="block">Returns byte i, bit j of the interface capabilities.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - byte index</dd><dd><code>j</code> - bit index</dd>
<dt><span class="strong">Returns:</span></dt><dd>INTERFACE_CAPABILITIES[i].j, see above.</dd></dl>
</li>
</ul>
<a name="moduleReserved()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>moduleReserved</h4>
<pre>public final byte[] moduleReserved()</pre>
<div class="block">Returns the application specific information (all 12 bytes).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>MODULE_RESERVED, see above.</dd></dl>
</li>
</ul>
<a name="moduleReserved(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>moduleReserved</h4>
<pre>public final int moduleReserved(int i)</pre>
<div class="block">Returns byte i of the application specific information.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - index</dd>
<dt><span class="strong">Returns:</span></dt><dd>MODULE_RESERVED[i], see above.</dd></dl>
</li>
</ul>
<a name="fx3()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fx3</h4>
<pre>public final boolean fx3()</pre>
<div class="block">Returns true if device is an FX3</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if device is an FX3</dd></dl>
</li>
</ul>
<a name="ref()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ref</h4>
<pre>public void ref()
throws <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></pre>
<div class="block">Increases reference counter.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code></dd></dl>
</li>
</ul>
<a name="unref()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unref</h4>
<pre>public void unref()</pre>
<div class="block">Decreases reference counter and rleases resources if 0 is reached.</div>
</li>
</ul>
<a name="finalize()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>finalize</h4>
<pre>protected void finalize()
throws java.lang.Throwable</pre>
<div class="block">Releases all resources.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>finalize</code> in class <code>java.lang.Object</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.Throwable</code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../ztex/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../ztex/ZtexContext.html" title="class in ztex"><span class="strong">Prev Class</span></a></li>
<li><a href="../ztex/ZtexEventHandler.html" title="class in ztex"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?ztex/ZtexDevice1.html" target="_top">Frames</a></li>
<li><a href="ZtexDevice1.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>