Git REALLY hates me version. More changes thn you can poke a stick at

INSTALL/environment-build.yml

@@ -6,7 +6,6 @@ dependencies:
   - pip
   - tk
   - pip:
-    - git+git://github.com/FMMT666/launchpad.py.git@master
     - pillow
     - pygame
     - pynput
@@ -18,3 +17,8 @@ dependencies:
     - pytesseract
     - imagehash
     - dhash
+    - selenium
+    - pyperclip
+    - python-dateutil
+    - launchpad-py
+    - launchpad

INSTALL/environment.yml

@@ -6,7 +6,6 @@ dependencies:
   - pip
   - tk
   - pip:
-    - git+git://github.com/FMMT666/launchpad.py.git@master
     - pillow
     - pygame
     - pynput
@@ -17,3 +16,8 @@ dependencies:
     - pytesseract
     - imagehash
     - dhash
+    - selenium
+    - pyperclip
+    - python-dateutil
+    - launchpad-py
+    - launchpad

INSTALL/requirements.txt

@@ -18,4 +18,8 @@ pywin32==227
 pytesseract==0.3.7
 ImageHash==4.2.0
 dhash==1.3
--e git+git://github.com/FMMT666/launchpad.py.git@master#egg=launchpad-py
+selenium==3.141.0
+pyperclip==1.8.0
+python-dateutil==2.8.1
+launchpad-py
+launchpad

LPHK.py

@@ -1,4 +1,4 @@
-import sys, os, subprocess, argparse
+import sys, os, subprocess, argparse, global_vars
 from datetime import datetime
 from constants import *
 
@@ -10,7 +10,7 @@
 if getattr(sys, 'frozen', False):
     IS_EXE = True
     PROG_FILE = sys.executable
-    PROG_PATH = os.path.dirname(PROG_FILE) 
+    PROG_PATH = os.path.dirname(PROG_FILE)
     PATH = sys._MEIPASS
 else:
     IS_EXE = False
@@ -65,10 +65,10 @@ def datetime_str():
 
 # Try to import launchpad.py
 try:
-    import launchpad_py as launchpad
+    import launchpad_py as launchpad_real
 except ImportError:
     try:
-        import launchpad
+        import launchpad as launchpad_real
     except ImportError:
         sys.exit("[LPHK] Error loading launchpad.py")
 print("")
@@ -79,7 +79,17 @@ def datetime_str():
 # just import the control modules to automatically integrate them
 import command_list
 
-lp = launchpad.Launchpad()
+
+# create a launchpad object, either real or fake
+def Launchpad():
+    if window.IsStandalone():
+        import launchpad_fake
+        return launchpad_fake.launchpad
+    else:
+        return launchpad_real.Launchpad()
+
+
+LP = None
 
 EXIT_ON_WINDOW_CLOSE = True
 
@@ -88,51 +98,71 @@ def init():
 
     ap = argparse.ArgumentParser()                             # argparse makes argument processing easy
     ap.add_argument(                                           # reimnplementation of debug (-d or --debug)
-        "-d", "--debug", 
-        help = "turn on debugging mode", action="store_true")
-    ap.add_argument(                                           # new option to automatically load a layout
-        "-l", "--layout", 
-        help = "load a layout", 
+        "-d", "--debug",
+        help = "Turn on debugging mode", action="store_true")
+    ap.add_argument(                                           # option to automatically load a layout
+        "-l", "--layout",
+        help = "Load an initial layout",
         type=argparse.FileType('r'))
