added MF64 LED-mode for LedCtrlXY; added demo

Author: FMMT666

README.md

@@ -112,6 +112,9 @@ Successfully tested with Ubuntu 18.04-LTS+. Requires compiling your own PyGame t
     - added MF64 LED-mode settings: brightness, toggling, flashing and animation settings
     - updated MF64 LedCtrlRaw() to accept LED-mode settings
     - updated MF64 LedAllOn() to optionally accept LED-mode settings
+    - updated MF64 LedCtrlXY() to optionally accept LED-mode settings
+    - added MF64 "constants" for easier LED-mode settings
+    - added MF64 LED-mode example file "midifighter_led_modes.py"
 
 
 ### CHANGES 2020/05/XX:
@@ -2272,6 +2275,28 @@ There is no possibility to control the RGB LEDs individually.
 ---
 ## Detailed description of Midi Fighter specific methods
 
+### Constants
+
+#### LED Modes
+
+    The following constants can be used instead of using integer values for the LED modes.
+
+        MODE_BRIGHT[0..15]  instead of  18..33  for brightness
+        MODE_TOGGLE[0..7]   instead of  34..41  for toggling
+        MODE_PULSE[0..7]    instead of  42..49  for pulsing
+        MODE_ANIM_SQUARE    instead of  50
+        MODE_ANIM_CIRCLE    instead of  51
+        MODE_ANIM_STAR      instead of  52
+        MODE_ANIM_TRIANGLE  instead of  53
+
+    Some examples:
+      lp.LedAllOn( 5, 18 )  becomes lp.LedAllOn( 5, lp.MODE_BRIGHT[0] );  LED RED BUT OFF
+      lp.LedAllOn( 5, 33 )  becomes lp.LedAllOn( 5, lp.MODE_BRIGHT[15] ); LED RED FULLY ON
+      lp.LedAllOn( 5, 33 )  becomes lp.LedAllOn( 5, lp.MODE_BRIGHT[15] ); LED RED FULLY ON
+
+    Accessing "out of bounds" list values will of course crash your app.
+
+
 ### ButtonStateRaw()
 
     Returns the state of the buttons in RAW mode.
@@ -2318,6 +2343,17 @@ There is no possibility to control the RGB LEDs individually.
         (*) This might be an error in the manual, as it does not contain an 1/4 setting
             and starts at 1/32. Need to check ...
 
+      As an alternative and instead of using the numbers above, these constants can be used.
+      E.g. "LedAllOn( 5, lp.MODE_BRIGHT[5] )" for an intensity value of 5, from 0..15
+
+        MODE_BRIGHT[0..15]
+        MODE_TOGGLE[0..7]
+        MODE_PULSE[0..7]
+        MODE_ANIM_SQUARE
+        MODE_ANIM_CIRCLE
+        MODE_ANIM_STAR
+        MODE_ANIM_TRIANGLE
+
       PARAMS: <led>         36..99; number of the LED to control
               <colorcode>   0..127; color code
               <mode>        [OPTIONAL] 18..53, see above
@@ -2341,6 +2377,17 @@ There is no possibility to control the RGB LEDs individually.
         (*) This might be an error in the manual, as it does not contain an 1/4 setting
             and starts at 1/32. Need to check ...
 
+      As an alternative and instead of using the numbers above, these constants can be used.
+      E.g. "LedAllOn( 5, lp.MODE_BRIGHT[5] )" for an intensity value of 5, from 0..15
+
+        MODE_BRIGHT[0..15]
+        MODE_TOGGLE[0..7]
+        MODE_PULSE[0..7]
+        MODE_ANIM_SQUARE
+        MODE_ANIM_CIRCLE
+        MODE_ANIM_STAR
+        MODE_ANIM_TRIANGLE
+
       PARAMS: <led>         36..99; number of the LED to control
               <mode>        18..53; see above
       RETURN:
@@ -2426,6 +2473,17 @@ There is no possibility to control the RGB LEDs individually.
         (*) This might be an error in the manual, as it does not contain an 1/4 setting
             and starts at 1/32. Need to check ...
 
+      As an alternative and instead of using the numbers above, these constants can be used.
+      E.g. "LedAllOn( 5, lp.MODE_BRIGHT[5] )" for an intensity value of 5, from 0..15
+
+        MODE_BRIGHT[0..15]
+        MODE_TOGGLE[0..7]
+        MODE_PULSE[0..7]
+        MODE_ANIM_SQUARE
+        MODE_ANIM_CIRCLE
+        MODE_ANIM_STAR
+        MODE_ANIM_TRIANGLE
+
       PARAMS: <colorcode>   0..127; color code
       RETURN:
 

