From 499d4e8b37d3ab084562864e7d1eef7d7bacd223 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 18 May 2018 11:43:12 +0200 Subject: [PATCH 01/44] Initial import Signed-off-by: Gergely Nagy --- .gitignore | 1 + .kaleidoscope-builder.conf | 2 + .travis.yml | 24 + COPYING | 674 +++++++++++++++++++ Makefile | 14 + README.md | 6 + examples/ErgoDox/ErgoDox.ino | 57 ++ extras/boards.txt | 23 + extras/platform.txt | 7 + extras/variants/ergodox/pins_arduino.h | 385 +++++++++++ library.properties | 9 + src/Kaleidoscope-Hardware-ErgoDox.h | 20 + src/kaleidoscope/hardware/ErgoDox.cpp | 110 +++ src/kaleidoscope/hardware/ErgoDox.h | 120 ++++ src/kaleidoscope/hardware/ErgoDoxScanner.cpp | 184 +++++ src/kaleidoscope/hardware/ErgoDoxScanner.h | 44 ++ src/kaleidoscope/hardware/i2cmaster.cpp | 198 ++++++ src/kaleidoscope/hardware/i2cmaster.h | 176 +++++ 18 files changed, 2054 insertions(+) create mode 100644 .gitignore create mode 100644 .kaleidoscope-builder.conf create mode 100644 .travis.yml create mode 100644 COPYING create mode 100644 Makefile create mode 100644 README.md create mode 100644 examples/ErgoDox/ErgoDox.ino create mode 100644 extras/boards.txt create mode 100644 extras/platform.txt create mode 100644 extras/variants/ergodox/pins_arduino.h create mode 100644 library.properties create mode 100644 src/Kaleidoscope-Hardware-ErgoDox.h create mode 100644 src/kaleidoscope/hardware/ErgoDox.cpp create mode 100644 src/kaleidoscope/hardware/ErgoDox.h create mode 100644 src/kaleidoscope/hardware/ErgoDoxScanner.cpp create mode 100644 src/kaleidoscope/hardware/ErgoDoxScanner.h create mode 100644 src/kaleidoscope/hardware/i2cmaster.cpp create mode 100644 src/kaleidoscope/hardware/i2cmaster.h diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..2c04c9d8 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/output/ \ No newline at end of file diff --git a/.kaleidoscope-builder.conf b/.kaleidoscope-builder.conf new file mode 100644 index 00000000..a0681b9b --- /dev/null +++ b/.kaleidoscope-builder.conf @@ -0,0 +1,2 @@ +DEFAULT_SKETCH="ErgoDox" +BOARD="ergodox" diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 00000000..bbd83bf0 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,24 @@ +dist: trusty +sudo: false +os: + - linux +install: + - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Arduino-Boards hardware/keyboardio/avr + - cat extras/boards.txt >>hardware/keyboardio/avr/boards.txt + - cat extras/platform.txt >>hardware/keyboardio/avr/platform.txt + - cp -pr extras/variants/ergodox hardware/keyboardio/avr/variants/ +script: + - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware +notifications: + irc: + channels: + - "chat.freenode.net#keyboardio" + use_notice: true + skip_join: true + template: + - "%{repository_name}/%{branch} %{commit} by %{author}: %{commit_subject} %{build_url} %{message}" + email: + on_success: change + on_failure: change +cache: + ccache: true diff --git a/COPYING b/COPYING new file mode 100644 index 00000000..94a9ed02 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..8f830f44 --- /dev/null +++ b/Makefile @@ -0,0 +1,14 @@ +# This stub makefile for a Kaleidoscope plugin pulls in +# all targets from the Kaleidoscope-Plugin library + +UNAME_S := $(shell uname -s) + +ifeq ($(UNAME_S),Darwin) +SKETCHBOOK_DIR ?= $(HOME)/Documents/Arduino/ +else +SKETCHBOOK_DIR ?= $(HOME)/Arduino +endif + +BOARD_HARDWARE_PATH ?= $(SKETCHBOOK_DIR)/hardware +KALEIDOSCOPE_PLUGIN_MAKEFILE_DIR ?= keyboardio/avr/build-tools/makefiles/ +include $(BOARD_HARDWARE_PATH)/$(KALEIDOSCOPE_PLUGIN_MAKEFILE_DIR)/rules.mk diff --git a/README.md b/README.md new file mode 100644 index 00000000..e2ded6bb --- /dev/null +++ b/README.md @@ -0,0 +1,6 @@ +# Kaleidoscope-Hardware-ErgoDox + +This is a plugin for [Kaleidoscope][fw], that adds hardware support for +the ErgoDox. + + [fw]: https://github.com/keyboardio/Kaleidoscope diff --git a/examples/ErgoDox/ErgoDox.ino b/examples/ErgoDox/ErgoDox.ino new file mode 100644 index 00000000..1b6d7dad --- /dev/null +++ b/examples/ErgoDox/ErgoDox.ino @@ -0,0 +1,57 @@ +/* -*- mode: c++ -*- + * ErgoDox -- A very basic Kaleidoscope example for the ErgoDox + * Copyright (C) 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 2 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, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +#include "Kaleidoscope.h" + +/* *INDENT-OFF* */ +KEYMAPS( + [0] = KEYMAP_STACKED + ( + // left hand + Key_Equals, Key_1, Key_2, Key_3, Key_4, Key_5, Key_LeftArrow, + Key_Delete, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_NoKey, + Key_Backspace, Key_A, Key_S, Key_D, Key_F, Key_G, + Key_LeftShift, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_LeftControl, + Key_Backtick, Key_Quote, Key_NoKey, Key_LeftArrow, Key_RightArrow, + + Key_NoKey, Key_LeftGui, + Key_Home, + Key_Space, Key_Backspace, Key_End, + + // right hand + Key_RightArrow, Key_6, Key_7, Key_8, Key_9, Key_0, Key_Minus, + Key_NoKey, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Backslash, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_RightControl, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_RightShift, + Key_UpArrow, Key_DownArrow, XXX, XXX, Key_NoKey, + + Key_LeftAlt, Key_Esc, + Key_PageUp, + Key_PageDown, Key_Tab, Key_Enter + ), +) +/* *INDENT-ON* */ + +void setup() { + Kaleidoscope.setup(); +} + +void loop() { + Kaleidoscope.loop(); +} diff --git a/extras/boards.txt b/extras/boards.txt new file mode 100644 index 00000000..9efcb1ec --- /dev/null +++ b/extras/boards.txt @@ -0,0 +1,23 @@ +## These should be appended to hardware/keyboardio/avr/boards.txt + +############################################################## + +ergodox.name=ErgoDox +ergodox.vid.0=0xfeed +ergodox.pid.0=0x1307 + +ergodox.upload.tool=teensy_loader_cli +ergodox.upload.protocol=halfkay +ergodox.upload.maximum_size=32256 +ergodox.upload.maximum_data_size=2560 + +ergodox.build.mcu=atmega32u4 +ergodox.build.f_cpu=16000000L +ergodox.build.vid=0xfeed +ergodox.build.pid=0x1307 +ergodox.build.usb_product="ErgoDox EZ" +ergodox.build.usb_manufacturer="ErgoDox EZ" +ergodox.build.board=AVR_ERGODOX +ergodox.build.core=arduino:arduino +ergodox.build.variant=ergodox +ergodox.build.extra_flags={build.usb_flags} '-DKALEIDOSCOPE_HARDWARE_H="Kaleidoscope-Hardware-ErgoDox.h"' diff --git a/extras/platform.txt b/extras/platform.txt new file mode 100644 index 00000000..b2102d0e --- /dev/null +++ b/extras/platform.txt @@ -0,0 +1,7 @@ +## These should be appended to hardware/keyboardio/platform.txt + +tools.teensy_loader_cli.cmd.path=teensy_loader_cli +tools.teensy_loader_cli.upload.params.verbose=-v +tools.teensy_loader_cli.upload.params.quiet= +tools.teensy_loader_cli.upload.noverify= +tools.teensy_loader_cli.upload.pattern="{cmd.path}" {upload.verbose} --mcu=atmega32u4 -w -v "{build.path}/{build.project_name}.hex" diff --git a/extras/variants/ergodox/pins_arduino.h b/extras/variants/ergodox/pins_arduino.h new file mode 100644 index 00000000..609b7636 --- /dev/null +++ b/extras/variants/ergodox/pins_arduino.h @@ -0,0 +1,385 @@ +/* + + Based on pins_arduino.h for the Arduino Leonardo as of Arduino 1.6.10 + + pins_arduino.h - Pin definition functions for Arduino + Part of Arduino - http://www.arduino.cc/ + + Copyright (c) 2007 David A. Mellis + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library 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 + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General + Public License along with this library; if not, write to the + Free Software Foundation, Inc., 59 Temple Place, Suite 330, + Boston, MA 02111-1307 USA +*/ + +#ifndef Pins_Arduino_h +#define Pins_Arduino_h + +#include + +// Workaround for wrong definitions in "iom32u4.h". +// This should be fixed in the AVR toolchain. +#undef UHCON +#undef UHINT +#undef UHIEN +#undef UHADDR +#undef UHFNUM +#undef UHFNUML +#undef UHFNUMH +#undef UHFLEN +#undef UPINRQX +#undef UPINTX +#undef UPNUM +#undef UPRST +#undef UPCONX +#undef UPCFG0X +#undef UPCFG1X +#undef UPSTAX +#undef UPCFG2X +#undef UPIENX +#undef UPDATX +#undef TCCR2A +#undef WGM20 +#undef WGM21 +#undef COM2B0 +#undef COM2B1 +#undef COM2A0 +#undef COM2A1 +#undef TCCR2B +#undef CS20 +#undef CS21 +#undef CS22 +#undef WGM22 +#undef FOC2B +#undef FOC2A +#undef TCNT2 +#undef TCNT2_0 +#undef TCNT2_1 +#undef TCNT2_2 +#undef TCNT2_3 +#undef TCNT2_4 +#undef TCNT2_5 +#undef TCNT2_6 +#undef TCNT2_7 +#undef OCR2A +#undef OCR2_0 +#undef OCR2_1 +#undef OCR2_2 +#undef OCR2_3 +#undef OCR2_4 +#undef OCR2_5 +#undef OCR2_6 +#undef OCR2_7 +#undef OCR2B +#undef OCR2_0 +#undef OCR2_1 +#undef OCR2_2 +#undef OCR2_3 +#undef OCR2_4 +#undef OCR2_5 +#undef OCR2_6 +#undef OCR2_7 + +#define NUM_DIGITAL_PINS 31 +#define NUM_ANALOG_INPUTS 12 + +#define TX_RX_LED_INIT DDRD |= (1<<5), DDRB |= (1<<0) +/* + +// The only way to get the Arduino core to not light up the RX and TX LEDS +// on every USB packet is to define these to noops + +#define TXLED1 PORTD |= (1<<5) +#define TXLED0 PORTD &= ~(1<<5) +#define RXLED1 PORTB |= (1<<0) +#define RXLED0 PORTB &= ~(1<<0) + +*/ + +#define TXLED1 ((void)0) +#define TXLED0 ((void)0) +#define RXLED1 ((void)0) +#define RXLED0 ((void)0) + + +static const uint8_t SDA = 2; +static const uint8_t SCL = 3; +#define LED_BUILTIN 17 +#define LED_BUILTIN_RX 17 +#define LED_BUILTIN_TX 30 + +// Map SPI port to 'new' pins D14..D17 +static const uint8_t SS = 17; +static const uint8_t MOSI = 16; +static const uint8_t MISO = 14; +static const uint8_t SCK = 15; + +// Mapping of analog pins as digital I/O +// A6-A11 share with digital pins +static const uint8_t A0 = 18; +static const uint8_t A1 = 19; +static const uint8_t A2 = 20; +static const uint8_t A3 = 21; +static const uint8_t A4 = 22; +static const uint8_t A5 = 23; +static const uint8_t A6 = 24; // D4 +static const uint8_t A7 = 25; // D6 +static const uint8_t A8 = 26; // D8 +static const uint8_t A9 = 27; // D9 +static const uint8_t A10 = 28; // D10 +static const uint8_t A11 = 29; // D12 + +#define digitalPinToPCICR(p) ((((p) >= 8 && (p) <= 11) || ((p) >= 14 && (p) <= 17) || ((p) >= A8 && (p) <= A10)) ? (&PCICR) : ((uint8_t *)0)) +#define digitalPinToPCICRbit(p) 0 +#define digitalPinToPCMSK(p) ((((p) >= 8 && (p) <= 11) || ((p) >= 14 && (p) <= 17) || ((p) >= A8 && (p) <= A10)) ? (&PCMSK0) : ((uint8_t *)0)) +#define digitalPinToPCMSKbit(p) ( ((p) >= 8 && (p) <= 11) ? (p) - 4 : ((p) == 14 ? 3 : ((p) == 15 ? 1 : ((p) == 16 ? 2 : ((p) == 17 ? 0 : (p - A8 + 4)))))) + +// __AVR_ATmega32U4__ has an unusual mapping of pins to channels +extern const uint8_t PROGMEM analog_pin_to_channel_PGM[]; +#define analogPinToChannel(P) ( pgm_read_byte( analog_pin_to_channel_PGM + (P) ) ) + +#define digitalPinHasPWM(p) ((p) == 3 || (p) == 5 || (p) == 6 || (p) == 9 || (p) == 10 || (p) == 11 || (p) == 13) + +#define digitalPinToInterrupt(p) ((p) == 0 ? 2 : ((p) == 1 ? 3 : ((p) == 2 ? 1 : ((p) == 3 ? 0 : ((p) == 7 ? 4 : NOT_AN_INTERRUPT))))) + +#ifdef ARDUINO_MAIN + +// On the Arduino board, digital pins are also used +// for the analog output (software PWM). Analog input +// pins are a separate set. + +// ATMEL ATMEGA32U4 / ARDUINO LEONARDO +// +// D0 PD2 RXD1/INT2 +// D1 PD3 TXD1/INT3 +// D2 PD1 SDA SDA/INT1 +// D3# PD0 PWM8/SCL OC0B/SCL/INT0 +// D4 A6 PD4 ADC8 +// D5# PC6 ??? OC3A/#OC4A +// D6# A7 PD7 FastPWM #OC4D/ADC10 +// D7 PE6 INT6/AIN0 +// +// D8 A8 PB4 ADC11/PCINT4 +// D9# A9 PB5 PWM16 OC1A/#OC4B/ADC12/PCINT5 +// D10# A10 PB6 PWM16 OC1B/0c4B/ADC13/PCINT6 +// D11# PB7 PWM8/16 0C0A/OC1C/#RTS/PCINT7 +// D12 A11 PD6 T1/#OC4D/ADC9 +// D13# PC7 PWM10 CLK0/OC4A +// +// A0 D18 PF7 ADC7 +// A1 D19 PF6 ADC6 +// A2 D20 PF5 ADC5 +// A3 D21 PF4 ADC4 +// A4 D22 PF1 ADC1 +// A5 D23 PF0 ADC0 +// +// New pins D14..D17 to map SPI port to digital pins +// +// MISO D14 PB3 MISO,PCINT3 +// SCK D15 PB1 SCK,PCINT1 +// MOSI D16 PB2 MOSI,PCINT2 +// SS D17 PB0 RXLED,SS/PCINT0 +// +// TXLED D30 PD5 XCK1 +// RXLED D17 PB0 +// HWB PE2 HWB + +// these arrays map port names (e.g. port B) to the +// appropriate addresses for various functions (e.g. reading +// and writing) +const uint16_t PROGMEM port_to_mode_PGM[] = { + NOT_A_PORT, + NOT_A_PORT, + (uint16_t) &DDRB, + (uint16_t) &DDRC, + (uint16_t) &DDRD, + (uint16_t) &DDRE, + (uint16_t) &DDRF, +}; + +const uint16_t PROGMEM port_to_output_PGM[] = { + NOT_A_PORT, + NOT_A_PORT, + (uint16_t) &PORTB, + (uint16_t) &PORTC, + (uint16_t) &PORTD, + (uint16_t) &PORTE, + (uint16_t) &PORTF, +}; + +const uint16_t PROGMEM port_to_input_PGM[] = { + NOT_A_PORT, + NOT_A_PORT, + (uint16_t) &PINB, + (uint16_t) &PINC, + (uint16_t) &PIND, + (uint16_t) &PINE, + (uint16_t) &PINF, +}; + +const uint8_t PROGMEM digital_pin_to_port_PGM[] = { + PD, // D0 - PD2 + PD, // D1 - PD3 + PD, // D2 - PD1 + PD, // D3 - PD0 + PD, // D4 - PD4 + PC, // D5 - PC6 + PD, // D6 - PD7 + PE, // D7 - PE6 + + PB, // D8 - PB4 + PB, // D9 - PB5 + PB, // D10 - PB6 + PB, // D11 - PB7 + PD, // D12 - PD6 + PC, // D13 - PC7 + + PB, // D14 - MISO - PB3 + PB, // D15 - SCK - PB1 + PB, // D16 - MOSI - PB2 + PB, // D17 - SS - PB0 + + PF, // D18 - A0 - PF7 + PF, // D19 - A1 - PF6 + PF, // D20 - A2 - PF5 + PF, // D21 - A3 - PF4 + PF, // D22 - A4 - PF1 + PF, // D23 - A5 - PF0 + + PD, // D24 / D4 - A6 - PD4 + PD, // D25 / D6 - A7 - PD7 + PB, // D26 / D8 - A8 - PB4 + PB, // D27 / D9 - A9 - PB5 + PB, // D28 / D10 - A10 - PB6 + PD, // D29 / D12 - A11 - PD6 + PD, // D30 / TX Led - PD5 +}; + +const uint8_t PROGMEM digital_pin_to_bit_mask_PGM[] = { + _BV(2), // D0 - PD2 + _BV(3), // D1 - PD3 + _BV(1), // D2 - PD1 + _BV(0), // D3 - PD0 + _BV(4), // D4 - PD4 + _BV(6), // D5 - PC6 + _BV(7), // D6 - PD7 + _BV(6), // D7 - PE6 + + _BV(4), // D8 - PB4 + _BV(5), // D9 - PB5 + _BV(6), // D10 - PB6 + _BV(7), // D11 - PB7 + _BV(6), // D12 - PD6 + _BV(7), // D13 - PC7 + + _BV(3), // D14 - MISO - PB3 + _BV(1), // D15 - SCK - PB1 + _BV(2), // D16 - MOSI - PB2 + _BV(0), // D17 - SS - PB0 + + _BV(7), // D18 - A0 - PF7 + _BV(6), // D19 - A1 - PF6 + _BV(5), // D20 - A2 - PF5 + _BV(4), // D21 - A3 - PF4 + _BV(1), // D22 - A4 - PF1 + _BV(0), // D23 - A5 - PF0 + + _BV(4), // D24 / D4 - A6 - PD4 + _BV(7), // D25 / D6 - A7 - PD7 + _BV(4), // D26 / D8 - A8 - PB4 + _BV(5), // D27 / D9 - A9 - PB5 + _BV(6), // D28 / D10 - A10 - PB6 + _BV(6), // D29 / D12 - A11 - PD6 + _BV(5), // D30 / TX Led - PD5 +}; + +const uint8_t PROGMEM digital_pin_to_timer_PGM[] = { + NOT_ON_TIMER, + NOT_ON_TIMER, + NOT_ON_TIMER, + TIMER0B, /* 3 */ + NOT_ON_TIMER, + TIMER3A, /* 5 */ + TIMER4D, /* 6 */ + NOT_ON_TIMER, + + NOT_ON_TIMER, + TIMER1A, /* 9 */ + TIMER1B, /* 10 */ + TIMER0A, /* 11 */ + + NOT_ON_TIMER, + TIMER4A, /* 13 */ + + NOT_ON_TIMER, + NOT_ON_TIMER, + NOT_ON_TIMER, + NOT_ON_TIMER, + NOT_ON_TIMER, + NOT_ON_TIMER, + + NOT_ON_TIMER, + NOT_ON_TIMER, + NOT_ON_TIMER, + NOT_ON_TIMER, + NOT_ON_TIMER, + NOT_ON_TIMER, + NOT_ON_TIMER, + NOT_ON_TIMER, + NOT_ON_TIMER, + NOT_ON_TIMER, + NOT_ON_TIMER, +}; + +const uint8_t PROGMEM analog_pin_to_channel_PGM[] = { + 7, // A0 PF7 ADC7 + 6, // A1 PF6 ADC6 + 5, // A2 PF5 ADC5 + 4, // A3 PF4 ADC4 + 1, // A4 PF1 ADC1 + 0, // A5 PF0 ADC0 + 8, // A6 D4 PD4 ADC8 + 10, // A7 D6 PD7 ADC10 + 11, // A8 D8 PB4 ADC11 + 12, // A9 D9 PB5 ADC12 + 13, // A10 D10 PB6 ADC13 + 9 // A11 D12 PD6 ADC9 +}; + +#endif /* ARDUINO_MAIN */ + +// These serial port names are intended to allow libraries and architecture-neutral +// sketches to automatically default to the correct port name for a particular type +// of use. For example, a GPS module would normally connect to SERIAL_PORT_HARDWARE_OPEN, +// the first hardware serial port whose RX/TX pins are not dedicated to another use. +// +// SERIAL_PORT_MONITOR Port which normally prints to the Arduino Serial Monitor +// +// SERIAL_PORT_USBVIRTUAL Port which is USB virtual serial +// +// SERIAL_PORT_LINUXBRIDGE Port which connects to a Linux system via Bridge library +// +// SERIAL_PORT_HARDWARE Hardware serial port, physical RX & TX pins. +// +// SERIAL_PORT_HARDWARE_OPEN Hardware serial ports which are open for use. Their RX & TX +// pins are NOT connected to anything by default. +#define SERIAL_PORT_MONITOR Serial +#define SERIAL_PORT_USBVIRTUAL Serial +#define SERIAL_PORT_HARDWARE Serial1 +#define SERIAL_PORT_HARDWARE_OPEN Serial1 + +// Alias SerialUSB to Serial +#define SerialUSB SERIAL_PORT_USBVIRTUAL + +#endif /* Pins_Arduino_h */ diff --git a/library.properties b/library.properties new file mode 100644 index 00000000..3352b150 --- /dev/null +++ b/library.properties @@ -0,0 +1,9 @@ +name=Kaleidoscope-Hardware-ErgoDox +version=0.0.1 +author=Gergely Nagy +maintainer=Gergely Nagy +sentence=ErgoDox Hardware support for Kaleidoscope. +paragraph=... +category=Communication +url=https://github.com/keyboardio/Kaleidoscope-Hardware-ErgoDox +architectures=avr diff --git a/src/Kaleidoscope-Hardware-ErgoDox.h b/src/Kaleidoscope-Hardware-ErgoDox.h new file mode 100644 index 00000000..235fd029 --- /dev/null +++ b/src/Kaleidoscope-Hardware-ErgoDox.h @@ -0,0 +1,20 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-Hardware-ErgoDox -- ErgoDox hardware support for Kaleidoscope + * Copyright (C) 2018 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#pragma once +#include "kaleidoscope/hardware/ErgoDox.h" diff --git a/src/kaleidoscope/hardware/ErgoDox.cpp b/src/kaleidoscope/hardware/ErgoDox.cpp new file mode 100644 index 00000000..1702b3f6 --- /dev/null +++ b/src/kaleidoscope/hardware/ErgoDox.cpp @@ -0,0 +1,110 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-Hardware-ErgoDox -- ErgoDox hardware support for Kaleidoscope + * Copyright (C) 2018 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#include +#include +#include +#include "ErgoDoxScanner.h" + +namespace kaleidoscope { +namespace hardware { + +ErgoDoxScanner ErgoDox::scanner_; +uint8_t ErgoDox::previousKeyState_[ROWS]; +uint8_t ErgoDox::keyState_[ROWS]; +uint8_t ErgoDox::masks_[ROWS]; + +void ErgoDox::setup(void) { + wdt_disable(); + delay(100); + + TCCR1A = 0b10101001; + TCCR1B = 0b00001001; + + DDRB &= ~(1 << 4); + PORTB &= ~(1 << 4); + + DDRC &= ~(1 << 7); + DDRD &= ~(1 << 5 | 1 << 4); + DDRE &= ~(1 << 6); + PORTC |= (1 << 7); + PORTD |= (1 << 5 | 1 << 4); + PORTE |= (1 << 6); + + scanner_.begin(); +} + +void ErgoDox::readMatrix() { + for (uint8_t i = 0; i < ROWS / 2; i++) { + scanner_.selectRow(i); + scanner_.selectRow(i + ROWS / 2); + + // TODO(algernon): debouncing + + // left side + previousKeyState_[i] = keyState_[i]; + keyState_[i] = scanner_.readCols(i); + + // right side + previousKeyState_[i + ROWS / 2] = keyState_[i + ROWS / 2]; + keyState_[i + ROWS / 2] = scanner_.readCols(i + ROWS / 2); + + scanner_.unselectRows(); + } +} + +void ErgoDox::actOnMatrixScan() { + for (byte row = 0; row < ROWS; row++) { + for (byte col = 0; col < COLS; col++) { + uint8_t keyState = (bitRead(previousKeyState_[row], col) << 0) | + (bitRead(keyState_[row], col) << 1); + handleKeyswitchEvent(Key_NoKey, row, col, keyState); + } + } +} + +void ErgoDox::scanMatrix() { + readMatrix(); + actOnMatrixScan(); +} + +void ErgoDox::maskKey(byte row, byte col) { + if (row >= ROWS || col >= COLS) + return; + + bitWrite(masks_[row], col, 1); +} + +void ErgoDox::unMaskKey(byte row, byte col) { + if (row >= ROWS || col >= COLS) + return; + + bitWrite(masks_[row], col, 0); +} + +bool ErgoDox::isKeyMasked(byte row, byte col) { + if (row >= ROWS || col >= COLS) + return false; + + return bitRead(masks_[row], col); +} + +} +} + +HARDWARE_IMPLEMENTATION KeyboardHardware; diff --git a/src/kaleidoscope/hardware/ErgoDox.h b/src/kaleidoscope/hardware/ErgoDox.h new file mode 100644 index 00000000..af119e68 --- /dev/null +++ b/src/kaleidoscope/hardware/ErgoDox.h @@ -0,0 +1,120 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-Hardware-ErgoDox -- ErgoDox hardware support for Kaleidoscope + * Copyright (C) 2018 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#pragma once + +#include + +#include "ErgoDoxScanner.h" + +#define HARDWARE_IMPLEMENTATION kaleidoscope::hardware::ErgoDox +#include "Kaleidoscope-HIDAdaptor-KeyboardioHID.h" + +#include "macro_helpers.h" + +struct cRGB { + uint8_t r, g, b; +}; + +#define COLS 6 +#define ROWS 14 +#define LED_COUNT 0 + +#define CRGB(r,g,b) (cRGB){b, g, r} + +namespace kaleidoscope { +namespace hardware { + +class ErgoDox { + public: + ErgoDox(void) {}; + + void syncLeds(void) {}; + void setCrgbAt(byte row, byte col, cRGB color) {}; + void setCrgbAt(uint8_t i, cRGB crgb) {}; + cRGB getCrgbAt(uint8_t i) { + return CRGB(0, 0, 0); + }; + + void scanMatrix(void); + void readMatrix(void); + void actOnMatrixScan(void); + void setup(); + + /* Key masking + * ----------- + * + * There are situations when one wants to ignore key events for a while, and + * mask them out. These functions help do that. In isolation, they do nothing, + * plugins and the core firmware is expected to make use of these. + * + * See `handleKeyswitchEvent` in the Kaleidoscope sources for a use-case. + */ + void maskKey(byte row, byte col); + void unMaskKey(byte row, byte col); + bool isKeyMasked(byte row, byte col); + + private: + static ErgoDoxScanner scanner_; + static uint8_t previousKeyState_[ROWS]; + static uint8_t keyState_[ROWS]; + static uint8_t masks_[ROWS]; +}; + +#define KEYMAP_STACKED( \ + /* left hand, spatial positions */ \ + k00,k01,k02,k03,k04,k05,k06, \ + k10,k11,k12,k13,k14,k15,k16, \ + k20,k21,k22,k23,k24,k25, \ + k30,k31,k32,k33,k34,k35,k36, \ + k40,k41,k42,k43,k44, \ + k55,k56, \ + k54, \ + k53,k52,k51, \ + \ + /* right hand, spatial positions */ \ + k07,k08,k09,k0A,k0B,k0C,k0D, \ + k17,k18,k19,k1A,k1B,k1C,k1D, \ + k28,k29,k2A,k2B,k2C,k2D, \ + k37,k38,k39,k3A,k3B,k3C,k3D, \ + k49,k4A,k4B,k4C,k4D, \ + k57,k58, \ + k59, \ + k5C,k5B,k5A ) \ + \ + /* matrix positions */ \ + { \ + { k00, k10, k20, k30, k40, XXX }, \ + { k01, k11, k21, k31, k41, k51 }, \ + { k02, k12, k22, k32, k42, k52 }, \ + { k03, k13, k23, k33, k43, k53 }, \ + { k04, k14, k24, k34, k44, k54 }, \ + { k05, k15, k25, k35, XXX, k55 }, \ + { k06, k16, XXX, k36, XXX, k56 }, \ + \ + { k07, k17, XXX, k37,XXX, k57 }, \ + { k08, k18, k28, k38,XXX, k58 }, \ + { k09, k19, k29, k39, k49, k59 }, \ + { k0A, k1A, k2A, k3A, k4A, k5A }, \ + { k0B, k1B, k2B, k3B, k4B, k5B }, \ + { k0C, k1C, k2C, k3C, k4C, k5C }, \ + { k0D, k1D, k2D, k3D, k4D, XXX } \ + } + +} +} diff --git a/src/kaleidoscope/hardware/ErgoDoxScanner.cpp b/src/kaleidoscope/hardware/ErgoDoxScanner.cpp new file mode 100644 index 00000000..5625e781 --- /dev/null +++ b/src/kaleidoscope/hardware/ErgoDoxScanner.cpp @@ -0,0 +1,184 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-Hardware-ErgoDox -- ErgoDox hardware support for Kaleidoscope + * Copyright (C) 2018 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#include "ErgoDoxScanner.h" +#include +#include "i2cmaster.h" + +#define I2C_ADDR 0b0100000 +#define I2C_ADDR_WRITE ( (I2C_ADDR<<1) | I2C_WRITE ) +#define I2C_ADDR_READ ( (I2C_ADDR<<1) | I2C_READ ) +#define IODIRA 0x00 +#define IODIRB 0x01 +#define GPPUA 0x0C +#define GPPUB 0x0D +#define GPIOA 0x12 +#define GPIOB 0x13 +#define OLATA 0x14 +#define OLATB 0x15 + +namespace kaleidoscope { +namespace hardware { + +uint8_t ErgoDoxScanner::initExpander() { + uint8_t status = 0x20; + + if (i2c_initialized_ == false) { + i2c_init(); + i2c_initialized_ = true; + _delay_ms(1000); + } + + status = i2c_start(I2C_ADDR_WRITE); + if (status) + goto out; + status = i2c_write(IODIRA); + if (status) + goto out; + status = i2c_write(0b00000000); + if (status) + goto out; + status = i2c_write(0b00111111); + if (status) + goto out; + + i2c_stop(); + + status = i2c_start(I2C_ADDR_WRITE); + if (status) + goto out; + status = i2c_write(GPPUA); + if (status) + goto out; + status = i2c_write(0b00000000); + if (status) + goto out; + status = i2c_write(0b00111111); + if (status) + goto out; + +out: + i2c_stop(); + + return status; +} + +void +ErgoDoxScanner::initCols() { + DDRF &= ~(1 << 7 | 1 << 6 | 1 << 5 | 1 << 4 | 1 << 1 | 1 << 0); + PORTF |= (1 << 7 | 1 << 6 | 1 << 5 | 1 << 4 | 1 << 1 | 1 << 0); +} + +void +ErgoDoxScanner::begin() { + expander_error_ = initExpander(); + + unselectRows(); + initCols(); +} + +void +ErgoDoxScanner::selectRow(int row) { + if (row < 7) { + if (!expander_error_) { + expander_error_ = i2c_start(I2C_ADDR_WRITE); + if (expander_error_) + goto out; + expander_error_ = i2c_write(GPIOA); + if (expander_error_) + goto out; + expander_error_ = i2c_write(0xFF & ~(1 << row)); + if (expander_error_) + goto out; +out: + i2c_stop(); + } + } else { + switch (row) { + case 7: + DDRB |= (1 << 0); + PORTB &= ~(1 << 0); + break; + case 8: + DDRB |= (1 << 1); + PORTB &= ~(1 << 1); + break; + case 9: + DDRB |= (1 << 2); + PORTB &= ~(1 << 2); + break; + case 10: + DDRB |= (1 << 3); + PORTB &= ~(1 << 3); + break; + case 11: + DDRD |= (1 << 2); + PORTD &= ~(1 << 3); + break; + case 12: + DDRD |= (1 << 3); + PORTD &= ~(1 << 3); + break; + case 13: + DDRC |= (1 << 6); + PORTC &= ~(1 << 6); + break; + } + } +} + +void +ErgoDoxScanner::unselectRows() { + DDRB &= ~(1 << 0 | 1 << 1 | 1 << 2 | 1 << 3); + PORTB &= ~(1 << 0 | 1 << 1 | 1 << 2 | 1 << 3); + DDRD &= ~(1 << 2 | 1 << 3); + PORTD &= ~(1 << 2 | 1 << 3); + DDRC &= ~(1 << 6); + PORTC &= ~(1 << 6); +} + +uint8_t +ErgoDoxScanner::readCols(int row) { + if (row < 7) { + if (expander_error_) { + return 0; + } + uint8_t data = 0; + + expander_error_ = i2c_start(I2C_ADDR_WRITE); + if (expander_error_) + goto out; + expander_error_ = i2c_write(GPIOB); + if (expander_error_) + goto out; + expander_error_ = i2c_start(I2C_ADDR_READ); + if (expander_error_) + goto out; + + data = i2c_readNak(); + data = ~data; +out: + i2c_stop(); + return data; + } else { + return (~((PINF & 0x03) | ((PINF & 0xF0) >> 2))) & ~0b11000000; + } +} + +} +} diff --git a/src/kaleidoscope/hardware/ErgoDoxScanner.h b/src/kaleidoscope/hardware/ErgoDoxScanner.h new file mode 100644 index 00000000..8f5eb001 --- /dev/null +++ b/src/kaleidoscope/hardware/ErgoDoxScanner.h @@ -0,0 +1,44 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-Hardware-ErgoDox -- ErgoDox hardware support for Kaleidoscope + * Copyright (C) 2018 Gergely Nagy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#pragma once + +#include + +namespace kaleidoscope { +namespace hardware { + +class ErgoDoxScanner { + public: + ErgoDoxScanner() {} + + void begin(); + void initCols(); + void selectRow(int row); + void unselectRows(); + uint8_t readCols(int row); + + private: + bool i2c_initialized_ = false; + uint8_t expander_error_ = 0x20; + + uint8_t initExpander(); +}; + +} +} diff --git a/src/kaleidoscope/hardware/i2cmaster.cpp b/src/kaleidoscope/hardware/i2cmaster.cpp new file mode 100644 index 00000000..267848c1 --- /dev/null +++ b/src/kaleidoscope/hardware/i2cmaster.cpp @@ -0,0 +1,198 @@ +/************************************************************************* +* Title: I2C master library using hardware TWI interface +* Author: Peter Fleury http://jump.to/fleury +* File: $Id: twimaster.c,v 1.3 2005/07/02 11:14:21 Peter Exp $ +* Software: AVR-GCC 3.4.3 / avr-libc 1.2.3 +* Target: any AVR device with hardware TWI +* Usage: API compatible with I2C Software Library i2cmaster.h +**************************************************************************/ +#include +#include + +#include "i2cmaster.h" + + +/* define CPU frequency in Mhz here if not defined in Makefile */ +#ifndef F_CPU +#define F_CPU 16000000UL +#endif + +/* I2C clock in Hz */ +#define SCL_CLOCK 400000L + + +/************************************************************************* + Initialization of the I2C bus interface. Need to be called only once +*************************************************************************/ +void i2c_init(void) { + /* initialize TWI clock + * minimal values in Bit Rate Register (TWBR) and minimal Prescaler + * bits in the TWI Status Register should give us maximal possible + * I2C bus speed - about 444 kHz + * + * for more details, see 20.5.2 in ATmega16/32 secification + */ + + TWSR = 0; /* no prescaler */ + TWBR = 10; /* must be >= 10 for stable operation */ + +}/* i2c_init */ + + +/************************************************************************* + Issues a start condition and sends address and transfer direction. + return 0 = device accessible, 1= failed to access device +*************************************************************************/ +unsigned char i2c_start(unsigned char address) { + uint8_t twst; + + // send START condition + TWCR = (1 << TWINT) | (1 << TWSTA) | (1 << TWEN); + + // wait until transmission completed + while (!(TWCR & (1 << TWINT))); + + // check value of TWI Status Register. Mask prescaler bits. + twst = TW_STATUS & 0xF8; + if ((twst != TW_START) && (twst != TW_REP_START)) return 1; + + // send device address + TWDR = address; + TWCR = (1 << TWINT) | (1 << TWEN); + + // wail until transmission completed and ACK/NACK has been received + while (!(TWCR & (1 << TWINT))); + + // check value of TWI Status Register. Mask prescaler bits. + twst = TW_STATUS & 0xF8; + if ((twst != TW_MT_SLA_ACK) && (twst != TW_MR_SLA_ACK)) return 1; + + return 0; + +}/* i2c_start */ + + +/************************************************************************* + Issues a start condition and sends address and transfer direction. + If device is busy, use ack polling to wait until device is ready + + Input: address and transfer direction of I2C device +*************************************************************************/ +void i2c_start_wait(unsigned char address) { + uint8_t twst; + + + while (1) { + // send START condition + TWCR = (1 << TWINT) | (1 << TWSTA) | (1 << TWEN); + + // wait until transmission completed + while (!(TWCR & (1 << TWINT))); + + // check value of TWI Status Register. Mask prescaler bits. + twst = TW_STATUS & 0xF8; + if ((twst != TW_START) && (twst != TW_REP_START)) continue; + + // send device address + TWDR = address; + TWCR = (1 << TWINT) | (1 << TWEN); + + // wail until transmission completed + while (!(TWCR & (1 << TWINT))); + + // check value of TWI Status Register. Mask prescaler bits. + twst = TW_STATUS & 0xF8; + if ((twst == TW_MT_SLA_NACK) || (twst == TW_MR_DATA_NACK)) { + /* device busy, send stop condition to terminate write operation */ + TWCR = (1 << TWINT) | (1 << TWEN) | (1 << TWSTO); + + // wait until stop condition is executed and bus released + while (TWCR & (1 << TWSTO)); + + continue; + } + //if( twst != TW_MT_SLA_ACK) return 1; + break; + } + +}/* i2c_start_wait */ + + +/************************************************************************* + Issues a repeated start condition and sends address and transfer direction + + Input: address and transfer direction of I2C device + + Return: 0 device accessible + 1 failed to access device +*************************************************************************/ +unsigned char i2c_rep_start(unsigned char address) { + return i2c_start(address); + +}/* i2c_rep_start */ + + +/************************************************************************* + Terminates the data transfer and releases the I2C bus +*************************************************************************/ +void i2c_stop(void) { + /* send stop condition */ + TWCR = (1 << TWINT) | (1 << TWEN) | (1 << TWSTO); + + // wait until stop condition is executed and bus released + while (TWCR & (1 << TWSTO)); + +}/* i2c_stop */ + + +/************************************************************************* + Send one byte to I2C device + + Input: byte to be transfered + Return: 0 write successful + 1 write failed +*************************************************************************/ +unsigned char i2c_write(unsigned char data) { + uint8_t twst; + + // send data to the previously addressed device + TWDR = data; + TWCR = (1 << TWINT) | (1 << TWEN); + + // wait until transmission completed + while (!(TWCR & (1 << TWINT))); + + // check value of TWI Status Register. Mask prescaler bits + twst = TW_STATUS & 0xF8; + if (twst != TW_MT_DATA_ACK) return 1; + return 0; + +}/* i2c_write */ + + +/************************************************************************* + Read one byte from the I2C device, request more data from device + + Return: byte read from I2C device +*************************************************************************/ +unsigned char i2c_readAck(void) { + TWCR = (1 << TWINT) | (1 << TWEN) | (1 << TWEA); + while (!(TWCR & (1 << TWINT))); + + return TWDR; + +}/* i2c_readAck */ + + +/************************************************************************* + Read one byte from the I2C device, read is followed by a stop condition + + Return: byte read from I2C device +*************************************************************************/ +unsigned char i2c_readNak(void) { + TWCR = (1 << TWINT) | (1 << TWEN); + while (!(TWCR & (1 << TWINT))); + + return TWDR; + +}/* i2c_readNak */ diff --git a/src/kaleidoscope/hardware/i2cmaster.h b/src/kaleidoscope/hardware/i2cmaster.h new file mode 100644 index 00000000..ec356876 --- /dev/null +++ b/src/kaleidoscope/hardware/i2cmaster.h @@ -0,0 +1,176 @@ +#pragma once +/************************************************************************* +* Title: C include file for the I2C master interface +* (i2cmaster.S or twimaster.c) +* Author: Peter Fleury http://jump.to/fleury +* File: $Id: i2cmaster.h,v 1.10 2005/03/06 22:39:57 Peter Exp $ +* Software: AVR-GCC 3.4.3 / avr-libc 1.2.3 +* Target: any AVR device +* Usage: see Doxygen manual +**************************************************************************/ + +#ifdef DOXYGEN +/** + @defgroup pfleury_ic2master I2C Master library + @code #include @endcode + + @brief I2C (TWI) Master Software Library + + Basic routines for communicating with I2C slave devices. This single master + implementation is limited to one bus master on the I2C bus. + + This I2c library is implemented as a compact assembler software implementation of the I2C protocol + which runs on any AVR (i2cmaster.S) and as a TWI hardware interface for all AVR with built-in TWI hardware (twimaster.c). + Since the API for these two implementations is exactly the same, an application can be linked either against the + software I2C implementation or the hardware I2C implementation. + + Use 4.7k pull-up resistor on the SDA and SCL pin. + + Adapt the SCL and SDA port and pin definitions and eventually the delay routine in the module + i2cmaster.S to your target when using the software I2C implementation ! + + Adjust the CPU clock frequence F_CPU in twimaster.c or in the Makfile when using the TWI hardware implementaion. + + @note + The module i2cmaster.S is based on the Atmel Application Note AVR300, corrected and adapted + to GNU assembler and AVR-GCC C call interface. + Replaced the incorrect quarter period delays found in AVR300 with + half period delays. + + @author Peter Fleury pfleury@gmx.ch http://jump.to/fleury + + @par API Usage Example + The following code shows typical usage of this library, see example test_i2cmaster.c + + @code + + #include + + + #define Dev24C02 0xA2 // device address of EEPROM 24C02, see datasheet + + int main(void) + { + unsigned char ret; + + i2c_init(); // initialize I2C library + + // write 0x75 to EEPROM address 5 (Byte Write) + i2c_start_wait(Dev24C02+I2C_WRITE); // set device address and write mode + i2c_write(0x05); // write address = 5 + i2c_write(0x75); // write value 0x75 to EEPROM + i2c_stop(); // set stop conditon = release bus + + + // read previously written value back from EEPROM address 5 + i2c_start_wait(Dev24C02+I2C_WRITE); // set device address and write mode + + i2c_write(0x05); // write address = 5 + i2c_rep_start(Dev24C02+I2C_READ); // set device address and read mode + + ret = i2c_readNak(); // read one byte from EEPROM + i2c_stop(); + + for(;;); + } + @endcode + +*/ +#endif /* DOXYGEN */ + +/**@{*/ + +#if (__GNUC__ * 100 + __GNUC_MINOR__) < 304 +#error "This library requires AVR-GCC 3.4 or later, update to newer AVR-GCC compiler !" +#endif + +#include + +/** defines the data direction (reading from I2C device) in i2c_start(),i2c_rep_start() */ +#define I2C_READ 1 + +/** defines the data direction (writing to I2C device) in i2c_start(),i2c_rep_start() */ +#define I2C_WRITE 0 + + +/** + @brief initialize the I2C master interace. Need to be called only once + @param void + @return none + */ +extern void i2c_init(void); + + +/** + @brief Terminates the data transfer and releases the I2C bus + @param void + @return none + */ +extern void i2c_stop(void); + + +/** + @brief Issues a start condition and sends address and transfer direction + + @param addr address and transfer direction of I2C device + @retval 0 device accessible + @retval 1 failed to access device + */ +extern unsigned char i2c_start(unsigned char addr); + + +/** + @brief Issues a repeated start condition and sends address and transfer direction + + @param addr address and transfer direction of I2C device + @retval 0 device accessible + @retval 1 failed to access device + */ +extern unsigned char i2c_rep_start(unsigned char addr); + + +/** + @brief Issues a start condition and sends address and transfer direction + + If device is busy, use ack polling to wait until device ready + @param addr address and transfer direction of I2C device + @return none + */ +extern void i2c_start_wait(unsigned char addr); + + +/** + @brief Send one byte to I2C device + @param data byte to be transfered + @retval 0 write successful + @retval 1 write failed + */ +extern unsigned char i2c_write(unsigned char data); + + +/** + @brief read one byte from the I2C device, request more data from device + @return byte read from I2C device + */ +extern unsigned char i2c_readAck(void); + +/** + @brief read one byte from the I2C device, read is followed by a stop condition + @return byte read from I2C device + */ +extern unsigned char i2c_readNak(void); + +/** + @brief read one byte from the I2C device + + Implemented as a macro, which calls either i2c_readAck or i2c_readNak + + @param ack 1 send ack, request more data from device
+ 0 send nak, read is followed by a stop condition + @return byte read from I2C device + */ +extern unsigned char i2c_read(unsigned char ack); +#define i2c_read(ack) (ack) ? i2c_readAck() : i2c_readNak(); + + +/**@}*/ From afa32312e04b59eab4a17261e5c932cbdac29ee0 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 18 May 2018 12:00:29 +0200 Subject: [PATCH 02/44] Make the ErgoDox symbol available The global `ErgoDox` symbol should be a shortcut, an alias, to KeyboardHardware. When using ErgoDox-specific functionality, `ErgoDox.someMethod()` is much clearer about that than `KeyboardHardware.someMethod()` would be. Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/ErgoDox.cpp | 1 + src/kaleidoscope/hardware/ErgoDox.h | 2 ++ 2 files changed, 3 insertions(+) diff --git a/src/kaleidoscope/hardware/ErgoDox.cpp b/src/kaleidoscope/hardware/ErgoDox.cpp index 1702b3f6..4bed81af 100644 --- a/src/kaleidoscope/hardware/ErgoDox.cpp +++ b/src/kaleidoscope/hardware/ErgoDox.cpp @@ -108,3 +108,4 @@ bool ErgoDox::isKeyMasked(byte row, byte col) { } HARDWARE_IMPLEMENTATION KeyboardHardware; +kaleidoscope::hardware::ErgoDox &ErgoDox = KeyboardHardware; diff --git a/src/kaleidoscope/hardware/ErgoDox.h b/src/kaleidoscope/hardware/ErgoDox.h index af119e68..18e974db 100644 --- a/src/kaleidoscope/hardware/ErgoDox.h +++ b/src/kaleidoscope/hardware/ErgoDox.h @@ -118,3 +118,5 @@ class ErgoDox { } } + +extern kaleidoscope::hardware::ErgoDox &ErgoDox; From bd913cde2bd473f2e91b6df3bc5307ae9366e0c2 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 18 May 2018 12:18:42 +0200 Subject: [PATCH 03/44] Add support for the status LEDs Fixes #2. Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/ErgoDox.cpp | 21 +++++++++++++++++++++ src/kaleidoscope/hardware/ErgoDox.h | 4 ++++ 2 files changed, 25 insertions(+) diff --git a/src/kaleidoscope/hardware/ErgoDox.cpp b/src/kaleidoscope/hardware/ErgoDox.cpp index 4bed81af..63c064aa 100644 --- a/src/kaleidoscope/hardware/ErgoDox.cpp +++ b/src/kaleidoscope/hardware/ErgoDox.cpp @@ -47,6 +47,10 @@ void ErgoDox::setup(void) { PORTE |= (1 << 6); scanner_.begin(); + + setStatusLEDBrightness(1, 15); + setStatusLEDBrightness(2, 15); + setStatusLEDBrightness(3, 15); } void ErgoDox::readMatrix() { @@ -104,6 +108,23 @@ bool ErgoDox::isKeyMasked(byte row, byte col) { return bitRead(masks_[row], col); } +// ErgoDox-specific stuff +void ErgoDox::setStatusLED(uint8_t led, bool state) { + if (state) { + DDRB |= (1 << (led + 4)); + PORTB |= (1 << (led + 4)); + } else { + DDRB &= ~(1 << (led + 4)); + PORTB &= ~(1 << (led + 4)); + } +} + +void ErgoDox::setStatusLEDBrightness(uint8_t led, uint8_t brightness) { + (led == 1) ? (OCR1A = brightness) : + (led == 2) ? (OCR1B = brightness) : + (OCR1C = brightness); +} + } } diff --git a/src/kaleidoscope/hardware/ErgoDox.h b/src/kaleidoscope/hardware/ErgoDox.h index 18e974db..553205f1 100644 --- a/src/kaleidoscope/hardware/ErgoDox.h +++ b/src/kaleidoscope/hardware/ErgoDox.h @@ -69,6 +69,10 @@ class ErgoDox { void unMaskKey(byte row, byte col); bool isKeyMasked(byte row, byte col); + // ErgoDox-specific stuff + void setStatusLED(uint8_t led, bool state = true); + void setStatusLEDBrightness(uint8_t led, uint8_t brightness); + private: static ErgoDoxScanner scanner_; static uint8_t previousKeyState_[ROWS]; From 39763abbb50107d77fa970603ad587bdf99e3b52 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 18 May 2018 17:38:14 +0200 Subject: [PATCH 04/44] Implement ErgoDox.resetDevice() Can be used to reset the device, and put it into programmable mode, from within the firmware. Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/ErgoDox.cpp | 33 +++++++++++++++++++++++++++ src/kaleidoscope/hardware/ErgoDox.h | 2 ++ 2 files changed, 35 insertions(+) diff --git a/src/kaleidoscope/hardware/ErgoDox.cpp b/src/kaleidoscope/hardware/ErgoDox.cpp index 63c064aa..6f99f899 100644 --- a/src/kaleidoscope/hardware/ErgoDox.cpp +++ b/src/kaleidoscope/hardware/ErgoDox.cpp @@ -125,6 +125,39 @@ void ErgoDox::setStatusLEDBrightness(uint8_t led, uint8_t brightness) { (OCR1C = brightness); } +void ErgoDox::resetDevice() { + cli(); + UDCON = 1; + USBCON = (1 << FRZCLK); + UCSR1B = 0; + _delay_ms(5); + + EIMSK = 0; + PCICR = 0; + SPCR = 0; + ACSR = 0; + EECR = 0; + ADCSRA = 0; + TIMSK0 = 0; + TIMSK1 = 0; + TIMSK3 = 0; + TIMSK4 = 0; + UCSR1B = 0; + TWCR = 0; + DDRB = 0; + DDRC = 0; + DDRD = 0; + DDRE = 0; + DDRF = 0; + TWCR = 0; + PORTB = 0; + PORTC = 0; + PORTD = 0; + PORTE = 0; + PORTF = 0; + asm volatile("jmp 0x7E00"); +} + } } diff --git a/src/kaleidoscope/hardware/ErgoDox.h b/src/kaleidoscope/hardware/ErgoDox.h index 553205f1..6b7500ed 100644 --- a/src/kaleidoscope/hardware/ErgoDox.h +++ b/src/kaleidoscope/hardware/ErgoDox.h @@ -73,6 +73,8 @@ class ErgoDox { void setStatusLED(uint8_t led, bool state = true); void setStatusLEDBrightness(uint8_t led, uint8_t brightness); + void resetDevice(); + private: static ErgoDoxScanner scanner_; static uint8_t previousKeyState_[ROWS]; From 12ed823c2d71eb6b32f0e9e3550201c081912e66 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 18 May 2018 17:42:54 +0200 Subject: [PATCH 05/44] Don't call the keyswitch event handler when idle Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/ErgoDox.cpp | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/kaleidoscope/hardware/ErgoDox.cpp b/src/kaleidoscope/hardware/ErgoDox.cpp index 6f99f899..2b2d0ed3 100644 --- a/src/kaleidoscope/hardware/ErgoDox.cpp +++ b/src/kaleidoscope/hardware/ErgoDox.cpp @@ -77,7 +77,8 @@ void ErgoDox::actOnMatrixScan() { for (byte col = 0; col < COLS; col++) { uint8_t keyState = (bitRead(previousKeyState_[row], col) << 0) | (bitRead(keyState_[row], col) << 1); - handleKeyswitchEvent(Key_NoKey, row, col, keyState); + if (keyState) + handleKeyswitchEvent(Key_NoKey, row, col, keyState); } } } From 596d3cf12ee23aec40a8f3614356b38ffa29fe5d Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 18 May 2018 18:06:46 +0200 Subject: [PATCH 06/44] Implement debouncing This adds a very simple debouncing algorithm for debouncing. It works by making sure a key is not changing state more than a configurable amount of cycles. Defaults to five cycles for now. Fixes #1. Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/ErgoDox.cpp | 49 +++++++++++++++++++++------ src/kaleidoscope/hardware/ErgoDox.h | 7 ++++ 2 files changed, 45 insertions(+), 11 deletions(-) diff --git a/src/kaleidoscope/hardware/ErgoDox.cpp b/src/kaleidoscope/hardware/ErgoDox.cpp index 2b2d0ed3..89ec936b 100644 --- a/src/kaleidoscope/hardware/ErgoDox.cpp +++ b/src/kaleidoscope/hardware/ErgoDox.cpp @@ -28,6 +28,8 @@ ErgoDoxScanner ErgoDox::scanner_; uint8_t ErgoDox::previousKeyState_[ROWS]; uint8_t ErgoDox::keyState_[ROWS]; uint8_t ErgoDox::masks_[ROWS]; +uint8_t ErgoDox::debounce_matrix_[ROWS][COLS]; +uint8_t ErgoDox::debounce = 5; void ErgoDox::setup(void) { wdt_disable(); @@ -53,20 +55,23 @@ void ErgoDox::setup(void) { setStatusLEDBrightness(3, 15); } -void ErgoDox::readMatrix() { - for (uint8_t i = 0; i < ROWS / 2; i++) { - scanner_.selectRow(i); - scanner_.selectRow(i + ROWS / 2); +void ErgoDox::readMatrixRow(uint8_t row) { + uint8_t mask, cols; - // TODO(algernon): debouncing + previousKeyState_[row] = keyState_[row]; + mask = debounceMaskForRow(row); + cols = (scanner_.readCols(row) & mask) | (keyState_[row] & ~mask); + debounceRow(cols ^ keyState_[row], row); + keyState_[row] = cols; +} - // left side - previousKeyState_[i] = keyState_[i]; - keyState_[i] = scanner_.readCols(i); +void ErgoDox::readMatrix() { + for (uint8_t row = 0; row < ROWS / 2; row++) { + scanner_.selectRow(row); + scanner_.selectRow(row + ROWS / 2); - // right side - previousKeyState_[i + ROWS / 2] = keyState_[i + ROWS / 2]; - keyState_[i + ROWS / 2] = scanner_.readCols(i + ROWS / 2); + readMatrixRow(row); + readMatrixRow(row + ROWS / 2); scanner_.unselectRows(); } @@ -159,6 +164,28 @@ void ErgoDox::resetDevice() { asm volatile("jmp 0x7E00"); } + +uint8_t ErgoDox::debounceMaskForRow(uint8_t row) { + uint8_t result = 0; + + for (uint8_t c = 0; c < COLS; ++c) { + if (debounce_matrix_[row][c]) { + --debounce_matrix_[row][c]; + } else { + result |= (1 << c); + } + } + return result; +} + +void ErgoDox::debounceRow(uint8_t change, uint8_t row) { + for (uint8_t i = 0; i < COLS; ++i) { + if (change & (1 << i)) { + debounce_matrix_[row][i] = debounce; + } + } +} + } } diff --git a/src/kaleidoscope/hardware/ErgoDox.h b/src/kaleidoscope/hardware/ErgoDox.h index 6b7500ed..42a65df4 100644 --- a/src/kaleidoscope/hardware/ErgoDox.h +++ b/src/kaleidoscope/hardware/ErgoDox.h @@ -75,11 +75,18 @@ class ErgoDox { void resetDevice(); + static uint8_t debounce; + private: static ErgoDoxScanner scanner_; static uint8_t previousKeyState_[ROWS]; static uint8_t keyState_[ROWS]; static uint8_t masks_[ROWS]; + static uint8_t debounce_matrix_[ROWS][COLS]; + + static uint8_t debounceMaskForRow(uint8_t row); + static void debounceRow(uint8_t change, uint8_t row); + static void readMatrixRow(uint8_t row); }; #define KEYMAP_STACKED( \ From 02ae51de6e6d16116ce30df1afca2f02d8358c7d Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 18 May 2018 20:37:59 +0200 Subject: [PATCH 07/44] extras/boards.txt: Disable the V1 plugin API by default As this is a new port, there is little sense in supporting the legacy API. Disable it for some nice space savings! Signed-off-by: Gergely Nagy --- extras/boards.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/extras/boards.txt b/extras/boards.txt index 9efcb1ec..cf99400a 100644 --- a/extras/boards.txt +++ b/extras/boards.txt @@ -20,4 +20,4 @@ ergodox.build.usb_manufacturer="ErgoDox EZ" ergodox.build.board=AVR_ERGODOX ergodox.build.core=arduino:arduino ergodox.build.variant=ergodox -ergodox.build.extra_flags={build.usb_flags} '-DKALEIDOSCOPE_HARDWARE_H="Kaleidoscope-Hardware-ErgoDox.h"' +ergodox.build.extra_flags={build.usb_flags} '-DKALEIDOSCOPE_HARDWARE_H="Kaleidoscope-Hardware-ErgoDox.h"' '-DKALEIDOSCOPE_ENABLE_V1_PLUGIN_API=0' From 831d1df057c0ea066314159c5110300c4344826a Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 18 May 2018 23:52:23 +0200 Subject: [PATCH 08/44] Credit QMK, where a big part of this comes from Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/ErgoDox.cpp | 2 ++ src/kaleidoscope/hardware/ErgoDox.h | 2 ++ src/kaleidoscope/hardware/ErgoDoxScanner.cpp | 2 ++ src/kaleidoscope/hardware/ErgoDoxScanner.h | 2 ++ 4 files changed, 8 insertions(+) diff --git a/src/kaleidoscope/hardware/ErgoDox.cpp b/src/kaleidoscope/hardware/ErgoDox.cpp index 89ec936b..4fc99e77 100644 --- a/src/kaleidoscope/hardware/ErgoDox.cpp +++ b/src/kaleidoscope/hardware/ErgoDox.cpp @@ -2,6 +2,8 @@ * Kaleidoscope-Hardware-ErgoDox -- ErgoDox hardware support for Kaleidoscope * Copyright (C) 2018 Gergely Nagy * + * Based on QMK, which is (C) Jack Humbert, Erez Zukerman, et al. + * * 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 diff --git a/src/kaleidoscope/hardware/ErgoDox.h b/src/kaleidoscope/hardware/ErgoDox.h index 42a65df4..0d0ddcc3 100644 --- a/src/kaleidoscope/hardware/ErgoDox.h +++ b/src/kaleidoscope/hardware/ErgoDox.h @@ -2,6 +2,8 @@ * Kaleidoscope-Hardware-ErgoDox -- ErgoDox hardware support for Kaleidoscope * Copyright (C) 2018 Gergely Nagy * + * Based on QMK, which is (C) Jack Humbert, Erez Zukerman, et al. + * * 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 diff --git a/src/kaleidoscope/hardware/ErgoDoxScanner.cpp b/src/kaleidoscope/hardware/ErgoDoxScanner.cpp index 5625e781..20d7519f 100644 --- a/src/kaleidoscope/hardware/ErgoDoxScanner.cpp +++ b/src/kaleidoscope/hardware/ErgoDoxScanner.cpp @@ -2,6 +2,8 @@ * Kaleidoscope-Hardware-ErgoDox -- ErgoDox hardware support for Kaleidoscope * Copyright (C) 2018 Gergely Nagy * + * Based on QMK, which is (C) Jack Humbert, Erez Zukerman, et al. + * * 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 diff --git a/src/kaleidoscope/hardware/ErgoDoxScanner.h b/src/kaleidoscope/hardware/ErgoDoxScanner.h index 8f5eb001..457906ae 100644 --- a/src/kaleidoscope/hardware/ErgoDoxScanner.h +++ b/src/kaleidoscope/hardware/ErgoDoxScanner.h @@ -2,6 +2,8 @@ * Kaleidoscope-Hardware-ErgoDox -- ErgoDox hardware support for Kaleidoscope * Copyright (C) 2018 Gergely Nagy * + * Based on QMK, which is (C) Jack Humbert, Erez Zukerman, et al. + * * 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 From e8c0ea7247cea596c6d84223af17b03bbb0faf75 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 19 May 2018 00:00:22 +0200 Subject: [PATCH 09/44] Add flashing functions to .kaleidoscope-builder.conf Signed-off-by: Gergely Nagy --- .kaleidoscope-builder.conf | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/.kaleidoscope-builder.conf b/.kaleidoscope-builder.conf index a0681b9b..8ce70f95 100644 --- a/.kaleidoscope-builder.conf +++ b/.kaleidoscope-builder.conf @@ -1,2 +1,24 @@ +flash_over_usb() { + sleep 1s + + echo "Please reset your keyboard!" + teensy_loader_cli --mcu "${MCU}" -w "${HEX_FILE_PATH}" +} + +flash () { + prepare_to_flash + + # This is defined in the (optional) user config. + # shellcheck disable=SC2154 + ${preFlash_HOOKS} + + flash_over_usb || flash_over_usb + + # This is defined in the (optional) user config. + # shellcheck disable=SC2154 + ${postFlash_HOOKS} +} + +NO_RESET=1 DEFAULT_SKETCH="ErgoDox" BOARD="ergodox" From 51f3d94cff06724738cfededff66eb897a48b535 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 19 May 2018 00:11:41 +0200 Subject: [PATCH 10/44] Another copyright & credits update Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/ErgoDox.cpp | 8 +++++++- src/kaleidoscope/hardware/ErgoDox.h | 7 ++++++- src/kaleidoscope/hardware/ErgoDoxScanner.cpp | 7 ++++++- src/kaleidoscope/hardware/ErgoDoxScanner.h | 7 ++++++- 4 files changed, 25 insertions(+), 4 deletions(-) diff --git a/src/kaleidoscope/hardware/ErgoDox.cpp b/src/kaleidoscope/hardware/ErgoDox.cpp index 4fc99e77..bf5ac8a0 100644 --- a/src/kaleidoscope/hardware/ErgoDox.cpp +++ b/src/kaleidoscope/hardware/ErgoDox.cpp @@ -2,7 +2,13 @@ * Kaleidoscope-Hardware-ErgoDox -- ErgoDox hardware support for Kaleidoscope * Copyright (C) 2018 Gergely Nagy * - * Based on QMK, which is (C) Jack Humbert, Erez Zukerman, et al. + * Based on QMK (commit 8cdb4a915) + * (C) Jack Humbert, Erez Zukerman, Oleg Kostyuk + * Original QMK sources: + * - keyboards/ergodox_ez/ergodox_ez.c + * - keyboards/ergodox_ez/ergodox_ez.h + * - keyboards/ergodox_ez/matrix.c + * - tmk_core/common/avr/bootloader.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 diff --git a/src/kaleidoscope/hardware/ErgoDox.h b/src/kaleidoscope/hardware/ErgoDox.h index 0d0ddcc3..8e04e6c5 100644 --- a/src/kaleidoscope/hardware/ErgoDox.h +++ b/src/kaleidoscope/hardware/ErgoDox.h @@ -2,7 +2,12 @@ * Kaleidoscope-Hardware-ErgoDox -- ErgoDox hardware support for Kaleidoscope * Copyright (C) 2018 Gergely Nagy * - * Based on QMK, which is (C) Jack Humbert, Erez Zukerman, et al. + * Based on QMK (commit 8cdb4a915) + * (C) Jack Humbert, Erez Zukerman, Oleg Kostyuk + * Original QMK sources: + * - keyboards/ergodox_ez/ergodox_ez.c + * - keyboards/ergodox_ez/ergodox_ez.h + * - keyboards/ergodox_ez/matrix.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 diff --git a/src/kaleidoscope/hardware/ErgoDoxScanner.cpp b/src/kaleidoscope/hardware/ErgoDoxScanner.cpp index 20d7519f..c5e0e8f4 100644 --- a/src/kaleidoscope/hardware/ErgoDoxScanner.cpp +++ b/src/kaleidoscope/hardware/ErgoDoxScanner.cpp @@ -2,7 +2,12 @@ * Kaleidoscope-Hardware-ErgoDox -- ErgoDox hardware support for Kaleidoscope * Copyright (C) 2018 Gergely Nagy * - * Based on QMK, which is (C) Jack Humbert, Erez Zukerman, et al. + * Based on QMK (commit 8cdb4a915) + * (C) Jack Humbert, Erez Zukerman, Oleg Kostyuk + * Original QMK sources: + * - keyboards/ergodox_ez/ergodox_ez.c + * - keyboards/ergodox_ez/ergodox_ez.h + * - keyboards/ergodox_ez/matrix.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 diff --git a/src/kaleidoscope/hardware/ErgoDoxScanner.h b/src/kaleidoscope/hardware/ErgoDoxScanner.h index 457906ae..86fdcbd7 100644 --- a/src/kaleidoscope/hardware/ErgoDoxScanner.h +++ b/src/kaleidoscope/hardware/ErgoDoxScanner.h @@ -2,7 +2,12 @@ * Kaleidoscope-Hardware-ErgoDox -- ErgoDox hardware support for Kaleidoscope * Copyright (C) 2018 Gergely Nagy * - * Based on QMK, which is (C) Jack Humbert, Erez Zukerman, et al. + * Based on QMK (commit 8cdb4a915) + * (C) Jack Humbert, Erez Zukerman, Oleg Kostyuk + * Original QMK sources: + * - keyboards/ergodox_ez/ergodox_ez.c + * - keyboards/ergodox_ez/ergodox_ez.h + * - keyboards/ergodox_ez/matrix.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 From d76987edffcba4b80321e52c16be551e2a22277f Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 19 May 2018 00:33:45 +0200 Subject: [PATCH 11/44] Renamed the library to Kaleidoscope-Hardware-EZ-ErgoDox Signed-off-by: Gergely Nagy --- library.properties | 4 ++-- ...-Hardware-ErgoDox.h => Kaleidoscope-Hardware-EZ-ErgoDox.h} | 2 +- src/kaleidoscope/hardware/ErgoDox.cpp | 2 +- src/kaleidoscope/hardware/ErgoDox.h | 2 +- src/kaleidoscope/hardware/ErgoDoxScanner.cpp | 2 +- src/kaleidoscope/hardware/ErgoDoxScanner.h | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) rename src/{Kaleidoscope-Hardware-ErgoDox.h => Kaleidoscope-Hardware-EZ-ErgoDox.h} (90%) diff --git a/library.properties b/library.properties index 3352b150..068dab6c 100644 --- a/library.properties +++ b/library.properties @@ -1,9 +1,9 @@ -name=Kaleidoscope-Hardware-ErgoDox +name=Kaleidoscope-Hardware-EZ-ErgoDox version=0.0.1 author=Gergely Nagy maintainer=Gergely Nagy sentence=ErgoDox Hardware support for Kaleidoscope. paragraph=... category=Communication -url=https://github.com/keyboardio/Kaleidoscope-Hardware-ErgoDox +url=https://github.com/keyboardio/Kaleidoscope-Hardware-EZ-ErgoDox architectures=avr diff --git a/src/Kaleidoscope-Hardware-ErgoDox.h b/src/Kaleidoscope-Hardware-EZ-ErgoDox.h similarity index 90% rename from src/Kaleidoscope-Hardware-ErgoDox.h rename to src/Kaleidoscope-Hardware-EZ-ErgoDox.h index 235fd029..a7e7ab65 100644 --- a/src/Kaleidoscope-Hardware-ErgoDox.h +++ b/src/Kaleidoscope-Hardware-EZ-ErgoDox.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Kaleidoscope-Hardware-ErgoDox -- ErgoDox hardware support for Kaleidoscope + * Kaleidoscope-Hardware-EZ-ErgoDox -- ErgoDox hardware support for Kaleidoscope * Copyright (C) 2018 Gergely Nagy * * This program is free software: you can redistribute it and/or modify diff --git a/src/kaleidoscope/hardware/ErgoDox.cpp b/src/kaleidoscope/hardware/ErgoDox.cpp index bf5ac8a0..1a7acf5a 100644 --- a/src/kaleidoscope/hardware/ErgoDox.cpp +++ b/src/kaleidoscope/hardware/ErgoDox.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Kaleidoscope-Hardware-ErgoDox -- ErgoDox hardware support for Kaleidoscope + * Kaleidoscope-Hardware-EZ-ErgoDox -- ErgoDox hardware support for Kaleidoscope * Copyright (C) 2018 Gergely Nagy * * Based on QMK (commit 8cdb4a915) diff --git a/src/kaleidoscope/hardware/ErgoDox.h b/src/kaleidoscope/hardware/ErgoDox.h index 8e04e6c5..f9d7ae7c 100644 --- a/src/kaleidoscope/hardware/ErgoDox.h +++ b/src/kaleidoscope/hardware/ErgoDox.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Kaleidoscope-Hardware-ErgoDox -- ErgoDox hardware support for Kaleidoscope + * Kaleidoscope-Hardware-EZ-ErgoDox -- ErgoDox hardware support for Kaleidoscope * Copyright (C) 2018 Gergely Nagy * * Based on QMK (commit 8cdb4a915) diff --git a/src/kaleidoscope/hardware/ErgoDoxScanner.cpp b/src/kaleidoscope/hardware/ErgoDoxScanner.cpp index c5e0e8f4..2db4c139 100644 --- a/src/kaleidoscope/hardware/ErgoDoxScanner.cpp +++ b/src/kaleidoscope/hardware/ErgoDoxScanner.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Kaleidoscope-Hardware-ErgoDox -- ErgoDox hardware support for Kaleidoscope + * Kaleidoscope-Hardware-EZ-ErgoDox -- ErgoDox hardware support for Kaleidoscope * Copyright (C) 2018 Gergely Nagy * * Based on QMK (commit 8cdb4a915) diff --git a/src/kaleidoscope/hardware/ErgoDoxScanner.h b/src/kaleidoscope/hardware/ErgoDoxScanner.h index 86fdcbd7..42302955 100644 --- a/src/kaleidoscope/hardware/ErgoDoxScanner.h +++ b/src/kaleidoscope/hardware/ErgoDoxScanner.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Kaleidoscope-Hardware-ErgoDox -- ErgoDox hardware support for Kaleidoscope + * Kaleidoscope-Hardware-EZ-ErgoDox -- ErgoDox hardware support for Kaleidoscope * Copyright (C) 2018 Gergely Nagy * * Based on QMK (commit 8cdb4a915) From d869a8dacea159d4df9ec0bf30660afed131e78f Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 19 May 2018 00:34:31 +0200 Subject: [PATCH 12/44] Drop the extras We are going into Arduino-Boards (at least for now). Signed-off-by: Gergely Nagy --- .travis.yml | 3 - extras/boards.txt | 23 -- extras/platform.txt | 7 - extras/variants/ergodox/pins_arduino.h | 385 ------------------------- 4 files changed, 418 deletions(-) delete mode 100644 extras/boards.txt delete mode 100644 extras/platform.txt delete mode 100644 extras/variants/ergodox/pins_arduino.h diff --git a/.travis.yml b/.travis.yml index bbd83bf0..719b82ed 100644 --- a/.travis.yml +++ b/.travis.yml @@ -4,9 +4,6 @@ os: - linux install: - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Arduino-Boards hardware/keyboardio/avr - - cat extras/boards.txt >>hardware/keyboardio/avr/boards.txt - - cat extras/platform.txt >>hardware/keyboardio/avr/platform.txt - - cp -pr extras/variants/ergodox hardware/keyboardio/avr/variants/ script: - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware notifications: diff --git a/extras/boards.txt b/extras/boards.txt deleted file mode 100644 index cf99400a..00000000 --- a/extras/boards.txt +++ /dev/null @@ -1,23 +0,0 @@ -## These should be appended to hardware/keyboardio/avr/boards.txt - -############################################################## - -ergodox.name=ErgoDox -ergodox.vid.0=0xfeed -ergodox.pid.0=0x1307 - -ergodox.upload.tool=teensy_loader_cli -ergodox.upload.protocol=halfkay -ergodox.upload.maximum_size=32256 -ergodox.upload.maximum_data_size=2560 - -ergodox.build.mcu=atmega32u4 -ergodox.build.f_cpu=16000000L -ergodox.build.vid=0xfeed -ergodox.build.pid=0x1307 -ergodox.build.usb_product="ErgoDox EZ" -ergodox.build.usb_manufacturer="ErgoDox EZ" -ergodox.build.board=AVR_ERGODOX -ergodox.build.core=arduino:arduino -ergodox.build.variant=ergodox -ergodox.build.extra_flags={build.usb_flags} '-DKALEIDOSCOPE_HARDWARE_H="Kaleidoscope-Hardware-ErgoDox.h"' '-DKALEIDOSCOPE_ENABLE_V1_PLUGIN_API=0' diff --git a/extras/platform.txt b/extras/platform.txt deleted file mode 100644 index b2102d0e..00000000 --- a/extras/platform.txt +++ /dev/null @@ -1,7 +0,0 @@ -## These should be appended to hardware/keyboardio/platform.txt - -tools.teensy_loader_cli.cmd.path=teensy_loader_cli -tools.teensy_loader_cli.upload.params.verbose=-v -tools.teensy_loader_cli.upload.params.quiet= -tools.teensy_loader_cli.upload.noverify= -tools.teensy_loader_cli.upload.pattern="{cmd.path}" {upload.verbose} --mcu=atmega32u4 -w -v "{build.path}/{build.project_name}.hex" diff --git a/extras/variants/ergodox/pins_arduino.h b/extras/variants/ergodox/pins_arduino.h deleted file mode 100644 index 609b7636..00000000 --- a/extras/variants/ergodox/pins_arduino.h +++ /dev/null @@ -1,385 +0,0 @@ -/* - - Based on pins_arduino.h for the Arduino Leonardo as of Arduino 1.6.10 - - pins_arduino.h - Pin definition functions for Arduino - Part of Arduino - http://www.arduino.cc/ - - Copyright (c) 2007 David A. Mellis - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library 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 - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General - Public License along with this library; if not, write to the - Free Software Foundation, Inc., 59 Temple Place, Suite 330, - Boston, MA 02111-1307 USA -*/ - -#ifndef Pins_Arduino_h -#define Pins_Arduino_h - -#include - -// Workaround for wrong definitions in "iom32u4.h". -// This should be fixed in the AVR toolchain. -#undef UHCON -#undef UHINT -#undef UHIEN -#undef UHADDR -#undef UHFNUM -#undef UHFNUML -#undef UHFNUMH -#undef UHFLEN -#undef UPINRQX -#undef UPINTX -#undef UPNUM -#undef UPRST -#undef UPCONX -#undef UPCFG0X -#undef UPCFG1X -#undef UPSTAX -#undef UPCFG2X -#undef UPIENX -#undef UPDATX -#undef TCCR2A -#undef WGM20 -#undef WGM21 -#undef COM2B0 -#undef COM2B1 -#undef COM2A0 -#undef COM2A1 -#undef TCCR2B -#undef CS20 -#undef CS21 -#undef CS22 -#undef WGM22 -#undef FOC2B -#undef FOC2A -#undef TCNT2 -#undef TCNT2_0 -#undef TCNT2_1 -#undef TCNT2_2 -#undef TCNT2_3 -#undef TCNT2_4 -#undef TCNT2_5 -#undef TCNT2_6 -#undef TCNT2_7 -#undef OCR2A -#undef OCR2_0 -#undef OCR2_1 -#undef OCR2_2 -#undef OCR2_3 -#undef OCR2_4 -#undef OCR2_5 -#undef OCR2_6 -#undef OCR2_7 -#undef OCR2B -#undef OCR2_0 -#undef OCR2_1 -#undef OCR2_2 -#undef OCR2_3 -#undef OCR2_4 -#undef OCR2_5 -#undef OCR2_6 -#undef OCR2_7 - -#define NUM_DIGITAL_PINS 31 -#define NUM_ANALOG_INPUTS 12 - -#define TX_RX_LED_INIT DDRD |= (1<<5), DDRB |= (1<<0) -/* - -// The only way to get the Arduino core to not light up the RX and TX LEDS -// on every USB packet is to define these to noops - -#define TXLED1 PORTD |= (1<<5) -#define TXLED0 PORTD &= ~(1<<5) -#define RXLED1 PORTB |= (1<<0) -#define RXLED0 PORTB &= ~(1<<0) - -*/ - -#define TXLED1 ((void)0) -#define TXLED0 ((void)0) -#define RXLED1 ((void)0) -#define RXLED0 ((void)0) - - -static const uint8_t SDA = 2; -static const uint8_t SCL = 3; -#define LED_BUILTIN 17 -#define LED_BUILTIN_RX 17 -#define LED_BUILTIN_TX 30 - -// Map SPI port to 'new' pins D14..D17 -static const uint8_t SS = 17; -static const uint8_t MOSI = 16; -static const uint8_t MISO = 14; -static const uint8_t SCK = 15; - -// Mapping of analog pins as digital I/O -// A6-A11 share with digital pins -static const uint8_t A0 = 18; -static const uint8_t A1 = 19; -static const uint8_t A2 = 20; -static const uint8_t A3 = 21; -static const uint8_t A4 = 22; -static const uint8_t A5 = 23; -static const uint8_t A6 = 24; // D4 -static const uint8_t A7 = 25; // D6 -static const uint8_t A8 = 26; // D8 -static const uint8_t A9 = 27; // D9 -static const uint8_t A10 = 28; // D10 -static const uint8_t A11 = 29; // D12 - -#define digitalPinToPCICR(p) ((((p) >= 8 && (p) <= 11) || ((p) >= 14 && (p) <= 17) || ((p) >= A8 && (p) <= A10)) ? (&PCICR) : ((uint8_t *)0)) -#define digitalPinToPCICRbit(p) 0 -#define digitalPinToPCMSK(p) ((((p) >= 8 && (p) <= 11) || ((p) >= 14 && (p) <= 17) || ((p) >= A8 && (p) <= A10)) ? (&PCMSK0) : ((uint8_t *)0)) -#define digitalPinToPCMSKbit(p) ( ((p) >= 8 && (p) <= 11) ? (p) - 4 : ((p) == 14 ? 3 : ((p) == 15 ? 1 : ((p) == 16 ? 2 : ((p) == 17 ? 0 : (p - A8 + 4)))))) - -// __AVR_ATmega32U4__ has an unusual mapping of pins to channels -extern const uint8_t PROGMEM analog_pin_to_channel_PGM[]; -#define analogPinToChannel(P) ( pgm_read_byte( analog_pin_to_channel_PGM + (P) ) ) - -#define digitalPinHasPWM(p) ((p) == 3 || (p) == 5 || (p) == 6 || (p) == 9 || (p) == 10 || (p) == 11 || (p) == 13) - -#define digitalPinToInterrupt(p) ((p) == 0 ? 2 : ((p) == 1 ? 3 : ((p) == 2 ? 1 : ((p) == 3 ? 0 : ((p) == 7 ? 4 : NOT_AN_INTERRUPT))))) - -#ifdef ARDUINO_MAIN - -// On the Arduino board, digital pins are also used -// for the analog output (software PWM). Analog input -// pins are a separate set. - -// ATMEL ATMEGA32U4 / ARDUINO LEONARDO -// -// D0 PD2 RXD1/INT2 -// D1 PD3 TXD1/INT3 -// D2 PD1 SDA SDA/INT1 -// D3# PD0 PWM8/SCL OC0B/SCL/INT0 -// D4 A6 PD4 ADC8 -// D5# PC6 ??? OC3A/#OC4A -// D6# A7 PD7 FastPWM #OC4D/ADC10 -// D7 PE6 INT6/AIN0 -// -// D8 A8 PB4 ADC11/PCINT4 -// D9# A9 PB5 PWM16 OC1A/#OC4B/ADC12/PCINT5 -// D10# A10 PB6 PWM16 OC1B/0c4B/ADC13/PCINT6 -// D11# PB7 PWM8/16 0C0A/OC1C/#RTS/PCINT7 -// D12 A11 PD6 T1/#OC4D/ADC9 -// D13# PC7 PWM10 CLK0/OC4A -// -// A0 D18 PF7 ADC7 -// A1 D19 PF6 ADC6 -// A2 D20 PF5 ADC5 -// A3 D21 PF4 ADC4 -// A4 D22 PF1 ADC1 -// A5 D23 PF0 ADC0 -// -// New pins D14..D17 to map SPI port to digital pins -// -// MISO D14 PB3 MISO,PCINT3 -// SCK D15 PB1 SCK,PCINT1 -// MOSI D16 PB2 MOSI,PCINT2 -// SS D17 PB0 RXLED,SS/PCINT0 -// -// TXLED D30 PD5 XCK1 -// RXLED D17 PB0 -// HWB PE2 HWB - -// these arrays map port names (e.g. port B) to the -// appropriate addresses for various functions (e.g. reading -// and writing) -const uint16_t PROGMEM port_to_mode_PGM[] = { - NOT_A_PORT, - NOT_A_PORT, - (uint16_t) &DDRB, - (uint16_t) &DDRC, - (uint16_t) &DDRD, - (uint16_t) &DDRE, - (uint16_t) &DDRF, -}; - -const uint16_t PROGMEM port_to_output_PGM[] = { - NOT_A_PORT, - NOT_A_PORT, - (uint16_t) &PORTB, - (uint16_t) &PORTC, - (uint16_t) &PORTD, - (uint16_t) &PORTE, - (uint16_t) &PORTF, -}; - -const uint16_t PROGMEM port_to_input_PGM[] = { - NOT_A_PORT, - NOT_A_PORT, - (uint16_t) &PINB, - (uint16_t) &PINC, - (uint16_t) &PIND, - (uint16_t) &PINE, - (uint16_t) &PINF, -}; - -const uint8_t PROGMEM digital_pin_to_port_PGM[] = { - PD, // D0 - PD2 - PD, // D1 - PD3 - PD, // D2 - PD1 - PD, // D3 - PD0 - PD, // D4 - PD4 - PC, // D5 - PC6 - PD, // D6 - PD7 - PE, // D7 - PE6 - - PB, // D8 - PB4 - PB, // D9 - PB5 - PB, // D10 - PB6 - PB, // D11 - PB7 - PD, // D12 - PD6 - PC, // D13 - PC7 - - PB, // D14 - MISO - PB3 - PB, // D15 - SCK - PB1 - PB, // D16 - MOSI - PB2 - PB, // D17 - SS - PB0 - - PF, // D18 - A0 - PF7 - PF, // D19 - A1 - PF6 - PF, // D20 - A2 - PF5 - PF, // D21 - A3 - PF4 - PF, // D22 - A4 - PF1 - PF, // D23 - A5 - PF0 - - PD, // D24 / D4 - A6 - PD4 - PD, // D25 / D6 - A7 - PD7 - PB, // D26 / D8 - A8 - PB4 - PB, // D27 / D9 - A9 - PB5 - PB, // D28 / D10 - A10 - PB6 - PD, // D29 / D12 - A11 - PD6 - PD, // D30 / TX Led - PD5 -}; - -const uint8_t PROGMEM digital_pin_to_bit_mask_PGM[] = { - _BV(2), // D0 - PD2 - _BV(3), // D1 - PD3 - _BV(1), // D2 - PD1 - _BV(0), // D3 - PD0 - _BV(4), // D4 - PD4 - _BV(6), // D5 - PC6 - _BV(7), // D6 - PD7 - _BV(6), // D7 - PE6 - - _BV(4), // D8 - PB4 - _BV(5), // D9 - PB5 - _BV(6), // D10 - PB6 - _BV(7), // D11 - PB7 - _BV(6), // D12 - PD6 - _BV(7), // D13 - PC7 - - _BV(3), // D14 - MISO - PB3 - _BV(1), // D15 - SCK - PB1 - _BV(2), // D16 - MOSI - PB2 - _BV(0), // D17 - SS - PB0 - - _BV(7), // D18 - A0 - PF7 - _BV(6), // D19 - A1 - PF6 - _BV(5), // D20 - A2 - PF5 - _BV(4), // D21 - A3 - PF4 - _BV(1), // D22 - A4 - PF1 - _BV(0), // D23 - A5 - PF0 - - _BV(4), // D24 / D4 - A6 - PD4 - _BV(7), // D25 / D6 - A7 - PD7 - _BV(4), // D26 / D8 - A8 - PB4 - _BV(5), // D27 / D9 - A9 - PB5 - _BV(6), // D28 / D10 - A10 - PB6 - _BV(6), // D29 / D12 - A11 - PD6 - _BV(5), // D30 / TX Led - PD5 -}; - -const uint8_t PROGMEM digital_pin_to_timer_PGM[] = { - NOT_ON_TIMER, - NOT_ON_TIMER, - NOT_ON_TIMER, - TIMER0B, /* 3 */ - NOT_ON_TIMER, - TIMER3A, /* 5 */ - TIMER4D, /* 6 */ - NOT_ON_TIMER, - - NOT_ON_TIMER, - TIMER1A, /* 9 */ - TIMER1B, /* 10 */ - TIMER0A, /* 11 */ - - NOT_ON_TIMER, - TIMER4A, /* 13 */ - - NOT_ON_TIMER, - NOT_ON_TIMER, - NOT_ON_TIMER, - NOT_ON_TIMER, - NOT_ON_TIMER, - NOT_ON_TIMER, - - NOT_ON_TIMER, - NOT_ON_TIMER, - NOT_ON_TIMER, - NOT_ON_TIMER, - NOT_ON_TIMER, - NOT_ON_TIMER, - NOT_ON_TIMER, - NOT_ON_TIMER, - NOT_ON_TIMER, - NOT_ON_TIMER, - NOT_ON_TIMER, -}; - -const uint8_t PROGMEM analog_pin_to_channel_PGM[] = { - 7, // A0 PF7 ADC7 - 6, // A1 PF6 ADC6 - 5, // A2 PF5 ADC5 - 4, // A3 PF4 ADC4 - 1, // A4 PF1 ADC1 - 0, // A5 PF0 ADC0 - 8, // A6 D4 PD4 ADC8 - 10, // A7 D6 PD7 ADC10 - 11, // A8 D8 PB4 ADC11 - 12, // A9 D9 PB5 ADC12 - 13, // A10 D10 PB6 ADC13 - 9 // A11 D12 PD6 ADC9 -}; - -#endif /* ARDUINO_MAIN */ - -// These serial port names are intended to allow libraries and architecture-neutral -// sketches to automatically default to the correct port name for a particular type -// of use. For example, a GPS module would normally connect to SERIAL_PORT_HARDWARE_OPEN, -// the first hardware serial port whose RX/TX pins are not dedicated to another use. -// -// SERIAL_PORT_MONITOR Port which normally prints to the Arduino Serial Monitor -// -// SERIAL_PORT_USBVIRTUAL Port which is USB virtual serial -// -// SERIAL_PORT_LINUXBRIDGE Port which connects to a Linux system via Bridge library -// -// SERIAL_PORT_HARDWARE Hardware serial port, physical RX & TX pins. -// -// SERIAL_PORT_HARDWARE_OPEN Hardware serial ports which are open for use. Their RX & TX -// pins are NOT connected to anything by default. -#define SERIAL_PORT_MONITOR Serial -#define SERIAL_PORT_USBVIRTUAL Serial -#define SERIAL_PORT_HARDWARE Serial1 -#define SERIAL_PORT_HARDWARE_OPEN Serial1 - -// Alias SerialUSB to Serial -#define SerialUSB SERIAL_PORT_USBVIRTUAL - -#endif /* Pins_Arduino_h */ From bbc38e712096e414834a699db2701bf1b7f22eb1 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 20 May 2018 08:16:35 +0200 Subject: [PATCH 13/44] Use Timer1 for scan timing Instead of running `scanMatrix` whenever we get there, use Timer1 to set a consistent period. This does not mean we'll run every time the timer is up, but we will run at consistent intervals. Fixes #6. Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/ErgoDox.cpp | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/src/kaleidoscope/hardware/ErgoDox.cpp b/src/kaleidoscope/hardware/ErgoDox.cpp index 1a7acf5a..990772e8 100644 --- a/src/kaleidoscope/hardware/ErgoDox.cpp +++ b/src/kaleidoscope/hardware/ErgoDox.cpp @@ -39,6 +39,8 @@ uint8_t ErgoDox::masks_[ROWS]; uint8_t ErgoDox::debounce_matrix_[ROWS][COLS]; uint8_t ErgoDox::debounce = 5; +static bool do_scan_ = 1; + void ErgoDox::setup(void) { wdt_disable(); delay(100); @@ -61,6 +63,20 @@ void ErgoDox::setup(void) { setStatusLEDBrightness(1, 15); setStatusLEDBrightness(2, 15); setStatusLEDBrightness(3, 15); + + /* Set up Timer1 for 500usec */ + TCCR1B = _BV(WGM13); + TCCR1A = 0; + + const unsigned long cycles = (F_CPU / 2000000) * 500; + + ICR1 = cycles; + TCCR1B = _BV(WGM13) | _BV(CS10); + TIMSK1 = _BV(TOIE1); +} + +ISR(TIMER1_OVF_vect) { + do_scan_ = true; } void ErgoDox::readMatrixRow(uint8_t row) { @@ -74,6 +90,8 @@ void ErgoDox::readMatrixRow(uint8_t row) { } void ErgoDox::readMatrix() { + do_scan_ = false; + for (uint8_t row = 0; row < ROWS / 2; row++) { scanner_.selectRow(row); scanner_.selectRow(row + ROWS / 2); @@ -97,6 +115,9 @@ void ErgoDox::actOnMatrixScan() { } void ErgoDox::scanMatrix() { + if (!do_scan_) + return; + readMatrix(); actOnMatrixScan(); } From f8726905ea98ca80d972c5eb6a9162ff3bd2fe45 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 20 May 2018 09:59:53 +0200 Subject: [PATCH 14/44] Support detaching & re-attaching the expander Partly addresses #5. We still need to gracefully handle when the expander is not coming back. Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/ErgoDox.cpp | 2 ++ src/kaleidoscope/hardware/ErgoDoxScanner.cpp | 19 ++++++++++++++----- src/kaleidoscope/hardware/ErgoDoxScanner.h | 3 ++- 3 files changed, 18 insertions(+), 6 deletions(-) diff --git a/src/kaleidoscope/hardware/ErgoDox.cpp b/src/kaleidoscope/hardware/ErgoDox.cpp index 990772e8..43965cde 100644 --- a/src/kaleidoscope/hardware/ErgoDox.cpp +++ b/src/kaleidoscope/hardware/ErgoDox.cpp @@ -92,6 +92,8 @@ void ErgoDox::readMatrixRow(uint8_t row) { void ErgoDox::readMatrix() { do_scan_ = false; + scanner_.reattachExpanderOnError(); + for (uint8_t row = 0; row < ROWS / 2; row++) { scanner_.selectRow(row); scanner_.selectRow(row + ROWS / 2); diff --git a/src/kaleidoscope/hardware/ErgoDoxScanner.cpp b/src/kaleidoscope/hardware/ErgoDoxScanner.cpp index 2db4c139..630dc3d3 100644 --- a/src/kaleidoscope/hardware/ErgoDoxScanner.cpp +++ b/src/kaleidoscope/hardware/ErgoDoxScanner.cpp @@ -45,11 +45,7 @@ namespace hardware { uint8_t ErgoDoxScanner::initExpander() { uint8_t status = 0x20; - if (i2c_initialized_ == false) { - i2c_init(); - i2c_initialized_ = true; - _delay_ms(1000); - } + i2c_init(); status = i2c_start(I2C_ADDR_WRITE); if (status) @@ -187,5 +183,18 @@ out: } } +void +ErgoDoxScanner::reattachExpanderOnError() { + static uint8_t attach_counter; + + if (!expander_error_) + return; + + if (attach_counter++ != 0) + return; + + expander_error_ = initExpander(); +} + } } diff --git a/src/kaleidoscope/hardware/ErgoDoxScanner.h b/src/kaleidoscope/hardware/ErgoDoxScanner.h index 42302955..1439725d 100644 --- a/src/kaleidoscope/hardware/ErgoDoxScanner.h +++ b/src/kaleidoscope/hardware/ErgoDoxScanner.h @@ -40,8 +40,9 @@ class ErgoDoxScanner { void unselectRows(); uint8_t readCols(int row); + void reattachExpanderOnError(); + private: - bool i2c_initialized_ = false; uint8_t expander_error_ = 0x20; uint8_t initExpander(); From 2b19388f6c5db34dd18f62aea127c5110a746ffe Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 20 May 2018 10:14:37 +0200 Subject: [PATCH 15/44] ErgoDoxScanner: Try re-attaching every 5 seconds only Not doing so destroys the latency of the still functional right half. Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/ErgoDoxScanner.cpp | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/kaleidoscope/hardware/ErgoDoxScanner.cpp b/src/kaleidoscope/hardware/ErgoDoxScanner.cpp index 630dc3d3..7ed32212 100644 --- a/src/kaleidoscope/hardware/ErgoDoxScanner.cpp +++ b/src/kaleidoscope/hardware/ErgoDoxScanner.cpp @@ -185,15 +185,16 @@ out: void ErgoDoxScanner::reattachExpanderOnError() { - static uint8_t attach_counter; + static uint32_t start_time = millis(); if (!expander_error_) return; - if (attach_counter++ != 0) + if (millis() - start_time < 5000) return; expander_error_ = initExpander(); + start_time = millis(); } } From c6be3cf804728f345ca893e0d34d3fb924d08a03 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 20 May 2018 10:22:06 +0200 Subject: [PATCH 16/44] ErgoDoxScanner: We need that delay in initExpander Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/ErgoDoxScanner.cpp | 1 + 1 file changed, 1 insertion(+) diff --git a/src/kaleidoscope/hardware/ErgoDoxScanner.cpp b/src/kaleidoscope/hardware/ErgoDoxScanner.cpp index 7ed32212..4460e38f 100644 --- a/src/kaleidoscope/hardware/ErgoDoxScanner.cpp +++ b/src/kaleidoscope/hardware/ErgoDoxScanner.cpp @@ -46,6 +46,7 @@ uint8_t ErgoDoxScanner::initExpander() { uint8_t status = 0x20; i2c_init(); + delay(1000); status = i2c_start(I2C_ADDR_WRITE); if (status) From e706ffaa8979c923e9bc2a68c93028fe387d02c6 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 8 Jun 2018 09:13:47 +0200 Subject: [PATCH 17/44] Implement detachFromHost() and attachToHost() Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/ErgoDox.cpp | 8 ++++++++ src/kaleidoscope/hardware/ErgoDox.h | 11 +++++++++++ 2 files changed, 19 insertions(+) diff --git a/src/kaleidoscope/hardware/ErgoDox.cpp b/src/kaleidoscope/hardware/ErgoDox.cpp index 43965cde..7fc5728e 100644 --- a/src/kaleidoscope/hardware/ErgoDox.cpp +++ b/src/kaleidoscope/hardware/ErgoDox.cpp @@ -217,6 +217,14 @@ void ErgoDox::debounceRow(uint8_t change, uint8_t row) { } } +void ErgoDox::detachFromHost() { + UDCON |= (1 << DETACH); +} + +void ErgoDox::attachToHost() { + UDCON &= ~(1 << DETACH); +} + } } diff --git a/src/kaleidoscope/hardware/ErgoDox.h b/src/kaleidoscope/hardware/ErgoDox.h index f9d7ae7c..9a11e0cd 100644 --- a/src/kaleidoscope/hardware/ErgoDox.h +++ b/src/kaleidoscope/hardware/ErgoDox.h @@ -63,6 +63,17 @@ class ErgoDox { void actOnMatrixScan(void); void setup(); + /** Detaching from / attaching to the host. + * + * These two functions should detach the device from (or attach it to) the + * host, preferably without rebooting the device. Their purpose is to allow + * one to do some configuration inbetween, so the re-attach happens with + * different properties. The device remains powered between these operations, + * only the connection to the host gets severed. + */ + void detachFromHost(); + void attachToHost(); + /* Key masking * ----------- * From 9b6cf1ce148e76e0f8a58f7a335487f2fdbd2a8f Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 9 Jun 2018 21:06:59 +0200 Subject: [PATCH 18/44] Use the Kaleidoscope naming convention for KEYMAP_STACKED In Kaleidoscope, we use the rxcy naming scheme, so lets use that for the ErgoDox port too. Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/ErgoDox.h | 79 ++++++++++++++--------------- 1 file changed, 39 insertions(+), 40 deletions(-) diff --git a/src/kaleidoscope/hardware/ErgoDox.h b/src/kaleidoscope/hardware/ErgoDox.h index 9a11e0cd..f46f3cf1 100644 --- a/src/kaleidoscope/hardware/ErgoDox.h +++ b/src/kaleidoscope/hardware/ErgoDox.h @@ -107,46 +107,45 @@ class ErgoDox { static void readMatrixRow(uint8_t row); }; -#define KEYMAP_STACKED( \ - /* left hand, spatial positions */ \ - k00,k01,k02,k03,k04,k05,k06, \ - k10,k11,k12,k13,k14,k15,k16, \ - k20,k21,k22,k23,k24,k25, \ - k30,k31,k32,k33,k34,k35,k36, \ - k40,k41,k42,k43,k44, \ - k55,k56, \ - k54, \ - k53,k52,k51, \ - \ - /* right hand, spatial positions */ \ - k07,k08,k09,k0A,k0B,k0C,k0D, \ - k17,k18,k19,k1A,k1B,k1C,k1D, \ - k28,k29,k2A,k2B,k2C,k2D, \ - k37,k38,k39,k3A,k3B,k3C,k3D, \ - k49,k4A,k4B,k4C,k4D, \ - k57,k58, \ - k59, \ - k5C,k5B,k5A ) \ - \ - /* matrix positions */ \ - { \ - { k00, k10, k20, k30, k40, XXX }, \ - { k01, k11, k21, k31, k41, k51 }, \ - { k02, k12, k22, k32, k42, k52 }, \ - { k03, k13, k23, k33, k43, k53 }, \ - { k04, k14, k24, k34, k44, k54 }, \ - { k05, k15, k25, k35, XXX, k55 }, \ - { k06, k16, XXX, k36, XXX, k56 }, \ - \ - { k07, k17, XXX, k37,XXX, k57 }, \ - { k08, k18, k28, k38,XXX, k58 }, \ - { k09, k19, k29, k39, k49, k59 }, \ - { k0A, k1A, k2A, k3A, k4A, k5A }, \ - { k0B, k1B, k2B, k3B, k4B, k5B }, \ - { k0C, k1C, k2C, k3C, k4C, k5C }, \ - { k0D, k1D, k2D, k3D, k4D, XXX } \ - } - +#define KEYMAP_STACKED( \ + /* left hand, spatial positions */ \ + r0c0, r0c1, r0c2, r0c3, r0c4, r0c5, r0c6, \ + r1c0, r1c1, r1c2, r1c3, r1c4, r1c5, r1c6, \ + r2c0, r2c1, r2c2, r2c3, r2c4, r2c5, \ + r3c0, r3c1, r3c2, r3c3, r3c4, r3c5, r3c6, \ + r4c0, r4c1, r4c2, r4c3, r4c4, \ + r5c5, r5c6, \ + r5c4, \ + r5c3, r5c2, r5c1, \ + \ + /* right hand, spatial positions */ \ + r0c7, r0c8, r0c9, r0c10, r0c11, r0c12, r0c13, \ + r1c7, r1c8, r1c9, r1c10, r1c11, r1c12, r1c13, \ + r2c8, r2c9, r2c10, r2c11, r2c12, r2c13, \ + r3c7, r3c8, r3c9, r3c10, r3c11, r3c12, r3c13, \ + r4c9, r4c10, r4c11, r4c12, r4c13, \ + r5c7, r5c8, \ + r5c9, \ + r5c12, r5c11, r5c10 ) \ + \ + /* matrix positions */ \ + { \ + { r0c0, r1c0, r2c0, r3c0, r4c0, XXX }, \ + { r0c1, r1c1, r2c1, r3c1, r4c1, r5c1 }, \ + { r0c2, r1c2, r2c2, r3c2, r4c2, r5c2 }, \ + { r0c3, r1c3, r2c3, r3c3, r4c3, r5c3 }, \ + { r0c4, r1c4, r2c4, r3c4, r4c4, r5c4 }, \ + { r0c5, r1c5, r2c5, r3c5, XXX, r5c5 }, \ + { r0c6, r1c6, XXX, r3c6, XXX, r5c6 }, \ + \ + { r0c7, r1c7, XXX, r3c7, XXX, r5c7 }, \ + { r0c8, r1c8, r2c8, r3c8, XXX, r5c8 }, \ + { r0c9, r1c9, r2c9, r3c9, r4c9, r5c9 }, \ + { r0c10, r1c10, r2c10, r3c10, r4c10, r5c10 }, \ + { r0c11, r1c11, r2c11, r3c11, r4c11, r5c11 }, \ + { r0c12, r1c12, r2c12, r3c12, r4c12, r5c12 }, \ + { r0c13, r1c13, r2c13, r3c13, r4c13, XXX } \ + } } } From 0e573229031cc92845c2a1e19652231b200c2bbc Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 9 Jun 2018 21:18:02 +0200 Subject: [PATCH 19/44] Implement getKeyswitchStateAtPosition Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/ErgoDox.cpp | 9 +++++++++ src/kaleidoscope/hardware/ErgoDox.h | 12 ++++++++++++ 2 files changed, 21 insertions(+) diff --git a/src/kaleidoscope/hardware/ErgoDox.cpp b/src/kaleidoscope/hardware/ErgoDox.cpp index 7fc5728e..5b1ae01f 100644 --- a/src/kaleidoscope/hardware/ErgoDox.cpp +++ b/src/kaleidoscope/hardware/ErgoDox.cpp @@ -225,6 +225,15 @@ void ErgoDox::attachToHost() { UDCON &= ~(1 << DETACH); } +uint8_t ErgoDox::getKeyswitchStateAtPosition(byte row, byte col) { + return bitRead(keyState_[row], col); +} + +uint8_t ErgoDox::getKeyswitchStateAtPosition(uint8_t keyIndex) { + keyIndex--; + return getKeyswitchStateAtPosition(keyIndex / COLS, keyIndex % COLS); +} + } } diff --git a/src/kaleidoscope/hardware/ErgoDox.h b/src/kaleidoscope/hardware/ErgoDox.h index f46f3cf1..fbf63d80 100644 --- a/src/kaleidoscope/hardware/ErgoDox.h +++ b/src/kaleidoscope/hardware/ErgoDox.h @@ -87,6 +87,18 @@ class ErgoDox { void unMaskKey(byte row, byte col); bool isKeyMasked(byte row, byte col); + /** Key switch state + * + * These two methods return the state of the keyswitch at any given position, + * regardless of which half they are on. This is a hardware-agnostic access to + * the key switch states. + * + * The first variant requires a row and a column, the second an index, as + * returned by `keyIndex`. + */ + uint8_t getKeyswitchStateAtPosition(byte row, byte col); + uint8_t getKeyswitchStateAtPosition(uint8_t keyIndex); + // ErgoDox-specific stuff void setStatusLED(uint8_t led, bool state = true); void setStatusLEDBrightness(uint8_t led, uint8_t brightness); From 2414a6f4779c060e1e0e049b1117df0a4dec3e61 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 9 Jun 2018 21:28:58 +0200 Subject: [PATCH 20/44] Implement the RxCy constants Fixes #8. Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/ErgoDox.h | 102 ++++++++++++++++++++++++++++ 1 file changed, 102 insertions(+) diff --git a/src/kaleidoscope/hardware/ErgoDox.h b/src/kaleidoscope/hardware/ErgoDox.h index fbf63d80..afd90c59 100644 --- a/src/kaleidoscope/hardware/ErgoDox.h +++ b/src/kaleidoscope/hardware/ErgoDox.h @@ -161,4 +161,106 @@ class ErgoDox { } } +/* To be used by the hardware implementations, `keyIndex` tells us the index of + * a key, from which we can figure out the row and column as needed. The index + * starts at one, so that plugins that work with a list of key indexes can use + * zero as a sentinel. This is important, because when we initialize arrays with + * fewer elements than the declared array size, the remaining elements will be + * zero. We can use this to avoid having to explicitly add a sentinel in + * user-facing code. + */ +constexpr byte keyIndex(byte row, byte col) { + return row * COLS + col + 1; +} + +constexpr byte R0C0 = keyIndex(0, 0); +constexpr byte R0C1 = keyIndex(0, 1); +constexpr byte R0C2 = keyIndex(0, 2); +constexpr byte R0C3 = keyIndex(0, 3); +constexpr byte R0C4 = keyIndex(0, 4); +constexpr byte R0C5 = keyIndex(0, 5); +constexpr byte R0C6 = keyIndex(0, 6); +constexpr byte R0C7 = keyIndex(0, 7); +constexpr byte R0C8 = keyIndex(0, 8); +constexpr byte R0C9 = keyIndex(0, 9); +constexpr byte R0C10 = keyIndex(0, 10); +constexpr byte R0C11 = keyIndex(0, 11); +constexpr byte R0C12 = keyIndex(0, 12); +constexpr byte R0C13 = keyIndex(0, 13); + +constexpr byte R1C0 = keyIndex(1, 0); +constexpr byte R1C1 = keyIndex(1, 1); +constexpr byte R1C2 = keyIndex(1, 2); +constexpr byte R1C3 = keyIndex(1, 3); +constexpr byte R1C4 = keyIndex(1, 4); +constexpr byte R1C5 = keyIndex(1, 5); +constexpr byte R1C6 = keyIndex(1, 6); +constexpr byte R1C7 = keyIndex(1, 7); +constexpr byte R1C8 = keyIndex(1, 8); +constexpr byte R1C9 = keyIndex(1, 9); +constexpr byte R1C10 = keyIndex(1, 10); +constexpr byte R1C11 = keyIndex(1, 11); +constexpr byte R1C12 = keyIndex(1, 12); +constexpr byte R1C13 = keyIndex(1, 13); + +constexpr byte R2C0 = keyIndex(2, 0); +constexpr byte R2C1 = keyIndex(2, 1); +constexpr byte R2C2 = keyIndex(2, 2); +constexpr byte R2C3 = keyIndex(2, 3); +constexpr byte R2C4 = keyIndex(2, 4); +constexpr byte R2C5 = keyIndex(2, 5); +constexpr byte R2C6 = keyIndex(2, 6); +constexpr byte R2C7 = keyIndex(2, 7); +constexpr byte R2C8 = keyIndex(2, 8); +constexpr byte R2C9 = keyIndex(2, 9); +constexpr byte R2C10 = keyIndex(2, 10); +constexpr byte R2C11 = keyIndex(2, 11); +constexpr byte R2C12 = keyIndex(2, 12); +constexpr byte R2C13 = keyIndex(2, 13); + +constexpr byte R3C0 = keyIndex(3, 0); +constexpr byte R3C1 = keyIndex(3, 1); +constexpr byte R3C2 = keyIndex(3, 2); +constexpr byte R3C3 = keyIndex(3, 3); +constexpr byte R3C4 = keyIndex(3, 4); +constexpr byte R3C5 = keyIndex(3, 5); +constexpr byte R3C6 = keyIndex(3, 6); +constexpr byte R3C7 = keyIndex(3, 7); +constexpr byte R3C8 = keyIndex(3, 8); +constexpr byte R3C9 = keyIndex(3, 9); +constexpr byte R3C10 = keyIndex(3, 10); +constexpr byte R3C11 = keyIndex(3, 11); +constexpr byte R3C12 = keyIndex(3, 12); +constexpr byte R3C13 = keyIndex(3, 13); + +constexpr byte R4C0 = keyIndex(4, 0); +constexpr byte R4C1 = keyIndex(4, 1); +constexpr byte R4C2 = keyIndex(4, 2); +constexpr byte R4C3 = keyIndex(4, 3); +constexpr byte R4C4 = keyIndex(4, 4); +constexpr byte R4C5 = keyIndex(4, 5); +constexpr byte R4C6 = keyIndex(4, 6); +constexpr byte R4C7 = keyIndex(4, 7); +constexpr byte R4C8 = keyIndex(4, 8); +constexpr byte R4C9 = keyIndex(4, 9); +constexpr byte R4C10 = keyIndex(4, 10); +constexpr byte R4C11 = keyIndex(4, 11); +constexpr byte R4C12 = keyIndex(4, 12); +constexpr byte R4C13 = keyIndex(4, 13); + +constexpr byte R5C0 = keyIndex(5, 0); +constexpr byte R5C1 = keyIndex(5, 1); +constexpr byte R5C2 = keyIndex(5, 2); +constexpr byte R5C3 = keyIndex(5, 3); +constexpr byte R5C4 = keyIndex(5, 4); +constexpr byte R5C5 = keyIndex(5, 5); +constexpr byte R5C6 = keyIndex(5, 6); +constexpr byte R5C7 = keyIndex(5, 7); +constexpr byte R5C8 = keyIndex(5, 8); +constexpr byte R5C9 = keyIndex(5, 9); +constexpr byte R5C10 = keyIndex(5, 10); +constexpr byte R5C11 = keyIndex(5, 11); +constexpr byte R5C12 = keyIndex(5, 12); +constexpr byte R5C13 = keyIndex(5, 13); + extern kaleidoscope::hardware::ErgoDox &ErgoDox; From c455b9cc08a6d3fdceb9eb2506bd075d2b79c48d Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 10 Jun 2018 13:49:35 +0200 Subject: [PATCH 21/44] Better keyswitch state APIs Instead of `getKeyswitchStateAtPosition`, which is long, unintuitive and feels wrong too, introduce `isKeyswitchPressed`, shorter, better, more reasonable (because it returns a bool - we support only two states anyway!). Additionally, add `pressedKeyswitchCount()`, which returns the number of key switches pressed. Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/ErgoDox.cpp | 22 +++++++++++++--- src/kaleidoscope/hardware/ErgoDox.h | 37 +++++++++++++++++++++------ 2 files changed, 47 insertions(+), 12 deletions(-) diff --git a/src/kaleidoscope/hardware/ErgoDox.cpp b/src/kaleidoscope/hardware/ErgoDox.cpp index 5b1ae01f..512b4a1c 100644 --- a/src/kaleidoscope/hardware/ErgoDox.cpp +++ b/src/kaleidoscope/hardware/ErgoDox.cpp @@ -225,13 +225,27 @@ void ErgoDox::attachToHost() { UDCON &= ~(1 << DETACH); } -uint8_t ErgoDox::getKeyswitchStateAtPosition(byte row, byte col) { - return bitRead(keyState_[row], col); +bool ErgoDox::isKeyswitchPressed(byte row, byte col) { + return (bitRead(keyState_[row], col) != 0); } -uint8_t ErgoDox::getKeyswitchStateAtPosition(uint8_t keyIndex) { +bool ErgoDox::isKeyswitchPressed(uint8_t keyIndex) { keyIndex--; - return getKeyswitchStateAtPosition(keyIndex / COLS, keyIndex % COLS); + return isKeyswitchPressed(keyIndex / COLS, keyIndex % COLS); +} + +uint8_t ErgoDox::pressedKeyswitchCount() { + uint8_t count; + + for (uint8_t r = 0; r < ROWS; r++) { + if (!keyState_[r]) + continue; + + for (uint8_t c = 0; c < COLS; c++) { + count += bitRead(keyState_[r], c); + } + } + return count; } } diff --git a/src/kaleidoscope/hardware/ErgoDox.h b/src/kaleidoscope/hardware/ErgoDox.h index afd90c59..b8473bbf 100644 --- a/src/kaleidoscope/hardware/ErgoDox.h +++ b/src/kaleidoscope/hardware/ErgoDox.h @@ -87,17 +87,38 @@ class ErgoDox { void unMaskKey(byte row, byte col); bool isKeyMasked(byte row, byte col); - /** Key switch state + /** Key switch states * - * These two methods return the state of the keyswitch at any given position, - * regardless of which half they are on. This is a hardware-agnostic access to - * the key switch states. + * These methods offer a way to peek at the key switch states, for those cases + * where we need to deal with the state closest to the hardware. Some methods + * offer a way to check if a key is pressed, others return the number of + * pressed keys. + */ + /** + * Check if a key is pressed at a given position. + * + * @param row is the row the key is located at in the matrix. + * @param col is the column the key is located at in the matrix. + * + * @returns true if the key is pressed, false otherwise. + */ + bool isKeyswitchPressed(byte row, byte col); + /** + * Check if a key is pressed at a given position. + * + * @param keyIndex is the key index, as calculated by `keyIndex`. + * + * @note Key indexes start at 1, not 0! + * + * @returns true if the key is pressed, false otherwise. + */ + bool isKeyswitchPressed(uint8_t keyIndex); + /** + * Check the number of key switches currently pressed. * - * The first variant requires a row and a column, the second an index, as - * returned by `keyIndex`. + * @returns the number of keys pressed. */ - uint8_t getKeyswitchStateAtPosition(byte row, byte col); - uint8_t getKeyswitchStateAtPosition(uint8_t keyIndex); + uint8_t pressedKeyswitchCount(); // ErgoDox-specific stuff void setStatusLED(uint8_t led, bool state = true); From 56fdd2c5552122d8944761b8a13a36b8775e33f1 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 16 Jun 2018 13:43:09 +0200 Subject: [PATCH 22/44] Optimize pressedKeyswitchCount() Instead of manually counting set bits, use gcc's `__builtin_popcount()` for a - supposedly - more efficient count. Also initialize the counter to zero, while there. Fixes #11. Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/ErgoDox.cpp | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/src/kaleidoscope/hardware/ErgoDox.cpp b/src/kaleidoscope/hardware/ErgoDox.cpp index 512b4a1c..19522f0b 100644 --- a/src/kaleidoscope/hardware/ErgoDox.cpp +++ b/src/kaleidoscope/hardware/ErgoDox.cpp @@ -235,15 +235,10 @@ bool ErgoDox::isKeyswitchPressed(uint8_t keyIndex) { } uint8_t ErgoDox::pressedKeyswitchCount() { - uint8_t count; + uint8_t count = 0; for (uint8_t r = 0; r < ROWS; r++) { - if (!keyState_[r]) - continue; - - for (uint8_t c = 0; c < COLS; c++) { - count += bitRead(keyState_[r], c); - } + count += __builtin_popcount(keyState_[r]); } return count; } From b2465a655bd9b8e3509eebaea602710f77590325 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 23 Aug 2018 09:01:35 +0200 Subject: [PATCH 23/44] Assign my copyright to Keyboard.io While the original plugin was written independently, significant developments were made while working for Keyboard.io. As such, I feel it is appropriate to assign copyright to the company. Signed-off-by: Gergely Nagy --- examples/ErgoDox/ErgoDox.ino | 2 +- src/Kaleidoscope-Hardware-EZ-ErgoDox.h | 2 +- src/kaleidoscope/hardware/ErgoDox.cpp | 2 +- src/kaleidoscope/hardware/ErgoDox.h | 2 +- src/kaleidoscope/hardware/ErgoDoxScanner.cpp | 2 +- src/kaleidoscope/hardware/ErgoDoxScanner.h | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/examples/ErgoDox/ErgoDox.ino b/examples/ErgoDox/ErgoDox.ino index 1b6d7dad..d78779e2 100644 --- a/examples/ErgoDox/ErgoDox.ino +++ b/examples/ErgoDox/ErgoDox.ino @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * ErgoDox -- A very basic Kaleidoscope example for the ErgoDox - * Copyright (C) 2018 Gergely Nagy + * Copyright (C) 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 diff --git a/src/Kaleidoscope-Hardware-EZ-ErgoDox.h b/src/Kaleidoscope-Hardware-EZ-ErgoDox.h index a7e7ab65..356e315d 100644 --- a/src/Kaleidoscope-Hardware-EZ-ErgoDox.h +++ b/src/Kaleidoscope-Hardware-EZ-ErgoDox.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Hardware-EZ-ErgoDox -- ErgoDox hardware support for Kaleidoscope - * Copyright (C) 2018 Gergely Nagy + * Copyright (C) 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 diff --git a/src/kaleidoscope/hardware/ErgoDox.cpp b/src/kaleidoscope/hardware/ErgoDox.cpp index 19522f0b..7cd1f46b 100644 --- a/src/kaleidoscope/hardware/ErgoDox.cpp +++ b/src/kaleidoscope/hardware/ErgoDox.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Hardware-EZ-ErgoDox -- ErgoDox hardware support for Kaleidoscope - * Copyright (C) 2018 Gergely Nagy + * Copyright (C) 2018 Keyboard.io, Inc * * Based on QMK (commit 8cdb4a915) * (C) Jack Humbert, Erez Zukerman, Oleg Kostyuk diff --git a/src/kaleidoscope/hardware/ErgoDox.h b/src/kaleidoscope/hardware/ErgoDox.h index b8473bbf..83b3021d 100644 --- a/src/kaleidoscope/hardware/ErgoDox.h +++ b/src/kaleidoscope/hardware/ErgoDox.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Hardware-EZ-ErgoDox -- ErgoDox hardware support for Kaleidoscope - * Copyright (C) 2018 Gergely Nagy + * Copyright (C) 2018 Keyboard.io, Inc * * Based on QMK (commit 8cdb4a915) * (C) Jack Humbert, Erez Zukerman, Oleg Kostyuk diff --git a/src/kaleidoscope/hardware/ErgoDoxScanner.cpp b/src/kaleidoscope/hardware/ErgoDoxScanner.cpp index 4460e38f..869cde34 100644 --- a/src/kaleidoscope/hardware/ErgoDoxScanner.cpp +++ b/src/kaleidoscope/hardware/ErgoDoxScanner.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Hardware-EZ-ErgoDox -- ErgoDox hardware support for Kaleidoscope - * Copyright (C) 2018 Gergely Nagy + * Copyright (C) 2018 Keyboard.io, Inc * * Based on QMK (commit 8cdb4a915) * (C) Jack Humbert, Erez Zukerman, Oleg Kostyuk diff --git a/src/kaleidoscope/hardware/ErgoDoxScanner.h b/src/kaleidoscope/hardware/ErgoDoxScanner.h index 1439725d..d3a1f1f9 100644 --- a/src/kaleidoscope/hardware/ErgoDoxScanner.h +++ b/src/kaleidoscope/hardware/ErgoDoxScanner.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-Hardware-EZ-ErgoDox -- ErgoDox hardware support for Kaleidoscope - * Copyright (C) 2018 Gergely Nagy + * Copyright (C) 2018 Keyboard.io, Inc * * Based on QMK (commit 8cdb4a915) * (C) Jack Humbert, Erez Zukerman, Oleg Kostyuk From 628adc0dfe1b257e4c3d341521ea2f74e5614a18 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 23 Aug 2018 09:01:37 +0200 Subject: [PATCH 24/44] Add CONTRIBUTING.md Copied from Kaleidoscope, as it is applicable here too. Signed-off-by: Gergely Nagy --- CONTRIBUTING.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..c490e3ce --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# Developer Certificate of Origin + +All contributions must include acceptance of the DCO: + +``` +Developer Certificate of Origin +Version 1.1 + +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. +1 Letterman Drive +Suite D4700 +San Francisco, CA, 94129 + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + + +Developer's Certificate of Origin 1.1 + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + +(b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + +(c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + +(d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. +``` + +## Sign your work + +To accept the DCO, please add this line to each commit message with your name +and email address (`git commit -s` will do this for you): + + Signed-off-by: Jane Example From d3d79760b1bb4f08913e5a5ca2ceeff7762a453f Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 4 Sep 2018 18:24:01 -0700 Subject: [PATCH 25/44] Update travis.yml to point to new bundle repo --- .travis.yml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 719b82ed..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: From 4a265d72882f24ff137e2234f2792d73da4fd0fd Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 4 Sep 2018 18:42:29 -0700 Subject: [PATCH 26/44] shellcheck should only be run in the Kaleidoscope repo --- .travis.yml | 5 ----- 1 file changed, 5 deletions(-) diff --git a/.travis.yml b/.travis.yml index e3e64f77..23d30ccc 100644 --- a/.travis.yml +++ b/.travis.yml @@ -2,15 +2,10 @@ dist: trusty sudo: false os: - linux -addons: - apt: - packages: - - shellcheck install: - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Kaleidoscope-Bundle-Keyboardio hardware/keyboardio script: - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware - - shellcheck bin/kaleidoscope-builder notifications: irc: channels: From e5ad4c0649297305fbd861d9abc7a865625dd6bc Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 11 Sep 2018 18:44:32 +0200 Subject: [PATCH 27/44] Initial import Signed-off-by: Gergely Nagy --- .gitignore | 1 + .kaleidoscope-builder.conf | 24 + .travis.yml | 21 + CONTRIBUTING.md | 50 ++ COPYING | 674 ++++++++++++++++++ Makefile | 14 + README.md | 11 + examples/Atreus/Atreus.ino | 101 +++ library.properties | 9 + ...Kaleidoscope-Hardware-Technomancy-Atreus.h | 20 + src/kaleidoscope/hardware/Atreus.cpp | 296 ++++++++ src/kaleidoscope/hardware/Atreus.h | 234 ++++++ 12 files changed, 1455 insertions(+) create mode 100644 .gitignore create mode 100644 .kaleidoscope-builder.conf create mode 100644 .travis.yml create mode 100644 CONTRIBUTING.md create mode 100644 COPYING create mode 100644 Makefile create mode 100644 README.md create mode 100644 examples/Atreus/Atreus.ino create mode 100644 library.properties create mode 100644 src/Kaleidoscope-Hardware-Technomancy-Atreus.h create mode 100644 src/kaleidoscope/hardware/Atreus.cpp create mode 100644 src/kaleidoscope/hardware/Atreus.h diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..2c04c9d8 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/output/ \ No newline at end of file diff --git a/.kaleidoscope-builder.conf b/.kaleidoscope-builder.conf new file mode 100644 index 00000000..d80241fb --- /dev/null +++ b/.kaleidoscope-builder.conf @@ -0,0 +1,24 @@ +flash_over_usb() { + sleep 1s + + echo "Please reset your keyboard!" + teensy_loader_cli --mcu "${MCU}" -w "${HEX_FILE_PATH}" +} + +flash () { + prepare_to_flash + + # This is defined in the (optional) user config. + # shellcheck disable=SC2154 + ${preFlash_HOOKS} + + flash_over_usb || flash_over_usb + + # This is defined in the (optional) user config. + # shellcheck disable=SC2154 + ${postFlash_HOOKS} +} + +NO_RESET=1 +DEFAULT_SKETCH="Atreus" +BOARD="atreus" diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 00000000..23d30ccc --- /dev/null +++ b/.travis.yml @@ -0,0 +1,21 @@ +dist: trusty +sudo: false +os: + - linux +install: + - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Kaleidoscope-Bundle-Keyboardio hardware/keyboardio +script: + - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware +notifications: + irc: + channels: + - "chat.freenode.net#keyboardio" + use_notice: true + skip_join: true + template: + - "%{repository_name}/%{branch} %{commit} by %{author}: %{commit_subject} %{build_url} %{message}" + email: + on_success: change + on_failure: change +cache: + ccache: true diff --git a/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 diff --git a/COPYING b/COPYING new file mode 100644 index 00000000..94a9ed02 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..8f830f44 --- /dev/null +++ b/Makefile @@ -0,0 +1,14 @@ +# This stub makefile for a Kaleidoscope plugin pulls in +# all targets from the Kaleidoscope-Plugin library + +UNAME_S := $(shell uname -s) + +ifeq ($(UNAME_S),Darwin) +SKETCHBOOK_DIR ?= $(HOME)/Documents/Arduino/ +else +SKETCHBOOK_DIR ?= $(HOME)/Arduino +endif + +BOARD_HARDWARE_PATH ?= $(SKETCHBOOK_DIR)/hardware +KALEIDOSCOPE_PLUGIN_MAKEFILE_DIR ?= keyboardio/avr/build-tools/makefiles/ +include $(BOARD_HARDWARE_PATH)/$(KALEIDOSCOPE_PLUGIN_MAKEFILE_DIR)/rules.mk diff --git a/README.md b/README.md new file mode 100644 index 00000000..fb7fcfc1 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# Kaleidoscope-Hardware-Technomancy-Atreus + +This is a plugin for [Kaleidoscope][fw], that adds hardware support for the +[Atreus][atreus]. Supported models include post-2016 PCB variants with an A* +MCU, and the hand-wired variant from [FalbaTech][falba] with a Teensy2. + +PCBs prior to 2016, and the legacy teensy2 variants are not supported. + + [fw]: https://github.com/keyboardio/Kaleidoscope + [atreus]: https://atreus.technomancy.us/ + [falba]: https://falba.tech/ diff --git a/examples/Atreus/Atreus.ino b/examples/Atreus/Atreus.ino new file mode 100644 index 00000000..e6dc9a8d --- /dev/null +++ b/examples/Atreus/Atreus.ino @@ -0,0 +1,101 @@ +/* -*- mode: c++ -*- + * Atreus -- A very basic Kaleidoscope example for the Atreus + * Copyright (C) 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; either version 2 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, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +#include "Kaleidoscope.h" +#include "Kaleidoscope-Macros.h" + +#define MO(n) ShiftToLayer(n) +#define TG(n) LockLayer(n) + +enum { + RESET +}; + +#define Key_Exclamation LSHIFT(Key_1) +#define Key_At LSHIFT(Key_2) +#define Key_Hash LSHIFT(Key_3) +#define Key_Dollar LSHIFT(Key_4) +#define Key_And LSHIFT(Key_7) +#define Key_Star LSHIFT(Key_8) +#define Key_Plus LSHIFT(Key_Equals) + +/* *INDENT-OFF* */ +KEYMAPS( + [0] = KEYMAP_STACKED + ( + Key_Q ,Key_W ,Key_E ,Key_R ,Key_T + ,Key_A ,Key_S ,Key_D ,Key_F ,Key_G + ,Key_Z ,Key_X ,Key_C ,Key_V ,Key_B + ,Key_Esc ,Key_Tab ,Key_LeftGui ,Key_LeftShift ,Key_Backspace ,Key_LeftControl + + ,Key_Y ,Key_U ,Key_I ,Key_O ,Key_P + ,Key_H ,Key_J ,Key_K ,Key_L ,Key_Semicolon + ,Key_N ,Key_M ,Key_Comma ,Key_Period ,Key_Slash + ,Key_LeftAlt ,Key_Space ,MO(1) ,Key_Minus ,Key_Quote ,Key_Enter + ), + + [1] = KEYMAP_STACKED + ( + Key_Exclamation ,Key_At ,Key_UpArrow ,Key_LeftCurlyBracket ,Key_RightCurlyBracket + ,Key_Hash ,Key_LeftArrow ,Key_DownArrow ,Key_RightArrow ,Key_Dollar + ,Key_LeftBracket ,Key_RightBracket ,Key_LeftParen ,Key_RightParen ,Key_And + ,TG(2) ,Key_Insert ,Key_LeftGui ,Key_LeftShift ,Key_Backspace ,Key_LeftControl + + ,Key_PageUp ,Key_7 ,Key_8 ,Key_9 ,Key_Star + ,Key_PageDown ,Key_4 ,Key_5 ,Key_6 ,Key_Plus + ,Key_Backtick ,Key_1 ,Key_2 ,Key_3 ,Key_Backslash + ,Key_LeftAlt ,Key_Space ,MO(1) ,Key_Period ,Key_0 ,Key_Equals + ), + + [2] = KEYMAP_STACKED + ( + Key_Insert ,Key_Home ,Key_UpArrow ,Key_End ,Key_PageUp + ,Key_Delete ,Key_LeftArrow ,Key_DownArrow ,Key_RightArrow ,Key_PageDown + ,XXX ,Consumer_VolumeIncrement ,XXX ,XXX ,M(RESET) + ,XXX ,Consumer_VolumeDecrement ,___ ,___ ,___ ,___ + + ,Key_UpArrow ,Key_F7 ,Key_F8 ,Key_F9 ,Key_F10 + ,Key_DownArrow ,Key_F4 ,Key_F5 ,Key_F6 ,Key_F11 + ,XXX ,Key_F1 ,Key_F2 ,Key_F3 ,Key_F12 + ,___ ,___ ,___ ,Key_PrintScreen ,Key_ScrollLock ,Consumer_PlaySlashPause + ) +) +/* *INDENT-ON* */ + +KALEIDOSCOPE_INIT_PLUGINS(Macros); + +const macro_t *macroAction(uint8_t macroIndex, uint8_t keyState) { + switch (macroIndex) { + case RESET: + Atreus.resetDevice(); + break; + default: + break; + } + + return MACRO_NONE; +} + +void setup() { + Kaleidoscope.setup(); +} + +void loop() { + Kaleidoscope.loop(); +} diff --git a/library.properties b/library.properties new file mode 100644 index 00000000..6818af5d --- /dev/null +++ b/library.properties @@ -0,0 +1,9 @@ +name=Kaleidoscope-Hardware-Technomancy-Atreus +version=0.0.1 +author=Gergely Nagy +maintainer=Gergely Nagy +sentence=Atreus Hardware support for Kaleidoscope. +paragraph=... +category=Communication +url=https://github.com/keyboardio/Kaleidoscope-Hardware-Technomancy-Atreus +architectures=avr diff --git a/src/Kaleidoscope-Hardware-Technomancy-Atreus.h b/src/Kaleidoscope-Hardware-Technomancy-Atreus.h new file mode 100644 index 00000000..f098619a --- /dev/null +++ b/src/Kaleidoscope-Hardware-Technomancy-Atreus.h @@ -0,0 +1,20 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-Hardware-Technomancy-Atreus -- Atreus hardware support for Kaleidoscope + * Copyright (C) 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, 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 "kaleidoscope/hardware/Atreus.h" diff --git a/src/kaleidoscope/hardware/Atreus.cpp b/src/kaleidoscope/hardware/Atreus.cpp new file mode 100644 index 00000000..c06d9b45 --- /dev/null +++ b/src/kaleidoscope/hardware/Atreus.cpp @@ -0,0 +1,296 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-Hardware-Technomancy-Atreus -- Atreus hardware support for Kaleidoscope + * Copyright (C) 2018 Keyboard.io, Inc + * + * Based on QMK (commit e9a67f8fd) + * (C) Jack Humbert, Phil Hagelberg, and others + * Original QMK sources: + * - keyboards/atreus/atreus.h + * - keyboards/atreus/config.h + * - quantum/matrix.c + * - tmk_core/common/avr/bootloader.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 . + */ + +#include +#include +#include + +static bool do_scan_ = true; + +ISR(TIMER1_OVF_vect) { + do_scan_ = true; +} + +namespace kaleidoscope { +namespace hardware { + +uint16_t Atreus::previousKeyState_[ROWS]; +uint16_t Atreus::keyState_[ROWS]; +uint16_t Atreus::masks_[ROWS]; + +uint8_t Atreus::debounce_matrix_[ROWS][COLS]; +uint8_t Atreus::debounce = 5; + +void Atreus::setup(void) { + wdt_disable(); + delay(100); + + for (uint8_t i=0; i < ROWS; i++) { + unselectRow(i); + keyState_[i] = previousKeyState_[i] = 0; + } + + // Initialize columns + DDRB &= ~(_BV(5) | _BV(4) | _BV(6) | _BV(7)); + PORTB |= (_BV(5) | _BV(4) | _BV(6) | _BV(7)); + + DDRD &= ~(_BV(7) | _BV(4) | _BV(6)); + PORTD |= (_BV(7) | _BV(4) | _BV(6)); + + DDRC &= ~(_BV(6)); + PORTC |= (_BV(6)); + + DDRE &= ~(_BV(6)); + PORTE |= (_BV(6)); + + DDRF &= ~(_BV(6) | _BV(7)); + PORTF |= (_BV(6) | _BV(7)); + + /* Set up Timer1 for 500usec */ + TCCR1B = _BV(WGM13); + TCCR1A = 0; + + const unsigned long cycles = (F_CPU / 2000000) * 500; + + ICR1 = cycles; + TCCR1B = _BV(WGM13) | _BV(CS10); + TIMSK1 = _BV(TOIE1); +} + +void Atreus::selectRow(uint8_t row) +{ + switch (row) { + case 0: + DDRD |= (_BV(0)); + PORTD &= ~(_BV(0)); + break; + case 1: + DDRD |= (_BV(1)); + PORTD &= ~(_BV(1)); + break; + case 2: + DDRD |= (_BV(3)); + PORTD &= ~(_BV(3)); + break; + case 3: + DDRD |= (_BV(2)); + PORTD &= ~(_BV(2)); + break; + default: + break; + } +} + +void Atreus::unselectRow(uint8_t row) +{ + switch (row) { + case 0: + DDRD &= ~(_BV(0)); + PORTD |= (_BV(0)); + break; + case 1: + DDRD &= ~(_BV(1)); + PORTD |= (_BV(1)); + break; + case 2: + DDRD &= ~(_BV(3)); + PORTD |= (_BV(3)); + break; + case 3: + DDRD &= ~(_BV(2)); + PORTD |= (_BV(2)); + break; + default: + break; + } +} + +uint16_t Atreus::readCols() { + return ((PIND&(_BV(7)) ? 0 : (_BV(0))) | + (PINC&(_BV(6)) ? 0 : (_BV(1))) | + (PINB&(_BV(5)) ? 0 : (_BV(2))) | + (PINB&(_BV(4)) ? 0 : (_BV(3))) | + (PINE&(_BV(6)) ? 0 : (_BV(4))) | + (PIND&(_BV(4)) ? 0 : (_BV(5))) | + (PINB&(_BV(6)) ? 0 : (_BV(6))) | + (PINF&(_BV(6)) ? 0 : (_BV(7))) | + (PINF&(_BV(7)) ? 0 : (_BV(8))) | + (PIND&(_BV(6)) ? 0 : (_BV(9))) | + (PINB&(_BV(7)) ? 0 : (_BV(10)))); +} + +void Atreus::readMatrixRow(uint8_t current_row) +{ + uint16_t mask, cols; + + previousKeyState_[current_row] = keyState_[current_row]; + + mask = debounceMaskForRow(current_row); + + selectRow(current_row); + cols = (readCols() & mask) | (keyState_[current_row] & ~mask); + unselectRow(current_row); + debounceRow(cols ^ keyState_[current_row], current_row); + keyState_[current_row] = cols; +} + +void Atreus::readMatrix() { + do_scan_ = false; + + for (uint8_t current_row = 0; current_row < ROWS; current_row++) { + readMatrixRow(current_row); + } +} + +void Atreus::actOnMatrixScan() { + for (byte row = 0; row < ROWS; row++) { + for (byte col = 0; col < COLS; col++) { + uint8_t keyState = (bitRead(previousKeyState_[row], col) << 0) | + (bitRead(keyState_[row], col) << 1); + if (keyState) { + handleKeyswitchEvent(Key_NoKey, row, col, keyState); + } + } + previousKeyState_[row] = keyState_[row]; + } +} + +void Atreus::scanMatrix() { + if (!do_scan_) + return; + + readMatrix(); + actOnMatrixScan(); +} + +void Atreus::maskKey(byte row, byte col) { + if (row >= ROWS || col >= COLS) + return; + + bitWrite(masks_[row], col, 1); +} + +void Atreus::unMaskKey(byte row, byte col) { + if (row >= ROWS || col >= COLS) + return; + + bitWrite(masks_[row], col, 0); +} + +bool Atreus::isKeyMasked(byte row, byte col) { + if (row >= ROWS || col >= COLS) + return false; + + return bitRead(masks_[row], col); +} + +// Atreus-specific stuff + +void Atreus::resetDevice() { + cli(); + UDCON = 1; + USBCON = (1 << FRZCLK); + UCSR1B = 0; + _delay_ms(5); + + EIMSK = 0; + PCICR = 0; + SPCR = 0; + ACSR = 0; + EECR = 0; + ADCSRA = 0; + TIMSK0 = 0; + TIMSK1 = 0; + TIMSK3 = 0; + TIMSK4 = 0; + UCSR1B = 0; + TWCR = 0; + DDRB = 0; + DDRC = 0; + DDRD = 0; + DDRE = 0; + DDRF = 0; + TWCR = 0; + PORTB = 0; + PORTC = 0; + PORTD = 0; + PORTE = 0; + PORTF = 0; + asm volatile("jmp 0x7E00"); +} + +void Atreus::detachFromHost() { + UDCON |= (1 << DETACH); +} + +void Atreus::attachToHost() { + UDCON &= ~(1 << DETACH); +} + +bool Atreus::isKeyswitchPressed(byte row, byte col) { + return (bitRead(keyState_[row], col) != 0); +} + +bool Atreus::isKeyswitchPressed(uint8_t keyIndex) { + keyIndex--; + return isKeyswitchPressed(keyIndex / COLS, keyIndex % COLS); +} + +uint8_t Atreus::pressedKeyswitchCount() { + uint8_t count = 0; + + for (uint8_t r = 0; r < ROWS; r++) { + count += __builtin_popcount(keyState_[r]); + } + return count; +} + +uint16_t Atreus::debounceMaskForRow(uint8_t row) { + uint16_t result = 0; + + for (uint16_t c = 0; c < COLS; ++c) { + if (debounce_matrix_[row][c]) { + --debounce_matrix_[row][c]; + } else { + result |= (1 << c); + } + } + return result; +} + +void Atreus::debounceRow(uint16_t change, uint8_t row) { + for (uint16_t i = 0; i < COLS; ++i) { + if (change & (1 << i)) { + debounce_matrix_[row][i] = debounce; + } + } +} + +} +} + +HARDWARE_IMPLEMENTATION KeyboardHardware; +kaleidoscope::hardware::Atreus &Atreus = KeyboardHardware; diff --git a/src/kaleidoscope/hardware/Atreus.h b/src/kaleidoscope/hardware/Atreus.h new file mode 100644 index 00000000..47718a67 --- /dev/null +++ b/src/kaleidoscope/hardware/Atreus.h @@ -0,0 +1,234 @@ +/* -*- mode: c++ -*- + * Kaleidoscope-Hardware-Technomancy-Atreus -- Atreus hardware support for Kaleidoscope + * Copyright (C) 2018 Keyboard.io, Inc + * + * Based on QMK (commit e9a67f8fd) + * (C) Jack Humbert, Jun Wako, Phil Hagelberg, and others + * Original QMK sources: + * - keyboards/atreus/atreus.h + * - keyboards/atreus/config.h + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#pragma once + +#include + +#define HARDWARE_IMPLEMENTATION kaleidoscope::hardware::Atreus +#include "Kaleidoscope-HIDAdaptor-KeyboardioHID.h" + +#include "macro_helpers.h" + +struct cRGB { + uint8_t r, g, b; +}; + +#define COLS 11 +#define ROWS 4 +#define LED_COUNT 0 + +#define CRGB(r,g,b) (cRGB){b, g, r} + +namespace kaleidoscope { +namespace hardware { + +class Atreus { + public: + Atreus(void) {}; + + void syncLeds(void) {}; + void setCrgbAt(byte row, byte col, cRGB color) {}; + void setCrgbAt(uint8_t i, cRGB crgb) {}; + cRGB getCrgbAt(uint8_t i) { + return CRGB(0, 0, 0); + }; + + void scanMatrix(void); + void readMatrix(void); + void actOnMatrixScan(void); + void setup(); + + /** Detaching from / attaching to the host. + * + * These two functions should detach the device from (or attach it to) the + * host, preferably without rebooting the device. Their purpose is to allow + * one to do some configuration inbetween, so the re-attach happens with + * different properties. The device remains powered between these operations, + * only the connection to the host gets severed. + */ + void detachFromHost(); + void attachToHost(); + + /* Key masking + * ----------- + * + * There are situations when one wants to ignore key events for a while, and + * mask them out. These functions help do that. In isolation, they do nothing, + * plugins and the core firmware is expected to make use of these. + * + * See `handleKeyswitchEvent` in the Kaleidoscope sources for a use-case. + */ + void maskKey(byte row, byte col); + void unMaskKey(byte row, byte col); + bool isKeyMasked(byte row, byte col); + + /** Key switch states + * + * These methods offer a way to peek at the key switch states, for those cases + * where we need to deal with the state closest to the hardware. Some methods + * offer a way to check if a key is pressed, others return the number of + * pressed keys. + */ + /** + * Check if a key is pressed at a given position. + * + * @param row is the row the key is located at in the matrix. + * @param col is the column the key is located at in the matrix. + * + * @returns true if the key is pressed, false otherwise. + */ + bool isKeyswitchPressed(byte row, byte col); + /** + * Check if a key is pressed at a given position. + * + * @param keyIndex is the key index, as calculated by `keyIndex`. + * + * @note Key indexes start at 1, not 0! + * + * @returns true if the key is pressed, false otherwise. + */ + bool isKeyswitchPressed(uint8_t keyIndex); + /** + * Check the number of key switches currently pressed. + * + * @returns the number of keys pressed. + */ + uint8_t pressedKeyswitchCount(); + + void resetDevice(); + + static uint8_t debounce; + + private: + static uint16_t previousKeyState_[ROWS]; + static uint16_t keyState_[ROWS]; + static uint16_t masks_[ROWS]; + + static void readMatrixRow(uint8_t row); + static uint16_t readCols(); + static void selectRow(uint8_t row); + static void unselectRow(uint8_t row); + + static uint8_t debounce_matrix_[ROWS][COLS]; + static uint16_t debounceMaskForRow(uint8_t row); + static void debounceRow(uint16_t change, uint8_t row); +}; + +#define KEYMAP( \ + R0C0, R0C1, R0C2, R0C3, R0C4, R0C7, R0C8, R0C9, R0C10, R0C11, \ + R1C0, R1C1, R1C2, R1C3, R1C4, R1C7, R1C8, R1C9, R1C10, R1C11, \ + R2C0, R2C1, R2C2, R2C3, R2C4, R2C7, R2C8, R2C9, R2C10, R2C11, \ + R3C0, R3C1, R3C2, R3C3, R3C4, R3C5, R3C6, R3C7, R3C8, R3C9, R3C10, R3C11 \ + ) \ + { \ + { R0C0, R0C1, R0C2, R0C3, R0C4, XXX, R0C7, R0C8, R0C9, R0C10, R0C11 }, \ + { R1C0, R1C1, R1C2, R1C3, R1C4, XXX, R1C7, R1C8, R1C9, R1C10, R1C11 }, \ + { R2C0, R2C1, R2C2, R2C3, R2C4, R3C5, R2C7, R2C8, R2C9, R2C10, R2C11 }, \ + { R3C0, R3C1, R3C2, R3C3, R3C4, R3C6, R3C7, R3C8, R3C9, R3C10, R3C11 } \ + } + +#define KEYMAP_STACKED( \ + R0C0, R0C1, R0C2, R0C3, R0C4, \ + R1C0, R1C1, R1C2, R1C3, R1C4, \ + R2C0, R2C1, R2C2, R2C3, R2C4, \ + R3C0, R3C1, R3C2, R3C3, R3C4, R3C5, \ + \ + R0C7, R0C8, R0C9, R0C10, R0C11, \ + R1C7, R1C8, R1C9, R1C10, R1C11, \ + R2C7, R2C8, R2C9, R2C10, R2C11, \ + R3C6, R3C7, R3C8, R3C9, R3C10, R3C11 \ + ) \ + { \ + { R0C0, R0C1, R0C2, R0C3, R0C4, XXX, R0C7, R0C8, R0C9, R0C10, R0C11 }, \ + { R1C0, R1C1, R1C2, R1C3, R1C4, XXX, R1C7, R1C8, R1C9, R1C10, R1C11 }, \ + { R2C0, R2C1, R2C2, R2C3, R2C4, R3C5, R2C7, R2C8, R2C9, R2C10, R2C11 }, \ + { R3C0, R3C1, R3C2, R3C3, R3C4, R3C6, R3C7, R3C8, R3C9, R3C10, R3C11 } \ + } + +} +} + +/* To be used by the hardware implementations, `keyIndex` tells us the index of + * a key, from which we can figure out the row and column as needed. The index + * starts at one, so that plugins that work with a list of key indexes can use + * zero as a sentinel. This is important, because when we initialize arrays with + * fewer elements than the declared array size, the remaining elements will be + * zero. We can use this to avoid having to explicitly add a sentinel in + * user-facing code. + */ +constexpr byte keyIndex(byte row, byte col) { + return row * COLS + col + 1; +} + +constexpr byte R0C0 = keyIndex(0, 0); +constexpr byte R0C1 = keyIndex(0, 1); +constexpr byte R0C2 = keyIndex(0, 2); +constexpr byte R0C3 = keyIndex(0, 3); +constexpr byte R0C4 = keyIndex(0, 4); + +constexpr byte R0C7 = keyIndex(0, 7); +constexpr byte R0C8 = keyIndex(0, 8); +constexpr byte R0C9 = keyIndex(0, 9); +constexpr byte R0C10 = keyIndex(0, 10); +constexpr byte R0C11 = keyIndex(0, 11); + +constexpr byte R1C0 = keyIndex(1, 0); +constexpr byte R1C1 = keyIndex(1, 1); +constexpr byte R1C2 = keyIndex(1, 2); +constexpr byte R1C3 = keyIndex(1, 3); +constexpr byte R1C4 = keyIndex(1, 4); + +constexpr byte R1C7 = keyIndex(1, 7); +constexpr byte R1C8 = keyIndex(1, 8); +constexpr byte R1C9 = keyIndex(1, 9); +constexpr byte R1C10 = keyIndex(1, 10); +constexpr byte R1C11 = keyIndex(1, 11); + +constexpr byte R2C0 = keyIndex(2, 0); +constexpr byte R2C1 = keyIndex(2, 1); +constexpr byte R2C2 = keyIndex(2, 2); +constexpr byte R2C3 = keyIndex(2, 3); +constexpr byte R2C4 = keyIndex(2, 4); + +constexpr byte R2C7 = keyIndex(2, 7); +constexpr byte R2C8 = keyIndex(2, 8); +constexpr byte R2C9 = keyIndex(2, 9); +constexpr byte R2C10 = keyIndex(2, 10); +constexpr byte R2C11 = keyIndex(2, 11); + +constexpr byte R3C0 = keyIndex(3, 0); +constexpr byte R3C1 = keyIndex(3, 1); +constexpr byte R3C2 = keyIndex(3, 2); +constexpr byte R3C3 = keyIndex(3, 3); +constexpr byte R3C4 = keyIndex(3, 4); +constexpr byte R3C5 = keyIndex(3, 5); +constexpr byte R3C6 = keyIndex(3, 6); +constexpr byte R3C7 = keyIndex(3, 7); +constexpr byte R3C8 = keyIndex(3, 8); +constexpr byte R3C9 = keyIndex(3, 9); +constexpr byte R3C10 = keyIndex(3, 10); +constexpr byte R3C11 = keyIndex(3, 11); + +extern kaleidoscope::hardware::Atreus &Atreus; From d927627a0775dd9f637efd7597483b9b1e51f061 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 11 Sep 2018 23:06:35 +0200 Subject: [PATCH 28/44] Rearranged the columns Rearranged the columns so we can do some bit shifting and OR-ing magic instead of manually picking bits from various pins. Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/Atreus.cpp | 20 ++++++++++---------- src/kaleidoscope/hardware/Atreus.h | 17 ++++++++--------- 2 files changed, 18 insertions(+), 19 deletions(-) diff --git a/src/kaleidoscope/hardware/Atreus.cpp b/src/kaleidoscope/hardware/Atreus.cpp index c06d9b45..1fd8cede 100644 --- a/src/kaleidoscope/hardware/Atreus.cpp +++ b/src/kaleidoscope/hardware/Atreus.cpp @@ -129,17 +129,17 @@ void Atreus::unselectRow(uint8_t row) } uint16_t Atreus::readCols() { - return ((PIND&(_BV(7)) ? 0 : (_BV(0))) | - (PINC&(_BV(6)) ? 0 : (_BV(1))) | - (PINB&(_BV(5)) ? 0 : (_BV(2))) | - (PINB&(_BV(4)) ? 0 : (_BV(3))) | - (PINE&(_BV(6)) ? 0 : (_BV(4))) | + return ((PINB&(_BV(4)) ? 0 : (_BV(0))) | + (PINB&(_BV(5)) ? 0 : (_BV(1))) | + (PINB&(_BV(6)) ? 0 : (_BV(2))) | + (PINB&(_BV(7)) ? 0 : (_BV(3))) | + (PINC&(_BV(6)) ? 0 : (_BV(4))) | (PIND&(_BV(4)) ? 0 : (_BV(5))) | - (PINB&(_BV(6)) ? 0 : (_BV(6))) | - (PINF&(_BV(6)) ? 0 : (_BV(7))) | - (PINF&(_BV(7)) ? 0 : (_BV(8))) | - (PIND&(_BV(6)) ? 0 : (_BV(9))) | - (PINB&(_BV(7)) ? 0 : (_BV(10)))); + (PIND&(_BV(6)) ? 0 : (_BV(6))) | + (PIND&(_BV(7)) ? 0 : (_BV(7))) | + (PINE&(_BV(6)) ? 0 : (_BV(8))) | + (PINF&(_BV(6)) ? 0 : (_BV(9))) | + (PINF&(_BV(7)) ? 0 : (_BV(10)))); } void Atreus::readMatrixRow(uint8_t current_row) diff --git a/src/kaleidoscope/hardware/Atreus.h b/src/kaleidoscope/hardware/Atreus.h index 47718a67..aab63db2 100644 --- a/src/kaleidoscope/hardware/Atreus.h +++ b/src/kaleidoscope/hardware/Atreus.h @@ -143,10 +143,10 @@ class Atreus { R3C0, R3C1, R3C2, R3C3, R3C4, R3C5, R3C6, R3C7, R3C8, R3C9, R3C10, R3C11 \ ) \ { \ - { R0C0, R0C1, R0C2, R0C3, R0C4, XXX, R0C7, R0C8, R0C9, R0C10, R0C11 }, \ - { R1C0, R1C1, R1C2, R1C3, R1C4, XXX, R1C7, R1C8, R1C9, R1C10, R1C11 }, \ - { R2C0, R2C1, R2C2, R2C3, R2C4, R3C5, R2C7, R2C8, R2C9, R2C10, R2C11 }, \ - { R3C0, R3C1, R3C2, R3C3, R3C4, R3C6, R3C7, R3C8, R3C9, R3C10, R3C11 } \ + { R0C3, R0C2, R0C7, R0C11, R0C1, XXX, R0C10, R0C0, R0C4, R0C8, R0C9 }, \ + { R1C3, R1C2, R1C7, R1C11, R1C1, XXX, R1C10, R1C0, R1C4, R1C8, R1C9 }, \ + { R2C3, R2C2, R2C7, R2C11, R2C1, R3C5, R2C10, R2C0, R2C4, R2C8, R2C9 }, \ + { R3C3, R3C2, R3C7, R3C11, R3C1, R3C6, R3C10, R3C0, R3C4, R3C8, R3C9 } \ } #define KEYMAP_STACKED( \ @@ -161,12 +161,11 @@ class Atreus { R3C6, R3C7, R3C8, R3C9, R3C10, R3C11 \ ) \ { \ - { R0C0, R0C1, R0C2, R0C3, R0C4, XXX, R0C7, R0C8, R0C9, R0C10, R0C11 }, \ - { R1C0, R1C1, R1C2, R1C3, R1C4, XXX, R1C7, R1C8, R1C9, R1C10, R1C11 }, \ - { R2C0, R2C1, R2C2, R2C3, R2C4, R3C5, R2C7, R2C8, R2C9, R2C10, R2C11 }, \ - { R3C0, R3C1, R3C2, R3C3, R3C4, R3C6, R3C7, R3C8, R3C9, R3C10, R3C11 } \ + { R0C3, R0C2, R0C7, R0C11, R0C1, XXX, R0C10, R0C0, R0C4, R0C8, R0C9 }, \ + { R1C3, R1C2, R1C7, R1C11, R1C1, XXX, R1C10, R1C0, R1C4, R1C8, R1C9 }, \ + { R2C3, R2C2, R2C7, R2C11, R2C1, R3C5, R2C10, R2C0, R2C4, R2C8, R2C9 }, \ + { R3C3, R3C2, R3C7, R3C11, R3C1, R3C6, R3C10, R3C0, R3C4, R3C8, R3C9 } \ } - } } From e28e1290333de0461672f674db17d49e9f97e019 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 12 Sep 2018 16:18:52 +0200 Subject: [PATCH 29/44] Lower the debounce time to 3 cycles instead of 5. Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/Atreus.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/kaleidoscope/hardware/Atreus.cpp b/src/kaleidoscope/hardware/Atreus.cpp index 1fd8cede..13217910 100644 --- a/src/kaleidoscope/hardware/Atreus.cpp +++ b/src/kaleidoscope/hardware/Atreus.cpp @@ -42,7 +42,7 @@ uint16_t Atreus::keyState_[ROWS]; uint16_t Atreus::masks_[ROWS]; uint8_t Atreus::debounce_matrix_[ROWS][COLS]; -uint8_t Atreus::debounce = 5; +uint8_t Atreus::debounce = 3; void Atreus::setup(void) { wdt_disable(); From 575fbc6bb190a185b26d2065646d7a563d1dbfcc Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 10 Oct 2018 06:27:05 +0200 Subject: [PATCH 30/44] Travis cleanup Remove the IRC notifications from Travis (we're not using IRC anymore). Signed-off-by: Gergely Nagy --- .travis.yml | 7 ------- 1 file changed, 7 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 From e5019aed369905e0945e6c0f6bd50dafc8911636 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 10 Oct 2018 06:28:25 +0200 Subject: [PATCH 31/44] Travis cleanup Remove the IRC notifications from Travis (we're not using IRC anymore). Signed-off-by: Gergely Nagy --- .travis.yml | 7 ------- 1 file changed, 7 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 From 1b6620f5542e8b53de08ae3ab069910c588719fe Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 16 Oct 2018 07:37:26 +0200 Subject: [PATCH 32/44] hardware::Atreus: Adjust a header path Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/Atreus.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/kaleidoscope/hardware/Atreus.h b/src/kaleidoscope/hardware/Atreus.h index aab63db2..c60b7330 100644 --- a/src/kaleidoscope/hardware/Atreus.h +++ b/src/kaleidoscope/hardware/Atreus.h @@ -29,7 +29,7 @@ #define HARDWARE_IMPLEMENTATION kaleidoscope::hardware::Atreus #include "Kaleidoscope-HIDAdaptor-KeyboardioHID.h" -#include "macro_helpers.h" +#include "kaleidoscope/macro_helpers.h" struct cRGB { uint8_t r, g, b; From f1298c52ba244df47c3410d49ed51168337000e2 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 16 Oct 2018 07:39:59 +0200 Subject: [PATCH 33/44] hardware::ErgoDox: Use the new path for macro_helpers.h Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/ErgoDox.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/kaleidoscope/hardware/ErgoDox.h b/src/kaleidoscope/hardware/ErgoDox.h index 83b3021d..243f6138 100644 --- a/src/kaleidoscope/hardware/ErgoDox.h +++ b/src/kaleidoscope/hardware/ErgoDox.h @@ -32,7 +32,7 @@ #define HARDWARE_IMPLEMENTATION kaleidoscope::hardware::ErgoDox #include "Kaleidoscope-HIDAdaptor-KeyboardioHID.h" -#include "macro_helpers.h" +#include "kaleidoscope/macro_helpers.h" struct cRGB { uint8_t r, g, b; From 86d014e7e11950bc9f49b9d96e5b3a6e688e0616 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 16 Oct 2018 18:29:14 +0200 Subject: [PATCH 34/44] hardware::Atreus: Make cpplint happy Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/Atreus.cpp | 2 +- src/kaleidoscope/hardware/Atreus.h | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/kaleidoscope/hardware/Atreus.cpp b/src/kaleidoscope/hardware/Atreus.cpp index 13217910..934204be 100644 --- a/src/kaleidoscope/hardware/Atreus.cpp +++ b/src/kaleidoscope/hardware/Atreus.cpp @@ -73,7 +73,7 @@ void Atreus::setup(void) { TCCR1B = _BV(WGM13); TCCR1A = 0; - const unsigned long cycles = (F_CPU / 2000000) * 500; + const uint32_t cycles = (F_CPU / 2000000) * 500; ICR1 = cycles; TCCR1B = _BV(WGM13) | _BV(CS10); diff --git a/src/kaleidoscope/hardware/Atreus.h b/src/kaleidoscope/hardware/Atreus.h index c60b7330..1165b7ba 100644 --- a/src/kaleidoscope/hardware/Atreus.h +++ b/src/kaleidoscope/hardware/Atreus.h @@ -46,14 +46,14 @@ namespace hardware { class Atreus { public: - Atreus(void) {}; + Atreus(void) {} - void syncLeds(void) {}; - void setCrgbAt(byte row, byte col, cRGB color) {}; - void setCrgbAt(uint8_t i, cRGB crgb) {}; + void syncLeds(void) {} + void setCrgbAt(byte row, byte col, cRGB color) {} + void setCrgbAt(uint8_t i, cRGB crgb) {} cRGB getCrgbAt(uint8_t i) { return CRGB(0, 0, 0); - }; + } void scanMatrix(void); void readMatrix(void); From 9506e2b70b8c81a82431bf66ec9c94b47f5e4688 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 16 Oct 2018 18:30:26 +0200 Subject: [PATCH 35/44] hardware::ErgoDox: Make cpplint happy Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/ErgoDox.cpp | 2 +- src/kaleidoscope/hardware/ErgoDox.h | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/kaleidoscope/hardware/ErgoDox.cpp b/src/kaleidoscope/hardware/ErgoDox.cpp index 7cd1f46b..b05a82b9 100644 --- a/src/kaleidoscope/hardware/ErgoDox.cpp +++ b/src/kaleidoscope/hardware/ErgoDox.cpp @@ -68,7 +68,7 @@ void ErgoDox::setup(void) { TCCR1B = _BV(WGM13); TCCR1A = 0; - const unsigned long cycles = (F_CPU / 2000000) * 500; + const uint32_t cycles = (F_CPU / 2000000) * 500; ICR1 = cycles; TCCR1B = _BV(WGM13) | _BV(CS10); diff --git a/src/kaleidoscope/hardware/ErgoDox.h b/src/kaleidoscope/hardware/ErgoDox.h index 243f6138..da48c126 100644 --- a/src/kaleidoscope/hardware/ErgoDox.h +++ b/src/kaleidoscope/hardware/ErgoDox.h @@ -49,14 +49,14 @@ namespace hardware { class ErgoDox { public: - ErgoDox(void) {}; + ErgoDox(void) {} - void syncLeds(void) {}; - void setCrgbAt(byte row, byte col, cRGB color) {}; - void setCrgbAt(uint8_t i, cRGB crgb) {}; + void syncLeds(void) {} + void setCrgbAt(byte row, byte col, cRGB color) {} + void setCrgbAt(uint8_t i, cRGB crgb) {} cRGB getCrgbAt(uint8_t i) { return CRGB(0, 0, 0); - }; + } void scanMatrix(void); void readMatrix(void); From febf2babbc0e11803db7ae1bd586c505dbee7404 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 16 Oct 2018 18:15:19 -0700 Subject: [PATCH 36/44] astyle --- examples/Atreus/Atreus.ino | 10 +-- src/kaleidoscope/hardware/Atreus.cpp | 105 +++++++++++++-------------- 2 files changed, 56 insertions(+), 59 deletions(-) diff --git a/examples/Atreus/Atreus.ino b/examples/Atreus/Atreus.ino index e6dc9a8d..373f09ac 100644 --- a/examples/Atreus/Atreus.ino +++ b/examples/Atreus/Atreus.ino @@ -82,11 +82,11 @@ KALEIDOSCOPE_INIT_PLUGINS(Macros); const macro_t *macroAction(uint8_t macroIndex, uint8_t keyState) { switch (macroIndex) { - case RESET: - Atreus.resetDevice(); - break; - default: - break; + case RESET: + Atreus.resetDevice(); + break; + default: + break; } return MACRO_NONE; diff --git a/src/kaleidoscope/hardware/Atreus.cpp b/src/kaleidoscope/hardware/Atreus.cpp index 934204be..c4c52086 100644 --- a/src/kaleidoscope/hardware/Atreus.cpp +++ b/src/kaleidoscope/hardware/Atreus.cpp @@ -48,7 +48,7 @@ void Atreus::setup(void) { wdt_disable(); delay(100); - for (uint8_t i=0; i < ROWS; i++) { + for (uint8_t i = 0; i < ROWS; i++) { unselectRow(i); keyState_[i] = previousKeyState_[i] = 0; } @@ -80,70 +80,67 @@ void Atreus::setup(void) { TIMSK1 = _BV(TOIE1); } -void Atreus::selectRow(uint8_t row) -{ +void Atreus::selectRow(uint8_t row) { switch (row) { - case 0: - DDRD |= (_BV(0)); - PORTD &= ~(_BV(0)); - break; - case 1: - DDRD |= (_BV(1)); - PORTD &= ~(_BV(1)); - break; - case 2: - DDRD |= (_BV(3)); - PORTD &= ~(_BV(3)); - break; - case 3: - DDRD |= (_BV(2)); - PORTD &= ~(_BV(2)); - break; - default: - break; + case 0: + DDRD |= (_BV(0)); + PORTD &= ~(_BV(0)); + break; + case 1: + DDRD |= (_BV(1)); + PORTD &= ~(_BV(1)); + break; + case 2: + DDRD |= (_BV(3)); + PORTD &= ~(_BV(3)); + break; + case 3: + DDRD |= (_BV(2)); + PORTD &= ~(_BV(2)); + break; + default: + break; } } -void Atreus::unselectRow(uint8_t row) -{ +void Atreus::unselectRow(uint8_t row) { switch (row) { - case 0: - DDRD &= ~(_BV(0)); - PORTD |= (_BV(0)); - break; - case 1: - DDRD &= ~(_BV(1)); - PORTD |= (_BV(1)); - break; - case 2: - DDRD &= ~(_BV(3)); - PORTD |= (_BV(3)); - break; - case 3: - DDRD &= ~(_BV(2)); - PORTD |= (_BV(2)); - break; - default: - break; + case 0: + DDRD &= ~(_BV(0)); + PORTD |= (_BV(0)); + break; + case 1: + DDRD &= ~(_BV(1)); + PORTD |= (_BV(1)); + break; + case 2: + DDRD &= ~(_BV(3)); + PORTD |= (_BV(3)); + break; + case 3: + DDRD &= ~(_BV(2)); + PORTD |= (_BV(2)); + break; + default: + break; } } uint16_t Atreus::readCols() { - return ((PINB&(_BV(4)) ? 0 : (_BV(0))) | - (PINB&(_BV(5)) ? 0 : (_BV(1))) | - (PINB&(_BV(6)) ? 0 : (_BV(2))) | - (PINB&(_BV(7)) ? 0 : (_BV(3))) | - (PINC&(_BV(6)) ? 0 : (_BV(4))) | - (PIND&(_BV(4)) ? 0 : (_BV(5))) | - (PIND&(_BV(6)) ? 0 : (_BV(6))) | - (PIND&(_BV(7)) ? 0 : (_BV(7))) | - (PINE&(_BV(6)) ? 0 : (_BV(8))) | - (PINF&(_BV(6)) ? 0 : (_BV(9))) | - (PINF&(_BV(7)) ? 0 : (_BV(10)))); + return ((PINB & (_BV(4)) ? 0 : (_BV(0))) | + (PINB & (_BV(5)) ? 0 : (_BV(1))) | + (PINB & (_BV(6)) ? 0 : (_BV(2))) | + (PINB & (_BV(7)) ? 0 : (_BV(3))) | + (PINC & (_BV(6)) ? 0 : (_BV(4))) | + (PIND & (_BV(4)) ? 0 : (_BV(5))) | + (PIND & (_BV(6)) ? 0 : (_BV(6))) | + (PIND & (_BV(7)) ? 0 : (_BV(7))) | + (PINE & (_BV(6)) ? 0 : (_BV(8))) | + (PINF & (_BV(6)) ? 0 : (_BV(9))) | + (PINF & (_BV(7)) ? 0 : (_BV(10)))); } -void Atreus::readMatrixRow(uint8_t current_row) -{ +void Atreus::readMatrixRow(uint8_t current_row) { uint16_t mask, cols; previousKeyState_[current_row] = keyState_[current_row]; From bb1417ce7549cae4e69916891e3bb4de954fdecf Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 19 Oct 2018 08:19:23 +0200 Subject: [PATCH 37/44] hardware::Atreus: Implement a dummy getLedIndex() Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/Atreus.h | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/kaleidoscope/hardware/Atreus.h b/src/kaleidoscope/hardware/Atreus.h index 1165b7ba..3236f8be 100644 --- a/src/kaleidoscope/hardware/Atreus.h +++ b/src/kaleidoscope/hardware/Atreus.h @@ -54,6 +54,9 @@ class Atreus { cRGB getCrgbAt(uint8_t i) { return CRGB(0, 0, 0); } + uint8_t getLedIndex(byte row, byte col) { + return 0; + } void scanMatrix(void); void readMatrix(void); From 3e6b3539cecf4eafbfa598f9e4eed4e269789a6e Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 17 Oct 2018 00:31:42 +0200 Subject: [PATCH 38/44] Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/Hardware-Technomancy-Atreus.md`. This is in preparation of merging plugins into a single monorepo. Signed-off-by: Gergely Nagy --- README.md | 11 ++++------- doc/plugin/Hardware-Technomancy-Atreus.md | 11 +++++++++++ .../Atreus/.kaleidoscope-builder.conf | 0 3 files changed, 15 insertions(+), 7 deletions(-) create mode 100644 doc/plugin/Hardware-Technomancy-Atreus.md rename .kaleidoscope-builder.conf => examples/Atreus/.kaleidoscope-builder.conf (100%) diff --git a/README.md b/README.md index fb7fcfc1..0b635026 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,8 @@ # Kaleidoscope-Hardware-Technomancy-Atreus -This is a plugin for [Kaleidoscope][fw], that adds hardware support for the -[Atreus][atreus]. Supported models include post-2016 PCB variants with an A* -MCU, and the hand-wired variant from [FalbaTech][falba] with a Teensy2. +[![Build Status][travis:image]][travis:status] -PCBs prior to 2016, and the legacy teensy2 variants are not supported. + [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-Hardware-Technomancy-Atreus.svg?branch=master + [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-Hardware-Technomancy-Atreus - [fw]: https://github.com/keyboardio/Kaleidoscope - [atreus]: https://atreus.technomancy.us/ - [falba]: https://falba.tech/ +See [doc/plugin/Hardware-Technomancy-Atreus.md](doc/plugin/Hardware-Technomancy-Atreus.md) for documentation. diff --git a/doc/plugin/Hardware-Technomancy-Atreus.md b/doc/plugin/Hardware-Technomancy-Atreus.md new file mode 100644 index 00000000..fb7fcfc1 --- /dev/null +++ b/doc/plugin/Hardware-Technomancy-Atreus.md @@ -0,0 +1,11 @@ +# Kaleidoscope-Hardware-Technomancy-Atreus + +This is a plugin for [Kaleidoscope][fw], that adds hardware support for the +[Atreus][atreus]. Supported models include post-2016 PCB variants with an A* +MCU, and the hand-wired variant from [FalbaTech][falba] with a Teensy2. + +PCBs prior to 2016, and the legacy teensy2 variants are not supported. + + [fw]: https://github.com/keyboardio/Kaleidoscope + [atreus]: https://atreus.technomancy.us/ + [falba]: https://falba.tech/ diff --git a/.kaleidoscope-builder.conf b/examples/Atreus/.kaleidoscope-builder.conf similarity index 100% rename from .kaleidoscope-builder.conf rename to examples/Atreus/.kaleidoscope-builder.conf From d9cb9f4298d26b079cb4a0cd92d736e21e773ad0 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 17 Oct 2018 00:31:51 +0200 Subject: [PATCH 39/44] Remove files we do not need in the monorepo Signed-off-by: Gergely Nagy --- .gitignore | 1 - .travis.yml | 14 - CONTRIBUTING.md | 50 ---- COPYING | 674 --------------------------------------------- Makefile | 14 - README.md | 8 - library.properties | 9 - 7 files changed, 770 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 2c04c9d8..00000000 --- a/.gitignore +++ /dev/null @@ -1 +0,0 @@ -/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 0b635026..00000000 --- a/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# Kaleidoscope-Hardware-Technomancy-Atreus - -[![Build Status][travis:image]][travis:status] - - [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-Hardware-Technomancy-Atreus.svg?branch=master - [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-Hardware-Technomancy-Atreus - -See [doc/plugin/Hardware-Technomancy-Atreus.md](doc/plugin/Hardware-Technomancy-Atreus.md) for documentation. diff --git a/library.properties b/library.properties deleted file mode 100644 index 6818af5d..00000000 --- a/library.properties +++ /dev/null @@ -1,9 +0,0 @@ -name=Kaleidoscope-Hardware-Technomancy-Atreus -version=0.0.1 -author=Gergely Nagy -maintainer=Gergely Nagy -sentence=Atreus Hardware support for Kaleidoscope. -paragraph=... -category=Communication -url=https://github.com/keyboardio/Kaleidoscope-Hardware-Technomancy-Atreus -architectures=avr From 954a5f3091b269f6d91602675f027dbae5b091d6 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 19 Oct 2018 08:25:22 +0200 Subject: [PATCH 40/44] hardware::Atreus: Only compile the plugin when building for Atreus With moving to a monorepo, the plugin will always be compiled, so we want to guard ourselves, to only compile when building for the Atreus. We do this with an `#ifdef ARDUINO_AVR_ATREUS` guard. Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/Atreus.cpp | 4 ++++ src/kaleidoscope/hardware/Atreus.h | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/src/kaleidoscope/hardware/Atreus.cpp b/src/kaleidoscope/hardware/Atreus.cpp index c4c52086..db5219cb 100644 --- a/src/kaleidoscope/hardware/Atreus.cpp +++ b/src/kaleidoscope/hardware/Atreus.cpp @@ -24,6 +24,8 @@ * along with this program. If not, see . */ +#ifdef ARDUINO_AVR_ATREUS + #include #include #include @@ -291,3 +293,5 @@ void Atreus::debounceRow(uint16_t change, uint8_t row) { HARDWARE_IMPLEMENTATION KeyboardHardware; kaleidoscope::hardware::Atreus &Atreus = KeyboardHardware; + +#endif diff --git a/src/kaleidoscope/hardware/Atreus.h b/src/kaleidoscope/hardware/Atreus.h index 3236f8be..744ada74 100644 --- a/src/kaleidoscope/hardware/Atreus.h +++ b/src/kaleidoscope/hardware/Atreus.h @@ -24,6 +24,8 @@ #pragma once +#ifdef ARDUINO_AVR_ATREUS + #include #define HARDWARE_IMPLEMENTATION kaleidoscope::hardware::Atreus @@ -234,3 +236,5 @@ constexpr byte R3C10 = keyIndex(3, 10); constexpr byte R3C11 = keyIndex(3, 11); extern kaleidoscope::hardware::Atreus &Atreus; + +#endif From 819c2c6a3426ab3882ba9d5f29ad25e26d0db281 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 17 Oct 2018 00:35:09 +0200 Subject: [PATCH 41/44] Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/Hardware-EZ-ErgoDox.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 | 10 ++++++---- doc/plugin/Hardware-EZ-ErgoDox.md | 6 ++++++ .../ErgoDox/.kaleidoscope-builder.conf | 0 src/kaleidoscope/hardware/ErgoDox.cpp | 2 +- src/kaleidoscope/hardware/ErgoDox.h | 2 +- .../hardware/{ => ErgoDox}/ErgoDoxScanner.cpp | 4 ++-- .../hardware/{ => ErgoDox}/ErgoDoxScanner.h | 0 src/kaleidoscope/hardware/{ => ErgoDox}/i2cmaster.cpp | 2 +- src/kaleidoscope/hardware/{ => ErgoDox}/i2cmaster.h | 0 9 files changed, 17 insertions(+), 9 deletions(-) create mode 100644 doc/plugin/Hardware-EZ-ErgoDox.md rename .kaleidoscope-builder.conf => examples/ErgoDox/.kaleidoscope-builder.conf (100%) rename src/kaleidoscope/hardware/{ => ErgoDox}/ErgoDoxScanner.cpp (97%) rename src/kaleidoscope/hardware/{ => ErgoDox}/ErgoDoxScanner.h (100%) rename src/kaleidoscope/hardware/{ => ErgoDox}/i2cmaster.cpp (99%) rename src/kaleidoscope/hardware/{ => ErgoDox}/i2cmaster.h (100%) diff --git a/README.md b/README.md index e2ded6bb..b2eb1b79 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ -# Kaleidoscope-Hardware-ErgoDox +# Kaleidoscope-Hardware-EZ-ErgoDox -This is a plugin for [Kaleidoscope][fw], that adds hardware support for -the ErgoDox. +[![Build Status][travis:image]][travis:status] - [fw]: https://github.com/keyboardio/Kaleidoscope + [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-Hardware-EZ-ErgoDox.svg?branch=master + [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-Hardware-EZ-ErgoDox + +See [doc/plugin/Hardware-EZ-ErgoDox.md](doc/plugin/Hardware-EZ-ErgoDox.md) for documentation. diff --git a/doc/plugin/Hardware-EZ-ErgoDox.md b/doc/plugin/Hardware-EZ-ErgoDox.md new file mode 100644 index 00000000..e2ded6bb --- /dev/null +++ b/doc/plugin/Hardware-EZ-ErgoDox.md @@ -0,0 +1,6 @@ +# Kaleidoscope-Hardware-ErgoDox + +This is a plugin for [Kaleidoscope][fw], that adds hardware support for +the ErgoDox. + + [fw]: https://github.com/keyboardio/Kaleidoscope diff --git a/.kaleidoscope-builder.conf b/examples/ErgoDox/.kaleidoscope-builder.conf similarity index 100% rename from .kaleidoscope-builder.conf rename to examples/ErgoDox/.kaleidoscope-builder.conf diff --git a/src/kaleidoscope/hardware/ErgoDox.cpp b/src/kaleidoscope/hardware/ErgoDox.cpp index b05a82b9..3877b3ab 100644 --- a/src/kaleidoscope/hardware/ErgoDox.cpp +++ b/src/kaleidoscope/hardware/ErgoDox.cpp @@ -27,7 +27,7 @@ #include #include #include -#include "ErgoDoxScanner.h" +#include "kaleidoscope/hardware/ErgoDox/ErgoDoxScanner.h" namespace kaleidoscope { namespace hardware { diff --git a/src/kaleidoscope/hardware/ErgoDox.h b/src/kaleidoscope/hardware/ErgoDox.h index da48c126..5b9b2137 100644 --- a/src/kaleidoscope/hardware/ErgoDox.h +++ b/src/kaleidoscope/hardware/ErgoDox.h @@ -27,7 +27,7 @@ #include -#include "ErgoDoxScanner.h" +#include "kaleidoscope/hardware/ErgoDox/ErgoDoxScanner.h" #define HARDWARE_IMPLEMENTATION kaleidoscope::hardware::ErgoDox #include "Kaleidoscope-HIDAdaptor-KeyboardioHID.h" diff --git a/src/kaleidoscope/hardware/ErgoDoxScanner.cpp b/src/kaleidoscope/hardware/ErgoDox/ErgoDoxScanner.cpp similarity index 97% rename from src/kaleidoscope/hardware/ErgoDoxScanner.cpp rename to src/kaleidoscope/hardware/ErgoDox/ErgoDoxScanner.cpp index 869cde34..d48b6d11 100644 --- a/src/kaleidoscope/hardware/ErgoDoxScanner.cpp +++ b/src/kaleidoscope/hardware/ErgoDox/ErgoDoxScanner.cpp @@ -23,9 +23,9 @@ * along with this program. If not, see . */ -#include "ErgoDoxScanner.h" +#include "kaleidoscope/hardware/ErgoDox/ErgoDoxScanner.h" #include -#include "i2cmaster.h" +#include "kaleidoscope/hardware/ErgoDox/i2cmaster.h" #define I2C_ADDR 0b0100000 #define I2C_ADDR_WRITE ( (I2C_ADDR<<1) | I2C_WRITE ) diff --git a/src/kaleidoscope/hardware/ErgoDoxScanner.h b/src/kaleidoscope/hardware/ErgoDox/ErgoDoxScanner.h similarity index 100% rename from src/kaleidoscope/hardware/ErgoDoxScanner.h rename to src/kaleidoscope/hardware/ErgoDox/ErgoDoxScanner.h diff --git a/src/kaleidoscope/hardware/i2cmaster.cpp b/src/kaleidoscope/hardware/ErgoDox/i2cmaster.cpp similarity index 99% rename from src/kaleidoscope/hardware/i2cmaster.cpp rename to src/kaleidoscope/hardware/ErgoDox/i2cmaster.cpp index 267848c1..83226857 100644 --- a/src/kaleidoscope/hardware/i2cmaster.cpp +++ b/src/kaleidoscope/hardware/ErgoDox/i2cmaster.cpp @@ -9,7 +9,7 @@ #include #include -#include "i2cmaster.h" +#include "kaleidoscope/hardware/ErgoDox/i2cmaster.h" /* define CPU frequency in Mhz here if not defined in Makefile */ diff --git a/src/kaleidoscope/hardware/i2cmaster.h b/src/kaleidoscope/hardware/ErgoDox/i2cmaster.h similarity index 100% rename from src/kaleidoscope/hardware/i2cmaster.h rename to src/kaleidoscope/hardware/ErgoDox/i2cmaster.h From 86dd55d87f54deed77b35b59a1944c073096fc62 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 17 Oct 2018 00:35:12 +0200 Subject: [PATCH 42/44] Remove files we do not need in the monorepo Signed-off-by: Gergely Nagy --- .gitignore | 1 - .travis.yml | 14 - CONTRIBUTING.md | 50 ---- COPYING | 674 --------------------------------------------- Makefile | 14 - README.md | 8 - library.properties | 9 - 7 files changed, 770 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 2c04c9d8..00000000 --- a/.gitignore +++ /dev/null @@ -1 +0,0 @@ -/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 b2eb1b79..00000000 --- a/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# Kaleidoscope-Hardware-EZ-ErgoDox - -[![Build Status][travis:image]][travis:status] - - [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-Hardware-EZ-ErgoDox.svg?branch=master - [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-Hardware-EZ-ErgoDox - -See [doc/plugin/Hardware-EZ-ErgoDox.md](doc/plugin/Hardware-EZ-ErgoDox.md) for documentation. diff --git a/library.properties b/library.properties deleted file mode 100644 index 068dab6c..00000000 --- a/library.properties +++ /dev/null @@ -1,9 +0,0 @@ -name=Kaleidoscope-Hardware-EZ-ErgoDox -version=0.0.1 -author=Gergely Nagy -maintainer=Gergely Nagy -sentence=ErgoDox Hardware support for Kaleidoscope. -paragraph=... -category=Communication -url=https://github.com/keyboardio/Kaleidoscope-Hardware-EZ-ErgoDox -architectures=avr From 1e02f4c8b4044daa08f52736c1f39321f2e9044c Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 19 Oct 2018 08:35:54 +0200 Subject: [PATCH 43/44] hardware::ErgoDox: Only compile the plugin when building for ErgoDox With moving to a monorepo, the plugin will always be compiled, so we want to guard ourselves, to only compile when building for the ErgoDox. We do this with an `#ifdef ARDUINO_AVR_ERGODOX` guard. Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/ErgoDox.cpp | 4 ++++ src/kaleidoscope/hardware/ErgoDox.h | 4 ++++ src/kaleidoscope/hardware/ErgoDox/ErgoDoxScanner.cpp | 4 ++++ src/kaleidoscope/hardware/ErgoDox/ErgoDoxScanner.h | 4 ++++ src/kaleidoscope/hardware/ErgoDox/i2cmaster.cpp | 5 +++++ src/kaleidoscope/hardware/ErgoDox/i2cmaster.h | 4 ++++ 6 files changed, 25 insertions(+) diff --git a/src/kaleidoscope/hardware/ErgoDox.cpp b/src/kaleidoscope/hardware/ErgoDox.cpp index 3877b3ab..706e3a61 100644 --- a/src/kaleidoscope/hardware/ErgoDox.cpp +++ b/src/kaleidoscope/hardware/ErgoDox.cpp @@ -24,6 +24,8 @@ * along with this program. If not, see . */ +#ifdef ARDUINO_AVR_ERGODOX + #include #include #include @@ -248,3 +250,5 @@ uint8_t ErgoDox::pressedKeyswitchCount() { HARDWARE_IMPLEMENTATION KeyboardHardware; kaleidoscope::hardware::ErgoDox &ErgoDox = KeyboardHardware; + +#endif diff --git a/src/kaleidoscope/hardware/ErgoDox.h b/src/kaleidoscope/hardware/ErgoDox.h index 5b9b2137..7b1c3df4 100644 --- a/src/kaleidoscope/hardware/ErgoDox.h +++ b/src/kaleidoscope/hardware/ErgoDox.h @@ -25,6 +25,8 @@ #pragma once +#ifdef ARDUINO_AVR_ERGODOX + #include #include "kaleidoscope/hardware/ErgoDox/ErgoDoxScanner.h" @@ -285,3 +287,5 @@ constexpr byte R5C12 = keyIndex(5, 12); constexpr byte R5C13 = keyIndex(5, 13); extern kaleidoscope::hardware::ErgoDox &ErgoDox; + +#endif diff --git a/src/kaleidoscope/hardware/ErgoDox/ErgoDoxScanner.cpp b/src/kaleidoscope/hardware/ErgoDox/ErgoDoxScanner.cpp index d48b6d11..8969e042 100644 --- a/src/kaleidoscope/hardware/ErgoDox/ErgoDoxScanner.cpp +++ b/src/kaleidoscope/hardware/ErgoDox/ErgoDoxScanner.cpp @@ -23,6 +23,8 @@ * along with this program. If not, see . */ +#ifdef ARDUINO_AVR_ERGODOX + #include "kaleidoscope/hardware/ErgoDox/ErgoDoxScanner.h" #include #include "kaleidoscope/hardware/ErgoDox/i2cmaster.h" @@ -200,3 +202,5 @@ ErgoDoxScanner::reattachExpanderOnError() { } } + +#endif diff --git a/src/kaleidoscope/hardware/ErgoDox/ErgoDoxScanner.h b/src/kaleidoscope/hardware/ErgoDox/ErgoDoxScanner.h index d3a1f1f9..a3c63f06 100644 --- a/src/kaleidoscope/hardware/ErgoDox/ErgoDoxScanner.h +++ b/src/kaleidoscope/hardware/ErgoDox/ErgoDoxScanner.h @@ -25,6 +25,8 @@ #pragma once +#ifdef ARDUINO_AVR_ERGODOX + #include namespace kaleidoscope { @@ -50,3 +52,5 @@ class ErgoDoxScanner { } } + +#endif diff --git a/src/kaleidoscope/hardware/ErgoDox/i2cmaster.cpp b/src/kaleidoscope/hardware/ErgoDox/i2cmaster.cpp index 83226857..74018792 100644 --- a/src/kaleidoscope/hardware/ErgoDox/i2cmaster.cpp +++ b/src/kaleidoscope/hardware/ErgoDox/i2cmaster.cpp @@ -6,6 +6,9 @@ * Target: any AVR device with hardware TWI * Usage: API compatible with I2C Software Library i2cmaster.h **************************************************************************/ + +#ifdef ARDUINO_AVR_ERGODOX + #include #include @@ -196,3 +199,5 @@ unsigned char i2c_readNak(void) { return TWDR; }/* i2c_readNak */ + +#endif diff --git a/src/kaleidoscope/hardware/ErgoDox/i2cmaster.h b/src/kaleidoscope/hardware/ErgoDox/i2cmaster.h index ec356876..65533c59 100644 --- a/src/kaleidoscope/hardware/ErgoDox/i2cmaster.h +++ b/src/kaleidoscope/hardware/ErgoDox/i2cmaster.h @@ -9,6 +9,8 @@ * Usage: see Doxygen manual **************************************************************************/ +#ifdef ARDUINO_AVR_ERGODOX + #ifdef DOXYGEN /** @defgroup pfleury_ic2master I2C Master library @@ -174,3 +176,5 @@ extern unsigned char i2c_read(unsigned char ack); /**@}*/ + +#endif From 6a252cc8ac1e7ca591cb0650d073b497fa3997cf Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 19 Oct 2018 08:36:58 +0200 Subject: [PATCH 44/44] hardware::ErgoDox: Add a dummy getLedIndex() method Signed-off-by: Gergely Nagy --- src/kaleidoscope/hardware/ErgoDox.h | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/kaleidoscope/hardware/ErgoDox.h b/src/kaleidoscope/hardware/ErgoDox.h index 7b1c3df4..5fb36ee3 100644 --- a/src/kaleidoscope/hardware/ErgoDox.h +++ b/src/kaleidoscope/hardware/ErgoDox.h @@ -59,6 +59,9 @@ class ErgoDox { cRGB getCrgbAt(uint8_t i) { return CRGB(0, 0, 0); } + uint8_t getLedIndex(byte row, byte col) { + return 0; + } void scanMatrix(void); void readMatrix(void);