-    ap.add_argument(                                           # new option to start minimised
-        "-m", "--minimised", 
+    ap.add_argument(                                           # option to start minimised
+        "-m", "--minimised",
         help = "Start the application minimised", action="store_true")
-
-    window.ARGS = vars(ap.parse_args())                        # store the arguments in a place anything can get to
-
-    if window.ARGS['debug']:
+    ap.add_argument(                                           # option to start without connecting to a Launchpad
+        "-s", "--standalone",
+        help = "Operate without connection to Launchpad", type=str, choices=[LP_MK1, LP_MK2, LP_MINI, LP_PRO])
+    ap.add_argument(                                           # option to start with launchpad window in a particular mode
+        "-M", "--mode",
+        help = "Launchpad mode", type=str, choices=[LM_EDIT, LM_MOVE, LM_SWAP, LM_COPY, LM_DEL, LM_RUN], default=LM_EDIT)
+    ap.add_argument(                                           # turn of unnecessary verbosity
+        "-q", "--quiet",
+        help = "Disable information popups", action="store_true")
+
+    global_vars.ARGS = vars(ap.parse_args())                   # store the arguments in a place anything can get to
+
+    if global_vars.ARGS['debug']:
         EXIT_ON_WINDOW_CLOSE = False
         print("[LPHK] Debugging mode active! Will not shut down on window close.")
         print("[LPHK] Run shutdown() to manually close the program correctly.")
-    
+
     files.init(USER_PATH)
     sound.init(USER_PATH)
 
+    global LP
+    LP = Launchpad()
+
 def shutdown():
     if lp_events.timer != None:                          # cancel any outstanding events
         lp_events.timer.cancel()
+
     scripts.to_run = []                                  # remove anything from the list of scripts scheduled to run
+
     for x in range(9):
         for y in range(9):
             if scripts.buttons[x][y].thread != None:
                 scripts.buttons[x][y].thread.kill.set()  # request to kill any running threads
-    if window.lp_connected:
+
+    if window.lp_connected or window.IsStandalone:
         scripts.Unbind_all()                             # unbind all the buttons
         lp_events.timer.cancel()                         # cancel all the timers
-        launchpad_connector.disconnect(lp)               # disconnect from the launchpad
+        if LP != None and LP != -1:
+            launchpad_connector.disconnect(LP)           # disconnect from the launchpad
         window.lp_connected = False
+
     logger.stop()                                        # stop logging
+
     if window.restart:
+        window.restart = False                           # don't do this forever
         if IS_EXE:
             os.startfile(sys.argv[0])
         else:
             os.execv(sys.executable, ["\"" + sys.executable + "\""] + sys.argv)
+
     sys.exit("[LPHK] Shutting down...")
 
 
 def main():
     init()
-    window.init(lp, launchpad, PATH, PROG_PATH, USER_PATH, VERSION, PLATFORM)
+    window.init(LP, PATH, PROG_PATH, USER_PATH, VERSION, PLATFORM)
     if EXIT_ON_WINDOW_CLOSE:
         shutdown()
 

NewCommands.md

@@ -55,7 +55,7 @@ This has a shorter list of requirements, but it's more coding, and requires more
  * Required basic understanding of stages of execution of a command 
 
 
-#### An example - Decoding an old version of the MOUSE_SCROLL command
+#### An example - Decoding S_FDIST command
 
 The `S_FDIST` command looks like this:
 ```python
@@ -69,7 +69,7 @@ class Scrape_Fingerprint_Distance(command_base.Command_Basic):
         self,
         ):
 
-        super().__init__("S_FDIST",  # the name of the command as you have to enter it in the code
+        super().__init__("S_FDIST, Calculate the distance between 2 fingerprints",
             LIB,
             (
             # Desc         Opt    Var       type     p1_val                      p2_val 
@@ -82,6 +82,10 @@ class Scrape_Fingerprint_Distance(command_base.Command_Basic):
             (3,           "    Return the hamming distance between fingerprints {1} and {2} into {3}"), 
             ) )
 
+        self.doc = ["This command calculates the hamming distance between 2 fingerprints.", \
+                    "This can be used to determine how similar 2 images are.  The larger", \
+                    "the hamming distance, the more different the images are."]
+
 
     def Process(self, btn, idx, split_line):
         f1 = self.Get_param(btn, 1)                    # get the fingerprints
@@ -130,7 +134,7 @@ The initialization of a command class serves to define the name of the command.
         self,
         ):
 
-        super().__init__("S_FDIST",  # the name of the command as you have to enter it in the code
+        super().__init__("S_FDIST, Calculate the distance between 2 fingerprints",
             LIB,
             (
             # Desc         Opt    Var       type     p1_val                      p2_val 
@@ -142,9 +146,13 @@ The initialization of a command class serves to define the name of the command.
             # num params, format string                           (trailing comma is important)
             (3,           "    Return the hamming distance between fingerprints {1} and {2} into {3}"), 
             ) )
+
+        self.doc = ["This command calculates the hamming distance between 2 fingerprints.", \
+                    "This can be used to determine how similar 2 images are.  The larger", \
+                    "the hamming distance, the more different the images are."]
 ```
 
-The 5th line defines the name of the command.  Note that command names are case sensitive, so the name should be in all uppercase to be consistent. 
+The 5th line defines the name of the command.  Note that command names are case sensitive, so the name should be in all uppercase to be consistent.  The name can be optionally followed by a comma and a description of the command.  This description is used as part of the auto-documentation of commands
 
 Line 6 passes the name of the current library (lib) to the the object.  The current library will be used to define where the command originates from in some of the low level reporting functions. 
 
@@ -644,7 +652,7 @@ Every command requires a validation.  If you do not provide validation code, the
 
             try:
                 temp = int(split_line[1])
-                if valid_var_name(temp):
+                if variables.valid_var_name(temp):
 
                 if temp < 1:
                     return ("Line:" + str(idx+1) + " - '" + split_line[0] + " parameter 1 must be a positive number.", btn.line[idx])

README.md

@@ -137,11 +137,26 @@ I have specifically chosen to do my best to develop this using as many cross pla
   * `.desktop` shortcuts are coming soon!
 
 ## How do I use it? (Post-Install) [[Table of Contents]](https://github.com/nimaid/LPHK#table-of-contents)
-* Before starting the program, make sure your Launchpad Classic/Mini/S or MkII is connected to the computer.
+* Command line options
+  * usage: lphk.py [-h] [-d] [-l LAYOUT] [-m] [-s {Mk1,Mk2,Mini,Pro}] [-M {edit,move,swap,copy,run}] [-q]
+  * -h, --help
+    * Show this help message and exit
+  * -d, --debug 
+    * Turn on debugging mode
+  * -l LAYOUT, --layout 
+    * LAYOUT Load an initial layout
+  * -m, --minimised 
+    * Start the application minimised
+  * -s {Mk1,Mk2,Mini,Pro}, --standalone {Mk1,Mk2,Mini,Pro} 
+    * Operate without connection to Launchpad
+  * -M {edit,move,swap,copy,run}, --mode {edit,move,swap,copy,run} 
+    * Launchpad mode
+  * -q, --quiet 
+    * Disable information popups* Click `Launchpad > Connect to Launchpad...`.
+* Before starting the program, if you are planning to use a Launchpad, ensure it (Launchpad Classic/Mini/S or MkII) is connected to the computer.
   * If you have a Launchpad Pro, there is currently beta support for it. Please put it in `Live` mode by following the instructions in the pop-up when trying to connect in the next step. For more info, see the [User Manual](https://d2xhy469pqj8rc.cloudfront.net/sites/default/files/novation/downloads/10581/launchpad-pro-gsg-en.pdf).
-* Click `Launchpad > Connect to Launchpad...`.
   * If the connection is successful, the grid will appear, and the status bar at the bottom will turn green.
-* The current mode is displayed in the upper right, in the gap between the circular buttons. Clicking this text will change the mode. There are four modes:
+* The current mode is displayed in the upper right, in the gap between the circular buttons. Clicking this text will change the mode. There are five modes:
     * "Edit" mode: Click on a button to open the Script Edit window for that button.
       * All scripts are saved in the `.lpl` (LaunchPad Layout) files, but the editor also has the ability to import/export single `.lps` (LaunchPad Script) files.
         * For examples, you can click `Import Script` and look through the `user_scripts/examples/` folder.
@@ -158,6 +173,10 @@ I have specifically chosen to do my best to develop this using as many cross pla
       * The selected button will remain unchanged.
       * The second button will have the selected button's old script and color bound to it.
         * If the second button is already bound, you will get a dialog box with options.
+    * "Run" mode: Click on a button to execute it.
+      * The button is executes when you release the mouse button.
+      * A release of the button is queued immediately after the button press.
+      * This is currentl;y only functional with an emulated launchpad
 * Go to `Layout > Save layout as...` to save your current layout for future use, colors and all.
 * Go to `Layout > Load layout...` to load an existing layout. Examples are in `user_layouts/examples/`.
 
@@ -190,16 +209,52 @@ RELEASE (argument 1)
 ```
 If this is used, all other lines in the file must either be blank lines or comments.
 
+#### The `@LOAD_LAYOUT` Header [[Table of Contents]](https://github.com/nimaid/LPHK#table-of-contents)
+This is a method of loading a new layout.  The header is followed by the name of the layout.
+```
+@LOAD_LAYOUT c:\layouts\newlayout.lpl
+```
+#### The `@SUB` Header [[Table of Contents]](https://github.com/nimaid/LPHK#table-of-contents)
+This defines a subroutine name and parameters.
+```
+@SUB SUB1 a% b% @result%
+```
+This defines a subroutine that will be called using CALL:SUB1.  It requires 3 parameters.  The first 2 can be either integer constants or variables.  The last must be a variable because a result can be returned in it.
+Within the subroutine, refer to the parameters as `a`, `b`, and `result`.
+If a parameter name is preceeded with `@`, the parameter is passed by reference and a variable MUST be specified in the calling code
+If a parameter name is preceeded with `-`, the parameter is optional
+If a parameter name is followed with `%`, the parameter is integer
+If a parameter name is followed with `#`, the parameter is floating point
+If a parameter name is followed with `$`, the parameter is a string
+If a parameter name is followed with `!`, the parameter is a boolean
+#### The `@DESC` Header  [[Table of Contents]](https://github.com/nimaid/LPHK#table-of-contents)
+This defines efines a one line description of a subroutine or button.
+```
+@DESC Starts the music
+```
+#### The "@NAME" Header [[Table of Contents]](https://github.com/nimaid/LPHK#table-of-contents)
+The sets the name of a button.  Currently this does nothing outside the automatically generated documentation, but could in the future be used to place a label, hint text, etc on the form showing the launchpad.
+```
+@NAME Fast Press
+```
+This sets the name to `Fast Press`.  Note that names are not limited to a single word, but in general should be terse.
+#### The "@DOC" Header [[Table of Contents]](https://github.com/nimaid/LPHK#table-of-contents)
+This adds lines of documentation to a subroutine or button script.
+```
+@DOC This is the first line of documentation
+@DOC And this is the second line
+```
+This adds 2 lines of documentation that will appear in the automatically generated documentation
 ### Commands List [[Table of Contents]](https://github.com/nimaid/LPHK#table-of-contents)
 Commands follow the format: `COMMAND arg1 arg2 ...`. Scripts are just a text file with newlines separating commands.
 
 #### Utility [[Table of Contents]](https://github.com/nimaid/LPHK#table-of-contents)
 * `ABORT`
-  * Terminates the script immediately, logging any message after the command.  This has the same functionality as END, however it carries with it the notion that the termination was abnormal.
+  * Terminates the script immediately, logging any message after the command.  This has the same functionality as END, however it carries with it the notion that the termination was abnormal.  This will stop execution of a script immediately, even if called from within a subroutine.
 * `DELAY`
   * Delays the script for (argument 1) seconds.
 * `END`
-  * Terminates the script immediately, logging any message after the command.  This has the same functionality as ABORT, however it indicates a normal termination.
+  * Terminates the script immediately, logging any message after the command.  This has the same functionality as ABORT, however it indicates a normal termination.    This will stop execution of a script immediately, even if called from within a subroutine.
 * `GOTO_LABEL`
   * Goto label (argument 1).
 * `IF_PRESSED_GOTO_LABEL`
@@ -224,6 +279,8 @@ Commands follow the format: `COMMAND arg1 arg2 ...`. Scripts are just a text fil
   * Works the same as the REPEAT_LABEL command, except the number of times the loop is executed is defined by argument 2.  In addition, the loop counter is reset automatically allowing loops to be nested.
 * `RESET_REPEATS`
   * Reset the counter on all repeats. (no arguments)
+* `RETURN`
+  * Returns from a subroutine.  If not in a subroutine, this will terminate the script.
 * `SOUND`
   * Play a sound named (argument 1) inside the `user_sounds/` folder.
     * Supports `.wav`, `.flac`, and `.ogg` only.

VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2