1 /* Copyright (C) 2014 by Jacob Alexander
3 * Permission is hereby granted, free of charge, to any person obtaining a copy
4 * of this software and associated documentation files (the "Software"), to deal
5 * in the Software without restriction, including without limitation the rights
6 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7 * copies of the Software, and to permit persons to whom the Software is
8 * furnished to do so, subject to the following conditions:
10 * The above copyright notice and this permission notice shall be included in
11 * all copies or substantial portions of the Software.
13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 // ----- Includes -----
25 #include <Lib/ScanLib.h>
31 #include <matrix_scan.h>
35 #include "scan_loop.h"
39 // ----- Function Declarations -----
42 void cliFunc_echo( char* args );
46 // ----- Variables -----
48 // Scan Module command dictionary
49 CLIDict_Entry( echo, "Example command, echos the arguments." );
51 CLIDict_Def( scanCLIDict, "Scan Module Commands" ) = {
53 { 0, 0, 0 } // Null entry for dictionary end
56 // Number of scans since the last USB send
57 uint16_t Scan_scanCount = 0;
61 // ----- Functions -----
64 inline void Scan_setup()
66 // Register Scan CLI dictionary
67 CLI_registerDictionary( scanCLIDict, scanCLIDictName );
69 // Setup GPIO pins for matrix scanning
77 // Main Detection Loop
78 inline uint8_t Scan_loop()
80 Matrix_scan( Scan_scanCount++ );
86 // Signal from Macro Module that all keys have been processed (that it knows about)
87 inline void Scan_finishedWithMacro( uint8_t sentKeys )
92 // Signal from Output Module that all keys have been processed (that it knows about)
93 inline void Scan_finishedWithOutput( uint8_t sentKeys )
95 // Reset scan loop indicator (resets each key debounce state)
96 // TODO should this occur after USB send or Macro processing?
101 // ----- CLI Command Functions -----
103 // XXX Just an example command showing how to parse arguments (more complex than generally needed)
104 void cliFunc_echo( char* args )
108 char* arg2Ptr = args;
110 // Parse args until a \0 is found
113 print( NL ); // No \r\n by default after the command is entered
115 curArgs = arg2Ptr; // Use the previous 2nd arg pointer to separate the next arg from the list
116 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
118 // Stop processing args if no more are found
119 if ( *arg1Ptr == '\0' )