Added STARTMOUSE/Mouse mode; default double w.

Author: ScribbleJ

README.md

@@ -17,12 +17,12 @@ This project aims to significantly enhance the typing experience for Tap Strap u
    * (Optional) Tap Cycling: If you keep double-triple-etc tapping, after you go past the end of what's configured, it wraps back around to single-tap again, so you can "go back" without getting the wrong output first.
    * Does All the Keys:  You know the list of like a thousand Android KeyCodes?  Well, we do!  ( See /config/DEFAULT_1 )  
    * Multiple Configuration Profiles: Supports switching between unlimited chording configurations to suit different use cases.
+   * Easier Switching Between Mouse and Not: You can set a tap command to activate the mouse instead of all the fiddling about with trying to get the firmware to recognize you want mouse mode.  In the default keymap, double-tap w to activate mouse mode.  There is no AirMouse.  
    * Super Untested And Unfinished Code: You won't see that from Tap Systems!
 
 ## Upcoming Features:
 
    * Hopefully nothing -- it would be infintely prefereable to see Tap Systems make these features available on-device, most particularly the elimination of the backspace behavior and the ability to program chords offline.  But until they do...
-   * Mouse mode
    * Better UI/In-app Configuration
    * System service to make it useful even when Android doesn't want to use the IME (anytime you're not in a text entry, basically) -- work more like a hardware keyboard.
    * I'd still like to add a HID "passthrough" that allows you to connect your phone to another device and actually use the Tap Strap with these IME features on any bluetooth device.  But so far, no luck.
@@ -50,7 +50,10 @@ It's full of bugs and will probably set your phone on fire.  I can't take any re
 * If you use mulitple maps, they can be named whatever you like, but still must end in \_1.csv for the first tap, \_2 for the second, etc.
 * Comments in DEFAULT\_1.csv in the /config directory here will give you some clues.
 
-## USAGE NOTE:
+## USAGE NOTES:
+
+* The only way to activate mouse mode when using the IME is to use the tap command to start it.  By default it's double-tap w, 10101.  But you can set STARTMOUSE to any tap you like in your own config.  
+* Even more importantly, the only way to get out of mouse mode is by tapping all four fingers, think 'h' or 01111.   
 
 ### JUST KEEP TAPPING.  // Hey, is this an app name?
 

app/src/main/java/com/scribblej/tapstrapapp/TapInputMethodService.kt

@@ -29,6 +29,7 @@ import com.scribblej.tapstrapapp.presentation.TapInputView
 
 import com.scribblej.tapstrapapp.presentation.TapInputViewModel
 import com.tapwithus.sdk.mode.TapInputMode
+import com.tapwithus.sdk.mouse.MousePacket
 
 // For managing the timeouts without race conditions
 import java.util.concurrent.Executors
@@ -62,12 +63,17 @@ class TapInputMethodService : LifecycleInputMethodService(),
         return arrayOf()
     }
 
+    var inMouseMode = false
+
     private fun tapMouseStart() : Array<KeyEvent> {
         sdk.connectedTaps.forEach() { sdk.startControllerWithMouseHIDMode(it) }
+        inMouseMode = true;
         return arrayOf()
     }
+
     private fun tapMouseStop() : Array<KeyEvent> {
         sdk.connectedTaps.forEach() { sdk.startControllerMode(it) }
+        inMouseMode = false;
         return arrayOf()
     }
 
@@ -76,7 +82,7 @@ class TapInputMethodService : LifecycleInputMethodService(),
     private val actionMap: Map<String, () -> Array<KeyEvent>> = mapOf(
         "MAPSWITCH" to { prepareMapSwitch() },
         "STARTMOUSE" to { tapMouseStart() },
-        "STOPMOUSE"  to { tapMouseStop() },
+        "STOPMOUSE"  to { tapMouseStop() },  // There's not actually any way to use this right now, it's hardcoded 01111 in mouse mode gets you out.
         "CTRL"  to { toggleModifier(KeyEvent.META_CTRL_ON) },
         "ALT"   to { toggleModifier(KeyEvent.META_ALT_ON) },
         "SHIFT" to { toggleModifier(KeyEvent.META_SHIFT_ON) },
@@ -244,6 +250,8 @@ class TapInputMethodService : LifecycleInputMethodService(),
         )
     }
 
+
+
     var mapSwitchFlag: Boolean = false
     // TODO: check whether input is even wanted?
     private fun sendKeys(commandList: CommandList) {
@@ -320,6 +328,17 @@ class TapInputMethodService : LifecycleInputMethodService(),
             val tapPattern: TapPattern = data
             tapInputViewModel.updateTapPattern(tapPattern)
 
+            //TODO: this better
+            if (inMouseMode) {
+                // We have to continue to listen to taps, but we don't want to respond to any of them until we see the secret
+                // stop mousing code.  Which for purposes of testing, I guess we could use the distance in the mouse packets,
+                // or we could have a particular tap, or IDK IDK.  Today's not a day for thinking.
+                val secretStop = "01111".reversed().toInt(2) // whynot?
+                if (tapPattern == secretStop)
+                    tapMouseStop()
+
+                return
+            }
             val commandLists = getCommandListsForTapPattern(tapPattern)
             tapInputViewModel.setCommandLists(commandLists)
 

config/DEFAULT_2.csv

@@ -19,7 +19,7 @@
 01001,[
 # looks like y and w
 10001,z
-10101,
+10101,STARTMOUSE
 # one finger up
 01111,.
 10111,:

config/testconfig/DEFAULT_1.csv

@@ -35,7 +35,7 @@
 11001,ENTER
 10011,p
 #
-11100,MAPSWITCH,MOUSEMAP,STARTMOUSE
+11100,STARTMOUSE
 01110,BACKSPACE
 00111,MAPSWITCH,SWITCHMAP
 # all fingers together