From c29a6772a426f5bf658e9498bb83f6834ce0a181 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 16 Jan 2017 15:18:13 +0100 Subject: [PATCH 01/36] Initial import Lifted out of the monolithic Akela library. Signed-off-by: Gergely Nagy --- .gitignore | 2 + COPYING | 674 +++++++++++++++++++++++++++++++++++++++ README.md | 93 ++++++ examples/Cycle/Cycle.ino | 63 ++++ library.properties | 10 + src/Akela-Cycle.h | 21 ++ src/Akela/Cycle.cpp | 99 ++++++ src/Akela/Cycle.h | 50 +++ 8 files changed, 1012 insertions(+) create mode 100644 .gitignore create mode 100644 COPYING create mode 100644 README.md create mode 100644 examples/Cycle/Cycle.ino create mode 100644 library.properties create mode 100644 src/Akela-Cycle.h create mode 100644 src/Akela/Cycle.cpp create mode 100644 src/Akela/Cycle.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..d1405930 --- /dev/null +++ b/README.md @@ -0,0 +1,93 @@ +# Akela-Cycle + +If you ever wanted a key that works like keys on old cell phones, when you press +a key and it cycles through a number of options in a sequence, then the cycling +key is what you are looking for. It is a bit different than on cell phones of +old, as it is a separate key, that works in combination of other keys: you press +a key, then the cycle key, and the cycle key will replace the previously input +symbol with another. Keep tapping the cycle key, and it will replace symbols +with new ones, in a loop. + +## Using the plugin + +To use the plugin, we need to include the header, and declare the behaviour +used. Then, we need to place a cycle key or two on the keymap. And finally, we +need to implement the [`cycleAction`][cycleaction] function that gets called +each time the cycling key triggers. + + [cycleaction]: #cycleactionpreviouskey-cyclecount + +```c++ +#include + +// Somewhere in the keymap: +Key_Cycle + +// later in the Sketch: +void cycleAction (Key previousKey, uint8_t cycleCount) { + if (previousKey.raw == Key_A.raw) { + cycleThrough (Key_B, Key_C, Key_D); + } +} + +void setup (void) { + Keyboardio.setup (KEYMAP_SIZE); + + Keyboardio.use (&Cycle, NULL); +} +``` + +## Keymap markup + +### `Key_Cycle` + +> The key code for the cycle key. There can be as many of this on the keymap, as +> many one wants, but they all behave the same. There is little point in having +> more than one on each side. + +## Plugin methods + +The plugin provides a `Cycle` object, but to implement the actions, we need to +define a function ([`cycleAction`][cycleaction]) outside of the object. A +handler, of sorts. The object also provides a helper method to replace the +previous symbol with another. The plugin also provides one macro that is +particularly useful, and in most cases, should be used over the `.replace()` +method explained below. + +### `cycleThrough(keys...)` + +> Cycles through all the possibilities given in `keys` (starting from the +> beginning once it reached the end). This should be used from +> the [`cycleAction`][cycleaction] function, once it is determined what sequence +> to cycle through. +> +> To make the cycling loop complete, the first element of the `keys` list should +> be the one that - when followed by the Cycle key - triggers the action. + +### `.replace(key)` + +> Deletes the previous symbol (by sending a `Backspace`), and inputs the new +> one. This is used by `cycleThrough()` above, behind the scenes. +> +> The recommended method is to use the macro, but in special circumstances, this +> function can be of direct use as well. + +## Overrideable methods + +### `cycleAction(previousKey, cycleCount)` + +> The heart and soul of the plugin, that must be defined in the Sketch. It will +> be called whenever the cycling key triggers, and the two arguments are the +> last key pressed (not counting repeated taps of the cycling key itself), and +> the number of times the cycling key has been pressed. +> +> It is up to us to decide what to do, and when. But the most common - and +> expected - action is to call `cycleThrough()` with a different sequence for +> each key we want to use together with the cycling key. + +## 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-Cycle/blob/master/examples/Cycle/Cycle.ino diff --git a/examples/Cycle/Cycle.ino b/examples/Cycle/Cycle.ino new file mode 100644 index 00000000..6f34d3a1 --- /dev/null +++ b/examples/Cycle/Cycle.ino @@ -0,0 +1,63 @@ +/* -*- 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, + Key_Cycle, + + Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, + Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, + + Key_RShift, Key_RAlt, Key_Space, Key_RCtrl, + Key_Cycle + ), +}; + +void cycleAction (Key previousKey, uint8_t cycleCount) { + if (previousKey.raw == Key_E.raw) { + if (cycleCount == 1) { + Cycle.replace (Key_F); + } else if (cycleCount == 2) { + Cycle.replace (Key_G); + } + } + if (previousKey.raw == Key_A.raw) { + cycleThrough (Key_A, Key_B, Key_C, Key_D); + } +} + +void setup () { + Keyboardio.setup (KEYMAP_SIZE); + + Keyboardio.use (&Cycle, NULL); +} + +void loop () { + Keyboardio.loop (); +} diff --git a/library.properties b/library.properties new file mode 100644 index 00000000..1a40e247 --- /dev/null +++ b/library.properties @@ -0,0 +1,10 @@ +name=Akela-Cycle +version=0.0.0 +author=Gergely Nagy +maintainer=Gergely Nagy +sentence=Key sequence cycling dead key. +paragraph=Key sequence cycling dead key. +category=Communication +url=https://github.com/Akela-Plugins/Akela-Cycle +architectures=avr +dot_a_linkage=true diff --git a/src/Akela-Cycle.h b/src/Akela-Cycle.h new file mode 100644 index 00000000..4eb036f4 --- /dev/null +++ b/src/Akela-Cycle.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/Cycle.cpp b/src/Akela/Cycle.cpp new file mode 100644 index 00000000..a2140ec0 --- /dev/null +++ b/src/Akela/Cycle.cpp @@ -0,0 +1,99 @@ +/* -*- mode: c++ -*- + * Akela -- Animated Keyboardio Extension Library for Anything + * Copyright (C) 2016, 2017 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#include + +using namespace Akela::Ranges; + +namespace Akela { + // --- state --- + Key Cycle::lastNonCycleKey; + uint8_t Cycle::cycleCount; + + // --- helpers --- + +#define isCycle(k) (k.raw == CYCLE) + + // --- api --- + + Cycle::Cycle (void) { + } + + void + Cycle::begin (void) { + event_handler_hook_add (this->eventHandlerHook); + } + + void + Cycle::replace (Key key) { + handle_key_event (Key_Backspace, 255, 255, IS_PRESSED | INJECTED); + Keyboard.sendReport (); + handle_key_event (Key_Backspace, 255, 255, WAS_PRESSED | INJECTED); + Keyboard.sendReport (); + + handle_key_event (key, 255, 255, IS_PRESSED | INJECTED); + Keyboard.sendReport (); + handle_key_event (key, 255, 255, WAS_PRESSED | INJECTED); + Keyboard.sendReport (); + } + + void + Cycle::replace (uint8_t cycleSize, const Key cycleSteps[]) { + uint8_t idx = cycleCount % cycleSize; + Key key; + + key.raw = pgm_read_word (cycleSteps + idx); + replace (key); + } + + // --- hooks --- + + Key + Cycle::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 (isCycle (mappedKey)) + return Key_NoKey; + return mappedKey; + } + + if (!isCycle (mappedKey)) { + if (key_toggled_on (keyState)) { + lastNonCycleKey.raw = mappedKey.raw; + cycleCount = 0; + } + return mappedKey; + } + + if (!key_toggled_off (keyState)) + return Key_NoKey; + + cycleCount++; + cycleAction (lastNonCycleKey, cycleCount); + return Key_NoKey; + } +}; + +__attribute__((weak)) +void +cycleAction (Key previousKey, uint8_t cycleCount) { +} + +Akela::Cycle Cycle; diff --git a/src/Akela/Cycle.h b/src/Akela/Cycle.h new file mode 100644 index 00000000..4b98d831 --- /dev/null +++ b/src/Akela/Cycle.h @@ -0,0 +1,50 @@ +/* -*- 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 Key_Cycle (Key){ .raw = Akela::Ranges::CYCLE } + +#define cycleThrough(...) ({ \ + static const Key __k[] PROGMEM = { __VA_ARGS__ }; \ + Cycle.replace (sizeof (__k) / sizeof (Key), &__k[0]); \ + }) + +namespace Akela { + class Cycle : public KeyboardioPlugin { + public: + Cycle (void); + + virtual void begin (void) final; + + static void replace (Key key); + static void replace (uint8_t cycleSize, const Key cycleSteps[]); + + private: + static Key lastNonCycleKey; + static uint8_t cycleCount; + + static Key eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState); + }; +}; + +void cycleAction (Key previousKey, uint8_t cycleCount); + +extern Akela::Cycle Cycle; From f614532139e493b49cfd85420e155e375b172cb7 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 16 Jan 2017 17:16:49 +0100 Subject: [PATCH 02/36] 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 d1405930..91ed7b4e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # Akela-Cycle +![status][st:stable] + + [st:stable]: https://img.shields.io/badge/stable-✔-black.png?style=flat&colorA=44cc11&colorB=494e52 + [st:broken]: https://img.shields.io/badge/broken-X-black.png?style=flat&colorA=e05d44&colorB=494e52 + [st:experimental]: https://img.shields.io/badge/experimental----black.png?style=flat&colorA=dfb317&colorB=494e52 + If you ever wanted a key that works like keys on old cell phones, when you press a key and it cycles through a number of options in a sequence, then the cycling key is what you are looking for. It is a bit different than on cell phones of From 09825b62d0868cd5e0db1532e38418b755dd6863 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 17 Jan 2017 10:15:07 +0100 Subject: [PATCH 03/36] 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 91ed7b4e..e998e6f2 100644 --- a/README.md +++ b/README.md @@ -96,4 +96,4 @@ method explained below. Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/Akela-Plugins/Akela-Cycle/blob/master/examples/Cycle/Cycle.ino + [plugin:example]: https://github.com/keyboardio/Akela-Cycle/blob/master/examples/Cycle/Cycle.ino diff --git a/library.properties b/library.properties index 1a40e247..793ec03d 100644 --- a/library.properties +++ b/library.properties @@ -5,6 +5,6 @@ maintainer=Gergely Nagy sentence=Key sequence cycling dead key. paragraph=Key sequence cycling dead key. category=Communication -url=https://github.com/Akela-Plugins/Akela-Cycle +url=https://github.com/keyboardio/Akela-Cycle architectures=avr dot_a_linkage=true From 19600d2ac140d13be65af4f15f775953b481973c Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 27 Jan 2017 09:20:07 +0100 Subject: [PATCH 04/36] Drop Key_LEDEffectNext from the example The example does not use LEDs, drop the key, lest we'd need to pull in the Keyboardio-LEDControl plugin, too. Signed-off-by: Gergely Nagy --- examples/Cycle/Cycle.ino | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/examples/Cycle/Cycle.ino b/examples/Cycle/Cycle.ino index 6f34d3a1..1c70f38b 100644 --- a/examples/Cycle/Cycle.ino +++ b/examples/Cycle/Cycle.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, Key_Cycle, From 6a8eb4dd482d6e5fc03c5e24aa9f39ddc9c875f3 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 27 Jan 2017 23:01:25 +0100 Subject: [PATCH 05/36] Use the new, double-add protected hook functions Signed-off-by: Gergely Nagy --- src/Akela/Cycle.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Akela/Cycle.cpp b/src/Akela/Cycle.cpp index a2140ec0..fc85b664 100644 --- a/src/Akela/Cycle.cpp +++ b/src/Akela/Cycle.cpp @@ -36,7 +36,7 @@ namespace Akela { void Cycle::begin (void) { - event_handler_hook_add (this->eventHandlerHook); + event_handler_hook_use (this->eventHandlerHook); } void From c03725e736b890839fb76e0835c0667102fc5ef7 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 11 Feb 2017 22:32:18 +0100 Subject: [PATCH 06/36] The Big Rename Rename the library to Kaleidoscope-Cycle, and follow up with other renames, too. Signed-off-by: Gergely Nagy --- README.md | 10 +++++----- examples/Cycle/Cycle.ino | 11 ++++++----- library.properties | 10 +++++----- src/{Akela-Cycle.h => Kaleidoscope-Cycle.h} | 4 ++-- src/{Akela => Kaleidoscope}/Cycle.cpp | 11 ++++++----- src/{Akela => Kaleidoscope}/Cycle.h | 12 ++++++------ 6 files changed, 30 insertions(+), 28 deletions(-) rename src/{Akela-Cycle.h => Kaleidoscope-Cycle.h} (87%) rename src/{Akela => Kaleidoscope}/Cycle.cpp (90%) rename src/{Akela => Kaleidoscope}/Cycle.h (81%) diff --git a/README.md b/README.md index e998e6f2..d4f513de 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Akela-Cycle +# Kaleidoscope-Cycle ![status][st:stable] @@ -24,7 +24,7 @@ each time the cycling key triggers. [cycleaction]: #cycleactionpreviouskey-cyclecount ```c++ -#include +#include // Somewhere in the keymap: Key_Cycle @@ -37,9 +37,9 @@ void cycleAction (Key previousKey, uint8_t cycleCount) { } void setup (void) { - Keyboardio.setup (KEYMAP_SIZE); + Kaleidoscope.setup (KEYMAP_SIZE); - Keyboardio.use (&Cycle, NULL); + Kaleidoscope.use (&Cycle, NULL); } ``` @@ -96,4 +96,4 @@ method explained below. Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/keyboardio/Akela-Cycle/blob/master/examples/Cycle/Cycle.ino + [plugin:example]: https://github.com/keyboardio/Kaleidoscope-Cycle/blob/master/examples/Cycle/Cycle.ino diff --git a/examples/Cycle/Cycle.ino b/examples/Cycle/Cycle.ino index 1c70f38b..67122b23 100644 --- a/examples/Cycle/Cycle.ino +++ b/examples/Cycle/Cycle.ino @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Cycle -- Key sequence cycling dead key for Kaleidoscope. * 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 @@ -53,11 +54,11 @@ void cycleAction (Key previousKey, uint8_t cycleCount) { } void setup () { - Keyboardio.setup (KEYMAP_SIZE); + Kaleidoscope.setup (KEYMAP_SIZE); - Keyboardio.use (&Cycle, NULL); + Kaleidoscope.use (&Cycle, NULL); } void loop () { - Keyboardio.loop (); + Kaleidoscope.loop (); } diff --git a/library.properties b/library.properties index 793ec03d..886173eb 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ -name=Akela-Cycle +name=Kaleidoscope-Cycle version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy -sentence=Key sequence cycling dead key. -paragraph=Key sequence cycling dead key. +maintainer=Gergely Nagy +sentence=Key sequence cycling dead key for Kaleidoscope. +paragraph=Key sequence cycling dead key for Kaleidoscope. category=Communication -url=https://github.com/keyboardio/Akela-Cycle +url=https://github.com/keyboardio/Kaleidoscope-Cycle architectures=avr dot_a_linkage=true diff --git a/src/Akela-Cycle.h b/src/Kaleidoscope-Cycle.h similarity index 87% rename from src/Akela-Cycle.h rename to src/Kaleidoscope-Cycle.h index 4eb036f4..b3a86460 100644 --- a/src/Akela-Cycle.h +++ b/src/Kaleidoscope-Cycle.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Cycle -- Key sequence cycling dead key for Kaleidoscope. * 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/Cycle.cpp b/src/Kaleidoscope/Cycle.cpp similarity index 90% rename from src/Akela/Cycle.cpp rename to src/Kaleidoscope/Cycle.cpp index fc85b664..01bac302 100644 --- a/src/Akela/Cycle.cpp +++ b/src/Kaleidoscope/Cycle.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Cycle -- Key sequence cycling dead key for Kaleidoscope. * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,11 +16,12 @@ * along with this program. If not, see . */ -#include +#include +#include -using namespace Akela::Ranges; +using namespace KaleidoscopePlugins::Ranges; -namespace Akela { +namespace KaleidoscopePlugins { // --- state --- Key Cycle::lastNonCycleKey; uint8_t Cycle::cycleCount; @@ -96,4 +97,4 @@ void cycleAction (Key previousKey, uint8_t cycleCount) { } -Akela::Cycle Cycle; +KaleidoscopePlugins::Cycle Cycle; diff --git a/src/Akela/Cycle.h b/src/Kaleidoscope/Cycle.h similarity index 81% rename from src/Akela/Cycle.h rename to src/Kaleidoscope/Cycle.h index 4b98d831..04e3158a 100644 --- a/src/Akela/Cycle.h +++ b/src/Kaleidoscope/Cycle.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Cycle -- Key sequence cycling dead key for Kaleidoscope. * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -18,17 +18,17 @@ #pragma once -#include +#include -#define Key_Cycle (Key){ .raw = Akela::Ranges::CYCLE } +#define Key_Cycle (Key){ .raw = KaleidoscopePlugins::Ranges::CYCLE } #define cycleThrough(...) ({ \ static const Key __k[] PROGMEM = { __VA_ARGS__ }; \ Cycle.replace (sizeof (__k) / sizeof (Key), &__k[0]); \ }) -namespace Akela { - class Cycle : public KeyboardioPlugin { +namespace KaleidoscopePlugins { + class Cycle : public KaleidoscopePlugin { public: Cycle (void); @@ -47,4 +47,4 @@ namespace Akela { void cycleAction (Key previousKey, uint8_t cycleCount); -extern Akela::Cycle Cycle; +extern KaleidoscopePlugins::Cycle Cycle; From f479458b8c7d2306b9749cc11163ccda0a2c2dd0 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Feb 2017 11:02:20 +0100 Subject: [PATCH 07/36] 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 d4f513de..2b627736 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # Kaleidoscope-Cycle -![status][st:stable] +![status][st:stable] [![Build Status][travis:image]][travis:status] + + [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-Cycle.svg?branch=master + [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-Cycle [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 efe24269612d304caa751fe3ecb7d54507db908f Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 20 Mar 2017 12:34:22 +0100 Subject: [PATCH 08/36] 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 2b627736..be34bc31 100644 --- a/README.md +++ b/README.md @@ -94,6 +94,10 @@ method explained below. > expected - action is to call `cycleThrough()` with a different sequence for > each key we want to use together with the cycling key. +## Dependencies + +* [Kaleidoscope-Ranges](https://github.com/keyboardio/Kaleidoscope-Ranges) + ## Further reading Starting from the [example][plugin:example] is the recommended way of getting From b34180f4c78eb66e730a0476d7550013c5397047 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 27 Mar 2017 15:30:17 -0700 Subject: [PATCH 09/36] Update to new handle_keyswitch_event API naming --- src/Kaleidoscope/Cycle.cpp | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/Kaleidoscope/Cycle.cpp b/src/Kaleidoscope/Cycle.cpp index 01bac302..f9535ede 100644 --- a/src/Kaleidoscope/Cycle.cpp +++ b/src/Kaleidoscope/Cycle.cpp @@ -42,14 +42,14 @@ namespace KaleidoscopePlugins { void Cycle::replace (Key key) { - handle_key_event (Key_Backspace, 255, 255, IS_PRESSED | INJECTED); + handle_keyswitch_event (Key_Backspace, 255, 255, IS_PRESSED | INJECTED); Keyboard.sendReport (); - handle_key_event (Key_Backspace, 255, 255, WAS_PRESSED | INJECTED); + handle_keyswitch_event (Key_Backspace, 255, 255, WAS_PRESSED | INJECTED); Keyboard.sendReport (); - handle_key_event (key, 255, 255, IS_PRESSED | INJECTED); + handle_keyswitch_event (key, 255, 255, IS_PRESSED | INJECTED); Keyboard.sendReport (); - handle_key_event (key, 255, 255, WAS_PRESSED | INJECTED); + handle_keyswitch_event (key, 255, 255, WAS_PRESSED | INJECTED); Keyboard.sendReport (); } From 4a45dc2faf7f016b8813d5b027da635a19792f0b Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 27 Mar 2017 15:31:44 -0700 Subject: [PATCH 10/36] Use UNKNOWN_KEYSWITCH_LOCATION rather than a magic value --- src/Kaleidoscope/Cycle.cpp | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/Kaleidoscope/Cycle.cpp b/src/Kaleidoscope/Cycle.cpp index f9535ede..fd77248a 100644 --- a/src/Kaleidoscope/Cycle.cpp +++ b/src/Kaleidoscope/Cycle.cpp @@ -42,14 +42,14 @@ namespace KaleidoscopePlugins { void Cycle::replace (Key key) { - handle_keyswitch_event (Key_Backspace, 255, 255, IS_PRESSED | INJECTED); + handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); Keyboard.sendReport (); - handle_keyswitch_event (Key_Backspace, 255, 255, WAS_PRESSED | INJECTED); + handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); Keyboard.sendReport (); - handle_keyswitch_event (key, 255, 255, IS_PRESSED | INJECTED); + handle_keyswitch_event (key, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); Keyboard.sendReport (); - handle_keyswitch_event (key, 255, 255, WAS_PRESSED | INJECTED); + handle_keyswitch_event (key, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); Keyboard.sendReport (); } From 7c3d6644b7a9c6ba0d8331190b3d6f1718b5a924 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 22 May 2017 00:37:22 -0700 Subject: [PATCH 11/36] Update to match new Key tables --- examples/Cycle/Cycle.ino | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/examples/Cycle/Cycle.ino b/examples/Cycle/Cycle.ino index 67122b23..f3e6ebf1 100644 --- a/examples/Cycle/Cycle.ino +++ b/examples/Cycle/Cycle.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, Key_Cycle, 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, Key_Cycle ), }; From 903230ec144a3693dd43dd8c54dea03fffcb7922 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 23 May 2017 19:20:14 -0700 Subject: [PATCH 12/36] Update to 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 14d236ed39b83977040577d13e5e09404ebd631b Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Fri, 26 May 2017 16:20:20 -0700 Subject: [PATCH 13/36] make astyle --- examples/Cycle/Cycle.ino | 54 +++++++++++++++++----------------- src/Kaleidoscope/Cycle.cpp | 60 +++++++++++++++++++------------------- src/Kaleidoscope/Cycle.h | 4 +-- 3 files changed, 59 insertions(+), 59 deletions(-) diff --git a/examples/Cycle/Cycle.ino b/examples/Cycle/Cycle.ino index f3e6ebf1..b515f344 100644 --- a/examples/Cycle/Cycle.ino +++ b/examples/Cycle/Cycle.ino @@ -20,45 +20,45 @@ #include const Key keymaps[][ROWS][COLS] PROGMEM = { - [0] = KEYMAP_STACKED - ( - Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, - Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, - Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, - Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, + [0] = KEYMAP_STACKED + ( + Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, + Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, + Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, + Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, - Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, - Key_Cycle, + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, + Key_Cycle, - Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, - Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, - Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, - Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, + Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, + Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, - Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, - Key_Cycle - ), + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, + Key_Cycle + ), }; void cycleAction (Key previousKey, uint8_t cycleCount) { - if (previousKey.raw == Key_E.raw) { - if (cycleCount == 1) { - Cycle.replace (Key_F); - } else if (cycleCount == 2) { - Cycle.replace (Key_G); + if (previousKey.raw == Key_E.raw) { + if (cycleCount == 1) { + Cycle.replace (Key_F); + } else if (cycleCount == 2) { + Cycle.replace (Key_G); + } + } + if (previousKey.raw == Key_A.raw) { + cycleThrough (Key_A, Key_B, Key_C, Key_D); } - } - if (previousKey.raw == Key_A.raw) { - cycleThrough (Key_A, Key_B, Key_C, Key_D); - } } void setup () { - Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.setup (KEYMAP_SIZE); - Kaleidoscope.use (&Cycle, NULL); + Kaleidoscope.use (&Cycle, NULL); } void loop () { - Kaleidoscope.loop (); + Kaleidoscope.loop (); } diff --git a/src/Kaleidoscope/Cycle.cpp b/src/Kaleidoscope/Cycle.cpp index fd77248a..fa215e38 100644 --- a/src/Kaleidoscope/Cycle.cpp +++ b/src/Kaleidoscope/Cycle.cpp @@ -22,26 +22,26 @@ using namespace KaleidoscopePlugins::Ranges; namespace KaleidoscopePlugins { - // --- state --- - Key Cycle::lastNonCycleKey; - uint8_t Cycle::cycleCount; +// --- state --- +Key Cycle::lastNonCycleKey; +uint8_t Cycle::cycleCount; - // --- helpers --- +// --- helpers --- #define isCycle(k) (k.raw == CYCLE) - // --- api --- +// --- api --- - Cycle::Cycle (void) { - } +Cycle::Cycle (void) { +} - void - Cycle::begin (void) { +void +Cycle::begin (void) { event_handler_hook_use (this->eventHandlerHook); - } +} - void - Cycle::replace (Key key) { +void +Cycle::replace (Key key) { handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); Keyboard.sendReport (); handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); @@ -51,45 +51,45 @@ namespace KaleidoscopePlugins { Keyboard.sendReport (); handle_keyswitch_event (key, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); Keyboard.sendReport (); - } +} - void - Cycle::replace (uint8_t cycleSize, const Key cycleSteps[]) { +void +Cycle::replace (uint8_t cycleSize, const Key cycleSteps[]) { uint8_t idx = cycleCount % cycleSize; Key key; key.raw = pgm_read_word (cycleSteps + idx); replace (key); - } +} - // --- hooks --- +// --- hooks --- - Key - Cycle::eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState) { +Key +Cycle::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 (isCycle (mappedKey)) - return Key_NoKey; - return mappedKey; + if (isCycle (mappedKey)) + return Key_NoKey; + return mappedKey; } if (!isCycle (mappedKey)) { - if (key_toggled_on (keyState)) { - lastNonCycleKey.raw = mappedKey.raw; - cycleCount = 0; - } - return mappedKey; + if (key_toggled_on (keyState)) { + lastNonCycleKey.raw = mappedKey.raw; + cycleCount = 0; + } + return mappedKey; } if (!key_toggled_off (keyState)) - return Key_NoKey; + return Key_NoKey; cycleCount++; cycleAction (lastNonCycleKey, cycleCount); return Key_NoKey; - } +} }; __attribute__((weak)) diff --git a/src/Kaleidoscope/Cycle.h b/src/Kaleidoscope/Cycle.h index 04e3158a..6289fa6e 100644 --- a/src/Kaleidoscope/Cycle.h +++ b/src/Kaleidoscope/Cycle.h @@ -28,7 +28,7 @@ }) namespace KaleidoscopePlugins { - class Cycle : public KaleidoscopePlugin { +class Cycle : public KaleidoscopePlugin { public: Cycle (void); @@ -42,7 +42,7 @@ namespace KaleidoscopePlugins { static uint8_t cycleCount; static Key eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState); - }; +}; }; void cycleAction (Key previousKey, uint8_t cycleCount); From 38cf866870a83d5495636f658f21f01e54ebd503 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 3 Jun 2017 09:06:35 +0200 Subject: [PATCH 14/36] Kaleidoscope Style Guide conformance Signed-off-by: Gergely Nagy --- README.md | 19 +++++---- examples/Cycle/Cycle.ino | 52 ++++++++++++------------ src/Kaleidoscope/Cycle.cpp | 81 +++++++++++++++++--------------------- src/Kaleidoscope/Cycle.h | 25 ++++++------ 4 files changed, 84 insertions(+), 93 deletions(-) diff --git a/README.md b/README.md index be34bc31..966c587f 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,9 @@ [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-Cycle.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-Cycle - [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 If you ever wanted a key that works like keys on old cell phones, when you press a key and it cycles through a number of options in a sequence, then the cycling @@ -33,16 +33,15 @@ each time the cycling key triggers. Key_Cycle // later in the Sketch: -void cycleAction (Key previousKey, uint8_t cycleCount) { - if (previousKey.raw == Key_A.raw) { +void cycleAction(Key previous_key, uint8_t cycle_count) { + if (previous_key.raw == Key_A.raw) { cycleThrough (Key_B, Key_C, Key_D); } } -void setup (void) { - Kaleidoscope.setup (KEYMAP_SIZE); - - Kaleidoscope.use (&Cycle, NULL); +void setup(void) { + USE_PLUGINS(&Cycle); + Kaleidoscope.setup(); } ``` @@ -83,7 +82,7 @@ method explained below. ## Overrideable methods -### `cycleAction(previousKey, cycleCount)` +### `cycleAction(previous_key, cycle_count)` > The heart and soul of the plugin, that must be defined in the Sketch. It will > be called whenever the cycling key triggers, and the two arguments are the diff --git a/examples/Cycle/Cycle.ino b/examples/Cycle/Cycle.ino index b515f344..b31fb593 100644 --- a/examples/Cycle/Cycle.ino +++ b/examples/Cycle/Cycle.ino @@ -21,44 +21,42 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED - ( - Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, - Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, - Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, - Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, + (Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, + Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, + Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, + Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, - Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, - Key_Cycle, + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, + Key_Cycle, - Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, - Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, - Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, - Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, + Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, + Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, - Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, - Key_Cycle - ), + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, + Key_Cycle), }; -void cycleAction (Key previousKey, uint8_t cycleCount) { - if (previousKey.raw == Key_E.raw) { - if (cycleCount == 1) { - Cycle.replace (Key_F); - } else if (cycleCount == 2) { - Cycle.replace (Key_G); +void cycleAction(Key previous_key, uint8_t cycle_count) { + if (previous_key.raw == Key_E.raw) { + if (cycle_count == 1) { + Cycle.replace(Key_F); + } else if (cycle_count == 2) { + Cycle.replace(Key_G); } } - if (previousKey.raw == Key_A.raw) { - cycleThrough (Key_A, Key_B, Key_C, Key_D); + if (previous_key.raw == Key_A.raw) { + cycleThrough(Key_A, Key_B, Key_C, Key_D); } } -void setup () { - Kaleidoscope.setup (KEYMAP_SIZE); +void setup() { + USE_PLUGINS(&Cycle); - Kaleidoscope.use (&Cycle, NULL); + Kaleidoscope.setup(); } -void loop () { - Kaleidoscope.loop (); +void loop() { + Kaleidoscope.loop(); } diff --git a/src/Kaleidoscope/Cycle.cpp b/src/Kaleidoscope/Cycle.cpp index fa215e38..be1adf1d 100644 --- a/src/Kaleidoscope/Cycle.cpp +++ b/src/Kaleidoscope/Cycle.cpp @@ -19,82 +19,75 @@ #include #include -using namespace KaleidoscopePlugins::Ranges; - -namespace KaleidoscopePlugins { +namespace kaleidoscope { // --- state --- -Key Cycle::lastNonCycleKey; -uint8_t Cycle::cycleCount; +Key Cycle::last_non_cycle_key_; +uint8_t Cycle::cycle_count_; // --- helpers --- -#define isCycle(k) (k.raw == CYCLE) +#define isCycle(k) (k.raw == KaleidoscopePlugins::Ranges::CYCLE) // --- api --- -Cycle::Cycle (void) { +Cycle::Cycle(void) { } -void -Cycle::begin (void) { - event_handler_hook_use (this->eventHandlerHook); +void Cycle::begin(void) { + event_handler_hook_use(eventHandlerHook); } -void -Cycle::replace (Key key) { - handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); - Keyboard.sendReport (); - handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); - Keyboard.sendReport (); - - handle_keyswitch_event (key, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); - Keyboard.sendReport (); - handle_keyswitch_event (key, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); - Keyboard.sendReport (); +void Cycle::replace(Key key) { + handle_keyswitch_event(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); + Keyboard.sendReport(); + handle_keyswitch_event(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); + Keyboard.sendReport(); + + handle_keyswitch_event(key, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); + Keyboard.sendReport(); + handle_keyswitch_event(key, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); + Keyboard.sendReport(); } -void -Cycle::replace (uint8_t cycleSize, const Key cycleSteps[]) { - uint8_t idx = cycleCount % cycleSize; +void Cycle::replace(uint8_t cycle_size, const Key cycle_steps[]) { + uint8_t idx = cycle_count_ % cycle_size; Key key; - key.raw = pgm_read_word (cycleSteps + idx); - replace (key); + key.raw = pgm_read_word(cycle_steps + idx); + replace(key); } // --- hooks --- -Key -Cycle::eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState) { - if (keyState & INJECTED) - return mappedKey; +Key Cycle::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 (isCycle (mappedKey)) + if (!key_is_pressed(key_state) && !key_was_pressed(key_state)) { + if (isCycle(mapped_key)) return Key_NoKey; - return mappedKey; + return mapped_key; } - if (!isCycle (mappedKey)) { - if (key_toggled_on (keyState)) { - lastNonCycleKey.raw = mappedKey.raw; - cycleCount = 0; + if (!isCycle(mapped_key)) { + if (key_toggled_on(key_state)) { + last_non_cycle_key_.raw = mapped_key.raw; + cycle_count_ = 0; } - return mappedKey; + return mapped_key; } - if (!key_toggled_off (keyState)) + if (!key_toggled_off(key_state)) return Key_NoKey; - cycleCount++; - cycleAction (lastNonCycleKey, cycleCount); + ++cycle_count_; + cycleAction(last_non_cycle_key_, cycle_count_); return Key_NoKey; } }; __attribute__((weak)) -void -cycleAction (Key previousKey, uint8_t cycleCount) { +void cycleAction(Key previous_key, uint8_t cycle_count) { } -KaleidoscopePlugins::Cycle Cycle; +kaleidoscope::Cycle Cycle; diff --git a/src/Kaleidoscope/Cycle.h b/src/Kaleidoscope/Cycle.h index 6289fa6e..ece5deb5 100644 --- a/src/Kaleidoscope/Cycle.h +++ b/src/Kaleidoscope/Cycle.h @@ -18,33 +18,34 @@ #pragma once +#include #include -#define Key_Cycle (Key){ .raw = KaleidoscopePlugins::Ranges::CYCLE } +#define Key_Cycle ((Key) { .raw = KaleidoscopePlugins::Ranges::CYCLE }) #define cycleThrough(...) ({ \ static const Key __k[] PROGMEM = { __VA_ARGS__ }; \ - Cycle.replace (sizeof (__k) / sizeof (Key), &__k[0]); \ + Cycle.replace(sizeof(__k) / sizeof(Key), &__k[0]); \ }) -namespace KaleidoscopePlugins { +namespace kaleidoscope { class Cycle : public KaleidoscopePlugin { public: - Cycle (void); + Cycle(void); - virtual void begin (void) final; + void begin(void) final; - static void replace (Key key); - static void replace (uint8_t cycleSize, const Key cycleSteps[]); + static void replace(Key key); + static void replace(uint8_t cycle_size, const Key cycle_steps[]); private: - static Key lastNonCycleKey; - static uint8_t cycleCount; + static Key last_non_cycle_key_; + static uint8_t cycle_count_; - static Key eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState); + static Key eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state); }; }; -void cycleAction (Key previousKey, uint8_t cycleCount); +void cycleAction(Key previous_key, uint8_t cycle_count); -extern KaleidoscopePlugins::Cycle Cycle; +extern kaleidoscope::Cycle Cycle; From 3b4e2add7d028cad6f6a546447f708cc40709afd Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 3 Jun 2017 10:43:16 +0200 Subject: [PATCH 15/36] Conform to the latest Kaleidoscope Style Guide Signed-off-by: Gergely Nagy --- examples/Cycle/Cycle.ino | 56 +++++++++++++++---------------- src/Kaleidoscope/Cycle.cpp | 68 +++++++++++++++++++------------------- src/Kaleidoscope/Cycle.h | 18 +++++----- 3 files changed, 71 insertions(+), 71 deletions(-) diff --git a/examples/Cycle/Cycle.ino b/examples/Cycle/Cycle.ino index b31fb593..49a206b9 100644 --- a/examples/Cycle/Cycle.ino +++ b/examples/Cycle/Cycle.ino @@ -20,43 +20,43 @@ #include const Key keymaps[][ROWS][COLS] PROGMEM = { - [0] = KEYMAP_STACKED - (Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, - Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, - Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, - Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, - - Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, - Key_Cycle, - - Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, - Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, - Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, - Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, - - Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, - Key_Cycle), + [0] = KEYMAP_STACKED + (Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, + Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, + Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, + Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, + + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, + Key_Cycle, + + Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, + Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, + + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, + Key_Cycle), }; void cycleAction(Key previous_key, uint8_t cycle_count) { - if (previous_key.raw == Key_E.raw) { - if (cycle_count == 1) { - Cycle.replace(Key_F); - } else if (cycle_count == 2) { - Cycle.replace(Key_G); - } - } - if (previous_key.raw == Key_A.raw) { - cycleThrough(Key_A, Key_B, Key_C, Key_D); + if (previous_key.raw == Key_E.raw) { + if (cycle_count == 1) { + Cycle.replace(Key_F); + } else if (cycle_count == 2) { + Cycle.replace(Key_G); } + } + if (previous_key.raw == Key_A.raw) { + cycleThrough(Key_A, Key_B, Key_C, Key_D); + } } void setup() { - USE_PLUGINS(&Cycle); + USE_PLUGINS(&Cycle); - Kaleidoscope.setup(); + Kaleidoscope.setup(); } void loop() { - Kaleidoscope.loop(); + Kaleidoscope.loop(); } diff --git a/src/Kaleidoscope/Cycle.cpp b/src/Kaleidoscope/Cycle.cpp index be1adf1d..c1deff39 100644 --- a/src/Kaleidoscope/Cycle.cpp +++ b/src/Kaleidoscope/Cycle.cpp @@ -34,55 +34,55 @@ Cycle::Cycle(void) { } void Cycle::begin(void) { - event_handler_hook_use(eventHandlerHook); + event_handler_hook_use(eventHandlerHook); } void Cycle::replace(Key key) { - handle_keyswitch_event(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); - Keyboard.sendReport(); - handle_keyswitch_event(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); - Keyboard.sendReport(); - - handle_keyswitch_event(key, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); - Keyboard.sendReport(); - handle_keyswitch_event(key, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); - Keyboard.sendReport(); + handle_keyswitch_event(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); + Keyboard.sendReport(); + handle_keyswitch_event(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); + Keyboard.sendReport(); + + handle_keyswitch_event(key, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); + Keyboard.sendReport(); + handle_keyswitch_event(key, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); + Keyboard.sendReport(); } void Cycle::replace(uint8_t cycle_size, const Key cycle_steps[]) { - uint8_t idx = cycle_count_ % cycle_size; - Key key; + uint8_t idx = cycle_count_ % cycle_size; + Key key; - key.raw = pgm_read_word(cycle_steps + idx); - replace(key); + key.raw = pgm_read_word(cycle_steps + idx); + replace(key); } // --- hooks --- Key Cycle::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state) { - if (key_state & INJECTED) - return mapped_key; - - if (!key_is_pressed(key_state) && !key_was_pressed(key_state)) { - if (isCycle(mapped_key)) - return Key_NoKey; - return mapped_key; - } - - if (!isCycle(mapped_key)) { - if (key_toggled_on(key_state)) { - last_non_cycle_key_.raw = mapped_key.raw; - cycle_count_ = 0; - } - return mapped_key; + if (key_state & INJECTED) + return mapped_key; + + if (!key_is_pressed(key_state) && !key_was_pressed(key_state)) { + if (isCycle(mapped_key)) + return Key_NoKey; + return mapped_key; + } + + if (!isCycle(mapped_key)) { + if (key_toggled_on(key_state)) { + last_non_cycle_key_.raw = mapped_key.raw; + cycle_count_ = 0; } + return mapped_key; + } - if (!key_toggled_off(key_state)) - return Key_NoKey; - - ++cycle_count_; - cycleAction(last_non_cycle_key_, cycle_count_); + if (!key_toggled_off(key_state)) return Key_NoKey; + + ++cycle_count_; + cycleAction(last_non_cycle_key_, cycle_count_); + return Key_NoKey; } }; diff --git a/src/Kaleidoscope/Cycle.h b/src/Kaleidoscope/Cycle.h index ece5deb5..2ed4632f 100644 --- a/src/Kaleidoscope/Cycle.h +++ b/src/Kaleidoscope/Cycle.h @@ -30,19 +30,19 @@ namespace kaleidoscope { class Cycle : public KaleidoscopePlugin { - public: - Cycle(void); + public: + Cycle(void); - void begin(void) final; + void begin(void) final; - static void replace(Key key); - static void replace(uint8_t cycle_size, const Key cycle_steps[]); + static void replace(Key key); + static void replace(uint8_t cycle_size, const Key cycle_steps[]); - private: - static Key last_non_cycle_key_; - static uint8_t cycle_count_; + private: + static Key last_non_cycle_key_; + static uint8_t cycle_count_; - static Key eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state); + static Key eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state); }; }; From 492c4a2c5ac2bfca28175ed9459a2f0e54a24d14 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 4 Jun 2017 12:22:57 +0200 Subject: [PATCH 16/36] README.md: Minor style adjustment Signed-off-by: Gergely Nagy --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 966c587f..8ef324df 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,7 @@ void cycleAction(Key previous_key, uint8_t cycle_count) { void setup(void) { USE_PLUGINS(&Cycle); + Kaleidoscope.setup(); } ``` From e6543b2011f078e59aefff1346c3908d5aa6bbb7 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 5 Jun 2017 10:38:58 +0200 Subject: [PATCH 17/36] Updated to use the newest Ranges APIs Signed-off-by: Gergely Nagy --- src/Kaleidoscope/Cycle.cpp | 2 +- src/Kaleidoscope/Cycle.h | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Kaleidoscope/Cycle.cpp b/src/Kaleidoscope/Cycle.cpp index c1deff39..3fe85b6b 100644 --- a/src/Kaleidoscope/Cycle.cpp +++ b/src/Kaleidoscope/Cycle.cpp @@ -26,7 +26,7 @@ uint8_t Cycle::cycle_count_; // --- helpers --- -#define isCycle(k) (k.raw == KaleidoscopePlugins::Ranges::CYCLE) +#define isCycle(k) (k.raw == kaleidoscope::ranges::CYCLE) // --- api --- diff --git a/src/Kaleidoscope/Cycle.h b/src/Kaleidoscope/Cycle.h index 2ed4632f..aca7aaa1 100644 --- a/src/Kaleidoscope/Cycle.h +++ b/src/Kaleidoscope/Cycle.h @@ -21,7 +21,7 @@ #include #include -#define Key_Cycle ((Key) { .raw = KaleidoscopePlugins::Ranges::CYCLE }) +#define Key_Cycle ((Key) { .raw = kaleidoscope::ranges::CYCLE }) #define cycleThrough(...) ({ \ static const Key __k[] PROGMEM = { __VA_ARGS__ }; \ From 855ac5fa19fc90583b20bfcf255333f8d295fda9 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 24 Jul 2017 14:03:06 -0700 Subject: [PATCH 18/36] keyToggledO* camelcasing --- src/Kaleidoscope/Cycle.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Kaleidoscope/Cycle.cpp b/src/Kaleidoscope/Cycle.cpp index 3fe85b6b..f68150d9 100644 --- a/src/Kaleidoscope/Cycle.cpp +++ b/src/Kaleidoscope/Cycle.cpp @@ -70,14 +70,14 @@ Key Cycle::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_stat } if (!isCycle(mapped_key)) { - if (key_toggled_on(key_state)) { + if (keyToggledOn(key_state)) { last_non_cycle_key_.raw = mapped_key.raw; cycle_count_ = 0; } return mapped_key; } - if (!key_toggled_off(key_state)) + if (!keyToggledOff(key_state)) return Key_NoKey; ++cycle_count_; From cad621194fa1fe66eceec83385a6d82c3989b1a3 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 24 Jul 2017 14:15:51 -0700 Subject: [PATCH 19/36] CamelCase of KeyIsPressed and KeyWasPressed --- src/Kaleidoscope/Cycle.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/Cycle.cpp b/src/Kaleidoscope/Cycle.cpp index f68150d9..f79e2d71 100644 --- a/src/Kaleidoscope/Cycle.cpp +++ b/src/Kaleidoscope/Cycle.cpp @@ -63,7 +63,7 @@ Key Cycle::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_stat 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 (isCycle(mapped_key)) return Key_NoKey; return mapped_key; From 0f3e63f8be0da0b63db8a52460d348096427020c Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 24 Jul 2017 14:36:15 -0700 Subject: [PATCH 20/36] CamelCase of handle_*_key* --- src/Kaleidoscope/Cycle.cpp | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/Kaleidoscope/Cycle.cpp b/src/Kaleidoscope/Cycle.cpp index f79e2d71..2f2c53c3 100644 --- a/src/Kaleidoscope/Cycle.cpp +++ b/src/Kaleidoscope/Cycle.cpp @@ -38,14 +38,14 @@ void Cycle::begin(void) { } void Cycle::replace(Key key) { - handle_keyswitch_event(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); + handleKeyswitchEvent(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); Keyboard.sendReport(); - handle_keyswitch_event(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); + handleKeyswitchEvent(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); Keyboard.sendReport(); - handle_keyswitch_event(key, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); + handleKeyswitchEvent(key, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); Keyboard.sendReport(); - handle_keyswitch_event(key, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); + handleKeyswitchEvent(key, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); Keyboard.sendReport(); } From e5f9929ed0fff0d478e0246ed64ff2fe74ea8615 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 25 Jul 2017 13:28:06 -0700 Subject: [PATCH 21/36] Port to new kaleidoscope::hid facade --- src/Kaleidoscope/Cycle.cpp | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/Kaleidoscope/Cycle.cpp b/src/Kaleidoscope/Cycle.cpp index 2f2c53c3..38eb6fab 100644 --- a/src/Kaleidoscope/Cycle.cpp +++ b/src/Kaleidoscope/Cycle.cpp @@ -18,6 +18,7 @@ #include #include +#include "kaleidoscope/hid.h" namespace kaleidoscope { // --- state --- @@ -39,14 +40,14 @@ void Cycle::begin(void) { void Cycle::replace(Key key) { handleKeyswitchEvent(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); - Keyboard.sendReport(); + hid::sendKeyboardReport(); handleKeyswitchEvent(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); - Keyboard.sendReport(); + hid::sendKeyboardReport(); handleKeyswitchEvent(key, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); - Keyboard.sendReport(); + hid::sendKeyboardReport(); handleKeyswitchEvent(key, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); - Keyboard.sendReport(); + hid::sendKeyboardReport(); } void Cycle::replace(uint8_t cycle_size, const Key cycle_steps[]) { From 997b3a58e0aba8d857610f5defac0d16c2d6409e Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 25 Jul 2017 15:52:03 -0700 Subject: [PATCH 22/36] 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 0cb75c5e7ff03734678e88254b7625e4dcc698c0 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 17 Aug 2017 11:42:03 +0200 Subject: [PATCH 23/36] Stop using obsolete functions `USE_PLUGINS` and `event_handler_hook_use` are being phased out, stop using them. Signed-off-by: Gergely Nagy --- README.md | 2 +- examples/Cycle/Cycle.ino | 2 +- src/Kaleidoscope/Cycle.cpp | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8ef324df..2f5d166b 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ void cycleAction(Key previous_key, uint8_t cycle_count) { } void setup(void) { - USE_PLUGINS(&Cycle); + Kaleidoscope.use(&Cycle); Kaleidoscope.setup(); } diff --git a/examples/Cycle/Cycle.ino b/examples/Cycle/Cycle.ino index 49a206b9..8d1d7f8f 100644 --- a/examples/Cycle/Cycle.ino +++ b/examples/Cycle/Cycle.ino @@ -52,7 +52,7 @@ void cycleAction(Key previous_key, uint8_t cycle_count) { } void setup() { - USE_PLUGINS(&Cycle); + Kaleidoscope.use(&Cycle); Kaleidoscope.setup(); } diff --git a/src/Kaleidoscope/Cycle.cpp b/src/Kaleidoscope/Cycle.cpp index 38eb6fab..9bdc13a5 100644 --- a/src/Kaleidoscope/Cycle.cpp +++ b/src/Kaleidoscope/Cycle.cpp @@ -35,7 +35,7 @@ Cycle::Cycle(void) { } void Cycle::begin(void) { - event_handler_hook_use(eventHandlerHook); + Kaleidoscope.useEventHandlerHook(eventHandlerHook); } void Cycle::replace(Key key) { From 8431bed1ed6110e6b664a28a638b4595a1750ea9 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 21 Aug 2017 22:22:39 -0700 Subject: [PATCH 24/36] 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 191ecdb0000c4f334c80652cbd2c9edd0cbd9218 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 12 May 2018 10:44:12 +0200 Subject: [PATCH 25/36] Updated to use the new plugin APIs Signed-off-by: Gergely Nagy --- README.md | 4 ++-- examples/Cycle/Cycle.ino | 6 +++--- src/Kaleidoscope/Cycle.cpp | 42 +++++++++++++++++++++++--------------- src/Kaleidoscope/Cycle.h | 18 +++++++++------- 4 files changed, 42 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 2f5d166b..bf362830 100644 --- a/README.md +++ b/README.md @@ -39,9 +39,9 @@ void cycleAction(Key previous_key, uint8_t cycle_count) { } } -void setup(void) { - Kaleidoscope.use(&Cycle); +KALEIDOSCOPE_INIT_PLUGINS(Cycle); +void setup(void) { Kaleidoscope.setup(); } ``` diff --git a/examples/Cycle/Cycle.ino b/examples/Cycle/Cycle.ino index 8d1d7f8f..cbca3a3c 100644 --- a/examples/Cycle/Cycle.ino +++ b/examples/Cycle/Cycle.ino @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Cycle -- Key sequence cycling dead key for Kaleidoscope. - * 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 @@ -51,9 +51,9 @@ void cycleAction(Key previous_key, uint8_t cycle_count) { } } -void setup() { - Kaleidoscope.use(&Cycle); +KALEIDOSCOPE_INIT_PLUGINS(Cycle); +void setup() { Kaleidoscope.setup(); } diff --git a/src/Kaleidoscope/Cycle.cpp b/src/Kaleidoscope/Cycle.cpp index 9bdc13a5..fa920d2c 100644 --- a/src/Kaleidoscope/Cycle.cpp +++ b/src/Kaleidoscope/Cycle.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Cycle -- Key sequence cycling dead key for Kaleidoscope. - * 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 @@ -31,13 +31,6 @@ uint8_t Cycle::cycle_count_; // --- api --- -Cycle::Cycle(void) { -} - -void Cycle::begin(void) { - Kaleidoscope.useEventHandlerHook(eventHandlerHook); -} - void Cycle::replace(Key key) { handleKeyswitchEvent(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); hid::sendKeyboardReport(); @@ -60,14 +53,15 @@ void Cycle::replace(uint8_t cycle_size, const Key cycle_steps[]) { // --- hooks --- -Key Cycle::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state) { +EventHandlerResult Cycle::onKeyswitchEvent(Key &mapped_key, byte row, byte col, uint8_t key_state) { if (key_state & INJECTED) - return mapped_key; + return EventHandlerResult::OK; if (!keyIsPressed(key_state) && !keyWasPressed(key_state)) { - if (isCycle(mapped_key)) - return Key_NoKey; - return mapped_key; + if (isCycle(mapped_key)) { + return EventHandlerResult::EVENT_CONSUMED; + } + return EventHandlerResult::OK; } if (!isCycle(mapped_key)) { @@ -75,16 +69,32 @@ Key Cycle::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_stat last_non_cycle_key_.raw = mapped_key.raw; cycle_count_ = 0; } - return mapped_key; + return EventHandlerResult::OK; } - if (!keyToggledOff(key_state)) - return Key_NoKey; + if (!keyToggledOff(key_state)) { + return EventHandlerResult::EVENT_CONSUMED; + } ++cycle_count_; cycleAction(last_non_cycle_key_, cycle_count_); + return EventHandlerResult::EVENT_CONSUMED; +} + +#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API +// Deprecated v1 API +void Cycle::begin() { + Kaleidoscope.useEventHandlerHook(legacyEventHandler); +} + +Key Cycle::legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state) { + EventHandlerResult r = ::Cycle.onKeyswitchEvent(mapped_key, row, col, key_state); + if (r == EventHandlerResult::OK) + return mapped_key; return Key_NoKey; } +#endif + }; __attribute__((weak)) diff --git a/src/Kaleidoscope/Cycle.h b/src/Kaleidoscope/Cycle.h index aca7aaa1..c0f306ff 100644 --- a/src/Kaleidoscope/Cycle.h +++ b/src/Kaleidoscope/Cycle.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Cycle -- Key sequence cycling dead key for Kaleidoscope. - * 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 @@ -29,20 +29,24 @@ }) namespace kaleidoscope { -class Cycle : public KaleidoscopePlugin { +class Cycle : public kaleidoscope::Plugin { public: - Cycle(void); - - void begin(void) final; + Cycle(void) {} static void replace(Key key); static void replace(uint8_t cycle_size, const Key cycle_steps[]); + EventHandlerResult onKeyswitchEvent(Key &mapped_key, byte row, byte col, uint8_t key_state); + +#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API + protected: + void begin(); + static Key legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state); +#endif + private: static Key last_non_cycle_key_; static uint8_t cycle_count_; - - static Key eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state); }; }; From 28dc505ef01d0d4b947d932553119c14d438710d Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 17 Jun 2018 10:54:09 +0200 Subject: [PATCH 26/36] 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/Cycle.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/Kaleidoscope/Cycle.h b/src/Kaleidoscope/Cycle.h index c0f306ff..35afcde7 100644 --- a/src/Kaleidoscope/Cycle.h +++ b/src/Kaleidoscope/Cycle.h @@ -39,6 +39,10 @@ class Cycle : public kaleidoscope::Plugin { EventHandlerResult onKeyswitchEvent(Key &mapped_key, byte row, byte col, uint8_t key_state); #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 47c3fbd2ec937b24537b1c1ea8533e23bd643c2f Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 20 Aug 2018 22:54:51 +0200 Subject: [PATCH 27/36] Drop the V1 plugin API compatibility code Signed-off-by: Gergely Nagy --- src/Kaleidoscope/Cycle.cpp | 14 -------------- src/Kaleidoscope/Cycle.h | 10 ---------- 2 files changed, 24 deletions(-) diff --git a/src/Kaleidoscope/Cycle.cpp b/src/Kaleidoscope/Cycle.cpp index fa920d2c..300a4d78 100644 --- a/src/Kaleidoscope/Cycle.cpp +++ b/src/Kaleidoscope/Cycle.cpp @@ -81,20 +81,6 @@ EventHandlerResult Cycle::onKeyswitchEvent(Key &mapped_key, byte row, byte col, return EventHandlerResult::EVENT_CONSUMED; } -#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API -// Deprecated v1 API -void Cycle::begin() { - Kaleidoscope.useEventHandlerHook(legacyEventHandler); -} - -Key Cycle::legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state) { - EventHandlerResult r = ::Cycle.onKeyswitchEvent(mapped_key, row, col, key_state); - if (r == EventHandlerResult::OK) - return mapped_key; - return Key_NoKey; -} -#endif - }; __attribute__((weak)) diff --git a/src/Kaleidoscope/Cycle.h b/src/Kaleidoscope/Cycle.h index 35afcde7..4810d91f 100644 --- a/src/Kaleidoscope/Cycle.h +++ b/src/Kaleidoscope/Cycle.h @@ -38,16 +38,6 @@ class Cycle : public kaleidoscope::Plugin { EventHandlerResult onKeyswitchEvent(Key &mapped_key, byte row, byte col, uint8_t key_state); -#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); -#endif - private: static Key last_non_cycle_key_; static uint8_t cycle_count_; From ff0b9adb3a21c01951aa560b61736e03cd0aa1a4 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:05:48 +0200 Subject: [PATCH 28/36] Relicense under the GPLv3 (only) Signed-off-by: Gergely Nagy --- examples/Cycle/Cycle.ino | 19 +++++++++---------- src/Kaleidoscope-Cycle.h | 19 +++++++++---------- src/Kaleidoscope/Cycle.cpp | 19 +++++++++---------- src/Kaleidoscope/Cycle.h | 19 +++++++++---------- 4 files changed, 36 insertions(+), 40 deletions(-) diff --git a/examples/Cycle/Cycle.ino b/examples/Cycle/Cycle.ino index cbca3a3c..176cb67d 100644 --- a/examples/Cycle/Cycle.ino +++ b/examples/Cycle/Cycle.ino @@ -2,18 +2,17 @@ * Kaleidoscope-Cycle -- Key sequence cycling dead key for Kaleidoscope. * 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-Cycle.h b/src/Kaleidoscope-Cycle.h index b3a86460..f3aab9ac 100644 --- a/src/Kaleidoscope-Cycle.h +++ b/src/Kaleidoscope-Cycle.h @@ -2,18 +2,17 @@ * Kaleidoscope-Cycle -- Key sequence cycling dead key for Kaleidoscope. * 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/Cycle.cpp b/src/Kaleidoscope/Cycle.cpp index 300a4d78..9616a9ba 100644 --- a/src/Kaleidoscope/Cycle.cpp +++ b/src/Kaleidoscope/Cycle.cpp @@ -2,18 +2,17 @@ * Kaleidoscope-Cycle -- Key sequence cycling dead key for Kaleidoscope. * 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/Cycle.h b/src/Kaleidoscope/Cycle.h index 4810d91f..deb2b141 100644 --- a/src/Kaleidoscope/Cycle.h +++ b/src/Kaleidoscope/Cycle.h @@ -2,18 +2,17 @@ * Kaleidoscope-Cycle -- Key sequence cycling dead key for Kaleidoscope. * 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 a07030172228764158821e598400108e73189b0a Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:05:50 +0200 Subject: [PATCH 29/36] 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/Cycle/Cycle.ino | 2 +- library.properties | 2 +- src/Kaleidoscope-Cycle.h | 2 +- src/Kaleidoscope/Cycle.cpp | 2 +- src/Kaleidoscope/Cycle.h | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/examples/Cycle/Cycle.ino b/examples/Cycle/Cycle.ino index 176cb67d..558b2eff 100644 --- a/examples/Cycle/Cycle.ino +++ b/examples/Cycle/Cycle.ino @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Cycle -- Key sequence cycling dead key for Kaleidoscope. - * 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 886173eb..5a67f084 100644 --- a/library.properties +++ b/library.properties @@ -1,7 +1,7 @@ name=Kaleidoscope-Cycle version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy +maintainer=Gergely Nagy sentence=Key sequence cycling dead key for Kaleidoscope. paragraph=Key sequence cycling dead key for Kaleidoscope. category=Communication diff --git a/src/Kaleidoscope-Cycle.h b/src/Kaleidoscope-Cycle.h index f3aab9ac..d8b22f0c 100644 --- a/src/Kaleidoscope-Cycle.h +++ b/src/Kaleidoscope-Cycle.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Cycle -- Key sequence cycling dead key for Kaleidoscope. - * 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/Cycle.cpp b/src/Kaleidoscope/Cycle.cpp index 9616a9ba..4f16408a 100644 --- a/src/Kaleidoscope/Cycle.cpp +++ b/src/Kaleidoscope/Cycle.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Cycle -- Key sequence cycling dead key for Kaleidoscope. - * 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/Cycle.h b/src/Kaleidoscope/Cycle.h index deb2b141..ee85125e 100644 --- a/src/Kaleidoscope/Cycle.h +++ b/src/Kaleidoscope/Cycle.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Cycle -- Key sequence cycling dead key for Kaleidoscope. - * 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 ecfb675682e722b959bd518a3ff1c2d13c4b6c4a Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:05:52 +0200 Subject: [PATCH 30/36] 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 3d40837e01d52b379233c838e55b3635b290dd9e Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 4 Sep 2018 18:24:00 -0700 Subject: [PATCH 31/36] 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 5233a79439de41b8c253552a7b356cd6b2119a6f Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 4 Sep 2018 18:42:29 -0700 Subject: [PATCH 32/36] 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 0d80af6d4b7309616a8d1c30223361d0d358dd3b Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 10 Oct 2018 06:11:41 +0200 Subject: [PATCH 33/36] 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 bf362830..55bc9dc4 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,10 @@ # Kaleidoscope-Cycle -![status][st:stable] [![Build Status][travis:image]][travis:status] +[![Build Status][travis:image]][travis:status] [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-Cycle.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-Cycle - [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 - If you ever wanted a key that works like keys on old cell phones, when you press a key and it cycles through a number of options in a sequence, then the cycling key is what you are looking for. It is a bit different than on cell phones of From 42b73ec686a89cf97b30e86a34f347b1bd25a57a Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 13 Oct 2018 11:34:52 +0200 Subject: [PATCH 34/36] Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/Cycle.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 | 96 +----------------- doc/plugin/Cycle.md | 97 +++++++++++++++++++ src/Kaleidoscope-Cycle.h | 2 +- .../plugin}/Cycle.cpp | 6 +- .../plugin}/Cycle.h | 6 +- 5 files changed, 107 insertions(+), 100 deletions(-) create mode 100644 doc/plugin/Cycle.md rename src/{Kaleidoscope => kaleidoscope/plugin}/Cycle.cpp (97%) rename src/{Kaleidoscope => kaleidoscope/plugin}/Cycle.h (95%) diff --git a/README.md b/README.md index 55bc9dc4..4d54fd53 100644 --- a/README.md +++ b/README.md @@ -5,98 +5,4 @@ [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-Cycle.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-Cycle -If you ever wanted a key that works like keys on old cell phones, when you press -a key and it cycles through a number of options in a sequence, then the cycling -key is what you are looking for. It is a bit different than on cell phones of -old, as it is a separate key, that works in combination of other keys: you press -a key, then the cycle key, and the cycle key will replace the previously input -symbol with another. Keep tapping the cycle key, and it will replace symbols -with new ones, in a loop. - -## Using the plugin - -To use the plugin, we need to include the header, and declare the behaviour -used. Then, we need to place a cycle key or two on the keymap. And finally, we -need to implement the [`cycleAction`][cycleaction] function that gets called -each time the cycling key triggers. - - [cycleaction]: #cycleactionpreviouskey-cyclecount - -```c++ -#include - -// Somewhere in the keymap: -Key_Cycle - -// later in the Sketch: -void cycleAction(Key previous_key, uint8_t cycle_count) { - if (previous_key.raw == Key_A.raw) { - cycleThrough (Key_B, Key_C, Key_D); - } -} - -KALEIDOSCOPE_INIT_PLUGINS(Cycle); - -void setup(void) { - Kaleidoscope.setup(); -} -``` - -## Keymap markup - -### `Key_Cycle` - -> The key code for the cycle key. There can be as many of this on the keymap, as -> many one wants, but they all behave the same. There is little point in having -> more than one on each side. - -## Plugin methods - -The plugin provides a `Cycle` object, but to implement the actions, we need to -define a function ([`cycleAction`][cycleaction]) outside of the object. A -handler, of sorts. The object also provides a helper method to replace the -previous symbol with another. The plugin also provides one macro that is -particularly useful, and in most cases, should be used over the `.replace()` -method explained below. - -### `cycleThrough(keys...)` - -> Cycles through all the possibilities given in `keys` (starting from the -> beginning once it reached the end). This should be used from -> the [`cycleAction`][cycleaction] function, once it is determined what sequence -> to cycle through. -> -> To make the cycling loop complete, the first element of the `keys` list should -> be the one that - when followed by the Cycle key - triggers the action. - -### `.replace(key)` - -> Deletes the previous symbol (by sending a `Backspace`), and inputs the new -> one. This is used by `cycleThrough()` above, behind the scenes. -> -> The recommended method is to use the macro, but in special circumstances, this -> function can be of direct use as well. - -## Overrideable methods - -### `cycleAction(previous_key, cycle_count)` - -> The heart and soul of the plugin, that must be defined in the Sketch. It will -> be called whenever the cycling key triggers, and the two arguments are the -> last key pressed (not counting repeated taps of the cycling key itself), and -> the number of times the cycling key has been pressed. -> -> It is up to us to decide what to do, and when. But the most common - and -> expected - action is to call `cycleThrough()` with a different sequence for -> each key we want to use together with the cycling key. - -## 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-Cycle/blob/master/examples/Cycle/Cycle.ino +See [doc/plugin/Cycle.md](doc/plugin/Cycle.md) for documentation. diff --git a/doc/plugin/Cycle.md b/doc/plugin/Cycle.md new file mode 100644 index 00000000..69a7d00a --- /dev/null +++ b/doc/plugin/Cycle.md @@ -0,0 +1,97 @@ +# Kaleidoscope-Cycle + +If you ever wanted a key that works like keys on old cell phones, when you press +a key and it cycles through a number of options in a sequence, then the cycling +key is what you are looking for. It is a bit different than on cell phones of +old, as it is a separate key, that works in combination of other keys: you press +a key, then the cycle key, and the cycle key will replace the previously input +symbol with another. Keep tapping the cycle key, and it will replace symbols +with new ones, in a loop. + +## Using the plugin + +To use the plugin, we need to include the header, and declare the behaviour +used. Then, we need to place a cycle key or two on the keymap. And finally, we +need to implement the [`cycleAction`][cycleaction] function that gets called +each time the cycling key triggers. + + [cycleaction]: #cycleactionpreviouskey-cyclecount + +```c++ +#include + +// Somewhere in the keymap: +Key_Cycle + +// later in the Sketch: +void cycleAction(Key previous_key, uint8_t cycle_count) { + if (previous_key.raw == Key_A.raw) { + cycleThrough (Key_B, Key_C, Key_D); + } +} + +KALEIDOSCOPE_INIT_PLUGINS(Cycle); + +void setup(void) { + Kaleidoscope.setup(); +} +``` + +## Keymap markup + +### `Key_Cycle` + +> The key code for the cycle key. There can be as many of this on the keymap, as +> many one wants, but they all behave the same. There is little point in having +> more than one on each side. + +## Plugin methods + +The plugin provides a `Cycle` object, but to implement the actions, we need to +define a function ([`cycleAction`][cycleaction]) outside of the object. A +handler, of sorts. The object also provides a helper method to replace the +previous symbol with another. The plugin also provides one macro that is +particularly useful, and in most cases, should be used over the `.replace()` +method explained below. + +### `cycleThrough(keys...)` + +> Cycles through all the possibilities given in `keys` (starting from the +> beginning once it reached the end). This should be used from +> the [`cycleAction`][cycleaction] function, once it is determined what sequence +> to cycle through. +> +> To make the cycling loop complete, the first element of the `keys` list should +> be the one that - when followed by the Cycle key - triggers the action. + +### `.replace(key)` + +> Deletes the previous symbol (by sending a `Backspace`), and inputs the new +> one. This is used by `cycleThrough()` above, behind the scenes. +> +> The recommended method is to use the macro, but in special circumstances, this +> function can be of direct use as well. + +## Overrideable methods + +### `cycleAction(previous_key, cycle_count)` + +> The heart and soul of the plugin, that must be defined in the Sketch. It will +> be called whenever the cycling key triggers, and the two arguments are the +> last key pressed (not counting repeated taps of the cycling key itself), and +> the number of times the cycling key has been pressed. +> +> It is up to us to decide what to do, and when. But the most common - and +> expected - action is to call `cycleThrough()` with a different sequence for +> each key we want to use together with the cycling key. + +## 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-Cycle/blob/master/examples/Cycle/Cycle.ino diff --git a/src/Kaleidoscope-Cycle.h b/src/Kaleidoscope-Cycle.h index d8b22f0c..d66fe39d 100644 --- a/src/Kaleidoscope-Cycle.h +++ b/src/Kaleidoscope-Cycle.h @@ -17,4 +17,4 @@ #pragma once -#include +#include diff --git a/src/Kaleidoscope/Cycle.cpp b/src/kaleidoscope/plugin/Cycle.cpp similarity index 97% rename from src/Kaleidoscope/Cycle.cpp rename to src/kaleidoscope/plugin/Cycle.cpp index 4f16408a..ec279c7b 100644 --- a/src/Kaleidoscope/Cycle.cpp +++ b/src/kaleidoscope/plugin/Cycle.cpp @@ -20,6 +20,7 @@ #include "kaleidoscope/hid.h" namespace kaleidoscope { +namespace plugin { // --- state --- Key Cycle::last_non_cycle_key_; uint8_t Cycle::cycle_count_; @@ -80,10 +81,11 @@ EventHandlerResult Cycle::onKeyswitchEvent(Key &mapped_key, byte row, byte col, return EventHandlerResult::EVENT_CONSUMED; } -}; +} +} __attribute__((weak)) void cycleAction(Key previous_key, uint8_t cycle_count) { } -kaleidoscope::Cycle Cycle; +kaleidoscope::plugin::Cycle Cycle; diff --git a/src/Kaleidoscope/Cycle.h b/src/kaleidoscope/plugin/Cycle.h similarity index 95% rename from src/Kaleidoscope/Cycle.h rename to src/kaleidoscope/plugin/Cycle.h index ee85125e..d5004626 100644 --- a/src/Kaleidoscope/Cycle.h +++ b/src/kaleidoscope/plugin/Cycle.h @@ -28,6 +28,7 @@ }) namespace kaleidoscope { +namespace plugin { class Cycle : public kaleidoscope::Plugin { public: Cycle(void) {} @@ -41,8 +42,9 @@ class Cycle : public kaleidoscope::Plugin { static Key last_non_cycle_key_; static uint8_t cycle_count_; }; -}; +} +} void cycleAction(Key previous_key, uint8_t cycle_count); -extern kaleidoscope::Cycle Cycle; +extern kaleidoscope::plugin::Cycle Cycle; From e020f18bef5175f10ee4928f9a034e9b971aff68 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 13 Oct 2018 11:34:54 +0200 Subject: [PATCH 35/36] 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 4d54fd53..00000000 --- a/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# Kaleidoscope-Cycle - -[![Build Status][travis:image]][travis:status] - - [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-Cycle.svg?branch=master - [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-Cycle - -See [doc/plugin/Cycle.md](doc/plugin/Cycle.md) for documentation. diff --git a/library.properties b/library.properties deleted file mode 100644 index 5a67f084..00000000 --- a/library.properties +++ /dev/null @@ -1,10 +0,0 @@ -name=Kaleidoscope-Cycle -version=0.0.0 -author=Gergely Nagy -maintainer=Gergely Nagy -sentence=Key sequence cycling dead key for Kaleidoscope. -paragraph=Key sequence cycling dead key for Kaleidoscope. -category=Communication -url=https://github.com/keyboardio/Kaleidoscope-Cycle -architectures=avr -dot_a_linkage=true From 7cc911fc4e63bd21106a3cfc5e5454bf8cd14eca Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 17 Oct 2018 23:57:34 +0200 Subject: [PATCH 36/36] 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/Cycle.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/plugin/Cycle.md b/doc/plugin/Cycle.md index 69a7d00a..cdfe9a9c 100644 --- a/doc/plugin/Cycle.md +++ b/doc/plugin/Cycle.md @@ -87,11 +87,11 @@ method explained below. ## 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-Cycle/blob/master/examples/Cycle/Cycle.ino + [plugin:example]: ../../examples/Cycle/Cycle.ino