From fe06702a59d998c4ce01e9472062144952b47fdf Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 16 Jan 2017 15:18:13 +0100 Subject: [PATCH 01/42] Initial import Lifted out of the monolithic Akela library. Signed-off-by: Gergely Nagy --- .gitignore | 2 + COPYING | 674 +++++++++++++++++++++++++++++++++++++ README.md | 86 +++++ examples/Leader/Leader.ino | 67 ++++ library.properties | 10 + src/Akela-Leader.h | 21 ++ src/Akela/Leader.cpp | 177 ++++++++++ src/Akela/Leader.h | 61 ++++ 8 files changed, 1098 insertions(+) create mode 100644 .gitignore create mode 100644 COPYING create mode 100644 README.md create mode 100644 examples/Leader/Leader.ino create mode 100644 library.properties create mode 100644 src/Akela-Leader.h create mode 100644 src/Akela/Leader.cpp create mode 100644 src/Akela/Leader.h diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..aead9485 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.#* +*~ 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..9fb56120 --- /dev/null +++ b/README.md @@ -0,0 +1,86 @@ +# Akela-Leader + +Leader keys are a kind of key where when they are tapped, all following keys are +swallowed, until the plugin finds a matching sequence in the dictionary, it +times out, or fails to find any possibilities. When a sequence is found, the +corresponding action is executed, but the processing still continues. If any key +is pressed that is not the continuation of the existing sequence, processing +aborts, and the key is handled normally. + +This behaviour is best described with an example. Suppose we want a behaviour +where `LEAD u` starts unicode input mode, and `LEAD u h e a r t` should result +in a heart symbol being input, and we want `LEAD u 0 0 e 9 SPC` to input `é`, +and any other hex code that follows `LEAD u`, should be handled as-is, and +passed to the host. Obviously, we can't have all of this in a dictionary. + +So we put `LEAD u` and `LEAD u h e a r t` in the dictionary only. The first will +start unicode input mode, the second will type in the magic sequence that +results in the symbol, and then aborts the leader sequence processing. With this +setup, if we type `LEAD u 0`, then `LEAD u` will be handled first, and start +unicode input mode. Then, at the `0`, the plugin notices it is not part of any +sequence, so aborts leader processing, and passes the key on as-is, and it ends +up being sent to the host. Thus, we covered all the cases of our scenario! + +## Using the plugin + +To use the plugin, one needs to include the header, implement some actions, +create a dictionary, and configure the provided `Leader` object to use the +dictionary: + +```c++ +#include + +static void leaderA (void) { + Serial.println ("leaderA"); +} + +static void leaderTX (void) { + Serial.println ("leaderTX"); +} + +static const Akela::Leader::dictionary_t leaderDictionary PROGMEM = LEADER_DICT + ( + {LEADER_SEQ (LEAD (0), Key_A), leaderA}, + {LEADER_SEQ (LEAD (0), Key_T, Key_X), leaderTX} + ); + +void setup () { + Serial.begin (9600); + + Leader.configure (leaderDictionary); + + Keyboardio.setup (KEYMAP_SIZE); + Keyboardio.use (&Leader, NULL); +} +``` + +The dictionary is made up of a list of keys, and an action callback. Using the +`LEADER_DICT` and `LEADER_SEQ` helpers is recommended. The dictionary *must* be +marked `PROGMEM`! + +**Note** that we need to use the `Leader` object before any other that adds or +changes key behaviour! Failing to do so may result in unpredictable behaviour. + +## Plugin methods + +The plugin provides the `Leader` object, with the following methods: + +### `.configure(dictionary)` + +> Tells `Leader` to use the specified dictionary. The dictionary is an array of +> `Akela::Leader::dictionary_t` elements. Each element is made up of two +> elements, the first being a list of keys, the second an action to perform when +> the sequence is found. + +### `.reset()` + +> Finishes the leader sequence processing. This is best called from actions that +> are final actions, where one does not wish to continue the leader sequence +> further in the hopes of finding a longer match. + +## Further reading + +Starting from the [example][plugin:example] is the recommended way of getting +started with the plugin. + + [plugin:example]: https://github.com/Akela-Plugins/Akela-Leader/blob/master/examples/Leader/Leader.ino diff --git a/examples/Leader/Leader.ino b/examples/Leader/Leader.ino new file mode 100644 index 00000000..b82a6511 --- /dev/null +++ b/examples/Leader/Leader.ino @@ -0,0 +1,67 @@ +/* -*- mode: c++ -*- + * Akela -- Animated Keyboardio Extension Library for Anything + * Copyright (C) 2016, 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 + +const Key keymaps[][ROWS][COLS] PROGMEM = { + [0] = KEYMAP_STACKED + ( + Key_LEDEffectNext, Key_1, Key_2, Key_3, Key_4, Key_5, Key_LEDEffectNext, + 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, + LEAD(0), + + 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, + LEAD(0) + ), +}; + +static void leaderTestA (uint8_t seqIndex) { + Serial.println (F("leaderTestA")); +} + +static void leaderTestAA (uint8_t seqIndex) { + Serial.println (F("leaderTestAA")); +} + +static const Akela::Leader::dictionary_t leaderDictionary[] PROGMEM = LEADER_DICT + ( + {LEADER_SEQ(LEAD(0), Key_A), leaderTestA}, + {LEADER_SEQ(LEAD(0), Key_A, Key_A), leaderTestAA} + ); + +void setup () { + Serial.begin (9600); + + Leader.configure (leaderDictionary); + + Keyboardio.setup (KEYMAP_SIZE); + Keyboardio.use (&Leader, NULL); +} + +void loop () { + Keyboardio.loop (); +} diff --git a/library.properties b/library.properties new file mode 100644 index 00000000..867d366b --- /dev/null +++ b/library.properties @@ -0,0 +1,10 @@ +name=Akela-Lead +version=0.0.0 +author=Gergely Nagy +maintainer=Gergely Nagy +sentence=Leader keys for Keyboardio boards. +paragraph=VIM-style leader keys. +category=Communication +url=https://github.com/Akela-Plugins/Akela-Leader +architectures=avr +dot_a_linkage=true diff --git a/src/Akela-Leader.h b/src/Akela-Leader.h new file mode 100644 index 00000000..683be05e --- /dev/null +++ b/src/Akela-Leader.h @@ -0,0 +1,21 @@ +/* -*- mode: c++ -*- + * Akela -- Animated Keyboardio Extension Library for Anything + * Copyright (C) 2016, 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/Akela/Leader.cpp b/src/Akela/Leader.cpp new file mode 100644 index 00000000..d9828085 --- /dev/null +++ b/src/Akela/Leader.cpp @@ -0,0 +1,177 @@ +/* -*- mode: c++ -*- + * Akela -- Animated Keyboardio Extension Library for Anything + * Copyright (C) 2016, 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 + +using namespace Akela::Ranges; + +namespace Akela { + // --- state --- + Key Leader::sequence[LEADER_MAX_SEQUENCE_LENGTH + 1]; + uint8_t Leader::sequencePos; + uint8_t Leader::timer; + uint8_t Leader::timeOut = DEFAULT_TIMEOUT; + const Leader::dictionary_t *Leader::dictionary; + + // --- helpers --- + +#define isLeader(k) (k.raw >= LEAD_FIRST && k.raw <= LEAD_LAST) +#define isActive() (sequence[0].raw != Key_NoKey.raw) + + // --- actions --- + int8_t + Leader::lookup (void) { + bool match; + + for (uint8_t seqIndex = 0; ; seqIndex++) { + match = true; + + if (pgm_read_word (&(dictionary[seqIndex].sequence[0].raw)) == Key_NoKey.raw) + break; + + Key seqKey; + for (uint8_t i = 0; i <= sequencePos; i++) { + seqKey.raw = pgm_read_word (&(dictionary[seqIndex].sequence[i].raw)); + + if (sequence[i].raw != seqKey.raw) { + match = false; + break; + } + } + + if (!match) + continue; + + seqKey.raw = pgm_read_word (&(dictionary[seqIndex].sequence[sequencePos + 1].raw)); + if (seqKey.raw == Key_NoKey.raw) { + return seqIndex; + } + } + + return -1; + } + + // --- api --- + + Leader::Leader (void) { + } + + void + Leader::begin (void) { + event_handler_hook_add (this->eventHandlerHook); + loop_hook_add (this->loopHook); + } + + void + Leader::configure (const Leader::dictionary_t dictionary_[]) { + dictionary = dictionary_; + } + + void + Leader::reset (void) { + timer = 0; + sequencePos = 0; + sequence[0].raw = Key_NoKey.raw; + } + + void + Leader::inject (Key key, uint8_t keyState) { + eventHandlerHook (key, 255, 255, keyState); + } + + // --- hooks --- + Key + Leader::eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState) { + if (keyState & INJECTED) + return mappedKey; + + if (!key_is_pressed (keyState) && !key_was_pressed (keyState)) { + if (isLeader (mappedKey)) + return Key_NoKey; + return mappedKey; + } + + if (!isActive () && !isLeader (mappedKey)) + return mappedKey; + + if (!isActive ()) { + // Must be a leader key! + + if (key_toggled_off (keyState)) { + // not active, but a leader key = start the sequence on key release! + sequencePos = 0; + sequence[sequencePos].raw = mappedKey.raw; + } + + // If the sequence was not active yet, ignore the key. + return Key_NoKey; + } + + // active + int8_t actionIndex = lookup (); + + if (key_toggled_on (keyState)) { + sequencePos++; + if (sequencePos > LEADER_MAX_SEQUENCE_LENGTH) { + reset (); + return mappedKey; + } + + timer = 0; + sequence[sequencePos].raw = mappedKey.raw; + actionIndex = lookup (); + + if (actionIndex < 0) { + // No match, abort and pass it through. + reset (); + return mappedKey; + } + return Key_NoKey; + } else if (key_is_pressed (keyState)) { + // held, no need for anything here. + return Key_NoKey; + } + + if (actionIndex < 0) { + // No match, abort and pass it through. + reset (); + return mappedKey; + } + + action_t leaderAction = (action_t) pgm_read_ptr (&(dictionary[actionIndex].action)); + (*leaderAction) (actionIndex); + return Key_NoKey; + } + + void + Leader::loopHook (bool postClear) { + if (!postClear) + return; + + if (!isActive ()) + return; + + if (timer < timeOut) + timer++; + + if (timer >= timeOut) + reset (); + } +}; + +Akela::Leader Leader; diff --git a/src/Akela/Leader.h b/src/Akela/Leader.h new file mode 100644 index 00000000..c11f2ed0 --- /dev/null +++ b/src/Akela/Leader.h @@ -0,0 +1,61 @@ +/* -*- mode: c++ -*- + * Akela -- Animated Keyboardio Extension Library for Anything + * Copyright (C) 2016, 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 + +#define LEADER_MAX_SEQUENCE_LENGTH 16 + +#define LEAD(n) (Key){ .raw = Akela::Ranges::LEAD_FIRST + n } + +#define LEADER_SEQ(...) { __VA_ARGS__, Key_NoKey } +#define LEADER_DICT(...) { __VA_ARGS__, {{Key_NoKey}, NULL} } + +namespace Akela { + class Leader : public KeyboardioPlugin { + public: + typedef void (*action_t) (uint8_t seqIndex); + typedef struct { + Key sequence[LEADER_MAX_SEQUENCE_LENGTH + 1]; + action_t action; + } dictionary_t; + + Leader (void); + + virtual void begin (void) final; + + static void configure (const dictionary_t dictionary[]); + static void reset (void); + + void inject (Key key, uint8_t keyState); + + private: + static Key sequence[LEADER_MAX_SEQUENCE_LENGTH + 1]; + static uint8_t sequencePos; + static uint8_t timer; + static uint8_t timeOut; + static const Leader::dictionary_t *dictionary; + + static Key eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState); + static void loopHook (bool postClear); + static int8_t lookup (void); + }; +}; + +extern Akela::Leader Leader; From 32d5cc6ae4a315555d536e4d0045717ff40efc03 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 16 Jan 2017 17:16:49 +0100 Subject: [PATCH 02/42] Add a status icon. Signed-off-by: Gergely Nagy --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 9fb56120..777017fc 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # Akela-Leader +![status][st:stable] + + [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 + Leader keys are a kind of key where when they are tapped, all following keys are swallowed, until the plugin finds a matching sequence in the dictionary, it times out, or fails to find any possibilities. When a sequence is found, the From 4070116b2aa48d681f0abbfbabf0df68e0ad618c Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 17 Jan 2017 10:15:07 +0100 Subject: [PATCH 03/42] Move from Akela-Plugins to keyboardio Signed-off-by: Gergely Nagy --- README.md | 2 +- library.properties | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 777017fc..dfc10483 100644 --- a/README.md +++ b/README.md @@ -89,4 +89,4 @@ The plugin provides the `Leader` object, with the following methods: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/Akela-Plugins/Akela-Leader/blob/master/examples/Leader/Leader.ino + [plugin:example]: https://github.com/keyboardio/Akela-Leader/blob/master/examples/Leader/Leader.ino diff --git a/library.properties b/library.properties index 867d366b..5fbc4b0f 100644 --- a/library.properties +++ b/library.properties @@ -5,6 +5,6 @@ maintainer=Gergely Nagy sentence=Leader keys for Keyboardio boards. paragraph=VIM-style leader keys. category=Communication -url=https://github.com/Akela-Plugins/Akela-Leader +url=https://github.com/keyboardio/Akela-Leader architectures=avr dot_a_linkage=true From 0abf80a499c622a2b187b4180e71d36bb074e4c4 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 21 Jan 2017 16:10:31 +0100 Subject: [PATCH 04/42] Don't abort early on partial matches If we find a partial match, do not abort, but continue until we either find a full match, a mismatch, or until we time out. This make it possible to have gaps in the sequence, where a partial sequence has no explicit handler. Fixes #1. Signed-off-by: Gergely Nagy --- src/Akela/Leader.cpp | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/src/Akela/Leader.cpp b/src/Akela/Leader.cpp index d9828085..01cbc7f1 100644 --- a/src/Akela/Leader.cpp +++ b/src/Akela/Leader.cpp @@ -30,6 +30,9 @@ namespace Akela { // --- helpers --- +#define PARTIAL_MATCH -1 +#define NO_MATCH -2 + #define isLeader(k) (k.raw >= LEAD_FIRST && k.raw <= LEAD_LAST) #define isActive() (sequence[0].raw != Key_NoKey.raw) @@ -60,10 +63,12 @@ namespace Akela { seqKey.raw = pgm_read_word (&(dictionary[seqIndex].sequence[sequencePos + 1].raw)); if (seqKey.raw == Key_NoKey.raw) { return seqIndex; + } else { + return PARTIAL_MATCH; } } - return -1; + return NO_MATCH; } // --- api --- @@ -136,22 +141,20 @@ namespace Akela { sequence[sequencePos].raw = mappedKey.raw; actionIndex = lookup (); - if (actionIndex < 0) { - // No match, abort and pass it through. - reset (); - return mappedKey; - } - return Key_NoKey; + if (actionIndex >= 0) + return Key_NoKey; } else if (key_is_pressed (keyState)) { // held, no need for anything here. return Key_NoKey; } - if (actionIndex < 0) { - // No match, abort and pass it through. + if (actionIndex == NO_MATCH) { reset (); return mappedKey; } + if (actionIndex == PARTIAL_MATCH) { + return Key_NoKey; + } action_t leaderAction = (action_t) pgm_read_ptr (&(dictionary[actionIndex].action)); (*leaderAction) (actionIndex); From 8ebac50a8b04eb9925063d3f1d3d077e852d801d Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 27 Jan 2017 09:30:40 +0100 Subject: [PATCH 05/42] Do not use Key_LEDEffectNext in the example Signed-off-by: Gergely Nagy --- examples/Leader/Leader.ino | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/examples/Leader/Leader.ino b/examples/Leader/Leader.ino index b82a6511..ae55ece9 100644 --- a/examples/Leader/Leader.ino +++ b/examples/Leader/Leader.ino @@ -21,10 +21,10 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED ( - Key_LEDEffectNext, Key_1, Key_2, Key_3, Key_4, Key_5, Key_LEDEffectNext, - 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_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, LEAD(0), From bb2df55e093409203292c80e1af10dbed3fddf93 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 27 Jan 2017 23:01:25 +0100 Subject: [PATCH 06/42] Use the new, double-add protected hook functions Signed-off-by: Gergely Nagy --- src/Akela/Leader.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Akela/Leader.cpp b/src/Akela/Leader.cpp index 01cbc7f1..4ece766b 100644 --- a/src/Akela/Leader.cpp +++ b/src/Akela/Leader.cpp @@ -78,8 +78,8 @@ namespace Akela { void Leader::begin (void) { - event_handler_hook_add (this->eventHandlerHook); - loop_hook_add (this->loopHook); + event_handler_hook_use (this->eventHandlerHook); + loop_hook_use (this->loopHook); } void From c2fa06994ba35f60fc414a09f2561d7d9d7aa9f0 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 31 Jan 2017 16:26:02 +0100 Subject: [PATCH 07/42] Fix the library name in library.properties Signed-off-by: Gergely Nagy --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index 5fbc4b0f..e8780408 100644 --- a/library.properties +++ b/library.properties @@ -1,4 +1,4 @@ -name=Akela-Lead +name=Akela-Leader version=0.0.0 author=Gergely Nagy maintainer=Gergely Nagy From df28f6db573b94246b077f7a39083112a328782c Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 31 Jan 2017 16:34:01 +0100 Subject: [PATCH 08/42] Use 20 instead of DEFAULT_TIMEOUT Signed-off-by: Gergely Nagy --- src/Akela/Leader.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Akela/Leader.cpp b/src/Akela/Leader.cpp index 4ece766b..a2c9e6d9 100644 --- a/src/Akela/Leader.cpp +++ b/src/Akela/Leader.cpp @@ -25,7 +25,7 @@ namespace Akela { Key Leader::sequence[LEADER_MAX_SEQUENCE_LENGTH + 1]; uint8_t Leader::sequencePos; uint8_t Leader::timer; - uint8_t Leader::timeOut = DEFAULT_TIMEOUT; + uint8_t Leader::timeOut = 20; const Leader::dictionary_t *Leader::dictionary; // --- helpers --- From cb732da5308cec5f1126e7ba490a33da0c71224d Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 1 Feb 2017 13:59:13 +0100 Subject: [PATCH 09/42] Expose the timeOut Fixes #2. Signed-off-by: Gergely Nagy --- README.md | 10 ++++++++++ src/Akela/Leader.h | 2 +- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dfc10483..04efe45e 100644 --- a/README.md +++ b/README.md @@ -84,6 +84,16 @@ The plugin provides the `Leader` object, with the following methods: > are final actions, where one does not wish to continue the leader sequence > further in the hopes of finding a longer match. +### `.timeOut` + +> The number of loop iterations to wait before a sequence times out. Once the +> sequence timed out, if there is a partial match with an action, that will be +> performed, otherwise the Leader sequence will simply reset. +> +> Not strictly a method, it is a variable one can assign a new value to. +> +> Defaults to 20. + ## Further reading Starting from the [example][plugin:example] is the recommended way of getting diff --git a/src/Akela/Leader.h b/src/Akela/Leader.h index c11f2ed0..618e159a 100644 --- a/src/Akela/Leader.h +++ b/src/Akela/Leader.h @@ -42,6 +42,7 @@ namespace Akela { static void configure (const dictionary_t dictionary[]); static void reset (void); + static uint8_t timeOut; void inject (Key key, uint8_t keyState); @@ -49,7 +50,6 @@ namespace Akela { static Key sequence[LEADER_MAX_SEQUENCE_LENGTH + 1]; static uint8_t sequencePos; static uint8_t timer; - static uint8_t timeOut; static const Leader::dictionary_t *dictionary; static Key eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState); From db87474e16dcd888f75a5af8c16f1750949008f5 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 9 Feb 2017 23:28:28 +0100 Subject: [PATCH 10/42] Use a timer instead of a loop counter As loop counters are not a reliable substitute for timers, because they are unreliable, use proper timers instead. Fixes #3. Signed-off-by: Gergely Nagy --- README.md | 4 ++-- src/Akela/Leader.cpp | 14 ++++++-------- src/Akela/Leader.h | 4 ++-- 3 files changed, 10 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 04efe45e..30eeaf48 100644 --- a/README.md +++ b/README.md @@ -86,13 +86,13 @@ The plugin provides the `Leader` object, with the following methods: ### `.timeOut` -> The number of loop iterations to wait before a sequence times out. Once the +> The number of milliseconds to wait before a sequence times out. Once the > sequence timed out, if there is a partial match with an action, that will be > performed, otherwise the Leader sequence will simply reset. > > Not strictly a method, it is a variable one can assign a new value to. > -> Defaults to 20. +> Defaults to 1000. ## Further reading diff --git a/src/Akela/Leader.cpp b/src/Akela/Leader.cpp index a2c9e6d9..bd796909 100644 --- a/src/Akela/Leader.cpp +++ b/src/Akela/Leader.cpp @@ -24,8 +24,8 @@ namespace Akela { // --- state --- Key Leader::sequence[LEADER_MAX_SEQUENCE_LENGTH + 1]; uint8_t Leader::sequencePos; - uint8_t Leader::timer; - uint8_t Leader::timeOut = 20; + uint32_t Leader::startTime; + uint16_t Leader::timeOut = 1000; const Leader::dictionary_t *Leader::dictionary; // --- helpers --- @@ -89,7 +89,7 @@ namespace Akela { void Leader::reset (void) { - timer = 0; + startTime = 0; sequencePos = 0; sequence[0].raw = Key_NoKey.raw; } @@ -119,6 +119,7 @@ namespace Akela { if (key_toggled_off (keyState)) { // not active, but a leader key = start the sequence on key release! + startTime = millis (); sequencePos = 0; sequence[sequencePos].raw = mappedKey.raw; } @@ -137,7 +138,7 @@ namespace Akela { return mappedKey; } - timer = 0; + startTime = millis (); sequence[sequencePos].raw = mappedKey.raw; actionIndex = lookup (); @@ -169,10 +170,7 @@ namespace Akela { if (!isActive ()) return; - if (timer < timeOut) - timer++; - - if (timer >= timeOut) + if ((millis () - startTime) >= timeOut) reset (); } }; diff --git a/src/Akela/Leader.h b/src/Akela/Leader.h index 618e159a..796b90fa 100644 --- a/src/Akela/Leader.h +++ b/src/Akela/Leader.h @@ -42,14 +42,14 @@ namespace Akela { static void configure (const dictionary_t dictionary[]); static void reset (void); - static uint8_t timeOut; + static uint16_t timeOut; void inject (Key key, uint8_t keyState); private: static Key sequence[LEADER_MAX_SEQUENCE_LENGTH + 1]; static uint8_t sequencePos; - static uint8_t timer; + static uint32_t startTime; static const Leader::dictionary_t *dictionary; static Key eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState); From b737fe947e6af9b87e9f6b75be89df51b93f5d82 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 11 Feb 2017 23:11:05 +0100 Subject: [PATCH 11/42] The Big Rename Renamed the library to Kaleidoscope-Leader, and followed up with other renames. Signed-off-by: Gergely Nagy --- README.md | 15 ++++++++------- examples/Leader/Leader.ino | 13 +++++++------ library.properties | 8 ++++---- src/{Akela-Leader.h => Kaleidoscope-Leader.h} | 4 ++-- src/{Akela => Kaleidoscope}/Leader.cpp | 10 +++++----- src/{Akela => Kaleidoscope}/Leader.h | 13 +++++++------ 6 files changed, 33 insertions(+), 30 deletions(-) rename src/{Akela-Leader.h => Kaleidoscope-Leader.h} (89%) rename src/{Akela => Kaleidoscope}/Leader.cpp (95%) rename src/{Akela => Kaleidoscope}/Leader.h (84%) diff --git a/README.md b/README.md index 30eeaf48..54422a3d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Akela-Leader +# Kaleidoscope-Leader ![status][st:stable] @@ -34,7 +34,8 @@ create a dictionary, and configure the provided `Leader` object to use the dictionary: ```c++ -#include +#include +#include static void leaderA (void) { Serial.println ("leaderA"); @@ -44,7 +45,7 @@ static void leaderTX (void) { Serial.println ("leaderTX"); } -static const Akela::Leader::dictionary_t leaderDictionary PROGMEM = LEADER_DICT +static const KaleidoscopePlugins::Leader::dictionary_t leaderDictionary PROGMEM = LEADER_DICT ( {LEADER_SEQ (LEAD (0), Key_A), leaderA}, {LEADER_SEQ (LEAD (0), Key_T, Key_X), leaderTX} @@ -55,8 +56,8 @@ void setup () { Leader.configure (leaderDictionary); - Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&Leader, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&Leader, NULL); } ``` @@ -74,7 +75,7 @@ The plugin provides the `Leader` object, with the following methods: ### `.configure(dictionary)` > Tells `Leader` to use the specified dictionary. The dictionary is an array of -> `Akela::Leader::dictionary_t` elements. Each element is made up of two +> `Kaleidoscope::Leader::dictionary_t` elements. Each element is made up of two > elements, the first being a list of keys, the second an action to perform when > the sequence is found. @@ -99,4 +100,4 @@ The plugin provides the `Leader` object, with the following methods: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/keyboardio/Akela-Leader/blob/master/examples/Leader/Leader.ino + [plugin:example]: https://github.com/keyboardio/Kaleidoscope-Leader/blob/master/examples/Leader/Leader.ino diff --git a/examples/Leader/Leader.ino b/examples/Leader/Leader.ino index ae55ece9..b3015144 100644 --- a/examples/Leader/Leader.ino +++ b/examples/Leader/Leader.ino @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Leader -- VIM-style leader keys * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,7 +16,8 @@ * along with this program. If not, see . */ -#include +#include +#include const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED @@ -47,7 +48,7 @@ static void leaderTestAA (uint8_t seqIndex) { Serial.println (F("leaderTestAA")); } -static const Akela::Leader::dictionary_t leaderDictionary[] PROGMEM = LEADER_DICT +static const KaleidoscopePlugins::Leader::dictionary_t leaderDictionary[] PROGMEM = LEADER_DICT ( {LEADER_SEQ(LEAD(0), Key_A), leaderTestA}, {LEADER_SEQ(LEAD(0), Key_A, Key_A), leaderTestAA} @@ -58,10 +59,10 @@ void setup () { Leader.configure (leaderDictionary); - Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&Leader, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&Leader, NULL); } void loop () { - Keyboardio.loop (); + Kaleidoscope.loop (); } diff --git a/library.properties b/library.properties index e8780408..940bf4e2 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ -name=Akela-Leader +name=Kaleidoscope-Leader version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy -sentence=Leader keys for Keyboardio boards. +maintainer=Gergely Nagy +sentence=Leader keys for Kaleidoscope. paragraph=VIM-style leader keys. category=Communication -url=https://github.com/keyboardio/Akela-Leader +url=https://github.com/keyboardio/Kaleidoscope-Leader architectures=avr dot_a_linkage=true diff --git a/src/Akela-Leader.h b/src/Kaleidoscope-Leader.h similarity index 89% rename from src/Akela-Leader.h rename to src/Kaleidoscope-Leader.h index 683be05e..61fe563a 100644 --- a/src/Akela-Leader.h +++ b/src/Kaleidoscope-Leader.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Leader -- VIM-style leader keys * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -18,4 +18,4 @@ #pragma once -#include +#include diff --git a/src/Akela/Leader.cpp b/src/Kaleidoscope/Leader.cpp similarity index 95% rename from src/Akela/Leader.cpp rename to src/Kaleidoscope/Leader.cpp index bd796909..0adcb044 100644 --- a/src/Akela/Leader.cpp +++ b/src/Kaleidoscope/Leader.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Leader -- VIM-style leader keys * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,11 +16,11 @@ * along with this program. If not, see . */ -#include +#include -using namespace Akela::Ranges; +using namespace KaleidoscopePlugins::Ranges; -namespace Akela { +namespace KaleidoscopePlugins { // --- state --- Key Leader::sequence[LEADER_MAX_SEQUENCE_LENGTH + 1]; uint8_t Leader::sequencePos; @@ -175,4 +175,4 @@ namespace Akela { } }; -Akela::Leader Leader; +KaleidoscopePlugins::Leader Leader; diff --git a/src/Akela/Leader.h b/src/Kaleidoscope/Leader.h similarity index 84% rename from src/Akela/Leader.h rename to src/Kaleidoscope/Leader.h index 796b90fa..e7fce5f2 100644 --- a/src/Akela/Leader.h +++ b/src/Kaleidoscope/Leader.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Leader -- VIM-style leader keys * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -18,17 +18,18 @@ #pragma once -#include +#include +#include #define LEADER_MAX_SEQUENCE_LENGTH 16 -#define LEAD(n) (Key){ .raw = Akela::Ranges::LEAD_FIRST + n } +#define LEAD(n) (Key){ .raw = KaleidoscopePlugins::Ranges::LEAD_FIRST + n } #define LEADER_SEQ(...) { __VA_ARGS__, Key_NoKey } #define LEADER_DICT(...) { __VA_ARGS__, {{Key_NoKey}, NULL} } -namespace Akela { - class Leader : public KeyboardioPlugin { +namespace KaleidoscopePlugins { + class Leader : public KaleidoscopePlugin { public: typedef void (*action_t) (uint8_t seqIndex); typedef struct { @@ -58,4 +59,4 @@ namespace Akela { }; }; -extern Akela::Leader Leader; +extern KaleidoscopePlugins::Leader Leader; From 15000dd6947dbc9dedd4ebb5fbfb955908487c28 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 21 Feb 2017 12:01:07 +0100 Subject: [PATCH 12/42] Improved timeout handling Instead of calculating the time delta every time we want to check if the timer elapsed, calculate the projected ending time at the start, and compare against that. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/Leader.cpp | 9 ++++----- src/Kaleidoscope/Leader.h | 2 +- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/src/Kaleidoscope/Leader.cpp b/src/Kaleidoscope/Leader.cpp index 0adcb044..2bb8e704 100644 --- a/src/Kaleidoscope/Leader.cpp +++ b/src/Kaleidoscope/Leader.cpp @@ -24,7 +24,7 @@ namespace KaleidoscopePlugins { // --- state --- Key Leader::sequence[LEADER_MAX_SEQUENCE_LENGTH + 1]; uint8_t Leader::sequencePos; - uint32_t Leader::startTime; + uint32_t Leader::endTime; uint16_t Leader::timeOut = 1000; const Leader::dictionary_t *Leader::dictionary; @@ -89,7 +89,6 @@ namespace KaleidoscopePlugins { void Leader::reset (void) { - startTime = 0; sequencePos = 0; sequence[0].raw = Key_NoKey.raw; } @@ -119,7 +118,7 @@ namespace KaleidoscopePlugins { if (key_toggled_off (keyState)) { // not active, but a leader key = start the sequence on key release! - startTime = millis (); + endTime = millis () + timeOut; sequencePos = 0; sequence[sequencePos].raw = mappedKey.raw; } @@ -138,7 +137,7 @@ namespace KaleidoscopePlugins { return mappedKey; } - startTime = millis (); + endTime = millis () + timeOut; sequence[sequencePos].raw = mappedKey.raw; actionIndex = lookup (); @@ -170,7 +169,7 @@ namespace KaleidoscopePlugins { if (!isActive ()) return; - if ((millis () - startTime) >= timeOut) + if (millis () >= endTime) reset (); } }; diff --git a/src/Kaleidoscope/Leader.h b/src/Kaleidoscope/Leader.h index e7fce5f2..4b6fdf24 100644 --- a/src/Kaleidoscope/Leader.h +++ b/src/Kaleidoscope/Leader.h @@ -50,7 +50,7 @@ namespace KaleidoscopePlugins { private: static Key sequence[LEADER_MAX_SEQUENCE_LENGTH + 1]; static uint8_t sequencePos; - static uint32_t startTime; + static uint32_t endTime; static const Leader::dictionary_t *dictionary; static Key eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState); From a1af698eb67d7ae807fab9bbd3c44f2b11326b79 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Feb 2017 11:27:57 +0100 Subject: [PATCH 13/42] Test the plugin with Travis CI Signed-off-by: Gergely Nagy --- .gitignore | 2 ++ .travis.yml | 18 ++++++++++++++++++ README.md | 5 ++++- 3 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 .travis.yml diff --git a/.gitignore b/.gitignore index aead9485..be16c9be 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,4 @@ .#* *~ +/hardware/ +/output/ \ No newline at end of file diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 00000000..77431b24 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,18 @@ +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 +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/README.md b/README.md index 54422a3d..7cfc5aaf 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # Kaleidoscope-Leader -![status][st:stable] +![status][st:stable] [![Build Status][travis:image]][travis:status] + + [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-Leader.svg?branch=master + [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-Leader [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 From 0f65281703ea33149849c7294142642df273fb3e Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 28 Feb 2017 18:45:14 +0100 Subject: [PATCH 14/42] Restrict the max sequence length to 4 Using a max length of 16 is a huge waste of resources, restrict it to 4 instead. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/Leader.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/Leader.h b/src/Kaleidoscope/Leader.h index 4b6fdf24..982ca778 100644 --- a/src/Kaleidoscope/Leader.h +++ b/src/Kaleidoscope/Leader.h @@ -21,7 +21,7 @@ #include #include -#define LEADER_MAX_SEQUENCE_LENGTH 16 +#define LEADER_MAX_SEQUENCE_LENGTH 4 #define LEAD(n) (Key){ .raw = KaleidoscopePlugins::Ranges::LEAD_FIRST + n } From 9287dbb774d6d5fe0ef899bf257b76f8f7a49cb0 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 20 Mar 2017 12:47:51 +0100 Subject: [PATCH 15/42] README: Add a "Dependencies" section Signed-off-by: Gergely Nagy --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 7cfc5aaf..2286adf7 100644 --- a/README.md +++ b/README.md @@ -98,6 +98,10 @@ The plugin provides the `Leader` object, with the following methods: > > Defaults to 1000. +## Dependencies + +* [Kaleidoscope-Ranges](https://github.com/keyboardio/Kaleidoscope-Ranges) + ## Further reading Starting from the [example][plugin:example] is the recommended way of getting From c3dbe52f723ba8ac93cfdecf0d1e6880644b3b42 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 22 May 2017 13:12:20 -0700 Subject: [PATCH 16/42] Bring example up to new API --- examples/Leader/Leader.ino | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/examples/Leader/Leader.ino b/examples/Leader/Leader.ino index b3015144..63ee31b0 100644 --- a/examples/Leader/Leader.ino +++ b/examples/Leader/Leader.ino @@ -22,12 +22,12 @@ 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_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_LCtrl, Key_Backspace, Key_LGUI, Key_LShift, + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, LEAD(0), Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, @@ -35,9 +35,9 @@ 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, LEAD(0) - ), + ), }; static void leaderTestA (uint8_t seqIndex) { From 126b14d6c6c712d5234614789e5b2f0e7284585e Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 23 May 2017 20:04:13 -0700 Subject: [PATCH 17/42] New build infrastructure --- .travis.yml | 29 ++++++++++++++++------------- Makefile | 12 ++++++++++++ 2 files changed, 28 insertions(+), 13 deletions(-) create mode 100644 Makefile diff --git a/.travis.yml b/.travis.yml index 77431b24..e7030acf 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,18 +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 - - export EXTRA_BUILDER_ARGS="-libraries ." - - 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 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 f148a4c7e72cda8cfd54801e17dce7c14b4d3453 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Fri, 26 May 2017 16:20:22 -0700 Subject: [PATCH 18/42] make astyle --- examples/Leader/Leader.ino | 52 +++++------ src/Kaleidoscope/Leader.cpp | 166 ++++++++++++++++++------------------ src/Kaleidoscope/Leader.h | 8 +- 3 files changed, 113 insertions(+), 113 deletions(-) diff --git a/examples/Leader/Leader.ino b/examples/Leader/Leader.ino index 63ee31b0..c83c21d9 100644 --- a/examples/Leader/Leader.ino +++ b/examples/Leader/Leader.ino @@ -20,49 +20,49 @@ #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, - LEAD(0), + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, + LEAD(0), - 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, - LEAD(0) - ), + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, + LEAD(0) + ), }; static void leaderTestA (uint8_t seqIndex) { - Serial.println (F("leaderTestA")); + Serial.println (F("leaderTestA")); } static void leaderTestAA (uint8_t seqIndex) { - Serial.println (F("leaderTestAA")); + Serial.println (F("leaderTestAA")); } static const KaleidoscopePlugins::Leader::dictionary_t leaderDictionary[] PROGMEM = LEADER_DICT - ( - {LEADER_SEQ(LEAD(0), Key_A), leaderTestA}, - {LEADER_SEQ(LEAD(0), Key_A, Key_A), leaderTestAA} - ); + ( +{LEADER_SEQ(LEAD(0), Key_A), leaderTestA}, +{LEADER_SEQ(LEAD(0), Key_A, Key_A), leaderTestAA} + ); void setup () { - Serial.begin (9600); + Serial.begin (9600); - Leader.configure (leaderDictionary); + Leader.configure (leaderDictionary); - Kaleidoscope.setup (KEYMAP_SIZE); - Kaleidoscope.use (&Leader, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&Leader, NULL); } void loop () { - Kaleidoscope.loop (); + Kaleidoscope.loop (); } diff --git a/src/Kaleidoscope/Leader.cpp b/src/Kaleidoscope/Leader.cpp index 2bb8e704..7ff9f629 100644 --- a/src/Kaleidoscope/Leader.cpp +++ b/src/Kaleidoscope/Leader.cpp @@ -21,14 +21,14 @@ using namespace KaleidoscopePlugins::Ranges; namespace KaleidoscopePlugins { - // --- state --- - Key Leader::sequence[LEADER_MAX_SEQUENCE_LENGTH + 1]; - uint8_t Leader::sequencePos; - uint32_t Leader::endTime; - uint16_t Leader::timeOut = 1000; - const Leader::dictionary_t *Leader::dictionary; +// --- state --- +Key Leader::sequence[LEADER_MAX_SEQUENCE_LENGTH + 1]; +uint8_t Leader::sequencePos; +uint32_t Leader::endTime; +uint16_t Leader::timeOut = 1000; +const Leader::dictionary_t *Leader::dictionary; - // --- helpers --- +// --- helpers --- #define PARTIAL_MATCH -1 #define NO_MATCH -2 @@ -36,142 +36,142 @@ namespace KaleidoscopePlugins { #define isLeader(k) (k.raw >= LEAD_FIRST && k.raw <= LEAD_LAST) #define isActive() (sequence[0].raw != Key_NoKey.raw) - // --- actions --- - int8_t - Leader::lookup (void) { +// --- actions --- +int8_t +Leader::lookup (void) { bool match; for (uint8_t seqIndex = 0; ; seqIndex++) { - match = true; + match = true; - if (pgm_read_word (&(dictionary[seqIndex].sequence[0].raw)) == Key_NoKey.raw) - break; + if (pgm_read_word (&(dictionary[seqIndex].sequence[0].raw)) == Key_NoKey.raw) + break; - Key seqKey; - for (uint8_t i = 0; i <= sequencePos; i++) { - seqKey.raw = pgm_read_word (&(dictionary[seqIndex].sequence[i].raw)); + Key seqKey; + for (uint8_t i = 0; i <= sequencePos; i++) { + seqKey.raw = pgm_read_word (&(dictionary[seqIndex].sequence[i].raw)); - if (sequence[i].raw != seqKey.raw) { - match = false; - break; + if (sequence[i].raw != seqKey.raw) { + match = false; + break; + } } - } - if (!match) - continue; + if (!match) + continue; - seqKey.raw = pgm_read_word (&(dictionary[seqIndex].sequence[sequencePos + 1].raw)); - if (seqKey.raw == Key_NoKey.raw) { - return seqIndex; - } else { - return PARTIAL_MATCH; - } + seqKey.raw = pgm_read_word (&(dictionary[seqIndex].sequence[sequencePos + 1].raw)); + if (seqKey.raw == Key_NoKey.raw) { + return seqIndex; + } else { + return PARTIAL_MATCH; + } } return NO_MATCH; - } +} - // --- api --- +// --- api --- - Leader::Leader (void) { - } +Leader::Leader (void) { +} - void - Leader::begin (void) { +void +Leader::begin (void) { event_handler_hook_use (this->eventHandlerHook); loop_hook_use (this->loopHook); - } +} - void - Leader::configure (const Leader::dictionary_t dictionary_[]) { +void +Leader::configure (const Leader::dictionary_t dictionary_[]) { dictionary = dictionary_; - } +} - void - Leader::reset (void) { +void +Leader::reset (void) { sequencePos = 0; sequence[0].raw = Key_NoKey.raw; - } +} - void - Leader::inject (Key key, uint8_t keyState) { +void +Leader::inject (Key key, uint8_t keyState) { eventHandlerHook (key, 255, 255, keyState); - } +} - // --- hooks --- - Key - Leader::eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState) { +// --- hooks --- +Key +Leader::eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState) { if (keyState & INJECTED) - return mappedKey; + return mappedKey; if (!key_is_pressed (keyState) && !key_was_pressed (keyState)) { - if (isLeader (mappedKey)) - return Key_NoKey; - return mappedKey; + if (isLeader (mappedKey)) + return Key_NoKey; + return mappedKey; } if (!isActive () && !isLeader (mappedKey)) - return mappedKey; + return mappedKey; if (!isActive ()) { - // Must be a leader key! + // Must be a leader key! - if (key_toggled_off (keyState)) { - // not active, but a leader key = start the sequence on key release! - endTime = millis () + timeOut; - sequencePos = 0; - sequence[sequencePos].raw = mappedKey.raw; - } + if (key_toggled_off (keyState)) { + // not active, but a leader key = start the sequence on key release! + endTime = millis () + timeOut; + sequencePos = 0; + sequence[sequencePos].raw = mappedKey.raw; + } - // If the sequence was not active yet, ignore the key. - return Key_NoKey; + // If the sequence was not active yet, ignore the key. + return Key_NoKey; } // active int8_t actionIndex = lookup (); if (key_toggled_on (keyState)) { - sequencePos++; - if (sequencePos > LEADER_MAX_SEQUENCE_LENGTH) { - reset (); - return mappedKey; - } + sequencePos++; + if (sequencePos > LEADER_MAX_SEQUENCE_LENGTH) { + reset (); + return mappedKey; + } - endTime = millis () + timeOut; - sequence[sequencePos].raw = mappedKey.raw; - actionIndex = lookup (); + endTime = millis () + timeOut; + sequence[sequencePos].raw = mappedKey.raw; + actionIndex = lookup (); - if (actionIndex >= 0) - return Key_NoKey; + if (actionIndex >= 0) + return Key_NoKey; } else if (key_is_pressed (keyState)) { - // held, no need for anything here. - return Key_NoKey; + // held, no need for anything here. + return Key_NoKey; } if (actionIndex == NO_MATCH) { - reset (); - return mappedKey; + reset (); + return mappedKey; } if (actionIndex == PARTIAL_MATCH) { - return Key_NoKey; + return Key_NoKey; } action_t leaderAction = (action_t) pgm_read_ptr (&(dictionary[actionIndex].action)); (*leaderAction) (actionIndex); return Key_NoKey; - } +} - void - Leader::loopHook (bool postClear) { +void +Leader::loopHook (bool postClear) { if (!postClear) - return; + return; if (!isActive ()) - return; + return; if (millis () >= endTime) - reset (); - } + reset (); +} }; KaleidoscopePlugins::Leader Leader; diff --git a/src/Kaleidoscope/Leader.h b/src/Kaleidoscope/Leader.h index 982ca778..d402c9b0 100644 --- a/src/Kaleidoscope/Leader.h +++ b/src/Kaleidoscope/Leader.h @@ -29,12 +29,12 @@ #define LEADER_DICT(...) { __VA_ARGS__, {{Key_NoKey}, NULL} } namespace KaleidoscopePlugins { - class Leader : public KaleidoscopePlugin { +class Leader : public KaleidoscopePlugin { public: typedef void (*action_t) (uint8_t seqIndex); typedef struct { - Key sequence[LEADER_MAX_SEQUENCE_LENGTH + 1]; - action_t action; + Key sequence[LEADER_MAX_SEQUENCE_LENGTH + 1]; + action_t action; } dictionary_t; Leader (void); @@ -56,7 +56,7 @@ namespace KaleidoscopePlugins { static Key eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState); static void loopHook (bool postClear); static int8_t lookup (void); - }; +}; }; extern KaleidoscopePlugins::Leader Leader; From 1822c6e3c40a4e4fe30cbca5b3cf94fec9f8e848 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Sat, 3 Jun 2017 22:53:45 -0700 Subject: [PATCH 19/42] astyle with current project style guidelines --- examples/Leader/Leader.ino | 56 +++++------ src/Kaleidoscope/Leader.cpp | 194 ++++++++++++++++++------------------ src/Kaleidoscope/Leader.h | 40 ++++---- 3 files changed, 145 insertions(+), 145 deletions(-) diff --git a/examples/Leader/Leader.ino b/examples/Leader/Leader.ino index c83c21d9..8ba224de 100644 --- a/examples/Leader/Leader.ino +++ b/examples/Leader/Leader.ino @@ -20,49 +20,49 @@ #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, - LEAD(0), + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, + LEAD(0), - 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, - LEAD(0) - ), + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, + LEAD(0) + ), }; -static void leaderTestA (uint8_t seqIndex) { - Serial.println (F("leaderTestA")); +static void leaderTestA(uint8_t seqIndex) { + Serial.println(F("leaderTestA")); } -static void leaderTestAA (uint8_t seqIndex) { - Serial.println (F("leaderTestAA")); +static void leaderTestAA(uint8_t seqIndex) { + Serial.println(F("leaderTestAA")); } static const KaleidoscopePlugins::Leader::dictionary_t leaderDictionary[] PROGMEM = LEADER_DICT - ( + ( {LEADER_SEQ(LEAD(0), Key_A), leaderTestA}, {LEADER_SEQ(LEAD(0), Key_A, Key_A), leaderTestAA} - ); + ); -void setup () { - Serial.begin (9600); +void setup() { + Serial.begin(9600); - Leader.configure (leaderDictionary); + Leader.configure(leaderDictionary); - Kaleidoscope.setup (KEYMAP_SIZE); - Kaleidoscope.use (&Leader, NULL); + Kaleidoscope.setup(KEYMAP_SIZE); + Kaleidoscope.use(&Leader, NULL); } -void loop () { - Kaleidoscope.loop (); +void loop() { + Kaleidoscope.loop(); } diff --git a/src/Kaleidoscope/Leader.cpp b/src/Kaleidoscope/Leader.cpp index 7ff9f629..9e213859 100644 --- a/src/Kaleidoscope/Leader.cpp +++ b/src/Kaleidoscope/Leader.cpp @@ -38,139 +38,139 @@ const Leader::dictionary_t *Leader::dictionary; // --- actions --- int8_t -Leader::lookup (void) { - bool match; - - for (uint8_t seqIndex = 0; ; seqIndex++) { - match = true; - - if (pgm_read_word (&(dictionary[seqIndex].sequence[0].raw)) == Key_NoKey.raw) - break; - - Key seqKey; - for (uint8_t i = 0; i <= sequencePos; i++) { - seqKey.raw = pgm_read_word (&(dictionary[seqIndex].sequence[i].raw)); - - if (sequence[i].raw != seqKey.raw) { - match = false; - break; - } - } - - if (!match) - continue; - - seqKey.raw = pgm_read_word (&(dictionary[seqIndex].sequence[sequencePos + 1].raw)); - if (seqKey.raw == Key_NoKey.raw) { - return seqIndex; - } else { - return PARTIAL_MATCH; - } +Leader::lookup(void) { + bool match; + + for (uint8_t seqIndex = 0; ; seqIndex++) { + match = true; + + if (pgm_read_word(&(dictionary[seqIndex].sequence[0].raw)) == Key_NoKey.raw) + break; + + Key seqKey; + for (uint8_t i = 0; i <= sequencePos; i++) { + seqKey.raw = pgm_read_word(&(dictionary[seqIndex].sequence[i].raw)); + + if (sequence[i].raw != seqKey.raw) { + match = false; + break; + } + } + + if (!match) + continue; + + seqKey.raw = pgm_read_word(&(dictionary[seqIndex].sequence[sequencePos + 1].raw)); + if (seqKey.raw == Key_NoKey.raw) { + return seqIndex; + } else { + return PARTIAL_MATCH; } + } - return NO_MATCH; + return NO_MATCH; } // --- api --- -Leader::Leader (void) { +Leader::Leader(void) { } void -Leader::begin (void) { - event_handler_hook_use (this->eventHandlerHook); - loop_hook_use (this->loopHook); +Leader::begin(void) { + event_handler_hook_use(this->eventHandlerHook); + loop_hook_use(this->loopHook); } void -Leader::configure (const Leader::dictionary_t dictionary_[]) { - dictionary = dictionary_; +Leader::configure(const Leader::dictionary_t dictionary_[]) { + dictionary = dictionary_; } void -Leader::reset (void) { - sequencePos = 0; - sequence[0].raw = Key_NoKey.raw; +Leader::reset(void) { + sequencePos = 0; + sequence[0].raw = Key_NoKey.raw; } void -Leader::inject (Key key, uint8_t keyState) { - eventHandlerHook (key, 255, 255, keyState); +Leader::inject(Key key, uint8_t keyState) { + eventHandlerHook(key, 255, 255, keyState); } // --- hooks --- Key -Leader::eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState) { - if (keyState & INJECTED) - return mappedKey; - - if (!key_is_pressed (keyState) && !key_was_pressed (keyState)) { - if (isLeader (mappedKey)) - return Key_NoKey; - return mappedKey; +Leader::eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keyState) { + if (keyState & INJECTED) + return mappedKey; + + if (!key_is_pressed(keyState) && !key_was_pressed(keyState)) { + if (isLeader(mappedKey)) + return Key_NoKey; + return mappedKey; + } + + if (!isActive() && !isLeader(mappedKey)) + return mappedKey; + + if (!isActive()) { + // Must be a leader key! + + if (key_toggled_off(keyState)) { + // not active, but a leader key = start the sequence on key release! + endTime = millis() + timeOut; + sequencePos = 0; + sequence[sequencePos].raw = mappedKey.raw; } - if (!isActive () && !isLeader (mappedKey)) - return mappedKey; - - if (!isActive ()) { - // Must be a leader key! + // If the sequence was not active yet, ignore the key. + return Key_NoKey; + } - if (key_toggled_off (keyState)) { - // not active, but a leader key = start the sequence on key release! - endTime = millis () + timeOut; - sequencePos = 0; - sequence[sequencePos].raw = mappedKey.raw; - } + // active + int8_t actionIndex = lookup(); - // If the sequence was not active yet, ignore the key. - return Key_NoKey; + if (key_toggled_on(keyState)) { + sequencePos++; + if (sequencePos > LEADER_MAX_SEQUENCE_LENGTH) { + reset(); + return mappedKey; } - // active - int8_t actionIndex = lookup (); - - if (key_toggled_on (keyState)) { - sequencePos++; - if (sequencePos > LEADER_MAX_SEQUENCE_LENGTH) { - reset (); - return mappedKey; - } - - endTime = millis () + timeOut; - sequence[sequencePos].raw = mappedKey.raw; - actionIndex = lookup (); - - if (actionIndex >= 0) - return Key_NoKey; - } else if (key_is_pressed (keyState)) { - // held, no need for anything here. - return Key_NoKey; - } + endTime = millis() + timeOut; + sequence[sequencePos].raw = mappedKey.raw; + actionIndex = lookup(); - if (actionIndex == NO_MATCH) { - reset (); - return mappedKey; - } - if (actionIndex == PARTIAL_MATCH) { - return Key_NoKey; - } + if (actionIndex >= 0) + return Key_NoKey; + } else if (key_is_pressed(keyState)) { + // held, no need for anything here. + return Key_NoKey; + } - action_t leaderAction = (action_t) pgm_read_ptr (&(dictionary[actionIndex].action)); - (*leaderAction) (actionIndex); + if (actionIndex == NO_MATCH) { + reset(); + return mappedKey; + } + if (actionIndex == PARTIAL_MATCH) { return Key_NoKey; + } + + action_t leaderAction = (action_t) pgm_read_ptr(&(dictionary[actionIndex].action)); + (*leaderAction)(actionIndex); + return Key_NoKey; } void -Leader::loopHook (bool postClear) { - if (!postClear) - return; +Leader::loopHook(bool postClear) { + if (!postClear) + return; - if (!isActive ()) - return; + if (!isActive()) + return; - if (millis () >= endTime) - reset (); + if (millis() >= endTime) + reset(); } }; diff --git a/src/Kaleidoscope/Leader.h b/src/Kaleidoscope/Leader.h index d402c9b0..d8b0a8fa 100644 --- a/src/Kaleidoscope/Leader.h +++ b/src/Kaleidoscope/Leader.h @@ -30,32 +30,32 @@ namespace KaleidoscopePlugins { class Leader : public KaleidoscopePlugin { - public: - typedef void (*action_t) (uint8_t seqIndex); - typedef struct { - Key sequence[LEADER_MAX_SEQUENCE_LENGTH + 1]; - action_t action; - } dictionary_t; + public: + typedef void (*action_t)(uint8_t seqIndex); + typedef struct { + Key sequence[LEADER_MAX_SEQUENCE_LENGTH + 1]; + action_t action; + } dictionary_t; - Leader (void); + Leader(void); - virtual void begin (void) final; + virtual void begin(void) final; - static void configure (const dictionary_t dictionary[]); - static void reset (void); - static uint16_t timeOut; + static void configure(const dictionary_t dictionary[]); + static void reset(void); + static uint16_t timeOut; - void inject (Key key, uint8_t keyState); + void inject(Key key, uint8_t keyState); - private: - static Key sequence[LEADER_MAX_SEQUENCE_LENGTH + 1]; - static uint8_t sequencePos; - static uint32_t endTime; - static const Leader::dictionary_t *dictionary; + private: + static Key sequence[LEADER_MAX_SEQUENCE_LENGTH + 1]; + static uint8_t sequencePos; + static uint32_t endTime; + static const Leader::dictionary_t *dictionary; - static Key eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState); - static void loopHook (bool postClear); - static int8_t lookup (void); + static Key eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keyState); + static void loopHook(bool postClear); + static int8_t lookup(void); }; }; From bbc7ddaeff7688ca247f6572f7875e9dd39c38b6 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Sun, 4 Jun 2017 00:35:00 -0700 Subject: [PATCH 20/42] virtual void begin(void) final is redunant and makes the linter unhappy --- src/Kaleidoscope/Leader.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/Leader.h b/src/Kaleidoscope/Leader.h index d8b0a8fa..961bacaf 100644 --- a/src/Kaleidoscope/Leader.h +++ b/src/Kaleidoscope/Leader.h @@ -39,7 +39,7 @@ class Leader : public KaleidoscopePlugin { Leader(void); - virtual void begin(void) final; + void begin(void) final; static void configure(const dictionary_t dictionary[]); static void reset(void); From 6839c3ca36b639c4339ebac3e0abb2741958d1ae Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 4 Jun 2017 15:24:00 +0200 Subject: [PATCH 21/42] Kaleidoscope Style Guide conformance Signed-off-by: Gergely Nagy --- README.md | 49 +++++++------- examples/Leader/Leader.ino | 45 ++++++------- src/Kaleidoscope/Leader.cpp | 129 +++++++++++++++++------------------- src/Kaleidoscope/Leader.h | 29 ++++---- 4 files changed, 121 insertions(+), 131 deletions(-) diff --git a/README.md b/README.md index 2286adf7..2a7a5564 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,9 @@ [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-Leader.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-Leader - [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 Leader keys are a kind of key where when they are tapped, all following keys are swallowed, until the plugin finds a matching sequence in the dictionary, it @@ -40,27 +40,26 @@ dictionary: #include #include -static void leaderA (void) { - Serial.println ("leaderA"); +static void leaderA() { + Serial.println("leaderA"); } -static void leaderTX (void) { - Serial.println ("leaderTX"); +static void leaderTX() { + Serial.println("leaderTX"); } -static const KaleidoscopePlugins::Leader::dictionary_t leaderDictionary PROGMEM = LEADER_DICT - ( - {LEADER_SEQ (LEAD (0), Key_A), leaderA}, - {LEADER_SEQ (LEAD (0), Key_T, Key_X), leaderTX} - ); - -void setup () { - Serial.begin (9600); - - Leader.configure (leaderDictionary); - - Kaleidoscope.setup (KEYMAP_SIZE); - Kaleidoscope.use (&Leader, NULL); +static const kaleidoscope::Leader::dictionary_t leader_dictionary PROGMEM = + LEADER_DICT({LEADER_SEQ(LEAD(0), Key_A), leaderA}, + {LEADER_SEQ(LEAD(0), Key_T, Key_X), leaderTX}); + +void setup() { + Serial.begin(9600); + + USE_PLUGINS(&Leader); + + Kaleidoscope.setup(); + + Leader.dictionary = leader_dictionary; } ``` @@ -75,20 +74,24 @@ changes key behaviour! Failing to do so may result in unpredictable behaviour. The plugin provides the `Leader` object, with the following methods: -### `.configure(dictionary)` +### `.dictionary` > Tells `Leader` to use the specified dictionary. The dictionary is an array of -> `Kaleidoscope::Leader::dictionary_t` elements. Each element is made up of two +> `kaleidoscope::Leader::dictionary_t` elements. Each element is made up of two > elements, the first being a list of keys, the second an action to perform when > the sequence is found. +> Not strictly a method, it is a variable one can assign a new value to. +> +> The dictionary *MUST* reside in `PROGMEM`. + ### `.reset()` > Finishes the leader sequence processing. This is best called from actions that > are final actions, where one does not wish to continue the leader sequence > further in the hopes of finding a longer match. -### `.timeOut` +### `.time_out` > The number of milliseconds to wait before a sequence times out. Once the > sequence timed out, if there is a partial match with an action, that will be diff --git a/examples/Leader/Leader.ino b/examples/Leader/Leader.ino index 8ba224de..6d5a5d3d 100644 --- a/examples/Leader/Leader.ino +++ b/examples/Leader/Leader.ino @@ -21,46 +21,41 @@ 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_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, - LEAD(0), + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, + LEAD(0), - 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, - LEAD(0) - ), + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, + LEAD(0)), }; -static void leaderTestA(uint8_t seqIndex) { +static void leaderTestA(uint8_t seq_index) { Serial.println(F("leaderTestA")); } -static void leaderTestAA(uint8_t seqIndex) { +static void leaderTestAA(uint8_t seq_index) { Serial.println(F("leaderTestAA")); } -static const KaleidoscopePlugins::Leader::dictionary_t leaderDictionary[] PROGMEM = LEADER_DICT - ( -{LEADER_SEQ(LEAD(0), Key_A), leaderTestA}, -{LEADER_SEQ(LEAD(0), Key_A, Key_A), leaderTestAA} - ); +static const kaleidoscope::Leader::dictionary_t leader_dictionary[] PROGMEM = +LEADER_DICT({LEADER_SEQ(LEAD(0), Key_A), leaderTestA}, +{LEADER_SEQ(LEAD(0), Key_A, Key_A), leaderTestAA}); void setup() { - Serial.begin(9600); + USE_PLUGINS(&Leader); - Leader.configure(leaderDictionary); + Kaleidoscope.setup(); - Kaleidoscope.setup(KEYMAP_SIZE); - Kaleidoscope.use(&Leader, NULL); + Leader.dictionary = leader_dictionary; } void loop() { diff --git a/src/Kaleidoscope/Leader.cpp b/src/Kaleidoscope/Leader.cpp index 9e213859..1014c9c1 100644 --- a/src/Kaleidoscope/Leader.cpp +++ b/src/Kaleidoscope/Leader.cpp @@ -18,14 +18,15 @@ #include -using namespace KaleidoscopePlugins::Ranges; +namespace kaleidoscope { + +namespace Ranges = KaleidoscopePlugins::Ranges; -namespace KaleidoscopePlugins { // --- state --- -Key Leader::sequence[LEADER_MAX_SEQUENCE_LENGTH + 1]; -uint8_t Leader::sequencePos; -uint32_t Leader::endTime; -uint16_t Leader::timeOut = 1000; +Key Leader::sequence_[LEADER_MAX_SEQUENCE_LENGTH + 1]; +uint8_t Leader::sequence_pos_; +uint32_t Leader::end_time_; +uint16_t Leader::time_out = 1000; const Leader::dictionary_t *Leader::dictionary; // --- helpers --- @@ -33,25 +34,24 @@ const Leader::dictionary_t *Leader::dictionary; #define PARTIAL_MATCH -1 #define NO_MATCH -2 -#define isLeader(k) (k.raw >= LEAD_FIRST && k.raw <= LEAD_LAST) -#define isActive() (sequence[0].raw != Key_NoKey.raw) +#define isLeader(k) (k.raw >= Ranges::LEAD_FIRST && k.raw <= Ranges::LEAD_LAST) +#define isActive() (sequence_[0].raw != Key_NoKey.raw) // --- actions --- -int8_t -Leader::lookup(void) { +int8_t Leader::lookup(void) { bool match; - for (uint8_t seqIndex = 0; ; seqIndex++) { + for (uint8_t seq_index = 0; ; seq_index++) { match = true; - if (pgm_read_word(&(dictionary[seqIndex].sequence[0].raw)) == Key_NoKey.raw) + if (pgm_read_word(&(dictionary[seq_index].sequence[0].raw)) == Key_NoKey.raw) break; - Key seqKey; - for (uint8_t i = 0; i <= sequencePos; i++) { - seqKey.raw = pgm_read_word(&(dictionary[seqIndex].sequence[i].raw)); + Key seq_key; + for (uint8_t i = 0; i <= sequence_pos_; i++) { + seq_key.raw = pgm_read_word(&(dictionary[seq_index].sequence[i].raw)); - if (sequence[i].raw != seqKey.raw) { + if (sequence_[i].raw != seq_key.raw) { match = false; break; } @@ -60,9 +60,9 @@ Leader::lookup(void) { if (!match) continue; - seqKey.raw = pgm_read_word(&(dictionary[seqIndex].sequence[sequencePos + 1].raw)); - if (seqKey.raw == Key_NoKey.raw) { - return seqIndex; + seq_key.raw = pgm_read_word(&(dictionary[seq_index].sequence[sequence_pos_ + 1].raw)); + if (seq_key.raw == Key_NoKey.raw) { + return seq_index; } else { return PARTIAL_MATCH; } @@ -76,51 +76,42 @@ Leader::lookup(void) { Leader::Leader(void) { } -void -Leader::begin(void) { - event_handler_hook_use(this->eventHandlerHook); - loop_hook_use(this->loopHook); -} - -void -Leader::configure(const Leader::dictionary_t dictionary_[]) { - dictionary = dictionary_; +void Leader::begin(void) { + event_handler_hook_use(eventHandlerHook); + loop_hook_use(loopHook); } -void -Leader::reset(void) { - sequencePos = 0; - sequence[0].raw = Key_NoKey.raw; +void Leader::reset(void) { + sequence_pos_ = 0; + sequence_[0].raw = Key_NoKey.raw; } -void -Leader::inject(Key key, uint8_t keyState) { - eventHandlerHook(key, 255, 255, keyState); +void Leader::inject(Key key, uint8_t key_state) { + eventHandlerHook(key, UNKNOWN_KEYSWITCH_LOCATION, key_state); } // --- hooks --- -Key -Leader::eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keyState) { - if (keyState & INJECTED) - return mappedKey; +Key Leader::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state) { + if (key_state & INJECTED) + return mapped_key; - if (!key_is_pressed(keyState) && !key_was_pressed(keyState)) { - if (isLeader(mappedKey)) + if (!key_is_pressed(key_state) && !key_was_pressed(key_state)) { + if (isLeader(mapped_key)) return Key_NoKey; - return mappedKey; + return mapped_key; } - if (!isActive() && !isLeader(mappedKey)) - return mappedKey; + if (!isActive() && !isLeader(mapped_key)) + return mapped_key; if (!isActive()) { // Must be a leader key! - if (key_toggled_off(keyState)) { + if (key_toggled_off(key_state)) { // not active, but a leader key = start the sequence on key release! - endTime = millis() + timeOut; - sequencePos = 0; - sequence[sequencePos].raw = mappedKey.raw; + end_time_ = millis() + time_out; + sequence_pos_ = 0; + sequence_[sequence_pos_].raw = mapped_key.raw; } // If the sequence was not active yet, ignore the key. @@ -128,50 +119,50 @@ Leader::eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keyState) { } // active - int8_t actionIndex = lookup(); + int8_t action_index = lookup(); - if (key_toggled_on(keyState)) { - sequencePos++; - if (sequencePos > LEADER_MAX_SEQUENCE_LENGTH) { + if (key_toggled_on(key_state)) { + sequence_pos_++; + if (sequence_pos_ > LEADER_MAX_SEQUENCE_LENGTH) { reset(); - return mappedKey; + return mapped_key; } - endTime = millis() + timeOut; - sequence[sequencePos].raw = mappedKey.raw; - actionIndex = lookup(); + end_time_ = millis() + time_out; + sequence_[sequence_pos_].raw = mapped_key.raw; + action_index = lookup(); - if (actionIndex >= 0) + if (action_index >= 0) return Key_NoKey; - } else if (key_is_pressed(keyState)) { + } else if (key_is_pressed(key_state)) { // held, no need for anything here. return Key_NoKey; } - if (actionIndex == NO_MATCH) { + if (action_index == NO_MATCH) { reset(); - return mappedKey; + return mapped_key; } - if (actionIndex == PARTIAL_MATCH) { + if (action_index == PARTIAL_MATCH) { return Key_NoKey; } - action_t leaderAction = (action_t) pgm_read_ptr(&(dictionary[actionIndex].action)); - (*leaderAction)(actionIndex); + action_t leaderAction = (action_t) pgm_read_ptr(&(dictionary[action_index].action)); + (*leaderAction)(action_index); return Key_NoKey; } -void -Leader::loopHook(bool postClear) { - if (!postClear) +void Leader::loopHook(bool is_post_clear) { + if (!is_post_clear) return; if (!isActive()) return; - if (millis() >= endTime) + if (millis() >= end_time_) reset(); } -}; -KaleidoscopePlugins::Leader Leader; +} + +kaleidoscope::Leader Leader; diff --git a/src/Kaleidoscope/Leader.h b/src/Kaleidoscope/Leader.h index 961bacaf..8ca96c21 100644 --- a/src/Kaleidoscope/Leader.h +++ b/src/Kaleidoscope/Leader.h @@ -23,40 +23,41 @@ #define LEADER_MAX_SEQUENCE_LENGTH 4 -#define LEAD(n) (Key){ .raw = KaleidoscopePlugins::Ranges::LEAD_FIRST + n } +#define LEAD(n) (Key) { .raw = KaleidoscopePlugins::Ranges::LEAD_FIRST + n } #define LEADER_SEQ(...) { __VA_ARGS__, Key_NoKey } #define LEADER_DICT(...) { __VA_ARGS__, {{Key_NoKey}, NULL} } -namespace KaleidoscopePlugins { +namespace kaleidoscope { + class Leader : public KaleidoscopePlugin { public: - typedef void (*action_t)(uint8_t seqIndex); + typedef void (*action_t)(uint8_t seq_index); typedef struct { Key sequence[LEADER_MAX_SEQUENCE_LENGTH + 1]; action_t action; } dictionary_t; Leader(void); + static const dictionary_t *dictionary; void begin(void) final; - static void configure(const dictionary_t dictionary[]); static void reset(void); - static uint16_t timeOut; + static uint16_t time_out; - void inject(Key key, uint8_t keyState); + void inject(Key key, uint8_t key_state); private: - static Key sequence[LEADER_MAX_SEQUENCE_LENGTH + 1]; - static uint8_t sequencePos; - static uint32_t endTime; - static const Leader::dictionary_t *dictionary; + static Key sequence_[LEADER_MAX_SEQUENCE_LENGTH + 1]; + static uint8_t sequence_pos_; + static uint32_t end_time_; - static Key eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keyState); - static void loopHook(bool postClear); + static Key eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state); + static void loopHook(bool is_post_clear); static int8_t lookup(void); }; -}; -extern KaleidoscopePlugins::Leader Leader; +} + +extern kaleidoscope::Leader Leader; From 853712eec162844cd49dcd3511bce66a531f7b53 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 5 Jun 2017 10:42:49 +0200 Subject: [PATCH 22/42] Use the newest Ranges APIs Signed-off-by: Gergely Nagy --- src/Kaleidoscope/Leader.cpp | 4 +--- src/Kaleidoscope/Leader.h | 2 +- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/src/Kaleidoscope/Leader.cpp b/src/Kaleidoscope/Leader.cpp index 1014c9c1..1b72ba92 100644 --- a/src/Kaleidoscope/Leader.cpp +++ b/src/Kaleidoscope/Leader.cpp @@ -20,8 +20,6 @@ namespace kaleidoscope { -namespace Ranges = KaleidoscopePlugins::Ranges; - // --- state --- Key Leader::sequence_[LEADER_MAX_SEQUENCE_LENGTH + 1]; uint8_t Leader::sequence_pos_; @@ -34,7 +32,7 @@ const Leader::dictionary_t *Leader::dictionary; #define PARTIAL_MATCH -1 #define NO_MATCH -2 -#define isLeader(k) (k.raw >= Ranges::LEAD_FIRST && k.raw <= Ranges::LEAD_LAST) +#define isLeader(k) (k.raw >= ranges::LEAD_FIRST && k.raw <= ranges::LEAD_LAST) #define isActive() (sequence_[0].raw != Key_NoKey.raw) // --- actions --- diff --git a/src/Kaleidoscope/Leader.h b/src/Kaleidoscope/Leader.h index 8ca96c21..16fd7117 100644 --- a/src/Kaleidoscope/Leader.h +++ b/src/Kaleidoscope/Leader.h @@ -23,7 +23,7 @@ #define LEADER_MAX_SEQUENCE_LENGTH 4 -#define LEAD(n) (Key) { .raw = KaleidoscopePlugins::Ranges::LEAD_FIRST + n } +#define LEAD(n) (Key) { .raw = kaleidoscope::ranges::LEAD_FIRST + n } #define LEADER_SEQ(...) { __VA_ARGS__, Key_NoKey } #define LEADER_DICT(...) { __VA_ARGS__, {{Key_NoKey}, NULL} } From 4d1a73f0b7946385f5696a58eded2b40e19cf3d6 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 5 Jun 2017 15:57:02 +0200 Subject: [PATCH 23/42] README.md: Properties are not methods Signed-off-by: Gergely Nagy --- README.md | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 2a7a5564..d8326b41 100644 --- a/README.md +++ b/README.md @@ -72,16 +72,14 @@ changes key behaviour! Failing to do so may result in unpredictable behaviour. ## Plugin methods -The plugin provides the `Leader` object, with the following methods: +The plugin provides the `Leader` object, with the following methods and properties: ### `.dictionary` -> Tells `Leader` to use the specified dictionary. The dictionary is an array of -> `kaleidoscope::Leader::dictionary_t` elements. Each element is made up of two -> elements, the first being a list of keys, the second an action to perform when -> the sequence is found. - -> Not strictly a method, it is a variable one can assign a new value to. +> Set this property to the dictionary `Leader` should use. The dictionary is an +> array of `kaleidoscope::Leader::dictionary_t` elements. Each element is made +> up of two elements, the first being a list of keys, the second an action to +> perform when the sequence is found.i > > The dictionary *MUST* reside in `PROGMEM`. @@ -97,8 +95,6 @@ The plugin provides the `Leader` object, with the following methods: > sequence timed out, if there is a partial match with an action, that will be > performed, otherwise the Leader sequence will simply reset. > -> Not strictly a method, it is a variable one can assign a new value to. -> > Defaults to 1000. ## Dependencies From d70059ce4af1de0bda12a05e209be72334c34cbc Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 24 Jul 2017 14:00:01 -0700 Subject: [PATCH 24/42] keyToggledO* camelcasing --- src/Kaleidoscope/Leader.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Kaleidoscope/Leader.cpp b/src/Kaleidoscope/Leader.cpp index 1b72ba92..7b7d271a 100644 --- a/src/Kaleidoscope/Leader.cpp +++ b/src/Kaleidoscope/Leader.cpp @@ -105,7 +105,7 @@ Key Leader::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_sta if (!isActive()) { // Must be a leader key! - if (key_toggled_off(key_state)) { + if (keyToggledOff(key_state)) { // not active, but a leader key = start the sequence on key release! end_time_ = millis() + time_out; sequence_pos_ = 0; @@ -119,7 +119,7 @@ Key Leader::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_sta // active int8_t action_index = lookup(); - if (key_toggled_on(key_state)) { + if (keyToggledOn(key_state)) { sequence_pos_++; if (sequence_pos_ > LEADER_MAX_SEQUENCE_LENGTH) { reset(); From 39dc5fe3497211d12767b95233404d5e305e7927 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 24 Jul 2017 14:14:32 -0700 Subject: [PATCH 25/42] CamelCase of KeyIsPressed and KeyWasPressed --- src/Kaleidoscope/Leader.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Kaleidoscope/Leader.cpp b/src/Kaleidoscope/Leader.cpp index 7b7d271a..e2ff1457 100644 --- a/src/Kaleidoscope/Leader.cpp +++ b/src/Kaleidoscope/Leader.cpp @@ -93,7 +93,7 @@ Key Leader::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_sta if (key_state & INJECTED) return mapped_key; - if (!key_is_pressed(key_state) && !key_was_pressed(key_state)) { + if (!keyIsPressed(key_state) && !keyWasPressed(key_state)) { if (isLeader(mapped_key)) return Key_NoKey; return mapped_key; @@ -132,7 +132,7 @@ Key Leader::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_sta if (action_index >= 0) return Key_NoKey; - } else if (key_is_pressed(key_state)) { + } else if (keyIsPressed(key_state)) { // held, no need for anything here. return Key_NoKey; } From 8556552d9b04725adcf01b41599b5b223814ff20 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 25 Jul 2017 15:52:15 -0700 Subject: [PATCH 26/42] 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 f27a3a46ec3fc6cd93400d6b14d2c96edebf8a8c Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 17 Aug 2017 12:01:21 +0200 Subject: [PATCH 27/42] Stop using deprecated interfaces Use `Kaleidoscope.use`, `Kaleidoscope.useEventHandlerHook`, and `Kaleidoscope.useLoopHook` instead of `USE_PLUGINS`, `event_handler_hook_use`, and `loop_hook_use`, which are getting deprecated. Signed-off-by: Gergely Nagy --- README.md | 10 +++++----- examples/Leader/Leader.ino | 2 +- src/Kaleidoscope/Leader.cpp | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d8326b41..d48d0601 100644 --- a/README.md +++ b/README.md @@ -48,17 +48,17 @@ static void leaderTX() { Serial.println("leaderTX"); } -static const kaleidoscope::Leader::dictionary_t leader_dictionary PROGMEM = +static const kaleidoscope::Leader::dictionary_t leader_dictionary PROGMEM = LEADER_DICT({LEADER_SEQ(LEAD(0), Key_A), leaderA}, {LEADER_SEQ(LEAD(0), Key_T, Key_X), leaderTX}); void setup() { Serial.begin(9600); - - USE_PLUGINS(&Leader); - + + Kaleidoscope.use(&Leader); + Kaleidoscope.setup(); - + Leader.dictionary = leader_dictionary; } ``` diff --git a/examples/Leader/Leader.ino b/examples/Leader/Leader.ino index 6d5a5d3d..ee25451d 100644 --- a/examples/Leader/Leader.ino +++ b/examples/Leader/Leader.ino @@ -51,7 +51,7 @@ LEADER_DICT({LEADER_SEQ(LEAD(0), Key_A), leaderTestA}, {LEADER_SEQ(LEAD(0), Key_A, Key_A), leaderTestAA}); void setup() { - USE_PLUGINS(&Leader); + Kaleidoscope.use(&Leader); Kaleidoscope.setup(); diff --git a/src/Kaleidoscope/Leader.cpp b/src/Kaleidoscope/Leader.cpp index e2ff1457..aa075e55 100644 --- a/src/Kaleidoscope/Leader.cpp +++ b/src/Kaleidoscope/Leader.cpp @@ -75,8 +75,8 @@ Leader::Leader(void) { } void Leader::begin(void) { - event_handler_hook_use(eventHandlerHook); - loop_hook_use(loopHook); + Kaleidoscope.useEventHandlerHook(eventHandlerHook); + Kaleidoscope.useLoopHook(loopHook); } void Leader::reset(void) { From 329c1336385ad4b0f6289b9b56a558d695d9e7e0 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 21 Aug 2017 22:23:44 -0700 Subject: [PATCH 28/42] 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 52de40905c4a9837c8a97eb94e52ae84c741fe11 Mon Sep 17 00:00:00 2001 From: Kethku Date: Thu, 1 Mar 2018 12:36:02 -0800 Subject: [PATCH 29/42] Type for leader dictionary in readme incorrect. Added array so that type is a pointer instead of a single entry. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d48d0601..15d4f109 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ static void leaderTX() { Serial.println("leaderTX"); } -static const kaleidoscope::Leader::dictionary_t leader_dictionary PROGMEM = +static const kaleidoscope::Leader::dictionary_t leader_dictionary[] PROGMEM = LEADER_DICT({LEADER_SEQ(LEAD(0), Key_A), leaderA}, {LEADER_SEQ(LEAD(0), Key_T, Key_X), leaderTX}); From f6fe0183b7a78b4d0c9b155e866c131641a6676a Mon Sep 17 00:00:00 2001 From: Kethku Date: Thu, 1 Mar 2018 12:38:23 -0800 Subject: [PATCH 30/42] Changed function types to match example --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d48d0601..4c438e3a 100644 --- a/README.md +++ b/README.md @@ -40,11 +40,11 @@ dictionary: #include #include -static void leaderA() { +static void leaderA(uint8_t seq_index) { Serial.println("leaderA"); } -static void leaderTX() { +static void leaderTX(uint8_t seq_index) { Serial.println("leaderTX"); } From 8074c18d2d632fabd8a6cd22bbef20dd83643977 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 12 May 2018 18:23:18 +0200 Subject: [PATCH 31/42] Updated to use the new plugin APIs Signed-off-by: Gergely Nagy --- README.md | 4 +- examples/Leader/Leader.ino | 10 +++-- src/Kaleidoscope/Leader.cpp | 84 ++++++++++++++++++++++--------------- src/Kaleidoscope/Leader.h | 20 +++++---- 4 files changed, 71 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index 60aa4deb..7dc84369 100644 --- a/README.md +++ b/README.md @@ -52,11 +52,11 @@ static const kaleidoscope::Leader::dictionary_t leader_dictionary[] PROGMEM = LEADER_DICT({LEADER_SEQ(LEAD(0), Key_A), leaderA}, {LEADER_SEQ(LEAD(0), Key_T, Key_X), leaderTX}); +KALEIDOSCOPE_INIT_PLUGINS(Leader); + void setup() { Serial.begin(9600); - Kaleidoscope.use(&Leader); - Kaleidoscope.setup(); Leader.dictionary = leader_dictionary; diff --git a/examples/Leader/Leader.ino b/examples/Leader/Leader.ino index ee25451d..1f1c1b8e 100644 --- a/examples/Leader/Leader.ino +++ b/examples/Leader/Leader.ino @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Leader -- VIM-style leader keys - * Copyright (C) 2016, 2017 Gergely Nagy + * Copyright (C) 2016, 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 @@ -19,6 +19,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, @@ -31,12 +32,13 @@ 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, LEAD(0)), }; +// *INDENT-ON* static void leaderTestA(uint8_t seq_index) { Serial.println(F("leaderTestA")); @@ -50,9 +52,9 @@ static const kaleidoscope::Leader::dictionary_t leader_dictionary[] PROGMEM = LEADER_DICT({LEADER_SEQ(LEAD(0), Key_A), leaderTestA}, {LEADER_SEQ(LEAD(0), Key_A, Key_A), leaderTestAA}); -void setup() { - Kaleidoscope.use(&Leader); +KALEIDOSCOPE_INIT_PLUGINS(Leader); +void setup() { Kaleidoscope.setup(); Leader.dictionary = leader_dictionary; diff --git a/src/Kaleidoscope/Leader.cpp b/src/Kaleidoscope/Leader.cpp index aa075e55..bc993d47 100644 --- a/src/Kaleidoscope/Leader.cpp +++ b/src/Kaleidoscope/Leader.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Leader -- VIM-style leader keys - * Copyright (C) 2016, 2017 Gergely Nagy + * Copyright (C) 2016, 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 @@ -71,41 +71,34 @@ int8_t Leader::lookup(void) { // --- api --- -Leader::Leader(void) { -} - -void Leader::begin(void) { - Kaleidoscope.useEventHandlerHook(eventHandlerHook); - Kaleidoscope.useLoopHook(loopHook); -} - void Leader::reset(void) { sequence_pos_ = 0; sequence_[0].raw = Key_NoKey.raw; } void Leader::inject(Key key, uint8_t key_state) { - eventHandlerHook(key, UNKNOWN_KEYSWITCH_LOCATION, key_state); + onKeyswitchEvent(key, UNKNOWN_KEYSWITCH_LOCATION, key_state); } // --- hooks --- -Key Leader::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state) { - if (key_state & INJECTED) - return mapped_key; +EventHandlerResult Leader::onKeyswitchEvent(Key &mapped_key, byte row, byte col, uint8_t keyState) { + if (keyState & INJECTED) + return EventHandlerResult::OK; - if (!keyIsPressed(key_state) && !keyWasPressed(key_state)) { - if (isLeader(mapped_key)) - return Key_NoKey; - return mapped_key; + if (!keyIsPressed(keyState) && !keyWasPressed(keyState)) { + if (isLeader(mapped_key)) { + return EventHandlerResult::EVENT_CONSUMED; + } + return EventHandlerResult::OK; } if (!isActive() && !isLeader(mapped_key)) - return mapped_key; + return EventHandlerResult::OK; if (!isActive()) { // Must be a leader key! - if (keyToggledOff(key_state)) { + if (keyToggledOff(keyState)) { // not active, but a leader key = start the sequence on key release! end_time_ = millis() + time_out; sequence_pos_ = 0; @@ -113,53 +106,76 @@ Key Leader::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_sta } // If the sequence was not active yet, ignore the key. - return Key_NoKey; + return EventHandlerResult::EVENT_CONSUMED; } // active int8_t action_index = lookup(); - if (keyToggledOn(key_state)) { + if (keyToggledOn(keyState)) { sequence_pos_++; if (sequence_pos_ > LEADER_MAX_SEQUENCE_LENGTH) { reset(); - return mapped_key; + return EventHandlerResult::OK; } end_time_ = millis() + time_out; sequence_[sequence_pos_].raw = mapped_key.raw; action_index = lookup(); - if (action_index >= 0) - return Key_NoKey; - } else if (keyIsPressed(key_state)) { + if (action_index >= 0) { + return EventHandlerResult::EVENT_CONSUMED; + } + } else if (keyIsPressed(keyState)) { // held, no need for anything here. - return Key_NoKey; + return EventHandlerResult::EVENT_CONSUMED; } if (action_index == NO_MATCH) { reset(); - return mapped_key; + return EventHandlerResult::OK; } if (action_index == PARTIAL_MATCH) { - return Key_NoKey; + return EventHandlerResult::EVENT_CONSUMED; } action_t leaderAction = (action_t) pgm_read_ptr(&(dictionary[action_index].action)); (*leaderAction)(action_index); - return Key_NoKey; -} -void Leader::loopHook(bool is_post_clear) { - if (!is_post_clear) - return; + return EventHandlerResult::EVENT_CONSUMED; +} +EventHandlerResult Leader::afterEachCycle() { if (!isActive()) - return; + return EventHandlerResult::OK; if (millis() >= end_time_) reset(); + + return EventHandlerResult::OK; +} + +// Legacy V1 API +#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API +void Leader::begin() { + Kaleidoscope.useEventHandlerHook(legacyEventHandler); + Kaleidoscope.useLoopHook(legacyLoopHook); +} + +Key Leader::legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state) { + EventHandlerResult r = ::Leader.onKeyswitchEvent(mapped_key, row, col, key_state); + if (r == EventHandlerResult::OK) + return mapped_key; + return Key_NoKey; +} + +void Leader::legacyLoopHook(bool is_post_clear) { + if (!is_post_clear) + return; + + ::Leader.afterEachCycle(); } +#endif } diff --git a/src/Kaleidoscope/Leader.h b/src/Kaleidoscope/Leader.h index 16fd7117..bf0ea507 100644 --- a/src/Kaleidoscope/Leader.h +++ b/src/Kaleidoscope/Leader.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Leader -- VIM-style leader keys - * Copyright (C) 2016, 2017 Gergely Nagy + * Copyright (C) 2016, 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 @@ -30,7 +30,7 @@ namespace kaleidoscope { -class Leader : public KaleidoscopePlugin { +class Leader : public kaleidoscope::Plugin { public: typedef void (*action_t)(uint8_t seq_index); typedef struct { @@ -38,23 +38,29 @@ class Leader : public KaleidoscopePlugin { action_t action; } dictionary_t; - Leader(void); + Leader(void) {} static const dictionary_t *dictionary; - void begin(void) final; - static void reset(void); static uint16_t time_out; void inject(Key key, uint8_t key_state); + EventHandlerResult onKeyswitchEvent(Key &mapped_key, byte row, byte col, uint8_t keyState); + EventHandlerResult afterEachCycle(); + +#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API + protected: + void begin(); + static Key legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state); + static void legacyLoopHook(bool is_post_clear); +#endif + private: static Key sequence_[LEADER_MAX_SEQUENCE_LENGTH + 1]; static uint8_t sequence_pos_; static uint32_t end_time_; - static Key eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state); - static void loopHook(bool is_post_clear); static int8_t lookup(void); }; From db088083deeae7105ab15488af9741bb8b1cec0c Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 17 Jun 2018 11:09:03 +0200 Subject: [PATCH 32/42] Override onSetup when using a compatibility layer The default `onSetup` will call `.begin`, to support initializing plugins using the V1 plugins while using `KALEIDOSCOPE_INIT_PLUGINS`. However, plugins that implement a compatibility layer so that they can be used with both the new API, and with `Kaleidoscope.use()` will have a `.begin` method too. Which the default `onSetup` will call, and we'll register the compatibility layer too, in addition to the new-style event handlers. This results in many things running twice, which leads to all kinds of problems. For this reason, override `onSetup`, so that it does not call `begin`. When used with `Kaleidoscope.use()`, the plugin will still work, so compatibility is maintained. But the bug is now gone. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/Leader.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/Kaleidoscope/Leader.h b/src/Kaleidoscope/Leader.h index bf0ea507..df1ecfeb 100644 --- a/src/Kaleidoscope/Leader.h +++ b/src/Kaleidoscope/Leader.h @@ -50,6 +50,10 @@ class Leader : public kaleidoscope::Plugin { EventHandlerResult afterEachCycle(); #if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API + kaleidoscope::EventHandlerResult onSetup() { + return kaleidoscope::EventHandlerResult::OK; + } + protected: void begin(); static Key legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state); From 375ef6cdafb6d7a888c4be648792485d3a54fcaa Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 20 Aug 2018 23:08:40 +0200 Subject: [PATCH 33/42] Drop the V1 plugin API compatibility code Signed-off-by: Gergely Nagy --- src/Kaleidoscope/Leader.cpp | 22 ---------------------- src/Kaleidoscope/Leader.h | 11 ----------- 2 files changed, 33 deletions(-) diff --git a/src/Kaleidoscope/Leader.cpp b/src/Kaleidoscope/Leader.cpp index bc993d47..03e5aaec 100644 --- a/src/Kaleidoscope/Leader.cpp +++ b/src/Kaleidoscope/Leader.cpp @@ -155,28 +155,6 @@ EventHandlerResult Leader::afterEachCycle() { return EventHandlerResult::OK; } -// Legacy V1 API -#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API -void Leader::begin() { - Kaleidoscope.useEventHandlerHook(legacyEventHandler); - Kaleidoscope.useLoopHook(legacyLoopHook); -} - -Key Leader::legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state) { - EventHandlerResult r = ::Leader.onKeyswitchEvent(mapped_key, row, col, key_state); - if (r == EventHandlerResult::OK) - return mapped_key; - return Key_NoKey; -} - -void Leader::legacyLoopHook(bool is_post_clear) { - if (!is_post_clear) - return; - - ::Leader.afterEachCycle(); -} -#endif - } kaleidoscope::Leader Leader; diff --git a/src/Kaleidoscope/Leader.h b/src/Kaleidoscope/Leader.h index df1ecfeb..0b0f52ed 100644 --- a/src/Kaleidoscope/Leader.h +++ b/src/Kaleidoscope/Leader.h @@ -49,17 +49,6 @@ class Leader : public kaleidoscope::Plugin { EventHandlerResult onKeyswitchEvent(Key &mapped_key, byte row, byte col, uint8_t keyState); EventHandlerResult afterEachCycle(); -#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API - kaleidoscope::EventHandlerResult onSetup() { - return kaleidoscope::EventHandlerResult::OK; - } - - protected: - void begin(); - static Key legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state); - static void legacyLoopHook(bool is_post_clear); -#endif - private: static Key sequence_[LEADER_MAX_SEQUENCE_LENGTH + 1]; static uint8_t sequence_pos_; From 33015c8126aa27235845575f007a4d480db1bdf5 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:15:49 +0200 Subject: [PATCH 34/42] Relicense under the GPLv3 (only) Signed-off-by: Gergely Nagy --- examples/Leader/Leader.ino | 19 +++++++++---------- src/Kaleidoscope-Leader.h | 19 +++++++++---------- src/Kaleidoscope/Leader.cpp | 19 +++++++++---------- src/Kaleidoscope/Leader.h | 19 +++++++++---------- 4 files changed, 36 insertions(+), 40 deletions(-) diff --git a/examples/Leader/Leader.ino b/examples/Leader/Leader.ino index 1f1c1b8e..daf3bc23 100644 --- a/examples/Leader/Leader.ino +++ b/examples/Leader/Leader.ino @@ -2,18 +2,17 @@ * Kaleidoscope-Leader -- VIM-style leader keys * Copyright (C) 2016, 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-Leader.h b/src/Kaleidoscope-Leader.h index 61fe563a..208db05b 100644 --- a/src/Kaleidoscope-Leader.h +++ b/src/Kaleidoscope-Leader.h @@ -2,18 +2,17 @@ * Kaleidoscope-Leader -- VIM-style leader keys * Copyright (C) 2016, 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/Leader.cpp b/src/Kaleidoscope/Leader.cpp index 03e5aaec..133dee5d 100644 --- a/src/Kaleidoscope/Leader.cpp +++ b/src/Kaleidoscope/Leader.cpp @@ -2,18 +2,17 @@ * Kaleidoscope-Leader -- VIM-style leader keys * Copyright (C) 2016, 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/Leader.h b/src/Kaleidoscope/Leader.h index 0b0f52ed..c8d7243e 100644 --- a/src/Kaleidoscope/Leader.h +++ b/src/Kaleidoscope/Leader.h @@ -2,18 +2,17 @@ * Kaleidoscope-Leader -- VIM-style leader keys * Copyright (C) 2016, 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 0e4b34b09dae68f40b23e064b02d149667dfa8c5 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:15:51 +0200 Subject: [PATCH 35/42] 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/Leader/Leader.ino | 2 +- library.properties | 2 +- src/Kaleidoscope-Leader.h | 2 +- src/Kaleidoscope/Leader.cpp | 2 +- src/Kaleidoscope/Leader.h | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/examples/Leader/Leader.ino b/examples/Leader/Leader.ino index daf3bc23..583c95d9 100644 --- a/examples/Leader/Leader.ino +++ b/examples/Leader/Leader.ino @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Leader -- VIM-style leader keys - * Copyright (C) 2016, 2017, 2018 Gergely Nagy + * Copyright (C) 2016, 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 940bf4e2..04eaaa79 100644 --- a/library.properties +++ b/library.properties @@ -1,7 +1,7 @@ name=Kaleidoscope-Leader version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy +maintainer=Gergely Nagy sentence=Leader keys for Kaleidoscope. paragraph=VIM-style leader keys. category=Communication diff --git a/src/Kaleidoscope-Leader.h b/src/Kaleidoscope-Leader.h index 208db05b..1f2fce3e 100644 --- a/src/Kaleidoscope-Leader.h +++ b/src/Kaleidoscope-Leader.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Leader -- VIM-style leader keys - * Copyright (C) 2016, 2017 Gergely Nagy + * Copyright (C) 2016, 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/Leader.cpp b/src/Kaleidoscope/Leader.cpp index 133dee5d..2b11f969 100644 --- a/src/Kaleidoscope/Leader.cpp +++ b/src/Kaleidoscope/Leader.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Leader -- VIM-style leader keys - * Copyright (C) 2016, 2017, 2018 Gergely Nagy + * Copyright (C) 2016, 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/Leader.h b/src/Kaleidoscope/Leader.h index c8d7243e..6e9564d4 100644 --- a/src/Kaleidoscope/Leader.h +++ b/src/Kaleidoscope/Leader.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Leader -- VIM-style leader keys - * Copyright (C) 2016, 2017, 2018 Gergely Nagy + * Copyright (C) 2016, 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 4db3c1a51a60b9483d3d5cfb3e01087645335021 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:15:53 +0200 Subject: [PATCH 36/42] 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 cac493917b5f9603cdbe2a209a9a71855f34d15f Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 4 Sep 2018 18:24:01 -0700 Subject: [PATCH 37/42] 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 d34335667b9e3b60a01cc0cd15314bd9f028d4b0 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 4 Sep 2018 18:42:30 -0700 Subject: [PATCH 38/42] 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 13f92255cb76d4f9bf9959f6c67e8a339496b3e2 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 10 Oct 2018 06:38:08 +0200 Subject: [PATCH 39/42] 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 7dc84369..9226862a 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,10 @@ # Kaleidoscope-Leader -![status][st:stable] [![Build Status][travis:image]][travis:status] +[![Build Status][travis:image]][travis:status] [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-Leader.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-Leader - [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 - Leader keys are a kind of key where when they are tapped, all following keys are swallowed, until the plugin finds a matching sequence in the dictionary, it times out, or fails to find any possibilities. When a sequence is found, the From e37669a623d221dbcc344e8bcdfc6a89087cf614 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 13 Oct 2018 12:40:35 +0200 Subject: [PATCH 40/42] Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/Leader.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 | 99 +--------------- doc/plugin/Leader.md | 107 ++++++++++++++++++ examples/Leader/Leader.ino | 2 +- src/Kaleidoscope-Leader.h | 2 +- .../plugin}/Leader.cpp | 4 +- .../plugin}/Leader.h | 6 +- 6 files changed, 118 insertions(+), 102 deletions(-) create mode 100644 doc/plugin/Leader.md rename src/{Kaleidoscope => kaleidoscope/plugin}/Leader.cpp (98%) rename src/{Kaleidoscope => kaleidoscope/plugin}/Leader.h (93%) diff --git a/README.md b/README.md index 9226862a..827d9be4 100644 --- a/README.md +++ b/README.md @@ -5,101 +5,4 @@ [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-Leader.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-Leader -Leader keys are a kind of key where when they are tapped, all following keys are -swallowed, until the plugin finds a matching sequence in the dictionary, it -times out, or fails to find any possibilities. When a sequence is found, the -corresponding action is executed, but the processing still continues. If any key -is pressed that is not the continuation of the existing sequence, processing -aborts, and the key is handled normally. - -This behaviour is best described with an example. Suppose we want a behaviour -where `LEAD u` starts unicode input mode, and `LEAD u h e a r t` should result -in a heart symbol being input, and we want `LEAD u 0 0 e 9 SPC` to input `é`, -and any other hex code that follows `LEAD u`, should be handled as-is, and -passed to the host. Obviously, we can't have all of this in a dictionary. - -So we put `LEAD u` and `LEAD u h e a r t` in the dictionary only. The first will -start unicode input mode, the second will type in the magic sequence that -results in the symbol, and then aborts the leader sequence processing. With this -setup, if we type `LEAD u 0`, then `LEAD u` will be handled first, and start -unicode input mode. Then, at the `0`, the plugin notices it is not part of any -sequence, so aborts leader processing, and passes the key on as-is, and it ends -up being sent to the host. Thus, we covered all the cases of our scenario! - -## Using the plugin - -To use the plugin, one needs to include the header, implement some actions, -create a dictionary, and configure the provided `Leader` object to use the -dictionary: - -```c++ -#include -#include - -static void leaderA(uint8_t seq_index) { - Serial.println("leaderA"); -} - -static void leaderTX(uint8_t seq_index) { - Serial.println("leaderTX"); -} - -static const kaleidoscope::Leader::dictionary_t leader_dictionary[] PROGMEM = - LEADER_DICT({LEADER_SEQ(LEAD(0), Key_A), leaderA}, - {LEADER_SEQ(LEAD(0), Key_T, Key_X), leaderTX}); - -KALEIDOSCOPE_INIT_PLUGINS(Leader); - -void setup() { - Serial.begin(9600); - - Kaleidoscope.setup(); - - Leader.dictionary = leader_dictionary; -} -``` - -The dictionary is made up of a list of keys, and an action callback. Using the -`LEADER_DICT` and `LEADER_SEQ` helpers is recommended. The dictionary *must* be -marked `PROGMEM`! - -**Note** that we need to use the `Leader` object before any other that adds or -changes key behaviour! Failing to do so may result in unpredictable behaviour. - -## Plugin methods - -The plugin provides the `Leader` object, with the following methods and properties: - -### `.dictionary` - -> Set this property to the dictionary `Leader` should use. The dictionary is an -> array of `kaleidoscope::Leader::dictionary_t` elements. Each element is made -> up of two elements, the first being a list of keys, the second an action to -> perform when the sequence is found.i -> -> The dictionary *MUST* reside in `PROGMEM`. - -### `.reset()` - -> Finishes the leader sequence processing. This is best called from actions that -> are final actions, where one does not wish to continue the leader sequence -> further in the hopes of finding a longer match. - -### `.time_out` - -> The number of milliseconds to wait before a sequence times out. Once the -> sequence timed out, if there is a partial match with an action, that will be -> performed, otherwise the Leader sequence will simply reset. -> -> Defaults to 1000. - -## Dependencies - -* [Kaleidoscope-Ranges](https://github.com/keyboardio/Kaleidoscope-Ranges) - -## 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-Leader/blob/master/examples/Leader/Leader.ino +See [doc/plugin/Leader.md](doc/plugin/Leader.md) for documentation. diff --git a/doc/plugin/Leader.md b/doc/plugin/Leader.md new file mode 100644 index 00000000..8fa1e041 --- /dev/null +++ b/doc/plugin/Leader.md @@ -0,0 +1,107 @@ +# Kaleidoscope-Leader + +Leader keys are a kind of key where when they are tapped, all following keys are +swallowed, until the plugin finds a matching sequence in the dictionary, it +times out, or fails to find any possibilities. When a sequence is found, the +corresponding action is executed, but the processing still continues. If any key +is pressed that is not the continuation of the existing sequence, processing +aborts, and the key is handled normally. + +This behaviour is best described with an example. Suppose we want a behaviour +where `LEAD u` starts unicode input mode, and `LEAD u h e a r t` should result +in a heart symbol being input, and we want `LEAD u 0 0 e 9 SPC` to input `é`, +and any other hex code that follows `LEAD u`, should be handled as-is, and +passed to the host. Obviously, we can't have all of this in a dictionary. + +So we put `LEAD u` and `LEAD u h e a r t` in the dictionary only. The first will +start unicode input mode, the second will type in the magic sequence that +results in the symbol, and then aborts the leader sequence processing. With this +setup, if we type `LEAD u 0`, then `LEAD u` will be handled first, and start +unicode input mode. Then, at the `0`, the plugin notices it is not part of any +sequence, so aborts leader processing, and passes the key on as-is, and it ends +up being sent to the host. Thus, we covered all the cases of our scenario! + +## Using the plugin + +To use the plugin, one needs to include the header, implement some actions, +create a dictionary, and configure the provided `Leader` object to use the +dictionary: + +```c++ +#include +#include + +static void leaderA(uint8_t seq_index) { + Serial.println("leaderA"); +} + +static void leaderTX(uint8_t seq_index) { + Serial.println("leaderTX"); +} + +static const kaleidoscope::Leader::dictionary_t leader_dictionary[] PROGMEM = + LEADER_DICT({LEADER_SEQ(LEAD(0), Key_A), leaderA}, + {LEADER_SEQ(LEAD(0), Key_T, Key_X), leaderTX}); + +KALEIDOSCOPE_INIT_PLUGINS(Leader); + +void setup() { + Serial.begin(9600); + + Kaleidoscope.setup(); + + Leader.dictionary = leader_dictionary; +} +``` + +The dictionary is made up of a list of keys, and an action callback. Using the +`LEADER_DICT` and `LEADER_SEQ` helpers is recommended. The dictionary *must* be +marked `PROGMEM`! + +**Note** that we need to use the `Leader` object before any other that adds or +changes key behaviour! Failing to do so may result in unpredictable behaviour. + +## Plugin methods + +The plugin provides the `Leader` object, with the following methods and properties: + +### `.dictionary` + +> Set this property to the dictionary `Leader` should use. The dictionary is an +> array of `kaleidoscope::Leader::dictionary_t` elements. Each element is made +> up of two elements, the first being a list of keys, the second an action to +> perform when the sequence is found.i +> +> The dictionary *MUST* reside in `PROGMEM`. + +### `.reset()` + +> Finishes the leader sequence processing. This is best called from actions that +> are final actions, where one does not wish to continue the leader sequence +> further in the hopes of finding a longer match. + +### `.time_out` + +> The number of milliseconds to wait before a sequence times out. Once the +> sequence timed out, if there is a partial match with an action, that will be +> performed, otherwise the Leader sequence will simply reset. +> +> Defaults to 1000. + +## Dependencies + +* [Kaleidoscope-Ranges](https://github.com/keyboardio/Kaleidoscope-Ranges) + +## 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-Leader/blob/master/examples/Leader/Leader.ino + +## Upgrading + +Previous versions of `Leader` used `kaleidoscope::Leader::dictionary_t` as a +type for defining the dictionary. In newer versions, this is +`kaleidoscope::plugin::Leader::dictionary_t`. The old name still works, but will +be removed by 2019-01-14. diff --git a/examples/Leader/Leader.ino b/examples/Leader/Leader.ino index 583c95d9..e49869f6 100644 --- a/examples/Leader/Leader.ino +++ b/examples/Leader/Leader.ino @@ -47,7 +47,7 @@ static void leaderTestAA(uint8_t seq_index) { Serial.println(F("leaderTestAA")); } -static const kaleidoscope::Leader::dictionary_t leader_dictionary[] PROGMEM = +static const kaleidoscope::plugin::Leader::dictionary_t leader_dictionary[] PROGMEM = LEADER_DICT({LEADER_SEQ(LEAD(0), Key_A), leaderTestA}, {LEADER_SEQ(LEAD(0), Key_A, Key_A), leaderTestAA}); diff --git a/src/Kaleidoscope-Leader.h b/src/Kaleidoscope-Leader.h index 1f2fce3e..87b948fa 100644 --- a/src/Kaleidoscope-Leader.h +++ b/src/Kaleidoscope-Leader.h @@ -17,4 +17,4 @@ #pragma once -#include +#include diff --git a/src/Kaleidoscope/Leader.cpp b/src/kaleidoscope/plugin/Leader.cpp similarity index 98% rename from src/Kaleidoscope/Leader.cpp rename to src/kaleidoscope/plugin/Leader.cpp index 2b11f969..96968082 100644 --- a/src/Kaleidoscope/Leader.cpp +++ b/src/kaleidoscope/plugin/Leader.cpp @@ -18,6 +18,7 @@ #include namespace kaleidoscope { +namespace plugin { // --- state --- Key Leader::sequence_[LEADER_MAX_SEQUENCE_LENGTH + 1]; @@ -154,6 +155,7 @@ EventHandlerResult Leader::afterEachCycle() { return EventHandlerResult::OK; } +} } -kaleidoscope::Leader Leader; +kaleidoscope::plugin::Leader Leader; diff --git a/src/Kaleidoscope/Leader.h b/src/kaleidoscope/plugin/Leader.h similarity index 93% rename from src/Kaleidoscope/Leader.h rename to src/kaleidoscope/plugin/Leader.h index 6e9564d4..a7c56e87 100644 --- a/src/Kaleidoscope/Leader.h +++ b/src/kaleidoscope/plugin/Leader.h @@ -28,6 +28,7 @@ #define LEADER_DICT(...) { __VA_ARGS__, {{Key_NoKey}, NULL} } namespace kaleidoscope { +namespace plugin { class Leader : public kaleidoscope::Plugin { public: @@ -55,7 +56,10 @@ class Leader : public kaleidoscope::Plugin { static int8_t lookup(void); }; +} +// Backwards compatibility +typedef plugin::Leader Leader; } -extern kaleidoscope::Leader Leader; +extern kaleidoscope::plugin::Leader Leader; From da6b3515fd9b7ab65c8e4e940787dd2e9aeda319 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 13 Oct 2018 13:51:53 +0200 Subject: [PATCH 41/42] 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 827d9be4..00000000 --- a/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# Kaleidoscope-Leader - -[![Build Status][travis:image]][travis:status] - - [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-Leader.svg?branch=master - [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-Leader - -See [doc/plugin/Leader.md](doc/plugin/Leader.md) for documentation. diff --git a/library.properties b/library.properties deleted file mode 100644 index 04eaaa79..00000000 --- a/library.properties +++ /dev/null @@ -1,10 +0,0 @@ -name=Kaleidoscope-Leader -version=0.0.0 -author=Gergely Nagy -maintainer=Gergely Nagy -sentence=Leader keys for Kaleidoscope. -paragraph=VIM-style leader keys. -category=Communication -url=https://github.com/keyboardio/Kaleidoscope-Leader -architectures=avr -dot_a_linkage=true From cabb6fbe1f7671241d19b581534e8d91c24e4ed7 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 18 Oct 2018 00:03:30 +0200 Subject: [PATCH 42/42] 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/Leader.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/plugin/Leader.md b/doc/plugin/Leader.md index 8fa1e041..85f7ed74 100644 --- a/doc/plugin/Leader.md +++ b/doc/plugin/Leader.md @@ -90,14 +90,14 @@ The plugin provides the `Leader` object, with the following methods and properti ## Dependencies -* [Kaleidoscope-Ranges](https://github.com/keyboardio/Kaleidoscope-Ranges) +* [Kaleidoscope-Ranges](Ranges.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-Leader/blob/master/examples/Leader/Leader.ino + [plugin:example]: ../../examples/Leader/Leader.ino ## Upgrading