1 /* Copyright (C) 2014,2016 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>
32 #include <matrix_scan.h>
34 #include <output_com.h>
37 #include "scan_loop.h"
41 // ----- Function Declarations -----
43 // ----- Variables -----
45 // Number of scans since the last USB send
46 uint16_t Scan_scanCount = 0;
50 // ----- Functions -----
53 inline void Scan_setup()
55 // Setup GPIO pins for matrix scanning
58 // Setup ISSI chip to control the leds
66 // Main Detection Loop
67 inline uint8_t Scan_loop()
69 Matrix_scan( Scan_scanCount++ );
71 // Process any LED events
78 // Signal from Macro Module that all keys have been processed (that it knows about)
79 inline void Scan_finishedWithMacro( uint8_t sentKeys )
84 // Signal from Output Module that all keys have been processed (that it knows about)
85 inline void Scan_finishedWithOutput( uint8_t sentKeys )
87 // Reset scan loop indicator (resets each key debounce state)
88 // TODO should this occur after USB send or Macro processing?
94 // ----- Capabilities -----
96 // Custom capability examples
97 // Refer to kll.h in Macros/PartialMap for state and stateType information
98 void CustomAction_action1_capability( uint8_t state, uint8_t stateType, uint8_t *args )
100 // Display capability name
101 // XXX This is required for debug cli to give you a list of capabilities
102 if ( stateType == 0xFF && state == 0xFF )
104 print("CustomAction_action1_capability()");
108 // Prints Action1 info message to the debug cli
109 info_print("Action1");
112 uint8_t CustomAction_blockHold_storage = 0;
113 void CustomAction_blockHold_capability( uint8_t state, uint8_t stateType, uint8_t *args )
115 // Display capability name
116 if ( stateType == 0xFF && state == 0xFF )
118 print("CustomAction_blockHold_capability(usbCode)");
122 // Retrieve 8-bit argument
123 uint8_t key = args[0];
125 // We only care about normal keys
126 if ( stateType == 0x00 )
128 // Block given key if we're in the "Press" or "Hold" state
129 if ( ( state == 0x01 || state == 0x02 )
130 && CustomAction_blockHold_storage == 0 )
132 CustomAction_blockHold_storage = key;
133 info_msg("Blocking Key: ");
137 // Release if in the "Off" or "Release" state and we're blocking
138 else if ( ( state == 0x00 || state == 0x03 )
139 && key == CustomAction_blockHold_storage )
141 info_msg("Unblocking Key: ");
142 printHex( CustomAction_blockHold_storage );
144 CustomAction_blockHold_storage = 0;
149 void CustomAction_blockKey_capability( uint8_t state, uint8_t stateType, uint8_t *args )
151 // Display capability name
152 if ( stateType == 0xFF && state == 0xFF )
154 print("CustomAction_blockKey_capability(usbCode)");
158 // Retrieve 8-bit argument
159 uint8_t key = args[0];
161 // If key is not blocked, process
162 if ( key != CustomAction_blockHold_storage )
164 extern void Output_usbCodeSend_capability( uint8_t state, uint8_t stateType, uint8_t *args );
165 Output_usbCodeSend_capability( state, stateType, &key );