Merge lp:~jeff-licquia/pystromo/saitek into lp:pystromo

[Jeff Licquia]

This branch pulls in the changes from Shane McCormack to support the Saitek Cyborg Command Unit gamepad (with some updates from me).

[Raumkraut (raumkraut)]

Thanks for bringing this to my attention, Jeff.
It's not going to get merged in though, as the features have been implemented in the wrong places:
- Parsing config files should be (and is!) done before an InputDevice is instantiated.
- Saving application-state information shouldn't really be done by the InputDevice either. And it's probably a bad idea to write config data every time an LED changes.
- Plus some nomenclature issues. :)

And I have to ask: why were some buttons renamed to "TRIGGER_HAPPY##", aside from the amusement factor? :)

review: Needs Information

[Jeff Licquia (jeff-licquia)]

On 11/23/2010 07:48 AM, Raumkraut wrote:
> Review: Needs Information
> Thanks for bringing this to my attention, Jeff.
> It's not going to get merged in though, as the features have been implemented in the wrong places:
> - Parsing config files should be (and is!) done before an InputDevice is instantiated.
> - Saving application-state information shouldn't really be done by the InputDevice either. And it's probably a bad idea to write config data every time an LED changes.
> - Plus some nomenclature issues. :)

OK. I'll refactor and resend. Any hints on the nomenclature issues?

> And I have to ask: why were some buttons renamed to "TRIGGER_HAPPY##", aside from the amusement factor? :)

It's from linux/input.h; here's the commit log for when this came in:

commit cf2f765f1896064e34c6f0f2ef896ff058dd5c06
Author: Jiri Kosina <email address hidden>
Date: Mon Jan 4 12:20:56 2010 +0100

     HID: handle joysticks with large number of buttons

     Current HID code doesn't properly handle HID joysticks which have
     larger number of buttons than what fits into current range reserved
     for BTN_JOYSTICK.

     One such joystick reported to not work properly is Saitek X52 Pro
     Flight System.

     We can't extend the range to fit more buttons in, because of backwards
     compatibility reasons.

     Therefore this patch introduces a new BTN_TRIGGER_HAPPY range, and
     uses these to map the buttons which are over BTN_JOYSTICK limit.

     Acked-by: Dmitry Torokhov <email address hidden> [for the
input.h part]
     Signed-off-by: Jiri Kosina <email address hidden>

[Raumkraut (raumkraut)]

Right, further clarification:
- The events to use as additional LEDs should be passed in to InputDevices on instantiation. Actually, it looks like the value is already implicitly passed in with the **params. (The **params were originally intended solely to identify the devices to match against, so 'leds' may be better as another argument, I'm not sure)
- The LED state should probably only be saved on exit, which I think just means moving that code to the end of pystromo-remap.py.
- Nomenclature:
- - saitek.map should be named more specifically for the device.
- - The location of the save-file should probably not be user-specified, but in constants.py. Following XDG probably means ~/.local/pystromo/{device-id}.state (because we're storing the "state" of the device). If there's no device-id available (I forget), "{vendor}:{product}.state" probably covers 99.99% of cases.
- - Plus any other variables named after device manufacturers. ;)
- - And if the Czech wants to go all TRIGGER_HAPPY, I guess we should let him. :)

Also: `print` statements should probably be removed/commented from anything in the 'lib' directory, once you're happy that it's working.

Phew! It probably took me more time to write that, than it will for you to refactor the code. :D

review: Needs Fixing

[lp:~jeff-licquia/pystromo/saitek]

66. By Jeff Licquia on 2011-01-30

First pass at refactoring according to suggestions from upstream.

Changes:

 - References to "saitek" in variable names purged.

 - Instead of configuring the saved state file, force it to a standard
   location (currently ~/.local/pystromo, set in constants.py), with a
   standard filename.

 - Instead of saving on every LED state change, save when pystromo-remap
   exits. State is also only saved if needed (i.e. we read state on startup
   and/or we detected a state change).

67. By Jeff Licquia on 2011-01-30

