mirror of https://github.com/nirenjan/libx52.git
53 lines
1.5 KiB
Plaintext
53 lines
1.5 KiB
Plaintext
/**
|
|
@mainpage Saitek X52/X52Pro drivers for Linux/Unix
|
|
|
|
@section intro Introduction
|
|
|
|
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.
|
|
|
|
@section start Getting Started
|
|
|
|
@subsection install Installation
|
|
|
|
libx52 is available on Ubuntu as a PPA. Follow the instructions below to
|
|
install on Ubuntu:
|
|
|
|
@code{.unparsed}
|
|
sudo add-apt-repository nirenjan:libx52
|
|
sudo apt update
|
|
sudo apt install -y libx52-1
|
|
@endcode
|
|
|
|
@subsection building Building from source
|
|
|
|
Please follow the instructions in [INSTALL.md](https://github.com/nirenjan/libx52/blob/master/INSTALL.md) specific to your system to build from source.
|
|
|
|
@section features Features
|
|
|
|
libx52 supports setting the following parameters on the joystick
|
|
|
|
1. Text on the multifunction display (MFD).
|
|
2. All 3 clocks on the MFD.
|
|
4. Date display on the MFD.
|
|
5. Blinking of the POV hat and clutch LEDs (both blinking or not).
|
|
6. Shift indicator on the MFD.
|
|
7. Setting the color of the individual LEDs (*X52 Pro only*).
|
|
|
|
@section api Application Programming Interface
|
|
|
|
See the @ref libx52_integration page for details on how to integrate libx52
|
|
with your application.
|
|
|
|
See the documentation for the following files for a complete list of all
|
|
functions.
|
|
|
|
- libx52.h
|
|
- libx52io.h
|
|
- libx52util.h
|
|
|
|
*/
|