4 TODO, write some insightful/informative :P
6 Please give authors credit for modules used if you use in a distributed product :D
10 ----------------------
12 ----------------------
14 Below listed are the Arch Linux pacman names, AUR packages may be required.
16 These depend a bit on which targets you are trying to build, but the general one:
17 - cmake (2.8 and higher)
18 - Teensy Loader (http://pjrc.com/teensy/loader.html)
21 AVR Specific (Teensy 1.0/++,2.0/++) (try to use something recent, suggested versions below)
23 - avr-binutils (2.23.2)
27 ARM Specific (Teensy 3.0/3.1) (Sourcery CodeBench Lite for ARM EABI
28 (http://www.mentor.com/embedded-software/sourcery-tools/sourcery-codebench/editions/lite-edition/)
32 - arm-none-eaby-binutils
36 ----------------------
37 Selecting Architecture
38 ----------------------
40 This is where you choose which architecture you want to build for.
42 - Teensy 1.0 (Not tested)
43 - Teensy 1.0++ (Not tested)
49 Open up CMakeLists.txt in your favourite text editor.
56 #| Specify the compiler family to use
57 #| Currently only supports AVR and ARM
60 #| "avr" # Teensy++ 1.0
61 #| "avr" # Teensy++ 2.0
65 set( COMPILER_FAMILY "avr" )
68 Just change the COMPILER_FAMILY variable to whatever you are trying to build for.
70 NOTE: If you change this option, you will *may* to delete the build directory that is created in the Building sections below.
74 ----------------------
75 Selecting Microcontroller
76 ----------------------
78 Even if you selected the "avr" family of microcontroller architectures, you will still need to specify a target microcontroller (or once more ARM microcontrollers are supported).
80 Open up avr.cmake (or arm.cmake) in your favourite text editor.
84 # Atmel Defines and Linker Options
88 #| You _MUST_ set this to match the board you are using
89 #| type "make clean" after changing this, so all files will be rebuilt
91 #| "at90usb162" # Teensy 1.0
92 #| "atmega32u4" # Teensy 2.0
93 #| "at90usb646" # Teensy++ 1.0
94 #| "at90usb1286" # Teensy++ 2.0
96 set( MCU "at90usb1286" )
101 # ARM Defines and Linker Options
104 #| Chip Name (Linker)
105 #| You _MUST_ set this to match the board you are using
106 #| type "make clean" after changing this, so all files will be rebuilt
108 #| "mk20dx128" # Teensy 3.0
109 #| "mk20dx256" # Teensy 3.1
111 set( CHIP "mk20dx128" )
114 Just change the CHIP variable to the microcontroller you are trying to build for.
116 NOTE: If you change this option, you will *need* to delete the build directory that is created in the Building sections below.
120 ----------------------
122 ----------------------
124 WARNING: Not all modules are compatible, and some modules may have dependencies on other modules.
126 This is where the options start getting interesting.
127 The Kiibohd Controller is designed around a set of 4 types of modules that correspond to different functionality:
134 The Scan Module is where the most interesting stuff happens. These modules take in "keypress data".
135 A converter Scan Module will interpret a protocol into key press/releases.
136 A matrix Scan Module may inherit from the matrix module to scan keypress from a matrix
137 This module just has to give press/release codes, but does have some callback control to other modules depending on the lifecycle for press/release codes (this can be very complicated depending on the protocol).
138 Each Scan Module has it's own default keymap/modifier map. (TODO recommend keymap changing in the Macro Module).
140 Some scan modules have very specialized hardware requirements, each module directory should have at least a link to the needed parts and/or schematics (TODO!).
143 The Macro Module takes care of the mapping of the key press/release code into an Output (USB) scan code.
144 Any layering, macros, keypress intelligence/reaction is done here.
147 The Output Module is the module dealing with output from the microcontroller. Currently USB is the only output protocol.
148 Different USB output implementations are available, pjrc being the safest/least featureful one.
149 Debug capabilities may depend on the module selected.
152 The Debug Module enables various things like the Teensy LED on errors, debug terminal output.
153 (TODO get true UART working in avr, not just arm)
157 Open up setup.cmake in your favourite text editor.
164 #| Note: This is the only section you probably want to modify
165 #| Each module is defined by it's own folder (e.g. Scan/Matrix represents the "Matrix" module)
166 #| All of the modules must be specified, as they generate the sources list of files to compile
167 #| Any modifications to this file will cause a complete rebuild of the project
169 #| Please look at the {Scan,Macro,Output,Debug}/module.txt for information on the modules and how to create new ones
171 ##| Deals with acquiring the keypress information and turning it into a key index
172 set( ScanModule "avr-capsense" )
174 ##| Uses the key index and potentially applies special conditions to it, mapping it to a usb key code
175 set( MacroModule "buffer" )
177 ##| Sends the current list of usb key codes through USB HID
178 set( OutputModule "pjrc" )
180 ##| Debugging source to use, each module has it's own set of defines that it sets
181 set( DebugModule "full" )
184 Look at each module individually for it's requirements. There is chip/architecture dependency checking but some permutations of modules may not be tested/compile.
187 There are also CMake options for temporarily selecting modules. But it's easier to just edit the file.
188 e.g. cmake -DScanModuleOverride=<module name>
192 ----------------------
194 ----------------------
205 [master]: cmake .. [...sy/avr-capsense-haata/build](hyatt@901Mas:pts/4)
210 -- Detected Scan Module Source Files:
211 Scan/avr-capsense/scan_loop.c
212 -- Detected Macro Module Source Files:
214 -- Detected Output Module Source Files:
215 Output/pjrc/usb_com.c;Output/pjrc/avr/usb_keyboard_debug.c
216 -- Detected Debug Module Source Files:
217 Debug/full/../led/led.c;Debug/full/../print/print.c
220 -- Build files have been written to: /home/hyatt/Source/Teensy/avr-capsense-haata/build
221 [master]: make [...sy/avr-capsense-haata/build](hyatt@901Mas:pts/4)
222 Scanning dependencies of target kiibohd.elf
223 [ 12%] Building C object CMakeFiles/kiibohd.elf.dir/main.c.o
224 [ 25%] Building C object CMakeFiles/kiibohd.elf.dir/Scan/avr-capsense/scan_loop.c.o
225 [ 37%] Building C object CMakeFiles/kiibohd.elf.dir/Macro/buffer/macro.c.o
226 [ 50%] Building C object CMakeFiles/kiibohd.elf.dir/Output/pjrc/usb_com.c.o
227 [ 62%] Building C object CMakeFiles/kiibohd.elf.dir/Output/pjrc/avr/usb_keyboard_debug.c.o
228 [ 75%] Building C object CMakeFiles/kiibohd.elf.dir/Debug/led/led.c.o
229 [ 87%] Building C object CMakeFiles/kiibohd.elf.dir/Debug/print/print.c.o
230 Linking C executable kiibohd.elf
231 Creating load file for Flash: kiibohd.hex
232 Creating Extended Listing: kiibohd.lss
233 Creating Symbol Table: kiibohd.sym
234 [ 87%] Built target kiibohd.elf
235 Scanning dependencies of target SizeAfter
236 [100%] Size after generation:
237 text data bss dec hex filename
238 0 6112 0 6112 17e0 kiibohd.hex
239 5792 320 852 6964 1b34 kiibohd.elf
240 [100%] Built target SizeAfter
244 ----------------------
245 Linux Loading Firmware
246 ----------------------
248 The 'load' script that is created during the build can load the firmware over USB.
249 It uses sudo, so make sure you have the priviledges.
251 (TODO, not complete, avr and arm are different currently, need to be unified)
256 ----------------------
258 ----------------------
262 ----------------------
263 Windows Loading Firmware
264 ----------------------
268 ----------------------
270 ----------------------
274 ----------------------
275 Mac OS X Loading Firmware
276 ----------------------
282 ----------------------
284 ----------------------