Include further changes in key mapping for LED "buttons".

68. By Jeff Licquia on 2011-01-30

Fix bug in InputDevice.save_state(), and remove debug statements.

69. By Jeff Licquia on 2011-01-30

Renamed sample file and gave it a better device ID.

70. By Jeff Licquia on 2011-01-30

Get rid of print statements in lib dir.

[Jeff Licquia (jeff-licquia)]

Hello again! Sorry for taking so long, but here's the refactored changes. I tried to do everything you asked for. Specifics:

> - The events to use as additional LEDs should be passed in to InputDevices on
> instantiation. Actually, it looks like the value is already implicitly passed
> in with the **params. (The **params were originally intended solely to
> identify the devices to match against, so 'leds' may be better as another
> argument, I'm not sure)

"leds" is now its own argument.

> - The LED state should probably only be saved on exit, which I think just
> means moving that code to the end of pystromo-remap.py.

Done, sorta. The save code was moved to its own method for InputDevice, which is called at the end of pystromo-remap.py.

> - Nomenclature:
> - - saitek.map should be named more specifically for the device.

Done.

> - - The location of the save-file should probably not be user-specified, but
> in constants.py. Following XDG probably means ~/.local/pystromo/{device-
> id}.state (because we're storing the "state" of the device). If there's no
> device-id available (I forget), "{vendor}:{product}.state" probably covers
> 99.99% of cases.

This is done exactly as requested.

> - - Plus any other variables named after device manufacturers. ;)

Think I got them all.

> - - And if the Czech wants to go all TRIGGER_HAPPY, I guess we should let him.
> :)

It turned out I needed to add a few more; the switch events moved along with some of the buttons.

> Also: `print` statements should probably be removed/commented from anything in
> the 'lib' directory, once you're happy that it's working.

Think I got them all.

Unmerged revisions

70. By Jeff Licquia on 2011-01-30

Get rid of print statements in lib dir.

69. By Jeff Licquia on 2011-01-30

Renamed sample file and gave it a better device ID.

68. By Jeff Licquia on 2011-01-30

Fix bug in InputDevice.save_state(), and remove debug statements.

67. By Jeff Licquia on 2011-01-30

Include further changes in key mapping for LED "buttons".

66. By Jeff Licquia on 2011-01-30

First pass at refactoring according to suggestions from upstream.

Changes:

 - References to "saitek" in variable names purged.

 - Instead of configuring the saved state file, force it to a standard
   location (currently ~/.local/pystromo, set in constants.py), with a
   standard filename.

 - Instead of saving on every LED state change, save when pystromo-remap
   exits. State is also only saved if needed (i.e. we read state on startup
   and/or we detected a state change).

65. By Jeff Licquia on 2010-11-21

Updated key constants for buttons F1-F4 and 21 on Saitek.

64. By Shane Mc Cormack on 2010-11-20

Pull in Saitek gamepad changes from Shane McCormack.

Original repo: git://git.soren.co.uk/shane/pystromo.git/

