index.html

<!DOCTYPE html>
<!--
 | Generated by Apache Maven Doxia Site Renderer 1.8.1 from src/site/xdoc/index.xml.vm at 2018-10-21
 | Rendered using Apache Maven Fluido Skin 1.7
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <meta name="Date-Revision-yyyymmdd" content="20181021" />
    <meta http-equiv="Content-Language" content="en" />
    <title>usb4java &#x2013; About</title>
    <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
    <link rel="stylesheet" href="./css/site.css" />
    <link rel="stylesheet" href="./css/print.css" media="print" />
    <script type="text/javascript" src="./js/apache-maven-fluido-1.7.min.js"></script>
<link href="favicon.ico" rel="SHORTCUT ICON" />
  </head>
  <body class="topBarDisabled">
    <a href="https://github.com/usb4java">
      <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
        src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"
        alt="Fork me on GitHub">
    </a>
    <div class="container-fluid">
      <div id="banner">
        <div class="pull-left"><a href="./" id="bannerLeft"><img src="images/logo.png"  alt="usb4java"/></a></div>
        <div class="pull-right"></div>
        <div class="clear"><hr/></div>
      </div>

      <div id="breadcrumbs">
        <ul class="breadcrumb">
        <li id="publishDate">Last Published: 2018-10-21<span class="divider">|</span>
</li>
          <li id="projectVersion">Version: 1.3.0<span class="divider">|</span></li>
      <li class=""><a href="./" title="usb4java">usb4java</a><span class="divider">/</span></li>
    <li class="active ">About</li>
      <li class="pull-right"><span class="divider">|</span>
<a href="http://libusb.info/" class="externalLink" title="libusb">libusb</a></li>
      <li class="pull-right"><a href="http://javax-usb.sourceforge.net/" class="externalLink" title="javax-usb">javax-usb</a></li>
        </ul>
      </div>
      <div class="row-fluid">
        <div id="leftColumn" class="span2">
          <div class="well sidebar-nav">
    <ul class="nav nav-list">
      <li class="nav-header">usb4java</li>
    <li class="active"><a href="#"><span class="none"></span>About</a></li>
    <li><a href="quickstart/index.html" title="Quick start"><span class="icon-chevron-right"></span>Quick start</a></li>
    <li><a href="faq.html" title="FAQ"><span class="none"></span>FAQ</a></li>
    <li><a href="configuration.html" title="Configuration"><span class="none"></span>Configuration</a></li>
    <li><a href="nativelibs.html" title="Native libs"><span class="none"></span>Native libs</a></li>
      <li class="nav-header">Project Documentation</li>
    <li><a href="project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a></li>
    <li><a href="project-reports.html" title="Project Reports"><span class="icon-chevron-right"></span>Project Reports</a></li>
</ul>
          <hr />
          <div id="poweredBy">
            <div class="clear"></div>
            <div class="clear"></div>
            <div class="clear"></div>
            <div class="clear"></div>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
            </div>
          </div>
        </div>
        <div id="bodyColumn"  class="span10" >

  
    <div class="section">
<h2><a name="What_is_usb4java.3F"></a>What is usb4java?</h2>
      
<p>
        usb4java is a Java library to access USB devices. It is based on
        the native <a class="externalLink" href="http://libusb.info/">libusb 1.0</a> library
        and uses Java NIO buffers for data exchange between libusb and Java.
        usb4java also supports the
        <a class="externalLink" href="http://javax-usb.sourceforge.net/">javax-usb standard (JSR-80)</a>
        through the <a href="usb4java-javax/">usb4java-javax extension</a>.
      </p>
      
<p>
        Supported platforms are <b>Linux</b> (x86 32/64 bit, ARM 32/64 bit),
        <b>OS X</b> (x86 64 bit) and
        <b>Windows</b> (x86 32/64 bit). But other platforms may work
        as well (as long as they have at least Java 6 and are supported by
        libusb) by compiling the JNI library manually.
      </p>
    </div>

    
<div class="section">
<h2><a name="Download"></a>Download</h2>
      
<ul class="download">
        
<li>
          <a class="externalLink" href="https://github.com/usb4java/usb4java/releases">usb4java</a> (Main library)
        </li>
        
<li>
          <a class="externalLink" href="https://github.com/usb4java/usb4java-javax/releases">usb4java-javax</a> (javax-usb extension)
        </li>
      </ul>
    </div>

    
<div class="section">
<h2><a name="Maven"></a>Maven</h2>
      
<p>
        When you are using Maven then you can add the necessary dependencies
        like this:
      </p>
      
<div class="source">
<div>
<pre>&lt;-- For using just usb4java without javax-usb --&gt;
&lt;dependencies&gt;
  &lt;dependency&gt;
    &lt;groupId&gt;org.usb4java&lt;/groupId&gt;
    &lt;artifactId&gt;usb4java&lt;/artifactId&gt;
    &lt;version&gt;1.3.0&lt;/version&gt;
  &lt;/dependency&gt;
&lt;/dependencies&gt;

&lt;-- For using usb4java with javax-usb --&gt;
&lt;dependencies&gt;
  &lt;dependency&gt;
    &lt;groupId&gt;org.usb4java&lt;/groupId&gt;
    &lt;artifactId&gt;usb4java-javax&lt;/artifactId&gt;
    &lt;version&gt;1.3.0&lt;/version&gt;
  &lt;/dependency&gt;
&lt;/dependencies&gt;</pre></div></div>
    </div>

    
<div class="section">
<h2><a name="License"></a>License</h2>
      
<p>
        Copyright (C) 2011 Klaus Reimer, k@ailis.de<br />
        Copyright (C) 2013 Luca Longinotti, l@longi.li
      </p>

      
<p>
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the &quot;Software&quot;), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
      </p>
      
<p>
        The above copyright notice and this permission notice shall be included in
        all copies or substantial portions of the Software.
      </p>
      
<p>
        THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
        THE SOFTWARE.
      </p>
    </div>

    
<div class="section">
<h2><a name="Getting_started"></a>Getting started</h2>
      
<p>
        Read the <a href="quickstart/index.html">quick start guide</a> and the
        <a href="faq.html">FAQ</a>. There are also some
        <a class="externalLink" href="https://github.com/usb4java/usb4java-examples/">low-level (libusb) examples</a>
        and
        <a class="externalLink" href="https://github.com/usb4java/usb4java-javax-examples/">high-level (javax-usb) examples</a>
        available.
      </p>
    </div>

    
<div class="section">
<h2><a name="Support"></a>Support</h2>
      
<p>
        For questions and discussions please use the
        <a class="externalLink" href="mailto:usb4java@googlegroups.com">usb4java mailing list</a>
        (<a class="externalLink" href="http://groups.google.com/group/usb4java">Google group</a>).
        You can subscribe to it via email by sending a mail to
        <a class="externalLink" href="mailto:usb4java+subscribe@googlegroups.com">usb4java+subscribe@googlegroups.com</a>.
      </p>
      
<p>
        If you have found a bug in the software or this
        web site (even if it's just a typo) then please create
        an <a class="externalLink" href="https://github.com/usb4java/usb4java/issues">issue on GitHub</a>.
      </p>
    </div>
  

        </div>
      </div>
    </div>
    <hr/>
    <footer>
      <div class="container-fluid">
        <div class="row-fluid">
            <p>Copyright &copy;2011&#x2013;2018
<a href="http://usb4java.org/">usb4java Team</a>.
All rights reserved.</p>
        </div>
      </div>
    </footer>
  </body>
</html>