examples/.gitignore

@@ -10,6 +10,7 @@
 !launchpad_pressure.py
 !launchpad_pro_mk3_reset.py
 !midifighter_text.py
+!midifighter_led_modes.py
 !midi_events.py
 !buttons_raw.py
 !buttons_xy.py

examples/midifighter_led_modes.py

@@ -0,0 +1,86 @@
+#!/usr/bin/env python
+#
+# Just a quick LED mode example.
+# Works with Midi Figther 64
+# 
+#
+# FMMT666(ASkr) 7/2013..8/2020
+# www.askrprojects.net
+#
+
+import sys
+import random
+from pygame import time
+
+
+try:
+	import launchpad_py as launchpad
+except ImportError:
+	try:
+		import launchpad
+	except ImportError:
+		sys.exit("error loading launchpad.py")
+
+
+def main():
+
+	mode = None
+
+	if launchpad.MidiFighter64().Check( 0 ):
+		lp = launchpad.MidiFighter64()
+		if lp.Open( 0 ):
+			print("Midi Fighter 64")
+			mode = "F64"
+
+	if mode is None:
+		print("Did not find any devices, meh...")
+		return
+
+
+	# all red but off
+	for x in range(8):
+		for y in range(8):
+
+			# Additionally there are these vars which can be used to change the animation:
+			#   MODE_SQUARE
+			#   MODE_CIRCLE
+			#   MODE_STAR
+			#   MODE_TRIANGLE
+
+			# using if/elifs for better visibility:
+
+			# --- BRIGHTNESS 0..15
+			if   y == 0:
+				color = 5
+				mode = lp.MODE_BRIGHT[1]
+			elif y == 1:
+				mode = lp.MODE_BRIGHT[5]
+			elif y == 2:
+				mode = lp.MODE_BRIGHT[10]
+			elif y == 3:
+				mode = lp.MODE_BRIGHT[15]
+			# --- TOGGLING 0..7
+			elif y == 4:
+				color = 25
+				mode = lp.MODE_TOGGLE[4]
+			elif y == 5:
+				mode = lp.MODE_TOGGLE[x]
+			# --- PULSING 0..7
+			elif y == 6:
+				color = 78
+				mode = lp.MODE_PULSE[5]
+			elif y == 7:
+				mode = lp.MODE_PULSE[x]
+
+			lp.LedCtrlXY( x, y, color, mode )
+
+
+	print("bye ...")
+
+	lp.Reset() # turn all LEDs off
+	lp.Close() # close the Launchpad (will quit with an error due to a PyGame bug)
+
+	
+if __name__ == '__main__':
+	main()
+

launchpad_py/launchpad.py

@@ -2842,6 +2842,23 @@ class MidiFighter64( LaunchpadBase ):
 	#
 
 
+	#-------------------------------------------------------------------------------------
+	#-- Add some LED mode "constants" for better usability.
+	#-------------------------------------------------------------------------------------
+	def __init__( self ):
+
+		self.MODE_BRIGHT        = [ i+18 for i in range(16) ]
+		self.MODE_TOGGLE        = [ i+34 for i in range(8) ]
+		self.MODE_PULSE         = [ i+42 for i in range(8) ]
+		self.MODE_ANIM_SQUARE   = 50
+		self.MODE_ANIM_CIRCLE   = 51
+		self.MODE_ANIM_STAR     = 52
+		self.MODE_ANIM_TRIANGLE = 53
+
+		return super( MidiFighter64, self ).__init__( )
+
+
+
 	#-------------------------------------------------------------------------------------
 	#-- Opens one of the attached Launchpad MIDI devices.
 	#-- Uses search string "Fighter 64", by default.
@@ -2904,7 +2921,7 @@ def LedCtrlRawMode( self, number, mode ):
 	#--  <x>/<y>  0..7
 	#--  <color>  0..127 from color table
 	#-------------------------------------------------------------------------------------
-	def LedCtrlXY( self, x, y, color ):
+	def LedCtrlXY( self, x, y, color, mode = None ):
 
 		if x < 0 or x > 7:
 			return
@@ -2921,6 +2938,9 @@ def LedCtrlXY( self, x, y, color ):
 		number += (7-y) * 4
 
 		self.midi.RawWrite( 146, number, color )
+		# set the mode if required; faster than calling LedCtrlRawMode()
+		if mode is not None and mode > 17 and mode < 54:
+			self.midi.RawWrite( 147, number - 3*12, mode )
 
 
 	#-------------------------------------------------------------------------------------