From a722fea88d9dacaaae4932249f2cfc4e5ed59af8 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 16 Jan 2017 15:18:13 +0100 Subject: [PATCH 01/42] Initial import Lifted out of the monolithic Akela library. Signed-off-by: Gergely Nagy --- .gitignore | 2 + COPYING | 674 +++++++++++++++++++++++++++++++++++ README.md | 60 ++++ examples/Heatmap/Heatmap.ino | 51 +++ library.properties | 10 + src/Akela-Heatmap.h | 21 ++ src/Akela/Heatmap.cpp | 123 +++++++ src/Akela/Heatmap.h | 39 ++ 8 files changed, 980 insertions(+) create mode 100644 .gitignore create mode 100644 COPYING create mode 100644 README.md create mode 100644 examples/Heatmap/Heatmap.ino create mode 100644 library.properties create mode 100644 src/Akela-Heatmap.h create mode 100644 src/Akela/Heatmap.cpp create mode 100644 src/Akela/Heatmap.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..99f3e1d2 --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +# Akela-Heatmap + +The `Heatmap` plugin provides a LED effect, that displays a heatmap on the +keyboard. The LEDs under each key will have a color according to how much use +they see. Fewer used keys will have deep blue colors, that gradually turns +lighter, then green, to yellow, and finally red for the most used keys. The +heatmap is not updated on every key press, but periodically. It's precision is +also an approximation, and not a hundred percent exact. Nevertheless, it is a +reasonable estimate. + +## Using the plugin + +The plugin comes with reasonable defaults pre-configured, all one needs to do is +include the header, and make sure the plugin is in use: + +```c++ +#include + +void setup (void) { + Keyboardio.setup (KEYMAP_SIZE); + Keyboardio.use (&HeatmapEffect, NULL); +} +``` + +This sets up the heatmap to update every 500 cycles, which is about 2.5 seconds, +and is the default. It also registers a new LED effect, which means that if you +have not set up any other effects, then Heatmap will likely be the default. You +may not want that, so setting up at least one other LED effect, such as `LEDOff` +is highly recommended. + +## Plugin methods + +The plugin provides two methods on the `HeatmapEffect` object: + +### `.configure(updateFrequency)` + +> Sets up the update frequency of the heatmap. The smaller this value is, the +> more often the heatmap gets updated, but that comes with a cost: updating the +> heatmap takes a fairly large amount of computation, and is not fast. Doing it +> often will considerably slow down the keyboard, and that is rarely a desirable +> thing. +> +> Nevertheless, the frequency preferred is a very subjective thing, which is why +> this function exists. Give it a number, and it will wait that many scan cycles +> between updates. +> +> Defaults to *500*. + +### `.activate()` + +> When called, immediately activates the Heatmap effect. Mostly useful in the +> `setup()` method of the Sketch, or in macros that are meant to switch to the +> heatmap effect, no matter where we are in the list. + +## Further reading + +Starting from the [example][plugin:example] is the recommended way of getting +started with the plugin. + + [plugin:example]: https://github.com/Akela-Plugins/Akela-Heatmap/blob/master/examples/Heatmap/Heatmap.ino diff --git a/examples/Heatmap/Heatmap.ino b/examples/Heatmap/Heatmap.ino new file mode 100644 index 00000000..8ff990eb --- /dev/null +++ b/examples/Heatmap/Heatmap.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 (&HeatmapEffect, NULL); + + HeatmapEffect.activate (); +} + +void loop () { + Keyboardio.loop (); +} diff --git a/library.properties b/library.properties new file mode 100644 index 00000000..37b25b0a --- /dev/null +++ b/library.properties @@ -0,0 +1,10 @@ +name=Akela-Heatmap +version=0.0.0 +author=Gergely Nagy +maintainer=Gergely Nagy +sentence=Heatmap LED effect for Keyboardio boards. +paragraph=Displays a heatmap via the LEDs under each key. +category=Communication +url=https://github.com/Akela-Plugins/Akela-Heatmap +architectures=avr +dot_a_linkage=true diff --git a/src/Akela-Heatmap.h b/src/Akela-Heatmap.h new file mode 100644 index 00000000..2c0d1a10 --- /dev/null +++ b/src/Akela-Heatmap.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/Heatmap.cpp b/src/Akela/Heatmap.cpp new file mode 100644 index 00000000..abd4fbf2 --- /dev/null +++ b/src/Akela/Heatmap.cpp @@ -0,0 +1,123 @@ +/* -*- 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 { + static uint8_t heatmap[ROWS][COLS]; + static uint16_t totalKeys; + static uint8_t highestCount; + static uint16_t updateFrequency = 500; + static uint16_t loopCount; + + static const float heatColors[][3] = {{0.3, 0.3, 0.3}, {0.3, 1, 0.3}, {1, 1, 0.3}, {1, 0.3, 0.3}}; + + static void + shiftStats (void) { + highestCount = totalKeys = 0; + for (uint8_t r = 0; r < ROWS; r++) { + for (uint8_t c = 0; c < COLS; c++) { + heatmap[r][c] = heatmap[r][c] >> 1; + totalKeys += heatmap[r][c]; + if (heatmap[r][c] > highestCount) + highestCount = heatmap[r][c]; + } + } + } + + static cRGB + computeColor (float v) { + float fb = 0; + uint8_t idx1, idx2; + + if (v <= 0) { + idx1 = idx2 = 0; + } else if (v >= 1) { + idx1 = idx2 = 3; + } else { + float val = v * 3; + idx1 = int(floor(val)); + idx2 = idx1 + 1; + fb = val - float(idx1); + } + + uint8_t r = (int)(((heatColors[idx2][0] - heatColors[idx1][0]) * fb + heatColors[idx1][0]) * 255); + uint8_t g = (int)(((heatColors[idx2][1] - heatColors[idx1][1]) * fb + heatColors[idx1][1]) * 255); + uint8_t b = (int)(((heatColors[idx2][2] - heatColors[idx1][2]) * fb + heatColors[idx1][2]) * 255); + + return {r, g, b}; + } + + Heatmap::Heatmap (void) { + } + + void + Heatmap::begin (void) { + LEDControl.mode_add (this); + event_handler_hook_add (this->eventHook); + loop_hook_add (this->loopHook); + } + + void + Heatmap::configure (uint16_t updateFreq) { + updateFrequency = updateFreq; + } + + Key + Heatmap::eventHook (Key mappedKey, byte row, byte col, uint8_t keyState) { + // if it is a synthetic key, skip it. + if (keyState & INJECTED) + return mappedKey; + + // if the key is not toggled on, return. + if (key_toggled_on (keyState)) + return mappedKey; + + totalKeys++; + heatmap[row][col]++; + if (heatmap[row][col] > highestCount) + highestCount = heatmap[row][col]; + + return mappedKey; + } + + void + Heatmap::loopHook (bool postClear) { + if (highestCount > 191 || totalKeys > 16000) + shiftStats(); + } + + void + Heatmap::update (void) { + loopCount++; + + if (loopCount < updateFrequency) + return; + + loopCount = 0; + for (uint8_t r = 0; r < ROWS; r++) { + for (uint8_t c = 0; c < COLS; c++) { + uint8_t cap = totalKeys || 1; + float v = float(heatmap[r][c]) / cap; + led_set_crgb_at (r, c, computeColor (v)); + } + } + } +}; + +Akela::Heatmap HeatmapEffect; diff --git a/src/Akela/Heatmap.h b/src/Akela/Heatmap.h new file mode 100644 index 00000000..bdb64754 --- /dev/null +++ b/src/Akela/Heatmap.h @@ -0,0 +1,39 @@ +/* -*- 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 + +namespace Akela { + class Heatmap : public LEDMode { + public: + Heatmap (void); + + virtual void begin (void) final; + + static void configure (uint16_t updateFrequency); + + virtual void update (void) final; + private: + static Key eventHook (Key mappedKey, byte row, byte col, uint8_t keyState); + static void loopHook (bool postClear); + }; +}; + +extern Akela::Heatmap HeatmapEffect; From 42e819d39a6d02a69e69ccb65567ec2d9b67f4b5 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 16 Jan 2017 17:16:49 +0100 Subject: [PATCH 02/42] Add a status icon. Signed-off-by: Gergely Nagy --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 99f3e1d2..96b02915 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # Akela-Heatmap +![status][st:broken] + + [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 + The `Heatmap` plugin provides a LED effect, that displays a heatmap on the keyboard. The LEDs under each key will have a color according to how much use they see. Fewer used keys will have deep blue colors, that gradually turns From ace73a9449820b9e5486a7de71ef7e826ec71277 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 17 Jan 2017 10:15:07 +0100 Subject: [PATCH 03/42] Move from Akela-Plugins to keyboardio Signed-off-by: Gergely Nagy --- README.md | 2 +- library.properties | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 96b02915..22a3c85a 100644 --- a/README.md +++ b/README.md @@ -63,4 +63,4 @@ The plugin provides two methods on the `HeatmapEffect` object: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/Akela-Plugins/Akela-Heatmap/blob/master/examples/Heatmap/Heatmap.ino + [plugin:example]: https://github.com/keyboardio/Akela-Heatmap/blob/master/examples/Heatmap/Heatmap.ino diff --git a/library.properties b/library.properties index 37b25b0a..5fd6ffc7 100644 --- a/library.properties +++ b/library.properties @@ -5,6 +5,6 @@ maintainer=Gergely Nagy sentence=Heatmap LED effect for Keyboardio boards. paragraph=Displays a heatmap via the LEDs under each key. category=Communication -url=https://github.com/Akela-Plugins/Akela-Heatmap +url=https://github.com/keyboardio/Akela-Heatmap architectures=avr dot_a_linkage=true From 386f893829c489d596fdda29446792d60c92d383 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 27 Jan 2017 09:27:40 +0100 Subject: [PATCH 04/42] Updated to use Keyboardio-LEDControl Signed-off-by: Gergely Nagy --- examples/Heatmap/Heatmap.ino | 2 +- src/Akela/Heatmap.cpp | 2 +- src/Akela/Heatmap.h | 1 + 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/examples/Heatmap/Heatmap.ino b/examples/Heatmap/Heatmap.ino index 8ff990eb..4dcb83cb 100644 --- a/examples/Heatmap/Heatmap.ino +++ b/examples/Heatmap/Heatmap.ino @@ -41,7 +41,7 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { void setup () { Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&HeatmapEffect, NULL); + Keyboardio.use (&LEDControl, &HeatmapEffect, NULL); HeatmapEffect.activate (); } diff --git a/src/Akela/Heatmap.cpp b/src/Akela/Heatmap.cpp index abd4fbf2..5131c8d5 100644 --- a/src/Akela/Heatmap.cpp +++ b/src/Akela/Heatmap.cpp @@ -114,7 +114,7 @@ namespace Akela { for (uint8_t c = 0; c < COLS; c++) { uint8_t cap = totalKeys || 1; float v = float(heatmap[r][c]) / cap; - led_set_crgb_at (r, c, computeColor (v)); + LEDControl.led_set_crgb_at (r, c, computeColor (v)); } } } diff --git a/src/Akela/Heatmap.h b/src/Akela/Heatmap.h index bdb64754..2ba1952f 100644 --- a/src/Akela/Heatmap.h +++ b/src/Akela/Heatmap.h @@ -19,6 +19,7 @@ #pragma once #include +#include namespace Akela { class Heatmap : public LEDMode { From ba0b69bb890dceb6c5c9f621f244e88547900a29 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 27 Jan 2017 23:01:25 +0100 Subject: [PATCH 05/42] Use the new, double-add protected hook functions Signed-off-by: Gergely Nagy --- src/Akela/Heatmap.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Akela/Heatmap.cpp b/src/Akela/Heatmap.cpp index 5131c8d5..20f41727 100644 --- a/src/Akela/Heatmap.cpp +++ b/src/Akela/Heatmap.cpp @@ -69,8 +69,8 @@ namespace Akela { void Heatmap::begin (void) { LEDControl.mode_add (this); - event_handler_hook_add (this->eventHook); - loop_hook_add (this->loopHook); + event_handler_hook_use (this->eventHook); + loop_hook_use (this->loopHook); } void From 3d07ca461430e8d62fc375a5ea1706c3cacc0508 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 1 Feb 2017 22:53:37 +0100 Subject: [PATCH 06/42] Fix the key counting Bail out if the key did NOT toggle on, instead of bailing out only if it did. This addresses the key count computation part of #1. (Shifting looks fine, after this change) Signed-off-by: Gergely Nagy --- src/Akela/Heatmap.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Akela/Heatmap.cpp b/src/Akela/Heatmap.cpp index 20f41727..0feed26b 100644 --- a/src/Akela/Heatmap.cpp +++ b/src/Akela/Heatmap.cpp @@ -85,7 +85,7 @@ namespace Akela { return mappedKey; // if the key is not toggled on, return. - if (key_toggled_on (keyState)) + if (!key_toggled_on (keyState)) return mappedKey; totalKeys++; From fa1e3e36697d716b00a52a3473d0274485a7703a Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 1 Feb 2017 22:55:17 +0100 Subject: [PATCH 07/42] computeColor: Fix the color order The order is BGR, not RGB. Signed-off-by: Gergely Nagy --- src/Akela/Heatmap.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Akela/Heatmap.cpp b/src/Akela/Heatmap.cpp index 0feed26b..a7ae9410 100644 --- a/src/Akela/Heatmap.cpp +++ b/src/Akela/Heatmap.cpp @@ -60,7 +60,7 @@ namespace Akela { uint8_t g = (int)(((heatColors[idx2][1] - heatColors[idx1][1]) * fb + heatColors[idx1][1]) * 255); uint8_t b = (int)(((heatColors[idx2][2] - heatColors[idx1][2]) * fb + heatColors[idx1][2]) * 255); - return {r, g, b}; + return {b, g, r}; } Heatmap::Heatmap (void) { From 54538b42dde7ec4496cfd504ddea468263e0aa59 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 1 Feb 2017 22:55:49 +0100 Subject: [PATCH 08/42] Fix the cap computation Signed-off-by: Gergely Nagy --- src/Akela/Heatmap.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Akela/Heatmap.cpp b/src/Akela/Heatmap.cpp index a7ae9410..ecb04583 100644 --- a/src/Akela/Heatmap.cpp +++ b/src/Akela/Heatmap.cpp @@ -112,7 +112,7 @@ namespace Akela { loopCount = 0; for (uint8_t r = 0; r < ROWS; r++) { for (uint8_t c = 0; c < COLS; c++) { - uint8_t cap = totalKeys || 1; + uint8_t cap = max(totalKeys, 1); float v = float(heatmap[r][c]) / cap; LEDControl.led_set_crgb_at (r, c, computeColor (v)); } From 9aced5ccbd8b4d5387bddd5419fd6ece1a99b497 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 1 Feb 2017 22:56:14 +0100 Subject: [PATCH 09/42] Update heatColors to look a bit nicer on the keyboard Signed-off-by: Gergely Nagy --- src/Akela/Heatmap.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Akela/Heatmap.cpp b/src/Akela/Heatmap.cpp index ecb04583..042b611c 100644 --- a/src/Akela/Heatmap.cpp +++ b/src/Akela/Heatmap.cpp @@ -25,7 +25,7 @@ namespace Akela { static uint16_t updateFrequency = 500; static uint16_t loopCount; - static const float heatColors[][3] = {{0.3, 0.3, 0.3}, {0.3, 1, 0.3}, {1, 1, 0.3}, {1, 0.3, 0.3}}; + static const float heatColors[][3] = {{0.0, 0.0, 0.0}, {0.1, 1, 0.1}, {1, 1, 0.1}, {1, 0.1, 0.1}}; static void shiftStats (void) { From e183d12c2dd63deea46ca5f16f8385d6e71dc689 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 1 Feb 2017 22:56:39 +0100 Subject: [PATCH 10/42] Drop updateFrequency to 50 cycles Signed-off-by: Gergely Nagy --- src/Akela/Heatmap.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Akela/Heatmap.cpp b/src/Akela/Heatmap.cpp index 042b611c..5b1d0d46 100644 --- a/src/Akela/Heatmap.cpp +++ b/src/Akela/Heatmap.cpp @@ -22,7 +22,7 @@ namespace Akela { static uint8_t heatmap[ROWS][COLS]; static uint16_t totalKeys; static uint8_t highestCount; - static uint16_t updateFrequency = 500; + static uint16_t updateFrequency = 50; static uint16_t loopCount; static const float heatColors[][3] = {{0.0, 0.0, 0.0}, {0.1, 1, 0.1}, {1, 1, 0.1}, {1, 0.1, 0.1}}; From bf4fc0de5b4abe69d9f1830a11fceb842425e532 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 1 Feb 2017 22:57:11 +0100 Subject: [PATCH 11/42] Mark the plugin experimental Signed-off-by: Gergely Nagy --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 22a3c85a..e6d67183 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Akela-Heatmap -![status][st:broken] +![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 From e7e4ba0690b1203b939e4bc42608719eb7c0be82 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 10 Feb 2017 09:10:36 +0100 Subject: [PATCH 12/42] Move the static globals into the Heatmap object Fixes #3. Signed-off-by: Gergely Nagy --- src/Akela/Heatmap.cpp | 20 ++++++++++---------- src/Akela/Heatmap.h | 11 +++++++++++ 2 files changed, 21 insertions(+), 10 deletions(-) diff --git a/src/Akela/Heatmap.cpp b/src/Akela/Heatmap.cpp index 5b1d0d46..e067af27 100644 --- a/src/Akela/Heatmap.cpp +++ b/src/Akela/Heatmap.cpp @@ -19,16 +19,16 @@ #include namespace Akela { - static uint8_t heatmap[ROWS][COLS]; - static uint16_t totalKeys; - static uint8_t highestCount; - static uint16_t updateFrequency = 50; - static uint16_t loopCount; + uint8_t Heatmap::heatmap[ROWS][COLS]; + uint16_t Heatmap::totalKeys; + uint8_t Heatmap::highestCount; + uint16_t Heatmap::updateFrequency = 50; + uint16_t Heatmap::loopCount; - static const float heatColors[][3] = {{0.0, 0.0, 0.0}, {0.1, 1, 0.1}, {1, 1, 0.1}, {1, 0.1, 0.1}}; + const float Heatmap::heatColors[][3] = {{0.0, 0.0, 0.0}, {0.1, 1, 0.1}, {1, 1, 0.1}, {1, 0.1, 0.1}}; - static void - shiftStats (void) { + void + Heatmap::shiftStats (void) { highestCount = totalKeys = 0; for (uint8_t r = 0; r < ROWS; r++) { for (uint8_t c = 0; c < COLS; c++) { @@ -40,8 +40,8 @@ namespace Akela { } } - static cRGB - computeColor (float v) { + cRGB + Heatmap::computeColor (float v) { float fb = 0; uint8_t idx1, idx2; diff --git a/src/Akela/Heatmap.h b/src/Akela/Heatmap.h index 2ba1952f..789e1e19 100644 --- a/src/Akela/Heatmap.h +++ b/src/Akela/Heatmap.h @@ -32,6 +32,17 @@ namespace Akela { virtual void update (void) final; private: + static uint8_t heatmap[ROWS][COLS]; + static uint16_t totalKeys; + static uint8_t highestCount; + static uint16_t updateFrequency; + static uint16_t loopCount; + + static const float heatColors[][3]; + + static void shiftStats (void); + static cRGB computeColor (float v); + static Key eventHook (Key mappedKey, byte row, byte col, uint8_t keyState); static void loopHook (bool postClear); }; From f2787a569235e22e4b23580bf9bf40dd821e2bf2 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 10 Feb 2017 09:34:55 +0100 Subject: [PATCH 13/42] Use a timer instead of a loop counter Loop counters are an unreliable way to track time, use a timer instead. Fixes #2. Signed-off-by: Gergely Nagy --- README.md | 13 ++++--------- src/Akela/Heatmap.cpp | 11 +++++------ src/Akela/Heatmap.h | 2 +- 3 files changed, 10 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index e6d67183..4ef3066c 100644 --- a/README.md +++ b/README.md @@ -40,15 +40,10 @@ The plugin provides two methods on the `HeatmapEffect` object: ### `.configure(updateFrequency)` -> Sets up the update frequency of the heatmap. The smaller this value is, the -> more often the heatmap gets updated, but that comes with a cost: updating the -> heatmap takes a fairly large amount of computation, and is not fast. Doing it -> often will considerably slow down the keyboard, and that is rarely a desirable -> thing. -> -> Nevertheless, the frequency preferred is a very subjective thing, which is why -> this function exists. Give it a number, and it will wait that many scan cycles -> between updates. +> Sets up the update frequency of the heatmap, to update every `updateFrequency` +> milliseconds. Updating the heatmap incurs a significant performance penalty, +> and should not be done too often. Doing it too rarely, on the other hand, make +> it much less useful. One has to strike a reasonable balance. > > Defaults to *500*. diff --git a/src/Akela/Heatmap.cpp b/src/Akela/Heatmap.cpp index e067af27..92df231b 100644 --- a/src/Akela/Heatmap.cpp +++ b/src/Akela/Heatmap.cpp @@ -22,8 +22,8 @@ namespace Akela { uint8_t Heatmap::heatmap[ROWS][COLS]; uint16_t Heatmap::totalKeys; uint8_t Heatmap::highestCount; - uint16_t Heatmap::updateFrequency = 50; - uint16_t Heatmap::loopCount; + uint16_t Heatmap::updateFrequency = 500; + uint32_t Heatmap::startTime; const float Heatmap::heatColors[][3] = {{0.0, 0.0, 0.0}, {0.1, 1, 0.1}, {1, 1, 0.1}, {1, 0.1, 0.1}}; @@ -104,12 +104,11 @@ namespace Akela { void Heatmap::update (void) { - loopCount++; - - if (loopCount < updateFrequency) + if (startTime && (millis () - startTime) < updateFrequency) return; - loopCount = 0; + startTime = millis (); + for (uint8_t r = 0; r < ROWS; r++) { for (uint8_t c = 0; c < COLS; c++) { uint8_t cap = max(totalKeys, 1); diff --git a/src/Akela/Heatmap.h b/src/Akela/Heatmap.h index 789e1e19..e01294c6 100644 --- a/src/Akela/Heatmap.h +++ b/src/Akela/Heatmap.h @@ -36,7 +36,7 @@ namespace Akela { static uint16_t totalKeys; static uint8_t highestCount; static uint16_t updateFrequency; - static uint16_t loopCount; + static uint32_t startTime; static const float heatColors[][3]; From ce45b212d70bafd98fa45386be85f280e79f349e Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 11 Feb 2017 22:54:19 +0100 Subject: [PATCH 14/42] The Big Rename Rename the library to Kaleidoscope-Heatmap, and follow up with other renames. Signed-off-by: Gergely Nagy --- README.md | 11 ++++++----- examples/Heatmap/Heatmap.ino | 11 ++++++----- library.properties | 8 ++++---- src/{Akela-Heatmap.h => Kaleidoscope-Heatmap.h} | 4 ++-- src/{Akela => Kaleidoscope}/Heatmap.cpp | 9 +++++---- src/{Akela => Kaleidoscope}/Heatmap.h | 10 +++++----- 6 files changed, 28 insertions(+), 25 deletions(-) rename src/{Akela-Heatmap.h => Kaleidoscope-Heatmap.h} (88%) rename src/{Akela => Kaleidoscope}/Heatmap.cpp (94%) rename src/{Akela => Kaleidoscope}/Heatmap.h (86%) diff --git a/README.md b/README.md index 4ef3066c..dc0fc547 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Akela-Heatmap +# Kaleidoscope-Heatmap ![status][st:experimental] @@ -20,11 +20,12 @@ The plugin comes with reasonable defaults pre-configured, all one needs to do is include the header, and make sure the plugin is in use: ```c++ -#include +#include +#include void setup (void) { - Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&HeatmapEffect, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&HeatmapEffect, NULL); } ``` @@ -58,4 +59,4 @@ The plugin provides two methods on the `HeatmapEffect` object: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/keyboardio/Akela-Heatmap/blob/master/examples/Heatmap/Heatmap.ino + [plugin:example]: https://github.com/keyboardio/Kaleidoscope-Heatmap/blob/master/examples/Heatmap/Heatmap.ino diff --git a/examples/Heatmap/Heatmap.ino b/examples/Heatmap/Heatmap.ino index 4dcb83cb..8579e4ba 100644 --- a/examples/Heatmap/Heatmap.ino +++ b/examples/Heatmap/Heatmap.ino @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Heatmap -- Heatmap LED effect for Kaleidoscope. * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,7 +16,8 @@ * along with this program. If not, see . */ -#include +#include +#include const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED @@ -40,12 +41,12 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { }; void setup () { - Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&LEDControl, &HeatmapEffect, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&LEDControl, &HeatmapEffect, NULL); HeatmapEffect.activate (); } void loop () { - Keyboardio.loop (); + Kaleidoscope.loop (); } diff --git a/library.properties b/library.properties index 5fd6ffc7..81cf365e 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ -name=Akela-Heatmap +name=Kaleidoscope-Heatmap version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy -sentence=Heatmap LED effect for Keyboardio boards. +maintainer=Gergely Nagy +sentence=Heatmap LED effect for Kaleidoscope. paragraph=Displays a heatmap via the LEDs under each key. category=Communication -url=https://github.com/keyboardio/Akela-Heatmap +url=https://github.com/keyboardio/Kaleidoscope-Heatmap architectures=avr dot_a_linkage=true diff --git a/src/Akela-Heatmap.h b/src/Kaleidoscope-Heatmap.h similarity index 88% rename from src/Akela-Heatmap.h rename to src/Kaleidoscope-Heatmap.h index 2c0d1a10..e4874414 100644 --- a/src/Akela-Heatmap.h +++ b/src/Kaleidoscope-Heatmap.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Heatmap -- Heatmap LED effect for Kaleidoscope. * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -18,4 +18,4 @@ #pragma once -#include +#include diff --git a/src/Akela/Heatmap.cpp b/src/Kaleidoscope/Heatmap.cpp similarity index 94% rename from src/Akela/Heatmap.cpp rename to src/Kaleidoscope/Heatmap.cpp index 92df231b..7a4557d1 100644 --- a/src/Akela/Heatmap.cpp +++ b/src/Kaleidoscope/Heatmap.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Heatmap -- Heatmap LED effect for Kaleidoscope. * 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 { uint8_t Heatmap::heatmap[ROWS][COLS]; uint16_t Heatmap::totalKeys; uint8_t Heatmap::highestCount; @@ -119,4 +120,4 @@ namespace Akela { } }; -Akela::Heatmap HeatmapEffect; +KaleidoscopePlugins::Heatmap HeatmapEffect; diff --git a/src/Akela/Heatmap.h b/src/Kaleidoscope/Heatmap.h similarity index 86% rename from src/Akela/Heatmap.h rename to src/Kaleidoscope/Heatmap.h index e01294c6..1337fe7e 100644 --- a/src/Akela/Heatmap.h +++ b/src/Kaleidoscope/Heatmap.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Heatmap -- Heatmap LED effect for Kaleidoscope. * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -18,10 +18,10 @@ #pragma once -#include -#include +#include +#include -namespace Akela { +namespace KaleidoscopePlugins { class Heatmap : public LEDMode { public: Heatmap (void); @@ -48,4 +48,4 @@ namespace Akela { }; }; -extern Akela::Heatmap HeatmapEffect; +extern KaleidoscopePlugins::Heatmap HeatmapEffect; From 7a5a1b2b3305646b6a4cc24bfd353029ece5bb18 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 21 Feb 2017 09:57:27 +0100 Subject: [PATCH 15/42] Improved timer handling Instead of calculating the elapsed time every time we check the timer, calculate the projected end-time when we start the timer, and just compare millis() against that. Also removes the `.configure()` method, in favour of making the `timeOut` property public. Signed-off-by: Gergely Nagy --- README.md | 20 +++++++++++--------- src/Kaleidoscope/Heatmap.cpp | 13 ++++--------- src/Kaleidoscope/Heatmap.h | 5 ++--- 3 files changed, 17 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index dc0fc547..6595d054 100644 --- a/README.md +++ b/README.md @@ -39,21 +39,23 @@ is highly recommended. The plugin provides two methods on the `HeatmapEffect` object: -### `.configure(updateFrequency)` - -> Sets up the update frequency of the heatmap, to update every `updateFrequency` -> milliseconds. Updating the heatmap incurs a significant performance penalty, -> and should not be done too often. Doing it too rarely, on the other hand, make -> it much less useful. One has to strike a reasonable balance. -> -> Defaults to *500*. - ### `.activate()` > When called, immediately activates the Heatmap effect. Mostly useful in the > `setup()` method of the Sketch, or in macros that are meant to switch to the > heatmap effect, no matter where we are in the list. +### `.timeOut` + +> The number of milliseconds to wait between updating the heatmap. Updating the +> heatmap incurs a significant performance penalty, and should not be done too +> often. Doing it too rarely, on the other hand, make it much less useful. One +> has to strike a reasonable balance. +> +> Not strictly a method, it is a variable one can assign a new value to. +> +> Defaults to *500*. + ## Further reading Starting from the [example][plugin:example] is the recommended way of getting diff --git a/src/Kaleidoscope/Heatmap.cpp b/src/Kaleidoscope/Heatmap.cpp index 7a4557d1..bebdf69f 100644 --- a/src/Kaleidoscope/Heatmap.cpp +++ b/src/Kaleidoscope/Heatmap.cpp @@ -23,8 +23,8 @@ namespace KaleidoscopePlugins { uint8_t Heatmap::heatmap[ROWS][COLS]; uint16_t Heatmap::totalKeys; uint8_t Heatmap::highestCount; - uint16_t Heatmap::updateFrequency = 500; - uint32_t Heatmap::startTime; + uint16_t Heatmap::updateDelay = 500; + uint32_t Heatmap::endTime; const float Heatmap::heatColors[][3] = {{0.0, 0.0, 0.0}, {0.1, 1, 0.1}, {1, 1, 0.1}, {1, 0.1, 0.1}}; @@ -74,11 +74,6 @@ namespace KaleidoscopePlugins { loop_hook_use (this->loopHook); } - void - Heatmap::configure (uint16_t updateFreq) { - updateFrequency = updateFreq; - } - Key Heatmap::eventHook (Key mappedKey, byte row, byte col, uint8_t keyState) { // if it is a synthetic key, skip it. @@ -105,10 +100,10 @@ namespace KaleidoscopePlugins { void Heatmap::update (void) { - if (startTime && (millis () - startTime) < updateFrequency) + if (endTime && (millis () > endTime)) return; - startTime = millis (); + endTime = millis () + updateDelay; for (uint8_t r = 0; r < ROWS; r++) { for (uint8_t c = 0; c < COLS; c++) { diff --git a/src/Kaleidoscope/Heatmap.h b/src/Kaleidoscope/Heatmap.h index 1337fe7e..bad2b08d 100644 --- a/src/Kaleidoscope/Heatmap.h +++ b/src/Kaleidoscope/Heatmap.h @@ -28,15 +28,14 @@ namespace KaleidoscopePlugins { virtual void begin (void) final; - static void configure (uint16_t updateFrequency); + static uint16_t updateDelay; virtual void update (void) final; private: static uint8_t heatmap[ROWS][COLS]; static uint16_t totalKeys; static uint8_t highestCount; - static uint16_t updateFrequency; - static uint32_t startTime; + static uint32_t endTime; static const float heatColors[][3]; From f1e8f93f39e66e8c60b61c440c72f470c6b8d08f Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Feb 2017 11:27:41 +0100 Subject: [PATCH 16/42] Test the plugin with Travis CI Signed-off-by: Gergely Nagy --- .gitignore | 2 ++ .travis.yml | 18 ++++++++++++++++++ README.md | 5 ++++- 3 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 .travis.yml diff --git a/.gitignore b/.gitignore index aead9485..be16c9be 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,4 @@ .#* *~ +/hardware/ +/output/ \ No newline at end of file diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 00000000..77431b24 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,18 @@ +language: cpp +dist: trusty +sudo: required +os: + - linux +before_install: + - pushd .. + - wget http://downloads.arduino.cc/arduino-1.6.11-linux64.tar.xz + - tar xf arduino-1.6.11-linux64.tar.xz + - popd +install: + - git clone --recurse-submodules https://github.com/keyboardio/Arduino-Boards hardware/keyboardio/avr +script: + - export DEFAULT_SKETCH=$(cd examples; basename *) + - export ARDUINO_PATH=$(pwd)/../arduino-1.6.11 + - export BOARD_HARDWARE_PATH=$(pwd)/hardware + - export EXTRA_BUILDER_ARGS="-libraries ." + - hardware/keyboardio/avr/libraries/Kaleidoscope/tools/kaleidoscope-builder build diff --git a/README.md b/README.md index 6595d054..976daefe 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # Kaleidoscope-Heatmap -![status][st:experimental] +![status][st:experimental] [![Build Status][travis:image]][travis:status] + + [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-Heatmap.svg?branch=master + [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-Heatmap [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 d7ec8fd842ea31ab28efd9db03e859204ca8bfc4 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 20 Mar 2017 12:45:30 +0100 Subject: [PATCH 17/42] README: Add a "Dependencies" section Signed-off-by: Gergely Nagy --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 976daefe..851ee26a 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,10 @@ The plugin provides two methods on the `HeatmapEffect` object: > > Defaults to *500*. +## Dependencies + +* [Kaleidoscope-LEDControl](https://github.com/keyboardio/Kaleidoscope-LEDControl) + ## Further reading Starting from the [example][plugin:example] is the recommended way of getting From 647e15a4bc25efa9d414688cdad2c9a31468eb5a Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 22 May 2017 13:00:36 -0700 Subject: [PATCH 18/42] Fix example to match new key definitions --- examples/Heatmap/Heatmap.ino | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/examples/Heatmap/Heatmap.ino b/examples/Heatmap/Heatmap.ino index 8579e4ba..3b110fd1 100644 --- a/examples/Heatmap/Heatmap.ino +++ b/examples/Heatmap/Heatmap.ino @@ -19,24 +19,25 @@ #include #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_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, - Key_LCtrl, Key_Backspace, Key_LGUI, Key_LShift, - Key_skip, + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, + Key_NoKey, 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 + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, + Key_NoKey ), }; From 8e3f0ac20e98df794ab5aae7a94f5c612fc68717 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 23 May 2017 20:02:53 -0700 Subject: [PATCH 19/42] New build infrastructure --- .travis.yml | 29 ++++++++++++++++------------- Makefile | 12 ++++++++++++ 2 files changed, 28 insertions(+), 13 deletions(-) create mode 100644 Makefile diff --git a/.travis.yml b/.travis.yml index 77431b24..e7030acf 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,18 +1,21 @@ -language: cpp dist: trusty -sudo: required +sudo: false os: - linux -before_install: - - pushd .. - - wget http://downloads.arduino.cc/arduino-1.6.11-linux64.tar.xz - - tar xf arduino-1.6.11-linux64.tar.xz - - popd install: - - git clone --recurse-submodules https://github.com/keyboardio/Arduino-Boards hardware/keyboardio/avr + - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Arduino-Boards hardware/keyboardio/avr script: - - export DEFAULT_SKETCH=$(cd examples; basename *) - - export ARDUINO_PATH=$(pwd)/../arduino-1.6.11 - - export BOARD_HARDWARE_PATH=$(pwd)/hardware - - export EXTRA_BUILDER_ARGS="-libraries ." - - hardware/keyboardio/avr/libraries/Kaleidoscope/tools/kaleidoscope-builder build + - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware +notifications: + irc: + channels: + - "chat.freenode.net#keyboardio" + use_notice: true + skip_join: true + template: + - "%{repository_name}/%{branch} %{commit} by %{author}: %{commit_subject} %{build_url} %{message}" + email: + on_success: change + on_failure: change +cache: + ccache: true diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..9ce0c4a9 --- /dev/null +++ b/Makefile @@ -0,0 +1,12 @@ +# This stub makefile for a Kaleidoscope plugin pulls in +# all targets from the Kaleidoscope-Plugin library + +MAKEFILE_PREFIX=keyboardio/avr/libraries/Kaleidoscope-Plugin/build +UNAME_S := $(shell uname -s) + +BOARD_HARDWARE_PATH ?= $(HOME)/Arduino/hardware +ifeq ($(UNAME_S),Darwin) +BOARD_HARDWARE_PATH ?= $(HOME)/Library/Arduino/hardware +endif + +include $(BOARD_HARDWARE_PATH)/$(MAKEFILE_PREFIX)/*.mk From 0489fd9196bf8ec35603a15b0b1ec86f56861646 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Fri, 26 May 2017 16:20:21 -0700 Subject: [PATCH 20/42] make astyle --- examples/Heatmap/Heatmap.ino | 44 ++++++++--------- src/Kaleidoscope/Heatmap.cpp | 96 ++++++++++++++++++------------------ src/Kaleidoscope/Heatmap.h | 4 +- 3 files changed, 72 insertions(+), 72 deletions(-) diff --git a/examples/Heatmap/Heatmap.ino b/examples/Heatmap/Heatmap.ino index 3b110fd1..a5f12ea5 100644 --- a/examples/Heatmap/Heatmap.ino +++ b/examples/Heatmap/Heatmap.ino @@ -21,33 +21,33 @@ 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_NoKey, - - 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_NoKey - ), + [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_NoKey, + + 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_NoKey + ), }; void setup () { - Kaleidoscope.setup (KEYMAP_SIZE); - Kaleidoscope.use (&LEDControl, &HeatmapEffect, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&LEDControl, &HeatmapEffect, NULL); - HeatmapEffect.activate (); + HeatmapEffect.activate (); } void loop () { - Kaleidoscope.loop (); + Kaleidoscope.loop (); } diff --git a/src/Kaleidoscope/Heatmap.cpp b/src/Kaleidoscope/Heatmap.cpp index bebdf69f..a1287ecf 100644 --- a/src/Kaleidoscope/Heatmap.cpp +++ b/src/Kaleidoscope/Heatmap.cpp @@ -20,41 +20,41 @@ #include namespace KaleidoscopePlugins { - uint8_t Heatmap::heatmap[ROWS][COLS]; - uint16_t Heatmap::totalKeys; - uint8_t Heatmap::highestCount; - uint16_t Heatmap::updateDelay = 500; - uint32_t Heatmap::endTime; +uint8_t Heatmap::heatmap[ROWS][COLS]; +uint16_t Heatmap::totalKeys; +uint8_t Heatmap::highestCount; +uint16_t Heatmap::updateDelay = 500; +uint32_t Heatmap::endTime; - const float Heatmap::heatColors[][3] = {{0.0, 0.0, 0.0}, {0.1, 1, 0.1}, {1, 1, 0.1}, {1, 0.1, 0.1}}; +const float Heatmap::heatColors[][3] = {{0.0, 0.0, 0.0}, {0.1, 1, 0.1}, {1, 1, 0.1}, {1, 0.1, 0.1}}; - void - Heatmap::shiftStats (void) { +void +Heatmap::shiftStats (void) { highestCount = totalKeys = 0; for (uint8_t r = 0; r < ROWS; r++) { - for (uint8_t c = 0; c < COLS; c++) { - heatmap[r][c] = heatmap[r][c] >> 1; - totalKeys += heatmap[r][c]; - if (heatmap[r][c] > highestCount) - highestCount = heatmap[r][c]; - } + for (uint8_t c = 0; c < COLS; c++) { + heatmap[r][c] = heatmap[r][c] >> 1; + totalKeys += heatmap[r][c]; + if (heatmap[r][c] > highestCount) + highestCount = heatmap[r][c]; + } } - } +} - cRGB - Heatmap::computeColor (float v) { +cRGB +Heatmap::computeColor (float v) { float fb = 0; uint8_t idx1, idx2; if (v <= 0) { - idx1 = idx2 = 0; + idx1 = idx2 = 0; } else if (v >= 1) { - idx1 = idx2 = 3; + idx1 = idx2 = 3; } else { - float val = v * 3; - idx1 = int(floor(val)); - idx2 = idx1 + 1; - fb = val - float(idx1); + float val = v * 3; + idx1 = int(floor(val)); + idx2 = idx1 + 1; + fb = val - float(idx1); } uint8_t r = (int)(((heatColors[idx2][0] - heatColors[idx1][0]) * fb + heatColors[idx1][0]) * 255); @@ -62,57 +62,57 @@ namespace KaleidoscopePlugins { uint8_t b = (int)(((heatColors[idx2][2] - heatColors[idx1][2]) * fb + heatColors[idx1][2]) * 255); return {b, g, r}; - } +} - Heatmap::Heatmap (void) { - } +Heatmap::Heatmap (void) { +} - void - Heatmap::begin (void) { +void +Heatmap::begin (void) { LEDControl.mode_add (this); event_handler_hook_use (this->eventHook); loop_hook_use (this->loopHook); - } +} - Key - Heatmap::eventHook (Key mappedKey, byte row, byte col, uint8_t keyState) { +Key +Heatmap::eventHook (Key mappedKey, byte row, byte col, uint8_t keyState) { // if it is a synthetic key, skip it. if (keyState & INJECTED) - return mappedKey; + return mappedKey; // if the key is not toggled on, return. if (!key_toggled_on (keyState)) - return mappedKey; + return mappedKey; totalKeys++; heatmap[row][col]++; if (heatmap[row][col] > highestCount) - highestCount = heatmap[row][col]; + highestCount = heatmap[row][col]; return mappedKey; - } +} - void - Heatmap::loopHook (bool postClear) { +void +Heatmap::loopHook (bool postClear) { if (highestCount > 191 || totalKeys > 16000) - shiftStats(); - } + shiftStats(); +} - void - Heatmap::update (void) { +void +Heatmap::update (void) { if (endTime && (millis () > endTime)) - return; + return; endTime = millis () + updateDelay; for (uint8_t r = 0; r < ROWS; r++) { - for (uint8_t c = 0; c < COLS; c++) { - uint8_t cap = max(totalKeys, 1); - float v = float(heatmap[r][c]) / cap; - LEDControl.led_set_crgb_at (r, c, computeColor (v)); - } + for (uint8_t c = 0; c < COLS; c++) { + uint8_t cap = max(totalKeys, 1); + float v = float(heatmap[r][c]) / cap; + LEDControl.led_set_crgb_at (r, c, computeColor (v)); + } } - } +} }; KaleidoscopePlugins::Heatmap HeatmapEffect; diff --git a/src/Kaleidoscope/Heatmap.h b/src/Kaleidoscope/Heatmap.h index bad2b08d..f9c64f8d 100644 --- a/src/Kaleidoscope/Heatmap.h +++ b/src/Kaleidoscope/Heatmap.h @@ -22,7 +22,7 @@ #include namespace KaleidoscopePlugins { - class Heatmap : public LEDMode { +class Heatmap : public LEDMode { public: Heatmap (void); @@ -44,7 +44,7 @@ namespace KaleidoscopePlugins { static Key eventHook (Key mappedKey, byte row, byte col, uint8_t keyState); static void loopHook (bool postClear); - }; +}; }; extern KaleidoscopePlugins::Heatmap HeatmapEffect; From 17487f9c26b64e36b083fc160ea69c244f42bbfd Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Sat, 3 Jun 2017 22:55:33 -0700 Subject: [PATCH 21/42] astyle with current project style guidelines --- examples/Heatmap/Heatmap.ino | 48 +++++++------- src/Kaleidoscope/Heatmap.cpp | 122 +++++++++++++++++------------------ src/Kaleidoscope/Heatmap.h | 30 ++++----- 3 files changed, 100 insertions(+), 100 deletions(-) diff --git a/examples/Heatmap/Heatmap.ino b/examples/Heatmap/Heatmap.ino index a5f12ea5..25b0ebe1 100644 --- a/examples/Heatmap/Heatmap.ino +++ b/examples/Heatmap/Heatmap.ino @@ -21,33 +21,33 @@ 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_NoKey, - - 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_NoKey - ), + [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_NoKey, + + 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_NoKey + ), }; -void setup () { - Kaleidoscope.setup (KEYMAP_SIZE); - Kaleidoscope.use (&LEDControl, &HeatmapEffect, NULL); +void setup() { + Kaleidoscope.setup(KEYMAP_SIZE); + Kaleidoscope.use(&LEDControl, &HeatmapEffect, NULL); - HeatmapEffect.activate (); + HeatmapEffect.activate(); } -void loop () { - Kaleidoscope.loop (); +void loop() { + Kaleidoscope.loop(); } diff --git a/src/Kaleidoscope/Heatmap.cpp b/src/Kaleidoscope/Heatmap.cpp index a1287ecf..e8d74327 100644 --- a/src/Kaleidoscope/Heatmap.cpp +++ b/src/Kaleidoscope/Heatmap.cpp @@ -29,89 +29,89 @@ uint32_t Heatmap::endTime; const float Heatmap::heatColors[][3] = {{0.0, 0.0, 0.0}, {0.1, 1, 0.1}, {1, 1, 0.1}, {1, 0.1, 0.1}}; void -Heatmap::shiftStats (void) { - highestCount = totalKeys = 0; - for (uint8_t r = 0; r < ROWS; r++) { - for (uint8_t c = 0; c < COLS; c++) { - heatmap[r][c] = heatmap[r][c] >> 1; - totalKeys += heatmap[r][c]; - if (heatmap[r][c] > highestCount) - highestCount = heatmap[r][c]; - } +Heatmap::shiftStats(void) { + highestCount = totalKeys = 0; + for (uint8_t r = 0; r < ROWS; r++) { + for (uint8_t c = 0; c < COLS; c++) { + heatmap[r][c] = heatmap[r][c] >> 1; + totalKeys += heatmap[r][c]; + if (heatmap[r][c] > highestCount) + highestCount = heatmap[r][c]; } + } } cRGB -Heatmap::computeColor (float v) { - float fb = 0; - uint8_t idx1, idx2; - - if (v <= 0) { - idx1 = idx2 = 0; - } else if (v >= 1) { - idx1 = idx2 = 3; - } else { - float val = v * 3; - idx1 = int(floor(val)); - idx2 = idx1 + 1; - fb = val - float(idx1); - } - - uint8_t r = (int)(((heatColors[idx2][0] - heatColors[idx1][0]) * fb + heatColors[idx1][0]) * 255); - uint8_t g = (int)(((heatColors[idx2][1] - heatColors[idx1][1]) * fb + heatColors[idx1][1]) * 255); - uint8_t b = (int)(((heatColors[idx2][2] - heatColors[idx1][2]) * fb + heatColors[idx1][2]) * 255); - - return {b, g, r}; +Heatmap::computeColor(float v) { + float fb = 0; + uint8_t idx1, idx2; + + if (v <= 0) { + idx1 = idx2 = 0; + } else if (v >= 1) { + idx1 = idx2 = 3; + } else { + float val = v * 3; + idx1 = int(floor(val)); + idx2 = idx1 + 1; + fb = val - float(idx1); + } + + uint8_t r = (int)(((heatColors[idx2][0] - heatColors[idx1][0]) * fb + heatColors[idx1][0]) * 255); + uint8_t g = (int)(((heatColors[idx2][1] - heatColors[idx1][1]) * fb + heatColors[idx1][1]) * 255); + uint8_t b = (int)(((heatColors[idx2][2] - heatColors[idx1][2]) * fb + heatColors[idx1][2]) * 255); + + return {b, g, r}; } -Heatmap::Heatmap (void) { +Heatmap::Heatmap(void) { } void -Heatmap::begin (void) { - LEDControl.mode_add (this); - event_handler_hook_use (this->eventHook); - loop_hook_use (this->loopHook); +Heatmap::begin(void) { + LEDControl.mode_add(this); + event_handler_hook_use(this->eventHook); + loop_hook_use(this->loopHook); } Key -Heatmap::eventHook (Key mappedKey, byte row, byte col, uint8_t keyState) { - // if it is a synthetic key, skip it. - if (keyState & INJECTED) - return mappedKey; +Heatmap::eventHook(Key mappedKey, byte row, byte col, uint8_t keyState) { + // if it is a synthetic key, skip it. + if (keyState & INJECTED) + return mappedKey; - // if the key is not toggled on, return. - if (!key_toggled_on (keyState)) - return mappedKey; + // if the key is not toggled on, return. + if (!key_toggled_on(keyState)) + return mappedKey; - totalKeys++; - heatmap[row][col]++; - if (heatmap[row][col] > highestCount) - highestCount = heatmap[row][col]; + totalKeys++; + heatmap[row][col]++; + if (heatmap[row][col] > highestCount) + highestCount = heatmap[row][col]; - return mappedKey; + return mappedKey; } void -Heatmap::loopHook (bool postClear) { - if (highestCount > 191 || totalKeys > 16000) - shiftStats(); +Heatmap::loopHook(bool postClear) { + if (highestCount > 191 || totalKeys > 16000) + shiftStats(); } void -Heatmap::update (void) { - if (endTime && (millis () > endTime)) - return; - - endTime = millis () + updateDelay; - - for (uint8_t r = 0; r < ROWS; r++) { - for (uint8_t c = 0; c < COLS; c++) { - uint8_t cap = max(totalKeys, 1); - float v = float(heatmap[r][c]) / cap; - LEDControl.led_set_crgb_at (r, c, computeColor (v)); - } +Heatmap::update(void) { + if (endTime && (millis() > endTime)) + return; + + endTime = millis() + updateDelay; + + for (uint8_t r = 0; r < ROWS; r++) { + for (uint8_t c = 0; c < COLS; c++) { + uint8_t cap = max(totalKeys, 1); + float v = float(heatmap[r][c]) / cap; + LEDControl.led_set_crgb_at(r, c, computeColor(v)); } + } } }; diff --git a/src/Kaleidoscope/Heatmap.h b/src/Kaleidoscope/Heatmap.h index f9c64f8d..a49f58b3 100644 --- a/src/Kaleidoscope/Heatmap.h +++ b/src/Kaleidoscope/Heatmap.h @@ -23,27 +23,27 @@ namespace KaleidoscopePlugins { class Heatmap : public LEDMode { - public: - Heatmap (void); + public: + Heatmap(void); - virtual void begin (void) final; + virtual void begin(void) final; - static uint16_t updateDelay; + static uint16_t updateDelay; - virtual void update (void) final; - private: - static uint8_t heatmap[ROWS][COLS]; - static uint16_t totalKeys; - static uint8_t highestCount; - static uint32_t endTime; + virtual void update(void) final; + private: + static uint8_t heatmap[ROWS][COLS]; + static uint16_t totalKeys; + static uint8_t highestCount; + static uint32_t endTime; - static const float heatColors[][3]; + static const float heatColors[][3]; - static void shiftStats (void); - static cRGB computeColor (float v); + static void shiftStats(void); + static cRGB computeColor(float v); - static Key eventHook (Key mappedKey, byte row, byte col, uint8_t keyState); - static void loopHook (bool postClear); + static Key eventHook(Key mappedKey, byte row, byte col, uint8_t keyState); + static void loopHook(bool postClear); }; }; From be19287112d5caf5053409bb967ae107e5fcdc23 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Sun, 4 Jun 2017 00:34:59 -0700 Subject: [PATCH 22/42] virtual void begin(void) final is redunant and makes the linter unhappy --- src/Kaleidoscope/Heatmap.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/Heatmap.h b/src/Kaleidoscope/Heatmap.h index a49f58b3..2b214c34 100644 --- a/src/Kaleidoscope/Heatmap.h +++ b/src/Kaleidoscope/Heatmap.h @@ -26,7 +26,7 @@ class Heatmap : public LEDMode { public: Heatmap(void); - virtual void begin(void) final; + void begin(void) final; static uint16_t updateDelay; From 95b34d4eb0e0664382cc61f0e99f006709072772 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 4 Jun 2017 14:24:42 +0200 Subject: [PATCH 23/42] Kaleidoscope Style Guide conformance Signed-off-by: Gergely Nagy --- README.md | 15 ++++--- examples/Heatmap/Heatmap.ino | 37 ++++++++-------- src/Kaleidoscope/Heatmap.cpp | 86 ++++++++++++++++++------------------ src/Kaleidoscope/Heatmap.h | 27 ++++++----- 4 files changed, 81 insertions(+), 84 deletions(-) diff --git a/README.md b/README.md index 851ee26a..fec28c01 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,9 @@ [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-Heatmap.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-Heatmap - [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 The `Heatmap` plugin provides a LED effect, that displays a heatmap on the keyboard. The LEDs under each key will have a color according to how much use @@ -26,9 +26,10 @@ include the header, and make sure the plugin is in use: #include #include -void setup (void) { - Kaleidoscope.setup (KEYMAP_SIZE); - Kaleidoscope.use (&HeatmapEffect, NULL); +void setup() { + USE_PLUGINS(&HeatmapEffect); + + Kaleidoscope.setup (); } ``` @@ -48,7 +49,7 @@ The plugin provides two methods on the `HeatmapEffect` object: > `setup()` method of the Sketch, or in macros that are meant to switch to the > heatmap effect, no matter where we are in the list. -### `.timeOut` +### `.update_delay` > The number of milliseconds to wait between updating the heatmap. Updating the > heatmap incurs a significant performance penalty, and should not be done too diff --git a/examples/Heatmap/Heatmap.ino b/examples/Heatmap/Heatmap.ino index 25b0ebe1..25b24070 100644 --- a/examples/Heatmap/Heatmap.ino +++ b/examples/Heatmap/Heatmap.ino @@ -22,28 +22,27 @@ 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_NoKey, - - 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_NoKey - ), + (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_NoKey, + + 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_NoKey), }; void setup() { - Kaleidoscope.setup(KEYMAP_SIZE); - Kaleidoscope.use(&LEDControl, &HeatmapEffect, NULL); + USE_PLUGINS(&HeatmapEffect); + + Kaleidoscope.setup(); HeatmapEffect.activate(); } diff --git a/src/Kaleidoscope/Heatmap.cpp b/src/Kaleidoscope/Heatmap.cpp index e8d74327..da2b798c 100644 --- a/src/Kaleidoscope/Heatmap.cpp +++ b/src/Kaleidoscope/Heatmap.cpp @@ -19,30 +19,29 @@ #include #include -namespace KaleidoscopePlugins { -uint8_t Heatmap::heatmap[ROWS][COLS]; -uint16_t Heatmap::totalKeys; -uint8_t Heatmap::highestCount; -uint16_t Heatmap::updateDelay = 500; -uint32_t Heatmap::endTime; +namespace kaleidoscope { -const float Heatmap::heatColors[][3] = {{0.0, 0.0, 0.0}, {0.1, 1, 0.1}, {1, 1, 0.1}, {1, 0.1, 0.1}}; +uint8_t Heatmap::heatmap_[ROWS][COLS]; +uint16_t Heatmap::total_keys_; +uint8_t Heatmap::highest_count_; +uint16_t Heatmap::update_delay = 500; +uint32_t Heatmap::end_time_; -void -Heatmap::shiftStats(void) { - highestCount = totalKeys = 0; +const float Heatmap::heat_colors_[][3] = {{0.0, 0.0, 0.0}, {0.1, 1, 0.1}, {1, 1, 0.1}, {1, 0.1, 0.1}}; + +void Heatmap::shiftStats(void) { + highest_count_ = total_keys_ = 0; for (uint8_t r = 0; r < ROWS; r++) { for (uint8_t c = 0; c < COLS; c++) { - heatmap[r][c] = heatmap[r][c] >> 1; - totalKeys += heatmap[r][c]; - if (heatmap[r][c] > highestCount) - highestCount = heatmap[r][c]; + heatmap_[r][c] = heatmap_[r][c] >> 1; + total_keys_ += heatmap_[r][c]; + if (heatmap_[r][c] > highest_count_) + highest_count_ = heatmap_[r][c]; } } } -cRGB -Heatmap::computeColor(float v) { +cRGB Heatmap::computeColor(float v) { float fb = 0; uint8_t idx1, idx2; @@ -52,14 +51,14 @@ Heatmap::computeColor(float v) { idx1 = idx2 = 3; } else { float val = v * 3; - idx1 = int(floor(val)); + idx1 = static_cast(floor(val)); idx2 = idx1 + 1; - fb = val - float(idx1); + fb = val - static_cast(idx1); } - uint8_t r = (int)(((heatColors[idx2][0] - heatColors[idx1][0]) * fb + heatColors[idx1][0]) * 255); - uint8_t g = (int)(((heatColors[idx2][1] - heatColors[idx1][1]) * fb + heatColors[idx1][1]) * 255); - uint8_t b = (int)(((heatColors[idx2][2] - heatColors[idx1][2]) * fb + heatColors[idx1][2]) * 255); + uint8_t r = static_cast(((heat_colors_[idx2][0] - heat_colors_[idx1][0]) * fb + heat_colors_[idx1][0]) * 255); + uint8_t g = static_cast(((heat_colors_[idx2][1] - heat_colors_[idx1][1]) * fb + heat_colors_[idx1][1]) * 255); + uint8_t b = static_cast(((heat_colors_[idx2][2] - heat_colors_[idx1][2]) * fb + heat_colors_[idx1][2]) * 255); return {b, g, r}; } @@ -67,52 +66,51 @@ Heatmap::computeColor(float v) { Heatmap::Heatmap(void) { } -void -Heatmap::begin(void) { +void Heatmap::begin(void) { LEDControl.mode_add(this); - event_handler_hook_use(this->eventHook); - loop_hook_use(this->loopHook); + event_handler_hook_use(eventHook); + loop_hook_use(loopHook); } -Key -Heatmap::eventHook(Key mappedKey, byte row, byte col, uint8_t keyState) { +Key Heatmap::eventHook(Key mapped_key, byte row, byte col, uint8_t key_state) { // if it is a synthetic key, skip it. - if (keyState & INJECTED) - return mappedKey; + if (key_state & INJECTED) + return mapped_key; // if the key is not toggled on, return. - if (!key_toggled_on(keyState)) - return mappedKey; + if (!key_toggled_on(key_state)) + return mapped_key; - totalKeys++; - heatmap[row][col]++; - if (heatmap[row][col] > highestCount) - highestCount = heatmap[row][col]; + total_keys_++; + heatmap_[row][col]++; + if (heatmap_[row][col] > highest_count_) + highest_count_ = heatmap_[row][col]; - return mappedKey; + return mapped_key; } void -Heatmap::loopHook(bool postClear) { - if (highestCount > 191 || totalKeys > 16000) +Heatmap::loopHook(bool is_post_clear) { + if (highest_count_ > 191 || total_keys_ > 16000) shiftStats(); } void Heatmap::update(void) { - if (endTime && (millis() > endTime)) + if (end_time_ && (millis() > end_time_)) return; - endTime = millis() + updateDelay; + end_time_ = millis() + update_delay; for (uint8_t r = 0; r < ROWS; r++) { for (uint8_t c = 0; c < COLS; c++) { - uint8_t cap = max(totalKeys, 1); - float v = float(heatmap[r][c]) / cap; + uint8_t cap = max(total_keys_, 1); + float v = static_cast(heatmap_[r][c]) / cap; LEDControl.led_set_crgb_at(r, c, computeColor(v)); } } } -}; -KaleidoscopePlugins::Heatmap HeatmapEffect; +} + +kaleidoscope::Heatmap HeatmapEffect; diff --git a/src/Kaleidoscope/Heatmap.h b/src/Kaleidoscope/Heatmap.h index 2b214c34..2e312ebb 100644 --- a/src/Kaleidoscope/Heatmap.h +++ b/src/Kaleidoscope/Heatmap.h @@ -21,30 +21,29 @@ #include #include -namespace KaleidoscopePlugins { +namespace kaleidoscope { class Heatmap : public LEDMode { public: Heatmap(void); - void begin(void) final; - - static uint16_t updateDelay; + static uint16_t update_delay; - virtual void update(void) final; + void begin(void) final; + void update(void) final; private: - static uint8_t heatmap[ROWS][COLS]; - static uint16_t totalKeys; - static uint8_t highestCount; - static uint32_t endTime; + static uint8_t heatmap_[ROWS][COLS]; + static uint16_t total_keys_; + static uint8_t highest_count_; + static uint32_t end_time_; - static const float heatColors[][3]; + static const float heat_colors_[][3]; static void shiftStats(void); static cRGB computeColor(float v); - static Key eventHook(Key mappedKey, byte row, byte col, uint8_t keyState); - static void loopHook(bool postClear); -}; + static Key eventHook(Key mapped_key, byte row, byte col, uint8_t key_state); + static void loopHook(bool is_post_clear); }; +} -extern KaleidoscopePlugins::Heatmap HeatmapEffect; +extern kaleidoscope::Heatmap HeatmapEffect; From 751ce314fe42074a008fc276e3d06771c1a05924 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 5 Jun 2017 15:50:07 +0200 Subject: [PATCH 24/42] README.md: Properties are not methods Signed-off-by: Gergely Nagy --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fec28c01..daeec258 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,8 @@ is highly recommended. ## Plugin methods -The plugin provides two methods on the `HeatmapEffect` object: +The plugin provides a `HeatmapEffect` object, which has the following methods +and properties: ### `.activate()` @@ -56,8 +57,6 @@ The plugin provides two methods on the `HeatmapEffect` object: > often. Doing it too rarely, on the other hand, make it much less useful. One > has to strike a reasonable balance. > -> Not strictly a method, it is a variable one can assign a new value to. -> > Defaults to *500*. ## Dependencies From df3e79a56a4fe86f938a541bdaa0952d45254a10 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 24 Jul 2017 14:00:50 -0700 Subject: [PATCH 25/42] keyToggledO* camelcasing --- src/Kaleidoscope/Heatmap.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/Heatmap.cpp b/src/Kaleidoscope/Heatmap.cpp index da2b798c..5dab1245 100644 --- a/src/Kaleidoscope/Heatmap.cpp +++ b/src/Kaleidoscope/Heatmap.cpp @@ -78,7 +78,7 @@ Key Heatmap::eventHook(Key mapped_key, byte row, byte col, uint8_t key_state) { return mapped_key; // if the key is not toggled on, return. - if (!key_toggled_on(key_state)) + if (!keyToggledOn(key_state)) return mapped_key; total_keys_++; From 8c35edcfb5ab7a026fddc373b1021536d26ff358 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 24 Jul 2017 14:58:59 -0700 Subject: [PATCH 26/42] 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/Heatmap.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/Heatmap.cpp b/src/Kaleidoscope/Heatmap.cpp index 5dab1245..91702bba 100644 --- a/src/Kaleidoscope/Heatmap.cpp +++ b/src/Kaleidoscope/Heatmap.cpp @@ -106,7 +106,7 @@ Heatmap::update(void) { for (uint8_t c = 0; c < COLS; c++) { uint8_t cap = max(total_keys_, 1); float v = static_cast(heatmap_[r][c]) / cap; - LEDControl.led_set_crgb_at(r, c, computeColor(v)); + LEDControl.setCrgbAt(r, c, computeColor(v)); } } } From c263665f3ec64626bc9acd4fd77470644d21bf36 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 25 Jul 2017 15:52:08 -0700 Subject: [PATCH 27/42] Update Makefile to fix OS X build --- Makefile | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index 9ce0c4a9..2b04143a 100644 --- a/Makefile +++ b/Makefile @@ -4,9 +4,10 @@ MAKEFILE_PREFIX=keyboardio/avr/libraries/Kaleidoscope-Plugin/build UNAME_S := $(shell uname -s) -BOARD_HARDWARE_PATH ?= $(HOME)/Arduino/hardware ifeq ($(UNAME_S),Darwin) -BOARD_HARDWARE_PATH ?= $(HOME)/Library/Arduino/hardware +BOARD_HARDWARE_PATH ?= $(HOME)/Documents/Arduino/hardware +else +BOARD_HARDWARE_PATH ?= $(HOME)/Arduino/hardware endif -include $(BOARD_HARDWARE_PATH)/$(MAKEFILE_PREFIX)/*.mk +include $(BOARD_HARDWARE_PATH)/$(MAKEFILE_PREFIX)/rules.mk From dc0b2a2b919aa636963aeea899d0d5b1f54a0a6d Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 17 Aug 2017 00:38:57 +0200 Subject: [PATCH 28/42] Updated to use the new LEDMode/LEDControl API Signed-off-by: Gergely Nagy --- src/Kaleidoscope/Heatmap.cpp | 9 ++++----- src/Kaleidoscope/Heatmap.h | 4 +++- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/src/Kaleidoscope/Heatmap.cpp b/src/Kaleidoscope/Heatmap.cpp index 91702bba..08fa4cfa 100644 --- a/src/Kaleidoscope/Heatmap.cpp +++ b/src/Kaleidoscope/Heatmap.cpp @@ -66,10 +66,9 @@ cRGB Heatmap::computeColor(float v) { Heatmap::Heatmap(void) { } -void Heatmap::begin(void) { - LEDControl.mode_add(this); - event_handler_hook_use(eventHook); - loop_hook_use(loopHook); +void Heatmap::setup(void) { + Kaleidoscope.useEventHandlerHook(eventHook); + Kaleidoscope.useLoopHook(loopHook); } Key Heatmap::eventHook(Key mapped_key, byte row, byte col, uint8_t key_state) { @@ -106,7 +105,7 @@ Heatmap::update(void) { for (uint8_t c = 0; c < COLS; c++) { uint8_t cap = max(total_keys_, 1); float v = static_cast(heatmap_[r][c]) / cap; - LEDControl.setCrgbAt(r, c, computeColor(v)); + ::LEDControl.setCrgbAt(r, c, computeColor(v)); } } } diff --git a/src/Kaleidoscope/Heatmap.h b/src/Kaleidoscope/Heatmap.h index 2e312ebb..76f0c3ee 100644 --- a/src/Kaleidoscope/Heatmap.h +++ b/src/Kaleidoscope/Heatmap.h @@ -28,8 +28,10 @@ class Heatmap : public LEDMode { static uint16_t update_delay; - void begin(void) final; + protected: + void setup(void) final; void update(void) final; + private: static uint8_t heatmap_[ROWS][COLS]; static uint16_t total_keys_; From a5d3a9ff374fbe43fba6f191b3ff369431aba184 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 17 Aug 2017 00:39:12 +0200 Subject: [PATCH 29/42] Updated to use Kaleidoscope.use instead of USE_PLUGINS Signed-off-by: Gergely Nagy --- README.md | 2 +- examples/Heatmap/Heatmap.ino | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index daeec258..43a45d3e 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ include the header, and make sure the plugin is in use: #include void setup() { - USE_PLUGINS(&HeatmapEffect); + Kaleidoscope.use(&HeatmapEffect); Kaleidoscope.setup (); } diff --git a/examples/Heatmap/Heatmap.ino b/examples/Heatmap/Heatmap.ino index 25b24070..882f33bf 100644 --- a/examples/Heatmap/Heatmap.ino +++ b/examples/Heatmap/Heatmap.ino @@ -40,7 +40,7 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { }; void setup() { - USE_PLUGINS(&HeatmapEffect); + Kaleidoscope.use(&HeatmapEffect); Kaleidoscope.setup(); From bb5c89c76db1953d0e0085984ef118267e7aa623 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 21 Aug 2017 22:23:30 -0700 Subject: [PATCH 30/42] Update Makefile with OSX fixes and new paths --- Makefile | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index 2b04143a..8f830f44 100644 --- a/Makefile +++ b/Makefile @@ -1,13 +1,14 @@ # This stub makefile for a Kaleidoscope plugin pulls in # all targets from the Kaleidoscope-Plugin library -MAKEFILE_PREFIX=keyboardio/avr/libraries/Kaleidoscope-Plugin/build UNAME_S := $(shell uname -s) ifeq ($(UNAME_S),Darwin) -BOARD_HARDWARE_PATH ?= $(HOME)/Documents/Arduino/hardware +SKETCHBOOK_DIR ?= $(HOME)/Documents/Arduino/ else -BOARD_HARDWARE_PATH ?= $(HOME)/Arduino/hardware +SKETCHBOOK_DIR ?= $(HOME)/Arduino endif -include $(BOARD_HARDWARE_PATH)/$(MAKEFILE_PREFIX)/rules.mk +BOARD_HARDWARE_PATH ?= $(SKETCHBOOK_DIR)/hardware +KALEIDOSCOPE_PLUGIN_MAKEFILE_DIR ?= keyboardio/avr/build-tools/makefiles/ +include $(BOARD_HARDWARE_PATH)/$(KALEIDOSCOPE_PLUGIN_MAKEFILE_DIR)/rules.mk From 35c8352ef033764867132adde378d79a07e5a4d8 Mon Sep 17 00:00:00 2001 From: Donald Curtis Date: Fri, 3 Nov 2017 00:59:32 -0500 Subject: [PATCH 31/42] Fix update check was always checking. LED update should happen when the timer is past the end_time_, not it is less than the end_time_. --- src/Kaleidoscope/Heatmap.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/Heatmap.cpp b/src/Kaleidoscope/Heatmap.cpp index 08fa4cfa..78d1a50f 100644 --- a/src/Kaleidoscope/Heatmap.cpp +++ b/src/Kaleidoscope/Heatmap.cpp @@ -96,7 +96,7 @@ Heatmap::loopHook(bool is_post_clear) { void Heatmap::update(void) { - if (end_time_ && (millis() > end_time_)) + if (end_time_ && (millis() < end_time_)) return; end_time_ = millis() + update_delay; From a6ad9ab2aa6663afff66861c429d87852f3406c3 Mon Sep 17 00:00:00 2001 From: Maxime de Roucy Date: Fri, 9 Mar 2018 01:36:22 +0100 Subject: [PATCH 32/42] major rewrite: allow the user to set his own heat_color Change the algorithm so the hotest key is always at the hotest color. Add comments. Other changes. --- README.md | 38 ++++++-- src/Kaleidoscope/Heatmap.cpp | 162 ++++++++++++++++++++++++++--------- src/Kaleidoscope/Heatmap.h | 11 ++- 3 files changed, 159 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index 43a45d3e..4598c0bc 100644 --- a/README.md +++ b/README.md @@ -26,18 +26,27 @@ include the header, and make sure the plugin is in use: #include #include +static const cRGB heat_colors[] PROGMEM = { + { 0, 0, 0}, // black + {255, 25, 25}, // blue + { 25, 255, 25}, // green + { 25, 25, 255} // red +}; + void setup() { Kaleidoscope.use(&HeatmapEffect); Kaleidoscope.setup (); + + HeatmapEffect.heat_colors = heat_colors; + HeatmapEffect.heat_colors_length = 4; } ``` -This sets up the heatmap to update every 500 cycles, which is about 2.5 seconds, -and is the default. It also registers a new LED effect, which means that if you -have not set up any other effects, then Heatmap will likely be the default. You -may not want that, so setting up at least one other LED effect, such as `LEDOff` -is highly recommended. +This sets up the heatmap to update every second (by default). It also registers +a new LED effect, which means that if you have not set up any other effects, +then Heatmap will likely be the default. You may not want that, so setting up +at least one other LED effect, such as `LEDOff` is highly recommended. ## Plugin methods @@ -57,7 +66,24 @@ and properties: > often. Doing it too rarely, on the other hand, make it much less useful. One > has to strike a reasonable balance. > -> Defaults to *500*. +> Defaults to *1000*. + +### `.heat_colors` + +> A cRGB array describing the gradian of colors that will be used, from colder +> to hoter keys. +> E.g. with `heat_colors = {{100, 0, 0}, {0, 100, 0}, {0, 0, 100}}`, a key +> with a temperature of 0.8 (0=coldest, 1=hotest), will end up with a color +> `{0, 40, 60}`. +> +> Defaults to `{{0, 0, 0}, {25, 255, 25}, {25, 255, 255}, {25, 25, 255}}` +> (black, green, yellow, red) + +### `.heat_colors_length` + +> Length of the `heat_colors` array. +> +> Defaults to *4* ## Dependencies diff --git a/src/Kaleidoscope/Heatmap.cpp b/src/Kaleidoscope/Heatmap.cpp index 78d1a50f..23727206 100644 --- a/src/Kaleidoscope/Heatmap.cpp +++ b/src/Kaleidoscope/Heatmap.cpp @@ -21,49 +21,94 @@ namespace kaleidoscope { -uint8_t Heatmap::heatmap_[ROWS][COLS]; -uint16_t Heatmap::total_keys_; -uint8_t Heatmap::highest_count_; -uint16_t Heatmap::update_delay = 500; -uint32_t Heatmap::end_time_; - -const float Heatmap::heat_colors_[][3] = {{0.0, 0.0, 0.0}, {0.1, 1, 0.1}, {1, 1, 0.1}, {1, 0.1, 0.1}}; - -void Heatmap::shiftStats(void) { - highest_count_ = total_keys_ = 0; - for (uint8_t r = 0; r < ROWS; r++) { - for (uint8_t c = 0; c < COLS; c++) { - heatmap_[r][c] = heatmap_[r][c] >> 1; - total_keys_ += heatmap_[r][c]; - if (heatmap_[r][c] > highest_count_) - highest_count_ = heatmap_[r][c]; - } - } -} +// store the number of times each key has been strock +uint16_t Heatmap::heatmap_[ROWS][COLS]; +// max of heatmap_ (we divide by it so we start at 1) +uint16_t Heatmap::highest_ = 1; +// next heatmap computation time +uint32_t Heatmap::next_heatmap_comp_time_ = 0; +// in the cRGB struct the order is blue, green, red (It should be called cBGR…) +// default heat_colors black green yellow red +static const cRGB heat_colors_default_[] PROGMEM = {{0, 0, 0}, {25, 255, 25}, {25, 255, 255}, {25, 25, 255}}; + +// colors from cold to hot +const cRGB *Heatmap::heat_colors = heat_colors_default_; +uint8_t Heatmap::heat_colors_length = 4; +// number of millisecond to wait between each heatmap computation +uint16_t Heatmap::update_delay = 1000; cRGB Heatmap::computeColor(float v) { + // compute the color corresponding to a value between 0 and 1 + + /* + * for exemple, if: + * v=0.8 + * heat_colors_lenth=4 (hcl) + * the red components of heat_colors are: 0, 25, 25, 255 (rhc) + * the red component returned by computeColor will be: 117 + * + * 255 | / + * | / + * | / + * 117 | - - - - - - -/ + * | / + * 25 | ______/ | + * | __/ + * | _/ | + * |/_________________ + * 0 1 2 ↑ 3 + * ↑ 2.4 ↑ + * idx1 | idx2 + * <—–> + * fb + * + * in this exemple, I call red heat_colors: rhc + * idx1 = floor(v×(hcl-1)) = floor(0.8×3) = floor(2.4) = 2 + * idx2 = idx1 + 1 = 3 + * fb = v×(hcl-1)-idx1 = 0.8×3 - 2 = 0.4 + * red = (rhc[idx2]-rhc[idx1])×fb + rhc[idx1] = (255-25)×(2.4-2) + 25 = 117 + */ + float fb = 0; uint8_t idx1, idx2; if (v <= 0) { + // if v = 0, don't bother computing fb and use heat_colors[0] idx1 = idx2 = 0; } else if (v >= 1) { - idx1 = idx2 = 3; + // if v = 1, + // don't bother computing fb and use heat_colors[heat_colors_length-1] + idx1 = idx2 = heat_colors_length - 1; } else { - float val = v * 3; - idx1 = static_cast(floor(val)); + float val = v * (heat_colors_length - 1); + // static_cast from float to int just drop the decimal part of the number + // static_cast(5.9) → 5 + idx1 = static_cast(val); idx2 = idx1 + 1; fb = val - static_cast(idx1); } - uint8_t r = static_cast(((heat_colors_[idx2][0] - heat_colors_[idx1][0]) * fb + heat_colors_[idx1][0]) * 255); - uint8_t g = static_cast(((heat_colors_[idx2][1] - heat_colors_[idx1][1]) * fb + heat_colors_[idx1][1]) * 255); - uint8_t b = static_cast(((heat_colors_[idx2][2] - heat_colors_[idx1][2]) * fb + heat_colors_[idx1][2]) * 255); + uint8_t r = static_cast((pgm_read_byte(&(heat_colors[idx2].r)) - pgm_read_byte(&(heat_colors[idx1].r))) * fb + pgm_read_byte(&(heat_colors[idx1].r))); + uint8_t g = static_cast((pgm_read_byte(&(heat_colors[idx2].g)) - pgm_read_byte(&(heat_colors[idx1].g))) * fb + pgm_read_byte(&(heat_colors[idx1].g))); + uint8_t b = static_cast((pgm_read_byte(&(heat_colors[idx2].b)) - pgm_read_byte(&(heat_colors[idx1].b))) * fb + pgm_read_byte(&(heat_colors[idx1].b))); return {b, g, r}; } -Heatmap::Heatmap(void) { +void Heatmap::shiftStats(void) { + // this method is called when: + // 1. a value in heatmap_ reach INT8_MAX + // 2. highest_ reach heat_colors_length*512 (see Heatmap::loopHook) + + // we divide every heatmap element by 2 + for (uint8_t r = 0; r < ROWS; r++) { + for (uint8_t c = 0; c < COLS; c++) { + heatmap_[r][c] = heatmap_[r][c] >> 1; + } + } + + // and also divide highest_ accordingly + highest_ = highest_ >> 1; } void Heatmap::setup(void) { @@ -72,44 +117,81 @@ void Heatmap::setup(void) { } Key Heatmap::eventHook(Key mapped_key, byte row, byte col, uint8_t key_state) { - // if it is a synthetic key, skip it. + // this methode is called frequently by Kaleidoscope + // even if the module isn't activated + + // if it is a synthetic key, skip it if (key_state & INJECTED) return mapped_key; - // if the key is not toggled on, return. + // if the key is not toggled on, skip it if (!keyToggledOn(key_state)) return mapped_key; - total_keys_++; + // increment the heatmap_ value related to the key heatmap_[row][col]++; - if (heatmap_[row][col] > highest_count_) - highest_count_ = heatmap_[row][col]; + + // check highest_ + if (highest_ < heatmap_[row][col]) { + highest_ = heatmap_[row][col]; + + // if highest_ (and so heatmap_ value related to the key) + // is close to overflow: call shiftStats + // NOTE: this is barely impossible since shiftStats should be + // called much sooner by Heatmap::loopHook + if (highest_ == INT16_MAX) + shiftStats(); + } return mapped_key; } -void -Heatmap::loopHook(bool is_post_clear) { - if (highest_count_ > 191 || total_keys_ > 16000) +void Heatmap::loopHook(bool is_post_clear) { + // this methode is called frequently by Kaleidoscope + // even if the module isn't activated + + // call shiftStats (divide every heatmap value by 2) + // if highest_ reach heat_colors_length*512. + // So after the shift, highest_ will be heat_colors_length*256. We + // didn't lose any precision in our heatmap since between each color we have a + // maximum precision of 256 ; said differently, there is 256 state (at max) + // between heat_colors[x] and heat_colors[x+1]. + if (highest_ > (static_cast(heat_colors_length) << 9)) shiftStats(); } -void -Heatmap::update(void) { - if (end_time_ && (millis() < end_time_)) +void Heatmap::update(void) { + // this methode is called frequently by the LEDControl::loopHook + + // do nothing if we didn't reach next_heatmap_comp_time_ yet + if (next_heatmap_comp_time_ && (millis() < next_heatmap_comp_time_)) return; + // do the heatmap computing + // (we reach next_heatmap_comp_time_ or next_heatmap_comp_time_ was never scheduled) - end_time_ = millis() + update_delay; + // schedule the next heatmap computing + next_heatmap_comp_time_ = millis() + update_delay; + // for each key for (uint8_t r = 0; r < ROWS; r++) { for (uint8_t c = 0; c < COLS; c++) { - uint8_t cap = max(total_keys_, 1); - float v = static_cast(heatmap_[r][c]) / cap; + // how much the key was pressed compared to the others (between 0 and 1) + // (total_keys_ can't be equal to 0) + float v = static_cast(heatmap_[r][c]) / highest_; + // we could have used an interger instead of a float, but then we would + // have had to change some multiplication in division. + // / on uint is slower than * on float, so I stay with the float + // https://forum.arduino.cc/index.php?topic=92684.msg2733723#msg2733723 + + // set the LED color accordingly ::LEDControl.setCrgbAt(r, c, computeColor(v)); } } } +Heatmap::Heatmap(void) { +} + } kaleidoscope::Heatmap HeatmapEffect; diff --git a/src/Kaleidoscope/Heatmap.h b/src/Kaleidoscope/Heatmap.h index 76f0c3ee..fba0a51e 100644 --- a/src/Kaleidoscope/Heatmap.h +++ b/src/Kaleidoscope/Heatmap.h @@ -27,18 +27,17 @@ class Heatmap : public LEDMode { Heatmap(void); static uint16_t update_delay; + static const cRGB *heat_colors; + static uint8_t heat_colors_length; protected: void setup(void) final; void update(void) final; private: - static uint8_t heatmap_[ROWS][COLS]; - static uint16_t total_keys_; - static uint8_t highest_count_; - static uint32_t end_time_; - - static const float heat_colors_[][3]; + static uint16_t heatmap_[ROWS][COLS]; + static uint16_t highest_; + static uint32_t next_heatmap_comp_time_; static void shiftStats(void); static cRGB computeColor(float v); From c33ec4ba7e52159fd6dd032d82400869690b35ec Mon Sep 17 00:00:00 2001 From: UniversalTimeCodeGit <39132717+UniversalTimeCodeGit@users.noreply.github.com> Date: Thu, 10 May 2018 17:16:24 -0400 Subject: [PATCH 33/42] Implement Heatmap Reset Method This commit includes the resetMap method which is used to start the heatmap from 0. I also use it as a workaround for my map starting up with an "infinitely hot" key --- src/Kaleidoscope/Heatmap.cpp | 12 ++++++++++++ src/Kaleidoscope/Heatmap.h | 1 + 2 files changed, 13 insertions(+) diff --git a/src/Kaleidoscope/Heatmap.cpp b/src/Kaleidoscope/Heatmap.cpp index 23727206..eed703ba 100644 --- a/src/Kaleidoscope/Heatmap.cpp +++ b/src/Kaleidoscope/Heatmap.cpp @@ -111,6 +111,18 @@ void Heatmap::shiftStats(void) { highest_ = highest_ >> 1; } +void Heatmap::resetMap(void) { + // this method can be used as a way to work around an existing bug with a single key + // getting special attention or if the user just wants a button to reset the map + for (uint8_t r = 0; r < ROWS; r++) { + for (uint8_t c = 0; c < COLS; c++) { + heatmap_[r][c] = 0; + } + } + + highest_ = 1; +} + void Heatmap::setup(void) { Kaleidoscope.useEventHandlerHook(eventHook); Kaleidoscope.useLoopHook(loopHook); diff --git a/src/Kaleidoscope/Heatmap.h b/src/Kaleidoscope/Heatmap.h index fba0a51e..7d7b6639 100644 --- a/src/Kaleidoscope/Heatmap.h +++ b/src/Kaleidoscope/Heatmap.h @@ -29,6 +29,7 @@ class Heatmap : public LEDMode { static uint16_t update_delay; static const cRGB *heat_colors; static uint8_t heat_colors_length; + void resetMap(void); protected: void setup(void) final; From 56f85a76070223e6c28ac0d27732c23c31a02e23 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 11 May 2018 14:09:35 +0200 Subject: [PATCH 34/42] Make astyle happy Signed-off-by: Gergely Nagy --- src/Kaleidoscope/Heatmap.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/Heatmap.cpp b/src/Kaleidoscope/Heatmap.cpp index eed703ba..8264b7ac 100644 --- a/src/Kaleidoscope/Heatmap.cpp +++ b/src/Kaleidoscope/Heatmap.cpp @@ -112,7 +112,7 @@ void Heatmap::shiftStats(void) { } void Heatmap::resetMap(void) { - // this method can be used as a way to work around an existing bug with a single key + // this method can be used as a way to work around an existing bug with a single key // getting special attention or if the user just wants a button to reset the map for (uint8_t r = 0; r < ROWS; r++) { for (uint8_t c = 0; c < COLS; c++) { From bfe38620bd98144482c9ddd49169349ca85e1914 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 12 May 2018 18:00:45 +0200 Subject: [PATCH 35/42] Updated to use the new plugin APIs Signed-off-by: Gergely Nagy --- README.md | 3 +++ examples/Heatmap/Heatmap.ino | 13 +++++++----- src/Kaleidoscope/Heatmap.cpp | 38 +++++++++++++++++++++++++----------- src/Kaleidoscope/Heatmap.h | 17 ++++++++++------ 4 files changed, 49 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 4598c0bc..9d216d30 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,7 @@ include the header, and make sure the plugin is in use: ```c++ #include +#include #include static const cRGB heat_colors[] PROGMEM = { @@ -33,6 +34,8 @@ static const cRGB heat_colors[] PROGMEM = { { 25, 25, 255} // red }; +KALEIDOSCOPE_INIT_PLUGINS(LEDControl, HeatmapEffect); + void setup() { Kaleidoscope.use(&HeatmapEffect); diff --git a/examples/Heatmap/Heatmap.ino b/examples/Heatmap/Heatmap.ino index 882f33bf..8be87587 100644 --- a/examples/Heatmap/Heatmap.ino +++ b/examples/Heatmap/Heatmap.ino @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Heatmap -- Heatmap LED effect for Kaleidoscope. - * Copyright (C) 2016, 2017 Gergely Nagy + * Copyright (C) 2016, 2017, 2018 Gergely Nagy * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -17,9 +17,10 @@ */ #include +#include #include - +// *INDENT-OFF* const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED (Key_LEDEffectNext, Key_1, Key_2, Key_3, Key_4, Key_5, Key_LEDEffectNext, @@ -32,16 +33,18 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, - Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, Key_NoKey), }; +// *INDENT-ON* -void setup() { - Kaleidoscope.use(&HeatmapEffect); +KALEIDOSCOPE_INIT_PLUGINS(LEDControl, + HeatmapEffect); +void setup() { Kaleidoscope.setup(); HeatmapEffect.activate(); diff --git a/src/Kaleidoscope/Heatmap.cpp b/src/Kaleidoscope/Heatmap.cpp index 8264b7ac..c96b1d2c 100644 --- a/src/Kaleidoscope/Heatmap.cpp +++ b/src/Kaleidoscope/Heatmap.cpp @@ -123,22 +123,17 @@ void Heatmap::resetMap(void) { highest_ = 1; } -void Heatmap::setup(void) { - Kaleidoscope.useEventHandlerHook(eventHook); - Kaleidoscope.useLoopHook(loopHook); -} - -Key Heatmap::eventHook(Key mapped_key, byte row, byte col, uint8_t key_state) { +EventHandlerResult Heatmap::onKeyswitchEvent(Key &mapped_key, byte row, byte col, uint8_t key_state) { // this methode is called frequently by Kaleidoscope // even if the module isn't activated // if it is a synthetic key, skip it if (key_state & INJECTED) - return mapped_key; + return EventHandlerResult::OK; // if the key is not toggled on, skip it if (!keyToggledOn(key_state)) - return mapped_key; + return EventHandlerResult::OK; // increment the heatmap_ value related to the key heatmap_[row][col]++; @@ -155,10 +150,10 @@ Key Heatmap::eventHook(Key mapped_key, byte row, byte col, uint8_t key_state) { shiftStats(); } - return mapped_key; + return EventHandlerResult::OK; } -void Heatmap::loopHook(bool is_post_clear) { +EventHandlerResult Heatmap::beforeEachCycle() { // this methode is called frequently by Kaleidoscope // even if the module isn't activated @@ -170,6 +165,8 @@ void Heatmap::loopHook(bool is_post_clear) { // between heat_colors[x] and heat_colors[x+1]. if (highest_ > (static_cast(heat_colors_length) << 9)) shiftStats(); + + return EventHandlerResult::OK; } void Heatmap::update(void) { @@ -201,8 +198,27 @@ void Heatmap::update(void) { } } -Heatmap::Heatmap(void) { +// Legacy V1 API +#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API +void Heatmap::begin() { + Kaleidoscope.useEventHandlerHook(legacyEventHandler); + Kaleidoscope.useLoopHook(legacyLoopHook); +} + +Key Heatmap::legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state) { + EventHandlerResult r = ::HeatmapEffect.onKeyswitchEvent(mapped_key, row, col, key_state); + if (r == EventHandlerResult::OK) + return mapped_key; + return Key_NoKey; +} + +void Heatmap::legacyLoopHook(bool is_post_clear) { + if (is_post_clear) + return; + + ::HeatmapEffect.beforeEachCycle(); } +#endif } diff --git a/src/Kaleidoscope/Heatmap.h b/src/Kaleidoscope/Heatmap.h index 7d7b6639..a7912f54 100644 --- a/src/Kaleidoscope/Heatmap.h +++ b/src/Kaleidoscope/Heatmap.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Heatmap -- Heatmap LED effect for Kaleidoscope. - * Copyright (C) 2016, 2017 Gergely Nagy + * Copyright (C) 2016, 2017, 2018 Gergely Nagy * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -24,17 +24,25 @@ namespace kaleidoscope { class Heatmap : public LEDMode { public: - Heatmap(void); + Heatmap(void) {} static uint16_t update_delay; static const cRGB *heat_colors; static uint8_t heat_colors_length; void resetMap(void); + EventHandlerResult onKeyswitchEvent(Key &mapped_key, byte row, byte col, uint8_t key_state); + EventHandlerResult beforeEachCycle(); + protected: - void setup(void) final; void update(void) final; +#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API + void begin(); + static Key legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state); + static void legacyLoopHook(bool is_post_clear); +#endif + private: static uint16_t heatmap_[ROWS][COLS]; static uint16_t highest_; @@ -42,9 +50,6 @@ class Heatmap : public LEDMode { static void shiftStats(void); static cRGB computeColor(float v); - - static Key eventHook(Key mapped_key, byte row, byte col, uint8_t key_state); - static void loopHook(bool is_post_clear); }; } From cc32e8e735910e0669ad5c9580fb7ae47e8f0992 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 20 Aug 2018 23:02:13 +0200 Subject: [PATCH 36/42] Drop the V1 plugin API compatibility code Signed-off-by: Gergely Nagy --- src/Kaleidoscope/Heatmap.cpp | 22 ---------------------- src/Kaleidoscope/Heatmap.h | 6 ------ 2 files changed, 28 deletions(-) diff --git a/src/Kaleidoscope/Heatmap.cpp b/src/Kaleidoscope/Heatmap.cpp index c96b1d2c..b4d7bcd8 100644 --- a/src/Kaleidoscope/Heatmap.cpp +++ b/src/Kaleidoscope/Heatmap.cpp @@ -198,28 +198,6 @@ void Heatmap::update(void) { } } -// Legacy V1 API -#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API -void Heatmap::begin() { - Kaleidoscope.useEventHandlerHook(legacyEventHandler); - Kaleidoscope.useLoopHook(legacyLoopHook); -} - -Key Heatmap::legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state) { - EventHandlerResult r = ::HeatmapEffect.onKeyswitchEvent(mapped_key, row, col, key_state); - if (r == EventHandlerResult::OK) - return mapped_key; - return Key_NoKey; -} - -void Heatmap::legacyLoopHook(bool is_post_clear) { - if (is_post_clear) - return; - - ::HeatmapEffect.beforeEachCycle(); -} -#endif - } kaleidoscope::Heatmap HeatmapEffect; diff --git a/src/Kaleidoscope/Heatmap.h b/src/Kaleidoscope/Heatmap.h index a7912f54..765c59a6 100644 --- a/src/Kaleidoscope/Heatmap.h +++ b/src/Kaleidoscope/Heatmap.h @@ -37,12 +37,6 @@ class Heatmap : public LEDMode { protected: void update(void) final; -#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API - void begin(); - static Key legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state); - static void legacyLoopHook(bool is_post_clear); -#endif - private: static uint16_t heatmap_[ROWS][COLS]; static uint16_t highest_; From 1c847ac3f5f25568b75c00b34c2fc96b89669d7c Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 4 Sep 2018 18:24:01 -0700 Subject: [PATCH 37/42] Update travis.yml to point to new bundle repo --- .travis.yml | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/.travis.yml b/.travis.yml index e7030acf..e3e64f77 100644 --- a/.travis.yml +++ b/.travis.yml @@ -2,10 +2,15 @@ dist: trusty sudo: false os: - linux +addons: + apt: + packages: + - shellcheck install: - - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Arduino-Boards hardware/keyboardio/avr + - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Kaleidoscope-Bundle-Keyboardio hardware/keyboardio script: - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware + - shellcheck bin/kaleidoscope-builder notifications: irc: channels: @@ -13,7 +18,7 @@ notifications: use_notice: true skip_join: true template: - - "%{repository_name}/%{branch} %{commit} by %{author}: %{commit_subject} %{build_url} %{message}" + - "%{repository_name}/%{branch} %{commit} by %{author}: %{commit_subject} %{build_url} %{message}" email: on_success: change on_failure: change From ed38757c9c613dd243869ad6e24d84b37ca810d5 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 4 Sep 2018 18:42:29 -0700 Subject: [PATCH 38/42] shellcheck should only be run in the Kaleidoscope repo --- .travis.yml | 5 ----- 1 file changed, 5 deletions(-) diff --git a/.travis.yml b/.travis.yml index e3e64f77..23d30ccc 100644 --- a/.travis.yml +++ b/.travis.yml @@ -2,15 +2,10 @@ dist: trusty sudo: false os: - linux -addons: - apt: - packages: - - shellcheck install: - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Kaleidoscope-Bundle-Keyboardio hardware/keyboardio script: - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware - - shellcheck bin/kaleidoscope-builder notifications: irc: channels: From 000abdd35364a688228dfcc36643a1fb834b1b14 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 10 Oct 2018 06:29:49 +0200 Subject: [PATCH 39/42] README.md & Travis cleanup Remove the IRC notifications from Travis (we're not using IRC anymore), and the stable/experimental badge from README.md (because they aren't being kept up to date). Also removed an obsolete `Kaleidoscope.use()` call from the README's example. Signed-off-by: Gergely Nagy --- .travis.yml | 7 ------- README.md | 8 +------- 2 files changed, 1 insertion(+), 14 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 9d216d30..ae85a673 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,10 @@ # Kaleidoscope-Heatmap -![status][st:experimental] [![Build Status][travis:image]][travis:status] +[![Build Status][travis:image]][travis:status] [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-Heatmap.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-Heatmap - [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 - The `Heatmap` plugin provides a LED effect, that displays a heatmap on the keyboard. The LEDs under each key will have a color according to how much use they see. Fewer used keys will have deep blue colors, that gradually turns @@ -37,8 +33,6 @@ static const cRGB heat_colors[] PROGMEM = { KALEIDOSCOPE_INIT_PLUGINS(LEDControl, HeatmapEffect); void setup() { - Kaleidoscope.use(&HeatmapEffect); - Kaleidoscope.setup (); HeatmapEffect.heat_colors = heat_colors; From 03cdca3a171087865147370c6a3196c12a524a07 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 13 Oct 2018 12:35:29 +0200 Subject: [PATCH 40/42] Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/Heatmap.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 | 88 +----------------- doc/plugin/Heatmap.md | 89 +++++++++++++++++++ src/Kaleidoscope-Heatmap.h | 2 +- .../plugin}/Heatmap.cpp | 4 +- .../plugin}/Heatmap.h | 4 +- 5 files changed, 97 insertions(+), 90 deletions(-) create mode 100644 doc/plugin/Heatmap.md rename src/{Kaleidoscope => kaleidoscope/plugin}/Heatmap.cpp (99%) rename src/{Kaleidoscope => kaleidoscope/plugin}/Heatmap.h (95%) diff --git a/README.md b/README.md index ae85a673..fb5ba4c6 100644 --- a/README.md +++ b/README.md @@ -5,90 +5,4 @@ [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-Heatmap.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-Heatmap -The `Heatmap` plugin provides a LED effect, that displays a heatmap on the -keyboard. The LEDs under each key will have a color according to how much use -they see. Fewer used keys will have deep blue colors, that gradually turns -lighter, then green, to yellow, and finally red for the most used keys. The -heatmap is not updated on every key press, but periodically. It's precision is -also an approximation, and not a hundred percent exact. Nevertheless, it is a -reasonable estimate. - -## Using the plugin - -The plugin comes with reasonable defaults pre-configured, all one needs to do is -include the header, and make sure the plugin is in use: - -```c++ -#include -#include -#include - -static const cRGB heat_colors[] PROGMEM = { - { 0, 0, 0}, // black - {255, 25, 25}, // blue - { 25, 255, 25}, // green - { 25, 25, 255} // red -}; - -KALEIDOSCOPE_INIT_PLUGINS(LEDControl, HeatmapEffect); - -void setup() { - Kaleidoscope.setup (); - - HeatmapEffect.heat_colors = heat_colors; - HeatmapEffect.heat_colors_length = 4; -} -``` - -This sets up the heatmap to update every second (by default). It also registers -a new LED effect, which means that if you have not set up any other effects, -then Heatmap will likely be the default. You may not want that, so setting up -at least one other LED effect, such as `LEDOff` is highly recommended. - -## Plugin methods - -The plugin provides a `HeatmapEffect` object, which has the following methods -and properties: - -### `.activate()` - -> When called, immediately activates the Heatmap effect. Mostly useful in the -> `setup()` method of the Sketch, or in macros that are meant to switch to the -> heatmap effect, no matter where we are in the list. - -### `.update_delay` - -> The number of milliseconds to wait between updating the heatmap. Updating the -> heatmap incurs a significant performance penalty, and should not be done too -> often. Doing it too rarely, on the other hand, make it much less useful. One -> has to strike a reasonable balance. -> -> Defaults to *1000*. - -### `.heat_colors` - -> A cRGB array describing the gradian of colors that will be used, from colder -> to hoter keys. -> E.g. with `heat_colors = {{100, 0, 0}, {0, 100, 0}, {0, 0, 100}}`, a key -> with a temperature of 0.8 (0=coldest, 1=hotest), will end up with a color -> `{0, 40, 60}`. -> -> Defaults to `{{0, 0, 0}, {25, 255, 25}, {25, 255, 255}, {25, 25, 255}}` -> (black, green, yellow, red) - -### `.heat_colors_length` - -> Length of the `heat_colors` array. -> -> Defaults to *4* - -## Dependencies - -* [Kaleidoscope-LEDControl](https://github.com/keyboardio/Kaleidoscope-LEDControl) - -## 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-Heatmap/blob/master/examples/Heatmap/Heatmap.ino +See [doc/plugin/Heatmap.md](doc/plugin/Heatmap.md) for documentation. diff --git a/doc/plugin/Heatmap.md b/doc/plugin/Heatmap.md new file mode 100644 index 00000000..e9d77cf4 --- /dev/null +++ b/doc/plugin/Heatmap.md @@ -0,0 +1,89 @@ +# Kaleidoscope-Heatmap + +The `Heatmap` plugin provides a LED effect, that displays a heatmap on the +keyboard. The LEDs under each key will have a color according to how much use +they see. Fewer used keys will have deep blue colors, that gradually turns +lighter, then green, to yellow, and finally red for the most used keys. The +heatmap is not updated on every key press, but periodically. It's precision is +also an approximation, and not a hundred percent exact. Nevertheless, it is a +reasonable estimate. + +## Using the plugin + +The plugin comes with reasonable defaults pre-configured, all one needs to do is +include the header, and make sure the plugin is in use: + +```c++ +#include +#include +#include + +static const cRGB heat_colors[] PROGMEM = { + { 0, 0, 0}, // black + {255, 25, 25}, // blue + { 25, 255, 25}, // green + { 25, 25, 255} // red +}; + +KALEIDOSCOPE_INIT_PLUGINS(LEDControl, HeatmapEffect); + +void setup() { + Kaleidoscope.setup (); + + HeatmapEffect.heat_colors = heat_colors; + HeatmapEffect.heat_colors_length = 4; +} +``` + +This sets up the heatmap to update every second (by default). It also registers +a new LED effect, which means that if you have not set up any other effects, +then Heatmap will likely be the default. You may not want that, so setting up +at least one other LED effect, such as `LEDOff` is highly recommended. + +## Plugin methods + +The plugin provides a `HeatmapEffect` object, which has the following methods +and properties: + +### `.activate()` + +> When called, immediately activates the Heatmap effect. Mostly useful in the +> `setup()` method of the Sketch, or in macros that are meant to switch to the +> heatmap effect, no matter where we are in the list. + +### `.update_delay` + +> The number of milliseconds to wait between updating the heatmap. Updating the +> heatmap incurs a significant performance penalty, and should not be done too +> often. Doing it too rarely, on the other hand, make it much less useful. One +> has to strike a reasonable balance. +> +> Defaults to *1000*. + +### `.heat_colors` + +> A cRGB array describing the gradian of colors that will be used, from colder +> to hoter keys. +> E.g. with `heat_colors = {{100, 0, 0}, {0, 100, 0}, {0, 0, 100}}`, a key +> with a temperature of 0.8 (0=coldest, 1=hotest), will end up with a color +> `{0, 40, 60}`. +> +> Defaults to `{{0, 0, 0}, {25, 255, 25}, {25, 255, 255}, {25, 25, 255}}` +> (black, green, yellow, red) + +### `.heat_colors_length` + +> Length of the `heat_colors` array. +> +> Defaults to *4* + +## Dependencies + +* [Kaleidoscope-LEDControl](https://github.com/keyboardio/Kaleidoscope-LEDControl) + +## 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-Heatmap/blob/master/examples/Heatmap/Heatmap.ino diff --git a/src/Kaleidoscope-Heatmap.h b/src/Kaleidoscope-Heatmap.h index e4874414..7510be4b 100644 --- a/src/Kaleidoscope-Heatmap.h +++ b/src/Kaleidoscope-Heatmap.h @@ -18,4 +18,4 @@ #pragma once -#include +#include diff --git a/src/Kaleidoscope/Heatmap.cpp b/src/kaleidoscope/plugin/Heatmap.cpp similarity index 99% rename from src/Kaleidoscope/Heatmap.cpp rename to src/kaleidoscope/plugin/Heatmap.cpp index b4d7bcd8..215e16ec 100644 --- a/src/Kaleidoscope/Heatmap.cpp +++ b/src/kaleidoscope/plugin/Heatmap.cpp @@ -20,6 +20,7 @@ #include namespace kaleidoscope { +namespace plugin { // store the number of times each key has been strock uint16_t Heatmap::heatmap_[ROWS][COLS]; @@ -198,6 +199,7 @@ void Heatmap::update(void) { } } +} } -kaleidoscope::Heatmap HeatmapEffect; +kaleidoscope::plugin::Heatmap HeatmapEffect; diff --git a/src/Kaleidoscope/Heatmap.h b/src/kaleidoscope/plugin/Heatmap.h similarity index 95% rename from src/Kaleidoscope/Heatmap.h rename to src/kaleidoscope/plugin/Heatmap.h index 765c59a6..d7ff4dda 100644 --- a/src/Kaleidoscope/Heatmap.h +++ b/src/kaleidoscope/plugin/Heatmap.h @@ -22,6 +22,7 @@ #include namespace kaleidoscope { +namespace plugin { class Heatmap : public LEDMode { public: Heatmap(void) {} @@ -46,5 +47,6 @@ class Heatmap : public LEDMode { static cRGB computeColor(float v); }; } +} -extern kaleidoscope::Heatmap HeatmapEffect; +extern kaleidoscope::plugin::Heatmap HeatmapEffect; From dd37c5e4c85b651e35a91e39be97ac8580918bd8 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 13 Oct 2018 12:35:32 +0200 Subject: [PATCH 41/42] Remove files we do not need in the monorepo Signed-off-by: Gergely Nagy --- .gitignore | 4 - .travis.yml | 14 - COPYING | 674 --------------------------------------------- Makefile | 14 - README.md | 8 - library.properties | 10 - 6 files changed, 724 deletions(-) delete mode 100644 .gitignore delete mode 100644 .travis.yml 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/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 fb5ba4c6..00000000 --- a/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# Kaleidoscope-Heatmap - -[![Build Status][travis:image]][travis:status] - - [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-Heatmap.svg?branch=master - [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-Heatmap - -See [doc/plugin/Heatmap.md](doc/plugin/Heatmap.md) for documentation. diff --git a/library.properties b/library.properties deleted file mode 100644 index 81cf365e..00000000 --- a/library.properties +++ /dev/null @@ -1,10 +0,0 @@ -name=Kaleidoscope-Heatmap -version=0.0.0 -author=Gergely Nagy -maintainer=Gergely Nagy -sentence=Heatmap LED effect for Kaleidoscope. -paragraph=Displays a heatmap via the LEDs under each key. -category=Communication -url=https://github.com/keyboardio/Kaleidoscope-Heatmap -architectures=avr -dot_a_linkage=true From 1fcd37520e0fc87864232cc62b170be9808c4332 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 18 Oct 2018 00:00:32 +0200 Subject: [PATCH 42/42] Update the documentation links Updates the example and dependency links in the documentation, to use URLs that are valid within the monorepo. Signed-off-by: Gergely Nagy --- doc/plugin/Heatmap.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/plugin/Heatmap.md b/doc/plugin/Heatmap.md index e9d77cf4..2e3d0402 100644 --- a/doc/plugin/Heatmap.md +++ b/doc/plugin/Heatmap.md @@ -79,11 +79,11 @@ and properties: ## Dependencies -* [Kaleidoscope-LEDControl](https://github.com/keyboardio/Kaleidoscope-LEDControl) +* [Kaleidoscope-LEDControl](LEDControl.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-Heatmap/blob/master/examples/Heatmap/Heatmap.ino + [plugin:example]: ../../examples/Heatmap/Heatmap.ino