From fc0a16651f84bcfb3e0473d7a5b3f672c396352e Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 21 Jan 2017 10:45:27 +0100 Subject: [PATCH 01/52] Initial import Extracted from algernon/Model01-Sketch. Signed-off-by: Gergely Nagy --- .gitignore | 2 + COPYING | 674 +++++++++++++++++++++++++++++++ README.md | 42 ++ library.properties | 10 + src/Akela-LED-ActiveModColor.h | 21 + src/Akela/LED-ActiveModColor.cpp | 65 +++ src/Akela/LED-ActiveModColor.h | 37 ++ 7 files changed, 851 insertions(+) create mode 100644 .gitignore create mode 100644 COPYING create mode 100644 README.md create mode 100644 library.properties create mode 100644 src/Akela-LED-ActiveModColor.h create mode 100644 src/Akela/LED-ActiveModColor.cpp create mode 100644 src/Akela/LED-ActiveModColor.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..6c3eacd6 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# Akela-LED-ActiveModColor + +![status][st:experimental] + + [st:stable]: https://img.shields.io/badge/stable-✔-black.png?style=flat&colorA=44cc11&colorB=494e52 + [st:broken]: https://img.shields.io/badge/broken-X-black.png?style=flat&colorA=e05d44&colorB=494e52 + [st:experimental]: https://img.shields.io/badge/experimental----black.png?style=flat&colorA=dfb317&colorB=494e52 + +With this plugin, any active modifier on the keyboard will have the LED under it +highlighted. No matter how the modifier got activated (a key press, a macro, +anything else), the coloring will apply. + +## Using the plugin + +To use the plugin, one needs to include the header, and activate the effect. It +is also possible to use a custom color instead of the white default. + +```c++ +#include + +void setup () { + Keyboardio.setup (KEYMAP_SIZE); + + Keyboardio.use (&ActiveModColorEffect, NULL); + + ActiveModColorEffect.configure ({0x00, 0xff, 0xff}); +} +``` + +It is recommended to place the activation (the `Keyboardio.use` call) of the +plugin last, so that it can reliably override any other plugins that may work +with the LEDs, and apply the highlight over those. + +## Plugin methods + +The plugin provides the `ActiveModColorEffect` object, which has the following +method: + +### `.configure(color)` + +> Set the color to use for highlighting the modifiers. If unset, will use the +> default white color. diff --git a/library.properties b/library.properties new file mode 100644 index 00000000..a938888b --- /dev/null +++ b/library.properties @@ -0,0 +1,10 @@ +name=Akela-LED-ActiveModColor +version=0.0.0 +author=Gergely Nagy +maintainer=Gergely Nagy +sentence=Light up the LEDs under the active modifiers. +paragraph=Supports one-shot and normal modifiers - if it is active, it lights up. +category=Communication +url=https://github.com/algernon/Akela-LED-ActiveModColor +architectures=avr +dot_a_linkage=true diff --git a/src/Akela-LED-ActiveModColor.h b/src/Akela-LED-ActiveModColor.h new file mode 100644 index 00000000..fc6f5506 --- /dev/null +++ b/src/Akela-LED-ActiveModColor.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/LED-ActiveModColor.cpp b/src/Akela/LED-ActiveModColor.cpp new file mode 100644 index 00000000..ba16bcb3 --- /dev/null +++ b/src/Akela/LED-ActiveModColor.cpp @@ -0,0 +1,65 @@ +/* -*- 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 + +namespace Akela { + namespace LEDEffects { + cRGB ActiveModColorEffect::highlightColor = (cRGB) {0xff, 0xff, 0xff}; + + ActiveModColorEffect::ActiveModColorEffect (void) { + } + + void + ActiveModColorEffect::begin (void) { + loop_hook_add (loopHook); + } + + void + ActiveModColorEffect::configure (const cRGB highlightColor_) { + highlightColor = highlightColor_; + } + + void + ActiveModColorEffect::loopHook (bool postClear) { + if (postClear) + return; + + for (byte r = 0; r < ROWS; r++) { + for (byte c = 0; c < COLS; c++) { + Key k = Layer.lookup (r, c); + + if (k.raw >= Akela::Ranges::OSM_FIRST && k.raw <= Akela::Ranges::OSM_LAST) { + uint8_t idx = k.raw - Akela::Ranges::OSM_FIRST; + k.flags = 0; + k.keyCode = Key_LCtrl.keyCode + idx; + } + + if (k.raw < Key_LCtrl.raw || k.raw > Key_RGUI.raw) + continue; + + if (Keyboard.isModifierActive (k.keyCode)) + led_set_crgb_at (r, c, highlightColor); + } + } + } + + }; +}; + +Akela::LEDEffects::ActiveModColorEffect ActiveModColorEffect; diff --git a/src/Akela/LED-ActiveModColor.h b/src/Akela/LED-ActiveModColor.h new file mode 100644 index 00000000..8cfc978a --- /dev/null +++ b/src/Akela/LED-ActiveModColor.h @@ -0,0 +1,37 @@ +/* -*- 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 + +namespace Akela { + namespace LEDEffects { + class ActiveModColorEffect : public KeyboardioPlugin { + public: + ActiveModColorEffect (void); + + static void configure (const cRGB highlightColor); + virtual void begin (void) final; + + private: + static cRGB highlightColor; + static void loopHook (bool postClear); + }; + }; +}; + +extern Akela::LEDEffects::ActiveModColorEffect ActiveModColorEffect; From 9dd4b107c6193df8a1cb268de9cb724762cc8993 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 21 Jan 2017 23:22:53 +0100 Subject: [PATCH 02/52] Move to the keyboardio organization Signed-off-by: Gergely Nagy --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index a938888b..43508d3b 100644 --- a/library.properties +++ b/library.properties @@ -5,6 +5,6 @@ maintainer=Gergely Nagy sentence=Light up the LEDs under the active modifiers. paragraph=Supports one-shot and normal modifiers - if it is active, it lights up. category=Communication -url=https://github.com/algernon/Akela-LED-ActiveModColor +url=https://github.com/keyboardio/Akela-LED-ActiveModColor architectures=avr dot_a_linkage=true From 7956b83e7d56202df844a69700624c741a80f867 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 22 Jan 2017 11:09:28 +0100 Subject: [PATCH 03/52] Add an example Signed-off-by: Gergely Nagy --- README.md | 7 +++ .../LED-ActiveModColor/LED-ActiveModColor.ino | 51 +++++++++++++++++++ 2 files changed, 58 insertions(+) create mode 100644 examples/LED-ActiveModColor/LED-ActiveModColor.ino diff --git a/README.md b/README.md index 6c3eacd6..7a000dfb 100644 --- a/README.md +++ b/README.md @@ -40,3 +40,10 @@ method: > Set the color to use for highlighting the modifiers. If unset, will use the > default white color. + +## Further reading + +Starting from the [example][plugin:example] is the recommended way of getting +started with the plugin. + + [plugin:example]: https://github.com/keyboardio/Akela-LED-ActiveModColor/blob/master/examples/LED-ActiveModColor/LED-ActiveModColor.ino diff --git a/examples/LED-ActiveModColor/LED-ActiveModColor.ino b/examples/LED-ActiveModColor/LED-ActiveModColor.ino new file mode 100644 index 00000000..8dcce250 --- /dev/null +++ b/examples/LED-ActiveModColor/LED-ActiveModColor.ino @@ -0,0 +1,51 @@ +/* -*- 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_skip, + + Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, + Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, + + Key_RShift, Key_RAlt, Key_Space, Key_RCtrl, + Key_skip + ), +}; + +void setup () { + Keyboardio.setup (KEYMAP_SIZE); + Keyboardio.use (&ActiveModColorEffect, NULL); + + ActiveModColorEffect.configure ({0x00, 0xff, 0xff}); +} + +void loop () { + Keyboardio.loop (); +} From 23368b21611a38a5a095d6b8cb49aeaefff67b9b Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 27 Jan 2017 09:34:49 +0100 Subject: [PATCH 04/52] Updated to use the Keyboardio-LEDControl library Signed-off-by: Gergely Nagy --- examples/LED-ActiveModColor/LED-ActiveModColor.ino | 2 +- src/Akela/LED-ActiveModColor.cpp | 2 +- src/Akela/LED-ActiveModColor.h | 1 + 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/examples/LED-ActiveModColor/LED-ActiveModColor.ino b/examples/LED-ActiveModColor/LED-ActiveModColor.ino index 8dcce250..6a6e40d1 100644 --- a/examples/LED-ActiveModColor/LED-ActiveModColor.ino +++ b/examples/LED-ActiveModColor/LED-ActiveModColor.ino @@ -41,7 +41,7 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { void setup () { Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&ActiveModColorEffect, NULL); + Keyboardio.use (&LEDControl, &ActiveModColorEffect, NULL); ActiveModColorEffect.configure ({0x00, 0xff, 0xff}); } diff --git a/src/Akela/LED-ActiveModColor.cpp b/src/Akela/LED-ActiveModColor.cpp index ba16bcb3..579c2b16 100644 --- a/src/Akela/LED-ActiveModColor.cpp +++ b/src/Akela/LED-ActiveModColor.cpp @@ -54,7 +54,7 @@ namespace Akela { continue; if (Keyboard.isModifierActive (k.keyCode)) - led_set_crgb_at (r, c, highlightColor); + LEDControl.led_set_crgb_at (r, c, highlightColor); } } } diff --git a/src/Akela/LED-ActiveModColor.h b/src/Akela/LED-ActiveModColor.h index 8cfc978a..096536c4 100644 --- a/src/Akela/LED-ActiveModColor.h +++ b/src/Akela/LED-ActiveModColor.h @@ -17,6 +17,7 @@ */ #include +#include namespace Akela { namespace LEDEffects { From fbe6293655aff9a3da30db8eeefaf27dfe7a70e2 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 27 Jan 2017 23:01:25 +0100 Subject: [PATCH 05/52] Use the new, double-add protected hook functions Signed-off-by: Gergely Nagy --- src/Akela/LED-ActiveModColor.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Akela/LED-ActiveModColor.cpp b/src/Akela/LED-ActiveModColor.cpp index 579c2b16..7dbd8691 100644 --- a/src/Akela/LED-ActiveModColor.cpp +++ b/src/Akela/LED-ActiveModColor.cpp @@ -27,7 +27,7 @@ namespace Akela { void ActiveModColorEffect::begin (void) { - loop_hook_add (loopHook); + loop_hook_use (loopHook); } void From d5d3b46e31aa03fe11ea80ecf55a32eff48ad771 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 11 Feb 2017 23:14:14 +0100 Subject: [PATCH 06/52] The Big Rename Renamed the library to Kaleidoscope-LED-ActiveModColor, and followed up with other renames. Signed-off-by: Gergely Nagy --- README.md | 13 +++++++------ examples/LED-ActiveModColor/LED-ActiveModColor.ino | 11 ++++++----- library.properties | 6 +++--- ...ModColor.h => Kaleidoscope-LED-ActiveModColor.h} | 4 ++-- src/{Akela => Kaleidoscope}/LED-ActiveModColor.cpp | 13 +++++++------ src/{Akela => Kaleidoscope}/LED-ActiveModColor.h | 12 ++++++------ 6 files changed, 31 insertions(+), 28 deletions(-) rename src/{Akela-LED-ActiveModColor.h => Kaleidoscope-LED-ActiveModColor.h} (85%) rename src/{Akela => Kaleidoscope}/LED-ActiveModColor.cpp (78%) rename src/{Akela => Kaleidoscope}/LED-ActiveModColor.h (75%) diff --git a/README.md b/README.md index 7a000dfb..55382bd0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Akela-LED-ActiveModColor +# Kaleidoscope-LED-ActiveModColor ![status][st:experimental] @@ -16,18 +16,19 @@ To use the plugin, one needs to include the header, and activate the effect. It is also possible to use a custom color instead of the white default. ```c++ -#include +#include +#include void setup () { - Keyboardio.setup (KEYMAP_SIZE); + Kaleidoscope.setup (KEYMAP_SIZE); - Keyboardio.use (&ActiveModColorEffect, NULL); + Kaleidoscope.use (&ActiveModColorEffect, NULL); ActiveModColorEffect.configure ({0x00, 0xff, 0xff}); } ``` -It is recommended to place the activation (the `Keyboardio.use` call) of the +It is recommended to place the activation (the `Kaleidoscope.use` call) of the plugin last, so that it can reliably override any other plugins that may work with the LEDs, and apply the highlight over those. @@ -46,4 +47,4 @@ method: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/keyboardio/Akela-LED-ActiveModColor/blob/master/examples/LED-ActiveModColor/LED-ActiveModColor.ino + [plugin:example]: https://github.com/keyboardio/Kaleidoscope-LED-ActiveModColor/blob/master/examples/LED-ActiveModColor/LED-ActiveModColor.ino diff --git a/examples/LED-ActiveModColor/LED-ActiveModColor.ino b/examples/LED-ActiveModColor/LED-ActiveModColor.ino index 6a6e40d1..69496129 100644 --- a/examples/LED-ActiveModColor/LED-ActiveModColor.ino +++ b/examples/LED-ActiveModColor/LED-ActiveModColor.ino @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-LED-ActiveModColor -- Light up the LEDs under the active modifiers * 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 @@ -40,12 +41,12 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { }; void setup () { - Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&LEDControl, &ActiveModColorEffect, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&LEDControl, &ActiveModColorEffect, NULL); ActiveModColorEffect.configure ({0x00, 0xff, 0xff}); } void loop () { - Keyboardio.loop (); + Kaleidoscope.loop (); } diff --git a/library.properties b/library.properties index 43508d3b..6108b80a 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ -name=Akela-LED-ActiveModColor +name=Kaleidoscope-LED-ActiveModColor version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy +maintainer=Gergely Nagy sentence=Light up the LEDs under the active modifiers. paragraph=Supports one-shot and normal modifiers - if it is active, it lights up. category=Communication -url=https://github.com/keyboardio/Akela-LED-ActiveModColor +url=https://github.com/keyboardio/Kaleidoscope-LED-ActiveModColor architectures=avr dot_a_linkage=true diff --git a/src/Akela-LED-ActiveModColor.h b/src/Kaleidoscope-LED-ActiveModColor.h similarity index 85% rename from src/Akela-LED-ActiveModColor.h rename to src/Kaleidoscope-LED-ActiveModColor.h index fc6f5506..e9a70b39 100644 --- a/src/Akela-LED-ActiveModColor.h +++ b/src/Kaleidoscope-LED-ActiveModColor.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-LED-ActiveModColor -- Light up the LEDs under the active modifiers * 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/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp similarity index 78% rename from src/Akela/LED-ActiveModColor.cpp rename to src/Kaleidoscope/LED-ActiveModColor.cpp index 7dbd8691..0c9e2baa 100644 --- a/src/Akela/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-LED-ActiveModColor -- Light up the LEDs under the active modifiers * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,9 +16,10 @@ * along with this program. If not, see . */ -#include +#include +#include -namespace Akela { +namespace KaleidoscopePlugins { namespace LEDEffects { cRGB ActiveModColorEffect::highlightColor = (cRGB) {0xff, 0xff, 0xff}; @@ -44,8 +45,8 @@ namespace Akela { for (byte c = 0; c < COLS; c++) { Key k = Layer.lookup (r, c); - if (k.raw >= Akela::Ranges::OSM_FIRST && k.raw <= Akela::Ranges::OSM_LAST) { - uint8_t idx = k.raw - Akela::Ranges::OSM_FIRST; + if (k.raw >= KaleidoscopePlugins::Ranges::OSM_FIRST && k.raw <= KaleidoscopePlugins::Ranges::OSM_LAST) { + uint8_t idx = k.raw - KaleidoscopePlugins::Ranges::OSM_FIRST; k.flags = 0; k.keyCode = Key_LCtrl.keyCode + idx; } @@ -62,4 +63,4 @@ namespace Akela { }; }; -Akela::LEDEffects::ActiveModColorEffect ActiveModColorEffect; +KaleidoscopePlugins::LEDEffects::ActiveModColorEffect ActiveModColorEffect; diff --git a/src/Akela/LED-ActiveModColor.h b/src/Kaleidoscope/LED-ActiveModColor.h similarity index 75% rename from src/Akela/LED-ActiveModColor.h rename to src/Kaleidoscope/LED-ActiveModColor.h index 096536c4..ee6abbde 100644 --- a/src/Akela/LED-ActiveModColor.h +++ b/src/Kaleidoscope/LED-ActiveModColor.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-LED-ActiveModColor -- Light up the LEDs under the active modifiers * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,12 +16,12 @@ * along with this program. If not, see . */ -#include -#include +#include +#include -namespace Akela { +namespace KaleidoscopePlugins { namespace LEDEffects { - class ActiveModColorEffect : public KeyboardioPlugin { + class ActiveModColorEffect : public KaleidoscopePlugin { public: ActiveModColorEffect (void); @@ -35,4 +35,4 @@ namespace Akela { }; }; -extern Akela::LEDEffects::ActiveModColorEffect ActiveModColorEffect; +extern KaleidoscopePlugins::LEDEffects::ActiveModColorEffect ActiveModColorEffect; From 79b791d6e70c5bcea5eb2e2b6c98de7ae20bad55 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Feb 2017 11:28:01 +0100 Subject: [PATCH 07/52] Test the plugin with Travis CI Signed-off-by: Gergely Nagy --- .gitignore | 2 ++ .travis.yml | 18 ++++++++++++++++++ README.md | 5 ++++- 3 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 .travis.yml diff --git a/.gitignore b/.gitignore index aead9485..be16c9be 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,4 @@ .#* *~ +/hardware/ +/output/ \ No newline at end of file diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 00000000..77431b24 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,18 @@ +language: cpp +dist: trusty +sudo: required +os: + - linux +before_install: + - pushd .. + - wget http://downloads.arduino.cc/arduino-1.6.11-linux64.tar.xz + - tar xf arduino-1.6.11-linux64.tar.xz + - popd +install: + - git clone --recurse-submodules https://github.com/keyboardio/Arduino-Boards hardware/keyboardio/avr +script: + - export DEFAULT_SKETCH=$(cd examples; basename *) + - export ARDUINO_PATH=$(pwd)/../arduino-1.6.11 + - export BOARD_HARDWARE_PATH=$(pwd)/hardware + - export EXTRA_BUILDER_ARGS="-libraries ." + - hardware/keyboardio/avr/libraries/Kaleidoscope/tools/kaleidoscope-builder build diff --git a/README.md b/README.md index 55382bd0..523ae7bc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # Kaleidoscope-LED-ActiveModColor -![status][st:experimental] +![status][st:experimental] [![Build Status][travis:image]][travis:status] + + [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-LED-ActiveModColor.svg?branch=master + [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-LED-ActiveModColor [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 115c54ef14be3e8b8f3fc70f98da094e6d7e42aa Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 20 Mar 2017 12:49:31 +0100 Subject: [PATCH 08/52] README: Add a "Dependencies" section Signed-off-by: Gergely Nagy --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 523ae7bc..c2aa5720 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,11 @@ method: > Set the color to use for highlighting the modifiers. If unset, will use the > default white color. +## Dependencies + +* [Kaleidoscope-LEDControl](https://github.com/keyboardio/Kaleidoscope-LEDControl) +* [Kaleidoscope-Ranges](https://github.com/keyboardio/Kaleidoscope-Ranges) + ## Further reading Starting from the [example][plugin:example] is the recommended way of getting From 55e5068cfcd4d43ad0970537112e8b0767f342a2 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Sun, 21 May 2017 23:06:53 -0700 Subject: [PATCH 09/52] Update for new modifier names --- src/Kaleidoscope/LED-ActiveModColor.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index 0c9e2baa..e7ed8f10 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -48,10 +48,10 @@ namespace KaleidoscopePlugins { if (k.raw >= KaleidoscopePlugins::Ranges::OSM_FIRST && k.raw <= KaleidoscopePlugins::Ranges::OSM_LAST) { uint8_t idx = k.raw - KaleidoscopePlugins::Ranges::OSM_FIRST; k.flags = 0; - k.keyCode = Key_LCtrl.keyCode + idx; + k.keyCode = Key_LeftControl.keyCode + idx; } - if (k.raw < Key_LCtrl.raw || k.raw > Key_RGUI.raw) + if (k.raw < Key_LeftControl.raw || k.raw > Key_RightGui.raw) continue; if (Keyboard.isModifierActive (k.keyCode)) From b8be8d9fe1d5f7341f1ed4d898f839892a54c4ed Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 22 May 2017 00:17:11 -0700 Subject: [PATCH 10/52] Update example for new key defs --- examples/LED-ActiveModColor/LED-ActiveModColor.ino | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/examples/LED-ActiveModColor/LED-ActiveModColor.ino b/examples/LED-ActiveModColor/LED-ActiveModColor.ino index 69496129..f52a712a 100644 --- a/examples/LED-ActiveModColor/LED-ActiveModColor.ino +++ b/examples/LED-ActiveModColor/LED-ActiveModColor.ino @@ -25,9 +25,9 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { 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_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, - Key_LCtrl, Key_Backspace, Key_LGUI, Key_LShift, + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, Key_skip, Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, @@ -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_skip ), }; From 41970ac68940ab577a078adadc644ec8ac82c136 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 23 May 2017 20:04:54 -0700 Subject: [PATCH 11/52] New build infrastructure --- .travis.yml | 29 ++++++++++++++++------------- Makefile | 12 ++++++++++++ 2 files changed, 28 insertions(+), 13 deletions(-) create mode 100644 Makefile diff --git a/.travis.yml b/.travis.yml index 77431b24..e7030acf 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,18 +1,21 @@ -language: cpp dist: trusty -sudo: required +sudo: false os: - linux -before_install: - - pushd .. - - wget http://downloads.arduino.cc/arduino-1.6.11-linux64.tar.xz - - tar xf arduino-1.6.11-linux64.tar.xz - - popd install: - - git clone --recurse-submodules https://github.com/keyboardio/Arduino-Boards hardware/keyboardio/avr + - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Arduino-Boards hardware/keyboardio/avr script: - - export DEFAULT_SKETCH=$(cd examples; basename *) - - export ARDUINO_PATH=$(pwd)/../arduino-1.6.11 - - export BOARD_HARDWARE_PATH=$(pwd)/hardware - - export EXTRA_BUILDER_ARGS="-libraries ." - - hardware/keyboardio/avr/libraries/Kaleidoscope/tools/kaleidoscope-builder build + - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware +notifications: + irc: + channels: + - "chat.freenode.net#keyboardio" + use_notice: true + skip_join: true + template: + - "%{repository_name}/%{branch} %{commit} by %{author}: %{commit_subject} %{build_url} %{message}" + email: + on_success: change + on_failure: change +cache: + ccache: true diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..9ce0c4a9 --- /dev/null +++ b/Makefile @@ -0,0 +1,12 @@ +# This stub makefile for a Kaleidoscope plugin pulls in +# all targets from the Kaleidoscope-Plugin library + +MAKEFILE_PREFIX=keyboardio/avr/libraries/Kaleidoscope-Plugin/build +UNAME_S := $(shell uname -s) + +BOARD_HARDWARE_PATH ?= $(HOME)/Arduino/hardware +ifeq ($(UNAME_S),Darwin) +BOARD_HARDWARE_PATH ?= $(HOME)/Library/Arduino/hardware +endif + +include $(BOARD_HARDWARE_PATH)/$(MAKEFILE_PREFIX)/*.mk From 1f8fc546e55c62641c900eaa611eabf3fa3456ef Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Fri, 26 May 2017 16:20:22 -0700 Subject: [PATCH 12/52] make astyle --- .../LED-ActiveModColor/LED-ActiveModColor.ino | 44 +++++++------- src/Kaleidoscope/LED-ActiveModColor.cpp | 58 ++++++++++--------- src/Kaleidoscope/LED-ActiveModColor.h | 22 +++---- 3 files changed, 63 insertions(+), 61 deletions(-) diff --git a/examples/LED-ActiveModColor/LED-ActiveModColor.ino b/examples/LED-ActiveModColor/LED-ActiveModColor.ino index f52a712a..384279f9 100644 --- a/examples/LED-ActiveModColor/LED-ActiveModColor.ino +++ b/examples/LED-ActiveModColor/LED-ActiveModColor.ino @@ -20,33 +20,33 @@ #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_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, - - Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, - Key_skip, - - Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, - Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, - Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, - Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, - - Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, - Key_skip - ), + [0] = KEYMAP_STACKED + ( + Key_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_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, + + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, + Key_skip, + + Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, + Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, + + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, + Key_skip + ), }; void setup () { - Kaleidoscope.setup (KEYMAP_SIZE); - Kaleidoscope.use (&LEDControl, &ActiveModColorEffect, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&LEDControl, &ActiveModColorEffect, NULL); - ActiveModColorEffect.configure ({0x00, 0xff, 0xff}); + ActiveModColorEffect.configure ({0x00, 0xff, 0xff}); } void loop () { - Kaleidoscope.loop (); + Kaleidoscope.loop (); } diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index e7ed8f10..d9d0d77b 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -20,47 +20,49 @@ #include namespace KaleidoscopePlugins { - namespace LEDEffects { - cRGB ActiveModColorEffect::highlightColor = (cRGB) {0xff, 0xff, 0xff}; +namespace LEDEffects { +cRGB ActiveModColorEffect::highlightColor = (cRGB) { + 0xff, 0xff, 0xff +}; - ActiveModColorEffect::ActiveModColorEffect (void) { - } +ActiveModColorEffect::ActiveModColorEffect (void) { +} - void - ActiveModColorEffect::begin (void) { - loop_hook_use (loopHook); - } +void +ActiveModColorEffect::begin (void) { + loop_hook_use (loopHook); +} - void - ActiveModColorEffect::configure (const cRGB highlightColor_) { - highlightColor = highlightColor_; - } +void +ActiveModColorEffect::configure (const cRGB highlightColor_) { + highlightColor = highlightColor_; +} - void - ActiveModColorEffect::loopHook (bool postClear) { - if (postClear) +void +ActiveModColorEffect::loopHook (bool postClear) { + if (postClear) return; - for (byte r = 0; r < ROWS; r++) { + for (byte r = 0; r < ROWS; r++) { for (byte c = 0; c < COLS; c++) { - Key k = Layer.lookup (r, c); + Key k = Layer.lookup (r, c); - if (k.raw >= KaleidoscopePlugins::Ranges::OSM_FIRST && k.raw <= KaleidoscopePlugins::Ranges::OSM_LAST) { - uint8_t idx = k.raw - KaleidoscopePlugins::Ranges::OSM_FIRST; - k.flags = 0; - k.keyCode = Key_LeftControl.keyCode + idx; - } + if (k.raw >= KaleidoscopePlugins::Ranges::OSM_FIRST && k.raw <= KaleidoscopePlugins::Ranges::OSM_LAST) { + uint8_t idx = k.raw - KaleidoscopePlugins::Ranges::OSM_FIRST; + k.flags = 0; + k.keyCode = Key_LeftControl.keyCode + idx; + } - if (k.raw < Key_LeftControl.raw || k.raw > Key_RightGui.raw) - continue; + if (k.raw < Key_LeftControl.raw || k.raw > Key_RightGui.raw) + continue; - if (Keyboard.isModifierActive (k.keyCode)) - LEDControl.led_set_crgb_at (r, c, highlightColor); + if (Keyboard.isModifierActive (k.keyCode)) + LEDControl.led_set_crgb_at (r, c, highlightColor); } - } } +} - }; +}; }; KaleidoscopePlugins::LEDEffects::ActiveModColorEffect ActiveModColorEffect; diff --git a/src/Kaleidoscope/LED-ActiveModColor.h b/src/Kaleidoscope/LED-ActiveModColor.h index ee6abbde..fca1f9c1 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.h +++ b/src/Kaleidoscope/LED-ActiveModColor.h @@ -20,19 +20,19 @@ #include namespace KaleidoscopePlugins { - namespace LEDEffects { - class ActiveModColorEffect : public KaleidoscopePlugin { - public: - ActiveModColorEffect (void); +namespace LEDEffects { +class ActiveModColorEffect : public KaleidoscopePlugin { + public: + ActiveModColorEffect (void); - static void configure (const cRGB highlightColor); - virtual void begin (void) final; + static void configure (const cRGB highlightColor); + virtual void begin (void) final; - private: - static cRGB highlightColor; - static void loopHook (bool postClear); - }; - }; + private: + static cRGB highlightColor; + static void loopHook (bool postClear); +}; +}; }; extern KaleidoscopePlugins::LEDEffects::ActiveModColorEffect ActiveModColorEffect; From 5273b43ba09d4ada1d40c08cf68baf7c7e3e54f0 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Sat, 3 Jun 2017 22:53:20 -0700 Subject: [PATCH 13/52] astyle with current project style guidelines --- .../LED-ActiveModColor/LED-ActiveModColor.ino | 48 +++++++++---------- src/Kaleidoscope/LED-ActiveModColor.cpp | 44 ++++++++--------- src/Kaleidoscope/LED-ActiveModColor.h | 14 +++--- 3 files changed, 53 insertions(+), 53 deletions(-) diff --git a/examples/LED-ActiveModColor/LED-ActiveModColor.ino b/examples/LED-ActiveModColor/LED-ActiveModColor.ino index 384279f9..bd8f86b1 100644 --- a/examples/LED-ActiveModColor/LED-ActiveModColor.ino +++ b/examples/LED-ActiveModColor/LED-ActiveModColor.ino @@ -20,33 +20,33 @@ #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_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, - - Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, - Key_skip, - - Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, - Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, - Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, - Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, - - Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, - Key_skip - ), + [0] = KEYMAP_STACKED + ( + Key_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_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, + + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, + Key_skip, + + Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, + Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, + + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, + Key_skip + ), }; -void setup () { - Kaleidoscope.setup (KEYMAP_SIZE); - Kaleidoscope.use (&LEDControl, &ActiveModColorEffect, NULL); +void setup() { + Kaleidoscope.setup(KEYMAP_SIZE); + Kaleidoscope.use(&LEDControl, &ActiveModColorEffect, NULL); - ActiveModColorEffect.configure ({0x00, 0xff, 0xff}); + ActiveModColorEffect.configure({0x00, 0xff, 0xff}); } -void loop () { - Kaleidoscope.loop (); +void loop() { + Kaleidoscope.loop(); } diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index d9d0d77b..24a8d0c8 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -22,44 +22,44 @@ namespace KaleidoscopePlugins { namespace LEDEffects { cRGB ActiveModColorEffect::highlightColor = (cRGB) { - 0xff, 0xff, 0xff + 0xff, 0xff, 0xff }; -ActiveModColorEffect::ActiveModColorEffect (void) { +ActiveModColorEffect::ActiveModColorEffect(void) { } void -ActiveModColorEffect::begin (void) { - loop_hook_use (loopHook); +ActiveModColorEffect::begin(void) { + loop_hook_use(loopHook); } void -ActiveModColorEffect::configure (const cRGB highlightColor_) { - highlightColor = highlightColor_; +ActiveModColorEffect::configure(const cRGB highlightColor_) { + highlightColor = highlightColor_; } void -ActiveModColorEffect::loopHook (bool postClear) { - if (postClear) - return; +ActiveModColorEffect::loopHook(bool postClear) { + if (postClear) + return; - for (byte r = 0; r < ROWS; r++) { - for (byte c = 0; c < COLS; c++) { - Key k = Layer.lookup (r, c); + for (byte r = 0; r < ROWS; r++) { + for (byte c = 0; c < COLS; c++) { + Key k = Layer.lookup(r, c); - if (k.raw >= KaleidoscopePlugins::Ranges::OSM_FIRST && k.raw <= KaleidoscopePlugins::Ranges::OSM_LAST) { - uint8_t idx = k.raw - KaleidoscopePlugins::Ranges::OSM_FIRST; - k.flags = 0; - k.keyCode = Key_LeftControl.keyCode + idx; - } + if (k.raw >= KaleidoscopePlugins::Ranges::OSM_FIRST && k.raw <= KaleidoscopePlugins::Ranges::OSM_LAST) { + uint8_t idx = k.raw - KaleidoscopePlugins::Ranges::OSM_FIRST; + k.flags = 0; + k.keyCode = Key_LeftControl.keyCode + idx; + } - if (k.raw < Key_LeftControl.raw || k.raw > Key_RightGui.raw) - continue; + if (k.raw < Key_LeftControl.raw || k.raw > Key_RightGui.raw) + continue; - if (Keyboard.isModifierActive (k.keyCode)) - LEDControl.led_set_crgb_at (r, c, highlightColor); - } + if (Keyboard.isModifierActive(k.keyCode)) + LEDControl.led_set_crgb_at(r, c, highlightColor); } + } } }; diff --git a/src/Kaleidoscope/LED-ActiveModColor.h b/src/Kaleidoscope/LED-ActiveModColor.h index fca1f9c1..96d0716b 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.h +++ b/src/Kaleidoscope/LED-ActiveModColor.h @@ -22,15 +22,15 @@ namespace KaleidoscopePlugins { namespace LEDEffects { class ActiveModColorEffect : public KaleidoscopePlugin { - public: - ActiveModColorEffect (void); + public: + ActiveModColorEffect(void); - static void configure (const cRGB highlightColor); - virtual void begin (void) final; + static void configure(const cRGB highlightColor); + virtual void begin(void) final; - private: - static cRGB highlightColor; - static void loopHook (bool postClear); + private: + static cRGB highlightColor; + static void loopHook(bool postClear); }; }; }; From 06056f9a590c96ac4295edaaad6252b1acfe94b6 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Sun, 4 Jun 2017 00:35:00 -0700 Subject: [PATCH 14/52] virtual void begin(void) final is redunant and makes the linter unhappy --- src/Kaleidoscope/LED-ActiveModColor.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/LED-ActiveModColor.h b/src/Kaleidoscope/LED-ActiveModColor.h index 96d0716b..47be5449 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.h +++ b/src/Kaleidoscope/LED-ActiveModColor.h @@ -26,7 +26,7 @@ class ActiveModColorEffect : public KaleidoscopePlugin { ActiveModColorEffect(void); static void configure(const cRGB highlightColor); - virtual void begin(void) final; + void begin(void) final; private: static cRGB highlightColor; From 8f0cfb753c92d3fa9541d263a984ec8fa561a290 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 4 Jun 2017 19:14:28 +0200 Subject: [PATCH 15/52] Kaleidoscope Style Guide conformance Signed-off-by: Gergely Nagy --- README.md | 27 ++++++++++--------- .../LED-ActiveModColor/LED-ActiveModColor.ino | 10 +++---- src/Kaleidoscope/LED-ActiveModColor.cpp | 26 +++++++----------- src/Kaleidoscope/LED-ActiveModColor.h | 16 +++++------ 4 files changed, 36 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index c2aa5720..dd894e7c 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,9 @@ [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-LED-ActiveModColor.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-LED-ActiveModColor - [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 With this plugin, any active modifier on the keyboard will have the LED under it highlighted. No matter how the modifier got activated (a key press, a macro, @@ -23,27 +23,28 @@ is also possible to use a custom color instead of the white default. #include void setup () { - Kaleidoscope.setup (KEYMAP_SIZE); - - Kaleidoscope.use (&ActiveModColorEffect, NULL); + USE_PLUGINS(&ActiveModColorEffect); + + Kaleidoscope.setup (); - ActiveModColorEffect.configure ({0x00, 0xff, 0xff}); + ActiveModColorEffect.highlight_color = CRGB(0x00, 0xff, 0xff); } ``` -It is recommended to place the activation (the `Kaleidoscope.use` call) of the -plugin last, so that it can reliably override any other plugins that may work -with the LEDs, and apply the highlight over those. +It is recommended to place the activation (the `USE_PLUGINS` call) of the plugin +last, so that it can reliably override any other plugins that may work with the +LEDs, and apply the highlight over those. ## Plugin methods The plugin provides the `ActiveModColorEffect` object, which has the following method: -### `.configure(color)` +### `.highlight_color` -> Set the color to use for highlighting the modifiers. If unset, will use the -> default white color. +> The color to use for highlighting the modifiers. Defaults to a white color. +> +> Not strictly a method, it is a variable one can assign a new value to. ## Dependencies diff --git a/examples/LED-ActiveModColor/LED-ActiveModColor.ino b/examples/LED-ActiveModColor/LED-ActiveModColor.ino index bd8f86b1..605a9c87 100644 --- a/examples/LED-ActiveModColor/LED-ActiveModColor.ino +++ b/examples/LED-ActiveModColor/LED-ActiveModColor.ino @@ -36,15 +36,15 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, - Key_skip - ), + Key_skip), }; void setup() { - Kaleidoscope.setup(KEYMAP_SIZE); - Kaleidoscope.use(&LEDControl, &ActiveModColorEffect, NULL); + USE_PLUGINS(&ActiveModColorEffect); - ActiveModColorEffect.configure({0x00, 0xff, 0xff}); + Kaleidoscope.setup(); + + ActiveModColorEffect.highlight_color = CRGB(0x00, 0xff, 0xff); } void loop() { diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index 24a8d0c8..c51810ba 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -19,28 +19,21 @@ #include #include -namespace KaleidoscopePlugins { -namespace LEDEffects { -cRGB ActiveModColorEffect::highlightColor = (cRGB) { +namespace kaleidoscope { + +cRGB ActiveModColorEffect::highlight_color = (cRGB) { 0xff, 0xff, 0xff }; ActiveModColorEffect::ActiveModColorEffect(void) { } -void -ActiveModColorEffect::begin(void) { +void ActiveModColorEffect::begin(void) { loop_hook_use(loopHook); } -void -ActiveModColorEffect::configure(const cRGB highlightColor_) { - highlightColor = highlightColor_; -} - -void -ActiveModColorEffect::loopHook(bool postClear) { - if (postClear) +void ActiveModColorEffect::loopHook(bool is_post_clear) { + if (is_post_clear) return; for (byte r = 0; r < ROWS; r++) { @@ -57,12 +50,11 @@ ActiveModColorEffect::loopHook(bool postClear) { continue; if (Keyboard.isModifierActive(k.keyCode)) - LEDControl.led_set_crgb_at(r, c, highlightColor); + LEDControl.led_set_crgb_at(r, c, highlight_color); } } } -}; -}; +} -KaleidoscopePlugins::LEDEffects::ActiveModColorEffect ActiveModColorEffect; +kaleidoscope::ActiveModColorEffect ActiveModColorEffect; diff --git a/src/Kaleidoscope/LED-ActiveModColor.h b/src/Kaleidoscope/LED-ActiveModColor.h index 47be5449..ef75aa1a 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.h +++ b/src/Kaleidoscope/LED-ActiveModColor.h @@ -16,23 +16,23 @@ * along with this program. If not, see . */ +#pragma once + #include #include -namespace KaleidoscopePlugins { -namespace LEDEffects { +namespace kaleidoscope { class ActiveModColorEffect : public KaleidoscopePlugin { public: ActiveModColorEffect(void); - static void configure(const cRGB highlightColor); void begin(void) final; + static cRGB highlight_color; + private: - static cRGB highlightColor; - static void loopHook(bool postClear); -}; -}; + static void loopHook(bool is_post_clear); }; +} -extern KaleidoscopePlugins::LEDEffects::ActiveModColorEffect ActiveModColorEffect; +extern kaleidoscope::ActiveModColorEffect ActiveModColorEffect; From 8d071acde2d220025d85b0a1cbabbffb4bc40c05 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 5 Jun 2017 13:03:08 +0200 Subject: [PATCH 16/52] Update to work with the latest Ranges APIs Signed-off-by: Gergely Nagy --- src/Kaleidoscope/LED-ActiveModColor.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index c51810ba..226dd3c2 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -40,8 +40,8 @@ void ActiveModColorEffect::loopHook(bool is_post_clear) { for (byte c = 0; c < COLS; c++) { Key k = Layer.lookup(r, c); - if (k.raw >= KaleidoscopePlugins::Ranges::OSM_FIRST && k.raw <= KaleidoscopePlugins::Ranges::OSM_LAST) { - uint8_t idx = k.raw - KaleidoscopePlugins::Ranges::OSM_FIRST; + if (k.raw >= ranges::OSM_FIRST && k.raw <= ranges::OSM_LAST) { + uint8_t idx = k.raw - ranges::OSM_FIRST; k.flags = 0; k.keyCode = Key_LeftControl.keyCode + idx; } From 28a3c82ae80d48cc38fc9f2d37aa43f3a3a82fd9 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 5 Jun 2017 15:57:41 +0200 Subject: [PATCH 17/52] README.md: Properties are not methods Signed-off-by: Gergely Nagy --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index dd894e7c..414b7823 100644 --- a/README.md +++ b/README.md @@ -38,13 +38,11 @@ LEDs, and apply the highlight over those. ## Plugin methods The plugin provides the `ActiveModColorEffect` object, which has the following -method: +property: ### `.highlight_color` > The color to use for highlighting the modifiers. Defaults to a white color. -> -> Not strictly a method, it is a variable one can assign a new value to. ## Dependencies From f3d4961578a64dad306105ec5c9e99b1a4448e76 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 15 Jun 2017 08:20:12 +0200 Subject: [PATCH 18/52] Turn the LED off if the modifier is inactive Fixes #1. But the consequence is that the plugin will not play nicely with LED modes that do not refresh. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/LED-ActiveModColor.cpp | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index 226dd3c2..22ac9b9a 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -51,6 +51,8 @@ void ActiveModColorEffect::loopHook(bool is_post_clear) { if (Keyboard.isModifierActive(k.keyCode)) LEDControl.led_set_crgb_at(r, c, highlight_color); + else + LEDControl.led_set_crgb_at(r, c, CRGB(0, 0, 0)); } } } From df8a2d1a504cbe885ea44b0d6e0117efecebd583 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 17 Jun 2017 13:06:48 +0200 Subject: [PATCH 19/52] Revert "Turn the LED off if the modifier is inactive" This reverts commit f3d4961578a64dad306105ec5c9e99b1a4448e76, because the interaction with LED modes with it is worse than the issue it fixed. --- src/Kaleidoscope/LED-ActiveModColor.cpp | 2 -- 1 file changed, 2 deletions(-) diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index 22ac9b9a..226dd3c2 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -51,8 +51,6 @@ void ActiveModColorEffect::loopHook(bool is_post_clear) { if (Keyboard.isModifierActive(k.keyCode)) LEDControl.led_set_crgb_at(r, c, highlight_color); - else - LEDControl.led_set_crgb_at(r, c, CRGB(0, 0, 0)); } } } From 9953d874a6470d3fb28eb03cd4684d773d8bfc6f Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 24 Jul 2017 14:59:02 -0700 Subject: [PATCH 20/52] CamelCaseifcation of LED related functions s/led_set_crgb_at/setCrgbAt/ s/hsv_to_rgb/hsvToRgb/ s/led_get_crgb_at/getCrgbAt/ s/led_sync/syncLeds/ s/get_led_index/getLedIndex/ s/send_led_data/sendLedData/ s/led_power_fault/ledPowerFault/ --- src/Kaleidoscope/LED-ActiveModColor.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index 226dd3c2..52702815 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -50,7 +50,7 @@ void ActiveModColorEffect::loopHook(bool is_post_clear) { continue; if (Keyboard.isModifierActive(k.keyCode)) - LEDControl.led_set_crgb_at(r, c, highlight_color); + LEDControl.setCrgbAt(r, c, highlight_color); } } } From 13646a658108952b0135c3585e48471ffc3b27f2 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 25 Jul 2017 14:49:02 -0700 Subject: [PATCH 21/52] port to new hid facade --- src/Kaleidoscope/LED-ActiveModColor.cpp | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index 52702815..f4f77f46 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -18,6 +18,7 @@ #include #include +#include namespace kaleidoscope { @@ -49,7 +50,7 @@ void ActiveModColorEffect::loopHook(bool is_post_clear) { if (k.raw < Key_LeftControl.raw || k.raw > Key_RightGui.raw) continue; - if (Keyboard.isModifierActive(k.keyCode)) + if (hid::isModifierKeyActive(k)) LEDControl.setCrgbAt(r, c, highlight_color); } } From f2d73d4d71d5901758e85c23af99ffe783384386 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 25 Jul 2017 15:52:09 -0700 Subject: [PATCH 22/52] Update Makefile to fix OS X build --- Makefile | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index 9ce0c4a9..2b04143a 100644 --- a/Makefile +++ b/Makefile @@ -4,9 +4,10 @@ MAKEFILE_PREFIX=keyboardio/avr/libraries/Kaleidoscope-Plugin/build UNAME_S := $(shell uname -s) -BOARD_HARDWARE_PATH ?= $(HOME)/Arduino/hardware ifeq ($(UNAME_S),Darwin) -BOARD_HARDWARE_PATH ?= $(HOME)/Library/Arduino/hardware +BOARD_HARDWARE_PATH ?= $(HOME)/Documents/Arduino/hardware +else +BOARD_HARDWARE_PATH ?= $(HOME)/Arduino/hardware endif -include $(BOARD_HARDWARE_PATH)/$(MAKEFILE_PREFIX)/*.mk +include $(BOARD_HARDWARE_PATH)/$(MAKEFILE_PREFIX)/rules.mk From 58d07f1e06c095c8265feadf7114efd7104bb087 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 9 Aug 2017 10:54:46 +0200 Subject: [PATCH 23/52] Lift out `isModifier` into its own function To make it easier to extend the plugin, to teach it to highlight keys other than the traditional modifiers, lift the code that checks for a modifier into its own function. No functional change, just refactoring. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/LED-ActiveModColor.cpp | 21 ++++++++++++++------- src/Kaleidoscope/LED-ActiveModColor.h | 1 + 2 files changed, 15 insertions(+), 7 deletions(-) diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index f4f77f46..e0d328d7 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -33,6 +33,19 @@ void ActiveModColorEffect::begin(void) { loop_hook_use(loopHook); } +bool ActiveModColorEffect::isModifier(Key key) { + if (key.raw >= ranges::OSM_FIRST && key.raw <= ranges::OSM_LAST) { + uint8_t idx = key.raw - ranges::OSM_FIRST; + key.flags = 0; + key.keyCode = Key_LeftControl.keyCode + idx; + } + + if (key.raw < Key_LeftControl.raw || key.raw > Key_RightGui.raw) + return false; + + return true; +} + void ActiveModColorEffect::loopHook(bool is_post_clear) { if (is_post_clear) return; @@ -41,13 +54,7 @@ void ActiveModColorEffect::loopHook(bool is_post_clear) { for (byte c = 0; c < COLS; c++) { Key k = Layer.lookup(r, c); - if (k.raw >= ranges::OSM_FIRST && k.raw <= ranges::OSM_LAST) { - uint8_t idx = k.raw - ranges::OSM_FIRST; - k.flags = 0; - k.keyCode = Key_LeftControl.keyCode + idx; - } - - if (k.raw < Key_LeftControl.raw || k.raw > Key_RightGui.raw) + if (!isModifier(k)) continue; if (hid::isModifierKeyActive(k)) diff --git a/src/Kaleidoscope/LED-ActiveModColor.h b/src/Kaleidoscope/LED-ActiveModColor.h index ef75aa1a..6151e3a9 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.h +++ b/src/Kaleidoscope/LED-ActiveModColor.h @@ -31,6 +31,7 @@ class ActiveModColorEffect : public KaleidoscopePlugin { static cRGB highlight_color; private: + static bool isModifier(Key key); static void loopHook(bool is_post_clear); }; } From b60937f9dbcb10af3f259da9eaea97e544e9e74e Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 9 Aug 2017 10:57:19 +0200 Subject: [PATCH 24/52] Combine modifier & modifier activeness checking The goal is to have a single `if` for checking if we should highlight a key, so that we can later have an `else if` branch to highlight non-traditional modifiers. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/LED-ActiveModColor.cpp | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index e0d328d7..0d6380c2 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -54,10 +54,7 @@ void ActiveModColorEffect::loopHook(bool is_post_clear) { for (byte c = 0; c < COLS; c++) { Key k = Layer.lookup(r, c); - if (!isModifier(k)) - continue; - - if (hid::isModifierKeyActive(k)) + if (isModifier(k) && hid::isModifierKeyActive(k)) LEDControl.setCrgbAt(r, c, highlight_color); } } From de3d793b407e9a01089e51fe477b8cf721d27bd2 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 9 Aug 2017 11:01:49 +0200 Subject: [PATCH 25/52] Move the modifier activity check into `isModifierActive` This way, the body of the loop in `loopHook` becomes even simpler. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/LED-ActiveModColor.cpp | 6 +++--- src/Kaleidoscope/LED-ActiveModColor.h | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index 0d6380c2..15e20303 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -33,7 +33,7 @@ void ActiveModColorEffect::begin(void) { loop_hook_use(loopHook); } -bool ActiveModColorEffect::isModifier(Key key) { +bool ActiveModColorEffect::isModifierActive(Key key) { if (key.raw >= ranges::OSM_FIRST && key.raw <= ranges::OSM_LAST) { uint8_t idx = key.raw - ranges::OSM_FIRST; key.flags = 0; @@ -43,7 +43,7 @@ bool ActiveModColorEffect::isModifier(Key key) { if (key.raw < Key_LeftControl.raw || key.raw > Key_RightGui.raw) return false; - return true; + return hid::isModifierKeyActive(key); } void ActiveModColorEffect::loopHook(bool is_post_clear) { @@ -54,7 +54,7 @@ void ActiveModColorEffect::loopHook(bool is_post_clear) { for (byte c = 0; c < COLS; c++) { Key k = Layer.lookup(r, c); - if (isModifier(k) && hid::isModifierKeyActive(k)) + if (isModifierActive(k)) LEDControl.setCrgbAt(r, c, highlight_color); } } diff --git a/src/Kaleidoscope/LED-ActiveModColor.h b/src/Kaleidoscope/LED-ActiveModColor.h index 6151e3a9..e63f3025 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.h +++ b/src/Kaleidoscope/LED-ActiveModColor.h @@ -31,7 +31,7 @@ class ActiveModColorEffect : public KaleidoscopePlugin { static cRGB highlight_color; private: - static bool isModifier(Key key); + static bool isModifierActive(Key key); static void loopHook(bool is_post_clear); }; } From 8becec569e9b1fe95fbf644102fe280cde5fc4bc Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 9 Aug 2017 11:13:23 +0200 Subject: [PATCH 26/52] Add support for highlighting layer keys too Fixes #2, thanks @ToyKeeper! Signed-off-by: Gergely Nagy --- src/Kaleidoscope/LED-ActiveModColor.cpp | 19 ++++++++++++++++++- src/Kaleidoscope/LED-ActiveModColor.h | 1 + 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index 15e20303..3df67495 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -46,6 +46,23 @@ bool ActiveModColorEffect::isModifierActive(Key key) { return hid::isModifierKeyActive(key); } +bool ActiveModColorEffect::isLayerKeyActive(Key key) { + uint8_t layer = 255; + + if (key.raw >= ranges::OSL_FIRST && key.raw <= ranges::OSL_LAST) { + layer = key.raw - ranges::OSL_FIRST; + } else if (key.flags & (SYNTHETIC | SWITCH_TO_KEYMAP)) { + layer = key.keyCode; + if (layer >= MOMENTARY_OFFSET) + layer -= MOMENTARY_OFFSET; + } + + if (layer == 255) + return false; + + return Layer.isOn(layer); +} + void ActiveModColorEffect::loopHook(bool is_post_clear) { if (is_post_clear) return; @@ -54,7 +71,7 @@ void ActiveModColorEffect::loopHook(bool is_post_clear) { for (byte c = 0; c < COLS; c++) { Key k = Layer.lookup(r, c); - if (isModifierActive(k)) + if (isModifierActive(k) || isLayerKeyActive(k)) LEDControl.setCrgbAt(r, c, highlight_color); } } diff --git a/src/Kaleidoscope/LED-ActiveModColor.h b/src/Kaleidoscope/LED-ActiveModColor.h index e63f3025..6da5ac7c 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.h +++ b/src/Kaleidoscope/LED-ActiveModColor.h @@ -32,6 +32,7 @@ class ActiveModColorEffect : public KaleidoscopePlugin { private: static bool isModifierActive(Key key); + static bool isLayerKeyActive(Key key); static void loopHook(bool is_post_clear); }; } From 3518ba605aeeeb6ba53263e9bedbf6308173540c Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 9 Aug 2017 11:20:27 +0200 Subject: [PATCH 27/52] Documentation & example update Make it clear that layer keys are considered modifiers by the plugin. While in that area, use `Kaleidoscope.use` instead of the now deprecated `USE_PLUGINS` macro. Signed-off-by: Gergely Nagy --- README.md | 18 ++++++++++-------- .../LED-ActiveModColor/LED-ActiveModColor.ino | 2 +- 2 files changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 414b7823..6996c802 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,9 @@ With this plugin, any active modifier on the keyboard will have the LED under it highlighted. No matter how the modifier got activated (a key press, a macro, -anything else), the coloring will apply. +anything else), the coloring will apply. Layer keys, be them layer toggles, +momentary switches, or one-shot layer keys count as modifiers as far as the +plugin is concerned. ## Using the plugin @@ -23,19 +25,19 @@ is also possible to use a custom color instead of the white default. #include void setup () { - USE_PLUGINS(&ActiveModColorEffect); - + Kaleidoscope.use(&ActiveModColorEffect); + Kaleidoscope.setup (); - + ActiveModColorEffect.highlight_color = CRGB(0x00, 0xff, 0xff); } ``` -It is recommended to place the activation (the `USE_PLUGINS` call) of the plugin -last, so that it can reliably override any other plugins that may work with the -LEDs, and apply the highlight over those. +It is recommended to place the activation (the `Kaleidoscope.use` call) of the +plugin last, so that it can reliably override any other plugins that may work +with the LEDs, and apply the highlight over those. -## Plugin methods +## Plugin properties The plugin provides the `ActiveModColorEffect` object, which has the following property: diff --git a/examples/LED-ActiveModColor/LED-ActiveModColor.ino b/examples/LED-ActiveModColor/LED-ActiveModColor.ino index 605a9c87..7653ad06 100644 --- a/examples/LED-ActiveModColor/LED-ActiveModColor.ino +++ b/examples/LED-ActiveModColor/LED-ActiveModColor.ino @@ -40,7 +40,7 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { }; void setup() { - USE_PLUGINS(&ActiveModColorEffect); + Kaleidoscope.use(&ActiveModColorEffect); Kaleidoscope.setup(); From a0dad6bf0eb3b281ef1a42855f0c96dd413e9ee3 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 9 Aug 2017 11:22:46 +0200 Subject: [PATCH 28/52] Use Kaleidoscope.useLoopHook() instead of loop_hook_use() We are trying to migrate to the former, so while I'm here, do so in this plugin, so we can deprecate and remove `loop_hook_use` sooner. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/LED-ActiveModColor.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index 3df67495..317f419d 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -30,7 +30,7 @@ ActiveModColorEffect::ActiveModColorEffect(void) { } void ActiveModColorEffect::begin(void) { - loop_hook_use(loopHook); + Kaleidoscope.useLoopHook(loopHook); } bool ActiveModColorEffect::isModifierActive(Key key) { From f25480730eafcf83c982c34a2bec21de00623d5c Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 10 Aug 2017 01:12:37 +0200 Subject: [PATCH 29/52] When checking for normal layer keys, make sure the RESERVED bit isn't set If the `RESERVED` bit is set, that means the key is outside of the control of the core firmware, and as such, can't be a normal layer key. As it happens, `OSM(LeftControl)` (and other OSM keys) triggered this branch of code, and resulted in one-shot modifiers getting highlighted too. Thanks to @ToyKeeper for reporting the problem, and providing reproduction steps. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/LED-ActiveModColor.cpp | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index 317f419d..9bf68d11 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -51,7 +51,8 @@ bool ActiveModColorEffect::isLayerKeyActive(Key key) { if (key.raw >= ranges::OSL_FIRST && key.raw <= ranges::OSL_LAST) { layer = key.raw - ranges::OSL_FIRST; - } else if (key.flags & (SYNTHETIC | SWITCH_TO_KEYMAP)) { + } else if ((key.flags & (SYNTHETIC | SWITCH_TO_KEYMAP)) && + !(key.flags & RESERVED)) { layer = key.keyCode; if (layer >= MOMENTARY_OFFSET) layer -= MOMENTARY_OFFSET; From 453e30038fd2b79c7d1998463d1b77adf92ae547 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 10 Aug 2017 08:50:43 +0200 Subject: [PATCH 30/52] isLayerKeyActive: Check for flag equality, not just two bits set To find layer keys and layer keys only, we need to make sure that `key.flags` has only these two bits set, and none of the others. Otherwise it may light up keys as if they were layer keys, while they aren't, because they happen to have `SYNTHETIC` and `SWITCH_TO_KEYMAP` set, `RESERVED` unset, but have other flags that make the event handler loop treat them properly. Mouse keys are one such thing. Thanks to @ToyKeeper for reporting the issue! Signed-off-by: Gergely Nagy --- src/Kaleidoscope/LED-ActiveModColor.cpp | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index 9bf68d11..9e52352e 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -51,8 +51,7 @@ bool ActiveModColorEffect::isLayerKeyActive(Key key) { if (key.raw >= ranges::OSL_FIRST && key.raw <= ranges::OSL_LAST) { layer = key.raw - ranges::OSL_FIRST; - } else if ((key.flags & (SYNTHETIC | SWITCH_TO_KEYMAP)) && - !(key.flags & RESERVED)) { + } else if (key.flags == (SYNTHETIC | SWITCH_TO_KEYMAP)) { layer = key.keyCode; if (layer >= MOMENTARY_OFFSET) layer -= MOMENTARY_OFFSET; From 2e1ae36cff8f7795064290cba8e58df45907b92e Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 15 Aug 2017 08:51:01 +0200 Subject: [PATCH 31/52] Use the new Layer.lookupOnActiveLayer function We want to highlight keys as specified by the layer, not as their current role, otherwise we may be missing keys we should highlight. Thanks to @cdisselkoen for the report and the reproduction steps! Fixes #3. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/LED-ActiveModColor.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index 9e52352e..132a0c31 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -69,7 +69,7 @@ void ActiveModColorEffect::loopHook(bool is_post_clear) { for (byte r = 0; r < ROWS; r++) { for (byte c = 0; c < COLS; c++) { - Key k = Layer.lookup(r, c); + Key k = Layer.lookupOnActiveLayer(r, c); if (isModifierActive(k) || isLayerKeyActive(k)) LEDControl.setCrgbAt(r, c, highlight_color); From 559858db8af100462895cb5104fdfb8a4f7930b5 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 15 Aug 2017 22:45:31 +0200 Subject: [PATCH 32/52] Updated to use the new LEDMode/LEDControl API Signed-off-by: Gergely Nagy --- src/Kaleidoscope/LED-ActiveModColor.cpp | 32 ++++++++++++++++--------- src/Kaleidoscope/LED-ActiveModColor.h | 6 ++--- 2 files changed, 24 insertions(+), 14 deletions(-) diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index 132a0c31..9d959567 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -26,14 +26,11 @@ cRGB ActiveModColorEffect::highlight_color = (cRGB) { 0xff, 0xff, 0xff }; -ActiveModColorEffect::ActiveModColorEffect(void) { -} - void ActiveModColorEffect::begin(void) { Kaleidoscope.useLoopHook(loopHook); } -bool ActiveModColorEffect::isModifierActive(Key key) { +uint8_t ActiveModColorEffect::isModifierKeyActive(Key key) { if (key.raw >= ranges::OSM_FIRST && key.raw <= ranges::OSM_LAST) { uint8_t idx = key.raw - ranges::OSM_FIRST; key.flags = 0; @@ -41,12 +38,15 @@ bool ActiveModColorEffect::isModifierActive(Key key) { } if (key.raw < Key_LeftControl.raw || key.raw > Key_RightGui.raw) - return false; + return 0; - return hid::isModifierKeyActive(key); + if (hid::isModifierKeyActive(key)) + return 2; + else + return 1; } -bool ActiveModColorEffect::isLayerKeyActive(Key key) { +uint8_t ActiveModColorEffect::isLayerKeyActive(Key key) { uint8_t layer = 255; if (key.raw >= ranges::OSL_FIRST && key.raw <= ranges::OSL_LAST) { @@ -58,9 +58,12 @@ bool ActiveModColorEffect::isLayerKeyActive(Key key) { } if (layer == 255) - return false; + return 0; - return Layer.isOn(layer); + if (Layer.isOn(layer)) + return 2; + else + return 1; } void ActiveModColorEffect::loopHook(bool is_post_clear) { @@ -70,9 +73,16 @@ void ActiveModColorEffect::loopHook(bool is_post_clear) { for (byte r = 0; r < ROWS; r++) { for (byte c = 0; c < COLS; c++) { Key k = Layer.lookupOnActiveLayer(r, c); + uint8_t is_mod = isModifierKeyActive(k); + uint8_t is_layer = isLayerKeyActive(k); + + if (!is_mod && !is_layer) // Neither mod, nor layer key + continue; - if (isModifierActive(k) || isLayerKeyActive(k)) - LEDControl.setCrgbAt(r, c, highlight_color); + if (is_mod == 2 || is_mod == 2) + ::LEDControl.setCrgbAt(r, c, highlight_color); + else + ::LEDControl.refreshAt(r, c); } } } diff --git a/src/Kaleidoscope/LED-ActiveModColor.h b/src/Kaleidoscope/LED-ActiveModColor.h index 6da5ac7c..c38eb604 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.h +++ b/src/Kaleidoscope/LED-ActiveModColor.h @@ -24,15 +24,15 @@ namespace kaleidoscope { class ActiveModColorEffect : public KaleidoscopePlugin { public: - ActiveModColorEffect(void); + ActiveModColorEffect(void) {} void begin(void) final; static cRGB highlight_color; private: - static bool isModifierActive(Key key); - static bool isLayerKeyActive(Key key); + static uint8_t isModifierKeyActive(Key key); + static uint8_t isLayerKeyActive(Key key); static void loopHook(bool is_post_clear); }; } From e15aaed8c6839908b5c22f6907d73f0c56d10f72 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 16 Aug 2017 01:52:37 +0200 Subject: [PATCH 33/52] loopHook: Correct a thinko Thanks @obra for catching it! Signed-off-by: Gergely Nagy --- src/Kaleidoscope/LED-ActiveModColor.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index 9d959567..3349f207 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -79,7 +79,7 @@ void ActiveModColorEffect::loopHook(bool is_post_clear) { if (!is_mod && !is_layer) // Neither mod, nor layer key continue; - if (is_mod == 2 || is_mod == 2) + if (is_mod == 2 || is_layer == 2) ::LEDControl.setCrgbAt(r, c, highlight_color); else ::LEDControl.refreshAt(r, c); From 8375838c81de81662c4246c7bad79f4e29ffdb64 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 16 Aug 2017 09:55:35 +0200 Subject: [PATCH 34/52] Redo the logic that checks if we need to highlight Instead of using `Kaleidoscope-Ranges` and custom helper functions with magic constants to decide whether we need to highlight a key, refresh it, or leave it alone, use an if-else chain and inner ifs for activity. Leverages the new `OneShot.isOneShotKey(key)` and `OneShot.isActive(key)` methods. The net result is slightly cleaner code (though it can still be improved), and about 0.2ms saved, along with some PROGMEM space. Signed-off-by: Gergely Nagy --- README.md | 2 +- src/Kaleidoscope/LED-ActiveModColor.cpp | 67 ++++++++----------------- src/Kaleidoscope/LED-ActiveModColor.h | 2 - 3 files changed, 22 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index 6996c802..3f8b7512 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ property: ## Dependencies * [Kaleidoscope-LEDControl](https://github.com/keyboardio/Kaleidoscope-LEDControl) -* [Kaleidoscope-Ranges](https://github.com/keyboardio/Kaleidoscope-Ranges) +* [Kaleidoscope-OneShot](https://github.com/keyboardio/Kaleidoscope-OneShot) ## Further reading diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index 3349f207..e47d16c5 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -17,7 +17,7 @@ */ #include -#include +#include #include namespace kaleidoscope { @@ -30,42 +30,6 @@ void ActiveModColorEffect::begin(void) { Kaleidoscope.useLoopHook(loopHook); } -uint8_t ActiveModColorEffect::isModifierKeyActive(Key key) { - if (key.raw >= ranges::OSM_FIRST && key.raw <= ranges::OSM_LAST) { - uint8_t idx = key.raw - ranges::OSM_FIRST; - key.flags = 0; - key.keyCode = Key_LeftControl.keyCode + idx; - } - - if (key.raw < Key_LeftControl.raw || key.raw > Key_RightGui.raw) - return 0; - - if (hid::isModifierKeyActive(key)) - return 2; - else - return 1; -} - -uint8_t ActiveModColorEffect::isLayerKeyActive(Key key) { - uint8_t layer = 255; - - if (key.raw >= ranges::OSL_FIRST && key.raw <= ranges::OSL_LAST) { - layer = key.raw - ranges::OSL_FIRST; - } else if (key.flags == (SYNTHETIC | SWITCH_TO_KEYMAP)) { - layer = key.keyCode; - if (layer >= MOMENTARY_OFFSET) - layer -= MOMENTARY_OFFSET; - } - - if (layer == 255) - return 0; - - if (Layer.isOn(layer)) - return 2; - else - return 1; -} - void ActiveModColorEffect::loopHook(bool is_post_clear) { if (is_post_clear) return; @@ -73,16 +37,27 @@ void ActiveModColorEffect::loopHook(bool is_post_clear) { for (byte r = 0; r < ROWS; r++) { for (byte c = 0; c < COLS; c++) { Key k = Layer.lookupOnActiveLayer(r, c); - uint8_t is_mod = isModifierKeyActive(k); - uint8_t is_layer = isLayerKeyActive(k); - - if (!is_mod && !is_layer) // Neither mod, nor layer key - continue; - if (is_mod == 2 || is_layer == 2) - ::LEDControl.setCrgbAt(r, c, highlight_color); - else - ::LEDControl.refreshAt(r, c); + if (::OneShot.isOneShotKey(k)) { + if (::OneShot.isActive(k)) + ::LEDControl.setCrgbAt(r, c, highlight_color); + else + ::LEDControl.refreshAt(r, c); + } else if (k.raw >= Key_LeftControl.raw && k.raw <= Key_RightGui.raw) { + if (hid::isModifierKeyActive(k)) + ::LEDControl.setCrgbAt(r, c, highlight_color); + else + ::LEDControl.refreshAt(r, c); + } else if (k.flags == (SYNTHETIC | SWITCH_TO_KEYMAP)) { + uint8_t layer = k.keyCode; + if (layer >= MOMENTARY_OFFSET) + layer -= MOMENTARY_OFFSET; + + if (Layer.isOn(layer)) + ::LEDControl.setCrgbAt(r, c, highlight_color); + else + ::LEDControl.refreshAt(r, c); + } } } } diff --git a/src/Kaleidoscope/LED-ActiveModColor.h b/src/Kaleidoscope/LED-ActiveModColor.h index c38eb604..2d0a05b6 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.h +++ b/src/Kaleidoscope/LED-ActiveModColor.h @@ -31,8 +31,6 @@ class ActiveModColorEffect : public KaleidoscopePlugin { static cRGB highlight_color; private: - static uint8_t isModifierKeyActive(Key key); - static uint8_t isLayerKeyActive(Key key); static void loopHook(bool is_post_clear); }; } From b3e1f73546f6f060badf8f6f82c41e14936bb1c1 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 18 Aug 2017 09:51:35 +0200 Subject: [PATCH 35/52] Add a way to optimize for a one-shot-only setup. OneShot has a convenient way to tell us if any OneShot keys are active: `OneShot.isActive()`. Thus, if we are using oneshots only, we can skip scanning the whole keymap if no one-shots are active, saving us a whole lot of time per cycle we would be spending needlessly. The optimization is off by default, and must be turned on by the user's sketch. Signed-off-by: Gergely Nagy --- README.md | 9 +++++++++ src/Kaleidoscope/LED-ActiveModColor.cpp | 4 ++++ src/Kaleidoscope/LED-ActiveModColor.h | 1 + 3 files changed, 14 insertions(+) diff --git a/README.md b/README.md index 3f8b7512..9e2a71c5 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,15 @@ property: > The color to use for highlighting the modifiers. Defaults to a white color. +### `.oneshot_only` + +> A flag one can set to tell the plugin that they are using one-shot modifiers +> and layers only. This allows it to take some shortcuts, and optimize +> performance, at the cost of not highlighting any non-oneshot keys it otherwise +> would. +> +> Defaults to `false`. + ## Dependencies * [Kaleidoscope-LEDControl](https://github.com/keyboardio/Kaleidoscope-LEDControl) diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index e47d16c5..25bb39df 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -25,6 +25,7 @@ namespace kaleidoscope { cRGB ActiveModColorEffect::highlight_color = (cRGB) { 0xff, 0xff, 0xff }; +bool ActiveModColorEffect::oneshot_only; void ActiveModColorEffect::begin(void) { Kaleidoscope.useLoopHook(loopHook); @@ -34,6 +35,9 @@ void ActiveModColorEffect::loopHook(bool is_post_clear) { if (is_post_clear) return; + if (oneshot_only && !::OneShot.isActive()) + return; + for (byte r = 0; r < ROWS; r++) { for (byte c = 0; c < COLS; c++) { Key k = Layer.lookupOnActiveLayer(r, c); diff --git a/src/Kaleidoscope/LED-ActiveModColor.h b/src/Kaleidoscope/LED-ActiveModColor.h index 2d0a05b6..82a880de 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.h +++ b/src/Kaleidoscope/LED-ActiveModColor.h @@ -29,6 +29,7 @@ class ActiveModColorEffect : public KaleidoscopePlugin { void begin(void) final; static cRGB highlight_color; + static bool oneshot_only; private: static void loopHook(bool is_post_clear); From 26b07ba67a3ca837d5c38ccbbfcc438fbfca2ef3 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 18 Aug 2017 17:41:00 +0200 Subject: [PATCH 36/52] Revert "Add a way to optimize for a one-shot-only setup." This reverts commit b3e1f73546f6f060badf8f6f82c41e14936bb1c1, because it broke more things than it fixed. --- README.md | 9 --------- src/Kaleidoscope/LED-ActiveModColor.cpp | 4 ---- src/Kaleidoscope/LED-ActiveModColor.h | 1 - 3 files changed, 14 deletions(-) diff --git a/README.md b/README.md index 9e2a71c5..3f8b7512 100644 --- a/README.md +++ b/README.md @@ -46,15 +46,6 @@ property: > The color to use for highlighting the modifiers. Defaults to a white color. -### `.oneshot_only` - -> A flag one can set to tell the plugin that they are using one-shot modifiers -> and layers only. This allows it to take some shortcuts, and optimize -> performance, at the cost of not highlighting any non-oneshot keys it otherwise -> would. -> -> Defaults to `false`. - ## Dependencies * [Kaleidoscope-LEDControl](https://github.com/keyboardio/Kaleidoscope-LEDControl) diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index 25bb39df..e47d16c5 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -25,7 +25,6 @@ namespace kaleidoscope { cRGB ActiveModColorEffect::highlight_color = (cRGB) { 0xff, 0xff, 0xff }; -bool ActiveModColorEffect::oneshot_only; void ActiveModColorEffect::begin(void) { Kaleidoscope.useLoopHook(loopHook); @@ -35,9 +34,6 @@ void ActiveModColorEffect::loopHook(bool is_post_clear) { if (is_post_clear) return; - if (oneshot_only && !::OneShot.isActive()) - return; - for (byte r = 0; r < ROWS; r++) { for (byte c = 0; c < COLS; c++) { Key k = Layer.lookupOnActiveLayer(r, c); diff --git a/src/Kaleidoscope/LED-ActiveModColor.h b/src/Kaleidoscope/LED-ActiveModColor.h index 82a880de..2d0a05b6 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.h +++ b/src/Kaleidoscope/LED-ActiveModColor.h @@ -29,7 +29,6 @@ class ActiveModColorEffect : public KaleidoscopePlugin { void begin(void) final; static cRGB highlight_color; - static bool oneshot_only; private: static void loopHook(bool is_post_clear); From 1f97689ff1d79c17026e6c331f80a62d0f2668b8 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 21 Aug 2017 22:23:49 -0700 Subject: [PATCH 37/52] Update Makefile with OSX fixes and new paths --- Makefile | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index 2b04143a..8f830f44 100644 --- a/Makefile +++ b/Makefile @@ -1,13 +1,14 @@ # This stub makefile for a Kaleidoscope plugin pulls in # all targets from the Kaleidoscope-Plugin library -MAKEFILE_PREFIX=keyboardio/avr/libraries/Kaleidoscope-Plugin/build UNAME_S := $(shell uname -s) ifeq ($(UNAME_S),Darwin) -BOARD_HARDWARE_PATH ?= $(HOME)/Documents/Arduino/hardware +SKETCHBOOK_DIR ?= $(HOME)/Documents/Arduino/ else -BOARD_HARDWARE_PATH ?= $(HOME)/Arduino/hardware +SKETCHBOOK_DIR ?= $(HOME)/Arduino endif -include $(BOARD_HARDWARE_PATH)/$(MAKEFILE_PREFIX)/rules.mk +BOARD_HARDWARE_PATH ?= $(SKETCHBOOK_DIR)/hardware +KALEIDOSCOPE_PLUGIN_MAKEFILE_DIR ?= keyboardio/avr/build-tools/makefiles/ +include $(BOARD_HARDWARE_PATH)/$(KALEIDOSCOPE_PLUGIN_MAKEFILE_DIR)/rules.mk From 920b265a8621e79d2db64147b20c9c892ac22e7f Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 5 Oct 2017 07:04:07 +0200 Subject: [PATCH 38/52] Stop using deprecated interfaces Use `LAYER_SHIFT_OFFSET` instead of `MOMENTARY_OFFSET`, as the latter is deprecated. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/LED-ActiveModColor.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index e47d16c5..f615979e 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -50,8 +50,8 @@ void ActiveModColorEffect::loopHook(bool is_post_clear) { ::LEDControl.refreshAt(r, c); } else if (k.flags == (SYNTHETIC | SWITCH_TO_KEYMAP)) { uint8_t layer = k.keyCode; - if (layer >= MOMENTARY_OFFSET) - layer -= MOMENTARY_OFFSET; + if (layer >= LAYER_SHIFT_OFFSET) + layer -= LAYER_SHIFT_OFFSET; if (Layer.isOn(layer)) ::LEDControl.setCrgbAt(r, c, highlight_color); From 049a057b5edf9f4d09f632869a2d0a17f1fe37ed Mon Sep 17 00:00:00 2001 From: David Glasser Date: Tue, 17 Oct 2017 02:01:42 -0700 Subject: [PATCH 39/52] Show sticky keys in a different color Depends on https://github.com/keyboardio/Kaleidoscope-OneShot/pull/18 --- README.md | 4 ++++ src/Kaleidoscope/LED-ActiveModColor.cpp | 6 +++++- src/Kaleidoscope/LED-ActiveModColor.h | 1 + 3 files changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3f8b7512..a0706e5c 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,10 @@ property: > The color to use for highlighting the modifiers. Defaults to a white color. +### `.sticky_color` + +> The color to use for highlighting one-shot modifiers when they are sticky. Defaults to a red color. + ## Dependencies * [Kaleidoscope-LEDControl](https://github.com/keyboardio/Kaleidoscope-LEDControl) diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index f615979e..a0054fcb 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -26,6 +26,8 @@ cRGB ActiveModColorEffect::highlight_color = (cRGB) { 0xff, 0xff, 0xff }; +cRGB ActiveModColorEffect::sticky_color = CRGB(0xff, 0x00, 0x00); + void ActiveModColorEffect::begin(void) { Kaleidoscope.useLoopHook(loopHook); } @@ -39,7 +41,9 @@ void ActiveModColorEffect::loopHook(bool is_post_clear) { Key k = Layer.lookupOnActiveLayer(r, c); if (::OneShot.isOneShotKey(k)) { - if (::OneShot.isActive(k)) + if (::OneShot.isSticky(k)) + ::LEDControl.setCrgbAt(r, c, sticky_color); + else if (::OneShot.isActive(k)) ::LEDControl.setCrgbAt(r, c, highlight_color); else ::LEDControl.refreshAt(r, c); diff --git a/src/Kaleidoscope/LED-ActiveModColor.h b/src/Kaleidoscope/LED-ActiveModColor.h index 2d0a05b6..569dd135 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.h +++ b/src/Kaleidoscope/LED-ActiveModColor.h @@ -29,6 +29,7 @@ class ActiveModColorEffect : public KaleidoscopePlugin { void begin(void) final; static cRGB highlight_color; + static cRGB sticky_color; private: static void loopHook(bool is_post_clear); From 962d959a7fbad3e3b83ec0ce55ed7d0ad81e203e Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 12 May 2018 18:26:35 +0200 Subject: [PATCH 40/52] Updated to use the new plugin APIs Signed-off-by: Gergely Nagy --- README.md | 6 ++-- .../LED-ActiveModColor/LED-ActiveModColor.ino | 8 ++++-- src/Kaleidoscope/LED-ActiveModColor.cpp | 28 +++++++++++++------ src/Kaleidoscope/LED-ActiveModColor.h | 15 ++++++---- 4 files changed, 37 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index a0706e5c..58148553 100644 --- a/README.md +++ b/README.md @@ -22,11 +22,13 @@ is also possible to use a custom color instead of the white default. ```c++ #include +#include #include -void setup () { - Kaleidoscope.use(&ActiveModColorEffect); +KALEIDOSCOPE_INIT_PLUGINS(LEDControl, + ActiveModColorEffect); +void setup () { Kaleidoscope.setup (); ActiveModColorEffect.highlight_color = CRGB(0x00, 0xff, 0xff); diff --git a/examples/LED-ActiveModColor/LED-ActiveModColor.ino b/examples/LED-ActiveModColor/LED-ActiveModColor.ino index 7653ad06..2750d363 100644 --- a/examples/LED-ActiveModColor/LED-ActiveModColor.ino +++ b/examples/LED-ActiveModColor/LED-ActiveModColor.ino @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-LED-ActiveModColor -- Light up the LEDs under the active modifiers - * 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 @@ -17,6 +17,7 @@ */ #include +#include #include const Key keymaps[][ROWS][COLS] PROGMEM = { @@ -39,9 +40,10 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { Key_skip), }; -void setup() { - Kaleidoscope.use(&ActiveModColorEffect); +KALEIDOSCOPE_INIT_PLUGINS(LEDControl, + ActiveModColorEffect); +void setup() { Kaleidoscope.setup(); ActiveModColorEffect.highlight_color = CRGB(0x00, 0xff, 0xff); diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index a0054fcb..3f9e1f73 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-LED-ActiveModColor -- Light up the LEDs under the active modifiers - * 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 @@ -28,14 +28,7 @@ cRGB ActiveModColorEffect::highlight_color = (cRGB) { cRGB ActiveModColorEffect::sticky_color = CRGB(0xff, 0x00, 0x00); -void ActiveModColorEffect::begin(void) { - Kaleidoscope.useLoopHook(loopHook); -} - -void ActiveModColorEffect::loopHook(bool is_post_clear) { - if (is_post_clear) - return; - +EventHandlerResult ActiveModColorEffect::beforeReportingState() { for (byte r = 0; r < ROWS; r++) { for (byte c = 0; c < COLS; c++) { Key k = Layer.lookupOnActiveLayer(r, c); @@ -64,8 +57,25 @@ void ActiveModColorEffect::loopHook(bool is_post_clear) { } } } + + return EventHandlerResult::OK; +} + +// Legacy API +#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API +void ActiveModColorEffect::begin() { + Kaleidoscope.useLoopHook(legacyLoopHook); } +void ActiveModColorEffect::legacyLoopHook(bool is_post_clear) { + if (is_post_clear) + return; + + ::ActiveModColorEffect.beforeReportingState(); +} +#endif + + } kaleidoscope::ActiveModColorEffect ActiveModColorEffect; diff --git a/src/Kaleidoscope/LED-ActiveModColor.h b/src/Kaleidoscope/LED-ActiveModColor.h index 569dd135..36650646 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.h +++ b/src/Kaleidoscope/LED-ActiveModColor.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-LED-ActiveModColor -- Light up the LEDs under the active modifiers - * 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 @@ -22,17 +22,20 @@ #include namespace kaleidoscope { -class ActiveModColorEffect : public KaleidoscopePlugin { +class ActiveModColorEffect : public kaleidoscope::Plugin { public: ActiveModColorEffect(void) {} - void begin(void) final; - static cRGB highlight_color; static cRGB sticky_color; - private: - static void loopHook(bool is_post_clear); + EventHandlerResult beforeReportingState(); + +#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API + protected: + void begin(); + static void legacyLoopHook(bool is_post_clear); +#endif }; } From d725a7d16a511e031229a61d336096362a1103d7 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 17 Jun 2018 11:09:49 +0200 Subject: [PATCH 41/52] Override onSetup when using a compatibility layer The default `onSetup` will call `.begin`, to support initializing plugins using the V1 plugins while using `KALEIDOSCOPE_INIT_PLUGINS`. However, plugins that implement a compatibility layer so that they can be used with both the new API, and with `Kaleidoscope.use()` will have a `.begin` method too. Which the default `onSetup` will call, and we'll register the compatibility layer too, in addition to the new-style event handlers. This results in many things running twice, which leads to all kinds of problems. For this reason, override `onSetup`, so that it does not call `begin`. When used with `Kaleidoscope.use()`, the plugin will still work, so compatibility is maintained. But the bug is now gone. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/LED-ActiveModColor.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/Kaleidoscope/LED-ActiveModColor.h b/src/Kaleidoscope/LED-ActiveModColor.h index 36650646..954ffeaa 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.h +++ b/src/Kaleidoscope/LED-ActiveModColor.h @@ -32,6 +32,10 @@ class ActiveModColorEffect : public kaleidoscope::Plugin { EventHandlerResult beforeReportingState(); #if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API + kaleidoscope::EventHandlerResult onSetup() { + return kaleidoscope::EventHandlerResult::OK; + } + protected: void begin(); static void legacyLoopHook(bool is_post_clear); From 95600ce02ff1184b1f691d6f715bb6af028bc439 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 20 Aug 2018 23:09:22 +0200 Subject: [PATCH 42/52] Drop the V1 plugin API compatibility code Signed-off-by: Gergely Nagy --- src/Kaleidoscope/LED-ActiveModColor.cpp | 15 --------------- src/Kaleidoscope/LED-ActiveModColor.h | 10 ---------- 2 files changed, 25 deletions(-) diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index 3f9e1f73..5bd67263 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -61,21 +61,6 @@ EventHandlerResult ActiveModColorEffect::beforeReportingState() { return EventHandlerResult::OK; } -// Legacy API -#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API -void ActiveModColorEffect::begin() { - Kaleidoscope.useLoopHook(legacyLoopHook); -} - -void ActiveModColorEffect::legacyLoopHook(bool is_post_clear) { - if (is_post_clear) - return; - - ::ActiveModColorEffect.beforeReportingState(); -} -#endif - - } kaleidoscope::ActiveModColorEffect ActiveModColorEffect; diff --git a/src/Kaleidoscope/LED-ActiveModColor.h b/src/Kaleidoscope/LED-ActiveModColor.h index 954ffeaa..66617c9f 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.h +++ b/src/Kaleidoscope/LED-ActiveModColor.h @@ -30,16 +30,6 @@ class ActiveModColorEffect : public kaleidoscope::Plugin { static cRGB sticky_color; EventHandlerResult beforeReportingState(); - -#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API - kaleidoscope::EventHandlerResult onSetup() { - return kaleidoscope::EventHandlerResult::OK; - } - - protected: - void begin(); - static void legacyLoopHook(bool is_post_clear); -#endif }; } From abf5cd7a7ed23ac88c7df2b29cc7d0f1bfb11856 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:16:00 +0200 Subject: [PATCH 43/52] Relicense under the GPLv3 (only) Signed-off-by: Gergely Nagy --- .../LED-ActiveModColor/LED-ActiveModColor.ino | 19 +++++++++---------- src/Kaleidoscope-LED-ActiveModColor.h | 19 +++++++++---------- src/Kaleidoscope/LED-ActiveModColor.cpp | 19 +++++++++---------- src/Kaleidoscope/LED-ActiveModColor.h | 19 +++++++++---------- 4 files changed, 36 insertions(+), 40 deletions(-) diff --git a/examples/LED-ActiveModColor/LED-ActiveModColor.ino b/examples/LED-ActiveModColor/LED-ActiveModColor.ino index 2750d363..aa9e2c02 100644 --- a/examples/LED-ActiveModColor/LED-ActiveModColor.ino +++ b/examples/LED-ActiveModColor/LED-ActiveModColor.ino @@ -2,18 +2,17 @@ * Kaleidoscope-LED-ActiveModColor -- Light up the LEDs under the active modifiers * 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-LED-ActiveModColor.h b/src/Kaleidoscope-LED-ActiveModColor.h index e9a70b39..fd308f50 100644 --- a/src/Kaleidoscope-LED-ActiveModColor.h +++ b/src/Kaleidoscope-LED-ActiveModColor.h @@ -2,18 +2,17 @@ * Kaleidoscope-LED-ActiveModColor -- Light up the LEDs under the active modifiers * 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/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index 5bd67263..ff7a5944 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -2,18 +2,17 @@ * Kaleidoscope-LED-ActiveModColor -- Light up the LEDs under the active modifiers * 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/LED-ActiveModColor.h b/src/Kaleidoscope/LED-ActiveModColor.h index 66617c9f..839a5ea8 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.h +++ b/src/Kaleidoscope/LED-ActiveModColor.h @@ -2,18 +2,17 @@ * Kaleidoscope-LED-ActiveModColor -- Light up the LEDs under the active modifiers * 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 74c404ee4de7400f52d7ad4d855734fd50668e86 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:16:03 +0200 Subject: [PATCH 44/52] Assign my copyright to Keyboard.io While the original plugin was written independently, significant developments were made while working for Keyboard.io. As such, I feel it is appropriate to assign copyright to the company. Signed-off-by: Gergely Nagy --- examples/LED-ActiveModColor/LED-ActiveModColor.ino | 2 +- library.properties | 2 +- src/Kaleidoscope-LED-ActiveModColor.h | 2 +- src/Kaleidoscope/LED-ActiveModColor.cpp | 2 +- src/Kaleidoscope/LED-ActiveModColor.h | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/examples/LED-ActiveModColor/LED-ActiveModColor.ino b/examples/LED-ActiveModColor/LED-ActiveModColor.ino index aa9e2c02..d06abf10 100644 --- a/examples/LED-ActiveModColor/LED-ActiveModColor.ino +++ b/examples/LED-ActiveModColor/LED-ActiveModColor.ino @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-LED-ActiveModColor -- Light up the LEDs under the active modifiers - * 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 6108b80a..35a7ddd2 100644 --- a/library.properties +++ b/library.properties @@ -1,7 +1,7 @@ name=Kaleidoscope-LED-ActiveModColor version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy +maintainer=Gergely Nagy sentence=Light up the LEDs under the active modifiers. paragraph=Supports one-shot and normal modifiers - if it is active, it lights up. category=Communication diff --git a/src/Kaleidoscope-LED-ActiveModColor.h b/src/Kaleidoscope-LED-ActiveModColor.h index fd308f50..7fe92f0b 100644 --- a/src/Kaleidoscope-LED-ActiveModColor.h +++ b/src/Kaleidoscope-LED-ActiveModColor.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-LED-ActiveModColor -- Light up the LEDs under the active modifiers - * 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/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp index ff7a5944..d8ed6240 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-LED-ActiveModColor -- Light up the LEDs under the active modifiers - * 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/LED-ActiveModColor.h b/src/Kaleidoscope/LED-ActiveModColor.h index 839a5ea8..f2d4fdb0 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.h +++ b/src/Kaleidoscope/LED-ActiveModColor.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-LED-ActiveModColor -- Light up the LEDs under the active modifiers - * 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 973bfc868a7bf8d00605b7f9fccedbb2b9a20a84 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:16:05 +0200 Subject: [PATCH 45/52] Add CONTRIBUTING.md Copied from Kaleidoscope, as it is applicable here too. Signed-off-by: Gergely Nagy --- CONTRIBUTING.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..c490e3ce --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# Developer Certificate of Origin + +All contributions must include acceptance of the DCO: + +``` +Developer Certificate of Origin +Version 1.1 + +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. +1 Letterman Drive +Suite D4700 +San Francisco, CA, 94129 + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + + +Developer's Certificate of Origin 1.1 + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + +(b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + +(c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + +(d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. +``` + +## Sign your work + +To accept the DCO, please add this line to each commit message with your name +and email address (`git commit -s` will do this for you): + + Signed-off-by: Jane Example From 2db231da8506f8ba1a4993a5afde35935d2c0098 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 4 Sep 2018 18:24:01 -0700 Subject: [PATCH 46/52] Update travis.yml to point to new bundle repo --- .travis.yml | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/.travis.yml b/.travis.yml index e7030acf..e3e64f77 100644 --- a/.travis.yml +++ b/.travis.yml @@ -2,10 +2,15 @@ dist: trusty sudo: false os: - linux +addons: + apt: + packages: + - shellcheck install: - - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Arduino-Boards hardware/keyboardio/avr + - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Kaleidoscope-Bundle-Keyboardio hardware/keyboardio script: - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware + - shellcheck bin/kaleidoscope-builder notifications: irc: channels: @@ -13,7 +18,7 @@ notifications: use_notice: true skip_join: true template: - - "%{repository_name}/%{branch} %{commit} by %{author}: %{commit_subject} %{build_url} %{message}" + - "%{repository_name}/%{branch} %{commit} by %{author}: %{commit_subject} %{build_url} %{message}" email: on_success: change on_failure: change From de4b202eacf3e0104457e70f5638a3eee31e8c35 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 4 Sep 2018 18:42:29 -0700 Subject: [PATCH 47/52] shellcheck should only be run in the Kaleidoscope repo --- .travis.yml | 5 ----- 1 file changed, 5 deletions(-) diff --git a/.travis.yml b/.travis.yml index e3e64f77..23d30ccc 100644 --- a/.travis.yml +++ b/.travis.yml @@ -2,15 +2,10 @@ dist: trusty sudo: false os: - linux -addons: - apt: - packages: - - shellcheck install: - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Kaleidoscope-Bundle-Keyboardio hardware/keyboardio script: - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware - - shellcheck bin/kaleidoscope-builder notifications: irc: channels: From b4e8ec7a4819ee19e809688f0679233fbb99ace4 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 10 Oct 2018 06:38:50 +0200 Subject: [PATCH 48/52] README.md & Travis cleanup Remove the IRC notifications from Travis (we're not using IRC anymore), and the stable/experimental badge from README.md (because they aren't being kept up to date). Signed-off-by: Gergely Nagy --- .travis.yml | 7 ------- README.md | 6 +----- 2 files changed, 1 insertion(+), 12 deletions(-) diff --git a/.travis.yml b/.travis.yml index 23d30ccc..49b8c498 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,13 +7,6 @@ install: script: - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware notifications: - irc: - channels: - - "chat.freenode.net#keyboardio" - use_notice: true - skip_join: true - template: - - "%{repository_name}/%{branch} %{commit} by %{author}: %{commit_subject} %{build_url} %{message}" email: on_success: change on_failure: change diff --git a/README.md b/README.md index 58148553..3db9d4cc 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,10 @@ # Kaleidoscope-LED-ActiveModColor -![status][st:experimental] [![Build Status][travis:image]][travis:status] +[![Build Status][travis:image]][travis:status] [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-LED-ActiveModColor.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-LED-ActiveModColor - [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 - With this plugin, any active modifier on the keyboard will have the LED under it highlighted. No matter how the modifier got activated (a key press, a macro, anything else), the coloring will apply. Layer keys, be them layer toggles, From ea250c3446dad357d9a5c77404873b41d1e5c9f5 Mon Sep 17 00:00:00 2001 From: Kajsa Anderson Date: Sun, 14 Oct 2018 22:49:49 -0500 Subject: [PATCH 49/52] Update README.md Update reference to obsolete, removed method kaleidoscope.use Signed-off-by: Kajsa Anderson --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3db9d4cc..ba4b7dd0 100644 --- a/README.md +++ b/README.md @@ -31,14 +31,14 @@ void setup () { } ``` -It is recommended to place the activation (the `Kaleidoscope.use` call) of the +It is recommended to place the activation (the `KALEIDOSCOPE_INIT_PLUGINS` parameter) of the plugin last, so that it can reliably override any other plugins that may work with the LEDs, and apply the highlight over those. ## Plugin properties The plugin provides the `ActiveModColorEffect` object, which has the following -property: +properties: ### `.highlight_color` From 4e0e149cd33664da5c33ca3598a5985a83459fec Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 13 Oct 2018 14:49:17 +0200 Subject: [PATCH 50/52] Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/LED-ActiveModColor.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 | 55 +----------------- doc/plugin/LED-ActiveModColor.md | 56 +++++++++++++++++++ src/Kaleidoscope-LED-ActiveModColor.h | 2 +- .../plugin}/LED-ActiveModColor.cpp | 4 +- .../plugin}/LED-ActiveModColor.h | 4 +- 5 files changed, 64 insertions(+), 57 deletions(-) create mode 100644 doc/plugin/LED-ActiveModColor.md rename src/{Kaleidoscope => kaleidoscope/plugin}/LED-ActiveModColor.cpp (96%) rename src/{Kaleidoscope => kaleidoscope/plugin}/LED-ActiveModColor.h (91%) diff --git a/README.md b/README.md index ba4b7dd0..23eb72b2 100644 --- a/README.md +++ b/README.md @@ -5,57 +5,4 @@ [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-LED-ActiveModColor.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-LED-ActiveModColor -With this plugin, any active modifier on the keyboard will have the LED under it -highlighted. No matter how the modifier got activated (a key press, a macro, -anything else), the coloring will apply. Layer keys, be them layer toggles, -momentary switches, or one-shot layer keys count as modifiers as far as the -plugin is concerned. - -## Using the plugin - -To use the plugin, one needs to include the header, and activate the effect. It -is also possible to use a custom color instead of the white default. - -```c++ -#include -#include -#include - -KALEIDOSCOPE_INIT_PLUGINS(LEDControl, - ActiveModColorEffect); - -void setup () { - Kaleidoscope.setup (); - - ActiveModColorEffect.highlight_color = CRGB(0x00, 0xff, 0xff); -} -``` - -It is recommended to place the activation (the `KALEIDOSCOPE_INIT_PLUGINS` parameter) of the -plugin last, so that it can reliably override any other plugins that may work -with the LEDs, and apply the highlight over those. - -## Plugin properties - -The plugin provides the `ActiveModColorEffect` object, which has the following -properties: - -### `.highlight_color` - -> The color to use for highlighting the modifiers. Defaults to a white color. - -### `.sticky_color` - -> The color to use for highlighting one-shot modifiers when they are sticky. Defaults to a red color. - -## Dependencies - -* [Kaleidoscope-LEDControl](https://github.com/keyboardio/Kaleidoscope-LEDControl) -* [Kaleidoscope-OneShot](https://github.com/keyboardio/Kaleidoscope-OneShot) - -## 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-LED-ActiveModColor/blob/master/examples/LED-ActiveModColor/LED-ActiveModColor.ino +See [doc/plugin/LED-ActiveModColor.md](doc/plugin/LED-ActiveModColor.md) for documentation. diff --git a/doc/plugin/LED-ActiveModColor.md b/doc/plugin/LED-ActiveModColor.md new file mode 100644 index 00000000..259f6c3c --- /dev/null +++ b/doc/plugin/LED-ActiveModColor.md @@ -0,0 +1,56 @@ +# Kaleidoscope-LED-ActiveModColor + +With this plugin, any active modifier on the keyboard will have the LED under it +highlighted. No matter how the modifier got activated (a key press, a macro, +anything else), the coloring will apply. Layer keys, be them layer toggles, +momentary switches, or one-shot layer keys count as modifiers as far as the +plugin is concerned. + +## Using the plugin + +To use the plugin, one needs to include the header, and activate the effect. It +is also possible to use a custom color instead of the white default. + +```c++ +#include +#include +#include + +KALEIDOSCOPE_INIT_PLUGINS(LEDControl, + ActiveModColorEffect); + +void setup () { + Kaleidoscope.setup (); + + ActiveModColorEffect.highlight_color = CRGB(0x00, 0xff, 0xff); +} +``` + +It is recommended to place the activation (the `KALEIDOSCOPE_INIT_PLUGINS` parameter) of the +plugin last, so that it can reliably override any other plugins that may work +with the LEDs, and apply the highlight over those. + +## Plugin properties + +The plugin provides the `ActiveModColorEffect` object, which has the following +properties: + +### `.highlight_color` + +> The color to use for highlighting the modifiers. Defaults to a white color. + +### `.sticky_color` + +> The color to use for highlighting one-shot modifiers when they are sticky. Defaults to a red color. + +## Dependencies + +* [Kaleidoscope-LEDControl](https://github.com/keyboardio/Kaleidoscope-LEDControl) +* [Kaleidoscope-OneShot](https://github.com/keyboardio/Kaleidoscope-OneShot) + +## 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-LED-ActiveModColor/blob/master/examples/LED-ActiveModColor/LED-ActiveModColor.ino diff --git a/src/Kaleidoscope-LED-ActiveModColor.h b/src/Kaleidoscope-LED-ActiveModColor.h index 7fe92f0b..b74abb82 100644 --- a/src/Kaleidoscope-LED-ActiveModColor.h +++ b/src/Kaleidoscope-LED-ActiveModColor.h @@ -17,4 +17,4 @@ #pragma once -#include +#include diff --git a/src/Kaleidoscope/LED-ActiveModColor.cpp b/src/kaleidoscope/plugin/LED-ActiveModColor.cpp similarity index 96% rename from src/Kaleidoscope/LED-ActiveModColor.cpp rename to src/kaleidoscope/plugin/LED-ActiveModColor.cpp index d8ed6240..710f39be 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.cpp +++ b/src/kaleidoscope/plugin/LED-ActiveModColor.cpp @@ -20,6 +20,7 @@ #include namespace kaleidoscope { +namespace plugin { cRGB ActiveModColorEffect::highlight_color = (cRGB) { 0xff, 0xff, 0xff @@ -60,6 +61,7 @@ EventHandlerResult ActiveModColorEffect::beforeReportingState() { return EventHandlerResult::OK; } +} } -kaleidoscope::ActiveModColorEffect ActiveModColorEffect; +kaleidoscope::plugin::ActiveModColorEffect ActiveModColorEffect; diff --git a/src/Kaleidoscope/LED-ActiveModColor.h b/src/kaleidoscope/plugin/LED-ActiveModColor.h similarity index 91% rename from src/Kaleidoscope/LED-ActiveModColor.h rename to src/kaleidoscope/plugin/LED-ActiveModColor.h index f2d4fdb0..6beb7889 100644 --- a/src/Kaleidoscope/LED-ActiveModColor.h +++ b/src/kaleidoscope/plugin/LED-ActiveModColor.h @@ -21,6 +21,7 @@ #include namespace kaleidoscope { +namespace plugin { class ActiveModColorEffect : public kaleidoscope::Plugin { public: ActiveModColorEffect(void) {} @@ -31,5 +32,6 @@ class ActiveModColorEffect : public kaleidoscope::Plugin { EventHandlerResult beforeReportingState(); }; } +} -extern kaleidoscope::ActiveModColorEffect ActiveModColorEffect; +extern kaleidoscope::plugin::ActiveModColorEffect ActiveModColorEffect; From 4bd10142a791c96842e2698db1ac0ae50d1cb409 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 13 Oct 2018 14:49:21 +0200 Subject: [PATCH 51/52] Remove files we do not need in the monorepo Signed-off-by: Gergely Nagy --- .gitignore | 4 - .travis.yml | 14 - CONTRIBUTING.md | 50 ---- COPYING | 674 --------------------------------------------- Makefile | 14 - README.md | 8 - library.properties | 10 - 7 files changed, 774 deletions(-) delete mode 100644 .gitignore delete mode 100644 .travis.yml delete mode 100644 CONTRIBUTING.md delete mode 100644 COPYING delete mode 100644 Makefile delete mode 100644 README.md delete mode 100644 library.properties diff --git a/.gitignore b/.gitignore deleted file mode 100644 index be16c9be..00000000 --- a/.gitignore +++ /dev/null @@ -1,4 +0,0 @@ -.#* -*~ -/hardware/ -/output/ \ No newline at end of file diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 49b8c498..00000000 --- a/.travis.yml +++ /dev/null @@ -1,14 +0,0 @@ -dist: trusty -sudo: false -os: - - linux -install: - - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Kaleidoscope-Bundle-Keyboardio hardware/keyboardio -script: - - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware -notifications: - email: - on_success: change - on_failure: change -cache: - ccache: true diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index c490e3ce..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,50 +0,0 @@ -# Developer Certificate of Origin - -All contributions must include acceptance of the DCO: - -``` -Developer Certificate of Origin -Version 1.1 - -Copyright (C) 2004, 2006 The Linux Foundation and its contributors. -1 Letterman Drive -Suite D4700 -San Francisco, CA, 94129 - -Everyone is permitted to copy and distribute verbatim copies of this -license document, but changing it is not allowed. - - -Developer's Certificate of Origin 1.1 - -By making a contribution to this project, I certify that: - -(a) The contribution was created in whole or in part by me and I - have the right to submit it under the open source license - indicated in the file; or - -(b) The contribution is based upon previous work that, to the best - of my knowledge, is covered under an appropriate open source - license and I have the right under that license to submit that - work with modifications, whether created in whole or in part - by me, under the same open source license (unless I am - permitted to submit under a different license), as indicated - in the file; or - -(c) The contribution was provided directly to me by some other - person who certified (a), (b) or (c) and I have not modified - it. - -(d) I understand and agree that this project and the contribution - are public and that a record of the contribution (including all - personal information I submit with it, including my sign-off) is - maintained indefinitely and may be redistributed consistent with - this project or the open source license(s) involved. -``` - -## Sign your work - -To accept the DCO, please add this line to each commit message with your name -and email address (`git commit -s` will do this for you): - - Signed-off-by: Jane Example diff --git a/COPYING b/COPYING deleted file mode 100644 index 94a9ed02..00000000 --- a/COPYING +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/Makefile b/Makefile deleted file mode 100644 index 8f830f44..00000000 --- a/Makefile +++ /dev/null @@ -1,14 +0,0 @@ -# This stub makefile for a Kaleidoscope plugin pulls in -# all targets from the Kaleidoscope-Plugin library - -UNAME_S := $(shell uname -s) - -ifeq ($(UNAME_S),Darwin) -SKETCHBOOK_DIR ?= $(HOME)/Documents/Arduino/ -else -SKETCHBOOK_DIR ?= $(HOME)/Arduino -endif - -BOARD_HARDWARE_PATH ?= $(SKETCHBOOK_DIR)/hardware -KALEIDOSCOPE_PLUGIN_MAKEFILE_DIR ?= keyboardio/avr/build-tools/makefiles/ -include $(BOARD_HARDWARE_PATH)/$(KALEIDOSCOPE_PLUGIN_MAKEFILE_DIR)/rules.mk diff --git a/README.md b/README.md deleted file mode 100644 index 23eb72b2..00000000 --- a/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# Kaleidoscope-LED-ActiveModColor - -[![Build Status][travis:image]][travis:status] - - [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-LED-ActiveModColor.svg?branch=master - [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-LED-ActiveModColor - -See [doc/plugin/LED-ActiveModColor.md](doc/plugin/LED-ActiveModColor.md) for documentation. diff --git a/library.properties b/library.properties deleted file mode 100644 index 35a7ddd2..00000000 --- a/library.properties +++ /dev/null @@ -1,10 +0,0 @@ -name=Kaleidoscope-LED-ActiveModColor -version=0.0.0 -author=Gergely Nagy -maintainer=Gergely Nagy -sentence=Light up the LEDs under the active modifiers. -paragraph=Supports one-shot and normal modifiers - if it is active, it lights up. -category=Communication -url=https://github.com/keyboardio/Kaleidoscope-LED-ActiveModColor -architectures=avr -dot_a_linkage=true From a532205b127df2e5db8f067afc8b3583b55fd69b Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 18 Oct 2018 00:06:09 +0200 Subject: [PATCH 52/52] Update the documentation links Updates the example and dependency links in the documentation, to use URLs that are valid within the monorepo. Signed-off-by: Gergely Nagy --- doc/plugin/LED-ActiveModColor.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/plugin/LED-ActiveModColor.md b/doc/plugin/LED-ActiveModColor.md index 259f6c3c..2776ec84 100644 --- a/doc/plugin/LED-ActiveModColor.md +++ b/doc/plugin/LED-ActiveModColor.md @@ -45,12 +45,12 @@ properties: ## Dependencies -* [Kaleidoscope-LEDControl](https://github.com/keyboardio/Kaleidoscope-LEDControl) -* [Kaleidoscope-OneShot](https://github.com/keyboardio/Kaleidoscope-OneShot) +* [Kaleidoscope-LEDControl](LEDControl.md) +* [Kaleidoscope-OneShot](OneShot.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-LED-ActiveModColor/blob/master/examples/LED-ActiveModColor/LED-ActiveModColor.ino + [plugin:example]: ../../examples/LED-ActiveModColor/LED-ActiveModColor.ino