Adding examples of custom action/capabilties

- See md1Action.kll for usage - Includes Block/Unblock
kiibohd · Aug 16, 2015 · 398018e · 398018e
1 parent 59c14fc
commit 398018e
Show file tree

Hide file tree

Showing 3 changed files with 101 additions and 4 deletions.
diff --git a/Scan/MD1/defaultMap.kll b/Scan/MD1/defaultMap.kll
@@ -1,10 +1,10 @@
 Name = MD1;
-Version = 0.2;
-Author = "HaaTa (Jacob Alexander) 2014";
-KLL = 0.3;
+Version = 0.3;
+Author = "HaaTa (Jacob Alexander) 2014-2015";
+KLL = 0.3c;
 
 # Modified Date
-Date = 2014-09-14;
+Date = 2015-08-16;
 
 
 S0x00 : U"Esc";
@@ -71,3 +71,15 @@ S0x3C : U"RAlt";
 S0x3D : U"Function3"; # Right Blank Key 1
 S0x3E : U"Function4"; # Right Blank Key 2
 
+
+# Custom Action Examples
+
+# Example capability, prints to cli
+action1 => CustomAction_action1_capability(); # No arguments
+
+# Blocks given USB Code, must be used with blockLink
+# Simple example, supports only blocking a single key at a time
+# Keys must be specified using numbers see Macro/PartialMap/usb_hid.h
+blockHold => CustomAction_blockHold_capability( usbCode : 1 ); # Single 8-bit argument
+blockKey => CustomAction_blockKey_capability( usbCode : 1 );
+
diff --git a/Scan/MD1/scan_loop.c b/Scan/MD1/scan_loop.c
@@ -98,6 +98,83 @@ inline void Scan_finishedWithOutput( uint8_t sentKeys )
 }
 
 
+
+// ----- Capabilities -----
+
+// Custom capability examples
+// Refer to kll.h in Macros/PartialMap for state and stateType information
+void CustomAction_action1_capability( uint8_t state, uint8_t stateType, uint8_t *args )
+{
+	// Display capability name
+	// XXX This is required for debug cli to give you a list of capabilities
+	if ( stateType == 0xFF && state == 0xFF )
+	{
+		print("CustomAction_action1_capability()");
+		return;
+	}
+
+	// Prints Action1 info message to the debug cli
+	info_print("Action1");
+}
+
+uint8_t CustomAction_blockHold_storage = 0;
+void CustomAction_blockHold_capability( uint8_t state, uint8_t stateType, uint8_t *args )
+{
+	// Display capability name
+	if ( stateType == 0xFF && state == 0xFF )
+	{
+		print("CustomAction_blockHold_capability(usbCode)");
+		return;
+	}
+
+	// Retrieve 8-bit argument
+	uint8_t key = args[0];
+
+	// We only care about normal keys
+	if ( stateType == 0x00 )
+	{
+		// Block given key if we're in the "Press" or "Hold" state
+		if ( ( state == 0x01 || state == 0x02 )
+			&& CustomAction_blockHold_storage == 0 )
+		{
+			CustomAction_blockHold_storage = key;
+			info_msg("Blocking Key: ");
+			printHex( key );
+			print( NL );
+		}
+		// Release if in the "Off" or "Release" state and we're blocking
+		else if ( ( state == 0x00 || state == 0x03 )
+			&& key == CustomAction_blockHold_storage )
+		{
+			info_msg("Unblocking Key: ");
+			printHex( CustomAction_blockHold_storage );
+			print( NL );
+			CustomAction_blockHold_storage = 0;
+		}
+	}
+}
+
+void CustomAction_blockKey_capability( uint8_t state, uint8_t stateType, uint8_t *args )
+{
+	// Display capability name
+	if ( stateType == 0xFF && state == 0xFF )
+	{
+		print("CustomAction_blockKey_capability(usbCode)");
+		return;
+	}
+
+	// Retrieve 8-bit argument
+	uint8_t key = args[0];
+
+	// If key is not blocked, process
+	if ( key != CustomAction_blockHold_storage )
+	{
+		Output_usbCodeSend_capability( state, stateType, &key );
+	}
+}
+
+
+
 // ----- CLI Command Functions -----
 
 // XXX Just an example command showing how to parse arguments (more complex than generally needed)

diff --git a/Scan/MD1/scan_loop.h b/Scan/MD1/scan_loop.h
@@ -38,3 +38,11 @@ uint8_t Scan_loop( void );
 void Scan_finishedWithMacro( uint8_t sentKeys );  // Called by Macro Module
 void Scan_finishedWithOutput( uint8_t sentKeys ); // Called by Output Module
 
+
+// ----- Capabilities -----
+
+// Example capabilities
+void CustomAction_action1_capability( uint8_t state, uint8_t stateType, uint8_t *args );
+void CustomAction_blockHold_capability( uint8_t state, uint8_t stateType, uint8_t *args );
+void CustomAction_blockKey_capability( uint8_t state, uint8_t stateType, uint8_t *args );
+