mirror of https://github.com/nirenjan/libx52.git
114 lines
5.2 KiB
HTML
114 lines
5.2 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>libx52: Saitek X52/X52Pro drivers for Linux/Unix</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">libx52
|
|
 <span id="projectnumber">0.2.3</span>
|
|
</div>
|
|
<div id="projectbrief">Saitek X52/X52Pro drivers for Linux/Unix</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="PageDoc"><div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Saitek X52/X52Pro drivers for Linux/Unix </div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><h1><a class="anchor" id="intro"></a>
|
|
Introduction</h1>
|
|
<p>libx52 is an open source library that allows you to communicate with a Saitek X52 or Saitek X52Pro joystick on Linux and Unix machines. Saitek only provides Windows drivers for their joysticks, necessitating the need for this project for users to be able to control the LEDs and MFD text on a Linux or Unix device.</p>
|
|
<h1><a class="anchor" id="start"></a>
|
|
Getting Started</h1>
|
|
<h2><a class="anchor" id="install"></a>
|
|
Installation</h2>
|
|
<p>libx52 is available on Ubuntu as a PPA. Follow the instructions below to install on Ubuntu:</p>
|
|
<div class="fragment"><div class="line">sudo add-apt-repository nirenjan:x52pro-linux</div>
|
|
<div class="line">sudo apt update</div>
|
|
<div class="line">sudo apt install -y libx52-1</div>
|
|
</div><!-- fragment --><h2><a class="anchor" id="building"></a>
|
|
Building from source</h2>
|
|
<p>Please follow the instructions in <a href="https://github.com/nirenjan/x52pro-linux/blob/master/INSTALL.md">INSTALL.md</a> specific to your system to build from source.</p>
|
|
<h1><a class="anchor" id="features"></a>
|
|
Features</h1>
|
|
<p>libx52 supports setting the following parameters on the joystick</p>
|
|
<ol type="1">
|
|
<li>Text on the multifunction display (MFD).</li>
|
|
<li>All 3 clocks on the MFD.</li>
|
|
<li>Date display on the MFD.</li>
|
|
<li>Blinking of the POV hat and clutch LEDs (both blinking or not).</li>
|
|
<li>Shift indicator on the MFD.</li>
|
|
<li>Setting the color of the individual LEDs (<em>X52 Pro only</em>).</li>
|
|
</ol>
|
|
<h1><a class="anchor" id="api"></a>
|
|
Application Programming Interface</h1>
|
|
<p>See the <a class="el" href="libx52_integration.html">Integration</a> page for details on how to integrate libx52 with your application.</p>
|
|
<p>See the documentation for the following files for a complete list of all functions.</p>
|
|
<ul>
|
|
<li><a class="el" href="libx52_8h.html" title="Functions, structures and enumerations for the Saitek X52 MFD & LED driver library.">libx52.h</a></li>
|
|
<li><a class="el" href="libx52io_8h.html" title="Functions, structures and enumerations for the Saitek X52 IO driver library.">libx52io.h</a></li>
|
|
<li><a class="el" href="libx52util_8h.html" title="Utility functions for the Saitek X52 MFD & LED driver library.">libx52util.h</a> </li>
|
|
</ul>
|
|
</div></div><!-- PageDoc -->
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|