=== added file 'config/saitek-cyborg-cmdunit.map'
--- config/saitek-cyborg-cmdunit.map	1970-01-01 00:00:00 +0000
+++ config/saitek-cyborg-cmdunit.map	2011-01-30 05:34:10 +0000
@@ -0,0 +1,236 @@
+# Saitek Cyborg Command Unit gamepad
+[Device:saitek-cyborg-command-unit]
+vendor=0x06a3
+product=0x80c1
+leds=BTN_TRIGGER_HAPPY22, BTN_TRIGGER_HAPPY23, BTN_TRIGGER_HAPPY24
+
+################################################################################
+# Green                                                                        #
+################################################################################
+[map:saitek-cyborg-command-unit + BTN_TRIGGER_HAPPY22]
+### F1
+#BTN_TRIGGER_HAPPY17:
+### F2
+#BTN_TRIGGER_HAPPY18:
+### F3
+#BTN_TRIGGER_HAPPY19:
+### F4
+#BTN_TRIGGER_HAPPY20:
+
+### 1
+#BTN_TRIGGER:
+### W
+#BTN_THUMB:
+### 3
+#BTN_THUMB2:
+### 4
+#BTN_TOP:
+
+### A
+#BTN_TOP2:
+### S
+#BTN_PINKIE:
+### D
+#BTN_BASE:
+### 8
+#BTN_BASE2:
+
+### 9
+#BTN_BASE3:
+### 10
+#BTN_BASE4:
+### 11
+#BTN_BASE5:
+
+### 12
+#BTN_BASE6:
+### 13
+#BTN_7:
+### 14
+#BTN_8:
+
+### 15
+#BTN_DEAD2:
+### 16
+#BTN_DEAD:
+### 21
+#BTN_TRIGGER_HAPPY21:
+
+### X Axis
+#ABS_X:
+### Y Axis
+#ABS_Y:
+
+
+################################################################################
+# Yellow                                                                       #
+################################################################################
+[map:saitek-cyborg-command-unit + BTN_TRIGGER_HAPPY23]
+### F1
+#BTN_TRIGGER_HAPPY17:
+### F2
+#BTN_TRIGGER_HAPPY18:
+### F3
+#BTN_TRIGGER_HAPPY19:
+### F4
+#BTN_TRIGGER_HAPPY20:
+
+### 1
+#BTN_TRIGGER:
+### W
+#BTN_THUMB:
+### 3
+#BTN_THUMB2:
+### 4
+#BTN_TOP:
+
+### A
+#BTN_TOP2:
+### S
+#BTN_PINKIE:
+### D
+#BTN_BASE:
+### 8
+#BTN_BASE2:
+
+### 9
+#BTN_BASE3:
+### 10
+#BTN_BASE4:
+### 11
+#BTN_BASE5:
+
+### 12
+#BTN_BASE6:
+### 13
+#BTN_7:
+### 14
+#BTN_8:
+
+### 15
+#BTN_DEAD2:
+### 16
+#BTN_DEAD:
+### 21
+#BTN_TRIGGER_HAPPY21:
+
+### X Axis
+#ABS_X:
+### Y Axis
+#ABS_Y:
+
+
+################################################################################
+# Red                                                                          #
+################################################################################
+[map:saitek-cyborg-command-unit + BTN_TRIGGER_HAPPY24]
+### F1
+#BTN_TRIGGER_HAPPY17:
+### F2
+#BTN_TRIGGER_HAPPY18:
+### F3
+#BTN_TRIGGER_HAPPY19:
+### F4
+#BTN_TRIGGER_HAPPY20:
+
+### 1
+#BTN_TRIGGER:
+### W
+#BTN_THUMB:
+### 3
+#BTN_THUMB2:
+### 4
+#BTN_TOP:
+
+### A
+#BTN_TOP2:
+### S
+#BTN_PINKIE:
+### D
+#BTN_BASE:
+### 8
+#BTN_BASE2:
+
+### 9
+#BTN_BASE3:
+### 10
+#BTN_BASE4:
+### 11
+#BTN_BASE5:
+
+### 12
+#BTN_BASE6:
+### 13
+#BTN_7:
+### 14
+#BTN_8:
+
+### 15
+#BTN_DEAD2:
+### 16
+#BTN_DEAD:
+### 21
+#BTN_TRIGGER_HAPPY21:
+
+### X Axis
+#ABS_X:
+### Y Axis
+#ABS_Y:
+
+
+################################################################################
+# All                                                                          #
+################################################################################
+[map:saitek-cyborg-command-unit]
+### F1
+#BTN_TRIGGER_HAPPY17:
+### F2
+#BTN_TRIGGER_HAPPY18:
+### F3
+#BTN_TRIGGER_HAPPY19:
+### F4
+#BTN_TRIGGER_HAPPY20:
+
+### 1
+#BTN_TRIGGER:
+### W
+#BTN_THUMB:
+### 3
+#BTN_THUMB2:
+### 4
+#BTN_TOP:
+
+### A
+#BTN_TOP2:
+### S
+#BTN_PINKIE:
+### D
+#BTN_BASE:
+### 8
+#BTN_BASE2:
+
+### 9
+#BTN_BASE3:
+### 10
+#BTN_BASE4:
+### 11
+#BTN_BASE5:
+
+### 12
+#BTN_BASE6:
+### 13
+#BTN_7:
+### 14
+#BTN_8:
+
+### 15
+#BTN_DEAD2:
+### 16
+#BTN_DEAD:
+### 21
+#BTN_TRIGGER_HAPPY21:
+
+### X Axis
+#ABS_X:
+### Y Axis
+#ABS_Y:

