Scan/MD1/scan_loop.c

   1 /* Copyright (C) 2014 by Jacob Alexander
   2  *
   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:
   9  *
  10  * The above copyright notice and this permission notice shall be included in
  11  * all copies or substantial portions of the Software.
  12  *
  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
  19  * THE SOFTWARE.
  20  */
  21
  22 // ----- Includes -----
  23
  24 // Compiler Includes
  25 #include <Lib/ScanLib.h>
  26
  27 // Project Includes
  28 #include <cli.h>
  29 #include <led.h>
  30 #include <print.h>
  31 #include <matrix_scan.h>
  32
  33 // Local Includes
  34 #include "scan_loop.h"
  35 #include "macro.h"
  36
  37
  38
  39 // ----- Function Declarations -----
  40
  41 // CLI Functions
  42 void cliFunc_echo( char* args );
  43
  44
  45
  46 // ----- Variables -----
  47
  48 // Scan Module command dictionary
  49 const char scanCLIDictName[] = "Scan Module Commands";
  50 const CLIDictItem scanCLIDict[] = {
  51         { "echo",        "Example command, echos the arguments.", cliFunc_echo },
  52         { 0, 0, 0 } // Null entry for dictionary end
  53 };
  54
  55 // Number of scans since the last USB send
  56 uint16_t Scan_scanCount = 0;
  57
  58
  59
  60 // ----- Functions -----
  61
  62 // Setup
  63 inline void Scan_setup()
  64 {
  65         // Register Scan CLI dictionary
  66         CLI_registerDictionary( scanCLIDict, scanCLIDictName );
  67
  68         // Setup GPIO pins for matrix scanning
  69         Matrix_setup();
  70
  71         // Reset scan count
  72         Scan_scanCount = 0;
  73 }
  74
  75
  76 // Main Detection Loop
  77 inline uint8_t Scan_loop()
  78 {
  79         Matrix_scan( Scan_scanCount++ );
  80
  81         return 0;
  82 }
  83
  84
  85 // Signal from Macro Module that all keys have been processed (that it knows about)
  86 inline void Scan_finishedWithMacro( uint8_t sentKeys )
  87 {
  88 }
  89
  90
  91 // Signal from Output Module that all keys have been processed (that it knows about)
  92 inline void Scan_finishedWithOutput( uint8_t sentKeys )
  93 {
  94         // Reset scan loop indicator (resets each key debounce state)
  95         // TODO should this occur after USB send or Macro processing?
  96         Scan_scanCount = 0;
  97 }
  98
  99
 100 // ----- CLI Command Functions -----
 101
 102 // XXX Just an example command showing how to parse arguments (more complex than generally needed)
 103 void cliFunc_echo( char* args )
 104 {
 105         char* curArgs;
 106         char* arg1Ptr;
 107         char* arg2Ptr = args;
 108
 109         // Parse args until a \0 is found
 110         while ( 1 )
 111         {
 112                 print( NL ); // No \r\n by default after the command is entered
 113
 114                 curArgs = arg2Ptr; // Use the previous 2nd arg pointer to separate the next arg from the list
 115                 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
 116
 117                 // Stop processing args if no more are found
 118                 if ( *arg1Ptr == '\0' )
 119                         break;
 120
 121                 // Print out the arg
 122                 dPrint( arg1Ptr );
 123         }
 124 }
 125