├── .gitignore ├── .travis.yml ├── LICENSE ├── Makefile ├── Model01-Firmware.ino ├── README.md ├── library.properties ├── sketch.json └── src └── Model01-Firmware.h /.gitignore: -------------------------------------------------------------------------------- 1 | *~ 2 | .#* 3 | /output/ 4 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | dist: trusty 2 | sudo: false 3 | os: 4 | - linux 5 | install: 6 | - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Kaleidoscope-Bundle-Keyboardio hardware/keyboardio 7 | script: 8 | - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware 9 | notifications: 10 | email: 11 | on_success: change 12 | on_failure: change 13 | cache: 14 | ccache: true 15 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # This makefile for a Kaleidoscope sketch pulls in all the targets 2 | # required to build the example 3 | 4 | 5 | 6 | 7 | ifneq ($(KALEIDOSCOPE_DIR),) 8 | search_path += $(KALEIDOSCOPE_DIR) 9 | endif 10 | 11 | ifneq ($(ARDUINO_DIRECTORIES_USER),) 12 | search_path += $(ARDUINO_DIRECTORIES_USER)/hardware/keyboardio/avr/libraries/Kaleidoscope 13 | endif 14 | 15 | ifeq ($(shell uname -s),Darwin) 16 | search_path += $(HOME)/Documents/Arduino/hardware/keyboardio/avr/libraries/Kaleidoscope 17 | else 18 | search_path += $(HOME)/Arduino/hardware/keyboardio/avr/libraries/Kaleidoscope 19 | endif 20 | 21 | sketch_makefile := etc/makefiles/sketch.mk 22 | 23 | $(foreach candidate, $(search_path), $(if $(wildcard $(candidate)/$(sketch_makefile)), $(eval ks_dir ?= $(candidate)))) 24 | 25 | ifneq ($(ks_dir),) 26 | 27 | $(info Using Kaleidoscope from $(ks_dir)) 28 | 29 | export KALEIDOSCOPE_DIR := $(ks_dir) 30 | include $(ks_dir)/$(sketch_makefile) 31 | 32 | else 33 | 34 | $(info I can't find your Kaleidoscope installation.) 35 | $(info ) 36 | $(info I tried looking in:) 37 | $(info ) 38 | $(foreach candidate, $(search_path), $(info $(candidate))) 39 | $(info ) 40 | $(info The easiest way to fix this is to set the 'KALEIDOSCOPE_DIR' environment) 41 | $(info variable to the location of your Kaleidoscope directory.) 42 | 43 | endif 44 | 45 | 46 | null-target: 47 | $(info You should never see this message) 48 | @: 49 | -------------------------------------------------------------------------------- /Model01-Firmware.ino: -------------------------------------------------------------------------------- 1 | // -*- mode: c++ -*- 2 | // Copyright 2016 Keyboardio, inc. 3 | // See "LICENSE" for license details 4 | 5 | #ifndef BUILD_INFORMATION 6 | #define BUILD_INFORMATION "locally built on " __DATE__ " at " __TIME__ 7 | #endif 8 | 9 | 10 | /** 11 | * These #include directives pull in the Kaleidoscope firmware core, 12 | * as well as the Kaleidoscope plugins we use in the Model 01's firmware 13 | */ 14 | 15 | 16 | // The Kaleidoscope core 17 | #include "Kaleidoscope.h" 18 | 19 | // Support for storing the keymap in EEPROM 20 | #include "Kaleidoscope-EEPROM-Settings.h" 21 | #include "Kaleidoscope-EEPROM-Keymap.h" 22 | 23 | // Support for communicating with the host via a simple Serial protocol 24 | #include "Kaleidoscope-FocusSerial.h" 25 | 26 | // Support for keys that move the mouse 27 | #include "Kaleidoscope-MouseKeys.h" 28 | 29 | // Support for macros 30 | #include "Kaleidoscope-Macros.h" 31 | 32 | // Support for controlling the keyboard's LEDs 33 | #include "Kaleidoscope-LEDControl.h" 34 | 35 | // Support for "Numpad" mode, which is mostly just the Numpad specific LED mode 36 | #include "Kaleidoscope-NumPad.h" 37 | 38 | // Support for the "Boot greeting" effect, which pulses the 'LED' button for 10s 39 | // when the keyboard is connected to a computer (or that computer is powered on) 40 | #include "Kaleidoscope-LEDEffect-BootGreeting.h" 41 | 42 | // Support for LED modes that set all LEDs to a single color 43 | #include "Kaleidoscope-LEDEffect-SolidColor.h" 44 | 45 | // Support for an LED mode that makes all the LEDs 'breathe' 46 | #include "Kaleidoscope-LEDEffect-Breathe.h" 47 | 48 | // Support for an LED mode that makes a red pixel chase a blue pixel across the keyboard 49 | #include "Kaleidoscope-LEDEffect-Chase.h" 50 | 51 | // Support for LED modes that pulse the keyboard's LED in a rainbow pattern 52 | #include "Kaleidoscope-LEDEffect-Rainbow.h" 53 | 54 | // Support for an LED mode that lights up the keys as you press them 55 | #include "Kaleidoscope-LED-Stalker.h" 56 | 57 | // Support for an LED mode that prints the keys you press in letters 4px high 58 | #include "Kaleidoscope-LED-AlphaSquare.h" 59 | 60 | // Support for shared palettes for other plugins, like Colormap below 61 | #include "Kaleidoscope-LED-Palette-Theme.h" 62 | 63 | // Support for an LED mode that lets one configure per-layer color maps 64 | #include "Kaleidoscope-Colormap.h" 65 | 66 | // Support for Keyboardio's internal keyboard testing mode 67 | #include "Kaleidoscope-HardwareTestMode.h" 68 | 69 | // Support for host power management (suspend & wakeup) 70 | #include "Kaleidoscope-HostPowerManagement.h" 71 | 72 | // Support for magic combos (key chords that trigger an action) 73 | #include "Kaleidoscope-MagicCombo.h" 74 | 75 | // Support for USB quirks, like changing the key state report protocol 76 | #include "Kaleidoscope-USB-Quirks.h" 77 | 78 | /** This 'enum' is a list of all the macros used by the Model 01's firmware 79 | * The names aren't particularly important. What is important is that each 80 | * is unique. 81 | * 82 | * These are the names of your macros. They'll be used in two places. 83 | * The first is in your keymap definitions. There, you'll use the syntax 84 | * `M(MACRO_NAME)` to mark a specific keymap position as triggering `MACRO_NAME` 85 | * 86 | * The second usage is in the 'switch' statement in the `macroAction` function. 87 | * That switch statement actually runs the code associated with a macro when 88 | * a macro key is pressed. 89 | */ 90 | 91 | enum { MACRO_VERSION_INFO, 92 | MACRO_ANY 93 | }; 94 | 95 | 96 | 97 | /** The Model 01's key layouts are defined as 'keymaps'. By default, there are three 98 | * keymaps: The standard QWERTY keymap, the "Function layer" keymap and the "Numpad" 99 | * keymap. 100 | * 101 | * Each keymap is defined as a list using the 'KEYMAP_STACKED' macro, built 102 | * of first the left hand's layout, followed by the right hand's layout. 103 | * 104 | * Keymaps typically consist mostly of `Key_` definitions. There are many, many keys 105 | * defined as part of the USB HID Keyboard specification. You can find the names 106 | * (if not yet the explanations) for all the standard `Key_` defintions offered by 107 | * Kaleidoscope in these files: 108 | * https://github.com/keyboardio/Kaleidoscope/blob/master/src/kaleidoscope/key_defs_keyboard.h 109 | * https://github.com/keyboardio/Kaleidoscope/blob/master/src/kaleidoscope/key_defs_consumerctl.h 110 | * https://github.com/keyboardio/Kaleidoscope/blob/master/src/kaleidoscope/key_defs_sysctl.h 111 | * https://github.com/keyboardio/Kaleidoscope/blob/master/src/kaleidoscope/key_defs_keymaps.h 112 | * 113 | * Additional things that should be documented here include 114 | * using ___ to let keypresses fall through to the previously active layer 115 | * using XXX to mark a keyswitch as 'blocked' on this layer 116 | * using ShiftToLayer() and LockLayer() keys to change the active keymap. 117 | * keeping NUM and FN consistent and accessible on all layers 118 | * 119 | * The PROG key is special, since it is how you indicate to the board that you 120 | * want to flash the firmware. However, it can be remapped to a regular key. 121 | * When the keyboard boots, it first looks to see whether the PROG key is held 122 | * down; if it is, it simply awaits further flashing instructions. If it is 123 | * not, it continues loading the rest of the firmware and the keyboard 124 | * functions normally, with whatever binding you have set to PROG. More detail 125 | * here: https://community.keyboard.io/t/how-the-prog-key-gets-you-into-the-bootloader/506/8 126 | * 127 | * The "keymaps" data structure is a list of the keymaps compiled into the firmware. 128 | * The order of keymaps in the list is important, as the ShiftToLayer(#) and LockLayer(#) 129 | * macros switch to key layers based on this list. 130 | * 131 | * 132 | 133 | * A key defined as 'ShiftToLayer(FUNCTION)' will switch to FUNCTION while held. 134 | * Similarly, a key defined as 'LockLayer(NUMPAD)' will switch to NUMPAD when tapped. 135 | */ 136 | 137 | /** 138 | * Layers are "0-indexed" -- That is the first one is layer 0. The second one is layer 1. 139 | * The third one is layer 2. 140 | * This 'enum' lets us use names like QWERTY, FUNCTION, and NUMPAD in place of 141 | * the numbers 0, 1 and 2. 142 | * 143 | */ 144 | 145 | enum { PRIMARY, NUMPAD, FUNCTION }; // layers 146 | 147 | 148 | /** 149 | * To change your keyboard's layout from QWERTY to DVORAK or COLEMAK, comment out the line 150 | * 151 | * #define PRIMARY_KEYMAP_QWERTY 152 | * 153 | * by changing it to 154 | * 155 | * // #define PRIMARY_KEYMAP_QWERTY 156 | * 157 | * Then uncomment the line corresponding to the layout you want to use. 158 | * 159 | */ 160 | 161 | #define PRIMARY_KEYMAP_QWERTY 162 | // #define PRIMARY_KEYMAP_DVORAK 163 | // #define PRIMARY_KEYMAP_COLEMAK 164 | // #define PRIMARY_KEYMAP_CUSTOM 165 | 166 | 167 | 168 | /* This comment temporarily turns off astyle's indent enforcement 169 | * so we can make the keymaps actually resemble the physical key layout better 170 | */ 171 | // *INDENT-OFF* 172 | 173 | KEYMAPS( 174 | 175 | #if defined (PRIMARY_KEYMAP_QWERTY) 176 | [PRIMARY] = KEYMAP_STACKED 177 | (___, Key_1, Key_2, Key_3, Key_4, Key_5, Key_LEDEffectNext, 178 | Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, 179 | Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, 180 | Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, 181 | Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, 182 | ShiftToLayer(FUNCTION), 183 | 184 | M(MACRO_ANY), Key_6, Key_7, Key_8, Key_9, Key_0, LockLayer(NUMPAD), 185 | Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, 186 | Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, 187 | Key_RightAlt, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, 188 | Key_RightShift, Key_LeftAlt, Key_Spacebar, Key_RightControl, 189 | ShiftToLayer(FUNCTION)), 190 | 191 | #elif defined (PRIMARY_KEYMAP_DVORAK) 192 | 193 | [PRIMARY] = KEYMAP_STACKED 194 | (___, Key_1, Key_2, Key_3, Key_4, Key_5, Key_LEDEffectNext, 195 | Key_Backtick, Key_Quote, Key_Comma, Key_Period, Key_P, Key_Y, Key_Tab, 196 | Key_PageUp, Key_A, Key_O, Key_E, Key_U, Key_I, 197 | Key_PageDown, Key_Semicolon, Key_Q, Key_J, Key_K, Key_X, Key_Escape, 198 | Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, 199 | ShiftToLayer(FUNCTION), 200 | 201 | M(MACRO_ANY), Key_6, Key_7, Key_8, Key_9, Key_0, LockLayer(NUMPAD), 202 | Key_Enter, Key_F, Key_G, Key_C, Key_R, Key_L, Key_Slash, 203 | Key_D, Key_H, Key_T, Key_N, Key_S, Key_Minus, 204 | Key_RightAlt, Key_B, Key_M, Key_W, Key_V, Key_Z, Key_Equals, 205 | Key_RightShift, Key_LeftAlt, Key_Spacebar, Key_RightControl, 206 | ShiftToLayer(FUNCTION)), 207 | 208 | #elif defined (PRIMARY_KEYMAP_COLEMAK) 209 | 210 | [PRIMARY] = KEYMAP_STACKED 211 | (___, Key_1, Key_2, Key_3, Key_4, Key_5, Key_LEDEffectNext, 212 | Key_Backtick, Key_Q, Key_W, Key_F, Key_P, Key_G, Key_Tab, 213 | Key_PageUp, Key_A, Key_R, Key_S, Key_T, Key_D, 214 | Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, 215 | Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, 216 | ShiftToLayer(FUNCTION), 217 | 218 | M(MACRO_ANY), Key_6, Key_7, Key_8, Key_9, Key_0, LockLayer(NUMPAD), 219 | Key_Enter, Key_J, Key_L, Key_U, Key_Y, Key_Semicolon, Key_Equals, 220 | Key_H, Key_N, Key_E, Key_I, Key_O, Key_Quote, 221 | Key_RightAlt, Key_K, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, 222 | Key_RightShift, Key_LeftAlt, Key_Spacebar, Key_RightControl, 223 | ShiftToLayer(FUNCTION)), 224 | 225 | #elif defined (PRIMARY_KEYMAP_CUSTOM) 226 | // Edit this keymap to make a custom layout 227 | [PRIMARY] = KEYMAP_STACKED 228 | (___, Key_1, Key_2, Key_3, Key_4, Key_5, Key_LEDEffectNext, 229 | Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, 230 | Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, 231 | Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, 232 | Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, 233 | ShiftToLayer(FUNCTION), 234 | 235 | M(MACRO_ANY), Key_6, Key_7, Key_8, Key_9, Key_0, LockLayer(NUMPAD), 236 | Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, 237 | Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, 238 | Key_RightAlt, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, 239 | Key_RightShift, Key_LeftAlt, Key_Spacebar, Key_RightControl, 240 | ShiftToLayer(FUNCTION)), 241 | 242 | #else 243 | 244 | #error "No default keymap defined. You should make sure that you have a line like '#define PRIMARY_KEYMAP_QWERTY' in your sketch" 245 | 246 | #endif 247 | 248 | 249 | 250 | [NUMPAD] = KEYMAP_STACKED 251 | (___, ___, ___, ___, ___, ___, ___, 252 | ___, ___, ___, ___, ___, ___, ___, 253 | ___, ___, ___, ___, ___, ___, 254 | ___, ___, ___, ___, ___, ___, ___, 255 | ___, ___, ___, ___, 256 | ___, 257 | 258 | M(MACRO_VERSION_INFO), ___, Key_7, Key_8, Key_9, Key_KeypadSubtract, ___, 259 | ___, ___, Key_4, Key_5, Key_6, Key_KeypadAdd, ___, 260 | ___, Key_1, Key_2, Key_3, Key_Equals, ___, 261 | ___, ___, Key_0, Key_Period, Key_KeypadMultiply, Key_KeypadDivide, Key_Enter, 262 | ___, ___, ___, ___, 263 | ___), 264 | 265 | [FUNCTION] = KEYMAP_STACKED 266 | (___, Key_F1, Key_F2, Key_F3, Key_F4, Key_F5, Key_CapsLock, 267 | Key_Tab, ___, Key_mouseUp, ___, Key_mouseBtnR, Key_mouseWarpEnd, Key_mouseWarpNE, 268 | Key_Home, Key_mouseL, Key_mouseDn, Key_mouseR, Key_mouseBtnL, Key_mouseWarpNW, 269 | Key_End, Key_PrintScreen, Key_Insert, ___, Key_mouseBtnM, Key_mouseWarpSW, Key_mouseWarpSE, 270 | ___, Key_Delete, ___, ___, 271 | ___, 272 | 273 | Consumer_ScanPreviousTrack, Key_F6, Key_F7, Key_F8, Key_F9, Key_F10, Key_F11, 274 | Consumer_PlaySlashPause, Consumer_ScanNextTrack, Key_LeftCurlyBracket, Key_RightCurlyBracket, Key_LeftBracket, Key_RightBracket, Key_F12, 275 | Key_LeftArrow, Key_DownArrow, Key_UpArrow, Key_RightArrow, ___, ___, 276 | Key_PcApplication, Consumer_Mute, Consumer_VolumeDecrement, Consumer_VolumeIncrement, ___, Key_Backslash, Key_Pipe, 277 | ___, ___, Key_Enter, ___, 278 | ___) 279 | ) // KEYMAPS( 280 | 281 | /* Re-enable astyle's indent enforcement */ 282 | // *INDENT-ON* 283 | 284 | /** versionInfoMacro handles the 'firmware version info' macro 285 | * When a key bound to the macro is pressed, this macro 286 | * prints out the firmware build information as virtual keystrokes 287 | */ 288 | 289 | static void versionInfoMacro(uint8_t key_state) { 290 | if (keyToggledOn(key_state)) { 291 | Macros.type(PSTR("Keyboardio Model 01 - Kaleidoscope ")); 292 | Macros.type(PSTR(BUILD_INFORMATION)); 293 | } 294 | } 295 | 296 | /** anyKeyMacro is used to provide the functionality of the 'Any' key. 297 | * 298 | * When the 'any key' macro is toggled on, a random alphanumeric key is 299 | * selected. While the key is held, the function generates a synthetic 300 | * keypress event repeating that randomly selected key. 301 | * 302 | */ 303 | 304 | static void anyKeyMacro(KeyEvent &event) { 305 | if (keyToggledOn(event.state)) { 306 | event.key.setKeyCode(Key_A.getKeyCode() + (uint8_t)(millis() % 36)); 307 | event.key.setFlags(0); 308 | } 309 | } 310 | 311 | 312 | /** macroAction dispatches keymap events that are tied to a macro 313 | to that macro. It takes two uint8_t parameters. 314 | 315 | The first is the macro being called (the entry in the 'enum' earlier in this file). 316 | The second is the state of the keyswitch. You can use the keyswitch state to figure out 317 | if the key has just been toggled on, is currently pressed or if it's just been released. 318 | 319 | The 'switch' statement should have a 'case' for each entry of the macro enum. 320 | Each 'case' statement should call out to a function to handle the macro in question. 321 | 322 | */ 323 | 324 | const macro_t *macroAction(uint8_t macro_id, KeyEvent &event) { 325 | switch (macro_id) { 326 | 327 | case MACRO_VERSION_INFO: 328 | versionInfoMacro(event.state); 329 | break; 330 | 331 | case MACRO_ANY: 332 | anyKeyMacro(event); 333 | break; 334 | } 335 | return MACRO_NONE; 336 | } 337 | 338 | 339 | 340 | // These 'solid' color effect definitions define a rainbow of 341 | // LED color modes calibrated to draw 500mA or less on the 342 | // Keyboardio Model 01. 343 | 344 | 345 | static kaleidoscope::plugin::LEDSolidColor solidRed(160, 0, 0); 346 | static kaleidoscope::plugin::LEDSolidColor solidOrange(140, 70, 0); 347 | static kaleidoscope::plugin::LEDSolidColor solidYellow(130, 100, 0); 348 | static kaleidoscope::plugin::LEDSolidColor solidGreen(0, 160, 0); 349 | static kaleidoscope::plugin::LEDSolidColor solidBlue(0, 70, 130); 350 | static kaleidoscope::plugin::LEDSolidColor solidIndigo(0, 0, 170); 351 | static kaleidoscope::plugin::LEDSolidColor solidViolet(130, 0, 120); 352 | 353 | /** toggleLedsOnSuspendResume toggles the LEDs off when the host goes to sleep, 354 | * and turns them back on when it wakes up. 355 | */ 356 | void toggleLedsOnSuspendResume(kaleidoscope::plugin::HostPowerManagement::Event event) { 357 | switch (event) { 358 | case kaleidoscope::plugin::HostPowerManagement::Suspend: 359 | LEDControl.disable(); 360 | break; 361 | case kaleidoscope::plugin::HostPowerManagement::Resume: 362 | LEDControl.enable(); 363 | break; 364 | case kaleidoscope::plugin::HostPowerManagement::Sleep: 365 | break; 366 | } 367 | } 368 | 369 | /** hostPowerManagementEventHandler dispatches power management events (suspend, 370 | * resume, and sleep) to other functions that perform action based on these 371 | * events. 372 | */ 373 | void hostPowerManagementEventHandler(kaleidoscope::plugin::HostPowerManagement::Event event) { 374 | toggleLedsOnSuspendResume(event); 375 | } 376 | 377 | /** This 'enum' is a list of all the magic combos used by the Model 01's 378 | * firmware The names aren't particularly important. What is important is that 379 | * each is unique. 380 | * 381 | * These are the names of your magic combos. They will be used by the 382 | * `USE_MAGIC_COMBOS` call below. 383 | */ 384 | enum { 385 | // Toggle between Boot (6-key rollover; for BIOSes and early boot) and NKRO 386 | // mode. 387 | COMBO_TOGGLE_NKRO_MODE, 388 | // Enter test mode 389 | COMBO_ENTER_TEST_MODE 390 | }; 391 | 392 | /** Wrappers, to be used by MagicCombo. **/ 393 | 394 | /** 395 | * This simply toggles the keyboard protocol via USBQuirks, and wraps it within 396 | * a function with an unused argument, to match what MagicCombo expects. 397 | */ 398 | static void toggleKeyboardProtocol(uint8_t combo_index) { 399 | USBQuirks.toggleKeyboardProtocol(); 400 | } 401 | 402 | /** 403 | * This enters the hardware test mode 404 | */ 405 | static void enterHardwareTestMode(uint8_t combo_index) { 406 | HardwareTestMode.runTests(); 407 | } 408 | 409 | 410 | /** Magic combo list, a list of key combo and action pairs the firmware should 411 | * recognise. 412 | */ 413 | USE_MAGIC_COMBOS({.action = toggleKeyboardProtocol, 414 | // Left Fn + Esc + Shift 415 | .keys = { R3C6, R2C6, R3C7 } 416 | }, { 417 | .action = enterHardwareTestMode, 418 | // Left Fn + Prog + LED 419 | .keys = { R3C6, R0C0, R0C6 } 420 | }); 421 | 422 | // First, tell Kaleidoscope which plugins you want to use. 423 | // The order can be important. For example, LED effects are 424 | // added in the order they're listed here. 425 | KALEIDOSCOPE_INIT_PLUGINS( 426 | // The EEPROMSettings & EEPROMKeymap plugins make it possible to have an 427 | // editable keymap in EEPROM. 428 | EEPROMSettings, 429 | EEPROMKeymap, 430 | 431 | // Focus allows bi-directional communication with the host, and is the 432 | // interface through which the keymap in EEPROM can be edited. 433 | Focus, 434 | 435 | // FocusSettingsCommand adds a few Focus commands, intended to aid in 436 | // changing some settings of the keyboard, such as the default layer (via the 437 | // `settings.defaultLayer` command) 438 | FocusSettingsCommand, 439 | 440 | // FocusEEPROMCommand adds a set of Focus commands, which are very helpful in 441 | // both debugging, and in backing up one's EEPROM contents. 442 | FocusEEPROMCommand, 443 | 444 | // The boot greeting effect pulses the LED button for 10 seconds after the 445 | // keyboard is first connected 446 | BootGreetingEffect, 447 | 448 | // The hardware test mode, which can be invoked by tapping Prog, LED and the 449 | // left Fn button at the same time. 450 | HardwareTestMode, 451 | 452 | // LEDControl provides support for other LED modes 453 | LEDControl, 454 | 455 | // We start with the LED effect that turns off all the LEDs. 456 | LEDOff, 457 | 458 | // The rainbow effect changes the color of all of the keyboard's keys at the same time 459 | // running through all the colors of the rainbow. 460 | LEDRainbowEffect, 461 | 462 | // The rainbow wave effect lights up your keyboard with all the colors of a rainbow 463 | // and slowly moves the rainbow across your keyboard 464 | LEDRainbowWaveEffect, 465 | 466 | // The chase effect follows the adventure of a blue pixel which chases a red pixel across 467 | // your keyboard. Spoiler: the blue pixel never catches the red pixel 468 | LEDChaseEffect, 469 | 470 | // These static effects turn your keyboard's LEDs a variety of colors 471 | solidRed, solidOrange, solidYellow, solidGreen, solidBlue, solidIndigo, solidViolet, 472 | 473 | // The breathe effect slowly pulses all of the LEDs on your keyboard 474 | LEDBreatheEffect, 475 | 476 | // The AlphaSquare effect prints each character you type, using your 477 | // keyboard's LEDs as a display 478 | AlphaSquareEffect, 479 | 480 | // The stalker effect lights up the keys you've pressed recently 481 | StalkerEffect, 482 | 483 | // The LED Palette Theme plugin provides a shared palette for other plugins, 484 | // like Colormap below 485 | LEDPaletteTheme, 486 | 487 | // The Colormap effect makes it possible to set up per-layer colormaps 488 | ColormapEffect, 489 | 490 | // The numpad plugin is responsible for lighting up the 'numpad' mode 491 | // with a custom LED effect 492 | NumPad, 493 | 494 | // The macros plugin adds support for macros 495 | Macros, 496 | 497 | // The MouseKeys plugin lets you add keys to your keymap which move the mouse. 498 | MouseKeys, 499 | 500 | // The HostPowerManagement plugin allows us to turn LEDs off when then host 501 | // goes to sleep, and resume them when it wakes up. 502 | HostPowerManagement, 503 | 504 | // The MagicCombo plugin lets you use key combinations to trigger custom 505 | // actions - a bit like Macros, but triggered by pressing multiple keys at the 506 | // same time. 507 | MagicCombo, 508 | 509 | // The USBQuirks plugin lets you do some things with USB that we aren't 510 | // comfortable - or able - to do automatically, but can be useful 511 | // nevertheless. Such as toggling the key report protocol between Boot (used 512 | // by BIOSes) and Report (NKRO). 513 | USBQuirks 514 | ); 515 | 516 | /** The 'setup' function is one of the two standard Arduino sketch functions. 517 | * It's called when your keyboard first powers up. This is where you set up 518 | * Kaleidoscope and any plugins. 519 | */ 520 | void setup() { 521 | // First, call Kaleidoscope's internal setup function 522 | Kaleidoscope.setup(); 523 | 524 | // While we hope to improve this in the future, the NumPad plugin 525 | // needs to be explicitly told which keymap layer is your numpad layer 526 | NumPad.numPadLayer = NUMPAD; 527 | 528 | // We configure the AlphaSquare effect to use RED letters 529 | AlphaSquare.color = CRGB(255, 0, 0); 530 | 531 | // We set the brightness of the rainbow effects to 150 (on a scale of 0-255) 532 | // This draws more than 500mA, but looks much nicer than a dimmer effect 533 | LEDRainbowEffect.brightness(150); 534 | LEDRainbowWaveEffect.brightness(150); 535 | 536 | // Set the action key the test mode should listen for to Left Fn 537 | HardwareTestMode.setActionKey(R3C6); 538 | 539 | // The LED Stalker mode has a few effects. The one we like is called 540 | // 'BlazingTrail'. For details on other options, see 541 | // https://github.com/keyboardio/Kaleidoscope/blob/master/docs/plugins/LED-Stalker.md 542 | StalkerEffect.variant = STALKER(BlazingTrail); 543 | 544 | // We want to make sure that the firmware starts with LED effects off 545 | // This avoids over-taxing devices that don't have a lot of power to share 546 | // with USB devices 547 | LEDOff.activate(); 548 | 549 | // To make the keymap editable without flashing new firmware, we store 550 | // additional layers in EEPROM. For now, we reserve space for five layers. If 551 | // one wants to use these layers, just set the default layer to one in EEPROM, 552 | // by using the `settings.defaultLayer` Focus command, or by using the 553 | // `keymap.onlyCustom` command to use EEPROM layers only. 554 | EEPROMKeymap.setup(5); 555 | 556 | // We need to tell the Colormap plugin how many layers we want to have custom 557 | // maps for. To make things simple, we set it to five layers, which is how 558 | // many editable layers we have (see above). 559 | ColormapEffect.max_layers(5); 560 | } 561 | 562 | /** loop is the second of the standard Arduino sketch functions. 563 | * As you might expect, it runs in a loop, never exiting. 564 | * 565 | * For Kaleidoscope-based keyboard firmware, you usually just want to 566 | * call Kaleidoscope.loop(); and not do anything custom here. 567 | */ 568 | 569 | void loop() { 570 | Kaleidoscope.loop(); 571 | } 572 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Keyboardio Model 01 Firmware 2 | 3 | This is the source code for the default firmware for the Keyboardio Model 01, as shipped from the factory. 4 | 5 | If you don't intend to customize your keyboard's firmware, you may want to consider using [Chrysalis](https://github.com/keyboardio/Chrysalis), our graphical configuration tool instead. 6 | 7 | To use or customize this firmware, you need to have Arduino and Kaleidoscope installed on your computer. 8 | 9 | If you don't yet have Kaleidoscope and Arduino installed on your computer, [set them up now](https://kaleidoscope.readthedocs.io/en/latest/setup_toolchain.html) 10 | 11 | 12 | ## Download the Model 01 Firmware 13 | 14 | ```sh 15 | git clone https://github.com/keyboardio/Model01-Firmware.git 16 | ``` 17 | 18 | # Build and flash the firmware 19 | 20 | Before you begin, make sure your Model 01 is connected to your computer. 21 | 22 | Open the sketch you wish to flash (for example, `Model01-Firmware.ino`). 23 | 24 | Make sure that you've picked the Model 01 from the Boards list in the tools menu. 25 | 26 | Click the Upload button or press `Ctrl-U`. 27 | 28 | Hold down the "Prog" key in the top left corner of your keyboard, until the compile finishes and the upload begins. 29 | 30 | # Start to customize the firmware 31 | 32 | You can customize your keyboard's key layout and LED effects by modifying the `Model01-Firmware.ino` file in the same directory as this README. Model01-Firmware.ino is a computer program written in 'Arduino C'. You can find documentation about Arduino C at https://arduino.cc. 33 | 34 | # Getting help 35 | 36 | As you start to explore customization of your keyboard's firmware, the community at https://community.keyboard.io can often be a valuable resource. 37 | 38 | # Thanks! 39 | 40 | <3 jesse 41 | 42 | [![Build Status](https://travis-ci.org/keyboardio/Model01-Firmware.svg?branch=master)](https://travis-ci.org/keyboardio/Model01-Firmware) 43 | -------------------------------------------------------------------------------- /library.properties: -------------------------------------------------------------------------------- 1 | name=Model01-Firmware 2 | version=1.0 3 | author=Jesse Vincent 4 | maintainer=Jesse Vincent 5 | sentence=The reference firmware for the Keyboardio Model 01 6 | paragraph=Keyboard firmware! 7 | category=Communication 8 | url=https://keyboard.io 9 | architectures=avr 10 | 11 | -------------------------------------------------------------------------------- /sketch.json: -------------------------------------------------------------------------------- 1 | { 2 | "cpu": { 3 | "fqbn": "keyboardio:avr:model01", 4 | "port": "" 5 | } 6 | } -------------------------------------------------------------------------------- /src/Model01-Firmware.h: -------------------------------------------------------------------------------- 1 | // Lets make cpplint happy! 2 | #pragma once 3 | --------------------------------------------------------------------------------