#include <cli.h>
#include <led.h>
#include <print.h>
+#include <matrix_scan.h>
+#include <macro.h>
// Local Includes
#include "scan_loop.h"
-#include "macro.h"
+
+
+
+// ----- Function Declarations -----
+
+// CLI Functions
+void cliFunc_echo( char* args );
// ----- Variables -----
-// Indicates if the next scan is the first after a USB send
-uint8_t Scan_firstScan = 1;
+// Scan Module command dictionary
+CLIDict_Entry( echo, "Example command, echos the arguments." );
+
+CLIDict_Def( scanCLIDict, "Scan Module Commands" ) = {
+ CLIDict_Item( echo ),
+ { 0, 0, 0 } // Null entry for dictionary end
+};
// Number of scans since the last USB send
uint16_t Scan_scanCount = 0;
// Setup
inline void Scan_setup()
{
+ // Register Scan CLI dictionary
+ CLI_registerDictionary( scanCLIDict, scanCLIDictName );
+
// Setup GPIO pins for matrix scanning
Matrix_setup();
- // First scan is next
- Scan_firstScan = 1;
+ // Reset scan count
+ Scan_scanCount = 0;
}
// Main Detection Loop
inline uint8_t Scan_loop()
{
- Matrix_scan( Scan_scanCount++, Scan_firstScan );
-
- // No longer the first scan
- Scan_firstScan = 0;
+ Matrix_scan( Scan_scanCount++ );
return 0;
}
{
// Reset scan loop indicator (resets each key debounce state)
// TODO should this occur after USB send or Macro processing?
- Scan_firstScan = 1;
Scan_scanCount = 0;
}
+
+
+// ----- 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 )
+ {
+ extern void Output_usbCodeSend_capability( uint8_t state, uint8_t stateType, uint8_t *args );
+ Output_usbCodeSend_capability( state, stateType, &key );
+ }
+}
+
+
+
+// ----- CLI Command Functions -----
+
+// XXX Just an example command showing how to parse arguments (more complex than generally needed)
+void cliFunc_echo( char* args )
+{
+ char* curArgs;
+ char* arg1Ptr;
+ char* arg2Ptr = args;
+
+ // Parse args until a \0 is found
+ while ( 1 )
+ {
+ print( NL ); // No \r\n by default after the command is entered
+
+ curArgs = arg2Ptr; // Use the previous 2nd arg pointer to separate the next arg from the list
+ CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
+
+ // Stop processing args if no more are found
+ if ( *arg1Ptr == '\0' )
+ break;
+
+ // Print out the arg
+ dPrint( arg1Ptr );
+ }
+}
+