From 51756fa4d6cdc2cb3a3069b463bb66e05286c7d6 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 16 Jan 2017 15:18:13 +0100 Subject: [PATCH 01/44] Initial import Lifted out of the monolithic Akela library. Signed-off-by: Gergely Nagy --- .gitignore | 2 + COPYING | 674 +++++++++++++++++++++++++++++++++++ README.md | 66 ++++ examples/HostOS/HostOS.ino | 54 +++ library.properties | 10 + src/Akela-HostOS.h | 29 ++ src/Akela/HostOS-Guesser.cpp | 52 +++ src/Akela/HostOS-Guesser.h | 33 ++ src/Akela/HostOS-Tracker.cpp | 21 ++ src/Akela/HostOS-Tracker.h | 33 ++ src/Akela/HostOS.cpp | 58 +++ src/Akela/HostOS.h | 49 +++ 12 files changed, 1081 insertions(+) create mode 100644 .gitignore create mode 100644 COPYING create mode 100644 README.md create mode 100644 examples/HostOS/HostOS.ino create mode 100644 library.properties create mode 100644 src/Akela-HostOS.h create mode 100644 src/Akela/HostOS-Guesser.cpp create mode 100644 src/Akela/HostOS-Guesser.h create mode 100644 src/Akela/HostOS-Tracker.cpp create mode 100644 src/Akela/HostOS-Tracker.h create mode 100644 src/Akela/HostOS.cpp create mode 100644 src/Akela/HostOS.h diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..aead9485 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.#* +*~ diff --git a/COPYING b/COPYING new file mode 100644 index 00000000..94a9ed02 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 00000000..0d35a103 --- /dev/null +++ b/README.md @@ -0,0 +1,66 @@ +# Akela-HostOS + +The `HostOS` extension is not all that useful in itself, rather, it is a +building block other plugins and extensions can use to not repeat the same +guesswork and logic. Its primary purpose is to help either detect, or keep track +of the host operating system. The detection part is not the most reliable thing, +mind you. + +The goal is to have a single place that remembers the host OS, either detected, +or set by the end-user, in a Sketch, or via a macro, or some other way. This +information can then be reused by other plugins. + +See the [Unicode][plugin:unicode] extension for an example about how to use +`HostOS` in practice. + + [plugin:unicode]: https://github.com/Akela-Plugins/Akela-Unicode + +## Using the extension + +The extension provides a `HostOS` singleton object. It can either be a simple +one without auto-detection (the default), or one that will try to detect the +Host OS, using the [FingerprintUSBHost][fprdetect] library. To enable +auto-detection, `AKELA_HOSTOS_GUESSER` must be defined before including the +`HostOS` library header. + + [fprdetect]: https://github.com/keyboardio/FingerprintUSBHost + +```c++ +#define AKELA_HOSTOS_GUESSER 1 + +#include + +void someFunction (void) { + if (HostOS.os() == Akela::HostOS::LINUX) { + // do something linux-y + } + if (HostOS.os() == Akela::HostOS::OSX) { + // do something OSX-y + } +} + +void setup (void) { + Keyboardio.setup (KEYMAP_SIZE); + Keyboardio.use (&HostOS); +} +``` + +## Extension methods + +The extension provides the following methods on the `HostOS` singleton: + +### `.os()` + +> Returns the stored type of the Host OS. + +### `.os(type)` + +> Sets the type of the host OS, overriding any previous value. The type is then +> stored in EEPROM for persistence. + +## Further reading + +Starting from the [example][plugin:example] is the recommended way of getting +started with the extension. + + [plugin:example]: https://github.com/Akela-Plugins/Akela-HostOS/blob/master/examples/HostOS/HostOS.ino diff --git a/examples/HostOS/HostOS.ino b/examples/HostOS/HostOS.ino new file mode 100644 index 00000000..c6490d6d --- /dev/null +++ b/examples/HostOS/HostOS.ino @@ -0,0 +1,54 @@ +/* -*- mode: c++ -*- + * Akela -- Animated Keyboardio Extension Library for Anything + * Copyright (C) 2016, 2017 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#include + +const Key keymaps[][ROWS][COLS] PROGMEM = { + [0] = KEYMAP_STACKED + ( + Key_LEDEffectNext, Key_1, Key_2, Key_3, Key_4, Key_5, Key_LEDEffectNext, + Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, + Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, + Key_PageDn, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Esc, + + Key_LCtrl, Key_Backspace, Key_LGUI, Key_LShift, + Key_skip, + + Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, + Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, + + Key_RShift, Key_RAlt, Key_Space, Key_RCtrl, + Key_skip + ), +}; + +void setup () { + Serial.begin (9600); + + Keyboardio.setup (KEYMAP_SIZE); + Keyboardio.use (&HostOS, NULL); + + Serial.print ("Host OS id is: "); + Serial.println (HostOS.os (), DEC); +} + +void loop () { + Keyboardio.loop (); +} diff --git a/library.properties b/library.properties new file mode 100644 index 00000000..07347e95 --- /dev/null +++ b/library.properties @@ -0,0 +1,10 @@ +name=Akela-HostOS +version=0.0.0 +author=Gergely Nagy +maintainer=Gergely Nagy +sentence=Host OS detection and tracking for Keyboardio boards. +paragraph=Provides functions to help guessing and/or tracking the host OS. +category=Communication +url=https://github.com/Akela-Plugins/Akela-HostOS +architectures=avr +dot_a_linkage=true diff --git a/src/Akela-HostOS.h b/src/Akela-HostOS.h new file mode 100644 index 00000000..d0b545e4 --- /dev/null +++ b/src/Akela-HostOS.h @@ -0,0 +1,29 @@ +/* -*- mode: c++ -*- + * Akela -- Animated Keyboardio Extension Library for Anything + * Copyright (C) 2016, 2017 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#pragma once + +#include +#include +#include + +#ifdef AKELA_HOSTOS_GUESSER +extern Akela::HostOS::Guesser HostOS; +#else +extern Akela::HostOS::Tracker HostOS; +#endif diff --git a/src/Akela/HostOS-Guesser.cpp b/src/Akela/HostOS-Guesser.cpp new file mode 100644 index 00000000..599d35e1 --- /dev/null +++ b/src/Akela/HostOS-Guesser.cpp @@ -0,0 +1,52 @@ +/* -*- mode: c++ -*- + * Akela -- Animated Keyboardio Extension Library for Anything + * Copyright (C) 2016, 2017 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#include + +#include + +namespace Akela { + namespace HostOS { + Guesser::Guesser (void) { + } + + void + Guesser::autoDetect (void) { + Serial.begin (9600); + + delay (15000); + + switch (FingerprintUSBHost.guessHostOS ()) { + case GuessedHost::WINDOWS: + osType = WINDOWS; + break; + case GuessedHost::LINUX: + osType = LINUX; + break; + case GuessedHost::MACOS: + osType = OSX; + break; + default: + osType = OTHER; + break; + } + } + }; +}; + +Akela::HostOS::Guesser HostOS; diff --git a/src/Akela/HostOS-Guesser.h b/src/Akela/HostOS-Guesser.h new file mode 100644 index 00000000..4ff01abd --- /dev/null +++ b/src/Akela/HostOS-Guesser.h @@ -0,0 +1,33 @@ +/* -*- mode: c++ -*- + * Akela -- Animated Keyboardio Extension Library for Anything + * Copyright (C) 2016, 2017 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#pragma once + +#include + +namespace Akela { + namespace HostOS { + class Guesser : public Base { + public: + Guesser (void); + + protected: + virtual void autoDetect (void) final; + }; + } +}; diff --git a/src/Akela/HostOS-Tracker.cpp b/src/Akela/HostOS-Tracker.cpp new file mode 100644 index 00000000..2089b87e --- /dev/null +++ b/src/Akela/HostOS-Tracker.cpp @@ -0,0 +1,21 @@ +/* -*- mode: c++ -*- + * Akela -- Animated Keyboardio Extension Library for Anything + * Copyright (C) 2016, 2017 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#include + +Akela::HostOS::Tracker HostOS; diff --git a/src/Akela/HostOS-Tracker.h b/src/Akela/HostOS-Tracker.h new file mode 100644 index 00000000..2ce095e7 --- /dev/null +++ b/src/Akela/HostOS-Tracker.h @@ -0,0 +1,33 @@ +/* -*- mode: c++ -*- + * Akela -- Animated Keyboardio Extension Library for Anything + * Copyright (C) 2016, 2017 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#pragma once + +#include + +namespace Akela { + namespace HostOS { + class Tracker : public Base { + public: + Tracker (void) {}; + + protected: + virtual void autoDetect (void) final {}; + }; + }; +}; diff --git a/src/Akela/HostOS.cpp b/src/Akela/HostOS.cpp new file mode 100644 index 00000000..32970a32 --- /dev/null +++ b/src/Akela/HostOS.cpp @@ -0,0 +1,58 @@ +/* -*- mode: c++ -*- + * Akela -- Animated Keyboardio Extension Library for Anything + * Copyright (C) 2016, 2017 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#include + +#include + +#define EEPROM_HOSTOS_TYPE_LOCATION 2 + +namespace Akela { + namespace HostOS { + void + Base::begin (void) { + if (isConfigured) + return; + + isConfigured = true; + + if (osType != AUTO) { + return; + } + + if ((osType = (Type)EEPROM.read (EEPROM_HOSTOS_TYPE_LOCATION)) != AUTO) + return; + + autoDetect (); + } + + HostOS::Type + Base::os (void) { + if (osType == AUTO) + autoDetect (); + + return osType; + } + + void + Base::os (HostOS::Type osType_) { + osType = osType_; + EEPROM.update (EEPROM_HOSTOS_TYPE_LOCATION, osType); + } + }; +}; diff --git a/src/Akela/HostOS.h b/src/Akela/HostOS.h new file mode 100644 index 00000000..80bcd2b6 --- /dev/null +++ b/src/Akela/HostOS.h @@ -0,0 +1,49 @@ +/* -*- mode: c++ -*- + * Akela -- Animated Keyboardio Extension Library for Anything + * Copyright (C) 2016, 2017 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#pragma once + +#include + +namespace Akela { + namespace HostOS { + typedef enum { + LINUX, + OSX, + WINDOWS, + OTHER, + + AUTO = 0xff, + } Type; + + class Base : public KeyboardioPlugin { + public: + virtual void begin (void) final; + + Type os (void); + void os (Type osType); + + protected: + virtual void autoDetect (void) = 0; + Type osType; + + private: + bool isConfigured = false; + }; + }; +}; From 2c0f42f838fd0ce02719011a411443d84943a16b Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 16 Jan 2017 17:16:49 +0100 Subject: [PATCH 02/44] Add a status icon. Signed-off-by: Gergely Nagy --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 0d35a103..723d03a6 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # Akela-HostOS +![status][st:stable] + + [st:stable]: https://img.shields.io/badge/stable-✔-black.png?style=flat&colorA=44cc11&colorB=494e52 + [st:broken]: https://img.shields.io/badge/broken-X-black.png?style=flat&colorA=e05d44&colorB=494e52 + [st:experimental]: https://img.shields.io/badge/experimental----black.png?style=flat&colorA=dfb317&colorB=494e52 + The `HostOS` extension is not all that useful in itself, rather, it is a building block other plugins and extensions can use to not repeat the same guesswork and logic. Its primary purpose is to help either detect, or keep track From 94b553a2f24faef8c34e422d3f4aa9382985ed5c Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 17 Jan 2017 10:15:07 +0100 Subject: [PATCH 03/44] Move from Akela-Plugins to keyboardio Signed-off-by: Gergely Nagy --- README.md | 4 ++-- library.properties | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 723d03a6..93a1fdb7 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ information can then be reused by other plugins. See the [Unicode][plugin:unicode] extension for an example about how to use `HostOS` in practice. - [plugin:unicode]: https://github.com/Akela-Plugins/Akela-Unicode + [plugin:unicode]: https://github.com/keyboardio/Akela-Unicode ## Using the extension @@ -69,4 +69,4 @@ The extension provides the following methods on the `HostOS` singleton: Starting from the [example][plugin:example] is the recommended way of getting started with the extension. - [plugin:example]: https://github.com/Akela-Plugins/Akela-HostOS/blob/master/examples/HostOS/HostOS.ino + [plugin:example]: https://github.com/keyboardio/Akela-HostOS/blob/master/examples/HostOS/HostOS.ino diff --git a/library.properties b/library.properties index 07347e95..87709782 100644 --- a/library.properties +++ b/library.properties @@ -5,6 +5,6 @@ maintainer=Gergely Nagy sentence=Host OS detection and tracking for Keyboardio boards. paragraph=Provides functions to help guessing and/or tracking the host OS. category=Communication -url=https://github.com/Akela-Plugins/Akela-HostOS +url=https://github.com/keyboardio/Akela-HostOS architectures=avr dot_a_linkage=true From d1b6e77504cd772270d2459188b1d8f8e2e61ea6 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 27 Jan 2017 09:28:32 +0100 Subject: [PATCH 04/44] Do not use Key_LEDEffectNext Signed-off-by: Gergely Nagy --- examples/HostOS/HostOS.ino | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/examples/HostOS/HostOS.ino b/examples/HostOS/HostOS.ino index c6490d6d..9262c2f7 100644 --- a/examples/HostOS/HostOS.ino +++ b/examples/HostOS/HostOS.ino @@ -21,10 +21,10 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED ( - Key_LEDEffectNext, Key_1, Key_2, Key_3, Key_4, Key_5, Key_LEDEffectNext, - Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, - Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, - Key_PageDn, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Esc, + Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, + Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, + Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, + Key_PageDn, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Esc, Key_LCtrl, Key_Backspace, Key_LGUI, Key_LShift, Key_skip, From d2d0193129617f5517268b4d025f62a2368f9733 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 11 Feb 2017 22:59:50 +0100 Subject: [PATCH 05/44] The Big Rename Renamed the library to Kaleidoscope-HostOS, and followed up with other renames. Signed-off-by: Gergely Nagy --- README.md | 23 ++++++++++--------- examples/HostOS/HostOS.ino | 10 ++++---- library.properties | 8 +++---- src/{Akela-HostOS.h => Kaleidoscope-HostOS.h} | 14 +++++------ .../HostOS-Guesser.cpp | 8 +++---- src/{Akela => Kaleidoscope}/HostOS-Guesser.h | 6 ++--- .../HostOS-Tracker.cpp | 6 ++--- src/{Akela => Kaleidoscope}/HostOS-Tracker.h | 6 ++--- src/{Akela => Kaleidoscope}/HostOS.cpp | 6 ++--- src/{Akela => Kaleidoscope}/HostOS.h | 8 +++---- 10 files changed, 48 insertions(+), 47 deletions(-) rename src/{Akela-HostOS.h => Kaleidoscope-HostOS.h} (69%) rename src/{Akela => Kaleidoscope}/HostOS-Guesser.cpp (86%) rename src/{Akela => Kaleidoscope}/HostOS-Guesser.h (86%) rename src/{Akela => Kaleidoscope}/HostOS-Tracker.cpp (81%) rename src/{Akela => Kaleidoscope}/HostOS-Tracker.h (86%) rename src/{Akela => Kaleidoscope}/HostOS.cpp (90%) rename src/{Akela => Kaleidoscope}/HostOS.h (86%) diff --git a/README.md b/README.md index 93a1fdb7..2e8241cd 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Akela-HostOS +# Kaleidoscope-HostOS ![status][st:stable] @@ -19,35 +19,36 @@ information can then be reused by other plugins. See the [Unicode][plugin:unicode] extension for an example about how to use `HostOS` in practice. - [plugin:unicode]: https://github.com/keyboardio/Akela-Unicode + [plugin:unicode]: https://github.com/keyboardio/Kaleidoscope-Unicode ## Using the extension The extension provides a `HostOS` singleton object. It can either be a simple one without auto-detection (the default), or one that will try to detect the Host OS, using the [FingerprintUSBHost][fprdetect] library. To enable -auto-detection, `AKELA_HOSTOS_GUESSER` must be defined before including the -`HostOS` library header. +auto-detection, `KALEIDOSCOPE_HOSTOS_GUESSER` must be defined before including +the `HostOS` library header. [fprdetect]: https://github.com/keyboardio/FingerprintUSBHost ```c++ -#define AKELA_HOSTOS_GUESSER 1 +#define KALEIDOSCOPE_HOSTOS_GUESSER 1 -#include +#include +#include void someFunction (void) { - if (HostOS.os() == Akela::HostOS::LINUX) { + if (HostOS.os() == Kaleidoscope::HostOS::LINUX) { // do something linux-y } - if (HostOS.os() == Akela::HostOS::OSX) { + if (HostOS.os() == Kaleidoscope::HostOS::OSX) { // do something OSX-y } } void setup (void) { - Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&HostOS); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&HostOS); } ``` @@ -69,4 +70,4 @@ The extension provides the following methods on the `HostOS` singleton: Starting from the [example][plugin:example] is the recommended way of getting started with the extension. - [plugin:example]: https://github.com/keyboardio/Akela-HostOS/blob/master/examples/HostOS/HostOS.ino + [plugin:example]: https://github.com/keyboardio/Kaleidoscope-HostOS/blob/master/examples/HostOS/HostOS.ino diff --git a/examples/HostOS/HostOS.ino b/examples/HostOS/HostOS.ino index 9262c2f7..f49471f0 100644 --- a/examples/HostOS/HostOS.ino +++ b/examples/HostOS/HostOS.ino @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,7 +16,7 @@ * along with this program. If not, see . */ -#include +#include const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED @@ -42,13 +42,13 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { void setup () { Serial.begin (9600); - Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&HostOS, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&HostOS, NULL); Serial.print ("Host OS id is: "); Serial.println (HostOS.os (), DEC); } void loop () { - Keyboardio.loop (); + Kaleidoscope.loop (); } diff --git a/library.properties b/library.properties index 87709782..3f04b3fe 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ -name=Akela-HostOS +name=Kaleidoscope-HostOS version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy -sentence=Host OS detection and tracking for Keyboardio boards. +maintainer=Gergely Nagy +sentence=Host OS detection and tracking for Kaleidoscope. paragraph=Provides functions to help guessing and/or tracking the host OS. category=Communication -url=https://github.com/keyboardio/Akela-HostOS +url=https://github.com/keyboardio/Kaleidoscope-HostOS architectures=avr dot_a_linkage=true diff --git a/src/Akela-HostOS.h b/src/Kaleidoscope-HostOS.h similarity index 69% rename from src/Akela-HostOS.h rename to src/Kaleidoscope-HostOS.h index d0b545e4..e7c8cb06 100644 --- a/src/Akela-HostOS.h +++ b/src/Kaleidoscope-HostOS.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -18,12 +18,12 @@ #pragma once -#include -#include -#include +#include +#include +#include -#ifdef AKELA_HOSTOS_GUESSER -extern Akela::HostOS::Guesser HostOS; +#ifdef KALEIDOSCOPE_HOSTOS_GUESSER +extern KaleidoscopePlugins::HostOS::Guesser HostOS; #else -extern Akela::HostOS::Tracker HostOS; +extern KaleidoscopePlugins::HostOS::Tracker HostOS; #endif diff --git a/src/Akela/HostOS-Guesser.cpp b/src/Kaleidoscope/HostOS-Guesser.cpp similarity index 86% rename from src/Akela/HostOS-Guesser.cpp rename to src/Kaleidoscope/HostOS-Guesser.cpp index 599d35e1..dc2dd196 100644 --- a/src/Akela/HostOS-Guesser.cpp +++ b/src/Kaleidoscope/HostOS-Guesser.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,11 +16,11 @@ * along with this program. If not, see . */ -#include +#include #include -namespace Akela { +namespace KaleidoscopePlugins { namespace HostOS { Guesser::Guesser (void) { } @@ -49,4 +49,4 @@ namespace Akela { }; }; -Akela::HostOS::Guesser HostOS; +KaleidoscopePlugins::HostOS::Guesser HostOS; diff --git a/src/Akela/HostOS-Guesser.h b/src/Kaleidoscope/HostOS-Guesser.h similarity index 86% rename from src/Akela/HostOS-Guesser.h rename to src/Kaleidoscope/HostOS-Guesser.h index 4ff01abd..6b634bc0 100644 --- a/src/Akela/HostOS-Guesser.h +++ b/src/Kaleidoscope/HostOS-Guesser.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -18,9 +18,9 @@ #pragma once -#include +#include -namespace Akela { +namespace KaleidoscopePlugins { namespace HostOS { class Guesser : public Base { public: diff --git a/src/Akela/HostOS-Tracker.cpp b/src/Kaleidoscope/HostOS-Tracker.cpp similarity index 81% rename from src/Akela/HostOS-Tracker.cpp rename to src/Kaleidoscope/HostOS-Tracker.cpp index 2089b87e..5c2007c1 100644 --- a/src/Akela/HostOS-Tracker.cpp +++ b/src/Kaleidoscope/HostOS-Tracker.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,6 +16,6 @@ * along with this program. If not, see . */ -#include +#include -Akela::HostOS::Tracker HostOS; +KaleidoscopePlugins::HostOS::Tracker HostOS; diff --git a/src/Akela/HostOS-Tracker.h b/src/Kaleidoscope/HostOS-Tracker.h similarity index 86% rename from src/Akela/HostOS-Tracker.h rename to src/Kaleidoscope/HostOS-Tracker.h index 2ce095e7..090908d3 100644 --- a/src/Akela/HostOS-Tracker.h +++ b/src/Kaleidoscope/HostOS-Tracker.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -18,9 +18,9 @@ #pragma once -#include +#include -namespace Akela { +namespace KaleidoscopePlugins { namespace HostOS { class Tracker : public Base { public: diff --git a/src/Akela/HostOS.cpp b/src/Kaleidoscope/HostOS.cpp similarity index 90% rename from src/Akela/HostOS.cpp rename to src/Kaleidoscope/HostOS.cpp index 32970a32..b68366df 100644 --- a/src/Akela/HostOS.cpp +++ b/src/Kaleidoscope/HostOS.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,13 +16,13 @@ * along with this program. If not, see . */ -#include +#include #include #define EEPROM_HOSTOS_TYPE_LOCATION 2 -namespace Akela { +namespace KaleidoscopePlugins { namespace HostOS { void Base::begin (void) { diff --git a/src/Akela/HostOS.h b/src/Kaleidoscope/HostOS.h similarity index 86% rename from src/Akela/HostOS.h rename to src/Kaleidoscope/HostOS.h index 80bcd2b6..9ebb8c82 100644 --- a/src/Akela/HostOS.h +++ b/src/Kaleidoscope/HostOS.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -18,9 +18,9 @@ #pragma once -#include +#include -namespace Akela { +namespace KaleidoscopePlugins { namespace HostOS { typedef enum { LINUX, @@ -31,7 +31,7 @@ namespace Akela { AUTO = 0xff, } Type; - class Base : public KeyboardioPlugin { + class Base : public KaleidoscopePlugin { public: virtual void begin (void) final; From b488434d4aea1ed78354ed6a55608e9b15cb2f3a Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Feb 2017 11:27:45 +0100 Subject: [PATCH 06/44] Test the plugin with Travis CI Signed-off-by: Gergely Nagy --- .gitignore | 2 ++ .travis.yml | 18 ++++++++++++++++++ README.md | 5 ++++- 3 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 .travis.yml diff --git a/.gitignore b/.gitignore index aead9485..be16c9be 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,4 @@ .#* *~ +/hardware/ +/output/ \ No newline at end of file diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 00000000..77431b24 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,18 @@ +language: cpp +dist: trusty +sudo: required +os: + - linux +before_install: + - pushd .. + - wget http://downloads.arduino.cc/arduino-1.6.11-linux64.tar.xz + - tar xf arduino-1.6.11-linux64.tar.xz + - popd +install: + - git clone --recurse-submodules https://github.com/keyboardio/Arduino-Boards hardware/keyboardio/avr +script: + - export DEFAULT_SKETCH=$(cd examples; basename *) + - export ARDUINO_PATH=$(pwd)/../arduino-1.6.11 + - export BOARD_HARDWARE_PATH=$(pwd)/hardware + - export EXTRA_BUILDER_ARGS="-libraries ." + - hardware/keyboardio/avr/libraries/Kaleidoscope/tools/kaleidoscope-builder build diff --git a/README.md b/README.md index 2e8241cd..4968f3f5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # Kaleidoscope-HostOS -![status][st:stable] +![status][st:stable] [![Build Status][travis:image]][travis:status] + + [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-HostOS.svg?branch=master + [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-HostOS [st:stable]: https://img.shields.io/badge/stable-✔-black.png?style=flat&colorA=44cc11&colorB=494e52 [st:broken]: https://img.shields.io/badge/broken-X-black.png?style=flat&colorA=e05d44&colorB=494e52 From baa8252e6723cfeb6d516cb2510254203a58eeb2 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 28 Feb 2017 22:30:23 +0100 Subject: [PATCH 07/44] Mark the plugin broken for now Due to fiddling with EEPROM, and the Guesser/Tracker selection not working, the whole plugin will need to be rethought. Signed-off-by: Gergely Nagy --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4968f3f5..fb1d1d90 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Kaleidoscope-HostOS -![status][st:stable] [![Build Status][travis:image]][travis:status] +![status][st:broken] [![Build Status][travis:image]][travis:status] [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-HostOS.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-HostOS From 0f6f095be207106a50d759ea3322838ccd32eab7 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 15 Mar 2017 10:37:54 +0100 Subject: [PATCH 08/44] Use the EEPROM-Settings plugin Use the EEPROM-Settings plugin to figure out where to store the EEPROM settings. Fixes #2. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/HostOS.cpp | 9 +++++---- src/Kaleidoscope/HostOS.h | 1 + 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/src/Kaleidoscope/HostOS.cpp b/src/Kaleidoscope/HostOS.cpp index b68366df..eca19df1 100644 --- a/src/Kaleidoscope/HostOS.cpp +++ b/src/Kaleidoscope/HostOS.cpp @@ -17,11 +17,10 @@ */ #include +#include #include -#define EEPROM_HOSTOS_TYPE_LOCATION 2 - namespace KaleidoscopePlugins { namespace HostOS { void @@ -29,13 +28,15 @@ namespace KaleidoscopePlugins { if (isConfigured) return; + eepromSlice = ::EEPROMSettings.requestSlice (sizeof (osType)); + isConfigured = true; if (osType != AUTO) { return; } - if ((osType = (Type)EEPROM.read (EEPROM_HOSTOS_TYPE_LOCATION)) != AUTO) + if ((osType = (Type)EEPROM.read (eepromSlice)) != AUTO) return; autoDetect (); @@ -52,7 +53,7 @@ namespace KaleidoscopePlugins { void Base::os (HostOS::Type osType_) { osType = osType_; - EEPROM.update (EEPROM_HOSTOS_TYPE_LOCATION, osType); + EEPROM.update (eepromSlice, osType); } }; }; diff --git a/src/Kaleidoscope/HostOS.h b/src/Kaleidoscope/HostOS.h index 9ebb8c82..1ac9e721 100644 --- a/src/Kaleidoscope/HostOS.h +++ b/src/Kaleidoscope/HostOS.h @@ -43,6 +43,7 @@ namespace KaleidoscopePlugins { Type osType; private: + uint16_t eepromSlice; bool isConfigured = false; }; }; From 6230a331c4dde940c20c123453204f67654081f3 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 15 Mar 2017 15:35:40 +0100 Subject: [PATCH 09/44] Make it possible again to choose between variants Fixes #1. Signed-off-by: Gergely Nagy --- README.md | 4 ++++ examples/HostOS/HostOS.ino | 1 + src/Kaleidoscope-HostOS.h | 9 ++------ .../{HostOS.cpp => HostOS-Base.cpp} | 2 +- src/Kaleidoscope/{HostOS.h => HostOS-Base.h} | 2 +- src/Kaleidoscope/HostOS-Guesser.cpp | 2 -- src/Kaleidoscope/HostOS-Guesser.h | 2 +- src/Kaleidoscope/HostOS-Tracker.cpp | 21 ------------------- .../{HostOS-Tracker.h => HostOS-select.h} | 19 +++++++---------- 9 files changed, 17 insertions(+), 45 deletions(-) rename src/Kaleidoscope/{HostOS.cpp => HostOS-Base.cpp} (97%) rename src/Kaleidoscope/{HostOS.h => HostOS-Base.h} (96%) delete mode 100644 src/Kaleidoscope/HostOS-Tracker.cpp rename src/Kaleidoscope/{HostOS-Tracker.h => HostOS-select.h} (76%) diff --git a/README.md b/README.md index fb1d1d90..f1238be4 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,7 @@ the `HostOS` library header. #include #include +#include void someFunction (void) { if (HostOS.os() == Kaleidoscope::HostOS::LINUX) { @@ -55,6 +56,9 @@ void setup (void) { } ``` +To be able to choose between the two variants, one must also include the +`Kaleidoscope/HostOS-select.h` header. + ## Extension methods The extension provides the following methods on the `HostOS` singleton: diff --git a/examples/HostOS/HostOS.ino b/examples/HostOS/HostOS.ino index f49471f0..40fa0530 100644 --- a/examples/HostOS/HostOS.ino +++ b/examples/HostOS/HostOS.ino @@ -17,6 +17,7 @@ */ #include +#include const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED diff --git a/src/Kaleidoscope-HostOS.h b/src/Kaleidoscope-HostOS.h index e7c8cb06..3c0126a1 100644 --- a/src/Kaleidoscope-HostOS.h +++ b/src/Kaleidoscope-HostOS.h @@ -18,12 +18,7 @@ #pragma once -#include -#include +#include #include -#ifdef KALEIDOSCOPE_HOSTOS_GUESSER -extern KaleidoscopePlugins::HostOS::Guesser HostOS; -#else -extern KaleidoscopePlugins::HostOS::Tracker HostOS; -#endif +extern KaleidoscopePlugins::HostOS::Base HostOS; diff --git a/src/Kaleidoscope/HostOS.cpp b/src/Kaleidoscope/HostOS-Base.cpp similarity index 97% rename from src/Kaleidoscope/HostOS.cpp rename to src/Kaleidoscope/HostOS-Base.cpp index eca19df1..67980733 100644 --- a/src/Kaleidoscope/HostOS.cpp +++ b/src/Kaleidoscope/HostOS-Base.cpp @@ -16,7 +16,7 @@ * along with this program. If not, see . */ -#include +#include #include #include diff --git a/src/Kaleidoscope/HostOS.h b/src/Kaleidoscope/HostOS-Base.h similarity index 96% rename from src/Kaleidoscope/HostOS.h rename to src/Kaleidoscope/HostOS-Base.h index 1ac9e721..20de6012 100644 --- a/src/Kaleidoscope/HostOS.h +++ b/src/Kaleidoscope/HostOS-Base.h @@ -39,7 +39,7 @@ namespace KaleidoscopePlugins { void os (Type osType); protected: - virtual void autoDetect (void) = 0; + virtual void autoDetect (void) {}; Type osType; private: diff --git a/src/Kaleidoscope/HostOS-Guesser.cpp b/src/Kaleidoscope/HostOS-Guesser.cpp index dc2dd196..f9c01184 100644 --- a/src/Kaleidoscope/HostOS-Guesser.cpp +++ b/src/Kaleidoscope/HostOS-Guesser.cpp @@ -48,5 +48,3 @@ namespace KaleidoscopePlugins { } }; }; - -KaleidoscopePlugins::HostOS::Guesser HostOS; diff --git a/src/Kaleidoscope/HostOS-Guesser.h b/src/Kaleidoscope/HostOS-Guesser.h index 6b634bc0..c529024a 100644 --- a/src/Kaleidoscope/HostOS-Guesser.h +++ b/src/Kaleidoscope/HostOS-Guesser.h @@ -18,7 +18,7 @@ #pragma once -#include +#include namespace KaleidoscopePlugins { namespace HostOS { diff --git a/src/Kaleidoscope/HostOS-Tracker.cpp b/src/Kaleidoscope/HostOS-Tracker.cpp deleted file mode 100644 index 5c2007c1..00000000 --- a/src/Kaleidoscope/HostOS-Tracker.cpp +++ /dev/null @@ -1,21 +0,0 @@ -/* -*- mode: c++ -*- - * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope - * Copyright (C) 2016, 2017 Gergely Nagy - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This program is 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 - -KaleidoscopePlugins::HostOS::Tracker HostOS; diff --git a/src/Kaleidoscope/HostOS-Tracker.h b/src/Kaleidoscope/HostOS-select.h similarity index 76% rename from src/Kaleidoscope/HostOS-Tracker.h rename to src/Kaleidoscope/HostOS-select.h index 090908d3..a80de9c0 100644 --- a/src/Kaleidoscope/HostOS-Tracker.h +++ b/src/Kaleidoscope/HostOS-select.h @@ -18,16 +18,11 @@ #pragma once -#include +#include +#include -namespace KaleidoscopePlugins { - namespace HostOS { - class Tracker : public Base { - public: - Tracker (void) {}; - - protected: - virtual void autoDetect (void) final {}; - }; - }; -}; +#if KALEIDOSCOPE_HOSTOS_GUESSER +KaleidoscopePlugins::HostOS::Base HostOS = KaleidoscopePlugins::HostOS::Guesser(); +#else +KaleidoscopePlugins::HostOS::Base HostOS; +#endif From 332e5152ff8bb1f076c88e1aeaadf988f786973d Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 15 Mar 2017 15:36:14 +0100 Subject: [PATCH 10/44] Mark the plugin stable again With the recent fixes, the plugin can be considered stable again. Signed-off-by: Gergely Nagy --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f1238be4..abd1b53f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Kaleidoscope-HostOS -![status][st:broken] [![Build Status][travis:image]][travis:status] +![status][st:stable] [![Build Status][travis:image]][travis:status] [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-HostOS.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-HostOS From fa01f2acb1d6d48b55c2a2029cd2ddbfdaa1cb0d Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 15 Mar 2017 15:59:27 +0100 Subject: [PATCH 11/44] Move the extern to HostOS-Base.h Signed-off-by: Gergely Nagy --- src/Kaleidoscope-HostOS.h | 2 -- src/Kaleidoscope/HostOS-Base.h | 2 ++ 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Kaleidoscope-HostOS.h b/src/Kaleidoscope-HostOS.h index 3c0126a1..f3295a91 100644 --- a/src/Kaleidoscope-HostOS.h +++ b/src/Kaleidoscope-HostOS.h @@ -20,5 +20,3 @@ #include #include - -extern KaleidoscopePlugins::HostOS::Base HostOS; diff --git a/src/Kaleidoscope/HostOS-Base.h b/src/Kaleidoscope/HostOS-Base.h index 20de6012..6ef48216 100644 --- a/src/Kaleidoscope/HostOS-Base.h +++ b/src/Kaleidoscope/HostOS-Base.h @@ -48,3 +48,5 @@ namespace KaleidoscopePlugins { }; }; }; + +extern KaleidoscopePlugins::HostOS::Base HostOS; From d9da70c2f455a92cb5fa016766ece7f93d33b261 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 15 Mar 2017 15:59:59 +0100 Subject: [PATCH 12/44] Add Focus support helpers Signed-off-by: Gergely Nagy --- src/Kaleidoscope-HostOS.h | 1 + src/Kaleidoscope/HostOS-Focus.cpp | 54 +++++++++++++++++++++++++++++++ src/Kaleidoscope/HostOS-Focus.h | 36 +++++++++++++++++++++ 3 files changed, 91 insertions(+) create mode 100644 src/Kaleidoscope/HostOS-Focus.cpp create mode 100644 src/Kaleidoscope/HostOS-Focus.h diff --git a/src/Kaleidoscope-HostOS.h b/src/Kaleidoscope-HostOS.h index f3295a91..c3f9fd96 100644 --- a/src/Kaleidoscope-HostOS.h +++ b/src/Kaleidoscope-HostOS.h @@ -20,3 +20,4 @@ #include #include +#include diff --git a/src/Kaleidoscope/HostOS-Focus.cpp b/src/Kaleidoscope/HostOS-Focus.cpp new file mode 100644 index 00000000..fe5b45b3 --- /dev/null +++ b/src/Kaleidoscope/HostOS-Focus.cpp @@ -0,0 +1,54 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope + * Copyright (C) 2016, 2017 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is 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 + +namespace KaleidoscopePlugins { + namespace HostOS { + bool + Focus (const char *command) { + enum { + GET, + SET, + } subCommand; + + if (strncmp_P (command, PSTR ("hostos."), 7) != 0) + return false; + if (strcmp_P (command + 7, PSTR ("type")) == 0) + subCommand = GET; + else if (strcmp_P (command + 7, PSTR ("set")) == 0) + subCommand = SET; + else + return false; + + switch (subCommand) { + case GET: + Serial.println (::HostOS.os ()); + break; + case SET: + uint8_t os = Serial.parseInt (); + ::HostOS.os ((KaleidoscopePlugins::HostOS::Type) os); + break; + } + + Serial.read (); + return true; + } + } +} diff --git a/src/Kaleidoscope/HostOS-Focus.h b/src/Kaleidoscope/HostOS-Focus.h new file mode 100644 index 00000000..7d104b76 --- /dev/null +++ b/src/Kaleidoscope/HostOS-Focus.h @@ -0,0 +1,36 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope + * Copyright (C) 2016, 2017 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is 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 KaleidoscopePlugins { + namespace HostOS { + bool Focus (const char *command); + }; +}; + +#define FOCUS_HOOK_HOSTOS \ + FOCUS_HOOK(KaleidoscopePlugins::HostOS::Focus, \ + "hostos.type\n" \ + "-----------\n" \ + "Display the OS type, as known to the plugin.\n\n" \ + "hostos.set type\n" \ + "---------------\n" \ + "Set the OS type.") From 4615c048d1cfdb38a49ebd33994954fb702171a2 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 17 Mar 2017 12:18:36 +0100 Subject: [PATCH 13/44] Simplify the Focus commands Instead of having a getter and a setter command, have one with an optional argument instead. Less code, less docs, easier to use and understand. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/HostOS-Focus.cpp | 20 +++----------------- src/Kaleidoscope/HostOS-Focus.h | 10 ++++------ 2 files changed, 7 insertions(+), 23 deletions(-) diff --git a/src/Kaleidoscope/HostOS-Focus.cpp b/src/Kaleidoscope/HostOS-Focus.cpp index fe5b45b3..2321e0b7 100644 --- a/src/Kaleidoscope/HostOS-Focus.cpp +++ b/src/Kaleidoscope/HostOS-Focus.cpp @@ -23,28 +23,14 @@ namespace KaleidoscopePlugins { namespace HostOS { bool Focus (const char *command) { - enum { - GET, - SET, - } subCommand; - - if (strncmp_P (command, PSTR ("hostos."), 7) != 0) - return false; - if (strcmp_P (command + 7, PSTR ("type")) == 0) - subCommand = GET; - else if (strcmp_P (command + 7, PSTR ("set")) == 0) - subCommand = SET; - else + if (strcmp_P (command, PSTR ("hostos.type")) != 0) return false; - switch (subCommand) { - case GET: + if (Serial.peek () == '\n') { Serial.println (::HostOS.os ()); - break; - case SET: + } else { uint8_t os = Serial.parseInt (); ::HostOS.os ((KaleidoscopePlugins::HostOS::Type) os); - break; } Serial.read (); diff --git a/src/Kaleidoscope/HostOS-Focus.h b/src/Kaleidoscope/HostOS-Focus.h index 7d104b76..9d77614d 100644 --- a/src/Kaleidoscope/HostOS-Focus.h +++ b/src/Kaleidoscope/HostOS-Focus.h @@ -28,9 +28,7 @@ namespace KaleidoscopePlugins { #define FOCUS_HOOK_HOSTOS \ FOCUS_HOOK(KaleidoscopePlugins::HostOS::Focus, \ - "hostos.type\n" \ - "-----------\n" \ - "Display the OS type, as known to the plugin.\n\n" \ - "hostos.set type\n" \ - "---------------\n" \ - "Set the OS type.") + "hostos.type [TYPE]\n" \ + "------------------\n" \ + "Set the OS type to `TYPE`; or display the " \ + "type, when called without arguments.") From ba3c60058f77316c65ad74b9c9443156a2bc303b Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 20 Mar 2017 12:46:40 +0100 Subject: [PATCH 14/44] README: Add a "Dependencies" section Signed-off-by: Gergely Nagy --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index abd1b53f..cd962016 100644 --- a/README.md +++ b/README.md @@ -72,6 +72,10 @@ The extension provides the following methods on the `HostOS` singleton: > Sets the type of the host OS, overriding any previous value. The type is then > stored in EEPROM for persistence. +## Dependencies + +* [Kaleidoscope-EEPROM-Settings](https://github.com/keyboardio/Kaleidoscope-EEPROM-Settings) + ## Further reading Starting from the [example][plugin:example] is the recommended way of getting From dede93e0fd1bed97180b5b19d666f2f477c0bc9e Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 27 Mar 2017 16:38:53 +0200 Subject: [PATCH 15/44] Instead of full docs, only document the commands Full documentation takes way too much space, and command names are a reasonable compromise for discoverability. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/HostOS-Focus.h | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/src/Kaleidoscope/HostOS-Focus.h b/src/Kaleidoscope/HostOS-Focus.h index 9d77614d..be312054 100644 --- a/src/Kaleidoscope/HostOS-Focus.h +++ b/src/Kaleidoscope/HostOS-Focus.h @@ -26,9 +26,5 @@ namespace KaleidoscopePlugins { }; }; -#define FOCUS_HOOK_HOSTOS \ - FOCUS_HOOK(KaleidoscopePlugins::HostOS::Focus, \ - "hostos.type [TYPE]\n" \ - "------------------\n" \ - "Set the OS type to `TYPE`; or display the " \ - "type, when called without arguments.") +#define FOCUS_HOOK_HOSTOS \ + FOCUS_HOOK(KaleidoscopePlugins::HostOS::Focus, "hostos.type") From 30a490d21838d99c227a15e45cff9035fb5be49a Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 22 May 2017 00:28:45 -0700 Subject: [PATCH 16/44] Update example to match new Key defs --- examples/HostOS/HostOS.ino | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/examples/HostOS/HostOS.ino b/examples/HostOS/HostOS.ino index 40fa0530..2ed0d48d 100644 --- a/examples/HostOS/HostOS.ino +++ b/examples/HostOS/HostOS.ino @@ -25,9 +25,9 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, - Key_PageDn, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Esc, + Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, - Key_LCtrl, Key_Backspace, Key_LGUI, Key_LShift, + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, Key_skip, Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, @@ -35,7 +35,7 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, - Key_RShift, Key_RAlt, Key_Space, Key_RCtrl, + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, Key_skip ), }; From 9964a151ef096489fab6c34a7bf8a2c4747fd76c Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 23 May 2017 20:03:07 -0700 Subject: [PATCH 17/44] New build infrastructure --- .travis.yml | 29 ++++++++++++++++------------- Makefile | 12 ++++++++++++ 2 files changed, 28 insertions(+), 13 deletions(-) create mode 100644 Makefile diff --git a/.travis.yml b/.travis.yml index 77431b24..e7030acf 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,18 +1,21 @@ -language: cpp dist: trusty -sudo: required +sudo: false os: - linux -before_install: - - pushd .. - - wget http://downloads.arduino.cc/arduino-1.6.11-linux64.tar.xz - - tar xf arduino-1.6.11-linux64.tar.xz - - popd install: - - git clone --recurse-submodules https://github.com/keyboardio/Arduino-Boards hardware/keyboardio/avr + - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Arduino-Boards hardware/keyboardio/avr script: - - export DEFAULT_SKETCH=$(cd examples; basename *) - - export ARDUINO_PATH=$(pwd)/../arduino-1.6.11 - - export BOARD_HARDWARE_PATH=$(pwd)/hardware - - export EXTRA_BUILDER_ARGS="-libraries ." - - hardware/keyboardio/avr/libraries/Kaleidoscope/tools/kaleidoscope-builder build + - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware +notifications: + irc: + channels: + - "chat.freenode.net#keyboardio" + use_notice: true + skip_join: true + template: + - "%{repository_name}/%{branch} %{commit} by %{author}: %{commit_subject} %{build_url} %{message}" + email: + on_success: change + on_failure: change +cache: + ccache: true diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..9ce0c4a9 --- /dev/null +++ b/Makefile @@ -0,0 +1,12 @@ +# This stub makefile for a Kaleidoscope plugin pulls in +# all targets from the Kaleidoscope-Plugin library + +MAKEFILE_PREFIX=keyboardio/avr/libraries/Kaleidoscope-Plugin/build +UNAME_S := $(shell uname -s) + +BOARD_HARDWARE_PATH ?= $(HOME)/Arduino/hardware +ifeq ($(UNAME_S),Darwin) +BOARD_HARDWARE_PATH ?= $(HOME)/Library/Arduino/hardware +endif + +include $(BOARD_HARDWARE_PATH)/$(MAKEFILE_PREFIX)/*.mk From 69f244b43bf8b87cf65efae02cf3ad8c31b48607 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Fri, 26 May 2017 16:20:22 -0700 Subject: [PATCH 18/44] make astyle --- examples/HostOS/HostOS.ino | 48 +++++++++++++------------- src/Kaleidoscope/HostOS-Base.cpp | 44 ++++++++++++------------ src/Kaleidoscope/HostOS-Base.h | 52 ++++++++++++++--------------- src/Kaleidoscope/HostOS-Focus.cpp | 22 ++++++------ src/Kaleidoscope/HostOS-Focus.h | 6 ++-- src/Kaleidoscope/HostOS-Guesser.cpp | 28 ++++++++-------- src/Kaleidoscope/HostOS-Guesser.h | 16 ++++----- 7 files changed, 108 insertions(+), 108 deletions(-) diff --git a/examples/HostOS/HostOS.ino b/examples/HostOS/HostOS.ino index 2ed0d48d..870f0170 100644 --- a/examples/HostOS/HostOS.ino +++ b/examples/HostOS/HostOS.ino @@ -20,36 +20,36 @@ #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_skip, - - Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, - Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, - Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, - Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, - - Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, - Key_skip - ), + [0] = KEYMAP_STACKED + ( + Key_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_skip, + + Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, + Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, + + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, + Key_skip + ), }; void setup () { - Serial.begin (9600); + Serial.begin (9600); - Kaleidoscope.setup (KEYMAP_SIZE); - Kaleidoscope.use (&HostOS, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&HostOS, NULL); - Serial.print ("Host OS id is: "); - Serial.println (HostOS.os (), DEC); + Serial.print ("Host OS id is: "); + Serial.println (HostOS.os (), DEC); } void loop () { - Kaleidoscope.loop (); + Kaleidoscope.loop (); } diff --git a/src/Kaleidoscope/HostOS-Base.cpp b/src/Kaleidoscope/HostOS-Base.cpp index 67980733..d03b512c 100644 --- a/src/Kaleidoscope/HostOS-Base.cpp +++ b/src/Kaleidoscope/HostOS-Base.cpp @@ -22,38 +22,38 @@ #include namespace KaleidoscopePlugins { - namespace HostOS { - void - Base::begin (void) { - if (isConfigured) +namespace HostOS { +void +Base::begin (void) { + if (isConfigured) return; - eepromSlice = ::EEPROMSettings.requestSlice (sizeof (osType)); + eepromSlice = ::EEPROMSettings.requestSlice (sizeof (osType)); - isConfigured = true; + isConfigured = true; - if (osType != AUTO) { + if (osType != AUTO) { return; - } + } - if ((osType = (Type)EEPROM.read (eepromSlice)) != AUTO) + if ((osType = (Type)EEPROM.read (eepromSlice)) != AUTO) return; - autoDetect (); - } + autoDetect (); +} - HostOS::Type - Base::os (void) { - if (osType == AUTO) +HostOS::Type +Base::os (void) { + if (osType == AUTO) autoDetect (); - return osType; - } + return osType; +} - void - Base::os (HostOS::Type osType_) { - osType = osType_; - EEPROM.update (eepromSlice, osType); - } - }; +void +Base::os (HostOS::Type osType_) { + osType = osType_; + EEPROM.update (eepromSlice, osType); +} +}; }; diff --git a/src/Kaleidoscope/HostOS-Base.h b/src/Kaleidoscope/HostOS-Base.h index 6ef48216..1972d708 100644 --- a/src/Kaleidoscope/HostOS-Base.h +++ b/src/Kaleidoscope/HostOS-Base.h @@ -21,32 +21,32 @@ #include namespace KaleidoscopePlugins { - namespace HostOS { - typedef enum { - LINUX, - OSX, - WINDOWS, - OTHER, - - AUTO = 0xff, - } Type; - - class Base : public KaleidoscopePlugin { - public: - virtual void begin (void) final; - - Type os (void); - void os (Type osType); - - protected: - virtual void autoDetect (void) {}; - Type osType; - - private: - uint16_t eepromSlice; - bool isConfigured = false; - }; - }; +namespace HostOS { +typedef enum { + LINUX, + OSX, + WINDOWS, + OTHER, + + AUTO = 0xff, +} Type; + +class Base : public KaleidoscopePlugin { + public: + virtual void begin (void) final; + + Type os (void); + void os (Type osType); + + protected: + virtual void autoDetect (void) {}; + Type osType; + + private: + uint16_t eepromSlice; + bool isConfigured = false; +}; +}; }; extern KaleidoscopePlugins::HostOS::Base HostOS; diff --git a/src/Kaleidoscope/HostOS-Focus.cpp b/src/Kaleidoscope/HostOS-Focus.cpp index 2321e0b7..9b68ef64 100644 --- a/src/Kaleidoscope/HostOS-Focus.cpp +++ b/src/Kaleidoscope/HostOS-Focus.cpp @@ -20,21 +20,21 @@ #include namespace KaleidoscopePlugins { - namespace HostOS { - bool - Focus (const char *command) { - if (strcmp_P (command, PSTR ("hostos.type")) != 0) +namespace HostOS { +bool +Focus (const char *command) { + if (strcmp_P (command, PSTR ("hostos.type")) != 0) return false; - if (Serial.peek () == '\n') { + if (Serial.peek () == '\n') { Serial.println (::HostOS.os ()); - } else { + } else { uint8_t os = Serial.parseInt (); ::HostOS.os ((KaleidoscopePlugins::HostOS::Type) os); - } - - Serial.read (); - return true; } - } + + Serial.read (); + return true; +} +} } diff --git a/src/Kaleidoscope/HostOS-Focus.h b/src/Kaleidoscope/HostOS-Focus.h index be312054..70a6dd40 100644 --- a/src/Kaleidoscope/HostOS-Focus.h +++ b/src/Kaleidoscope/HostOS-Focus.h @@ -21,9 +21,9 @@ #include namespace KaleidoscopePlugins { - namespace HostOS { - bool Focus (const char *command); - }; +namespace HostOS { +bool Focus (const char *command); +}; }; #define FOCUS_HOOK_HOSTOS \ diff --git a/src/Kaleidoscope/HostOS-Guesser.cpp b/src/Kaleidoscope/HostOS-Guesser.cpp index f9c01184..240ec80f 100644 --- a/src/Kaleidoscope/HostOS-Guesser.cpp +++ b/src/Kaleidoscope/HostOS-Guesser.cpp @@ -21,30 +21,30 @@ #include namespace KaleidoscopePlugins { - namespace HostOS { - Guesser::Guesser (void) { - } +namespace HostOS { +Guesser::Guesser (void) { +} - void - Guesser::autoDetect (void) { - Serial.begin (9600); +void +Guesser::autoDetect (void) { + Serial.begin (9600); - delay (15000); + delay (15000); - switch (FingerprintUSBHost.guessHostOS ()) { - case GuessedHost::WINDOWS: + switch (FingerprintUSBHost.guessHostOS ()) { + case GuessedHost::WINDOWS: osType = WINDOWS; break; - case GuessedHost::LINUX: + case GuessedHost::LINUX: osType = LINUX; break; - case GuessedHost::MACOS: + case GuessedHost::MACOS: osType = OSX; break; - default: + default: osType = OTHER; break; - } } - }; +} +}; }; diff --git a/src/Kaleidoscope/HostOS-Guesser.h b/src/Kaleidoscope/HostOS-Guesser.h index c529024a..dc293e96 100644 --- a/src/Kaleidoscope/HostOS-Guesser.h +++ b/src/Kaleidoscope/HostOS-Guesser.h @@ -21,13 +21,13 @@ #include namespace KaleidoscopePlugins { - namespace HostOS { - class Guesser : public Base { - public: - Guesser (void); +namespace HostOS { +class Guesser : public Base { + public: + Guesser (void); - protected: - virtual void autoDetect (void) final; - }; - } + protected: + virtual void autoDetect (void) final; +}; +} }; From e597957ab9c2d2bb8c5f4b5332156223f44cf94e Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Sat, 3 Jun 2017 22:55:26 -0700 Subject: [PATCH 19/44] astyle with current project style guidelines --- examples/HostOS/HostOS.ino | 52 ++++++++++++++--------------- src/Kaleidoscope/HostOS-Base.cpp | 36 ++++++++++---------- src/Kaleidoscope/HostOS-Base.h | 30 ++++++++--------- src/Kaleidoscope/HostOS-Focus.cpp | 22 ++++++------ src/Kaleidoscope/HostOS-Focus.h | 2 +- src/Kaleidoscope/HostOS-Guesser.cpp | 36 ++++++++++---------- src/Kaleidoscope/HostOS-Guesser.h | 8 ++--- 7 files changed, 93 insertions(+), 93 deletions(-) diff --git a/examples/HostOS/HostOS.ino b/examples/HostOS/HostOS.ino index 870f0170..8f77f88b 100644 --- a/examples/HostOS/HostOS.ino +++ b/examples/HostOS/HostOS.ino @@ -20,36 +20,36 @@ #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_skip, - - Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, - Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, - Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, - Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, - - Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, - Key_skip - ), + [0] = KEYMAP_STACKED + ( + Key_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_skip, + + Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, + Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, + + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, + Key_skip + ), }; -void setup () { - Serial.begin (9600); +void setup() { + Serial.begin(9600); - Kaleidoscope.setup (KEYMAP_SIZE); - Kaleidoscope.use (&HostOS, NULL); + Kaleidoscope.setup(KEYMAP_SIZE); + Kaleidoscope.use(&HostOS, NULL); - Serial.print ("Host OS id is: "); - Serial.println (HostOS.os (), DEC); + Serial.print("Host OS id is: "); + Serial.println(HostOS.os(), DEC); } -void loop () { - Kaleidoscope.loop (); +void loop() { + Kaleidoscope.loop(); } diff --git a/src/Kaleidoscope/HostOS-Base.cpp b/src/Kaleidoscope/HostOS-Base.cpp index d03b512c..1e8cc58b 100644 --- a/src/Kaleidoscope/HostOS-Base.cpp +++ b/src/Kaleidoscope/HostOS-Base.cpp @@ -24,36 +24,36 @@ namespace KaleidoscopePlugins { namespace HostOS { void -Base::begin (void) { - if (isConfigured) - return; +Base::begin(void) { + if (isConfigured) + return; - eepromSlice = ::EEPROMSettings.requestSlice (sizeof (osType)); + eepromSlice = ::EEPROMSettings.requestSlice(sizeof(osType)); - isConfigured = true; + isConfigured = true; - if (osType != AUTO) { - return; - } + if (osType != AUTO) { + return; + } - if ((osType = (Type)EEPROM.read (eepromSlice)) != AUTO) - return; + if ((osType = (Type)EEPROM.read(eepromSlice)) != AUTO) + return; - autoDetect (); + autoDetect(); } HostOS::Type -Base::os (void) { - if (osType == AUTO) - autoDetect (); +Base::os(void) { + if (osType == AUTO) + autoDetect(); - return osType; + return osType; } void -Base::os (HostOS::Type osType_) { - osType = osType_; - EEPROM.update (eepromSlice, osType); +Base::os(HostOS::Type osType_) { + osType = osType_; + EEPROM.update(eepromSlice, osType); } }; }; diff --git a/src/Kaleidoscope/HostOS-Base.h b/src/Kaleidoscope/HostOS-Base.h index 1972d708..c3bce54e 100644 --- a/src/Kaleidoscope/HostOS-Base.h +++ b/src/Kaleidoscope/HostOS-Base.h @@ -23,28 +23,28 @@ namespace KaleidoscopePlugins { namespace HostOS { typedef enum { - LINUX, - OSX, - WINDOWS, - OTHER, + LINUX, + OSX, + WINDOWS, + OTHER, - AUTO = 0xff, + AUTO = 0xff, } Type; class Base : public KaleidoscopePlugin { - public: - virtual void begin (void) final; + public: + virtual void begin(void) final; - Type os (void); - void os (Type osType); + Type os(void); + void os(Type osType); - protected: - virtual void autoDetect (void) {}; - Type osType; + protected: + virtual void autoDetect(void) {}; + Type osType; - private: - uint16_t eepromSlice; - bool isConfigured = false; + private: + uint16_t eepromSlice; + bool isConfigured = false; }; }; }; diff --git a/src/Kaleidoscope/HostOS-Focus.cpp b/src/Kaleidoscope/HostOS-Focus.cpp index 9b68ef64..6bfce4f1 100644 --- a/src/Kaleidoscope/HostOS-Focus.cpp +++ b/src/Kaleidoscope/HostOS-Focus.cpp @@ -22,19 +22,19 @@ namespace KaleidoscopePlugins { namespace HostOS { bool -Focus (const char *command) { - if (strcmp_P (command, PSTR ("hostos.type")) != 0) - return false; +Focus(const char *command) { + if (strcmp_P(command, PSTR("hostos.type")) != 0) + return false; - if (Serial.peek () == '\n') { - Serial.println (::HostOS.os ()); - } else { - uint8_t os = Serial.parseInt (); - ::HostOS.os ((KaleidoscopePlugins::HostOS::Type) os); - } + if (Serial.peek() == '\n') { + Serial.println(::HostOS.os()); + } else { + uint8_t os = Serial.parseInt(); + ::HostOS.os((KaleidoscopePlugins::HostOS::Type) os); + } - Serial.read (); - return true; + Serial.read(); + return true; } } } diff --git a/src/Kaleidoscope/HostOS-Focus.h b/src/Kaleidoscope/HostOS-Focus.h index 70a6dd40..032c6076 100644 --- a/src/Kaleidoscope/HostOS-Focus.h +++ b/src/Kaleidoscope/HostOS-Focus.h @@ -22,7 +22,7 @@ namespace KaleidoscopePlugins { namespace HostOS { -bool Focus (const char *command); +bool Focus(const char *command); }; }; diff --git a/src/Kaleidoscope/HostOS-Guesser.cpp b/src/Kaleidoscope/HostOS-Guesser.cpp index 240ec80f..25af7b21 100644 --- a/src/Kaleidoscope/HostOS-Guesser.cpp +++ b/src/Kaleidoscope/HostOS-Guesser.cpp @@ -22,29 +22,29 @@ namespace KaleidoscopePlugins { namespace HostOS { -Guesser::Guesser (void) { +Guesser::Guesser(void) { } void -Guesser::autoDetect (void) { - Serial.begin (9600); +Guesser::autoDetect(void) { + Serial.begin(9600); - delay (15000); + delay(15000); - switch (FingerprintUSBHost.guessHostOS ()) { - case GuessedHost::WINDOWS: - osType = WINDOWS; - break; - case GuessedHost::LINUX: - osType = LINUX; - break; - case GuessedHost::MACOS: - osType = OSX; - break; - default: - osType = OTHER; - break; - } + switch (FingerprintUSBHost.guessHostOS()) { + case GuessedHost::WINDOWS: + osType = WINDOWS; + break; + case GuessedHost::LINUX: + osType = LINUX; + break; + case GuessedHost::MACOS: + osType = OSX; + break; + default: + osType = OTHER; + break; + } } }; }; diff --git a/src/Kaleidoscope/HostOS-Guesser.h b/src/Kaleidoscope/HostOS-Guesser.h index dc293e96..0d1e410c 100644 --- a/src/Kaleidoscope/HostOS-Guesser.h +++ b/src/Kaleidoscope/HostOS-Guesser.h @@ -23,11 +23,11 @@ namespace KaleidoscopePlugins { namespace HostOS { class Guesser : public Base { - public: - Guesser (void); + public: + Guesser(void); - protected: - virtual void autoDetect (void) final; + protected: + virtual void autoDetect(void) final; }; } }; From 54d6241e67c4cc3e95567f7b7e0b9d428f271d6f Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Sun, 4 Jun 2017 00:34:59 -0700 Subject: [PATCH 20/44] virtual void begin(void) final is redunant and makes the linter unhappy --- src/Kaleidoscope/HostOS-Base.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/HostOS-Base.h b/src/Kaleidoscope/HostOS-Base.h index c3bce54e..b0a2f562 100644 --- a/src/Kaleidoscope/HostOS-Base.h +++ b/src/Kaleidoscope/HostOS-Base.h @@ -33,7 +33,7 @@ typedef enum { class Base : public KaleidoscopePlugin { public: - virtual void begin(void) final; + void begin(void) final; Type os(void); void os(Type osType); From 129272883ae5e045f6aa15180c635303b3f02e60 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 4 Jun 2017 14:51:38 +0200 Subject: [PATCH 21/44] Kaleidoscope Style Guide conformance Signed-off-by: Gergely Nagy --- README.md | 19 ++++++----- examples/HostOS/HostOS.ino | 37 ++++++++++---------- src/Kaleidoscope-HostOS.h | 1 - src/Kaleidoscope/HostOS-Base.cpp | 52 ++++++++++++++++++----------- src/Kaleidoscope/HostOS-Base.h | 26 +++++++++------ src/Kaleidoscope/HostOS-Focus.cpp | 40 ---------------------- src/Kaleidoscope/HostOS-Focus.h | 30 ----------------- src/Kaleidoscope/HostOS-Guesser.cpp | 21 ++++++------ src/Kaleidoscope/HostOS-Guesser.h | 10 +++--- src/Kaleidoscope/HostOS-select.h | 4 +-- 10 files changed, 96 insertions(+), 144 deletions(-) delete mode 100644 src/Kaleidoscope/HostOS-Focus.cpp delete mode 100644 src/Kaleidoscope/HostOS-Focus.h diff --git a/README.md b/README.md index cd962016..81118a0e 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,9 @@ [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-HostOS.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-HostOS - [st:stable]: https://img.shields.io/badge/stable-✔-black.png?style=flat&colorA=44cc11&colorB=494e52 - [st:broken]: https://img.shields.io/badge/broken-X-black.png?style=flat&colorA=e05d44&colorB=494e52 - [st:experimental]: https://img.shields.io/badge/experimental----black.png?style=flat&colorA=dfb317&colorB=494e52 + [st:stable]: https://img.shields.io/badge/stable-✔-black.svg?style=flat&colorA=44cc11&colorB=494e52 + [st:broken]: https://img.shields.io/badge/broken-X-black.svg?style=flat&colorA=e05d44&colorB=494e52 + [st:experimental]: https://img.shields.io/badge/experimental----black.svg?style=flat&colorA=dfb317&colorB=494e52 The `HostOS` extension is not all that useful in itself, rather, it is a building block other plugins and extensions can use to not repeat the same @@ -41,18 +41,19 @@ the `HostOS` library header. #include #include -void someFunction (void) { - if (HostOS.os() == Kaleidoscope::HostOS::LINUX) { +void someFunction(void) { + if (HostOS.os() == kaleidoscope::HostOS::LINUX) { // do something linux-y } - if (HostOS.os() == Kaleidoscope::HostOS::OSX) { + if (HostOS.os() == kaleidoscope::HostOS::OSX) { // do something OSX-y } } -void setup (void) { - Kaleidoscope.setup (KEYMAP_SIZE); - Kaleidoscope.use (&HostOS); +void setup(void) { + USE_PLUGINS(&HostOS); + + Kaleidoscope.setup (); } ``` diff --git a/examples/HostOS/HostOS.ino b/examples/HostOS/HostOS.ino index 8f77f88b..264898fa 100644 --- a/examples/HostOS/HostOS.ino +++ b/examples/HostOS/HostOS.ino @@ -21,30 +21,29 @@ 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_skip, - - Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, - Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, - Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, - Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, - - Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, - Key_skip - ), + (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_skip, + + Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, + Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, + + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, + Key_skip), }; void setup() { Serial.begin(9600); - Kaleidoscope.setup(KEYMAP_SIZE); - Kaleidoscope.use(&HostOS, NULL); + USE_PLUGINS(&HostOS); + + Kaleidoscope.setup(); Serial.print("Host OS id is: "); Serial.println(HostOS.os(), DEC); diff --git a/src/Kaleidoscope-HostOS.h b/src/Kaleidoscope-HostOS.h index c3f9fd96..f3295a91 100644 --- a/src/Kaleidoscope-HostOS.h +++ b/src/Kaleidoscope-HostOS.h @@ -20,4 +20,3 @@ #include #include -#include diff --git a/src/Kaleidoscope/HostOS-Base.cpp b/src/Kaleidoscope/HostOS-Base.cpp index 1e8cc58b..ada98a9f 100644 --- a/src/Kaleidoscope/HostOS-Base.cpp +++ b/src/Kaleidoscope/HostOS-Base.cpp @@ -21,39 +21,53 @@ #include -namespace KaleidoscopePlugins { -namespace HostOS { -void -Base::begin(void) { - if (isConfigured) +namespace kaleidoscope { +namespace hostos { + +void Base::begin(void) { + if (is_configured_) return; - eepromSlice = ::EEPROMSettings.requestSlice(sizeof(osType)); + eeprom_slice_ = ::EEPROMSettings.requestSlice(sizeof(os_)); - isConfigured = true; + is_configured_ = true; - if (osType != AUTO) { + if (os_ != AUTO) { return; } - if ((osType = (Type)EEPROM.read(eepromSlice)) != AUTO) + if ((os_ = (Type)EEPROM.read(eeprom_slice_)) != AUTO) return; autoDetect(); } -HostOS::Type -Base::os(void) { - if (osType == AUTO) +Type Base::os(void) { + if (os_ == AUTO) autoDetect(); - return osType; + return os_; +} + +void Base::os(Type new_os) { + os_ = new_os; + EEPROM.update(eeprom_slice_, os_); } -void -Base::os(HostOS::Type osType_) { - osType = osType_; - EEPROM.update(eepromSlice, osType); +bool Base::focusHook(const char *command) { + if (strcmp_P(command, PSTR("hostos.type")) != 0) + return false; + + if (Serial.peek() == '\n') { + Serial.println(os_); + } else { + uint8_t new_os = Serial.parseInt(); + os((Type) new_os); + } + + Serial.read(); + return true; +} + +} } -}; -}; diff --git a/src/Kaleidoscope/HostOS-Base.h b/src/Kaleidoscope/HostOS-Base.h index b0a2f562..a9bb5fb1 100644 --- a/src/Kaleidoscope/HostOS-Base.h +++ b/src/Kaleidoscope/HostOS-Base.h @@ -20,8 +20,9 @@ #include -namespace KaleidoscopePlugins { -namespace HostOS { +namespace kaleidoscope { +namespace hostos { + typedef enum { LINUX, OSX, @@ -36,17 +37,22 @@ class Base : public KaleidoscopePlugin { void begin(void) final; Type os(void); - void os(Type osType); + void os(Type new_os); + + bool focusHook(const char *command); protected: - virtual void autoDetect(void) {}; - Type osType; + virtual void autoDetect(void) {} + Type os_; private: - uint16_t eepromSlice; - bool isConfigured = false; -}; -}; + uint16_t eeprom_slice_; + bool is_configured_ = false; }; -extern KaleidoscopePlugins::HostOS::Base HostOS; +} +} + +extern kaleidoscope::hostos::Base HostOS; + +#define FOCUS_HOOK_HOSTOS FOCUS_HOOK(HostOS.focusHook, "hostos.type") diff --git a/src/Kaleidoscope/HostOS-Focus.cpp b/src/Kaleidoscope/HostOS-Focus.cpp deleted file mode 100644 index 6bfce4f1..00000000 --- a/src/Kaleidoscope/HostOS-Focus.cpp +++ /dev/null @@ -1,40 +0,0 @@ -/* -*- mode: c++ -*- - * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope - * Copyright (C) 2016, 2017 Gergely Nagy - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This program is 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 - -namespace KaleidoscopePlugins { -namespace HostOS { -bool -Focus(const char *command) { - if (strcmp_P(command, PSTR("hostos.type")) != 0) - return false; - - if (Serial.peek() == '\n') { - Serial.println(::HostOS.os()); - } else { - uint8_t os = Serial.parseInt(); - ::HostOS.os((KaleidoscopePlugins::HostOS::Type) os); - } - - Serial.read(); - return true; -} -} -} diff --git a/src/Kaleidoscope/HostOS-Focus.h b/src/Kaleidoscope/HostOS-Focus.h deleted file mode 100644 index 032c6076..00000000 --- a/src/Kaleidoscope/HostOS-Focus.h +++ /dev/null @@ -1,30 +0,0 @@ -/* -*- mode: c++ -*- - * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope - * Copyright (C) 2016, 2017 Gergely Nagy - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This program is 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 KaleidoscopePlugins { -namespace HostOS { -bool Focus(const char *command); -}; -}; - -#define FOCUS_HOOK_HOSTOS \ - FOCUS_HOOK(KaleidoscopePlugins::HostOS::Focus, "hostos.type") diff --git a/src/Kaleidoscope/HostOS-Guesser.cpp b/src/Kaleidoscope/HostOS-Guesser.cpp index 25af7b21..879e3da4 100644 --- a/src/Kaleidoscope/HostOS-Guesser.cpp +++ b/src/Kaleidoscope/HostOS-Guesser.cpp @@ -20,31 +20,32 @@ #include -namespace KaleidoscopePlugins { -namespace HostOS { +namespace kaleidoscope { +namespace hostos { + Guesser::Guesser(void) { } -void -Guesser::autoDetect(void) { +void Guesser::autoDetect(void) { Serial.begin(9600); delay(15000); switch (FingerprintUSBHost.guessHostOS()) { case GuessedHost::WINDOWS: - osType = WINDOWS; + os_ = WINDOWS; break; case GuessedHost::LINUX: - osType = LINUX; + os_ = LINUX; break; case GuessedHost::MACOS: - osType = OSX; + os_ = OSX; break; default: - osType = OTHER; + os_ = OTHER; break; } } -}; -}; + +} +} diff --git a/src/Kaleidoscope/HostOS-Guesser.h b/src/Kaleidoscope/HostOS-Guesser.h index 0d1e410c..72f9ce87 100644 --- a/src/Kaleidoscope/HostOS-Guesser.h +++ b/src/Kaleidoscope/HostOS-Guesser.h @@ -20,14 +20,16 @@ #include -namespace KaleidoscopePlugins { -namespace HostOS { +namespace kaleidoscope { +namespace hostos { + class Guesser : public Base { public: Guesser(void); protected: - virtual void autoDetect(void) final; + void autoDetect(void) final; }; + +} } -}; diff --git a/src/Kaleidoscope/HostOS-select.h b/src/Kaleidoscope/HostOS-select.h index a80de9c0..fd2cdb75 100644 --- a/src/Kaleidoscope/HostOS-select.h +++ b/src/Kaleidoscope/HostOS-select.h @@ -22,7 +22,7 @@ #include #if KALEIDOSCOPE_HOSTOS_GUESSER -KaleidoscopePlugins::HostOS::Base HostOS = KaleidoscopePlugins::HostOS::Guesser(); +kaleidoscope::hostos::Base HostOS = kaleidoscope::hostos::Guesser(); #else -KaleidoscopePlugins::HostOS::Base HostOS; +kaleidoscope::hostos::Base HostOS; #endif From 3a3af164d92881a21763e962c96232d3bfab5120 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 4 Jun 2017 18:57:03 +0200 Subject: [PATCH 22/44] Focus: Fix the focusHook The `focusHook` function ought to be static, so instead of using `HostOS` internals, use the accessors instead. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/HostOS-Base.cpp | 4 ++-- src/Kaleidoscope/HostOS-Base.h | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/Kaleidoscope/HostOS-Base.cpp b/src/Kaleidoscope/HostOS-Base.cpp index ada98a9f..24fc9de9 100644 --- a/src/Kaleidoscope/HostOS-Base.cpp +++ b/src/Kaleidoscope/HostOS-Base.cpp @@ -59,10 +59,10 @@ bool Base::focusHook(const char *command) { return false; if (Serial.peek() == '\n') { - Serial.println(os_); + Serial.println(::HostOS.os()); } else { uint8_t new_os = Serial.parseInt(); - os((Type) new_os); + ::HostOS.os((Type) new_os); } Serial.read(); diff --git a/src/Kaleidoscope/HostOS-Base.h b/src/Kaleidoscope/HostOS-Base.h index a9bb5fb1..251fb8d3 100644 --- a/src/Kaleidoscope/HostOS-Base.h +++ b/src/Kaleidoscope/HostOS-Base.h @@ -39,7 +39,7 @@ class Base : public KaleidoscopePlugin { Type os(void); void os(Type new_os); - bool focusHook(const char *command); + static bool focusHook(const char *command); protected: virtual void autoDetect(void) {} From d5a4200008a44e161d42ff57bdff70ad710fb3b0 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 25 Jul 2017 15:52:08 -0700 Subject: [PATCH 23/44] Update Makefile to fix OS X build --- Makefile | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index 9ce0c4a9..2b04143a 100644 --- a/Makefile +++ b/Makefile @@ -4,9 +4,10 @@ MAKEFILE_PREFIX=keyboardio/avr/libraries/Kaleidoscope-Plugin/build UNAME_S := $(shell uname -s) -BOARD_HARDWARE_PATH ?= $(HOME)/Arduino/hardware ifeq ($(UNAME_S),Darwin) -BOARD_HARDWARE_PATH ?= $(HOME)/Library/Arduino/hardware +BOARD_HARDWARE_PATH ?= $(HOME)/Documents/Arduino/hardware +else +BOARD_HARDWARE_PATH ?= $(HOME)/Arduino/hardware endif -include $(BOARD_HARDWARE_PATH)/$(MAKEFILE_PREFIX)/*.mk +include $(BOARD_HARDWARE_PATH)/$(MAKEFILE_PREFIX)/rules.mk From b0c587610039c0ebc630ee4bce02d65b3001c921 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 17 Aug 2017 11:57:14 +0200 Subject: [PATCH 24/44] Stop using USE_PLUGINS Use `Kaleidoscope.use` instead, because `USE_PLUGINS` is getting deprecated. Signed-off-by: Gergely Nagy --- README.md | 2 +- examples/HostOS/HostOS.ino | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 81118a0e..c5bd2407 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ void someFunction(void) { } void setup(void) { - USE_PLUGINS(&HostOS); + Kaleidoscope.use(&HostOS); Kaleidoscope.setup (); } diff --git a/examples/HostOS/HostOS.ino b/examples/HostOS/HostOS.ino index 264898fa..a7c8c5ec 100644 --- a/examples/HostOS/HostOS.ino +++ b/examples/HostOS/HostOS.ino @@ -41,7 +41,7 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { void setup() { Serial.begin(9600); - USE_PLUGINS(&HostOS); + Kaleidoscope.use(&HostOS); Kaleidoscope.setup(); From 3b249dc1b343e465a533ccbf943294097f4aad98 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 21 Aug 2017 22:23:34 -0700 Subject: [PATCH 25/44] Update Makefile with OSX fixes and new paths --- Makefile | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index 2b04143a..8f830f44 100644 --- a/Makefile +++ b/Makefile @@ -1,13 +1,14 @@ # This stub makefile for a Kaleidoscope plugin pulls in # all targets from the Kaleidoscope-Plugin library -MAKEFILE_PREFIX=keyboardio/avr/libraries/Kaleidoscope-Plugin/build UNAME_S := $(shell uname -s) ifeq ($(UNAME_S),Darwin) -BOARD_HARDWARE_PATH ?= $(HOME)/Documents/Arduino/hardware +SKETCHBOOK_DIR ?= $(HOME)/Documents/Arduino/ else -BOARD_HARDWARE_PATH ?= $(HOME)/Arduino/hardware +SKETCHBOOK_DIR ?= $(HOME)/Arduino endif -include $(BOARD_HARDWARE_PATH)/$(MAKEFILE_PREFIX)/rules.mk +BOARD_HARDWARE_PATH ?= $(SKETCHBOOK_DIR)/hardware +KALEIDOSCOPE_PLUGIN_MAKEFILE_DIR ?= keyboardio/avr/build-tools/makefiles/ +include $(BOARD_HARDWARE_PATH)/$(KALEIDOSCOPE_PLUGIN_MAKEFILE_DIR)/rules.mk From f54c60e1c4a237963478f64f68521fbd7a062756 Mon Sep 17 00:00:00 2001 From: "James N. V. Cash" Date: Mon, 16 Oct 2017 19:57:02 -0400 Subject: [PATCH 26/44] Fix use of enum in example code --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c5bd2407..6ef6e4ee 100644 --- a/README.md +++ b/README.md @@ -42,10 +42,10 @@ the `HostOS` library header. #include void someFunction(void) { - if (HostOS.os() == kaleidoscope::HostOS::LINUX) { + if (HostOS.os() == kaleidoscope::hostos::LINUX) { // do something linux-y } - if (HostOS.os() == kaleidoscope::HostOS::OSX) { + if (HostOS.os() == kaleidoscope::hostos::OSX) { // do something OSX-y } } From 87e2b1e186b60d6197687fbd30834540ed014753 Mon Sep 17 00:00:00 2001 From: "James N. V. Cash" Date: Mon, 16 Oct 2017 19:57:30 -0400 Subject: [PATCH 27/44] Show the possible values of the OS type enum in README --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 6ef6e4ee..3cdf9123 100644 --- a/README.md +++ b/README.md @@ -73,6 +73,15 @@ The extension provides the following methods on the `HostOS` singleton: > Sets the type of the host OS, overriding any previous value. The type is then > stored in EEPROM for persistence. +## Host OS Values + +The OS type (i.e. the return type of `.os()` and the arguments to `.os(type)`) will be one of the following: + + - `kaleidoscope::hostos::LINUX` + - `kaleidoscope::hostos::OSX` + - `kaleidoscope::hostos::WINDOWS` + - `kaleidoscope::hostos::OTHER` + ## Dependencies * [Kaleidoscope-EEPROM-Settings](https://github.com/keyboardio/Kaleidoscope-EEPROM-Settings) From 6b1745f3397fa54e77289a158c2ae9d24ad9827a Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 12 May 2018 18:02:46 +0200 Subject: [PATCH 28/44] Updated to use the new plugin APIs Signed-off-by: Gergely Nagy --- examples/HostOS/HostOS.ino | 10 ++++++---- src/Kaleidoscope/HostOS-Base.cpp | 19 ++++++++++++++----- src/Kaleidoscope/HostOS-Base.h | 10 +++++++--- src/Kaleidoscope/HostOS-Guesser.cpp | 5 +---- src/Kaleidoscope/HostOS-Guesser.h | 4 ++-- 5 files changed, 30 insertions(+), 18 deletions(-) diff --git a/examples/HostOS/HostOS.ino b/examples/HostOS/HostOS.ino index a7c8c5ec..e3d91b89 100644 --- a/examples/HostOS/HostOS.ino +++ b/examples/HostOS/HostOS.ino @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope - * Copyright (C) 2016, 2017 Gergely Nagy + * Copyright (C) 2016, 2017, 2018 Gergely Nagy * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -19,6 +19,7 @@ #include #include +// *INDENT-OFF* const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED (Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, @@ -31,18 +32,19 @@ 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_skip), }; +// *INDENT-ON* + +KALEIDOSCOPE_INIT_PLUGINS(HostOS); void setup() { Serial.begin(9600); - Kaleidoscope.use(&HostOS); - Kaleidoscope.setup(); Serial.print("Host OS id is: "); diff --git a/src/Kaleidoscope/HostOS-Base.cpp b/src/Kaleidoscope/HostOS-Base.cpp index 24fc9de9..0dff6353 100644 --- a/src/Kaleidoscope/HostOS-Base.cpp +++ b/src/Kaleidoscope/HostOS-Base.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope - * Copyright (C) 2016, 2017 Gergely Nagy + * Copyright (C) 2016, 2017, 2018 Gergely Nagy * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -24,22 +24,24 @@ namespace kaleidoscope { namespace hostos { -void Base::begin(void) { +EventHandlerResult Base::onSetup(void) { if (is_configured_) - return; + return EventHandlerResult::OK; eeprom_slice_ = ::EEPROMSettings.requestSlice(sizeof(os_)); is_configured_ = true; if (os_ != AUTO) { - return; + return EventHandlerResult::OK; } if ((os_ = (Type)EEPROM.read(eeprom_slice_)) != AUTO) - return; + return EventHandlerResult::OK; autoDetect(); + + return EventHandlerResult::OK; } Type Base::os(void) { @@ -69,5 +71,12 @@ bool Base::focusHook(const char *command) { return true; } +// Legacy V1 API +#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API +void Base::begin() { + ::HostOS.onSetup(); +} +#endif + } } diff --git a/src/Kaleidoscope/HostOS-Base.h b/src/Kaleidoscope/HostOS-Base.h index 251fb8d3..eecc140c 100644 --- a/src/Kaleidoscope/HostOS-Base.h +++ b/src/Kaleidoscope/HostOS-Base.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope - * Copyright (C) 2016, 2017 Gergely Nagy + * Copyright (C) 2016, 2017, 2018 Gergely Nagy * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -32,9 +32,9 @@ typedef enum { AUTO = 0xff, } Type; -class Base : public KaleidoscopePlugin { +class Base : public kaleidoscope::Plugin { public: - void begin(void) final; + EventHandlerResult onSetup(); Type os(void); void os(Type new_os); @@ -45,6 +45,10 @@ class Base : public KaleidoscopePlugin { virtual void autoDetect(void) {} Type os_; +#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API + void begin(); +#endif + private: uint16_t eeprom_slice_; bool is_configured_ = false; diff --git a/src/Kaleidoscope/HostOS-Guesser.cpp b/src/Kaleidoscope/HostOS-Guesser.cpp index 879e3da4..6c9eb1c0 100644 --- a/src/Kaleidoscope/HostOS-Guesser.cpp +++ b/src/Kaleidoscope/HostOS-Guesser.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope - * Copyright (C) 2016, 2017 Gergely Nagy + * Copyright (C) 2016, 2017, 2018 Gergely Nagy * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -23,9 +23,6 @@ namespace kaleidoscope { namespace hostos { -Guesser::Guesser(void) { -} - void Guesser::autoDetect(void) { Serial.begin(9600); diff --git a/src/Kaleidoscope/HostOS-Guesser.h b/src/Kaleidoscope/HostOS-Guesser.h index 72f9ce87..51bba63c 100644 --- a/src/Kaleidoscope/HostOS-Guesser.h +++ b/src/Kaleidoscope/HostOS-Guesser.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope - * Copyright (C) 2016, 2017 Gergely Nagy + * Copyright (C) 2016, 2017, 2018 Gergely Nagy * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -25,7 +25,7 @@ namespace hostos { class Guesser : public Base { public: - Guesser(void); + Guesser(void) {} protected: void autoDetect(void) final; From bf21f59f84c9d618a79b54233e02e8437a766a33 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 20 Aug 2018 23:03:17 +0200 Subject: [PATCH 29/44] Drop the V1 plugin API compatibility code Signed-off-by: Gergely Nagy --- src/Kaleidoscope/HostOS-Base.cpp | 7 ------- src/Kaleidoscope/HostOS-Base.h | 4 ---- 2 files changed, 11 deletions(-) diff --git a/src/Kaleidoscope/HostOS-Base.cpp b/src/Kaleidoscope/HostOS-Base.cpp index 0dff6353..abce74be 100644 --- a/src/Kaleidoscope/HostOS-Base.cpp +++ b/src/Kaleidoscope/HostOS-Base.cpp @@ -71,12 +71,5 @@ bool Base::focusHook(const char *command) { return true; } -// Legacy V1 API -#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API -void Base::begin() { - ::HostOS.onSetup(); -} -#endif - } } diff --git a/src/Kaleidoscope/HostOS-Base.h b/src/Kaleidoscope/HostOS-Base.h index eecc140c..f6f515e6 100644 --- a/src/Kaleidoscope/HostOS-Base.h +++ b/src/Kaleidoscope/HostOS-Base.h @@ -45,10 +45,6 @@ class Base : public kaleidoscope::Plugin { virtual void autoDetect(void) {} Type os_; -#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API - void begin(); -#endif - private: uint16_t eeprom_slice_; bool is_configured_ = false; From 4e267bd52ca106c0c98f6c7ff26f35b41a7f7429 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:15:26 +0200 Subject: [PATCH 30/44] Relicense under the GPLv3 (only) Signed-off-by: Gergely Nagy --- examples/HostOS/HostOS.ino | 19 +++++++++---------- src/Kaleidoscope-HostOS.h | 19 +++++++++---------- src/Kaleidoscope/HostOS-Base.cpp | 19 +++++++++---------- src/Kaleidoscope/HostOS-Base.h | 19 +++++++++---------- src/Kaleidoscope/HostOS-Guesser.cpp | 19 +++++++++---------- src/Kaleidoscope/HostOS-Guesser.h | 19 +++++++++---------- src/Kaleidoscope/HostOS-select.h | 19 +++++++++---------- 7 files changed, 63 insertions(+), 70 deletions(-) diff --git a/examples/HostOS/HostOS.ino b/examples/HostOS/HostOS.ino index e3d91b89..84c0867c 100644 --- a/examples/HostOS/HostOS.ino +++ b/examples/HostOS/HostOS.ino @@ -2,18 +2,17 @@ * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope * Copyright (C) 2016, 2017, 2018 Gergely Nagy * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. + * This program is free software: you can redistribute it and/or modify it under + * the terms of the GNU General Public License as published by the Free Software + * Foundation, version 3. * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * You should have received a copy of the GNU General Public License along with + * this program. If not, see . */ #include diff --git a/src/Kaleidoscope-HostOS.h b/src/Kaleidoscope-HostOS.h index f3295a91..4c0e408f 100644 --- a/src/Kaleidoscope-HostOS.h +++ b/src/Kaleidoscope-HostOS.h @@ -2,18 +2,17 @@ * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope * Copyright (C) 2016, 2017 Gergely Nagy * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. + * This program is free software: you can redistribute it and/or modify it under + * the terms of the GNU General Public License as published by the Free Software + * Foundation, version 3. * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * You should have received a copy of the GNU General Public License along with + * this program. If not, see . */ #pragma once diff --git a/src/Kaleidoscope/HostOS-Base.cpp b/src/Kaleidoscope/HostOS-Base.cpp index abce74be..3c11a6fb 100644 --- a/src/Kaleidoscope/HostOS-Base.cpp +++ b/src/Kaleidoscope/HostOS-Base.cpp @@ -2,18 +2,17 @@ * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope * Copyright (C) 2016, 2017, 2018 Gergely Nagy * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. + * This program is free software: you can redistribute it and/or modify it under + * the terms of the GNU General Public License as published by the Free Software + * Foundation, version 3. * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * You should have received a copy of the GNU General Public License along with + * this program. If not, see . */ #include diff --git a/src/Kaleidoscope/HostOS-Base.h b/src/Kaleidoscope/HostOS-Base.h index f6f515e6..a8211693 100644 --- a/src/Kaleidoscope/HostOS-Base.h +++ b/src/Kaleidoscope/HostOS-Base.h @@ -2,18 +2,17 @@ * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope * Copyright (C) 2016, 2017, 2018 Gergely Nagy * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. + * This program is free software: you can redistribute it and/or modify it under + * the terms of the GNU General Public License as published by the Free Software + * Foundation, version 3. * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * You should have received a copy of the GNU General Public License along with + * this program. If not, see . */ #pragma once diff --git a/src/Kaleidoscope/HostOS-Guesser.cpp b/src/Kaleidoscope/HostOS-Guesser.cpp index 6c9eb1c0..32178595 100644 --- a/src/Kaleidoscope/HostOS-Guesser.cpp +++ b/src/Kaleidoscope/HostOS-Guesser.cpp @@ -2,18 +2,17 @@ * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope * Copyright (C) 2016, 2017, 2018 Gergely Nagy * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. + * This program is free software: you can redistribute it and/or modify it under + * the terms of the GNU General Public License as published by the Free Software + * Foundation, version 3. * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * You should have received a copy of the GNU General Public License along with + * this program. If not, see . */ #include diff --git a/src/Kaleidoscope/HostOS-Guesser.h b/src/Kaleidoscope/HostOS-Guesser.h index 51bba63c..5155785f 100644 --- a/src/Kaleidoscope/HostOS-Guesser.h +++ b/src/Kaleidoscope/HostOS-Guesser.h @@ -2,18 +2,17 @@ * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope * Copyright (C) 2016, 2017, 2018 Gergely Nagy * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. + * This program is free software: you can redistribute it and/or modify it under + * the terms of the GNU General Public License as published by the Free Software + * Foundation, version 3. * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * You should have received a copy of the GNU General Public License along with + * this program. If not, see . */ #pragma once diff --git a/src/Kaleidoscope/HostOS-select.h b/src/Kaleidoscope/HostOS-select.h index fd2cdb75..d565b867 100644 --- a/src/Kaleidoscope/HostOS-select.h +++ b/src/Kaleidoscope/HostOS-select.h @@ -2,18 +2,17 @@ * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope * Copyright (C) 2016, 2017 Gergely Nagy * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. + * This program is free software: you can redistribute it and/or modify it under + * the terms of the GNU General Public License as published by the Free Software + * Foundation, version 3. * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * You should have received a copy of the GNU General Public License along with + * this program. If not, see . */ #pragma once From 530dd5710b80b57b9d775b7bfbdb534896ec7b92 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:15:29 +0200 Subject: [PATCH 31/44] Assign my copyright to Keyboard.io While the original plugin was written independently, significant developments were made while working for Keyboard.io. As such, I feel it is appropriate to assign copyright to the company. Signed-off-by: Gergely Nagy --- examples/HostOS/HostOS.ino | 2 +- library.properties | 2 +- src/Kaleidoscope-HostOS.h | 2 +- src/Kaleidoscope/HostOS-Base.cpp | 2 +- src/Kaleidoscope/HostOS-Base.h | 2 +- src/Kaleidoscope/HostOS-Guesser.cpp | 2 +- src/Kaleidoscope/HostOS-Guesser.h | 2 +- src/Kaleidoscope/HostOS-select.h | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/examples/HostOS/HostOS.ino b/examples/HostOS/HostOS.ino index 84c0867c..cc1834d9 100644 --- a/examples/HostOS/HostOS.ino +++ b/examples/HostOS/HostOS.ino @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope - * Copyright (C) 2016, 2017, 2018 Gergely Nagy + * Copyright (C) 2016, 2017, 2018 Keyboard.io, Inc * * This program is free software: you can redistribute it and/or modify it under * the terms of the GNU General Public License as published by the Free Software diff --git a/library.properties b/library.properties index 3f04b3fe..1dee0666 100644 --- a/library.properties +++ b/library.properties @@ -1,7 +1,7 @@ name=Kaleidoscope-HostOS version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy +maintainer=Gergely Nagy sentence=Host OS detection and tracking for Kaleidoscope. paragraph=Provides functions to help guessing and/or tracking the host OS. category=Communication diff --git a/src/Kaleidoscope-HostOS.h b/src/Kaleidoscope-HostOS.h index 4c0e408f..93016481 100644 --- a/src/Kaleidoscope-HostOS.h +++ b/src/Kaleidoscope-HostOS.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope - * Copyright (C) 2016, 2017 Gergely Nagy + * Copyright (C) 2016, 2017 Keyboard.io, Inc * * This program is free software: you can redistribute it and/or modify it under * the terms of the GNU General Public License as published by the Free Software diff --git a/src/Kaleidoscope/HostOS-Base.cpp b/src/Kaleidoscope/HostOS-Base.cpp index 3c11a6fb..e728045d 100644 --- a/src/Kaleidoscope/HostOS-Base.cpp +++ b/src/Kaleidoscope/HostOS-Base.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope - * Copyright (C) 2016, 2017, 2018 Gergely Nagy + * Copyright (C) 2016, 2017, 2018 Keyboard.io, Inc * * This program is free software: you can redistribute it and/or modify it under * the terms of the GNU General Public License as published by the Free Software diff --git a/src/Kaleidoscope/HostOS-Base.h b/src/Kaleidoscope/HostOS-Base.h index a8211693..3b83ad34 100644 --- a/src/Kaleidoscope/HostOS-Base.h +++ b/src/Kaleidoscope/HostOS-Base.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope - * Copyright (C) 2016, 2017, 2018 Gergely Nagy + * Copyright (C) 2016, 2017, 2018 Keyboard.io, Inc * * This program is free software: you can redistribute it and/or modify it under * the terms of the GNU General Public License as published by the Free Software diff --git a/src/Kaleidoscope/HostOS-Guesser.cpp b/src/Kaleidoscope/HostOS-Guesser.cpp index 32178595..355fa7f7 100644 --- a/src/Kaleidoscope/HostOS-Guesser.cpp +++ b/src/Kaleidoscope/HostOS-Guesser.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope - * Copyright (C) 2016, 2017, 2018 Gergely Nagy + * Copyright (C) 2016, 2017, 2018 Keyboard.io, Inc * * This program is free software: you can redistribute it and/or modify it under * the terms of the GNU General Public License as published by the Free Software diff --git a/src/Kaleidoscope/HostOS-Guesser.h b/src/Kaleidoscope/HostOS-Guesser.h index 5155785f..1dc81f68 100644 --- a/src/Kaleidoscope/HostOS-Guesser.h +++ b/src/Kaleidoscope/HostOS-Guesser.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope - * Copyright (C) 2016, 2017, 2018 Gergely Nagy + * Copyright (C) 2016, 2017, 2018 Keyboard.io, Inc * * This program is free software: you can redistribute it and/or modify it under * the terms of the GNU General Public License as published by the Free Software diff --git a/src/Kaleidoscope/HostOS-select.h b/src/Kaleidoscope/HostOS-select.h index d565b867..ac2d5e22 100644 --- a/src/Kaleidoscope/HostOS-select.h +++ b/src/Kaleidoscope/HostOS-select.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope - * Copyright (C) 2016, 2017 Gergely Nagy + * Copyright (C) 2016, 2017 Keyboard.io, Inc * * This program is free software: you can redistribute it and/or modify it under * the terms of the GNU General Public License as published by the Free Software From 23ad967d60dc0df9f71b21c6e602d5fe29296a1a Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:15:31 +0200 Subject: [PATCH 32/44] Add CONTRIBUTING.md Copied from Kaleidoscope, as it is applicable here too. Signed-off-by: Gergely Nagy --- CONTRIBUTING.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..c490e3ce --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# Developer Certificate of Origin + +All contributions must include acceptance of the DCO: + +``` +Developer Certificate of Origin +Version 1.1 + +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. +1 Letterman Drive +Suite D4700 +San Francisco, CA, 94129 + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + + +Developer's Certificate of Origin 1.1 + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + +(b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + +(c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + +(d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. +``` + +## Sign your work + +To accept the DCO, please add this line to each commit message with your name +and email address (`git commit -s` will do this for you): + + Signed-off-by: Jane Example From 21ba3548bc7a7fc229e9e8f202e510367d6df9c9 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 4 Sep 2018 18:24:01 -0700 Subject: [PATCH 33/44] 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 755e94a98efd34333106883f51e5c480192f3e5a Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 4 Sep 2018 18:42:29 -0700 Subject: [PATCH 34/44] 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 e07007c5aa73470e77e1b64641f00ff58b76ea38 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 5 Oct 2018 14:31:35 +0200 Subject: [PATCH 35/44] Migrate to use the new onFocusEvent APIs Signed-off-by: Gergely Nagy --- src/Kaleidoscope-HostOS.h | 3 +- src/Kaleidoscope/HostOS-Base.cpp | 15 ---------- src/Kaleidoscope/HostOS-Base.h | 4 --- src/Kaleidoscope/HostOS-Focus.cpp | 46 +++++++++++++++++++++++++++++++ src/Kaleidoscope/HostOS-Focus.h | 34 +++++++++++++++++++++++ 5 files changed, 82 insertions(+), 20 deletions(-) create mode 100644 src/Kaleidoscope/HostOS-Focus.cpp create mode 100644 src/Kaleidoscope/HostOS-Focus.h diff --git a/src/Kaleidoscope-HostOS.h b/src/Kaleidoscope-HostOS.h index 93016481..3a137545 100644 --- a/src/Kaleidoscope-HostOS.h +++ b/src/Kaleidoscope-HostOS.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope - * Copyright (C) 2016, 2017 Keyboard.io, Inc + * Copyright (C) 2016, 2017, 2018 Keyboard.io, Inc * * This program is free software: you can redistribute it and/or modify it under * the terms of the GNU General Public License as published by the Free Software @@ -18,4 +18,5 @@ #pragma once #include +#include #include diff --git a/src/Kaleidoscope/HostOS-Base.cpp b/src/Kaleidoscope/HostOS-Base.cpp index e728045d..d3207bcf 100644 --- a/src/Kaleidoscope/HostOS-Base.cpp +++ b/src/Kaleidoscope/HostOS-Base.cpp @@ -55,20 +55,5 @@ void Base::os(Type new_os) { EEPROM.update(eeprom_slice_, os_); } -bool Base::focusHook(const char *command) { - if (strcmp_P(command, PSTR("hostos.type")) != 0) - return false; - - if (Serial.peek() == '\n') { - Serial.println(::HostOS.os()); - } else { - uint8_t new_os = Serial.parseInt(); - ::HostOS.os((Type) new_os); - } - - Serial.read(); - return true; -} - } } diff --git a/src/Kaleidoscope/HostOS-Base.h b/src/Kaleidoscope/HostOS-Base.h index 3b83ad34..84d546e1 100644 --- a/src/Kaleidoscope/HostOS-Base.h +++ b/src/Kaleidoscope/HostOS-Base.h @@ -38,8 +38,6 @@ class Base : public kaleidoscope::Plugin { Type os(void); void os(Type new_os); - static bool focusHook(const char *command); - protected: virtual void autoDetect(void) {} Type os_; @@ -53,5 +51,3 @@ class Base : public kaleidoscope::Plugin { } extern kaleidoscope::hostos::Base HostOS; - -#define FOCUS_HOOK_HOSTOS FOCUS_HOOK(HostOS.focusHook, "hostos.type") diff --git a/src/Kaleidoscope/HostOS-Focus.cpp b/src/Kaleidoscope/HostOS-Focus.cpp new file mode 100644 index 00000000..930d6d6e --- /dev/null +++ b/src/Kaleidoscope/HostOS-Focus.cpp @@ -0,0 +1,46 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope + * Copyright (C) 2016, 2017, 2018 Keyboard.io, Inc + * + * This program is free software: you can redistribute it and/or modify it under + * the terms of the GNU General Public License as published by the Free Software + * Foundation, version 3. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. + * + * You should have received a copy of the GNU General Public License along with + * this program. If not, see . + */ + +#include +#include + +namespace kaleidoscope { +namespace hostos { + +EventHandlerResult FocusHostOSCommand::onFocusEvent(const char *command) { + const char *cmd = PSTR("hostos.type"); + + if (::Focus.handleHelp(command, cmd)) + return EventHandlerResult::OK; + if (strcmp_P(command, cmd) != 0) + return EventHandlerResult::OK; + + if (Serial.peek() == '\n') { + Serial.println(::HostOS.os()); + } else { + uint8_t new_os = Serial.parseInt(); + ::HostOS.os((Type) new_os); + } + + Serial.read(); + return EventHandlerResult::EVENT_CONSUMED; +} + +} +} + +kaleidoscope::hostos::FocusHostOSCommand FocusHostOSCommand; diff --git a/src/Kaleidoscope/HostOS-Focus.h b/src/Kaleidoscope/HostOS-Focus.h new file mode 100644 index 00000000..e40a47df --- /dev/null +++ b/src/Kaleidoscope/HostOS-Focus.h @@ -0,0 +1,34 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope + * Copyright (C) 2016, 2017, 2018 Keyboard.io, Inc + * + * This program is free software: you can redistribute it and/or modify it under + * the terms of the GNU General Public License as published by the Free Software + * Foundation, version 3. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. + * + * You should have received a copy of the GNU General Public License along with + * this program. If not, see . + */ + +#pragma once + +#include + +namespace kaleidoscope { +namespace hostos { + +class FocusHostOSCommand : public kaleidoscope::Plugin { + public: + FocusHostOSCommand() {} + EventHandlerResult onFocusEvent(const char *command); +}; + +} +} + +extern kaleidoscope::hostos::FocusHostOSCommand FocusHostOSCommand; From 2a0d12b2d9d11374859e45f1c3558ff540f396f8 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 10 Oct 2018 06:31:32 +0200 Subject: [PATCH 36/44] README.md & Travis cleanup Remove the IRC notifications from Travis (we're not using IRC anymore), and the stable/experimental badge from README.md (because they aren't being kept up to date). Also updated the README.md example to use `KALEIDOSCOPE_INIT_PLUGINS`. Signed-off-by: Gergely Nagy --- .travis.yml | 7 ------- README.md | 10 +++------- 2 files changed, 3 insertions(+), 14 deletions(-) diff --git a/.travis.yml b/.travis.yml index 23d30ccc..49b8c498 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,13 +7,6 @@ install: script: - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware notifications: - irc: - channels: - - "chat.freenode.net#keyboardio" - use_notice: true - skip_join: true - template: - - "%{repository_name}/%{branch} %{commit} by %{author}: %{commit_subject} %{build_url} %{message}" email: on_success: change on_failure: change diff --git a/README.md b/README.md index 3cdf9123..535ab530 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,10 @@ # Kaleidoscope-HostOS -![status][st:stable] [![Build Status][travis:image]][travis:status] +[![Build Status][travis:image]][travis:status] [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-HostOS.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-HostOS - [st:stable]: https://img.shields.io/badge/stable-✔-black.svg?style=flat&colorA=44cc11&colorB=494e52 - [st:broken]: https://img.shields.io/badge/broken-X-black.svg?style=flat&colorA=e05d44&colorB=494e52 - [st:experimental]: https://img.shields.io/badge/experimental----black.svg?style=flat&colorA=dfb317&colorB=494e52 - The `HostOS` extension is not all that useful in itself, rather, it is a building block other plugins and extensions can use to not repeat the same guesswork and logic. Its primary purpose is to help either detect, or keep track @@ -50,9 +46,9 @@ void someFunction(void) { } } -void setup(void) { - Kaleidoscope.use(&HostOS); +KALEIDOSCOPE_INIT_PLUGINS(HostOS); +void setup(void) { Kaleidoscope.setup (); } ``` From 74f5f6d2e7f4a58e67884be06cbf9fe2f76db73c Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 10 Oct 2018 08:13:14 +0200 Subject: [PATCH 37/44] README.md: Document the Focus command provided by the plugin Fixes #8. Signed-off-by: Gergely Nagy --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 535ab530..bbaed972 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,19 @@ The OS type (i.e. the return type of `.os()` and the arguments to `.os(type)`) w - `kaleidoscope::hostos::WINDOWS` - `kaleidoscope::hostos::OTHER` +## Focus commands + +The plugin provides the `FocusHostOSCommand` object, which, when enabled, +provides the `hostos.type` Focus command. + +### `hostos.type [type]` + +> Without argument, returns the current OS type set (a numeric value). +> +> With an argument, it sets the OS type. +> +> This command can be used from the host to reliably set the OS type within the firmware. + ## Dependencies * [Kaleidoscope-EEPROM-Settings](https://github.com/keyboardio/Kaleidoscope-EEPROM-Settings) From 985e31b48b8022c77fa22c92c1c3acfc0fc2f1ac Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 10 Oct 2018 00:36:55 +0200 Subject: [PATCH 38/44] Greatly simplify the plugin by removing auto-detection The `FingerprintUSBHost` library isn't the most reliable thing, so instead of setting false expectations, remove auto-detection instead. This makes the plugin a whole lost simpler, and depend on one less library. Fixes #9. Signed-off-by: Gergely Nagy --- README.md | 26 +++------- examples/HostOS/HostOS.ino | 1 - src/Kaleidoscope-HostOS.h | 3 +- src/Kaleidoscope/HostOS-Focus.cpp | 6 +-- src/Kaleidoscope/HostOS-Focus.h | 4 +- src/Kaleidoscope/HostOS-Guesser.cpp | 47 ------------------- src/Kaleidoscope/HostOS-Guesser.h | 34 -------------- src/Kaleidoscope/HostOS-select.h | 9 +--- .../{HostOS-Base.cpp => HostOS.cpp} | 24 +++------- src/Kaleidoscope/{HostOS-Base.h => HostOS.h} | 28 +++++++---- 10 files changed, 37 insertions(+), 145 deletions(-) delete mode 100644 src/Kaleidoscope/HostOS-Guesser.cpp delete mode 100644 src/Kaleidoscope/HostOS-Guesser.h rename src/Kaleidoscope/{HostOS-Base.cpp => HostOS.cpp} (76%) rename src/Kaleidoscope/{HostOS-Base.h => HostOS.h} (62%) diff --git a/README.md b/README.md index bbaed972..7e26288f 100644 --- a/README.md +++ b/README.md @@ -7,13 +7,11 @@ The `HostOS` extension is not all that useful in itself, rather, it is a building block other plugins and extensions can use to not repeat the same -guesswork and logic. Its primary purpose is to help either detect, or keep track -of the host operating system. The detection part is not the most reliable thing, -mind you. +guesswork and logic. -The goal is to have a single place that remembers the host OS, either detected, -or set by the end-user, in a Sketch, or via a macro, or some other way. This -information can then be reused by other plugins. +The goal is to have a single place that remembers the host OS, whether set by +the end-user in a Sketch, or via a macro, or some other way. This information +can then be reused by other plugins. See the [Unicode][plugin:unicode] extension for an example about how to use `HostOS` in practice. @@ -22,20 +20,11 @@ See the [Unicode][plugin:unicode] extension for an example about how to use ## Using the extension -The extension provides a `HostOS` singleton object. It can either be a simple -one without auto-detection (the default), or one that will try to detect the -Host OS, using the [FingerprintUSBHost][fprdetect] library. To enable -auto-detection, `KALEIDOSCOPE_HOSTOS_GUESSER` must be defined before including -the `HostOS` library header. - - [fprdetect]: https://github.com/keyboardio/FingerprintUSBHost +The extension provides a `HostOS` singleton object. ```c++ -#define KALEIDOSCOPE_HOSTOS_GUESSER 1 - #include #include -#include void someFunction(void) { if (HostOS.os() == kaleidoscope::hostos::LINUX) { @@ -46,16 +35,13 @@ void someFunction(void) { } } -KALEIDOSCOPE_INIT_PLUGINS(HostOS); +KALEIDOSCOPE_INIT_PLUGINS(HostOS) void setup(void) { Kaleidoscope.setup (); } ``` -To be able to choose between the two variants, one must also include the -`Kaleidoscope/HostOS-select.h` header. - ## Extension methods The extension provides the following methods on the `HostOS` singleton: diff --git a/examples/HostOS/HostOS.ino b/examples/HostOS/HostOS.ino index cc1834d9..9fb1599e 100644 --- a/examples/HostOS/HostOS.ino +++ b/examples/HostOS/HostOS.ino @@ -16,7 +16,6 @@ */ #include -#include // *INDENT-OFF* const Key keymaps[][ROWS][COLS] PROGMEM = { diff --git a/src/Kaleidoscope-HostOS.h b/src/Kaleidoscope-HostOS.h index 3a137545..2db78a77 100644 --- a/src/Kaleidoscope-HostOS.h +++ b/src/Kaleidoscope-HostOS.h @@ -17,6 +17,5 @@ #pragma once -#include +#include #include -#include diff --git a/src/Kaleidoscope/HostOS-Focus.cpp b/src/Kaleidoscope/HostOS-Focus.cpp index 930d6d6e..3b967499 100644 --- a/src/Kaleidoscope/HostOS-Focus.cpp +++ b/src/Kaleidoscope/HostOS-Focus.cpp @@ -19,7 +19,6 @@ #include namespace kaleidoscope { -namespace hostos { EventHandlerResult FocusHostOSCommand::onFocusEvent(const char *command) { const char *cmd = PSTR("hostos.type"); @@ -33,14 +32,13 @@ EventHandlerResult FocusHostOSCommand::onFocusEvent(const char *command) { Serial.println(::HostOS.os()); } else { uint8_t new_os = Serial.parseInt(); - ::HostOS.os((Type) new_os); + ::HostOS.os((hostos::Type) new_os); } Serial.read(); return EventHandlerResult::EVENT_CONSUMED; } -} } -kaleidoscope::hostos::FocusHostOSCommand FocusHostOSCommand; +kaleidoscope::FocusHostOSCommand FocusHostOSCommand; diff --git a/src/Kaleidoscope/HostOS-Focus.h b/src/Kaleidoscope/HostOS-Focus.h index e40a47df..1d93752e 100644 --- a/src/Kaleidoscope/HostOS-Focus.h +++ b/src/Kaleidoscope/HostOS-Focus.h @@ -20,7 +20,6 @@ #include namespace kaleidoscope { -namespace hostos { class FocusHostOSCommand : public kaleidoscope::Plugin { public: @@ -28,7 +27,6 @@ class FocusHostOSCommand : public kaleidoscope::Plugin { EventHandlerResult onFocusEvent(const char *command); }; -} } -extern kaleidoscope::hostos::FocusHostOSCommand FocusHostOSCommand; +extern kaleidoscope::FocusHostOSCommand FocusHostOSCommand; diff --git a/src/Kaleidoscope/HostOS-Guesser.cpp b/src/Kaleidoscope/HostOS-Guesser.cpp deleted file mode 100644 index 355fa7f7..00000000 --- a/src/Kaleidoscope/HostOS-Guesser.cpp +++ /dev/null @@ -1,47 +0,0 @@ -/* -*- mode: c++ -*- - * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope - * Copyright (C) 2016, 2017, 2018 Keyboard.io, Inc - * - * This program is free software: you can redistribute it and/or modify it under - * the terms of the GNU General Public License as published by the Free Software - * Foundation, version 3. - * - * This program is distributed in the hope that it will be useful, but WITHOUT - * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS - * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more - * details. - * - * You should have received a copy of the GNU General Public License along with - * this program. If not, see . - */ - -#include - -#include - -namespace kaleidoscope { -namespace hostos { - -void Guesser::autoDetect(void) { - Serial.begin(9600); - - delay(15000); - - switch (FingerprintUSBHost.guessHostOS()) { - case GuessedHost::WINDOWS: - os_ = WINDOWS; - break; - case GuessedHost::LINUX: - os_ = LINUX; - break; - case GuessedHost::MACOS: - os_ = OSX; - break; - default: - os_ = OTHER; - break; - } -} - -} -} diff --git a/src/Kaleidoscope/HostOS-Guesser.h b/src/Kaleidoscope/HostOS-Guesser.h deleted file mode 100644 index 1dc81f68..00000000 --- a/src/Kaleidoscope/HostOS-Guesser.h +++ /dev/null @@ -1,34 +0,0 @@ -/* -*- mode: c++ -*- - * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope - * Copyright (C) 2016, 2017, 2018 Keyboard.io, Inc - * - * This program is free software: you can redistribute it and/or modify it under - * the terms of the GNU General Public License as published by the Free Software - * Foundation, version 3. - * - * This program is distributed in the hope that it will be useful, but WITHOUT - * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS - * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more - * details. - * - * You should have received a copy of the GNU General Public License along with - * this program. If not, see . - */ - -#pragma once - -#include - -namespace kaleidoscope { -namespace hostos { - -class Guesser : public Base { - public: - Guesser(void) {} - - protected: - void autoDetect(void) final; -}; - -} -} diff --git a/src/Kaleidoscope/HostOS-select.h b/src/Kaleidoscope/HostOS-select.h index ac2d5e22..7a080cd7 100644 --- a/src/Kaleidoscope/HostOS-select.h +++ b/src/Kaleidoscope/HostOS-select.h @@ -17,11 +17,4 @@ #pragma once -#include -#include - -#if KALEIDOSCOPE_HOSTOS_GUESSER -kaleidoscope::hostos::Base HostOS = kaleidoscope::hostos::Guesser(); -#else -kaleidoscope::hostos::Base HostOS; -#endif +#warning is an obsolete header, and can be safely removed. diff --git a/src/Kaleidoscope/HostOS-Base.cpp b/src/Kaleidoscope/HostOS.cpp similarity index 76% rename from src/Kaleidoscope/HostOS-Base.cpp rename to src/Kaleidoscope/HostOS.cpp index d3207bcf..ac85faf1 100644 --- a/src/Kaleidoscope/HostOS-Base.cpp +++ b/src/Kaleidoscope/HostOS.cpp @@ -15,15 +15,14 @@ * this program. If not, see . */ -#include +#include #include #include namespace kaleidoscope { -namespace hostos { -EventHandlerResult Base::onSetup(void) { +EventHandlerResult HostOS::onSetup(void) { if (is_configured_) return EventHandlerResult::OK; @@ -31,29 +30,20 @@ EventHandlerResult Base::onSetup(void) { is_configured_ = true; - if (os_ != AUTO) { + if (os_ != hostos::UNKNOWN) { return EventHandlerResult::OK; } - if ((os_ = (Type)EEPROM.read(eeprom_slice_)) != AUTO) - return EventHandlerResult::OK; - - autoDetect(); + os_ = (hostos::Type)EEPROM.read(eeprom_slice_); return EventHandlerResult::OK; } -Type Base::os(void) { - if (os_ == AUTO) - autoDetect(); - - return os_; -} - -void Base::os(Type new_os) { +void HostOS::os(hostos::Type new_os) { os_ = new_os; EEPROM.update(eeprom_slice_, os_); } } -} + +kaleidoscope::HostOS HostOS; diff --git a/src/Kaleidoscope/HostOS-Base.h b/src/Kaleidoscope/HostOS.h similarity index 62% rename from src/Kaleidoscope/HostOS-Base.h rename to src/Kaleidoscope/HostOS.h index 84d546e1..af592e95 100644 --- a/src/Kaleidoscope/HostOS-Base.h +++ b/src/Kaleidoscope/HostOS.h @@ -28,26 +28,36 @@ typedef enum { WINDOWS, OTHER, - AUTO = 0xff, + UNKNOWN = 0xff, + AUTO = UNKNOWN } Type; -class Base : public kaleidoscope::Plugin { +} + +#define _DEPRECATED_MESSAGE_AUTODETECT \ + "The auto-detect mechanism of HostOS was removed, because it was\n" \ + "too unreliable. As such, the HostOS.autoDetect() method does\n" \ + "nothing anymore. Please consider other ways of changing the\n" \ + "HostOS type." + +class HostOS : public kaleidoscope::Plugin { public: + HostOS() {} EventHandlerResult onSetup(); - Type os(void); - void os(Type new_os); + hostos::Type os(void) { + return os_; + } + void os(hostos::Type new_os); - protected: - virtual void autoDetect(void) {} - Type os_; + void autoDetect() DEPRECATED(AUTODETECT) {} private: + hostos::Type os_; uint16_t eeprom_slice_; bool is_configured_ = false; }; -} } -extern kaleidoscope::hostos::Base HostOS; +extern kaleidoscope::HostOS HostOS; From d04f5f7e75b4a58b00f7cc359c256c68fdb01023 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 14 Oct 2018 10:58:50 +0200 Subject: [PATCH 39/44] README.md: Add an "Upgrading" section Signed-off-by: Gergely Nagy --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 7e26288f..b164560d 100644 --- a/README.md +++ b/README.md @@ -87,3 +87,12 @@ Starting from the [example][plugin:example] is the recommended way of getting started with the extension. [plugin:example]: https://github.com/keyboardio/Kaleidoscope-HostOS/blob/master/examples/HostOS/HostOS.ino + +## Upgrading + +Prior versions of `HostOS` used to include a way to auto-detect the host +operating system. This code was brittle, unreliable, and rather big too. For +these reasons, this functionality was removed. The `autoDetect()` method is now +a no-op, and is deprecated. The `Kaleidoscope/HostOS-select.h` header is +similarly obsolete. Both of these produce deprecation messages now, and will be +removed by 2019-01-14. From 38b8230c3096a897b4eae0b68f8dd972c44baf6f Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 17 Oct 2018 10:43:50 +0200 Subject: [PATCH 40/44] Explicitly initialize EEPROMSettings As the plugin now depends on EEPROMSettings, document that it needs to be initialized first, and adjust the example accordingly too. Signed-off-by: Gergely Nagy --- README.md | 6 +++++- examples/HostOS/HostOS.ino | 4 +++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b164560d..20d15e8b 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,7 @@ The extension provides a `HostOS` singleton object. ```c++ #include +#include #include void someFunction(void) { @@ -35,7 +36,7 @@ void someFunction(void) { } } -KALEIDOSCOPE_INIT_PLUGINS(HostOS) +KALEIDOSCOPE_INIT_PLUGINS(EEPROMSettings, HostOS) void setup(void) { Kaleidoscope.setup (); @@ -96,3 +97,6 @@ these reasons, this functionality was removed. The `autoDetect()` method is now a no-op, and is deprecated. The `Kaleidoscope/HostOS-select.h` header is similarly obsolete. Both of these produce deprecation messages now, and will be removed by 2019-01-14. + +Furthermore, `HostOS` now depends on `Kaleidoscope-EEPROM-Settings`, that plugin +should be initialized first. diff --git a/examples/HostOS/HostOS.ino b/examples/HostOS/HostOS.ino index 9fb1599e..3315c976 100644 --- a/examples/HostOS/HostOS.ino +++ b/examples/HostOS/HostOS.ino @@ -15,6 +15,8 @@ * this program. If not, see . */ +#include +#include #include // *INDENT-OFF* @@ -38,7 +40,7 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { }; // *INDENT-ON* -KALEIDOSCOPE_INIT_PLUGINS(HostOS); +KALEIDOSCOPE_INIT_PLUGINS(EEPROMSettings, HostOS); void setup() { Serial.begin(9600); From 175f5080a55b853348b163e68e6916f381fe6d42 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 14 Oct 2018 11:00:33 +0200 Subject: [PATCH 41/44] Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/HostOS.md`, sources under `src/kaleidoscope/plugin/` (appropriately namespaced). This is in preparation of merging plugins into a single monorepo. The `Kaleidoscope/HostOS-select.h` remains in place, for compatibility reasons. Signed-off-by: Gergely Nagy --- README.md | 96 +------------------ doc/plugin/HostOS.md | 96 +++++++++++++++++++ src/Kaleidoscope-HostOS.h | 4 +- .../plugin}/HostOS-Focus.cpp | 4 +- .../plugin}/HostOS-Focus.h | 5 +- .../plugin}/HostOS.cpp | 6 +- .../plugin}/HostOS.h | 5 +- 7 files changed, 113 insertions(+), 103 deletions(-) create mode 100644 doc/plugin/HostOS.md rename src/{Kaleidoscope => kaleidoscope/plugin}/HostOS-Focus.cpp (94%) rename src/{Kaleidoscope => kaleidoscope/plugin}/HostOS-Focus.h (91%) rename src/{Kaleidoscope => kaleidoscope/plugin}/HostOS.cpp (92%) rename src/{Kaleidoscope => kaleidoscope/plugin}/HostOS.h (93%) diff --git a/README.md b/README.md index 20d15e8b..af84959e 100644 --- a/README.md +++ b/README.md @@ -5,98 +5,4 @@ [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-HostOS.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-HostOS -The `HostOS` extension is not all that useful in itself, rather, it is a -building block other plugins and extensions can use to not repeat the same -guesswork and logic. - -The goal is to have a single place that remembers the host OS, whether set by -the end-user in a Sketch, or via a macro, or some other way. This information -can then be reused by other plugins. - -See the [Unicode][plugin:unicode] extension for an example about how to use -`HostOS` in practice. - - [plugin:unicode]: https://github.com/keyboardio/Kaleidoscope-Unicode - -## Using the extension - -The extension provides a `HostOS` singleton object. - -```c++ -#include -#include -#include - -void someFunction(void) { - if (HostOS.os() == kaleidoscope::hostos::LINUX) { - // do something linux-y - } - if (HostOS.os() == kaleidoscope::hostos::OSX) { - // do something OSX-y - } -} - -KALEIDOSCOPE_INIT_PLUGINS(EEPROMSettings, HostOS) - -void setup(void) { - Kaleidoscope.setup (); -} -``` - -## Extension methods - -The extension provides the following methods on the `HostOS` singleton: - -### `.os()` - -> Returns the stored type of the Host OS. - -### `.os(type)` - -> Sets the type of the host OS, overriding any previous value. The type is then -> stored in EEPROM for persistence. - -## Host OS Values - -The OS type (i.e. the return type of `.os()` and the arguments to `.os(type)`) will be one of the following: - - - `kaleidoscope::hostos::LINUX` - - `kaleidoscope::hostos::OSX` - - `kaleidoscope::hostos::WINDOWS` - - `kaleidoscope::hostos::OTHER` - -## Focus commands - -The plugin provides the `FocusHostOSCommand` object, which, when enabled, -provides the `hostos.type` Focus command. - -### `hostos.type [type]` - -> Without argument, returns the current OS type set (a numeric value). -> -> With an argument, it sets the OS type. -> -> This command can be used from the host to reliably set the OS type within the firmware. - -## Dependencies - -* [Kaleidoscope-EEPROM-Settings](https://github.com/keyboardio/Kaleidoscope-EEPROM-Settings) - -## Further reading - -Starting from the [example][plugin:example] is the recommended way of getting -started with the extension. - - [plugin:example]: https://github.com/keyboardio/Kaleidoscope-HostOS/blob/master/examples/HostOS/HostOS.ino - -## Upgrading - -Prior versions of `HostOS` used to include a way to auto-detect the host -operating system. This code was brittle, unreliable, and rather big too. For -these reasons, this functionality was removed. The `autoDetect()` method is now -a no-op, and is deprecated. The `Kaleidoscope/HostOS-select.h` header is -similarly obsolete. Both of these produce deprecation messages now, and will be -removed by 2019-01-14. - -Furthermore, `HostOS` now depends on `Kaleidoscope-EEPROM-Settings`, that plugin -should be initialized first. +See [doc/plugin/HostOS.md](doc/plugin/HostOS.md) for documentation. diff --git a/doc/plugin/HostOS.md b/doc/plugin/HostOS.md new file mode 100644 index 00000000..47c3ae61 --- /dev/null +++ b/doc/plugin/HostOS.md @@ -0,0 +1,96 @@ +# Kaleidoscope-HostOS + +The `HostOS` extension is not all that useful in itself, rather, it is a +building block other plugins and extensions can use to not repeat the same +guesswork and logic. + +The goal is to have a single place that remembers the host OS, whether set by +the end-user in a Sketch, or via a macro, or some other way. This information +can then be reused by other plugins. + +See the [Unicode][plugin:unicode] extension for an example about how to use +`HostOS` in practice. + + [plugin:unicode]: https://github.com/keyboardio/Kaleidoscope-Unicode + +## Using the extension + +The extension provides a `HostOS` singleton object. + +```c++ +#include +#include + +void someFunction(void) { + if (HostOS.os() == kaleidoscope::hostos::LINUX) { + // do something linux-y + } + if (HostOS.os() == kaleidoscope::hostos::OSX) { + // do something OSX-y + } +} + +KALEIDOSCOPE_INIT_PLUGINS(HostOS) + +void setup(void) { + Kaleidoscope.setup (); +} +``` + +## Extension methods + +The extension provides the following methods on the `HostOS` singleton: + +### `.os()` + +> Returns the stored type of the Host OS. + +### `.os(type)` + +> Sets the type of the host OS, overriding any previous value. The type is then +> stored in EEPROM for persistence. + +## Host OS Values + +The OS type (i.e. the return type of `.os()` and the arguments to `.os(type)`) will be one of the following: + + - `kaleidoscope::hostos::LINUX` + - `kaleidoscope::hostos::OSX` + - `kaleidoscope::hostos::WINDOWS` + - `kaleidoscope::hostos::OTHER` + +## Focus commands + +The plugin provides the `FocusHostOSCommand` object, which, when enabled, +provides the `hostos.type` Focus command. + +### `hostos.type [type]` + +> Without argument, returns the current OS type set (a numeric value). +> +> With an argument, it sets the OS type. +> +> This command can be used from the host to reliably set the OS type within the firmware. + +## Dependencies + +* [Kaleidoscope-EEPROM-Settings](https://github.com/keyboardio/Kaleidoscope-EEPROM-Settings) + +## Further reading + +Starting from the [example][plugin:example] is the recommended way of getting +started with the extension. + + [plugin:example]: https://github.com/keyboardio/Kaleidoscope-HostOS/blob/master/examples/HostOS/HostOS.ino + +## Upgrading + +Prior versions of `HostOS` used to include a way to auto-detect the host +operating system. This code was brittle, unreliable, and rather big too. For +these reasons, this functionality was removed. The `autoDetect()` method is now +a no-op, and is deprecated. The `Kaleidoscope/HostOS-select.h` header is +similarly obsolete. Both of these produce deprecation messages now, and will be +removed by 2019-01-14. + +Furthermore, `HostOS` now depends on `Kaleidoscope-EEPROM-Settings`, that plugin +should be initialized first. diff --git a/src/Kaleidoscope-HostOS.h b/src/Kaleidoscope-HostOS.h index 2db78a77..0c483820 100644 --- a/src/Kaleidoscope-HostOS.h +++ b/src/Kaleidoscope-HostOS.h @@ -17,5 +17,5 @@ #pragma once -#include -#include +#include +#include diff --git a/src/Kaleidoscope/HostOS-Focus.cpp b/src/kaleidoscope/plugin/HostOS-Focus.cpp similarity index 94% rename from src/Kaleidoscope/HostOS-Focus.cpp rename to src/kaleidoscope/plugin/HostOS-Focus.cpp index 3b967499..222e1399 100644 --- a/src/Kaleidoscope/HostOS-Focus.cpp +++ b/src/kaleidoscope/plugin/HostOS-Focus.cpp @@ -19,6 +19,7 @@ #include namespace kaleidoscope { +namespace plugin { EventHandlerResult FocusHostOSCommand::onFocusEvent(const char *command) { const char *cmd = PSTR("hostos.type"); @@ -39,6 +40,7 @@ EventHandlerResult FocusHostOSCommand::onFocusEvent(const char *command) { return EventHandlerResult::EVENT_CONSUMED; } +} } -kaleidoscope::FocusHostOSCommand FocusHostOSCommand; +kaleidoscope::plugin::FocusHostOSCommand FocusHostOSCommand; diff --git a/src/Kaleidoscope/HostOS-Focus.h b/src/kaleidoscope/plugin/HostOS-Focus.h similarity index 91% rename from src/Kaleidoscope/HostOS-Focus.h rename to src/kaleidoscope/plugin/HostOS-Focus.h index 1d93752e..87a5f452 100644 --- a/src/Kaleidoscope/HostOS-Focus.h +++ b/src/kaleidoscope/plugin/HostOS-Focus.h @@ -20,13 +20,14 @@ #include namespace kaleidoscope { +namespace plugin { class FocusHostOSCommand : public kaleidoscope::Plugin { public: FocusHostOSCommand() {} EventHandlerResult onFocusEvent(const char *command); }; - +} } -extern kaleidoscope::FocusHostOSCommand FocusHostOSCommand; +extern kaleidoscope::plugin::FocusHostOSCommand FocusHostOSCommand; diff --git a/src/Kaleidoscope/HostOS.cpp b/src/kaleidoscope/plugin/HostOS.cpp similarity index 92% rename from src/Kaleidoscope/HostOS.cpp rename to src/kaleidoscope/plugin/HostOS.cpp index ac85faf1..d1d11206 100644 --- a/src/Kaleidoscope/HostOS.cpp +++ b/src/kaleidoscope/plugin/HostOS.cpp @@ -15,12 +15,13 @@ * this program. If not, see . */ -#include +#include #include #include namespace kaleidoscope { +namespace plugin { EventHandlerResult HostOS::onSetup(void) { if (is_configured_) @@ -44,6 +45,7 @@ void HostOS::os(hostos::Type new_os) { EEPROM.update(eeprom_slice_, os_); } +} } -kaleidoscope::HostOS HostOS; +kaleidoscope::plugin::HostOS HostOS; diff --git a/src/Kaleidoscope/HostOS.h b/src/kaleidoscope/plugin/HostOS.h similarity index 93% rename from src/Kaleidoscope/HostOS.h rename to src/kaleidoscope/plugin/HostOS.h index af592e95..0668b83e 100644 --- a/src/Kaleidoscope/HostOS.h +++ b/src/kaleidoscope/plugin/HostOS.h @@ -20,6 +20,7 @@ #include namespace kaleidoscope { +namespace plugin { namespace hostos { typedef enum { @@ -57,7 +58,9 @@ class HostOS : public kaleidoscope::Plugin { uint16_t eeprom_slice_; bool is_configured_ = false; }; +} +namespace hostos = plugin::hostos; } -extern kaleidoscope::HostOS HostOS; +extern kaleidoscope::plugin::HostOS HostOS; From 067e3e8094d4fe46334568dec829b8d01b31a16a Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 14 Oct 2018 11:00:35 +0200 Subject: [PATCH 42/44] Remove files we do not need in the monorepo Signed-off-by: Gergely Nagy --- .gitignore | 4 - .travis.yml | 14 - CONTRIBUTING.md | 50 ---- COPYING | 674 --------------------------------------------- Makefile | 14 - README.md | 8 - library.properties | 10 - 7 files changed, 774 deletions(-) delete mode 100644 .gitignore delete mode 100644 .travis.yml delete mode 100644 CONTRIBUTING.md delete mode 100644 COPYING delete mode 100644 Makefile delete mode 100644 README.md delete mode 100644 library.properties diff --git a/.gitignore b/.gitignore deleted file mode 100644 index be16c9be..00000000 --- a/.gitignore +++ /dev/null @@ -1,4 +0,0 @@ -.#* -*~ -/hardware/ -/output/ \ No newline at end of file diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 49b8c498..00000000 --- a/.travis.yml +++ /dev/null @@ -1,14 +0,0 @@ -dist: trusty -sudo: false -os: - - linux -install: - - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Kaleidoscope-Bundle-Keyboardio hardware/keyboardio -script: - - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware -notifications: - email: - on_success: change - on_failure: change -cache: - ccache: true diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index c490e3ce..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,50 +0,0 @@ -# Developer Certificate of Origin - -All contributions must include acceptance of the DCO: - -``` -Developer Certificate of Origin -Version 1.1 - -Copyright (C) 2004, 2006 The Linux Foundation and its contributors. -1 Letterman Drive -Suite D4700 -San Francisco, CA, 94129 - -Everyone is permitted to copy and distribute verbatim copies of this -license document, but changing it is not allowed. - - -Developer's Certificate of Origin 1.1 - -By making a contribution to this project, I certify that: - -(a) The contribution was created in whole or in part by me and I - have the right to submit it under the open source license - indicated in the file; or - -(b) The contribution is based upon previous work that, to the best - of my knowledge, is covered under an appropriate open source - license and I have the right under that license to submit that - work with modifications, whether created in whole or in part - by me, under the same open source license (unless I am - permitted to submit under a different license), as indicated - in the file; or - -(c) The contribution was provided directly to me by some other - person who certified (a), (b) or (c) and I have not modified - it. - -(d) I understand and agree that this project and the contribution - are public and that a record of the contribution (including all - personal information I submit with it, including my sign-off) is - maintained indefinitely and may be redistributed consistent with - this project or the open source license(s) involved. -``` - -## Sign your work - -To accept the DCO, please add this line to each commit message with your name -and email address (`git commit -s` will do this for you): - - Signed-off-by: Jane Example diff --git a/COPYING b/COPYING deleted file mode 100644 index 94a9ed02..00000000 --- a/COPYING +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/Makefile b/Makefile deleted file mode 100644 index 8f830f44..00000000 --- a/Makefile +++ /dev/null @@ -1,14 +0,0 @@ -# This stub makefile for a Kaleidoscope plugin pulls in -# all targets from the Kaleidoscope-Plugin library - -UNAME_S := $(shell uname -s) - -ifeq ($(UNAME_S),Darwin) -SKETCHBOOK_DIR ?= $(HOME)/Documents/Arduino/ -else -SKETCHBOOK_DIR ?= $(HOME)/Arduino -endif - -BOARD_HARDWARE_PATH ?= $(SKETCHBOOK_DIR)/hardware -KALEIDOSCOPE_PLUGIN_MAKEFILE_DIR ?= keyboardio/avr/build-tools/makefiles/ -include $(BOARD_HARDWARE_PATH)/$(KALEIDOSCOPE_PLUGIN_MAKEFILE_DIR)/rules.mk diff --git a/README.md b/README.md deleted file mode 100644 index af84959e..00000000 --- a/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# Kaleidoscope-HostOS - -[![Build Status][travis:image]][travis:status] - - [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-HostOS.svg?branch=master - [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-HostOS - -See [doc/plugin/HostOS.md](doc/plugin/HostOS.md) for documentation. diff --git a/library.properties b/library.properties deleted file mode 100644 index 1dee0666..00000000 --- a/library.properties +++ /dev/null @@ -1,10 +0,0 @@ -name=Kaleidoscope-HostOS -version=0.0.0 -author=Gergely Nagy -maintainer=Gergely Nagy -sentence=Host OS detection and tracking for Kaleidoscope. -paragraph=Provides functions to help guessing and/or tracking the host OS. -category=Communication -url=https://github.com/keyboardio/Kaleidoscope-HostOS -architectures=avr -dot_a_linkage=true From 5884da5481df2dbc80f0faa50a75a233f8e52f44 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 18 Oct 2018 00:03:07 +0200 Subject: [PATCH 43/44] 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/HostOS.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/plugin/HostOS.md b/doc/plugin/HostOS.md index 47c3ae61..cf5d6721 100644 --- a/doc/plugin/HostOS.md +++ b/doc/plugin/HostOS.md @@ -11,7 +11,7 @@ can then be reused by other plugins. See the [Unicode][plugin:unicode] extension for an example about how to use `HostOS` in practice. - [plugin:unicode]: https://github.com/keyboardio/Kaleidoscope-Unicode + [plugin:unicode]: Unicode.md ## Using the extension @@ -74,14 +74,14 @@ provides the `hostos.type` Focus command. ## Dependencies -* [Kaleidoscope-EEPROM-Settings](https://github.com/keyboardio/Kaleidoscope-EEPROM-Settings) +* [Kaleidoscope-EEPROM-Settings](EEPROM-Settings.md) ## Further reading Starting from the [example][plugin:example] is the recommended way of getting started with the extension. - [plugin:example]: https://github.com/keyboardio/Kaleidoscope-HostOS/blob/master/examples/HostOS/HostOS.ino + [plugin:example]: ../../examples/HostOS/HostOS.ino ## Upgrading From ebe4a1c67369ae947b2cdb787afbd455266092bb Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 18 Oct 2018 00:55:19 +0200 Subject: [PATCH 44/44] HostOS: Drop the Kaleidoscope/HostOS-select.h header It causes conflicts on case-insensitive filesystems. Signed-off-by: Gergely Nagy --- doc/plugin/HostOS.md | 4 ++-- src/Kaleidoscope/HostOS-select.h | 20 -------------------- 2 files changed, 2 insertions(+), 22 deletions(-) delete mode 100644 src/Kaleidoscope/HostOS-select.h diff --git a/doc/plugin/HostOS.md b/doc/plugin/HostOS.md index cf5d6721..7aabb0de 100644 --- a/doc/plugin/HostOS.md +++ b/doc/plugin/HostOS.md @@ -89,8 +89,8 @@ Prior versions of `HostOS` used to include a way to auto-detect the host operating system. This code was brittle, unreliable, and rather big too. For these reasons, this functionality was removed. The `autoDetect()` method is now a no-op, and is deprecated. The `Kaleidoscope/HostOS-select.h` header is -similarly obsolete. Both of these produce deprecation messages now, and will be -removed by 2019-01-14. +similarly obsolete, and has even been removed (for unrelated reasons). The +`autoDetect()` method will be removed by 2019-01-14. Furthermore, `HostOS` now depends on `Kaleidoscope-EEPROM-Settings`, that plugin should be initialized first. diff --git a/src/Kaleidoscope/HostOS-select.h b/src/Kaleidoscope/HostOS-select.h deleted file mode 100644 index 7a080cd7..00000000 --- a/src/Kaleidoscope/HostOS-select.h +++ /dev/null @@ -1,20 +0,0 @@ -/* -*- mode: c++ -*- - * Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope - * Copyright (C) 2016, 2017 Keyboard.io, Inc - * - * This program is free software: you can redistribute it and/or modify it under - * the terms of the GNU General Public License as published by the Free Software - * Foundation, version 3. - * - * This program is distributed in the hope that it will be useful, but WITHOUT - * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS - * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more - * details. - * - * You should have received a copy of the GNU General Public License along with - * this program. If not, see . - */ - -#pragma once - -#warning is an obsolete header, and can be safely removed.