From 24d06c7168fa15cfe591ec4252a620824132f8c3 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 9 Dec 2017 11:03:40 +0100 Subject: [PATCH 01/21] Initial import Fixes keyboardio/Kaleidoscope#217. Signed-off-by: Gergely Nagy --- .gitignore | 4 + .travis.yml | 21 + COPYING | 674 +++++++++++++++++++++++++++ Makefile | 14 + README.md | 68 +++ examples/MyOldFriend/MyOldFriend.ino | 52 +++ library.properties | 10 + src/Kaleidoscope-MyOldFriend.h | 21 + src/Kaleidoscope/MyOldFriend.cpp | 84 ++++ src/Kaleidoscope/MyOldFriend.h | 48 ++ 10 files changed, 996 insertions(+) create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 COPYING create mode 100644 Makefile create mode 100644 README.md create mode 100644 examples/MyOldFriend/MyOldFriend.ino create mode 100644 library.properties create mode 100644 src/Kaleidoscope-MyOldFriend.h create mode 100644 src/Kaleidoscope/MyOldFriend.cpp create mode 100644 src/Kaleidoscope/MyOldFriend.h diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..be16c9be --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +.#* +*~ +/hardware/ +/output/ \ No newline at end of file diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 00000000..e7030acf --- /dev/null +++ b/.travis.yml @@ -0,0 +1,21 @@ +dist: trusty +sudo: false +os: + - linux +install: + - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Arduino-Boards hardware/keyboardio/avr +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 +cache: + ccache: true 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/Makefile b/Makefile new file mode 100644 index 00000000..3e1f64d2 --- /dev/null +++ b/Makefile @@ -0,0 +1,14 @@ +# 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 new file mode 100644 index 00000000..10a86b40 --- /dev/null +++ b/README.md @@ -0,0 +1,68 @@ +# Kaleidoscope-MyOldFriend + +![status][st:experimental] [![Build Status][travis:image]][travis:status] + + [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-MyOldFriend.svg?branch=master + [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-MyOldFriend + + [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 + +> Hello darkness, my old friend +> I've come to talk with you again + +Support performing custom actions whenever the host suspends, resumes, or is +sleeping. By default, the LEDs will be turned off on suspend, and the previous +LED mode restored on resume. + +## Using the plugin + +To use the plugin, one needs to include the header, and activate it. No further +configuration is necessary, unless one wants to perform custom actions. + +```c++ +#include +#include + +void setup () { + Kaleidoscope.setup (); + + Kaleidoscope.use(&MyOldFriend); +} +``` + +## Plugin methods + +The plugin provides the `MyOldFriend` object, which has the following methods: + +### `.toggleLEDs(event)` + +> Turns LEDs off on suspend, restores the previous LED mode on resume. This is +> called by `myOldFriendEventHandler()` by default. + +## Overrideable methods + +### `myOldFriendEventHandler(event)` + +> The `myOldFriendEventHandler` method is the brain of the plugin: this function +> tells it what action to perform in response to the various events. +> +> Currently supported events are: `kaleidoscope::MyOldFriend::Suspend` is fired +> once when the host suspends; `kaleidoscope::MyOldFriend::Sleep` is fired every +> cycle while the host is suspended; `kaleidoscope::MyOldFriend::Resume` is +> fired once when the host wakes up. +> +> The default implementation calls `MyOldFriend.toggleLEDs`. When overriding the +> function, the default is lost. + +## 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-MyOldFriend/blob/master/examples/MyOldFriend/MyOldFriend.ino diff --git a/examples/MyOldFriend/MyOldFriend.ino b/examples/MyOldFriend/MyOldFriend.ino new file mode 100644 index 00000000..30c2937a --- /dev/null +++ b/examples/MyOldFriend/MyOldFriend.ino @@ -0,0 +1,52 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-MyOldFriend -- Host sleep support plugin. + * Copyright (C) 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 +#include + +const Key keymaps[][ROWS][COLS] PROGMEM = { + [0] = KEYMAP_STACKED + ( + Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, + Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, + Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, + Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, + + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, + Key_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(); + + Kaleidoscope.use(&MyOldFriend); +} + +void loop() { + Kaleidoscope.loop(); +} diff --git a/library.properties b/library.properties new file mode 100644 index 00000000..41953ba1 --- /dev/null +++ b/library.properties @@ -0,0 +1,10 @@ +name=Kaleidoscope-MyOldFriend +version=0.0.0 +author=Gergely Nagy +maintainer=Gergely Nagy +sentence=Host sleep support library for Kaleidoscope. +paragraph=Turn LEDs off during host sleep, or do any other custom action. +category=Communication +url=https://github.com/keyboardio/Kaleidoscope-MyOldFriend +architectures=avr +dot_a_linkage=true diff --git a/src/Kaleidoscope-MyOldFriend.h b/src/Kaleidoscope-MyOldFriend.h new file mode 100644 index 00000000..e179d1d4 --- /dev/null +++ b/src/Kaleidoscope-MyOldFriend.h @@ -0,0 +1,21 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-MyOldFriend -- Host sleep support plugin. + * Copyright (C) 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/Kaleidoscope/MyOldFriend.cpp b/src/Kaleidoscope/MyOldFriend.cpp new file mode 100644 index 00000000..589fef4e --- /dev/null +++ b/src/Kaleidoscope/MyOldFriend.cpp @@ -0,0 +1,84 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-MyOldFriend -- Host sleep support plugin. + * Copyright (C) 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 +#include +#include +#include "LED-Off.h" + +// This is a terrible hack until Arduino#6964 gets implemented. +// It makes the `_usbSuspendState` symbol available to us. +extern u8 _usbSuspendState; + +namespace kaleidoscope { + +bool MyOldFriend::wasSuspended = false; +bool MyOldFriend::initialSuspend = true; + +void MyOldFriend::begin(void) { + Kaleidoscope.useLoopHook(loopHook); + Kaleidoscope.use(&::LEDOff); +} + +void MyOldFriend::toggleLEDs(MyOldFriend::Event event) { + static uint8_t prev_led_mode = 0; + + switch (event) { + case Suspend: + prev_led_mode = ::LEDControl.get_mode_index(); + ::LEDOff.activate(); + break; + case Resume: + ::LEDControl.set_mode(prev_led_mode); + ::LEDControl.refreshAll(); + break; + case Sleep: + break; + } +} + +void MyOldFriend::loopHook(bool post_clear) { + if (post_clear) + return; + + if ((_usbSuspendState & (1 << SUSPI))) { + if (!initialSuspend) { + if (!wasSuspended) { + wasSuspended = true; + myOldFriendEventHandler(Suspend); + } else { + myOldFriendEventHandler(Sleep); + } + } + } else { + if (initialSuspend) + initialSuspend = false; + if (wasSuspended) { + wasSuspended = false; + myOldFriendEventHandler(Resume); + } + } +} + +} + +__attribute__((weak)) void myOldFriendEventHandler(kaleidoscope::MyOldFriend::Event event) { + MyOldFriend.toggleLEDs(event); +} + +kaleidoscope::MyOldFriend MyOldFriend; diff --git a/src/Kaleidoscope/MyOldFriend.h b/src/Kaleidoscope/MyOldFriend.h new file mode 100644 index 00000000..cc4928a5 --- /dev/null +++ b/src/Kaleidoscope/MyOldFriend.h @@ -0,0 +1,48 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-MyOldFriend -- Host sleep support plugin. + * Copyright (C) 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 kaleidoscope { +class MyOldFriend : public KaleidoscopePlugin { + public: + typedef enum { + Suspend, + Sleep, + Resume, + } Event; + + MyOldFriend(void) {}; + + void begin(void) final; + + void toggleLEDs(Event event); + + private: + static bool wasSuspended; + static bool initialSuspend; + + static void loopHook(bool post_clear); +}; +} + +void myOldFriendEventHandler(kaleidoscope::MyOldFriend::Event event); + +extern kaleidoscope::MyOldFriend MyOldFriend; From 9a32ae987941c1f3e5cb4789db1319f8127b84b4 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 9 Dec 2017 11:15:04 +0100 Subject: [PATCH 02/21] Renamed a few private members to follow the style guide Signed-off-by: Gergely Nagy --- src/Kaleidoscope/MyOldFriend.cpp | 18 +++++++++--------- src/Kaleidoscope/MyOldFriend.h | 4 ++-- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/src/Kaleidoscope/MyOldFriend.cpp b/src/Kaleidoscope/MyOldFriend.cpp index 589fef4e..1cf422b7 100644 --- a/src/Kaleidoscope/MyOldFriend.cpp +++ b/src/Kaleidoscope/MyOldFriend.cpp @@ -27,8 +27,8 @@ extern u8 _usbSuspendState; namespace kaleidoscope { -bool MyOldFriend::wasSuspended = false; -bool MyOldFriend::initialSuspend = true; +bool MyOldFriend::was_suspended_ = false; +bool MyOldFriend::initial_suspend_ = true; void MyOldFriend::begin(void) { Kaleidoscope.useLoopHook(loopHook); @@ -57,19 +57,19 @@ void MyOldFriend::loopHook(bool post_clear) { return; if ((_usbSuspendState & (1 << SUSPI))) { - if (!initialSuspend) { - if (!wasSuspended) { - wasSuspended = true; + if (!initial_suspend_) { + if (!was_suspended_) { + was_suspended_ = true; myOldFriendEventHandler(Suspend); } else { myOldFriendEventHandler(Sleep); } } } else { - if (initialSuspend) - initialSuspend = false; - if (wasSuspended) { - wasSuspended = false; + if (initial_suspend_) + initial_suspend_ = false; + if (was_suspended_) { + was_suspended_ = false; myOldFriendEventHandler(Resume); } } diff --git a/src/Kaleidoscope/MyOldFriend.h b/src/Kaleidoscope/MyOldFriend.h index cc4928a5..e49a7aaf 100644 --- a/src/Kaleidoscope/MyOldFriend.h +++ b/src/Kaleidoscope/MyOldFriend.h @@ -36,8 +36,8 @@ class MyOldFriend : public KaleidoscopePlugin { void toggleLEDs(Event event); private: - static bool wasSuspended; - static bool initialSuspend; + static bool was_suspended_; + static bool initial_suspend_; static void loopHook(bool post_clear); }; From 1ab0ae3347f366f912166a9bb0d0484e774a9448 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 9 Dec 2017 11:15:32 +0100 Subject: [PATCH 03/21] make astlye Signed-off-by: Gergely Nagy --- src/Kaleidoscope/MyOldFriend.cpp | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/src/Kaleidoscope/MyOldFriend.cpp b/src/Kaleidoscope/MyOldFriend.cpp index 1cf422b7..ae4d8edd 100644 --- a/src/Kaleidoscope/MyOldFriend.cpp +++ b/src/Kaleidoscope/MyOldFriend.cpp @@ -39,16 +39,16 @@ void MyOldFriend::toggleLEDs(MyOldFriend::Event event) { static uint8_t prev_led_mode = 0; switch (event) { - case Suspend: - prev_led_mode = ::LEDControl.get_mode_index(); - ::LEDOff.activate(); - break; - case Resume: - ::LEDControl.set_mode(prev_led_mode); - ::LEDControl.refreshAll(); - break; - case Sleep: - break; + case Suspend: + prev_led_mode = ::LEDControl.get_mode_index(); + ::LEDOff.activate(); + break; + case Resume: + ::LEDControl.set_mode(prev_led_mode); + ::LEDControl.refreshAll(); + break; + case Sleep: + break; } } From 539aa85d6a88a4b913dbea2e694fa1faa110ea5c Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 10 Dec 2017 00:39:57 +0100 Subject: [PATCH 04/21] Add a special `WakeupKeyboard`, to be able to wake the host up At least on Linux, for a device to be considered capable of waking the host up, it must be a boot keyboard. As we do not (yet) support a boot keyboard, we fake one. An USB node that does nothing else than report itself as a boot keyboard, and does the minimum amount of work to get recognised as such. Because of this, Linux - and hopefully the other OSes too - will consider the whole device capable of waking up the host. This addresses keyboardio/Kaleidoscope#237, if all goes well. Signed-off-by: Gergely Nagy --- README.md | 7 +++ examples/MyOldFriend/MyOldFriend.ino | 2 + src/Kaleidoscope/MyOldFriend.h | 2 + src/Kaleidoscope/WakeupKeyboard.cpp | 91 ++++++++++++++++++++++++++++ src/Kaleidoscope/WakeupKeyboard.h | 38 ++++++++++++ 5 files changed, 140 insertions(+) create mode 100644 src/Kaleidoscope/WakeupKeyboard.cpp create mode 100644 src/Kaleidoscope/WakeupKeyboard.h diff --git a/README.md b/README.md index 10a86b40..21bebdf6 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,13 @@ void setup () { The plugin provides the `MyOldFriend` object, which has the following methods: +### `.enableWakeup()` + +> Enables host wakeup support. When enabled, pressing any key on the keyboard +> will wake the host up. +> +> Once enabled, it **cannot** be disabled again. + ### `.toggleLEDs(event)` > Turns LEDs off on suspend, restores the previous LED mode on resume. This is diff --git a/examples/MyOldFriend/MyOldFriend.ino b/examples/MyOldFriend/MyOldFriend.ino index 30c2937a..93c0ebc4 100644 --- a/examples/MyOldFriend/MyOldFriend.ino +++ b/examples/MyOldFriend/MyOldFriend.ino @@ -45,6 +45,8 @@ void setup() { Kaleidoscope.setup(); Kaleidoscope.use(&MyOldFriend); + + MyOldFriend.enableWakeup(); } void loop() { diff --git a/src/Kaleidoscope/MyOldFriend.h b/src/Kaleidoscope/MyOldFriend.h index e49a7aaf..93d939ea 100644 --- a/src/Kaleidoscope/MyOldFriend.h +++ b/src/Kaleidoscope/MyOldFriend.h @@ -19,6 +19,7 @@ #pragma once #include +#include "WakeupKeyboard.h" namespace kaleidoscope { class MyOldFriend : public KaleidoscopePlugin { @@ -32,6 +33,7 @@ class MyOldFriend : public KaleidoscopePlugin { MyOldFriend(void) {}; void begin(void) final; + void enableWakeup(void) { WakeupKeyboard.begin(); }; void toggleLEDs(Event event); diff --git a/src/Kaleidoscope/WakeupKeyboard.cpp b/src/Kaleidoscope/WakeupKeyboard.cpp new file mode 100644 index 00000000..74fad060 --- /dev/null +++ b/src/Kaleidoscope/WakeupKeyboard.cpp @@ -0,0 +1,91 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-MyOldFriend -- Host sleep support plugin. + * Copyright (C) 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 "WakeupKeyboard.h" + +static const uint8_t _hidReportDescriptorKeyboard[] PROGMEM = { + // Keyboard + 0x05, 0x01, /* USAGE_PAGE (Generic Desktop) */ + 0x09, 0x06, /* USAGE (Keyboard) */ + 0xa1, 0x01, /* COLLECTION (Application) */ + 0x05, 0x07, /* USAGE_PAGE (Keyboard) */ + + /* 0 LEDs, to have something the host can work with. */ + 0x05, 0x08, /* USAGE_PAGE (LEDs) */ + 0x19, 0x00, /* USAGE_MINIMUM (-) */ + 0x29, 0x00, /* USAGE_MAXIMUM (-) */ + 0x95, 0x00, /* REPORT_COUNT (0) */ + 0x75, 0x00, /* REPORT_SIZE (0) */ + 0x91, 0x02, /* OUTPUT (Data,Var,Abs) */ + + /* End */ + 0xc0 /* END_COLLECTION */ +}; + +WakeupKeyboard_::WakeupKeyboard_(void) : PluggableUSBModule(1, 1, epType) { + epType[0] = EP_TYPE_INTERRUPT_IN; + PluggableUSB().plug(this); +} + +int WakeupKeyboard_::getInterface(uint8_t* interfaceCount) { + *interfaceCount += 1; + HIDDescriptor hidInterface = { + D_INTERFACE(pluggedInterface, 1, USB_DEVICE_CLASS_HUMAN_INTERFACE, HID_SUBCLASS_BOOT_INTERFACE, HID_PROTOCOL_KEYBOARD), + D_HIDREPORT(sizeof(_hidReportDescriptorKeyboard)), + D_ENDPOINT(USB_ENDPOINT_IN(pluggedEndpoint), USB_ENDPOINT_TYPE_INTERRUPT, USB_EP_SIZE, 0x01) + }; + return USB_SendControl(0, &hidInterface, sizeof(hidInterface)); +} + +int WakeupKeyboard_::getDescriptor(USBSetup& setup) { + if (setup.bmRequestType != REQUEST_DEVICETOHOST_STANDARD_INTERFACE) { + return 0; + } + if (setup.wValueH != HID_REPORT_DESCRIPTOR_TYPE) { + return 0; + } + + if (setup.wIndex != pluggedInterface) { + return 0; + } + + return USB_SendControl(TRANSFER_PGM, _hidReportDescriptorKeyboard, sizeof(_hidReportDescriptorKeyboard)); +} + +bool WakeupKeyboard_::setup(USBSetup& setup) { + if (pluggedInterface != setup.wIndex) { + return false; + } + + uint8_t request = setup.bRequest; + uint8_t requestType = setup.bmRequestType; + + if (requestType == REQUEST_DEVICETOHOST_CLASS_INTERFACE) { + if (request == HID_GET_PROTOCOL) { + UEDATX = HID_BOOT_PROTOCOL; + return true; + } + } + + return false; +} + +void WakeupKeyboard_::begin () { +} + +WakeupKeyboard_ WakeupKeyboard; diff --git a/src/Kaleidoscope/WakeupKeyboard.h b/src/Kaleidoscope/WakeupKeyboard.h new file mode 100644 index 00000000..6b127f9b --- /dev/null +++ b/src/Kaleidoscope/WakeupKeyboard.h @@ -0,0 +1,38 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-MyOldFriend -- Host sleep support plugin. + * Copyright (C) 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 +#include "PluggableUSB.h" +#include "HID.h" + +class WakeupKeyboard_ : public PluggableUSBModule, public KaleidoscopePlugin { + public: + WakeupKeyboard_(void); + void begin() final; + + protected: + int getInterface(uint8_t* interfaceCount); + int getDescriptor(USBSetup& setup); + bool setup(USBSetup& setup); + + uint8_t epType[1]; +}; + +extern WakeupKeyboard_ WakeupKeyboard; From 9dc2daddc51bb0854fb74e7756f1d937c24b9ef7 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 10 Dec 2017 00:48:34 +0100 Subject: [PATCH 05/21] make astyle Signed-off-by: Gergely Nagy --- src/Kaleidoscope/MyOldFriend.h | 4 +++- src/Kaleidoscope/WakeupKeyboard.cpp | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/src/Kaleidoscope/MyOldFriend.h b/src/Kaleidoscope/MyOldFriend.h index 93d939ea..8d619e21 100644 --- a/src/Kaleidoscope/MyOldFriend.h +++ b/src/Kaleidoscope/MyOldFriend.h @@ -33,7 +33,9 @@ class MyOldFriend : public KaleidoscopePlugin { MyOldFriend(void) {}; void begin(void) final; - void enableWakeup(void) { WakeupKeyboard.begin(); }; + void enableWakeup(void) { + WakeupKeyboard.begin(); + }; void toggleLEDs(Event event); diff --git a/src/Kaleidoscope/WakeupKeyboard.cpp b/src/Kaleidoscope/WakeupKeyboard.cpp index 74fad060..f9beafde 100644 --- a/src/Kaleidoscope/WakeupKeyboard.cpp +++ b/src/Kaleidoscope/WakeupKeyboard.cpp @@ -85,7 +85,7 @@ bool WakeupKeyboard_::setup(USBSetup& setup) { return false; } -void WakeupKeyboard_::begin () { +void WakeupKeyboard_::begin() { } WakeupKeyboard_ WakeupKeyboard; From d602988b95a37c3104ef530e1c72ea5eb965c5f0 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 9 Dec 2017 11:38:57 +0100 Subject: [PATCH 06/21] Use LEDControl.paused instead of an implicit LEDOff Fixes #1. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/MyOldFriend.cpp | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/src/Kaleidoscope/MyOldFriend.cpp b/src/Kaleidoscope/MyOldFriend.cpp index ae4d8edd..ab0ad397 100644 --- a/src/Kaleidoscope/MyOldFriend.cpp +++ b/src/Kaleidoscope/MyOldFriend.cpp @@ -19,7 +19,6 @@ #include #include #include -#include "LED-Off.h" // This is a terrible hack until Arduino#6964 gets implemented. // It makes the `_usbSuspendState` symbol available to us. @@ -32,19 +31,17 @@ bool MyOldFriend::initial_suspend_ = true; void MyOldFriend::begin(void) { Kaleidoscope.useLoopHook(loopHook); - Kaleidoscope.use(&::LEDOff); } void MyOldFriend::toggleLEDs(MyOldFriend::Event event) { - static uint8_t prev_led_mode = 0; - switch (event) { case Suspend: - prev_led_mode = ::LEDControl.get_mode_index(); - ::LEDOff.activate(); + ::LEDControl.paused = true; + ::LEDControl.set_all_leds_to({0, 0, 0}); + ::LEDControl.syncLeds(); break; case Resume: - ::LEDControl.set_mode(prev_led_mode); + ::LEDControl.paused = false; ::LEDControl.refreshAll(); break; case Sleep: From 810a69cf3311f0801c031c2bb3d8e0e5f4d16487 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 16 Dec 2017 08:13:06 +0100 Subject: [PATCH 07/21] Rename the library to HostPowerManagement Signed-off-by: Gergely Nagy --- README.md | 32 +++++++++---------- .../HostPowerManagement.ino} | 8 ++--- library.properties | 8 ++--- ...d.h => Kaleidoscope-HostPowerManagement.h} | 4 +-- .../{MyOldFriend.h => HostPowerManagement.h} | 10 +++--- src/Kaleidoscope/MyOldFriend.cpp | 26 +++++++-------- src/Kaleidoscope/WakeupKeyboard.cpp | 4 +-- src/Kaleidoscope/WakeupKeyboard.h | 2 +- 8 files changed, 46 insertions(+), 48 deletions(-) rename examples/{MyOldFriend/MyOldFriend.ino => HostPowerManagement/HostPowerManagement.ino} (88%) rename src/{Kaleidoscope-MyOldFriend.h => Kaleidoscope-HostPowerManagement.h} (85%) rename src/Kaleidoscope/{MyOldFriend.h => HostPowerManagement.h} (78%) diff --git a/README.md b/README.md index 21bebdf6..17b1610e 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,14 @@ -# Kaleidoscope-MyOldFriend +# Kaleidoscope-HostPowerManagement ![status][st:experimental] [![Build Status][travis:image]][travis:status] - [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-MyOldFriend.svg?branch=master - [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-MyOldFriend + [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-HostPowerManagement.svg?branch=master + [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-HostPowerManagement [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 -> Hello darkness, my old friend -> I've come to talk with you again - Support performing custom actions whenever the host suspends, resumes, or is sleeping. By default, the LEDs will be turned off on suspend, and the previous LED mode restored on resume. @@ -23,18 +20,19 @@ configuration is necessary, unless one wants to perform custom actions. ```c++ #include -#include +#include void setup () { Kaleidoscope.setup (); - Kaleidoscope.use(&MyOldFriend); + Kaleidoscope.use(&HostPowerManagement); + HostPowerManagement.enableWakeup(); } ``` ## Plugin methods -The plugin provides the `MyOldFriend` object, which has the following methods: +The plugin provides the `HostPowerManagement` object, which has the following methods: ### `.enableWakeup()` @@ -46,21 +44,21 @@ The plugin provides the `MyOldFriend` object, which has the following methods: ### `.toggleLEDs(event)` > Turns LEDs off on suspend, restores the previous LED mode on resume. This is -> called by `myOldFriendEventHandler()` by default. +> called by `hostPowerManagementEventHandler()` by default. ## Overrideable methods -### `myOldFriendEventHandler(event)` +### `hostPowerManagementEventHandler(event)` -> The `myOldFriendEventHandler` method is the brain of the plugin: this function +> The `hostPowerManagementEventHandler` method is the brain of the plugin: this function > tells it what action to perform in response to the various events. > -> Currently supported events are: `kaleidoscope::MyOldFriend::Suspend` is fired -> once when the host suspends; `kaleidoscope::MyOldFriend::Sleep` is fired every -> cycle while the host is suspended; `kaleidoscope::MyOldFriend::Resume` is +> Currently supported events are: `kaleidoscope::HostPowerManagement::Suspend` is fired +> once when the host suspends; `kaleidoscope::HostPowerManagement::Sleep` is fired every +> cycle while the host is suspended; `kaleidoscope::HostPowerManagement::Resume` is > fired once when the host wakes up. > -> The default implementation calls `MyOldFriend.toggleLEDs`. When overriding the +> The default implementation calls `HostPowerManagement.toggleLEDs`. When overriding the > function, the default is lost. ## Dependencies @@ -72,4 +70,4 @@ The plugin provides the `MyOldFriend` object, which has the following methods: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/keyboardio/Kaleidoscope-MyOldFriend/blob/master/examples/MyOldFriend/MyOldFriend.ino + [plugin:example]: https://github.com/keyboardio/Kaleidoscope-HostPowerManagement/blob/master/examples/HostPowerManagement/HostPowerManagement.ino diff --git a/examples/MyOldFriend/MyOldFriend.ino b/examples/HostPowerManagement/HostPowerManagement.ino similarity index 88% rename from examples/MyOldFriend/MyOldFriend.ino rename to examples/HostPowerManagement/HostPowerManagement.ino index 93c0ebc4..be96b3ce 100644 --- a/examples/MyOldFriend/MyOldFriend.ino +++ b/examples/HostPowerManagement/HostPowerManagement.ino @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Kaleidoscope-MyOldFriend -- Host sleep support plugin. + * Kaleidoscope-HostPowerManagement -- Host power management support plugin. * Copyright (C) 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -17,7 +17,7 @@ */ #include -#include +#include const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED @@ -44,9 +44,9 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { void setup() { Kaleidoscope.setup(); - Kaleidoscope.use(&MyOldFriend); + Kaleidoscope.use(&HostPowerManagement); - MyOldFriend.enableWakeup(); + HostPowerManagement.enableWakeup(); } void loop() { diff --git a/library.properties b/library.properties index 41953ba1..db622f9d 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ -name=Kaleidoscope-MyOldFriend +name=Kaleidoscope-HostPowerManagement version=0.0.0 author=Gergely Nagy maintainer=Gergely Nagy -sentence=Host sleep support library for Kaleidoscope. -paragraph=Turn LEDs off during host sleep, or do any other custom action. +sentence=Host power management support library for Kaleidoscope. +paragraph=Hooks to support host suspend & resume, and the ability to wake the host from the keyboard. category=Communication -url=https://github.com/keyboardio/Kaleidoscope-MyOldFriend +url=https://github.com/keyboardio/Kaleidoscope-HostPowerManagement architectures=avr dot_a_linkage=true diff --git a/src/Kaleidoscope-MyOldFriend.h b/src/Kaleidoscope-HostPowerManagement.h similarity index 85% rename from src/Kaleidoscope-MyOldFriend.h rename to src/Kaleidoscope-HostPowerManagement.h index e179d1d4..6b9a0251 100644 --- a/src/Kaleidoscope-MyOldFriend.h +++ b/src/Kaleidoscope-HostPowerManagement.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Kaleidoscope-MyOldFriend -- Host sleep support plugin. + * Kaleidoscope-HostPowerManagement -- Host power management support plugin. * Copyright (C) 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/Kaleidoscope/MyOldFriend.h b/src/Kaleidoscope/HostPowerManagement.h similarity index 78% rename from src/Kaleidoscope/MyOldFriend.h rename to src/Kaleidoscope/HostPowerManagement.h index 8d619e21..de3c827b 100644 --- a/src/Kaleidoscope/MyOldFriend.h +++ b/src/Kaleidoscope/HostPowerManagement.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Kaleidoscope-MyOldFriend -- Host sleep support plugin. + * Kaleidoscope-HostPowerManagement -- Host power management support plugin. * Copyright (C) 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -22,7 +22,7 @@ #include "WakeupKeyboard.h" namespace kaleidoscope { -class MyOldFriend : public KaleidoscopePlugin { +class HostPowerManagement : public KaleidoscopePlugin { public: typedef enum { Suspend, @@ -30,7 +30,7 @@ class MyOldFriend : public KaleidoscopePlugin { Resume, } Event; - MyOldFriend(void) {}; + HostPowerManagement(void) {}; void begin(void) final; void enableWakeup(void) { @@ -47,6 +47,6 @@ class MyOldFriend : public KaleidoscopePlugin { }; } -void myOldFriendEventHandler(kaleidoscope::MyOldFriend::Event event); +void hostPowerManagementEventHandler(kaleidoscope::HostPowerManagement::Event event); -extern kaleidoscope::MyOldFriend MyOldFriend; +extern kaleidoscope::HostPowerManagement HostPowerManagement; diff --git a/src/Kaleidoscope/MyOldFriend.cpp b/src/Kaleidoscope/MyOldFriend.cpp index ab0ad397..2b4ee255 100644 --- a/src/Kaleidoscope/MyOldFriend.cpp +++ b/src/Kaleidoscope/MyOldFriend.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Kaleidoscope-MyOldFriend -- Host sleep support plugin. + * Kaleidoscope-HostPowerManagement -- Host power management support plugin. * Copyright (C) 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -17,7 +17,7 @@ */ #include -#include +#include #include // This is a terrible hack until Arduino#6964 gets implemented. @@ -26,14 +26,14 @@ extern u8 _usbSuspendState; namespace kaleidoscope { -bool MyOldFriend::was_suspended_ = false; -bool MyOldFriend::initial_suspend_ = true; +bool HostPowerManagement::was_suspended_ = false; +bool HostPowerManagement::initial_suspend_ = true; -void MyOldFriend::begin(void) { +void HostPowerManagement::begin(void) { Kaleidoscope.useLoopHook(loopHook); } -void MyOldFriend::toggleLEDs(MyOldFriend::Event event) { +void HostPowerManagement::toggleLEDs(HostPowerManagement::Event event) { switch (event) { case Suspend: ::LEDControl.paused = true; @@ -49,7 +49,7 @@ void MyOldFriend::toggleLEDs(MyOldFriend::Event event) { } } -void MyOldFriend::loopHook(bool post_clear) { +void HostPowerManagement::loopHook(bool post_clear) { if (post_clear) return; @@ -57,9 +57,9 @@ void MyOldFriend::loopHook(bool post_clear) { if (!initial_suspend_) { if (!was_suspended_) { was_suspended_ = true; - myOldFriendEventHandler(Suspend); + hostPowerManagementEventHandler(Suspend); } else { - myOldFriendEventHandler(Sleep); + hostPowerManagementEventHandler(Sleep); } } } else { @@ -67,15 +67,15 @@ void MyOldFriend::loopHook(bool post_clear) { initial_suspend_ = false; if (was_suspended_) { was_suspended_ = false; - myOldFriendEventHandler(Resume); + hostPowerManagementEventHandler(Resume); } } } } -__attribute__((weak)) void myOldFriendEventHandler(kaleidoscope::MyOldFriend::Event event) { - MyOldFriend.toggleLEDs(event); +__attribute__((weak)) void hostPowerManagementEventHandler(kaleidoscope::HostPowerManagement::Event event) { + HostPowerManagement.toggleLEDs(event); } -kaleidoscope::MyOldFriend MyOldFriend; +kaleidoscope::HostPowerManagement HostPowerManagement; diff --git a/src/Kaleidoscope/WakeupKeyboard.cpp b/src/Kaleidoscope/WakeupKeyboard.cpp index f9beafde..f75ecd63 100644 --- a/src/Kaleidoscope/WakeupKeyboard.cpp +++ b/src/Kaleidoscope/WakeupKeyboard.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Kaleidoscope-MyOldFriend -- Host sleep support plugin. + * Kaleidoscope-MyOldFriend -- Host power management support plugin. * Copyright (C) 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -85,7 +85,7 @@ bool WakeupKeyboard_::setup(USBSetup& setup) { return false; } -void WakeupKeyboard_::begin() { +void WakeupKeyboard_::begin () { } WakeupKeyboard_ WakeupKeyboard; diff --git a/src/Kaleidoscope/WakeupKeyboard.h b/src/Kaleidoscope/WakeupKeyboard.h index 6b127f9b..d1199ffa 100644 --- a/src/Kaleidoscope/WakeupKeyboard.h +++ b/src/Kaleidoscope/WakeupKeyboard.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Kaleidoscope-MyOldFriend -- Host sleep support plugin. + * Kaleidoscope-MyOldFriend -- Host power management support plugin. * Copyright (C) 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify From c71b96c2334f47c432941623065c9224195821b6 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 16 Dec 2017 08:20:20 +0100 Subject: [PATCH 08/21] make astyle Signed-off-by: Gergely Nagy --- src/Kaleidoscope/WakeupKeyboard.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/WakeupKeyboard.cpp b/src/Kaleidoscope/WakeupKeyboard.cpp index f75ecd63..a1585584 100644 --- a/src/Kaleidoscope/WakeupKeyboard.cpp +++ b/src/Kaleidoscope/WakeupKeyboard.cpp @@ -85,7 +85,7 @@ bool WakeupKeyboard_::setup(USBSetup& setup) { return false; } -void WakeupKeyboard_::begin () { +void WakeupKeyboard_::begin() { } WakeupKeyboard_ WakeupKeyboard; From 5eca9b9a1f6ac6c64334596c6c861d0f99438840 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 16 Dec 2017 08:24:05 +0100 Subject: [PATCH 09/21] Forgot to rename a file, oops. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/{MyOldFriend.cpp => HostPowerManagement.cpp} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename src/Kaleidoscope/{MyOldFriend.cpp => HostPowerManagement.cpp} (100%) diff --git a/src/Kaleidoscope/MyOldFriend.cpp b/src/Kaleidoscope/HostPowerManagement.cpp similarity index 100% rename from src/Kaleidoscope/MyOldFriend.cpp rename to src/Kaleidoscope/HostPowerManagement.cpp From c56c7791ba20084c6dbda269344d018f5e066782 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 16 Dec 2017 08:30:47 +0100 Subject: [PATCH 10/21] Do not provide toggleLEDs As this is a generic plugin, for keyboards that do not have LEDs, don't tie it to LEDControl, and don't provide a `toggleLEDs` method. Instead, show an example how to achieve the same thing from the sketch. Signed-off-by: Gergely Nagy --- README.md | 16 +++------------- .../HostPowerManagement/HostPowerManagement.ino | 17 +++++++++++++++++ src/Kaleidoscope/HostPowerManagement.cpp | 17 ----------------- src/Kaleidoscope/HostPowerManagement.h | 2 -- 4 files changed, 20 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 17b1610e..52b82866 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,8 @@ [st:experimental]: https://img.shields.io/badge/experimental----black.svg?style=flat&colorA=dfb317&colorB=494e52 Support performing custom actions whenever the host suspends, resumes, or is -sleeping. By default, the LEDs will be turned off on suspend, and the previous -LED mode restored on resume. +sleeping. Additionally, this plugin provides optional support for the keyboard +to wake the host up from suspend. ## Using the plugin @@ -41,11 +41,6 @@ The plugin provides the `HostPowerManagement` object, which has the following me > > Once enabled, it **cannot** be disabled again. -### `.toggleLEDs(event)` - -> Turns LEDs off on suspend, restores the previous LED mode on resume. This is -> called by `hostPowerManagementEventHandler()` by default. - ## Overrideable methods ### `hostPowerManagementEventHandler(event)` @@ -58,12 +53,7 @@ The plugin provides the `HostPowerManagement` object, which has the following me > cycle while the host is suspended; `kaleidoscope::HostPowerManagement::Resume` is > fired once when the host wakes up. > -> The default implementation calls `HostPowerManagement.toggleLEDs`. When overriding the -> function, the default is lost. - -## Dependencies - -* [Kaleidoscope-LEDControl](https://github.com/keyboardio/Kaleidoscope-LEDControl) +> The default implementation is empty. ## Further reading diff --git a/examples/HostPowerManagement/HostPowerManagement.ino b/examples/HostPowerManagement/HostPowerManagement.ino index be96b3ce..0c498931 100644 --- a/examples/HostPowerManagement/HostPowerManagement.ino +++ b/examples/HostPowerManagement/HostPowerManagement.ino @@ -17,6 +17,7 @@ */ #include +#include #include const Key keymaps[][ROWS][COLS] PROGMEM = { @@ -41,6 +42,22 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { }; +void hostPowerManagementEventHandler(kaleidoscope::HostPowerManagement::Event event) { + switch (event) { + case kaleidoscope::HostPowerManagement::Suspend: + LEDControl.paused = true; + LEDControl.set_all_leds_to({0, 0, 0}); + LEDControl.syncLeds(); + break; + case kaleidoscope::HostPowerManagement::Resume: + LEDControl.paused = false; + LEDControl.refreshAll(); + break; + case kaleidoscope::HostPowerManagement::Sleep: + break; + } +} + void setup() { Kaleidoscope.setup(); diff --git a/src/Kaleidoscope/HostPowerManagement.cpp b/src/Kaleidoscope/HostPowerManagement.cpp index 2b4ee255..d91ddbf9 100644 --- a/src/Kaleidoscope/HostPowerManagement.cpp +++ b/src/Kaleidoscope/HostPowerManagement.cpp @@ -33,22 +33,6 @@ void HostPowerManagement::begin(void) { Kaleidoscope.useLoopHook(loopHook); } -void HostPowerManagement::toggleLEDs(HostPowerManagement::Event event) { - switch (event) { - case Suspend: - ::LEDControl.paused = true; - ::LEDControl.set_all_leds_to({0, 0, 0}); - ::LEDControl.syncLeds(); - break; - case Resume: - ::LEDControl.paused = false; - ::LEDControl.refreshAll(); - break; - case Sleep: - break; - } -} - void HostPowerManagement::loopHook(bool post_clear) { if (post_clear) return; @@ -75,7 +59,6 @@ void HostPowerManagement::loopHook(bool post_clear) { } __attribute__((weak)) void hostPowerManagementEventHandler(kaleidoscope::HostPowerManagement::Event event) { - HostPowerManagement.toggleLEDs(event); } kaleidoscope::HostPowerManagement HostPowerManagement; diff --git a/src/Kaleidoscope/HostPowerManagement.h b/src/Kaleidoscope/HostPowerManagement.h index de3c827b..79e321f1 100644 --- a/src/Kaleidoscope/HostPowerManagement.h +++ b/src/Kaleidoscope/HostPowerManagement.h @@ -37,8 +37,6 @@ class HostPowerManagement : public KaleidoscopePlugin { WakeupKeyboard.begin(); }; - void toggleLEDs(Event event); - private: static bool was_suspended_; static bool initial_suspend_; From 19cffca5c46b50596cecacfbe557645f4e1acab2 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 12 May 2018 18:04:52 +0200 Subject: [PATCH 11/21] Updated to use the new plugin APIs Signed-off-by: Gergely Nagy --- README.md | 3 ++- .../HostPowerManagement.ino | 12 +++++---- src/Kaleidoscope/HostPowerManagement.cpp | 27 ++++++++++++------- src/Kaleidoscope/HostPowerManagement.h | 21 +++++++++------ src/Kaleidoscope/WakeupKeyboard.cpp | 6 ++--- src/Kaleidoscope/WakeupKeyboard.h | 8 +++--- 6 files changed, 47 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 52b82866..ef1cca88 100644 --- a/README.md +++ b/README.md @@ -22,10 +22,11 @@ configuration is necessary, unless one wants to perform custom actions. #include #include +KALEIDOSCOPE_INIT_PLUGINS(HostPowerManagement); + void setup () { Kaleidoscope.setup (); - Kaleidoscope.use(&HostPowerManagement); HostPowerManagement.enableWakeup(); } ``` diff --git a/examples/HostPowerManagement/HostPowerManagement.ino b/examples/HostPowerManagement/HostPowerManagement.ino index 0c498931..77b159ab 100644 --- a/examples/HostPowerManagement/HostPowerManagement.ino +++ b/examples/HostPowerManagement/HostPowerManagement.ino @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-HostPowerManagement -- Host power management support plugin. - * Copyright (C) 2017 Gergely Nagy + * Copyright (C) 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 @@ -20,6 +20,7 @@ #include #include +// *INDENT-OFF* const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED ( @@ -33,14 +34,14 @@ 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 hostPowerManagementEventHandler(kaleidoscope::HostPowerManagement::Event event) { switch (event) { @@ -58,11 +59,12 @@ void hostPowerManagementEventHandler(kaleidoscope::HostPowerManagement::Event ev } } +KALEIDOSCOPE_INIT_PLUGINS(LEDControl, + HostPowerManagement); + void setup() { Kaleidoscope.setup(); - Kaleidoscope.use(&HostPowerManagement); - HostPowerManagement.enableWakeup(); } diff --git a/src/Kaleidoscope/HostPowerManagement.cpp b/src/Kaleidoscope/HostPowerManagement.cpp index d91ddbf9..1a8fd422 100644 --- a/src/Kaleidoscope/HostPowerManagement.cpp +++ b/src/Kaleidoscope/HostPowerManagement.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-HostPowerManagement -- Host power management support plugin. - * Copyright (C) 2017 Gergely Nagy + * Copyright (C) 2017, 2018 Gergely Nagy * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -29,14 +29,7 @@ namespace kaleidoscope { bool HostPowerManagement::was_suspended_ = false; bool HostPowerManagement::initial_suspend_ = true; -void HostPowerManagement::begin(void) { - Kaleidoscope.useLoopHook(loopHook); -} - -void HostPowerManagement::loopHook(bool post_clear) { - if (post_clear) - return; - +EventHandlerResult HostPowerManagement::beforeEachCycle() { if ((_usbSuspendState & (1 << SUSPI))) { if (!initial_suspend_) { if (!was_suspended_) { @@ -54,7 +47,23 @@ void HostPowerManagement::loopHook(bool post_clear) { hostPowerManagementEventHandler(Resume); } } + + return EventHandlerResult::OK; +} + +// Legacy V1 API +#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API +void HostPowerManagement::begin() { + Kaleidoscope.useLoopHook(legacyLoopHook); +} + +void HostPowerManagement::legacyLoopHook(bool is_post_clear) { + if (is_post_clear) + return; + + ::HostPowerManagement.beforeEachCycle(); } +#endif } diff --git a/src/Kaleidoscope/HostPowerManagement.h b/src/Kaleidoscope/HostPowerManagement.h index 79e321f1..59d71a2d 100644 --- a/src/Kaleidoscope/HostPowerManagement.h +++ b/src/Kaleidoscope/HostPowerManagement.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-HostPowerManagement -- Host power management support plugin. - * Copyright (C) 2017 Gergely Nagy + * Copyright (C) 2017, 2018 Gergely Nagy * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -22,7 +22,7 @@ #include "WakeupKeyboard.h" namespace kaleidoscope { -class HostPowerManagement : public KaleidoscopePlugin { +class HostPowerManagement : public kaleidoscope::Plugin { public: typedef enum { Suspend, @@ -30,18 +30,23 @@ class HostPowerManagement : public KaleidoscopePlugin { Resume, } Event; - HostPowerManagement(void) {}; + HostPowerManagement(void) {} - void begin(void) final; void enableWakeup(void) { - WakeupKeyboard.begin(); - }; + WakeupKeyboard.init(); + } + + EventHandlerResult beforeEachCycle(); + +#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API + protected: + void begin(); + static void legacyLoopHook(bool is_post_clear); +#endif private: static bool was_suspended_; static bool initial_suspend_; - - static void loopHook(bool post_clear); }; } diff --git a/src/Kaleidoscope/WakeupKeyboard.cpp b/src/Kaleidoscope/WakeupKeyboard.cpp index a1585584..f527c792 100644 --- a/src/Kaleidoscope/WakeupKeyboard.cpp +++ b/src/Kaleidoscope/WakeupKeyboard.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- - * Kaleidoscope-MyOldFriend -- Host power management support plugin. - * Copyright (C) 2017 Gergely Nagy + * Kaleidoscope-HostPowerManagement -- Host power management support plugin. + * Copyright (C) 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 @@ -85,7 +85,7 @@ bool WakeupKeyboard_::setup(USBSetup& setup) { return false; } -void WakeupKeyboard_::begin() { +void WakeupKeyboard_::init() { } WakeupKeyboard_ WakeupKeyboard; diff --git a/src/Kaleidoscope/WakeupKeyboard.h b/src/Kaleidoscope/WakeupKeyboard.h index d1199ffa..e6ac356b 100644 --- a/src/Kaleidoscope/WakeupKeyboard.h +++ b/src/Kaleidoscope/WakeupKeyboard.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- - * Kaleidoscope-MyOldFriend -- Host power management support plugin. - * Copyright (C) 2017 Gergely Nagy + * Kaleidoscope-HostPowerManagement -- Host power management support plugin. + * Copyright (C) 2017, 2018 Gergely Nagy * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -22,10 +22,10 @@ #include "PluggableUSB.h" #include "HID.h" -class WakeupKeyboard_ : public PluggableUSBModule, public KaleidoscopePlugin { +class WakeupKeyboard_ : public PluggableUSBModule, public kaleidoscope::Plugin { public: WakeupKeyboard_(void); - void begin() final; + void init(); protected: int getInterface(uint8_t* interfaceCount); From da41514f1cf4fd85e6fafe0e695f3dbc1f54547d Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 2 Jun 2018 08:40:29 +0200 Subject: [PATCH 12/21] Remove WakeupKeyboard This removes WakeupKeyboard, because a similar feature was integrated into BootKeyboard itself, rendering it useless. See keyboardio/KeyboardioHID#35 for an explanation of the whole situation. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/HostPowerManagement.h | 10 +-- src/Kaleidoscope/WakeupKeyboard.cpp | 91 -------------------------- src/Kaleidoscope/WakeupKeyboard.h | 38 ----------- 3 files changed, 6 insertions(+), 133 deletions(-) delete mode 100644 src/Kaleidoscope/WakeupKeyboard.cpp delete mode 100644 src/Kaleidoscope/WakeupKeyboard.h diff --git a/src/Kaleidoscope/HostPowerManagement.h b/src/Kaleidoscope/HostPowerManagement.h index 59d71a2d..01b9d4f5 100644 --- a/src/Kaleidoscope/HostPowerManagement.h +++ b/src/Kaleidoscope/HostPowerManagement.h @@ -19,7 +19,11 @@ #pragma once #include -#include "WakeupKeyboard.h" + +#define _DEPRECATED_MESSAGE_ENABLEWAKEUP \ + "The HostPowerManagement.enableWakeup() call is not necessary anymore,\n" \ + "the firmware supports wakeup by default now. The line can be safely\n" \ + "removed." namespace kaleidoscope { class HostPowerManagement : public kaleidoscope::Plugin { @@ -32,9 +36,7 @@ class HostPowerManagement : public kaleidoscope::Plugin { HostPowerManagement(void) {} - void enableWakeup(void) { - WakeupKeyboard.init(); - } + void enableWakeup(void) DEPRECATED(ENABLEWAKEUP) {} EventHandlerResult beforeEachCycle(); diff --git a/src/Kaleidoscope/WakeupKeyboard.cpp b/src/Kaleidoscope/WakeupKeyboard.cpp deleted file mode 100644 index f527c792..00000000 --- a/src/Kaleidoscope/WakeupKeyboard.cpp +++ /dev/null @@ -1,91 +0,0 @@ -/* -*- mode: c++ -*- - * Kaleidoscope-HostPowerManagement -- Host power management support plugin. - * Copyright (C) 2017, 2018 Gergely Nagy - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This program is 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 "WakeupKeyboard.h" - -static const uint8_t _hidReportDescriptorKeyboard[] PROGMEM = { - // Keyboard - 0x05, 0x01, /* USAGE_PAGE (Generic Desktop) */ - 0x09, 0x06, /* USAGE (Keyboard) */ - 0xa1, 0x01, /* COLLECTION (Application) */ - 0x05, 0x07, /* USAGE_PAGE (Keyboard) */ - - /* 0 LEDs, to have something the host can work with. */ - 0x05, 0x08, /* USAGE_PAGE (LEDs) */ - 0x19, 0x00, /* USAGE_MINIMUM (-) */ - 0x29, 0x00, /* USAGE_MAXIMUM (-) */ - 0x95, 0x00, /* REPORT_COUNT (0) */ - 0x75, 0x00, /* REPORT_SIZE (0) */ - 0x91, 0x02, /* OUTPUT (Data,Var,Abs) */ - - /* End */ - 0xc0 /* END_COLLECTION */ -}; - -WakeupKeyboard_::WakeupKeyboard_(void) : PluggableUSBModule(1, 1, epType) { - epType[0] = EP_TYPE_INTERRUPT_IN; - PluggableUSB().plug(this); -} - -int WakeupKeyboard_::getInterface(uint8_t* interfaceCount) { - *interfaceCount += 1; - HIDDescriptor hidInterface = { - D_INTERFACE(pluggedInterface, 1, USB_DEVICE_CLASS_HUMAN_INTERFACE, HID_SUBCLASS_BOOT_INTERFACE, HID_PROTOCOL_KEYBOARD), - D_HIDREPORT(sizeof(_hidReportDescriptorKeyboard)), - D_ENDPOINT(USB_ENDPOINT_IN(pluggedEndpoint), USB_ENDPOINT_TYPE_INTERRUPT, USB_EP_SIZE, 0x01) - }; - return USB_SendControl(0, &hidInterface, sizeof(hidInterface)); -} - -int WakeupKeyboard_::getDescriptor(USBSetup& setup) { - if (setup.bmRequestType != REQUEST_DEVICETOHOST_STANDARD_INTERFACE) { - return 0; - } - if (setup.wValueH != HID_REPORT_DESCRIPTOR_TYPE) { - return 0; - } - - if (setup.wIndex != pluggedInterface) { - return 0; - } - - return USB_SendControl(TRANSFER_PGM, _hidReportDescriptorKeyboard, sizeof(_hidReportDescriptorKeyboard)); -} - -bool WakeupKeyboard_::setup(USBSetup& setup) { - if (pluggedInterface != setup.wIndex) { - return false; - } - - uint8_t request = setup.bRequest; - uint8_t requestType = setup.bmRequestType; - - if (requestType == REQUEST_DEVICETOHOST_CLASS_INTERFACE) { - if (request == HID_GET_PROTOCOL) { - UEDATX = HID_BOOT_PROTOCOL; - return true; - } - } - - return false; -} - -void WakeupKeyboard_::init() { -} - -WakeupKeyboard_ WakeupKeyboard; diff --git a/src/Kaleidoscope/WakeupKeyboard.h b/src/Kaleidoscope/WakeupKeyboard.h deleted file mode 100644 index e6ac356b..00000000 --- a/src/Kaleidoscope/WakeupKeyboard.h +++ /dev/null @@ -1,38 +0,0 @@ -/* -*- mode: c++ -*- - * Kaleidoscope-HostPowerManagement -- Host power management support plugin. - * Copyright (C) 2017, 2018 Gergely Nagy - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This program is 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 -#include "PluggableUSB.h" -#include "HID.h" - -class WakeupKeyboard_ : public PluggableUSBModule, public kaleidoscope::Plugin { - public: - WakeupKeyboard_(void); - void init(); - - protected: - int getInterface(uint8_t* interfaceCount); - int getDescriptor(USBSetup& setup); - bool setup(USBSetup& setup); - - uint8_t epType[1]; -}; - -extern WakeupKeyboard_ WakeupKeyboard; From 948b3d40b730bd3ecba3e30b3c77709a4d89419f Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 17 Jun 2018 11:03:57 +0200 Subject: [PATCH 13/21] Override onSetup when using a compatibility layer The default `onSetup` will call `.begin`, to support initializing plugins using the V1 plugins while using `KALEIDOSCOPE_INIT_PLUGINS`. However, plugins that implement a compatibility layer so that they can be used with both the new API, and with `Kaleidoscope.use()` will have a `.begin` method too. Which the default `onSetup` will call, and we'll register the compatibility layer too, in addition to the new-style event handlers. This results in many things running twice, which leads to all kinds of problems. For this reason, override `onSetup`, so that it does not call `begin`. When used with `Kaleidoscope.use()`, the plugin will still work, so compatibility is maintained. But the bug is now gone. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/HostPowerManagement.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/Kaleidoscope/HostPowerManagement.h b/src/Kaleidoscope/HostPowerManagement.h index 01b9d4f5..72a0826f 100644 --- a/src/Kaleidoscope/HostPowerManagement.h +++ b/src/Kaleidoscope/HostPowerManagement.h @@ -41,6 +41,10 @@ class HostPowerManagement : public kaleidoscope::Plugin { EventHandlerResult beforeEachCycle(); #if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API + kaleidoscope::EventHandlerResult onSetup() { + return kaleidoscope::EventHandlerResult::OK; + } + protected: void begin(); static void legacyLoopHook(bool is_post_clear); From cea73d9a7204ffc77a7a3db558ac299d977505c7 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Thu, 16 Aug 2018 18:05:19 -0700 Subject: [PATCH 14/21] This change hacks up HostPowerManagement to make it a noop on X86 --- src/Kaleidoscope/HostPowerManagement.cpp | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/Kaleidoscope/HostPowerManagement.cpp b/src/Kaleidoscope/HostPowerManagement.cpp index 1a8fd422..da7bacd5 100644 --- a/src/Kaleidoscope/HostPowerManagement.cpp +++ b/src/Kaleidoscope/HostPowerManagement.cpp @@ -22,7 +22,7 @@ // This is a terrible hack until Arduino#6964 gets implemented. // It makes the `_usbSuspendState` symbol available to us. -extern u8 _usbSuspendState; +extern uint8_t _usbSuspendState; namespace kaleidoscope { @@ -30,6 +30,8 @@ bool HostPowerManagement::was_suspended_ = false; bool HostPowerManagement::initial_suspend_ = true; EventHandlerResult HostPowerManagement::beforeEachCycle() { + +#ifdef __AVR__ if ((_usbSuspendState & (1 << SUSPI))) { if (!initial_suspend_) { if (!was_suspended_) { @@ -47,6 +49,7 @@ EventHandlerResult HostPowerManagement::beforeEachCycle() { hostPowerManagementEventHandler(Resume); } } +#endif return EventHandlerResult::OK; } From 026ff0407158b5a33727b1e5b857983359631c91 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 20 Aug 2018 23:04:11 +0200 Subject: [PATCH 15/21] Drop the V1 plugin API compatibility code Signed-off-by: Gergely Nagy --- src/Kaleidoscope/HostPowerManagement.cpp | 14 -------------- src/Kaleidoscope/HostPowerManagement.h | 10 ---------- 2 files changed, 24 deletions(-) diff --git a/src/Kaleidoscope/HostPowerManagement.cpp b/src/Kaleidoscope/HostPowerManagement.cpp index da7bacd5..46f8053f 100644 --- a/src/Kaleidoscope/HostPowerManagement.cpp +++ b/src/Kaleidoscope/HostPowerManagement.cpp @@ -54,20 +54,6 @@ EventHandlerResult HostPowerManagement::beforeEachCycle() { return EventHandlerResult::OK; } -// Legacy V1 API -#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API -void HostPowerManagement::begin() { - Kaleidoscope.useLoopHook(legacyLoopHook); -} - -void HostPowerManagement::legacyLoopHook(bool is_post_clear) { - if (is_post_clear) - return; - - ::HostPowerManagement.beforeEachCycle(); -} -#endif - } __attribute__((weak)) void hostPowerManagementEventHandler(kaleidoscope::HostPowerManagement::Event event) { diff --git a/src/Kaleidoscope/HostPowerManagement.h b/src/Kaleidoscope/HostPowerManagement.h index 72a0826f..61b8716b 100644 --- a/src/Kaleidoscope/HostPowerManagement.h +++ b/src/Kaleidoscope/HostPowerManagement.h @@ -40,16 +40,6 @@ class HostPowerManagement : public kaleidoscope::Plugin { EventHandlerResult beforeEachCycle(); -#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API - kaleidoscope::EventHandlerResult onSetup() { - return kaleidoscope::EventHandlerResult::OK; - } - - protected: - void begin(); - static void legacyLoopHook(bool is_post_clear); -#endif - private: static bool was_suspended_; static bool initial_suspend_; From 78816f4b36471f4920b109847b997e45da05625b Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 4 Sep 2018 18:24:01 -0700 Subject: [PATCH 16/21] 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 637943c9243123cb98bc4988efb73b0bf67d21d4 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 4 Sep 2018 18:42:29 -0700 Subject: [PATCH 17/21] 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 403754f915b4183aec3109a8268e38b9e1f31f69 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 10 Oct 2018 06:34:50 +0200 Subject: [PATCH 18/21] README.md, example, and 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). While there, updated both the README and the example to not use the now-obsolete `.enableWakeup` method. Signed-off-by: Gergely Nagy --- .travis.yml | 7 ------- README.md | 20 +++---------------- .../HostPowerManagement.ino | 2 -- 3 files changed, 3 insertions(+), 26 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 ef1cca88..f89544f9 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,12 @@ # Kaleidoscope-HostPowerManagement -![status][st:experimental] [![Build Status][travis:image]][travis:status] +[![Build Status][travis:image]][travis:status] [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-HostPowerManagement.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-HostPowerManagement - [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 - Support performing custom actions whenever the host suspends, resumes, or is -sleeping. Additionally, this plugin provides optional support for the keyboard -to wake the host up from suspend. +sleeping. ## Using the plugin @@ -26,21 +21,12 @@ KALEIDOSCOPE_INIT_PLUGINS(HostPowerManagement); void setup () { Kaleidoscope.setup (); - - HostPowerManagement.enableWakeup(); } ``` ## Plugin methods -The plugin provides the `HostPowerManagement` object, which has the following methods: - -### `.enableWakeup()` - -> Enables host wakeup support. When enabled, pressing any key on the keyboard -> will wake the host up. -> -> Once enabled, it **cannot** be disabled again. +The plugin provides the `HostPowerManagement` object, with no public methods. ## Overrideable methods diff --git a/examples/HostPowerManagement/HostPowerManagement.ino b/examples/HostPowerManagement/HostPowerManagement.ino index 77b159ab..5f27cbdf 100644 --- a/examples/HostPowerManagement/HostPowerManagement.ino +++ b/examples/HostPowerManagement/HostPowerManagement.ino @@ -64,8 +64,6 @@ KALEIDOSCOPE_INIT_PLUGINS(LEDControl, void setup() { Kaleidoscope.setup(); - - HostPowerManagement.enableWakeup(); } void loop() { From 5099d8ebb9b4574db958d768900f2902979027df Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 13 Oct 2018 12:35:58 +0200 Subject: [PATCH 19/21] Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/HostPowerManagement.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 | 44 +---------------- doc/plugin/HostPowerManagement.md | 47 +++++++++++++++++++ .../HostPowerManagement.ino | 8 ++-- src/Kaleidoscope-HostPowerManagement.h | 2 +- .../plugin}/HostPowerManagement.cpp | 6 ++- .../plugin}/HostPowerManagement.h | 10 +++- 6 files changed, 65 insertions(+), 52 deletions(-) create mode 100644 doc/plugin/HostPowerManagement.md rename src/{Kaleidoscope => kaleidoscope/plugin}/HostPowerManagement.cpp (92%) rename src/{Kaleidoscope => kaleidoscope/plugin}/HostPowerManagement.h (84%) diff --git a/README.md b/README.md index f89544f9..09498c2f 100644 --- a/README.md +++ b/README.md @@ -5,46 +5,4 @@ [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-HostPowerManagement.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-HostPowerManagement -Support performing custom actions whenever the host suspends, resumes, or is -sleeping. - -## Using the plugin - -To use the plugin, one needs to include the header, and activate it. No further -configuration is necessary, unless one wants to perform custom actions. - -```c++ -#include -#include - -KALEIDOSCOPE_INIT_PLUGINS(HostPowerManagement); - -void setup () { - Kaleidoscope.setup (); -} -``` - -## Plugin methods - -The plugin provides the `HostPowerManagement` object, with no public methods. - -## Overrideable methods - -### `hostPowerManagementEventHandler(event)` - -> The `hostPowerManagementEventHandler` method is the brain of the plugin: this function -> tells it what action to perform in response to the various events. -> -> Currently supported events are: `kaleidoscope::HostPowerManagement::Suspend` is fired -> once when the host suspends; `kaleidoscope::HostPowerManagement::Sleep` is fired every -> cycle while the host is suspended; `kaleidoscope::HostPowerManagement::Resume` is -> fired once when the host wakes up. -> -> The default implementation is empty. - -## 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-HostPowerManagement/blob/master/examples/HostPowerManagement/HostPowerManagement.ino +See [doc/plugin/HostPowerManagement.md](doc/plugin/HostPowerManagement.md) for documentation. diff --git a/doc/plugin/HostPowerManagement.md b/doc/plugin/HostPowerManagement.md new file mode 100644 index 00000000..0a5268cc --- /dev/null +++ b/doc/plugin/HostPowerManagement.md @@ -0,0 +1,47 @@ +# Kaleidoscope-HostPowerManagement + +Support performing custom actions whenever the host suspends, resumes, or is +sleeping. + +## Using the plugin + +To use the plugin, one needs to include the header, and activate it. No further +configuration is necessary, unless one wants to perform custom actions. + +```c++ +#include +#include + +KALEIDOSCOPE_INIT_PLUGINS(HostPowerManagement); + +void setup () { + Kaleidoscope.setup (); +} +``` + +## Plugin methods + +The plugin provides the `HostPowerManagement` object, with no public methods. + +## Overrideable methods + +### `hostPowerManagementEventHandler(event)` + +> The `hostPowerManagementEventHandler` method is the brain of the plugin: this function +> tells it what action to perform in response to the various events. +> +> Currently supported events are: +> `kaleidoscope::plugin::HostPowerManagement::Suspend` is fired once when the +> host suspends; `kaleidoscope::plugin::HostPowerManagement::Sleep` is fired +> every cycle while the host is suspended; +> `kaleidoscope::plugin::HostPowerManagement::Resume` is fired once when the +> host wakes up. +> +> The default implementation is empty. + +## 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-HostPowerManagement/blob/master/examples/HostPowerManagement/HostPowerManagement.ino diff --git a/examples/HostPowerManagement/HostPowerManagement.ino b/examples/HostPowerManagement/HostPowerManagement.ino index 5f27cbdf..72d6f9df 100644 --- a/examples/HostPowerManagement/HostPowerManagement.ino +++ b/examples/HostPowerManagement/HostPowerManagement.ino @@ -43,18 +43,18 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { }; // *INDENT-ON* -void hostPowerManagementEventHandler(kaleidoscope::HostPowerManagement::Event event) { +void hostPowerManagementEventHandler(kaleidoscope::plugin::HostPowerManagement::Event event) { switch (event) { - case kaleidoscope::HostPowerManagement::Suspend: + case kaleidoscope::plugin::HostPowerManagement::Suspend: LEDControl.paused = true; LEDControl.set_all_leds_to({0, 0, 0}); LEDControl.syncLeds(); break; - case kaleidoscope::HostPowerManagement::Resume: + case kaleidoscope::plugin::HostPowerManagement::Resume: LEDControl.paused = false; LEDControl.refreshAll(); break; - case kaleidoscope::HostPowerManagement::Sleep: + case kaleidoscope::plugin::HostPowerManagement::Sleep: break; } } diff --git a/src/Kaleidoscope-HostPowerManagement.h b/src/Kaleidoscope-HostPowerManagement.h index 6b9a0251..f6e56935 100644 --- a/src/Kaleidoscope-HostPowerManagement.h +++ b/src/Kaleidoscope-HostPowerManagement.h @@ -18,4 +18,4 @@ #pragma once -#include +#include diff --git a/src/Kaleidoscope/HostPowerManagement.cpp b/src/kaleidoscope/plugin/HostPowerManagement.cpp similarity index 92% rename from src/Kaleidoscope/HostPowerManagement.cpp rename to src/kaleidoscope/plugin/HostPowerManagement.cpp index 46f8053f..ce4c9826 100644 --- a/src/Kaleidoscope/HostPowerManagement.cpp +++ b/src/kaleidoscope/plugin/HostPowerManagement.cpp @@ -25,6 +25,7 @@ extern uint8_t _usbSuspendState; namespace kaleidoscope { +namespace plugin { bool HostPowerManagement::was_suspended_ = false; bool HostPowerManagement::initial_suspend_ = true; @@ -54,9 +55,10 @@ EventHandlerResult HostPowerManagement::beforeEachCycle() { return EventHandlerResult::OK; } +} } -__attribute__((weak)) void hostPowerManagementEventHandler(kaleidoscope::HostPowerManagement::Event event) { +__attribute__((weak)) void hostPowerManagementEventHandler(kaleidoscope::plugin::HostPowerManagement::Event event) { } -kaleidoscope::HostPowerManagement HostPowerManagement; +kaleidoscope::plugin::HostPowerManagement HostPowerManagement; diff --git a/src/Kaleidoscope/HostPowerManagement.h b/src/kaleidoscope/plugin/HostPowerManagement.h similarity index 84% rename from src/Kaleidoscope/HostPowerManagement.h rename to src/kaleidoscope/plugin/HostPowerManagement.h index 61b8716b..2dbb36f7 100644 --- a/src/Kaleidoscope/HostPowerManagement.h +++ b/src/kaleidoscope/plugin/HostPowerManagement.h @@ -26,6 +26,7 @@ "removed." namespace kaleidoscope { +namespace plugin { class HostPowerManagement : public kaleidoscope::Plugin { public: typedef enum { @@ -46,6 +47,11 @@ class HostPowerManagement : public kaleidoscope::Plugin { }; } -void hostPowerManagementEventHandler(kaleidoscope::HostPowerManagement::Event event); +// Backwards compatibility +typedef plugin::HostPowerManagement HostPowerManagement; -extern kaleidoscope::HostPowerManagement HostPowerManagement; +} + +void hostPowerManagementEventHandler(kaleidoscope::plugin::HostPowerManagement::Event event); + +extern kaleidoscope::plugin::HostPowerManagement HostPowerManagement; From 5cc3ee749ef615684afc1ae2266d3a11e0efbcc1 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 13 Oct 2018 12:39:04 +0200 Subject: [PATCH 20/21] 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 3e1f64d2..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 09498c2f..00000000 --- a/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# Kaleidoscope-HostPowerManagement - -[![Build Status][travis:image]][travis:status] - - [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-HostPowerManagement.svg?branch=master - [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-HostPowerManagement - -See [doc/plugin/HostPowerManagement.md](doc/plugin/HostPowerManagement.md) for documentation. diff --git a/library.properties b/library.properties deleted file mode 100644 index db622f9d..00000000 --- a/library.properties +++ /dev/null @@ -1,10 +0,0 @@ -name=Kaleidoscope-HostPowerManagement -version=0.0.0 -author=Gergely Nagy -maintainer=Gergely Nagy -sentence=Host power management support library for Kaleidoscope. -paragraph=Hooks to support host suspend & resume, and the ability to wake the host from the keyboard. -category=Communication -url=https://github.com/keyboardio/Kaleidoscope-HostPowerManagement -architectures=avr -dot_a_linkage=true From d21744e637d6f719c46ed7ea5a0d8b3e09ccaa04 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 14 Oct 2018 18:02:13 +0200 Subject: [PATCH 21/21] 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/HostPowerManagement.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/plugin/HostPowerManagement.md b/doc/plugin/HostPowerManagement.md index 0a5268cc..bd9973f3 100644 --- a/doc/plugin/HostPowerManagement.md +++ b/doc/plugin/HostPowerManagement.md @@ -44,4 +44,4 @@ The plugin provides the `HostPowerManagement` object, with no public methods. Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/keyboardio/Kaleidoscope-HostPowerManagement/blob/master/examples/HostPowerManagement/HostPowerManagement.ino + [plugin:example]: ../../examples/HostPowerManagement/HostPowerManagement.ino