From e83e8d1506cb4a6a6a2feaf1764d0a138f0fdf09 Mon Sep 17 00:00:00 2001
From: nirenjan <nirenjan@gmail.com>
Date: Thu, 8 Nov 2012 21:30:10 -0800
Subject: [PATCH] Create gh-pages branch via GitHub

---
 index.html  | 38 +++++++++++++++++++++++++++++---------
 params.json |  2 +-
 2 files changed, 30 insertions(+), 10 deletions(-)

diff --git a/index.html b/index.html
index 7a83f7f..c46d438 100644
--- a/index.html
+++ b/index.html
@@ -30,6 +30,8 @@
       <section>
         <h1>Saitek X52Pro joystick driver for Linux</h1>
 
+<h2>Overview</h2>
+
 <p>This project adds a new driver for the Saitek/MadCatz X52 Pro flight
 control system. The X52 pro is a HOTAS (hand on throttle and stick)
 with 7 axes, 39 buttons, 1 hat and 1 thumbstick and a multi-function
@@ -38,19 +40,37 @@ display which is programmable.</p>
 <p>Currently, only Windows drivers are available from Saitek PLC, which
 led me to develop a new Linux driver which can program the MFD and
 the individual LEDs on the joystick. Although the standard usbhid
-driver is capable of reading the joystick, it is not sufficient to
+driver is quite capable of reading the joystick, it is not sufficient to
 really utilize all the capabilities of this system.</p>
 
-<p>This project is currently a work-in-progress. However a high level
-outline of the current objectives are listed below:</p>
+<h2>Status</h2>
+
+<p>This page documents the objectives of the project and the status. This project is currently a work-in-progress.</p>
+
+<h3>Kernel Module</h3>
+
+<p>Currently, a kernel module exists which supports reading from the joystick and reporting to the input subsystem. The kernel module also supports setting the following:</p>
 
 <ul>
-<li>Write a kernel module and export sysfs interfaces to act as a
-driver.</li>
-<li>Write a userspace program that can configure the kernel module
-and create custom button mappings to keyboard or mouse events.</li>
-<li>Add interrupt handling and export a /dev/input/jsX interface.</li>
-<li>Allow userspace programs to register callbacks on MFD button events.</li>
+<li>MFD brightness</li>
+<li>LED brightness</li>
+<li>LED state for all 20 LEDs</li>
+<li>MFD text for all 3 lines</li>
+</ul><p>Pending are the following:</p>
+
+<ul>
+<li>Clock (Date/Time) on the MFD</li>
+<li>LED blinking mode</li>
+<li>Shift indicator on the MFD</li>
+</ul><h3>Userspace Daemon</h3>
+
+<p>In progress is a userspace daemon which hooks to the hidraw interface of the standard usbhid driver and interprets the hidraw data. Objectives for this daemon are:</p>
+
+<ul>
+<li>Create a uinput driver which will send keyboard and mouse events to the input subsystem.</li>
+<li>Create an output driver which will update the LEDs and MFD on the joystick.</li>
+<li>Create an API which will allow plugins to communicate with the daemon and update the joystick.</li>
+<li>Create an API which will allow customizing the keyboard and mouse event mapping.</li>
 </ul>
       </section>
       <footer>
diff --git a/params.json b/params.json
index 0b42192..0b5f000 100644
--- a/params.json
+++ b/params.json
@@ -1 +1 @@
-{"note":"Don't delete this file! It's used internally to help with page regeneration.","name":"X52Pro-Linux","tagline":"Saitek X52Pro drivers & controller mapping software for Linux","body":"Saitek X52Pro joystick driver for Linux\r\n=======================================\r\n\r\nThis project adds a new driver for the Saitek/MadCatz X52 Pro flight\r\ncontrol system. The X52 pro is a HOTAS (hand on throttle and stick)\r\nwith 7 axes, 39 buttons, 1 hat and 1 thumbstick and a multi-function\r\ndisplay which is programmable.\r\n\r\nCurrently, only Windows drivers are available from Saitek PLC, which\r\nled me to develop a new Linux driver which can program the MFD and\r\nthe individual LEDs on the joystick. Although the standard usbhid\r\ndriver is capable of reading the joystick, it is not sufficient to\r\nreally utilize all the capabilities of this system.\r\n\r\nThis project is currently a work-in-progress. However a high level\r\noutline of the current objectives are listed below:\r\n\r\n* Write a kernel module and export sysfs interfaces to act as a\r\ndriver.\r\n* Write a userspace program that can configure the kernel module\r\nand create custom button mappings to keyboard or mouse events.\r\n* Add interrupt handling and export a /dev/input/jsX interface.\r\n* Allow userspace programs to register callbacks on MFD button events.","google":""}
\ No newline at end of file
+{"tagline":"Saitek X52Pro drivers & controller mapping software for Linux","name":"X52Pro-Linux","body":"# Saitek X52Pro joystick driver for Linux\r\n\r\n## Overview\r\n\r\nThis project adds a new driver for the Saitek/MadCatz X52 Pro flight\r\ncontrol system. The X52 pro is a HOTAS (hand on throttle and stick)\r\nwith 7 axes, 39 buttons, 1 hat and 1 thumbstick and a multi-function\r\ndisplay which is programmable.\r\n\r\nCurrently, only Windows drivers are available from Saitek PLC, which\r\nled me to develop a new Linux driver which can program the MFD and\r\nthe individual LEDs on the joystick. Although the standard usbhid\r\ndriver is quite capable of reading the joystick, it is not sufficient to\r\nreally utilize all the capabilities of this system.\r\n\r\n## Status\r\nThis page documents the objectives of the project and the status. This project is currently a work-in-progress.\r\n\r\n### Kernel Module\r\n\r\nCurrently, a kernel module exists which supports reading from the joystick and reporting to the input subsystem. The kernel module also supports setting the following:\r\n\r\n* MFD brightness\r\n* LED brightness\r\n* LED state for all 20 LEDs\r\n* MFD text for all 3 lines\r\n\r\nPending are the following:\r\n* Clock (Date/Time) on the MFD\r\n* LED blinking mode\r\n* Shift indicator on the MFD\r\n\r\n### Userspace Daemon\r\n\r\nIn progress is a userspace daemon which hooks to the hidraw interface of the standard usbhid driver and interprets the hidraw data. Objectives for this daemon are:\r\n\r\n* Create a uinput driver which will send keyboard and mouse events to the input subsystem.\r\n* Create an output driver which will update the LEDs and MFD on the joystick.\r\n* Create an API which will allow plugins to communicate with the daemon and update the joystick.\r\n* Create an API which will allow customizing the keyboard and mouse event mapping.","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}
\ No newline at end of file