mirror
/
libx52
mirror of https://github.com/nirenjan/libx52.git
1
0
Fork 0
Code Releases Wiki Activity

deploy: f51985dd20

gh-pages
nirenjan 2021-09-29 04:29:06 +00:00
parent 3c2445abdc
commit ad6b69a23f
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
index.html
View File

@ -70,12 +70,19 @@ $(function() {
<div class="textblock"><h1><a class="anchor" id="intro"></a> <div class="textblock"><h1><a class="anchor" id="intro"></a>
Introduction</h1> 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> <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>
<p>This documentation is intended for application developers who wish to use the features of this library to communicate with supported devices.</p>
<h1><a class="anchor" id="start"></a> <h1><a class="anchor" id="start"></a>
Getting Started</h1> Getting Started</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> <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> <h1><a class="anchor" id="features"></a>
Library Features</h1> Features</h1>
<p>libx52 supports setting the following parameters on the joystick</p> <p>libx52 supports setting the following parameters on the joystick</p>
<ol type="1"> <ol type="1">
<li>Text on the multifunction display (MFD).</li> <li>Text on the multifunction display (MFD).</li>
@ -83,10 +90,11 @@ Library Features</h1>
<li>Date display 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>Blinking of the POV hat and clutch LEDs (both blinking or not).</li>
<li>Shift indicator on the MFD.</li> <li>Shift indicator on the MFD.</li>
<li>Setting the color of the individual LEDs (<em>on the X52 Pro only</em>).</li> <li>Setting the color of the individual LEDs (<em>X52 Pro only</em>).</li>
</ol> </ol>
<h1><a class="anchor" id="api"></a> <h1><a class="anchor" id="api"></a>
Application Programming Interface</h1> 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> <p>See the documentation for the following files for a complete list of all functions.</p>
<ul> <ul>
<li><a class="el" href="libx52_8h.html" title="Functions, structures and enumerations for the Saitek X52 MFD &amp; LED driver library.">libx52.h</a></li> <li><a class="el" href="libx52_8h.html" title="Functions, structures and enumerations for the Saitek X52 MFD &amp; LED driver library.">libx52.h</a></li>