diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..ebba5bc --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,10 @@ +version: 2 +updates: + - package-ecosystem: "gradle" + directory: "/" + schedule: + interval: "daily" + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "daily" \ No newline at end of file diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml new file mode 100644 index 0000000..018fb39 --- /dev/null +++ b/.github/release-drafter.yml @@ -0,0 +1,13 @@ +name-template: 'v$NEXT_PATCH_VERSION' +tag-template: 'v$NEXT_PATCH_VERSION' +categories: + - title: 'Features' + labels: + - 'enhancement' + - title: 'Fixes' + labels: + - 'bug' +change-template: '- $TITLE @$AUTHOR (#$NUMBER)' +template: | + ## Changes + $CHANGES \ No newline at end of file diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml new file mode 100644 index 0000000..357a4e2 --- /dev/null +++ b/.github/workflows/release-drafter.yml @@ -0,0 +1,14 @@ +name: Release Drafter 🪧 + +on: + push: + branches: + - master + +jobs: + update_release_draft: + runs-on: ubuntu-latest + steps: + - uses: release-drafter/release-drafter@v5 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1ce6ac7 --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +# Ignore IntelliJ related stuff +.idea +*.iml +/out +/docs + +# Gradle related stuff +.gradle +/build/ +*/build/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..3877ae0 --- /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. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..4dcb9a5 --- /dev/null +++ b/README.md @@ -0,0 +1,58 @@ + + +[![LightController](https://jitpack.io/v/IBims1ckoky/LightControllerAPI.svg)](https://jitpack.io/#IBims1ckoky/LightControllerAPI) +[![MissingFeature](https://img.shields.io/badge/Missing%20Feature-Open%20an%20Issue-blueviolet?style=flat-square&logo=appveyor)](https://github.com/IBims1ckoky/LightControllerAPI/issues) + +# LightControllerAPI + +This is an easy to use **LightControllerAPI** in for Java to control Lights from [PhillipsHue](https://www.philips-hue.com/). + + +# How to get started + +Gradle (Default): +```gradle +repositories { + maven { url 'https://jitpack.io' } +} + +dependencies { + implementation 'com.github.IBims1ckoky:LightControllerAPI:master-SNAPSHOT' +} +``` + +Maven: +```maven + + + jitpack.io + https://jitpack.io + + + + + + com.github.IBims1ckoky + LightControllerAPI + master-SNAPSHOT + + +``` + +## Visit the Wiki! + +### How to get started +* [Hardware Requirements](https://github.com/IBims1ckoky/LightControllerAPI/wiki/Hardware-Requirements) +* [Maven & Gradle](https://github.com/IBims1ckoky/LightControllerAPI/wiki/Maven-&-Gradle) +* [Important Information](https://github.com/IBims1ckoky/LightControllerAPI/wiki/Important-Information) +### BridgeAPI +* [BridgeIP](https://github.com/IBims1ckoky/LightControllerAPI/wiki/BridgeIP) +* [Username & Clientkey](https://github.com/IBims1ckoky/LightControllerAPI/wiki/Username-&-Clientkey) +* [Bridge Informations](https://github.com/IBims1ckoky/LightControllerAPI/wiki/Bridge-Informations) +* [Bridge Scanner](https://github.com/IBims1ckoky/LightControllerAPI/wiki/BridgeScanner-(Credentials)) +### LampAPI +* [Get All Lamps](https://github.com/IBims1ckoky/LightControllerAPI/wiki/Get-All-Lamps) +* [Lamp by Name](https://github.com/IBims1ckoky/LightControllerAPI/wiki/Lamp-by-Name) +* [Lamp Brightness](https://github.com/IBims1ckoky/LightControllerAPI/wiki/Lamp-Brightness) +* [Turn Lamps On & Off](https://github.com/IBims1ckoky/LightControllerAPI/wiki/Turn-Lamps-On-&-Off) +* [Other Updates]() \ No newline at end of file diff --git a/api/build.gradle.kts b/api/build.gradle.kts new file mode 100644 index 0000000..d115e8e --- /dev/null +++ b/api/build.gradle.kts @@ -0,0 +1,18 @@ +group = "de.maxizink" +version = "1.0-SNAPSHOT" + +description = "LightController-api" + +plugins { + `java-library` +} + +dependencies { + implementation("com.fasterxml.jackson.core:jackson-databind:2.13.1") + implementation("io.reactivex.rxjava3:rxjava:3.1.3") + implementation("com.google.code.gson:gson:2.8.9") + implementation("org.apache.httpcomponents:httpclient:4.5.13") + + api ("ch.qos.logback:logback-core:1.2.10") + api ("ch.qos.logback:logback-classic:1.2.6") +} \ No newline at end of file diff --git a/api/src/main/java/de/maxizink/lightcontroller/body/HueRequestBody.java b/api/src/main/java/de/maxizink/lightcontroller/body/HueRequestBody.java new file mode 100644 index 0000000..f98f817 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/body/HueRequestBody.java @@ -0,0 +1,5 @@ +package de.maxizink.lightcontroller.body; + +public interface HueRequestBody { + +} \ No newline at end of file diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/ResourceType.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/ResourceType.java new file mode 100644 index 0000000..9c7b904 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/ResourceType.java @@ -0,0 +1,36 @@ +package de.maxizink.lightcontroller.discovery; + +public enum ResourceType { + + DEVICE, + BRIDGE_HOME, + ROOM, + ZONE, + LIGHT, + BUTTON, + TEMPERATURE, + LIGHT_LEVEL, + MOTION, + ENTERTAINMENT, + GROUPED_LIGHT, + DEVICE_POWER, + ZIGBEE_BRIDGE_CONNECTIVITY, + ZIGBEE_CONNECTIVITY, + ZGP_CONNECTIVITY, + BRIDGE, + HOMEKIT, + SCENE, + ENTERTAINMENT_CONFIGURATION, + PUBLIC_IMAGE, + AUTH_V1, + BEHAVIOR_SCRIPT, + BEHAVIOR_INSTANCE, + GEOFENCE, + GEOFENCE_CLIENT, + GEOLOCATION; + + public static ResourceType getResourceType(final String name) { + return ResourceType.valueOf(name.toUpperCase()); + } + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/api/BridgeCredentialsDiscovery.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/api/BridgeCredentialsDiscovery.java new file mode 100644 index 0000000..86f13eb --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/api/BridgeCredentialsDiscovery.java @@ -0,0 +1,14 @@ +package de.maxizink.lightcontroller.discovery.bridge.api; + +import de.maxizink.lightcontroller.discovery.bridge.response.HueBridgeCredentialsResponse; +import de.maxizink.lightcontroller.injection.Service; + +import java.util.concurrent.CompletableFuture; + +public interface BridgeCredentialsDiscovery extends Service { + + HueBridgeCredentialsResponse generateHueBridgeCredentials(final String bridgeIp); + + CompletableFuture generateHueBridgeCredentialsAsync(final String bridgeIp); + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/api/BridgeIpDiscovery.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/api/BridgeIpDiscovery.java new file mode 100644 index 0000000..c31469c --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/api/BridgeIpDiscovery.java @@ -0,0 +1,19 @@ +package de.maxizink.lightcontroller.discovery.bridge.api; + +import de.maxizink.lightcontroller.discovery.bridge.exception.HueBridgeIpDiscoveryException; +import de.maxizink.lightcontroller.injection.Service; + +import java.util.List; +import java.util.concurrent.CompletableFuture; + +public interface BridgeIpDiscovery extends Service { + + String discoverBridgeIP() throws HueBridgeIpDiscoveryException; + + List discoverAllBridgeIPs() throws HueBridgeIpDiscoveryException; + + CompletableFuture discoveryBridgeIPAsync(); + + CompletableFuture> discoverAllBridgeIPsAsync(); + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/api/HueBridge.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/api/HueBridge.java new file mode 100644 index 0000000..231672e --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/api/HueBridge.java @@ -0,0 +1,33 @@ +package de.maxizink.lightcontroller.discovery.bridge.api; + +import de.maxizink.lightcontroller.discovery.bridge.models.BridgeInfo; +import de.maxizink.lightcontroller.discovery.bridge.models.HueBridgeCredentials; +import de.maxizink.lightcontroller.discovery.lamp.api.HueLamp; +import de.maxizink.lightcontroller.discovery.room.api.HueRoom; + +import java.util.List; +import java.util.Optional; +import java.util.UUID; + +public interface HueBridge { + + //Lamps + List getLamps(); + + Optional getLampById(final UUID uniqueId); + + Optional getLampByName(final String name); + + //Rooms + List getRooms(); + + Optional getHueRoomById(final UUID uniqueId); + + Optional getHueRoomByName(final String name); + + //Information + BridgeInfo getBridgeInfo(); + + HueBridgeCredentials getHueBridgeCredentials(); + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/api/HueBridgeDiscovery.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/api/HueBridgeDiscovery.java new file mode 100644 index 0000000..d1a3c0c --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/api/HueBridgeDiscovery.java @@ -0,0 +1,10 @@ +package de.maxizink.lightcontroller.discovery.bridge.api; + +import de.maxizink.lightcontroller.discovery.bridge.models.HueBridgeCredentials; +import de.maxizink.lightcontroller.injection.Service; + +public interface HueBridgeDiscovery extends Service { + + HueBridge discoverHueBridge(final HueBridgeCredentials hueBridgeCredentials); + +} \ No newline at end of file diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/body/GenerateHueBridgeBody.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/body/GenerateHueBridgeBody.java new file mode 100644 index 0000000..9dc92de --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/body/GenerateHueBridgeBody.java @@ -0,0 +1,14 @@ +package de.maxizink.lightcontroller.discovery.bridge.body; + +import de.maxizink.lightcontroller.body.HueRequestBody; +import lombok.AllArgsConstructor; +import lombok.NoArgsConstructor; + +@AllArgsConstructor(staticName = "of") +@NoArgsConstructor +public class GenerateHueBridgeBody implements HueRequestBody { + + private String devicetype; + private boolean generateclientkey; + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/exception/HueBridgeInformationDiscoveryException.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/exception/HueBridgeInformationDiscoveryException.java new file mode 100644 index 0000000..5cbcc8d --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/exception/HueBridgeInformationDiscoveryException.java @@ -0,0 +1,14 @@ +package de.maxizink.lightcontroller.discovery.bridge.exception; + +public class HueBridgeInformationDiscoveryException extends RuntimeException{ + + public HueBridgeInformationDiscoveryException(final String message) { + super(message); + } + + public HueBridgeInformationDiscoveryException(final String message, final Throwable throwable) { + super(message, throwable); + } + + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/exception/HueBridgeIpDiscoveryException.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/exception/HueBridgeIpDiscoveryException.java new file mode 100644 index 0000000..44048fc --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/exception/HueBridgeIpDiscoveryException.java @@ -0,0 +1,13 @@ +package de.maxizink.lightcontroller.discovery.bridge.exception; + +public class HueBridgeIpDiscoveryException extends RuntimeException { + + public HueBridgeIpDiscoveryException(final String message) { + super(message); + } + + public HueBridgeIpDiscoveryException(final String message, final Throwable throwable) { + super(message, throwable); + } + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/models/BridgeInfo.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/models/BridgeInfo.java new file mode 100644 index 0000000..f7eebfc --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/models/BridgeInfo.java @@ -0,0 +1,24 @@ +package de.maxizink.lightcontroller.discovery.bridge.models; + +import lombok.AllArgsConstructor; +import lombok.Data; +import lombok.NoArgsConstructor; +import org.jetbrains.annotations.Nullable; + +@Data +@NoArgsConstructor +@AllArgsConstructor +public class BridgeInfo { + + private String name; + private String datastoreversion; + private String swversion; + private String apiversion; + private String mac; + private String bridgeid; + private boolean factorynew; + private @Nullable String replacesbridgeid; + private String modelid; + private String startkitid; + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/models/HueBridgeCredentials.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/models/HueBridgeCredentials.java new file mode 100644 index 0000000..281f7c3 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/models/HueBridgeCredentials.java @@ -0,0 +1,15 @@ +package de.maxizink.lightcontroller.discovery.bridge.models; + +import lombok.AllArgsConstructor; +import lombok.Data; + +@Data +@AllArgsConstructor +public class HueBridgeCredentials { + + private final String userName; + private final String clientKey; + + private String ipAddress; + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/models/HueBridgeImpl.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/models/HueBridgeImpl.java new file mode 100644 index 0000000..6ade741 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/models/HueBridgeImpl.java @@ -0,0 +1,113 @@ +package de.maxizink.lightcontroller.discovery.bridge.models; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.google.gson.JsonArray; +import com.google.gson.JsonObject; +import com.google.gson.JsonParser; +import de.maxizink.lightcontroller.discovery.bridge.api.HueBridge; +import de.maxizink.lightcontroller.discovery.bridge.exception.HueBridgeInformationDiscoveryException; +import de.maxizink.lightcontroller.discovery.lamp.api.HueLamp; +import de.maxizink.lightcontroller.discovery.lamp.api.HueLampDiscovery; +import de.maxizink.lightcontroller.discovery.room.api.HueRoom; +import de.maxizink.lightcontroller.discovery.room.api.HueRoomDiscovery; +import de.maxizink.lightcontroller.injection.ServiceAccessor; +import de.maxizink.lightcontroller.mapper.CustomObjectMapper; +import de.maxizink.lightcontroller.utils.HttpUtils; +import de.maxizink.lightcontroller.utils.URLFormatter; +import lombok.Getter; +import lombok.SneakyThrows; +import org.apache.http.HttpHeaders; +import org.apache.http.client.HttpClient; +import org.apache.http.client.methods.HttpUriRequest; +import org.apache.http.message.BasicHeader; + +import java.net.URI; +import java.util.List; +import java.util.Optional; +import java.util.UUID; + +@Getter +public class HueBridgeImpl implements HueBridge { + + private static final ObjectMapper OBJECT_MAPPER = CustomObjectMapper.create(); + + private final String dataUri; + private final HueBridgeCredentials hueBridgeCredentials; + private final BridgeInfo bridgeInfo; + + public HueBridgeImpl(final HueBridgeCredentials hueBridgeCredentials) { + this.hueBridgeCredentials = hueBridgeCredentials; + this.dataUri = "https://" + hueBridgeCredentials.getIpAddress() + "/clip/v2/resource/bridge"; + this.bridgeInfo = fetchBridgeInfo(); + } + + @SneakyThrows + private BridgeInfo fetchBridgeInfo() { + HttpClient httpClient = HttpUtils.createClient(); + HttpUriRequest httpUriRequest = HttpUtils.createRequest(URLFormatter.getBridgeConfig(hueBridgeCredentials.getIpAddress())); + String json = HttpUtils.executeJson(httpClient, httpUriRequest); + return OBJECT_MAPPER.readValue(json, BridgeInfo.class); + } + + @SneakyThrows + private JsonArray getDataArray() { + HttpClient httpClient = HttpUtils.createClient(); + HttpUriRequest httpUriRequest = HttpUtils.createRequest(URI.create(dataUri), + new BasicHeader(HttpHeaders.HOST, this.hueBridgeCredentials.getIpAddress()), + HttpUtils.createCredentialHeader(hueBridgeCredentials) + ); + + String json = HttpUtils.executeJson(httpClient, httpUriRequest); + return checkErrors(JsonParser.parseString(json).getAsJsonObject()); + } + + private JsonArray checkErrors(final JsonObject jsonObject) { + JsonArray errorElement = jsonObject.get("errors").getAsJsonArray(); + if (errorElement.size() >= 1) { + throw new HueBridgeInformationDiscoveryException("An error occurred while fetch data from the Bridge"); + } + + return jsonObject.get("data").getAsJsonArray(); + } + + + @Override + public List getLamps() { + HueLampDiscovery hueLampDiscovery = ServiceAccessor.accessService(HueLampDiscovery.class); + return hueLampDiscovery.discoverAllLamps(this); + } + + @Override + public Optional getLampById(final UUID uniqueId) { + return getLamps().stream() + .filter(hueLamp -> hueLamp.getId().equals(uniqueId)) + .findFirst(); + } + + @Override + public Optional getLampByName(final String name) { + return getLamps().stream() + .filter(hueLamp -> hueLamp.getName().equalsIgnoreCase(name)) + .findFirst(); + } + + @Override + public List getRooms() { + HueRoomDiscovery hueLampDiscovery = ServiceAccessor.accessService(HueRoomDiscovery.class); + return hueLampDiscovery.discoverAllRooms(this); + } + + @Override + public Optional getHueRoomById(final UUID uniqueId) { + return getRooms().stream() + .filter(hueRoom -> hueRoom.getId().equals(uniqueId)) + .findFirst(); + } + + @Override + public Optional getHueRoomByName(final String name) { + return getRooms().stream() + .filter(hueRoom -> hueRoom.getName().equals(name)) + .findFirst(); + } +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/response/BridgeIpDiscoveryResponse.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/response/BridgeIpDiscoveryResponse.java new file mode 100644 index 0000000..1c96ee4 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/response/BridgeIpDiscoveryResponse.java @@ -0,0 +1,17 @@ +package de.maxizink.lightcontroller.discovery.bridge.response; + +import lombok.AllArgsConstructor; +import lombok.NoArgsConstructor; + +@AllArgsConstructor +@NoArgsConstructor +public class BridgeIpDiscoveryResponse { + + private String id; + private String internalipaddress; + private int port; + + public String getAddress() { + return internalipaddress; + } +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/response/HueBridgeCredentialsResponse.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/response/HueBridgeCredentialsResponse.java new file mode 100644 index 0000000..cf2dbbe --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/response/HueBridgeCredentialsResponse.java @@ -0,0 +1,37 @@ +package de.maxizink.lightcontroller.discovery.bridge.response; + +import de.maxizink.lightcontroller.discovery.bridge.models.HueBridgeCredentials; +import lombok.AllArgsConstructor; +import lombok.NoArgsConstructor; +import org.jetbrains.annotations.Nullable; + +@AllArgsConstructor +@NoArgsConstructor +public class HueBridgeCredentialsResponse { + + private Respone respone; + private @Nullable HueBridgeCredentials hueBridgeCredentials; + + public HueBridgeCredentialsResponse(Respone respone) { + this.respone = respone; + } + + public HueBridgeCredentials getHueBridgeCredentials() { + if (respone.equals(Respone.LINK_BUTTON_NOT_PRESSED)) { + throw new NullPointerException("There Response is LINK_BUTTON_NOT_PRESSED, so there are no Credentials!"); + } + return hueBridgeCredentials; + } + + public Respone getRespone() { + return respone; + } + + public enum Respone { + + LINK_BUTTON_NOT_PRESSED, + GENERATED; + + } + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/service/BridgeCredentialsDiscoveryService.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/service/BridgeCredentialsDiscoveryService.java new file mode 100644 index 0000000..4412cf7 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/service/BridgeCredentialsDiscoveryService.java @@ -0,0 +1,70 @@ +package de.maxizink.lightcontroller.discovery.bridge.service; + +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import de.maxizink.lightcontroller.body.HueRequestBody; +import de.maxizink.lightcontroller.discovery.bridge.api.BridgeCredentialsDiscovery; +import de.maxizink.lightcontroller.discovery.bridge.body.GenerateHueBridgeBody; +import de.maxizink.lightcontroller.discovery.bridge.models.HueBridgeCredentials; +import de.maxizink.lightcontroller.discovery.bridge.response.HueBridgeCredentialsResponse; +import de.maxizink.lightcontroller.utils.HttpUtils; +import de.maxizink.lightcontroller.utils.JsonUtils; +import de.maxizink.lightcontroller.utils.URLFormatter; +import lombok.SneakyThrows; +import org.apache.http.client.HttpClient; +import org.apache.http.client.methods.HttpUriRequest; + +import java.util.concurrent.CompletableFuture; + +import static de.maxizink.lightcontroller.utils.HttpUtils.*; + +public class BridgeCredentialsDiscoveryService implements BridgeCredentialsDiscovery { + + + @SneakyThrows + @Override + public HueBridgeCredentialsResponse generateHueBridgeCredentials(final String bridgeIp) { + HttpClient httpClient = HttpUtils.createClient(); + HueRequestBody hueRequestBody = GenerateHueBridgeBody.of("LightControllerAPI#2022", true); //TODO user should set the Application Name (devicetype) + HttpUriRequest httpUriRequest = HttpUtils.createPostRequest(URLFormatter.getBridgeAPIKey(bridgeIp), hueRequestBody); + + String body = HttpUtils.executeJson(httpClient, httpUriRequest); + + JsonObject jsonObject = JsonUtils.fromJsonArray(body); + if (jsonObject.has("error")) { + return new HueBridgeCredentialsResponse(HueBridgeCredentialsResponse.Respone.LINK_BUTTON_NOT_PRESSED); + } + + JsonObject credentialsObject = jsonObject.getAsJsonObject("success"); + HueBridgeCredentials hueBridgeCredentials = getCredentials(credentialsObject); + hueBridgeCredentials.setIpAddress(bridgeIp); + return new HueBridgeCredentialsResponse(HueBridgeCredentialsResponse.Respone.GENERATED, hueBridgeCredentials); + } + + @Override + public CompletableFuture generateHueBridgeCredentialsAsync(final String bridgeIp) { + return CompletableFuture.supplyAsync(() -> { + HttpClient httpClient = createClient(); + HueRequestBody hueRequestBody = GenerateHueBridgeBody.of("LightControllerAPI#2022", true); + HttpUriRequest httpUriRequest = createPostRequest(URLFormatter.getBridgeAPIKey(bridgeIp), hueRequestBody); + + String body = executeJson(httpClient, httpUriRequest); + JsonObject jsonObject = JsonUtils.fromJsonArray(body); + if (jsonObject.has("error")) { + return new HueBridgeCredentialsResponse(HueBridgeCredentialsResponse.Respone.LINK_BUTTON_NOT_PRESSED); + } + + JsonObject credentialsObject = jsonObject.getAsJsonObject("success"); + HueBridgeCredentials hueBridgeCredentials = getCredentials(credentialsObject); + hueBridgeCredentials.setIpAddress(bridgeIp); + return new HueBridgeCredentialsResponse(HueBridgeCredentialsResponse.Respone.GENERATED, hueBridgeCredentials); + }); + } + + private HueBridgeCredentials getCredentials(final JsonObject credentialsObject) { + JsonElement userName = credentialsObject.get("username"); + JsonElement clientKey = credentialsObject.get("clientkey"); + return new HueBridgeCredentials(userName.getAsString(), clientKey.getAsString(), ""); + } + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/service/BridgeIpDiscoveryService.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/service/BridgeIpDiscoveryService.java new file mode 100644 index 0000000..b28fa8d --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/service/BridgeIpDiscoveryService.java @@ -0,0 +1,81 @@ +package de.maxizink.lightcontroller.discovery.bridge.service; + +import com.fasterxml.jackson.databind.ObjectMapper; +import de.maxizink.lightcontroller.discovery.bridge.api.BridgeIpDiscovery; +import de.maxizink.lightcontroller.discovery.bridge.exception.HueBridgeIpDiscoveryException; +import de.maxizink.lightcontroller.discovery.bridge.response.BridgeIpDiscoveryResponse; +import de.maxizink.lightcontroller.mapper.CustomObjectMapper; +import de.maxizink.lightcontroller.utils.HttpUtils; +import lombok.SneakyThrows; +import org.apache.http.client.HttpClient; +import org.apache.http.client.methods.HttpUriRequest; + +import java.net.URI; +import java.util.Arrays; +import java.util.List; +import java.util.concurrent.CompletableFuture; +import java.util.stream.Collectors; + +import static de.maxizink.lightcontroller.utils.HttpUtils.*; + +public class BridgeIpDiscoveryService implements BridgeIpDiscovery { + + private static final URI HUE_BRIDGE_DISCOVERY_URI = URI.create("https://discovery.meethue.com/"); + private static final ObjectMapper OBJECT_MAPPER = CustomObjectMapper.create(); + + @SneakyThrows + @Override + public String discoverBridgeIP() { + return discoverAllBridgeIPs().get(0); + } + + @SneakyThrows + @Override + public List discoverAllBridgeIPs() { + HttpClient httpClient = HttpUtils.createClient(); + HttpUriRequest httpUriRequest = HttpUtils.createRequest(HUE_BRIDGE_DISCOVERY_URI); + + String body = HttpUtils.executeJson(httpClient, httpUriRequest); + + BridgeIpDiscoveryResponse[] bridgeIpDiscoveryResponse = OBJECT_MAPPER.readValue(body, BridgeIpDiscoveryResponse[].class); + return Arrays.stream(bridgeIpDiscoveryResponse). + map(BridgeIpDiscoveryResponse::getAddress) + .collect(Collectors.toList()); + } + + @SneakyThrows + @Override + public CompletableFuture discoveryBridgeIPAsync() { + return CompletableFuture.supplyAsync(() -> { + HttpClient httpClient = createClient(); + HttpUriRequest httpRequest = createRequest(HUE_BRIDGE_DISCOVERY_URI); + + String body = executeJson(httpClient, httpRequest); + BridgeIpDiscoveryResponse[] bridgeIpDiscoveryResponse = getBridges(body); + if (bridgeIpDiscoveryResponse.length <= 0) { + throw new HueBridgeIpDiscoveryException("No Hue Bridge was found"); + } + return bridgeIpDiscoveryResponse[0].getAddress(); + }); + } + + @Override + public CompletableFuture> discoverAllBridgeIPsAsync() { + return CompletableFuture.supplyAsync(() -> { + HttpClient httpClient = createClient(); + HttpUriRequest httpRequest = createRequest(HUE_BRIDGE_DISCOVERY_URI); + + String body = executeJson(httpClient, httpRequest); + BridgeIpDiscoveryResponse[] bridgeIpDiscoveryResponse = getBridges(body); + return Arrays.stream(bridgeIpDiscoveryResponse) + .map(BridgeIpDiscoveryResponse::getAddress) + .collect(Collectors.toList()); + }); + } + + @SneakyThrows + private BridgeIpDiscoveryResponse[] getBridges(final String response) { + return OBJECT_MAPPER.readValue(response, BridgeIpDiscoveryResponse[].class); + } + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/service/HueBridgeDiscoveryService.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/service/HueBridgeDiscoveryService.java new file mode 100644 index 0000000..e7a43ce --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/bridge/service/HueBridgeDiscoveryService.java @@ -0,0 +1,29 @@ +package de.maxizink.lightcontroller.discovery.bridge.service; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import de.maxizink.lightcontroller.discovery.bridge.api.HueBridgeDiscovery; +import de.maxizink.lightcontroller.discovery.bridge.api.HueBridge; +import de.maxizink.lightcontroller.discovery.bridge.models.HueBridgeCredentials; +import de.maxizink.lightcontroller.discovery.bridge.models.HueBridgeImpl; +import de.maxizink.lightcontroller.mapper.CustomObjectMapper; + +import java.net.URI; + +public class HueBridgeDiscoveryService implements HueBridgeDiscovery { + + private static final URI HUE_BRIDGE_DISCOVERY_URI = URI.create("https://discovery.meethue.com/"); + private static final ObjectMapper OBJECT_MAPPER = CustomObjectMapper.create(); + + @Override + public HueBridge discoverHueBridge(final HueBridgeCredentials hueBridgeCredentials) { + return new HueBridgeImpl(hueBridgeCredentials); + } + + private HueBridgeCredentials getCredentials(final JsonObject credentialsObject) { + JsonElement userName = credentialsObject.get("username"); + JsonElement clientKey = credentialsObject.get("clientkey"); + return new HueBridgeCredentials(userName.getAsString(), clientKey.getAsString(), ""); + } +} \ No newline at end of file diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/api/HueLamp.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/api/HueLamp.java new file mode 100644 index 0000000..9218d78 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/api/HueLamp.java @@ -0,0 +1,141 @@ +package de.maxizink.lightcontroller.discovery.lamp.api; + +import com.google.gson.JsonObject; +import de.maxizink.lightcontroller.discovery.bridge.api.HueBridge; +import de.maxizink.lightcontroller.discovery.lamp.model.*; +import lombok.AllArgsConstructor; +import lombok.Data; + +import java.util.List; +import java.util.Map; +import java.util.UUID; +import java.util.concurrent.CompletableFuture; + +/** + * This is the Interface from a normal {@link HueLamp}: + * It can be a colored one or a default Lamp. + * The default implementation is {@link HueLampImpl} + */ +public interface HueLamp { + + void refreshLampState(); + + void updateSync(final LampUpdateType lampUpdateType, T... t); + + CompletableFuture updateAsync(final LampUpdateType lampUpdateType, T... t); + + /** + * This returns you if the Lamp is enabled or disabled. + * But the Bridge handels that stuff a litte bit buggy + * so i dont recommend to use it while it wasnt fixed by Phillips. + * + * @return on/off + */ + @Deprecated(since = "hue-api-bride-buggy") + boolean isOn(); + + /** + * This returns you the {@link UUID} of the Lamp in the v2 HueAPI Version. + * Note that this UUID is only Single when you are using one {@link HueBridge}. + * With 2 or more {@link HueBridge} the Id can be duplicated. + * + * @return you the id + */ + UUID getId(); + + /** + * This returns you the Id of the Lamp. + * Its the HueAPI v1 Id (example: /light/1) + * + * @return you the old id + */ + @Deprecated(since = "hue-api-v2-release") + String getId_v1(); + + /** + *

