From f456e6aba8c3740516f109a5a49ccb62aa7efb91 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 2 Feb 2017 12:28:42 +0100 Subject: [PATCH 01/38] Initial import Signed-off-by: Gergely Nagy --- .gitignore | 2 + COPYING | 674 +++++++++++++++++++++++++++++++++++++ README.md | 93 +++++ examples/Syster/Syster.ino | 71 ++++ library.properties | 10 + src/Akela-Syster.h | 21 ++ src/Akela/Syster.cpp | 128 +++++++ src/Akela/Syster.h | 53 +++ 8 files changed, 1052 insertions(+) create mode 100644 .gitignore create mode 100644 COPYING create mode 100644 README.md create mode 100644 examples/Syster/Syster.ino create mode 100644 library.properties create mode 100644 src/Akela-Syster.h create mode 100644 src/Akela/Syster.cpp create mode 100644 src/Akela/Syster.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..4dbc9947 --- /dev/null +++ b/README.md @@ -0,0 +1,93 @@ +# Akela-Syster + +![status][st:experimental] + + [st:stable]: https://img.shields.io/badge/stable-✔-black.png?style=flat&colorA=44cc11&colorB=494e52 + [st:broken]: https://img.shields.io/badge/broken-X-black.png?style=flat&colorA=e05d44&colorB=494e52 + [st:experimental]: https://img.shields.io/badge/experimental----black.png?style=flat&colorA=dfb317&colorB=494e52 + +Syster is a way to input symbols in a different way: instead of macros, Leader +sequences or the like, we trigger the special input mode, and enter the symbol's +name. Once finished, we hit `Space`, and this plugin will do the rest: delete +everything we typed, look up an action for the entered symbol, and execute that. + +There are a number of ways this can be useful, but the easiest showcase is +symbolic Unicode input: `SYSTER coffee SPACE` turns into `☕`, witch just a +little code. + +## Using the plugin + +To use the plugin, one needs to include the header, and set up a function that +will handle the symbol actions: + +```c++ +#include +#include + +void systerAction (Akela::Syster::action_t action, const char *symbol) { + switch (action) { + case Akela::Syster::StartAction: + Unicode.type (0x2328); + break; + case Akela::Syster::EndAction: + handle_key_event (Key_Backspace, 255, 255, IS_PRESSED | INJECTED); + Keyboard.sendReport (); + handle_key_event (Key_Backspace, 255, 255, WAS_PRESSED | INJECTED); + Keyboard.sendReport (); + break; + case Akela::Syster::SymbolAction: + Serial.print ("systerAction: symbol="); + Serial.println (symbol); + if (strcmp (symbol, "coffee") == 0) { + Unicode.type (0x2615); + } + break; + } +} + +void setup () { + Serial.begin (9600); + + Keyboardio.setup (KEYMAP_SIZE); + Keyboardio.use (&Unicode, &Syster, NULL); +} +``` + +**Note** that we need to use the `Syster` object before any other that adds or +changes key behaviour! Failing to do so may result in unpredictable behaviour. + +## Plugin methods + +The plugin provides the `Syster` object, with no public methods. There are two +methods outside of the object, however, that can be overridden: + +### `systerAction(action, symbol)` + +> Called whenever an action needs to be taken, which can happen in three cases: + +> First, when the `Syster` key is pressed, and the alternate processing starts. +> In this case, `action` will be set to `Akela::Syster::StartAction`, and +> `symbol` will be `NULL`. This function can be used to do some setup to make it +> more obvious that the Syster input mode is active, such as sending a Unicode +> symbol to the host, or lighting up LEDs, or anything else we'd like. +> +> Second, when the sequence is finished with a `Space`. In this case, `action` +> will be set to `Akela::Syster::EndAction`, and `symbol` will be `NULL`. This +> can be used to undo anything that the start action did, if need be. +> +> Third, when the action for the symbol should be made. In this case, `action` +> is set to `Akela::Syster::SymbolAction`, and `symbol` will be a C string. It +> is up to us, what we do with this information, how we handle it. + +### `keyToChar(key)` + +> A function that turns a keycode into a character. If using QWERTY on the host, +> the default implementation is sufficient. When using something else, you may +> have to reimplement this function. + +## Further reading + +Starting from the [example][plugin:example] is the recommended way of getting +started with the plugin. + + [plugin:example]: https://github.com/keyboardio/Akela-Syster/blob/master/examples/Syster/Syster.ino diff --git a/examples/Syster/Syster.ino b/examples/Syster/Syster.ino new file mode 100644 index 00000000..a0039234 --- /dev/null +++ b/examples/Syster/Syster.ino @@ -0,0 +1,71 @@ +/* -*- mode: c++ -*- + * Akela -- Animated Keyboardio Extension Library for Anything + * Copyright (C) 2017 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#include +#include + +const Key keymaps[][ROWS][COLS] PROGMEM = { + [0] = KEYMAP_STACKED + ( + Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, + Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, + Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, + Key_PageDn, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Esc, + + Key_LCtrl, Key_Backspace, Key_LGUI, Key_LShift, + SYSTER, + + 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, + SYSTER + ), +}; + +void systerAction (Akela::Syster::action_t action, const char *symbol) { + switch (action) { + case Akela::Syster::StartAction: + Unicode.type (0x2328); + break; + case Akela::Syster::EndAction: + handle_key_event (Key_Backspace, 255, 255, IS_PRESSED | INJECTED); + Keyboard.sendReport (); + handle_key_event (Key_Backspace, 255, 255, WAS_PRESSED | INJECTED); + Keyboard.sendReport (); + break; + case Akela::Syster::SymbolAction: + Serial.print ("systerAction: symbol="); + Serial.println (symbol); + if (strcmp (symbol, "coffee") == 0) { + Unicode.type (0x2615); + } + break; + } +} + +void setup () { + Keyboardio.setup (KEYMAP_SIZE); + Keyboardio.use (&Unicode, &Syster, NULL); +} + +void loop () { + Keyboardio.loop (); +} diff --git a/library.properties b/library.properties new file mode 100644 index 00000000..199c1982 --- /dev/null +++ b/library.properties @@ -0,0 +1,10 @@ +name=Akela-Syster +version=0.0.0 +author=Gergely Nagy +maintainer=Gergely Nagy +sentence=Symbolic input system for KeyboardioFirmware. +paragraph=Allows inputting symbols (Unicode or otherwise) by name. +category=Communication +url=https://github.com/keyboardio/Akela-Syster +architectures=avr +dot_a_linkage=true diff --git a/src/Akela-Syster.h b/src/Akela-Syster.h new file mode 100644 index 00000000..4ad3d2c9 --- /dev/null +++ b/src/Akela-Syster.h @@ -0,0 +1,21 @@ +/* -*- mode: c++ -*- + * Akela -- Animated Keyboardio Extension Library for Anything + * Copyright (C) 2016, 2017 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#pragma once + +#include diff --git a/src/Akela/Syster.cpp b/src/Akela/Syster.cpp new file mode 100644 index 00000000..2b52dc54 --- /dev/null +++ b/src/Akela/Syster.cpp @@ -0,0 +1,128 @@ +/* -*- mode: c++ -*- + * Akela -- Animated Keyboardio Extension Library for Anything + * Copyright (C) 2017 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#include + +using namespace Akela::Ranges; + +namespace Akela { + // --- state --- + char Syster::symbol[SYSTER_MAX_SYMBOL_LENGTH + 1]; + uint8_t Syster::symbolPos; + bool Syster::isActive; + + // --- helpers --- + +#define isSyster(k) (k == SYSTER) + + // --- api --- + + Syster::Syster (void) { + } + + void + Syster::begin (void) { + event_handler_hook_use (this->eventHandlerHook); + } + + void + Syster::reset (void) { + symbolPos = 0; + symbol[0] = 0; + isActive = false; + } + + // --- hooks --- + Key + Syster::eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState) { + if (keyState & INJECTED) + return mappedKey; + + if (!isActive) { + if (!isSyster (mappedKey)) + return mappedKey; + + if (key_toggled_on (keyState)) { + isActive = true; + systerAction (StartAction, NULL); + } + return Key_NoKey; + } + + if (isSyster (mappedKey)) + return Key_NoKey; + + if (mappedKey == Key_Backspace && symbolPos == 0) + return Key_NoKey; + + if (key_toggled_off (keyState)) { + if (mappedKey == Key_Space) { + for (uint8_t i = 0; i <= symbolPos; i++) { + handle_key_event (Key_Backspace, 255, 255, IS_PRESSED | INJECTED); + Keyboard.sendReport (); + handle_key_event (Key_Backspace, 255, 255, WAS_PRESSED | INJECTED); + Keyboard.sendReport (); + } + + systerAction (EndAction, NULL); + + symbol[symbolPos] = 0; + systerAction (SymbolAction, symbol); + reset (); + + return Key_NoKey; + } + } + + if (key_toggled_on (keyState)) { + if (mappedKey == Key_Backspace) { + if (symbolPos > 0) + symbolPos--; + } else { + const char c = keyToChar (mappedKey); + if (c) + symbol[symbolPos++] = c; + } + } + + return mappedKey; + } +}; + +__attribute__((weak)) +const char +keyToChar (Key key) { + if (key.flags != 0) + return 0; + + switch (key.keyCode) { + case Key_A.keyCode ... Key_Z.keyCode: + return 'a' + (key.keyCode - Key_A.keyCode); + case Key_1.keyCode ... Key_0.keyCode: + return '1' + (key.keyCode - Key_1.keyCode); + } + + return 0; +} + +__attribute__((weak)) +void +systerAction (Akela::Syster::action_t action, const char *symbol) { +} + +Akela::Syster Syster; diff --git a/src/Akela/Syster.h b/src/Akela/Syster.h new file mode 100644 index 00000000..4c54bdc1 --- /dev/null +++ b/src/Akela/Syster.h @@ -0,0 +1,53 @@ +/* -*- mode: c++ -*- + * Akela -- Animated Keyboardio Extension Library for Anything + * Copyright (C) 2017 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#pragma once + +#include + +#define SYSTER_MAX_SYMBOL_LENGTH 32 + +#define SYSTER (Key){ .raw = Akela::Ranges::SYSTER } + +namespace Akela { + class Syster : public KeyboardioPlugin { + public: + typedef enum { + StartAction, + EndAction, + SymbolAction + } action_t; + + Syster (void); + + virtual void begin (void) final; + static void reset (void); + + private: + static char symbol[SYSTER_MAX_SYMBOL_LENGTH + 1]; + static uint8_t symbolPos; + static bool isActive; + + static Key eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState); + }; +}; + +const char keyToChar (Key key); +void systerAction (Akela::Syster::action_t action, const char *symbol); + +extern Akela::Syster Syster; From 16a4f0013a9ecd7d3bcd2b33b38642b7d3788fe5 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 2 Feb 2017 12:58:15 +0100 Subject: [PATCH 02/38] Don't pass all INJECTED keys through Only pass INJECTED keys through, if we are already active. This way, another plugin can trigger us by injecting a SYSTER key. Signed-off-by: Gergely Nagy --- src/Akela/Syster.cpp | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/Akela/Syster.cpp b/src/Akela/Syster.cpp index 2b52dc54..c79f47ad 100644 --- a/src/Akela/Syster.cpp +++ b/src/Akela/Syster.cpp @@ -50,9 +50,6 @@ namespace Akela { // --- hooks --- Key Syster::eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState) { - if (keyState & INJECTED) - return mappedKey; - if (!isActive) { if (!isSyster (mappedKey)) return mappedKey; @@ -64,6 +61,9 @@ namespace Akela { return Key_NoKey; } + if (keyState & INJECTED) + return mappedKey; + if (isSyster (mappedKey)) return Key_NoKey; From 29d45e8850de1a8f8c51930a7eb8530f634ab36d Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 11 Feb 2017 23:56:55 +0100 Subject: [PATCH 03/38] The Big Rename Renamed the plugin to Kaleidoscope-Syster, and followed up with other renames. Signed-off-by: Gergely Nagy --- README.md | 39 ++++++++++--------- examples/Syster/Syster.ino | 21 +++++----- library.properties | 8 ++-- src/{Akela-Syster.h => Kaleidoscope-Syster.h} | 4 +- src/{Akela => Kaleidoscope}/Syster.cpp | 12 +++--- src/{Akela => Kaleidoscope}/Syster.h | 15 +++---- 6 files changed, 52 insertions(+), 47 deletions(-) rename src/{Akela-Syster.h => Kaleidoscope-Syster.h} (89%) rename src/{Akela => Kaleidoscope}/Syster.cpp (91%) rename src/{Akela => Kaleidoscope}/Syster.h (76%) diff --git a/README.md b/README.md index 4dbc9947..baacf534 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Akela-Syster +# Kaleidoscope-Syster ![status][st:experimental] @@ -21,21 +21,22 @@ To use the plugin, one needs to include the header, and set up a function that will handle the symbol actions: ```c++ -#include -#include +#include +#include +#include -void systerAction (Akela::Syster::action_t action, const char *symbol) { +void systerAction (KaleidoscopePlugins::Syster::action_t action, const char *symbol) { switch (action) { - case Akela::Syster::StartAction: + case KaleidoscopePlugins::Syster::StartAction: Unicode.type (0x2328); break; - case Akela::Syster::EndAction: + case KaleidoscopePlugins::Syster::EndAction: handle_key_event (Key_Backspace, 255, 255, IS_PRESSED | INJECTED); Keyboard.sendReport (); handle_key_event (Key_Backspace, 255, 255, WAS_PRESSED | INJECTED); Keyboard.sendReport (); break; - case Akela::Syster::SymbolAction: + case KaleidoscopePlugins::Syster::SymbolAction: Serial.print ("systerAction: symbol="); Serial.println (symbol); if (strcmp (symbol, "coffee") == 0) { @@ -48,8 +49,8 @@ void systerAction (Akela::Syster::action_t action, const char *symbol) { void setup () { Serial.begin (9600); - Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&Unicode, &Syster, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&Unicode, &Syster, NULL); } ``` @@ -66,18 +67,20 @@ methods outside of the object, however, that can be overridden: > Called whenever an action needs to be taken, which can happen in three cases: > First, when the `Syster` key is pressed, and the alternate processing starts. -> In this case, `action` will be set to `Akela::Syster::StartAction`, and -> `symbol` will be `NULL`. This function can be used to do some setup to make it -> more obvious that the Syster input mode is active, such as sending a Unicode -> symbol to the host, or lighting up LEDs, or anything else we'd like. +> In this case, `action` will be set to +> `KaleidoscopePlugins::Syster::StartAction`, and `symbol` will be `NULL`. This +> function can be used to do some setup to make it more obvious that the Syster +> input mode is active, such as sending a Unicode symbol to the host, or +> lighting up LEDs, or anything else we'd like. > > Second, when the sequence is finished with a `Space`. In this case, `action` -> will be set to `Akela::Syster::EndAction`, and `symbol` will be `NULL`. This -> can be used to undo anything that the start action did, if need be. +> will be set to `KaleidoscopePlugins::Syster::EndAction`, and `symbol` will be +> `NULL`. This can be used to undo anything that the start action did, if need +> be. > > Third, when the action for the symbol should be made. In this case, `action` -> is set to `Akela::Syster::SymbolAction`, and `symbol` will be a C string. It -> is up to us, what we do with this information, how we handle it. +> is set to `KaleidoscopePlugins::Syster::SymbolAction`, and `symbol` will be a +> C string. It is up to us, what we do with this information, how we handle it. ### `keyToChar(key)` @@ -90,4 +93,4 @@ methods outside of the object, however, that can be overridden: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/keyboardio/Akela-Syster/blob/master/examples/Syster/Syster.ino + [plugin:example]: https://github.com/keyboardio/Kaleidoscope-Syster/blob/master/examples/Syster/Syster.ino diff --git a/examples/Syster/Syster.ino b/examples/Syster/Syster.ino index a0039234..4f4f2683 100644 --- a/examples/Syster/Syster.ino +++ b/examples/Syster/Syster.ino @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Syster -- Symbolic input system * Copyright (C) 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,8 +16,9 @@ * along with this program. If not, see . */ -#include -#include +#include +#include +#include const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED @@ -40,18 +41,18 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { ), }; -void systerAction (Akela::Syster::action_t action, const char *symbol) { +void systerAction (KaleidoscopePlugins::Syster::action_t action, const char *symbol) { switch (action) { - case Akela::Syster::StartAction: + case KaleidoscopePlugins::Syster::StartAction: Unicode.type (0x2328); break; - case Akela::Syster::EndAction: + case KaleidoscopePlugins::Syster::EndAction: handle_key_event (Key_Backspace, 255, 255, IS_PRESSED | INJECTED); Keyboard.sendReport (); handle_key_event (Key_Backspace, 255, 255, WAS_PRESSED | INJECTED); Keyboard.sendReport (); break; - case Akela::Syster::SymbolAction: + case KaleidoscopePlugins::Syster::SymbolAction: Serial.print ("systerAction: symbol="); Serial.println (symbol); if (strcmp (symbol, "coffee") == 0) { @@ -62,10 +63,10 @@ void systerAction (Akela::Syster::action_t action, const char *symbol) { } void setup () { - Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&Unicode, &Syster, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&Unicode, &Syster, NULL); } void loop () { - Keyboardio.loop (); + Kaleidoscope.loop (); } diff --git a/library.properties b/library.properties index 199c1982..2efabcc2 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ -name=Akela-Syster +name=Kaleidoscope-Syster version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy -sentence=Symbolic input system for KeyboardioFirmware. +maintainer=Gergely Nagy +sentence=Symbolic input system for Kaleidoscope. paragraph=Allows inputting symbols (Unicode or otherwise) by name. category=Communication -url=https://github.com/keyboardio/Akela-Syster +url=https://github.com/keyboardio/Kaleidoscope-Syster architectures=avr dot_a_linkage=true diff --git a/src/Akela-Syster.h b/src/Kaleidoscope-Syster.h similarity index 89% rename from src/Akela-Syster.h rename to src/Kaleidoscope-Syster.h index 4ad3d2c9..197304ed 100644 --- a/src/Akela-Syster.h +++ b/src/Kaleidoscope-Syster.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Syster -- Symbolic input system * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -18,4 +18,4 @@ #pragma once -#include +#include diff --git a/src/Akela/Syster.cpp b/src/Kaleidoscope/Syster.cpp similarity index 91% rename from src/Akela/Syster.cpp rename to src/Kaleidoscope/Syster.cpp index c79f47ad..e10be5e1 100644 --- a/src/Akela/Syster.cpp +++ b/src/Kaleidoscope/Syster.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Syster -- Symbolic input system * Copyright (C) 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 -using namespace Akela::Ranges; +using namespace KaleidoscopePlugins::Ranges; -namespace Akela { +namespace KaleidoscopePlugins { // --- state --- char Syster::symbol[SYSTER_MAX_SYMBOL_LENGTH + 1]; uint8_t Syster::symbolPos; @@ -122,7 +122,7 @@ keyToChar (Key key) { __attribute__((weak)) void -systerAction (Akela::Syster::action_t action, const char *symbol) { +systerAction (KaleidoscopePlugins::Syster::action_t action, const char *symbol) { } -Akela::Syster Syster; +KaleidoscopePlugins::Syster Syster; diff --git a/src/Akela/Syster.h b/src/Kaleidoscope/Syster.h similarity index 76% rename from src/Akela/Syster.h rename to src/Kaleidoscope/Syster.h index 4c54bdc1..98903147 100644 --- a/src/Akela/Syster.h +++ b/src/Kaleidoscope/Syster.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Syster -- Symbolic input system * Copyright (C) 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -18,14 +18,15 @@ #pragma once -#include +#include +#include #define SYSTER_MAX_SYMBOL_LENGTH 32 -#define SYSTER (Key){ .raw = Akela::Ranges::SYSTER } +#define SYSTER (Key){ .raw = KaleidoscopePlugins::Ranges::SYSTER } -namespace Akela { - class Syster : public KeyboardioPlugin { +namespace KaleidoscopePlugins { + class Syster : public KaleidoscopePlugin { public: typedef enum { StartAction, @@ -48,6 +49,6 @@ namespace Akela { }; const char keyToChar (Key key); -void systerAction (Akela::Syster::action_t action, const char *symbol); +void systerAction (KaleidoscopePlugins::Syster::action_t action, const char *symbol); -extern Akela::Syster Syster; +extern KaleidoscopePlugins::Syster Syster; From d11a7829fa0a13c206727e6ad8b2a66ecdead9b1 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Feb 2017 11:28:34 +0100 Subject: [PATCH 04/38] 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 baacf534..c803cb47 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # Kaleidoscope-Syster -![status][st:experimental] +![status][st:experimental] [![Build Status][travis:image]][travis:status] + + [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-Syster.svg?branch=master + [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-Syster [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 89af9a1653f86a72971f029f71d7111e2a8f6622 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 20 Mar 2017 12:53:47 +0100 Subject: [PATCH 05/38] 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 c803cb47..c6bd4d37 100644 --- a/README.md +++ b/README.md @@ -91,6 +91,10 @@ methods outside of the object, however, that can be overridden: > the default implementation is sufficient. When using something else, you may > have to reimplement this function. +## Dependencies + +* [Kaleidoscope-Ranges](https://github.com/keyboardio/Kaleidoscope-Ranges) + ## Further reading Starting from the [example][plugin:example] is the recommended way of getting From 7c42b8e07b2aa2d14233ab9965aece5d7453c50e Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 20 Mar 2017 21:39:33 +0100 Subject: [PATCH 06/38] Fix the example Had to follow up on HostOS changes... Signed-off-by: Gergely Nagy --- examples/Syster/Syster.ino | 2 ++ 1 file changed, 2 insertions(+) diff --git a/examples/Syster/Syster.ino b/examples/Syster/Syster.ino index 4f4f2683..2b761521 100644 --- a/examples/Syster/Syster.ino +++ b/examples/Syster/Syster.ino @@ -17,6 +17,8 @@ */ #include +#include +#include #include #include From e3b5ae4012bada9ec520992e06159fe525c59ffa Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 27 Mar 2017 15:36:54 -0700 Subject: [PATCH 07/38] Update to new handle_keyswitch_event API naming --- README.md | 4 ++-- examples/Syster/Syster.ino | 4 ++-- src/Kaleidoscope/Syster.cpp | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c6bd4d37..1cc39857 100644 --- a/README.md +++ b/README.md @@ -34,9 +34,9 @@ void systerAction (KaleidoscopePlugins::Syster::action_t action, const char *sym Unicode.type (0x2328); break; case KaleidoscopePlugins::Syster::EndAction: - handle_key_event (Key_Backspace, 255, 255, IS_PRESSED | INJECTED); + handle_keyswitch_event (Key_Backspace, 255, 255, IS_PRESSED | INJECTED); Keyboard.sendReport (); - handle_key_event (Key_Backspace, 255, 255, WAS_PRESSED | INJECTED); + handle_keyswitch_event (Key_Backspace, 255, 255, WAS_PRESSED | INJECTED); Keyboard.sendReport (); break; case KaleidoscopePlugins::Syster::SymbolAction: diff --git a/examples/Syster/Syster.ino b/examples/Syster/Syster.ino index 2b761521..249f9fdd 100644 --- a/examples/Syster/Syster.ino +++ b/examples/Syster/Syster.ino @@ -49,9 +49,9 @@ void systerAction (KaleidoscopePlugins::Syster::action_t action, const char *sym Unicode.type (0x2328); break; case KaleidoscopePlugins::Syster::EndAction: - handle_key_event (Key_Backspace, 255, 255, IS_PRESSED | INJECTED); + handle_keyswitch_event (Key_Backspace, 255, 255, IS_PRESSED | INJECTED); Keyboard.sendReport (); - handle_key_event (Key_Backspace, 255, 255, WAS_PRESSED | INJECTED); + handle_keyswitch_event (Key_Backspace, 255, 255, WAS_PRESSED | INJECTED); Keyboard.sendReport (); break; case KaleidoscopePlugins::Syster::SymbolAction: diff --git a/src/Kaleidoscope/Syster.cpp b/src/Kaleidoscope/Syster.cpp index e10be5e1..ce05db1d 100644 --- a/src/Kaleidoscope/Syster.cpp +++ b/src/Kaleidoscope/Syster.cpp @@ -73,9 +73,9 @@ namespace KaleidoscopePlugins { if (key_toggled_off (keyState)) { if (mappedKey == Key_Space) { for (uint8_t i = 0; i <= symbolPos; i++) { - handle_key_event (Key_Backspace, 255, 255, IS_PRESSED | INJECTED); + handle_keyswitch_event (Key_Backspace, 255, 255, IS_PRESSED | INJECTED); Keyboard.sendReport (); - handle_key_event (Key_Backspace, 255, 255, WAS_PRESSED | INJECTED); + handle_keyswitch_event (Key_Backspace, 255, 255, WAS_PRESSED | INJECTED); Keyboard.sendReport (); } From 79f543734f4226dbe3adaa9d53129e938b50f0bf Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 27 Mar 2017 15:39:26 -0700 Subject: [PATCH 08/38] Use UNKNOWN_KEYSWITCH_LOCATION rather than a magic value --- README.md | 4 ++-- examples/Syster/Syster.ino | 4 ++-- src/Kaleidoscope/Syster.cpp | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1cc39857..64ae0396 100644 --- a/README.md +++ b/README.md @@ -34,9 +34,9 @@ void systerAction (KaleidoscopePlugins::Syster::action_t action, const char *sym Unicode.type (0x2328); break; case KaleidoscopePlugins::Syster::EndAction: - handle_keyswitch_event (Key_Backspace, 255, 255, IS_PRESSED | INJECTED); + handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); Keyboard.sendReport (); - handle_keyswitch_event (Key_Backspace, 255, 255, WAS_PRESSED | INJECTED); + handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); Keyboard.sendReport (); break; case KaleidoscopePlugins::Syster::SymbolAction: diff --git a/examples/Syster/Syster.ino b/examples/Syster/Syster.ino index 249f9fdd..9ae856fd 100644 --- a/examples/Syster/Syster.ino +++ b/examples/Syster/Syster.ino @@ -49,9 +49,9 @@ void systerAction (KaleidoscopePlugins::Syster::action_t action, const char *sym Unicode.type (0x2328); break; case KaleidoscopePlugins::Syster::EndAction: - handle_keyswitch_event (Key_Backspace, 255, 255, IS_PRESSED | INJECTED); + handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); Keyboard.sendReport (); - handle_keyswitch_event (Key_Backspace, 255, 255, WAS_PRESSED | INJECTED); + handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); Keyboard.sendReport (); break; case KaleidoscopePlugins::Syster::SymbolAction: diff --git a/src/Kaleidoscope/Syster.cpp b/src/Kaleidoscope/Syster.cpp index ce05db1d..7ad31bab 100644 --- a/src/Kaleidoscope/Syster.cpp +++ b/src/Kaleidoscope/Syster.cpp @@ -73,9 +73,9 @@ namespace KaleidoscopePlugins { if (key_toggled_off (keyState)) { if (mappedKey == Key_Space) { for (uint8_t i = 0; i <= symbolPos; i++) { - handle_keyswitch_event (Key_Backspace, 255, 255, IS_PRESSED | INJECTED); + handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); Keyboard.sendReport (); - handle_keyswitch_event (Key_Backspace, 255, 255, WAS_PRESSED | INJECTED); + handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); Keyboard.sendReport (); } From 63f30ac35ec454c0fab1edc26f1c20d7f216dbb8 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Sun, 21 May 2017 23:15:06 -0700 Subject: [PATCH 09/38] Bring Syster up to the new key names --- examples/Syster/Syster.ino | 10 +++++----- src/Kaleidoscope/Syster.cpp | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/examples/Syster/Syster.ino b/examples/Syster/Syster.ino index 9ae856fd..74a34653 100644 --- a/examples/Syster/Syster.ino +++ b/examples/Syster/Syster.ino @@ -26,19 +26,19 @@ 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_Backtick, Key_Q, Key_W, Key_E, Key_Right, 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_LGui, Key_LShift, SYSTER, 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_Left, 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_RAlt, Key_Spacebar, Key_RControl, SYSTER ), }; diff --git a/src/Kaleidoscope/Syster.cpp b/src/Kaleidoscope/Syster.cpp index 7ad31bab..be9f587a 100644 --- a/src/Kaleidoscope/Syster.cpp +++ b/src/Kaleidoscope/Syster.cpp @@ -71,7 +71,7 @@ namespace KaleidoscopePlugins { return Key_NoKey; if (key_toggled_off (keyState)) { - if (mappedKey == Key_Space) { + if (mappedKey == Key_Spacebar) { for (uint8_t i = 0; i <= symbolPos; i++) { handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); Keyboard.sendReport (); From b8225c7d2e0b42c8e4ef0316e7bb14b33d5267df Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 22 May 2017 00:09:17 -0700 Subject: [PATCH 10/38] Bring example up to new key defs --- examples/Syster/Syster.ino | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/examples/Syster/Syster.ino b/examples/Syster/Syster.ino index 74a34653..22665e02 100644 --- a/examples/Syster/Syster.ino +++ b/examples/Syster/Syster.ino @@ -26,19 +26,19 @@ 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_Right, Key_T, Key_Tab, + 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_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, - Key_LeftControl, Key_Backspace, Key_LGui, Key_LShift, + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, SYSTER, 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_Left, 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_RAlt, Key_Spacebar, Key_RControl, + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, SYSTER ), }; From df8f89924c30cb65a9f96cb4a97d116b22001679 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 23 May 2017 20:15:58 -0700 Subject: [PATCH 11/38] 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 80e27ef57a3084c5e536d2e6b1b49d20ee0b5e77 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Fri, 26 May 2017 16:20:23 -0700 Subject: [PATCH 12/38] make astyle --- examples/Syster/Syster.ino | 70 ++++++++++----------- src/Kaleidoscope/Syster.cpp | 118 ++++++++++++++++++------------------ src/Kaleidoscope/Syster.h | 10 +-- 3 files changed, 99 insertions(+), 99 deletions(-) diff --git a/examples/Syster/Syster.ino b/examples/Syster/Syster.ino index 22665e02..767c31a3 100644 --- a/examples/Syster/Syster.ino +++ b/examples/Syster/Syster.ino @@ -23,52 +23,52 @@ #include const Key keymaps[][ROWS][COLS] PROGMEM = { - [0] = KEYMAP_STACKED - ( - Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, - Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, - Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, - Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, + [0] = KEYMAP_STACKED + ( + Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, + Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, + Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, + Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, - Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, - SYSTER, + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, + SYSTER, - Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, - Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, - Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, - Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, + Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, + Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, - Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, - SYSTER - ), + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, + SYSTER + ), }; void systerAction (KaleidoscopePlugins::Syster::action_t action, const char *symbol) { - switch (action) { - case KaleidoscopePlugins::Syster::StartAction: - Unicode.type (0x2328); - break; - case KaleidoscopePlugins::Syster::EndAction: - handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); - Keyboard.sendReport (); - handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); - Keyboard.sendReport (); - break; - case KaleidoscopePlugins::Syster::SymbolAction: - Serial.print ("systerAction: symbol="); - Serial.println (symbol); - if (strcmp (symbol, "coffee") == 0) { - Unicode.type (0x2615); + switch (action) { + case KaleidoscopePlugins::Syster::StartAction: + Unicode.type (0x2328); + break; + case KaleidoscopePlugins::Syster::EndAction: + handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); + Keyboard.sendReport (); + handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); + Keyboard.sendReport (); + break; + case KaleidoscopePlugins::Syster::SymbolAction: + Serial.print ("systerAction: symbol="); + Serial.println (symbol); + if (strcmp (symbol, "coffee") == 0) { + Unicode.type (0x2615); + } + break; } - break; - } } void setup () { - Kaleidoscope.setup (KEYMAP_SIZE); - Kaleidoscope.use (&Unicode, &Syster, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&Unicode, &Syster, NULL); } void loop () { - Kaleidoscope.loop (); + Kaleidoscope.loop (); } diff --git a/src/Kaleidoscope/Syster.cpp b/src/Kaleidoscope/Syster.cpp index be9f587a..d511fb41 100644 --- a/src/Kaleidoscope/Syster.cpp +++ b/src/Kaleidoscope/Syster.cpp @@ -21,103 +21,103 @@ using namespace KaleidoscopePlugins::Ranges; namespace KaleidoscopePlugins { - // --- state --- - char Syster::symbol[SYSTER_MAX_SYMBOL_LENGTH + 1]; - uint8_t Syster::symbolPos; - bool Syster::isActive; +// --- state --- +char Syster::symbol[SYSTER_MAX_SYMBOL_LENGTH + 1]; +uint8_t Syster::symbolPos; +bool Syster::isActive; - // --- helpers --- +// --- helpers --- #define isSyster(k) (k == SYSTER) - // --- api --- +// --- api --- - Syster::Syster (void) { - } +Syster::Syster (void) { +} - void - Syster::begin (void) { +void +Syster::begin (void) { event_handler_hook_use (this->eventHandlerHook); - } +} - void - Syster::reset (void) { +void +Syster::reset (void) { symbolPos = 0; symbol[0] = 0; isActive = false; - } +} - // --- hooks --- - Key - Syster::eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState) { +// --- hooks --- +Key +Syster::eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState) { if (!isActive) { - if (!isSyster (mappedKey)) - return mappedKey; + if (!isSyster (mappedKey)) + return mappedKey; - if (key_toggled_on (keyState)) { - isActive = true; - systerAction (StartAction, NULL); - } - return Key_NoKey; + if (key_toggled_on (keyState)) { + isActive = true; + systerAction (StartAction, NULL); + } + return Key_NoKey; } if (keyState & INJECTED) - return mappedKey; + return mappedKey; if (isSyster (mappedKey)) - return Key_NoKey; + return Key_NoKey; if (mappedKey == Key_Backspace && symbolPos == 0) - return Key_NoKey; + return Key_NoKey; if (key_toggled_off (keyState)) { - if (mappedKey == Key_Spacebar) { - for (uint8_t i = 0; i <= symbolPos; i++) { - handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); - Keyboard.sendReport (); - handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); - Keyboard.sendReport (); - } + if (mappedKey == Key_Spacebar) { + for (uint8_t i = 0; i <= symbolPos; i++) { + handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); + Keyboard.sendReport (); + handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); + Keyboard.sendReport (); + } - systerAction (EndAction, NULL); + systerAction (EndAction, NULL); - symbol[symbolPos] = 0; - systerAction (SymbolAction, symbol); - reset (); + symbol[symbolPos] = 0; + systerAction (SymbolAction, symbol); + reset (); - return Key_NoKey; - } + return Key_NoKey; + } } if (key_toggled_on (keyState)) { - if (mappedKey == Key_Backspace) { - if (symbolPos > 0) - symbolPos--; - } else { - const char c = keyToChar (mappedKey); - if (c) - symbol[symbolPos++] = c; - } + if (mappedKey == Key_Backspace) { + if (symbolPos > 0) + symbolPos--; + } else { + const char c = keyToChar (mappedKey); + if (c) + symbol[symbolPos++] = c; + } } return mappedKey; - } +} }; __attribute__((weak)) const char keyToChar (Key key) { - if (key.flags != 0) - return 0; - - switch (key.keyCode) { - case Key_A.keyCode ... Key_Z.keyCode: - return 'a' + (key.keyCode - Key_A.keyCode); - case Key_1.keyCode ... Key_0.keyCode: - return '1' + (key.keyCode - Key_1.keyCode); - } + if (key.flags != 0) + return 0; + + switch (key.keyCode) { + case Key_A.keyCode ... Key_Z.keyCode: + return 'a' + (key.keyCode - Key_A.keyCode); + case Key_1.keyCode ... Key_0.keyCode: + return '1' + (key.keyCode - Key_1.keyCode); + } - return 0; + return 0; } __attribute__((weak)) diff --git a/src/Kaleidoscope/Syster.h b/src/Kaleidoscope/Syster.h index 98903147..a398d40c 100644 --- a/src/Kaleidoscope/Syster.h +++ b/src/Kaleidoscope/Syster.h @@ -26,12 +26,12 @@ #define SYSTER (Key){ .raw = KaleidoscopePlugins::Ranges::SYSTER } namespace KaleidoscopePlugins { - class Syster : public KaleidoscopePlugin { +class Syster : public KaleidoscopePlugin { public: typedef enum { - StartAction, - EndAction, - SymbolAction + StartAction, + EndAction, + SymbolAction } action_t; Syster (void); @@ -45,7 +45,7 @@ namespace KaleidoscopePlugins { static bool isActive; static Key eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState); - }; +}; }; const char keyToChar (Key key); From a497d6726786f47109fcf8890e57c588fa4b7c5e Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Fri, 2 Jun 2017 23:43:06 -0700 Subject: [PATCH 13/38] Make the linter happy --- src/Kaleidoscope/Syster.cpp | 2 +- src/Kaleidoscope/Syster.h | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Kaleidoscope/Syster.cpp b/src/Kaleidoscope/Syster.cpp index d511fb41..f729bc25 100644 --- a/src/Kaleidoscope/Syster.cpp +++ b/src/Kaleidoscope/Syster.cpp @@ -18,7 +18,7 @@ #include -using namespace KaleidoscopePlugins::Ranges; +using KaleidoscopePlugins::Ranges; namespace KaleidoscopePlugins { // --- state --- diff --git a/src/Kaleidoscope/Syster.h b/src/Kaleidoscope/Syster.h index a398d40c..83c420df 100644 --- a/src/Kaleidoscope/Syster.h +++ b/src/Kaleidoscope/Syster.h @@ -36,7 +36,7 @@ class Syster : public KaleidoscopePlugin { Syster (void); - virtual void begin (void) final; + void begin (void) final; static void reset (void); private: From 5609a40db3a70b0aedef1b5874c2853fbf782ee4 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Sat, 3 Jun 2017 02:44:55 -0700 Subject: [PATCH 14/38] revert this change. it doesn't pass the linter, but it does actually work --- src/Kaleidoscope/Syster.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/Syster.cpp b/src/Kaleidoscope/Syster.cpp index f729bc25..d511fb41 100644 --- a/src/Kaleidoscope/Syster.cpp +++ b/src/Kaleidoscope/Syster.cpp @@ -18,7 +18,7 @@ #include -using KaleidoscopePlugins::Ranges; +using namespace KaleidoscopePlugins::Ranges; namespace KaleidoscopePlugins { // --- state --- From d77b1a5c41ffa34451dd5686db2bb06613af6cc9 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Sat, 3 Jun 2017 02:54:04 -0700 Subject: [PATCH 15/38] make astyle --- examples/Syster/Syster.ino | 76 +++++++++++------------ src/Kaleidoscope/Syster.cpp | 120 ++++++++++++++++++------------------ src/Kaleidoscope/Syster.h | 32 +++++----- 3 files changed, 114 insertions(+), 114 deletions(-) diff --git a/examples/Syster/Syster.ino b/examples/Syster/Syster.ino index 767c31a3..9a8911d3 100644 --- a/examples/Syster/Syster.ino +++ b/examples/Syster/Syster.ino @@ -23,52 +23,52 @@ #include const Key keymaps[][ROWS][COLS] PROGMEM = { - [0] = KEYMAP_STACKED - ( - Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, - Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, - Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, - Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, + [0] = KEYMAP_STACKED + ( + Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, + Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, + Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, + Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, - Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, - SYSTER, + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, + SYSTER, - Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, - Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, - Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, - Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, + Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, + Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, - Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, - SYSTER - ), + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, + SYSTER + ), }; -void systerAction (KaleidoscopePlugins::Syster::action_t action, const char *symbol) { - switch (action) { - case KaleidoscopePlugins::Syster::StartAction: - Unicode.type (0x2328); - break; - case KaleidoscopePlugins::Syster::EndAction: - handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); - Keyboard.sendReport (); - handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); - Keyboard.sendReport (); - break; - case KaleidoscopePlugins::Syster::SymbolAction: - Serial.print ("systerAction: symbol="); - Serial.println (symbol); - if (strcmp (symbol, "coffee") == 0) { - Unicode.type (0x2615); - } - break; +void systerAction(KaleidoscopePlugins::Syster::action_t action, const char *symbol) { + switch (action) { + case KaleidoscopePlugins::Syster::StartAction: + Unicode.type(0x2328); + break; + case KaleidoscopePlugins::Syster::EndAction: + handle_keyswitch_event(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); + Keyboard.sendReport(); + handle_keyswitch_event(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); + Keyboard.sendReport(); + break; + case KaleidoscopePlugins::Syster::SymbolAction: + Serial.print("systerAction: symbol="); + Serial.println(symbol); + if (strcmp(symbol, "coffee") == 0) { + Unicode.type(0x2615); } + break; + } } -void setup () { - Kaleidoscope.setup (KEYMAP_SIZE); - Kaleidoscope.use (&Unicode, &Syster, NULL); +void setup() { + Kaleidoscope.setup(KEYMAP_SIZE); + Kaleidoscope.use(&Unicode, &Syster, NULL); } -void loop () { - Kaleidoscope.loop (); +void loop() { + Kaleidoscope.loop(); } diff --git a/src/Kaleidoscope/Syster.cpp b/src/Kaleidoscope/Syster.cpp index d511fb41..93aefa1a 100644 --- a/src/Kaleidoscope/Syster.cpp +++ b/src/Kaleidoscope/Syster.cpp @@ -32,97 +32,97 @@ bool Syster::isActive; // --- api --- -Syster::Syster (void) { +Syster::Syster(void) { } void -Syster::begin (void) { - event_handler_hook_use (this->eventHandlerHook); +Syster::begin(void) { + event_handler_hook_use(this->eventHandlerHook); } void -Syster::reset (void) { - symbolPos = 0; - symbol[0] = 0; - isActive = false; +Syster::reset(void) { + symbolPos = 0; + symbol[0] = 0; + isActive = false; } // --- hooks --- Key -Syster::eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState) { - if (!isActive) { - if (!isSyster (mappedKey)) - return mappedKey; - - if (key_toggled_on (keyState)) { - isActive = true; - systerAction (StartAction, NULL); - } - return Key_NoKey; +Syster::eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keyState) { + if (!isActive) { + if (!isSyster(mappedKey)) + return mappedKey; + + if (key_toggled_on(keyState)) { + isActive = true; + systerAction(StartAction, NULL); } + return Key_NoKey; + } - if (keyState & INJECTED) - return mappedKey; + if (keyState & INJECTED) + return mappedKey; - if (isSyster (mappedKey)) - return Key_NoKey; + if (isSyster(mappedKey)) + return Key_NoKey; - if (mappedKey == Key_Backspace && symbolPos == 0) - return Key_NoKey; + if (mappedKey == Key_Backspace && symbolPos == 0) + return Key_NoKey; - if (key_toggled_off (keyState)) { - if (mappedKey == Key_Spacebar) { - for (uint8_t i = 0; i <= symbolPos; i++) { - handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); - Keyboard.sendReport (); - handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); - Keyboard.sendReport (); - } + if (key_toggled_off(keyState)) { + if (mappedKey == Key_Spacebar) { + for (uint8_t i = 0; i <= symbolPos; i++) { + handle_keyswitch_event(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); + Keyboard.sendReport(); + handle_keyswitch_event(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); + Keyboard.sendReport(); + } - systerAction (EndAction, NULL); + systerAction(EndAction, NULL); - symbol[symbolPos] = 0; - systerAction (SymbolAction, symbol); - reset (); + symbol[symbolPos] = 0; + systerAction(SymbolAction, symbol); + reset(); - return Key_NoKey; - } + return Key_NoKey; } - - if (key_toggled_on (keyState)) { - if (mappedKey == Key_Backspace) { - if (symbolPos > 0) - symbolPos--; - } else { - const char c = keyToChar (mappedKey); - if (c) - symbol[symbolPos++] = c; - } + } + + if (key_toggled_on(keyState)) { + if (mappedKey == Key_Backspace) { + if (symbolPos > 0) + symbolPos--; + } else { + const char c = keyToChar(mappedKey); + if (c) + symbol[symbolPos++] = c; } + } - return mappedKey; + return mappedKey; } }; __attribute__((weak)) const char -keyToChar (Key key) { - if (key.flags != 0) - return 0; - - switch (key.keyCode) { - case Key_A.keyCode ... Key_Z.keyCode: - return 'a' + (key.keyCode - Key_A.keyCode); - case Key_1.keyCode ... Key_0.keyCode: - return '1' + (key.keyCode - Key_1.keyCode); - } - +keyToChar(Key key) { + if (key.flags != 0) return 0; + + switch (key.keyCode) { + case Key_A.keyCode ... Key_Z.keyCode: + return 'a' + (key.keyCode - Key_A.keyCode); + case Key_1.keyCode ... Key_0.keyCode: + return '1' + (key.keyCode - Key_1.keyCode); + } + + return 0; } __attribute__((weak)) void -systerAction (KaleidoscopePlugins::Syster::action_t action, const char *symbol) { +systerAction(KaleidoscopePlugins::Syster::action_t action, const char *symbol) { } KaleidoscopePlugins::Syster Syster; diff --git a/src/Kaleidoscope/Syster.h b/src/Kaleidoscope/Syster.h index 83c420df..8781440c 100644 --- a/src/Kaleidoscope/Syster.h +++ b/src/Kaleidoscope/Syster.h @@ -27,28 +27,28 @@ namespace KaleidoscopePlugins { class Syster : public KaleidoscopePlugin { - public: - typedef enum { - StartAction, - EndAction, - SymbolAction - } action_t; + public: + typedef enum { + StartAction, + EndAction, + SymbolAction + } action_t; - Syster (void); + Syster(void); - void begin (void) final; - static void reset (void); + void begin(void) final; + static void reset(void); - private: - static char symbol[SYSTER_MAX_SYMBOL_LENGTH + 1]; - static uint8_t symbolPos; - static bool isActive; + private: + static char symbol[SYSTER_MAX_SYMBOL_LENGTH + 1]; + static uint8_t symbolPos; + static bool isActive; - static Key eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState); + static Key eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keyState); }; }; -const char keyToChar (Key key); -void systerAction (KaleidoscopePlugins::Syster::action_t action, const char *symbol); +const char keyToChar(Key key); +void systerAction(KaleidoscopePlugins::Syster::action_t action, const char *symbol); extern KaleidoscopePlugins::Syster Syster; From 6e8b932c0d0fd703ce351222d9df54da4e7bdccb Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 5 Jun 2017 11:52:41 +0200 Subject: [PATCH 16/38] Kaleidoscope Style Guide conformance ...and an update to use the new Ranges APIs. Signed-off-by: Gergely Nagy --- README.md | 41 +++++++++-------- examples/Syster/Syster.ino | 16 +++---- src/Kaleidoscope/Syster.cpp | 88 +++++++++++++++++-------------------- src/Kaleidoscope/Syster.h | 17 +++---- 4 files changed, 78 insertions(+), 84 deletions(-) diff --git a/README.md b/README.md index 64ae0396..299a2845 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,9 @@ [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-Syster.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-Syster - [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 Syster is a way to input symbols in a different way: instead of macros, Leader sequences or the like, we trigger the special input mode, and enter the symbol's @@ -28,18 +28,18 @@ will handle the symbol actions: #include #include -void systerAction (KaleidoscopePlugins::Syster::action_t action, const char *symbol) { +void systerAction(kaleidoscope::Syster::action_t action, const char *symbol) { switch (action) { - case KaleidoscopePlugins::Syster::StartAction: + case kaleidoscope::Syster::StartAction: Unicode.type (0x2328); break; - case KaleidoscopePlugins::Syster::EndAction: + case kaleidoscope::Syster::EndAction: handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); Keyboard.sendReport (); handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); Keyboard.sendReport (); break; - case KaleidoscopePlugins::Syster::SymbolAction: + case kaleidoscope::Syster::SymbolAction: Serial.print ("systerAction: symbol="); Serial.println (symbol); if (strcmp (symbol, "coffee") == 0) { @@ -49,11 +49,12 @@ void systerAction (KaleidoscopePlugins::Syster::action_t action, const char *sym } } -void setup () { - Serial.begin (9600); +void setup() { + Serial.begin(9600); + + USE_PLUGINS(&Unicode, &Syster); - Kaleidoscope.setup (KEYMAP_SIZE); - Kaleidoscope.use (&Unicode, &Syster, NULL); + Kaleidoscope.setup (); } ``` @@ -70,20 +71,18 @@ methods outside of the object, however, that can be overridden: > Called whenever an action needs to be taken, which can happen in three cases: > First, when the `Syster` key is pressed, and the alternate processing starts. -> In this case, `action` will be set to -> `KaleidoscopePlugins::Syster::StartAction`, and `symbol` will be `NULL`. This -> function can be used to do some setup to make it more obvious that the Syster -> input mode is active, such as sending a Unicode symbol to the host, or -> lighting up LEDs, or anything else we'd like. +> In this case, `action` will be set to `kaleidoscope::Syster::StartAction`, and +> `symbol` will be `NULL`. This function can be used to do some setup to make it +> more obvious that the Syster input mode is active, such as sending a Unicode +> symbol to the host, or lighting up LEDs, or anything else we'd like. > > Second, when the sequence is finished with a `Space`. In this case, `action` -> will be set to `KaleidoscopePlugins::Syster::EndAction`, and `symbol` will be -> `NULL`. This can be used to undo anything that the start action did, if need -> be. +> will be set to `kaleidoscope::Syster::EndAction`, and `symbol` will be `NULL`. +> This can be used to undo anything that the start action did, if need be. > > Third, when the action for the symbol should be made. In this case, `action` -> is set to `KaleidoscopePlugins::Syster::SymbolAction`, and `symbol` will be a -> C string. It is up to us, what we do with this information, how we handle it. +> is set to `kaleidoscope::Syster::SymbolAction`, and `symbol` will be a C +> string. It is up to us, what we do with this information, how we handle it. ### `keyToChar(key)` diff --git a/examples/Syster/Syster.ino b/examples/Syster/Syster.ino index 9a8911d3..8c6fc011 100644 --- a/examples/Syster/Syster.ino +++ b/examples/Syster/Syster.ino @@ -39,22 +39,21 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, - SYSTER - ), + SYSTER), }; -void systerAction(KaleidoscopePlugins::Syster::action_t action, const char *symbol) { +void systerAction(kaleidoscope::Syster::action_t action, const char *symbol) { switch (action) { - case KaleidoscopePlugins::Syster::StartAction: + case kaleidoscope::Syster::StartAction: Unicode.type(0x2328); break; - case KaleidoscopePlugins::Syster::EndAction: + case kaleidoscope::Syster::EndAction: handle_keyswitch_event(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); Keyboard.sendReport(); handle_keyswitch_event(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); Keyboard.sendReport(); break; - case KaleidoscopePlugins::Syster::SymbolAction: + case kaleidoscope::Syster::SymbolAction: Serial.print("systerAction: symbol="); Serial.println(symbol); if (strcmp(symbol, "coffee") == 0) { @@ -65,8 +64,9 @@ void systerAction(KaleidoscopePlugins::Syster::action_t action, const char *symb } void setup() { - Kaleidoscope.setup(KEYMAP_SIZE); - Kaleidoscope.use(&Unicode, &Syster, NULL); + USE_PLUGINS(&Unicode, &Syster); + + Kaleidoscope.setup(); } void loop() { diff --git a/src/Kaleidoscope/Syster.cpp b/src/Kaleidoscope/Syster.cpp index 93aefa1a..9b9ec3a8 100644 --- a/src/Kaleidoscope/Syster.cpp +++ b/src/Kaleidoscope/Syster.cpp @@ -18,61 +18,58 @@ #include -using namespace KaleidoscopePlugins::Ranges; +#undef SYSTER + +namespace kaleidoscope { -namespace KaleidoscopePlugins { // --- state --- -char Syster::symbol[SYSTER_MAX_SYMBOL_LENGTH + 1]; -uint8_t Syster::symbolPos; -bool Syster::isActive; +char Syster::symbol_[SYSTER_MAX_SYMBOL_LENGTH + 1]; +uint8_t Syster::symbol_pos_; +bool Syster::is_active_; // --- helpers --- - -#define isSyster(k) (k == SYSTER) +#define isSyster(k) (k == kaleidoscope::ranges::SYSTER) // --- api --- Syster::Syster(void) { } -void -Syster::begin(void) { - event_handler_hook_use(this->eventHandlerHook); +void Syster::begin(void) { + event_handler_hook_use(eventHandlerHook); } -void -Syster::reset(void) { - symbolPos = 0; - symbol[0] = 0; - isActive = false; +void Syster::reset(void) { + symbol_pos_ = 0; + symbol_[0] = 0; + is_active_ = false; } // --- hooks --- -Key -Syster::eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keyState) { - if (!isActive) { - if (!isSyster(mappedKey)) - return mappedKey; - - if (key_toggled_on(keyState)) { - isActive = true; +Key Syster::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state) { + if (!is_active_) { + if (!isSyster(mapped_key)) + return mapped_key; + + if (key_toggled_on(key_state)) { + is_active_ = true; systerAction(StartAction, NULL); } return Key_NoKey; } - if (keyState & INJECTED) - return mappedKey; + if (key_state & INJECTED) + return mapped_key; - if (isSyster(mappedKey)) + if (isSyster(mapped_key)) return Key_NoKey; - if (mappedKey == Key_Backspace && symbolPos == 0) + if (mapped_key == Key_Backspace && symbol_pos_ == 0) return Key_NoKey; - if (key_toggled_off(keyState)) { - if (mappedKey == Key_Spacebar) { - for (uint8_t i = 0; i <= symbolPos; i++) { + if (key_toggled_off(key_state)) { + if (mapped_key == Key_Spacebar) { + for (uint8_t i = 0; i <= symbol_pos_; i++) { handle_keyswitch_event(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); Keyboard.sendReport(); handle_keyswitch_event(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); @@ -81,32 +78,31 @@ Syster::eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keyState) { systerAction(EndAction, NULL); - symbol[symbolPos] = 0; - systerAction(SymbolAction, symbol); + symbol_[symbol_pos_] = 0; + systerAction(SymbolAction, symbol_); reset(); return Key_NoKey; } } - if (key_toggled_on(keyState)) { - if (mappedKey == Key_Backspace) { - if (symbolPos > 0) - symbolPos--; + if (key_toggled_on(key_state)) { + if (mapped_key == Key_Backspace) { + if (symbol_pos_ > 0) + symbol_pos_--; } else { - const char c = keyToChar(mappedKey); + const char c = keyToChar(mapped_key); if (c) - symbol[symbolPos++] = c; + symbol_[symbol_pos_++] = c; } } - return mappedKey; + return mapped_key; +} + } -}; -__attribute__((weak)) -const char -keyToChar(Key key) { +__attribute__((weak)) const char keyToChar(Key key) { if (key.flags != 0) return 0; @@ -120,9 +116,7 @@ keyToChar(Key key) { return 0; } -__attribute__((weak)) -void -systerAction(KaleidoscopePlugins::Syster::action_t action, const char *symbol) { +__attribute__((weak)) void systerAction(kaleidoscope::Syster::action_t action, const char *symbol) { } -KaleidoscopePlugins::Syster Syster; +kaleidoscope::Syster Syster; diff --git a/src/Kaleidoscope/Syster.h b/src/Kaleidoscope/Syster.h index 8781440c..35d8f825 100644 --- a/src/Kaleidoscope/Syster.h +++ b/src/Kaleidoscope/Syster.h @@ -23,9 +23,10 @@ #define SYSTER_MAX_SYMBOL_LENGTH 32 -#define SYSTER (Key){ .raw = KaleidoscopePlugins::Ranges::SYSTER } +#define SYSTER ((Key) { .raw = kaleidoscope::ranges::SYSTER }) + +namespace kaleidoscope { -namespace KaleidoscopePlugins { class Syster : public KaleidoscopePlugin { public: typedef enum { @@ -40,15 +41,15 @@ class Syster : public KaleidoscopePlugin { static void reset(void); private: - static char symbol[SYSTER_MAX_SYMBOL_LENGTH + 1]; - static uint8_t symbolPos; - static bool isActive; + static char symbol_[SYSTER_MAX_SYMBOL_LENGTH + 1]; + static uint8_t symbol_pos_; + static bool is_active_; - static Key eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keyState); + static Key eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state); }; }; const char keyToChar(Key key); -void systerAction(KaleidoscopePlugins::Syster::action_t action, const char *symbol); +void systerAction(kaleidoscope::Syster::action_t action, const char *symbol); -extern KaleidoscopePlugins::Syster Syster; +extern kaleidoscope::Syster Syster; From 76bf5159c83247475cfef39e2888f3cbf8da6b23 Mon Sep 17 00:00:00 2001 From: James Cash Date: Mon, 17 Jul 2017 16:45:11 -0400 Subject: [PATCH 17/38] Fix little typo in README.md typo "with" -> "witch" plus some comma usage. --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 299a2845..49e51c89 100644 --- a/README.md +++ b/README.md @@ -15,12 +15,12 @@ name. Once finished, we hit `Space`, and this plugin will do the rest: delete everything we typed, look up an action for the entered symbol, and execute that. There are a number of ways this can be useful, but the easiest showcase is -symbolic Unicode input: `SYSTER coffee SPACE` turns into `☕`, witch just a +symbolic Unicode input: `SYSTER coffee SPACE` turns into `☕`, with just a little code. ## Using the plugin -To use the plugin, one needs to include the header, and set up a function that +To use the plugin, one needs to include the header and set up a function that will handle the symbol actions: ```c++ @@ -70,14 +70,14 @@ methods outside of the object, however, that can be overridden: > Called whenever an action needs to be taken, which can happen in three cases: -> First, when the `Syster` key is pressed, and the alternate processing starts. +> First, when the `Syster` key is pressed and the alternate processing starts. > In this case, `action` will be set to `kaleidoscope::Syster::StartAction`, and > `symbol` will be `NULL`. This function can be used to do some setup to make it > more obvious that the Syster input mode is active, such as sending a Unicode > symbol to the host, or lighting up LEDs, or anything else we'd like. > > Second, when the sequence is finished with a `Space`. In this case, `action` -> will be set to `kaleidoscope::Syster::EndAction`, and `symbol` will be `NULL`. +> will be set to `kaleidoscope::Syster::EndAction` and `symbol` will be `NULL`. > This can be used to undo anything that the start action did, if need be. > > Third, when the action for the symbol should be made. In this case, `action` From 25cd093f184abd2d77871f62a72fa10245606700 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 24 Jul 2017 13:57:37 -0700 Subject: [PATCH 18/38] keyToggledO* camelcasing --- src/Kaleidoscope/Syster.cpp | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/Kaleidoscope/Syster.cpp b/src/Kaleidoscope/Syster.cpp index 9b9ec3a8..cbfa2c06 100644 --- a/src/Kaleidoscope/Syster.cpp +++ b/src/Kaleidoscope/Syster.cpp @@ -51,7 +51,7 @@ Key Syster::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_sta if (!isSyster(mapped_key)) return mapped_key; - if (key_toggled_on(key_state)) { + if (keyToggledOn(key_state)) { is_active_ = true; systerAction(StartAction, NULL); } @@ -67,7 +67,7 @@ Key Syster::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_sta if (mapped_key == Key_Backspace && symbol_pos_ == 0) return Key_NoKey; - if (key_toggled_off(key_state)) { + if (keyToggledOff(key_state)) { if (mapped_key == Key_Spacebar) { for (uint8_t i = 0; i <= symbol_pos_; i++) { handle_keyswitch_event(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); @@ -86,7 +86,7 @@ Key Syster::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_sta } } - if (key_toggled_on(key_state)) { + if (keyToggledOn(key_state)) { if (mapped_key == Key_Backspace) { if (symbol_pos_ > 0) symbol_pos_--; From 0235d41ae046bcb4c08721f41cdf19cce91cf72e Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 24 Jul 2017 14:41:47 -0700 Subject: [PATCH 19/38] CamelCase of handle_*_key* --- README.md | 4 ++-- examples/Syster/Syster.ino | 4 ++-- src/Kaleidoscope/Syster.cpp | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 49e51c89..8c90e1df 100644 --- a/README.md +++ b/README.md @@ -34,9 +34,9 @@ void systerAction(kaleidoscope::Syster::action_t action, const char *symbol) { Unicode.type (0x2328); break; case kaleidoscope::Syster::EndAction: - handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); + handleKeyswitchEvent (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); Keyboard.sendReport (); - handle_keyswitch_event (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); + handleKeyswitchEvent (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); Keyboard.sendReport (); break; case kaleidoscope::Syster::SymbolAction: diff --git a/examples/Syster/Syster.ino b/examples/Syster/Syster.ino index 8c6fc011..abdc87e3 100644 --- a/examples/Syster/Syster.ino +++ b/examples/Syster/Syster.ino @@ -48,9 +48,9 @@ void systerAction(kaleidoscope::Syster::action_t action, const char *symbol) { Unicode.type(0x2328); break; case kaleidoscope::Syster::EndAction: - handle_keyswitch_event(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); + handleKeyswitchEvent(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); Keyboard.sendReport(); - handle_keyswitch_event(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); + handleKeyswitchEvent(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); Keyboard.sendReport(); break; case kaleidoscope::Syster::SymbolAction: diff --git a/src/Kaleidoscope/Syster.cpp b/src/Kaleidoscope/Syster.cpp index cbfa2c06..57c1e102 100644 --- a/src/Kaleidoscope/Syster.cpp +++ b/src/Kaleidoscope/Syster.cpp @@ -70,9 +70,9 @@ Key Syster::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_sta if (keyToggledOff(key_state)) { if (mapped_key == Key_Spacebar) { for (uint8_t i = 0; i <= symbol_pos_; i++) { - handle_keyswitch_event(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); + handleKeyswitchEvent(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); Keyboard.sendReport(); - handle_keyswitch_event(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); + handleKeyswitchEvent(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); Keyboard.sendReport(); } From 6b6cbd4803fdba34b55df9534e7eb5fbf48a2757 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 25 Jul 2017 14:30:44 -0700 Subject: [PATCH 20/38] port to new hid facade --- README.md | 5 +++-- examples/Syster/Syster.ino | 5 +++-- src/Kaleidoscope/Syster.cpp | 5 +++-- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8c90e1df..3f6790ff 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,7 @@ will handle the symbol actions: #include #include #include +#include void systerAction(kaleidoscope::Syster::action_t action, const char *symbol) { switch (action) { @@ -35,9 +36,9 @@ void systerAction(kaleidoscope::Syster::action_t action, const char *symbol) { break; case kaleidoscope::Syster::EndAction: handleKeyswitchEvent (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); - Keyboard.sendReport (); + kaleidoscope::hid::sendKeyboardReport (); handleKeyswitchEvent (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); - Keyboard.sendReport (); + kaleidoscope::hid::sendKeyboardReport (); break; case kaleidoscope::Syster::SymbolAction: Serial.print ("systerAction: symbol="); diff --git a/examples/Syster/Syster.ino b/examples/Syster/Syster.ino index abdc87e3..9d7589d3 100644 --- a/examples/Syster/Syster.ino +++ b/examples/Syster/Syster.ino @@ -21,6 +21,7 @@ #include #include #include +#include const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED @@ -49,9 +50,9 @@ void systerAction(kaleidoscope::Syster::action_t action, const char *symbol) { break; case kaleidoscope::Syster::EndAction: handleKeyswitchEvent(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); - Keyboard.sendReport(); + kaleidoscope::hid::sendKeyboardReport(); handleKeyswitchEvent(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); - Keyboard.sendReport(); + kaleidoscope::hid::sendKeyboardReport(); break; case kaleidoscope::Syster::SymbolAction: Serial.print("systerAction: symbol="); diff --git a/src/Kaleidoscope/Syster.cpp b/src/Kaleidoscope/Syster.cpp index 57c1e102..4e5a8a08 100644 --- a/src/Kaleidoscope/Syster.cpp +++ b/src/Kaleidoscope/Syster.cpp @@ -17,6 +17,7 @@ */ #include +#include #undef SYSTER @@ -71,9 +72,9 @@ Key Syster::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_sta if (mapped_key == Key_Spacebar) { for (uint8_t i = 0; i <= symbol_pos_; i++) { handleKeyswitchEvent(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); - Keyboard.sendReport(); + hid::sendKeyboardReport(); handleKeyswitchEvent(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); - Keyboard.sendReport(); + hid::sendKeyboardReport(); } systerAction(EndAction, NULL); From f394c7d0ccf08fddfec941d00f46bcf1cea834f6 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 25 Jul 2017 15:52:19 -0700 Subject: [PATCH 21/38] 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 068c33d18c6e1b711ea726bf33ee21f9bcecc50d Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 17 Aug 2017 12:39:48 +0200 Subject: [PATCH 22/38] Stop using deprecated interfaces Use `Kaleidoscope.use` and `Kaleidoscope.useEventHandlerHook` instead of the deprecated `USE_PLUGINS` and `event_handler_hook_use` interfaces. Signed-off-by: Gergely Nagy --- README.md | 4 ++-- examples/Syster/Syster.ino | 2 +- src/Kaleidoscope/Syster.cpp | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3f6790ff..500013ef 100644 --- a/README.md +++ b/README.md @@ -52,8 +52,8 @@ void systerAction(kaleidoscope::Syster::action_t action, const char *symbol) { void setup() { Serial.begin(9600); - - USE_PLUGINS(&Unicode, &Syster); + + Kaleidoscope.use(&Unicode, &Syster); Kaleidoscope.setup (); } diff --git a/examples/Syster/Syster.ino b/examples/Syster/Syster.ino index 9d7589d3..76d13296 100644 --- a/examples/Syster/Syster.ino +++ b/examples/Syster/Syster.ino @@ -65,7 +65,7 @@ void systerAction(kaleidoscope::Syster::action_t action, const char *symbol) { } void setup() { - USE_PLUGINS(&Unicode, &Syster); + Kaleidoscope.use(&Unicode, &Syster); Kaleidoscope.setup(); } diff --git a/src/Kaleidoscope/Syster.cpp b/src/Kaleidoscope/Syster.cpp index 4e5a8a08..7c6ff5cb 100644 --- a/src/Kaleidoscope/Syster.cpp +++ b/src/Kaleidoscope/Syster.cpp @@ -37,7 +37,7 @@ Syster::Syster(void) { } void Syster::begin(void) { - event_handler_hook_use(eventHandlerHook); + Kaleidoscope.useEventHandlerHook(eventHandlerHook); } void Syster::reset(void) { From 9694ce9221b4d741ae45a72f383be996af64c858 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 21 Aug 2017 22:25:26 -0700 Subject: [PATCH 23/38] 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 33717489b504b77f3b44963b05c43cf5dc7eb696 Mon Sep 17 00:00:00 2001 From: Iliana Weller Date: Tue, 13 Feb 2018 06:15:13 -0800 Subject: [PATCH 24/38] Add public getter `is_active` --- src/Kaleidoscope/Syster.cpp | 4 ++++ src/Kaleidoscope/Syster.h | 2 ++ 2 files changed, 6 insertions(+) diff --git a/src/Kaleidoscope/Syster.cpp b/src/Kaleidoscope/Syster.cpp index 7c6ff5cb..396607c6 100644 --- a/src/Kaleidoscope/Syster.cpp +++ b/src/Kaleidoscope/Syster.cpp @@ -46,6 +46,10 @@ void Syster::reset(void) { is_active_ = false; } +bool Syster::is_active(void) { + return is_active_; +} + // --- hooks --- Key Syster::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state) { if (!is_active_) { diff --git a/src/Kaleidoscope/Syster.h b/src/Kaleidoscope/Syster.h index 35d8f825..83605be9 100644 --- a/src/Kaleidoscope/Syster.h +++ b/src/Kaleidoscope/Syster.h @@ -40,6 +40,8 @@ class Syster : public KaleidoscopePlugin { void begin(void) final; static void reset(void); + bool is_active(void); + private: static char symbol_[SYSTER_MAX_SYMBOL_LENGTH + 1]; static uint8_t symbol_pos_; From 8f2d4f360a4f9069969455065952222e2f632b02 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 13 May 2018 22:08:30 +0200 Subject: [PATCH 25/38] Updated to use the new plugin APIs Signed-off-by: Gergely Nagy --- README.md | 5 ++-- examples/Syster/Syster.ino | 12 +++++--- src/Kaleidoscope/Syster.cpp | 55 +++++++++++++++++++++---------------- src/Kaleidoscope/Syster.h | 17 ++++++++---- 4 files changed, 53 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 500013ef..d23f3549 100644 --- a/README.md +++ b/README.md @@ -50,11 +50,10 @@ void systerAction(kaleidoscope::Syster::action_t action, const char *symbol) { } } +KALEIDOSCOPE_INIT_PLUGINS(Unicode, Syster); + void setup() { Serial.begin(9600); - - Kaleidoscope.use(&Unicode, &Syster); - Kaleidoscope.setup (); } ``` diff --git a/examples/Syster/Syster.ino b/examples/Syster/Syster.ino index 76d13296..ea823f2a 100644 --- a/examples/Syster/Syster.ino +++ b/examples/Syster/Syster.ino @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Syster -- Symbolic input system - * Copyright (C) 2017 Gergely Nagy + * Copyright (C) 2017, 2018 Gergely Nagy * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -23,6 +23,7 @@ #include #include +// *INDENT-OFF* const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED ( @@ -36,12 +37,13 @@ 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, SYSTER), }; +// *INDENT-ON* void systerAction(kaleidoscope::Syster::action_t action, const char *symbol) { switch (action) { @@ -64,9 +66,11 @@ void systerAction(kaleidoscope::Syster::action_t action, const char *symbol) { } } -void setup() { - Kaleidoscope.use(&Unicode, &Syster); +KALEIDOSCOPE_INIT_PLUGINS(HostOS, + Unicode, + Syster); +void setup() { Kaleidoscope.setup(); } diff --git a/src/Kaleidoscope/Syster.cpp b/src/Kaleidoscope/Syster.cpp index 396607c6..08818ef6 100644 --- a/src/Kaleidoscope/Syster.cpp +++ b/src/Kaleidoscope/Syster.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Syster -- Symbolic input system - * Copyright (C) 2017 Gergely Nagy + * Copyright (C) 2017, 2018 Gergely Nagy * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -32,14 +32,6 @@ bool Syster::is_active_; #define isSyster(k) (k == kaleidoscope::ranges::SYSTER) // --- api --- - -Syster::Syster(void) { -} - -void Syster::begin(void) { - Kaleidoscope.useEventHandlerHook(eventHandlerHook); -} - void Syster::reset(void) { symbol_pos_ = 0; symbol_[0] = 0; @@ -51,28 +43,30 @@ bool Syster::is_active(void) { } // --- hooks --- -Key Syster::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state) { +EventHandlerResult Syster::onKeyswitchEvent(Key &mapped_key, byte row, byte col, uint8_t keyState) { if (!is_active_) { if (!isSyster(mapped_key)) - return mapped_key; + return EventHandlerResult::OK; - if (keyToggledOn(key_state)) { + if (keyToggledOn(keyState)) { is_active_ = true; systerAction(StartAction, NULL); } - return Key_NoKey; + return EventHandlerResult::EVENT_CONSUMED; } - if (key_state & INJECTED) - return mapped_key; + if (keyState & INJECTED) + return EventHandlerResult::OK; - if (isSyster(mapped_key)) - return Key_NoKey; + if (isSyster(mapped_key)) { + return EventHandlerResult::EVENT_CONSUMED; + } - if (mapped_key == Key_Backspace && symbol_pos_ == 0) - return Key_NoKey; + if (mapped_key == Key_Backspace && symbol_pos_ == 0) { + return EventHandlerResult::EVENT_CONSUMED; + } - if (keyToggledOff(key_state)) { + if (keyToggledOff(keyState)) { if (mapped_key == Key_Spacebar) { for (uint8_t i = 0; i <= symbol_pos_; i++) { handleKeyswitchEvent(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); @@ -87,11 +81,11 @@ Key Syster::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_sta systerAction(SymbolAction, symbol_); reset(); - return Key_NoKey; + return EventHandlerResult::EVENT_CONSUMED; } } - if (keyToggledOn(key_state)) { + if (keyToggledOn(keyState)) { if (mapped_key == Key_Backspace) { if (symbol_pos_ > 0) symbol_pos_--; @@ -102,8 +96,23 @@ Key Syster::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_sta } } - return mapped_key; + return EventHandlerResult::OK; +} + +// Legacy V1 API + +#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API +void Syster::begin() { + Kaleidoscope.useEventHandlerHook(legacyEventHandler); +} + +Key Syster::legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state) { + EventHandlerResult r = ::Syster.onKeyswitchEvent(mapped_key, row, col, key_state); + if (r == EventHandlerResult::OK) + return mapped_key; + return Key_NoKey; } +#endif } diff --git a/src/Kaleidoscope/Syster.h b/src/Kaleidoscope/Syster.h index 83605be9..b9da0303 100644 --- a/src/Kaleidoscope/Syster.h +++ b/src/Kaleidoscope/Syster.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Syster -- Symbolic input system - * Copyright (C) 2017 Gergely Nagy + * Copyright (C) 2017, 2018 Gergely Nagy * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -27,7 +27,7 @@ namespace kaleidoscope { -class Syster : public KaleidoscopePlugin { +class Syster : public kaleidoscope::Plugin { public: typedef enum { StartAction, @@ -35,19 +35,24 @@ class Syster : public KaleidoscopePlugin { SymbolAction } action_t; - Syster(void); + Syster(void) {} - void begin(void) final; static void reset(void); bool is_active(void); + EventHandlerResult onKeyswitchEvent(Key &mapped_key, byte row, byte col, uint8_t keyState); + +#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API + protected: + void begin(); + static Key legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state); +#endif + private: static char symbol_[SYSTER_MAX_SYMBOL_LENGTH + 1]; static uint8_t symbol_pos_; static bool is_active_; - - static Key eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state); }; }; From c42bfa481ab13f5fd85d069d15b6b941e5bc58ff Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 17 Jun 2018 11:25:05 +0200 Subject: [PATCH 26/38] Override onSetup when using a compatibility layer The default `onSetup` will call `.begin`, to support initializing plugins using the V1 plugins while using `KALEIDOSCOPE_INIT_PLUGINS`. However, plugins that implement a compatibility layer so that they can be used with both the new API, and with `Kaleidoscope.use()` will have a `.begin` method too. Which the default `onSetup` will call, and we'll register the compatibility layer too, in addition to the new-style event handlers. This results in many things running twice, which leads to all kinds of problems. For this reason, override `onSetup`, so that it does not call `begin`. When used with `Kaleidoscope.use()`, the plugin will still work, so compatibility is maintained. But the bug is now gone. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/Syster.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/Kaleidoscope/Syster.h b/src/Kaleidoscope/Syster.h index b9da0303..bcb7812d 100644 --- a/src/Kaleidoscope/Syster.h +++ b/src/Kaleidoscope/Syster.h @@ -44,6 +44,10 @@ class Syster : public kaleidoscope::Plugin { EventHandlerResult onKeyswitchEvent(Key &mapped_key, byte row, byte col, uint8_t keyState); #if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API + kaleidoscope::EventHandlerResult onSetup() { + return kaleidoscope::EventHandlerResult::OK; + } + protected: void begin(); static Key legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state); From e4d61fca0e02a5dcf15557fb8f742f0b40901d96 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 20 Aug 2018 23:27:57 +0200 Subject: [PATCH 27/38] Drop the V1 plugin API compatibility code Signed-off-by: Gergely Nagy --- src/Kaleidoscope/Syster.cpp | 15 --------------- src/Kaleidoscope/Syster.h | 10 ---------- 2 files changed, 25 deletions(-) diff --git a/src/Kaleidoscope/Syster.cpp b/src/Kaleidoscope/Syster.cpp index 08818ef6..1e68f063 100644 --- a/src/Kaleidoscope/Syster.cpp +++ b/src/Kaleidoscope/Syster.cpp @@ -99,21 +99,6 @@ EventHandlerResult Syster::onKeyswitchEvent(Key &mapped_key, byte row, byte col, return EventHandlerResult::OK; } -// Legacy V1 API - -#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API -void Syster::begin() { - Kaleidoscope.useEventHandlerHook(legacyEventHandler); -} - -Key Syster::legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state) { - EventHandlerResult r = ::Syster.onKeyswitchEvent(mapped_key, row, col, key_state); - if (r == EventHandlerResult::OK) - return mapped_key; - return Key_NoKey; -} -#endif - } __attribute__((weak)) const char keyToChar(Key key) { diff --git a/src/Kaleidoscope/Syster.h b/src/Kaleidoscope/Syster.h index bcb7812d..64f2a564 100644 --- a/src/Kaleidoscope/Syster.h +++ b/src/Kaleidoscope/Syster.h @@ -43,16 +43,6 @@ class Syster : public kaleidoscope::Plugin { EventHandlerResult onKeyswitchEvent(Key &mapped_key, byte row, byte col, uint8_t keyState); -#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API - kaleidoscope::EventHandlerResult onSetup() { - return kaleidoscope::EventHandlerResult::OK; - } - - protected: - void begin(); - static Key legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state); -#endif - private: static char symbol_[SYSTER_MAX_SYMBOL_LENGTH + 1]; static uint8_t symbol_pos_; From 0ee734cf152eaf29f1cdea993c66f4bbb7ec5fe9 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:17:37 +0200 Subject: [PATCH 28/38] Relicense under the GPLv3 (only) Signed-off-by: Gergely Nagy --- examples/Syster/Syster.ino | 19 +++++++++---------- src/Kaleidoscope-Syster.h | 19 +++++++++---------- src/Kaleidoscope/Syster.cpp | 19 +++++++++---------- src/Kaleidoscope/Syster.h | 19 +++++++++---------- 4 files changed, 36 insertions(+), 40 deletions(-) diff --git a/examples/Syster/Syster.ino b/examples/Syster/Syster.ino index ea823f2a..8f067397 100644 --- a/examples/Syster/Syster.ino +++ b/examples/Syster/Syster.ino @@ -2,18 +2,17 @@ * Kaleidoscope-Syster -- Symbolic input system * Copyright (C) 2017, 2018 Gergely Nagy * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. + * This program is 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-Syster.h b/src/Kaleidoscope-Syster.h index 197304ed..79aab2fa 100644 --- a/src/Kaleidoscope-Syster.h +++ b/src/Kaleidoscope-Syster.h @@ -2,18 +2,17 @@ * Kaleidoscope-Syster -- Symbolic input system * 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/Syster.cpp b/src/Kaleidoscope/Syster.cpp index 1e68f063..412e0424 100644 --- a/src/Kaleidoscope/Syster.cpp +++ b/src/Kaleidoscope/Syster.cpp @@ -2,18 +2,17 @@ * Kaleidoscope-Syster -- Symbolic input system * Copyright (C) 2017, 2018 Gergely Nagy * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. + * This program is 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/Syster.h b/src/Kaleidoscope/Syster.h index 64f2a564..40d2fa9f 100644 --- a/src/Kaleidoscope/Syster.h +++ b/src/Kaleidoscope/Syster.h @@ -2,18 +2,17 @@ * Kaleidoscope-Syster -- Symbolic input system * Copyright (C) 2017, 2018 Gergely Nagy * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. + * This program is 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 154a600c678c8fcf8a9f554644bba8fa644f4260 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:17:39 +0200 Subject: [PATCH 29/38] 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/Syster/Syster.ino | 2 +- library.properties | 2 +- src/Kaleidoscope-Syster.h | 2 +- src/Kaleidoscope/Syster.cpp | 2 +- src/Kaleidoscope/Syster.h | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/examples/Syster/Syster.ino b/examples/Syster/Syster.ino index 8f067397..1532ec19 100644 --- a/examples/Syster/Syster.ino +++ b/examples/Syster/Syster.ino @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Syster -- Symbolic input system - * Copyright (C) 2017, 2018 Gergely Nagy + * Copyright (C) 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 2efabcc2..e90cc472 100644 --- a/library.properties +++ b/library.properties @@ -1,7 +1,7 @@ name=Kaleidoscope-Syster version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy +maintainer=Gergely Nagy sentence=Symbolic input system for Kaleidoscope. paragraph=Allows inputting symbols (Unicode or otherwise) by name. category=Communication diff --git a/src/Kaleidoscope-Syster.h b/src/Kaleidoscope-Syster.h index 79aab2fa..4e2589f3 100644 --- a/src/Kaleidoscope-Syster.h +++ b/src/Kaleidoscope-Syster.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Syster -- Symbolic input system - * 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/Syster.cpp b/src/Kaleidoscope/Syster.cpp index 412e0424..525510a2 100644 --- a/src/Kaleidoscope/Syster.cpp +++ b/src/Kaleidoscope/Syster.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Syster -- Symbolic input system - * Copyright (C) 2017, 2018 Gergely Nagy + * Copyright (C) 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/Syster.h b/src/Kaleidoscope/Syster.h index 40d2fa9f..167b7e31 100644 --- a/src/Kaleidoscope/Syster.h +++ b/src/Kaleidoscope/Syster.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Syster -- Symbolic input system - * Copyright (C) 2017, 2018 Gergely Nagy + * Copyright (C) 2017, 2018 Keyboard.io, Inc * * This program is free software: you can redistribute it and/or modify it under * the terms of the GNU General Public License as published by the Free Software From c7b7c1b1e83f27b58dcb6d11ad022c16abdf94f7 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:17:41 +0200 Subject: [PATCH 30/38] 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 b57354ad054b243c5c8fca83e4a89bc4bb8ef17c Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 4 Sep 2018 18:24:02 -0700 Subject: [PATCH 31/38] 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 bf5606d9752b9d74f439de518a348a6c4eb93b17 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 4 Sep 2018 18:42:30 -0700 Subject: [PATCH 32/38] 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 8733c0d5e2a7afec4c576402b3b6f68395a86f36 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 10 Oct 2018 06:56:53 +0200 Subject: [PATCH 33/38] README.md & Travis cleanup Remove the IRC notifications from Travis (we're not using IRC anymore), and the stable/experimental badge from README.md (because they aren't being kept up to date). Signed-off-by: Gergely Nagy --- .travis.yml | 7 ------- README.md | 6 +----- 2 files changed, 1 insertion(+), 12 deletions(-) diff --git a/.travis.yml b/.travis.yml index 23d30ccc..49b8c498 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,13 +7,6 @@ install: script: - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware notifications: - irc: - channels: - - "chat.freenode.net#keyboardio" - use_notice: true - skip_join: true - template: - - "%{repository_name}/%{branch} %{commit} by %{author}: %{commit_subject} %{build_url} %{message}" email: on_success: change on_failure: change diff --git a/README.md b/README.md index d23f3549..f4a166a8 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,10 @@ # Kaleidoscope-Syster -![status][st:experimental] [![Build Status][travis:image]][travis:status] +[![Build Status][travis:image]][travis:status] [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-Syster.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-Syster - [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 - Syster is a way to input symbols in a different way: instead of macros, Leader sequences or the like, we trigger the special input mode, and enter the symbol's name. Once finished, we hit `Space`, and this plugin will do the rest: delete From ce2275e8ea0daa7e53bbc78e0b97f4fe4905bef2 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 16 Oct 2018 18:50:10 -0700 Subject: [PATCH 34/38] Remove an obsolete header from an example file --- examples/Syster/Syster.ino | 1 - 1 file changed, 1 deletion(-) diff --git a/examples/Syster/Syster.ino b/examples/Syster/Syster.ino index 1532ec19..e282d65b 100644 --- a/examples/Syster/Syster.ino +++ b/examples/Syster/Syster.ino @@ -17,7 +17,6 @@ #include #include -#include #include #include #include From e9542c28bd49a8ae24656948c6fa3092c24ffa33 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 17 Oct 2018 10:49:14 +0200 Subject: [PATCH 35/38] Update to work with the new HostOS `HostOS` depends on `EEPROMSettings` now, and as such, we need to initialize it ourselves too. Signed-off-by: Gergely Nagy --- README.md | 4 +++- examples/Syster/Syster.ino | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f4a166a8..d043ca97 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,8 @@ will handle the symbol actions: ```c++ #include +#include +#include #include #include #include @@ -46,7 +48,7 @@ void systerAction(kaleidoscope::Syster::action_t action, const char *symbol) { } } -KALEIDOSCOPE_INIT_PLUGINS(Unicode, Syster); +KALEIDOSCOPE_INIT_PLUGINS(EEPROMSettings, HostOS, Unicode, Syster); void setup() { Serial.begin(9600); diff --git a/examples/Syster/Syster.ino b/examples/Syster/Syster.ino index e282d65b..e409942a 100644 --- a/examples/Syster/Syster.ino +++ b/examples/Syster/Syster.ino @@ -16,6 +16,7 @@ */ #include +#include #include #include #include @@ -64,7 +65,8 @@ void systerAction(kaleidoscope::Syster::action_t action, const char *symbol) { } } -KALEIDOSCOPE_INIT_PLUGINS(HostOS, +KALEIDOSCOPE_INIT_PLUGINS(EEPROMSettings, + HostOS, Unicode, Syster); From a0cabc672728f4483bfc497d29423ffa37329b29 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 13 Oct 2018 15:29:56 +0200 Subject: [PATCH 36/38] Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/Syster.md`, sources under `src/kaleidoscope/plugin/` (appropriately namespaced). This is in preparation of merging plugins into a single monorepo. Signed-off-by: Gergely Nagy --- README.md | 94 +--------------- doc/plugin/Syster.md | 104 ++++++++++++++++++ examples/Syster/Syster.ino | 8 +- src/Kaleidoscope-Syster.h | 2 +- .../plugin}/Syster.cpp | 4 +- .../plugin}/Syster.h | 12 +- 6 files changed, 122 insertions(+), 102 deletions(-) create mode 100644 doc/plugin/Syster.md rename src/{Kaleidoscope => kaleidoscope/plugin}/Syster.cpp (98%) rename src/{Kaleidoscope => kaleidoscope/plugin}/Syster.h (86%) diff --git a/README.md b/README.md index d043ca97..111cb0c9 100644 --- a/README.md +++ b/README.md @@ -5,96 +5,4 @@ [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-Syster.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-Syster -Syster is a way to input symbols in a different way: instead of macros, Leader -sequences or the like, we trigger the special input mode, and enter the symbol's -name. Once finished, we hit `Space`, and this plugin will do the rest: delete -everything we typed, look up an action for the entered symbol, and execute that. - -There are a number of ways this can be useful, but the easiest showcase is -symbolic Unicode input: `SYSTER coffee SPACE` turns into `☕`, with just a -little code. - -## Using the plugin - -To use the plugin, one needs to include the header and set up a function that -will handle the symbol actions: - -```c++ -#include -#include -#include -#include -#include -#include - -void systerAction(kaleidoscope::Syster::action_t action, const char *symbol) { - switch (action) { - case kaleidoscope::Syster::StartAction: - Unicode.type (0x2328); - break; - case kaleidoscope::Syster::EndAction: - handleKeyswitchEvent (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); - kaleidoscope::hid::sendKeyboardReport (); - handleKeyswitchEvent (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); - kaleidoscope::hid::sendKeyboardReport (); - break; - case kaleidoscope::Syster::SymbolAction: - Serial.print ("systerAction: symbol="); - Serial.println (symbol); - if (strcmp (symbol, "coffee") == 0) { - Unicode.type (0x2615); - } - break; - } -} - -KALEIDOSCOPE_INIT_PLUGINS(EEPROMSettings, HostOS, Unicode, Syster); - -void setup() { - Serial.begin(9600); - Kaleidoscope.setup (); -} -``` - -**Note** that we need to use the `Syster` object before any other that adds or -changes key behaviour! Failing to do so may result in unpredictable behaviour. - -## Plugin methods - -The plugin provides the `Syster` object, with no public methods. There are two -methods outside of the object, however, that can be overridden: - -### `systerAction(action, symbol)` - -> Called whenever an action needs to be taken, which can happen in three cases: - -> First, when the `Syster` key is pressed and the alternate processing starts. -> In this case, `action` will be set to `kaleidoscope::Syster::StartAction`, and -> `symbol` will be `NULL`. This function can be used to do some setup to make it -> more obvious that the Syster input mode is active, such as sending a Unicode -> symbol to the host, or lighting up LEDs, or anything else we'd like. -> -> Second, when the sequence is finished with a `Space`. In this case, `action` -> will be set to `kaleidoscope::Syster::EndAction` and `symbol` will be `NULL`. -> This can be used to undo anything that the start action did, if need be. -> -> Third, when the action for the symbol should be made. In this case, `action` -> is set to `kaleidoscope::Syster::SymbolAction`, and `symbol` will be a C -> string. It is up to us, what we do with this information, how we handle it. - -### `keyToChar(key)` - -> A function that turns a keycode into a character. If using QWERTY on the host, -> the default implementation is sufficient. When using something else, you may -> have to reimplement this function. - -## Dependencies - -* [Kaleidoscope-Ranges](https://github.com/keyboardio/Kaleidoscope-Ranges) - -## Further reading - -Starting from the [example][plugin:example] is the recommended way of getting -started with the plugin. - - [plugin:example]: https://github.com/keyboardio/Kaleidoscope-Syster/blob/master/examples/Syster/Syster.ino +See [doc/plugin/Syster.md](doc/plugin/Syster.md) for documentation. diff --git a/doc/plugin/Syster.md b/doc/plugin/Syster.md new file mode 100644 index 00000000..cae4932d --- /dev/null +++ b/doc/plugin/Syster.md @@ -0,0 +1,104 @@ +# Kaleidoscope-Syster + +Syster is a way to input symbols in a different way: instead of macros, Leader +sequences or the like, we trigger the special input mode, and enter the symbol's +name. Once finished, we hit `Space`, and this plugin will do the rest: delete +everything we typed, look up an action for the entered symbol, and execute that. + +There are a number of ways this can be useful, but the easiest showcase is +symbolic Unicode input: `SYSTER coffee SPACE` turns into `☕`, with just a +little code. + +## Using the plugin + +To use the plugin, one needs to include the header and set up a function that +will handle the symbol actions: + +```c++ +#include +#include +#include +#include +#include +#include + +void systerAction(kaleidoscope::plugin::Syster::action_t action, const char *symbol) { + switch (action) { + case kaleidoscope::plugin::Syster::StartAction: + Unicode.type (0x2328); + break; + case kaleidoscope::plugin::Syster::EndAction: + handleKeyswitchEvent (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); + kaleidoscope::hid::sendKeyboardReport (); + handleKeyswitchEvent (Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); + kaleidoscope::hid::sendKeyboardReport (); + break; + case kaleidoscope::plugin::Syster::SymbolAction: + Serial.print ("systerAction: symbol="); + Serial.println (symbol); + if (strcmp (symbol, "coffee") == 0) { + Unicode.type (0x2615); + } + break; + } +} + +KALEIDOSCOPE_INIT_PLUGINS(EEPROMSettings, HostOS, Unicode, Syster); + +void setup() { + Serial.begin(9600); + Kaleidoscope.setup (); +} +``` + +**Note** that we need to use the `Syster` object before any other that adds or +changes key behaviour! Failing to do so may result in unpredictable behaviour. + +## Plugin methods + +The plugin provides the `Syster` object, with no public methods. There are two +methods outside of the object, however, that can be overridden: + +### `systerAction(action, symbol)` + +> Called whenever an action needs to be taken, which can happen in three cases: + +> First, when the `Syster` key is pressed and the alternate processing starts. +> In this case, `action` will be set to +> `kaleidoscope::plugin::Syster::StartAction`, and `symbol` will be `NULL`. This +> function can be used to do some setup to make it more obvious that the Syster +> input mode is active, such as sending a Unicode symbol to the host, or +> lighting up LEDs, or anything else we'd like. +> +> Second, when the sequence is finished with a `Space`. In this case, `action` +> will be set to `kaleidoscope::plugin::Syster::EndAction` and `symbol` will be +> `NULL`. This can be used to undo anything that the start action did, if need +> be. +> +> Third, when the action for the symbol should be made. In this case, `action` +> is set to `kaleidoscope::plugin::Syster::SymbolAction`, and `symbol` will be a +> C string. It is up to us, what we do with this information, how we handle it. + +### `keyToChar(key)` + +> A function that turns a keycode into a character. If using QWERTY on the host, +> the default implementation is sufficient. When using something else, you may +> have to reimplement this function. + +## Dependencies + +* [Kaleidoscope-Ranges](https://github.com/keyboardio/Kaleidoscope-Ranges) + +## Further reading + +Starting from the [example][plugin:example] is the recommended way of getting +started with the plugin. + + [plugin:example]: https://github.com/keyboardio/Kaleidoscope-Syster/blob/master/examples/Syster/Syster.ino + +## Upgrading + +Previous versions of `Syster` used `kaleidoscope::Syster::action_t` as the type +of Syster actions. In newer versions, this is +`kaleidoscope::plugin::Syster::action_t`. The old name still works, but will be +removed by 2019-01-14. diff --git a/examples/Syster/Syster.ino b/examples/Syster/Syster.ino index e409942a..51a5c025 100644 --- a/examples/Syster/Syster.ino +++ b/examples/Syster/Syster.ino @@ -44,18 +44,18 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { }; // *INDENT-ON* -void systerAction(kaleidoscope::Syster::action_t action, const char *symbol) { +void systerAction(kaleidoscope::plugin::Syster::action_t action, const char *symbol) { switch (action) { - case kaleidoscope::Syster::StartAction: + case kaleidoscope::plugin::Syster::StartAction: Unicode.type(0x2328); break; - case kaleidoscope::Syster::EndAction: + case kaleidoscope::plugin::Syster::EndAction: handleKeyswitchEvent(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, IS_PRESSED | INJECTED); kaleidoscope::hid::sendKeyboardReport(); handleKeyswitchEvent(Key_Backspace, UNKNOWN_KEYSWITCH_LOCATION, WAS_PRESSED | INJECTED); kaleidoscope::hid::sendKeyboardReport(); break; - case kaleidoscope::Syster::SymbolAction: + case kaleidoscope::plugin::Syster::SymbolAction: Serial.print("systerAction: symbol="); Serial.println(symbol); if (strcmp(symbol, "coffee") == 0) { diff --git a/src/Kaleidoscope-Syster.h b/src/Kaleidoscope-Syster.h index 4e2589f3..7780fab0 100644 --- a/src/Kaleidoscope-Syster.h +++ b/src/Kaleidoscope-Syster.h @@ -17,4 +17,4 @@ #pragma once -#include +#include diff --git a/src/Kaleidoscope/Syster.cpp b/src/kaleidoscope/plugin/Syster.cpp similarity index 98% rename from src/Kaleidoscope/Syster.cpp rename to src/kaleidoscope/plugin/Syster.cpp index 525510a2..ff96d2fd 100644 --- a/src/Kaleidoscope/Syster.cpp +++ b/src/kaleidoscope/plugin/Syster.cpp @@ -21,6 +21,7 @@ #undef SYSTER namespace kaleidoscope { +namespace plugin { // --- state --- char Syster::symbol_[SYSTER_MAX_SYMBOL_LENGTH + 1]; @@ -98,6 +99,7 @@ EventHandlerResult Syster::onKeyswitchEvent(Key &mapped_key, byte row, byte col, return EventHandlerResult::OK; } +} } __attribute__((weak)) const char keyToChar(Key key) { @@ -117,4 +119,4 @@ __attribute__((weak)) const char keyToChar(Key key) { __attribute__((weak)) void systerAction(kaleidoscope::Syster::action_t action, const char *symbol) { } -kaleidoscope::Syster Syster; +kaleidoscope::plugin::Syster Syster; diff --git a/src/Kaleidoscope/Syster.h b/src/kaleidoscope/plugin/Syster.h similarity index 86% rename from src/Kaleidoscope/Syster.h rename to src/kaleidoscope/plugin/Syster.h index 167b7e31..3b3dc736 100644 --- a/src/Kaleidoscope/Syster.h +++ b/src/kaleidoscope/plugin/Syster.h @@ -25,6 +25,7 @@ #define SYSTER ((Key) { .raw = kaleidoscope::ranges::SYSTER }) namespace kaleidoscope { +namespace plugin { class Syster : public kaleidoscope::Plugin { public: @@ -47,9 +48,14 @@ class Syster : public kaleidoscope::Plugin { static uint8_t symbol_pos_; static bool is_active_; }; -}; +} + +// Backwards compatibility +typedef plugin::Syster Syster; + +} const char keyToChar(Key key); -void systerAction(kaleidoscope::Syster::action_t action, const char *symbol); +void systerAction(kaleidoscope::plugin::Syster::action_t action, const char *symbol); -extern kaleidoscope::Syster Syster; +extern kaleidoscope::plugin::Syster Syster; From 9b026352898f130e971aaebb8cd6d057337e20a1 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 13 Oct 2018 15:32:50 +0200 Subject: [PATCH 37/38] 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 111cb0c9..00000000 --- a/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# Kaleidoscope-Syster - -[![Build Status][travis:image]][travis:status] - - [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-Syster.svg?branch=master - [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-Syster - -See [doc/plugin/Syster.md](doc/plugin/Syster.md) for documentation. diff --git a/library.properties b/library.properties deleted file mode 100644 index e90cc472..00000000 --- a/library.properties +++ /dev/null @@ -1,10 +0,0 @@ -name=Kaleidoscope-Syster -version=0.0.0 -author=Gergely Nagy -maintainer=Gergely Nagy -sentence=Symbolic input system for Kaleidoscope. -paragraph=Allows inputting symbols (Unicode or otherwise) by name. -category=Communication -url=https://github.com/keyboardio/Kaleidoscope-Syster -architectures=avr -dot_a_linkage=true From f5a4116fc3bf596f9eeb231d31197f303b2425fb Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 18 Oct 2018 00:16:57 +0200 Subject: [PATCH 38/38] 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/Syster.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/plugin/Syster.md b/doc/plugin/Syster.md index cae4932d..5d23f93c 100644 --- a/doc/plugin/Syster.md +++ b/doc/plugin/Syster.md @@ -87,14 +87,14 @@ methods outside of the object, however, that can be overridden: ## Dependencies -* [Kaleidoscope-Ranges](https://github.com/keyboardio/Kaleidoscope-Ranges) +* [Kaleidoscope-Ranges](Ranges.md) ## Further reading Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/keyboardio/Kaleidoscope-Syster/blob/master/examples/Syster/Syster.ino + [plugin:example]: ../../examples/Syster/Syster.ino ## Upgrading