From 17e17810dd964c47e1b0c1dd82cf8a69ae818941 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 16 Jan 2017 15:18:13 +0100 Subject: [PATCH 01/52] Initial import Lifted out of the monolithic Akela library. Signed-off-by: Gergely Nagy --- .gitignore | 2 + COPYING | 674 +++++++++++++++++++++++++++++++++ README.md | 130 +++++++ examples/TapDance/TapDance.ino | 62 +++ library.properties | 10 + src/Akela-TapDance.h | 21 + src/Akela/TapDance.cpp | 226 +++++++++++ src/Akela/TapDance.h | 70 ++++ 8 files changed, 1195 insertions(+) create mode 100644 .gitignore create mode 100644 COPYING create mode 100644 README.md create mode 100644 examples/TapDance/TapDance.ino create mode 100644 library.properties create mode 100644 src/Akela-TapDance.h create mode 100644 src/Akela/TapDance.cpp create mode 100644 src/Akela/TapDance.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..ceacd877 --- /dev/null +++ b/README.md @@ -0,0 +1,130 @@ +# Akela-TapDance + +Tap-dance keys are general purpose, multi-use keys, which trigger a different +action based on the number of times they were tapped in sequence. As an example +to make this clearer, one can have a key that inputs `A` when tapped once, +inputs `B` when tapped twice, and lights up the keyboard in Christmas colors +when tapped a third time. + +This behaviour is most useful in cases where we have a number of things we +perform rarely, where tapping a single key repeatedly is not counter-productive. +Such cases include - for example - multimedia forward / backward keys: forward +on single tap, backward on double. Of course, one could use modifiers to achieve +a similar effect, but that's two keys to use, this is only one. We can also hide +some destructive functionality behind a number of taps: reset the keyboard after +4 taps, and light up LEDs in increasingly frightful colors until then. + +## How does it work? + +To not interfere with normal typing, tap-dance keys have two ways to decide when +to call an action: they either get interrupted, or they time out. Every time a +tap-dance key is pressed, the timer resets, so one does not have to finish the +whole tapping sequence within a short time limit. The tap-dance counter +continues incrementing until one of these cases happen. + +When a tap-dance key is pressed and released, and nothing is pressed on the +keyboard until the timeout is reached, then the key will time out, and trigger +an action. Which action, depends on the number of times it has been tapped up +until this point. + +When a tap-dance key is pressed and released, and another key is hit before the +timer expires, then the tap-dance key will trigger an action first, perform it, +and only then will the firmware continue handling the interrupting key press. +This is to preserve the order of keys pressed. + +In both of these cases, the [`tapDanceAction`][tdaction] will be called, with +`tapDanceIndex` set to the index of the tap-dance action (as set in the keymap), +the `tapCount`, and `tapDanceAction` set to either `Akela::TapDance::Interrupt`, +or `Akela::TapDance::Timeout`. If we continue holding the key, then as long as +it is held, the same function will be called with `tapDanceAction` set to +`Akela::TapDance::Hold`. When the key is released, after either an `Interrupt` +or `Timeout` action was triggered, the function will be called with +`tapDanceAction` set to `Akela::TapDance::Release`. + +These actions allow us to create sophisticated tap-dance setups, where one can +tap a key twice and hold it, and have it repeat, for example. + +There is one additional value the `tapDanceAction` parameter can take: +`Akela::TapDance::Tap`. It is called with this argument for each and every tap, +even if no action is to be triggered yet. This is so that we can have a way to +do some side-effects, like light up LEDs to show progress, and so on. + +## Using the plugin + +To use the plugin, we need to include the header, and declare the behaviour +used. Then, we need to place tap-dance keys on the keymap. And finally, we need +to implement the [`tapDanceAction`][tdaction] function that gets called each +time an action is to be performed. + +```c++ +#include + +// Somewhere in the keymap: +TD(0) + +// later in the Sketch: +void tapDanceAction (uint8_t tapDanceIndex, uint8_t tapCount, + Akela::TapDance::ActionType tapDanceAction) { + switch (tapDanceIndex) { + case 0: + return tapDanceActionKeys (tapCount, tapDanceAction, + Key_nextTrack, Key_prevTrack); + } +} + +void setup (void) { + Keyboardio.setup (KEYMAP_SIZE); + Keyboardio.use (&TapDance, NULL); +} +``` + +## Keymap markup + +### `TD(id)` + +> A key that acts as a tap-dance key. The actions performed depend on the +> implementation for the `id` index within the [`tapDanceActions`][tdactions] +> function. +> +> The `id` parameter here is what will be used as `tapDanceIndex` in the handler +> function. + + [tdaction]: #tapdanceactiontapdanceindex-tapcount-tapdanceaction + +## Plugin methods + +The plugin provides a `TapDance` object, but to implement the actions, we need +to define a function ([`tapDanceAction`][tdaction]) outside of the object. A +handler, of sorts. Nevertheless, the plugin provides one macro that is +particularly useful: + +### `tapDanceActionKeys(tapCount, tapDanceAction, keys...)` + +> Sets up an action where for each subsequent tap, a different key will be +> chosen from the list of keys supplied in the `keys...` argument. +> +> If we have `Key_A` and `Key_B` in the list, then, if tapped once, this +> function will input `A`, but when tapped twice, will input `B`. +> +> When all our actions are just different keys, this is a very handy macro to +> use. +> +> The `tapCount` and `tapDanceActions` parameters should be the same as the +> similarly named parameters of the `tapDanceAction` function. + +### `tapDanceAction(tapDanceIndex, tapCount, tapDanceAction)` + +> The heart of the tap-dance plugin is the handler method. This is called every +> time any kind of tap-dance action is to be performed. See the +> *[How does it work?](#how-does-it-work)* section for details about when and +> how this function is called. +> +> The `tapDanceIndex` and `tapCount` parameters help us choose which action to +> perform. + +## 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-TapDance/blob/master/examples/TapDance/TapDance.ino diff --git a/examples/TapDance/TapDance.ino b/examples/TapDance/TapDance.ino new file mode 100644 index 00000000..5f345a59 --- /dev/null +++ b/examples/TapDance/TapDance.ino @@ -0,0 +1,62 @@ +/* -*- 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, + TD(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, + TD(1) + ), +}; + +static void tapDanceEsc (uint8_t tapDanceIndex, uint8_t tapCount, Akela::TapDance::ActionType tapDanceAction) { + tapDanceActionKeys (tapCount, tapDanceAction, Key_Esc, Key_Tab); +} + +void tapDanceAction (uint8_t tapDanceIndex, uint8_t tapCount, Akela::TapDance::ActionType tapDanceAction) { + switch (tapDanceIndex) { + case 0: + return tapDanceActionKeys (tapCount, tapDanceAction, Key_Tab, Key_Esc); + case 1: + return tapDanceEsc (tapDanceIndex, tapCount, tapDanceAction); + } +} + +void setup () { + Keyboardio.setup (KEYMAP_SIZE); + Keyboardio.use (&TapDance, NULL); +} + +void loop () { + Keyboardio.loop (); +} diff --git a/library.properties b/library.properties new file mode 100644 index 00000000..9c6643a8 --- /dev/null +++ b/library.properties @@ -0,0 +1,10 @@ +name=Akela-TapDance +version=0.0.0 +author=Gergely Nagy +maintainer=Gergely Nagy +sentence=Tap-dance keys for Keyboardio boards. +paragraph=Generic, multi-use keys. +category=Communication +url=https://github.com/Akela-Plugins/Akela-TapDance +architectures=avr +dot_a_linkage=true diff --git a/src/Akela-TapDance.h b/src/Akela-TapDance.h new file mode 100644 index 00000000..eb3692a9 --- /dev/null +++ b/src/Akela-TapDance.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/TapDance.cpp b/src/Akela/TapDance.cpp new file mode 100644 index 00000000..f88b3ddb --- /dev/null +++ b/src/Akela/TapDance.cpp @@ -0,0 +1,226 @@ +/* -*- 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 --- + uint16_t TapDance::timer; + uint16_t TapDance::timeOut = DEFAULT_TIMEOUT; + uint8_t TapDance::tapCount[32]; + uint32_t TapDance::pressedState; + uint32_t TapDance::triggeredState; + Key TapDance::lastTapDanceKey; + + // --- helpers --- + +#define isTapDance(k) (k.raw >= TD_FIRST && k.raw <= TD_LAST) +#define isInSeq(k) (lastTapDanceKey.raw == k.raw) +#define stillHeld(idx) (tapCount[idx]) +#define isActive() (lastTapDanceKey.raw != Key_NoKey.raw) + + // --- actions --- + + void + TapDance::interrupt (void) { + uint8_t idx = lastTapDanceKey.raw - TD_FIRST; + + tapDanceAction (idx, tapCount[idx], Interrupt); + bitWrite (triggeredState, idx, 1); + + timer = 0; + + if (bitRead (pressedState, idx)) + return; + + release (idx); + } + + void + TapDance::timeout (void) { + uint8_t idx = lastTapDanceKey.raw - TD_FIRST; + + tapDanceAction (idx, tapCount[idx], Timeout); + bitWrite (triggeredState, idx, 1); + + if (bitRead (pressedState, idx)) + return; + + lastTapDanceKey.raw = Key_NoKey.raw; + + release (idx); + } + + Key + TapDance::release (uint8_t tapDanceIndex) { + tapDanceAction (tapDanceIndex, tapCount[tapDanceIndex], Release); + + timer = 0; + tapCount[tapDanceIndex] = 0; + lastTapDanceKey.raw = Key_NoKey.raw; + + bitClear (pressedState, tapDanceIndex); + bitClear (triggeredState, tapDanceIndex); + return Key_NoKey; + } + + Key + TapDance::tap (void) { + uint8_t idx = lastTapDanceKey.raw - TD_FIRST; + + tapCount[idx]++; + timer = 0; + + tapDanceAction (idx, tapCount[idx], Tap); + + return Key_NoKey; + } + + // --- api --- + + TapDance::TapDance (void) { + lastTapDanceKey.raw = Key_NoKey.raw; + } + + void + TapDance::begin (void) { + event_handler_hook_add (this->eventHandlerHook); + loop_hook_add (this->loopHook); + } + + void + TapDance::actionKeys (uint8_t tapCount, ActionType tapDanceAction, uint8_t maxKeys, const Key tapKeys[]) { + if (tapCount > maxKeys) + return; + + Key key; + key.raw = pgm_read_word (&(tapKeys[tapCount - 1].raw)); + + switch (tapDanceAction) { + case Tap: + break; + case Interrupt: + case Timeout: + handle_key_event (key, 255, 255, IS_PRESSED | INJECTED); + break; + case Hold: + handle_key_event (key, 255, 255, IS_PRESSED | WAS_PRESSED | INJECTED); + break; + case Release: + Keyboard.sendReport (); + handle_key_event (key, 255, 255, WAS_PRESSED | INJECTED); + break; + } + } + + void + TapDance::inject (Key key, uint8_t keyState) { + eventHandlerHook (key, 255, 255, keyState); + } + + // --- hooks --- + + Key + TapDance::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 (isTapDance (mappedKey)) + return Key_NoKey; + return mappedKey; + } + + if (!isTapDance (mappedKey)) { + if (!isActive ()) + return mappedKey; + + if (key_toggled_on (keyState)) + interrupt (); + + return mappedKey; + } + + uint8_t tapDanceIndex = mappedKey.raw - TD_FIRST; + + if (key_toggled_off (keyState)) + bitClear (pressedState, tapDanceIndex); + + if (!isInSeq (mappedKey)) { + if (!isActive ()) { + if (bitRead (triggeredState, tapDanceIndex)) { + if (key_toggled_off (keyState)) + return release (tapDanceIndex); + return Key_NoKey; + } + + lastTapDanceKey.raw = mappedKey.raw; + return tap (); + } else { + if (key_toggled_off (keyState) && stillHeld (tapDanceIndex)) { + return release (tapDanceIndex); + } + + if (!key_toggled_on (keyState)) + return Key_NoKey; + + interrupt (); + } + } + + // in sequence + + if (key_toggled_off (keyState)) + return Key_NoKey; + + lastTapDanceKey.raw = mappedKey.raw; + bitSet (pressedState, tapDanceIndex); + + if (key_toggled_on (keyState)) + return tap (); + + if (bitRead (triggeredState, tapDanceIndex)) + tapDanceAction (tapDanceIndex, tapCount[tapDanceIndex], Hold); + + return Key_NoKey; + } + + void + TapDance::loopHook (bool postClear) { + if (!postClear) + return; + + if (!isActive ()) + return; + + if (timer < timeOut) + timer++; + + if (timer >= timeOut) + timeout(); + } +}; + +__attribute__((weak)) +void +tapDanceAction (uint8_t tapDanceIndex, uint8_t tapCount, Akela::TapDance::ActionType tapDanceAction) { +} + +Akela::TapDance TapDance; diff --git a/src/Akela/TapDance.h b/src/Akela/TapDance.h new file mode 100644 index 00000000..f759fe40 --- /dev/null +++ b/src/Akela/TapDance.h @@ -0,0 +1,70 @@ +/* -*- 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 TD(n) (Key){.raw = Akela::Ranges::TD_FIRST + n } + +#define tapDanceActionKeys(tapCount, tapDanceAction, ...) ({ \ + static const Key __k[] PROGMEM = { __VA_ARGS__ }; \ + TapDance.actionKeys (tapCount, tapDanceAction, \ + sizeof (__k) / sizeof (Key), &__k[0]); \ + }) + +namespace Akela { + class TapDance : public KeyboardioPlugin { + public: + typedef enum { + Tap, + Hold, + Interrupt, + Timeout, + Release, + } ActionType; + + TapDance (void); + + virtual void begin (void) final; + + void actionKeys (uint8_t tapCount, ActionType tapDanceAction, uint8_t maxKeys, const Key tapKeys[]); + + void inject (Key key, uint8_t keyState); + + private: + static uint16_t timer; + static uint16_t timeOut; + static uint8_t tapCount[32]; + static uint32_t pressedState; + static uint32_t triggeredState; + static Key lastTapDanceKey; + + static Key eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState); + static void loopHook (bool postClear); + + static Key tap (void); + static void interrupt (void); + static void timeout (void); + static Key release (uint8_t tapDanceIndex); + }; +}; + +void tapDanceAction (uint8_t tapDanceIndex, uint8_t tapCount, Akela::TapDance::ActionType tapDanceAction); + +extern Akela::TapDance TapDance; From 185248816acb50554893571f1614b93e3046e253 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 16 Jan 2017 17:16:50 +0100 Subject: [PATCH 02/52] 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 ceacd877..48452765 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # Akela-TapDance +![status][st:experimental] + + [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 + Tap-dance keys are general purpose, multi-use keys, which trigger a different action based on the number of times they were tapped in sequence. As an example to make this clearer, one can have a key that inputs `A` when tapped once, From 27e4b80e1fd5e69b3379105ef675ca3baaa1eecc Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 17 Jan 2017 10:15:07 +0100 Subject: [PATCH 03/52] 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 48452765..7901bbb1 100644 --- a/README.md +++ b/README.md @@ -133,4 +133,4 @@ particularly useful: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/Akela-Plugins/Akela-TapDance/blob/master/examples/TapDance/TapDance.ino + [plugin:example]: https://github.com/keyboardio/Akela-TapDance/blob/master/examples/TapDance/TapDance.ino diff --git a/library.properties b/library.properties index 9c6643a8..ce59c199 100644 --- a/library.properties +++ b/library.properties @@ -5,6 +5,6 @@ maintainer=Gergely Nagy sentence=Tap-dance keys for Keyboardio boards. paragraph=Generic, multi-use keys. category=Communication -url=https://github.com/Akela-Plugins/Akela-TapDance +url=https://github.com/keyboardio/Akela-TapDance architectures=avr dot_a_linkage=true From 3dc12f29e331c7374669c7885d64cbb1dca07c38 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 19 Jan 2017 12:37:23 +0100 Subject: [PATCH 04/52] actionKeys: Improved overflow handling When tapping a tap-dance key handled by `TapDance::actionKeys` more times than the amount of keys available, treat it as if the last action was to be triggered. This feels not only more intuitive, but it also allows the counter and state to reset as soon as possible, resulting in a better typing experience. Fixes #1. Signed-off-by: Gergely Nagy --- src/Akela/TapDance.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Akela/TapDance.cpp b/src/Akela/TapDance.cpp index f88b3ddb..00aee9c6 100644 --- a/src/Akela/TapDance.cpp +++ b/src/Akela/TapDance.cpp @@ -108,7 +108,7 @@ namespace Akela { void TapDance::actionKeys (uint8_t tapCount, ActionType tapDanceAction, uint8_t maxKeys, const Key tapKeys[]) { if (tapCount > maxKeys) - return; + tapCount = maxKeys; Key key; key.raw = pgm_read_word (&(tapKeys[tapCount - 1].raw)); From e112ea3d698a43a668a11418c3faaede8115d5fe Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 19 Jan 2017 12:45:44 +0100 Subject: [PATCH 05/52] Decrease the timeout to 5 cycles Having a long timeout for tap-dance is counter-intuitive, unlike for the other special keys with timeouts. Use a short one instead. Fixes #2. Signed-off-by: Gergely Nagy --- src/Akela/TapDance.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Akela/TapDance.cpp b/src/Akela/TapDance.cpp index 00aee9c6..0ed93d02 100644 --- a/src/Akela/TapDance.cpp +++ b/src/Akela/TapDance.cpp @@ -23,7 +23,7 @@ using namespace Akela::Ranges; namespace Akela { // --- state --- uint16_t TapDance::timer; - uint16_t TapDance::timeOut = DEFAULT_TIMEOUT; + uint16_t TapDance::timeOut = 5; uint8_t TapDance::tapCount[32]; uint32_t TapDance::pressedState; uint32_t TapDance::triggeredState; From 3dbaeb6a44bf6e2f497f72d659f386a49e52c31f Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 19 Jan 2017 13:44:16 +0100 Subject: [PATCH 06/52] Mark the plugin stable Signed-off-by: Gergely Nagy --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7901bbb1..7440480e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Akela-TapDance -![status][st:experimental] +![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 From e44aa0daee71a55498e3e51d04270af24cee3947 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 21 Jan 2017 20:05:21 +0100 Subject: [PATCH 07/52] Drop the `inject` method Not needed anymore. Signed-off-by: Gergely Nagy --- src/Akela/TapDance.cpp | 5 ----- src/Akela/TapDance.h | 2 -- 2 files changed, 7 deletions(-) diff --git a/src/Akela/TapDance.cpp b/src/Akela/TapDance.cpp index 0ed93d02..572ea3fb 100644 --- a/src/Akela/TapDance.cpp +++ b/src/Akela/TapDance.cpp @@ -130,11 +130,6 @@ namespace Akela { } } - void - TapDance::inject (Key key, uint8_t keyState) { - eventHandlerHook (key, 255, 255, keyState); - } - // --- hooks --- Key diff --git a/src/Akela/TapDance.h b/src/Akela/TapDance.h index f759fe40..97d918d3 100644 --- a/src/Akela/TapDance.h +++ b/src/Akela/TapDance.h @@ -45,8 +45,6 @@ namespace Akela { void actionKeys (uint8_t tapCount, ActionType tapDanceAction, uint8_t maxKeys, const Key tapKeys[]); - void inject (Key key, uint8_t keyState); - private: static uint16_t timer; static uint16_t timeOut; From d3d51fd26644918ef3e524284c99b5e3632720f8 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 21 Jan 2017 20:08:08 +0100 Subject: [PATCH 08/52] Record and use the position of the tap-dance key, too To be able to change the LEDs under a tap-dance key - for example - we need to know its position. For this reason, remember the position, and use it when injecting events, and pass them to `tapDanceAction`, too. Fixes #3. Signed-off-by: Gergely Nagy --- README.md | 5 +++-- src/Akela/TapDance.cpp | 24 +++++++++++++++--------- src/Akela/TapDance.h | 4 +++- 3 files changed, 21 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 7440480e..492065cf 100644 --- a/README.md +++ b/README.md @@ -118,7 +118,7 @@ particularly useful: > The `tapCount` and `tapDanceActions` parameters should be the same as the > similarly named parameters of the `tapDanceAction` function. -### `tapDanceAction(tapDanceIndex, tapCount, tapDanceAction)` +### `tapDanceAction(tapDanceIndex, row, col, tapCount, tapDanceAction)` > The heart of the tap-dance plugin is the handler method. This is called every > time any kind of tap-dance action is to be performed. See the @@ -126,7 +126,8 @@ particularly useful: > how this function is called. > > The `tapDanceIndex` and `tapCount` parameters help us choose which action to -> perform. +> perform. The `row` and `col` parameters tell us where the tap-dance key is on +> the keyboard. ## Further reading diff --git a/src/Akela/TapDance.cpp b/src/Akela/TapDance.cpp index 572ea3fb..d11da79f 100644 --- a/src/Akela/TapDance.cpp +++ b/src/Akela/TapDance.cpp @@ -28,6 +28,8 @@ namespace Akela { uint32_t TapDance::pressedState; uint32_t TapDance::triggeredState; Key TapDance::lastTapDanceKey; + byte TapDance::lastTapDanceRow; + byte TapDance::lastTapDanceCol; // --- helpers --- @@ -42,7 +44,7 @@ namespace Akela { TapDance::interrupt (void) { uint8_t idx = lastTapDanceKey.raw - TD_FIRST; - tapDanceAction (idx, tapCount[idx], Interrupt); + tapDanceAction (idx, lastTapDanceRow, lastTapDanceCol, tapCount[idx], Interrupt); bitWrite (triggeredState, idx, 1); timer = 0; @@ -57,7 +59,7 @@ namespace Akela { TapDance::timeout (void) { uint8_t idx = lastTapDanceKey.raw - TD_FIRST; - tapDanceAction (idx, tapCount[idx], Timeout); + tapDanceAction (idx, lastTapDanceRow, lastTapDanceCol, tapCount[idx], Timeout); bitWrite (triggeredState, idx, 1); if (bitRead (pressedState, idx)) @@ -70,7 +72,7 @@ namespace Akela { Key TapDance::release (uint8_t tapDanceIndex) { - tapDanceAction (tapDanceIndex, tapCount[tapDanceIndex], Release); + tapDanceAction (tapDanceIndex, lastTapDanceRow, lastTapDanceCol, tapCount[tapDanceIndex], Release); timer = 0; tapCount[tapDanceIndex] = 0; @@ -88,7 +90,7 @@ namespace Akela { tapCount[idx]++; timer = 0; - tapDanceAction (idx, tapCount[idx], Tap); + tapDanceAction (idx, lastTapDanceRow, lastTapDanceCol, tapCount[idx], Tap); return Key_NoKey; } @@ -118,14 +120,14 @@ namespace Akela { break; case Interrupt: case Timeout: - handle_key_event (key, 255, 255, IS_PRESSED | INJECTED); + handle_key_event (key, lastTapDanceRow, lastTapDanceCol, IS_PRESSED | INJECTED); break; case Hold: - handle_key_event (key, 255, 255, IS_PRESSED | WAS_PRESSED | INJECTED); + handle_key_event (key, lastTapDanceRow, lastTapDanceCol, IS_PRESSED | WAS_PRESSED | INJECTED); break; case Release: Keyboard.sendReport (); - handle_key_event (key, 255, 255, WAS_PRESSED | INJECTED); + handle_key_event (key, lastTapDanceRow, lastTapDanceCol, WAS_PRESSED | INJECTED); break; } } @@ -167,6 +169,8 @@ namespace Akela { } lastTapDanceKey.raw = mappedKey.raw; + lastTapDanceRow = row; + lastTapDanceCol = col; return tap (); } else { if (key_toggled_off (keyState) && stillHeld (tapDanceIndex)) { @@ -186,13 +190,15 @@ namespace Akela { return Key_NoKey; lastTapDanceKey.raw = mappedKey.raw; + lastTapDanceRow = row; + lastTapDanceCol = col; bitSet (pressedState, tapDanceIndex); if (key_toggled_on (keyState)) return tap (); if (bitRead (triggeredState, tapDanceIndex)) - tapDanceAction (tapDanceIndex, tapCount[tapDanceIndex], Hold); + tapDanceAction (tapDanceIndex, row, col, tapCount[tapDanceIndex], Hold); return Key_NoKey; } @@ -215,7 +221,7 @@ namespace Akela { __attribute__((weak)) void -tapDanceAction (uint8_t tapDanceIndex, uint8_t tapCount, Akela::TapDance::ActionType tapDanceAction) { +tapDanceAction (uint8_t tapDanceIndex, byte row, byte col, uint8_t tapCount, Akela::TapDance::ActionType tapDanceAction) { } Akela::TapDance TapDance; diff --git a/src/Akela/TapDance.h b/src/Akela/TapDance.h index 97d918d3..fa3199d7 100644 --- a/src/Akela/TapDance.h +++ b/src/Akela/TapDance.h @@ -52,6 +52,8 @@ namespace Akela { static uint32_t pressedState; static uint32_t triggeredState; static Key lastTapDanceKey; + static byte lastTapDanceRow; + static byte lastTapDanceCol; static Key eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState); static void loopHook (bool postClear); @@ -63,6 +65,6 @@ namespace Akela { }; }; -void tapDanceAction (uint8_t tapDanceIndex, uint8_t tapCount, Akela::TapDance::ActionType tapDanceAction); +void tapDanceAction (uint8_t tapDanceIndex, byte row, byte col, uint8_t tapCount, Akela::TapDance::ActionType tapDanceAction); extern Akela::TapDance TapDance; From 68d1bbe6bc0de4ed4485ca6fe04cbb8d0403e953 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 27 Jan 2017 09:40:45 +0100 Subject: [PATCH 09/52] Don't use Key_LEDEffectNext in the example Signed-off-by: Gergely Nagy --- examples/TapDance/TapDance.ino | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/examples/TapDance/TapDance.ino b/examples/TapDance/TapDance.ino index 5f345a59..e6bdaf6d 100644 --- a/examples/TapDance/TapDance.ino +++ b/examples/TapDance/TapDance.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, TD(0), From dd266fd27d6e18eda40769b4f5ca744d330118ff Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 27 Jan 2017 23:01:25 +0100 Subject: [PATCH 10/52] Use the new, double-add protected hook functions Signed-off-by: Gergely Nagy --- src/Akela/TapDance.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Akela/TapDance.cpp b/src/Akela/TapDance.cpp index d11da79f..573936f5 100644 --- a/src/Akela/TapDance.cpp +++ b/src/Akela/TapDance.cpp @@ -103,8 +103,8 @@ namespace Akela { void TapDance::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 d2fcb758441f5472747537f1648fb9d09cc1dfb0 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 1 Feb 2017 14:17:20 +0100 Subject: [PATCH 11/52] Expose the timeOut variable Fixes #4. Signed-off-by: Gergely Nagy --- README.md | 11 ++++++++++- src/Akela/TapDance.cpp | 2 +- src/Akela/TapDance.h | 2 +- 3 files changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 492065cf..61baade2 100644 --- a/README.md +++ b/README.md @@ -102,7 +102,16 @@ void setup (void) { The plugin provides a `TapDance` object, but to implement the actions, we need to define a function ([`tapDanceAction`][tdaction]) outside of the object. A handler, of sorts. Nevertheless, the plugin provides one macro that is -particularly useful: +particularly useful: `tapDanceActionKeys`. Apart from that, it provides one +method only: + +### `.timeOut` + +> The number of loop iterations to wait before a tap-dance sequence times out. +> Once the sequence timed out, the action for it will trigger, even without an +> interruptor. Defaults to 5, and the timer resets with every tap of the same + +> Not strictly a method, it is a variable one can assign a new value to. ### `tapDanceActionKeys(tapCount, tapDanceAction, keys...)` diff --git a/src/Akela/TapDance.cpp b/src/Akela/TapDance.cpp index 573936f5..b57772fa 100644 --- a/src/Akela/TapDance.cpp +++ b/src/Akela/TapDance.cpp @@ -23,7 +23,7 @@ using namespace Akela::Ranges; namespace Akela { // --- state --- uint16_t TapDance::timer; - uint16_t TapDance::timeOut = 5; + uint8_t TapDance::timeOut = 5; uint8_t TapDance::tapCount[32]; uint32_t TapDance::pressedState; uint32_t TapDance::triggeredState; diff --git a/src/Akela/TapDance.h b/src/Akela/TapDance.h index fa3199d7..24b5cde8 100644 --- a/src/Akela/TapDance.h +++ b/src/Akela/TapDance.h @@ -42,12 +42,12 @@ namespace Akela { TapDance (void); virtual void begin (void) final; + static uint8_t timeOut; void actionKeys (uint8_t tapCount, ActionType tapDanceAction, uint8_t maxKeys, const Key tapKeys[]); private: static uint16_t timer; - static uint16_t timeOut; static uint8_t tapCount[32]; static uint32_t pressedState; static uint32_t triggeredState; From bae049583d7209e867619bc4f6499b2faaade83e Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 10 Feb 2017 10:59:09 +0100 Subject: [PATCH 12/52] Correct the tapDanceAction prototype in the example With the wrong prototype, we do not override the default, and the callback never triggers. Signed-off-by: Gergely Nagy --- examples/TapDance/TapDance.ino | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/TapDance/TapDance.ino b/examples/TapDance/TapDance.ino index e6bdaf6d..1d850c78 100644 --- a/examples/TapDance/TapDance.ino +++ b/examples/TapDance/TapDance.ino @@ -43,7 +43,7 @@ static void tapDanceEsc (uint8_t tapDanceIndex, uint8_t tapCount, Akela::TapDanc tapDanceActionKeys (tapCount, tapDanceAction, Key_Esc, Key_Tab); } -void tapDanceAction (uint8_t tapDanceIndex, uint8_t tapCount, Akela::TapDance::ActionType tapDanceAction) { +void tapDanceAction (uint8_t tapDanceIndex, byte row, byte col, uint8_t tapCount, Akela::TapDance::ActionType tapDanceAction) { switch (tapDanceIndex) { case 0: return tapDanceActionKeys (tapCount, tapDanceAction, Key_Tab, Key_Esc); From 74070edcf1b5638be7d98a0221587f743294ed16 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 10 Feb 2017 10:59:49 +0100 Subject: [PATCH 13/52] Use timers instead of loop counters Loop counters are not reliable timer substitutes, use proper timers instead. Fixes #5. Signed-off-by: Gergely Nagy --- src/Akela/TapDance.cpp | 17 ++++++++--------- src/Akela/TapDance.h | 4 ++-- 2 files changed, 10 insertions(+), 11 deletions(-) diff --git a/src/Akela/TapDance.cpp b/src/Akela/TapDance.cpp index b57772fa..45a2d79f 100644 --- a/src/Akela/TapDance.cpp +++ b/src/Akela/TapDance.cpp @@ -22,8 +22,8 @@ using namespace Akela::Ranges; namespace Akela { // --- state --- - uint16_t TapDance::timer; - uint8_t TapDance::timeOut = 5; + uint32_t TapDance::startTime; + uint16_t TapDance::timeOut = 200; uint8_t TapDance::tapCount[32]; uint32_t TapDance::pressedState; uint32_t TapDance::triggeredState; @@ -47,7 +47,7 @@ namespace Akela { tapDanceAction (idx, lastTapDanceRow, lastTapDanceCol, tapCount[idx], Interrupt); bitWrite (triggeredState, idx, 1); - timer = 0; + startTime = millis (); if (bitRead (pressedState, idx)) return; @@ -59,6 +59,8 @@ namespace Akela { TapDance::timeout (void) { uint8_t idx = lastTapDanceKey.raw - TD_FIRST; + startTime = 0; + tapDanceAction (idx, lastTapDanceRow, lastTapDanceCol, tapCount[idx], Timeout); bitWrite (triggeredState, idx, 1); @@ -74,7 +76,7 @@ namespace Akela { TapDance::release (uint8_t tapDanceIndex) { tapDanceAction (tapDanceIndex, lastTapDanceRow, lastTapDanceCol, tapCount[tapDanceIndex], Release); - timer = 0; + startTime = 0; tapCount[tapDanceIndex] = 0; lastTapDanceKey.raw = Key_NoKey.raw; @@ -88,7 +90,7 @@ namespace Akela { uint8_t idx = lastTapDanceKey.raw - TD_FIRST; tapCount[idx]++; - timer = 0; + startTime = millis (); tapDanceAction (idx, lastTapDanceRow, lastTapDanceCol, tapCount[idx], Tap); @@ -211,10 +213,7 @@ namespace Akela { if (!isActive ()) return; - if (timer < timeOut) - timer++; - - if (timer >= timeOut) + if (startTime && (millis () - startTime) >= timeOut) timeout(); } }; diff --git a/src/Akela/TapDance.h b/src/Akela/TapDance.h index 24b5cde8..07dfb1ca 100644 --- a/src/Akela/TapDance.h +++ b/src/Akela/TapDance.h @@ -42,12 +42,12 @@ namespace Akela { TapDance (void); virtual void begin (void) final; - static uint8_t timeOut; + static uint16_t timeOut; void actionKeys (uint8_t tapCount, ActionType tapDanceAction, uint8_t maxKeys, const Key tapKeys[]); private: - static uint16_t timer; + static uint32_t startTime; static uint8_t tapCount[32]; static uint32_t pressedState; static uint32_t triggeredState; From b867f80ca2957ad78feb3eb643988b85ddf5c00a Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 12 Feb 2017 00:01:09 +0100 Subject: [PATCH 14/52] The Big Rename Rename the library to Kaleidoscope-TapDance, and follow up with other renames. Signed-off-by: Gergely Nagy --- README.md | 33 ++++++++++--------- examples/TapDance/TapDance.ino | 15 +++++---- library.properties | 8 ++--- ...ela-TapDance.h => Kaleidoscope-TapDance.h} | 4 +-- src/{Akela => Kaleidoscope}/TapDance.cpp | 12 +++---- src/{Akela => Kaleidoscope}/TapDance.h | 15 +++++---- 6 files changed, 46 insertions(+), 41 deletions(-) rename src/{Akela-TapDance.h => Kaleidoscope-TapDance.h} (88%) rename src/{Akela => Kaleidoscope}/TapDance.cpp (95%) rename src/{Akela => Kaleidoscope}/TapDance.h (83%) diff --git a/README.md b/README.md index 61baade2..68a0be9a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Akela-TapDance +# Kaleidoscope-TapDance ![status][st:stable] @@ -40,20 +40,22 @@ This is to preserve the order of keys pressed. In both of these cases, the [`tapDanceAction`][tdaction] will be called, with `tapDanceIndex` set to the index of the tap-dance action (as set in the keymap), -the `tapCount`, and `tapDanceAction` set to either `Akela::TapDance::Interrupt`, -or `Akela::TapDance::Timeout`. If we continue holding the key, then as long as -it is held, the same function will be called with `tapDanceAction` set to -`Akela::TapDance::Hold`. When the key is released, after either an `Interrupt` -or `Timeout` action was triggered, the function will be called with -`tapDanceAction` set to `Akela::TapDance::Release`. +the `tapCount`, and `tapDanceAction` set to either +`KaleidoscopePlugins::TapDance::Interrupt`, or +`KaleidoscopePlugins::TapDance::Timeout`. If we continue holding the key, then +as long as it is held, the same function will be called with `tapDanceAction` +set to `KaleidoscopePlugins::TapDance::Hold`. When the key is released, after +either an `Interrupt` or `Timeout` action was triggered, the function will be +called with `tapDanceAction` set to `KaleidoscopePlugins::TapDance::Release`. These actions allow us to create sophisticated tap-dance setups, where one can tap a key twice and hold it, and have it repeat, for example. There is one additional value the `tapDanceAction` parameter can take: -`Akela::TapDance::Tap`. It is called with this argument for each and every tap, -even if no action is to be triggered yet. This is so that we can have a way to -do some side-effects, like light up LEDs to show progress, and so on. +`KaleidoscopePlugins::TapDance::Tap`. It is called with this argument for each +and every tap, even if no action is to be triggered yet. This is so that we can +have a way to do some side-effects, like light up LEDs to show progress, and so +on. ## Using the plugin @@ -63,14 +65,15 @@ to implement the [`tapDanceAction`][tdaction] function that gets called each time an action is to be performed. ```c++ -#include +#include +#include // Somewhere in the keymap: TD(0) // later in the Sketch: void tapDanceAction (uint8_t tapDanceIndex, uint8_t tapCount, - Akela::TapDance::ActionType tapDanceAction) { + KaleidoscopePlugins::TapDance::ActionType tapDanceAction) { switch (tapDanceIndex) { case 0: return tapDanceActionKeys (tapCount, tapDanceAction, @@ -79,8 +82,8 @@ void tapDanceAction (uint8_t tapDanceIndex, uint8_t tapCount, } void setup (void) { - Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&TapDance, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&TapDance, NULL); } ``` @@ -143,4 +146,4 @@ method only: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/keyboardio/Akela-TapDance/blob/master/examples/TapDance/TapDance.ino + [plugin:example]: https://github.com/keyboardio/Kaleidoscope-TapDance/blob/master/examples/TapDance/TapDance.ino diff --git a/examples/TapDance/TapDance.ino b/examples/TapDance/TapDance.ino index 1d850c78..0b62b750 100644 --- a/examples/TapDance/TapDance.ino +++ b/examples/TapDance/TapDance.ino @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-TapDance -- Tap-dance 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 @@ -39,11 +40,11 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { ), }; -static void tapDanceEsc (uint8_t tapDanceIndex, uint8_t tapCount, Akela::TapDance::ActionType tapDanceAction) { +static void tapDanceEsc (uint8_t tapDanceIndex, uint8_t tapCount, KaleidoscopePlugins::TapDance::ActionType tapDanceAction) { tapDanceActionKeys (tapCount, tapDanceAction, Key_Esc, Key_Tab); } -void tapDanceAction (uint8_t tapDanceIndex, byte row, byte col, uint8_t tapCount, Akela::TapDance::ActionType tapDanceAction) { +void tapDanceAction (uint8_t tapDanceIndex, byte row, byte col, uint8_t tapCount, KaleidoscopePlugins::TapDance::ActionType tapDanceAction) { switch (tapDanceIndex) { case 0: return tapDanceActionKeys (tapCount, tapDanceAction, Key_Tab, Key_Esc); @@ -53,10 +54,10 @@ void tapDanceAction (uint8_t tapDanceIndex, byte row, byte col, uint8_t tapCount } void setup () { - Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&TapDance, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&TapDance, NULL); } void loop () { - Keyboardio.loop (); + Kaleidoscope.loop (); } diff --git a/library.properties b/library.properties index ce59c199..f8a00ad9 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ -name=Akela-TapDance +name=Kaleidoscope-TapDance version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy -sentence=Tap-dance keys for Keyboardio boards. +maintainer=Gergely Nagy +sentence=Tap-dance keys for Kaleidoscope. paragraph=Generic, multi-use keys. category=Communication -url=https://github.com/keyboardio/Akela-TapDance +url=https://github.com/keyboardio/Kaleidoscope-TapDance architectures=avr dot_a_linkage=true diff --git a/src/Akela-TapDance.h b/src/Kaleidoscope-TapDance.h similarity index 88% rename from src/Akela-TapDance.h rename to src/Kaleidoscope-TapDance.h index eb3692a9..86b75142 100644 --- a/src/Akela-TapDance.h +++ b/src/Kaleidoscope-TapDance.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-TapDance -- Tap-dance 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/TapDance.cpp b/src/Kaleidoscope/TapDance.cpp similarity index 95% rename from src/Akela/TapDance.cpp rename to src/Kaleidoscope/TapDance.cpp index 45a2d79f..72edd3a3 100644 --- a/src/Akela/TapDance.cpp +++ b/src/Kaleidoscope/TapDance.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-TapDance -- Tap-dance 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 --- uint32_t TapDance::startTime; uint16_t TapDance::timeOut = 200; @@ -220,7 +220,7 @@ namespace Akela { __attribute__((weak)) void -tapDanceAction (uint8_t tapDanceIndex, byte row, byte col, uint8_t tapCount, Akela::TapDance::ActionType tapDanceAction) { +tapDanceAction (uint8_t tapDanceIndex, byte row, byte col, uint8_t tapCount, KaleidoscopePlugins::TapDance::ActionType tapDanceAction) { } -Akela::TapDance TapDance; +KaleidoscopePlugins::TapDance TapDance; diff --git a/src/Akela/TapDance.h b/src/Kaleidoscope/TapDance.h similarity index 83% rename from src/Akela/TapDance.h rename to src/Kaleidoscope/TapDance.h index 07dfb1ca..c813163b 100644 --- a/src/Akela/TapDance.h +++ b/src/Kaleidoscope/TapDance.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-TapDance -- Tap-dance keys * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -18,9 +18,10 @@ #pragma once -#include +#include +#include -#define TD(n) (Key){.raw = Akela::Ranges::TD_FIRST + n } +#define TD(n) (Key){.raw = KaleidoscopePlugins::Ranges::TD_FIRST + n } #define tapDanceActionKeys(tapCount, tapDanceAction, ...) ({ \ static const Key __k[] PROGMEM = { __VA_ARGS__ }; \ @@ -28,8 +29,8 @@ sizeof (__k) / sizeof (Key), &__k[0]); \ }) -namespace Akela { - class TapDance : public KeyboardioPlugin { +namespace KaleidoscopePlugins { + class TapDance : public KaleidoscopePlugin { public: typedef enum { Tap, @@ -65,6 +66,6 @@ namespace Akela { }; }; -void tapDanceAction (uint8_t tapDanceIndex, byte row, byte col, uint8_t tapCount, Akela::TapDance::ActionType tapDanceAction); +void tapDanceAction (uint8_t tapDanceIndex, byte row, byte col, uint8_t tapCount, KaleidoscopePlugins::TapDance::ActionType tapDanceAction); -extern Akela::TapDance TapDance; +extern KaleidoscopePlugins::TapDance TapDance; From 78e55c75aff132a46fdfbf358ed6644647c62806 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 21 Feb 2017 13:10:31 +0100 Subject: [PATCH 15/52] Improved timer handling Instead of calculating a time delta every time we want to check for a timeout, compute the projected end ahead of time. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/TapDance.cpp | 12 ++++++------ src/Kaleidoscope/TapDance.h | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/Kaleidoscope/TapDance.cpp b/src/Kaleidoscope/TapDance.cpp index 72edd3a3..b9df2143 100644 --- a/src/Kaleidoscope/TapDance.cpp +++ b/src/Kaleidoscope/TapDance.cpp @@ -22,7 +22,7 @@ using namespace KaleidoscopePlugins::Ranges; namespace KaleidoscopePlugins { // --- state --- - uint32_t TapDance::startTime; + uint32_t TapDance::endTime; uint16_t TapDance::timeOut = 200; uint8_t TapDance::tapCount[32]; uint32_t TapDance::pressedState; @@ -47,7 +47,7 @@ namespace KaleidoscopePlugins { tapDanceAction (idx, lastTapDanceRow, lastTapDanceCol, tapCount[idx], Interrupt); bitWrite (triggeredState, idx, 1); - startTime = millis (); + endTime = 0; if (bitRead (pressedState, idx)) return; @@ -59,7 +59,7 @@ namespace KaleidoscopePlugins { TapDance::timeout (void) { uint8_t idx = lastTapDanceKey.raw - TD_FIRST; - startTime = 0; + endTime = 0; tapDanceAction (idx, lastTapDanceRow, lastTapDanceCol, tapCount[idx], Timeout); bitWrite (triggeredState, idx, 1); @@ -76,7 +76,7 @@ namespace KaleidoscopePlugins { TapDance::release (uint8_t tapDanceIndex) { tapDanceAction (tapDanceIndex, lastTapDanceRow, lastTapDanceCol, tapCount[tapDanceIndex], Release); - startTime = 0; + endTime = 0; tapCount[tapDanceIndex] = 0; lastTapDanceKey.raw = Key_NoKey.raw; @@ -90,7 +90,7 @@ namespace KaleidoscopePlugins { uint8_t idx = lastTapDanceKey.raw - TD_FIRST; tapCount[idx]++; - startTime = millis (); + endTime = millis () + timeOut; tapDanceAction (idx, lastTapDanceRow, lastTapDanceCol, tapCount[idx], Tap); @@ -213,7 +213,7 @@ namespace KaleidoscopePlugins { if (!isActive ()) return; - if (startTime && (millis () - startTime) >= timeOut) + if (endTime && millis () > endTime) timeout(); } }; diff --git a/src/Kaleidoscope/TapDance.h b/src/Kaleidoscope/TapDance.h index c813163b..439abbca 100644 --- a/src/Kaleidoscope/TapDance.h +++ b/src/Kaleidoscope/TapDance.h @@ -48,7 +48,7 @@ namespace KaleidoscopePlugins { void actionKeys (uint8_t tapCount, ActionType tapDanceAction, uint8_t maxKeys, const Key tapKeys[]); private: - static uint32_t startTime; + static uint32_t endTime; static uint8_t tapCount[32]; static uint32_t pressedState; static uint32_t triggeredState; From e073402547227225448395ee1d2eec64f4e0db80 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Feb 2017 11:28:38 +0100 Subject: [PATCH 16/52] 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 68a0be9a..fc2831ab 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # Kaleidoscope-TapDance -![status][st:stable] +![status][st:stable] [![Build Status][travis:image]][travis:status] + + [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-TapDance.svg?branch=master + [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-TapDance [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 bab09065acc30c4d9701e2c373d38923234ecd6b Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 17 Mar 2017 15:41:45 +0100 Subject: [PATCH 17/52] Limit the number of tap-dance keys to 16 max Limiting the number of keys saves us 20 bytes of SRAM, and almost 200 bytes of program space, and 16 tap-dance keys are still plenty. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/TapDance.cpp | 6 +++--- src/Kaleidoscope/TapDance.h | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/Kaleidoscope/TapDance.cpp b/src/Kaleidoscope/TapDance.cpp index b9df2143..0a037e30 100644 --- a/src/Kaleidoscope/TapDance.cpp +++ b/src/Kaleidoscope/TapDance.cpp @@ -24,9 +24,9 @@ namespace KaleidoscopePlugins { // --- state --- uint32_t TapDance::endTime; uint16_t TapDance::timeOut = 200; - uint8_t TapDance::tapCount[32]; - uint32_t TapDance::pressedState; - uint32_t TapDance::triggeredState; + uint8_t TapDance::tapCount[16]; + uint16_t TapDance::pressedState; + uint16_t TapDance::triggeredState; Key TapDance::lastTapDanceKey; byte TapDance::lastTapDanceRow; byte TapDance::lastTapDanceCol; diff --git a/src/Kaleidoscope/TapDance.h b/src/Kaleidoscope/TapDance.h index 439abbca..d545065d 100644 --- a/src/Kaleidoscope/TapDance.h +++ b/src/Kaleidoscope/TapDance.h @@ -49,9 +49,9 @@ namespace KaleidoscopePlugins { private: static uint32_t endTime; - static uint8_t tapCount[32]; - static uint32_t pressedState; - static uint32_t triggeredState; + static uint8_t tapCount[16]; + static uint16_t pressedState; + static uint16_t triggeredState; static Key lastTapDanceKey; static byte lastTapDanceRow; static byte lastTapDanceCol; From 51f0e4bcd6ab0f06781b2c7a8ca53768320aab40 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 18 Mar 2017 00:03:47 +0100 Subject: [PATCH 18/52] timeout: Do not clear the timer When timing out, we should not clear the timer, because then we'll fail to reset the tapCount later, too. Fixes #8. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/TapDance.cpp | 2 -- 1 file changed, 2 deletions(-) diff --git a/src/Kaleidoscope/TapDance.cpp b/src/Kaleidoscope/TapDance.cpp index 0a037e30..b9793bb3 100644 --- a/src/Kaleidoscope/TapDance.cpp +++ b/src/Kaleidoscope/TapDance.cpp @@ -59,8 +59,6 @@ namespace KaleidoscopePlugins { TapDance::timeout (void) { uint8_t idx = lastTapDanceKey.raw - TD_FIRST; - endTime = 0; - tapDanceAction (idx, lastTapDanceRow, lastTapDanceCol, tapCount[idx], Timeout); bitWrite (triggeredState, idx, 1); From f184177ec3e331e19f0c6bc6626a2365c44c1064 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 18 Mar 2017 00:23:56 +0100 Subject: [PATCH 19/52] Instead of releasing immediately, delay it until loop() When releasing immediately, other keys that may affect us (such as Shift) may not be handled yet. So lets wait with the release until the next loop. Addresses #6, at least partially. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/TapDance.cpp | 14 +++++++++++--- src/Kaleidoscope/TapDance.h | 1 + 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/src/Kaleidoscope/TapDance.cpp b/src/Kaleidoscope/TapDance.cpp index b9793bb3..157a5116 100644 --- a/src/Kaleidoscope/TapDance.cpp +++ b/src/Kaleidoscope/TapDance.cpp @@ -27,6 +27,7 @@ namespace KaleidoscopePlugins { uint8_t TapDance::tapCount[16]; uint16_t TapDance::pressedState; uint16_t TapDance::triggeredState; + uint16_t TapDance::releaseNextState; Key TapDance::lastTapDanceKey; byte TapDance::lastTapDanceRow; byte TapDance::lastTapDanceCol; @@ -72,14 +73,12 @@ namespace KaleidoscopePlugins { Key TapDance::release (uint8_t tapDanceIndex) { - tapDanceAction (tapDanceIndex, lastTapDanceRow, lastTapDanceCol, tapCount[tapDanceIndex], Release); - endTime = 0; - tapCount[tapDanceIndex] = 0; lastTapDanceKey.raw = Key_NoKey.raw; bitClear (pressedState, tapDanceIndex); bitClear (triggeredState, tapDanceIndex); + bitWrite (releaseNextState, tapDanceIndex, 1); return Key_NoKey; } @@ -208,6 +207,15 @@ namespace KaleidoscopePlugins { if (!postClear) return; + for (uint8_t i = 0; i < 16; i++) { + if (!bitRead (releaseNextState, i)) + continue; + + tapDanceAction (i, lastTapDanceRow, lastTapDanceCol, tapCount[i], Release); + tapCount[i] = 0; + bitClear (releaseNextState, i); + } + if (!isActive ()) return; diff --git a/src/Kaleidoscope/TapDance.h b/src/Kaleidoscope/TapDance.h index d545065d..e7545c4b 100644 --- a/src/Kaleidoscope/TapDance.h +++ b/src/Kaleidoscope/TapDance.h @@ -52,6 +52,7 @@ namespace KaleidoscopePlugins { static uint8_t tapCount[16]; static uint16_t pressedState; static uint16_t triggeredState; + static uint16_t releaseNextState; static Key lastTapDanceKey; static byte lastTapDanceRow; static byte lastTapDanceCol; From 1699ef4e7e59167504e681baafad5396af64c4b0 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 20 Mar 2017 12:54:19 +0100 Subject: [PATCH 20/52] 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 fc2831ab..caa41856 100644 --- a/README.md +++ b/README.md @@ -144,6 +144,10 @@ method only: > perform. The `row` and `col` parameters tell us where the tap-dance key is on > the keyboard. +## Dependencies + +* [Kaleidoscope-Ranges](https://github.com/keyboardio/Kaleidoscope-Ranges) + ## Further reading Starting from the [example][plugin:example] is the recommended way of getting From 37fa269ecb10a32008979a219f0b98554d2e3525 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 27 Mar 2017 15:39:46 -0700 Subject: [PATCH 21/52] Update to new handle_keyswitch_event API naming --- src/Kaleidoscope/TapDance.cpp | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/Kaleidoscope/TapDance.cpp b/src/Kaleidoscope/TapDance.cpp index 157a5116..22f35951 100644 --- a/src/Kaleidoscope/TapDance.cpp +++ b/src/Kaleidoscope/TapDance.cpp @@ -119,14 +119,14 @@ namespace KaleidoscopePlugins { break; case Interrupt: case Timeout: - handle_key_event (key, lastTapDanceRow, lastTapDanceCol, IS_PRESSED | INJECTED); + handle_keyswitch_event (key, lastTapDanceRow, lastTapDanceCol, IS_PRESSED | INJECTED); break; case Hold: - handle_key_event (key, lastTapDanceRow, lastTapDanceCol, IS_PRESSED | WAS_PRESSED | INJECTED); + handle_keyswitch_event (key, lastTapDanceRow, lastTapDanceCol, IS_PRESSED | WAS_PRESSED | INJECTED); break; case Release: Keyboard.sendReport (); - handle_key_event (key, lastTapDanceRow, lastTapDanceCol, WAS_PRESSED | INJECTED); + handle_keyswitch_event (key, lastTapDanceRow, lastTapDanceCol, WAS_PRESSED | INJECTED); break; } } From 18aa5eadabde2453e78dc56ccec5cf905e4d9f2c Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 22 May 2017 00:50:48 -0700 Subject: [PATCH 22/52] Update to new Key names --- examples/TapDance/TapDance.ino | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/examples/TapDance/TapDance.ino b/examples/TapDance/TapDance.ino index 0b62b750..48132506 100644 --- a/examples/TapDance/TapDance.ino +++ b/examples/TapDance/TapDance.ino @@ -25,9 +25,9 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, - Key_PageDn, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Esc, + Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, - Key_LCtrl, Key_Backspace, Key_LGUI, Key_LShift, + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, TD(0), Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, @@ -35,7 +35,7 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, - Key_RShift, Key_RAlt, Key_Space, Key_RCtrl, + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, TD(1) ), }; @@ -47,7 +47,7 @@ static void tapDanceEsc (uint8_t tapDanceIndex, uint8_t tapCount, KaleidoscopePl void tapDanceAction (uint8_t tapDanceIndex, byte row, byte col, uint8_t tapCount, KaleidoscopePlugins::TapDance::ActionType tapDanceAction) { switch (tapDanceIndex) { case 0: - return tapDanceActionKeys (tapCount, tapDanceAction, Key_Tab, Key_Esc); + return tapDanceActionKeys (tapCount, tapDanceAction, Key_Tab, Key_Escape); case 1: return tapDanceEsc (tapDanceIndex, tapCount, tapDanceAction); } From 4b7091a87f1243b0562f0a18db05f84def34324c Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 22 May 2017 01:05:03 -0700 Subject: [PATCH 23/52] KEymap update --- examples/TapDance/TapDance.ino | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/TapDance/TapDance.ino b/examples/TapDance/TapDance.ino index 48132506..4d9451f8 100644 --- a/examples/TapDance/TapDance.ino +++ b/examples/TapDance/TapDance.ino @@ -41,7 +41,7 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { }; static void tapDanceEsc (uint8_t tapDanceIndex, uint8_t tapCount, KaleidoscopePlugins::TapDance::ActionType tapDanceAction) { - tapDanceActionKeys (tapCount, tapDanceAction, Key_Esc, Key_Tab); + tapDanceActionKeys (tapCount, tapDanceAction, Key_Escape, Key_Tab); } void tapDanceAction (uint8_t tapDanceIndex, byte row, byte col, uint8_t tapCount, KaleidoscopePlugins::TapDance::ActionType tapDanceAction) { From ae3b49d01e4ef73c5bae01c52868570fa1d633c9 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 23 May 2017 20:16:11 -0700 Subject: [PATCH 24/52] 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 ad09f54c0de1852c1dd023c574a3ddbe742ae006 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Fri, 26 May 2017 16:20:23 -0700 Subject: [PATCH 25/52] make astyle --- examples/TapDance/TapDance.ino | 56 +++++----- src/Kaleidoscope/TapDance.cpp | 186 ++++++++++++++++----------------- src/Kaleidoscope/TapDance.h | 14 +-- 3 files changed, 128 insertions(+), 128 deletions(-) diff --git a/examples/TapDance/TapDance.ino b/examples/TapDance/TapDance.ino index 4d9451f8..1c25a477 100644 --- a/examples/TapDance/TapDance.ino +++ b/examples/TapDance/TapDance.ino @@ -20,44 +20,44 @@ #include const Key keymaps[][ROWS][COLS] PROGMEM = { - [0] = KEYMAP_STACKED - ( - Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, - Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, - Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, - Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, - - Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, - TD(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_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, - TD(1) - ), + [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, + TD(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_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, + TD(1) + ), }; static void tapDanceEsc (uint8_t tapDanceIndex, uint8_t tapCount, KaleidoscopePlugins::TapDance::ActionType tapDanceAction) { - tapDanceActionKeys (tapCount, tapDanceAction, Key_Escape, Key_Tab); + tapDanceActionKeys (tapCount, tapDanceAction, Key_Escape, Key_Tab); } void tapDanceAction (uint8_t tapDanceIndex, byte row, byte col, uint8_t tapCount, KaleidoscopePlugins::TapDance::ActionType tapDanceAction) { - switch (tapDanceIndex) { - case 0: - return tapDanceActionKeys (tapCount, tapDanceAction, Key_Tab, Key_Escape); - case 1: - return tapDanceEsc (tapDanceIndex, tapCount, tapDanceAction); - } + switch (tapDanceIndex) { + case 0: + return tapDanceActionKeys (tapCount, tapDanceAction, Key_Tab, Key_Escape); + case 1: + return tapDanceEsc (tapDanceIndex, tapCount, tapDanceAction); + } } void setup () { - Kaleidoscope.setup (KEYMAP_SIZE); - Kaleidoscope.use (&TapDance, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&TapDance, NULL); } void loop () { - Kaleidoscope.loop (); + Kaleidoscope.loop (); } diff --git a/src/Kaleidoscope/TapDance.cpp b/src/Kaleidoscope/TapDance.cpp index 22f35951..76518fce 100644 --- a/src/Kaleidoscope/TapDance.cpp +++ b/src/Kaleidoscope/TapDance.cpp @@ -21,28 +21,28 @@ using namespace KaleidoscopePlugins::Ranges; namespace KaleidoscopePlugins { - // --- state --- - uint32_t TapDance::endTime; - uint16_t TapDance::timeOut = 200; - uint8_t TapDance::tapCount[16]; - uint16_t TapDance::pressedState; - uint16_t TapDance::triggeredState; - uint16_t TapDance::releaseNextState; - Key TapDance::lastTapDanceKey; - byte TapDance::lastTapDanceRow; - byte TapDance::lastTapDanceCol; - - // --- helpers --- +// --- state --- +uint32_t TapDance::endTime; +uint16_t TapDance::timeOut = 200; +uint8_t TapDance::tapCount[16]; +uint16_t TapDance::pressedState; +uint16_t TapDance::triggeredState; +uint16_t TapDance::releaseNextState; +Key TapDance::lastTapDanceKey; +byte TapDance::lastTapDanceRow; +byte TapDance::lastTapDanceCol; + +// --- helpers --- #define isTapDance(k) (k.raw >= TD_FIRST && k.raw <= TD_LAST) #define isInSeq(k) (lastTapDanceKey.raw == k.raw) #define stillHeld(idx) (tapCount[idx]) #define isActive() (lastTapDanceKey.raw != Key_NoKey.raw) - // --- actions --- +// --- actions --- - void - TapDance::interrupt (void) { +void +TapDance::interrupt (void) { uint8_t idx = lastTapDanceKey.raw - TD_FIRST; tapDanceAction (idx, lastTapDanceRow, lastTapDanceCol, tapCount[idx], Interrupt); @@ -51,28 +51,28 @@ namespace KaleidoscopePlugins { endTime = 0; if (bitRead (pressedState, idx)) - return; + return; release (idx); - } +} - void - TapDance::timeout (void) { +void +TapDance::timeout (void) { uint8_t idx = lastTapDanceKey.raw - TD_FIRST; tapDanceAction (idx, lastTapDanceRow, lastTapDanceCol, tapCount[idx], Timeout); bitWrite (triggeredState, idx, 1); if (bitRead (pressedState, idx)) - return; + return; lastTapDanceKey.raw = Key_NoKey.raw; release (idx); - } +} - Key - TapDance::release (uint8_t tapDanceIndex) { +Key +TapDance::release (uint8_t tapDanceIndex) { endTime = 0; lastTapDanceKey.raw = Key_NoKey.raw; @@ -80,10 +80,10 @@ namespace KaleidoscopePlugins { bitClear (triggeredState, tapDanceIndex); bitWrite (releaseNextState, tapDanceIndex, 1); return Key_NoKey; - } +} - Key - TapDance::tap (void) { +Key +TapDance::tap (void) { uint8_t idx = lastTapDanceKey.raw - TD_FIRST; tapCount[idx]++; @@ -92,101 +92,101 @@ namespace KaleidoscopePlugins { tapDanceAction (idx, lastTapDanceRow, lastTapDanceCol, tapCount[idx], Tap); return Key_NoKey; - } +} - // --- api --- +// --- api --- - TapDance::TapDance (void) { +TapDance::TapDance (void) { lastTapDanceKey.raw = Key_NoKey.raw; - } +} - void - TapDance::begin (void) { +void +TapDance::begin (void) { event_handler_hook_use (this->eventHandlerHook); loop_hook_use (this->loopHook); - } +} - void - TapDance::actionKeys (uint8_t tapCount, ActionType tapDanceAction, uint8_t maxKeys, const Key tapKeys[]) { +void +TapDance::actionKeys (uint8_t tapCount, ActionType tapDanceAction, uint8_t maxKeys, const Key tapKeys[]) { if (tapCount > maxKeys) - tapCount = maxKeys; + tapCount = maxKeys; Key key; key.raw = pgm_read_word (&(tapKeys[tapCount - 1].raw)); switch (tapDanceAction) { case Tap: - break; + break; case Interrupt: case Timeout: - handle_keyswitch_event (key, lastTapDanceRow, lastTapDanceCol, IS_PRESSED | INJECTED); - break; + handle_keyswitch_event (key, lastTapDanceRow, lastTapDanceCol, IS_PRESSED | INJECTED); + break; case Hold: - handle_keyswitch_event (key, lastTapDanceRow, lastTapDanceCol, IS_PRESSED | WAS_PRESSED | INJECTED); - break; + handle_keyswitch_event (key, lastTapDanceRow, lastTapDanceCol, IS_PRESSED | WAS_PRESSED | INJECTED); + break; case Release: - Keyboard.sendReport (); - handle_keyswitch_event (key, lastTapDanceRow, lastTapDanceCol, WAS_PRESSED | INJECTED); - break; + Keyboard.sendReport (); + handle_keyswitch_event (key, lastTapDanceRow, lastTapDanceCol, WAS_PRESSED | INJECTED); + break; } - } +} - // --- hooks --- +// --- hooks --- - Key - TapDance::eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState) { +Key +TapDance::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 (isTapDance (mappedKey)) - return Key_NoKey; - return mappedKey; + if (isTapDance (mappedKey)) + return Key_NoKey; + return mappedKey; } if (!isTapDance (mappedKey)) { - if (!isActive ()) - return mappedKey; + if (!isActive ()) + return mappedKey; - if (key_toggled_on (keyState)) - interrupt (); + if (key_toggled_on (keyState)) + interrupt (); - return mappedKey; + return mappedKey; } uint8_t tapDanceIndex = mappedKey.raw - TD_FIRST; if (key_toggled_off (keyState)) - bitClear (pressedState, tapDanceIndex); + bitClear (pressedState, tapDanceIndex); if (!isInSeq (mappedKey)) { - if (!isActive ()) { - if (bitRead (triggeredState, tapDanceIndex)) { - if (key_toggled_off (keyState)) - return release (tapDanceIndex); - return Key_NoKey; + if (!isActive ()) { + if (bitRead (triggeredState, tapDanceIndex)) { + if (key_toggled_off (keyState)) + return release (tapDanceIndex); + return Key_NoKey; + } + + lastTapDanceKey.raw = mappedKey.raw; + lastTapDanceRow = row; + lastTapDanceCol = col; + return tap (); + } else { + if (key_toggled_off (keyState) && stillHeld (tapDanceIndex)) { + return release (tapDanceIndex); + } + + if (!key_toggled_on (keyState)) + return Key_NoKey; + + interrupt (); } - - lastTapDanceKey.raw = mappedKey.raw; - lastTapDanceRow = row; - lastTapDanceCol = col; - return tap (); - } else { - if (key_toggled_off (keyState) && stillHeld (tapDanceIndex)) { - return release (tapDanceIndex); - } - - if (!key_toggled_on (keyState)) - return Key_NoKey; - - interrupt (); - } } // in sequence if (key_toggled_off (keyState)) - return Key_NoKey; + return Key_NoKey; lastTapDanceKey.raw = mappedKey.raw; lastTapDanceRow = row; @@ -194,34 +194,34 @@ namespace KaleidoscopePlugins { bitSet (pressedState, tapDanceIndex); if (key_toggled_on (keyState)) - return tap (); + return tap (); if (bitRead (triggeredState, tapDanceIndex)) - tapDanceAction (tapDanceIndex, row, col, tapCount[tapDanceIndex], Hold); + tapDanceAction (tapDanceIndex, row, col, tapCount[tapDanceIndex], Hold); return Key_NoKey; - } +} - void - TapDance::loopHook (bool postClear) { +void +TapDance::loopHook (bool postClear) { if (!postClear) - return; + return; for (uint8_t i = 0; i < 16; i++) { - if (!bitRead (releaseNextState, i)) - continue; + if (!bitRead (releaseNextState, i)) + continue; - tapDanceAction (i, lastTapDanceRow, lastTapDanceCol, tapCount[i], Release); - tapCount[i] = 0; - bitClear (releaseNextState, i); + tapDanceAction (i, lastTapDanceRow, lastTapDanceCol, tapCount[i], Release); + tapCount[i] = 0; + bitClear (releaseNextState, i); } if (!isActive ()) - return; + return; if (endTime && millis () > endTime) - timeout(); - } + timeout(); +} }; __attribute__((weak)) diff --git a/src/Kaleidoscope/TapDance.h b/src/Kaleidoscope/TapDance.h index e7545c4b..4d1d0268 100644 --- a/src/Kaleidoscope/TapDance.h +++ b/src/Kaleidoscope/TapDance.h @@ -30,14 +30,14 @@ }) namespace KaleidoscopePlugins { - class TapDance : public KaleidoscopePlugin { +class TapDance : public KaleidoscopePlugin { public: typedef enum { - Tap, - Hold, - Interrupt, - Timeout, - Release, + Tap, + Hold, + Interrupt, + Timeout, + Release, } ActionType; TapDance (void); @@ -64,7 +64,7 @@ namespace KaleidoscopePlugins { static void interrupt (void); static void timeout (void); static Key release (uint8_t tapDanceIndex); - }; +}; }; void tapDanceAction (uint8_t tapDanceIndex, byte row, byte col, uint8_t tapCount, KaleidoscopePlugins::TapDance::ActionType tapDanceAction); From 1d8c3040f1a926d7432510159c2814c104a09279 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Fri, 2 Jun 2017 23:01:04 -0700 Subject: [PATCH 26/52] Fix issues found by the linter. --- src/Kaleidoscope/TapDance.cpp | 4 ++-- src/Kaleidoscope/TapDance.h | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/Kaleidoscope/TapDance.cpp b/src/Kaleidoscope/TapDance.cpp index 76518fce..9716f9b2 100644 --- a/src/Kaleidoscope/TapDance.cpp +++ b/src/Kaleidoscope/TapDance.cpp @@ -18,7 +18,7 @@ #include -using namespace KaleidoscopePlugins::Ranges; +using KaleidoscopePlugins::Ranges; namespace KaleidoscopePlugins { // --- state --- @@ -222,7 +222,7 @@ TapDance::loopHook (bool postClear) { if (endTime && millis () > endTime) timeout(); } -}; +} // namespace KaleidoscopePlugins __attribute__((weak)) void diff --git a/src/Kaleidoscope/TapDance.h b/src/Kaleidoscope/TapDance.h index 4d1d0268..60cf8925 100644 --- a/src/Kaleidoscope/TapDance.h +++ b/src/Kaleidoscope/TapDance.h @@ -42,7 +42,7 @@ class TapDance : public KaleidoscopePlugin { TapDance (void); - virtual void begin (void) final; + void begin (void) final; static uint16_t timeOut; void actionKeys (uint8_t tapCount, ActionType tapDanceAction, uint8_t maxKeys, const Key tapKeys[]); @@ -64,8 +64,8 @@ class TapDance : public KaleidoscopePlugin { static void interrupt (void); static void timeout (void); static Key release (uint8_t tapDanceIndex); -}; -}; +} +} // namespace KaleidoscopePlugins void tapDanceAction (uint8_t tapDanceIndex, byte row, byte col, uint8_t tapCount, KaleidoscopePlugins::TapDance::ActionType tapDanceAction); From 3f78f201257bbd348a36f3e1531f1bed708c9a78 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 3 Jun 2017 12:01:51 +0200 Subject: [PATCH 27/52] Make things compile again This is just a quick fix, to make things compile. No style guide conformance yet. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/TapDance.cpp | 12 +++++------- src/Kaleidoscope/TapDance.h | 2 +- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/src/Kaleidoscope/TapDance.cpp b/src/Kaleidoscope/TapDance.cpp index 9716f9b2..0386ba72 100644 --- a/src/Kaleidoscope/TapDance.cpp +++ b/src/Kaleidoscope/TapDance.cpp @@ -18,8 +18,6 @@ #include -using KaleidoscopePlugins::Ranges; - namespace KaleidoscopePlugins { // --- state --- uint32_t TapDance::endTime; @@ -34,7 +32,7 @@ byte TapDance::lastTapDanceCol; // --- helpers --- -#define isTapDance(k) (k.raw >= TD_FIRST && k.raw <= TD_LAST) +#define isTapDance(k) (k.raw >= Ranges::TD_FIRST && k.raw <= Ranges::TD_LAST) #define isInSeq(k) (lastTapDanceKey.raw == k.raw) #define stillHeld(idx) (tapCount[idx]) #define isActive() (lastTapDanceKey.raw != Key_NoKey.raw) @@ -43,7 +41,7 @@ byte TapDance::lastTapDanceCol; void TapDance::interrupt (void) { - uint8_t idx = lastTapDanceKey.raw - TD_FIRST; + uint8_t idx = lastTapDanceKey.raw - Ranges::TD_FIRST; tapDanceAction (idx, lastTapDanceRow, lastTapDanceCol, tapCount[idx], Interrupt); bitWrite (triggeredState, idx, 1); @@ -58,7 +56,7 @@ TapDance::interrupt (void) { void TapDance::timeout (void) { - uint8_t idx = lastTapDanceKey.raw - TD_FIRST; + uint8_t idx = lastTapDanceKey.raw - Ranges::TD_FIRST; tapDanceAction (idx, lastTapDanceRow, lastTapDanceCol, tapCount[idx], Timeout); bitWrite (triggeredState, idx, 1); @@ -84,7 +82,7 @@ TapDance::release (uint8_t tapDanceIndex) { Key TapDance::tap (void) { - uint8_t idx = lastTapDanceKey.raw - TD_FIRST; + uint8_t idx = lastTapDanceKey.raw - Ranges::TD_FIRST; tapCount[idx]++; endTime = millis () + timeOut; @@ -154,7 +152,7 @@ TapDance::eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState) return mappedKey; } - uint8_t tapDanceIndex = mappedKey.raw - TD_FIRST; + uint8_t tapDanceIndex = mappedKey.raw - Ranges::TD_FIRST; if (key_toggled_off (keyState)) bitClear (pressedState, tapDanceIndex); diff --git a/src/Kaleidoscope/TapDance.h b/src/Kaleidoscope/TapDance.h index 60cf8925..52af9dfe 100644 --- a/src/Kaleidoscope/TapDance.h +++ b/src/Kaleidoscope/TapDance.h @@ -64,7 +64,7 @@ class TapDance : public KaleidoscopePlugin { static void interrupt (void); static void timeout (void); static Key release (uint8_t tapDanceIndex); -} +}; } // namespace KaleidoscopePlugins void tapDanceAction (uint8_t tapDanceIndex, byte row, byte col, uint8_t tapCount, KaleidoscopePlugins::TapDance::ActionType tapDanceAction); From a6983c5c4d25b1e4feedfca6e6f76f61c204aef9 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Sat, 3 Jun 2017 22:45:45 -0700 Subject: [PATCH 28/52] astyle with current project style guidelines --- examples/TapDance/TapDance.ino | 64 ++++----- src/Kaleidoscope/TapDance.cpp | 254 ++++++++++++++++----------------- src/Kaleidoscope/TapDance.h | 56 ++++---- 3 files changed, 187 insertions(+), 187 deletions(-) diff --git a/examples/TapDance/TapDance.ino b/examples/TapDance/TapDance.ino index 1c25a477..1835a3c6 100644 --- a/examples/TapDance/TapDance.ino +++ b/examples/TapDance/TapDance.ino @@ -20,44 +20,44 @@ #include const Key keymaps[][ROWS][COLS] PROGMEM = { - [0] = KEYMAP_STACKED - ( - Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, - Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, - Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, - Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, - - Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, - TD(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_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, - TD(1) - ), + [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, + TD(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_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, + TD(1) + ), }; -static void tapDanceEsc (uint8_t tapDanceIndex, uint8_t tapCount, KaleidoscopePlugins::TapDance::ActionType tapDanceAction) { - tapDanceActionKeys (tapCount, tapDanceAction, Key_Escape, Key_Tab); +static void tapDanceEsc(uint8_t tapDanceIndex, uint8_t tapCount, KaleidoscopePlugins::TapDance::ActionType tapDanceAction) { + tapDanceActionKeys(tapCount, tapDanceAction, Key_Escape, Key_Tab); } -void tapDanceAction (uint8_t tapDanceIndex, byte row, byte col, uint8_t tapCount, KaleidoscopePlugins::TapDance::ActionType tapDanceAction) { - switch (tapDanceIndex) { - case 0: - return tapDanceActionKeys (tapCount, tapDanceAction, Key_Tab, Key_Escape); - case 1: - return tapDanceEsc (tapDanceIndex, tapCount, tapDanceAction); - } +void tapDanceAction(uint8_t tapDanceIndex, byte row, byte col, uint8_t tapCount, KaleidoscopePlugins::TapDance::ActionType tapDanceAction) { + switch (tapDanceIndex) { + case 0: + return tapDanceActionKeys(tapCount, tapDanceAction, Key_Tab, Key_Escape); + case 1: + return tapDanceEsc(tapDanceIndex, tapCount, tapDanceAction); + } } -void setup () { - Kaleidoscope.setup (KEYMAP_SIZE); - Kaleidoscope.use (&TapDance, NULL); +void setup() { + Kaleidoscope.setup(KEYMAP_SIZE); + Kaleidoscope.use(&TapDance, NULL); } -void loop () { - Kaleidoscope.loop (); +void loop() { + Kaleidoscope.loop(); } diff --git a/src/Kaleidoscope/TapDance.cpp b/src/Kaleidoscope/TapDance.cpp index 0386ba72..d0329a84 100644 --- a/src/Kaleidoscope/TapDance.cpp +++ b/src/Kaleidoscope/TapDance.cpp @@ -40,191 +40,191 @@ byte TapDance::lastTapDanceCol; // --- actions --- void -TapDance::interrupt (void) { - uint8_t idx = lastTapDanceKey.raw - Ranges::TD_FIRST; +TapDance::interrupt(void) { + uint8_t idx = lastTapDanceKey.raw - Ranges::TD_FIRST; - tapDanceAction (idx, lastTapDanceRow, lastTapDanceCol, tapCount[idx], Interrupt); - bitWrite (triggeredState, idx, 1); + tapDanceAction(idx, lastTapDanceRow, lastTapDanceCol, tapCount[idx], Interrupt); + bitWrite(triggeredState, idx, 1); - endTime = 0; + endTime = 0; - if (bitRead (pressedState, idx)) - return; + if (bitRead(pressedState, idx)) + return; - release (idx); + release(idx); } void -TapDance::timeout (void) { - uint8_t idx = lastTapDanceKey.raw - Ranges::TD_FIRST; +TapDance::timeout(void) { + uint8_t idx = lastTapDanceKey.raw - Ranges::TD_FIRST; - tapDanceAction (idx, lastTapDanceRow, lastTapDanceCol, tapCount[idx], Timeout); - bitWrite (triggeredState, idx, 1); + tapDanceAction(idx, lastTapDanceRow, lastTapDanceCol, tapCount[idx], Timeout); + bitWrite(triggeredState, idx, 1); - if (bitRead (pressedState, idx)) - return; + if (bitRead(pressedState, idx)) + return; - lastTapDanceKey.raw = Key_NoKey.raw; + lastTapDanceKey.raw = Key_NoKey.raw; - release (idx); + release(idx); } Key -TapDance::release (uint8_t tapDanceIndex) { - endTime = 0; - lastTapDanceKey.raw = Key_NoKey.raw; - - bitClear (pressedState, tapDanceIndex); - bitClear (triggeredState, tapDanceIndex); - bitWrite (releaseNextState, tapDanceIndex, 1); - return Key_NoKey; +TapDance::release(uint8_t tapDanceIndex) { + endTime = 0; + lastTapDanceKey.raw = Key_NoKey.raw; + + bitClear(pressedState, tapDanceIndex); + bitClear(triggeredState, tapDanceIndex); + bitWrite(releaseNextState, tapDanceIndex, 1); + return Key_NoKey; } Key -TapDance::tap (void) { - uint8_t idx = lastTapDanceKey.raw - Ranges::TD_FIRST; +TapDance::tap(void) { + uint8_t idx = lastTapDanceKey.raw - Ranges::TD_FIRST; - tapCount[idx]++; - endTime = millis () + timeOut; + tapCount[idx]++; + endTime = millis() + timeOut; - tapDanceAction (idx, lastTapDanceRow, lastTapDanceCol, tapCount[idx], Tap); + tapDanceAction(idx, lastTapDanceRow, lastTapDanceCol, tapCount[idx], Tap); - return Key_NoKey; + return Key_NoKey; } // --- api --- -TapDance::TapDance (void) { - lastTapDanceKey.raw = Key_NoKey.raw; +TapDance::TapDance(void) { + lastTapDanceKey.raw = Key_NoKey.raw; } void -TapDance::begin (void) { - event_handler_hook_use (this->eventHandlerHook); - loop_hook_use (this->loopHook); +TapDance::begin(void) { + event_handler_hook_use(this->eventHandlerHook); + loop_hook_use(this->loopHook); } void -TapDance::actionKeys (uint8_t tapCount, ActionType tapDanceAction, uint8_t maxKeys, const Key tapKeys[]) { - if (tapCount > maxKeys) - tapCount = maxKeys; - - Key key; - key.raw = pgm_read_word (&(tapKeys[tapCount - 1].raw)); - - switch (tapDanceAction) { - case Tap: - break; - case Interrupt: - case Timeout: - handle_keyswitch_event (key, lastTapDanceRow, lastTapDanceCol, IS_PRESSED | INJECTED); - break; - case Hold: - handle_keyswitch_event (key, lastTapDanceRow, lastTapDanceCol, IS_PRESSED | WAS_PRESSED | INJECTED); - break; - case Release: - Keyboard.sendReport (); - handle_keyswitch_event (key, lastTapDanceRow, lastTapDanceCol, WAS_PRESSED | INJECTED); - break; - } +TapDance::actionKeys(uint8_t tapCount, ActionType tapDanceAction, uint8_t maxKeys, const Key tapKeys[]) { + if (tapCount > maxKeys) + tapCount = maxKeys; + + Key key; + key.raw = pgm_read_word(&(tapKeys[tapCount - 1].raw)); + + switch (tapDanceAction) { + case Tap: + break; + case Interrupt: + case Timeout: + handle_keyswitch_event(key, lastTapDanceRow, lastTapDanceCol, IS_PRESSED | INJECTED); + break; + case Hold: + handle_keyswitch_event(key, lastTapDanceRow, lastTapDanceCol, IS_PRESSED | WAS_PRESSED | INJECTED); + break; + case Release: + Keyboard.sendReport(); + handle_keyswitch_event(key, lastTapDanceRow, lastTapDanceCol, WAS_PRESSED | INJECTED); + break; + } } // --- hooks --- Key -TapDance::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 (isTapDance (mappedKey)) - return Key_NoKey; - return mappedKey; - } +TapDance::eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keyState) { + if (keyState & INJECTED) + return mappedKey; - if (!isTapDance (mappedKey)) { - if (!isActive ()) - return mappedKey; + if (!key_is_pressed(keyState) && !key_was_pressed(keyState)) { + if (isTapDance(mappedKey)) + return Key_NoKey; + return mappedKey; + } - if (key_toggled_on (keyState)) - interrupt (); + if (!isTapDance(mappedKey)) { + if (!isActive()) + return mappedKey; - return mappedKey; - } + if (key_toggled_on(keyState)) + interrupt(); - uint8_t tapDanceIndex = mappedKey.raw - Ranges::TD_FIRST; - - if (key_toggled_off (keyState)) - bitClear (pressedState, tapDanceIndex); - - if (!isInSeq (mappedKey)) { - if (!isActive ()) { - if (bitRead (triggeredState, tapDanceIndex)) { - if (key_toggled_off (keyState)) - return release (tapDanceIndex); - return Key_NoKey; - } - - lastTapDanceKey.raw = mappedKey.raw; - lastTapDanceRow = row; - lastTapDanceCol = col; - return tap (); - } else { - if (key_toggled_off (keyState) && stillHeld (tapDanceIndex)) { - return release (tapDanceIndex); - } - - if (!key_toggled_on (keyState)) - return Key_NoKey; - - interrupt (); - } - } + return mappedKey; + } - // in sequence + uint8_t tapDanceIndex = mappedKey.raw - Ranges::TD_FIRST; - if (key_toggled_off (keyState)) - return Key_NoKey; + if (key_toggled_off(keyState)) + bitClear(pressedState, tapDanceIndex); - lastTapDanceKey.raw = mappedKey.raw; - lastTapDanceRow = row; - lastTapDanceCol = col; - bitSet (pressedState, tapDanceIndex); + if (!isInSeq(mappedKey)) { + if (!isActive()) { + if (bitRead(triggeredState, tapDanceIndex)) { + if (key_toggled_off(keyState)) + return release(tapDanceIndex); + return Key_NoKey; + } + + lastTapDanceKey.raw = mappedKey.raw; + lastTapDanceRow = row; + lastTapDanceCol = col; + return tap(); + } else { + if (key_toggled_off(keyState) && stillHeld(tapDanceIndex)) { + return release(tapDanceIndex); + } + + if (!key_toggled_on(keyState)) + return Key_NoKey; - if (key_toggled_on (keyState)) - return tap (); + interrupt(); + } + } - if (bitRead (triggeredState, tapDanceIndex)) - tapDanceAction (tapDanceIndex, row, col, tapCount[tapDanceIndex], Hold); + // in sequence + if (key_toggled_off(keyState)) return Key_NoKey; + + lastTapDanceKey.raw = mappedKey.raw; + lastTapDanceRow = row; + lastTapDanceCol = col; + bitSet(pressedState, tapDanceIndex); + + if (key_toggled_on(keyState)) + return tap(); + + if (bitRead(triggeredState, tapDanceIndex)) + tapDanceAction(tapDanceIndex, row, col, tapCount[tapDanceIndex], Hold); + + return Key_NoKey; } void -TapDance::loopHook (bool postClear) { - if (!postClear) - return; +TapDance::loopHook(bool postClear) { + if (!postClear) + return; - for (uint8_t i = 0; i < 16; i++) { - if (!bitRead (releaseNextState, i)) - continue; + for (uint8_t i = 0; i < 16; i++) { + if (!bitRead(releaseNextState, i)) + continue; - tapDanceAction (i, lastTapDanceRow, lastTapDanceCol, tapCount[i], Release); - tapCount[i] = 0; - bitClear (releaseNextState, i); - } + tapDanceAction(i, lastTapDanceRow, lastTapDanceCol, tapCount[i], Release); + tapCount[i] = 0; + bitClear(releaseNextState, i); + } - if (!isActive ()) - return; + if (!isActive()) + return; - if (endTime && millis () > endTime) - timeout(); + if (endTime && millis() > endTime) + timeout(); } } // namespace KaleidoscopePlugins __attribute__((weak)) void -tapDanceAction (uint8_t tapDanceIndex, byte row, byte col, uint8_t tapCount, KaleidoscopePlugins::TapDance::ActionType tapDanceAction) { +tapDanceAction(uint8_t tapDanceIndex, byte row, byte col, uint8_t tapCount, KaleidoscopePlugins::TapDance::ActionType tapDanceAction) { } KaleidoscopePlugins::TapDance TapDance; diff --git a/src/Kaleidoscope/TapDance.h b/src/Kaleidoscope/TapDance.h index 52af9dfe..a24540ab 100644 --- a/src/Kaleidoscope/TapDance.h +++ b/src/Kaleidoscope/TapDance.h @@ -31,42 +31,42 @@ namespace KaleidoscopePlugins { class TapDance : public KaleidoscopePlugin { - public: - typedef enum { - Tap, - Hold, - Interrupt, - Timeout, - Release, - } ActionType; + public: + typedef enum { + Tap, + Hold, + Interrupt, + Timeout, + Release, + } ActionType; - TapDance (void); + TapDance(void); - void begin (void) final; - static uint16_t timeOut; + void begin(void) final; + static uint16_t timeOut; - void actionKeys (uint8_t tapCount, ActionType tapDanceAction, uint8_t maxKeys, const Key tapKeys[]); + void actionKeys(uint8_t tapCount, ActionType tapDanceAction, uint8_t maxKeys, const Key tapKeys[]); - private: - static uint32_t endTime; - static uint8_t tapCount[16]; - static uint16_t pressedState; - static uint16_t triggeredState; - static uint16_t releaseNextState; - static Key lastTapDanceKey; - static byte lastTapDanceRow; - static byte lastTapDanceCol; + private: + static uint32_t endTime; + static uint8_t tapCount[16]; + static uint16_t pressedState; + static uint16_t triggeredState; + static uint16_t releaseNextState; + static Key lastTapDanceKey; + static byte lastTapDanceRow; + static byte lastTapDanceCol; - static Key eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState); - static void loopHook (bool postClear); + static Key eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keyState); + static void loopHook(bool postClear); - static Key tap (void); - static void interrupt (void); - static void timeout (void); - static Key release (uint8_t tapDanceIndex); + static Key tap(void); + static void interrupt(void); + static void timeout(void); + static Key release(uint8_t tapDanceIndex); }; } // namespace KaleidoscopePlugins -void tapDanceAction (uint8_t tapDanceIndex, byte row, byte col, uint8_t tapCount, KaleidoscopePlugins::TapDance::ActionType tapDanceAction); +void tapDanceAction(uint8_t tapDanceIndex, byte row, byte col, uint8_t tapCount, KaleidoscopePlugins::TapDance::ActionType tapDanceAction); extern KaleidoscopePlugins::TapDance TapDance; From 8be191fe9bda47629110cd82eaf2825e43ada8d6 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 5 Jun 2017 12:12:24 +0200 Subject: [PATCH 29/52] Kaleidoscope Style Guide conformance ...and an update to use the newest Ranges APIs. Signed-off-by: Gergely Nagy --- README.md | 64 ++++++----- examples/TapDance/TapDance.ino | 20 ++-- src/Kaleidoscope/TapDance.cpp | 191 ++++++++++++++++----------------- src/Kaleidoscope/TapDance.h | 44 ++++---- 4 files changed, 156 insertions(+), 163 deletions(-) diff --git a/README.md b/README.md index caa41856..6a5536db 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,9 @@ [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-TapDance.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-TapDance - [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 Tap-dance keys are general purpose, multi-use keys, which trigger a different action based on the number of times they were tapped in sequence. As an example @@ -44,21 +44,20 @@ This is to preserve the order of keys pressed. In both of these cases, the [`tapDanceAction`][tdaction] will be called, with `tapDanceIndex` set to the index of the tap-dance action (as set in the keymap), the `tapCount`, and `tapDanceAction` set to either -`KaleidoscopePlugins::TapDance::Interrupt`, or -`KaleidoscopePlugins::TapDance::Timeout`. If we continue holding the key, then -as long as it is held, the same function will be called with `tapDanceAction` -set to `KaleidoscopePlugins::TapDance::Hold`. When the key is released, after -either an `Interrupt` or `Timeout` action was triggered, the function will be -called with `tapDanceAction` set to `KaleidoscopePlugins::TapDance::Release`. +`kaleidoscope::TapDance::Interrupt`, or `kaleidoscope::TapDance::Timeout`. If we +continue holding the key, then as long as it is held, the same function will be +called with `tapDanceAction` set to `kaleidoscope::TapDance::Hold`. When the key +is released, after either an `Interrupt` or `Timeout` action was triggered, the +function will be called with `tapDanceAction` set to +`kaleidoscope::TapDance::Release`. These actions allow us to create sophisticated tap-dance setups, where one can tap a key twice and hold it, and have it repeat, for example. There is one additional value the `tapDanceAction` parameter can take: -`KaleidoscopePlugins::TapDance::Tap`. It is called with this argument for each -and every tap, even if no action is to be triggered yet. This is so that we can -have a way to do some side-effects, like light up LEDs to show progress, and so -on. +`kaleidoscope::TapDance::Tap`. It is called with this argument for each and +every tap, even if no action is to be triggered yet. This is so that we can have +a way to do some side-effects, like light up LEDs to show progress, and so on. ## Using the plugin @@ -75,18 +74,19 @@ time an action is to be performed. TD(0) // later in the Sketch: -void tapDanceAction (uint8_t tapDanceIndex, uint8_t tapCount, - KaleidoscopePlugins::TapDance::ActionType tapDanceAction) { - switch (tapDanceIndex) { +void tapDanceAction(uint8_t tap_dance_index, uint8_t tap_count, + kaleidoscope::TapDance::ActionType tap_dance_action) { + switch (tap_dance_index) { case 0: - return tapDanceActionKeys (tapCount, tapDanceAction, - Key_nextTrack, Key_prevTrack); + return tapDanceActionKeys(tap_count, tap_dance_action, + Consumer_ScanNextTrack, Consumer_ScanPreviousTrack); } } -void setup (void) { - Kaleidoscope.setup (KEYMAP_SIZE); - Kaleidoscope.use (&TapDance, NULL); +void setup() { + USE_PLUGINS(&TapDance); + + Kaleidoscope.setup (); } ``` @@ -98,8 +98,8 @@ void setup (void) { > implementation for the `id` index within the [`tapDanceActions`][tdactions] > function. > -> The `id` parameter here is what will be used as `tapDanceIndex` in the handler -> function. +> The `id` parameter here is what will be used as `tap_dance_index` in the +> handler function. [tdaction]: #tapdanceactiontapdanceindex-tapcount-tapdanceaction @@ -109,17 +109,15 @@ The plugin provides a `TapDance` object, but to implement the actions, we need to define a function ([`tapDanceAction`][tdaction]) outside of the object. A handler, of sorts. Nevertheless, the plugin provides one macro that is particularly useful: `tapDanceActionKeys`. Apart from that, it provides one -method only: +property only: -### `.timeOut` +### `.time_out` > The number of loop iterations to wait before a tap-dance sequence times out. > Once the sequence timed out, the action for it will trigger, even without an > interruptor. Defaults to 5, and the timer resets with every tap of the same -> Not strictly a method, it is a variable one can assign a new value to. - -### `tapDanceActionKeys(tapCount, tapDanceAction, keys...)` +### `tapDanceActionKeys(tap_count, tap_dance_action, keys...)` > Sets up an action where for each subsequent tap, a different key will be > chosen from the list of keys supplied in the `keys...` argument. @@ -130,19 +128,19 @@ method only: > When all our actions are just different keys, this is a very handy macro to > use. > -> The `tapCount` and `tapDanceActions` parameters should be the same as the +> The `tap_count` and `tap_dance_actions` parameters should be the same as the > similarly named parameters of the `tapDanceAction` function. -### `tapDanceAction(tapDanceIndex, row, col, tapCount, tapDanceAction)` +### `tapDanceAction(tap_dance_index, row, col, tap_count, tap_dance_action)` > The heart of the tap-dance plugin is the handler method. This is called every > time any kind of tap-dance action is to be performed. See the > *[How does it work?](#how-does-it-work)* section for details about when and > how this function is called. > -> The `tapDanceIndex` and `tapCount` parameters help us choose which action to -> perform. The `row` and `col` parameters tell us where the tap-dance key is on -> the keyboard. +> The `tap_dance_index` and `tap_count` parameters help us choose which action +> to perform. The `row` and `col` parameters tell us where the tap-dance key is +> on the keyboard. ## Dependencies diff --git a/examples/TapDance/TapDance.ino b/examples/TapDance/TapDance.ino index 1835a3c6..978e976d 100644 --- a/examples/TapDance/TapDance.ino +++ b/examples/TapDance/TapDance.ino @@ -36,26 +36,26 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, - TD(1) - ), + TD(1)), }; -static void tapDanceEsc(uint8_t tapDanceIndex, uint8_t tapCount, KaleidoscopePlugins::TapDance::ActionType tapDanceAction) { - tapDanceActionKeys(tapCount, tapDanceAction, Key_Escape, Key_Tab); +static void tapDanceEsc(uint8_t tap_dance_index, uint8_t tap_count, kaleidoscope::TapDance::ActionType tap_dance_action) { + tap_dance_actionKeys(tap_count, tap_dance_action, Key_Escape, Key_Tab); } -void tapDanceAction(uint8_t tapDanceIndex, byte row, byte col, uint8_t tapCount, KaleidoscopePlugins::TapDance::ActionType tapDanceAction) { - switch (tapDanceIndex) { +void tap_dance_action(uint8_t tap_dance_index, byte row, byte col, uint8_t tap_count, kaleidoscope::TapDance::ActionType tap_dance_action) { + switch (tap_dance_index) { case 0: - return tapDanceActionKeys(tapCount, tapDanceAction, Key_Tab, Key_Escape); + return tap_dance_actionKeys(tap_count, tap_dance_action, Key_Tab, Key_Escape); case 1: - return tapDanceEsc(tapDanceIndex, tapCount, tapDanceAction); + return tapDanceEsc(tap_dance_index, tap_count, tap_dance_action); } } void setup() { - Kaleidoscope.setup(KEYMAP_SIZE); - Kaleidoscope.use(&TapDance, NULL); + USE_PLUGINS(&TapDance); + + Kaleidoscope.setup(); } void loop() { diff --git a/src/Kaleidoscope/TapDance.cpp b/src/Kaleidoscope/TapDance.cpp index d0329a84..cc9fef2a 100644 --- a/src/Kaleidoscope/TapDance.cpp +++ b/src/Kaleidoscope/TapDance.cpp @@ -18,76 +18,73 @@ #include -namespace KaleidoscopePlugins { +namespace kaleidoscope { + // --- state --- -uint32_t TapDance::endTime; -uint16_t TapDance::timeOut = 200; -uint8_t TapDance::tapCount[16]; -uint16_t TapDance::pressedState; -uint16_t TapDance::triggeredState; -uint16_t TapDance::releaseNextState; -Key TapDance::lastTapDanceKey; -byte TapDance::lastTapDanceRow; -byte TapDance::lastTapDanceCol; +uint32_t TapDance::end_time_; +uint16_t TapDance::time_out = 200; +uint8_t TapDance::tap_count_[16]; +uint16_t TapDance::pressed_state_; +uint16_t TapDance::triggered_state_; +uint16_t TapDance::release_next_state_; +Key TapDance::last_tap_dance_key_; +byte TapDance::last_tap_dance_row_; +byte TapDance::last_tap_dance_col_; // --- helpers --- -#define isTapDance(k) (k.raw >= Ranges::TD_FIRST && k.raw <= Ranges::TD_LAST) -#define isInSeq(k) (lastTapDanceKey.raw == k.raw) -#define stillHeld(idx) (tapCount[idx]) -#define isActive() (lastTapDanceKey.raw != Key_NoKey.raw) +#define isTapDance(k) (k.raw >= ranges::TD_FIRST && k.raw <= ranges::TD_LAST) +#define isInSeq(k) (last_tap_dance_key_.raw == k.raw) +#define stillHeld(idx) (tap_count_[idx]) +#define isActive() (last_tap_dance_key_.raw != Key_NoKey.raw) // --- actions --- -void -TapDance::interrupt(void) { - uint8_t idx = lastTapDanceKey.raw - Ranges::TD_FIRST; +void TapDance::interrupt(void) { + uint8_t idx = last_tap_dance_key_.raw - ranges::TD_FIRST; - tapDanceAction(idx, lastTapDanceRow, lastTapDanceCol, tapCount[idx], Interrupt); - bitWrite(triggeredState, idx, 1); + tapDanceAction(idx, last_tap_dance_row_, last_tap_dance_col_, tap_count_[idx], Interrupt); + bitWrite(triggered_state_, idx, 1); - endTime = 0; + end_time_ = 0; - if (bitRead(pressedState, idx)) + if (bitRead(pressed_state_, idx)) return; release(idx); } -void -TapDance::timeout(void) { - uint8_t idx = lastTapDanceKey.raw - Ranges::TD_FIRST; +void TapDance::timeout(void) { + uint8_t idx = last_tap_dance_key_.raw - ranges::TD_FIRST; - tapDanceAction(idx, lastTapDanceRow, lastTapDanceCol, tapCount[idx], Timeout); - bitWrite(triggeredState, idx, 1); + tapDanceAction(idx, last_tap_dance_row_, last_tap_dance_col_, tap_count_[idx], Timeout); + bitWrite(triggered_state_, idx, 1); - if (bitRead(pressedState, idx)) + if (bitRead(pressed_state_, idx)) return; - lastTapDanceKey.raw = Key_NoKey.raw; + last_tap_dance_key_.raw = Key_NoKey.raw; release(idx); } -Key -TapDance::release(uint8_t tapDanceIndex) { - endTime = 0; - lastTapDanceKey.raw = Key_NoKey.raw; +Key TapDance::release(uint8_t tap_dance_index) { + end_time_ = 0; + last_tap_dance_key_.raw = Key_NoKey.raw; - bitClear(pressedState, tapDanceIndex); - bitClear(triggeredState, tapDanceIndex); - bitWrite(releaseNextState, tapDanceIndex, 1); + bitClear(pressed_state_, tap_dance_index); + bitClear(triggered_state_, tap_dance_index); + bitWrite(release_next_state_, tap_dance_index, 1); return Key_NoKey; } -Key -TapDance::tap(void) { - uint8_t idx = lastTapDanceKey.raw - Ranges::TD_FIRST; +Key TapDance::tap(void) { + uint8_t idx = last_tap_dance_key_.raw - ranges::TD_FIRST; - tapCount[idx]++; - endTime = millis() + timeOut; + tap_count_[idx]++; + end_time_ = millis() + time_out; - tapDanceAction(idx, lastTapDanceRow, lastTapDanceCol, tapCount[idx], Tap); + tapDanceAction(idx, last_tap_dance_row_, last_tap_dance_col_, tap_count_[idx], Tap); return Key_NoKey; } @@ -95,86 +92,82 @@ TapDance::tap(void) { // --- api --- TapDance::TapDance(void) { - lastTapDanceKey.raw = Key_NoKey.raw; } -void -TapDance::begin(void) { - event_handler_hook_use(this->eventHandlerHook); - loop_hook_use(this->loopHook); +void TapDance::begin(void) { + event_handler_hook_use(eventHandlerHook); + loop_hook_use(loopHook); } -void -TapDance::actionKeys(uint8_t tapCount, ActionType tapDanceAction, uint8_t maxKeys, const Key tapKeys[]) { - if (tapCount > maxKeys) - tapCount = maxKeys; +void TapDance::actionKeys(uint8_t tap_count, ActionType tap_dance_action, uint8_t max_keys, const Key tap_keys[]) { + if (tap_count > max_keys) + tap_count = max_keys; Key key; - key.raw = pgm_read_word(&(tapKeys[tapCount - 1].raw)); + key.raw = pgm_read_word(&(tap_keys[tap_count - 1].raw)); - switch (tapDanceAction) { + switch (tap_dance_action) { case Tap: break; case Interrupt: case Timeout: - handle_keyswitch_event(key, lastTapDanceRow, lastTapDanceCol, IS_PRESSED | INJECTED); + handle_keyswitch_event(key, last_tap_dance_row_, last_tap_dance_col_, IS_PRESSED | INJECTED); break; case Hold: - handle_keyswitch_event(key, lastTapDanceRow, lastTapDanceCol, IS_PRESSED | WAS_PRESSED | INJECTED); + handle_keyswitch_event(key, last_tap_dance_row_, last_tap_dance_col_, IS_PRESSED | WAS_PRESSED | INJECTED); break; case Release: Keyboard.sendReport(); - handle_keyswitch_event(key, lastTapDanceRow, lastTapDanceCol, WAS_PRESSED | INJECTED); + handle_keyswitch_event(key, last_tap_dance_row_, last_tap_dance_col_, WAS_PRESSED | INJECTED); break; } } // --- hooks --- -Key -TapDance::eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keyState) { - if (keyState & INJECTED) - return mappedKey; +Key TapDance::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 (isTapDance(mappedKey)) + if (!key_is_pressed(key_state) && !key_was_pressed(key_state)) { + if (isTapDance(mapped_key)) return Key_NoKey; - return mappedKey; + return mapped_key; } - if (!isTapDance(mappedKey)) { + if (!isTapDance(mapped_key)) { if (!isActive()) - return mappedKey; + return mapped_key; - if (key_toggled_on(keyState)) + if (key_toggled_on(key_state)) interrupt(); - return mappedKey; + return mapped_key; } - uint8_t tapDanceIndex = mappedKey.raw - Ranges::TD_FIRST; + uint8_t tap_dance_index = mapped_key.raw - ranges::TD_FIRST; - if (key_toggled_off(keyState)) - bitClear(pressedState, tapDanceIndex); + if (key_toggled_off(key_state)) + bitClear(pressed_state_, tap_dance_index); - if (!isInSeq(mappedKey)) { + if (!isInSeq(mapped_key)) { if (!isActive()) { - if (bitRead(triggeredState, tapDanceIndex)) { - if (key_toggled_off(keyState)) - return release(tapDanceIndex); + if (bitRead(triggered_state_, tap_dance_index)) { + if (key_toggled_off(key_state)) + return release(tap_dance_index); return Key_NoKey; } - lastTapDanceKey.raw = mappedKey.raw; - lastTapDanceRow = row; - lastTapDanceCol = col; + last_tap_dance_key_.raw = mapped_key.raw; + last_tap_dance_row_ = row; + last_tap_dance_col_ = col; return tap(); } else { - if (key_toggled_off(keyState) && stillHeld(tapDanceIndex)) { - return release(tapDanceIndex); + if (key_toggled_off(key_state) && stillHeld(tap_dance_index)) { + return release(tap_dance_index); } - if (!key_toggled_on(keyState)) + if (!key_toggled_on(key_state)) return Key_NoKey; interrupt(); @@ -183,48 +176,48 @@ TapDance::eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keyState) // in sequence - if (key_toggled_off(keyState)) + if (key_toggled_off(key_state)) return Key_NoKey; - lastTapDanceKey.raw = mappedKey.raw; - lastTapDanceRow = row; - lastTapDanceCol = col; - bitSet(pressedState, tapDanceIndex); + last_tap_dance_key_.raw = mapped_key.raw; + last_tap_dance_row_ = row; + last_tap_dance_col_ = col; + bitSet(pressed_state_, tap_dance_index); - if (key_toggled_on(keyState)) + if (key_toggled_on(key_state)) return tap(); - if (bitRead(triggeredState, tapDanceIndex)) - tapDanceAction(tapDanceIndex, row, col, tapCount[tapDanceIndex], Hold); + if (bitRead(triggered_state_, tap_dance_index)) + tapDanceAction(tap_dance_index, row, col, tap_count_[tap_dance_index], Hold); return Key_NoKey; } void -TapDance::loopHook(bool postClear) { - if (!postClear) +TapDance::loopHook(bool is_post_clear) { + if (!is_post_clear) return; for (uint8_t i = 0; i < 16; i++) { - if (!bitRead(releaseNextState, i)) + if (!bitRead(release_next_state_, i)) continue; - tapDanceAction(i, lastTapDanceRow, lastTapDanceCol, tapCount[i], Release); - tapCount[i] = 0; - bitClear(releaseNextState, i); + tapDanceAction(i, last_tap_dance_row_, last_tap_dance_col_, tap_count_[i], Release); + tap_count_[i] = 0; + bitClear(release_next_state_, i); } if (!isActive()) return; - if (endTime && millis() > endTime) + if (end_time_ && millis() > end_time_) timeout(); } -} // namespace KaleidoscopePlugins -__attribute__((weak)) -void -tapDanceAction(uint8_t tapDanceIndex, byte row, byte col, uint8_t tapCount, KaleidoscopePlugins::TapDance::ActionType tapDanceAction) { } -KaleidoscopePlugins::TapDance TapDance; +__attribute__((weak)) void tapDanceAction(uint8_t tap_dance_index, byte row, byte col, uint8_t tap_count, + kaleidoscope::TapDance::ActionType tap_dance_action) { +} + +kaleidoscope::TapDance TapDance; diff --git a/src/Kaleidoscope/TapDance.h b/src/Kaleidoscope/TapDance.h index a24540ab..61c574a2 100644 --- a/src/Kaleidoscope/TapDance.h +++ b/src/Kaleidoscope/TapDance.h @@ -21,15 +21,15 @@ #include #include -#define TD(n) (Key){.raw = KaleidoscopePlugins::Ranges::TD_FIRST + n } +#define TD(n) (Key) {.raw = kaleidoscope::ranges::TD_FIRST + n } -#define tapDanceActionKeys(tapCount, tapDanceAction, ...) ({ \ +#define tap_dance_actionKeys(tap_count, tap_dance_action, ...) ({ \ static const Key __k[] PROGMEM = { __VA_ARGS__ }; \ - TapDance.actionKeys (tapCount, tapDanceAction, \ - sizeof (__k) / sizeof (Key), &__k[0]); \ + TapDance.actionKeys(tap_count, tap_dance_action, \ + sizeof (__k) / sizeof (Key), &__k[0]); \ }) -namespace KaleidoscopePlugins { +namespace kaleidoscope { class TapDance : public KaleidoscopePlugin { public: typedef enum { @@ -43,30 +43,32 @@ class TapDance : public KaleidoscopePlugin { TapDance(void); void begin(void) final; - static uint16_t timeOut; + static uint16_t time_out; - void actionKeys(uint8_t tapCount, ActionType tapDanceAction, uint8_t maxKeys, const Key tapKeys[]); + void actionKeys(uint8_t tap_count, ActionType tap_dance_action, uint8_t max_keys, const Key tap_keys[]); private: - static uint32_t endTime; - static uint8_t tapCount[16]; - static uint16_t pressedState; - static uint16_t triggeredState; - static uint16_t releaseNextState; - static Key lastTapDanceKey; - static byte lastTapDanceRow; - static byte lastTapDanceCol; + static uint32_t end_time_; + static uint8_t tap_count_[16]; + static uint16_t pressed_state_; + static uint16_t triggered_state_; + static uint16_t release_next_state_; + static Key last_tap_dance_key_; + static byte last_tap_dance_row_; + static byte last_tap_dance_col_; - 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 Key tap(void); static void interrupt(void); static void timeout(void); - static Key release(uint8_t tapDanceIndex); + static Key release(uint8_t tap_dance_index); }; -} // namespace KaleidoscopePlugins -void tapDanceAction(uint8_t tapDanceIndex, byte row, byte col, uint8_t tapCount, KaleidoscopePlugins::TapDance::ActionType tapDanceAction); +} -extern KaleidoscopePlugins::TapDance TapDance; +void tapDanceAction(uint8_t tap_dance_index, byte row, byte col, uint8_t tap_count, + kaleidoscope::TapDance::ActionType tap_dance_action); + +extern kaleidoscope::TapDance TapDance; From 823f73f0261ef3f125586f009f2b5ff673d63a78 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 5 Jun 2017 13:09:34 +0200 Subject: [PATCH 30/52] Fix a silly search & replace bug Signed-off-by: Gergely Nagy --- src/Kaleidoscope/TapDance.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/TapDance.h b/src/Kaleidoscope/TapDance.h index 61c574a2..8546262a 100644 --- a/src/Kaleidoscope/TapDance.h +++ b/src/Kaleidoscope/TapDance.h @@ -23,7 +23,7 @@ #define TD(n) (Key) {.raw = kaleidoscope::ranges::TD_FIRST + n } -#define tap_dance_actionKeys(tap_count, tap_dance_action, ...) ({ \ +#define tapDanceActionKeys(tap_count, tap_dance_action, ...) ({ \ static const Key __k[] PROGMEM = { __VA_ARGS__ }; \ TapDance.actionKeys(tap_count, tap_dance_action, \ sizeof (__k) / sizeof (Key), &__k[0]); \ From 4e5e579da4b825ef9849520c7c725aa937e2a767 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 5 Jun 2017 14:38:56 +0200 Subject: [PATCH 31/52] Fix some more search & replace bugs Signed-off-by: Gergely Nagy --- examples/TapDance/TapDance.ino | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/examples/TapDance/TapDance.ino b/examples/TapDance/TapDance.ino index 978e976d..81402627 100644 --- a/examples/TapDance/TapDance.ino +++ b/examples/TapDance/TapDance.ino @@ -40,13 +40,13 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { }; static void tapDanceEsc(uint8_t tap_dance_index, uint8_t tap_count, kaleidoscope::TapDance::ActionType tap_dance_action) { - tap_dance_actionKeys(tap_count, tap_dance_action, Key_Escape, Key_Tab); + tapDanceActionKeys(tap_count, tap_dance_action, Key_Escape, Key_Tab); } -void tap_dance_action(uint8_t tap_dance_index, byte row, byte col, uint8_t tap_count, kaleidoscope::TapDance::ActionType tap_dance_action) { +void tapDanceAction(uint8_t tap_dance_index, byte row, byte col, uint8_t tap_count, kaleidoscope::TapDance::ActionType tap_dance_action) { switch (tap_dance_index) { case 0: - return tap_dance_actionKeys(tap_count, tap_dance_action, Key_Tab, Key_Escape); + return tapDanceActionKeys(tap_count, tap_dance_action, Key_Tab, Key_Escape); case 1: return tapDanceEsc(tap_dance_index, tap_count, tap_dance_action); } From 41683449eca4c6789cd445c39aaae6f21c9e9a78 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 24 Jul 2017 13:57:18 -0700 Subject: [PATCH 32/52] keyToggledO* camelcasing --- src/Kaleidoscope/TapDance.cpp | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/Kaleidoscope/TapDance.cpp b/src/Kaleidoscope/TapDance.cpp index cc9fef2a..656f5bfc 100644 --- a/src/Kaleidoscope/TapDance.cpp +++ b/src/Kaleidoscope/TapDance.cpp @@ -139,7 +139,7 @@ Key TapDance::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_s if (!isActive()) return mapped_key; - if (key_toggled_on(key_state)) + if (keyToggledOn(key_state)) interrupt(); return mapped_key; @@ -147,13 +147,13 @@ Key TapDance::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_s uint8_t tap_dance_index = mapped_key.raw - ranges::TD_FIRST; - if (key_toggled_off(key_state)) + if (keyToggledOff(key_state)) bitClear(pressed_state_, tap_dance_index); if (!isInSeq(mapped_key)) { if (!isActive()) { if (bitRead(triggered_state_, tap_dance_index)) { - if (key_toggled_off(key_state)) + if (keyToggledOff(key_state)) return release(tap_dance_index); return Key_NoKey; } @@ -163,11 +163,11 @@ Key TapDance::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_s last_tap_dance_col_ = col; return tap(); } else { - if (key_toggled_off(key_state) && stillHeld(tap_dance_index)) { + if (keyToggledOff(key_state) && stillHeld(tap_dance_index)) { return release(tap_dance_index); } - if (!key_toggled_on(key_state)) + if (!keyToggledOn(key_state)) return Key_NoKey; interrupt(); @@ -176,7 +176,7 @@ Key TapDance::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_s // in sequence - if (key_toggled_off(key_state)) + if (keyToggledOff(key_state)) return Key_NoKey; last_tap_dance_key_.raw = mapped_key.raw; @@ -184,7 +184,7 @@ Key TapDance::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_s last_tap_dance_col_ = col; bitSet(pressed_state_, tap_dance_index); - if (key_toggled_on(key_state)) + if (keyToggledOn(key_state)) return tap(); if (bitRead(triggered_state_, tap_dance_index)) From b93d18811eef10fc0ef6a6c8683ed9044bd8074f Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 24 Jul 2017 14:13:06 -0700 Subject: [PATCH 33/52] CamelCase of KeyIsPressed and KeyWasPressed --- src/Kaleidoscope/TapDance.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/TapDance.cpp b/src/Kaleidoscope/TapDance.cpp index 656f5bfc..a58e306f 100644 --- a/src/Kaleidoscope/TapDance.cpp +++ b/src/Kaleidoscope/TapDance.cpp @@ -129,7 +129,7 @@ Key TapDance::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_s 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 (isTapDance(mapped_key)) return Key_NoKey; return mapped_key; From 5fb304851f069b2411cfd0896b469e4356ab3a24 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 24 Jul 2017 14:42:23 -0700 Subject: [PATCH 34/52] CamelCase of handle_*_key* --- src/Kaleidoscope/TapDance.cpp | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/Kaleidoscope/TapDance.cpp b/src/Kaleidoscope/TapDance.cpp index a58e306f..9657cc70 100644 --- a/src/Kaleidoscope/TapDance.cpp +++ b/src/Kaleidoscope/TapDance.cpp @@ -111,14 +111,14 @@ void TapDance::actionKeys(uint8_t tap_count, ActionType tap_dance_action, uint8_ break; case Interrupt: case Timeout: - handle_keyswitch_event(key, last_tap_dance_row_, last_tap_dance_col_, IS_PRESSED | INJECTED); + handleKeyswitchEvent(key, last_tap_dance_row_, last_tap_dance_col_, IS_PRESSED | INJECTED); break; case Hold: - handle_keyswitch_event(key, last_tap_dance_row_, last_tap_dance_col_, IS_PRESSED | WAS_PRESSED | INJECTED); + handleKeyswitchEvent(key, last_tap_dance_row_, last_tap_dance_col_, IS_PRESSED | WAS_PRESSED | INJECTED); break; case Release: Keyboard.sendReport(); - handle_keyswitch_event(key, last_tap_dance_row_, last_tap_dance_col_, WAS_PRESSED | INJECTED); + handleKeyswitchEvent(key, last_tap_dance_row_, last_tap_dance_col_, WAS_PRESSED | INJECTED); break; } } From 9957fca651fd3f79e9eef749af79d60e71b34e3f Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 25 Jul 2017 14:42:07 -0700 Subject: [PATCH 35/52] Update to new hid facade --- src/Kaleidoscope/TapDance.cpp | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/Kaleidoscope/TapDance.cpp b/src/Kaleidoscope/TapDance.cpp index 9657cc70..f084d4ff 100644 --- a/src/Kaleidoscope/TapDance.cpp +++ b/src/Kaleidoscope/TapDance.cpp @@ -17,6 +17,7 @@ */ #include +#include namespace kaleidoscope { @@ -117,7 +118,7 @@ void TapDance::actionKeys(uint8_t tap_count, ActionType tap_dance_action, uint8_ handleKeyswitchEvent(key, last_tap_dance_row_, last_tap_dance_col_, IS_PRESSED | WAS_PRESSED | INJECTED); break; case Release: - Keyboard.sendReport(); + hid::sendKeyboardReport(); handleKeyswitchEvent(key, last_tap_dance_row_, last_tap_dance_col_, WAS_PRESSED | INJECTED); break; } From 64f9fe2a533fa59a454c4841949625ff49e97eab Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 25 Jul 2017 15:52:19 -0700 Subject: [PATCH 36/52] 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 a31d686911e4fdf0d3dedd1a456be2121edf93b9 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 3 Aug 2017 11:59:33 +0200 Subject: [PATCH 37/52] When interrupting a tap-dance sequence, make sure no extras are sent When interrupting, we send a report, release all keys, and mask the interrupting key to avoid issues like sending too many of the interrupting keys. Later on, we unmask the interrupting key if it has been masked. This fixes #9, but requires the masking patches to be merged first. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/TapDance.cpp | 15 ++++++++++++--- src/Kaleidoscope/TapDance.h | 2 +- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/src/Kaleidoscope/TapDance.cpp b/src/Kaleidoscope/TapDance.cpp index f084d4ff..894555e4 100644 --- a/src/Kaleidoscope/TapDance.cpp +++ b/src/Kaleidoscope/TapDance.cpp @@ -41,7 +41,7 @@ byte TapDance::last_tap_dance_col_; // --- actions --- -void TapDance::interrupt(void) { +void TapDance::interrupt(byte row, byte col) { uint8_t idx = last_tap_dance_key_.raw - ranges::TD_FIRST; tapDanceAction(idx, last_tap_dance_row_, last_tap_dance_col_, tap_count_[idx], Interrupt); @@ -49,6 +49,10 @@ void TapDance::interrupt(void) { end_time_ = 0; + KeyboardHardware.maskKey(row, col); + kaleidoscope::hid::sendKeyboardReport(); + kaleidoscope::hid::releaseAllKeys(); + if (bitRead(pressed_state_, idx)) return; @@ -133,6 +137,7 @@ Key TapDance::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_s if (!keyIsPressed(key_state) && !keyWasPressed(key_state)) { if (isTapDance(mapped_key)) return Key_NoKey; + return mapped_key; } @@ -141,8 +146,12 @@ Key TapDance::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_s return mapped_key; if (keyToggledOn(key_state)) - interrupt(); + interrupt(row, col); + if (KeyboardHardware.isKeyMasked(row, col)) { + KeyboardHardware.unMaskKey(row, col); + return Key_NoKey; + } return mapped_key; } @@ -171,7 +180,7 @@ Key TapDance::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_s if (!keyToggledOn(key_state)) return Key_NoKey; - interrupt(); + interrupt(row, col); } } diff --git a/src/Kaleidoscope/TapDance.h b/src/Kaleidoscope/TapDance.h index 8546262a..70d76f80 100644 --- a/src/Kaleidoscope/TapDance.h +++ b/src/Kaleidoscope/TapDance.h @@ -61,7 +61,7 @@ class TapDance : public KaleidoscopePlugin { static void loopHook(bool is_post_clear); static Key tap(void); - static void interrupt(void); + static void interrupt(byte row, byte col); static void timeout(void); static Key release(uint8_t tap_dance_index); }; From 2c27bf8476de98bf2b0005508ab79cd3f3419ffa Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 17 Aug 2017 12:41:04 +0200 Subject: [PATCH 38/52] Stop using deprecated interfaces Use `Kaleidoscope.use`, `Kaleidoscope.useEventHandlerHook`, and `Kaleidoscope.useLoopHook` instead of the deprecated `USE_PLUGINS`, `event_handler_hook_use` and `loop_hook_use` interfaces. Signed-off-by: Gergely Nagy --- README.md | 6 +++--- examples/TapDance/TapDance.ino | 2 +- src/Kaleidoscope/TapDance.cpp | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6a5536db..1606d22b 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ time an action is to be performed. TD(0) // later in the Sketch: -void tapDanceAction(uint8_t tap_dance_index, uint8_t tap_count, +void tapDanceAction(uint8_t tap_dance_index, uint8_t tap_count, kaleidoscope::TapDance::ActionType tap_dance_action) { switch (tap_dance_index) { case 0: @@ -84,8 +84,8 @@ void tapDanceAction(uint8_t tap_dance_index, uint8_t tap_count, } void setup() { - USE_PLUGINS(&TapDance); - + Kaleidoscope.use(&TapDance); + Kaleidoscope.setup (); } ``` diff --git a/examples/TapDance/TapDance.ino b/examples/TapDance/TapDance.ino index 81402627..a484f240 100644 --- a/examples/TapDance/TapDance.ino +++ b/examples/TapDance/TapDance.ino @@ -53,7 +53,7 @@ void tapDanceAction(uint8_t tap_dance_index, byte row, byte col, uint8_t tap_cou } void setup() { - USE_PLUGINS(&TapDance); + Kaleidoscope.use(&TapDance); Kaleidoscope.setup(); } diff --git a/src/Kaleidoscope/TapDance.cpp b/src/Kaleidoscope/TapDance.cpp index 894555e4..8d55ce6c 100644 --- a/src/Kaleidoscope/TapDance.cpp +++ b/src/Kaleidoscope/TapDance.cpp @@ -100,8 +100,8 @@ TapDance::TapDance(void) { } void TapDance::begin(void) { - event_handler_hook_use(eventHandlerHook); - loop_hook_use(loopHook); + Kaleidoscope.useEventHandlerHook(eventHandlerHook); + Kaleidoscope.useLoopHook(loopHook); } void TapDance::actionKeys(uint8_t tap_count, ActionType tap_dance_action, uint8_t max_keys, const Key tap_keys[]) { From c914d3d86a4c22dc8b4d5e97cb18b8a9e05c7839 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 21 Aug 2017 22:25:30 -0700 Subject: [PATCH 39/52] 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 8449dbe282d427c529d8685d83348ec2311a9fef Mon Sep 17 00:00:00 2001 From: James Cash Date: Thu, 2 Nov 2017 13:24:08 -0400 Subject: [PATCH 40/52] Fix plugin setup documentation Example in README shows wrong method signature to override --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1606d22b..5c981278 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ time an action is to be performed. TD(0) // later in the Sketch: -void tapDanceAction(uint8_t tap_dance_index, uint8_t tap_count, +void tapDanceAction(uint8_t tap_dance_index, byte row, byte col, uint8_t tap_count, kaleidoscope::TapDance::ActionType tap_dance_action) { switch (tap_dance_index) { case 0: From 0635518f9dec013c1e8748a0db87d3161b5b0c5f Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 13 May 2018 22:10:43 +0200 Subject: [PATCH 41/52] Updated to use the new plugin APIs Signed-off-by: Gergely Nagy --- README.md | 4 +- examples/TapDance/TapDance.ino | 10 +-- src/Kaleidoscope/TapDance.cpp | 111 ++++++++++++++++++++------------- src/Kaleidoscope/TapDance.h | 24 ++++--- 4 files changed, 89 insertions(+), 60 deletions(-) diff --git a/README.md b/README.md index 5c981278..80f56b6e 100644 --- a/README.md +++ b/README.md @@ -83,9 +83,9 @@ void tapDanceAction(uint8_t tap_dance_index, byte row, byte col, uint8_t tap_cou } } -void setup() { - Kaleidoscope.use(&TapDance); +KALEIDOSCOPE_INIT_PLUGINS(TapDance); +void setup() { Kaleidoscope.setup (); } ``` diff --git a/examples/TapDance/TapDance.ino b/examples/TapDance/TapDance.ino index a484f240..26babde0 100644 --- a/examples/TapDance/TapDance.ino +++ b/examples/TapDance/TapDance.ino @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-TapDance -- Tap-dance 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 ( @@ -32,12 +33,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, TD(1)), }; +// *INDENT-ON* static void tapDanceEsc(uint8_t tap_dance_index, uint8_t tap_count, kaleidoscope::TapDance::ActionType tap_dance_action) { tapDanceActionKeys(tap_count, tap_dance_action, Key_Escape, Key_Tab); @@ -52,9 +54,9 @@ void tapDanceAction(uint8_t tap_dance_index, byte row, byte col, uint8_t tap_cou } } -void setup() { - Kaleidoscope.use(&TapDance); +KALEIDOSCOPE_INIT_PLUGINS(TapDance); +void setup() { Kaleidoscope.setup(); } diff --git a/src/Kaleidoscope/TapDance.cpp b/src/Kaleidoscope/TapDance.cpp index 8d55ce6c..a90304c7 100644 --- a/src/Kaleidoscope/TapDance.cpp +++ b/src/Kaleidoscope/TapDance.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-TapDance -- Tap-dance 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 @@ -73,37 +73,26 @@ void TapDance::timeout(void) { release(idx); } -Key TapDance::release(uint8_t tap_dance_index) { +void TapDance::release(uint8_t tap_dance_index) { end_time_ = 0; last_tap_dance_key_.raw = Key_NoKey.raw; bitClear(pressed_state_, tap_dance_index); bitClear(triggered_state_, tap_dance_index); bitWrite(release_next_state_, tap_dance_index, 1); - return Key_NoKey; } -Key TapDance::tap(void) { +void TapDance::tap(void) { uint8_t idx = last_tap_dance_key_.raw - ranges::TD_FIRST; tap_count_[idx]++; end_time_ = millis() + time_out; tapDanceAction(idx, last_tap_dance_row_, last_tap_dance_col_, tap_count_[idx], Tap); - - return Key_NoKey; } // --- api --- -TapDance::TapDance(void) { -} - -void TapDance::begin(void) { - Kaleidoscope.useEventHandlerHook(eventHandlerHook); - Kaleidoscope.useLoopHook(loopHook); -} - void TapDance::actionKeys(uint8_t tap_count, ActionType tap_dance_action, uint8_t max_keys, const Key tap_keys[]) { if (tap_count > max_keys) tap_count = max_keys; @@ -130,55 +119,63 @@ void TapDance::actionKeys(uint8_t tap_count, ActionType tap_dance_action, uint8_ // --- hooks --- -Key TapDance::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state) { - if (key_state & INJECTED) - return mapped_key; +EventHandlerResult TapDance::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 (isTapDance(mapped_key)) - return Key_NoKey; + if (!keyIsPressed(keyState) && !keyWasPressed(keyState)) { + if (isTapDance(mapped_key)) { + return EventHandlerResult::EVENT_CONSUMED; + } - return mapped_key; + return EventHandlerResult::OK; } if (!isTapDance(mapped_key)) { if (!isActive()) - return mapped_key; + return EventHandlerResult::OK; - if (keyToggledOn(key_state)) + if (keyToggledOn(keyState)) interrupt(row, col); if (KeyboardHardware.isKeyMasked(row, col)) { KeyboardHardware.unMaskKey(row, col); - return Key_NoKey; + return EventHandlerResult::EVENT_CONSUMED; } - return mapped_key; + return EventHandlerResult::OK; } uint8_t tap_dance_index = mapped_key.raw - ranges::TD_FIRST; - if (keyToggledOff(key_state)) + if (keyToggledOff(keyState)) bitClear(pressed_state_, tap_dance_index); if (!isInSeq(mapped_key)) { if (!isActive()) { if (bitRead(triggered_state_, tap_dance_index)) { - if (keyToggledOff(key_state)) - return release(tap_dance_index); - return Key_NoKey; + if (keyToggledOff(keyState)) { + release(tap_dance_index); + } + + return EventHandlerResult::EVENT_CONSUMED; } last_tap_dance_key_.raw = mapped_key.raw; last_tap_dance_row_ = row; last_tap_dance_col_ = col; - return tap(); + + tap(); + + return EventHandlerResult::EVENT_CONSUMED; } else { - if (keyToggledOff(key_state) && stillHeld(tap_dance_index)) { - return release(tap_dance_index); + if (keyToggledOff(keyState) && stillHeld(tap_dance_index)) { + release(tap_dance_index); + return EventHandlerResult::EVENT_CONSUMED; } - if (!keyToggledOn(key_state)) - return Key_NoKey; + if (!keyToggledOn(keyState)) { + return EventHandlerResult::EVENT_CONSUMED; + } interrupt(row, col); } @@ -186,28 +183,27 @@ Key TapDance::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_s // in sequence - if (keyToggledOff(key_state)) - return Key_NoKey; + if (keyToggledOff(keyState)) { + return EventHandlerResult::EVENT_CONSUMED; + } last_tap_dance_key_.raw = mapped_key.raw; last_tap_dance_row_ = row; last_tap_dance_col_ = col; bitSet(pressed_state_, tap_dance_index); - if (keyToggledOn(key_state)) - return tap(); + if (keyToggledOn(keyState)) { + tap(); + return EventHandlerResult::EVENT_CONSUMED; + } if (bitRead(triggered_state_, tap_dance_index)) tapDanceAction(tap_dance_index, row, col, tap_count_[tap_dance_index], Hold); - return Key_NoKey; + return EventHandlerResult::EVENT_CONSUMED; } -void -TapDance::loopHook(bool is_post_clear) { - if (!is_post_clear) - return; - +EventHandlerResult TapDance::afterEachCycle() { for (uint8_t i = 0; i < 16; i++) { if (!bitRead(release_next_state_, i)) continue; @@ -218,11 +214,36 @@ TapDance::loopHook(bool is_post_clear) { } if (!isActive()) - return; + return EventHandlerResult::OK; if (end_time_ && millis() > end_time_) timeout(); + + return EventHandlerResult::OK; +} + +// Legacy V1 API + +#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API +void TapDance::begin() { + Kaleidoscope.useEventHandlerHook(legacyEventHandler); + Kaleidoscope.useLoopHook(legacyLoopHook); +} + +Key TapDance::legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state) { + EventHandlerResult r = ::TapDance.onKeyswitchEvent(mapped_key, row, col, key_state); + if (r == EventHandlerResult::OK) + return mapped_key; + return Key_NoKey; +} + +void TapDance::legacyLoopHook(bool is_post_clear) { + if (!is_post_clear) + return; + + ::TapDance.afterEachCycle(); } +#endif } diff --git a/src/Kaleidoscope/TapDance.h b/src/Kaleidoscope/TapDance.h index 70d76f80..1d7b146c 100644 --- a/src/Kaleidoscope/TapDance.h +++ b/src/Kaleidoscope/TapDance.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-TapDance -- Tap-dance 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 TapDance : public KaleidoscopePlugin { +class TapDance : public kaleidoscope::Plugin { public: typedef enum { Tap, @@ -40,13 +40,22 @@ class TapDance : public KaleidoscopePlugin { Release, } ActionType; - TapDance(void); + TapDance(void) {} - void begin(void) final; static uint16_t time_out; void actionKeys(uint8_t tap_count, ActionType tap_dance_action, uint8_t max_keys, const Key tap_keys[]); + 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 uint32_t end_time_; static uint8_t tap_count_[16]; @@ -57,13 +66,10 @@ class TapDance : public KaleidoscopePlugin { static byte last_tap_dance_row_; static byte last_tap_dance_col_; - static Key eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state); - static void loopHook(bool is_post_clear); - - static Key tap(void); + static void tap(void); static void interrupt(byte row, byte col); static void timeout(void); - static Key release(uint8_t tap_dance_index); + static void release(uint8_t tap_dance_index); }; } From 4499709cd5d7b8508ab15dcfc49451114818a42b Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 17 Jun 2018 11:25:56 +0200 Subject: [PATCH 42/52] 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/TapDance.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/Kaleidoscope/TapDance.h b/src/Kaleidoscope/TapDance.h index 1d7b146c..3169ae38 100644 --- a/src/Kaleidoscope/TapDance.h +++ b/src/Kaleidoscope/TapDance.h @@ -50,6 +50,10 @@ class TapDance : 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 37f51cacbe2806fb45ba2943a7dd0140e9ce031f Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 20 Aug 2018 23:28:53 +0200 Subject: [PATCH 43/52] Drop the V1 plugin API compatibility code Signed-off-by: Gergely Nagy --- src/Kaleidoscope/TapDance.cpp | 23 ----------------------- src/Kaleidoscope/TapDance.h | 11 ----------- 2 files changed, 34 deletions(-) diff --git a/src/Kaleidoscope/TapDance.cpp b/src/Kaleidoscope/TapDance.cpp index a90304c7..b24a1453 100644 --- a/src/Kaleidoscope/TapDance.cpp +++ b/src/Kaleidoscope/TapDance.cpp @@ -222,29 +222,6 @@ EventHandlerResult TapDance::afterEachCycle() { return EventHandlerResult::OK; } -// Legacy V1 API - -#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API -void TapDance::begin() { - Kaleidoscope.useEventHandlerHook(legacyEventHandler); - Kaleidoscope.useLoopHook(legacyLoopHook); -} - -Key TapDance::legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state) { - EventHandlerResult r = ::TapDance.onKeyswitchEvent(mapped_key, row, col, key_state); - if (r == EventHandlerResult::OK) - return mapped_key; - return Key_NoKey; -} - -void TapDance::legacyLoopHook(bool is_post_clear) { - if (!is_post_clear) - return; - - ::TapDance.afterEachCycle(); -} -#endif - } __attribute__((weak)) void tapDanceAction(uint8_t tap_dance_index, byte row, byte col, uint8_t tap_count, diff --git a/src/Kaleidoscope/TapDance.h b/src/Kaleidoscope/TapDance.h index 3169ae38..83062e28 100644 --- a/src/Kaleidoscope/TapDance.h +++ b/src/Kaleidoscope/TapDance.h @@ -49,17 +49,6 @@ class TapDance : 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 uint32_t end_time_; static uint8_t tap_count_[16]; From c6f63cb40bc409082fc38bf2524f91fa7b50e2d2 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:17:49 +0200 Subject: [PATCH 44/52] Relicense under the GPLv3 (only) Signed-off-by: Gergely Nagy --- examples/TapDance/TapDance.ino | 19 +++++++++---------- src/Kaleidoscope-TapDance.h | 19 +++++++++---------- src/Kaleidoscope/TapDance.cpp | 19 +++++++++---------- src/Kaleidoscope/TapDance.h | 19 +++++++++---------- 4 files changed, 36 insertions(+), 40 deletions(-) diff --git a/examples/TapDance/TapDance.ino b/examples/TapDance/TapDance.ino index 26babde0..46d60867 100644 --- a/examples/TapDance/TapDance.ino +++ b/examples/TapDance/TapDance.ino @@ -2,18 +2,17 @@ * Kaleidoscope-TapDance -- Tap-dance 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-TapDance.h b/src/Kaleidoscope-TapDance.h index 86b75142..0c289d6f 100644 --- a/src/Kaleidoscope-TapDance.h +++ b/src/Kaleidoscope-TapDance.h @@ -2,18 +2,17 @@ * Kaleidoscope-TapDance -- Tap-dance 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/TapDance.cpp b/src/Kaleidoscope/TapDance.cpp index b24a1453..59e7230a 100644 --- a/src/Kaleidoscope/TapDance.cpp +++ b/src/Kaleidoscope/TapDance.cpp @@ -2,18 +2,17 @@ * Kaleidoscope-TapDance -- Tap-dance 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/TapDance.h b/src/Kaleidoscope/TapDance.h index 83062e28..00a3c862 100644 --- a/src/Kaleidoscope/TapDance.h +++ b/src/Kaleidoscope/TapDance.h @@ -2,18 +2,17 @@ * Kaleidoscope-TapDance -- Tap-dance 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 fc9244649a38dbf692db6c79e8b002388a6c0039 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:17:51 +0200 Subject: [PATCH 45/52] 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/TapDance/TapDance.ino | 2 +- library.properties | 2 +- src/Kaleidoscope-TapDance.h | 2 +- src/Kaleidoscope/TapDance.cpp | 2 +- src/Kaleidoscope/TapDance.h | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/examples/TapDance/TapDance.ino b/examples/TapDance/TapDance.ino index 46d60867..4093b8cb 100644 --- a/examples/TapDance/TapDance.ino +++ b/examples/TapDance/TapDance.ino @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-TapDance -- Tap-dance 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 f8a00ad9..018566d3 100644 --- a/library.properties +++ b/library.properties @@ -1,7 +1,7 @@ name=Kaleidoscope-TapDance version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy +maintainer=Gergely Nagy sentence=Tap-dance keys for Kaleidoscope. paragraph=Generic, multi-use keys. category=Communication diff --git a/src/Kaleidoscope-TapDance.h b/src/Kaleidoscope-TapDance.h index 0c289d6f..a6dfd52f 100644 --- a/src/Kaleidoscope-TapDance.h +++ b/src/Kaleidoscope-TapDance.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-TapDance -- Tap-dance 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/TapDance.cpp b/src/Kaleidoscope/TapDance.cpp index 59e7230a..2ee938a9 100644 --- a/src/Kaleidoscope/TapDance.cpp +++ b/src/Kaleidoscope/TapDance.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-TapDance -- Tap-dance 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/TapDance.h b/src/Kaleidoscope/TapDance.h index 00a3c862..9c3e8db9 100644 --- a/src/Kaleidoscope/TapDance.h +++ b/src/Kaleidoscope/TapDance.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-TapDance -- Tap-dance 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 8187d742c4ad731976f9425b2f22101ae7b9d845 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:17:53 +0200 Subject: [PATCH 46/52] 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 37a31b6a7dfb36869ca75c5956046da4edfe2794 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 4 Sep 2018 18:24:02 -0700 Subject: [PATCH 47/52] 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 bd6c2be89b10520400e01ef4fc899ac9d1383764 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 4 Sep 2018 18:42:30 -0700 Subject: [PATCH 48/52] 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 680f1d3de8de966607386090df9f4b84b230c446 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 10 Oct 2018 06:57:23 +0200 Subject: [PATCH 49/52] 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 80f56b6e..57997e5e 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,10 @@ # Kaleidoscope-TapDance -![status][st:stable] [![Build Status][travis:image]][travis:status] +[![Build Status][travis:image]][travis:status] [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-TapDance.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-TapDance - [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 - Tap-dance keys are general purpose, multi-use keys, which trigger a different action based on the number of times they were tapped in sequence. As an example to make this clearer, one can have a key that inputs `A` when tapped once, From f4174da4de247cbe4152bdaaba718d41450c39d5 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 13 Oct 2018 15:33:06 +0200 Subject: [PATCH 50/52] Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/TapDance.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 | 144 +---------------- doc/plugin/TapDance.md | 153 ++++++++++++++++++ src/Kaleidoscope-TapDance.h | 2 +- .../plugin}/TapDance.cpp | 6 +- .../plugin}/TapDance.h | 9 +- 5 files changed, 166 insertions(+), 148 deletions(-) create mode 100644 doc/plugin/TapDance.md rename src/{Kaleidoscope => kaleidoscope/plugin}/TapDance.cpp (97%) rename src/{Kaleidoscope => kaleidoscope/plugin}/TapDance.h (90%) diff --git a/README.md b/README.md index 57997e5e..a6b6504c 100644 --- a/README.md +++ b/README.md @@ -5,146 +5,4 @@ [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-TapDance.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-TapDance -Tap-dance keys are general purpose, multi-use keys, which trigger a different -action based on the number of times they were tapped in sequence. As an example -to make this clearer, one can have a key that inputs `A` when tapped once, -inputs `B` when tapped twice, and lights up the keyboard in Christmas colors -when tapped a third time. - -This behaviour is most useful in cases where we have a number of things we -perform rarely, where tapping a single key repeatedly is not counter-productive. -Such cases include - for example - multimedia forward / backward keys: forward -on single tap, backward on double. Of course, one could use modifiers to achieve -a similar effect, but that's two keys to use, this is only one. We can also hide -some destructive functionality behind a number of taps: reset the keyboard after -4 taps, and light up LEDs in increasingly frightful colors until then. - -## How does it work? - -To not interfere with normal typing, tap-dance keys have two ways to decide when -to call an action: they either get interrupted, or they time out. Every time a -tap-dance key is pressed, the timer resets, so one does not have to finish the -whole tapping sequence within a short time limit. The tap-dance counter -continues incrementing until one of these cases happen. - -When a tap-dance key is pressed and released, and nothing is pressed on the -keyboard until the timeout is reached, then the key will time out, and trigger -an action. Which action, depends on the number of times it has been tapped up -until this point. - -When a tap-dance key is pressed and released, and another key is hit before the -timer expires, then the tap-dance key will trigger an action first, perform it, -and only then will the firmware continue handling the interrupting key press. -This is to preserve the order of keys pressed. - -In both of these cases, the [`tapDanceAction`][tdaction] will be called, with -`tapDanceIndex` set to the index of the tap-dance action (as set in the keymap), -the `tapCount`, and `tapDanceAction` set to either -`kaleidoscope::TapDance::Interrupt`, or `kaleidoscope::TapDance::Timeout`. If we -continue holding the key, then as long as it is held, the same function will be -called with `tapDanceAction` set to `kaleidoscope::TapDance::Hold`. When the key -is released, after either an `Interrupt` or `Timeout` action was triggered, the -function will be called with `tapDanceAction` set to -`kaleidoscope::TapDance::Release`. - -These actions allow us to create sophisticated tap-dance setups, where one can -tap a key twice and hold it, and have it repeat, for example. - -There is one additional value the `tapDanceAction` parameter can take: -`kaleidoscope::TapDance::Tap`. It is called with this argument for each and -every tap, even if no action is to be triggered yet. This is so that we can have -a way to do some side-effects, like light up LEDs to show progress, and so on. - -## Using the plugin - -To use the plugin, we need to include the header, and declare the behaviour -used. Then, we need to place tap-dance keys on the keymap. And finally, we need -to implement the [`tapDanceAction`][tdaction] function that gets called each -time an action is to be performed. - -```c++ -#include -#include - -// Somewhere in the keymap: -TD(0) - -// later in the Sketch: -void tapDanceAction(uint8_t tap_dance_index, byte row, byte col, uint8_t tap_count, - kaleidoscope::TapDance::ActionType tap_dance_action) { - switch (tap_dance_index) { - case 0: - return tapDanceActionKeys(tap_count, tap_dance_action, - Consumer_ScanNextTrack, Consumer_ScanPreviousTrack); - } -} - -KALEIDOSCOPE_INIT_PLUGINS(TapDance); - -void setup() { - Kaleidoscope.setup (); -} -``` - -## Keymap markup - -### `TD(id)` - -> A key that acts as a tap-dance key. The actions performed depend on the -> implementation for the `id` index within the [`tapDanceActions`][tdactions] -> function. -> -> The `id` parameter here is what will be used as `tap_dance_index` in the -> handler function. - - [tdaction]: #tapdanceactiontapdanceindex-tapcount-tapdanceaction - -## Plugin methods - -The plugin provides a `TapDance` object, but to implement the actions, we need -to define a function ([`tapDanceAction`][tdaction]) outside of the object. A -handler, of sorts. Nevertheless, the plugin provides one macro that is -particularly useful: `tapDanceActionKeys`. Apart from that, it provides one -property only: - -### `.time_out` - -> The number of loop iterations to wait before a tap-dance sequence times out. -> Once the sequence timed out, the action for it will trigger, even without an -> interruptor. Defaults to 5, and the timer resets with every tap of the same - -### `tapDanceActionKeys(tap_count, tap_dance_action, keys...)` - -> Sets up an action where for each subsequent tap, a different key will be -> chosen from the list of keys supplied in the `keys...` argument. -> -> If we have `Key_A` and `Key_B` in the list, then, if tapped once, this -> function will input `A`, but when tapped twice, will input `B`. -> -> When all our actions are just different keys, this is a very handy macro to -> use. -> -> The `tap_count` and `tap_dance_actions` parameters should be the same as the -> similarly named parameters of the `tapDanceAction` function. - -### `tapDanceAction(tap_dance_index, row, col, tap_count, tap_dance_action)` - -> The heart of the tap-dance plugin is the handler method. This is called every -> time any kind of tap-dance action is to be performed. See the -> *[How does it work?](#how-does-it-work)* section for details about when and -> how this function is called. -> -> The `tap_dance_index` and `tap_count` parameters help us choose which action -> to perform. The `row` and `col` parameters tell us where the tap-dance key is -> on the keyboard. - -## 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-TapDance/blob/master/examples/TapDance/TapDance.ino +See [doc/plugin/TapDance.md](doc/plugin/TapDance.md) for documentation. diff --git a/doc/plugin/TapDance.md b/doc/plugin/TapDance.md new file mode 100644 index 00000000..10a6726b --- /dev/null +++ b/doc/plugin/TapDance.md @@ -0,0 +1,153 @@ +# Kaleidoscope-TapDance + +Tap-dance keys are general purpose, multi-use keys, which trigger a different +action based on the number of times they were tapped in sequence. As an example +to make this clearer, one can have a key that inputs `A` when tapped once, +inputs `B` when tapped twice, and lights up the keyboard in Christmas colors +when tapped a third time. + +This behaviour is most useful in cases where we have a number of things we +perform rarely, where tapping a single key repeatedly is not counter-productive. +Such cases include - for example - multimedia forward / backward keys: forward +on single tap, backward on double. Of course, one could use modifiers to achieve +a similar effect, but that's two keys to use, this is only one. We can also hide +some destructive functionality behind a number of taps: reset the keyboard after +4 taps, and light up LEDs in increasingly frightful colors until then. + +## How does it work? + +To not interfere with normal typing, tap-dance keys have two ways to decide when +to call an action: they either get interrupted, or they time out. Every time a +tap-dance key is pressed, the timer resets, so one does not have to finish the +whole tapping sequence within a short time limit. The tap-dance counter +continues incrementing until one of these cases happen. + +When a tap-dance key is pressed and released, and nothing is pressed on the +keyboard until the timeout is reached, then the key will time out, and trigger +an action. Which action, depends on the number of times it has been tapped up +until this point. + +When a tap-dance key is pressed and released, and another key is hit before the +timer expires, then the tap-dance key will trigger an action first, perform it, +and only then will the firmware continue handling the interrupting key press. +This is to preserve the order of keys pressed. + +In both of these cases, the [`tapDanceAction`][tdaction] will be called, with +`tapDanceIndex` set to the index of the tap-dance action (as set in the keymap), +the `tapCount`, and `tapDanceAction` set to either +`kaleidoscope::plugin::TapDance::Interrupt`, or +`kaleidoscope::plugin::TapDance::Timeout`. If we continue holding the key, then +as long as it is held, the same function will be called with `tapDanceAction` +set to `kaleidoscope::plugin::TapDance::Hold`. When the key is released, after +either an `Interrupt` or `Timeout` action was triggered, the function will be +called with `tapDanceAction` set to `kaleidoscope::plugin::TapDance::Release`. + +These actions allow us to create sophisticated tap-dance setups, where one can +tap a key twice and hold it, and have it repeat, for example. + +There is one additional value the `tapDanceAction` parameter can take: +`kaleidoscope::plugin::TapDance::Tap`. It is called with this argument for each +and every tap, even if no action is to be triggered yet. This is so that we can +have a way to do some side-effects, like light up LEDs to show progress, and so +on. + +## Using the plugin + +To use the plugin, we need to include the header, and declare the behaviour +used. Then, we need to place tap-dance keys on the keymap. And finally, we need +to implement the [`tapDanceAction`][tdaction] function that gets called each +time an action is to be performed. + +```c++ +#include +#include + +// Somewhere in the keymap: +TD(0) + +// later in the Sketch: +void tapDanceAction(uint8_t tap_dance_index, byte row, byte col, uint8_t tap_count, + kaleidoscope::plugin::TapDance::ActionType tap_dance_action) { + switch (tap_dance_index) { + case 0: + return tapDanceActionKeys(tap_count, tap_dance_action, + Consumer_ScanNextTrack, Consumer_ScanPreviousTrack); + } +} + +KALEIDOSCOPE_INIT_PLUGINS(TapDance); + +void setup() { + Kaleidoscope.setup (); +} +``` + +## Keymap markup + +### `TD(id)` + +> A key that acts as a tap-dance key. The actions performed depend on the +> implementation for the `id` index within the [`tapDanceActions`][tdactions] +> function. +> +> The `id` parameter here is what will be used as `tap_dance_index` in the +> handler function. + + [tdaction]: #tapdanceactiontapdanceindex-tapcount-tapdanceaction + +## Plugin methods + +The plugin provides a `TapDance` object, but to implement the actions, we need +to define a function ([`tapDanceAction`][tdaction]) outside of the object. A +handler, of sorts. Nevertheless, the plugin provides one macro that is +particularly useful: `tapDanceActionKeys`. Apart from that, it provides one +property only: + +### `.time_out` + +> The number of loop iterations to wait before a tap-dance sequence times out. +> Once the sequence timed out, the action for it will trigger, even without an +> interruptor. Defaults to 5, and the timer resets with every tap of the same + +### `tapDanceActionKeys(tap_count, tap_dance_action, keys...)` + +> Sets up an action where for each subsequent tap, a different key will be +> chosen from the list of keys supplied in the `keys...` argument. +> +> If we have `Key_A` and `Key_B` in the list, then, if tapped once, this +> function will input `A`, but when tapped twice, will input `B`. +> +> When all our actions are just different keys, this is a very handy macro to +> use. +> +> The `tap_count` and `tap_dance_actions` parameters should be the same as the +> similarly named parameters of the `tapDanceAction` function. + +### `tapDanceAction(tap_dance_index, row, col, tap_count, tap_dance_action)` + +> The heart of the tap-dance plugin is the handler method. This is called every +> time any kind of tap-dance action is to be performed. See the +> *[How does it work?](#how-does-it-work)* section for details about when and +> how this function is called. +> +> The `tap_dance_index` and `tap_count` parameters help us choose which action +> to perform. The `row` and `col` parameters tell us where the tap-dance key is +> on the keyboard. + +## 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-TapDance/blob/master/examples/TapDance/TapDance.ino + +## Upgrading + +Previous versions of `TapDance` used `kaleidoscope::TapDance::ActionType` as the +type of TapDance actions. In newer versions, this is +`kaleidoscope::plugin::TapDance::ActionType`. The old name still works, but will +be removed by 2019-01-14. diff --git a/src/Kaleidoscope-TapDance.h b/src/Kaleidoscope-TapDance.h index a6dfd52f..786acd9a 100644 --- a/src/Kaleidoscope-TapDance.h +++ b/src/Kaleidoscope-TapDance.h @@ -17,4 +17,4 @@ #pragma once -#include +#include diff --git a/src/Kaleidoscope/TapDance.cpp b/src/kaleidoscope/plugin/TapDance.cpp similarity index 97% rename from src/Kaleidoscope/TapDance.cpp rename to src/kaleidoscope/plugin/TapDance.cpp index 2ee938a9..7dee8aa5 100644 --- a/src/Kaleidoscope/TapDance.cpp +++ b/src/kaleidoscope/plugin/TapDance.cpp @@ -19,6 +19,7 @@ #include namespace kaleidoscope { +namespace plugin { // --- state --- uint32_t TapDance::end_time_; @@ -221,10 +222,11 @@ EventHandlerResult TapDance::afterEachCycle() { return EventHandlerResult::OK; } +} } __attribute__((weak)) void tapDanceAction(uint8_t tap_dance_index, byte row, byte col, uint8_t tap_count, - kaleidoscope::TapDance::ActionType tap_dance_action) { + kaleidoscope::plugin::TapDance::ActionType tap_dance_action) { } -kaleidoscope::TapDance TapDance; +kaleidoscope::plugin::TapDance TapDance; diff --git a/src/Kaleidoscope/TapDance.h b/src/kaleidoscope/plugin/TapDance.h similarity index 90% rename from src/Kaleidoscope/TapDance.h rename to src/kaleidoscope/plugin/TapDance.h index 9c3e8db9..2bd69e3c 100644 --- a/src/Kaleidoscope/TapDance.h +++ b/src/kaleidoscope/plugin/TapDance.h @@ -29,6 +29,7 @@ }) namespace kaleidoscope { +namespace plugin { class TapDance : public kaleidoscope::Plugin { public: typedef enum { @@ -63,10 +64,14 @@ class TapDance : public kaleidoscope::Plugin { static void timeout(void); static void release(uint8_t tap_dance_index); }; +} + +// Backwards compatibility +typedef plugin::TapDance TapDance; } void tapDanceAction(uint8_t tap_dance_index, byte row, byte col, uint8_t tap_count, - kaleidoscope::TapDance::ActionType tap_dance_action); + kaleidoscope::plugin::TapDance::ActionType tap_dance_action); -extern kaleidoscope::TapDance TapDance; +extern kaleidoscope::plugin::TapDance TapDance; From 296c93ecbd61d0fc834a249241990d821916ab87 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 13 Oct 2018 15:36:07 +0200 Subject: [PATCH 51/52] 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 a6b6504c..00000000 --- a/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# Kaleidoscope-TapDance - -[![Build Status][travis:image]][travis:status] - - [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-TapDance.svg?branch=master - [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-TapDance - -See [doc/plugin/TapDance.md](doc/plugin/TapDance.md) for documentation. diff --git a/library.properties b/library.properties deleted file mode 100644 index 018566d3..00000000 --- a/library.properties +++ /dev/null @@ -1,10 +0,0 @@ -name=Kaleidoscope-TapDance -version=0.0.0 -author=Gergely Nagy -maintainer=Gergely Nagy -sentence=Tap-dance keys for Kaleidoscope. -paragraph=Generic, multi-use keys. -category=Communication -url=https://github.com/keyboardio/Kaleidoscope-TapDance -architectures=avr -dot_a_linkage=true From ff92fc8c8947beb6eadbd15b6e30f8569732cd55 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 18 Oct 2018 00:17:18 +0200 Subject: [PATCH 52/52] 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/TapDance.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/plugin/TapDance.md b/doc/plugin/TapDance.md index 10a6726b..99ad7bed 100644 --- a/doc/plugin/TapDance.md +++ b/doc/plugin/TapDance.md @@ -136,14 +136,14 @@ property only: ## 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-TapDance/blob/master/examples/TapDance/TapDance.ino + [plugin:example]: ../../examples/TapDance/TapDance.ino ## Upgrading