=== modified file 'lib/constants.py'
--- lib/constants.py	2007-10-01 13:58:18 +0000
+++ lib/constants.py	2011-01-30 05:34:10 +0000
@@ -15,6 +15,10 @@
 # The first one which exists is the one which is used.
 UINPUT_DEVICES = ['/dev/uinput', '/dev/input/uinput', '/dev/misc/uinput']
 
+# Path to the device state file, if used.  This is relative to the home
+# directory.
+STATE_FILE_PATH = "~/.local/pystromo"
+
 
 
 ## I don't know any other bus values!
@@ -299,6 +303,9 @@
 				0x129: 'BTN_BASE4',
 				0x12a: 'BTN_BASE5',
 				0x12b: 'BTN_BASE6',
+				0x12c: 'BTN_BASE7',
+				0x12d: 'BTN_BASE8',
+				0x12e: 'BTN_DEAD2',
 				0x12f: 'BTN_DEAD',
 				0x130: 'BTN_A',
 				0x131: 'BTN_B',
@@ -326,6 +333,14 @@
 				0x14a: 'BTN_TOUCH',
 				0x14b: 'BTN_STYLUS',
 				0x14c: 'BTN_STYLUS2',
+				0x2d0: 'BTN_TRIGGER_HAPPY17',
+				0x2d1: 'BTN_TRIGGER_HAPPY18',
+				0x2d2: 'BTN_TRIGGER_HAPPY19',
+				0x2d3: 'BTN_TRIGGER_HAPPY20',
+				0x2d4: 'BTN_TRIGGER_HAPPY21',
+				0x2d5: 'BTN_TRIGGER_HAPPY22',
+				0x2d6: 'BTN_TRIGGER_HAPPY23',
+				0x2d7: 'BTN_TRIGGER_HAPPY24',
 				},
 		# EV_REL
 		0x02: {

=== modified file 'lib/devices.py'
--- lib/devices.py	2008-10-13 22:00:38 +0000
+++ lib/devices.py	2011-01-30 05:34:10 +0000
@@ -9,6 +9,8 @@
 import events
 import mapping
 import constants as const
+import ConfigParser
+import os
 
 # This is a list of all the devices which have been created.
 # We use this for the receive() function.
@@ -59,7 +61,7 @@
 	busy = property(fget=_getBusy)
 	
 	
-	def __init__ (self, keymap, id=None, output=None, **params):
+	def __init__ (self, keymap, id=None, output=None, leds=None, **params):
 		"""
 			If not specified, the id will be populated by the device's
 			detected 'name' parameter (if any).
@@ -90,9 +92,18 @@
 		# at the same time...
 		self._starting = set()
 		
+		# Some gamepads use button events to indicate the state of 
+		# a switch on the pad.  Instead of recording individual
+		# events, we should maintain an internal sense of the
+		# switch state which can be used in key definitions.
+		if leds:
+			self._switch_buttons = leds.replace(' ', '').split(',');
+		else:
+			self._switch_buttons = []
 		
 		# Do stuff with device nodes
-		nodes = ioctl.matchInputNodes (**params)
+		# nodes = ioctl.matchInputNodes (**params)
+		nodes = ioctl.matchInputNodes (vendor=params['vendor'], product=params['product'])
 		self._nodes = nodes
 		for node in nodes:
 			# Gimme gimme gimme!
@@ -129,7 +140,29 @@
 		# Shortcuts
 		self._remap = lambda chord, **kwargs: self.keymap.remap(chord, device=self.id, **kwargs)
 		self._inMap = lambda chord: self.keymap.deviceContains(chord, device=self.id)
-		
+
+		# State file?
+		self._led_state = None
+		self._state_fn = None
+		if self.id:
+			self._state_fn = self.id + ".state"
+		elif "vendor" in params and "product" in params:
+			self._state_fn = "%s:%s.state" % (params["vendor"], params["product"])
+
+		if self._state_fn:
+			state_path = os.path.expanduser(os.path.join(const.STATE_FILE_PATH, self._state_fn))
+			if os.path.exists(state_path):
+				savefile = ConfigParser.ConfigParser()
+				savefile.read(state_path)
+				if savefile.has_section('lastled'):
+					try:
+						stringCode = savefile.get('lastled', 'stringCode')
+						eventValue = savefile.get('lastled', 'eventValue')
+						self._led_state = (stringCode, eventValue)
+						key = mapping.Key(stringCode, eventValue, eventValue)
+						self._changeMode(key)
+					except KeyError:
+						pass
 	
 	def __repr__ (self):
 		params = (self.__class__.__name__, str(self.id), len(self._nodes))
@@ -141,6 +174,28 @@
 			Returns a list of all the device nodes associated with this object.
 		"""
 		return self._nodes
+
+
+	def save_state(self):
+		"""
+			Saves LED state for the device, if supported.
+		"""
+		if self._state_fn and self._led_state:
+			(stringCode, eventValue) = self._led_state
+			savefile = ConfigParser.ConfigParser()
+
+			state_dir = os.path.expanduser(const.STATE_FILE_PATH)
+			if not os.path.exists(state_dir):
+				os.makedirs(state_dir)
+
+			state_path = os.path.join(state_dir, self._state_fn)
+			if os.path.exists(state_path):
+				savefile.read(state_path)
+			if not savefile.has_section('lastled'):
+				savefile.add_section('lastled')
+			savefile.set('lastled', 'stringCode', stringCode)
+			savefile.set('lastled', 'eventValue', eventValue)
+			savefile.write(open(state_path, 'wb'));
 		
 	
 	def read (self, node=None):
@@ -188,7 +243,7 @@
 					events.append(event)
 				
 				bytesToRead = eventSize
-				data = ''
+				data = ""
 				
 			
 		return events
@@ -208,6 +263,12 @@
 			## Most likely a SYN packet. We see a lot of those.
 			return False
 		
+		# Some game pads send BTN events for a change in LED mode
+		# instead of EV_LED events, handle that nicely here if the
+		# appropriate config settings are set.
+		if (event.type == const.EV_KEY and stringCode in self._switch_buttons):
+			event.type = const.EV_LED
+		
 		if event.type == const.EV_KEY and self._inMap(key):
 			if event.value == const.KEYDOWN:
 				self._startEvent (key)
@@ -239,8 +300,11 @@
 				
 			
 		elif event.type == const.EV_LED:
-			# We've received a notification of a change in LED status
-			self._changeMode (key)
+			# Change in LED status
+			if event.value == const.KEYDOWN:
+				self._led_state = (stringCode, event.value)
+			self._changeMode(key)
+			
 			
 		else:
 			# Don't have any specific rules for this type
@@ -258,7 +322,6 @@
 		if cycle not in queue:
 			queue[cycle] = cycle.getIter()
 		
-	
 	def _startEvent (self, key, modes=None):
 		"""
 			Starts whatever needs to be started with the additional

=== modified file 'pystromo-remap.py'
--- pystromo-remap.py	2008-10-13 22:00:38 +0000
+++ pystromo-remap.py	2011-01-30 05:34:10 +0000
@@ -211,7 +211,10 @@
 		# End the loop only if all the devices have finished.
 		if not len(busyDevices):
 			looping = False
-	
+
+# Save our state, if needed
+for device in inputs:
+	device.save_state()
 
 # Destroy and close our output
 output.close()