commit 092616039e2467f5a4892f3683d681dc42567957 Author: Dmitry Isaenko Date: Sun Oct 13 02:11:02 2019 +0300 Initial commit diff --git a/KEYCODES_G513.md b/KEYCODES_G513.md new file mode 100644 index 0000000..c866609 --- /dev/null +++ b/KEYCODES_G513.md @@ -0,0 +1,118 @@ +#### Leds + +| LED | Hex | Dec | +|-----------|-------|-------| +| CAPS | 2 | 2 | +| GAME | 3 | 3 | + +#### Keys + +| Key | Hex | Dec | +|---------------|-------|-------| +| a | 4 | 4 | +| b | 5 | 5 | +| c | 6 | 6 | +| d | 7 | 7 | +| e | 8 | 8 | +| f | 9 | 9 | +| g | A | 10 | +| h | B | 11 | +| i | C | 12 | +| j | D | 13 | +| k | E | 14 | +| l | F | 15 | +| m | 10 | 16 | +| n | 11 | 17 | +| o | 12 | 18 | +| p | 13 | 19 | +| q | 14 | 20 | +| r | 15 | 21 | +| s | 16 | 22 | +| t | 17 | 23 | +| u | 18 | 24 | +| v | 19 | 25 | +| w | 1A | 26 | +| x | 1B | 27 | +| y | 1C | 28 | +| z | 1D | 29 | +| 1 | 1E | 30 | +| 2 | 1F | 31 | +| 3 | 20 | 32 | +| 4 | 21 | 33 | +| 5 | 22 | 34 | +| 6 | 23 | 35 | +| 7 | 24 | 36 | +| 8 | 25 | 37 | +| 9 | 26 | 38 | +| 0 | 27 | 39 | +| ENTER | 28 | 40 | +| ESC | 29 | 41 | +| BACKSPACE | 2A | 42 | +| TAB | 2B | 43 | +| SPACE | 2C | 44 | +| - | 2D | 45 | +| = | 2E | 46 | +| [ | 2F | 47 | +| ] | 30 | 48 | +| | | | +| BACKSLASH | 32 | 50 | +| SEMICOLON | 33 | 51 | +| QUOTE | 34 | 52 | +| ~ | 35 | 53 | +| COMMA | 36 | 54 | +| PERIOD | 37 | 55 | +| SLASH | 38 | 56 | +| CAPS | 39 | 57 | +| F1 | 3A | 58 | +| F2 | 3B | 59 | +| F3 | 3C | 60 | +| F4 | 3D | 61 | +| F5 | 3E | 62 | +| F6 | 3F | 63 | +| F7 | 40 | 64 | +| F8 | 41 | 65 | +| F9 | 42 | 66 | +| F10 | 43 | 67 | +| F11 | 44 | 68 | +| F12 | 45 | 69 | +| PRTSCR | 46 | 70 | +| SCROLL | 47 | 71 | +| PAUSE | 48 | 72 | +| INS | 49 | 73 | +| HOME | 4A | 74 | +| PG_UP | 4B | 75 | +| DEL | 4C | 76 | +| END | 4D | 77 | +| PG_DN | 4E | 78 | +| → | 4F | 79 | +| ← | 50 | 80 | +| ↓ | 51 | 81 | +| ↑ | 52 | 82 | +| NUM | 53 | 83 | +| NUM_SLASH | 54 | 84 | +| NUM_ASTERISK| 55 | 85 | +| NUM_MINUS | 56 | 86 | +| NUM_PLUS | 57 | 87 | +| NUM_ENTER | 58 | 88 | +| NUM_1 | 59 | 89 | +| NUM_2 | 5A | 90 | +| NUM_3 | 5B | 91 | +| NUM_4 | 5C | 92 | +| NUM_5 | 5D | 93 | +| NUM_6 | 5E | 94 | +| NUM_7 | 5F | 95 | +| NUM_8 | 60 | 96 | +| NUM_9 | 61 | 97 | +| NUM_0 | 62 | 98 | +| NUM_DOT | 63 | 99 | +| | | | +| MENU | 65 | 101 | +| | | | +| L_CTRL | E0 | 224 | +| L_SHIFT | E1 | 225 | +| L_ALT | E2 | 226 | +| L_WIN | E3 | 227 | +| R_CTRL | E4 | 228 | +| R_SHIFT | E5 | 229 | +| R_ALT | E6 | 230 | +| FN | E7 | 231 | diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9cecc1d --- /dev/null +++ b/LICENSE @@ -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. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + 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: + + {project} Copyright (C) {year} {fullname} + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..757ffdc --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +# LogiLed + +![License](https://img.shields.io/badge/License-GPLv3-blue.svg) [![Releases](https://img.shields.io/github/downloads/developersu/LogiLed/total.svg)]() [![LatestVer](https://img.shields.io/github/release/developersu/LogiLed.svg)]() + +[Support author](#support-this-app) + +LogiLed is a Logitech G513 Carbon GUI driver for adjusting backlight and effects. + +#### License + +[GNU General Public License v3](https://www.gnu.org/licenses/gpl-3.0.html) + +#### Used libraries & resources +* [OpenJFX](https://wiki.openjdk.java.net/display/OpenJFX/Main) +* [usb4java](https://mvnrepository.com/artifact/org.usb4java/usb4java) +* Few icons taken from: [materialdesignicons.com](http://materialdesignicons.com/) +* Special thanks to pioneers and superstars who created, contributed and maintaining [g810-led](https://github.com/MatMoul/g810-led) project! + +### System requirements + +JRE/JDK 8u60 or higher. + +### Usage in Linux + +1. Install JRE/JDK 8u60 or higher (openJDK is good. Oracle's one is also good). JavaFX not needed (it's embedded). + +2. `root # java -jar /path/to/NS-USBloader.jar` + +3. Optional. Add user to 'udev' rules to use NS not-from-root-account +``` +root # vim /etc/udev/rules.d/99-NS.rules +SUBSYSTEM=="usb", ATTRS{idVendor}=="046D", ATTRS{idProduct}=="c33c", GROUP="plugdev" +root # udevadm control --reload-rules && udevadm trigger +``` + +### Building + +`$ mvn package` + +## Support this app + +If you like this app, just give a star. + +Want to support development? Make a donation* (see below): + +[Yandex.Money](https://money.yandex.ru/to/410014301951665) + +[PayPal](https://paypal.me/developersu) + +*Legal information: + +* [EN] Please note! This is non-commercial application. Any received money considered as a gift. +* [RU] Пожалуйста обратите внимание! Это некоммерческое приложение. Перечисляя средства вы совершаете дарение. \ No newline at end of file diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..8c17ad1 --- /dev/null +++ b/pom.xml @@ -0,0 +1,204 @@ + + + 4.0.0 + + loper + LogiLed + 0.1-SNAPSHOT + + + + LogiLed is a Logitech G513 GUI driver for adjusting backlight and effects. + + 2019 + + Dmitry Isaenko + https://developersu.blogspot.com/ + + + + + GNU General Public License v3 + http://www.gnu.org/licenses/gpl.txt + manual + + + + + + developer.su + Dmitry Isaenko + + Developer + + +3 + https://developersu.blogspot.com/ + + + + + UTF-8 + + + + GitHub + https://github.com/developer_su/${project.artifactId}/issues + + + + + + org.openjfx + javafx-controls + 11 + linux + compile + + + org.openjfx + javafx-media + 11 + linux + compile + + + org.openjfx + javafx-fxml + 11 + linux + compile + + + org.openjfx + javafx-graphics + 11 + linux + compile + + + + org.openjfx + javafx-controls + 11 + win + compile + + + org.openjfx + javafx-media + 11 + win + compile + + + org.openjfx + javafx-fxml + 11 + win + compile + + + org.openjfx + javafx-graphics + 11 + win + compile + + + + org.openjfx + javafx-controls + 11 + mac + compile + + + org.openjfx + javafx-media + 11 + mac + compile + + + org.openjfx + javafx-fxml + 11 + mac + compile + + + org.openjfx + javafx-graphics + 11 + mac + compile + + + + + org.usb4java + usb4java + 1.3.0 + compile + + + + + + + org.apache.maven.plugins + maven-compiler-plugin + 3.1 + + 1.8 + 1.8 + + + + + maven-jar-plugin + 2.4 + + + default-jar + none + + + + + + org.apache.maven.plugins + maven-assembly-plugin + 3.1.0 + + + + logiled.Main + + + + jar-with-dependencies + + + + + make-assembly + package + + single + + + + + + + \ No newline at end of file diff --git a/src/main/java/logiled/About/AboutController.java b/src/main/java/logiled/About/AboutController.java new file mode 100644 index 0000000..c33dd8a --- /dev/null +++ b/src/main/java/logiled/About/AboutController.java @@ -0,0 +1,66 @@ +package logiled.About; + +import javafx.application.HostServices; +import javafx.fxml.FXML; +import javafx.fxml.Initializable; +import javafx.scene.control.Button; +import javafx.scene.control.Hyperlink; +import javafx.scene.control.Label; +import javafx.stage.Stage; +import logiled.MainFx; +import logiled.Mediator; + +import java.net.URL; +import java.util.ResourceBundle; + + +public class AboutController implements Initializable { + + @FXML + private Button buttonOk; + + @FXML + private Label versionLbl; + + @FXML + private Hyperlink iconsMaterialHLink, + usb4JavaHLink, + gitHubHLink, + blogspotHLink; + + @Override + public void initialize(URL url, ResourceBundle resourceBundle) { + versionLbl.setText(MainFx.appVersion); + + HostServices hs = Mediator.getInstance().getHostServices(); + + iconsMaterialHLink.setOnAction(ActionEvent-> { + try { + hs.showDocument("https://materialdesignicons.com/"); + } catch (Exception ignored){} // No luck for linux =( + }); + usb4JavaHLink.setOnAction(ActionEvent-> { + try { + hs.showDocument("http://usb4java.org/"); + } catch (Exception ignored){} // No luck for linux =( + }); + gitHubHLink.setOnAction(ActionEvent-> { + try { + hs.showDocument("https://github.com/developersu/LoLed"); + } catch (Exception ignored){} // No luck for linux =( + }); + blogspotHLink.setOnAction(ActionEvent-> { + try { + hs.showDocument("https://developersu.blogspot.com/"); + } catch (Exception ignored){} // No luck for linux =( + }); + } + /** + * Set 'Exit' action when 'Ok' clicked + * */ + @FXML + private void buttonClickOk(){ + Stage thisStage = (Stage) buttonOk.getScene().getWindow(); + thisStage.close(); + } +} diff --git a/src/main/java/logiled/About/AboutWindow.java b/src/main/java/logiled/About/AboutWindow.java new file mode 100644 index 0000000..3bddb8a --- /dev/null +++ b/src/main/java/logiled/About/AboutWindow.java @@ -0,0 +1,44 @@ +package logiled.About; + +import javafx.fxml.FXMLLoader; +import javafx.scene.Parent; +import javafx.scene.Scene; +import javafx.scene.image.Image; +import javafx.stage.Stage; + +import java.io.IOException; +import java.util.Locale; +import java.util.ResourceBundle; + +public class AboutWindow { + + public AboutWindow(){ + Stage stageAbout = new Stage(); + + stageAbout.setMinWidth(500); + stageAbout.setMinHeight(500); + + FXMLLoader loaderAbout = new FXMLLoader(getClass().getResource("/AboutLayout.fxml")); + ResourceBundle resourceBundle; + + Locale userLocale = new Locale(Locale.getDefault().getISO3Language()); // NOTE: user locale based on ISO3 Language codes + resourceBundle = ResourceBundle.getBundle("locale", userLocale); + loaderAbout.setResources(resourceBundle); + + try { + Parent parentAbout = loaderAbout.load(); + + stageAbout.setTitle(resourceBundle.getString("menu_item_about")); + stageAbout.getIcons().addAll( + new Image(getClass().getResourceAsStream("/ico/appIcon_32.png")), + new Image(getClass().getResourceAsStream("/ico/appIcon_48.png")), + new Image(getClass().getResourceAsStream("/ico/appIcon_64.png")), + new Image(getClass().getResourceAsStream("/ico/appIcon_128.png")) + ); + stageAbout.setScene(new Scene(parentAbout, 500, 500)); + + stageAbout.show(); + + } catch (IOException ignored){} + } +} diff --git a/src/main/java/logiled/Controllers/KbrdController.java b/src/main/java/logiled/Controllers/KbrdController.java new file mode 100644 index 0000000..f023e72 --- /dev/null +++ b/src/main/java/logiled/Controllers/KbrdController.java @@ -0,0 +1,96 @@ +package logiled.Controllers; + +import javafx.collections.ListChangeListener; +import javafx.event.ActionEvent; +import javafx.fxml.FXML; +import javafx.fxml.Initializable; +import javafx.scene.Node; +import javafx.scene.control.*; +import javafx.scene.layout.VBox; + +import java.net.URL; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.ResourceBundle; + +public class KbrdController implements Initializable { + + @FXML + private Button + k_esc, k_f1, k_f2, k_f3, k_f4, k_f5, k_f6, k_f7, k_f8, k_f9, k_f10, k_f11, k_f12, + k_1, k_2, k_3, k_4, k_5, k_6, k_7, k_8, k_9, k_0, k_dash, k_equal, k_backspace, + k_tab, k_q, k_w, k_e, k_r, k_t, k_y, k_u, k_i, k_o, k_p, k_bracket_open, k_bracket_close, k_backslash, + k_caps, k_a, k_s, k_d, k_f, k_g, k_h, k_j, k_k, k_l, k_semicolon, k_quotation, k_enter, + k_l_shift, k_z, k_x, k_c, k_v, k_b, k_n, k_m, k_comma, k_dot, k_shash, k_r_shift, + k_l_ctrl, k_win, k_l_alt, k_space, k_r_alt, k_fn, k_menu, k_r_ctrl, + k_prtscr, k_scrl, k_pause, k_tilde, k_ins, k_home, k_pg_up, k_del, k_pg_dn, + k_arr_up, k_arr_down, k_arr_left, k_arr_right, k_end, + k_num, k_num_slash, k_num_asterisk, k_num_minus, k_num_9, k_num_8, k_num_7, k_num_6, k_num_5, k_num_4, k_num_3, k_num_2, k_num_1, k_num_0, k_num_period, k_num_enter, k_num_plus, + l_game, l_caps; + @FXML + private Button addRuleBtn, remRuleBtn; + + @FXML + private VBox rulesVBox; + + @Override + public void initialize(URL url, ResourceBundle resourceBundle) { + rulesVBox.getChildren().addListener(new ListChangeListener() { + @Override + public void onChanged(Change change) { + change.next(); // Get changes + if (change.wasAdded()){ // If something added, turn on ability to remove such rule + remRuleBtn.setDisable(false); + return; + } // Otherwise, check if we have anything inside the pane + if (rulesVBox.getChildren().isEmpty()) // If so, select latest available 'box' + remRuleBtn.setDisable(true); + else // If the pane is empty, disable 'Remove' button. + RuleBox.select((RuleBox) rulesVBox.getChildren().get(rulesVBox.getChildren().size()-1)); + } + }); + + addRuleBtn.setOnAction(ActionEvent -> rulesVBox.getChildren().add(new RuleBox())); + remRuleBtn.setDisable(true); + remRuleBtn.setOnAction(ActionEvent -> { + if (rulesVBox.getChildren().isEmpty()) + return; + RuleBox box; + if ((box = RuleBox.getSelected()) != null) + box.wipe(); // Reset buttons used for rule + rulesVBox.getChildren().remove(RuleBox.getSelected()); // Remove from pane + }); + } + + @FXML + private void toggleBntAction(ActionEvent event){ + if (rulesVBox.getChildren().isEmpty()) // if we have rule, then we have selected rule (app architecture) + return; + Button btn = (Button) event.getSource(); + RuleBox box; + if ((box = RuleBox.getSelected()) != null) + box.addKey(btn); + } + + public HashMap> getRules(){ + final HashMap> set = new HashMap<>(); + final List keySet = new ArrayList<>(); + final List ledSet = new ArrayList<>(); + + byte[][] keySingleRuleSet; + byte[][] ledSingleRuleSet; + + for (Node box : rulesVBox.getChildren()){ + keySingleRuleSet = ((RuleBox) box).getKeyCodes(); + if (keySingleRuleSet != null) + keySet.add(keySingleRuleSet); + ledSingleRuleSet = ((RuleBox) box).getLedCodes(); + if (ledSingleRuleSet != null) + ledSet.add(ledSingleRuleSet); + } + set.put("Key", keySet); + set.put("Led", ledSet); + return set; + } +} diff --git a/src/main/java/logiled/Controllers/LoCodepage.java b/src/main/java/logiled/Controllers/LoCodepage.java new file mode 100644 index 0000000..d8220a0 --- /dev/null +++ b/src/main/java/logiled/Controllers/LoCodepage.java @@ -0,0 +1,227 @@ +package logiled.Controllers; + +class LoCodepage { + static byte getCode(String id){ + switch (id){ + case "l_game": + return 0x2; + case "l_caps": + return 0x3; + case "k_a": + return 0x4; + case "k_b": + return 0x5; + case "k_c": + return 0x6; + case "k_d": + return 0x7; + case "k_e": + return 0x8; + case "k_f": + return 0x9; + case "k_g": + return 0xA; + case "k_h": + return 0xB; + case "k_i": + return 0xC; + case "k_j": + return 0xD; + case "k_k": + return 0xE; + case "k_l": + return 0xF; + case "k_m": + return 0x10; + case "k_n": + return 0x11; + case "k_o": + return 0x12; + case "k_p": + return 0x13; + case "k_q": + return 0x14; + case "k_r": + return 0x15; + case "k_s": + return 0x16; + case "k_t": + return 0x17; + case "k_u": + return 0x18; + case "k_v": + return 0x19; + case "k_w": + return 0x1A; + case "k_x": + return 0x1B; + case "k_y": + return 0x1C; + case "k_z": + return 0x1D; + case "k_1": + return 0x1E; + case "k_2": + return 0x1F; + case "k_3": + return 0x20; + case "k_4": + return 0x21; + case "k_5": + return 0x22; + case "k_6": + return 0x23; + case "k_7": + return 0x24; + case "k_8": + return 0x25; + case "k_9": + return 0x26; + case "k_0": + return 0x27; + case "k_enter": + return 0x28; + case "k_esc": + return 0x29; + case "k_backspace": + return 0x2a; + case "k_tab": + return 0x2b; + case "k_space": + return 0x2c; + case "k_dash": + return 0x2d; + case "k_equal": + return 0x2e; + case "k_bracket_open": + return 0x2f; + case "k_bracket_close": + return 0x30; + // nothing for 0x31 + case "k_backslash": + return 0x32; // (ISO version only?) + case "k_semicolon": + return 0x33; + case "k_quotation": + return 0x34; + case "k_tilde": + return 0x35; + case "k_comma": + return 0x36; + case "k_dot": + return 0x37; + case "k_shash": + return 0x38; + case "k_caps": + return 0x39; + case "k_f1": + return 0x3a; + case "k_f2": + return 0x3b; + case "k_f3": + return 0x3c; + case "k_f4": + return 0x3d; + case "k_f5": + return 0x3e; + case "k_f6": + return 0x3f; + case "k_f7": + return 0x40; + case "k_f8": + return 0x41; + case "k_f9": + return 0x42; + case "k_f10": + return 0x43; + case "k_f11": + return 0x44; + case "k_f12": + return 0x45; + case "k_prtscr": + return 0x46; + case "k_scrl": + return 0x47; + case "k_pause": + return 0x48; + case "k_ins": + return 0x49; + case "k_home": + return 0x4a; + case "k_pg_up": + return 0x4b; + case "k_del": + return 0x4c; + case "k_end": + return 0x4d; + case "k_pg_dn": + return 0x4e; + case "k_arr_right": + return 0x4f; + case "k_arr_left": + return 0x50; + case "k_arr_down": + return 0x51; + case "k_arr_up": + return 0x52; + case "k_num": + return 0x53; + case "k_num_slash": + return 0x54; + case "k_num_asterisk": + return 0x55; + case "k_num_minus": + return 0x56; + case "k_num_plus": + return 0x57; + /* not confirmed */ + case "k_num_enter": + return 0x58; + case "k_num_1": + return 0x59; + case "k_num_2": + return 0x5a; + case "k_num_3": + return 0x5b; + case "k_num_4": + return 0x5c; + case "k_num_5": + return 0x5d; + case "k_num_6": + return 0x5e; + case "k_num_7": + return 0x5f; + case "k_num_8": + return 0x60; + case "k_num_9": + return 0x61; + case "k_num_0": + return 0x62; + case "k_num_period": + return 0x63; + /*---------------*/ + // nothing for 0x64 (ISO version) + case "k_menu": + return 0x65; + + case "k_l_ctrl": + return (byte) 0xe0; + case "k_l_shift": + return (byte) 0xe1; + case "k_l_alt": + return (byte) 0xe2; + case "k_win": + return (byte) 0xe3; + case "k_r_ctrl": + return (byte) 0xe4; + case "k_r_shift": + return (byte) 0xe5; + case "k_r_alt": + return (byte) 0xe6; + case "k_fn": + return (byte) 0xe7; + default: + return 0x00; // ??? + } + } +} diff --git a/src/main/java/logiled/Controllers/MainController.java b/src/main/java/logiled/Controllers/MainController.java new file mode 100644 index 0000000..cb3bf44 --- /dev/null +++ b/src/main/java/logiled/Controllers/MainController.java @@ -0,0 +1,40 @@ +package logiled.Controllers; + +import javafx.fxml.FXML; +import javafx.fxml.Initializable; +import javafx.scene.control.Button; +import javafx.scene.control.Label; +import javafx.scene.control.MenuItem; +import logiled.About.AboutWindow; +import logiled.MessagesConsumer; +import logiled.USB.Communications; + +import java.net.URL; +import java.util.ResourceBundle; + +public class MainController implements Initializable { + @FXML + private KbrdController KbrdPaneController; + + @FXML + private Button applyBtn; + + @FXML + private Label infoLbl; + + @FXML + private MenuItem aboutMenuItem; + @Override + public void initialize(URL url, ResourceBundle resourceBundle) { + aboutMenuItem.setOnAction(actionEvent -> new AboutWindow()); + MessagesConsumer.getInstance().setInstance(infoLbl); + MessagesConsumer.getInstance().start(); + + applyBtn.setOnAction(actionEvent -> { + Communications communications = new Communications(KbrdPaneController.getRules()); + Thread commThread = new Thread(communications); + commThread.setDaemon(true); + commThread.start(); + }); + } +} diff --git a/src/main/java/logiled/Controllers/RuleBox.java b/src/main/java/logiled/Controllers/RuleBox.java new file mode 100644 index 0000000..4628680 --- /dev/null +++ b/src/main/java/logiled/Controllers/RuleBox.java @@ -0,0 +1,165 @@ +package logiled.Controllers; + +import javafx.geometry.Insets; +import javafx.geometry.Orientation; +import javafx.scene.Node; +import javafx.scene.control.*; +import javafx.scene.layout.FlowPane; +import javafx.scene.layout.HBox; +import javafx.scene.layout.Priority; +import javafx.scene.paint.Color; + +import java.util.ArrayList; +import java.util.List; + +public class RuleBox extends HBox { // todo: add class to selected toggle user data; provide interface to add buttons to selected toggle + + private final static ToggleGroup radioGroup = new ToggleGroup(); + + /** + * Get object (rule) that is currently selected + * */ + public static RuleBox getSelected(){ + Toggle selectedToggle; + if ((selectedToggle = radioGroup.getSelectedToggle()) == null) + return null; + return (RuleBox) selectedToggle.getUserData(); + } + /** + * Select rule + * @param box : the rule that has to be selected. + * */ + public static void select(RuleBox box){ + box.radBtn.setSelected(true); + } + + private final FlowPane flowPaneBox; + private final ColorPicker colorPicker; + private final RadioButton radBtn; + + public RuleBox(){ + super(); + Insets insets = new Insets(3.0, 3.0, 3.0, 3.0); + // Radio button for selecting rule + radBtn = new RadioButton(); + radBtn.setToggleGroup(radioGroup); // Add to our declared group + radBtn.setSelected(true); + // FlowPane for buttons selected for this rule + flowPaneBox = new FlowPane(); + flowPaneBox.setVgap(5.0); + flowPaneBox.setHgap(5.0); + HBox.setHgrow(flowPaneBox, Priority.ALWAYS); + // Set FlowPane where elements would be added + radBtn.setUserData(this); + // Set Color Picker + colorPicker = new ColorPicker(); + colorPicker.setValue(Color.CYAN); // (^-^ ) + colorPicker.setOnAction(ActionEvent-> { + for (Node node : flowPaneBox.getChildren()) + ((Button) ((Object[]) node.getUserData())[0]).setStyle( + String.format(".button:disabled {-fx-background-color: #bdf7ff; -fx-opacity: 1.0; -fx-text-fill: #%02x%02x%02x; -fx-border-color: #%02x%02x%02x;}", + (int) (colorPicker.getValue().getRed()*255), + (int) (colorPicker.getValue().getGreen()*255), + (int) (colorPicker.getValue().getBlue()*255), + (int) (colorPicker.getValue().getRed()*255), + (int) (colorPicker.getValue().getGreen()*255), + (int) (colorPicker.getValue().getBlue()*255)) + ); + }); + // Node that contains elements + this.setPadding(insets); + this.setSpacing(5.0); + this.getChildren().addAll(radBtn, colorPicker, new Separator(Orientation.VERTICAL), flowPaneBox); + } + /** + * Prepare this object to be deleted: release all buttons used etc. + * */ + public void wipe(){ + for (Node node : flowPaneBox.getChildren()) { + Button key = (Button) ((Object[]) node.getUserData())[0]; + key.setStyle(""); + key.setDisable(false); + } + } + /** + * Add button to UI (appears for current rule) + * */ + public void addKey(Button keyBtn){ + keyBtn.setDisable(true); + + keyBtn.setStyle( + String.format(".button:disabled {-fx-background-color: #bdf7ff; -fx-opacity: 1.0; -fx-text-fill: #%02x%02x%02x; -fx-border-color: #%02x%02x%02x;}", + (int) (colorPicker.getValue().getRed()*255), + (int) (colorPicker.getValue().getGreen()*255), + (int) (colorPicker.getValue().getBlue()*255), + (int) (colorPicker.getValue().getRed()*255), + (int) (colorPicker.getValue().getGreen()*255), + (int) (colorPicker.getValue().getBlue()*255)) + ); + final Button key = new Button(keyBtn.getText()); // Set same name + key.setMnemonicParsing(false); // don't wipe underscore from UI + key.setUserData(new Object[] {keyBtn, keyBtn.getId()}); // Store button-'patent' and 'FX ID' + key.setOnAction(ActionEvent->{ + keyBtn.setStyle(""); + flowPaneBox.getChildren().remove(key); + keyBtn.setDisable(false); + }); + flowPaneBox.getChildren().add(key); + } + /** + * Get information about this rule (keys) + * */ + public byte[][] getKeyCodes(){ + final List keysList = new ArrayList<>(); + + final byte red = (byte) (colorPicker.getValue().getRed()*255); + final byte green = (byte) (colorPicker.getValue().getGreen()*255); + final byte blue = (byte) (colorPicker.getValue().getBlue()*255); + + for (int i = 0; i < flowPaneBox.getChildren().size(); i++) { + Object[] pair = (Object[]) flowPaneBox.getChildren().get(i).getUserData(); + String id = (String) pair[1]; + if (id.startsWith("l_")) + continue; + byte[] keyInfo = new byte[4]; // Where 0 - special key/indicator code; 1 - red; 2 - green; 3 - blue + keyInfo[0] = LoCodepage.getCode(id); + keyInfo[1] = red; + keyInfo[2] = green; + keyInfo[3] = blue; + keysList.add(keyInfo); + } + + if (keysList.isEmpty()) + return null; + + return keysList.toArray(new byte[0][]); + } + /** + * Get information about this rule (Leds) + * */ + public byte[][] getLedCodes(){ + final List ledList = new ArrayList<>(); + + final byte red = (byte) (colorPicker.getValue().getRed()*255); + final byte green = (byte) (colorPicker.getValue().getGreen()*255); + final byte blue = (byte) (colorPicker.getValue().getBlue()*255); + + for (int i = 0; i < flowPaneBox.getChildren().size(); i++) { + Object[] pair = (Object[]) flowPaneBox.getChildren().get(i).getUserData(); + String id = (String) pair[1]; + if (id.startsWith("k_")) + continue; + byte[] keyInfo = new byte[4]; // Where 0 - special key/indicator code; 1 - red; 2 - green; 3 - blue + keyInfo[0] = LoCodepage.getCode(id); + keyInfo[1] = red; + keyInfo[2] = green; + keyInfo[3] = blue; + ledList.add(keyInfo); + } + + if (ledList.isEmpty()) + return null; + + return ledList.toArray(new byte[0][]); + } +} diff --git a/src/main/java/logiled/Main.java b/src/main/java/logiled/Main.java new file mode 100644 index 0000000..7379e08 --- /dev/null +++ b/src/main/java/logiled/Main.java @@ -0,0 +1,8 @@ +package logiled; + +public class Main { + + public static void main(String[] args) { + MainFx.main(args); + } +} diff --git a/src/main/java/logiled/MainFx.java b/src/main/java/logiled/MainFx.java new file mode 100644 index 0000000..09ad9c7 --- /dev/null +++ b/src/main/java/logiled/MainFx.java @@ -0,0 +1,55 @@ +package logiled; + +import javafx.application.Application; +import javafx.fxml.FXMLLoader; +import javafx.scene.Parent; +import javafx.scene.Scene; +import javafx.scene.image.Image; +import javafx.stage.Stage; + +import java.util.Locale; +import java.util.ResourceBundle; + +public class MainFx extends Application { + public static final String appVersion = "v0.1"; + + @Override + public void start(Stage primaryStage) throws Exception{ + Mediator.getInstance().setInstance(getHostServices()); + + FXMLLoader loader = new FXMLLoader(getClass().getResource("/Main.fxml")); + + Locale locale = new Locale(Locale.getDefault().getISO3Language()); + Locale.setDefault(locale); + + ResourceBundle rb = ResourceBundle.getBundle("locale", locale); + + loader.setResources(rb); + + Parent root = loader.load(); + + primaryStage.getIcons().addAll( + new Image(getClass().getResourceAsStream("/ico/appIcon_32.png")), + new Image(getClass().getResourceAsStream("/ico/appIcon_48.png")), + new Image(getClass().getResourceAsStream("/ico/appIcon_64.png")), + new Image(getClass().getResourceAsStream("/ico/appIcon_128.png")) + ); + + primaryStage.setTitle("LogiLed "+appVersion); + primaryStage.setMinWidth(1160); + primaryStage.setMinHeight(550); + Scene mainScene = new Scene(root, 1160, 525); + mainScene.getStylesheets().add("/light.css"); + primaryStage.setScene(mainScene); + primaryStage.show(); + + primaryStage.setOnHidden(e->MessagesConsumer.getInstance().stop()); // Useless? + } + + public static void main(String[] args) { + if ((args.length == 1) && (args[0].equals("-v") || args[0].equals("--version"))) + System.out.println("LogiLed "+appVersion); + else + launch(args); + } +} diff --git a/src/main/java/logiled/Mediator.java b/src/main/java/logiled/Mediator.java new file mode 100644 index 0000000..50c48ff --- /dev/null +++ b/src/main/java/logiled/Mediator.java @@ -0,0 +1,18 @@ +package logiled; + +import javafx.application.HostServices; + +public class Mediator{ + + private HostServices hostServices; + + public static Mediator getInstance(){ return MediatorHolder.INSTANCE; } + + public void setInstance(HostServices hostServices){ this.hostServices = hostServices; } + + private static class MediatorHolder{ + private static final Mediator INSTANCE = new Mediator(); + } + + public HostServices getHostServices() { return hostServices; } +} \ No newline at end of file diff --git a/src/main/java/logiled/MessagesConsumer.java b/src/main/java/logiled/MessagesConsumer.java new file mode 100644 index 0000000..7365a65 --- /dev/null +++ b/src/main/java/logiled/MessagesConsumer.java @@ -0,0 +1,36 @@ +package logiled; + +import javafx.animation.AnimationTimer; +import javafx.scene.control.Label; + +import java.util.ArrayList; +import java.util.concurrent.BlockingQueue; +import java.util.concurrent.LinkedBlockingDeque; + +public class MessagesConsumer extends AnimationTimer { + private BlockingQueue msgQueue = new LinkedBlockingDeque<>(); + private Label infoLabel; + + public static MessagesConsumer getInstance(){ return MessagesConsumerHolder.INSTANCE; } + + public void setInstance(Label infoLabel){ this.infoLabel = infoLabel; } + + private static class MessagesConsumerHolder{ + private static final MessagesConsumer INSTANCE = new MessagesConsumer(); + } + + @Override + public void handle(long l) { + ArrayList messages = new ArrayList<>(); + int msgRecieved = msgQueue.drainTo(messages); + if (msgRecieved > 0) + messages.forEach(infoLabel::setText); + } + + public void inform(String text){ + try { + this.msgQueue.put(text); + } + catch (InterruptedException ignored) {} + } +} \ No newline at end of file diff --git a/src/main/java/logiled/RainbowHexDump.java b/src/main/java/logiled/RainbowHexDump.java new file mode 100644 index 0000000..3dd1ec3 --- /dev/null +++ b/src/main/java/logiled/RainbowHexDump.java @@ -0,0 +1,43 @@ +package logiled; + +import java.nio.charset.StandardCharsets; + +/** + * Debug tool like hexdump <3 + */ +public class RainbowHexDump { + private static final String ANSI_RESET = "\u001B[0m"; + private static final String ANSI_BLACK = "\u001B[30m"; + private static final String ANSI_RED = "\u001B[31m"; + private static final String ANSI_GREEN = "\u001B[32m"; + private static final String ANSI_YELLOW = "\u001B[33m"; + private static final String ANSI_BLUE = "\u001B[34m"; + private static final String ANSI_PURPLE = "\u001B[35m"; + private static final String ANSI_CYAN = "\u001B[36m"; + private static final String ANSI_WHITE = "\u001B[37m"; + + + public static void hexDumpUTF8(byte[] byteArray){ + System.out.print(ANSI_BLUE); + for (int i=0; i < byteArray.length; i++) + System.out.print(String.format("%02d-", i%100)); + System.out.println(">"+ANSI_RED+byteArray.length+ANSI_RESET); + for (byte b: byteArray) + System.out.print(String.format("%02x ", b)); + System.out.print("\t\t\t" + + new String(byteArray, StandardCharsets.UTF_8) + + "\n"); + } + + public static void hexDumpUTF16LE(byte[] byteArray){ + System.out.print(ANSI_BLUE); + for (int i=0; i < byteArray.length; i++) + System.out.print(String.format("%02d-", i%100)); + System.out.println(">"+ANSI_RED+byteArray.length+ANSI_RESET); + for (byte b: byteArray) + System.out.print(String.format("%02x ", b)); + System.out.print("\t\t\t" + + new String(byteArray, StandardCharsets.UTF_16LE) + + "\n"); + } +} diff --git a/src/main/java/logiled/USB/Communications.java b/src/main/java/logiled/USB/Communications.java new file mode 100644 index 0000000..00884be --- /dev/null +++ b/src/main/java/logiled/USB/Communications.java @@ -0,0 +1,130 @@ +package logiled.USB; + +import logiled.MessagesConsumer; +import org.usb4java.DeviceHandle; +import org.usb4java.LibUsb; + +import java.nio.ByteBuffer; +import java.nio.IntBuffer; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.HashMap; +import java.util.List; + +public class Communications implements Runnable{ + + private static final byte[] commit = { + 0x11, (byte) 0xff, 0x0c, 0x5a, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x00 + }; + + private static final byte[] indicators = { // we have 2 leds on G513 + 0x12, (byte) 0xff, 0x0c, 0x3a, 0x00, 0x40, 0x00, 0x05, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 + }; + private static final byte[] keys = { // Can store 14 rules + 0x12, (byte) 0xff, 0x0c, 0x3a, 0x00, 0x01, 0x00, 0x0e, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 + }; + + private DeviceHandle handler; + + // What would be sent to keyboard + private List keyLedCommands; + + public Communications(HashMap> keyLedSet){ + keyLedCommands = new ArrayList<>(); + + int appendTo = 8; + + byte[] command = Arrays.copyOfRange(indicators, 0, indicators.length); + + for (byte[][] singleRuleSet : keyLedSet.get("Led")){ + for (byte[] keyLedSetting: singleRuleSet) { + System.arraycopy(keyLedSetting, 0, command, appendTo, 4); + appendTo += 4; + } + } + + if (appendTo > 8) { + keyLedCommands.add(Arrays.copyOfRange(command, 0, command.length)); + appendTo = 8; + } + + command = Arrays.copyOfRange(keys, 0, keys.length); + + for (byte[][] singleRuleSet : keyLedSet.get("Key")) { + for (byte[] keyLedSetting : singleRuleSet){ + if (appendTo == 64){ + keyLedCommands.add(Arrays.copyOfRange(command, 0, command.length)); + command = Arrays.copyOfRange(keys, 0, keys.length); + appendTo = 8; + } + System.arraycopy(keyLedSetting, 0, command, appendTo, 4); + appendTo += 4; + } + } + + if (appendTo > 8) + keyLedCommands.add(Arrays.copyOfRange(command, 0, command.length)); + // If any command has been added to chain, add commit command to the end + if (keyLedCommands.size() > 0) + keyLedCommands.add(commit); + } + + @Override + public void run() { + // If no commands in the query, then nothing to do + if (keyLedCommands.size() == 0) + return; + + UsbConnect usbConnect = new UsbConnect(); + + if (!usbConnect.isConnected()) + return; + + handler = usbConnect.getHandlerKbrd(); + + for (byte[] cmd : keyLedCommands) + if (write(cmd)) + break; + + usbConnect.close(); + } + /** + * Write to keyboard + * @param message : what to sent + * @return true in case of failure + * false for success + * */ + private boolean write(byte[] message){ + ByteBuffer writeBuffer = ByteBuffer.allocateDirect(message.length); //writeBuffer.order() equals BIG_ENDIAN; + writeBuffer.put(message); // Don't do writeBuffer.rewind(); + int result; + + if (message.length > 20) + result = LibUsb.controlTransfer(handler, (byte) 0x21, (byte) 0x09, (short) 0x212, (short) 1, writeBuffer, 2000); + else + result = LibUsb.controlTransfer(handler, (byte) 0x21, (byte) 0x09, (short) 0x211, (short) 1, writeBuffer, 2000); + + if (result < 0){ + MessagesConsumer.getInstance().inform("Data transfer failed: "+UsbErrorCodes.getErrCode(result)); + return true; + } + + ByteBuffer readBuffer = ByteBuffer.allocateDirect(64); + IntBuffer readBufTrans = IntBuffer.allocate(1); + LibUsb.interruptTransfer(handler, (byte) 0x82, readBuffer, readBufTrans, 1000); + /* + readBuffer.rewind(); + byte[] arr = new byte[readBuffer.get()]; + readBuffer.get(arr); + RainbowHexDump.hexDumpUTF8(arr); + */ + return false; + } +} diff --git a/src/main/java/logiled/USB/UsbConnect.java b/src/main/java/logiled/USB/UsbConnect.java new file mode 100644 index 0000000..56d1672 --- /dev/null +++ b/src/main/java/logiled/USB/UsbConnect.java @@ -0,0 +1,119 @@ +package logiled.USB; + +import logiled.MessagesConsumer; +import org.usb4java.*; + +public class UsbConnect { + private final int DEFAULT_INTERFACE = 1; + + private Context contextKbrd; + private DeviceHandle handlerKbrd; + + private boolean connected = false; + + public UsbConnect(){ + MessagesConsumer mc = MessagesConsumer.getInstance(); + + int result; + + // Creating Context required by libusb. Optional. TODO: Consider removing. + contextKbrd = new Context(); + result = LibUsb.init(contextKbrd); + if (result != LibUsb.SUCCESS) { + mc.inform("'libusb' initialization failed: "+result); + close(); + return; + } + + // Searching for NS in devices: obtain list of all devices + DeviceList deviceList = new DeviceList(); + result = LibUsb.getDeviceList(contextKbrd, deviceList); + if (result < 0) { + mc.inform("Getting device list failed: "+result); + close(); + return; + } + // Searching for keyboard in devices + DeviceDescriptor descriptor; + Device deviceKbrd = null; + for (Device device: deviceList){ + descriptor = new DeviceDescriptor(); // mmm.. leave it as is. + result = LibUsb.getDeviceDescriptor(device, descriptor); + if (result != LibUsb.SUCCESS){ + mc.inform("Read file descriptors for USB devices failed: "+result); + LibUsb.freeDeviceList(deviceList, true); + close(); + return; + } + if ((descriptor.idVendor() == (short) 0x046D) && (descriptor.idProduct() == (short) 0xC33C)){ + deviceKbrd = device; + break; + } + } + if (deviceKbrd == null){ + mc.inform("Keyboard is not found in connected devices."); + close(); + return; + } + // Handle keyboard device + handlerKbrd = new DeviceHandle(); + result = LibUsb.open(deviceKbrd, handlerKbrd); + if (result != LibUsb.SUCCESS) { + mc.inform("Open keyboard failed : "+UsbErrorCodes.getErrCode(result)+(result == LibUsb.ERROR_ACCESS?" (not enough rights)":"")); + // Let's make a bit dirty workaround since such shit happened + LibUsb.exit(contextKbrd); + return; // And close + } + + LibUsb.freeDeviceList(deviceList, true); + + // Check if this device uses kernel driver and detach if possible: + result = LibUsb.kernelDriverActive(handlerKbrd, DEFAULT_INTERFACE); + if (result == 1) { // used by kernel + if (LibUsb.detachKernelDriver(handlerKbrd, DEFAULT_INTERFACE) != LibUsb.SUCCESS) { + mc.inform("Detach kernel failed: " + UsbErrorCodes.getErrCode(result)); + close(); + return; + } + } + else if (result != LibUsb.SUCCESS) + mc.inform("Can't proceed with libusb driver : "+UsbErrorCodes.getErrCode(result)); + + // Claim interface + result = LibUsb.claimInterface(handlerKbrd, DEFAULT_INTERFACE); + if (result != LibUsb.SUCCESS) { + mc.inform("Claim interface failure: "+UsbErrorCodes.getErrCode(result)); + close(); + return; + } + else + mc.inform("Interface claimed"); + + this.connected = true; + } + + /** + * Get USB status + * @return status of connection + */ + public boolean isConnected() { return connected; } + /** + * Getter for handler + * @return DeviceHandle of Keyboard + */ + public DeviceHandle getHandlerKbrd(){ return handlerKbrd; } + /** + * Correct exit + * */ + public void close(){ + // Close handler in the end + if (handlerKbrd != null) { + // Try to release interface + LibUsb.releaseInterface(handlerKbrd, DEFAULT_INTERFACE); + LibUsb.close(handlerKbrd); + } + // Close context in the end + if (contextKbrd != null) + LibUsb.exit(contextKbrd); + } +} diff --git a/src/main/java/logiled/USB/UsbErrorCodes.java b/src/main/java/logiled/USB/UsbErrorCodes.java new file mode 100644 index 0000000..324ae7a --- /dev/null +++ b/src/main/java/logiled/USB/UsbErrorCodes.java @@ -0,0 +1,38 @@ +package logiled.USB; + +import org.usb4java.LibUsb; + +class UsbErrorCodes { + static String getErrCode(int value){ + switch (value){ + case LibUsb.ERROR_ACCESS: + return "ERROR_ACCESS"; + case LibUsb.ERROR_BUSY: + return "ERROR_BUSY"; + case LibUsb.ERROR_INTERRUPTED: + return "ERROR_INTERRUPTED"; + case LibUsb.ERROR_INVALID_PARAM: + return "ERROR_INVALID_PARAM"; + case LibUsb.ERROR_IO: + return "ERROR_IO"; + case LibUsb.ERROR_NO_DEVICE: + return "ERROR_NO_DEVICE"; + case LibUsb.ERROR_NO_MEM: + return "ERROR_NO_MEM"; + case LibUsb.ERROR_NOT_FOUND: + return "ERROR_NOT_FOUND"; + case LibUsb.ERROR_NOT_SUPPORTED: + return "ERROR_NOT_SUPPORTED"; + case LibUsb.ERROR_OTHER: + return "ERROR_OTHER"; + case LibUsb.ERROR_OVERFLOW: + return "ERROR_OVERFLOW"; + case LibUsb.ERROR_PIPE: + return "ERROR_PIPE"; + case LibUsb.ERROR_TIMEOUT: + return "ERROR_TIMEOUT"; + default: + return Integer.toString(value); + } + } +} diff --git a/src/main/resources/AboutLayout.fxml b/src/main/resources/AboutLayout.fxml new file mode 100644 index 0000000..c395594 --- /dev/null +++ b/src/main/resources/AboutLayout.fxml @@ -0,0 +1,67 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +