From fcde978862f29f584e8b77cc8894769e39d43bf3 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 25 Feb 2017 22:46:25 +0100 Subject: [PATCH 01/56] Initial import Signed-off-by: Gergely Nagy --- .gitignore | 4 + .travis.yml | 19 + COPYING | 674 +++++++++++++++++++ README.md | 42 ++ examples/EEPROM-Settings/EEPROM-Settings.ino | 59 ++ library.properties | 10 + src/Kaleidoscope-EEPROM-Settings.h | 21 + src/Kaleidoscope/EEPROM-Settings.cpp | 63 ++ src/Kaleidoscope/EEPROM-Settings.h | 46 ++ 9 files changed, 938 insertions(+) create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 COPYING create mode 100644 README.md create mode 100644 examples/EEPROM-Settings/EEPROM-Settings.ino create mode 100644 library.properties create mode 100644 src/Kaleidoscope-EEPROM-Settings.h create mode 100644 src/Kaleidoscope/EEPROM-Settings.cpp create mode 100644 src/Kaleidoscope/EEPROM-Settings.h diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..be16c9be --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +.#* +*~ +/hardware/ +/output/ \ No newline at end of file diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 00000000..b5ff1273 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,19 @@ +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 + - ln -s $(pwd) hardware/keyboardio/avr/libraries/Kaleidoscope-EEPROM-Settings +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/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..f4b5b59c --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# Kaleidoscope-EEPROM-Settings + +![status][st:experimental] [![Build Status][travis:image]][travis:status] + + [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-EEPROM-Settings.svg?branch=master + [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-EEPROM-Settings + + [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 + +TODO + +## Using the plugin + +TODO + +```c++ +#include +#include + +void setup () { + Kaleidoscope.setup (); + + USE_PLUGINS (&EEPROMSettings); + + // TODO +} +``` + +## Plugin methods + +The plugin provides the `EEPROMSettings` object, which has the following methods: + +**TODO** + +## 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-EEPROM-Settings/blob/master/examples/EEPROM-Settings/EEPROM-Settings.ino diff --git a/examples/EEPROM-Settings/EEPROM-Settings.ino b/examples/EEPROM-Settings/EEPROM-Settings.ino new file mode 100644 index 00000000..08e474d0 --- /dev/null +++ b/examples/EEPROM-Settings/EEPROM-Settings.ino @@ -0,0 +1,59 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. + * 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, + Key_skip, + + Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, + Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, + + Key_RShift, Key_RAlt, Key_Space, Key_RCtrl, + Key_skip + ), +}; + +void setup () { + Serial.begin (9600); + + Kaleidoscope.setup (); + + USE_PLUGINS (&EEPROMSettings); + + while (!Serial) { + } + + Serial.println (EEPROMSettings.isValid () ? "valid EEPROM settings" : "invalid EEPROM settings"); + Serial.println (EEPROMSettings.endOfSettings ()); +} + +void loop () { + Kaleidoscope.loop (); +} diff --git a/library.properties b/library.properties new file mode 100644 index 00000000..c78bfdfa --- /dev/null +++ b/library.properties @@ -0,0 +1,10 @@ +name=Kaleidoscope-EEPROM-Settings +version=0.0.0 +author=Gergely Nagy +maintainer=Gergely Nagy +sentence=Base EEPROM settings plugin for Kaleidoscope. +paragraph=... +category=Communication +url=https://github.com/keyboardio/Kaleidoscope-EEPROM-Settings +architectures=avr +dot_a_linkage=true diff --git a/src/Kaleidoscope-EEPROM-Settings.h b/src/Kaleidoscope-EEPROM-Settings.h new file mode 100644 index 00000000..f2735e3b --- /dev/null +++ b/src/Kaleidoscope-EEPROM-Settings.h @@ -0,0 +1,21 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. + * Copyright (C) 2017 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#pragma once + +#include diff --git a/src/Kaleidoscope/EEPROM-Settings.cpp b/src/Kaleidoscope/EEPROM-Settings.cpp new file mode 100644 index 00000000..213e6b64 --- /dev/null +++ b/src/Kaleidoscope/EEPROM-Settings.cpp @@ -0,0 +1,63 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. + * 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 + +namespace KaleidoscopePlugins { + struct EEPROMSettings::settings EEPROMSettings::settings; + bool EEPROMSettings::_isValid; + + EEPROMSettings::EEPROMSettings (void) { + } + + void + EEPROMSettings::begin (void) { + _isValid = true; + EEPROM.get (0, settings); + + if (settings.magic[0] != 'K' || settings.magic[1] != 'S') { + settings.magic[0] = 'K'; + settings.magic[1] = 'S'; + settings.endOfSettings = EEPROM_SETTINGS_RESERVED - 1; + + return update (); + } + + if (settings.endOfSettings != EEPROM_SETTINGS_RESERVED - 1) + _isValid = false; + } + + uint16_t + EEPROMSettings::endOfSettings (void) { + if (!isValid ()) + return 0; + return settings.endOfSettings; + } + + bool + EEPROMSettings::isValid (void) { + return _isValid; + } + + void + EEPROMSettings::update (void) { + EEPROM.put (0, settings); + } +}; + +KaleidoscopePlugins::EEPROMSettings EEPROMSettings; diff --git a/src/Kaleidoscope/EEPROM-Settings.h b/src/Kaleidoscope/EEPROM-Settings.h new file mode 100644 index 00000000..db20b708 --- /dev/null +++ b/src/Kaleidoscope/EEPROM-Settings.h @@ -0,0 +1,46 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. + * 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 + +#ifndef EEPROM_SETTINGS_RESERVED +#define EEPROM_SETTINGS_RESERVED ((E2END + 1) / 2) +#endif + +namespace KaleidoscopePlugins { + class EEPROMSettings : public KaleidoscopePlugin { + public: + EEPROMSettings (void); + + virtual void begin (void) final; + + static uint16_t endOfSettings (void); + static void update (void); + static bool isValid (void); + + private: + static bool _isValid; + static struct settings { + char magic[2]; + uint16_t endOfSettings; + } settings; + }; +}; + +extern KaleidoscopePlugins::EEPROMSettings EEPROMSettings; From eca8be7b57838219cdc9a9667c8c149fb9fdf050 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 26 Feb 2017 10:14:01 +0100 Subject: [PATCH 02/56] Add a missing #pragma once Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Settings.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/Kaleidoscope/EEPROM-Settings.h b/src/Kaleidoscope/EEPROM-Settings.h index db20b708..184bc1f7 100644 --- a/src/Kaleidoscope/EEPROM-Settings.h +++ b/src/Kaleidoscope/EEPROM-Settings.h @@ -16,6 +16,8 @@ * along with this program. If not, see . */ +#pragma once + #include #include From 212861173cb9d8b20f9a6a857e5b27e040e6dac2 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 26 Feb 2017 10:14:30 +0100 Subject: [PATCH 03/56] Add a version to the settings struct Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Settings.cpp | 17 +++++++++++++++++ src/Kaleidoscope/EEPROM-Settings.h | 4 ++++ 2 files changed, 21 insertions(+) diff --git a/src/Kaleidoscope/EEPROM-Settings.cpp b/src/Kaleidoscope/EEPROM-Settings.cpp index 213e6b64..bf221395 100644 --- a/src/Kaleidoscope/EEPROM-Settings.cpp +++ b/src/Kaleidoscope/EEPROM-Settings.cpp @@ -54,9 +54,26 @@ namespace KaleidoscopePlugins { return _isValid; } + void + EEPROMSettings::invalidate (void) { + _isValid = false; + } + void EEPROMSettings::update (void) { EEPROM.put (0, settings); + _isValid = true; + } + + uint8_t + EEPROMSettings::version (void) { + return settings.version; + } + + void + EEPROMSettings::version (uint8_t ver) { + settings.version = ver; + update (); } }; diff --git a/src/Kaleidoscope/EEPROM-Settings.h b/src/Kaleidoscope/EEPROM-Settings.h index 184bc1f7..cdaf9a7a 100644 --- a/src/Kaleidoscope/EEPROM-Settings.h +++ b/src/Kaleidoscope/EEPROM-Settings.h @@ -35,11 +35,15 @@ namespace KaleidoscopePlugins { static uint16_t endOfSettings (void); static void update (void); static bool isValid (void); + static void invalidate (void); + static uint8_t version (void); + static void version (uint8_t ver); private: static bool _isValid; static struct settings { char magic[2]; + uint8_t version; uint16_t endOfSettings; } settings; }; From ef832250f0f732c99a37cc12e3919a6816f7fce9 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 26 Feb 2017 10:14:47 +0100 Subject: [PATCH 04/56] Add (optional) Focus hooks Signed-off-by: Gergely Nagy --- src/Kaleidoscope-EEPROM-Settings.h | 1 + src/Kaleidoscope/EEPROM-Settings-Focus.cpp | 51 ++++++++++++++++++++++ src/Kaleidoscope/EEPROM-Settings-Focus.h | 33 ++++++++++++++ 3 files changed, 85 insertions(+) create mode 100644 src/Kaleidoscope/EEPROM-Settings-Focus.cpp create mode 100644 src/Kaleidoscope/EEPROM-Settings-Focus.h diff --git a/src/Kaleidoscope-EEPROM-Settings.h b/src/Kaleidoscope-EEPROM-Settings.h index f2735e3b..ca5fb963 100644 --- a/src/Kaleidoscope-EEPROM-Settings.h +++ b/src/Kaleidoscope-EEPROM-Settings.h @@ -19,3 +19,4 @@ #pragma once #include +#include diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp new file mode 100644 index 00000000..d7193b14 --- /dev/null +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp @@ -0,0 +1,51 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. + * 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 + +namespace FocusHooks { + bool settings (const char *command) { + enum { + ISVALID, + GETVERSION, + } subCommand; + + if (strncmp_P (command, PSTR ("settings."), 9) != 0) + return false; + + if (strcmp_P (command + 9, PSTR ("valid?")) == 0) + subCommand = ISVALID; + else if (strcmp_P (command + 9, PSTR ("version")) == 0) + subCommand = GETVERSION; + else + return false; + + switch (subCommand) { + case ISVALID: + Serial.println (EEPROMSettings.isValid () ? F("yes") : F("no")); + break; + case GETVERSION: + Serial.println (EEPROMSettings.version ()); + break; + } + + Serial.read (); + + return true; + } +}; diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.h b/src/Kaleidoscope/EEPROM-Settings-Focus.h new file mode 100644 index 00000000..67667e82 --- /dev/null +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.h @@ -0,0 +1,33 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. + * Copyright (C) 2017 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#pragma once + +#include + +namespace FocusHooks { + bool settings (const char *command); +}; + +#define FOCUS_HOOK_SETTINGS FOCUS_HOOK(FocusHooks::settings, \ + "settings.valid?\n" \ + "---------------\n" \ + "Return whether the EEPROM settings are valid, or not.\n\n" \ + "settings.version\n" \ + "----------------\n" \ + "Return the version of the EEPROM settings.") From 496cff414b512fb554f682f2a192addbb3d9ce05 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 26 Feb 2017 13:06:11 +0100 Subject: [PATCH 05/56] Travis: Remove obsolete workarounds Signed-off-by: Gergely Nagy --- .travis.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.travis.yml b/.travis.yml index b5ff1273..ed2b2e3b 100644 --- a/.travis.yml +++ b/.travis.yml @@ -10,10 +10,8 @@ before_install: - popd install: - git clone --recurse-submodules https://github.com/keyboardio/Arduino-Boards hardware/keyboardio/avr - - ln -s $(pwd) hardware/keyboardio/avr/libraries/Kaleidoscope-EEPROM-Settings 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 From c0d2c5173006c552e8ce61400cdb02c9c9dab666 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 15 Mar 2017 10:10:55 +0100 Subject: [PATCH 06/56] Rework how the whole thing operates Allows other plugins to request a slice of EEPROM, and returns the starting location of their area. Makes a CRC out of the slice sizes, so that it can detect when the EEPROM and the Sketch become out of sync. Handling that case is left up to the user. As a consequence, we no longer reserve a big chunk of EEPROM for the keymap, that just becomes another slice of it, which can be anywhere. This makes it a bit harder to adjust the size of it, but as far as this plugin goes, playing with the EEPROM layout will usually mean having to update its contents from scratch, anyway. Signed-off-by: Gergely Nagy --- examples/EEPROM-Settings/EEPROM-Settings.ino | 5 +- src/Kaleidoscope/EEPROM-Settings-Focus.cpp | 8 +++ src/Kaleidoscope/EEPROM-Settings-Focus.h | 5 +- src/Kaleidoscope/EEPROM-Settings.cpp | 45 ++++++++++--- src/Kaleidoscope/EEPROM-Settings.h | 14 ++-- src/Kaleidoscope/crc.cpp | 71 ++++++++++++++++++++ src/Kaleidoscope/crc.h | 45 +++++++++++++ 7 files changed, 174 insertions(+), 19 deletions(-) create mode 100644 src/Kaleidoscope/crc.cpp create mode 100644 src/Kaleidoscope/crc.h diff --git a/examples/EEPROM-Settings/EEPROM-Settings.ino b/examples/EEPROM-Settings/EEPROM-Settings.ino index 08e474d0..7ca1700a 100644 --- a/examples/EEPROM-Settings/EEPROM-Settings.ino +++ b/examples/EEPROM-Settings/EEPROM-Settings.ino @@ -50,8 +50,9 @@ void setup () { while (!Serial) { } - Serial.println (EEPROMSettings.isValid () ? "valid EEPROM settings" : "invalid EEPROM settings"); - Serial.println (EEPROMSettings.endOfSettings ()); + Serial.println (EEPROMSettings.isValid () ? F("valid EEPROM settings") : F("invalid EEPROM settings")); + Serial.println (EEPROMSettings.crc (), HEX); + Serial.println (EEPROMSettings.version ()); } void loop () { diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp index d7193b14..1be66f6e 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp @@ -17,12 +17,14 @@ */ #include +#include "crc.h" namespace FocusHooks { bool settings (const char *command) { enum { ISVALID, GETVERSION, + CRC, } subCommand; if (strncmp_P (command, PSTR ("settings."), 9) != 0) @@ -32,6 +34,8 @@ namespace FocusHooks { subCommand = ISVALID; else if (strcmp_P (command + 9, PSTR ("version")) == 0) subCommand = GETVERSION; + else if (strcmp_P (command + 9, PSTR ("crc")) == 0) + subCommand = CRC; else return false; @@ -41,6 +45,10 @@ namespace FocusHooks { break; case GETVERSION: Serial.println (EEPROMSettings.version ()); + case CRC: + Serial.print (::CRC.crc, HEX); + Serial.print (F("/")); + Serial.println (EEPROMSettings.crc (), HEX); break; } diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.h b/src/Kaleidoscope/EEPROM-Settings-Focus.h index 67667e82..de5af745 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.h +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.h @@ -30,4 +30,7 @@ namespace FocusHooks { "Return whether the EEPROM settings are valid, or not.\n\n" \ "settings.version\n" \ "----------------\n" \ - "Return the version of the EEPROM settings.") + "Return the version of the EEPROM settings.\n\n" \ + "settings.crc\n" \ + "------------\n" \ + "Return the CRC of the settings.") diff --git a/src/Kaleidoscope/EEPROM-Settings.cpp b/src/Kaleidoscope/EEPROM-Settings.cpp index bf221395..1c384596 100644 --- a/src/Kaleidoscope/EEPROM-Settings.cpp +++ b/src/Kaleidoscope/EEPROM-Settings.cpp @@ -17,41 +17,64 @@ */ #include +#include "crc.h" namespace KaleidoscopePlugins { struct EEPROMSettings::settings EEPROMSettings::settings; bool EEPROMSettings::_isValid; + bool EEPROMSettings::sealed; + uint16_t EEPROMSettings::nextStart = sizeof (EEPROMSettings::settings); EEPROMSettings::EEPROMSettings (void) { } void EEPROMSettings::begin (void) { - _isValid = true; EEPROM.get (0, settings); + } + + bool + EEPROMSettings::isValid (void) { + return _isValid; + } + + uint16_t + EEPROMSettings::crc (void) { + if (sealed) + return settings.crc; + return 0; + } + + void + EEPROMSettings::seal (void) { + sealed = true; + + CRC.finalize (); if (settings.magic[0] != 'K' || settings.magic[1] != 'S') { settings.magic[0] = 'K'; settings.magic[1] = 'S'; - settings.endOfSettings = EEPROM_SETTINGS_RESERVED - 1; + settings.version = 0; + settings.crc = CRC.crc; return update (); } - if (settings.endOfSettings != EEPROM_SETTINGS_RESERVED - 1) + if (settings.crc != CRC.crc) _isValid = false; } uint16_t - EEPROMSettings::endOfSettings (void) { - if (!isValid ()) + EEPROMSettings::requestSlice (uint16_t size) { + if (sealed) return 0; - return settings.endOfSettings; - } - bool - EEPROMSettings::isValid (void) { - return _isValid; + uint16_t start = nextStart; + nextStart += size; + + CRC.update ((const void *)&size, sizeof (size)); + + return start; } void @@ -61,6 +84,8 @@ namespace KaleidoscopePlugins { void EEPROMSettings::update (void) { + settings.crc = CRC.crc; + EEPROM.put (0, settings); _isValid = true; } diff --git a/src/Kaleidoscope/EEPROM-Settings.h b/src/Kaleidoscope/EEPROM-Settings.h index cdaf9a7a..02cc7d54 100644 --- a/src/Kaleidoscope/EEPROM-Settings.h +++ b/src/Kaleidoscope/EEPROM-Settings.h @@ -21,10 +21,6 @@ #include #include -#ifndef EEPROM_SETTINGS_RESERVED -#define EEPROM_SETTINGS_RESERVED ((E2END + 1) / 2) -#endif - namespace KaleidoscopePlugins { class EEPROMSettings : public KaleidoscopePlugin { public: @@ -32,19 +28,25 @@ namespace KaleidoscopePlugins { virtual void begin (void) final; - static uint16_t endOfSettings (void); static void update (void); static bool isValid (void); static void invalidate (void); static uint8_t version (void); static void version (uint8_t ver); + static uint16_t requestSlice (uint16_t size); + static void seal (void); + static uint16_t crc (void); + private: + static uint16_t nextStart; static bool _isValid; + static bool sealed; + static struct settings { char magic[2]; uint8_t version; - uint16_t endOfSettings; + uint16_t crc; } settings; }; }; diff --git a/src/Kaleidoscope/crc.cpp b/src/Kaleidoscope/crc.cpp new file mode 100644 index 00000000..f8403548 --- /dev/null +++ b/src/Kaleidoscope/crc.cpp @@ -0,0 +1,71 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. + * 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 . + * + * Originally generated by pycrc v0.9, https://pycrc.org + * + * using the configuration: + * Width = 16 + * Poly = 0x8005 + * Xor_In = 0x0000 + * ReflectIn = True + * Xor_Out = 0x0000 + * ReflectOut = True + * Algorithm = bit-by-bit-fast + */ + +#include "crc.h" + +void +CRC_::reflect (uint8_t len) { + uint8_t i; + uint16_t newCRC; + + newCRC = crc & 0x01; + for (i = 1; i < len; i++) { + crc >>= 1; + newCRC = (newCRC << 1) | (crc & 0x01); + } + + crc = newCRC; +} + +void +CRC_::update (const void *data, uint8_t len) +{ + const uint8_t *d = (const uint8_t *)data; + uint8_t i; + bool bit; + uint8_t c; + + while (len--) { + c = *d++; + for (i = 0x01; i & 0xff; i <<= 1) { + bit = crc & 0x8000; + if (c & i) { + bit = !bit; + } + crc <<= 1; + if (bit) { + crc ^= 0x8005; + } + } + crc &= 0xffff; + } + crc &= 0xffff; +} + +CRC_ CRC; diff --git a/src/Kaleidoscope/crc.h b/src/Kaleidoscope/crc.h new file mode 100644 index 00000000..f3db42a9 --- /dev/null +++ b/src/Kaleidoscope/crc.h @@ -0,0 +1,45 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. + * 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 . + * + * Originally generated by pycrc v0.9, https://pycrc.org + * + * using the configuration: + * Width = 16 + * Poly = 0x8005 + * Xor_In = 0x0000 + * ReflectIn = True + * Xor_Out = 0x0000 + * ReflectOut = True + * Algorithm = bit-by-bit-fast + */ + +#pragma once + +#include + +class CRC_ { + public: + uint16_t crc = 0; + + CRC_ (void) {}; + + void update (const void *data, uint8_t len); + void finalize (void) { reflect (16); }; + void reflect (uint8_t len); +}; + +extern CRC_ CRC; From ff29bce43ec93459eb42657c82fea4ac6485c005 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 17 Mar 2017 19:49:55 +0100 Subject: [PATCH 07/56] Focus: Add an EEPROM dump, and an upload command Fixes keyboardio/Kaleidoscope-Focus#1. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Settings-Focus.cpp | 37 ++++++++++++++++++++++ src/Kaleidoscope/EEPROM-Settings-Focus.h | 9 ++++++ 2 files changed, 46 insertions(+) diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp index 1be66f6e..dd683ae7 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp @@ -56,4 +56,41 @@ namespace FocusHooks { return true; } + + bool eeprom (const char *command) { + enum { + DUMP, + UPLOAD, + } subCommand; + + if (strcmp_P (command, PSTR ("eeprom.dump")) == 0) + subCommand = DUMP; + else if (strcmp_P (command, PSTR ("eeprom.upload")) == 0) + subCommand = UPLOAD; + else + return false; + + switch (subCommand) { + case DUMP: + for (uint16_t i = 0; i < EEPROM.length (); i++) { + uint8_t d = EEPROM[i]; + if (d < 16) + Serial.print (0); + Serial.print (d, HEX); + Serial.print (F(" ")); + if ((i + 1) % 32 == 0) + Serial.println (); + } + break; + case UPLOAD: + for (uint16_t i = 0; i < EEPROM.length (); i++) { + uint8_t d = Serial.parseInt (); + EEPROM.update (i, d); + } + break; + } + + Serial.read (); + return true; + } }; diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.h b/src/Kaleidoscope/EEPROM-Settings-Focus.h index de5af745..72e038c8 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.h +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.h @@ -22,6 +22,7 @@ namespace FocusHooks { bool settings (const char *command); + bool eeprom (const char *command); }; #define FOCUS_HOOK_SETTINGS FOCUS_HOOK(FocusHooks::settings, \ @@ -34,3 +35,11 @@ namespace FocusHooks { "settings.crc\n" \ "------------\n" \ "Return the CRC of the settings.") + +#define FOCUS_HOOK_EEPROM FOCUS_HOOK(FocusHooks::eeprom, \ + "eeprom.dump\n" \ + "-----------\n" \ + "Dump the contents of EEPROM.\n\n" \ + "eeprom.upload BYTES...\n" \ + "----------------------\n" \ + "Upload `BYTES` to EEPROM.") From ff46d8eede19d707bfeb45df313eb89657db26a4 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 19 Mar 2017 11:11:32 +0100 Subject: [PATCH 08/56] Use the new Focus helpers Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Settings-Focus.cpp | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp index dd683ae7..3051e472 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp @@ -17,6 +17,7 @@ */ #include +#include #include "crc.h" namespace FocusHooks { @@ -41,7 +42,8 @@ namespace FocusHooks { switch (subCommand) { case ISVALID: - Serial.println (EEPROMSettings.isValid () ? F("yes") : F("no")); + Focus.printBool (EEPROMSettings.isValid ()); + Serial.println (); break; case GETVERSION: Serial.println (EEPROMSettings.version ()); @@ -74,10 +76,8 @@ namespace FocusHooks { case DUMP: for (uint16_t i = 0; i < EEPROM.length (); i++) { uint8_t d = EEPROM[i]; - if (d < 16) - Serial.print (0); - Serial.print (d, HEX); - Serial.print (F(" ")); + Focus.printNumber (d); + Focus.printSpace (); if ((i + 1) % 32 == 0) Serial.println (); } From 3648c6687cc1796a0eb8748aa6b842ccafee4386 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 19 Mar 2017 11:18:57 +0100 Subject: [PATCH 09/56] No need to consume the trailing \n anymore Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Settings-Focus.cpp | 3 --- 1 file changed, 3 deletions(-) diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp index 3051e472..84b58e55 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp @@ -54,8 +54,6 @@ namespace FocusHooks { break; } - Serial.read (); - return true; } @@ -90,7 +88,6 @@ namespace FocusHooks { break; } - Serial.read (); return true; } }; From 7884289e594bc8785580da2de97f1ebbeb687540 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 20 Mar 2017 12:42:42 +0100 Subject: [PATCH 10/56] 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 f4b5b59c..ee2e3fc3 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,10 @@ The plugin provides the `EEPROMSettings` object, which has the following methods **TODO** +## Dependencies + +* [Kaleidoscope-Focus](https://github.com/keyboardio/Kaleidoscope-Focus) + ## Further reading Starting from the [example][plugin:example] is the recommended way of getting From f1e7ab05eb209e00820d605196542c4ec1a52f28 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 27 Mar 2017 16:38:33 +0200 Subject: [PATCH 11/56] Instead of full docs, only document the commands Full documentation takes way too much space, and command names are a reasonable compromise for discoverability. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Settings-Focus.h | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.h b/src/Kaleidoscope/EEPROM-Settings-Focus.h index 72e038c8..54fc0f12 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.h +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.h @@ -27,19 +27,9 @@ namespace FocusHooks { #define FOCUS_HOOK_SETTINGS FOCUS_HOOK(FocusHooks::settings, \ "settings.valid?\n" \ - "---------------\n" \ - "Return whether the EEPROM settings are valid, or not.\n\n" \ "settings.version\n" \ - "----------------\n" \ - "Return the version of the EEPROM settings.\n\n" \ - "settings.crc\n" \ - "------------\n" \ - "Return the CRC of the settings.") + "settings.crc") #define FOCUS_HOOK_EEPROM FOCUS_HOOK(FocusHooks::eeprom, \ "eeprom.dump\n" \ - "-----------\n" \ - "Dump the contents of EEPROM.\n\n" \ - "eeprom.upload BYTES...\n" \ - "----------------------\n" \ - "Upload `BYTES` to EEPROM.") + "eeprom.upload") From 26d7af1b96b966d9a6db7adf0b4c18a81d314cd2 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 29 Mar 2017 14:51:32 +0200 Subject: [PATCH 12/56] Fix the `settings.version` Focus command There was a missing `break`, so control flowed through to the CRC case. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Settings-Focus.cpp | 1 + 1 file changed, 1 insertion(+) diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp index 84b58e55..d87943e7 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp @@ -47,6 +47,7 @@ namespace FocusHooks { break; case GETVERSION: Serial.println (EEPROMSettings.version ()); + break; case CRC: Serial.print (::CRC.crc, HEX); Serial.print (F("/")); From 19b5655770fa4f224551241d56231a00512b3188 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 29 Mar 2017 18:47:29 +0200 Subject: [PATCH 13/56] Add a way to figure out the used & free EEPROM amount Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Settings-Focus.cpp | 6 ++++++ src/Kaleidoscope/EEPROM-Settings-Focus.h | 1 + src/Kaleidoscope/EEPROM-Settings.cpp | 5 +++++ src/Kaleidoscope/EEPROM-Settings.h | 1 + 4 files changed, 13 insertions(+) diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp index d87943e7..40d201e2 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp @@ -60,6 +60,7 @@ namespace FocusHooks { bool eeprom (const char *command) { enum { + FREE, DUMP, UPLOAD, } subCommand; @@ -68,6 +69,8 @@ namespace FocusHooks { subCommand = DUMP; else if (strcmp_P (command, PSTR ("eeprom.upload")) == 0) subCommand = UPLOAD; + else if (strcmp_P (command, PSTR ("eeprom.free")) == 0) + subCommand = FREE; else return false; @@ -87,6 +90,9 @@ namespace FocusHooks { EEPROM.update (i, d); } break; + case FREE: + Serial.println (EEPROM.length () - EEPROMSettings.used ()); + break; } return true; diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.h b/src/Kaleidoscope/EEPROM-Settings-Focus.h index 54fc0f12..3e084e8b 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.h +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.h @@ -31,5 +31,6 @@ namespace FocusHooks { "settings.crc") #define FOCUS_HOOK_EEPROM FOCUS_HOOK(FocusHooks::eeprom, \ + "eeprom.free\n" \ "eeprom.dump\n" \ "eeprom.upload") diff --git a/src/Kaleidoscope/EEPROM-Settings.cpp b/src/Kaleidoscope/EEPROM-Settings.cpp index 1c384596..5ef289f9 100644 --- a/src/Kaleidoscope/EEPROM-Settings.cpp +++ b/src/Kaleidoscope/EEPROM-Settings.cpp @@ -82,6 +82,11 @@ namespace KaleidoscopePlugins { _isValid = false; } + uint16_t + EEPROMSettings::used (void) { + return nextStart; + } + void EEPROMSettings::update (void) { settings.crc = CRC.crc; diff --git a/src/Kaleidoscope/EEPROM-Settings.h b/src/Kaleidoscope/EEPROM-Settings.h index 02cc7d54..3cd95e82 100644 --- a/src/Kaleidoscope/EEPROM-Settings.h +++ b/src/Kaleidoscope/EEPROM-Settings.h @@ -37,6 +37,7 @@ namespace KaleidoscopePlugins { static uint16_t requestSlice (uint16_t size); static void seal (void); static uint16_t crc (void); + static uint16_t used (void); private: static uint16_t nextStart; From 0bfb77361989f02e0409d09a4d615b2eb6a52d3d Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 5 Apr 2017 10:14:45 +0200 Subject: [PATCH 14/56] Focus: Don't format the eeprom.dump output Fixes #1. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Settings-Focus.cpp | 2 -- 1 file changed, 2 deletions(-) diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp index 40d201e2..2fcdcdd9 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp @@ -80,8 +80,6 @@ namespace FocusHooks { uint8_t d = EEPROM[i]; Focus.printNumber (d); Focus.printSpace (); - if ((i + 1) % 32 == 0) - Serial.println (); } break; case UPLOAD: From fc59d1f64be8384f50c3499b5f3f45a673a4a16d Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 5 Apr 2017 10:25:34 +0200 Subject: [PATCH 15/56] Focus: Merge the eeprom.dump and eeprom.upload commands Fixes #2. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Settings-Focus.cpp | 35 +++++++++++----------- 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp index 2fcdcdd9..916dc1b3 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp @@ -60,34 +60,35 @@ namespace FocusHooks { bool eeprom (const char *command) { enum { + CONTENTS, FREE, - DUMP, - UPLOAD, } subCommand; - if (strcmp_P (command, PSTR ("eeprom.dump")) == 0) - subCommand = DUMP; - else if (strcmp_P (command, PSTR ("eeprom.upload")) == 0) - subCommand = UPLOAD; + if (strcmp_P (command, PSTR ("eeprom.contents")) == 0) + subCommand = CONTENTS; else if (strcmp_P (command, PSTR ("eeprom.free")) == 0) subCommand = FREE; else return false; switch (subCommand) { - case DUMP: - for (uint16_t i = 0; i < EEPROM.length (); i++) { - uint8_t d = EEPROM[i]; - Focus.printNumber (d); - Focus.printSpace (); - } - break; - case UPLOAD: - for (uint16_t i = 0; i < EEPROM.length (); i++) { - uint8_t d = Serial.parseInt (); - EEPROM.update (i, d); + case CONTENTS: { + if (Serial.peek () == '\n') { + for (uint16_t i = 0; i < EEPROM.length (); i++) { + uint8_t d = EEPROM[i]; + Focus.printNumber (d); + Focus.printSpace (); + } + Serial.println (); + } else { + for (uint16_t i = 0; i < EEPROM.length (); i++) { + uint8_t d = Serial.parseInt (); + EEPROM.update (i, d); + } } + break; + } case FREE: Serial.println (EEPROM.length () - EEPROMSettings.used ()); break; From cdd6b811f9b533859aeebe29f118cb49a31ee564 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 5 Apr 2017 10:27:15 +0200 Subject: [PATCH 16/56] Focus: Allow partial eeprom upload Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Settings-Focus.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp index 916dc1b3..b892b8dd 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp @@ -81,7 +81,7 @@ namespace FocusHooks { } Serial.println (); } else { - for (uint16_t i = 0; i < EEPROM.length (); i++) { + for (uint16_t i = 0; i < EEPROM.length () && Serial.peek () != '\n'; i++) { uint8_t d = Serial.parseInt (); EEPROM.update (i, d); } From a83d61e280b7aab4e2b02f7e5423a3d75570fbf8 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 5 Apr 2017 10:34:39 +0200 Subject: [PATCH 17/56] Focus: Fix the command list `eeprom.dump` and `eeprom.upload` has been merged into `eeprom.contents`, reflect that in the command list, too. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Settings-Focus.h | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.h b/src/Kaleidoscope/EEPROM-Settings-Focus.h index 3e084e8b..32c9fb13 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.h +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.h @@ -32,5 +32,4 @@ namespace FocusHooks { #define FOCUS_HOOK_EEPROM FOCUS_HOOK(FocusHooks::eeprom, \ "eeprom.free\n" \ - "eeprom.dump\n" \ - "eeprom.upload") + "eeprom.contents") From e3e6ec94887f40d1c4753c924b1162f8e1a00e2d Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 6 Apr 2017 19:25:47 +0200 Subject: [PATCH 18/56] README: Change the status images to SVG Signed-off-by: Gergely Nagy --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ee2e3fc3..6395057c 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,9 @@ [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-EEPROM-Settings.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-EEPROM-Settings - [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 TODO From 1379094d3926f9755da9eba7b38c840ab3f717ca Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 6 Apr 2017 19:44:17 +0200 Subject: [PATCH 19/56] Add some developer-oriented docs to the README Signed-off-by: Gergely Nagy --- README.md | 97 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 93 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6395057c..dcb503a3 100644 --- a/README.md +++ b/README.md @@ -9,22 +9,52 @@ [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 -TODO +To be able to reliably store persistent configuration in `EEPROM`, we need to be +able to split up the available space for plugins to use. We also want to make +sure that we notice when the `EEPROM` contents and the firmware are out of sync. +This plugin provides the tools to do that. + +It does not guard against errors, it merely provides the means to discover them, +and let the firmware Sketch handle the case in whatever way it finds reasonable. +It's a building block, and not much else. All Kaleidoscope plugins that need to +store data in `EEPROM` are encouraged to make use of this library. ## Using the plugin -TODO +There are a few steps one needs to take to use the plugin: we must first +register it, then either let other plugins request slices of `EEPROM`, or do so +ourselves. And finally, seal it, to signal that we are done setting up. At that +point, we can verify whether the contents of the `EEPROM` agree with our +firmware. ```c++ #include #include +static uint16_t settingsBase; +static struct { + bool someSettingFlag; +} testSettings; + void setup () { Kaleidoscope.setup (); USE_PLUGINS (&EEPROMSettings); - // TODO + /* Use other plugins that make use of the EEPROM */ + + settingsBase = EEPROMSettings.requestSlice (sizeof (testSettings)); + + EEPROMSettings.seal (); + + if (!EEPROMSettings.isValid ()) { + // Handle the case where the settings are out of sync... + // Flash LEDs, for example. + + return; + } + + EEPROM.get (settingsBase, testSettings); } ``` @@ -32,7 +62,66 @@ void setup () { The plugin provides the `EEPROMSettings` object, which has the following methods: -**TODO** +### `cycleThrough(keys...)` + +> Cycles through all the possibilities given in `keys` (starting from the +> beginning once it reached the end). This should be used from +> the [`cycleAction`][cycleaction] function, once it is determined what sequence +> to cycle through. + +### `update()` + +> Updates the `EEPROM` header with the current status quo, including the version +> and the CRC checksum. +> +> This should be called when upgrading from one version to another, or when +> fixing up an out-of-sync case. + +### `isValid()` + +> Returns whether the `EEPROM` header is valid, that is, if it has the expected +> CRC checksum. +> +> Should only be called after calling `seal()`. + +### `invalidate()` + +> Invalidates the `EEPROM` header. Use when the version does not match what the +> firmware would expect. This signals to other plugins that the contents of +> `EEPROM` should not be trusted. + +### `version([newVersion])` + +> Sets or returns the version of the `EEPROM` layout. This is purely for use by +> the firmware, so it can attempt to upgrade the contents, if need be, or alert +> the user in there's a mismatch. Plugins do not use this property. +> +> Should only be called after calling `seal()`. + +### `requestSlice(size)` + +> Requests a slice of the `EEPROM`, and returns the starting address (or 0 on +> error, including when the request arrived after sealing the layout). +> +> Should only be called **before** calling `seal()`. + +### `seal()` + +> Seal the `EEPROM` layout, so no new slices can be requested. The CRC checksum +> is considered final at this time, and the `isValid()`, `crc()`, `used()` and +> `version()` methods can be used from this point onwards. + +### `crc()` + +> Returns the CRC checksum of the layout. Should only be used after calling +> `seal()`. + +### `used()` + +> Returns the amount of space requested so far. +> +> Should only be used after calling `seal()`. + ## Dependencies From b811e1f973ff7c4ba954f92dc367150db50fe101 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 6 Apr 2017 19:47:16 +0200 Subject: [PATCH 20/56] Document the Focus hooks too Signed-off-by: Gergely Nagy --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dcb503a3..bc2ed1ed 100644 --- a/README.md +++ b/README.md @@ -122,10 +122,17 @@ The plugin provides the `EEPROMSettings` object, which has the following methods > > Should only be used after calling `seal()`. +## Focus Hooks + +The plugin provides two [Focus][focus] hooks: `FOCUS_HOOK_SETTINGS`, and +`FOCUS_HOOK_EEPROM`, that register commands that allow one to work with the +settings, and with the contents of the `EEPROM` through Focus. + + [focus]: https://github.com/keyboardio/Kaleidoscope-Focus ## Dependencies -* [Kaleidoscope-Focus](https://github.com/keyboardio/Kaleidoscope-Focus) +* [Kaleidoscope-Focus][focus] ## Further reading From 957866fb841759f22f470dc1b2d9b08e99f0c960 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 7 Apr 2017 12:22:12 +0200 Subject: [PATCH 21/56] README: Drop a left over sample from another plugin Signed-off-by: Gergely Nagy --- README.md | 7 ------- 1 file changed, 7 deletions(-) diff --git a/README.md b/README.md index bc2ed1ed..63d333ca 100644 --- a/README.md +++ b/README.md @@ -62,13 +62,6 @@ void setup () { The plugin provides the `EEPROMSettings` object, which has the following methods: -### `cycleThrough(keys...)` - -> Cycles through all the possibilities given in `keys` (starting from the -> beginning once it reached the end). This should be used from -> the [`cycleAction`][cycleaction] function, once it is determined what sequence -> to cycle through. - ### `update()` > Updates the `EEPROM` header with the current status quo, including the version From 664df896e0a6757c65defb1acf78a99aabc1f318 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 7 Apr 2017 12:23:18 +0200 Subject: [PATCH 22/56] README: Rearrange the methods a bit Signed-off-by: Gergely Nagy --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 63d333ca..00be48d8 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,19 @@ void setup () { The plugin provides the `EEPROMSettings` object, which has the following methods: +### `requestSlice(size)` + +> Requests a slice of the `EEPROM`, and returns the starting address (or 0 on +> error, including when the request arrived after sealing the layout). +> +> Should only be called **before** calling `seal()`. + +### `seal()` + +> Seal the `EEPROM` layout, so no new slices can be requested. The CRC checksum +> is considered final at this time, and the `isValid()`, `crc()`, `used()` and +> `version()` methods can be used from this point onwards. + ### `update()` > Updates the `EEPROM` header with the current status quo, including the version @@ -91,19 +104,6 @@ The plugin provides the `EEPROMSettings` object, which has the following methods > > Should only be called after calling `seal()`. -### `requestSlice(size)` - -> Requests a slice of the `EEPROM`, and returns the starting address (or 0 on -> error, including when the request arrived after sealing the layout). -> -> Should only be called **before** calling `seal()`. - -### `seal()` - -> Seal the `EEPROM` layout, so no new slices can be requested. The CRC checksum -> is considered final at this time, and the `isValid()`, `crc()`, `used()` and -> `version()` methods can be used from this point onwards. - ### `crc()` > Returns the CRC checksum of the layout. Should only be used after calling From a5a3bb65216abfdd3a2defd23c75f93e036b1f3f Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 22 May 2017 01:01:43 -0700 Subject: [PATCH 23/56] Update to new Keymap --- examples/EEPROM-Settings/EEPROM-Settings.ino | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/examples/EEPROM-Settings/EEPROM-Settings.ino b/examples/EEPROM-Settings/EEPROM-Settings.ino index 7ca1700a..7eed1f01 100644 --- a/examples/EEPROM-Settings/EEPROM-Settings.ino +++ b/examples/EEPROM-Settings/EEPROM-Settings.ino @@ -25,9 +25,9 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, - Key_PageDn, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Esc, + Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, - Key_LCtrl, Key_Backspace, Key_LGUI, Key_LShift, + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, Key_skip, Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, @@ -35,7 +35,7 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, - Key_RShift, Key_RAlt, Key_Space, Key_RCtrl, + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, Key_skip ), }; From 59c361e6c8cd908c55e473f7bea57b720d716053 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 23 May 2017 20:00:23 -0700 Subject: [PATCH 24/56] New build infrastructure --- .travis.yml | 28 ++++++++++++++++------------ Makefile | 12 ++++++++++++ 2 files changed, 28 insertions(+), 12 deletions(-) create mode 100644 Makefile diff --git a/.travis.yml b/.travis.yml index ed2b2e3b..e7030acf 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,17 +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 - - 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 e3dc58f38453a3822d0c772411636ac7c0a0a250 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Fri, 26 May 2017 16:20:21 -0700 Subject: [PATCH 25/56] make astyle --- examples/EEPROM-Settings/EEPROM-Settings.ino | 54 ++++++------ src/Kaleidoscope/EEPROM-Settings-Focus.cpp | 82 +++++++++--------- src/Kaleidoscope/EEPROM-Settings-Focus.h | 4 +- src/Kaleidoscope/EEPROM-Settings.cpp | 88 ++++++++++---------- src/Kaleidoscope/EEPROM-Settings.h | 10 +-- src/Kaleidoscope/crc.cpp | 53 ++++++------ src/Kaleidoscope/crc.h | 14 ++-- 7 files changed, 153 insertions(+), 152 deletions(-) diff --git a/examples/EEPROM-Settings/EEPROM-Settings.ino b/examples/EEPROM-Settings/EEPROM-Settings.ino index 7eed1f01..ef8fcc2d 100644 --- a/examples/EEPROM-Settings/EEPROM-Settings.ino +++ b/examples/EEPROM-Settings/EEPROM-Settings.ino @@ -20,41 +20,41 @@ #include const Key keymaps[][ROWS][COLS] PROGMEM = { - [0] = KEYMAP_STACKED - ( - Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, - Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, - Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, - Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, - - Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, - Key_skip, - - Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, - Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, - Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, - Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, - - Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, - Key_skip - ), + [0] = KEYMAP_STACKED + ( + Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, + Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, + Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, + Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, + + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, + Key_skip, + + Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, + Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, + + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, + Key_skip + ), }; void setup () { - Serial.begin (9600); + Serial.begin (9600); - Kaleidoscope.setup (); + Kaleidoscope.setup (); - USE_PLUGINS (&EEPROMSettings); + USE_PLUGINS (&EEPROMSettings); - while (!Serial) { - } + while (!Serial) { + } - Serial.println (EEPROMSettings.isValid () ? F("valid EEPROM settings") : F("invalid EEPROM settings")); - Serial.println (EEPROMSettings.crc (), HEX); - Serial.println (EEPROMSettings.version ()); + Serial.println (EEPROMSettings.isValid () ? F("valid EEPROM settings") : F("invalid EEPROM settings")); + Serial.println (EEPROMSettings.crc (), HEX); + Serial.println (EEPROMSettings.version ()); } void loop () { - Kaleidoscope.loop (); + Kaleidoscope.loop (); } diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp index b892b8dd..4a187e7e 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp @@ -21,79 +21,79 @@ #include "crc.h" namespace FocusHooks { - bool settings (const char *command) { +bool settings (const char *command) { enum { - ISVALID, - GETVERSION, - CRC, + ISVALID, + GETVERSION, + CRC, } subCommand; if (strncmp_P (command, PSTR ("settings."), 9) != 0) - return false; + return false; if (strcmp_P (command + 9, PSTR ("valid?")) == 0) - subCommand = ISVALID; + subCommand = ISVALID; else if (strcmp_P (command + 9, PSTR ("version")) == 0) - subCommand = GETVERSION; + subCommand = GETVERSION; else if (strcmp_P (command + 9, PSTR ("crc")) == 0) - subCommand = CRC; + subCommand = CRC; else - return false; + return false; switch (subCommand) { case ISVALID: - Focus.printBool (EEPROMSettings.isValid ()); - Serial.println (); - break; + Focus.printBool (EEPROMSettings.isValid ()); + Serial.println (); + break; case GETVERSION: - Serial.println (EEPROMSettings.version ()); - break; + Serial.println (EEPROMSettings.version ()); + break; case CRC: - Serial.print (::CRC.crc, HEX); - Serial.print (F("/")); - Serial.println (EEPROMSettings.crc (), HEX); - break; + Serial.print (::CRC.crc, HEX); + Serial.print (F("/")); + Serial.println (EEPROMSettings.crc (), HEX); + break; } return true; - } +} - bool eeprom (const char *command) { +bool eeprom (const char *command) { enum { - CONTENTS, - FREE, + CONTENTS, + FREE, } subCommand; if (strcmp_P (command, PSTR ("eeprom.contents")) == 0) - subCommand = CONTENTS; + subCommand = CONTENTS; else if (strcmp_P (command, PSTR ("eeprom.free")) == 0) - subCommand = FREE; + subCommand = FREE; else - return false; + return false; switch (subCommand) { case CONTENTS: { - if (Serial.peek () == '\n') { - for (uint16_t i = 0; i < EEPROM.length (); i++) { - uint8_t d = EEPROM[i]; - Focus.printNumber (d); - Focus.printSpace (); - } - Serial.println (); - } else { - for (uint16_t i = 0; i < EEPROM.length () && Serial.peek () != '\n'; i++) { - uint8_t d = Serial.parseInt (); - EEPROM.update (i, d); + if (Serial.peek () == '\n') { + for (uint16_t i = 0; i < EEPROM.length (); i++) { + uint8_t d = EEPROM[i]; + Focus.printNumber (d); + Focus.printSpace (); + } + Serial.println (); + } else { + for (uint16_t i = 0; i < EEPROM.length () && Serial.peek () != '\n'; i++) { + uint8_t d = Serial.parseInt (); + EEPROM.update (i, d); + } } - } - break; + break; } case FREE: - Serial.println (EEPROM.length () - EEPROMSettings.used ()); - break; + Serial.println (EEPROM.length () - EEPROMSettings.used ()); + break; } return true; - } +} }; diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.h b/src/Kaleidoscope/EEPROM-Settings-Focus.h index 32c9fb13..00e9ea6d 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.h +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.h @@ -21,8 +21,8 @@ #include namespace FocusHooks { - bool settings (const char *command); - bool eeprom (const char *command); +bool settings (const char *command); +bool eeprom (const char *command); }; #define FOCUS_HOOK_SETTINGS FOCUS_HOOK(FocusHooks::settings, \ diff --git a/src/Kaleidoscope/EEPROM-Settings.cpp b/src/Kaleidoscope/EEPROM-Settings.cpp index 5ef289f9..d81bb9f2 100644 --- a/src/Kaleidoscope/EEPROM-Settings.cpp +++ b/src/Kaleidoscope/EEPROM-Settings.cpp @@ -20,54 +20,54 @@ #include "crc.h" namespace KaleidoscopePlugins { - struct EEPROMSettings::settings EEPROMSettings::settings; - bool EEPROMSettings::_isValid; - bool EEPROMSettings::sealed; - uint16_t EEPROMSettings::nextStart = sizeof (EEPROMSettings::settings); +struct EEPROMSettings::settings EEPROMSettings::settings; +bool EEPROMSettings::_isValid; +bool EEPROMSettings::sealed; +uint16_t EEPROMSettings::nextStart = sizeof (EEPROMSettings::settings); - EEPROMSettings::EEPROMSettings (void) { - } +EEPROMSettings::EEPROMSettings (void) { +} - void - EEPROMSettings::begin (void) { +void +EEPROMSettings::begin (void) { EEPROM.get (0, settings); - } +} - bool - EEPROMSettings::isValid (void) { +bool +EEPROMSettings::isValid (void) { return _isValid; - } +} - uint16_t - EEPROMSettings::crc (void) { +uint16_t +EEPROMSettings::crc (void) { if (sealed) - return settings.crc; + return settings.crc; return 0; - } +} - void - EEPROMSettings::seal (void) { +void +EEPROMSettings::seal (void) { sealed = true; CRC.finalize (); if (settings.magic[0] != 'K' || settings.magic[1] != 'S') { - settings.magic[0] = 'K'; - settings.magic[1] = 'S'; - settings.version = 0; - settings.crc = CRC.crc; + settings.magic[0] = 'K'; + settings.magic[1] = 'S'; + settings.version = 0; + settings.crc = CRC.crc; - return update (); + return update (); } if (settings.crc != CRC.crc) - _isValid = false; - } + _isValid = false; +} - uint16_t - EEPROMSettings::requestSlice (uint16_t size) { +uint16_t +EEPROMSettings::requestSlice (uint16_t size) { if (sealed) - return 0; + return 0; uint16_t start = nextStart; nextStart += size; @@ -75,36 +75,36 @@ namespace KaleidoscopePlugins { CRC.update ((const void *)&size, sizeof (size)); return start; - } +} - void - EEPROMSettings::invalidate (void) { +void +EEPROMSettings::invalidate (void) { _isValid = false; - } +} - uint16_t - EEPROMSettings::used (void) { +uint16_t +EEPROMSettings::used (void) { return nextStart; - } +} - void - EEPROMSettings::update (void) { +void +EEPROMSettings::update (void) { settings.crc = CRC.crc; EEPROM.put (0, settings); _isValid = true; - } +} - uint8_t - EEPROMSettings::version (void) { +uint8_t +EEPROMSettings::version (void) { return settings.version; - } +} - void - EEPROMSettings::version (uint8_t ver) { +void +EEPROMSettings::version (uint8_t ver) { settings.version = ver; update (); - } +} }; KaleidoscopePlugins::EEPROMSettings EEPROMSettings; diff --git a/src/Kaleidoscope/EEPROM-Settings.h b/src/Kaleidoscope/EEPROM-Settings.h index 3cd95e82..4c9e2c48 100644 --- a/src/Kaleidoscope/EEPROM-Settings.h +++ b/src/Kaleidoscope/EEPROM-Settings.h @@ -22,7 +22,7 @@ #include namespace KaleidoscopePlugins { - class EEPROMSettings : public KaleidoscopePlugin { +class EEPROMSettings : public KaleidoscopePlugin { public: EEPROMSettings (void); @@ -45,11 +45,11 @@ namespace KaleidoscopePlugins { static bool sealed; static struct settings { - char magic[2]; - uint8_t version; - uint16_t crc; + char magic[2]; + uint8_t version; + uint16_t crc; } settings; - }; +}; }; extern KaleidoscopePlugins::EEPROMSettings EEPROMSettings; diff --git a/src/Kaleidoscope/crc.cpp b/src/Kaleidoscope/crc.cpp index f8403548..a3a1a5e8 100644 --- a/src/Kaleidoscope/crc.cpp +++ b/src/Kaleidoscope/crc.cpp @@ -31,41 +31,40 @@ void CRC_::reflect (uint8_t len) { - uint8_t i; - uint16_t newCRC; + uint8_t i; + uint16_t newCRC; - newCRC = crc & 0x01; - for (i = 1; i < len; i++) { - crc >>= 1; - newCRC = (newCRC << 1) | (crc & 0x01); - } + newCRC = crc & 0x01; + for (i = 1; i < len; i++) { + crc >>= 1; + newCRC = (newCRC << 1) | (crc & 0x01); + } - crc = newCRC; + crc = newCRC; } void -CRC_::update (const void *data, uint8_t len) -{ - const uint8_t *d = (const uint8_t *)data; - uint8_t i; - bool bit; - uint8_t c; +CRC_::update (const void *data, uint8_t len) { + const uint8_t *d = (const uint8_t *)data; + uint8_t i; + bool bit; + uint8_t c; - while (len--) { - c = *d++; - for (i = 0x01; i & 0xff; i <<= 1) { - bit = crc & 0x8000; - if (c & i) { - bit = !bit; - } - crc <<= 1; - if (bit) { - crc ^= 0x8005; - } + while (len--) { + c = *d++; + for (i = 0x01; i & 0xff; i <<= 1) { + bit = crc & 0x8000; + if (c & i) { + bit = !bit; + } + crc <<= 1; + if (bit) { + crc ^= 0x8005; + } + } + crc &= 0xffff; } crc &= 0xffff; - } - crc &= 0xffff; } CRC_ CRC; diff --git a/src/Kaleidoscope/crc.h b/src/Kaleidoscope/crc.h index f3db42a9..f0f919b7 100644 --- a/src/Kaleidoscope/crc.h +++ b/src/Kaleidoscope/crc.h @@ -32,14 +32,16 @@ #include class CRC_ { - public: - uint16_t crc = 0; + public: + uint16_t crc = 0; - CRC_ (void) {}; + CRC_ (void) {}; - void update (const void *data, uint8_t len); - void finalize (void) { reflect (16); }; - void reflect (uint8_t len); + void update (const void *data, uint8_t len); + void finalize (void) { + reflect (16); + }; + void reflect (uint8_t len); }; extern CRC_ CRC; From a0b2d400dbed4c706144fc51a69c979b9d1ef7b0 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Sat, 3 Jun 2017 22:56:30 -0700 Subject: [PATCH 26/56] astyle with current project style guidelines --- examples/EEPROM-Settings/EEPROM-Settings.ino | 58 ++++----- src/Kaleidoscope/EEPROM-Settings-Focus.cpp | 128 +++++++++---------- src/Kaleidoscope/EEPROM-Settings-Focus.h | 4 +- src/Kaleidoscope/EEPROM-Settings.cpp | 84 ++++++------ src/Kaleidoscope/EEPROM-Settings.h | 52 ++++---- src/Kaleidoscope/crc.cpp | 54 ++++---- src/Kaleidoscope/crc.h | 16 +-- 7 files changed, 198 insertions(+), 198 deletions(-) diff --git a/examples/EEPROM-Settings/EEPROM-Settings.ino b/examples/EEPROM-Settings/EEPROM-Settings.ino index ef8fcc2d..09c6e59e 100644 --- a/examples/EEPROM-Settings/EEPROM-Settings.ino +++ b/examples/EEPROM-Settings/EEPROM-Settings.ino @@ -20,41 +20,41 @@ #include const Key keymaps[][ROWS][COLS] PROGMEM = { - [0] = KEYMAP_STACKED - ( - Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, - Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, - Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, - Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, - - Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, - Key_skip, - - Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, - Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, - Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, - Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, - - Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, - Key_skip - ), + [0] = KEYMAP_STACKED + ( + Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, + Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, + Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, + Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, + + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, + Key_skip, + + Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, + Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, + + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, + Key_skip + ), }; -void setup () { - Serial.begin (9600); +void setup() { + Serial.begin(9600); - Kaleidoscope.setup (); + Kaleidoscope.setup(); - USE_PLUGINS (&EEPROMSettings); + USE_PLUGINS(&EEPROMSettings); - while (!Serial) { - } + while (!Serial) { + } - Serial.println (EEPROMSettings.isValid () ? F("valid EEPROM settings") : F("invalid EEPROM settings")); - Serial.println (EEPROMSettings.crc (), HEX); - Serial.println (EEPROMSettings.version ()); + Serial.println(EEPROMSettings.isValid() ? F("valid EEPROM settings") : F("invalid EEPROM settings")); + Serial.println(EEPROMSettings.crc(), HEX); + Serial.println(EEPROMSettings.version()); } -void loop () { - Kaleidoscope.loop (); +void loop() { + Kaleidoscope.loop(); } diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp index 4a187e7e..3bdee5b3 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp @@ -21,79 +21,79 @@ #include "crc.h" namespace FocusHooks { -bool settings (const char *command) { - enum { - ISVALID, - GETVERSION, - CRC, - } subCommand; +bool settings(const char *command) { + enum { + ISVALID, + GETVERSION, + CRC, + } subCommand; - if (strncmp_P (command, PSTR ("settings."), 9) != 0) - return false; + if (strncmp_P(command, PSTR("settings."), 9) != 0) + return false; - if (strcmp_P (command + 9, PSTR ("valid?")) == 0) - subCommand = ISVALID; - else if (strcmp_P (command + 9, PSTR ("version")) == 0) - subCommand = GETVERSION; - else if (strcmp_P (command + 9, PSTR ("crc")) == 0) - subCommand = CRC; - else - return false; + if (strcmp_P(command + 9, PSTR("valid?")) == 0) + subCommand = ISVALID; + else if (strcmp_P(command + 9, PSTR("version")) == 0) + subCommand = GETVERSION; + else if (strcmp_P(command + 9, PSTR("crc")) == 0) + subCommand = CRC; + else + return false; - switch (subCommand) { - case ISVALID: - Focus.printBool (EEPROMSettings.isValid ()); - Serial.println (); - break; - case GETVERSION: - Serial.println (EEPROMSettings.version ()); - break; - case CRC: - Serial.print (::CRC.crc, HEX); - Serial.print (F("/")); - Serial.println (EEPROMSettings.crc (), HEX); - break; - } + switch (subCommand) { + case ISVALID: + Focus.printBool(EEPROMSettings.isValid()); + Serial.println(); + break; + case GETVERSION: + Serial.println(EEPROMSettings.version()); + break; + case CRC: + Serial.print(::CRC.crc, HEX); + Serial.print(F("/")); + Serial.println(EEPROMSettings.crc(), HEX); + break; + } - return true; + return true; } -bool eeprom (const char *command) { - enum { - CONTENTS, - FREE, - } subCommand; - - if (strcmp_P (command, PSTR ("eeprom.contents")) == 0) - subCommand = CONTENTS; - else if (strcmp_P (command, PSTR ("eeprom.free")) == 0) - subCommand = FREE; - else - return false; +bool eeprom(const char *command) { + enum { + CONTENTS, + FREE, + } subCommand; - switch (subCommand) { - case CONTENTS: { - if (Serial.peek () == '\n') { - for (uint16_t i = 0; i < EEPROM.length (); i++) { - uint8_t d = EEPROM[i]; - Focus.printNumber (d); - Focus.printSpace (); - } - Serial.println (); - } else { - for (uint16_t i = 0; i < EEPROM.length () && Serial.peek () != '\n'; i++) { - uint8_t d = Serial.parseInt (); - EEPROM.update (i, d); - } - } + if (strcmp_P(command, PSTR("eeprom.contents")) == 0) + subCommand = CONTENTS; + else if (strcmp_P(command, PSTR("eeprom.free")) == 0) + subCommand = FREE; + else + return false; - break; - } - case FREE: - Serial.println (EEPROM.length () - EEPROMSettings.used ()); - break; + switch (subCommand) { + case CONTENTS: { + if (Serial.peek() == '\n') { + for (uint16_t i = 0; i < EEPROM.length(); i++) { + uint8_t d = EEPROM[i]; + Focus.printNumber(d); + Focus.printSpace(); + } + Serial.println(); + } else { + for (uint16_t i = 0; i < EEPROM.length() && Serial.peek() != '\n'; i++) { + uint8_t d = Serial.parseInt(); + EEPROM.update(i, d); + } } - return true; + break; + } + case FREE: + Serial.println(EEPROM.length() - EEPROMSettings.used()); + break; + } + + return true; } }; diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.h b/src/Kaleidoscope/EEPROM-Settings-Focus.h index 00e9ea6d..42beef42 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.h +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.h @@ -21,8 +21,8 @@ #include namespace FocusHooks { -bool settings (const char *command); -bool eeprom (const char *command); +bool settings(const char *command); +bool eeprom(const char *command); }; #define FOCUS_HOOK_SETTINGS FOCUS_HOOK(FocusHooks::settings, \ diff --git a/src/Kaleidoscope/EEPROM-Settings.cpp b/src/Kaleidoscope/EEPROM-Settings.cpp index d81bb9f2..02dabacb 100644 --- a/src/Kaleidoscope/EEPROM-Settings.cpp +++ b/src/Kaleidoscope/EEPROM-Settings.cpp @@ -23,87 +23,87 @@ namespace KaleidoscopePlugins { struct EEPROMSettings::settings EEPROMSettings::settings; bool EEPROMSettings::_isValid; bool EEPROMSettings::sealed; -uint16_t EEPROMSettings::nextStart = sizeof (EEPROMSettings::settings); +uint16_t EEPROMSettings::nextStart = sizeof(EEPROMSettings::settings); -EEPROMSettings::EEPROMSettings (void) { +EEPROMSettings::EEPROMSettings(void) { } void -EEPROMSettings::begin (void) { - EEPROM.get (0, settings); +EEPROMSettings::begin(void) { + EEPROM.get(0, settings); } bool -EEPROMSettings::isValid (void) { - return _isValid; +EEPROMSettings::isValid(void) { + return _isValid; } uint16_t -EEPROMSettings::crc (void) { - if (sealed) - return settings.crc; - return 0; +EEPROMSettings::crc(void) { + if (sealed) + return settings.crc; + return 0; } void -EEPROMSettings::seal (void) { - sealed = true; +EEPROMSettings::seal(void) { + sealed = true; - CRC.finalize (); + CRC.finalize(); - if (settings.magic[0] != 'K' || settings.magic[1] != 'S') { - settings.magic[0] = 'K'; - settings.magic[1] = 'S'; - settings.version = 0; - settings.crc = CRC.crc; + if (settings.magic[0] != 'K' || settings.magic[1] != 'S') { + settings.magic[0] = 'K'; + settings.magic[1] = 'S'; + settings.version = 0; + settings.crc = CRC.crc; - return update (); - } + return update(); + } - if (settings.crc != CRC.crc) - _isValid = false; + if (settings.crc != CRC.crc) + _isValid = false; } uint16_t -EEPROMSettings::requestSlice (uint16_t size) { - if (sealed) - return 0; +EEPROMSettings::requestSlice(uint16_t size) { + if (sealed) + return 0; - uint16_t start = nextStart; - nextStart += size; + uint16_t start = nextStart; + nextStart += size; - CRC.update ((const void *)&size, sizeof (size)); + CRC.update((const void *)&size, sizeof(size)); - return start; + return start; } void -EEPROMSettings::invalidate (void) { - _isValid = false; +EEPROMSettings::invalidate(void) { + _isValid = false; } uint16_t -EEPROMSettings::used (void) { - return nextStart; +EEPROMSettings::used(void) { + return nextStart; } void -EEPROMSettings::update (void) { - settings.crc = CRC.crc; +EEPROMSettings::update(void) { + settings.crc = CRC.crc; - EEPROM.put (0, settings); - _isValid = true; + EEPROM.put(0, settings); + _isValid = true; } uint8_t -EEPROMSettings::version (void) { - return settings.version; +EEPROMSettings::version(void) { + return settings.version; } void -EEPROMSettings::version (uint8_t ver) { - settings.version = ver; - update (); +EEPROMSettings::version(uint8_t ver) { + settings.version = ver; + update(); } }; diff --git a/src/Kaleidoscope/EEPROM-Settings.h b/src/Kaleidoscope/EEPROM-Settings.h index 4c9e2c48..8f2d81a0 100644 --- a/src/Kaleidoscope/EEPROM-Settings.h +++ b/src/Kaleidoscope/EEPROM-Settings.h @@ -23,32 +23,32 @@ namespace KaleidoscopePlugins { class EEPROMSettings : public KaleidoscopePlugin { - public: - EEPROMSettings (void); - - virtual void begin (void) final; - - static void update (void); - static bool isValid (void); - static void invalidate (void); - static uint8_t version (void); - static void version (uint8_t ver); - - static uint16_t requestSlice (uint16_t size); - static void seal (void); - static uint16_t crc (void); - static uint16_t used (void); - - private: - static uint16_t nextStart; - static bool _isValid; - static bool sealed; - - static struct settings { - char magic[2]; - uint8_t version; - uint16_t crc; - } settings; + public: + EEPROMSettings(void); + + virtual void begin(void) final; + + static void update(void); + static bool isValid(void); + static void invalidate(void); + static uint8_t version(void); + static void version(uint8_t ver); + + static uint16_t requestSlice(uint16_t size); + static void seal(void); + static uint16_t crc(void); + static uint16_t used(void); + + private: + static uint16_t nextStart; + static bool _isValid; + static bool sealed; + + static struct settings { + char magic[2]; + uint8_t version; + uint16_t crc; + } settings; }; }; diff --git a/src/Kaleidoscope/crc.cpp b/src/Kaleidoscope/crc.cpp index a3a1a5e8..4ae8d23f 100644 --- a/src/Kaleidoscope/crc.cpp +++ b/src/Kaleidoscope/crc.cpp @@ -30,41 +30,41 @@ #include "crc.h" void -CRC_::reflect (uint8_t len) { - uint8_t i; - uint16_t newCRC; +CRC_::reflect(uint8_t len) { + uint8_t i; + uint16_t newCRC; - newCRC = crc & 0x01; - for (i = 1; i < len; i++) { - crc >>= 1; - newCRC = (newCRC << 1) | (crc & 0x01); - } + newCRC = crc & 0x01; + for (i = 1; i < len; i++) { + crc >>= 1; + newCRC = (newCRC << 1) | (crc & 0x01); + } - crc = newCRC; + crc = newCRC; } void -CRC_::update (const void *data, uint8_t len) { - const uint8_t *d = (const uint8_t *)data; - uint8_t i; - bool bit; - uint8_t c; +CRC_::update(const void *data, uint8_t len) { + const uint8_t *d = (const uint8_t *)data; + uint8_t i; + bool bit; + uint8_t c; - while (len--) { - c = *d++; - for (i = 0x01; i & 0xff; i <<= 1) { - bit = crc & 0x8000; - if (c & i) { - bit = !bit; - } - crc <<= 1; - if (bit) { - crc ^= 0x8005; - } - } - crc &= 0xffff; + while (len--) { + c = *d++; + for (i = 0x01; i & 0xff; i <<= 1) { + bit = crc & 0x8000; + if (c & i) { + bit = !bit; + } + crc <<= 1; + if (bit) { + crc ^= 0x8005; + } } crc &= 0xffff; + } + crc &= 0xffff; } CRC_ CRC; diff --git a/src/Kaleidoscope/crc.h b/src/Kaleidoscope/crc.h index f0f919b7..cba1d21d 100644 --- a/src/Kaleidoscope/crc.h +++ b/src/Kaleidoscope/crc.h @@ -32,16 +32,16 @@ #include class CRC_ { - public: - uint16_t crc = 0; + public: + uint16_t crc = 0; - CRC_ (void) {}; + CRC_(void) {}; - void update (const void *data, uint8_t len); - void finalize (void) { - reflect (16); - }; - void reflect (uint8_t len); + void update(const void *data, uint8_t len); + void finalize(void) { + reflect(16); + }; + void reflect(uint8_t len); }; extern CRC_ CRC; From 49887a2805440461d2f4550772c46c154d5cad83 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Sun, 4 Jun 2017 00:34:59 -0700 Subject: [PATCH 27/56] virtual void begin(void) final is redunant and makes the linter unhappy --- src/Kaleidoscope/EEPROM-Settings.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/EEPROM-Settings.h b/src/Kaleidoscope/EEPROM-Settings.h index 8f2d81a0..5f17938b 100644 --- a/src/Kaleidoscope/EEPROM-Settings.h +++ b/src/Kaleidoscope/EEPROM-Settings.h @@ -26,7 +26,7 @@ class EEPROMSettings : public KaleidoscopePlugin { public: EEPROMSettings(void); - virtual void begin(void) final; + void begin(void) final; static void update(void); static bool isValid(void); From 202860575baf726f3555f6a1ac58ce9f26aff383 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 4 Jun 2017 12:18:58 +0200 Subject: [PATCH 28/56] Kaleidoscope Style Guide conformance Signed-off-by: Gergely Nagy --- README.md | 41 ++++++++++--- src/Kaleidoscope/EEPROM-Settings.cpp | 90 +++++++++++++--------------- src/Kaleidoscope/EEPROM-Settings.h | 12 ++-- 3 files changed, 81 insertions(+), 62 deletions(-) diff --git a/README.md b/README.md index 00be48d8..aa0e3fba 100644 --- a/README.md +++ b/README.md @@ -37,24 +37,24 @@ static struct { } testSettings; void setup () { - Kaleidoscope.setup (); + Kaleidoscope.setup(); - USE_PLUGINS (&EEPROMSettings); + USE_PLUGINS(&EEPROMSettings); /* Use other plugins that make use of the EEPROM */ - settingsBase = EEPROMSettings.requestSlice (sizeof (testSettings)); + settingsBase = EEPROMSettings.requestSlice(sizeof(testSettings)); - EEPROMSettings.seal (); + EEPROMSettings.seal(); - if (!EEPROMSettings.isValid ()) { + if (!EEPROMSettings.isValid()) { // Handle the case where the settings are out of sync... // Flash LEDs, for example. return; } - EEPROM.get (settingsBase, testSettings); + EEPROM.get(settingsBase, testSettings); } ``` @@ -115,13 +115,40 @@ The plugin provides the `EEPROMSettings` object, which has the following methods > > Should only be used after calling `seal()`. -## Focus Hooks +## Focus commands The plugin provides two [Focus][focus] hooks: `FOCUS_HOOK_SETTINGS`, and `FOCUS_HOOK_EEPROM`, that register commands that allow one to work with the settings, and with the contents of the `EEPROM` through Focus. [focus]: https://github.com/keyboardio/Kaleidoscope-Focus + +These provide the following `Focus` commands: + +### `settings.crc` + +> Returns the actual, and the expected checksum of the settings. + +### `settings.valid?` + +> Returns either `true` or `false`, depending on whether the sealed settings are +> to be considered valid or not. + +### `settings.version` + +> Returns the (user-set) version of the settings. + +### `eeprom.contents` + +> Without argument, displays the full contents of the `EEPROM`, including the +> settings header. +> +> With arguments, the command updates as much of the `EEPROM` as arguments are +> provided. It will discard any unnecessary arguments. + +### `eeprom.free` + +> Returns the amount of free bytes in `EEPROM`. ## Dependencies diff --git a/src/Kaleidoscope/EEPROM-Settings.cpp b/src/Kaleidoscope/EEPROM-Settings.cpp index 02dabacb..9037c701 100644 --- a/src/Kaleidoscope/EEPROM-Settings.cpp +++ b/src/Kaleidoscope/EEPROM-Settings.cpp @@ -19,92 +19,84 @@ #include #include "crc.h" -namespace KaleidoscopePlugins { -struct EEPROMSettings::settings EEPROMSettings::settings; -bool EEPROMSettings::_isValid; -bool EEPROMSettings::sealed; -uint16_t EEPROMSettings::nextStart = sizeof(EEPROMSettings::settings); +namespace kaleidoscope { + +struct EEPROMSettings::settings EEPROMSettings::settings_; +bool EEPROMSettings::is_valid_; +bool EEPROMSettings::sealed_; +uint16_t EEPROMSettings::next_start_ = sizeof(EEPROMSettings::settings); EEPROMSettings::EEPROMSettings(void) { } -void -EEPROMSettings::begin(void) { - EEPROM.get(0, settings); +void EEPROMSettings::begin(void) { + EEPROM.get(0, settings_); } -bool -EEPROMSettings::isValid(void) { - return _isValid; +bool EEPROMSettings::isValid(void) { + return is_valid_; } -uint16_t -EEPROMSettings::crc(void) { - if (sealed) - return settings.crc; +uint16_t EEPROMSettings::crc(void) { + if (sealed_) + return settings_.crc; return 0; } -void -EEPROMSettings::seal(void) { - sealed = true; +void EEPROMSettings::seal(void) { + sealed_ = true; CRC.finalize(); - if (settings.magic[0] != 'K' || settings.magic[1] != 'S') { - settings.magic[0] = 'K'; - settings.magic[1] = 'S'; - settings.version = 0; - settings.crc = CRC.crc; + if (settings_.magic[0] != 'K' || settings_.magic[1] != 'S') { + settings_.magic[0] = 'K'; + settings_.magic[1] = 'S'; + settings_.version = 0; + settings_.crc = CRC.crc; return update(); } - if (settings.crc != CRC.crc) - _isValid = false; + if (settings_.crc != CRC.crc) + is_valid_ = false; } -uint16_t -EEPROMSettings::requestSlice(uint16_t size) { - if (sealed) +uint16_t EEPROMSettings::requestSlice(uint16_t size) { + if (sealed_) return 0; - uint16_t start = nextStart; - nextStart += size; + uint16_t start = next_start_; + next_start_ += size; CRC.update((const void *)&size, sizeof(size)); return start; } -void -EEPROMSettings::invalidate(void) { - _isValid = false; +void EEPROMSettings::invalidate(void) { + is_valid_ = false; } -uint16_t -EEPROMSettings::used(void) { - return nextStart; +uint16_t EEPROMSettings::used(void) { + return next_start_; } -void -EEPROMSettings::update(void) { - settings.crc = CRC.crc; +void EEPROMSettings::update(void) { + settings_.crc = CRC.crc; - EEPROM.put(0, settings); - _isValid = true; + EEPROM.put(0, settings_); + is_valid_ = true; } -uint8_t -EEPROMSettings::version(void) { - return settings.version; +uint8_t EEPROMSettings::version(void) { + return settings_.version; } -void -EEPROMSettings::version(uint8_t ver) { - settings.version = ver; +void EEPROMSettings::version(uint8_t ver) { + settings_.version = ver; update(); } -}; -KaleidoscopePlugins::EEPROMSettings EEPROMSettings; +} + +kaleidoscope::EEPROMSettings EEPROMSettings; diff --git a/src/Kaleidoscope/EEPROM-Settings.h b/src/Kaleidoscope/EEPROM-Settings.h index 5f17938b..b58f6536 100644 --- a/src/Kaleidoscope/EEPROM-Settings.h +++ b/src/Kaleidoscope/EEPROM-Settings.h @@ -21,7 +21,7 @@ #include #include -namespace KaleidoscopePlugins { +namespace kaleidoscope { class EEPROMSettings : public KaleidoscopePlugin { public: EEPROMSettings(void); @@ -40,16 +40,16 @@ class EEPROMSettings : public KaleidoscopePlugin { static uint16_t used(void); private: - static uint16_t nextStart; - static bool _isValid; - static bool sealed; + static uint16_t next_start_; + static bool is_valid_; + static bool sealed_; static struct settings { char magic[2]; uint8_t version; uint16_t crc; - } settings; + } settings_; }; }; -extern KaleidoscopePlugins::EEPROMSettings EEPROMSettings; +extern kaleidoscope::EEPROMSettings EEPROMSettings; From da90c342fb9dfd918c0fe7ffe4afb928601a4b14 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 4 Jun 2017 12:20:19 +0200 Subject: [PATCH 29/56] Some more linter-triggered fixes Signed-off-by: Gergely Nagy --- examples/EEPROM-Settings/EEPROM-Settings.ino | 32 +++++++++----------- src/Kaleidoscope/crc.h | 2 +- 2 files changed, 16 insertions(+), 18 deletions(-) diff --git a/examples/EEPROM-Settings/EEPROM-Settings.ino b/examples/EEPROM-Settings/EEPROM-Settings.ino index 09c6e59e..3e0fb16f 100644 --- a/examples/EEPROM-Settings/EEPROM-Settings.ino +++ b/examples/EEPROM-Settings/EEPROM-Settings.ino @@ -21,23 +21,21 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED - ( - Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, - Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, - Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, - Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, - - Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, - Key_skip, - - Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, - Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, - Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, - Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, - - Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, - Key_skip - ), + (Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, + Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, + Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, + Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, + + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, + Key_skip, + + Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, + Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, + + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, + Key_skip), }; void setup() { diff --git a/src/Kaleidoscope/crc.h b/src/Kaleidoscope/crc.h index cba1d21d..83e72187 100644 --- a/src/Kaleidoscope/crc.h +++ b/src/Kaleidoscope/crc.h @@ -40,7 +40,7 @@ class CRC_ { void update(const void *data, uint8_t len); void finalize(void) { reflect(16); - }; + } void reflect(uint8_t len); }; From 564b656162e795611a4f34f4c0e1805e4557bf0f Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 4 Jun 2017 12:24:15 +0200 Subject: [PATCH 30/56] README.md: Minor style adjustment Signed-off-by: Gergely Nagy --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index aa0e3fba..617b3ddb 100644 --- a/README.md +++ b/README.md @@ -37,12 +37,12 @@ static struct { } testSettings; void setup () { - Kaleidoscope.setup(); - USE_PLUGINS(&EEPROMSettings); /* Use other plugins that make use of the EEPROM */ + Kaleidoscope.setup(); + settingsBase = EEPROMSettings.requestSlice(sizeof(testSettings)); EEPROMSettings.seal(); From c5980dc5a689d93ef9873483f0d5aace79608471 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 4 Jun 2017 12:51:53 +0200 Subject: [PATCH 31/56] Local variables shall follow the style guide too Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Settings-Focus.cpp | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp index 3bdee5b3..e8d06db9 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp @@ -21,26 +21,27 @@ #include "crc.h" namespace FocusHooks { + bool settings(const char *command) { enum { ISVALID, GETVERSION, CRC, - } subCommand; + } sub_command; if (strncmp_P(command, PSTR("settings."), 9) != 0) return false; if (strcmp_P(command + 9, PSTR("valid?")) == 0) - subCommand = ISVALID; + sub_command = ISVALID; else if (strcmp_P(command + 9, PSTR("version")) == 0) - subCommand = GETVERSION; + sub_command = GETVERSION; else if (strcmp_P(command + 9, PSTR("crc")) == 0) - subCommand = CRC; + sub_command = CRC; else return false; - switch (subCommand) { + switch (sub_command) { case ISVALID: Focus.printBool(EEPROMSettings.isValid()); Serial.println(); @@ -62,16 +63,16 @@ bool eeprom(const char *command) { enum { CONTENTS, FREE, - } subCommand; + } sub_command; if (strcmp_P(command, PSTR("eeprom.contents")) == 0) - subCommand = CONTENTS; + sub_command = CONTENTS; else if (strcmp_P(command, PSTR("eeprom.free")) == 0) - subCommand = FREE; + sub_command = FREE; else return false; - switch (subCommand) { + switch (sub_command) { case CONTENTS: { if (Serial.peek() == '\n') { for (uint16_t i = 0; i < EEPROM.length(); i++) { @@ -96,4 +97,5 @@ bool eeprom(const char *command) { return true; } -}; + +} From ae8cd514a2e45aeca6ef3822e1fe2494d1c2b1bf Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 4 Jun 2017 12:56:05 +0200 Subject: [PATCH 32/56] Focus hooks shall follow the style guide more closely Moved them to the a namespace much more fitting, and renamed the hooks too. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Settings-Focus.cpp | 17 +++++++------ src/Kaleidoscope/EEPROM-Settings-Focus.h | 28 +++++++++++++--------- 2 files changed, 27 insertions(+), 18 deletions(-) diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp index e8d06db9..66f536b7 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp @@ -20,9 +20,10 @@ #include #include "crc.h" -namespace FocusHooks { +namespace kaleidoscope { +namespace eeprom_settings { -bool settings(const char *command) { +bool settingsFocusHook(const char *command) { enum { ISVALID, GETVERSION, @@ -43,23 +44,23 @@ bool settings(const char *command) { switch (sub_command) { case ISVALID: - Focus.printBool(EEPROMSettings.isValid()); + Focus.printBool(::EEPROMSettings.isValid()); Serial.println(); break; case GETVERSION: - Serial.println(EEPROMSettings.version()); + Serial.println(::EEPROMSettings.version()); break; case CRC: Serial.print(::CRC.crc, HEX); Serial.print(F("/")); - Serial.println(EEPROMSettings.crc(), HEX); + Serial.println(::EEPROMSettings.crc(), HEX); break; } return true; } -bool eeprom(const char *command) { +bool eepromFocusHook(const char *command) { enum { CONTENTS, FREE, @@ -91,7 +92,7 @@ bool eeprom(const char *command) { break; } case FREE: - Serial.println(EEPROM.length() - EEPROMSettings.used()); + Serial.println(EEPROM.length() - ::EEPROMSettings.used()); break; } @@ -99,3 +100,5 @@ bool eeprom(const char *command) { } } + +} diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.h b/src/Kaleidoscope/EEPROM-Settings-Focus.h index 42beef42..fdd250df 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.h +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.h @@ -20,16 +20,22 @@ #include -namespace FocusHooks { -bool settings(const char *command); -bool eeprom(const char *command); -}; +namespace kaleidoscope { +namespace eeprom_settings { -#define FOCUS_HOOK_SETTINGS FOCUS_HOOK(FocusHooks::settings, \ - "settings.valid?\n" \ - "settings.version\n" \ - "settings.crc") +bool settingsFocusHook(const char *command); +bool eepromFocusHook(const char *command); -#define FOCUS_HOOK_EEPROM FOCUS_HOOK(FocusHooks::eeprom, \ - "eeprom.free\n" \ - "eeprom.contents") +} +} + +#define FOCUS_HOOK_SETTINGS FOCUS_HOOK \ + (kaleidoscope::eeprom_settings::settingsFocusHook, \ + "settings.valid?\n" \ + "settings.version\n" \ + "settings.crc") + +#define FOCUS_HOOK_EEPROM FOCUS_HOOK \ + (kalediscope::eeprom_settings::eepromFocusHook, \ + "eeprom.free\n" \ + "eeprom.contents") From 33a19c3b51023a0c4c23a5601b2fc4885212a2a9 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 4 Jun 2017 14:43:06 +0200 Subject: [PATCH 33/56] Fix the Focus hooks We need to reference the global `Focus` object, not a local one, to avoid confusion. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Settings-Focus.cpp | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp index 66f536b7..9a14c0a1 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp @@ -44,7 +44,7 @@ bool settingsFocusHook(const char *command) { switch (sub_command) { case ISVALID: - Focus.printBool(::EEPROMSettings.isValid()); + ::Focus.printBool(::EEPROMSettings.isValid()); Serial.println(); break; case GETVERSION: @@ -78,8 +78,8 @@ bool eepromFocusHook(const char *command) { if (Serial.peek() == '\n') { for (uint16_t i = 0; i < EEPROM.length(); i++) { uint8_t d = EEPROM[i]; - Focus.printNumber(d); - Focus.printSpace(); + ::Focus.printNumber(d); + ::Focus.printSpace(); } Serial.println(); } else { From 583e916590dd60fa208389e27d046d7c91f4672f Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 4 Jun 2017 18:58:20 +0200 Subject: [PATCH 34/56] Fix a typo Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Settings-Focus.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.h b/src/Kaleidoscope/EEPROM-Settings-Focus.h index fdd250df..aac30d59 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.h +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.h @@ -36,6 +36,6 @@ bool eepromFocusHook(const char *command); "settings.crc") #define FOCUS_HOOK_EEPROM FOCUS_HOOK \ - (kalediscope::eeprom_settings::eepromFocusHook, \ + (kaleidoscope::eeprom_settings::eepromFocusHook, \ "eeprom.free\n" \ "eeprom.contents") From 30ebf9599f9685d35a2c9eedd171240f3ef44432 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 25 Jul 2017 15:52:05 -0700 Subject: [PATCH 35/56] 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 1b6dc98703e04ee3b8cbbd596d4c5da709b9a689 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 17 Aug 2017 11:48:20 +0200 Subject: [PATCH 36/56] Use `Kaleidoscope.use` instead of `USE_PLUGINS` The latter is being obsoleted, so use the former, newer API. Signed-off-by: Gergely Nagy --- README.md | 16 ++++++++-------- examples/EEPROM-Settings/EEPROM-Settings.ino | 2 +- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 617b3ddb..cff535be 100644 --- a/README.md +++ b/README.md @@ -37,23 +37,23 @@ static struct { } testSettings; void setup () { - USE_PLUGINS(&EEPROMSettings); + Kaleidoscope.use(&EEPROMSettings); /* Use other plugins that make use of the EEPROM */ - + Kaleidoscope.setup(); - + settingsBase = EEPROMSettings.requestSlice(sizeof(testSettings)); - + EEPROMSettings.seal(); - + if (!EEPROMSettings.isValid()) { // Handle the case where the settings are out of sync... // Flash LEDs, for example. - + return; } - + EEPROM.get(settingsBase, testSettings); } ``` @@ -122,7 +122,7 @@ The plugin provides two [Focus][focus] hooks: `FOCUS_HOOK_SETTINGS`, and settings, and with the contents of the `EEPROM` through Focus. [focus]: https://github.com/keyboardio/Kaleidoscope-Focus - + These provide the following `Focus` commands: ### `settings.crc` diff --git a/examples/EEPROM-Settings/EEPROM-Settings.ino b/examples/EEPROM-Settings/EEPROM-Settings.ino index 3e0fb16f..9c8db0b0 100644 --- a/examples/EEPROM-Settings/EEPROM-Settings.ino +++ b/examples/EEPROM-Settings/EEPROM-Settings.ino @@ -43,7 +43,7 @@ void setup() { Kaleidoscope.setup(); - USE_PLUGINS(&EEPROMSettings); + Kaleidoscope.use(&EEPROMSettings); while (!Serial) { } From 50c92bddf7a751604063fe55b0d6a6e57c7f7dde Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 21 Aug 2017 22:23:02 -0700 Subject: [PATCH 37/56] 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 94b7d139901b2602c9a1911bdb09885cd4bcbb9c Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 12 May 2018 17:47:13 +0200 Subject: [PATCH 38/56] Updated to use the new plugin APIs Signed-off-by: Gergely Nagy --- README.md | 6 ++---- examples/EEPROM-Settings/EEPROM-Settings.ino | 10 ++++++---- src/Kaleidoscope/EEPROM-Settings.cpp | 18 +++++++++++++----- src/Kaleidoscope/EEPROM-Settings.h | 13 +++++++++---- 4 files changed, 30 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index cff535be..d2365de2 100644 --- a/README.md +++ b/README.md @@ -36,11 +36,9 @@ static struct { bool someSettingFlag; } testSettings; -void setup () { - Kaleidoscope.use(&EEPROMSettings); - - /* Use other plugins that make use of the EEPROM */ +KALEIDOSCOPE_INIT_PLUGINS(EEPROMSettings, /* Other plugins that use EEPROM... */); +void setup () { Kaleidoscope.setup(); settingsBase = EEPROMSettings.requestSlice(sizeof(testSettings)); diff --git a/examples/EEPROM-Settings/EEPROM-Settings.ino b/examples/EEPROM-Settings/EEPROM-Settings.ino index 9c8db0b0..d01f8132 100644 --- a/examples/EEPROM-Settings/EEPROM-Settings.ino +++ b/examples/EEPROM-Settings/EEPROM-Settings.ino @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. - * 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 @@ -19,6 +19,7 @@ #include #include +// *INDENT-OFF* const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED (Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, @@ -31,20 +32,21 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, - Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, Key_skip), }; +// *INDENT-ON* + +KALEIDOSCOPE_INIT_PLUGINS(EEPROMSettings); void setup() { Serial.begin(9600); Kaleidoscope.setup(); - Kaleidoscope.use(&EEPROMSettings); - while (!Serial) { } diff --git a/src/Kaleidoscope/EEPROM-Settings.cpp b/src/Kaleidoscope/EEPROM-Settings.cpp index 9037c701..83f4e11f 100644 --- a/src/Kaleidoscope/EEPROM-Settings.cpp +++ b/src/Kaleidoscope/EEPROM-Settings.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. - * 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 @@ -26,11 +26,9 @@ bool EEPROMSettings::is_valid_; bool EEPROMSettings::sealed_; uint16_t EEPROMSettings::next_start_ = sizeof(EEPROMSettings::settings); -EEPROMSettings::EEPROMSettings(void) { -} - -void EEPROMSettings::begin(void) { +EventHandlerResult EEPROMSettings::onSetup() { EEPROM.get(0, settings_); + return EventHandlerResult::OK; } bool EEPROMSettings::isValid(void) { @@ -65,6 +63,9 @@ uint16_t EEPROMSettings::requestSlice(uint16_t size) { if (sealed_) return 0; + Serial.print("requestSlice; size="); + Serial.println(size); + uint16_t start = next_start_; next_start_ += size; @@ -97,6 +98,13 @@ void EEPROMSettings::version(uint8_t ver) { update(); } +// Legacy V1 API +#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API +void EEPROMSettings::begin() { + ::EEPROMSettings.onSetup(); +} +#endif + } kaleidoscope::EEPROMSettings EEPROMSettings; diff --git a/src/Kaleidoscope/EEPROM-Settings.h b/src/Kaleidoscope/EEPROM-Settings.h index b58f6536..1b8e483c 100644 --- a/src/Kaleidoscope/EEPROM-Settings.h +++ b/src/Kaleidoscope/EEPROM-Settings.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. - * Copyright (C) 2017 Gergely Nagy + * Copyright (C) 2017, 2018 Gergely Nagy * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -22,11 +22,11 @@ #include namespace kaleidoscope { -class EEPROMSettings : public KaleidoscopePlugin { +class EEPROMSettings : public kaleidoscope::Plugin { public: - EEPROMSettings(void); + EEPROMSettings(void) {} - void begin(void) final; + EventHandlerResult onSetup(); static void update(void); static bool isValid(void); @@ -39,6 +39,11 @@ class EEPROMSettings : public KaleidoscopePlugin { static uint16_t crc(void); static uint16_t used(void); +#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API + protected: + void begin(); +#endif + private: static uint16_t next_start_; static bool is_valid_; From c11c09ba5f650d7d1275689cd275c8bdaeb4c9e5 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 20 Aug 2018 22:58:00 +0200 Subject: [PATCH 39/56] Drop the V1 plugin API compatibility code Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Settings.cpp | 7 ------- src/Kaleidoscope/EEPROM-Settings.h | 5 ----- 2 files changed, 12 deletions(-) diff --git a/src/Kaleidoscope/EEPROM-Settings.cpp b/src/Kaleidoscope/EEPROM-Settings.cpp index 83f4e11f..9fa48ef4 100644 --- a/src/Kaleidoscope/EEPROM-Settings.cpp +++ b/src/Kaleidoscope/EEPROM-Settings.cpp @@ -98,13 +98,6 @@ void EEPROMSettings::version(uint8_t ver) { update(); } -// Legacy V1 API -#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API -void EEPROMSettings::begin() { - ::EEPROMSettings.onSetup(); -} -#endif - } kaleidoscope::EEPROMSettings EEPROMSettings; diff --git a/src/Kaleidoscope/EEPROM-Settings.h b/src/Kaleidoscope/EEPROM-Settings.h index 1b8e483c..373cbdfd 100644 --- a/src/Kaleidoscope/EEPROM-Settings.h +++ b/src/Kaleidoscope/EEPROM-Settings.h @@ -39,11 +39,6 @@ class EEPROMSettings : public kaleidoscope::Plugin { static uint16_t crc(void); static uint16_t used(void); -#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API - protected: - void begin(); -#endif - private: static uint16_t next_start_; static bool is_valid_; From fc130b88702b7ea92bb55da87e0804a4c378c4bb Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:14:25 +0200 Subject: [PATCH 40/56] Relicense under the GPLv3 (only) Signed-off-by: Gergely Nagy --- examples/EEPROM-Settings/EEPROM-Settings.ino | 19 +++++++++---------- src/Kaleidoscope-EEPROM-Settings.h | 19 +++++++++---------- src/Kaleidoscope/EEPROM-Settings-Focus.cpp | 19 +++++++++---------- src/Kaleidoscope/EEPROM-Settings-Focus.h | 19 +++++++++---------- src/Kaleidoscope/EEPROM-Settings.cpp | 19 +++++++++---------- src/Kaleidoscope/EEPROM-Settings.h | 19 +++++++++---------- src/Kaleidoscope/crc.cpp | 19 +++++++++---------- src/Kaleidoscope/crc.h | 19 +++++++++---------- 8 files changed, 72 insertions(+), 80 deletions(-) diff --git a/examples/EEPROM-Settings/EEPROM-Settings.ino b/examples/EEPROM-Settings/EEPROM-Settings.ino index d01f8132..f44906e0 100644 --- a/examples/EEPROM-Settings/EEPROM-Settings.ino +++ b/examples/EEPROM-Settings/EEPROM-Settings.ino @@ -2,18 +2,17 @@ * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. * 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-EEPROM-Settings.h b/src/Kaleidoscope-EEPROM-Settings.h index ca5fb963..1c731bc5 100644 --- a/src/Kaleidoscope-EEPROM-Settings.h +++ b/src/Kaleidoscope-EEPROM-Settings.h @@ -2,18 +2,17 @@ * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. * 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 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/EEPROM-Settings-Focus.cpp b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp index 9a14c0a1..f661ed6f 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp @@ -2,18 +2,17 @@ * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. * 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 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/EEPROM-Settings-Focus.h b/src/Kaleidoscope/EEPROM-Settings-Focus.h index aac30d59..66597153 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.h +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.h @@ -2,18 +2,17 @@ * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. * 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 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/EEPROM-Settings.cpp b/src/Kaleidoscope/EEPROM-Settings.cpp index 9fa48ef4..9072073c 100644 --- a/src/Kaleidoscope/EEPROM-Settings.cpp +++ b/src/Kaleidoscope/EEPROM-Settings.cpp @@ -2,18 +2,17 @@ * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. * 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/EEPROM-Settings.h b/src/Kaleidoscope/EEPROM-Settings.h index 373cbdfd..704dfdf9 100644 --- a/src/Kaleidoscope/EEPROM-Settings.h +++ b/src/Kaleidoscope/EEPROM-Settings.h @@ -2,18 +2,17 @@ * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. * 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 diff --git a/src/Kaleidoscope/crc.cpp b/src/Kaleidoscope/crc.cpp index 4ae8d23f..4596c66c 100644 --- a/src/Kaleidoscope/crc.cpp +++ b/src/Kaleidoscope/crc.cpp @@ -2,18 +2,17 @@ * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. * 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 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 . * * Originally generated by pycrc v0.9, https://pycrc.org * diff --git a/src/Kaleidoscope/crc.h b/src/Kaleidoscope/crc.h index 83e72187..8e37c28b 100644 --- a/src/Kaleidoscope/crc.h +++ b/src/Kaleidoscope/crc.h @@ -2,18 +2,17 @@ * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. * 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 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 . * * Originally generated by pycrc v0.9, https://pycrc.org * From cbae65ceb43f1e89bd5e48ba5ddda351ee2f4301 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:14:27 +0200 Subject: [PATCH 41/56] 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/EEPROM-Settings/EEPROM-Settings.ino | 2 +- library.properties | 2 +- src/Kaleidoscope-EEPROM-Settings.h | 2 +- src/Kaleidoscope/EEPROM-Settings-Focus.cpp | 2 +- src/Kaleidoscope/EEPROM-Settings-Focus.h | 2 +- src/Kaleidoscope/EEPROM-Settings.cpp | 2 +- src/Kaleidoscope/EEPROM-Settings.h | 2 +- src/Kaleidoscope/crc.cpp | 2 +- src/Kaleidoscope/crc.h | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/examples/EEPROM-Settings/EEPROM-Settings.ino b/examples/EEPROM-Settings/EEPROM-Settings.ino index f44906e0..0d2b1850 100644 --- a/examples/EEPROM-Settings/EEPROM-Settings.ino +++ b/examples/EEPROM-Settings/EEPROM-Settings.ino @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. - * 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 c78bfdfa..ee68df70 100644 --- a/library.properties +++ b/library.properties @@ -1,7 +1,7 @@ name=Kaleidoscope-EEPROM-Settings version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy +maintainer=Gergely Nagy sentence=Base EEPROM settings plugin for Kaleidoscope. paragraph=... category=Communication diff --git a/src/Kaleidoscope-EEPROM-Settings.h b/src/Kaleidoscope-EEPROM-Settings.h index 1c731bc5..123b49cc 100644 --- a/src/Kaleidoscope-EEPROM-Settings.h +++ b/src/Kaleidoscope-EEPROM-Settings.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. - * Copyright (C) 2017 Gergely Nagy + * Copyright (C) 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/EEPROM-Settings-Focus.cpp b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp index f661ed6f..084ea8ee 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. - * Copyright (C) 2017 Gergely Nagy + * Copyright (C) 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/EEPROM-Settings-Focus.h b/src/Kaleidoscope/EEPROM-Settings-Focus.h index 66597153..cebf254f 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.h +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. - * Copyright (C) 2017 Gergely Nagy + * Copyright (C) 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/EEPROM-Settings.cpp b/src/Kaleidoscope/EEPROM-Settings.cpp index 9072073c..0e187a09 100644 --- a/src/Kaleidoscope/EEPROM-Settings.cpp +++ b/src/Kaleidoscope/EEPROM-Settings.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. - * 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/EEPROM-Settings.h b/src/Kaleidoscope/EEPROM-Settings.h index 704dfdf9..3fccd2ba 100644 --- a/src/Kaleidoscope/EEPROM-Settings.h +++ b/src/Kaleidoscope/EEPROM-Settings.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. - * 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/crc.cpp b/src/Kaleidoscope/crc.cpp index 4596c66c..0c199695 100644 --- a/src/Kaleidoscope/crc.cpp +++ b/src/Kaleidoscope/crc.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. - * Copyright (C) 2017 Gergely Nagy + * Copyright (C) 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/crc.h b/src/Kaleidoscope/crc.h index 8e37c28b..0eb1aec4 100644 --- a/src/Kaleidoscope/crc.h +++ b/src/Kaleidoscope/crc.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. - * Copyright (C) 2017 Gergely Nagy + * Copyright (C) 2017 Keyboard.io, Inc * * This program is free software: you can redistribute it and/or modify it under * the terms of the GNU General Public License as published by the Free Software From a0bab51db85e640d97c7488e6329da7f48ca136c Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:14:29 +0200 Subject: [PATCH 42/56] 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 8605ff7d1d7ca0810d41f8cf19e618a8b9a4ac0a Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 4 Sep 2018 18:24:00 -0700 Subject: [PATCH 43/56] 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 a643e323e6d00a045b16f76f37305a60ae3401d3 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 4 Sep 2018 18:42:29 -0700 Subject: [PATCH 44/56] 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 ba332c1846e301d04fdba2e99da397ad08122e7f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Csilla=20Nagyn=C3=A9=20Martin=C3=A1k?= Date: Wed, 3 Oct 2018 06:29:25 +0200 Subject: [PATCH 45/56] Remove a debugging Serial.print() MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit These two lines went in by mistake earlier, they were meant for local debugging only. As such, having them in the plugin is a bug, easily squashed by removing them. Signed-off-by: Csilla Nagyné Martinák --- src/Kaleidoscope/EEPROM-Settings.cpp | 3 --- 1 file changed, 3 deletions(-) diff --git a/src/Kaleidoscope/EEPROM-Settings.cpp b/src/Kaleidoscope/EEPROM-Settings.cpp index 0e187a09..657fa89c 100644 --- a/src/Kaleidoscope/EEPROM-Settings.cpp +++ b/src/Kaleidoscope/EEPROM-Settings.cpp @@ -62,9 +62,6 @@ uint16_t EEPROMSettings::requestSlice(uint16_t size) { if (sealed_) return 0; - Serial.print("requestSlice; size="); - Serial.println(size); - uint16_t start = next_start_; next_start_ += size; From 47efb47506673554cd064daa9e32630f92aa8fae Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 3 Oct 2018 06:42:08 +0200 Subject: [PATCH 46/56] Seal the EEPROM layout automatically If `EEPROMSettings.seal()` wasn't explicitly called, seal the layout in `beforeEachCycle()`. On the flip side, this makes user sketches simpler, because they don't have to seal explicitly. This is done at the cost of an if check each cycle. In the long run, EEPROM layout management will be moving out of this plugin, so this check will be eventually dropped too. Signed-off-by: Gergely Nagy --- README.md | 3 +++ src/Kaleidoscope/EEPROM-Settings.cpp | 7 +++++++ src/Kaleidoscope/EEPROM-Settings.h | 1 + 3 files changed, 11 insertions(+) diff --git a/README.md b/README.md index d2365de2..d6e86c33 100644 --- a/README.md +++ b/README.md @@ -72,6 +72,9 @@ The plugin provides the `EEPROMSettings` object, which has the following methods > Seal the `EEPROM` layout, so no new slices can be requested. The CRC checksum > is considered final at this time, and the `isValid()`, `crc()`, `used()` and > `version()` methods can be used from this point onwards. +> +> If not called explicitly, the layout will be sealed automatically after +> `setup()` in the sketch finished. ### `update()` diff --git a/src/Kaleidoscope/EEPROM-Settings.cpp b/src/Kaleidoscope/EEPROM-Settings.cpp index 657fa89c..4e4fb247 100644 --- a/src/Kaleidoscope/EEPROM-Settings.cpp +++ b/src/Kaleidoscope/EEPROM-Settings.cpp @@ -30,6 +30,13 @@ EventHandlerResult EEPROMSettings::onSetup() { return EventHandlerResult::OK; } +EventHandlerResult EEPROMSettings::beforeEachCycle() { + if (!sealed_) + seal(); + + return EventHandlerResult::OK; +} + bool EEPROMSettings::isValid(void) { return is_valid_; } diff --git a/src/Kaleidoscope/EEPROM-Settings.h b/src/Kaleidoscope/EEPROM-Settings.h index 3fccd2ba..33cb0214 100644 --- a/src/Kaleidoscope/EEPROM-Settings.h +++ b/src/Kaleidoscope/EEPROM-Settings.h @@ -26,6 +26,7 @@ class EEPROMSettings : public kaleidoscope::Plugin { EEPROMSettings(void) {} EventHandlerResult onSetup(); + EventHandlerResult beforeEachCycle(); static void update(void); static bool isValid(void); From 504727d6772ac0901633cb78bd48787dba69aa47 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 5 Oct 2018 13:59:51 +0200 Subject: [PATCH 47/56] Migrate to the new onFocusEvent API Signed-off-by: Gergely Nagy --- README.md | 13 ++++----- src/Kaleidoscope/EEPROM-Settings-Focus.cpp | 32 ++++++++++++++-------- src/Kaleidoscope/EEPROM-Settings-Focus.h | 30 ++++++++++---------- 3 files changed, 43 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index d6e86c33..150c8d1b 100644 --- a/README.md +++ b/README.md @@ -118,13 +118,12 @@ The plugin provides the `EEPROMSettings` object, which has the following methods ## Focus commands -The plugin provides two [Focus][focus] hooks: `FOCUS_HOOK_SETTINGS`, and -`FOCUS_HOOK_EEPROM`, that register commands that allow one to work with the -settings, and with the contents of the `EEPROM` through Focus. +The plugin provides two - optional - [Focus][FocusSerial] command plugins: +`FocusSettingsCommand` and `FocusEEPROMCommand`. These must be explicitly added +to `KALEIDOSCOPE_INIT_PLUGINS` if one wishes to use them. They provide the +following commands: - [focus]: https://github.com/keyboardio/Kaleidoscope-Focus - -These provide the following `Focus` commands: + [FocusSerial]: https://github.com/keyboardio/Kaleidoscope-FocusSerial ### `settings.crc` @@ -153,7 +152,7 @@ These provide the following `Focus` commands: ## Dependencies -* [Kaleidoscope-Focus][focus] +* [Kaleidoscope-FocusSerial][FocusSerial] ## Further reading diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp index 084ea8ee..2ed4c15a 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. - * Copyright (C) 2017 Keyboard.io, Inc + * 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 @@ -16,21 +16,26 @@ */ #include -#include +#include #include "crc.h" namespace kaleidoscope { -namespace eeprom_settings { +namespace eeprom { -bool settingsFocusHook(const char *command) { +EventHandlerResult FocusSettingsCommand::onFocusEvent(const char *command) { enum { ISVALID, GETVERSION, CRC, } sub_command; + if (strcmp_P(command, PSTR("help")) == 0) { + Serial.println(F("settings.valid?\nsettings.version\nsettings.crc")); + return EventHandlerResult::OK; + } + if (strncmp_P(command, PSTR("settings."), 9) != 0) - return false; + return EventHandlerResult::OK; if (strcmp_P(command + 9, PSTR("valid?")) == 0) sub_command = ISVALID; @@ -39,7 +44,7 @@ bool settingsFocusHook(const char *command) { else if (strcmp_P(command + 9, PSTR("crc")) == 0) sub_command = CRC; else - return false; + return EventHandlerResult::OK; switch (sub_command) { case ISVALID: @@ -56,21 +61,24 @@ bool settingsFocusHook(const char *command) { break; } - return true; + return EventHandlerResult::EVENT_CONSUMED; } -bool eepromFocusHook(const char *command) { +EventHandlerResult FocusEEPROMCommand::onFocusEvent(const char *command) { enum { CONTENTS, FREE, } sub_command; + if (::Focus.handleHelp(command, PSTR("eeprom.contents\neeprom.free"))) + return EventHandlerResult::OK; + if (strcmp_P(command, PSTR("eeprom.contents")) == 0) sub_command = CONTENTS; else if (strcmp_P(command, PSTR("eeprom.free")) == 0) sub_command = FREE; else - return false; + return EventHandlerResult::OK; switch (sub_command) { case CONTENTS: { @@ -95,9 +103,11 @@ bool eepromFocusHook(const char *command) { break; } - return true; + return EventHandlerResult::EVENT_CONSUMED; } } - } + +kaleidoscope::eeprom::FocusSettingsCommand FocusSettingsCommand; +kaleidoscope::eeprom::FocusEEPROMCommand FocusEEPROMCommand; diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.h b/src/Kaleidoscope/EEPROM-Settings-Focus.h index cebf254f..3da46524 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.h +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. - * Copyright (C) 2017 Keyboard.io, Inc + * 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 @@ -20,21 +20,23 @@ #include namespace kaleidoscope { -namespace eeprom_settings { +namespace eeprom { +class FocusSettingsCommand : public kaleidoscope::Plugin { + public: + FocusSettingsCommand() {} -bool settingsFocusHook(const char *command); -bool eepromFocusHook(const char *command); + EventHandlerResult onFocusEvent(const char *command); +}; + +class FocusEEPROMCommand : public kaleidoscope::Plugin { + public: + FocusEEPROMCommand () {} + + EventHandlerResult onFocusEvent(const char *command); +}; } } -#define FOCUS_HOOK_SETTINGS FOCUS_HOOK \ - (kaleidoscope::eeprom_settings::settingsFocusHook, \ - "settings.valid?\n" \ - "settings.version\n" \ - "settings.crc") - -#define FOCUS_HOOK_EEPROM FOCUS_HOOK \ - (kaleidoscope::eeprom_settings::eepromFocusHook, \ - "eeprom.free\n" \ - "eeprom.contents") +extern kaleidoscope::eeprom::FocusSettingsCommand FocusSettingsCommand; +extern kaleidoscope::eeprom::FocusEEPROMCommand FocusEEPROMCommand; From 68cdc384de65f51d1ba4ddcb0214965c43daa8b6 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Fri, 5 Oct 2018 10:33:46 -0700 Subject: [PATCH 48/56] astyle --- src/Kaleidoscope/EEPROM-Settings-Focus.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.h b/src/Kaleidoscope/EEPROM-Settings-Focus.h index 3da46524..bd0b659e 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.h +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.h @@ -30,7 +30,7 @@ class FocusSettingsCommand : public kaleidoscope::Plugin { class FocusEEPROMCommand : public kaleidoscope::Plugin { public: - FocusEEPROMCommand () {} + FocusEEPROMCommand() {} EventHandlerResult onFocusEvent(const char *command); }; From 5edc8a07b2dcea236a5e52e6da13b494da43ad51 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 7 Oct 2018 09:28:31 +0200 Subject: [PATCH 49/56] FocusSettingsCommand: Use Focus.handleHelp This saves a few bytes of PROGMEM for us. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Settings-Focus.cpp | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp index 2ed4c15a..c34890f5 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp @@ -29,10 +29,8 @@ EventHandlerResult FocusSettingsCommand::onFocusEvent(const char *command) { CRC, } sub_command; - if (strcmp_P(command, PSTR("help")) == 0) { - Serial.println(F("settings.valid?\nsettings.version\nsettings.crc")); + if (::Focus.handleHelp(command, PSTR("settings.valid?\nsettings.version\nsettings.crc"))) return EventHandlerResult::OK; - } if (strncmp_P(command, PSTR("settings."), 9) != 0) return EventHandlerResult::OK; From 354132255939b283b0a00eeecc97fc5fc6387499 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 8 Oct 2018 23:15:20 +0200 Subject: [PATCH 50/56] Clean up the EEPROM header This removes the `magic` field from the beginning of the header. It was originally meant to signal if the EEPROM we're dealing with is new, or if it has been set up with `EEPROMSettings` before. But as `EEPROMSettings` is pretty much the only way we deal with EEPROM, there's not much need for that. With the removal, we do need a way to update the CRC bits on first use, so we use the `version` field instead: if it is `0xff`, we update the CRC, and consider the settings valid. This means that until the version is set, the EEPROM layout is considered flexible, and verification is essentially disabled. Once the version is set, we can validate. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/EEPROM-Settings.cpp | 11 +++++------ src/Kaleidoscope/EEPROM-Settings.h | 1 - 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/src/Kaleidoscope/EEPROM-Settings.cpp b/src/Kaleidoscope/EEPROM-Settings.cpp index 4e4fb247..b611007e 100644 --- a/src/Kaleidoscope/EEPROM-Settings.cpp +++ b/src/Kaleidoscope/EEPROM-Settings.cpp @@ -52,12 +52,11 @@ void EEPROMSettings::seal(void) { CRC.finalize(); - if (settings_.magic[0] != 'K' || settings_.magic[1] != 'S') { - settings_.magic[0] = 'K'; - settings_.magic[1] = 'S'; - settings_.version = 0; - settings_.crc = CRC.crc; - + /* Until we set a version, consider the EEPROM contents flexible, and always + * update the CRC. This will always result in the settings being considered + * valid. + */ + if (settings_.version == 0xff) { return update(); } diff --git a/src/Kaleidoscope/EEPROM-Settings.h b/src/Kaleidoscope/EEPROM-Settings.h index 33cb0214..e582213f 100644 --- a/src/Kaleidoscope/EEPROM-Settings.h +++ b/src/Kaleidoscope/EEPROM-Settings.h @@ -45,7 +45,6 @@ class EEPROMSettings : public kaleidoscope::Plugin { static bool sealed_; static struct settings { - char magic[2]; uint8_t version; uint16_t crc; } settings_; From a8b677138e60746038e0b3e6392cef404a35818c Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 8 Oct 2018 23:39:05 +0200 Subject: [PATCH 51/56] Add support for saving the default layer With upcoming EEPROMKeymap changes, saving the default layer will become an important part of the keyboard settings. The new `default_layer` method provides a way to set it programmatically, while the `settings.defaultLayer` Focus command allows the user to set it via Focus. The default layer - if set - is activated when the settings are sealed, either directly or automatically. Signed-off-by: Gergely Nagy --- README.md | 15 ++++++++++++ src/Kaleidoscope/EEPROM-Settings-Focus.cpp | 27 +++++++++++++++------- src/Kaleidoscope/EEPROM-Settings.cpp | 17 ++++++++++++-- src/Kaleidoscope/EEPROM-Settings.h | 3 +++ 4 files changed, 52 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 150c8d1b..701a313e 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,15 @@ The plugin provides the `EEPROMSettings` object, which has the following methods > > Should only be called **before** calling `seal()`. +### `default_layer([id])` + +> Sets (or returns, if called without an ID) the default layer. When the +> keyboard boots up, it will automatically switch to the configured layer - if +> any. +> +> This is the Focus counterpart of the `default_layer()` method documented +> above. + ### `seal()` > Seal the `EEPROM` layout, so no new slices can be requested. The CRC checksum @@ -125,6 +134,12 @@ following commands: [FocusSerial]: https://github.com/keyboardio/Kaleidoscope-FocusSerial +### `settings.defaultLayer` + +> Sets or returns (if called without arguments) the ID of the default layer. If +> set, the keyboard will automatically switch to the given layer when connected. +> Setting it to `255` disables the automatic switching. + ### `settings.crc` > Returns the actual, and the expected checksum of the settings. diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp index c34890f5..56cc50a9 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp +++ b/src/Kaleidoscope/EEPROM-Settings-Focus.cpp @@ -24,32 +24,43 @@ namespace eeprom { EventHandlerResult FocusSettingsCommand::onFocusEvent(const char *command) { enum { - ISVALID, - GETVERSION, + DEFAULT_LAYER, + IS_VALID, + GET_VERSION, CRC, } sub_command; - if (::Focus.handleHelp(command, PSTR("settings.valid?\nsettings.version\nsettings.crc"))) + if (::Focus.handleHelp(command, PSTR("settings.defaultLayer\nsettings.valid?\nsettings.version\nsettings.crc"))) return EventHandlerResult::OK; if (strncmp_P(command, PSTR("settings."), 9) != 0) return EventHandlerResult::OK; - if (strcmp_P(command + 9, PSTR("valid?")) == 0) - sub_command = ISVALID; + if (strcmp_P(command + 9, PSTR("defaultLayer")) == 0) + sub_command = DEFAULT_LAYER; + else if (strcmp_P(command + 9, PSTR("valid?")) == 0) + sub_command = IS_VALID; else if (strcmp_P(command + 9, PSTR("version")) == 0) - sub_command = GETVERSION; + sub_command = GET_VERSION; else if (strcmp_P(command + 9, PSTR("crc")) == 0) sub_command = CRC; else return EventHandlerResult::OK; switch (sub_command) { - case ISVALID: + case DEFAULT_LAYER: { + if (Serial.peek() == '\n') { + Serial.println(::EEPROMSettings.default_layer()); + } else { + ::EEPROMSettings.default_layer(Serial.parseInt()); + } + break; + } + case IS_VALID: ::Focus.printBool(::EEPROMSettings.isValid()); Serial.println(); break; - case GETVERSION: + case GET_VERSION: Serial.println(::EEPROMSettings.version()); break; case CRC: diff --git a/src/Kaleidoscope/EEPROM-Settings.cpp b/src/Kaleidoscope/EEPROM-Settings.cpp index b611007e..3870187f 100644 --- a/src/Kaleidoscope/EEPROM-Settings.cpp +++ b/src/Kaleidoscope/EEPROM-Settings.cpp @@ -47,15 +47,28 @@ uint16_t EEPROMSettings::crc(void) { return 0; } +uint8_t EEPROMSettings::default_layer(uint8_t layer) { + if (layer == 0xff) + return settings_.default_layer; + + settings_.default_layer = layer; + update(); + return settings_.default_layer; +} + void EEPROMSettings::seal(void) { sealed_ = true; CRC.finalize(); + /* If we have a default layer set, switch to it. As 0xff is the default EEPROM + * value, treat it as not having a default layer set. */ + if (settings_.default_layer != 0xff) + Layer.move(settings_.default_layer); + /* Until we set a version, consider the EEPROM contents flexible, and always * update the CRC. This will always result in the settings being considered - * valid. - */ + * valid. */ if (settings_.version == 0xff) { return update(); } diff --git a/src/Kaleidoscope/EEPROM-Settings.h b/src/Kaleidoscope/EEPROM-Settings.h index e582213f..73d08636 100644 --- a/src/Kaleidoscope/EEPROM-Settings.h +++ b/src/Kaleidoscope/EEPROM-Settings.h @@ -39,12 +39,15 @@ class EEPROMSettings : public kaleidoscope::Plugin { static uint16_t crc(void); static uint16_t used(void); + static uint8_t default_layer(uint8_t layer = 0xff); + private: static uint16_t next_start_; static bool is_valid_; static bool sealed_; static struct settings { + uint8_t default_layer; uint8_t version; uint16_t crc; } settings_; From 5457003c13682c7454fb4bb3d48d35f0f6da83bd Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 10 Oct 2018 06:19:29 +0200 Subject: [PATCH 52/56] 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 701a313e..685a8d9d 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,10 @@ # Kaleidoscope-EEPROM-Settings -![status][st:experimental] [![Build Status][travis:image]][travis:status] +[![Build Status][travis:image]][travis:status] [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-EEPROM-Settings.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-EEPROM-Settings - [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 - To be able to reliably store persistent configuration in `EEPROM`, we need to be able to split up the available space for plugins to use. We also want to make sure that we notice when the `EEPROM` contents and the firmware are out of sync. From b80ecfec7178d792330757f4c59d1f155b3ad948 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 13 Oct 2018 12:25:47 +0200 Subject: [PATCH 53/56] Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/EEPROM-Settings.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 | 167 +---------------- doc/plugin/EEPROM-Settings.md | 168 ++++++++++++++++++ src/Kaleidoscope-EEPROM-Settings.h | 4 +- .../plugin}/EEPROM-Settings-Focus.cpp | 6 +- .../plugin}/EEPROM-Settings-Focus.h | 6 +- .../plugin}/EEPROM-Settings.cpp | 4 +- .../plugin}/EEPROM-Settings.h | 6 +- .../plugin}/crc.cpp | 0 .../plugin}/crc.h | 0 9 files changed, 186 insertions(+), 175 deletions(-) create mode 100644 doc/plugin/EEPROM-Settings.md rename src/{Kaleidoscope => kaleidoscope/plugin}/EEPROM-Settings-Focus.cpp (95%) rename src/{Kaleidoscope => kaleidoscope/plugin}/EEPROM-Settings-Focus.h (86%) rename src/{Kaleidoscope => kaleidoscope/plugin}/EEPROM-Settings.cpp (97%) rename src/{Kaleidoscope => kaleidoscope/plugin}/EEPROM-Settings.h (94%) rename src/{Kaleidoscope => kaleidoscope/plugin}/crc.cpp (100%) rename src/{Kaleidoscope => kaleidoscope/plugin}/crc.h (100%) diff --git a/README.md b/README.md index 685a8d9d..687b5684 100644 --- a/README.md +++ b/README.md @@ -5,169 +5,4 @@ [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-EEPROM-Settings.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-EEPROM-Settings -To be able to reliably store persistent configuration in `EEPROM`, we need to be -able to split up the available space for plugins to use. We also want to make -sure that we notice when the `EEPROM` contents and the firmware are out of sync. -This plugin provides the tools to do that. - -It does not guard against errors, it merely provides the means to discover them, -and let the firmware Sketch handle the case in whatever way it finds reasonable. -It's a building block, and not much else. All Kaleidoscope plugins that need to -store data in `EEPROM` are encouraged to make use of this library. - -## Using the plugin - -There are a few steps one needs to take to use the plugin: we must first -register it, then either let other plugins request slices of `EEPROM`, or do so -ourselves. And finally, seal it, to signal that we are done setting up. At that -point, we can verify whether the contents of the `EEPROM` agree with our -firmware. - -```c++ -#include -#include - -static uint16_t settingsBase; -static struct { - bool someSettingFlag; -} testSettings; - -KALEIDOSCOPE_INIT_PLUGINS(EEPROMSettings, /* Other plugins that use EEPROM... */); - -void setup () { - Kaleidoscope.setup(); - - settingsBase = EEPROMSettings.requestSlice(sizeof(testSettings)); - - EEPROMSettings.seal(); - - if (!EEPROMSettings.isValid()) { - // Handle the case where the settings are out of sync... - // Flash LEDs, for example. - - return; - } - - EEPROM.get(settingsBase, testSettings); -} -``` - -## Plugin methods - -The plugin provides the `EEPROMSettings` object, which has the following methods: - -### `requestSlice(size)` - -> Requests a slice of the `EEPROM`, and returns the starting address (or 0 on -> error, including when the request arrived after sealing the layout). -> -> Should only be called **before** calling `seal()`. - -### `default_layer([id])` - -> Sets (or returns, if called without an ID) the default layer. When the -> keyboard boots up, it will automatically switch to the configured layer - if -> any. -> -> This is the Focus counterpart of the `default_layer()` method documented -> above. - -### `seal()` - -> Seal the `EEPROM` layout, so no new slices can be requested. The CRC checksum -> is considered final at this time, and the `isValid()`, `crc()`, `used()` and -> `version()` methods can be used from this point onwards. -> -> If not called explicitly, the layout will be sealed automatically after -> `setup()` in the sketch finished. - -### `update()` - -> Updates the `EEPROM` header with the current status quo, including the version -> and the CRC checksum. -> -> This should be called when upgrading from one version to another, or when -> fixing up an out-of-sync case. - -### `isValid()` - -> Returns whether the `EEPROM` header is valid, that is, if it has the expected -> CRC checksum. -> -> Should only be called after calling `seal()`. - -### `invalidate()` - -> Invalidates the `EEPROM` header. Use when the version does not match what the -> firmware would expect. This signals to other plugins that the contents of -> `EEPROM` should not be trusted. - -### `version([newVersion])` - -> Sets or returns the version of the `EEPROM` layout. This is purely for use by -> the firmware, so it can attempt to upgrade the contents, if need be, or alert -> the user in there's a mismatch. Plugins do not use this property. -> -> Should only be called after calling `seal()`. - -### `crc()` - -> Returns the CRC checksum of the layout. Should only be used after calling -> `seal()`. - -### `used()` - -> Returns the amount of space requested so far. -> -> Should only be used after calling `seal()`. - -## Focus commands - -The plugin provides two - optional - [Focus][FocusSerial] command plugins: -`FocusSettingsCommand` and `FocusEEPROMCommand`. These must be explicitly added -to `KALEIDOSCOPE_INIT_PLUGINS` if one wishes to use them. They provide the -following commands: - - [FocusSerial]: https://github.com/keyboardio/Kaleidoscope-FocusSerial - -### `settings.defaultLayer` - -> Sets or returns (if called without arguments) the ID of the default layer. If -> set, the keyboard will automatically switch to the given layer when connected. -> Setting it to `255` disables the automatic switching. - -### `settings.crc` - -> Returns the actual, and the expected checksum of the settings. - -### `settings.valid?` - -> Returns either `true` or `false`, depending on whether the sealed settings are -> to be considered valid or not. - -### `settings.version` - -> Returns the (user-set) version of the settings. - -### `eeprom.contents` - -> Without argument, displays the full contents of the `EEPROM`, including the -> settings header. -> -> With arguments, the command updates as much of the `EEPROM` as arguments are -> provided. It will discard any unnecessary arguments. - -### `eeprom.free` - -> Returns the amount of free bytes in `EEPROM`. - -## Dependencies - -* [Kaleidoscope-FocusSerial][FocusSerial] - -## 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-EEPROM-Settings/blob/master/examples/EEPROM-Settings/EEPROM-Settings.ino +See [doc/plugin/EEPROM-Settings.md](doc/plugin/EEPROM-Settings.md) for documentation. diff --git a/doc/plugin/EEPROM-Settings.md b/doc/plugin/EEPROM-Settings.md new file mode 100644 index 00000000..ccfb4955 --- /dev/null +++ b/doc/plugin/EEPROM-Settings.md @@ -0,0 +1,168 @@ +# Kaleidoscope-EEPROM-Settings + +To be able to reliably store persistent configuration in `EEPROM`, we need to be +able to split up the available space for plugins to use. We also want to make +sure that we notice when the `EEPROM` contents and the firmware are out of sync. +This plugin provides the tools to do that. + +It does not guard against errors, it merely provides the means to discover them, +and let the firmware Sketch handle the case in whatever way it finds reasonable. +It's a building block, and not much else. All Kaleidoscope plugins that need to +store data in `EEPROM` are encouraged to make use of this library. + +## Using the plugin + +There are a few steps one needs to take to use the plugin: we must first +register it, then either let other plugins request slices of `EEPROM`, or do so +ourselves. And finally, seal it, to signal that we are done setting up. At that +point, we can verify whether the contents of the `EEPROM` agree with our +firmware. + +```c++ +#include +#include + +static uint16_t settingsBase; +static struct { + bool someSettingFlag; +} testSettings; + +KALEIDOSCOPE_INIT_PLUGINS(EEPROMSettings, /* Other plugins that use EEPROM... */); + +void setup () { + Kaleidoscope.setup(); + + settingsBase = EEPROMSettings.requestSlice(sizeof(testSettings)); + + EEPROMSettings.seal(); + + if (!EEPROMSettings.isValid()) { + // Handle the case where the settings are out of sync... + // Flash LEDs, for example. + + return; + } + + EEPROM.get(settingsBase, testSettings); +} +``` + +## Plugin methods + +The plugin provides the `EEPROMSettings` object, which has the following methods: + +### `requestSlice(size)` + +> Requests a slice of the `EEPROM`, and returns the starting address (or 0 on +> error, including when the request arrived after sealing the layout). +> +> Should only be called **before** calling `seal()`. + +### `default_layer([id])` + +> Sets (or returns, if called without an ID) the default layer. When the +> keyboard boots up, it will automatically switch to the configured layer - if +> any. +> +> This is the Focus counterpart of the `default_layer()` method documented +> above. + +### `seal()` + +> Seal the `EEPROM` layout, so no new slices can be requested. The CRC checksum +> is considered final at this time, and the `isValid()`, `crc()`, `used()` and +> `version()` methods can be used from this point onwards. +> +> If not called explicitly, the layout will be sealed automatically after +> `setup()` in the sketch finished. + +### `update()` + +> Updates the `EEPROM` header with the current status quo, including the version +> and the CRC checksum. +> +> This should be called when upgrading from one version to another, or when +> fixing up an out-of-sync case. + +### `isValid()` + +> Returns whether the `EEPROM` header is valid, that is, if it has the expected +> CRC checksum. +> +> Should only be called after calling `seal()`. + +### `invalidate()` + +> Invalidates the `EEPROM` header. Use when the version does not match what the +> firmware would expect. This signals to other plugins that the contents of +> `EEPROM` should not be trusted. + +### `version([newVersion])` + +> Sets or returns the version of the `EEPROM` layout. This is purely for use by +> the firmware, so it can attempt to upgrade the contents, if need be, or alert +> the user in there's a mismatch. Plugins do not use this property. +> +> Should only be called after calling `seal()`. + +### `crc()` + +> Returns the CRC checksum of the layout. Should only be used after calling +> `seal()`. + +### `used()` + +> Returns the amount of space requested so far. +> +> Should only be used after calling `seal()`. + +## Focus commands + +The plugin provides two - optional - [Focus][FocusSerial] command plugins: +`FocusSettingsCommand` and `FocusEEPROMCommand`. These must be explicitly added +to `KALEIDOSCOPE_INIT_PLUGINS` if one wishes to use them. They provide the +following commands: + + [FocusSerial]: https://github.com/keyboardio/Kaleidoscope-FocusSerial + +### `settings.defaultLayer` + +> Sets or returns (if called without arguments) the ID of the default layer. If +> set, the keyboard will automatically switch to the given layer when connected. +> Setting it to `255` disables the automatic switching. + +### `settings.crc` + +> Returns the actual, and the expected checksum of the settings. + +### `settings.valid?` + +> Returns either `true` or `false`, depending on whether the sealed settings are +> to be considered valid or not. + +### `settings.version` + +> Returns the (user-set) version of the settings. + +### `eeprom.contents` + +> Without argument, displays the full contents of the `EEPROM`, including the +> settings header. +> +> With arguments, the command updates as much of the `EEPROM` as arguments are +> provided. It will discard any unnecessary arguments. + +### `eeprom.free` + +> Returns the amount of free bytes in `EEPROM`. + +## Dependencies + +* [Kaleidoscope-FocusSerial][FocusSerial] + +## 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-EEPROM-Settings/blob/master/examples/EEPROM-Settings/EEPROM-Settings.ino diff --git a/src/Kaleidoscope-EEPROM-Settings.h b/src/Kaleidoscope-EEPROM-Settings.h index 123b49cc..a36d235e 100644 --- a/src/Kaleidoscope-EEPROM-Settings.h +++ b/src/Kaleidoscope-EEPROM-Settings.h @@ -17,5 +17,5 @@ #pragma once -#include -#include +#include +#include diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp b/src/kaleidoscope/plugin/EEPROM-Settings-Focus.cpp similarity index 95% rename from src/Kaleidoscope/EEPROM-Settings-Focus.cpp rename to src/kaleidoscope/plugin/EEPROM-Settings-Focus.cpp index 56cc50a9..1f669f3b 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.cpp +++ b/src/kaleidoscope/plugin/EEPROM-Settings-Focus.cpp @@ -20,6 +20,7 @@ #include "crc.h" namespace kaleidoscope { +namespace plugin { namespace eeprom { EventHandlerResult FocusSettingsCommand::onFocusEvent(const char *command) { @@ -115,8 +116,9 @@ EventHandlerResult FocusEEPROMCommand::onFocusEvent(const char *command) { return EventHandlerResult::EVENT_CONSUMED; } +} } } -kaleidoscope::eeprom::FocusSettingsCommand FocusSettingsCommand; -kaleidoscope::eeprom::FocusEEPROMCommand FocusEEPROMCommand; +kaleidoscope::plugin::eeprom::FocusSettingsCommand FocusSettingsCommand; +kaleidoscope::plugin::eeprom::FocusEEPROMCommand FocusEEPROMCommand; diff --git a/src/Kaleidoscope/EEPROM-Settings-Focus.h b/src/kaleidoscope/plugin/EEPROM-Settings-Focus.h similarity index 86% rename from src/Kaleidoscope/EEPROM-Settings-Focus.h rename to src/kaleidoscope/plugin/EEPROM-Settings-Focus.h index bd0b659e..469e8db2 100644 --- a/src/Kaleidoscope/EEPROM-Settings-Focus.h +++ b/src/kaleidoscope/plugin/EEPROM-Settings-Focus.h @@ -20,6 +20,7 @@ #include namespace kaleidoscope { +namespace plugin { namespace eeprom { class FocusSettingsCommand : public kaleidoscope::Plugin { public: @@ -35,8 +36,9 @@ class FocusEEPROMCommand : public kaleidoscope::Plugin { EventHandlerResult onFocusEvent(const char *command); }; +} } } -extern kaleidoscope::eeprom::FocusSettingsCommand FocusSettingsCommand; -extern kaleidoscope::eeprom::FocusEEPROMCommand FocusEEPROMCommand; +extern kaleidoscope::plugin::eeprom::FocusSettingsCommand FocusSettingsCommand; +extern kaleidoscope::plugin::eeprom::FocusEEPROMCommand FocusEEPROMCommand; diff --git a/src/Kaleidoscope/EEPROM-Settings.cpp b/src/kaleidoscope/plugin/EEPROM-Settings.cpp similarity index 97% rename from src/Kaleidoscope/EEPROM-Settings.cpp rename to src/kaleidoscope/plugin/EEPROM-Settings.cpp index 3870187f..76058754 100644 --- a/src/Kaleidoscope/EEPROM-Settings.cpp +++ b/src/kaleidoscope/plugin/EEPROM-Settings.cpp @@ -19,6 +19,7 @@ #include "crc.h" namespace kaleidoscope { +namespace plugin { struct EEPROMSettings::settings EEPROMSettings::settings_; bool EEPROMSettings::is_valid_; @@ -113,6 +114,7 @@ void EEPROMSettings::version(uint8_t ver) { update(); } +} } -kaleidoscope::EEPROMSettings EEPROMSettings; +kaleidoscope::plugin::EEPROMSettings EEPROMSettings; diff --git a/src/Kaleidoscope/EEPROM-Settings.h b/src/kaleidoscope/plugin/EEPROM-Settings.h similarity index 94% rename from src/Kaleidoscope/EEPROM-Settings.h rename to src/kaleidoscope/plugin/EEPROM-Settings.h index 73d08636..0264ab3e 100644 --- a/src/Kaleidoscope/EEPROM-Settings.h +++ b/src/kaleidoscope/plugin/EEPROM-Settings.h @@ -21,6 +21,7 @@ #include namespace kaleidoscope { +namespace plugin { class EEPROMSettings : public kaleidoscope::Plugin { public: EEPROMSettings(void) {} @@ -52,6 +53,7 @@ class EEPROMSettings : public kaleidoscope::Plugin { uint16_t crc; } settings_; }; -}; +} +} -extern kaleidoscope::EEPROMSettings EEPROMSettings; +extern kaleidoscope::plugin::EEPROMSettings EEPROMSettings; diff --git a/src/Kaleidoscope/crc.cpp b/src/kaleidoscope/plugin/crc.cpp similarity index 100% rename from src/Kaleidoscope/crc.cpp rename to src/kaleidoscope/plugin/crc.cpp diff --git a/src/Kaleidoscope/crc.h b/src/kaleidoscope/plugin/crc.h similarity index 100% rename from src/Kaleidoscope/crc.h rename to src/kaleidoscope/plugin/crc.h From 58830c66856ee46f31ed0409fe917b6dedf55c2a Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 13 Oct 2018 12:25:49 +0200 Subject: [PATCH 54/56] 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 687b5684..00000000 --- a/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# Kaleidoscope-EEPROM-Settings - -[![Build Status][travis:image]][travis:status] - - [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-EEPROM-Settings.svg?branch=master - [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-EEPROM-Settings - -See [doc/plugin/EEPROM-Settings.md](doc/plugin/EEPROM-Settings.md) for documentation. diff --git a/library.properties b/library.properties deleted file mode 100644 index ee68df70..00000000 --- a/library.properties +++ /dev/null @@ -1,10 +0,0 @@ -name=Kaleidoscope-EEPROM-Settings -version=0.0.0 -author=Gergely Nagy -maintainer=Gergely Nagy -sentence=Base EEPROM settings plugin for Kaleidoscope. -paragraph=... -category=Communication -url=https://github.com/keyboardio/Kaleidoscope-EEPROM-Settings -architectures=avr -dot_a_linkage=true From 76c041c4285ef656d268212036bd06b7c3325019 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 14 Oct 2018 18:00:12 +0200 Subject: [PATCH 55/56] 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/EEPROM-Settings.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/plugin/EEPROM-Settings.md b/doc/plugin/EEPROM-Settings.md index ccfb4955..598e7ae3 100644 --- a/doc/plugin/EEPROM-Settings.md +++ b/doc/plugin/EEPROM-Settings.md @@ -123,7 +123,7 @@ The plugin provides two - optional - [Focus][FocusSerial] command plugins: to `KALEIDOSCOPE_INIT_PLUGINS` if one wishes to use them. They provide the following commands: - [FocusSerial]: https://github.com/keyboardio/Kaleidoscope-FocusSerial + [FocusSerial]: FocusSerial.md ### `settings.defaultLayer` @@ -165,4 +165,4 @@ following commands: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/keyboardio/Kaleidoscope-EEPROM-Settings/blob/master/examples/EEPROM-Settings/EEPROM-Settings.ino + [plugin:example]: ../../examples/EEPROM-Settings/EEPROM-Settings.ino From 4bc0eb5d11306ffa96f0cbdee2decdd541ae47d8 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 15 Oct 2018 23:33:15 +0200 Subject: [PATCH 56/56] Further source-code rearrangement Merged `EEPROM-Settings-Focus` into `EEPROM-Settings` itself: there's no reason they should be separate. Also moved the CRC headers to `kaleidoscope/plugin/EEPROM-Settings/` to not pollute the plugin namespace. Signed-off-by: Gergely Nagy --- src/Kaleidoscope-EEPROM-Settings.h | 1 - .../plugin/EEPROM-Settings-Focus.cpp | 124 ------------------ .../plugin/EEPROM-Settings-Focus.h | 44 ------- src/kaleidoscope/plugin/EEPROM-Settings.cpp | 99 +++++++++++++- src/kaleidoscope/plugin/EEPROM-Settings.h | 16 +++ .../plugin/{ => EEPROM-Settings}/crc.cpp | 0 .../plugin/{ => EEPROM-Settings}/crc.h | 0 7 files changed, 114 insertions(+), 170 deletions(-) delete mode 100644 src/kaleidoscope/plugin/EEPROM-Settings-Focus.cpp delete mode 100644 src/kaleidoscope/plugin/EEPROM-Settings-Focus.h rename src/kaleidoscope/plugin/{ => EEPROM-Settings}/crc.cpp (100%) rename src/kaleidoscope/plugin/{ => EEPROM-Settings}/crc.h (100%) diff --git a/src/Kaleidoscope-EEPROM-Settings.h b/src/Kaleidoscope-EEPROM-Settings.h index a36d235e..ed93eec9 100644 --- a/src/Kaleidoscope-EEPROM-Settings.h +++ b/src/Kaleidoscope-EEPROM-Settings.h @@ -18,4 +18,3 @@ #pragma once #include -#include diff --git a/src/kaleidoscope/plugin/EEPROM-Settings-Focus.cpp b/src/kaleidoscope/plugin/EEPROM-Settings-Focus.cpp deleted file mode 100644 index 1f669f3b..00000000 --- a/src/kaleidoscope/plugin/EEPROM-Settings-Focus.cpp +++ /dev/null @@ -1,124 +0,0 @@ -/* -*- mode: c++ -*- - * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. - * 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 - * Foundation, version 3. - * - * This program is distributed in the hope that it will be useful, but WITHOUT - * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS - * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more - * details. - * - * You should have received a copy of the GNU General Public License along with - * this program. If not, see . - */ - -#include -#include -#include "crc.h" - -namespace kaleidoscope { -namespace plugin { -namespace eeprom { - -EventHandlerResult FocusSettingsCommand::onFocusEvent(const char *command) { - enum { - DEFAULT_LAYER, - IS_VALID, - GET_VERSION, - CRC, - } sub_command; - - if (::Focus.handleHelp(command, PSTR("settings.defaultLayer\nsettings.valid?\nsettings.version\nsettings.crc"))) - return EventHandlerResult::OK; - - if (strncmp_P(command, PSTR("settings."), 9) != 0) - return EventHandlerResult::OK; - - if (strcmp_P(command + 9, PSTR("defaultLayer")) == 0) - sub_command = DEFAULT_LAYER; - else if (strcmp_P(command + 9, PSTR("valid?")) == 0) - sub_command = IS_VALID; - else if (strcmp_P(command + 9, PSTR("version")) == 0) - sub_command = GET_VERSION; - else if (strcmp_P(command + 9, PSTR("crc")) == 0) - sub_command = CRC; - else - return EventHandlerResult::OK; - - switch (sub_command) { - case DEFAULT_LAYER: { - if (Serial.peek() == '\n') { - Serial.println(::EEPROMSettings.default_layer()); - } else { - ::EEPROMSettings.default_layer(Serial.parseInt()); - } - break; - } - case IS_VALID: - ::Focus.printBool(::EEPROMSettings.isValid()); - Serial.println(); - break; - case GET_VERSION: - Serial.println(::EEPROMSettings.version()); - break; - case CRC: - Serial.print(::CRC.crc, HEX); - Serial.print(F("/")); - Serial.println(::EEPROMSettings.crc(), HEX); - break; - } - - return EventHandlerResult::EVENT_CONSUMED; -} - -EventHandlerResult FocusEEPROMCommand::onFocusEvent(const char *command) { - enum { - CONTENTS, - FREE, - } sub_command; - - if (::Focus.handleHelp(command, PSTR("eeprom.contents\neeprom.free"))) - return EventHandlerResult::OK; - - if (strcmp_P(command, PSTR("eeprom.contents")) == 0) - sub_command = CONTENTS; - else if (strcmp_P(command, PSTR("eeprom.free")) == 0) - sub_command = FREE; - else - return EventHandlerResult::OK; - - switch (sub_command) { - case CONTENTS: { - if (Serial.peek() == '\n') { - for (uint16_t i = 0; i < EEPROM.length(); i++) { - uint8_t d = EEPROM[i]; - ::Focus.printNumber(d); - ::Focus.printSpace(); - } - Serial.println(); - } else { - for (uint16_t i = 0; i < EEPROM.length() && Serial.peek() != '\n'; i++) { - uint8_t d = Serial.parseInt(); - EEPROM.update(i, d); - } - } - - break; - } - case FREE: - Serial.println(EEPROM.length() - ::EEPROMSettings.used()); - break; - } - - return EventHandlerResult::EVENT_CONSUMED; -} - -} -} -} - -kaleidoscope::plugin::eeprom::FocusSettingsCommand FocusSettingsCommand; -kaleidoscope::plugin::eeprom::FocusEEPROMCommand FocusEEPROMCommand; diff --git a/src/kaleidoscope/plugin/EEPROM-Settings-Focus.h b/src/kaleidoscope/plugin/EEPROM-Settings-Focus.h deleted file mode 100644 index 469e8db2..00000000 --- a/src/kaleidoscope/plugin/EEPROM-Settings-Focus.h +++ /dev/null @@ -1,44 +0,0 @@ -/* -*- mode: c++ -*- - * Kaleidoscope-EEPROM-Settings -- Basic EEPROM settings plugin for Kaleidoscope. - * 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 - * Foundation, version 3. - * - * This program is distributed in the hope that it will be useful, but WITHOUT - * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS - * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more - * details. - * - * You should have received a copy of the GNU General Public License along with - * this program. If not, see . - */ - -#pragma once - -#include - -namespace kaleidoscope { -namespace plugin { -namespace eeprom { -class FocusSettingsCommand : public kaleidoscope::Plugin { - public: - FocusSettingsCommand() {} - - EventHandlerResult onFocusEvent(const char *command); -}; - -class FocusEEPROMCommand : public kaleidoscope::Plugin { - public: - FocusEEPROMCommand() {} - - EventHandlerResult onFocusEvent(const char *command); -}; - -} -} -} - -extern kaleidoscope::plugin::eeprom::FocusSettingsCommand FocusSettingsCommand; -extern kaleidoscope::plugin::eeprom::FocusEEPROMCommand FocusEEPROMCommand; diff --git a/src/kaleidoscope/plugin/EEPROM-Settings.cpp b/src/kaleidoscope/plugin/EEPROM-Settings.cpp index 76058754..9e0e4d72 100644 --- a/src/kaleidoscope/plugin/EEPROM-Settings.cpp +++ b/src/kaleidoscope/plugin/EEPROM-Settings.cpp @@ -16,7 +16,8 @@ */ #include -#include "crc.h" +#include +#include "kaleidoscope/plugin/EEPROM-Settings/crc.h" namespace kaleidoscope { namespace plugin { @@ -114,7 +115,103 @@ void EEPROMSettings::version(uint8_t ver) { update(); } +/** Focus **/ +EventHandlerResult FocusSettingsCommand::onFocusEvent(const char *command) { + enum { + DEFAULT_LAYER, + IS_VALID, + GET_VERSION, + CRC, + } sub_command; + + if (::Focus.handleHelp(command, PSTR("settings.defaultLayer\nsettings.valid?\nsettings.version\nsettings.crc"))) + return EventHandlerResult::OK; + + if (strncmp_P(command, PSTR("settings."), 9) != 0) + return EventHandlerResult::OK; + + if (strcmp_P(command + 9, PSTR("defaultLayer")) == 0) + sub_command = DEFAULT_LAYER; + else if (strcmp_P(command + 9, PSTR("valid?")) == 0) + sub_command = IS_VALID; + else if (strcmp_P(command + 9, PSTR("version")) == 0) + sub_command = GET_VERSION; + else if (strcmp_P(command + 9, PSTR("crc")) == 0) + sub_command = CRC; + else + return EventHandlerResult::OK; + + switch (sub_command) { + case DEFAULT_LAYER: { + if (Serial.peek() == '\n') { + Serial.println(::EEPROMSettings.default_layer()); + } else { + ::EEPROMSettings.default_layer(Serial.parseInt()); + } + break; + } + case IS_VALID: + ::Focus.printBool(::EEPROMSettings.isValid()); + Serial.println(); + break; + case GET_VERSION: + Serial.println(::EEPROMSettings.version()); + break; + case CRC: + Serial.print(::CRC.crc, HEX); + Serial.print(F("/")); + Serial.println(::EEPROMSettings.crc(), HEX); + break; + } + + return EventHandlerResult::EVENT_CONSUMED; +} + +EventHandlerResult FocusEEPROMCommand::onFocusEvent(const char *command) { + enum { + CONTENTS, + FREE, + } sub_command; + + if (::Focus.handleHelp(command, PSTR("eeprom.contents\neeprom.free"))) + return EventHandlerResult::OK; + + if (strcmp_P(command, PSTR("eeprom.contents")) == 0) + sub_command = CONTENTS; + else if (strcmp_P(command, PSTR("eeprom.free")) == 0) + sub_command = FREE; + else + return EventHandlerResult::OK; + + switch (sub_command) { + case CONTENTS: { + if (Serial.peek() == '\n') { + for (uint16_t i = 0; i < EEPROM.length(); i++) { + uint8_t d = EEPROM[i]; + ::Focus.printNumber(d); + ::Focus.printSpace(); + } + Serial.println(); + } else { + for (uint16_t i = 0; i < EEPROM.length() && Serial.peek() != '\n'; i++) { + uint8_t d = Serial.parseInt(); + EEPROM.update(i, d); + } + } + + break; + } + case FREE: + Serial.println(EEPROM.length() - ::EEPROMSettings.used()); + break; + } + + return EventHandlerResult::EVENT_CONSUMED; +} + } } kaleidoscope::plugin::EEPROMSettings EEPROMSettings; +kaleidoscope::plugin::FocusSettingsCommand FocusSettingsCommand; +kaleidoscope::plugin::FocusEEPROMCommand FocusEEPROMCommand; diff --git a/src/kaleidoscope/plugin/EEPROM-Settings.h b/src/kaleidoscope/plugin/EEPROM-Settings.h index 0264ab3e..34c0bcda 100644 --- a/src/kaleidoscope/plugin/EEPROM-Settings.h +++ b/src/kaleidoscope/plugin/EEPROM-Settings.h @@ -53,7 +53,23 @@ class EEPROMSettings : public kaleidoscope::Plugin { uint16_t crc; } settings_; }; + +class FocusSettingsCommand : public kaleidoscope::Plugin { + public: + FocusSettingsCommand() {} + + EventHandlerResult onFocusEvent(const char *command); +}; + +class FocusEEPROMCommand : public kaleidoscope::Plugin { + public: + FocusEEPROMCommand() {} + + EventHandlerResult onFocusEvent(const char *command); +}; } } extern kaleidoscope::plugin::EEPROMSettings EEPROMSettings; +extern kaleidoscope::plugin::FocusSettingsCommand FocusSettingsCommand; +extern kaleidoscope::plugin::FocusEEPROMCommand FocusEEPROMCommand; diff --git a/src/kaleidoscope/plugin/crc.cpp b/src/kaleidoscope/plugin/EEPROM-Settings/crc.cpp similarity index 100% rename from src/kaleidoscope/plugin/crc.cpp rename to src/kaleidoscope/plugin/EEPROM-Settings/crc.cpp diff --git a/src/kaleidoscope/plugin/crc.h b/src/kaleidoscope/plugin/EEPROM-Settings/crc.h similarity index 100% rename from src/kaleidoscope/plugin/crc.h rename to src/kaleidoscope/plugin/EEPROM-Settings/crc.h