Returns you the Simple Name of the Lamp. + * + * @return you the Name of the Lamp + */ + String getName(); + + /** + *

Returns you you the alert Effets. + * + * @return the {@link Alert} + */ + Alert getAlert(); + + /** + *

Returns you the Color from the Lamp. + *

The Color format is CIE. + * + * @return you the {@link Color} + */ + Color getColor() throws NullPointerException; + + /** + * Returns you the current {@link LampMode} of the Lamp. + * It Returns {@link LampMode}.STREAMING when the Lamp is listening to Something + * like Spotify, Desktop or something else. + * + * @return you the LampMode + */ + LampMode getLampMode(); + + Dimming getDimming(); + + /** + * This returns you which type of Lamp this {@link HueLamp} is. + * When it can diplay Colors, it is a {@link LampType} COLOR + * + * @return you the LampType + */ + LampType getLampType(); + + /** + * Returns you the MetaData from the {@link HueLamp}. + * It contains the {@link LampArchetype}. At this time, the api is basically maintained for the {@link LampType} + * but other types works to. + * The second thing in the {@link MetaData} is the name of the Lamp which you can get with the + * {@code getName()} Method. + * + * @return you the {@link MetaData} + */ + MetaData getMetaData(); + + HueBridge getHueBridge(); + + /** + *

This are the Sub Classes for the {@link HueLamp} + */ + @Data + @AllArgsConstructor + class MetaData { + private LampArchetype archetype; + private String name; + } + + @Data + class Alert { + private List action_values; + } + + @Data + class Dimming { + private final Number brightness; + } + + @Data + class Color { + private Map gamut; + private String gamut_type; + private ColorEntry xy; + + @Data + public static class ColorEntry { + private double x; + private double y; + } + } +} \ No newline at end of file diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/api/HueLampDiscovery.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/api/HueLampDiscovery.java new file mode 100644 index 0000000..92d644e --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/api/HueLampDiscovery.java @@ -0,0 +1,18 @@ +package de.maxizink.lightcontroller.discovery.lamp.api; + +import com.google.gson.JsonObject; +import de.maxizink.lightcontroller.discovery.bridge.api.HueBridge; +import de.maxizink.lightcontroller.injection.Service; + +import java.util.List; +import java.util.concurrent.CompletableFuture; + +public interface HueLampDiscovery extends Service { + + List discoverAllLamps(final HueBridge hueBridge); + + CompletableFuture> discoverAllLampsAsync(final HueBridge hueBridge); + + JsonObject getLampObject(final HueLamp hueLamp); + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/api/LampUpdate.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/api/LampUpdate.java new file mode 100644 index 0000000..d160f4c --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/api/LampUpdate.java @@ -0,0 +1,9 @@ +package de.maxizink.lightcontroller.discovery.lamp.api; + +import de.maxizink.lightcontroller.body.HueRequestBody; + +public interface LampUpdate { + + HueRequestBody getRequestBody(final T... param); + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/body/HueColorBody.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/body/HueColorBody.java new file mode 100644 index 0000000..8d503fd --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/body/HueColorBody.java @@ -0,0 +1,33 @@ +package de.maxizink.lightcontroller.discovery.lamp.body; + +import de.maxizink.lightcontroller.body.HueRequestBody; +import lombok.Data; + +public class HueColorBody implements HueRequestBody { + + private CustomColor color; + + public HueColorBody(double x, double y) { + this.color = new CustomColor(x, y); + } + + @Data + public static class CustomColor { + + private final ColorEntry xy; + + public CustomColor(double x, double y) { + this.xy = new ColorEntry(x, y); + } + + @Data + private static class ColorEntry { + + private final double x; + private final double y; + + } + + } + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/body/HueColorTemperatureBody.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/body/HueColorTemperatureBody.java new file mode 100644 index 0000000..1314c27 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/body/HueColorTemperatureBody.java @@ -0,0 +1,26 @@ +package de.maxizink.lightcontroller.discovery.lamp.body; + +import de.maxizink.lightcontroller.body.HueRequestBody; +import de.maxizink.lightcontroller.discovery.lamp.api.HueLamp; +import lombok.Data; +import lombok.NoArgsConstructor; + +@Data +@NoArgsConstructor +public class HueColorTemperatureBody implements HueRequestBody { + + private ColorTemperature color_temperature; + + public HueColorTemperatureBody(final int mirek) { + if (mirek < 135 || mirek > 500) { + throw new IllegalArgumentException("int is not between 135 and 500"); + } + this.color_temperature = new ColorTemperature(mirek); + } + + @Data + public static class ColorTemperature { + private final int mirek; + } + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/body/HueLampBrightnessBody.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/body/HueLampBrightnessBody.java new file mode 100644 index 0000000..4359d94 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/body/HueLampBrightnessBody.java @@ -0,0 +1,26 @@ +package de.maxizink.lightcontroller.discovery.lamp.body; + +import de.maxizink.lightcontroller.body.HueRequestBody; +import lombok.AllArgsConstructor; +import lombok.Data; +import lombok.NoArgsConstructor; + +@Data +@AllArgsConstructor +@NoArgsConstructor +public class HueLampBrightnessBody implements HueRequestBody { + + private Dimming dimming; + + public HueLampBrightnessBody(final Number brightness) { + this.dimming = new Dimming(brightness); + } + + @Data + public static class Dimming { + + private final Number brightness; + + } + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/body/HueLampEnabledBody.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/body/HueLampEnabledBody.java new file mode 100644 index 0000000..1ef2602 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/body/HueLampEnabledBody.java @@ -0,0 +1,23 @@ +package de.maxizink.lightcontroller.discovery.lamp.body; + +import de.maxizink.lightcontroller.body.HueRequestBody; +import lombok.Data; + +@Data +public class HueLampEnabledBody implements HueRequestBody { + + private EnabledStatus on; + + public HueLampEnabledBody(final boolean enabled) { + this.on = new EnabledStatus(enabled); + } + + @Data + public static class EnabledStatus { + + //Real Data + private final boolean on; + + } + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/exception/HueLampDiscoveryException.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/exception/HueLampDiscoveryException.java new file mode 100644 index 0000000..b5f3e6c --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/exception/HueLampDiscoveryException.java @@ -0,0 +1,9 @@ +package de.maxizink.lightcontroller.discovery.lamp.exception; + +public class HueLampDiscoveryException extends RuntimeException { + + public HueLampDiscoveryException(final String message) { + super(message); + } + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/model/HueColor.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/model/HueColor.java new file mode 100644 index 0000000..e75ff54 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/model/HueColor.java @@ -0,0 +1,20 @@ +package de.maxizink.lightcontroller.discovery.lamp.model; + +import lombok.AllArgsConstructor; +import lombok.Getter; + +@AllArgsConstructor +@Getter +public enum HueColor { + + RED(0.675, 0.322), + GREEN(0.24, 0.42), + YELLOW(0.45, 0.5), + VIOLET(0.08, 0.2), + ORANGE(0.5, 0.42), + BLUE(00.18, 0.15); + + private double x; + private double y; + + } diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/model/HueLampImpl.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/model/HueLampImpl.java new file mode 100644 index 0000000..2a6da8f --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/model/HueLampImpl.java @@ -0,0 +1,118 @@ +package de.maxizink.lightcontroller.discovery.lamp.model; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.google.gson.JsonObject; +import de.maxizink.lightcontroller.discovery.bridge.api.HueBridge; +import de.maxizink.lightcontroller.discovery.bridge.models.HueBridgeCredentials; +import de.maxizink.lightcontroller.discovery.lamp.api.HueLamp; +import de.maxizink.lightcontroller.discovery.lamp.api.HueLampDiscovery; +import de.maxizink.lightcontroller.discovery.lamp.api.LampUpdate; +import de.maxizink.lightcontroller.mapper.CustomObjectMapper; +import de.maxizink.lightcontroller.injection.ServiceAccessor; +import de.maxizink.lightcontroller.utils.HttpUtils; +import de.maxizink.lightcontroller.utils.URLFormatter; +import lombok.Getter; +import lombok.SneakyThrows; +import org.apache.http.client.HttpClient; +import org.apache.http.client.methods.HttpUriRequest; +import org.jetbrains.annotations.Nullable; + +import java.lang.reflect.Constructor; +import java.util.UUID; +import java.util.concurrent.CompletableFuture; + +import static de.maxizink.lightcontroller.utils.HttpUtils.createCredentialHeader; +import static de.maxizink.lightcontroller.utils.HttpUtils.executeJson; + +@Getter +public class HueLampImpl implements HueLamp { + + private static final ObjectMapper OBJECT_MAPPER = CustomObjectMapper.create(); + + private UUID id; + private String id_v1; + private Alert alert; + private @Nullable Color color; + private LampMode lampMode; + private Dimming dimming; + private LampType lampType; + private MetaData metaData; + @Deprecated(since = "hue-api-bride-buggy") + private boolean on; + + private final HueBridge hueBridge; + + @SneakyThrows + public HueLampImpl(final JsonObject dataObject, final HueBridge hueBridge) { + this.hueBridge = hueBridge; + + this.id = UUID.fromString(dataObject.get("id").getAsString()); + this.id_v1 = dataObject.get("id_v1").getAsString(); + this.on = dataObject.getAsJsonObject("on").get("on").getAsBoolean(); + this.alert = OBJECT_MAPPER.readValue(dataObject.getAsJsonObject("alert").toString(), Alert.class); + this.lampMode = LampMode.getMode(dataObject.get("mode").getAsString()); + this.dimming = new Dimming(dataObject.getAsJsonObject("dimming").get("brightness").getAsNumber()); + + if (dataObject.has("color")) { + this.color = OBJECT_MAPPER.readValue(dataObject.getAsJsonObject("color").toString(), Color.class); + this.lampType = LampType.COLOR; + } else { + this.lampType = LampType.NO_COLOR; + } + + JsonObject metaDataObject = dataObject.getAsJsonObject("metadata"); + this.metaData = new MetaData(LampArchetype.getArchetype(metaDataObject.get("archetype").getAsString()), + metaDataObject.get("name").getAsString()); + } + + @Override + public void refreshLampState() { + HueLampDiscovery hueLampDiscovery = ServiceAccessor.accessService(HueLampDiscovery.class); + JsonObject jsonObject = hueLampDiscovery.getLampObject(this); + + HueLamp hueLamp = new HueLampImpl(jsonObject, hueBridge); + if (jsonObject.has("color")) { + this.color = hueLamp.getColor(); + } + + this.on = hueLamp.isOn(); + this.lampMode = hueLamp.getLampMode(); + this.alert = hueLamp.getAlert(); + this.metaData = hueLamp.getMetaData(); + this.dimming = new Dimming(jsonObject.getAsJsonObject("dimming").get("brightness").getAsNumber()); + } + + @SneakyThrows + @Override + public void updateSync(final LampUpdateType lampUpdateType, final T... t) { + HueLampDiscovery hueLampDiscovery = ServiceAccessor.accessService(HueLampDiscovery.class); + + Constructor constructor = lampUpdateType.getUpdateClazz().getConstructor(HueLamp.class); + LampUpdate lampUpdate = (LampUpdate) constructor.newInstance(this); + + HueBridgeCredentials hueBridgeCredentials = getHueBridge().getHueBridgeCredentials(); + HttpClient httpClient = HttpUtils.createClient(); + HttpUriRequest httpRequest = HttpUtils.createPutRequest( + URLFormatter.getLamp(hueBridgeCredentials.getIpAddress(), this.getId()), + lampUpdate.getRequestBody(t), + createCredentialHeader(hueBridgeCredentials) + ); + executeJson(httpClient, httpRequest); + refreshLampState(); + } + + @Override + public CompletableFuture updateAsync(final LampUpdateType lampUpdateType, final T... t) { + return CompletableFuture.runAsync(() -> updateSync(lampUpdateType, t)); + } + + @Override + public String getName() { + return this.metaData.getName(); + } + + @Override + public HueBridge getHueBridge() { + return hueBridge; + } +} \ No newline at end of file diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/model/LampArchetype.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/model/LampArchetype.java new file mode 100644 index 0000000..df6812d --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/model/LampArchetype.java @@ -0,0 +1,51 @@ +package de.maxizink.lightcontroller.discovery.lamp.model; + +public enum LampArchetype { + + UNKNOWN_ARCHETYPE, + CLASSIC_BULB, + SULTAN_BULB, + FLOOD_BULB, + /** + * Implemented {@link de.maxizink.lightcontroller.discovery.lamp.api.HueLamp} + */ + SPOT_BULB, + CANDLE_BULB, + LUSTER_BULB, + PENDANT_ROUND, + PENDANT_LONG, + CEILING_ROUND, + CEILING_SQUARE, + FLOOR_SHADE, + FLOOR_LANTERN, + TABLE_SHADE, + RECESSED_CEILING, + RECESSED_FLOOR, + SINGLE_SPOT, + DOUBLE_SPOT, + TABLE_WASH, + WALL_LANTERN, + WALL_SHADE, + FLEXIBLE_LAMP, + GROUND_SPOT, + WALL_SPOT, + PLUG, + HUE_GO, + HUE_LIGHTSTRIP, + HUE_IRIS, + HUE_BLOOM, + BOLLARD, + WALL_WASHER, + HUE_PLAY, + VINTAGE_BULB, + CHRISTMAS_TREE, + HUE_CENTRIS, + HUE_LIGHTSTRIP_TV, + HUE_TUBE, + HUE_SIGNE; + + public static LampArchetype getArchetype(final String value) { + return LampArchetype.valueOf(value.toUpperCase()); + } + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/model/LampMode.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/model/LampMode.java new file mode 100644 index 0000000..13a6c56 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/model/LampMode.java @@ -0,0 +1,21 @@ +package de.maxizink.lightcontroller.discovery.lamp.model; + +public enum LampMode { + + NORMAL, + STREAMING; + + static LampMode getMode(final String mode) { + switch (mode.toLowerCase()) { + case "normal" -> { + return NORMAL; + } + case "streaming" -> { + return STREAMING; + } + } + return null; + } + + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/model/LampType.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/model/LampType.java new file mode 100644 index 0000000..7276237 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/model/LampType.java @@ -0,0 +1,8 @@ +package de.maxizink.lightcontroller.discovery.lamp.model; + +public enum LampType { + + COLOR, + NO_COLOR + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/model/LampUpdateType.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/model/LampUpdateType.java new file mode 100644 index 0000000..9471dba --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/model/LampUpdateType.java @@ -0,0 +1,25 @@ +package de.maxizink.lightcontroller.discovery.lamp.model; + +import de.maxizink.lightcontroller.discovery.lamp.api.LampUpdate; +import de.maxizink.lightcontroller.discovery.lamp.update.BrightnessLampUpdate; +import de.maxizink.lightcontroller.discovery.lamp.update.ColorLampUpdate; +import de.maxizink.lightcontroller.discovery.lamp.update.ColorTemperatureLampUpdate; +import de.maxizink.lightcontroller.discovery.lamp.update.EnabledLampUpdate; +import lombok.AllArgsConstructor; +import lombok.Getter; + +import java.awt.*; + +@AllArgsConstructor +@Getter +public final class LampUpdateType { + + public static final LampUpdateType COLOR = new LampUpdateType<>(ColorLampUpdate.class, Color.class); + public static final LampUpdateType COLOR_TEMPERATURE = new LampUpdateType<>(ColorTemperatureLampUpdate.class, Integer.class); + public static final LampUpdateType ENABLE = new LampUpdateType<>(EnabledLampUpdate.class, Boolean.class); + public static final LampUpdateType BRIGHTNESS = new LampUpdateType<>(BrightnessLampUpdate.class, Number.class); + + private Class> updateClazz; + private Class type; + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/service/HueLampDiscoveryService.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/service/HueLampDiscoveryService.java new file mode 100644 index 0000000..b7cad2c --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/service/HueLampDiscoveryService.java @@ -0,0 +1,75 @@ +package de.maxizink.lightcontroller.discovery.lamp.service; + +import com.google.gson.JsonArray; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import de.maxizink.lightcontroller.discovery.bridge.api.HueBridge; +import de.maxizink.lightcontroller.discovery.lamp.api.HueLamp; +import de.maxizink.lightcontroller.discovery.lamp.api.HueLampDiscovery; +import de.maxizink.lightcontroller.discovery.lamp.exception.HueLampDiscoveryException; +import de.maxizink.lightcontroller.discovery.lamp.model.HueLampImpl; +import de.maxizink.lightcontroller.utils.HttpUtils; +import de.maxizink.lightcontroller.utils.HueResponseValidator; +import de.maxizink.lightcontroller.utils.JsonUtils; +import de.maxizink.lightcontroller.utils.URLFormatter; +import org.apache.http.client.HttpClient; +import org.apache.http.client.methods.HttpUriRequest; + +import java.util.ArrayList; +import java.util.List; +import java.util.concurrent.CompletableFuture; + +import static de.maxizink.lightcontroller.utils.HttpUtils.*; + +public class HueLampDiscoveryService implements HueLampDiscovery { + + @Override + public List discoverAllLamps(final HueBridge hueBridge) { + HttpClient httpClient = createClient(); + HttpUriRequest httpRequest = createRequest(URLFormatter.getAllLamps(hueBridge.getHueBridgeCredentials().getIpAddress()), + HttpUtils.createCredentialHeader(hueBridge.getHueBridgeCredentials())); + + String json = executeJson(httpClient, httpRequest); + JsonObject jsonObject = JsonUtils.fromJson(json); + if (HueResponseValidator.hasErrors(jsonObject)) { + throw new HueLampDiscoveryException("Error while fetching HueLamps"); + } + + List hueLamps = new ArrayList<>(); + JsonArray jsonLampArray = jsonObject.getAsJsonArray("data"); + for (JsonElement jsonElement : jsonLampArray) { + HueLamp hueLamp = new HueLampImpl(jsonElement.getAsJsonObject(), hueBridge); + hueLamps.add(hueLamp); + } + + return hueLamps; + } + + @Override + public CompletableFuture> discoverAllLampsAsync(final HueBridge hueBridge) { + return CompletableFuture.supplyAsync(() -> discoverAllLamps(hueBridge)); + } + + @Override + public JsonObject getLampObject(final HueLamp hueLamp) { + HueBridge hueBridge = hueLamp.getHueBridge(); + HttpClient httpClient = createClient(); + HttpUriRequest httpRequest = createRequest(URLFormatter.getAllLamps(hueBridge.getHueBridgeCredentials().getIpAddress()), + HttpUtils.createCredentialHeader(hueBridge.getHueBridgeCredentials())); + + String json = executeJson(httpClient, httpRequest); + JsonObject jsonObject = JsonUtils.fromJson(json); + if (HueResponseValidator.hasErrors(jsonObject)) { + throw new HueLampDiscoveryException("Error while fetching HueLamps"); + } + + JsonArray jsonLampArray = jsonObject.getAsJsonArray("data"); + for (JsonElement jsonElement : jsonLampArray) { + HueLamp lampImpl = new HueLampImpl(jsonElement.getAsJsonObject(), hueBridge); + if (lampImpl.getId().equals(hueLamp.getId())) { + return jsonElement.getAsJsonObject(); + } + } + throw new IllegalArgumentException("Unknown Lamp"); + } +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/update/BrightnessLampUpdate.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/update/BrightnessLampUpdate.java new file mode 100644 index 0000000..308afe0 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/update/BrightnessLampUpdate.java @@ -0,0 +1,19 @@ +package de.maxizink.lightcontroller.discovery.lamp.update; + +import de.maxizink.lightcontroller.body.HueRequestBody; +import de.maxizink.lightcontroller.discovery.lamp.api.HueLamp; +import de.maxizink.lightcontroller.discovery.lamp.api.LampUpdate; +import de.maxizink.lightcontroller.discovery.lamp.body.HueLampBrightnessBody; +import lombok.AllArgsConstructor; + +@AllArgsConstructor +public class BrightnessLampUpdate implements LampUpdate { + + private final HueLamp hueLamp; + + @Override + public HueRequestBody getRequestBody(final Number... param) { + return new HueLampBrightnessBody(param[0]); + } + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/update/ColorLampUpdate.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/update/ColorLampUpdate.java new file mode 100644 index 0000000..0a05b04 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/update/ColorLampUpdate.java @@ -0,0 +1,22 @@ +package de.maxizink.lightcontroller.discovery.lamp.update; + +import de.maxizink.lightcontroller.body.HueRequestBody; +import de.maxizink.lightcontroller.discovery.lamp.api.HueLamp; +import de.maxizink.lightcontroller.discovery.lamp.api.LampUpdate; +import de.maxizink.lightcontroller.discovery.lamp.body.HueColorBody; +import de.maxizink.lightcontroller.utils.CIEColor; +import lombok.AllArgsConstructor; + +import java.awt.*; + +@AllArgsConstructor +public class ColorLampUpdate implements LampUpdate { + + private final HueLamp hueLamp; + + @Override + public HueRequestBody getRequestBody(Color... param) { + CIEColor color = CIEColor.converterColorToCIE(param[0]); + return new HueColorBody(color.getX(), color.getY()); + } +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/update/ColorTemperatureLampUpdate.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/update/ColorTemperatureLampUpdate.java new file mode 100644 index 0000000..a4183b6 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/update/ColorTemperatureLampUpdate.java @@ -0,0 +1,18 @@ +package de.maxizink.lightcontroller.discovery.lamp.update; + +import de.maxizink.lightcontroller.body.HueRequestBody; +import de.maxizink.lightcontroller.discovery.lamp.api.HueLamp; +import de.maxizink.lightcontroller.discovery.lamp.api.LampUpdate; +import de.maxizink.lightcontroller.discovery.lamp.body.HueColorTemperatureBody; +import lombok.AllArgsConstructor; + +@AllArgsConstructor +public class ColorTemperatureLampUpdate implements LampUpdate { + + private final HueLamp hueLamp; + + @Override + public HueRequestBody getRequestBody(Integer... param) { + return new HueColorTemperatureBody(param[0]); + } +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/update/EnabledLampUpdate.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/update/EnabledLampUpdate.java new file mode 100644 index 0000000..ebfa2f2 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/lamp/update/EnabledLampUpdate.java @@ -0,0 +1,19 @@ +package de.maxizink.lightcontroller.discovery.lamp.update; + +import de.maxizink.lightcontroller.body.HueRequestBody; +import de.maxizink.lightcontroller.discovery.lamp.api.HueLamp; +import de.maxizink.lightcontroller.discovery.lamp.api.LampUpdate; +import de.maxizink.lightcontroller.discovery.lamp.body.HueLampEnabledBody; +import lombok.AllArgsConstructor; + +@AllArgsConstructor +public class EnabledLampUpdate implements LampUpdate { + + public HueLamp hueLamp; + + @Override + public HueRequestBody getRequestBody(final Boolean... param) { + return new HueLampEnabledBody(param[0]); + } + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/room/api/HueRoom.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/room/api/HueRoom.java new file mode 100644 index 0000000..53a5b03 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/room/api/HueRoom.java @@ -0,0 +1,29 @@ +package de.maxizink.lightcontroller.discovery.room.api; + +import de.maxizink.lightcontroller.discovery.bridge.api.HueBridge; +import de.maxizink.lightcontroller.discovery.lamp.api.HueLamp; +import de.maxizink.lightcontroller.discovery.lamp.model.LampUpdateType; +import de.maxizink.lightcontroller.discovery.room.model.RoomArchetype; + +import java.util.List; +import java.util.UUID; + +public interface HueRoom { + + void updateRoomLamps(final LampUpdateType lampUpdateType, final T... value); + + void turnOn(); + + void turnOff(); + + String getName(); + + UUID getId(); + + RoomArchetype getRoomArchetype(); + + HueBridge getHueBridge(); + + List getLamps(); + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/room/api/HueRoomDiscovery.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/room/api/HueRoomDiscovery.java new file mode 100644 index 0000000..01d3241 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/room/api/HueRoomDiscovery.java @@ -0,0 +1,18 @@ +package de.maxizink.lightcontroller.discovery.room.api; + +import de.maxizink.lightcontroller.discovery.bridge.api.HueBridge; +import de.maxizink.lightcontroller.injection.Service; + +import java.util.List; +import java.util.Optional; +import java.util.UUID; + +public interface HueRoomDiscovery extends Service { + + Optional getHueRoomById(final HueBridge hueBridge, final UUID uniqueId); + + Optional getHueRoomByName(final HueBridge hueBridge, final String name); + + List discoverAllRooms(final HueBridge hueBridge); + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/room/exception/HueRoomDiscoveryException.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/room/exception/HueRoomDiscoveryException.java new file mode 100644 index 0000000..4714e43 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/room/exception/HueRoomDiscoveryException.java @@ -0,0 +1,9 @@ +package de.maxizink.lightcontroller.discovery.room.exception; + +public class HueRoomDiscoveryException extends RuntimeException { + + public HueRoomDiscoveryException(final String message) { + super(message); + } + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/room/model/HueRoomImpl.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/room/model/HueRoomImpl.java new file mode 100644 index 0000000..3f09b86 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/room/model/HueRoomImpl.java @@ -0,0 +1,102 @@ +package de.maxizink.lightcontroller.discovery.room.model; + +import com.google.gson.JsonArray; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import de.maxizink.lightcontroller.discovery.ResourceType; +import de.maxizink.lightcontroller.discovery.bridge.api.HueBridge; +import de.maxizink.lightcontroller.discovery.lamp.api.HueLamp; +import de.maxizink.lightcontroller.discovery.lamp.model.LampUpdateType; +import de.maxizink.lightcontroller.discovery.room.api.HueRoom; + +import java.util.ArrayList; +import java.util.List; +import java.util.Optional; +import java.util.UUID; +import java.util.stream.Collectors; + +public class HueRoomImpl implements HueRoom { + + private final HueBridge hueBridge; + private final String roomName; + private final RoomArchetype roomArchetype; + private final UUID id; + + private final List lampIDs = new ArrayList<>(); + + public HueRoomImpl(final JsonObject dataObject, final HueBridge hueBridge) { + this.hueBridge = hueBridge; + + JsonObject metaDataObject = dataObject.getAsJsonObject("metadata"); + this.roomName = metaDataObject.get("name").getAsString(); + this.roomArchetype = RoomArchetype.getRoomArchetype(metaDataObject.get("archetype").getAsString()); + + this.id = UUID.fromString(dataObject.get("id").getAsString()); + + JsonArray jsonArray = dataObject.getAsJsonArray("services"); + for (JsonElement jsonElement : jsonArray) { + JsonObject object = jsonElement.getAsJsonObject(); + ResourceType resourceType = ResourceType.getResourceType(object.get("rtype").getAsString()); + if (resourceType.equals(ResourceType.LIGHT)) { + this.lampIDs.add(UUID.fromString(object.get("rid").getAsString())); + } + } + } + + @Override + public void turnOn() { + changeRoomStates(true); + } + + @Override + public void turnOff() { + changeRoomStates(false); + } + + @Override + public void updateRoomLamps(final LampUpdateType lampUpdateType, final T... value) { + getLamps().forEach(hueLamp -> hueLamp.updateSync(lampUpdateType, value)); + } + + @Override + public String getName() { + return this.roomName; + } + + @Override + public UUID getId() { + return this.id; + } + + @Override + public RoomArchetype getRoomArchetype() { + return this.roomArchetype; + } + + @Override + public HueBridge getHueBridge() { + return this.hueBridge; + } + + /** + * This class does not cache the HueLamps because the data of the lamps can be old + * when caching the lamps. + * + * @return a list of {@link HueLamp} from the {@link HueRoom} + */ + @Override + public List getLamps() { + return this.lampIDs.stream() + .map(this.hueBridge::getLampById) + .filter(Optional::isPresent) + .map(Optional::get) + .collect(Collectors.toList()); + } + + private void changeRoomStates(final boolean enabled) { + for (HueLamp lamp : getLamps()) { + lamp.updateSync(LampUpdateType.ENABLE, enabled); + } + } + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/room/model/RoomArchetype.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/room/model/RoomArchetype.java new file mode 100644 index 0000000..a898246 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/room/model/RoomArchetype.java @@ -0,0 +1,50 @@ +package de.maxizink.lightcontroller.discovery.room.model; + +public enum RoomArchetype { + + LIVING_ROOM, + KITCHEN, + DINING, + BEDROOM, + KIDS_BEDROOM, + BATHROOM, + NURSERY, + RECREATION, + OFFICE, + GYM, + HALLWAY, + TOILET, + FRONT_DOOR, + GARAGE, + TERRACE, + GARDEN, + DRIVEWAY, + CARPORT, + HOME, + DOWNSTAIRS, + UPSTAIRS, + TOP_FLOOR, + ATTIC, + GUEST_ROOM, + STAIRCASE, + LOUNGE, + MAN_CAVE, + COMPUTER, + STUDIO, + MUSIC, + TV, + READING, + CLOSET, + STORAGE, + LAUNDRY_ROOM, + BALCONY, + PORCH, + BARBECUE, + POOL, + OTHER; + + public static RoomArchetype getRoomArchetype(final String string) { + return valueOf(string.toUpperCase()); + } + + } diff --git a/api/src/main/java/de/maxizink/lightcontroller/discovery/room/service/HueRoomDiscoveryService.java b/api/src/main/java/de/maxizink/lightcontroller/discovery/room/service/HueRoomDiscoveryService.java new file mode 100644 index 0000000..f68caf2 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/discovery/room/service/HueRoomDiscoveryService.java @@ -0,0 +1,60 @@ +package de.maxizink.lightcontroller.discovery.room.service; + +import com.google.gson.JsonArray; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import de.maxizink.lightcontroller.discovery.bridge.api.HueBridge; +import de.maxizink.lightcontroller.discovery.room.api.HueRoom; +import de.maxizink.lightcontroller.discovery.room.api.HueRoomDiscovery; +import de.maxizink.lightcontroller.discovery.room.exception.HueRoomDiscoveryException; +import de.maxizink.lightcontroller.discovery.room.model.HueRoomImpl; +import de.maxizink.lightcontroller.utils.HueResponseValidator; +import de.maxizink.lightcontroller.utils.JsonUtils; +import de.maxizink.lightcontroller.utils.URLFormatter; +import org.apache.http.client.methods.HttpUriRequest; + +import java.util.ArrayList; +import java.util.List; +import java.util.Optional; +import java.util.UUID; + +import static de.maxizink.lightcontroller.utils.HttpUtils.*; + +public class HueRoomDiscoveryService implements HueRoomDiscovery { + + @Override + public Optional getHueRoomById(final HueBridge hueBridge, final UUID uniqueId) { + return discoverAllRooms(hueBridge).stream() + .filter(hueRoom -> hueRoom.getId().equals(uniqueId)) + .findFirst(); + } + + @Override + public Optional getHueRoomByName(final HueBridge hueBridge, final String name) { + return discoverAllRooms(hueBridge).stream() + .filter(hueRoom -> hueRoom.getName().equals(name)) + .findFirst(); + } + + @Override + public List discoverAllRooms(final HueBridge hueBridge) { + HttpUriRequest httpRequest = createRequest(URLFormatter.getAllRooms(hueBridge.getHueBridgeCredentials().getIpAddress()), + createCredentialHeader(hueBridge.getHueBridgeCredentials())); + + String json = executeJson(httpRequest); + + JsonObject dataObject = JsonUtils.fromJson(executeJson(httpRequest)); + if (HueResponseValidator.hasErrors(dataObject)) { + throw new HueRoomDiscoveryException("Error while discover Rooms"); + } + + List hueRooms = new ArrayList<>(); + JsonArray jsonLampArray = dataObject.getAsJsonArray("data"); + for (JsonElement jsonElement : jsonLampArray) { + HueRoom hueRoom = new HueRoomImpl(jsonElement.getAsJsonObject(), hueBridge); + hueRooms.add(hueRoom); + } + + return hueRooms; + } +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/injection/Service.java b/api/src/main/java/de/maxizink/lightcontroller/injection/Service.java new file mode 100644 index 0000000..7631427 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/injection/Service.java @@ -0,0 +1,4 @@ +package de.maxizink.lightcontroller.injection; + +public interface Service { +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/injection/ServiceAccessor.java b/api/src/main/java/de/maxizink/lightcontroller/injection/ServiceAccessor.java new file mode 100644 index 0000000..9d49870 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/injection/ServiceAccessor.java @@ -0,0 +1,36 @@ +package de.maxizink.lightcontroller.injection; + +import de.maxizink.lightcontroller.discovery.bridge.api.BridgeCredentialsDiscovery; +import de.maxizink.lightcontroller.discovery.bridge.api.BridgeIpDiscovery; +import de.maxizink.lightcontroller.discovery.bridge.api.HueBridgeDiscovery; +import de.maxizink.lightcontroller.discovery.bridge.service.BridgeCredentialsDiscoveryService; +import de.maxizink.lightcontroller.discovery.bridge.service.BridgeIpDiscoveryService; +import de.maxizink.lightcontroller.discovery.bridge.service.HueBridgeDiscoveryService; +import de.maxizink.lightcontroller.discovery.lamp.api.HueLampDiscovery; +import de.maxizink.lightcontroller.discovery.lamp.service.HueLampDiscoveryService; +import de.maxizink.lightcontroller.discovery.room.api.HueRoomDiscovery; +import de.maxizink.lightcontroller.discovery.room.service.HueRoomDiscoveryService; +import de.maxizink.lightcontroller.utils.TrustEverythingUtil; + +import java.util.HashMap; +import java.util.Map; + +public class ServiceAccessor { + + private static final Map, Service> SERVICES = new HashMap<>(); + + static { + TrustEverythingUtil.trustAllSslConnectionsByDisablingCertificateVerification(); + + SERVICES.put(BridgeIpDiscovery.class, new BridgeIpDiscoveryService()); + SERVICES.put(BridgeCredentialsDiscovery.class, new BridgeCredentialsDiscoveryService()); + SERVICES.put(HueBridgeDiscovery.class, new HueBridgeDiscoveryService()); + SERVICES.put(HueLampDiscovery.class, new HueLampDiscoveryService()); + SERVICES.put(HueRoomDiscovery.class, new HueRoomDiscoveryService()); + } + + public static T accessService(final Class clazz) { + return (T) SERVICES.get(clazz); + } + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/mapper/CustomObjectMapper.java b/api/src/main/java/de/maxizink/lightcontroller/mapper/CustomObjectMapper.java new file mode 100644 index 0000000..0899419 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/mapper/CustomObjectMapper.java @@ -0,0 +1,30 @@ +package de.maxizink.lightcontroller.mapper; + +import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.PropertyAccessor; +import com.fasterxml.jackson.databind.DeserializationFeature; +import com.fasterxml.jackson.databind.ObjectMapper; +import lombok.AccessLevel; +import lombok.NoArgsConstructor; + +@NoArgsConstructor(access = AccessLevel.PRIVATE) +public class CustomObjectMapper { + + public static ObjectMapper create() { + ObjectMapper objectMapper = new ObjectMapper(); + objectMapper.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES); + + objectMapper.setVisibility(PropertyAccessor.FIELD, JsonAutoDetect.Visibility.ANY); + objectMapper.setDefaultTyping(createCustomTypeResolver()); + + return objectMapper; + } + + private static CustomTypeResolver createCustomTypeResolver() { + CustomTypeResolver customTypeResolver = new CustomTypeResolver(); + customTypeResolver.init(JsonTypeInfo.Id.CLASS, null); + customTypeResolver.inclusion(JsonTypeInfo.As.PROPERTY); + return customTypeResolver; + } +} \ No newline at end of file diff --git a/api/src/main/java/de/maxizink/lightcontroller/mapper/CustomTypeResolver.java b/api/src/main/java/de/maxizink/lightcontroller/mapper/CustomTypeResolver.java new file mode 100644 index 0000000..a15c311 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/mapper/CustomTypeResolver.java @@ -0,0 +1,17 @@ +package de.maxizink.lightcontroller.mapper; + +import com.fasterxml.jackson.databind.JavaType; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.jsontype.impl.LaissezFaireSubTypeValidator; + +public class CustomTypeResolver extends ObjectMapper.DefaultTypeResolverBuilder { + + public CustomTypeResolver() { + super(ObjectMapper.DefaultTyping.NON_FINAL, LaissezFaireSubTypeValidator.instance); + } + + @Override + public boolean useForType(JavaType t) { + return !t.isContainerType() && (t.isInterface() || t.isAbstract() || t.hasGenericTypes()); + } +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/utils/CIEColor.java b/api/src/main/java/de/maxizink/lightcontroller/utils/CIEColor.java new file mode 100644 index 0000000..d293698 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/utils/CIEColor.java @@ -0,0 +1,36 @@ +package de.maxizink.lightcontroller.utils; + +import lombok.Data; + +import java.awt.*; + +@Data +public class CIEColor { + + private final float x; + private final float y; + private final int brightness; + + public static CIEColor converterColorToCIE(final Color color) { + float red = color.getRed(); + float green = color.getGreen(); + float blue = color.getBlue(); + + double redGamma = gamma(red); + double greenGama = gamma(green); + double blueGama = gamma(blue); + + double rgbX = redGamma * 0.664511f + greenGama * 0.154324f + blueGama * 0.162028f; + double rgbY = redGamma * 0.283881f + greenGama * 0.668433f + blueGama * 0.047685f; + double rgbZ = redGamma * 0.000088f + greenGama * 0.072310f + blueGama * 0.986039f; + + float x = (float) (rgbX / (rgbX + rgbY + rgbZ)); + float y = (float) (rgbY / (rgbX + rgbY + rgbZ)); + return new CIEColor(x, y, (int) (rgbY * 255f)); + } + + private static double gamma(float component) { + return (component > 0.04045f) ? Math.pow((component + 0.055f) / (1.0f + 0.055f), 2.4f) : (component / 12.92f); + } + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/utils/HttpUtils.java b/api/src/main/java/de/maxizink/lightcontroller/utils/HttpUtils.java new file mode 100644 index 0000000..ac11bfb --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/utils/HttpUtils.java @@ -0,0 +1,98 @@ +package de.maxizink.lightcontroller.utils; + +import com.fasterxml.jackson.databind.ObjectMapper; +import de.maxizink.lightcontroller.body.HueRequestBody; +import de.maxizink.lightcontroller.discovery.bridge.models.HueBridgeCredentials; +import de.maxizink.lightcontroller.mapper.CustomObjectMapper; +import lombok.SneakyThrows; +import org.apache.http.Header; +import org.apache.http.HttpResponse; +import org.apache.http.client.HttpClient; +import org.apache.http.client.methods.HttpUriRequest; +import org.apache.http.client.methods.RequestBuilder; +import org.apache.http.conn.ssl.SSLConnectionSocketFactory; +import org.apache.http.entity.StringEntity; +import org.apache.http.impl.client.HttpClients; +import org.apache.http.message.BasicHeader; +import org.apache.http.util.EntityUtils; + +import java.net.URI; + +public class HttpUtils { + + private static final ObjectMapper OBJECT_MAPPER = CustomObjectMapper.create(); + + public static Header createCredentialHeader(final HueBridgeCredentials hueBridgeCredentials) { + return new BasicHeader("hue-application-key", hueBridgeCredentials.getUserName()); + } + + @SneakyThrows + public static String executeJson(final HttpUriRequest httpRequest) { + return executeJson(createClient(), httpRequest); + } + + @SneakyThrows + public static String executeJson(final HttpClient httpClient, final HttpUriRequest httpRequest) { + HttpResponse httpResponse = httpClient.execute(httpRequest); + return EntityUtils.toString(httpResponse.getEntity()); + } + + public static HttpClient createClient() { + return HttpClients.custom() + .setSSLSocketFactory(new SSLConnectionSocketFactory(TrustEverythingUtil.getContext(), (hostname, session) -> true)) + .setSSLHostnameVerifier((hostname, session) -> true) + .build(); + } + + public static HttpUriRequest createRequest(final URI uri) { + return RequestBuilder.get() + .setUri(uri) + .build(); + } + + public static HttpUriRequest createRequest(final URI uri, final Header... headers) { + RequestBuilder requestBuilder = RequestBuilder.get(); + requestBuilder.setUri(uri); + for (Header header : headers) { + requestBuilder.addHeader(header); + } + return requestBuilder.build(); + } + + + @SneakyThrows + public static HttpUriRequest createPostRequest(final URI uri, final HueRequestBody hueRequestBody) { + return RequestBuilder.post() + .setUri(uri) + .setEntity(new StringEntity(OBJECT_MAPPER.writeValueAsString(hueRequestBody))) + .build(); + } + + @SneakyThrows + public static HttpUriRequest createPostRequest(final URI uri, final HueRequestBody hueRequestBody, + final Header... headers) { + RequestBuilder requestBuilder = RequestBuilder.post() + .setUri(uri) + .setEntity(new StringEntity(OBJECT_MAPPER.writeValueAsString(hueRequestBody))); + + for (Header header : headers) { + requestBuilder.addHeader(header); + } + + return requestBuilder.build(); + } + + @SneakyThrows + public static HttpUriRequest createPutRequest(final URI uri, final HueRequestBody hueRequestBody, + final Header... headers) { + RequestBuilder requestBuilder = RequestBuilder.put() + .setUri(uri) + .setEntity(new StringEntity(OBJECT_MAPPER.writeValueAsString(hueRequestBody))); + + for (Header header : headers) { + requestBuilder.addHeader(header); + } + + return requestBuilder.build(); + } +} \ No newline at end of file diff --git a/api/src/main/java/de/maxizink/lightcontroller/utils/HueResponseValidator.java b/api/src/main/java/de/maxizink/lightcontroller/utils/HueResponseValidator.java new file mode 100644 index 0000000..04f5a65 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/utils/HueResponseValidator.java @@ -0,0 +1,15 @@ +package de.maxizink.lightcontroller.utils; + +import com.google.gson.JsonArray; +import com.google.gson.JsonObject; + +public class HueResponseValidator { + + public static boolean hasErrors(final JsonObject jsonObject) { + if (!jsonObject.has("errors")) { + return false; + } + JsonArray errorArray = jsonObject.getAsJsonArray("errors"); + return errorArray.size() >= 1; + } +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/utils/JsonUtils.java b/api/src/main/java/de/maxizink/lightcontroller/utils/JsonUtils.java new file mode 100644 index 0000000..ada45aa --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/utils/JsonUtils.java @@ -0,0 +1,18 @@ +package de.maxizink.lightcontroller.utils; + +import com.google.gson.JsonArray; +import com.google.gson.JsonObject; +import com.google.gson.JsonParser; + +public class JsonUtils { + + public static JsonObject fromJsonArray(final String responseBody) { + JsonArray jsonArray = JsonParser.parseString(responseBody).getAsJsonArray(); + return jsonArray.get(0).getAsJsonObject(); + } + + public static JsonObject fromJson(final String responseBody) { + return JsonParser.parseString(responseBody).getAsJsonObject(); + } + +} diff --git a/api/src/main/java/de/maxizink/lightcontroller/utils/TrustEverythingUtil.java b/api/src/main/java/de/maxizink/lightcontroller/utils/TrustEverythingUtil.java new file mode 100644 index 0000000..efbba7f --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/utils/TrustEverythingUtil.java @@ -0,0 +1,48 @@ +package de.maxizink.lightcontroller.utils; + +import lombok.SneakyThrows; +import lombok.extern.slf4j.Slf4j; + +import javax.net.ssl.HttpsURLConnection; +import javax.net.ssl.SSLContext; +import javax.net.ssl.TrustManager; +import javax.net.ssl.X509TrustManager; +import java.security.SecureRandom; +import java.security.cert.X509Certificate; + +@Slf4j +public class TrustEverythingUtil implements X509TrustManager { + + @Override + public void checkClientTrusted(X509Certificate[] chain, String authType) { + + } + + @Override + public void checkServerTrusted(X509Certificate[] chain, String authType) { + + } + + @Override + public X509Certificate[] getAcceptedIssuers() { + return new X509Certificate[]{}; + } + + @SneakyThrows + public static void trustAllSslConnectionsByDisablingCertificateVerification() { + log.info("Turning off certificate verification..."); + SSLContext sslContext = SSLContext.getInstance("SSL"); + sslContext.init(null, new TrustManager[]{new TrustEverythingUtil()}, new SecureRandom()); + HttpsURLConnection.setDefaultSSLSocketFactory(sslContext.getSocketFactory()); + HttpsURLConnection.setDefaultHostnameVerifier((hostname, session) -> true); + log.info("Certificate verification has been turned off, all certificates are now accepted."); + } + + @SneakyThrows + public static SSLContext getContext() { + SSLContext sslContext = SSLContext.getInstance("SSL"); + sslContext.init(null, new TrustManager[]{new TrustEverythingUtil()}, new SecureRandom()); + return sslContext; + } + +} \ No newline at end of file diff --git a/api/src/main/java/de/maxizink/lightcontroller/utils/URLFormatter.java b/api/src/main/java/de/maxizink/lightcontroller/utils/URLFormatter.java new file mode 100644 index 0000000..73463b3 --- /dev/null +++ b/api/src/main/java/de/maxizink/lightcontroller/utils/URLFormatter.java @@ -0,0 +1,34 @@ +package de.maxizink.lightcontroller.utils; + +import lombok.SneakyThrows; + +import java.net.URI; +import java.util.UUID; + +public class URLFormatter { + + @SneakyThrows + public static URI getBridgeAPIKey(final String bridgeIp) { + return new URI("https://" + bridgeIp + "/api"); + } + + @SneakyThrows + public static URI getBridgeConfig(final String bridgeIp) { + return new URI("https://" + bridgeIp + "/api/config"); + } + + @SneakyThrows + public static URI getAllLamps(final String bridgeIp) { + return new URI("https://" + bridgeIp + "/clip/v2/resource/light"); + } + + @SneakyThrows + public static URI getLamp(final String bridgeIp, final UUID id) { + return new URI("https://" + bridgeIp + "/clip/v2/resource/light/" + id.toString()); + } + + @SneakyThrows + public static URI getAllRooms(final String bridgeIp) { + return new URI("https://" + bridgeIp + "/clip/v2/resource/room"); + } +} diff --git a/api/src/test/java/de/maxizink/lightcontroller/SecondModuleTest.java b/api/src/test/java/de/maxizink/lightcontroller/SecondModuleTest.java new file mode 100644 index 0000000..c4a76ed --- /dev/null +++ b/api/src/test/java/de/maxizink/lightcontroller/SecondModuleTest.java @@ -0,0 +1,4 @@ +package de.maxizink.lightcontroller; + +public class SecondModuleTest { +} diff --git a/assets/light-api.png b/assets/light-api.png new file mode 100644 index 0000000..97f6c1e Binary files /dev/null and b/assets/light-api.png differ diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..e22f50b --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,32 @@ +plugins { + `java-library` + id("org.sonarqube") version "3.3" +} + +group = "de.maxizink" +version = "1.0-SNAPSHOT" + +subprojects { + + apply(plugin="java") + + repositories { + mavenCentral() + } + + dependencies { + compileOnly("org.projectlombok:lombok:1.18.22") + annotationProcessor("org.projectlombok:lombok:1.18.20") + implementation("org.jetbrains:annotations:23.0.0") + testImplementation("org.junit.jupiter:junit-jupiter-api:5.8.2") + testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine") + } +} + +sonarqube { + properties { + property("sonar.projectKey", "IBims1ckoky_LightControllerAPI") + property("sonar.organization", "ibims1ckoky") + property("sonar.host.url", "https://sonarcloud.io") + } +} \ No newline at end of file diff --git a/example/build.gradle.kts b/example/build.gradle.kts new file mode 100644 index 0000000..9cafaab --- /dev/null +++ b/example/build.gradle.kts @@ -0,0 +1,17 @@ +group = "de.maxizink" +version = "1.0-SNAPSHOT" + +description = "LightController-example" + +plugins { + `java-library` +} + +repositories { + maven("https://jitpack.io") +} + +dependencies { + api(project(":LightControllerAPI-api")) + //implementation("com.github.IBims1ckoky:LightControllerAPI:master-SNAPSHOT"); +} diff --git a/example/src/main/java/de/maxizink/lightcontroller/LightControllerExample.java b/example/src/main/java/de/maxizink/lightcontroller/LightControllerExample.java new file mode 100644 index 0000000..db6a5f2 --- /dev/null +++ b/example/src/main/java/de/maxizink/lightcontroller/LightControllerExample.java @@ -0,0 +1,28 @@ +package de.maxizink.lightcontroller; + +import de.maxizink.lightcontroller.discovery.RoomDiscoveryExample; +import de.maxizink.lightcontroller.discovery.bridge.api.BridgeCredentialsDiscovery; +import de.maxizink.lightcontroller.discovery.bridge.api.BridgeIpDiscovery; +import de.maxizink.lightcontroller.discovery.bridge.api.HueBridgeDiscovery; +import de.maxizink.lightcontroller.injection.ServiceAccessor; +import lombok.SneakyThrows; +import lombok.extern.slf4j.Slf4j; + +@Slf4j +public class LightControllerExample { + + @SneakyThrows + public static void main(final String[] args) { + //With that you can load all Services + BridgeIpDiscovery bridgeIpDiscovery = ServiceAccessor.accessService(BridgeIpDiscovery.class); + BridgeCredentialsDiscovery bridgeCredentialsDiscovery = ServiceAccessor.accessService(BridgeCredentialsDiscovery.class); + HueBridgeDiscovery hueBridgeDiscovery = ServiceAccessor.accessService(HueBridgeDiscovery.class); + + //Run all Examples + //new BridgeDiscoveryExample(); + //new LampDiscoveryExample(); + new RoomDiscoveryExample(); + + //new LightControllerUsageExample(); + } +} diff --git a/example/src/main/java/de/maxizink/lightcontroller/LightControllerUsageExample.java b/example/src/main/java/de/maxizink/lightcontroller/LightControllerUsageExample.java new file mode 100644 index 0000000..0c1e452 --- /dev/null +++ b/example/src/main/java/de/maxizink/lightcontroller/LightControllerUsageExample.java @@ -0,0 +1,67 @@ +package de.maxizink.lightcontroller; + +import de.maxizink.lightcontroller.discovery.bridge.api.BridgeCredentialsDiscovery; +import de.maxizink.lightcontroller.discovery.bridge.api.BridgeIpDiscovery; +import de.maxizink.lightcontroller.discovery.bridge.api.HueBridge; +import de.maxizink.lightcontroller.discovery.bridge.api.HueBridgeDiscovery; +import de.maxizink.lightcontroller.discovery.bridge.models.HueBridgeCredentials; +import de.maxizink.lightcontroller.discovery.bridge.response.HueBridgeCredentialsResponse; +import de.maxizink.lightcontroller.discovery.lamp.api.HueLamp; +import de.maxizink.lightcontroller.discovery.lamp.api.HueLampDiscovery; +import de.maxizink.lightcontroller.discovery.lamp.model.LampUpdateType; +import de.maxizink.lightcontroller.discovery.room.api.HueRoom; +import de.maxizink.lightcontroller.injection.ServiceAccessor; + +import java.util.List; + +public class LightControllerUsageExample { + + public LightControllerUsageExample() { + BridgeIpDiscovery bridgeIpDiscovery = ServiceAccessor.accessService(BridgeIpDiscovery.class); + BridgeCredentialsDiscovery bridgeCredentialsDiscovery = ServiceAccessor.accessService(BridgeCredentialsDiscovery.class); + HueBridgeDiscovery hueBridgeDiscovery = ServiceAccessor.accessService(HueBridgeDiscovery.class); + HueLampDiscovery hueLampDiscovery = ServiceAccessor.accessService(HueLampDiscovery.class); + + + String bridgeIp = bridgeIpDiscovery.discoverBridgeIP(); + HueBridgeCredentials hueBridgeCredentials = getCredentials(bridgeIp); + HueBridge hueBridge = hueBridgeDiscovery.discoverHueBridge(hueBridgeCredentials); + + List allHueLampsFromBridge = hueBridge.getLamps(); + //or + List allHueLampsFromService = hueLampDiscovery.discoverAllLamps(hueBridge); + + hueBridge.getLampByName("Max Bett").ifPresent(hueLamp -> { + hueLamp.updateSync(LampUpdateType.ENABLE, true); //Set Enabled to true + hueLamp.updateSync(LampUpdateType.BRIGHTNESS, 50); //Set the Brightness to 50% + }); + + List allRooms = hueBridge.getRooms(); + + hueBridge.getHueRoomByName("Max Zimmer").ifPresent(hueRoom -> { + + }); + } + + private HueBridgeCredentials getCredentials(final String bridgeIp) { + BridgeCredentialsDiscovery bridgeCredentialsDiscovery = ServiceAccessor.accessService(BridgeCredentialsDiscovery.class); + + + + + + + HueBridgeCredentials hueBridgeCredentials = new HueBridgeCredentials( + "", // This is for testing hard coded + "", // This for testing hard coded + bridgeIp + ); + + HueBridgeCredentialsResponse other = bridgeCredentialsDiscovery.generateHueBridgeCredentials(bridgeIp); + if (other.getRespone().equals(HueBridgeCredentialsResponse.Respone.GENERATED)) { + return other.getHueBridgeCredentials(); + } + return hueBridgeCredentials; + } + +} diff --git a/example/src/main/java/de/maxizink/lightcontroller/discovery/BridgeDiscoveryExample.java b/example/src/main/java/de/maxizink/lightcontroller/discovery/BridgeDiscoveryExample.java new file mode 100644 index 0000000..275c280 --- /dev/null +++ b/example/src/main/java/de/maxizink/lightcontroller/discovery/BridgeDiscoveryExample.java @@ -0,0 +1,84 @@ +package de.maxizink.lightcontroller.discovery; + +import de.maxizink.lightcontroller.discovery.bridge.api.BridgeCredentialsDiscovery; +import de.maxizink.lightcontroller.discovery.bridge.api.BridgeIpDiscovery; +import de.maxizink.lightcontroller.discovery.bridge.api.HueBridge; +import de.maxizink.lightcontroller.discovery.bridge.api.HueBridgeDiscovery; +import de.maxizink.lightcontroller.discovery.bridge.models.BridgeInfo; +import de.maxizink.lightcontroller.discovery.bridge.models.HueBridgeCredentials; +import de.maxizink.lightcontroller.discovery.bridge.response.HueBridgeCredentialsResponse; +import de.maxizink.lightcontroller.injection.ServiceAccessor; +import lombok.SneakyThrows; +import lombok.extern.slf4j.Slf4j; + +import java.util.List; + +@Slf4j +public class BridgeDiscoveryExample { + + + public BridgeDiscoveryExample() { + //discoverBridgeIP(); //This shows all Methods to get the BridgeIP + //createHueBridgeCredentials(); //This should create an API Key + //getHueBridgeFromExistingKey(); //This should create a HueBridge Class + } + + /** + * This shows the Methods from the {@link BridgeIpDiscovery} to get the BridgeIP(s). + */ + @SneakyThrows + private void discoverBridgeIP() { + BridgeIpDiscovery bridgeIpDiscovery = ServiceAccessor.accessService(BridgeIpDiscovery.class); + + String bridgeIp = bridgeIpDiscovery.discoverBridgeIP(); //Sync + List bridgeIps = bridgeIpDiscovery.discoverAllBridgeIPs(); //Sync + + String asyncBridgeIp = bridgeIpDiscovery.discoveryBridgeIPAsync().get(); //Async + List asyncBridgeIps = bridgeIpDiscovery.discoverAllBridgeIPsAsync().get(); //Async + } + + /** + * This shows the Methods from the {@link BridgeCredentialsDiscovery} to generate{@link HueBridgeCredentials} for a BridgeIP. + */ + @SneakyThrows + private void createHueBridgeCredentials() { + BridgeIpDiscovery bridgeIpDiscovery = ServiceAccessor.accessService(BridgeIpDiscovery.class); + BridgeCredentialsDiscovery bridgeCredentialsDiscovery = ServiceAccessor.accessService(BridgeCredentialsDiscovery.class); + String bridgeIp = bridgeIpDiscovery.discoverBridgeIP(); + + HueBridgeCredentialsResponse keyGenerateResponse = bridgeCredentialsDiscovery.generateHueBridgeCredentials(bridgeIp); + if (keyGenerateResponse.getRespone().equals(HueBridgeCredentialsResponse.Respone.LINK_BUTTON_NOT_PRESSED)) { + //Handle here what should happen if the link button was not pressed + //INFO: The getCredentials() Method returns null and throws an error! + log.info("No Credentials generated! Press the Link Button"); + } + + if (keyGenerateResponse.getRespone().equals(HueBridgeCredentialsResponse.Respone.GENERATED)) { + HueBridgeCredentials hueBridgeCredentials = keyGenerateResponse.getHueBridgeCredentials(); + //Do Stuff here you want if the Credentials were generated! + log.info("Credentials were generated:"); + log.info(" - UserName -> " + hueBridgeCredentials.getUserName()); + log.info(" - ClientKey -> " + hueBridgeCredentials.getClientKey()); + } + } + + + @SneakyThrows + private void getHueBridgeFromExistingKey() { + BridgeIpDiscovery bridgeIpDiscovery = ServiceAccessor.accessService(BridgeIpDiscovery.class); + BridgeCredentialsDiscovery bridgeCredentialsDiscovery = ServiceAccessor.accessService(BridgeCredentialsDiscovery.class); + HueBridgeDiscovery hueBridgeDiscovery = ServiceAccessor.accessService(HueBridgeDiscovery.class); + + String bridgeIp = bridgeIpDiscovery.discoverBridgeIP(); + HueBridgeCredentialsResponse hueBridgeCredentials = bridgeCredentialsDiscovery.generateHueBridgeCredentials(bridgeIp); + if (hueBridgeCredentials.getRespone().equals(HueBridgeCredentialsResponse.Respone.LINK_BUTTON_NOT_PRESSED)) { + // Credentials could not created + return; + } + + HueBridge hueBridge = hueBridgeDiscovery.discoverHueBridge(hueBridgeCredentials.getHueBridgeCredentials()); + BridgeInfo bridgeInfo = hueBridge.getBridgeInfo(); + log.info("Bridge MAC-Adress: " + bridgeInfo.getMac()); + } + +} diff --git a/example/src/main/java/de/maxizink/lightcontroller/discovery/LampDiscoveryExample.java b/example/src/main/java/de/maxizink/lightcontroller/discovery/LampDiscoveryExample.java new file mode 100644 index 0000000..362f72f --- /dev/null +++ b/example/src/main/java/de/maxizink/lightcontroller/discovery/LampDiscoveryExample.java @@ -0,0 +1,80 @@ +package de.maxizink.lightcontroller.discovery; + +import de.maxizink.lightcontroller.discovery.bridge.api.HueBridge; +import de.maxizink.lightcontroller.discovery.bridge.api.HueBridgeDiscovery; +import de.maxizink.lightcontroller.discovery.bridge.models.HueBridgeCredentials; +import de.maxizink.lightcontroller.discovery.lamp.api.HueLamp; +import de.maxizink.lightcontroller.discovery.lamp.api.HueLampDiscovery; +import de.maxizink.lightcontroller.discovery.lamp.model.HueColor; +import de.maxizink.lightcontroller.discovery.lamp.model.LampUpdateType; +import de.maxizink.lightcontroller.injection.ServiceAccessor; +import lombok.SneakyThrows; + +import java.awt.*; +import java.util.List; +import java.util.Optional; + +public class LampDiscoveryExample { + + public LampDiscoveryExample() { + doLightInfo(); + } + + private void doLightInfo() { + HueBridgeDiscovery hueBridgeDiscovery = ServiceAccessor.accessService(HueBridgeDiscovery.class); + HueLampDiscovery hueLampDiscovery = ServiceAccessor.accessService(HueLampDiscovery.class); + + HueBridgeCredentials hueBridgeCredentials = new HueBridgeCredentials( + "name", + "key", + "" + ); + + HueBridge hueBridge = hueBridgeDiscovery.discoverHueBridge(hueBridgeCredentials); + //syncLamps(hueBridge); + //asyncLamps(hueBridge); + //updateLamp(hueBridge); + byName(hueBridge); + } + + private void byName(HueBridge hueBridge) { + Optional optionalHueLamp = hueBridge.getLampByName("My Lamp"); + optionalHueLamp.ifPresent(hueLamp -> { + hueLamp.getId(); + hueLamp.getName(); + }); + } + + private void updateLamp(final HueBridge hueBridge) { + HueLamp hueLamp = hueBridge.getLampByName("Max Bett").get(); + hueLamp.updateSync(LampUpdateType.COLOR, Color.ORANGE); + hueLamp.updateSync(LampUpdateType.BRIGHTNESS, 100); + hueLamp.updateSync(LampUpdateType.COLOR_TEMPERATURE, 500); + hueLamp.updateAsync(LampUpdateType.ENABLE, true).join(); + } + + private void syncLamps(final HueBridge hueBridge) { + Optional optionalHueLamp = hueBridge.getLampByName("My Lamp"); + List hueLamps = hueBridge.getLamps(); + + hueLamps.forEach(hueLamp -> { + //Sync Lamps + hueLamp.getId(); + hueLamp.getName(); + }); + } + + @SneakyThrows + private void asyncLamps(final HueBridge hueBridge) { + HueLampDiscovery hueLampDiscovery = ServiceAccessor.accessService(HueLampDiscovery.class); + List hueLamps = hueLampDiscovery.discoverAllLampsAsync(hueBridge).get(); + + hueLamps.forEach(hueLamp -> { + //Sync Lamps + hueLamp.getId(); + hueLamp.getName(); + }); + } + + +} diff --git a/example/src/main/java/de/maxizink/lightcontroller/discovery/RoomDiscoveryExample.java b/example/src/main/java/de/maxizink/lightcontroller/discovery/RoomDiscoveryExample.java new file mode 100644 index 0000000..1a34328 --- /dev/null +++ b/example/src/main/java/de/maxizink/lightcontroller/discovery/RoomDiscoveryExample.java @@ -0,0 +1,50 @@ +package de.maxizink.lightcontroller.discovery; + +import de.maxizink.lightcontroller.discovery.bridge.api.HueBridge; +import de.maxizink.lightcontroller.discovery.bridge.api.HueBridgeDiscovery; +import de.maxizink.lightcontroller.discovery.bridge.models.HueBridgeCredentials; +import de.maxizink.lightcontroller.discovery.lamp.api.HueLamp; +import de.maxizink.lightcontroller.discovery.lamp.model.LampUpdateType; +import de.maxizink.lightcontroller.discovery.room.api.HueRoom; +import de.maxizink.lightcontroller.discovery.room.api.HueRoomDiscovery; +import de.maxizink.lightcontroller.injection.ServiceAccessor; + +import java.awt.*; +import java.util.List; + +public class RoomDiscoveryExample { + + public RoomDiscoveryExample() { + discoverAllRooms(); + } + + private void discoverAllRooms() { + HueBridgeDiscovery hueBridgeDiscovery = ServiceAccessor.accessService(HueBridgeDiscovery.class); + HueRoomDiscovery hueRoomDiscovery = ServiceAccessor.accessService(HueRoomDiscovery.class); + + HueBridgeCredentials hueBridgeCredentials = new HueBridgeCredentials( + "", // This is for testing hard coded + "", // This for testing hard coded + "" + ); + + HueBridge hueBridge = hueBridgeDiscovery.discoverHueBridge(hueBridgeCredentials); + List hueRooms = hueRoomDiscovery.discoverAllRooms(hueBridge); //get all rooms by service + + //get room by + hueRoomDiscovery.getHueRoomByName(hueBridge, "Max Zimmer").ifPresent(hueRoom -> { + hueRoom.getName(); + hueRoom.getRoomArchetype(); + hueRoom.turnOff(); + + hueRoom.updateRoomLamps(LampUpdateType.COLOR, Color.GREEN); + hueRoom.updateRoomLamps(LampUpdateType.BRIGHTNESS, 10); + + for (HueLamp lamp : hueRoom.getLamps()) { + lamp.getName(); + lamp.getId(); + } + }); + } + +} diff --git a/example/src/test/java/de/maxizink/lightcontroller/SecondModuleTest.java b/example/src/test/java/de/maxizink/lightcontroller/SecondModuleTest.java new file mode 100644 index 0000000..c4a76ed --- /dev/null +++ b/example/src/test/java/de/maxizink/lightcontroller/SecondModuleTest.java @@ -0,0 +1,4 @@ +package de.maxizink.lightcontroller; + +public class SecondModuleTest { +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..e708b1c Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..2e6e589 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..4f906e0 --- /dev/null +++ b/gradlew @@ -0,0 +1,185 @@ +#!/usr/bin/env sh + +# +# Copyright 2015 the original author or authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=`expr $i + 1` + done + case $i in + 0) set -- ;; + 1) set -- "$args0" ;; + 2) set -- "$args0" "$args1" ;; + 3) set -- "$args0" "$args1" "$args2" ;; + 4) set -- "$args0" "$args1" "$args2" "$args3" ;; + 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=`save "$@"` + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..3e8833f --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,7 @@ +rootProject.name = "LightControllerAPI" + +include("LightControllerAPI-example") +project(":LightControllerAPI-example").projectDir = file("example") + +include("LightControllerAPI-api") +project(":LightControllerAPI-api").projectDir = file("api")