From db09b35be3e7d378f470f5e441228df5fe13130d Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 25 Feb 2017 23:32:40 +0100 Subject: [PATCH 01/59] Initial import Signed-off-by: Gergely Nagy --- .gitignore | 4 + .travis.yml | 19 + COPYING | 674 +++++++++++++++++++++++ README.md | 42 ++ examples/EEPROM-Keymap/EEPROM-Keymap.ino | 57 ++ library.properties | 10 + src/Kaleidoscope-EEPROM-Keymap.h | 21 + src/Kaleidoscope/EEPROM-Keymap.cpp | 189 +++++++ src/Kaleidoscope/EEPROM-Keymap.h | 59 ++ 9 files changed, 1075 insertions(+) create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 COPYING create mode 100644 README.md create mode 100644 examples/EEPROM-Keymap/EEPROM-Keymap.ino create mode 100644 library.properties create mode 100644 src/Kaleidoscope-EEPROM-Keymap.h create mode 100644 src/Kaleidoscope/EEPROM-Keymap.cpp create mode 100644 src/Kaleidoscope/EEPROM-Keymap.h diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..be16c9be --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +.#* +*~ +/hardware/ +/output/ \ No newline at end of file diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 00000000..b5ff1273 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,19 @@ +language: cpp +dist: trusty +sudo: required +os: + - linux +before_install: + - pushd .. + - wget http://downloads.arduino.cc/arduino-1.6.11-linux64.tar.xz + - tar xf arduino-1.6.11-linux64.tar.xz + - popd +install: + - git clone --recurse-submodules https://github.com/keyboardio/Arduino-Boards hardware/keyboardio/avr + - ln -s $(pwd) hardware/keyboardio/avr/libraries/Kaleidoscope-EEPROM-Settings +script: + - export DEFAULT_SKETCH=$(cd examples; basename *) + - export ARDUINO_PATH=$(pwd)/../arduino-1.6.11 + - export BOARD_HARDWARE_PATH=$(pwd)/hardware + - export EXTRA_BUILDER_ARGS="-libraries ." + - hardware/keyboardio/avr/libraries/Kaleidoscope/tools/kaleidoscope-builder build diff --git a/COPYING b/COPYING new file mode 100644 index 00000000..94a9ed02 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 00000000..f7bda3ef --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# Kaleidoscope-EEPROM-Keymap + +![status][st:experimental] [![Build Status][travis:image]][travis:status] + + [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-EEPROM-Keymap.svg?branch=master + [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-EEPROM-Keymap + + [st:stable]: https://img.shields.io/badge/stable-✔-black.png?style=flat&colorA=44cc11&colorB=494e52 + [st:broken]: https://img.shields.io/badge/broken-X-black.png?style=flat&colorA=e05d44&colorB=494e52 + [st:experimental]: https://img.shields.io/badge/experimental----black.png?style=flat&colorA=dfb317&colorB=494e52 + +TODO + +## Using the plugin + +TODO + +```c++ +#include +#include + +void setup () { + Kaleidoscope.setup (); + + USE_PLUGINS (&EEPROMKeymap); + + // TODO +} +``` + +## Plugin methods + +The plugin provides the `EEPROMKeymap` object, which has the following methods: + +**TODO** + +## Further reading + +Starting from the [example][plugin:example] is the recommended way of getting +started with the plugin. + + [plugin:example]: https://github.com/keyboardio/Kaleidoscope-EEPROM-Keymap/blob/master/examples/EEPROM-Keymap/EEPROM-Keymap.ino diff --git a/examples/EEPROM-Keymap/EEPROM-Keymap.ino b/examples/EEPROM-Keymap/EEPROM-Keymap.ino new file mode 100644 index 00000000..e1f1a470 --- /dev/null +++ b/examples/EEPROM-Keymap/EEPROM-Keymap.ino @@ -0,0 +1,57 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-EEPROM-Keymap -- EEPROM-based keymap support. + * Copyright (C) 2017 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#include +#include +#include + +const Key keymaps[][ROWS][COLS] PROGMEM = { + [0] = KEYMAP_STACKED + ( + Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, + Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, + Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, + Key_PageDn, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Esc, + + Key_LCtrl, Key_Backspace, Key_LGUI, Key_LShift, + Key_skip, + + Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, + Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, + + Key_RShift, Key_RAlt, Key_Space, Key_RCtrl, + Key_skip + ), +}; + +void setup () { + Serial.begin (9600); + + Kaleidoscope.setup (); + + USE_PLUGINS (&EEPROMKeymap, &Focus); + + Focus.addCommand (FOCUS_CMD_KEYMAP); + Layer.getKey = EEPROMKeymap.getKey; +} + +void loop () { + Kaleidoscope.loop (); +} diff --git a/library.properties b/library.properties new file mode 100644 index 00000000..4e0b6dbc --- /dev/null +++ b/library.properties @@ -0,0 +1,10 @@ +name=Kaleidoscope-EEPROM-Keymap +version=0.0.0 +author=Gergely Nagy +maintainer=Gergely Nagy +sentence=EEPROM-based keymap support for Kaleidoscope. +paragraph=... +category=Communication +url=https://github.com/keyboardio/Kaleidoscope-EEPROM-Keymap +architectures=avr +dot_a_linkage=true diff --git a/src/Kaleidoscope-EEPROM-Keymap.h b/src/Kaleidoscope-EEPROM-Keymap.h new file mode 100644 index 00000000..77d64c5c --- /dev/null +++ b/src/Kaleidoscope-EEPROM-Keymap.h @@ -0,0 +1,21 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-EEPROM-Keymap -- EEPROM-based keymap support. + * Copyright (C) 2017 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#pragma once + +#include diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp new file mode 100644 index 00000000..5ec287c3 --- /dev/null +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -0,0 +1,189 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-EEPROM-Keymap -- EEPROM-based keymap support. + * Copyright (C) 2017 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#include +#include + +namespace KaleidoscopePlugins { + uint16_t EEPROMKeymap::keymapBase; + uint8_t EEPROMKeymap::maxLayers; + + EEPROMKeymap::EEPROMKeymap (void) { + } + + void + EEPROMKeymap::begin (void) { + USE_PLUGINS (&::EEPROMSettings); + + uint16_t layerSize = ROWS * COLS * 2; + maxLayers = (E2END - ::EEPROMSettings.endOfSettings ()) / layerSize; + keymapBase = ::EEPROMSettings.endOfSettings () + 1; + } + + Key + EEPROMKeymap::getKey (uint8_t layer, byte row, byte col) { + Key key; + + if (layer >= maxLayers) + return Key_NoKey; + + uint16_t pos = ((layer * ROWS * COLS) + (row * COLS) + col) * 2; + + key.flags = EEPROM.read (keymapBase + pos); + key.keyCode = EEPROM.read (keymapBase + pos + 1); + + if (key.raw == 0xffff) + return Key_NoKey; + + return key; + } + + uint16_t + EEPROMKeymap::base (void) { + return keymapBase; + } + + bool + EEPROMKeymap::focusKeymap (const char *command) { + enum { + UPLOAD, + GETPOS, + SETPOS, + DUMP, + TRANSFER, + } subCommand; + + if (strncmp_P (command, PSTR ("keymap."), 7) != 0) + return false; + + if (strcmp_P (command + 7, PSTR ("upload")) == 0) + subCommand = UPLOAD; + else if (strcmp_P (command + 7, PSTR ("dump")) == 0) + subCommand = DUMP; + else if (strcmp_P (command + 7, PSTR ("transfer")) == 0) + subCommand = TRANSFER; + else if (strcmp_P (command + 7, PSTR ("getPos")) == 0) + subCommand = GETPOS; + else if (strcmp_P (command + 7, PSTR ("setPos")) == 0) + subCommand = SETPOS; + else + return false; + + switch (subCommand) { + case UPLOAD: + { + uint16_t i = 0; + while ((Serial.peek () != '\n') && (i < ROWS * COLS * maxLayers)) { + uint8_t flags = Serial.parseInt (); + uint8_t keyCode = Serial.parseInt (); + uint16_t pos = i * 2; + EEPROM.update (keymapBase + pos, flags); + EEPROM.update (keymapBase + pos + 1, keyCode); + i++; + } + break; + } + + case GETPOS: + { + uint8_t layer = Serial.parseInt (); + uint8_t row = Serial.parseInt (); + uint8_t col = Serial.parseInt (); + + Key k = getKey (layer, row, col); + + Serial.print (k.flags); + Serial.print (F(" ")); + Serial.println (k.keyCode); + + break; + } + + case DUMP: + { + for (uint8_t layer = 0; layer < 4; layer++) { + for (uint8_t row = 0; row < ROWS; row++) { + for (uint8_t col = 0; col < COLS; col++) { + Key k = getKey (layer, row, col); + + if (k.flags < 10) + Serial.print (F(" ")); + if (k.flags < 100) + Serial.print (F(" ")); + Serial.print (k.flags); + Serial.print (F(" ")); + + if (k.keyCode < 10) + Serial.print (F(" ")); + if (k.keyCode < 100) + Serial.print (F(" ")); + Serial.print (k.keyCode); + + if (col < COLS - 1) + Serial.print (F(" ")); + } + Serial.println (); + } + Serial.println (); + } + break; + } + + case SETPOS: + { + uint8_t layer = Serial.parseInt (); + uint8_t row = Serial.parseInt (); + uint8_t col = Serial.parseInt (); + uint8_t flags = Serial.parseInt (); + uint8_t keyCode = Serial.parseInt (); + + uint16_t pos = ((layer * ROWS * COLS) + (row * COLS) + col) * 2; + + EEPROM.update (keymapBase + pos, flags); + EEPROM.update (keymapBase + pos + 1, keyCode); + + break; + } + + case TRANSFER: + { + uint8_t layer = Serial.parseInt (); + + for (uint8_t row = 0; row < ROWS; row++) { + for (uint8_t col = 0; col < COLS; col++) { + Key k = Layer.getKeyFromPROGMEM (layer, row, col); + uint16_t pos = ((layer * ROWS * COLS) + (row * COLS) + col) * 2; + + EEPROM.update (keymapBase + pos, k.flags); + EEPROM.update (keymapBase + pos + 1, k.keyCode); + } + } + + break; + } + + } + + Serial.read (); + + return true; + } + +}; + +KaleidoscopePlugins::EEPROMKeymap EEPROMKeymap; diff --git a/src/Kaleidoscope/EEPROM-Keymap.h b/src/Kaleidoscope/EEPROM-Keymap.h new file mode 100644 index 00000000..e80b6cb0 --- /dev/null +++ b/src/Kaleidoscope/EEPROM-Keymap.h @@ -0,0 +1,59 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-EEPROM-Keymap -- EEPROM-based keymap support. + * Copyright (C) 2017 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#include +#include + +#define FOCUS_CMD_KEYMAP FOCUS_COMMAND(EEPROMKeymap.focusKeymap, \ + "keymap.dump\n" \ + "-----------\n" \ + "Dumps the keymap from EEPROM.\n\n" \ + "keymap.upload ...\n" \ + "-------------------------------\n" \ + "Uploads a new keymap to EEPROM." \ + "Starts at layer 0, row 0, column 0, " \ + "and continues as long as there is data on the line.\n\n" \ + "keymap.setPos layer row column flag keyCode\n" \ + "-------------------------------------------\n" \ + "Sets the key at the specified `layer`, `row`, and `column` " \ + "to the key with `flag`, and `keyCode` properties.\n\n" \ + "keymap.getPos layer row column\n" \ + "------------------------------\n" \ + "Dump the key at `layer`, `row`, and `column`.\n\n" \ + "keymap.transfer layer\n" \ + "---------------------\n" \ + "Transfers the `layer` from PROGMEM to EEPROM.") + +namespace KaleidoscopePlugins { + class EEPROMKeymap : public KaleidoscopePlugin { + public: + EEPROMKeymap (void); + + virtual void begin (void) final; + + static Key getKey (uint8_t layer, byte row, byte col); + static uint16_t base (void); + static bool focusKeymap (const char *command); + + private: + static uint16_t keymapBase; + static uint8_t maxLayers; + }; +}; + +extern KaleidoscopePlugins::EEPROMKeymap EEPROMKeymap; From 03ab5f1a474cfabf8303e0fbb70900039c3c4a11 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 26 Feb 2017 09:04:13 +0100 Subject: [PATCH 02/59] Updated to support newest Focus Signed-off-by: Gergely Nagy --- examples/EEPROM-Keymap/EEPROM-Keymap.ino | 5 +++- src/Kaleidoscope/EEPROM-Keymap.h | 38 ++++++++++++------------ 2 files changed, 23 insertions(+), 20 deletions(-) diff --git a/examples/EEPROM-Keymap/EEPROM-Keymap.ino b/examples/EEPROM-Keymap/EEPROM-Keymap.ino index e1f1a470..9bdd3656 100644 --- a/examples/EEPROM-Keymap/EEPROM-Keymap.ino +++ b/examples/EEPROM-Keymap/EEPROM-Keymap.ino @@ -48,7 +48,10 @@ void setup () { USE_PLUGINS (&EEPROMKeymap, &Focus); - Focus.addCommand (FOCUS_CMD_KEYMAP); + Focus.addHook (FOCUS_HOOK_KEYMAP); + Focus.addHook (FOCUS_HOOK_HELP); + Focus.addHook (FOCUS_HOOK_VERSION); + Layer.getKey = EEPROMKeymap.getKey; } diff --git a/src/Kaleidoscope/EEPROM-Keymap.h b/src/Kaleidoscope/EEPROM-Keymap.h index e80b6cb0..65a77cd4 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.h +++ b/src/Kaleidoscope/EEPROM-Keymap.h @@ -19,25 +19,25 @@ #include #include -#define FOCUS_CMD_KEYMAP FOCUS_COMMAND(EEPROMKeymap.focusKeymap, \ - "keymap.dump\n" \ - "-----------\n" \ - "Dumps the keymap from EEPROM.\n\n" \ - "keymap.upload ...\n" \ - "-------------------------------\n" \ - "Uploads a new keymap to EEPROM." \ - "Starts at layer 0, row 0, column 0, " \ - "and continues as long as there is data on the line.\n\n" \ - "keymap.setPos layer row column flag keyCode\n" \ - "-------------------------------------------\n" \ - "Sets the key at the specified `layer`, `row`, and `column` " \ - "to the key with `flag`, and `keyCode` properties.\n\n" \ - "keymap.getPos layer row column\n" \ - "------------------------------\n" \ - "Dump the key at `layer`, `row`, and `column`.\n\n" \ - "keymap.transfer layer\n" \ - "---------------------\n" \ - "Transfers the `layer` from PROGMEM to EEPROM.") +#define FOCUS_HOOK_KEYMAP FOCUS_HOOK(EEPROMKeymap.focusKeymap, \ + "keymap.dump\n" \ + "-----------\n" \ + "Dumps the keymap from EEPROM.\n\n" \ + "keymap.upload ...\n" \ + "-------------------------------\n" \ + "Uploads a new keymap to EEPROM." \ + "Starts at layer 0, row 0, column 0, " \ + "and continues as long as there is data on the line.\n\n" \ + "keymap.setPos layer row column flag keyCode\n" \ + "-------------------------------------------\n" \ + "Sets the key at the specified `layer`, `row`, and `column` " \ + "to the key with `flag`, and `keyCode` properties.\n\n" \ + "keymap.getPos layer row column\n" \ + "------------------------------\n" \ + "Dump the key at `layer`, `row`, and `column`.\n\n" \ + "keymap.transfer layer\n" \ + "---------------------\n" \ + "Transfers the `layer` from PROGMEM to EEPROM.") namespace KaleidoscopePlugins { class EEPROMKeymap : public KaleidoscopePlugin { From 73c0f86d37ef7d162e4c1292d409c7afaf18bad6 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 26 Feb 2017 10:16:47 +0100 Subject: [PATCH 03/59] Add a missing #pragma once Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Keymap.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/Kaleidoscope/EEPROM-Keymap.h b/src/Kaleidoscope/EEPROM-Keymap.h index 65a77cd4..1267c1bf 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.h +++ b/src/Kaleidoscope/EEPROM-Keymap.h @@ -16,6 +16,8 @@ * along with this program. If not, see . */ +#pragma once + #include #include From 00b836d0ace5934eb98519dfe4c1fc4637b97460 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 26 Feb 2017 10:24:49 +0100 Subject: [PATCH 04/59] Code optimalization Lift out the key updating code into a private method. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Keymap.cpp | 33 +++++++++++++++++------------- src/Kaleidoscope/EEPROM-Keymap.h | 2 ++ 2 files changed, 21 insertions(+), 14 deletions(-) diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index 5ec287c3..add87f78 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -58,6 +58,12 @@ namespace KaleidoscopePlugins { return keymapBase; } + void + EEPROMKeymap::updateKey (uint16_t basePos, Key key) { + EEPROM.update (keymapBase + basePos * 2, key.flags); + EEPROM.update (keymapBase + basePos * 2 + 1, key.keyCode); + } + bool EEPROMKeymap::focusKeymap (const char *command) { enum { @@ -89,11 +95,12 @@ namespace KaleidoscopePlugins { { uint16_t i = 0; while ((Serial.peek () != '\n') && (i < ROWS * COLS * maxLayers)) { - uint8_t flags = Serial.parseInt (); - uint8_t keyCode = Serial.parseInt (); - uint16_t pos = i * 2; - EEPROM.update (keymapBase + pos, flags); - EEPROM.update (keymapBase + pos + 1, keyCode); + Key key; + + key.flags = Serial.parseInt (); + key.keyCode = Serial.parseInt (); + updateKey (i, key); + i++; } break; @@ -149,13 +156,12 @@ namespace KaleidoscopePlugins { uint8_t layer = Serial.parseInt (); uint8_t row = Serial.parseInt (); uint8_t col = Serial.parseInt (); - uint8_t flags = Serial.parseInt (); - uint8_t keyCode = Serial.parseInt (); - - uint16_t pos = ((layer * ROWS * COLS) + (row * COLS) + col) * 2; + Key key; + key.flags = Serial.parseInt (); + key.keyCode = Serial.parseInt (); - EEPROM.update (keymapBase + pos, flags); - EEPROM.update (keymapBase + pos + 1, keyCode); + uint16_t pos = ((layer * ROWS * COLS) + (row * COLS) + col); + updateKey (pos, key); break; } @@ -167,10 +173,9 @@ namespace KaleidoscopePlugins { for (uint8_t row = 0; row < ROWS; row++) { for (uint8_t col = 0; col < COLS; col++) { Key k = Layer.getKeyFromPROGMEM (layer, row, col); - uint16_t pos = ((layer * ROWS * COLS) + (row * COLS) + col) * 2; + uint16_t pos = ((layer * ROWS * COLS) + (row * COLS) + col); - EEPROM.update (keymapBase + pos, k.flags); - EEPROM.update (keymapBase + pos + 1, k.keyCode); + updateKey (pos, k); } } diff --git a/src/Kaleidoscope/EEPROM-Keymap.h b/src/Kaleidoscope/EEPROM-Keymap.h index 1267c1bf..92fc2e13 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.h +++ b/src/Kaleidoscope/EEPROM-Keymap.h @@ -55,6 +55,8 @@ namespace KaleidoscopePlugins { private: static uint16_t keymapBase; static uint8_t maxLayers; + + static void updateKey (uint16_t basePos, Key key); }; }; From 45391388dbb57ac34503f4372a38e897d9f43613 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 26 Feb 2017 10:25:21 +0100 Subject: [PATCH 05/59] Move the Focus hook into a separate file Signed-off-by: Gergely Nagy --- src/Kaleidoscope-EEPROM-Keymap.h | 1 + src/Kaleidoscope/EEPROM-Keymap-Focus.h | 42 ++++++++++++++++++++++++++ src/Kaleidoscope/EEPROM-Keymap.h | 20 ------------ 3 files changed, 43 insertions(+), 20 deletions(-) create mode 100644 src/Kaleidoscope/EEPROM-Keymap-Focus.h diff --git a/src/Kaleidoscope-EEPROM-Keymap.h b/src/Kaleidoscope-EEPROM-Keymap.h index 77d64c5c..fec376e8 100644 --- a/src/Kaleidoscope-EEPROM-Keymap.h +++ b/src/Kaleidoscope-EEPROM-Keymap.h @@ -19,3 +19,4 @@ #pragma once #include +#include diff --git a/src/Kaleidoscope/EEPROM-Keymap-Focus.h b/src/Kaleidoscope/EEPROM-Keymap-Focus.h new file mode 100644 index 00000000..5e72184d --- /dev/null +++ b/src/Kaleidoscope/EEPROM-Keymap-Focus.h @@ -0,0 +1,42 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-EEPROM-Keymap -- EEPROM-based keymap support. + * Copyright (C) 2017 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#pragma once + +#include +#include + +#define FOCUS_HOOK_KEYMAP FOCUS_HOOK(EEPROMKeymap.focusKeymap, \ + "keymap.dump\n" \ + "-----------\n" \ + "Dumps the keymap from EEPROM.\n\n" \ + "keymap.upload ...\n" \ + "-------------------------------\n" \ + "Uploads a new keymap to EEPROM." \ + "Starts at layer 0, row 0, column 0, " \ + "and continues as long as there is data on the line.\n\n" \ + "keymap.setPos layer row column flag keyCode\n" \ + "-------------------------------------------\n" \ + "Sets the key at the specified `layer`, `row`, and `column` " \ + "to the key with `flag`, and `keyCode` properties.\n\n" \ + "keymap.getPos layer row column\n" \ + "------------------------------\n" \ + "Dump the key at `layer`, `row`, and `column`.\n\n" \ + "keymap.transfer layer\n" \ + "---------------------\n" \ + "Transfers the `layer` from PROGMEM to EEPROM.") diff --git a/src/Kaleidoscope/EEPROM-Keymap.h b/src/Kaleidoscope/EEPROM-Keymap.h index 92fc2e13..5dedee66 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.h +++ b/src/Kaleidoscope/EEPROM-Keymap.h @@ -21,26 +21,6 @@ #include #include -#define FOCUS_HOOK_KEYMAP FOCUS_HOOK(EEPROMKeymap.focusKeymap, \ - "keymap.dump\n" \ - "-----------\n" \ - "Dumps the keymap from EEPROM.\n\n" \ - "keymap.upload ...\n" \ - "-------------------------------\n" \ - "Uploads a new keymap to EEPROM." \ - "Starts at layer 0, row 0, column 0, " \ - "and continues as long as there is data on the line.\n\n" \ - "keymap.setPos layer row column flag keyCode\n" \ - "-------------------------------------------\n" \ - "Sets the key at the specified `layer`, `row`, and `column` " \ - "to the key with `flag`, and `keyCode` properties.\n\n" \ - "keymap.getPos layer row column\n" \ - "------------------------------\n" \ - "Dump the key at `layer`, `row`, and `column`.\n\n" \ - "keymap.transfer layer\n" \ - "---------------------\n" \ - "Transfers the `layer` from PROGMEM to EEPROM.") - namespace KaleidoscopePlugins { class EEPROMKeymap : public KaleidoscopePlugin { public: From 807d18ab31bfe84055d5d0773c6213d152bc31a0 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 26 Feb 2017 10:28:54 +0100 Subject: [PATCH 06/59] Nicer dump output Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Keymap.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index add87f78..3bc46b2d 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -142,7 +142,7 @@ namespace KaleidoscopePlugins { Serial.print (k.keyCode); if (col < COLS - 1) - Serial.print (F(" ")); + Serial.print (F(" | ")); } Serial.println (); } From 80178956e41ee4a3c08c14d348705421e97b4086 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 26 Feb 2017 13:09:33 +0100 Subject: [PATCH 07/59] Travis: Remove obsolete workarounds Signed-off-by: Gergely Nagy --- .travis.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.travis.yml b/.travis.yml index b5ff1273..ed2b2e3b 100644 --- a/.travis.yml +++ b/.travis.yml @@ -10,10 +10,8 @@ before_install: - popd install: - git clone --recurse-submodules https://github.com/keyboardio/Arduino-Boards hardware/keyboardio/avr - - ln -s $(pwd) hardware/keyboardio/avr/libraries/Kaleidoscope-EEPROM-Settings script: - export DEFAULT_SKETCH=$(cd examples; basename *) - export ARDUINO_PATH=$(pwd)/../arduino-1.6.11 - export BOARD_HARDWARE_PATH=$(pwd)/hardware - - export EXTRA_BUILDER_ARGS="-libraries ." - hardware/keyboardio/avr/libraries/Kaleidoscope/tools/kaleidoscope-builder build From 33f5d8d9de24b5720e757e1beae417427079c413 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 28 Feb 2017 09:42:32 +0100 Subject: [PATCH 08/59] Some small code optimizations Lifted out a few things from the main `focusKeymap` method, to make code size smaller. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Keymap.cpp | 55 ++++++++++++++++-------------- src/Kaleidoscope/EEPROM-Keymap.h | 2 ++ 2 files changed, 32 insertions(+), 25 deletions(-) diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index 3bc46b2d..5a737175 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -64,6 +64,32 @@ namespace KaleidoscopePlugins { EEPROM.update (keymapBase + basePos * 2 + 1, key.keyCode); } + Key + EEPROMKeymap::parseKey (void) { + Key key; + + key.flags = Serial.parseInt (); + key.keyCode = Serial.parseInt (); + + return key; + } + + void + EEPROMKeymap::printKey (Key k) { + if (k.flags < 10) + Serial.print (F(" ")); + if (k.flags < 100) + Serial.print (F(" ")); + Serial.print (k.flags); + Serial.print (F(" ")); + + if (k.keyCode < 10) + Serial.print (F(" ")); + if (k.keyCode < 100) + Serial.print (F(" ")); + Serial.print (k.keyCode); + } + bool EEPROMKeymap::focusKeymap (const char *command) { enum { @@ -95,12 +121,7 @@ namespace KaleidoscopePlugins { { uint16_t i = 0; while ((Serial.peek () != '\n') && (i < ROWS * COLS * maxLayers)) { - Key key; - - key.flags = Serial.parseInt (); - key.keyCode = Serial.parseInt (); - updateKey (i, key); - + updateKey (i, parseKey ()); i++; } break; @@ -114,9 +135,7 @@ namespace KaleidoscopePlugins { Key k = getKey (layer, row, col); - Serial.print (k.flags); - Serial.print (F(" ")); - Serial.println (k.keyCode); + printKey (k); break; } @@ -128,18 +147,7 @@ namespace KaleidoscopePlugins { for (uint8_t col = 0; col < COLS; col++) { Key k = getKey (layer, row, col); - if (k.flags < 10) - Serial.print (F(" ")); - if (k.flags < 100) - Serial.print (F(" ")); - Serial.print (k.flags); - Serial.print (F(" ")); - - if (k.keyCode < 10) - Serial.print (F(" ")); - if (k.keyCode < 100) - Serial.print (F(" ")); - Serial.print (k.keyCode); + printKey (k); if (col < COLS - 1) Serial.print (F(" | ")); @@ -156,12 +164,9 @@ namespace KaleidoscopePlugins { uint8_t layer = Serial.parseInt (); uint8_t row = Serial.parseInt (); uint8_t col = Serial.parseInt (); - Key key; - key.flags = Serial.parseInt (); - key.keyCode = Serial.parseInt (); uint16_t pos = ((layer * ROWS * COLS) + (row * COLS) + col); - updateKey (pos, key); + updateKey (pos, parseKey ()); break; } diff --git a/src/Kaleidoscope/EEPROM-Keymap.h b/src/Kaleidoscope/EEPROM-Keymap.h index 5dedee66..83809a89 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.h +++ b/src/Kaleidoscope/EEPROM-Keymap.h @@ -37,6 +37,8 @@ namespace KaleidoscopePlugins { static uint8_t maxLayers; static void updateKey (uint16_t basePos, Key key); + static Key parseKey (void); + static void printKey (Key key); }; }; From 18d8a3133858134e76f657e68cdaf0d4eeb24642 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 28 Feb 2017 13:48:13 +0100 Subject: [PATCH 09/59] Drop the getPos & setPos commands They are not all that useful, and take up considerable space, for very little gain. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Keymap-Focus.h | 7 ------ src/Kaleidoscope/EEPROM-Keymap.cpp | 31 -------------------------- 2 files changed, 38 deletions(-) diff --git a/src/Kaleidoscope/EEPROM-Keymap-Focus.h b/src/Kaleidoscope/EEPROM-Keymap-Focus.h index 5e72184d..72103329 100644 --- a/src/Kaleidoscope/EEPROM-Keymap-Focus.h +++ b/src/Kaleidoscope/EEPROM-Keymap-Focus.h @@ -30,13 +30,6 @@ "Uploads a new keymap to EEPROM." \ "Starts at layer 0, row 0, column 0, " \ "and continues as long as there is data on the line.\n\n" \ - "keymap.setPos layer row column flag keyCode\n" \ - "-------------------------------------------\n" \ - "Sets the key at the specified `layer`, `row`, and `column` " \ - "to the key with `flag`, and `keyCode` properties.\n\n" \ - "keymap.getPos layer row column\n" \ - "------------------------------\n" \ - "Dump the key at `layer`, `row`, and `column`.\n\n" \ "keymap.transfer layer\n" \ "---------------------\n" \ "Transfers the `layer` from PROGMEM to EEPROM.") diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index 5a737175..dce75463 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -94,8 +94,6 @@ namespace KaleidoscopePlugins { EEPROMKeymap::focusKeymap (const char *command) { enum { UPLOAD, - GETPOS, - SETPOS, DUMP, TRANSFER, } subCommand; @@ -109,10 +107,6 @@ namespace KaleidoscopePlugins { subCommand = DUMP; else if (strcmp_P (command + 7, PSTR ("transfer")) == 0) subCommand = TRANSFER; - else if (strcmp_P (command + 7, PSTR ("getPos")) == 0) - subCommand = GETPOS; - else if (strcmp_P (command + 7, PSTR ("setPos")) == 0) - subCommand = SETPOS; else return false; @@ -127,19 +121,6 @@ namespace KaleidoscopePlugins { break; } - case GETPOS: - { - uint8_t layer = Serial.parseInt (); - uint8_t row = Serial.parseInt (); - uint8_t col = Serial.parseInt (); - - Key k = getKey (layer, row, col); - - printKey (k); - - break; - } - case DUMP: { for (uint8_t layer = 0; layer < 4; layer++) { @@ -159,18 +140,6 @@ namespace KaleidoscopePlugins { break; } - case SETPOS: - { - uint8_t layer = Serial.parseInt (); - uint8_t row = Serial.parseInt (); - uint8_t col = Serial.parseInt (); - - uint16_t pos = ((layer * ROWS * COLS) + (row * COLS) + col); - updateKey (pos, parseKey ()); - - break; - } - case TRANSFER: { uint8_t layer = Serial.parseInt (); From e3481be6edc3e45c44b35f7e62428e20a262ed9e Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 14 Mar 2017 23:49:07 +0100 Subject: [PATCH 10/59] Fix the `keymap.dump` Focus command The `keymap.dump` command should dump up to `maxLayers` amount of layers, instead of a hardcoded four. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Keymap.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index dce75463..d5c64c06 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -123,7 +123,7 @@ namespace KaleidoscopePlugins { case DUMP: { - for (uint8_t layer = 0; layer < 4; layer++) { + for (uint8_t layer = 0; layer < maxLayers; layer++) { for (uint8_t row = 0; row < ROWS; row++) { for (uint8_t col = 0; col < COLS; col++) { Key k = getKey (layer, row, col); From 4e1a5791364624603f4d56cbd8f854994f7fb74f Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 15 Mar 2017 10:15:41 +0100 Subject: [PATCH 11/59] Do not treat 0xffff as NoKey We expect the keymap in EEPROM to be set up by the time we get to use it, instead of having uninitialized EEPROM there. So remove the special handling of 0xffff. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Keymap.cpp | 3 --- 1 file changed, 3 deletions(-) diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index d5c64c06..ea3536b4 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -47,9 +47,6 @@ namespace KaleidoscopePlugins { key.flags = EEPROM.read (keymapBase + pos); key.keyCode = EEPROM.read (keymapBase + pos + 1); - if (key.raw == 0xffff) - return Key_NoKey; - return key; } From 5a7601bb300a1e6edde869447a67bef443a2c32b Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 15 Mar 2017 10:17:00 +0100 Subject: [PATCH 12/59] Update to use the new EEPROM-Settings library Signed-off-by: Gergely Nagy --- examples/EEPROM-Keymap/EEPROM-Keymap.ino | 4 ++++ src/Kaleidoscope/EEPROM-Keymap.cpp | 8 +++++--- src/Kaleidoscope/EEPROM-Keymap.h | 5 ++++- 3 files changed, 13 insertions(+), 4 deletions(-) diff --git a/examples/EEPROM-Keymap/EEPROM-Keymap.ino b/examples/EEPROM-Keymap/EEPROM-Keymap.ino index 9bdd3656..f1127a23 100644 --- a/examples/EEPROM-Keymap/EEPROM-Keymap.ino +++ b/examples/EEPROM-Keymap/EEPROM-Keymap.ino @@ -48,11 +48,15 @@ void setup () { USE_PLUGINS (&EEPROMKeymap, &Focus); + Focus.addHook (FOCUS_HOOK_SETTINGS); Focus.addHook (FOCUS_HOOK_KEYMAP); Focus.addHook (FOCUS_HOOK_HELP); Focus.addHook (FOCUS_HOOK_VERSION); Layer.getKey = EEPROMKeymap.getKey; + + EEPROMKeymap.reserveSpace (2); + EEPROMSettings.seal (); } void loop () { diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index ea3536b4..91a42d49 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -29,10 +29,12 @@ namespace KaleidoscopePlugins { void EEPROMKeymap::begin (void) { USE_PLUGINS (&::EEPROMSettings); + } - uint16_t layerSize = ROWS * COLS * 2; - maxLayers = (E2END - ::EEPROMSettings.endOfSettings ()) / layerSize; - keymapBase = ::EEPROMSettings.endOfSettings () + 1; + void + EEPROMKeymap::reserveSpace (uint8_t layers) { + maxLayers = layers; + keymapBase = ::EEPROMSettings.requestSlice (maxLayers * ROWS * COLS * 2); } Key diff --git a/src/Kaleidoscope/EEPROM-Keymap.h b/src/Kaleidoscope/EEPROM-Keymap.h index 83809a89..14b5493c 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.h +++ b/src/Kaleidoscope/EEPROM-Keymap.h @@ -28,8 +28,11 @@ namespace KaleidoscopePlugins { virtual void begin (void) final; - static Key getKey (uint8_t layer, byte row, byte col); + static void reserveSpace (uint8_t layers); static uint16_t base (void); + + static Key getKey (uint8_t layer, byte row, byte col); + static bool focusKeymap (const char *command); private: From a747d6c8cf0a496cd291d2831d43f0d12278128a Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 19 Mar 2017 11:12:12 +0100 Subject: [PATCH 13/59] Use the new Focus helpers Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Keymap.cpp | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index 91a42d49..f80da400 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -18,6 +18,7 @@ #include #include +#include namespace KaleidoscopePlugins { uint16_t EEPROMKeymap::keymapBase; @@ -75,18 +76,9 @@ namespace KaleidoscopePlugins { void EEPROMKeymap::printKey (Key k) { - if (k.flags < 10) - Serial.print (F(" ")); - if (k.flags < 100) - Serial.print (F(" ")); - Serial.print (k.flags); - Serial.print (F(" ")); - - if (k.keyCode < 10) - Serial.print (F(" ")); - if (k.keyCode < 100) - Serial.print (F(" ")); - Serial.print (k.keyCode); + ::Focus.printNumber (k.flags); + ::Focus.printSpace (); + ::Focus.printNumber (k.keyCode); } bool From 035c95a20793f904933fd5166bb1fe33bbde952b Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 19 Mar 2017 11:18:33 +0100 Subject: [PATCH 14/59] No need to consume the trailing \n anymore Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Keymap.cpp | 2 -- 1 file changed, 2 deletions(-) diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index f80da400..41efc99f 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -149,8 +149,6 @@ namespace KaleidoscopePlugins { } - Serial.read (); - return true; } From 0c387ce1c3edf221c1db0185165da21238431c04 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 19 Mar 2017 11:27:21 +0100 Subject: [PATCH 15/59] Focus: Lift out keymap.transfer The keymap.transfer command is only useful if we have both PROGMEM & EEPROM keymaps, which will rarely be a case, and likely only temporarily, too. As such, lift that out of the `focusKeymap` function, into its own. This makes the command optional, and can save us some 140 bytes of program space (even more if documentation is enabled). Signed-off-by: Gergely Nagy --- examples/EEPROM-Keymap/EEPROM-Keymap.ino | 1 + src/Kaleidoscope/EEPROM-Keymap-Focus.h | 11 +++++---- src/Kaleidoscope/EEPROM-Keymap.cpp | 30 ++++++++++++------------ src/Kaleidoscope/EEPROM-Keymap.h | 1 + 4 files changed, 24 insertions(+), 19 deletions(-) diff --git a/examples/EEPROM-Keymap/EEPROM-Keymap.ino b/examples/EEPROM-Keymap/EEPROM-Keymap.ino index f1127a23..30d39015 100644 --- a/examples/EEPROM-Keymap/EEPROM-Keymap.ino +++ b/examples/EEPROM-Keymap/EEPROM-Keymap.ino @@ -50,6 +50,7 @@ void setup () { Focus.addHook (FOCUS_HOOK_SETTINGS); Focus.addHook (FOCUS_HOOK_KEYMAP); + Focus.addHook (FOCUS_HOOK_KEYMAP_TRANSFER); Focus.addHook (FOCUS_HOOK_HELP); Focus.addHook (FOCUS_HOOK_VERSION); diff --git a/src/Kaleidoscope/EEPROM-Keymap-Focus.h b/src/Kaleidoscope/EEPROM-Keymap-Focus.h index 72103329..39ffbdc0 100644 --- a/src/Kaleidoscope/EEPROM-Keymap-Focus.h +++ b/src/Kaleidoscope/EEPROM-Keymap-Focus.h @@ -29,7 +29,10 @@ "-------------------------------\n" \ "Uploads a new keymap to EEPROM." \ "Starts at layer 0, row 0, column 0, " \ - "and continues as long as there is data on the line.\n\n" \ - "keymap.transfer layer\n" \ - "---------------------\n" \ - "Transfers the `layer` from PROGMEM to EEPROM.") + "and continues as long as there is data on the line.") + + +#define FOCUS_HOOK_KEYMAP_TRANSFER FOCUS_HOOK(EEPROMKeymap.focusKeymapTransfer, \ + "keymap.transfer layer\n" \ + "---------------------\n" \ + "Transfers the `layer` from PROGMEM to EEPROM.") diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index 41efc99f..126c0e77 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -86,7 +86,6 @@ namespace KaleidoscopePlugins { enum { UPLOAD, DUMP, - TRANSFER, } subCommand; if (strncmp_P (command, PSTR ("keymap."), 7) != 0) @@ -96,8 +95,6 @@ namespace KaleidoscopePlugins { subCommand = UPLOAD; else if (strcmp_P (command + 7, PSTR ("dump")) == 0) subCommand = DUMP; - else if (strcmp_P (command + 7, PSTR ("transfer")) == 0) - subCommand = TRANSFER; else return false; @@ -131,22 +128,25 @@ namespace KaleidoscopePlugins { break; } - case TRANSFER: - { - uint8_t layer = Serial.parseInt (); + } - for (uint8_t row = 0; row < ROWS; row++) { - for (uint8_t col = 0; col < COLS; col++) { - Key k = Layer.getKeyFromPROGMEM (layer, row, col); - uint16_t pos = ((layer * ROWS * COLS) + (row * COLS) + col); + return true; + } - updateKey (pos, k); - } - } + bool + EEPROMKeymap::focusKeymapTransfer (const char *command) { + if (strcmp_P (command, PSTR ("keymap.transfer")) != 0) + return false; - break; - } + uint8_t layer = Serial.parseInt (); + + for (uint8_t row = 0; row < ROWS; row++) { + for (uint8_t col = 0; col < COLS; col++) { + Key k = Layer.getKeyFromPROGMEM (layer, row, col); + uint16_t pos = ((layer * ROWS * COLS) + (row * COLS) + col); + updateKey (pos, k); + } } return true; diff --git a/src/Kaleidoscope/EEPROM-Keymap.h b/src/Kaleidoscope/EEPROM-Keymap.h index 14b5493c..02043a55 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.h +++ b/src/Kaleidoscope/EEPROM-Keymap.h @@ -34,6 +34,7 @@ namespace KaleidoscopePlugins { static Key getKey (uint8_t layer, byte row, byte col); static bool focusKeymap (const char *command); + static bool focusKeymapTransfer (const char *command); private: static uint16_t keymapBase; From b766ad6c4d4dc8a7394b3bbd7744197d9199f926 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 20 Mar 2017 12:36:59 +0100 Subject: [PATCH 16/59] README: Add a "Dependencies" section Signed-off-by: Gergely Nagy --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index f7bda3ef..2c6c1285 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,11 @@ The plugin provides the `EEPROMKeymap` object, which has the following methods: **TODO** +## Dependencies + +* [Kaleidoscope-EEPROM-Settings](https://github.com/keyboardio/Kaleidoscope-EEPROM-Settings) +* [Kaleidoscope-Focus](https://github.com/keyboardio/Kaleidoscope-Focus) + ## Further reading Starting from the [example][plugin:example] is the recommended way of getting From 0f3dddae98bd4637d4ea055d5cd63a6c9f90446d Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 21 Mar 2017 12:19:56 +0100 Subject: [PATCH 17/59] Make the `updateKey` method public It can be useful for other plugins that want to update the EEPROM keymap. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Keymap.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/Kaleidoscope/EEPROM-Keymap.h b/src/Kaleidoscope/EEPROM-Keymap.h index 02043a55..f9995d71 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.h +++ b/src/Kaleidoscope/EEPROM-Keymap.h @@ -36,11 +36,12 @@ namespace KaleidoscopePlugins { static bool focusKeymap (const char *command); static bool focusKeymapTransfer (const char *command); + static void updateKey (uint16_t basePos, Key key); + private: static uint16_t keymapBase; static uint8_t maxLayers; - static void updateKey (uint16_t basePos, Key key); static Key parseKey (void); static void printKey (Key key); }; From 379a2d483b46a8a13307a9c7d6420ed12867e0b0 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Mar 2017 08:22:13 +0100 Subject: [PATCH 18/59] Add a `getKeyOverride` method This method uses the EEPROM only to augment the PROGMEM keymap: if EEPROM is transparent, then PROGMEM is used. As such, the keymap in EEPROM is only an overlay in this case. Signed-off-by: Gergely Nagy --- examples/EEPROM-Keymap/EEPROM-Keymap.ino | 4 ++-- src/Kaleidoscope/EEPROM-Keymap.cpp | 10 ++++++++++ src/Kaleidoscope/EEPROM-Keymap.h | 1 + 3 files changed, 13 insertions(+), 2 deletions(-) diff --git a/examples/EEPROM-Keymap/EEPROM-Keymap.ino b/examples/EEPROM-Keymap/EEPROM-Keymap.ino index 30d39015..b2d8be40 100644 --- a/examples/EEPROM-Keymap/EEPROM-Keymap.ino +++ b/examples/EEPROM-Keymap/EEPROM-Keymap.ino @@ -54,9 +54,9 @@ void setup () { Focus.addHook (FOCUS_HOOK_HELP); Focus.addHook (FOCUS_HOOK_VERSION); - Layer.getKey = EEPROMKeymap.getKey; + Layer.getKey = EEPROMKeymap.getKeyOverride; - EEPROMKeymap.reserveSpace (2); + EEPROMKeymap.reserveSpace (1); EEPROMSettings.seal (); } diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index 126c0e77..2e095fff 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -53,6 +53,16 @@ namespace KaleidoscopePlugins { return key; } + Key + EEPROMKeymap::getKeyOverride (uint8_t layer, byte row, byte col) { + Key key; + + key = getKey (layer, row, col); + if (key == Key_Transparent) + key = Layer.getKeyFromPROGMEM (layer, row, col); + return key; + } + uint16_t EEPROMKeymap::base (void) { return keymapBase; diff --git a/src/Kaleidoscope/EEPROM-Keymap.h b/src/Kaleidoscope/EEPROM-Keymap.h index f9995d71..65574d23 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.h +++ b/src/Kaleidoscope/EEPROM-Keymap.h @@ -32,6 +32,7 @@ namespace KaleidoscopePlugins { static uint16_t base (void); static Key getKey (uint8_t layer, byte row, byte col); + static Key getKeyOverride (uint8_t layer, byte row, byte col); static bool focusKeymap (const char *command); static bool focusKeymapTransfer (const char *command); From cdbbc0cd0a3ce74f81baf3db80572a3178743a72 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 27 Mar 2017 16:38:12 +0200 Subject: [PATCH 19/59] Instead of full docs, only document the commands Full documentation takes way too much space, and command names are a reasonable compromise for discoverability. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Keymap-Focus.h | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/src/Kaleidoscope/EEPROM-Keymap-Focus.h b/src/Kaleidoscope/EEPROM-Keymap-Focus.h index 39ffbdc0..1b6b224d 100644 --- a/src/Kaleidoscope/EEPROM-Keymap-Focus.h +++ b/src/Kaleidoscope/EEPROM-Keymap-Focus.h @@ -23,16 +23,8 @@ #define FOCUS_HOOK_KEYMAP FOCUS_HOOK(EEPROMKeymap.focusKeymap, \ "keymap.dump\n" \ - "-----------\n" \ - "Dumps the keymap from EEPROM.\n\n" \ - "keymap.upload ...\n" \ - "-------------------------------\n" \ - "Uploads a new keymap to EEPROM." \ - "Starts at layer 0, row 0, column 0, " \ - "and continues as long as there is data on the line.") + "keymap.upload") #define FOCUS_HOOK_KEYMAP_TRANSFER FOCUS_HOOK(EEPROMKeymap.focusKeymapTransfer, \ - "keymap.transfer layer\n" \ - "---------------------\n" \ - "Transfers the `layer` from PROGMEM to EEPROM.") + "keymap.transfer layer") From 78836fd091d4a122b8f1f853fc3c9de7d3b0d7f9 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 5 Apr 2017 10:31:09 +0200 Subject: [PATCH 20/59] Focus: Less formatting in the dump output Fixes #1. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Keymap.cpp | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index 2e095fff..01e98507 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -127,14 +127,11 @@ namespace KaleidoscopePlugins { Key k = getKey (layer, row, col); printKey (k); - - if (col < COLS - 1) - Serial.print (F(" | ")); + ::Focus.printSpace (); } - Serial.println (); } - Serial.println (); } + Serial.println (); break; } From 1432015235eb721bc3d88672e8060fc2d45c73d0 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 5 Apr 2017 10:36:57 +0200 Subject: [PATCH 21/59] Focus: Merge keymap.dump and keymap.upload into keymap.map Fixes #2. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Keymap-Focus.h | 5 +-- src/Kaleidoscope/EEPROM-Keymap.cpp | 51 ++++++++------------------ 2 files changed, 16 insertions(+), 40 deletions(-) diff --git a/src/Kaleidoscope/EEPROM-Keymap-Focus.h b/src/Kaleidoscope/EEPROM-Keymap-Focus.h index 1b6b224d..eac8f2fa 100644 --- a/src/Kaleidoscope/EEPROM-Keymap-Focus.h +++ b/src/Kaleidoscope/EEPROM-Keymap-Focus.h @@ -21,10 +21,7 @@ #include #include -#define FOCUS_HOOK_KEYMAP FOCUS_HOOK(EEPROMKeymap.focusKeymap, \ - "keymap.dump\n" \ - "keymap.upload") - +#define FOCUS_HOOK_KEYMAP FOCUS_HOOK(EEPROMKeymap.focusKeymap, "keymap.map") #define FOCUS_HOOK_KEYMAP_TRANSFER FOCUS_HOOK(EEPROMKeymap.focusKeymapTransfer, \ "keymap.transfer layer") diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index 01e98507..9a4f0aa9 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -93,48 +93,27 @@ namespace KaleidoscopePlugins { bool EEPROMKeymap::focusKeymap (const char *command) { - enum { - UPLOAD, - DUMP, - } subCommand; - - if (strncmp_P (command, PSTR ("keymap."), 7) != 0) - return false; - - if (strcmp_P (command + 7, PSTR ("upload")) == 0) - subCommand = UPLOAD; - else if (strcmp_P (command + 7, PSTR ("dump")) == 0) - subCommand = DUMP; - else + if (strcmp_P (command, PSTR ("keymap.map")) != 0) return false; - switch (subCommand) { - case UPLOAD: - { - uint16_t i = 0; - while ((Serial.peek () != '\n') && (i < ROWS * COLS * maxLayers)) { - updateKey (i, parseKey ()); - i++; - } - break; - } - - case DUMP: - { - for (uint8_t layer = 0; layer < maxLayers; layer++) { - for (uint8_t row = 0; row < ROWS; row++) { - for (uint8_t col = 0; col < COLS; col++) { - Key k = getKey (layer, row, col); + if (Serial.peek () == '\n') { + for (uint8_t layer = 0; layer < maxLayers; layer++) { + for (uint8_t row = 0; row < ROWS; row++) { + for (uint8_t col = 0; col < COLS; col++) { + Key k = getKey (layer, row, col); - printKey (k); - ::Focus.printSpace (); - } + printKey (k); + ::Focus.printSpace (); } } - Serial.println (); - break; } - + Serial.println (); + } else { + uint16_t i = 0; + while ((Serial.peek () != '\n') && (i < ROWS * COLS * maxLayers)) { + updateKey (i, parseKey ()); + i++; + } } return true; From e07f00e9470c8a67069c8d699b242a7a3b6aec15 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 5 Apr 2017 10:42:05 +0200 Subject: [PATCH 22/59] Focus: keymap.map should work with raw keycodes Instead of separating `flags` and `keyCode`, just use the `raw` combination. Easier for higher level tools to work with. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Keymap.cpp | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index 9a4f0aa9..11b0fc8a 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -78,17 +78,14 @@ namespace KaleidoscopePlugins { EEPROMKeymap::parseKey (void) { Key key; - key.flags = Serial.parseInt (); - key.keyCode = Serial.parseInt (); + key.raw = Serial.parseInt (); return key; } void EEPROMKeymap::printKey (Key k) { - ::Focus.printNumber (k.flags); - ::Focus.printSpace (); - ::Focus.printNumber (k.keyCode); + ::Focus.printNumber (k.raw); } bool From 2f7c38a15d4faf4e872fe2974a7a49542d1e37c6 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 24 Apr 2017 09:43:03 +0200 Subject: [PATCH 23/59] Focus: Fix the `keymap.transfer` docs Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Keymap-Focus.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/EEPROM-Keymap-Focus.h b/src/Kaleidoscope/EEPROM-Keymap-Focus.h index eac8f2fa..23bfb61f 100644 --- a/src/Kaleidoscope/EEPROM-Keymap-Focus.h +++ b/src/Kaleidoscope/EEPROM-Keymap-Focus.h @@ -24,4 +24,4 @@ #define FOCUS_HOOK_KEYMAP FOCUS_HOOK(EEPROMKeymap.focusKeymap, "keymap.map") #define FOCUS_HOOK_KEYMAP_TRANSFER FOCUS_HOOK(EEPROMKeymap.focusKeymapTransfer, \ - "keymap.transfer layer") + "keymap.transfer") From 543c3b09f27a4942b3d865093376f7dc55d81b8f Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 22 May 2017 01:03:40 -0700 Subject: [PATCH 24/59] Update example to match new keymap --- examples/EEPROM-Keymap/EEPROM-Keymap.ino | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/examples/EEPROM-Keymap/EEPROM-Keymap.ino b/examples/EEPROM-Keymap/EEPROM-Keymap.ino index b2d8be40..eaa58201 100644 --- a/examples/EEPROM-Keymap/EEPROM-Keymap.ino +++ b/examples/EEPROM-Keymap/EEPROM-Keymap.ino @@ -26,9 +26,9 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, - Key_PageDn, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Esc, + Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, - Key_LCtrl, Key_Backspace, Key_LGUI, Key_LShift, + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, Key_skip, Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, @@ -36,7 +36,7 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, - Key_RShift, Key_RAlt, Key_Space, Key_RCtrl, + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, Key_skip ), }; From 0e0f3037e507d7ca3bf8b2198e0ea822b17dcda1 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 23 May 2017 21:11:34 -0700 Subject: [PATCH 25/59] Modernize build and test infra --- Makefile | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 Makefile diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..9ce0c4a9 --- /dev/null +++ b/Makefile @@ -0,0 +1,12 @@ +# This stub makefile for a Kaleidoscope plugin pulls in +# all targets from the Kaleidoscope-Plugin library + +MAKEFILE_PREFIX=keyboardio/avr/libraries/Kaleidoscope-Plugin/build +UNAME_S := $(shell uname -s) + +BOARD_HARDWARE_PATH ?= $(HOME)/Arduino/hardware +ifeq ($(UNAME_S),Darwin) +BOARD_HARDWARE_PATH ?= $(HOME)/Library/Arduino/hardware +endif + +include $(BOARD_HARDWARE_PATH)/$(MAKEFILE_PREFIX)/*.mk From a0cebeb0ee87ccd0662097f41f5ce779b7958f83 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 23 May 2017 21:19:23 -0700 Subject: [PATCH 26/59] Switch to modern build infrastructure --- .travis.yml | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/.travis.yml b/.travis.yml index ed2b2e3b..e7030acf 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,17 +1,21 @@ -language: cpp dist: trusty -sudo: required +sudo: false os: - linux -before_install: - - pushd .. - - wget http://downloads.arduino.cc/arduino-1.6.11-linux64.tar.xz - - tar xf arduino-1.6.11-linux64.tar.xz - - popd install: - - git clone --recurse-submodules https://github.com/keyboardio/Arduino-Boards hardware/keyboardio/avr + - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Arduino-Boards hardware/keyboardio/avr script: - - export DEFAULT_SKETCH=$(cd examples; basename *) - - export ARDUINO_PATH=$(pwd)/../arduino-1.6.11 - - export BOARD_HARDWARE_PATH=$(pwd)/hardware - - hardware/keyboardio/avr/libraries/Kaleidoscope/tools/kaleidoscope-builder build + - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware +notifications: + irc: + channels: + - "chat.freenode.net#keyboardio" + use_notice: true + skip_join: true + template: + - "%{repository_name}/%{branch} %{commit} by %{author}: %{commit_subject} %{build_url} %{message}" + email: + on_success: change + on_failure: change +cache: + ccache: true From 97008a28f07e7ff7b5adbd56f0547622770a0000 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Fri, 26 May 2017 15:41:19 -0700 Subject: [PATCH 27/59] "make astyle --- examples/EEPROM-Keymap/EEPROM-Keymap.ino | 54 +++++------ src/Kaleidoscope/EEPROM-Keymap.cpp | 116 +++++++++++------------ src/Kaleidoscope/EEPROM-Keymap.h | 4 +- 3 files changed, 87 insertions(+), 87 deletions(-) diff --git a/examples/EEPROM-Keymap/EEPROM-Keymap.ino b/examples/EEPROM-Keymap/EEPROM-Keymap.ino index eaa58201..e3480f37 100644 --- a/examples/EEPROM-Keymap/EEPROM-Keymap.ino +++ b/examples/EEPROM-Keymap/EEPROM-Keymap.ino @@ -21,45 +21,45 @@ #include const Key keymaps[][ROWS][COLS] PROGMEM = { - [0] = KEYMAP_STACKED - ( - Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, - Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, - Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, - Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, + [0] = KEYMAP_STACKED + ( + Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, + Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, + Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, + Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, - Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, - Key_skip, + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, + Key_skip, - Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, - Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, - Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, - Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, + Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, + Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, - Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, - Key_skip - ), + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, + Key_skip + ), }; void setup () { - Serial.begin (9600); + Serial.begin (9600); - Kaleidoscope.setup (); + Kaleidoscope.setup (); - USE_PLUGINS (&EEPROMKeymap, &Focus); + USE_PLUGINS (&EEPROMKeymap, &Focus); - Focus.addHook (FOCUS_HOOK_SETTINGS); - Focus.addHook (FOCUS_HOOK_KEYMAP); - Focus.addHook (FOCUS_HOOK_KEYMAP_TRANSFER); - Focus.addHook (FOCUS_HOOK_HELP); - Focus.addHook (FOCUS_HOOK_VERSION); + Focus.addHook (FOCUS_HOOK_SETTINGS); + Focus.addHook (FOCUS_HOOK_KEYMAP); + Focus.addHook (FOCUS_HOOK_KEYMAP_TRANSFER); + Focus.addHook (FOCUS_HOOK_HELP); + Focus.addHook (FOCUS_HOOK_VERSION); - Layer.getKey = EEPROMKeymap.getKeyOverride; + Layer.getKey = EEPROMKeymap.getKeyOverride; - EEPROMKeymap.reserveSpace (1); - EEPROMSettings.seal (); + EEPROMKeymap.reserveSpace (1); + EEPROMSettings.seal (); } void loop () { - Kaleidoscope.loop (); + Kaleidoscope.loop (); } diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index 11b0fc8a..314b65a2 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -21,29 +21,29 @@ #include namespace KaleidoscopePlugins { - uint16_t EEPROMKeymap::keymapBase; - uint8_t EEPROMKeymap::maxLayers; +uint16_t EEPROMKeymap::keymapBase; +uint8_t EEPROMKeymap::maxLayers; - EEPROMKeymap::EEPROMKeymap (void) { - } +EEPROMKeymap::EEPROMKeymap (void) { +} - void - EEPROMKeymap::begin (void) { +void +EEPROMKeymap::begin (void) { USE_PLUGINS (&::EEPROMSettings); - } +} - void - EEPROMKeymap::reserveSpace (uint8_t layers) { +void +EEPROMKeymap::reserveSpace (uint8_t layers) { maxLayers = layers; keymapBase = ::EEPROMSettings.requestSlice (maxLayers * ROWS * COLS * 2); - } +} - Key - EEPROMKeymap::getKey (uint8_t layer, byte row, byte col) { +Key +EEPROMKeymap::getKey (uint8_t layer, byte row, byte col) { Key key; if (layer >= maxLayers) - return Key_NoKey; + return Key_NoKey; uint16_t pos = ((layer * ROWS * COLS) + (row * COLS) + col) * 2; @@ -51,89 +51,89 @@ namespace KaleidoscopePlugins { key.keyCode = EEPROM.read (keymapBase + pos + 1); return key; - } +} - Key - EEPROMKeymap::getKeyOverride (uint8_t layer, byte row, byte col) { +Key +EEPROMKeymap::getKeyOverride (uint8_t layer, byte row, byte col) { Key key; key = getKey (layer, row, col); if (key == Key_Transparent) - key = Layer.getKeyFromPROGMEM (layer, row, col); + key = Layer.getKeyFromPROGMEM (layer, row, col); return key; - } +} - uint16_t - EEPROMKeymap::base (void) { +uint16_t +EEPROMKeymap::base (void) { return keymapBase; - } +} - void - EEPROMKeymap::updateKey (uint16_t basePos, Key key) { +void +EEPROMKeymap::updateKey (uint16_t basePos, Key key) { EEPROM.update (keymapBase + basePos * 2, key.flags); EEPROM.update (keymapBase + basePos * 2 + 1, key.keyCode); - } +} - Key - EEPROMKeymap::parseKey (void) { +Key +EEPROMKeymap::parseKey (void) { Key key; key.raw = Serial.parseInt (); return key; - } +} - void - EEPROMKeymap::printKey (Key k) { +void +EEPROMKeymap::printKey (Key k) { ::Focus.printNumber (k.raw); - } +} - bool - EEPROMKeymap::focusKeymap (const char *command) { +bool +EEPROMKeymap::focusKeymap (const char *command) { if (strcmp_P (command, PSTR ("keymap.map")) != 0) - return false; + return false; if (Serial.peek () == '\n') { - for (uint8_t layer = 0; layer < maxLayers; layer++) { - for (uint8_t row = 0; row < ROWS; row++) { - for (uint8_t col = 0; col < COLS; col++) { - Key k = getKey (layer, row, col); - - printKey (k); - ::Focus.printSpace (); - } + for (uint8_t layer = 0; layer < maxLayers; layer++) { + for (uint8_t row = 0; row < ROWS; row++) { + for (uint8_t col = 0; col < COLS; col++) { + Key k = getKey (layer, row, col); + + printKey (k); + ::Focus.printSpace (); + } + } } - } - Serial.println (); + Serial.println (); } else { - uint16_t i = 0; - while ((Serial.peek () != '\n') && (i < ROWS * COLS * maxLayers)) { - updateKey (i, parseKey ()); - i++; - } + uint16_t i = 0; + while ((Serial.peek () != '\n') && (i < ROWS * COLS * maxLayers)) { + updateKey (i, parseKey ()); + i++; + } } return true; - } +} - bool - EEPROMKeymap::focusKeymapTransfer (const char *command) { +bool +EEPROMKeymap::focusKeymapTransfer (const char *command) { if (strcmp_P (command, PSTR ("keymap.transfer")) != 0) - return false; + return false; uint8_t layer = Serial.parseInt (); for (uint8_t row = 0; row < ROWS; row++) { - for (uint8_t col = 0; col < COLS; col++) { - Key k = Layer.getKeyFromPROGMEM (layer, row, col); - uint16_t pos = ((layer * ROWS * COLS) + (row * COLS) + col); + for (uint8_t col = 0; col < COLS; col++) { + Key k = Layer.getKeyFromPROGMEM (layer, row, col); + uint16_t pos = ((layer * ROWS * COLS) + (row * COLS) + col); - updateKey (pos, k); - } + updateKey (pos, k); + } } return true; - } +} }; diff --git a/src/Kaleidoscope/EEPROM-Keymap.h b/src/Kaleidoscope/EEPROM-Keymap.h index 65574d23..511cab35 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.h +++ b/src/Kaleidoscope/EEPROM-Keymap.h @@ -22,7 +22,7 @@ #include namespace KaleidoscopePlugins { - class EEPROMKeymap : public KaleidoscopePlugin { +class EEPROMKeymap : public KaleidoscopePlugin { public: EEPROMKeymap (void); @@ -45,7 +45,7 @@ namespace KaleidoscopePlugins { static Key parseKey (void); static void printKey (Key key); - }; +}; }; extern KaleidoscopePlugins::EEPROMKeymap EEPROMKeymap; From ba6128dddc989ca7494ff4a69ef727d769d19313 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 3 Jun 2017 10:07:48 +0200 Subject: [PATCH 28/59] Kaleidoscope Style Guide conformance Updated the code to conform to the latest style guide. And added a bit of documentation too, while there. Signed-off-by: Gergely Nagy --- README.md | 78 ++++++++++-- examples/EEPROM-Keymap/EEPROM-Keymap.ino | 62 +++++----- src/Kaleidoscope/EEPROM-Keymap.cpp | 148 +++++++++++------------ src/Kaleidoscope/EEPROM-Keymap.h | 35 +++--- 4 files changed, 185 insertions(+), 138 deletions(-) diff --git a/README.md b/README.md index 2c6c1285..7f17b417 100644 --- a/README.md +++ b/README.md @@ -5,26 +5,54 @@ [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-EEPROM-Keymap.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-EEPROM-Keymap - [st:stable]: https://img.shields.io/badge/stable-✔-black.png?style=flat&colorA=44cc11&colorB=494e52 - [st:broken]: https://img.shields.io/badge/broken-X-black.png?style=flat&colorA=e05d44&colorB=494e52 - [st:experimental]: https://img.shields.io/badge/experimental----black.png?style=flat&colorA=dfb317&colorB=494e52 + [st:stable]: https://img.shields.io/badge/stable-✔-black.svg?style=flat&colorA=44cc11&colorB=494e52 + [st:broken]: https://img.shields.io/badge/broken-X-black.svg?style=flat&colorA=e05d44&colorB=494e52 + [st:experimental]: https://img.shields.io/badge/experimental----black.svg?style=flat&colorA=dfb317&colorB=494e52 -TODO +While keyboards usually ship with a keymap programmed in, to be able to change +that keymap, without flashing new firmware, we need a way to place the keymap +into a place we can update at run-time, and which persists across reboots. +Fortunately, we have a bit of `EEPROM` on the keyboard, and can use it to store +either the full keymap (and saving space in the firmware then), or store an +overlay there. In the latter case, whenever there is a non-transparent key on +the overlay, we will use that instead of the keyboard default. + +In short, this plugin allows us to change our keymaps, without having to compile +and flash new firmware. It does so through the use of the [Focus][plugin:focus] +plugin. + + [plugin:focus]: https://github.com/keyboardio/Kaleidoscope-Focus ## Using the plugin -TODO +Using the plugin is reasonably simple: after including the header, enable the +plugin, and let the `Layer` object know that we'll be using `EEPROMKeymap` to +figure out which keys to use. We can either use the `getKeyOverride` or the +`getKey` method, depending on whether we want to override, or fully replace the +built-in keymap. Then we need to set at most how many layers we want to store in +`EEPROM`, and that is about it. + +We can then update the keymap via [Focus][plugin:focus]. ```c++ #include #include +#include +#include -void setup () { - Kaleidoscope.setup (); +void setup() { + Serial.begin(9600); + USE_PLUGINS(&EEPROMKeymap, &Focus); - USE_PLUGINS (&EEPROMKeymap); + Kaleidoscope.setup(); + + Focus.addHook(FOCUS_HOOK_KEYMAP); + Focus.addHook(FOCUS_HOOK_KEYMAP_TRANSFER); + + Layer.getKey = EEPROMKeymap.getKeyOverride; - // TODO + EEPROMKeymap.max_layers(1); + EEPROMSettings.seal(); } ``` @@ -32,7 +60,37 @@ void setup () { The plugin provides the `EEPROMKeymap` object, which has the following methods: -**TODO** +### `.max_layers(max)` + +> Tells the extension to reserve space in EEPROM for up to `max` layers. Can +> only be called once, any subsequent call will be a no-op. + +## Focus commands + +The plugin provides two `Focus` hooks: `FOCUS_HOOK_KEYMAP`, and +`FOCUS_HOOK_KEYMAP_TRANSFER`. Together, they make the following commands +available, respectively: + +### `keymap.map [codes...]` + +> Without arguments, displays the keymap currently in effect. Each key is +> printed as its raw, 16-bit keycode. +> +> With arguments, it stores as many keys as given. One does not need to set all +> keys, on all layers: the command will start from the first key on the first +> layer, and go on as long as it has input. It will not go past the layer set +> via the `.max_layers()` method. + +### `keymap.transfer LAYER` + +> Transfers the `LAYER` from the built-in memory of the keyboard into `EEPROM` +> storage. +> +> Useful mostly when one wants to remove the built-in keymap, and wants to +> easily transfer it into `EEPROM` first. +> +> This is generally not needed, and it is recommended to not enable this +> command, unless the feature this command implements is truly needed. ## Dependencies diff --git a/examples/EEPROM-Keymap/EEPROM-Keymap.ino b/examples/EEPROM-Keymap/EEPROM-Keymap.ino index e3480f37..207d7bae 100644 --- a/examples/EEPROM-Keymap/EEPROM-Keymap.ino +++ b/examples/EEPROM-Keymap/EEPROM-Keymap.ino @@ -21,45 +21,43 @@ #include const Key keymaps[][ROWS][COLS] PROGMEM = { - [0] = KEYMAP_STACKED - ( - Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, - Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, - Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, - Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, - - Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, - Key_skip, - - Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, - Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, - Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, - Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, - - Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, - Key_skip - ), + [0] = KEYMAP_STACKED + (Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, + Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, + Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, + Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, + + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, + Key_skip, + + Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, + Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, + + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, + Key_skip), }; -void setup () { - Serial.begin (9600); +void setup() { + Serial.begin(9600); - Kaleidoscope.setup (); + USE_PLUGINS(&EEPROMKeymap, &Focus); - USE_PLUGINS (&EEPROMKeymap, &Focus); + Kaleidoscope.setup(); - Focus.addHook (FOCUS_HOOK_SETTINGS); - Focus.addHook (FOCUS_HOOK_KEYMAP); - Focus.addHook (FOCUS_HOOK_KEYMAP_TRANSFER); - Focus.addHook (FOCUS_HOOK_HELP); - Focus.addHook (FOCUS_HOOK_VERSION); + Focus.addHook(FOCUS_HOOK_SETTINGS); + Focus.addHook(FOCUS_HOOK_KEYMAP); + Focus.addHook(FOCUS_HOOK_KEYMAP_TRANSFER); + Focus.addHook(FOCUS_HOOK_HELP); + Focus.addHook(FOCUS_HOOK_VERSION); - Layer.getKey = EEPROMKeymap.getKeyOverride; + Layer.getKey = EEPROMKeymap.getKeyOverride; - EEPROMKeymap.reserveSpace (1); - EEPROMSettings.seal (); + EEPROMKeymap.max_layers(1); + EEPROMSettings.seal(); } -void loop () { - Kaleidoscope.loop (); +void loop() { + Kaleidoscope.loop(); } diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index 314b65a2..7acbfdb0 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -20,121 +20,111 @@ #include #include -namespace KaleidoscopePlugins { -uint16_t EEPROMKeymap::keymapBase; -uint8_t EEPROMKeymap::maxLayers; +namespace kaleidoscope { +uint16_t EEPROMKeymap::keymap_base_; +uint8_t EEPROMKeymap::max_layers_; -EEPROMKeymap::EEPROMKeymap (void) { +EEPROMKeymap::EEPROMKeymap(void) { } -void -EEPROMKeymap::begin (void) { - USE_PLUGINS (&::EEPROMSettings); +void EEPROMKeymap::begin(void) { + USE_PLUGINS(&::EEPROMSettings); } -void -EEPROMKeymap::reserveSpace (uint8_t layers) { - maxLayers = layers; - keymapBase = ::EEPROMSettings.requestSlice (maxLayers * ROWS * COLS * 2); +void EEPROMKeymap::max_layers(uint8_t max) { + max_layers_ = max; + keymap_base_ = ::EEPROMSettings.requestSlice(max_layers_ * ROWS * COLS * 2); } -Key -EEPROMKeymap::getKey (uint8_t layer, byte row, byte col) { - Key key; +Key EEPROMKeymap::getKey(uint8_t layer, byte row, byte col) { + Key key; - if (layer >= maxLayers) - return Key_NoKey; + if (layer >= max_layers_) + return Key_NoKey; - uint16_t pos = ((layer * ROWS * COLS) + (row * COLS) + col) * 2; + uint16_t pos = ((layer * ROWS * COLS) + (row * COLS) + col) * 2; - key.flags = EEPROM.read (keymapBase + pos); - key.keyCode = EEPROM.read (keymapBase + pos + 1); + key.flags = EEPROM.read(keymap_base_ + pos); + key.keyCode = EEPROM.read(keymap_base_ + pos + 1); - return key; + return key; } -Key -EEPROMKeymap::getKeyOverride (uint8_t layer, byte row, byte col) { - Key key; +Key EEPROMKeymap::getKeyOverride(uint8_t layer, byte row, byte col) { + Key key; - key = getKey (layer, row, col); - if (key == Key_Transparent) - key = Layer.getKeyFromPROGMEM (layer, row, col); - return key; + key = getKey(layer, row, col); + if (key == Key_Transparent) + key = Layer.getKeyFromPROGMEM(layer, row, col); + return key; } -uint16_t -EEPROMKeymap::base (void) { - return keymapBase; +uint16_t EEPROMKeymap::keymap_base(void) { + return keymap_base_; } -void -EEPROMKeymap::updateKey (uint16_t basePos, Key key) { - EEPROM.update (keymapBase + basePos * 2, key.flags); - EEPROM.update (keymapBase + basePos * 2 + 1, key.keyCode); +void EEPROMKeymap::updateKey(uint16_t base_pos, Key key) { + EEPROM.update(keymap_base_ + base_pos * 2, key.flags); + EEPROM.update(keymap_base_ + base_pos * 2 + 1, key.keyCode); } -Key -EEPROMKeymap::parseKey (void) { - Key key; +Key EEPROMKeymap::parseKey(void) { + Key key; - key.raw = Serial.parseInt (); + key.raw = Serial.parseInt(); - return key; + return key; } -void -EEPROMKeymap::printKey (Key k) { - ::Focus.printNumber (k.raw); +void EEPROMKeymap::printKey(Key k) { + ::Focus.printNumber(k.raw); } -bool -EEPROMKeymap::focusKeymap (const char *command) { - if (strcmp_P (command, PSTR ("keymap.map")) != 0) - return false; - - if (Serial.peek () == '\n') { - for (uint8_t layer = 0; layer < maxLayers; layer++) { - for (uint8_t row = 0; row < ROWS; row++) { - for (uint8_t col = 0; col < COLS; col++) { - Key k = getKey (layer, row, col); - - printKey (k); - ::Focus.printSpace (); - } - } - } - Serial.println (); - } else { - uint16_t i = 0; - while ((Serial.peek () != '\n') && (i < ROWS * COLS * maxLayers)) { - updateKey (i, parseKey ()); - i++; +bool EEPROMKeymap::focusKeymap(const char *command) { + if (strcmp_P(command, PSTR("keymap.map")) != 0) + return false; + + if (Serial.peek() == '\n') { + for (uint8_t layer = 0; layer < max_layers_; layer++) { + for (uint8_t row = 0; row < ROWS; row++) { + for (uint8_t col = 0; col < COLS; col++) { + Key k = getKey(layer, row, col); + + printKey(k); + ::Focus.printSpace(); } + } } + Serial.println(); + } else { + uint16_t i = 0; + while ((Serial.peek() != '\n') && (i < ROWS * COLS * max_layers_)) { + updateKey(i, parseKey()); + i++; + } + } - return true; + return true; } -bool -EEPROMKeymap::focusKeymapTransfer (const char *command) { - if (strcmp_P (command, PSTR ("keymap.transfer")) != 0) - return false; +bool EEPROMKeymap::focusKeymapTransfer(const char *command) { + if (strcmp_P(command, PSTR("keymap.transfer")) != 0) + return false; - uint8_t layer = Serial.parseInt (); + uint8_t layer = Serial.parseInt(); - for (uint8_t row = 0; row < ROWS; row++) { - for (uint8_t col = 0; col < COLS; col++) { - Key k = Layer.getKeyFromPROGMEM (layer, row, col); - uint16_t pos = ((layer * ROWS * COLS) + (row * COLS) + col); + for (uint8_t row = 0; row < ROWS; row++) { + for (uint8_t col = 0; col < COLS; col++) { + Key k = Layer.getKeyFromPROGMEM(layer, row, col); + uint16_t pos =((layer * ROWS * COLS) + (row * COLS) + col); - updateKey (pos, k); - } + updateKey(pos, k); } + } - return true; + return true; } -}; +} -KaleidoscopePlugins::EEPROMKeymap EEPROMKeymap; +kaleidoscope::EEPROMKeymap EEPROMKeymap; diff --git a/src/Kaleidoscope/EEPROM-Keymap.h b/src/Kaleidoscope/EEPROM-Keymap.h index 511cab35..b1e7de81 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.h +++ b/src/Kaleidoscope/EEPROM-Keymap.h @@ -21,31 +21,32 @@ #include #include -namespace KaleidoscopePlugins { +namespace kaleidoscope { class EEPROMKeymap : public KaleidoscopePlugin { - public: - EEPROMKeymap (void); + public: + EEPROMKeymap(void); - virtual void begin (void) final; + static void max_layers(uint8_t max); - static void reserveSpace (uint8_t layers); - static uint16_t base (void); + void begin(void) final; - static Key getKey (uint8_t layer, byte row, byte col); - static Key getKeyOverride (uint8_t layer, byte row, byte col); + static uint16_t keymap_base(void); - static bool focusKeymap (const char *command); - static bool focusKeymapTransfer (const char *command); + static Key getKey(uint8_t layer, byte row, byte col); + static Key getKeyOverride(uint8_t layer, byte row, byte col); - static void updateKey (uint16_t basePos, Key key); + static bool focusKeymap(const char *command); + static bool focusKeymapTransfer(const char *command); - private: - static uint16_t keymapBase; - static uint8_t maxLayers; + static void updateKey(uint16_t base_pos, Key key); - static Key parseKey (void); - static void printKey (Key key); + private: + static uint16_t keymap_base_; + static uint8_t max_layers_; + + static Key parseKey(void); + static void printKey(Key key); }; }; -extern KaleidoscopePlugins::EEPROMKeymap EEPROMKeymap; +extern kaleidoscope::EEPROMKeymap EEPROMKeymap; From 8782cea7c1cbf374986e8ff76d449d11cd3a8d54 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 3 Jun 2017 10:09:06 +0200 Subject: [PATCH 29/59] Focus: When printing the keymap, use the effective layout Instead of printing the keymap from EEPROM, print the effective layout. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Keymap.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index 7acbfdb0..2411b4f3 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -88,7 +88,7 @@ bool EEPROMKeymap::focusKeymap(const char *command) { for (uint8_t layer = 0; layer < max_layers_; layer++) { for (uint8_t row = 0; row < ROWS; row++) { for (uint8_t col = 0; col < COLS; col++) { - Key k = getKey(layer, row, col); + Key k = Layer.getKey(layer, row, col); printKey(k); ::Focus.printSpace(); From 36a0632d6d8903bd5514e5e185e966cc271b6c70 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Sat, 3 Jun 2017 23:49:57 -0700 Subject: [PATCH 30/59] astyle to pad operators --- src/Kaleidoscope/EEPROM-Keymap.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index 2411b4f3..a56b17ca 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -116,7 +116,7 @@ bool EEPROMKeymap::focusKeymapTransfer(const char *command) { for (uint8_t row = 0; row < ROWS; row++) { for (uint8_t col = 0; col < COLS; col++) { Key k = Layer.getKeyFromPROGMEM(layer, row, col); - uint16_t pos =((layer * ROWS * COLS) + (row * COLS) + col); + uint16_t pos = ((layer * ROWS * COLS) + (row * COLS) + col); updateKey(pos, k); } From feda65117004d4639a4d721ed8dea98dbe7ceccd Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 15 Jun 2017 08:35:44 +0200 Subject: [PATCH 31/59] Mark the plugin stable Signed-off-by: Gergely Nagy --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7f17b417..a7f7fc6a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Kaleidoscope-EEPROM-Keymap -![status][st:experimental] [![Build Status][travis:image]][travis:status] +![status][st:stable] [![Build Status][travis:image]][travis:status] [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-EEPROM-Keymap.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-EEPROM-Keymap From 98b389411b29247a1a84ac722f150fcb229610ee Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 15 Jun 2017 08:35:57 +0200 Subject: [PATCH 32/59] Use Kaleidoscope.use instead of USE_PLUGINS Signed-off-by: Gergely Nagy --- README.md | 2 +- examples/EEPROM-Keymap/EEPROM-Keymap.ino | 2 +- src/Kaleidoscope/EEPROM-Keymap.cpp | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a7f7fc6a..8ab29ee4 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ We can then update the keymap via [Focus][plugin:focus]. void setup() { Serial.begin(9600); - USE_PLUGINS(&EEPROMKeymap, &Focus); + Kaleidoscope.use(&EEPROMKeymap, &Focus); Kaleidoscope.setup(); diff --git a/examples/EEPROM-Keymap/EEPROM-Keymap.ino b/examples/EEPROM-Keymap/EEPROM-Keymap.ino index 207d7bae..1f3dd91d 100644 --- a/examples/EEPROM-Keymap/EEPROM-Keymap.ino +++ b/examples/EEPROM-Keymap/EEPROM-Keymap.ino @@ -42,7 +42,7 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { void setup() { Serial.begin(9600); - USE_PLUGINS(&EEPROMKeymap, &Focus); + Kaleidoscope.use(&EEPROMKeymap, &Focus); Kaleidoscope.setup(); diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index a56b17ca..e9a9de8d 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -28,7 +28,7 @@ EEPROMKeymap::EEPROMKeymap(void) { } void EEPROMKeymap::begin(void) { - USE_PLUGINS(&::EEPROMSettings); + Kaleidoscope.use(&::EEPROMSettings); } void EEPROMKeymap::max_layers(uint8_t max) { From ceaded3eb4acd1fba61be3b1a61ca0ec62a1390b Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 25 Jul 2017 15:52:05 -0700 Subject: [PATCH 33/59] Update Makefile to fix OS X build --- Makefile | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index 9ce0c4a9..2b04143a 100644 --- a/Makefile +++ b/Makefile @@ -4,9 +4,10 @@ MAKEFILE_PREFIX=keyboardio/avr/libraries/Kaleidoscope-Plugin/build UNAME_S := $(shell uname -s) -BOARD_HARDWARE_PATH ?= $(HOME)/Arduino/hardware ifeq ($(UNAME_S),Darwin) -BOARD_HARDWARE_PATH ?= $(HOME)/Library/Arduino/hardware +BOARD_HARDWARE_PATH ?= $(HOME)/Documents/Arduino/hardware +else +BOARD_HARDWARE_PATH ?= $(HOME)/Arduino/hardware endif -include $(BOARD_HARDWARE_PATH)/$(MAKEFILE_PREFIX)/*.mk +include $(BOARD_HARDWARE_PATH)/$(MAKEFILE_PREFIX)/rules.mk From c8c5cc0b026a0015a3b13a84fbd12ee31f4f23ed Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 21 Aug 2017 22:22:52 -0700 Subject: [PATCH 34/59] Update Makefile with OSX fixes and new paths --- Makefile | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index 2b04143a..8f830f44 100644 --- a/Makefile +++ b/Makefile @@ -1,13 +1,14 @@ # This stub makefile for a Kaleidoscope plugin pulls in # all targets from the Kaleidoscope-Plugin library -MAKEFILE_PREFIX=keyboardio/avr/libraries/Kaleidoscope-Plugin/build UNAME_S := $(shell uname -s) ifeq ($(UNAME_S),Darwin) -BOARD_HARDWARE_PATH ?= $(HOME)/Documents/Arduino/hardware +SKETCHBOOK_DIR ?= $(HOME)/Documents/Arduino/ else -BOARD_HARDWARE_PATH ?= $(HOME)/Arduino/hardware +SKETCHBOOK_DIR ?= $(HOME)/Arduino endif -include $(BOARD_HARDWARE_PATH)/$(MAKEFILE_PREFIX)/rules.mk +BOARD_HARDWARE_PATH ?= $(SKETCHBOOK_DIR)/hardware +KALEIDOSCOPE_PLUGIN_MAKEFILE_DIR ?= keyboardio/avr/build-tools/makefiles/ +include $(BOARD_HARDWARE_PATH)/$(KALEIDOSCOPE_PLUGIN_MAKEFILE_DIR)/rules.mk From 0f00b4a9a9fa84653a214e09d0b5201537b4d2d1 Mon Sep 17 00:00:00 2001 From: "James N. V. Cash" Date: Wed, 25 Oct 2017 21:17:31 -0400 Subject: [PATCH 35/59] Add method to allow upload of keymap for individual layer --- src/Kaleidoscope/EEPROM-Keymap-Focus.h | 3 +++ src/Kaleidoscope/EEPROM-Keymap.cpp | 16 ++++++++++++++++ src/Kaleidoscope/EEPROM-Keymap.h | 1 + 3 files changed, 20 insertions(+) diff --git a/src/Kaleidoscope/EEPROM-Keymap-Focus.h b/src/Kaleidoscope/EEPROM-Keymap-Focus.h index 23bfb61f..931be0ff 100644 --- a/src/Kaleidoscope/EEPROM-Keymap-Focus.h +++ b/src/Kaleidoscope/EEPROM-Keymap-Focus.h @@ -23,5 +23,8 @@ #define FOCUS_HOOK_KEYMAP FOCUS_HOOK(EEPROMKeymap.focusKeymap, "keymap.map") +#define FOCUS_HOOK_KEYMAP_LAYER FOCUS_HOOK(EEPROMKeymap.focusKeymapLayer, \ + "keymap.layer") + #define FOCUS_HOOK_KEYMAP_TRANSFER FOCUS_HOOK(EEPROMKeymap.focusKeymapTransfer, \ "keymap.transfer") diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index e9a9de8d..af6d5507 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -107,6 +107,22 @@ bool EEPROMKeymap::focusKeymap(const char *command) { return true; } +bool EEPROMKeymap::focusKeymapLayer(const char *command) { + if (strcmp_P(command, PSTR("keymap.layer")) != 0) { + return false; + } + + uint8_t layer = Serial.parseInt(); + uint16_t keysPerLayer = ROWS * COLS; + uint16_t offset = layer * keysPerLayer; + for (uint16_t k = 0; (k < keysPerLayer) && (Serial.peek() != '\n'); k++) { + updateKey(layer + k, parseKey()); + } + + return true; + +} + bool EEPROMKeymap::focusKeymapTransfer(const char *command) { if (strcmp_P(command, PSTR("keymap.transfer")) != 0) return false; diff --git a/src/Kaleidoscope/EEPROM-Keymap.h b/src/Kaleidoscope/EEPROM-Keymap.h index b1e7de81..66c89620 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.h +++ b/src/Kaleidoscope/EEPROM-Keymap.h @@ -36,6 +36,7 @@ class EEPROMKeymap : public KaleidoscopePlugin { static Key getKeyOverride(uint8_t layer, byte row, byte col); static bool focusKeymap(const char *command); + static bool focusKeymapLayer(const char *command); static bool focusKeymapTransfer(const char *command); static void updateKey(uint16_t base_pos, Key key); From 6dcc6a9277ae5a30c32c98f6dc85d2738f274f79 Mon Sep 17 00:00:00 2001 From: "James N. V. Cash" Date: Thu, 26 Oct 2017 08:16:48 -0400 Subject: [PATCH 36/59] Teach plugin to print out the contents of a given layer --- src/Kaleidoscope/EEPROM-Keymap.cpp | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index af6d5507..7d83e792 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -115,8 +115,18 @@ bool EEPROMKeymap::focusKeymapLayer(const char *command) { uint8_t layer = Serial.parseInt(); uint16_t keysPerLayer = ROWS * COLS; uint16_t offset = layer * keysPerLayer; - for (uint16_t k = 0; (k < keysPerLayer) && (Serial.peek() != '\n'); k++) { - updateKey(layer + k, parseKey()); + if (Serial.peek() == '\n') { + for (uint8_t row = 0; row < ROWS; row++) { + for (uint8_t col = 0; col < COLS; col++) { + Key k = Layer.getKey(layer, row, col); + printKey(k); + ::Focus.printSpace(); + } + } + } else { + for (uint16_t k = 0; (k < keysPerLayer) && (Serial.peek() != '\n'); k++) { + updateKey(layer + k, parseKey()); + } } return true; From e4cf2e4c755be8f667a381b07b8d9e7528cf1142 Mon Sep 17 00:00:00 2001 From: "James N. V. Cash" Date: Thu, 26 Oct 2017 08:21:01 -0400 Subject: [PATCH 37/59] Add documentation about new hook to readme --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8ab29ee4..3afc9628 100644 --- a/README.md +++ b/README.md @@ -67,8 +67,8 @@ The plugin provides the `EEPROMKeymap` object, which has the following methods: ## Focus commands -The plugin provides two `Focus` hooks: `FOCUS_HOOK_KEYMAP`, and -`FOCUS_HOOK_KEYMAP_TRANSFER`. Together, they make the following commands +The plugin provides three `Focus` hooks: `FOCUS_HOOK_KEYMAP`, `FOCUS_HOOK_KEYMAP_LAYER`, +and `FOCUS_HOOK_KEYMAP_TRANSFER`. Together, they make the following commands available, respectively: ### `keymap.map [codes...]` @@ -81,6 +81,13 @@ available, respectively: > layer, and go on as long as it has input. It will not go past the layer set > via the `.max_layers()` method. +### `keymap.layer LAYER [codes...]` + +> Without codes, prints the keymap for the given layer (zero-indexed). +> Prints each key as its raw 16-bit keycode. + +> With codes, stores them as the keymap for the given layer. + ### `keymap.transfer LAYER` > Transfers the `LAYER` from the built-in memory of the keyboard into `EEPROM` From 480bfbd0217ce349d6c129ec35c058f8b9b6cdb4 Mon Sep 17 00:00:00 2001 From: "James N. V. Cash" Date: Fri, 27 Oct 2017 17:28:32 -0400 Subject: [PATCH 38/59] Guard against out-of-bounds layer --- src/Kaleidoscope/EEPROM-Keymap.cpp | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index 7d83e792..0d2b00c6 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -113,6 +113,9 @@ bool EEPROMKeymap::focusKeymapLayer(const char *command) { } uint8_t layer = Serial.parseInt(); + if (layer >= max_layers_) { + return false; + } uint16_t keysPerLayer = ROWS * COLS; uint16_t offset = layer * keysPerLayer; if (Serial.peek() == '\n') { From 0073be9a74b87d6772acb6b1e0c7268282951bd4 Mon Sep 17 00:00:00 2001 From: "James N. V. Cash" Date: Mon, 30 Oct 2017 08:16:37 -0400 Subject: [PATCH 39/59] Fix error in storing keys by layer --- src/Kaleidoscope/EEPROM-Keymap.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index 0d2b00c6..5a0a6636 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -117,7 +117,6 @@ bool EEPROMKeymap::focusKeymapLayer(const char *command) { return false; } uint16_t keysPerLayer = ROWS * COLS; - uint16_t offset = layer * keysPerLayer; if (Serial.peek() == '\n') { for (uint8_t row = 0; row < ROWS; row++) { for (uint8_t col = 0; col < COLS; col++) { @@ -127,8 +126,9 @@ bool EEPROMKeymap::focusKeymapLayer(const char *command) { } } } else { + uint16_t offset = layer * keysPerLayer; for (uint16_t k = 0; (k < keysPerLayer) && (Serial.peek() != '\n'); k++) { - updateKey(layer + k, parseKey()); + updateKey(offset + k, parseKey()); } } From c298d22827a6e90235c0bf0b507f3c6df99118be Mon Sep 17 00:00:00 2001 From: "James N. V. Cash" Date: Mon, 30 Oct 2017 10:42:46 -0400 Subject: [PATCH 40/59] Only need keysPerLayer in the updating branch of the conditional --- src/Kaleidoscope/EEPROM-Keymap.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index 5a0a6636..a8bd42bf 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -116,7 +116,6 @@ bool EEPROMKeymap::focusKeymapLayer(const char *command) { if (layer >= max_layers_) { return false; } - uint16_t keysPerLayer = ROWS * COLS; if (Serial.peek() == '\n') { for (uint8_t row = 0; row < ROWS; row++) { for (uint8_t col = 0; col < COLS; col++) { @@ -126,6 +125,7 @@ bool EEPROMKeymap::focusKeymapLayer(const char *command) { } } } else { + uint16_t keysPerLayer = ROWS * COLS; uint16_t offset = layer * keysPerLayer; for (uint16_t k = 0; (k < keysPerLayer) && (Serial.peek() != '\n'); k++) { updateKey(offset + k, parseKey()); From 5d53d77c6f3dc6962ddb9397c8107bdbeca4a059 Mon Sep 17 00:00:00 2001 From: "James N. V. Cash" Date: Fri, 17 Nov 2017 17:13:23 -0500 Subject: [PATCH 41/59] If layer is greater than max_layer, always fall back to EEPROM Current behaviour will make higher layers not work & always return Key_NoKey --- src/Kaleidoscope/EEPROM-Keymap.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index a8bd42bf..72ed86e6 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -54,7 +54,7 @@ Key EEPROMKeymap::getKeyOverride(uint8_t layer, byte row, byte col) { Key key; key = getKey(layer, row, col); - if (key == Key_Transparent) + if (key == Key_Transparent || layer >= max_layers_) key = Layer.getKeyFromPROGMEM(layer, row, col); return key; } From cc0d69ea2d482520cb8548183c06833a6faa7387 Mon Sep 17 00:00:00 2001 From: "James N. V. Cash" Date: Fri, 17 Nov 2017 17:17:55 -0500 Subject: [PATCH 42/59] Explain what max_layers should be set to in README --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 3afc9628..9e247684 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,9 @@ The plugin provides the `EEPROMKeymap` object, which has the following methods: > Tells the extension to reserve space in EEPROM for up to `max` layers. Can > only be called once, any subsequent call will be a no-op. +> This should be set to the number of keymap layers you want to be +> able to program from EEPROM (probably the number of layers you have +> defined in your keymap). ## Focus commands From 02a2a6c54adb327bffcca15c1e536d61349d5fe1 Mon Sep 17 00:00:00 2001 From: matt venn Date: Thu, 14 Dec 2017 18:55:33 +0100 Subject: [PATCH 43/59] fixed missing newline --- src/Kaleidoscope/EEPROM-Keymap.cpp | 1 + 1 file changed, 1 insertion(+) diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index 72ed86e6..a581c464 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -124,6 +124,7 @@ bool EEPROMKeymap::focusKeymapLayer(const char *command) { ::Focus.printSpace(); } } + Serial.println(); } else { uint16_t keysPerLayer = ROWS * COLS; uint16_t offset = layer * keysPerLayer; From 435018eb6a7a40536746037a1216ec2af2ff966a Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 9 May 2018 22:53:53 +0200 Subject: [PATCH 44/59] Updated to use the new plugin APIs Signed-off-by: Gergely Nagy --- README.md | 9 ++++++--- examples/EEPROM-Keymap/EEPROM-Keymap.ino | 10 ++++++---- src/Kaleidoscope/EEPROM-Keymap.cpp | 9 +-------- src/Kaleidoscope/EEPROM-Keymap.h | 8 +++----- 4 files changed, 16 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 9e247684..ec8373da 100644 --- a/README.md +++ b/README.md @@ -40,12 +40,15 @@ We can then update the keymap via [Focus][plugin:focus]. #include #include +KALEIDOSCOPE_INIT_PLUGINS(EEPROMSettings, + EEPROMKeymap, + Focus); + void setup() { Serial.begin(9600); - Kaleidoscope.use(&EEPROMKeymap, &Focus); - + Kaleidoscope.setup(); - + Focus.addHook(FOCUS_HOOK_KEYMAP); Focus.addHook(FOCUS_HOOK_KEYMAP_TRANSFER); diff --git a/examples/EEPROM-Keymap/EEPROM-Keymap.ino b/examples/EEPROM-Keymap/EEPROM-Keymap.ino index 1f3dd91d..5a1bb85c 100644 --- a/examples/EEPROM-Keymap/EEPROM-Keymap.ino +++ b/examples/EEPROM-Keymap/EEPROM-Keymap.ino @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-EEPROM-Keymap -- EEPROM-based keymap support. - * Copyright (C) 2017 Gergely Nagy + * Copyright (C) 2017, 2018 Gergely Nagy * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -20,6 +20,7 @@ #include #include +// *INDENT-OFF* const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED (Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, @@ -32,18 +33,19 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, - Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, Key_skip), }; +// *INDENT-ON* + +KALEIDOSCOPE_INIT_PLUGINS(EEPROMSettings, EEPROMKeymap, Focus); void setup() { Serial.begin(9600); - Kaleidoscope.use(&EEPROMKeymap, &Focus); - Kaleidoscope.setup(); Focus.addHook(FOCUS_HOOK_SETTINGS); diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index a581c464..015854ac 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-EEPROM-Keymap -- EEPROM-based keymap support. - * Copyright (C) 2017 Gergely Nagy + * Copyright (C) 2017, 2018 Gergely Nagy * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -24,13 +24,6 @@ namespace kaleidoscope { uint16_t EEPROMKeymap::keymap_base_; uint8_t EEPROMKeymap::max_layers_; -EEPROMKeymap::EEPROMKeymap(void) { -} - -void EEPROMKeymap::begin(void) { - Kaleidoscope.use(&::EEPROMSettings); -} - void EEPROMKeymap::max_layers(uint8_t max) { max_layers_ = max; keymap_base_ = ::EEPROMSettings.requestSlice(max_layers_ * ROWS * COLS * 2); diff --git a/src/Kaleidoscope/EEPROM-Keymap.h b/src/Kaleidoscope/EEPROM-Keymap.h index 66c89620..564fce98 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.h +++ b/src/Kaleidoscope/EEPROM-Keymap.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-EEPROM-Keymap -- EEPROM-based keymap support. - * Copyright (C) 2017 Gergely Nagy + * Copyright (C) 2017, 2018 Gergely Nagy * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -22,14 +22,12 @@ #include namespace kaleidoscope { -class EEPROMKeymap : public KaleidoscopePlugin { +class EEPROMKeymap : public kaleidoscope::Plugin { public: - EEPROMKeymap(void); + EEPROMKeymap(void) {} static void max_layers(uint8_t max); - void begin(void) final; - static uint16_t keymap_base(void); static Key getKey(uint8_t layer, byte row, byte col); From 459d847002e47e0783279ee82fe6eca517129bac Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:13:59 +0200 Subject: [PATCH 45/59] Relicense under the GPLv3 (only) Signed-off-by: Gergely Nagy --- examples/EEPROM-Keymap/EEPROM-Keymap.ino | 19 +++++++++---------- src/Kaleidoscope-EEPROM-Keymap.h | 19 +++++++++---------- src/Kaleidoscope/EEPROM-Keymap-Focus.h | 19 +++++++++---------- src/Kaleidoscope/EEPROM-Keymap.cpp | 19 +++++++++---------- src/Kaleidoscope/EEPROM-Keymap.h | 19 +++++++++---------- 5 files changed, 45 insertions(+), 50 deletions(-) diff --git a/examples/EEPROM-Keymap/EEPROM-Keymap.ino b/examples/EEPROM-Keymap/EEPROM-Keymap.ino index 5a1bb85c..dacd0ccf 100644 --- a/examples/EEPROM-Keymap/EEPROM-Keymap.ino +++ b/examples/EEPROM-Keymap/EEPROM-Keymap.ino @@ -2,18 +2,17 @@ * Kaleidoscope-EEPROM-Keymap -- EEPROM-based keymap support. * Copyright (C) 2017, 2018 Gergely Nagy * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. + * This program is free software: you can redistribute it and/or modify it under + * the terms of the GNU General Public License as published by the Free Software + * Foundation, version 3. * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * You should have received a copy of the GNU General Public License along with + * this program. If not, see . */ #include diff --git a/src/Kaleidoscope-EEPROM-Keymap.h b/src/Kaleidoscope-EEPROM-Keymap.h index fec376e8..9e161e93 100644 --- a/src/Kaleidoscope-EEPROM-Keymap.h +++ b/src/Kaleidoscope-EEPROM-Keymap.h @@ -2,18 +2,17 @@ * Kaleidoscope-EEPROM-Keymap -- EEPROM-based keymap support. * Copyright (C) 2017 Gergely Nagy * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. + * This program is free software: you can redistribute it and/or modify it under + * the terms of the GNU General Public License as published by the Free Software + * Foundation, version 3. * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * You should have received a copy of the GNU General Public License along with + * this program. If not, see . */ #pragma once diff --git a/src/Kaleidoscope/EEPROM-Keymap-Focus.h b/src/Kaleidoscope/EEPROM-Keymap-Focus.h index 931be0ff..3964677f 100644 --- a/src/Kaleidoscope/EEPROM-Keymap-Focus.h +++ b/src/Kaleidoscope/EEPROM-Keymap-Focus.h @@ -2,18 +2,17 @@ * Kaleidoscope-EEPROM-Keymap -- EEPROM-based keymap support. * Copyright (C) 2017 Gergely Nagy * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. + * This program is free software: you can redistribute it and/or modify it under + * the terms of the GNU General Public License as published by the Free Software + * Foundation, version 3. * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * You should have received a copy of the GNU General Public License along with + * this program. If not, see . */ #pragma once diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index 015854ac..0e79e478 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -2,18 +2,17 @@ * Kaleidoscope-EEPROM-Keymap -- EEPROM-based keymap support. * Copyright (C) 2017, 2018 Gergely Nagy * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. + * This program is free software: you can redistribute it and/or modify it under + * the terms of the GNU General Public License as published by the Free Software + * Foundation, version 3. * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * You should have received a copy of the GNU General Public License along with + * this program. If not, see . */ #include diff --git a/src/Kaleidoscope/EEPROM-Keymap.h b/src/Kaleidoscope/EEPROM-Keymap.h index 564fce98..eaa48784 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.h +++ b/src/Kaleidoscope/EEPROM-Keymap.h @@ -2,18 +2,17 @@ * Kaleidoscope-EEPROM-Keymap -- EEPROM-based keymap support. * Copyright (C) 2017, 2018 Gergely Nagy * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. + * This program is free software: you can redistribute it and/or modify it under + * the terms of the GNU General Public License as published by the Free Software + * Foundation, version 3. * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * You should have received a copy of the GNU General Public License along with + * this program. If not, see . */ #pragma once From b2ae841d245bc3800c4d18e0cd4235be53dfaf62 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:14:01 +0200 Subject: [PATCH 46/59] Assign my copyright to Keyboard.io While the original plugin was written independently, significant developments were made while working for Keyboard.io. As such, I feel it is appropriate to assign copyright to the company. Signed-off-by: Gergely Nagy --- examples/EEPROM-Keymap/EEPROM-Keymap.ino | 2 +- library.properties | 2 +- src/Kaleidoscope-EEPROM-Keymap.h | 2 +- src/Kaleidoscope/EEPROM-Keymap-Focus.h | 2 +- src/Kaleidoscope/EEPROM-Keymap.cpp | 2 +- src/Kaleidoscope/EEPROM-Keymap.h | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/examples/EEPROM-Keymap/EEPROM-Keymap.ino b/examples/EEPROM-Keymap/EEPROM-Keymap.ino index dacd0ccf..60e48a19 100644 --- a/examples/EEPROM-Keymap/EEPROM-Keymap.ino +++ b/examples/EEPROM-Keymap/EEPROM-Keymap.ino @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-EEPROM-Keymap -- EEPROM-based keymap support. - * Copyright (C) 2017, 2018 Gergely Nagy + * Copyright (C) 2017, 2018 Keyboard.io, Inc * * This program is free software: you can redistribute it and/or modify it under * the terms of the GNU General Public License as published by the Free Software diff --git a/library.properties b/library.properties index 4e0b6dbc..6865fb81 100644 --- a/library.properties +++ b/library.properties @@ -1,7 +1,7 @@ name=Kaleidoscope-EEPROM-Keymap version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy +maintainer=Gergely Nagy sentence=EEPROM-based keymap support for Kaleidoscope. paragraph=... category=Communication diff --git a/src/Kaleidoscope-EEPROM-Keymap.h b/src/Kaleidoscope-EEPROM-Keymap.h index 9e161e93..9ab581bd 100644 --- a/src/Kaleidoscope-EEPROM-Keymap.h +++ b/src/Kaleidoscope-EEPROM-Keymap.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-EEPROM-Keymap -- EEPROM-based keymap support. - * Copyright (C) 2017 Gergely Nagy + * Copyright (C) 2017 Keyboard.io, Inc * * This program is free software: you can redistribute it and/or modify it under * the terms of the GNU General Public License as published by the Free Software diff --git a/src/Kaleidoscope/EEPROM-Keymap-Focus.h b/src/Kaleidoscope/EEPROM-Keymap-Focus.h index 3964677f..dce6ee3f 100644 --- a/src/Kaleidoscope/EEPROM-Keymap-Focus.h +++ b/src/Kaleidoscope/EEPROM-Keymap-Focus.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-EEPROM-Keymap -- EEPROM-based keymap support. - * Copyright (C) 2017 Gergely Nagy + * Copyright (C) 2017 Keyboard.io, Inc * * This program is free software: you can redistribute it and/or modify it under * the terms of the GNU General Public License as published by the Free Software diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index 0e79e478..aede1faf 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-EEPROM-Keymap -- EEPROM-based keymap support. - * Copyright (C) 2017, 2018 Gergely Nagy + * Copyright (C) 2017, 2018 Keyboard.io, Inc * * This program is free software: you can redistribute it and/or modify it under * the terms of the GNU General Public License as published by the Free Software diff --git a/src/Kaleidoscope/EEPROM-Keymap.h b/src/Kaleidoscope/EEPROM-Keymap.h index eaa48784..26ebfb48 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.h +++ b/src/Kaleidoscope/EEPROM-Keymap.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-EEPROM-Keymap -- EEPROM-based keymap support. - * Copyright (C) 2017, 2018 Gergely Nagy + * Copyright (C) 2017, 2018 Keyboard.io, Inc * * This program is free software: you can redistribute it and/or modify it under * the terms of the GNU General Public License as published by the Free Software From e16d0dfcc53ff54a57013ef159f6dff6231baadc Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:14:03 +0200 Subject: [PATCH 47/59] Add CONTRIBUTING.md Copied from Kaleidoscope, as it is applicable here too. Signed-off-by: Gergely Nagy --- CONTRIBUTING.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..c490e3ce --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# Developer Certificate of Origin + +All contributions must include acceptance of the DCO: + +``` +Developer Certificate of Origin +Version 1.1 + +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. +1 Letterman Drive +Suite D4700 +San Francisco, CA, 94129 + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + + +Developer's Certificate of Origin 1.1 + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + +(b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + +(c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + +(d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. +``` + +## Sign your work + +To accept the DCO, please add this line to each commit message with your name +and email address (`git commit -s` will do this for you): + + Signed-off-by: Jane Example From b9c5fd4c9103b063593219e944c10e3a6eec47c3 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 4 Sep 2018 18:24:00 -0700 Subject: [PATCH 48/59] Update travis.yml to point to new bundle repo --- .travis.yml | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/.travis.yml b/.travis.yml index e7030acf..e3e64f77 100644 --- a/.travis.yml +++ b/.travis.yml @@ -2,10 +2,15 @@ dist: trusty sudo: false os: - linux +addons: + apt: + packages: + - shellcheck install: - - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Arduino-Boards hardware/keyboardio/avr + - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Kaleidoscope-Bundle-Keyboardio hardware/keyboardio script: - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware + - shellcheck bin/kaleidoscope-builder notifications: irc: channels: @@ -13,7 +18,7 @@ notifications: use_notice: true skip_join: true template: - - "%{repository_name}/%{branch} %{commit} by %{author}: %{commit_subject} %{build_url} %{message}" + - "%{repository_name}/%{branch} %{commit} by %{author}: %{commit_subject} %{build_url} %{message}" email: on_success: change on_failure: change From fbdc8bdf35dc8cf976379893eba2e03612044038 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 4 Sep 2018 18:42:29 -0700 Subject: [PATCH 49/59] shellcheck should only be run in the Kaleidoscope repo --- .travis.yml | 5 ----- 1 file changed, 5 deletions(-) diff --git a/.travis.yml b/.travis.yml index e3e64f77..23d30ccc 100644 --- a/.travis.yml +++ b/.travis.yml @@ -2,15 +2,10 @@ dist: trusty sudo: false os: - linux -addons: - apt: - packages: - - shellcheck install: - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Kaleidoscope-Bundle-Keyboardio hardware/keyboardio script: - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware - - shellcheck bin/kaleidoscope-builder notifications: irc: channels: From a02cde9c21c1282b9e27a96ff458a84aae649f4c Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 3 Oct 2018 08:47:08 +0200 Subject: [PATCH 50/59] Automatically pull in EEPROMSettings, and set up defaults To make it easier to use the plugin, pull in `EEPROMSettings` by default, and explicitly call its `onSetup` (it is safe to do so), so user sketches don't have to if they don't use `EEPROMSettings` directly. Also set `Layer.getKey` to `EEPROMKeymap.getKeyOverride` to provide a sensible default. Signed-off-by: Gergely Nagy --- README.md | 7 +------ examples/EEPROM-Keymap/EEPROM-Keymap.ino | 9 +++------ src/Kaleidoscope/EEPROM-Keymap.cpp | 7 +++++++ src/Kaleidoscope/EEPROM-Keymap.h | 2 ++ 4 files changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index ec8373da..3fab8197 100644 --- a/README.md +++ b/README.md @@ -37,11 +37,9 @@ We can then update the keymap via [Focus][plugin:focus]. ```c++ #include #include -#include #include -KALEIDOSCOPE_INIT_PLUGINS(EEPROMSettings, - EEPROMKeymap, +KALEIDOSCOPE_INIT_PLUGINS(EEPROMKeymap, Focus); void setup() { @@ -52,10 +50,7 @@ void setup() { Focus.addHook(FOCUS_HOOK_KEYMAP); Focus.addHook(FOCUS_HOOK_KEYMAP_TRANSFER); - Layer.getKey = EEPROMKeymap.getKeyOverride; - EEPROMKeymap.max_layers(1); - EEPROMSettings.seal(); } ``` diff --git a/examples/EEPROM-Keymap/EEPROM-Keymap.ino b/examples/EEPROM-Keymap/EEPROM-Keymap.ino index 60e48a19..e7771534 100644 --- a/examples/EEPROM-Keymap/EEPROM-Keymap.ino +++ b/examples/EEPROM-Keymap/EEPROM-Keymap.ino @@ -20,7 +20,7 @@ #include // *INDENT-OFF* -const Key keymaps[][ROWS][COLS] PROGMEM = { +KEYMAPS( [0] = KEYMAP_STACKED (Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, @@ -37,10 +37,10 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, Key_skip), -}; +) // *INDENT-ON* -KALEIDOSCOPE_INIT_PLUGINS(EEPROMSettings, EEPROMKeymap, Focus); +KALEIDOSCOPE_INIT_PLUGINS(EEPROMKeymap, Focus); void setup() { Serial.begin(9600); @@ -53,10 +53,7 @@ void setup() { Focus.addHook(FOCUS_HOOK_HELP); Focus.addHook(FOCUS_HOOK_VERSION); - Layer.getKey = EEPROMKeymap.getKeyOverride; - EEPROMKeymap.max_layers(1); - EEPROMSettings.seal(); } void loop() { diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index aede1faf..0b707fe2 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -23,6 +23,13 @@ namespace kaleidoscope { uint16_t EEPROMKeymap::keymap_base_; uint8_t EEPROMKeymap::max_layers_; +EventHandlerResult EEPROMKeymap::onSetup() { + ::EEPROMSettings.onSetup(); + Layer.getKey = ::EEPROMKeymap.getKeyOverride; + + return EventHandlerResult::OK; +} + void EEPROMKeymap::max_layers(uint8_t max) { max_layers_ = max; keymap_base_ = ::EEPROMSettings.requestSlice(max_layers_ * ROWS * COLS * 2); diff --git a/src/Kaleidoscope/EEPROM-Keymap.h b/src/Kaleidoscope/EEPROM-Keymap.h index 26ebfb48..631e51b3 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.h +++ b/src/Kaleidoscope/EEPROM-Keymap.h @@ -25,6 +25,8 @@ class EEPROMKeymap : public kaleidoscope::Plugin { public: EEPROMKeymap(void) {} + EventHandlerResult onSetup(); + static void max_layers(uint8_t max); static uint16_t keymap_base(void); From f3eb6a7200fc78ba493f0d6b815bf34137b275db Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 3 Oct 2018 08:26:34 +0200 Subject: [PATCH 51/59] Try to avoid a possible PROGMEM overflow in getKeyOverride If we're looking up a key from `PROGMEM`, only do that if the layer in question is smaller than `layer_count`. Doing otherwise would read garbage from `PROGMEM` in case we try to read from a layer higher than what we have in there. This can happen if we have more layers in `EEPROM` than in `PROGMEM`. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Keymap.cpp | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index 0b707fe2..0be6c4f6 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -53,8 +53,17 @@ Key EEPROMKeymap::getKeyOverride(uint8_t layer, byte row, byte col) { Key key; key = getKey(layer, row, col); - if (key == Key_Transparent || layer >= max_layers_) + + /* + * If we read a transparent key from EEPROM, or we're trying to read from a + * layer higher than what is available there (max_layers), check if we're below + * the layer count in PROGMEM (layer_count). If we are, read from PROGMEM, + * otherwise leave the key as-is (either transparent or NoKey). + */ + if ((key == Key_Transparent || layer >= max_layers) && + (layer < layer_count)) key = Layer.getKeyFromPROGMEM(layer, row, col); + return key; } From 906f567698e700b397e57a0dd4dd422409bf3b76 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 3 Oct 2018 12:34:59 +0200 Subject: [PATCH 52/59] Fix a compile error `max_layers` is a method, so comparing to that would be integer<->pointer comparison. We want to compare to `max_layers_`. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Keymap.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index 0be6c4f6..2084ceb1 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -60,7 +60,7 @@ Key EEPROMKeymap::getKeyOverride(uint8_t layer, byte row, byte col) { * the layer count in PROGMEM (layer_count). If we are, read from PROGMEM, * otherwise leave the key as-is (either transparent or NoKey). */ - if ((key == Key_Transparent || layer >= max_layers) && + if ((key == Key_Transparent || layer >= max_layers_) && (layer < layer_count)) key = Layer.getKeyFromPROGMEM(layer, row, col); From 184981ff9a89f19e4670879f206f1b5e61f2e52c Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 5 Oct 2018 14:07:45 +0200 Subject: [PATCH 53/59] Migrate to the onFocusEvent API While there, drop the `keymap.layer` command, which was a workaround to a Chrysalis bug fixed since. Signed-off-by: Gergely Nagy --- README.md | 40 ++++-------- examples/EEPROM-Keymap/EEPROM-Keymap.ino | 12 +--- src/Kaleidoscope-EEPROM-Keymap.h | 2 +- src/Kaleidoscope/EEPROM-Keymap-Transfer.cpp | 50 +++++++++++++++ ...eymap-Focus.h => EEPROM-Keymap-Transfer.h} | 17 +++-- src/Kaleidoscope/EEPROM-Keymap.cpp | 62 +++---------------- src/Kaleidoscope/EEPROM-Keymap.h | 5 +- 7 files changed, 87 insertions(+), 101 deletions(-) create mode 100644 src/Kaleidoscope/EEPROM-Keymap-Transfer.cpp rename src/Kaleidoscope/{EEPROM-Keymap-Focus.h => EEPROM-Keymap-Transfer.h} (65%) diff --git a/README.md b/README.md index 3fab8197..6baff5ff 100644 --- a/README.md +++ b/README.md @@ -18,38 +18,32 @@ overlay there. In the latter case, whenever there is a non-transparent key on the overlay, we will use that instead of the keyboard default. In short, this plugin allows us to change our keymaps, without having to compile -and flash new firmware. It does so through the use of the [Focus][plugin:focus] -plugin. +and flash new firmware. It does so through the use of the +[FocusSerial][plugin:focusSerial] plugin. - [plugin:focus]: https://github.com/keyboardio/Kaleidoscope-Focus + [plugin:focusSerial]: https://github.com/keyboardio/Kaleidoscope-FocusSerial ## Using the plugin Using the plugin is reasonably simple: after including the header, enable the -plugin, and let the `Layer` object know that we'll be using `EEPROMKeymap` to -figure out which keys to use. We can either use the `getKeyOverride` or the -`getKey` method, depending on whether we want to override, or fully replace the -built-in keymap. Then we need to set at most how many layers we want to store in -`EEPROM`, and that is about it. +plugin, and configure how many layers at most we want to store in `EEPROM`. +There are other settings one can tweak, but these two steps are enough to get +started with. -We can then update the keymap via [Focus][plugin:focus]. +Once these are set up, we can update the keymap via [Focus][plugin:focusSerial]. ```c++ #include #include -#include +#include KALEIDOSCOPE_INIT_PLUGINS(EEPROMKeymap, - Focus); + Focus, + FocusKeymapTransferCommand); void setup() { - Serial.begin(9600); - Kaleidoscope.setup(); - Focus.addHook(FOCUS_HOOK_KEYMAP); - Focus.addHook(FOCUS_HOOK_KEYMAP_TRANSFER); - EEPROMKeymap.max_layers(1); } ``` @@ -68,9 +62,8 @@ The plugin provides the `EEPROMKeymap` object, which has the following methods: ## Focus commands -The plugin provides three `Focus` hooks: `FOCUS_HOOK_KEYMAP`, `FOCUS_HOOK_KEYMAP_LAYER`, -and `FOCUS_HOOK_KEYMAP_TRANSFER`. Together, they make the following commands -available, respectively: +The plugin provides a `keymap.map` Focus command unconditionally, and a +`keymap.transfer` via the `FocusKeymapTransferCommand` object. ### `keymap.map [codes...]` @@ -82,13 +75,6 @@ available, respectively: > layer, and go on as long as it has input. It will not go past the layer set > via the `.max_layers()` method. -### `keymap.layer LAYER [codes...]` - -> Without codes, prints the keymap for the given layer (zero-indexed). -> Prints each key as its raw 16-bit keycode. - -> With codes, stores them as the keymap for the given layer. - ### `keymap.transfer LAYER` > Transfers the `LAYER` from the built-in memory of the keyboard into `EEPROM` @@ -103,7 +89,7 @@ available, respectively: ## Dependencies * [Kaleidoscope-EEPROM-Settings](https://github.com/keyboardio/Kaleidoscope-EEPROM-Settings) -* [Kaleidoscope-Focus](https://github.com/keyboardio/Kaleidoscope-Focus) +* [Kaleidoscope-FocusSerial](https://github.com/keyboardio/Kaleidoscope-FocusSerial) ## Further reading diff --git a/examples/EEPROM-Keymap/EEPROM-Keymap.ino b/examples/EEPROM-Keymap/EEPROM-Keymap.ino index e7771534..50f3b4b8 100644 --- a/examples/EEPROM-Keymap/EEPROM-Keymap.ino +++ b/examples/EEPROM-Keymap/EEPROM-Keymap.ino @@ -17,7 +17,7 @@ #include #include -#include +#include // *INDENT-OFF* KEYMAPS( @@ -40,19 +40,11 @@ KEYMAPS( ) // *INDENT-ON* -KALEIDOSCOPE_INIT_PLUGINS(EEPROMKeymap, Focus); +KALEIDOSCOPE_INIT_PLUGINS(EEPROMKeymap, Focus, FocusKeymapTransfer); void setup() { - Serial.begin(9600); - Kaleidoscope.setup(); - Focus.addHook(FOCUS_HOOK_SETTINGS); - Focus.addHook(FOCUS_HOOK_KEYMAP); - Focus.addHook(FOCUS_HOOK_KEYMAP_TRANSFER); - Focus.addHook(FOCUS_HOOK_HELP); - Focus.addHook(FOCUS_HOOK_VERSION); - EEPROMKeymap.max_layers(1); } diff --git a/src/Kaleidoscope-EEPROM-Keymap.h b/src/Kaleidoscope-EEPROM-Keymap.h index 9ab581bd..3bcb13c8 100644 --- a/src/Kaleidoscope-EEPROM-Keymap.h +++ b/src/Kaleidoscope-EEPROM-Keymap.h @@ -18,4 +18,4 @@ #pragma once #include -#include +#include diff --git a/src/Kaleidoscope/EEPROM-Keymap-Transfer.cpp b/src/Kaleidoscope/EEPROM-Keymap-Transfer.cpp new file mode 100644 index 00000000..77ec771b --- /dev/null +++ b/src/Kaleidoscope/EEPROM-Keymap-Transfer.cpp @@ -0,0 +1,50 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-EEPROM-Keymap -- EEPROM-based keymap support. + * Copyright (C) 2017, 2018 Keyboard.io, Inc + * + * This program is free software: you can redistribute it and/or modify it under + * the terms of the GNU General Public License as published by the Free Software + * Foundation, version 3. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. + * + * You should have received a copy of the GNU General Public License along with + * this program. If not, see . + */ + +#include +#include +#include + +namespace kaleidoscope { +namespace eeprom { + +EventHandlerResult FocusKeymapTransferCommand::onFocusEvent(const char *command) { + const char *cmd = PSTR("keymap.transfer"); + + if (::Focus.handleHelp(command, cmd)) + return EventHandlerResult::OK; + if (strcmp_P(command, cmd) != 0) + return EventHandlerResult::OK; + + uint8_t layer = Serial.parseInt(); + + for (uint8_t row = 0; row < ROWS; row++) { + for (uint8_t col = 0; col < COLS; col++) { + Key k = Layer.getKeyFromPROGMEM(layer, row, col); + uint16_t pos = ((layer * ROWS * COLS) + (row * COLS) + col); + + ::EEPROMKeymap.updateKey(pos, k); + } + } + + return EventHandlerResult::EVENT_CONSUMED; +} + +} +} + +kaleidoscope::eeprom::FocusKeymapTransferCommand FocusKeymapTransferCommand; diff --git a/src/Kaleidoscope/EEPROM-Keymap-Focus.h b/src/Kaleidoscope/EEPROM-Keymap-Transfer.h similarity index 65% rename from src/Kaleidoscope/EEPROM-Keymap-Focus.h rename to src/Kaleidoscope/EEPROM-Keymap-Transfer.h index dce6ee3f..6dfee13c 100644 --- a/src/Kaleidoscope/EEPROM-Keymap-Focus.h +++ b/src/Kaleidoscope/EEPROM-Keymap-Transfer.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-EEPROM-Keymap -- EEPROM-based keymap support. - * Copyright (C) 2017 Keyboard.io, Inc + * Copyright (C) 2017-2018 Keyboard.io, Inc * * This program is free software: you can redistribute it and/or modify it under * the terms of the GNU General Public License as published by the Free Software @@ -20,10 +20,15 @@ #include #include -#define FOCUS_HOOK_KEYMAP FOCUS_HOOK(EEPROMKeymap.focusKeymap, "keymap.map") +namespace kaleidoscope { +namespace eeprom { +class FocusKeymapTransferCommand : public Plugin { + public: + FocusKeymapTransferCommand() {} -#define FOCUS_HOOK_KEYMAP_LAYER FOCUS_HOOK(EEPROMKeymap.focusKeymapLayer, \ - "keymap.layer") + EventHandlerResult onFocusEvent(const char *command); +}; +} +} -#define FOCUS_HOOK_KEYMAP_TRANSFER FOCUS_HOOK(EEPROMKeymap.focusKeymapTransfer, \ - "keymap.transfer") +extern kaleidoscope::eeprom::FocusKeymapTransferCommand FocusKeymapTransferCommand; diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index 2084ceb1..28e5c608 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -17,7 +17,7 @@ #include #include -#include +#include namespace kaleidoscope { uint16_t EEPROMKeymap::keymap_base_; @@ -88,9 +88,13 @@ void EEPROMKeymap::printKey(Key k) { ::Focus.printNumber(k.raw); } -bool EEPROMKeymap::focusKeymap(const char *command) { - if (strcmp_P(command, PSTR("keymap.map")) != 0) - return false; +EventHandlerResult EEPROMKeymap::onFocusEvent(const char *command) { + const char *cmd = PSTR("keymap.map"); + if (::Focus.handleHelp(command, cmd)) + return EventHandlerResult::OK; + + if (strcmp_P(command, cmd) != 0) + return EventHandlerResult::OK; if (Serial.peek() == '\n') { for (uint8_t layer = 0; layer < max_layers_; layer++) { @@ -112,55 +116,7 @@ bool EEPROMKeymap::focusKeymap(const char *command) { } } - return true; -} - -bool EEPROMKeymap::focusKeymapLayer(const char *command) { - if (strcmp_P(command, PSTR("keymap.layer")) != 0) { - return false; - } - - uint8_t layer = Serial.parseInt(); - if (layer >= max_layers_) { - return false; - } - if (Serial.peek() == '\n') { - for (uint8_t row = 0; row < ROWS; row++) { - for (uint8_t col = 0; col < COLS; col++) { - Key k = Layer.getKey(layer, row, col); - printKey(k); - ::Focus.printSpace(); - } - } - Serial.println(); - } else { - uint16_t keysPerLayer = ROWS * COLS; - uint16_t offset = layer * keysPerLayer; - for (uint16_t k = 0; (k < keysPerLayer) && (Serial.peek() != '\n'); k++) { - updateKey(offset + k, parseKey()); - } - } - - return true; - -} - -bool EEPROMKeymap::focusKeymapTransfer(const char *command) { - if (strcmp_P(command, PSTR("keymap.transfer")) != 0) - return false; - - uint8_t layer = Serial.parseInt(); - - for (uint8_t row = 0; row < ROWS; row++) { - for (uint8_t col = 0; col < COLS; col++) { - Key k = Layer.getKeyFromPROGMEM(layer, row, col); - uint16_t pos = ((layer * ROWS * COLS) + (row * COLS) + col); - - updateKey(pos, k); - } - } - - return true; + return EventHandlerResult::EVENT_CONSUMED; } } diff --git a/src/Kaleidoscope/EEPROM-Keymap.h b/src/Kaleidoscope/EEPROM-Keymap.h index 631e51b3..86368f3a 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.h +++ b/src/Kaleidoscope/EEPROM-Keymap.h @@ -26,6 +26,7 @@ class EEPROMKeymap : public kaleidoscope::Plugin { EEPROMKeymap(void) {} EventHandlerResult onSetup(); + EventHandlerResult onFocusEvent(const char *command); static void max_layers(uint8_t max); @@ -34,10 +35,6 @@ class EEPROMKeymap : public kaleidoscope::Plugin { static Key getKey(uint8_t layer, byte row, byte col); static Key getKeyOverride(uint8_t layer, byte row, byte col); - static bool focusKeymap(const char *command); - static bool focusKeymapLayer(const char *command); - static bool focusKeymapTransfer(const char *command); - static void updateKey(uint16_t base_pos, Key key); private: From a066d82747b6d3f5399a05745c334e2d1d3601bd Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 5 Oct 2018 21:25:48 +0200 Subject: [PATCH 54/59] Fix a thinko It's called `FocusKeymapTransferCommand`, not `FocusKeymapTransfer`. Signed-off-by: Gergely Nagy --- examples/EEPROM-Keymap/EEPROM-Keymap.ino | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/EEPROM-Keymap/EEPROM-Keymap.ino b/examples/EEPROM-Keymap/EEPROM-Keymap.ino index 50f3b4b8..e5c35ec9 100644 --- a/examples/EEPROM-Keymap/EEPROM-Keymap.ino +++ b/examples/EEPROM-Keymap/EEPROM-Keymap.ino @@ -40,7 +40,7 @@ KEYMAPS( ) // *INDENT-ON* -KALEIDOSCOPE_INIT_PLUGINS(EEPROMKeymap, Focus, FocusKeymapTransfer); +KALEIDOSCOPE_INIT_PLUGINS(EEPROMKeymap, Focus, FocusKeymapTransferCommand); void setup() { Kaleidoscope.setup(); From 83f1805d5d3384bbcb157daac33abbeeb684a1b6 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 9 Oct 2018 00:35:14 +0200 Subject: [PATCH 55/59] Redesign the plugin setup procedure Instead of a low-level interface where one has to set the EEPROM-stored layers and the lookup method separately, introduce a `setup` method that combines the two in a much easier to grasp interface. It takes a layer number, and an optional mode, and sets things up accordingly. With this new setup procedure comes a new way of how the plugin works: instead of being able to override the keymap in EEPROM, we extend it (or use a custom implementation, for advanced use-cases). The default layer can still be set via Focus, thus effectively overriding the keymap in PROGMEM. To better support this, a new Focus command is introduced too: `keymap.roLayers`, which returns the number of layers in PROGMEM. The `keymap.transfer` Focus command is removed, because it can be done much more reliably from the host side, building on top of `keymap.map`. The rest of the lower-level interface is still there, though undocumented, for advanced use-cases the new simplified setup does not fit. Signed-off-by: Gergely Nagy --- README.md | 63 ++++++------------- examples/EEPROM-Keymap/EEPROM-Keymap.ino | 4 +- src/Kaleidoscope-EEPROM-Keymap.h | 1 - src/Kaleidoscope/EEPROM-Keymap-Transfer.cpp | 50 --------------- src/Kaleidoscope/EEPROM-Keymap-Transfer.h | 34 ---------- src/Kaleidoscope/EEPROM-Keymap.cpp | 69 +++++++++++++++------ src/Kaleidoscope/EEPROM-Keymap.h | 11 +++- 7 files changed, 80 insertions(+), 152 deletions(-) delete mode 100644 src/Kaleidoscope/EEPROM-Keymap-Transfer.cpp delete mode 100644 src/Kaleidoscope/EEPROM-Keymap-Transfer.h diff --git a/README.md b/README.md index 6baff5ff..34d7c9f9 100644 --- a/README.md +++ b/README.md @@ -9,26 +9,15 @@ [st:broken]: https://img.shields.io/badge/broken-X-black.svg?style=flat&colorA=e05d44&colorB=494e52 [st:experimental]: https://img.shields.io/badge/experimental----black.svg?style=flat&colorA=dfb317&colorB=494e52 -While keyboards usually ship with a keymap programmed in, to be able to change -that keymap, without flashing new firmware, we need a way to place the keymap -into a place we can update at run-time, and which persists across reboots. -Fortunately, we have a bit of `EEPROM` on the keyboard, and can use it to store -either the full keymap (and saving space in the firmware then), or store an -overlay there. In the latter case, whenever there is a non-transparent key on -the overlay, we will use that instead of the keyboard default. - -In short, this plugin allows us to change our keymaps, without having to compile -and flash new firmware. It does so through the use of the -[FocusSerial][plugin:focusSerial] plugin. +While keyboards usually ship with a keymap programmed in, to be able to change that keymap, without flashing new firmware, we need a way to place the keymap into a place we can update at run-time, and which persists across reboots. Fortunately, we have a bit of `EEPROM` on the keyboard, and can use it to store either the full keymap (and saving space in the firmware then), or store additional layers there. + +In short, this plugin allows us to change our keymaps, without having to compile and flash new firmware. It does so through the use of the [FocusSerial][plugin:focusSerial] plugin. [plugin:focusSerial]: https://github.com/keyboardio/Kaleidoscope-FocusSerial ## Using the plugin -Using the plugin is reasonably simple: after including the header, enable the -plugin, and configure how many layers at most we want to store in `EEPROM`. -There are other settings one can tweak, but these two steps are enough to get -started with. +Using the plugin is reasonably simple: after including the header, enable the plugin, and configure how many layers at most we want to store in `EEPROM`. There are other settings one can tweak, but these two steps are enough to get started with. Once these are set up, we can update the keymap via [Focus][plugin:focusSerial]. @@ -38,53 +27,40 @@ Once these are set up, we can update the keymap via [Focus][plugin:focusSerial]. #include KALEIDOSCOPE_INIT_PLUGINS(EEPROMKeymap, - Focus, - FocusKeymapTransferCommand); + Focus); void setup() { Kaleidoscope.setup(); - EEPROMKeymap.max_layers(1); + EEPROMKeymap.setup(1); } ``` ## Plugin methods -The plugin provides the `EEPROMKeymap` object, which has the following methods: +The plugin provides the `EEPROMKeymap` object, which has the following method: -### `.max_layers(max)` +### `.setup(layers[, mode])` -> Tells the extension to reserve space in EEPROM for up to `max` layers. Can -> only be called once, any subsequent call will be a no-op. -> This should be set to the number of keymap layers you want to be -> able to program from EEPROM (probably the number of layers you have -> defined in your keymap). +> Reserve space in EEPROM for up to `layers` layers, and set things up to work according to the specified `mode` (see below for a list of supported modes). To be called from the `setup` method of one's sketch. +> +> Supported modes are: +> - `EEPROMKeymap.Mode::EXTEND`: Extend the keymap with layers from EEPROM, treating them as extensions of the main keymap embedded in the firmware. The first layer in EEPROM will have a number one higher than the last layer in PROGMEM. In this case, the total number of layers will be the number of them in PROGMEM plus `layers`. +> - `EEPROMKeymap.Mode::CUSTOM`: For advanced use cases where the `EXTEND` mode is not appropriate. In this case, the plugin merely reserves a slice of EEPROM for the requested amount of layers, but does no other configuration - that's entirely up to the Sketch. ## Focus commands -The plugin provides a `keymap.map` Focus command unconditionally, and a -`keymap.transfer` via the `FocusKeymapTransferCommand` object. +The plugin provides the `keymap.map` and a `keymap.roLayers` commands. ### `keymap.map [codes...]` -> Without arguments, displays the keymap currently in effect. Each key is -> printed as its raw, 16-bit keycode. +> Without arguments, displays the keymap currently in effect. Each key is printed as its raw, 16-bit keycode. > -> With arguments, it stores as many keys as given. One does not need to set all -> keys, on all layers: the command will start from the first key on the first -> layer, and go on as long as it has input. It will not go past the layer set -> via the `.max_layers()` method. +> With arguments, it stores as many keys as given. One does not need to set all keys, on all layers: the command will start from the first key on the first layer, and go on as long as it has input. It will not go past the total amount of layers (that is, `layer_count`). -### `keymap.transfer LAYER` +### `keymap.roLayers` -> Transfers the `LAYER` from the built-in memory of the keyboard into `EEPROM` -> storage. -> -> Useful mostly when one wants to remove the built-in keymap, and wants to -> easily transfer it into `EEPROM` first. -> -> This is generally not needed, and it is recommended to not enable this -> command, unless the feature this command implements is truly needed. +> Returns the number of read-only layers. This only makes sense for the `EEPROMKeymap.Mode::EXTEND` mode, where it returns the number of layers in PROGMEM. In any other case, it doesn't return anything, doing so is left for another event handler that understands what the correct value would be. ## Dependencies @@ -93,7 +69,6 @@ The plugin provides a `keymap.map` Focus command unconditionally, and a ## Further reading -Starting from the [example][plugin:example] is the recommended way of getting -started with the plugin. +Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. [plugin:example]: https://github.com/keyboardio/Kaleidoscope-EEPROM-Keymap/blob/master/examples/EEPROM-Keymap/EEPROM-Keymap.ino diff --git a/examples/EEPROM-Keymap/EEPROM-Keymap.ino b/examples/EEPROM-Keymap/EEPROM-Keymap.ino index e5c35ec9..f9158099 100644 --- a/examples/EEPROM-Keymap/EEPROM-Keymap.ino +++ b/examples/EEPROM-Keymap/EEPROM-Keymap.ino @@ -40,12 +40,12 @@ KEYMAPS( ) // *INDENT-ON* -KALEIDOSCOPE_INIT_PLUGINS(EEPROMKeymap, Focus, FocusKeymapTransferCommand); +KALEIDOSCOPE_INIT_PLUGINS(EEPROMKeymap, Focus); void setup() { Kaleidoscope.setup(); - EEPROMKeymap.max_layers(1); + EEPROMKeymap.setup(1, EEPROMKeymap.Mode::EXTEND); } void loop() { diff --git a/src/Kaleidoscope-EEPROM-Keymap.h b/src/Kaleidoscope-EEPROM-Keymap.h index 3bcb13c8..7b3b8af0 100644 --- a/src/Kaleidoscope-EEPROM-Keymap.h +++ b/src/Kaleidoscope-EEPROM-Keymap.h @@ -18,4 +18,3 @@ #pragma once #include -#include diff --git a/src/Kaleidoscope/EEPROM-Keymap-Transfer.cpp b/src/Kaleidoscope/EEPROM-Keymap-Transfer.cpp deleted file mode 100644 index 77ec771b..00000000 --- a/src/Kaleidoscope/EEPROM-Keymap-Transfer.cpp +++ /dev/null @@ -1,50 +0,0 @@ -/* -*- mode: c++ -*- - * Kaleidoscope-EEPROM-Keymap -- EEPROM-based keymap support. - * Copyright (C) 2017, 2018 Keyboard.io, Inc - * - * This program is free software: you can redistribute it and/or modify it under - * the terms of the GNU General Public License as published by the Free Software - * Foundation, version 3. - * - * This program is distributed in the hope that it will be useful, but WITHOUT - * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS - * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more - * details. - * - * You should have received a copy of the GNU General Public License along with - * this program. If not, see . - */ - -#include -#include -#include - -namespace kaleidoscope { -namespace eeprom { - -EventHandlerResult FocusKeymapTransferCommand::onFocusEvent(const char *command) { - const char *cmd = PSTR("keymap.transfer"); - - if (::Focus.handleHelp(command, cmd)) - return EventHandlerResult::OK; - if (strcmp_P(command, cmd) != 0) - return EventHandlerResult::OK; - - uint8_t layer = Serial.parseInt(); - - for (uint8_t row = 0; row < ROWS; row++) { - for (uint8_t col = 0; col < COLS; col++) { - Key k = Layer.getKeyFromPROGMEM(layer, row, col); - uint16_t pos = ((layer * ROWS * COLS) + (row * COLS) + col); - - ::EEPROMKeymap.updateKey(pos, k); - } - } - - return EventHandlerResult::EVENT_CONSUMED; -} - -} -} - -kaleidoscope::eeprom::FocusKeymapTransferCommand FocusKeymapTransferCommand; diff --git a/src/Kaleidoscope/EEPROM-Keymap-Transfer.h b/src/Kaleidoscope/EEPROM-Keymap-Transfer.h deleted file mode 100644 index 6dfee13c..00000000 --- a/src/Kaleidoscope/EEPROM-Keymap-Transfer.h +++ /dev/null @@ -1,34 +0,0 @@ -/* -*- mode: c++ -*- - * Kaleidoscope-EEPROM-Keymap -- EEPROM-based keymap support. - * Copyright (C) 2017-2018 Keyboard.io, Inc - * - * This program is free software: you can redistribute it and/or modify it under - * the terms of the GNU General Public License as published by the Free Software - * Foundation, version 3. - * - * This program is distributed in the hope that it will be useful, but WITHOUT - * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS - * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more - * details. - * - * You should have received a copy of the GNU General Public License along with - * this program. If not, see . - */ - -#pragma once - -#include -#include - -namespace kaleidoscope { -namespace eeprom { -class FocusKeymapTransferCommand : public Plugin { - public: - FocusKeymapTransferCommand() {} - - EventHandlerResult onFocusEvent(const char *command); -}; -} -} - -extern kaleidoscope::eeprom::FocusKeymapTransferCommand FocusKeymapTransferCommand; diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/Kaleidoscope/EEPROM-Keymap.cpp index 28e5c608..249f1790 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/Kaleidoscope/EEPROM-Keymap.cpp @@ -20,16 +20,30 @@ #include namespace kaleidoscope { +EEPROMKeymap::Mode EEPROMKeymap::mode_; uint16_t EEPROMKeymap::keymap_base_; uint8_t EEPROMKeymap::max_layers_; +uint8_t EEPROMKeymap::progmem_layers_; EventHandlerResult EEPROMKeymap::onSetup() { ::EEPROMSettings.onSetup(); - Layer.getKey = ::EEPROMKeymap.getKeyOverride; - + progmem_layers_ = layer_count; return EventHandlerResult::OK; } +void EEPROMKeymap::setup(uint8_t max, Mode mode) { + switch (mode) { + case Mode::CUSTOM: + break; + case Mode::EXTEND: + layer_count = progmem_layers_ + max; + Layer.getKey = getKeyExtended; + break; + } + mode_ = mode; + max_layers(max); +} + void EEPROMKeymap::max_layers(uint8_t max) { max_layers_ = max; keymap_base_ = ::EEPROMSettings.requestSlice(max_layers_ * ROWS * COLS * 2); @@ -49,22 +63,16 @@ Key EEPROMKeymap::getKey(uint8_t layer, byte row, byte col) { return key; } -Key EEPROMKeymap::getKeyOverride(uint8_t layer, byte row, byte col) { +Key EEPROMKeymap::getKeyExtended(uint8_t layer, byte row, byte col) { Key key; - key = getKey(layer, row, col); - - /* - * If we read a transparent key from EEPROM, or we're trying to read from a - * layer higher than what is available there (max_layers), check if we're below - * the layer count in PROGMEM (layer_count). If we are, read from PROGMEM, - * otherwise leave the key as-is (either transparent or NoKey). - */ - if ((key == Key_Transparent || layer >= max_layers_) && - (layer < layer_count)) - key = Layer.getKeyFromPROGMEM(layer, row, col); + // If the layer is within PROGMEM bounds, look it up from there + if (layer < progmem_layers_) { + return Layer.getKeyFromPROGMEM(layer, row, col); + } - return key; + // If the layer is outside of PROGMEM, look up from EEPROM + return getKey(layer - progmem_layers_, row, col); } uint16_t EEPROMKeymap::keymap_base(void) { @@ -90,14 +98,24 @@ void EEPROMKeymap::printKey(Key k) { EventHandlerResult EEPROMKeymap::onFocusEvent(const char *command) { const char *cmd = PSTR("keymap.map"); - if (::Focus.handleHelp(command, cmd)) + if (::Focus.handleHelp(command, PSTR("keymap.map\nkeymap.roLayers"))) + return EventHandlerResult::OK; + + if (strncmp_P(command, PSTR("keymap."), 7) != 0) return EventHandlerResult::OK; - if (strcmp_P(command, cmd) != 0) + if (strcmp_P(command + 7, PSTR("roLayers")) == 0) { + if (mode_ != Mode::EXTEND) + return EventHandlerResult::OK; + Serial.println(progmem_layers_); + return EventHandlerResult::EVENT_CONSUMED; + } + + if (strcmp_P(command + 7, PSTR("map")) != 0) return EventHandlerResult::OK; if (Serial.peek() == '\n') { - for (uint8_t layer = 0; layer < max_layers_; layer++) { + for (uint8_t layer = 0; layer < layer_count; layer++) { for (uint8_t row = 0; row < ROWS; row++) { for (uint8_t col = 0; col < COLS; col++) { Key k = Layer.getKey(layer, row, col); @@ -110,8 +128,19 @@ EventHandlerResult EEPROMKeymap::onFocusEvent(const char *command) { Serial.println(); } else { uint16_t i = 0; - while ((Serial.peek() != '\n') && (i < ROWS * COLS * max_layers_)) { - updateKey(i, parseKey()); + uint8_t layers = layer_count; + if (layers > 0) + layers--; + while ((Serial.peek() != '\n') && (i < ROWS * COLS * layers)) { + Key k = parseKey(); + + if (mode_ == Mode::EXTEND) { + uint8_t layer = i / (ROWS * COLS); + if (layer >= progmem_layers_) + updateKey(i - (progmem_layers_ * ROWS * COLS), k); + } else { + updateKey(i, k); + } i++; } } diff --git a/src/Kaleidoscope/EEPROM-Keymap.h b/src/Kaleidoscope/EEPROM-Keymap.h index 86368f3a..4cff00ea 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.h +++ b/src/Kaleidoscope/EEPROM-Keymap.h @@ -23,23 +23,32 @@ namespace kaleidoscope { class EEPROMKeymap : public kaleidoscope::Plugin { public: + enum class Mode { + CUSTOM, + EXTEND, + }; + EEPROMKeymap(void) {} EventHandlerResult onSetup(); EventHandlerResult onFocusEvent(const char *command); + static void setup(uint8_t max, Mode mode = Mode::EXTEND); + static void max_layers(uint8_t max); static uint16_t keymap_base(void); static Key getKey(uint8_t layer, byte row, byte col); - static Key getKeyOverride(uint8_t layer, byte row, byte col); + static Key getKeyExtended(uint8_t layer, byte row, byte col); static void updateKey(uint16_t base_pos, Key key); private: static uint16_t keymap_base_; static uint8_t max_layers_; + static uint8_t progmem_layers_; + static Mode mode_; static Key parseKey(void); static void printKey(Key key); From 86cdb0f1b6c6c9f665487645ca5f590f57a161f4 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 10 Oct 2018 06:15:35 +0200 Subject: [PATCH 56/59] README.md & Travis cleanup Remove the IRC notifications from Travis (we're not using IRC anymore), and the stable/experimental badge from README.md (because they aren't being kept up to date). Signed-off-by: Gergely Nagy --- .travis.yml | 7 ------- README.md | 6 +----- 2 files changed, 1 insertion(+), 12 deletions(-) diff --git a/.travis.yml b/.travis.yml index 23d30ccc..49b8c498 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,13 +7,6 @@ install: script: - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware notifications: - irc: - channels: - - "chat.freenode.net#keyboardio" - use_notice: true - skip_join: true - template: - - "%{repository_name}/%{branch} %{commit} by %{author}: %{commit_subject} %{build_url} %{message}" email: on_success: change on_failure: change diff --git a/README.md b/README.md index 34d7c9f9..1a93a6ef 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,10 @@ # Kaleidoscope-EEPROM-Keymap -![status][st:stable] [![Build Status][travis:image]][travis:status] +[![Build Status][travis:image]][travis:status] [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-EEPROM-Keymap.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-EEPROM-Keymap - [st:stable]: https://img.shields.io/badge/stable-✔-black.svg?style=flat&colorA=44cc11&colorB=494e52 - [st:broken]: https://img.shields.io/badge/broken-X-black.svg?style=flat&colorA=e05d44&colorB=494e52 - [st:experimental]: https://img.shields.io/badge/experimental----black.svg?style=flat&colorA=dfb317&colorB=494e52 - While keyboards usually ship with a keymap programmed in, to be able to change that keymap, without flashing new firmware, we need a way to place the keymap into a place we can update at run-time, and which persists across reboots. Fortunately, we have a bit of `EEPROM` on the keyboard, and can use it to store either the full keymap (and saving space in the firmware then), or store additional layers there. In short, this plugin allows us to change our keymaps, without having to compile and flash new firmware. It does so through the use of the [FocusSerial][plugin:focusSerial] plugin. From eaf6dc573848139a3dceb5a2f9aa876c027745e5 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 13 Oct 2018 11:37:20 +0200 Subject: [PATCH 57/59] Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/EEPROM-Keymap.md`, sources under `src/kaleidoscope/plugin/` (appropriately namespaced). This is in preparation of merging plugins into a single monorepo. Signed-off-by: Gergely Nagy --- README.md | 64 +----------------- doc/plugin/EEPROM-Keymap.md | 65 +++++++++++++++++++ src/Kaleidoscope-EEPROM-Keymap.h | 2 +- .../plugin}/EEPROM-Keymap.cpp | 4 +- .../plugin}/EEPROM-Keymap.h | 6 +- 5 files changed, 74 insertions(+), 67 deletions(-) create mode 100644 doc/plugin/EEPROM-Keymap.md rename src/{Kaleidoscope => kaleidoscope/plugin}/EEPROM-Keymap.cpp (98%) rename src/{Kaleidoscope => kaleidoscope/plugin}/EEPROM-Keymap.h (95%) diff --git a/README.md b/README.md index 1a93a6ef..30fd6bda 100644 --- a/README.md +++ b/README.md @@ -5,66 +5,4 @@ [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-EEPROM-Keymap.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-EEPROM-Keymap -While keyboards usually ship with a keymap programmed in, to be able to change that keymap, without flashing new firmware, we need a way to place the keymap into a place we can update at run-time, and which persists across reboots. Fortunately, we have a bit of `EEPROM` on the keyboard, and can use it to store either the full keymap (and saving space in the firmware then), or store additional layers there. - -In short, this plugin allows us to change our keymaps, without having to compile and flash new firmware. It does so through the use of the [FocusSerial][plugin:focusSerial] plugin. - - [plugin:focusSerial]: https://github.com/keyboardio/Kaleidoscope-FocusSerial - -## Using the plugin - -Using the plugin is reasonably simple: after including the header, enable the plugin, and configure how many layers at most we want to store in `EEPROM`. There are other settings one can tweak, but these two steps are enough to get started with. - -Once these are set up, we can update the keymap via [Focus][plugin:focusSerial]. - -```c++ -#include -#include -#include - -KALEIDOSCOPE_INIT_PLUGINS(EEPROMKeymap, - Focus); - -void setup() { - Kaleidoscope.setup(); - - EEPROMKeymap.setup(1); -} -``` - -## Plugin methods - -The plugin provides the `EEPROMKeymap` object, which has the following method: - -### `.setup(layers[, mode])` - -> Reserve space in EEPROM for up to `layers` layers, and set things up to work according to the specified `mode` (see below for a list of supported modes). To be called from the `setup` method of one's sketch. -> -> Supported modes are: -> - `EEPROMKeymap.Mode::EXTEND`: Extend the keymap with layers from EEPROM, treating them as extensions of the main keymap embedded in the firmware. The first layer in EEPROM will have a number one higher than the last layer in PROGMEM. In this case, the total number of layers will be the number of them in PROGMEM plus `layers`. -> - `EEPROMKeymap.Mode::CUSTOM`: For advanced use cases where the `EXTEND` mode is not appropriate. In this case, the plugin merely reserves a slice of EEPROM for the requested amount of layers, but does no other configuration - that's entirely up to the Sketch. - -## Focus commands - -The plugin provides the `keymap.map` and a `keymap.roLayers` commands. - -### `keymap.map [codes...]` - -> Without arguments, displays the keymap currently in effect. Each key is printed as its raw, 16-bit keycode. -> -> With arguments, it stores as many keys as given. One does not need to set all keys, on all layers: the command will start from the first key on the first layer, and go on as long as it has input. It will not go past the total amount of layers (that is, `layer_count`). - -### `keymap.roLayers` - -> Returns the number of read-only layers. This only makes sense for the `EEPROMKeymap.Mode::EXTEND` mode, where it returns the number of layers in PROGMEM. In any other case, it doesn't return anything, doing so is left for another event handler that understands what the correct value would be. - -## Dependencies - -* [Kaleidoscope-EEPROM-Settings](https://github.com/keyboardio/Kaleidoscope-EEPROM-Settings) -* [Kaleidoscope-FocusSerial](https://github.com/keyboardio/Kaleidoscope-FocusSerial) - -## Further reading - -Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - - [plugin:example]: https://github.com/keyboardio/Kaleidoscope-EEPROM-Keymap/blob/master/examples/EEPROM-Keymap/EEPROM-Keymap.ino +See [doc/plugin/EEPROM-Keymap.md](doc/plugin/EEPROM-Keymap.md) for documentation. diff --git a/doc/plugin/EEPROM-Keymap.md b/doc/plugin/EEPROM-Keymap.md new file mode 100644 index 00000000..3fc03667 --- /dev/null +++ b/doc/plugin/EEPROM-Keymap.md @@ -0,0 +1,65 @@ +# Kaleidoscope-EEPROM-Keymap + +While keyboards usually ship with a keymap programmed in, to be able to change that keymap, without flashing new firmware, we need a way to place the keymap into a place we can update at run-time, and which persists across reboots. Fortunately, we have a bit of `EEPROM` on the keyboard, and can use it to store either the full keymap (and saving space in the firmware then), or store additional layers there. + +In short, this plugin allows us to change our keymaps, without having to compile and flash new firmware. It does so through the use of the [FocusSerial][plugin:focusSerial] plugin. + + [plugin:focusSerial]: https://github.com/keyboardio/Kaleidoscope-FocusSerial + +## Using the plugin + +Using the plugin is reasonably simple: after including the header, enable the plugin, and configure how many layers at most we want to store in `EEPROM`. There are other settings one can tweak, but these two steps are enough to get started with. + +Once these are set up, we can update the keymap via [Focus][plugin:focusSerial]. + +```c++ +#include +#include +#include + +KALEIDOSCOPE_INIT_PLUGINS(EEPROMKeymap, + Focus); + +void setup() { + Kaleidoscope.setup(); + + EEPROMKeymap.setup(1); +} +``` + +## Plugin methods + +The plugin provides the `EEPROMKeymap` object, which has the following method: + +### `.setup(layers[, mode])` + +> Reserve space in EEPROM for up to `layers` layers, and set things up to work according to the specified `mode` (see below for a list of supported modes). To be called from the `setup` method of one's sketch. +> +> Supported modes are: +> - `EEPROMKeymap.Mode::EXTEND`: Extend the keymap with layers from EEPROM, treating them as extensions of the main keymap embedded in the firmware. The first layer in EEPROM will have a number one higher than the last layer in PROGMEM. In this case, the total number of layers will be the number of them in PROGMEM plus `layers`. +> - `EEPROMKeymap.Mode::CUSTOM`: For advanced use cases where the `EXTEND` mode is not appropriate. In this case, the plugin merely reserves a slice of EEPROM for the requested amount of layers, but does no other configuration - that's entirely up to the Sketch. + +## Focus commands + +The plugin provides the `keymap.map` and a `keymap.roLayers` commands. + +### `keymap.map [codes...]` + +> Without arguments, displays the keymap currently in effect. Each key is printed as its raw, 16-bit keycode. +> +> With arguments, it stores as many keys as given. One does not need to set all keys, on all layers: the command will start from the first key on the first layer, and go on as long as it has input. It will not go past the total amount of layers (that is, `layer_count`). + +### `keymap.roLayers` + +> Returns the number of read-only layers. This only makes sense for the `EEPROMKeymap.Mode::EXTEND` mode, where it returns the number of layers in PROGMEM. In any other case, it doesn't return anything, doing so is left for another event handler that understands what the correct value would be. + +## Dependencies + +* [Kaleidoscope-EEPROM-Settings](https://github.com/keyboardio/Kaleidoscope-EEPROM-Settings) +* [Kaleidoscope-FocusSerial](https://github.com/keyboardio/Kaleidoscope-FocusSerial) + +## Further reading + +Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. + + [plugin:example]: https://github.com/keyboardio/Kaleidoscope-EEPROM-Keymap/blob/master/examples/EEPROM-Keymap/EEPROM-Keymap.ino diff --git a/src/Kaleidoscope-EEPROM-Keymap.h b/src/Kaleidoscope-EEPROM-Keymap.h index 7b3b8af0..3dd4be9e 100644 --- a/src/Kaleidoscope-EEPROM-Keymap.h +++ b/src/Kaleidoscope-EEPROM-Keymap.h @@ -17,4 +17,4 @@ #pragma once -#include +#include diff --git a/src/Kaleidoscope/EEPROM-Keymap.cpp b/src/kaleidoscope/plugin/EEPROM-Keymap.cpp similarity index 98% rename from src/Kaleidoscope/EEPROM-Keymap.cpp rename to src/kaleidoscope/plugin/EEPROM-Keymap.cpp index 249f1790..bb415be2 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.cpp +++ b/src/kaleidoscope/plugin/EEPROM-Keymap.cpp @@ -20,6 +20,7 @@ #include namespace kaleidoscope { +namespace plugin { EEPROMKeymap::Mode EEPROMKeymap::mode_; uint16_t EEPROMKeymap::keymap_base_; uint8_t EEPROMKeymap::max_layers_; @@ -148,6 +149,7 @@ EventHandlerResult EEPROMKeymap::onFocusEvent(const char *command) { return EventHandlerResult::EVENT_CONSUMED; } +} } -kaleidoscope::EEPROMKeymap EEPROMKeymap; +kaleidoscope::plugin::EEPROMKeymap EEPROMKeymap; diff --git a/src/Kaleidoscope/EEPROM-Keymap.h b/src/kaleidoscope/plugin/EEPROM-Keymap.h similarity index 95% rename from src/Kaleidoscope/EEPROM-Keymap.h rename to src/kaleidoscope/plugin/EEPROM-Keymap.h index 4cff00ea..ae72e8e9 100644 --- a/src/Kaleidoscope/EEPROM-Keymap.h +++ b/src/kaleidoscope/plugin/EEPROM-Keymap.h @@ -21,6 +21,7 @@ #include namespace kaleidoscope { +namespace plugin { class EEPROMKeymap : public kaleidoscope::Plugin { public: enum class Mode { @@ -53,6 +54,7 @@ class EEPROMKeymap : public kaleidoscope::Plugin { static Key parseKey(void); static void printKey(Key key); }; -}; +} +} -extern kaleidoscope::EEPROMKeymap EEPROMKeymap; +extern kaleidoscope::plugin::EEPROMKeymap EEPROMKeymap; From 72fdfdd54387749337b5510a80cb2d19f96a3272 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 13 Oct 2018 11:37:23 +0200 Subject: [PATCH 58/59] Remove files we do not need in the monorepo Signed-off-by: Gergely Nagy --- .gitignore | 4 - .travis.yml | 14 - CONTRIBUTING.md | 50 ---- COPYING | 674 --------------------------------------------- Makefile | 14 - README.md | 8 - library.properties | 10 - 7 files changed, 774 deletions(-) delete mode 100644 .gitignore delete mode 100644 .travis.yml delete mode 100644 CONTRIBUTING.md delete mode 100644 COPYING delete mode 100644 Makefile delete mode 100644 README.md delete mode 100644 library.properties diff --git a/.gitignore b/.gitignore deleted file mode 100644 index be16c9be..00000000 --- a/.gitignore +++ /dev/null @@ -1,4 +0,0 @@ -.#* -*~ -/hardware/ -/output/ \ No newline at end of file diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 49b8c498..00000000 --- a/.travis.yml +++ /dev/null @@ -1,14 +0,0 @@ -dist: trusty -sudo: false -os: - - linux -install: - - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Kaleidoscope-Bundle-Keyboardio hardware/keyboardio -script: - - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware -notifications: - email: - on_success: change - on_failure: change -cache: - ccache: true diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index c490e3ce..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,50 +0,0 @@ -# Developer Certificate of Origin - -All contributions must include acceptance of the DCO: - -``` -Developer Certificate of Origin -Version 1.1 - -Copyright (C) 2004, 2006 The Linux Foundation and its contributors. -1 Letterman Drive -Suite D4700 -San Francisco, CA, 94129 - -Everyone is permitted to copy and distribute verbatim copies of this -license document, but changing it is not allowed. - - -Developer's Certificate of Origin 1.1 - -By making a contribution to this project, I certify that: - -(a) The contribution was created in whole or in part by me and I - have the right to submit it under the open source license - indicated in the file; or - -(b) The contribution is based upon previous work that, to the best - of my knowledge, is covered under an appropriate open source - license and I have the right under that license to submit that - work with modifications, whether created in whole or in part - by me, under the same open source license (unless I am - permitted to submit under a different license), as indicated - in the file; or - -(c) The contribution was provided directly to me by some other - person who certified (a), (b) or (c) and I have not modified - it. - -(d) I understand and agree that this project and the contribution - are public and that a record of the contribution (including all - personal information I submit with it, including my sign-off) is - maintained indefinitely and may be redistributed consistent with - this project or the open source license(s) involved. -``` - -## Sign your work - -To accept the DCO, please add this line to each commit message with your name -and email address (`git commit -s` will do this for you): - - Signed-off-by: Jane Example diff --git a/COPYING b/COPYING deleted file mode 100644 index 94a9ed02..00000000 --- a/COPYING +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/Makefile b/Makefile deleted file mode 100644 index 8f830f44..00000000 --- a/Makefile +++ /dev/null @@ -1,14 +0,0 @@ -# This stub makefile for a Kaleidoscope plugin pulls in -# all targets from the Kaleidoscope-Plugin library - -UNAME_S := $(shell uname -s) - -ifeq ($(UNAME_S),Darwin) -SKETCHBOOK_DIR ?= $(HOME)/Documents/Arduino/ -else -SKETCHBOOK_DIR ?= $(HOME)/Arduino -endif - -BOARD_HARDWARE_PATH ?= $(SKETCHBOOK_DIR)/hardware -KALEIDOSCOPE_PLUGIN_MAKEFILE_DIR ?= keyboardio/avr/build-tools/makefiles/ -include $(BOARD_HARDWARE_PATH)/$(KALEIDOSCOPE_PLUGIN_MAKEFILE_DIR)/rules.mk diff --git a/README.md b/README.md deleted file mode 100644 index 30fd6bda..00000000 --- a/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# Kaleidoscope-EEPROM-Keymap - -[![Build Status][travis:image]][travis:status] - - [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-EEPROM-Keymap.svg?branch=master - [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-EEPROM-Keymap - -See [doc/plugin/EEPROM-Keymap.md](doc/plugin/EEPROM-Keymap.md) for documentation. diff --git a/library.properties b/library.properties deleted file mode 100644 index 6865fb81..00000000 --- a/library.properties +++ /dev/null @@ -1,10 +0,0 @@ -name=Kaleidoscope-EEPROM-Keymap -version=0.0.0 -author=Gergely Nagy -maintainer=Gergely Nagy -sentence=EEPROM-based keymap support for Kaleidoscope. -paragraph=... -category=Communication -url=https://github.com/keyboardio/Kaleidoscope-EEPROM-Keymap -architectures=avr -dot_a_linkage=true From b5264f383ff5a0eb5cec47c22dbfb26d0632dec1 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 14 Oct 2018 17:59:29 +0200 Subject: [PATCH 59/59] Update the documentation links Updates the example and dependency links in the documentation, to use URLs that are valid within the monorepo. Signed-off-by: Gergely Nagy --- doc/plugin/EEPROM-Keymap.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/plugin/EEPROM-Keymap.md b/doc/plugin/EEPROM-Keymap.md index 3fc03667..be343bec 100644 --- a/doc/plugin/EEPROM-Keymap.md +++ b/doc/plugin/EEPROM-Keymap.md @@ -4,7 +4,7 @@ While keyboards usually ship with a keymap programmed in, to be able to change t In short, this plugin allows us to change our keymaps, without having to compile and flash new firmware. It does so through the use of the [FocusSerial][plugin:focusSerial] plugin. - [plugin:focusSerial]: https://github.com/keyboardio/Kaleidoscope-FocusSerial + [plugin:focusSerial]: FocusSerial.md ## Using the plugin @@ -55,11 +55,11 @@ The plugin provides the `keymap.map` and a `keymap.roLayers` commands. ## Dependencies -* [Kaleidoscope-EEPROM-Settings](https://github.com/keyboardio/Kaleidoscope-EEPROM-Settings) -* [Kaleidoscope-FocusSerial](https://github.com/keyboardio/Kaleidoscope-FocusSerial) +* [Kaleidoscope-EEPROM-Settings](EEPROM-Settings.md) +* [Kaleidoscope-FocusSerial](FocusSerial.md) ## Further reading Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/keyboardio/Kaleidoscope-EEPROM-Keymap/blob/master/examples/EEPROM-Keymap/EEPROM-Keymap.ino + [plugin:example]: ../../examples/EEPROM-Keymap/EEPROM-Keymap.ino