diff --git a/LICENSE.GPL3 b/LICENSE.GPL3 new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE.GPL3 @@ -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..10dfa82 --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +Repository for the nymea air conditioning experience plugin. + diff --git a/airconditioningjsonhandler.cpp b/airconditioningjsonhandler.cpp new file mode 100644 index 0000000..bd8572f --- /dev/null +++ b/airconditioningjsonhandler.cpp @@ -0,0 +1,248 @@ +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * +* +* Copyright 2013 - 2022, nymea GmbH +* Contact: contact@nymea.io +* +* This file is part of nymea. +* This project including source code and documentation is protected by +* copyright law, and remains the property of nymea GmbH. All rights, including +* reproduction, publication, editing and translation, are reserved. The use of +* this project is subject to the terms of a license agreement to be concluded +* with nymea GmbH in accordance with the terms of use of nymea GmbH, available +* under https://nymea.io/license +* +* GNU General Public License Usage +* Alternatively, this project may be redistributed and/or modified under the +* terms of the GNU General Public License as published by the Free Software +* Foundation, GNU version 3. This project 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 project. If not, see . +* +* For any further details and any questions please contact us under +* contact@nymea.io or see our FAQ/Licensing Information on +* https://nymea.io/license/faq +* +* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +#include "airconditioningjsonhandler.h" +#include "airconditioningmanager.h" + + +Q_DECLARE_LOGGING_CATEGORY(dcAdaptiveLighting) + +AirConditioningJsonHandler::AirConditioningJsonHandler(AirConditioningManager *manager, QObject *parent): + JsonHandler(parent), + m_manager(manager) +{ + + registerEnum(); + registerFlag(); + registerEnum(); + registerObject(); + registerObject(); + registerList(); + + QVariantMap params, returns; + QString description; + + params.clear(); returns.clear(); + description = "Get all Zones."; + params.insert("o:zoneId", enumValueName(Uuid)); + returns.insert("airConditioningError", enumRef()); + returns.insert("zones", objectRef()); + registerMethod("GetZones", description, params, returns, Types::PermissionScopeControlThings); + + params.clear(); returns.clear(); + description = "Create a zones."; + params.insert("name", enumValueName(String)); + params.insert("o:thermostats", QVariantList() << enumValueName(Uuid)); + params.insert("o:windowSensors", QVariantList() << enumValueName(Uuid)); + params.insert("o:indoorSensors", QVariantList() << enumValueName(Uuid)); + params.insert("o:outdoorSensors", QVariantList() << enumValueName(Uuid)); + returns.insert("airConditioningError", enumRef()); + returns.insert("o:zone", objectRef()); + registerMethod("AddZone", description, params, returns); + + params.clear(); returns.clear(); + description = "Remove a zone."; + params.insert("zoneId", enumValueName(Uuid)); + returns.insert("airConditioningError", enumRef()); + registerMethod("RemoveZone", description, params, returns); + + params.clear(); returns.clear(); + description = "Set zone name."; + params.insert("zoneId", enumValueName(Uuid)); + params.insert("name", enumValueName(String)); + returns.insert("airConditioningError", enumRef()); + registerMethod("SetZoneName", description, params, returns); + + params.clear(); returns.clear(); + description = "Set zone standby setpoint temperature."; + params.insert("zoneId", enumValueName(Uuid)); + params.insert("standbySetpoint", enumValueName(Double)); + returns.insert("airConditioningError", enumRef()); + registerMethod("SetZoneStandbySetpoint", description, params, returns); + + params.clear(); returns.clear(); + description = "Set zone setpoint override temperature. Parameter minutes gives the minutes until the setpoint should return to the standby/schedule."; + params.insert("zoneId", enumValueName(Uuid)); + params.insert("setpointOverride", enumValueName(Double)); + params.insert("mode", enumRef()); + params.insert("o:minutes", enumValueName(Int)); + returns.insert("airConditioningError", enumRef()); + registerMethod("SetZoneSetpointOverride", description, params, returns); + + params.clear(); returns.clear(); + description = "Set the time schedule for a zone."; + params.insert("zoneId", enumValueName(Uuid)); + params.insert("weekSchedule", objectRef()); + returns.insert("airConditioningError", enumRef()); + registerMethod("SetZoneWeekSchedule", description, params, returns); + + params.clear(); returns.clear(); + description = "Set Zone things"; + params.insert("zoneId", enumValueName(Uuid)); + params.insert("thermostats", QVariantList() << enumValueName(Uuid)); + params.insert("windowSensors", QVariantList() << enumValueName(Uuid)); + params.insert("indoorSensors", QVariantList() << enumValueName(Uuid)); + params.insert("outdoorSensors", QVariantList() << enumValueName(Uuid)); + returns.insert("airConditioningError", enumRef()); + registerMethod("SetZoneThings", description, params, returns); + + params.clear(); + description = "Emitted whenever a zone is added"; + params.insert("zone", objectRef()); + registerNotification("ZoneAdded", description, params); + + params.clear(); + description = "Emitted whenever a zone is removed"; + params.insert("zoneId", enumValueName(Uuid)); + registerNotification("ZoneRemoved", description, params); + + params.clear(); + description = "Emitted whenever a zone changes"; + params.insert("zone", objectRef()); + registerNotification("ZoneChanged", description, params); + + connect(manager, &AirConditioningManager::zoneAdded, this, [=](const ZoneInfo &zone){ + emit ZoneAdded({{"zone", pack(zone)}}); + }); + connect(manager, &AirConditioningManager::zoneRemoved, this, [=](const QUuid &zoneId){ + emit ZoneRemoved({{"zoneId", zoneId}}); + }); + connect(manager, &AirConditioningManager::zoneChanged, this, [=](const ZoneInfo &zone){ + emit ZoneChanged({{"zone", pack(zone)}}); + }); +} + +QString AirConditioningJsonHandler::name() const +{ + return "AirConditioning"; +} + +JsonReply *AirConditioningJsonHandler::GetZones(const QVariantMap ¶ms) +{ + ZoneInfos zones; + if (params.contains("zoneId")) { + QUuid zoneId = ThingId(params.value("zoneId").toUuid()); + zones = ZoneInfos({m_manager->zone(zoneId)}); + } else { + zones = m_manager->zones(); + } + return createReply({ + {"airConditioningError", enumValueName(AirConditioningManager::AirConditioningErrorNoError)}, + {"zones", pack(zones)} + }); +} + +JsonReply *AirConditioningJsonHandler::AddZone(const QVariantMap ¶ms) +{ + QList thermostats, windowSensors, indoorSensors, outdoorSensors; + foreach (const QVariant &id, params.value("thermostats").toList()) { + thermostats.append(id.toUuid()); + } + foreach (const QVariant &id, params.value("windowSensors").toList()) { + windowSensors.append(id.toUuid()); + } + foreach (const QVariant &id, params.value("indoorSensors").toList()) { + indoorSensors.append(id.toUuid()); + } + foreach (const QVariant &id, params.value("outdoorSensors").toList()) { + outdoorSensors.append(id.toUuid()); + } + QPair status = m_manager->addZone(params.value("name").toString(), thermostats, windowSensors, indoorSensors, outdoorSensors); + QVariantMap ret = { + {"airConditioningError", enumValueName(status.first)} + }; + if (status.first == AirConditioningManager::AirConditioningErrorNoError) { + ret.insert("zone", pack(status.second)); + } + return createReply(ret); +} + +JsonReply *AirConditioningJsonHandler::RemoveZone(const QVariantMap ¶ms) +{ + AirConditioningManager::AirConditioningError status = m_manager->removeZone(params.value("zoneId").toUuid()); + return createReply({{"airConditioningError", enumValueName(status)}}); +} + +JsonReply *AirConditioningJsonHandler::SetZoneName(const QVariantMap ¶ms) +{ + AirConditioningManager::AirConditioningError status = m_manager->setZoneName(params.value("zoneId").toUuid(), params.value("name").toString()); + return createReply({ + {"airConditioningError", enumValueName(status)} + }); +} + +JsonReply *AirConditioningJsonHandler::SetZoneStandbySetpoint(const QVariantMap ¶ms) +{ + QUuid zoneId = params.value("zoneId").toUuid(); + double standbySetpoint = params.value("standbySetpoint").toDouble(); + + AirConditioningManager::AirConditioningError status = m_manager->setZoneStandbySetpoint(zoneId, standbySetpoint); + return createReply({{"airConditioningError", enumValueName(status)}}); +} + +JsonReply *AirConditioningJsonHandler::SetZoneSetpointOverride(const QVariantMap ¶ms) +{ + QUuid zoneId = params.value("zoneId").toUuid(); + double standbySetpoint = params.value("setpointOverride").toDouble(); + QMetaEnum modeEnum = QMetaEnum::fromType(); + ZoneInfo::SetpointOverrideMode mode = static_cast(modeEnum.keyToValue(params.value("mode").toByteArray())); + uint minutes = params.value("minutes", 0).toUInt(); + + AirConditioningManager::AirConditioningError status = m_manager->setZoneSetpointOverride(zoneId, standbySetpoint, mode, minutes); + return createReply({{"airConditioningError", enumValueName(status)}}); +} + +JsonReply *AirConditioningJsonHandler::SetZoneWeekSchedule(const QVariantMap ¶ms) +{ + TemperatureWeekSchedule weekSchedule = unpack(params.value("weekSchedule")); + QUuid zoneId = params.value("zoneId").toUuid(); + AirConditioningManager::AirConditioningError status = m_manager->setZoneWeekSchedules(zoneId, weekSchedule); + return createReply({{"airConditioningError", enumValueName(status)}}); +} + +JsonReply *AirConditioningJsonHandler::SetZoneThings(const QVariantMap ¶ms) +{ + QUuid zoneId = params.value("zoneId").toUuid(); + QList thermostats, windowSensors, indoorSensors, outdoorSensors; + foreach (const QVariant &variant, params.value("thermostats").toList()) { + thermostats.append(ThingId(variant.toUuid())); + } + foreach (const QVariant &variant, params.value("windowSensors").toList()) { + windowSensors.append(ThingId(variant.toUuid())); + } + foreach (const QVariant &variant, params.value("indoorSensors").toList()) { + indoorSensors.append(ThingId(variant.toUuid())); + } + foreach (const QVariant &variant, params.value("outdoorSensors").toList()) { + outdoorSensors.append(ThingId(variant.toUuid())); + } + AirConditioningManager::AirConditioningError status = m_manager->setZoneThings(zoneId, thermostats, windowSensors, indoorSensors, outdoorSensors); + return createReply({{"airConditioningError", enumValueName(status)}}); +} diff --git a/airconditioningjsonhandler.h b/airconditioningjsonhandler.h new file mode 100644 index 0000000..eee338f --- /dev/null +++ b/airconditioningjsonhandler.h @@ -0,0 +1,66 @@ +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * +* +* Copyright 2013 - 2022, nymea GmbH +* Contact: contact@nymea.io +* +* This file is part of nymea. +* This project including source code and documentation is protected by +* copyright law, and remains the property of nymea GmbH. All rights, including +* reproduction, publication, editing and translation, are reserved. The use of +* this project is subject to the terms of a license agreement to be concluded +* with nymea GmbH in accordance with the terms of use of nymea GmbH, available +* under https://nymea.io/license +* +* GNU General Public License Usage +* Alternatively, this project may be redistributed and/or modified under the +* terms of the GNU General Public License as published by the Free Software +* Foundation, GNU version 3. This project 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 project. If not, see . +* +* For any further details and any questions please contact us under +* contact@nymea.io or see our FAQ/Licensing Information on +* https://nymea.io/license/faq +* +* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +#ifndef AIRCONDITIONINGJSONHANDLER_H +#define AIRCONDITIONINGJSONHANDLER_H + +#include + +#include "jsonrpc/jsonhandler.h" + +class AirConditioningManager; + +class AirConditioningJsonHandler : public JsonHandler +{ + Q_OBJECT +public: + explicit AirConditioningJsonHandler(AirConditioningManager *manager, QObject *parent = nullptr); + + QString name() const override; + + Q_INVOKABLE JsonReply *GetZones(const QVariantMap ¶ms); + Q_INVOKABLE JsonReply *AddZone(const QVariantMap ¶ms); + Q_INVOKABLE JsonReply *RemoveZone(const QVariantMap ¶ms); + Q_INVOKABLE JsonReply *SetZoneName(const QVariantMap ¶ms); + Q_INVOKABLE JsonReply *SetZoneStandbySetpoint(const QVariantMap ¶ms); + Q_INVOKABLE JsonReply *SetZoneSetpointOverride(const QVariantMap ¶ms); + Q_INVOKABLE JsonReply* SetZoneWeekSchedule(const QVariantMap ¶ms); + Q_INVOKABLE JsonReply *SetZoneThings(const QVariantMap ¶ms); + +signals: + void ZoneAdded(const QVariantMap ¶ms); + void ZoneRemoved(const QVariantMap ¶ms); + void ZoneChanged(const QVariantMap ¶ms); + +private: + AirConditioningManager *m_manager = nullptr; +}; + +#endif // AIRCONDITIONINGJSONHANDLER_H diff --git a/airconditioningmanager.cpp b/airconditioningmanager.cpp new file mode 100644 index 0000000..c3de964 --- /dev/null +++ b/airconditioningmanager.cpp @@ -0,0 +1,571 @@ +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * +* +* Copyright 2013 - 2022, nymea GmbH +* Contact: contact@nymea.io +* +* This file is part of nymea. +* This project including source code and documentation is protected by +* copyright law, and remains the property of nymea GmbH. All rights, including +* reproduction, publication, editing and translation, are reserved. The use of +* this project is subject to the terms of a license agreement to be concluded +* with nymea GmbH in accordance with the terms of use of nymea GmbH, available +* under https://nymea.io/license +* +* GNU General Public License Usage +* Alternatively, this project may be redistributed and/or modified under the +* terms of the GNU General Public License as published by the Free Software +* Foundation, GNU version 3. This project 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 project. If not, see . +* +* For any further details and any questions please contact us under +* contact@nymea.io or see our FAQ/Licensing Information on +* https://nymea.io/license/faq +* +* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +#include "airconditioningmanager.h" +#include "zoneinfo.h" + +#include + +#include +#include + +Q_DECLARE_LOGGING_CATEGORY(dcAirConditioning) + +AirConditioningManager::AirConditioningManager(ThingManager *thingManager, QObject *parent): + QObject(parent), + m_thingManager(thingManager) +{ + qCDebug(dcAirConditioning()) << "Loading air conditioning experience..."; + connect(m_thingManager, &ThingManager::thingAdded, this, &AirConditioningManager::onThingAdded); + connect(m_thingManager, &ThingManager::thingRemoved, this, &AirConditioningManager::onThingRemoved); + connect(m_thingManager, &ThingManager::thingStateChanged, this, &AirConditioningManager::onThingStateChaged); + connect(m_thingManager, &ThingManager::actionExecuted, this, &AirConditioningManager::onActionExecuted); + + foreach (Thing *thing, m_thingManager->configuredThings()) { + if (thing->thingClass().interfaces().contains("thermostat")) { + m_thermostats.insert(thing->id(), new Thermostat(m_thingManager, thing, this)); + } + } + + loadZones(); + + m_updateTimer = new QTimer(this); + m_updateTimer->start(1000); + connect(m_updateTimer, &QTimer::timeout, this, [=](){ + if (m_lastUpdateTime.time().minute() != QDateTime::currentDateTime().time().minute()) { + m_lastUpdateTime = QDateTime::currentDateTime(); + update(); + } + }); +} + +ZoneInfos AirConditioningManager::zones() const +{ + return m_zones.values(); +} + +ZoneInfo AirConditioningManager::zone(const ThingId &thermostatId) +{ + return m_zones.value(thermostatId); +} + +QPair AirConditioningManager::addZone(const QString &name, const QList &thermostats, const QList windowSensors, const QList indoorSensors, const QList outdoorSensors) +{ + ZoneInfo zone(QUuid::createUuid()); + zone.setName(name); + zone.setWeekSchedule(TemperatureWeekSchedule::create()); + AirConditioningError status = verifyThingIds(thermostats, windowSensors, indoorSensors, outdoorSensors); + if (status != AirConditioningErrorNoError) { + qCWarning(dcAirConditioning()) << "Invalid thing id" << status << "in" << thermostats; + return qMakePair(status, ZoneInfo()); + } + + zone.setThermostats(thermostats); + zone.setWindowSensors(windowSensors); + zone.setIndoorSensors(indoorSensors); + zone.setOutdoorSensors(outdoorSensors); + + m_zones.insert(zone.id(), zone); + saveZones(); + + emit zoneAdded(zone); + return qMakePair(AirConditioningErrorNoError, zone); +} + +AirConditioningManager::AirConditioningError AirConditioningManager::removeZone(const QUuid &zoneId) +{ + if (!m_zones.contains(zoneId)) { + return AirConditioningErrorZoneNotFound; + } + m_zones.remove(zoneId); + saveZones(); + + emit zoneRemoved(zoneId); + return AirConditioningErrorNoError; +} + +AirConditioningManager::AirConditioningError AirConditioningManager::setZoneName(const QUuid &zoneId, const QString &name) +{ + if (!m_zones.contains(zoneId)) { + return AirConditioningErrorZoneNotFound; + } + m_zones[zoneId].setName(name); + saveZones(); + + emit zoneChanged(m_zones.value(zoneId)); + return AirConditioningErrorNoError; +} + +AirConditioningManager::AirConditioningError AirConditioningManager::setZoneStandbySetpoint(const QUuid &zoneId, double standbySetpoint) +{ + if (!m_zones.contains(zoneId)) { + return AirConditioningErrorZoneNotFound; + } + m_zones[zoneId].setStandbySetpoint(standbySetpoint); + + saveZones(); + + emit zoneChanged(m_zones.value(zoneId)); + + update(); + + return AirConditioningErrorNoError; +} + +AirConditioningManager::AirConditioningError AirConditioningManager::setZoneWeekSchedules(const QUuid &zoneId, const TemperatureWeekSchedule &weekSchedule) +{ + if (!m_zones.contains(zoneId)) { + return AirConditioningErrorZoneNotFound; + } + + if (weekSchedule.count() != 7) { + qCWarning(dcAirConditioning()) << "There must be exactly 7 schedules in a week schedule:" << weekSchedule; + return AirConditioningErrorInvalidTimeSpec; + } + for (int day = 0; day < 7; day++) { + TemperatureDaySchedule daySchedule = weekSchedule.at(day); + for (int i = 0; i < daySchedule.count(); i++) { + TemperatureSchedule schedule = daySchedule.at(i); + if (schedule.startTime() >= schedule.endTime()) { + qCWarning(dcAirConditioning()) << "Invalid time spec. startTime mus be earlier than endTime:" << schedule; + return AirConditioningErrorInvalidTimeSpec; + } + for (int j = i+1; j < daySchedule.count(); j++) { + TemperatureSchedule other = daySchedule.at(j); + if (other.startTime() < schedule.startTime() && other.endTime() > schedule.startTime()) { + qCWarning(dcAirConditioning()) << "Invalid time spec. Overlapping schedules:\n" << schedule << "\n" << other; + return AirConditioningErrorInvalidTimeSpec; + } + if (other.startTime() < schedule.endTime() && other.endTime() > schedule.startTime()) { + qCWarning(dcAirConditioning()) << "Invalid time spec. Overlapping schedules:\n" << schedule << "\n" << other; + return AirConditioningErrorInvalidTimeSpec; + } + } + } + } + + m_zones[zoneId].setWeekSchedule(weekSchedule); + saveZones(); + emit zoneChanged(m_zones.value(zoneId)); + qCInfo(dcAirConditioning()) << "Temperature schedule saved:" << weekSchedule; + update(); + return AirConditioningErrorNoError; +} + +AirConditioningManager::AirConditioningError AirConditioningManager::setZoneThings(const QUuid &zoneId, const QList &thermostats, const QList &windowSensors, const QList &indoorSensors, const QList &outdoorSensors) +{ + if (!m_zones.contains(zoneId)) { + return AirConditioningErrorZoneNotFound; + } + AirConditioningError status = verifyThingIds(thermostats, windowSensors, indoorSensors, outdoorSensors); + if (status != AirConditioningErrorNoError) { + return status; + } + m_zones[zoneId].setThermostats(thermostats); + m_zones[zoneId].setWindowSensors(windowSensors); + m_zones[zoneId].setIndoorSensors(indoorSensors); + m_zones[zoneId].setOutdoorSensors(outdoorSensors); + saveZones(); + qCDebug(dcAirConditioning()) << "Zone things set. Thermostats:" << thermostats << "Window sensors:" << windowSensors << "indoor sensors:" << indoorSensors << "outdoor sensors:" << outdoorSensors; + emit zoneChanged(m_zones.value(zoneId)); + updateZone(zoneId); + return AirConditioningErrorNoError; +} + +AirConditioningManager::AirConditioningError AirConditioningManager::setZoneSetpointOverride(const QUuid &zoneId, double setpoint, ZoneInfo::SetpointOverrideMode mode, uint minutes) +{ + if (!m_zones.contains(zoneId)) { + return AirConditioningErrorZoneNotFound; + } + m_zones[zoneId].setSetpointOverride(setpoint, mode, QDateTime::currentDateTime().addMSecs(minutes * 60000)); + m_eventualOverrideCache[zoneId] = (m_zones[zoneId].zoneStatus() | ZoneInfo::ZoneStatusFlagSetpointOverrideActive); + qCDebug(dcAirConditioning()) << "Memorizing zone status:" << m_eventualOverrideCache.value(zoneId); + saveZones(); + emit zoneChanged(m_zones.value(zoneId)); + updateZone(zoneId); + return AirConditioningErrorNoError; +} + +void AirConditioningManager::onThingAdded(Thing *thing) +{ + if (thing->thingClass().interfaces().contains("thermostat")) { + qCInfo(dcAirConditioning()) << "Thermostat added:" << thing; + m_thermostats.insert(thing->id(), new Thermostat(m_thingManager, thing, this)); + } +} + +void AirConditioningManager::onThingRemoved(const ThingId &thingId) +{ + foreach (const ZoneInfo &zone, m_zones) { + QList thermostats = m_zones.value(zone.id()).thermostats(); + QList windowSensors = m_zones.value(zone.id()).windowSensors(); + QList indoorSensors = m_zones.value(zone.id()).indoorSensors(); + QList outdoorSensors = m_zones.value(zone.id()).outdoorSensors(); + bool changed = false; + if (thermostats.contains(thingId)) { + thermostats.removeAll(thingId); + changed = true; + } + if (windowSensors.contains(thingId)) { + windowSensors.removeAll(thingId); + changed = true; + } + if (indoorSensors.contains(thingId)) { + indoorSensors.removeAll(thingId); + changed = true; + } + if (outdoorSensors.contains(thingId)) { + outdoorSensors.removeAll(thingId); + changed = true; + } + if (changed) { + setZoneThings(zone.id(), thermostats, windowSensors, indoorSensors, outdoorSensors); + } + } +} + +void AirConditioningManager::onThingStateChaged(Thing *thing, const StateTypeId &stateTypeId, const QVariant &value, const QVariant &minValue, const QVariant &maxValue) +{ + Q_UNUSED(stateTypeId) + Q_UNUSED(value) + Q_UNUSED(minValue) + Q_UNUSED(maxValue) + + // We'll only want to immediately react on window open/close changes. Anything else is good enough once per minute + if (!thing->thingClass().interfaces().contains("closablesensor")) { + return; + } + + + foreach (const ZoneInfo &zone, m_zones) { + if (zone.windowSensors().contains(thing->id())) { + qCDebug(dcAirConditioning()) << "Window sensor in zone" << zone.name() << "changed"; + updateZone(zone.id()); + } + } +} + +void AirConditioningManager::onActionExecuted(const Action &action, Thing::ThingError status) +{ + if (action.triggeredBy() == Action::TriggeredByUser) { + Thing *thing = m_thingManager->findConfiguredThing(action.thingId()); + if (thing && thing->thingClass().interfaces().contains("thermostat")) { + if (thing->thingClass().actionTypes().findById(action.actionTypeId()).name() == "targetTemperature") { + foreach (const ZoneInfo &zone, m_zones) { + if (zone.thermostats().contains(thing->id())) { + qCInfo(dcAirConditioning()).nospace() << "Target temperature changed on thermostat in zone " << zone.name() << ". Activating setpoint override for" << action.paramValue(action.actionTypeId()).toDouble(); + m_zones[zone.id()].setSetpointOverride(action.paramValue(action.actionTypeId()).toDouble(), ZoneInfo::SetpointOverrideModeEventual); + } + } + } + } + } +} + +void AirConditioningManager::update() +{ + qCDebug(dcAirConditioning()) << "Upadting air conditioning"; + foreach (const QUuid &zoneId, m_zones.keys()) { + updateZone(zoneId); + } +} + +void AirConditioningManager::updateZone(const QUuid &zoneId) +{ + ZoneInfo zone = m_zones.value(zoneId); + qCDebug(dcAirConditioning()) << "*** Evaluating Zone:" << zone.name(); + + QDateTime now = QDateTime::currentDateTime(); + + bool timeScheduleActive = false; + bool overrideActive = false; + qCDebug(dcAirConditioning()) << "Standby temp:" << zone.standbySetpoint() << "Override:" << zone.setpointOverrideMode() << zone.setpointOverride() << zone.setpointOverrideEnd().toString(Qt::DefaultLocaleShortDate) << "Schedules:" << zone.weekSchedule(); + + if (zone.setpointOverrideMode() == ZoneInfo::SetpointOverrideModeUnlimited + || (zone.setpointOverrideMode() == ZoneInfo::SetpointOverrideModeTimed && zone.setpointOverrideEnd() > now) + || zone.setpointOverrideMode() == ZoneInfo::SetpointOverrideModeEventual) { + qCDebug(dcAirConditioning()) << "Setpoint override active until" << zone.setpointOverrideEnd(); + overrideActive = true; + } + + TemperatureDaySchedule daySchedule = zone.weekSchedule().at(now.date().dayOfWeek() - 1); + double timeScheduleTemp; + foreach (const TemperatureSchedule &schedule, daySchedule) { + if (schedule.startTime() < now.time() && schedule.endTime() > now.time()) { + qCDebug(dcAirConditioning()) << "Schedule is active:" << schedule; + timeScheduleTemp = schedule.temperature(); + timeScheduleActive = true; + break; + } + } + + // Checking window open + bool windowOpen = false; + foreach (const ThingId &thingId, zone.windowSensors()) { + Thing *thing = m_thingManager->findConfiguredThing(thingId); + if (!thing) { + qCWarning(dcAirConditioning()) << "Thing" << thingId << "seems to have been removed from the system!"; + continue; + } + if (!thing->stateValue("closed").toBool()) { + qCInfo(dcAirConditioning()) << "Window open."; + windowOpen = true; + break; + } + } + + + // *********** + + double targetTemp = zone.standbySetpoint(); + if (overrideActive) { + targetTemp = zone.setpointOverride(); + } else if (timeScheduleActive) { + targetTemp = timeScheduleTemp; + } + + qCDebug(dcAirConditioning()) << "Window open" << windowOpen << "Override active:" << overrideActive << "Time schedule active:" << timeScheduleActive << "target:" << targetTemp; + + bool highHumidity = false; + bool badAir = false; + foreach (const ThingId &thingId, zone.thermostats()) { + Thermostat *thermostat = m_thermostats.value(thingId); + if (thermostat) { + qCDebug(dcAirConditioning()) << "Setting window open" << windowOpen << " and target temp" << targetTemp; + thermostat->setWindowOpen(windowOpen); + thermostat->setTargetTemperature(targetTemp); + } + } + + foreach (const ThingId &thingId, zone.indoorSensors()) { + Thing *thing = m_thingManager->findConfiguredThing(thingId); + + if (thing->thingClass().interfaces().contains("humiditysensor")) { + if (thing->stateValue("humidity").toDouble() >= 60) { // > 60 over longer periods of time may cause mould + highHumidity = true; + } + } + + if (thing->thingClass().interfaces().contains("vocsensor")) { + if (thing->stateValue("voc").toDouble() >= 660) { // Moderate as of IAQ + badAir = true; + } + } + + if (thing->thingClass().interfaces().contains("pm25sensor")) { + if (thing->stateValue("pm25").toDouble() >= 25) { // Moderate as of CAQI + badAir = true; + } + } + + } + + ZoneInfo::ZoneStatus newStatus = ZoneInfo::ZoneStatusFlagNone; + newStatus.setFlag(ZoneInfo::ZoneStatusFlagWindowOpen, windowOpen); + newStatus.setFlag(ZoneInfo::ZoneStatusFlagSetpointOverrideActive, overrideActive); + newStatus.setFlag(ZoneInfo::ZoneStatusFlagTimeScheduleActive, timeScheduleActive); + newStatus.setFlag(ZoneInfo::ZoneStatusFlagHighHumidity, highHumidity); + newStatus.setFlag(ZoneInfo::ZoneStatusFlagBadAir, badAir); + + if (zone.setpointOverrideMode() == ZoneInfo::SetpointOverrideModeEventual && + newStatus != m_eventualOverrideCache.value(zone.id())) { + qCDebug(dcAirConditioning()) << "Zone status changed:" << m_eventualOverrideCache.value(zone.id()) << "->" << newStatus << "Resetting eventual override"; + m_zones[zone.id()].setSetpointOverride(zone.setpointOverride(), ZoneInfo::SetpointOverrideModeNone); + updateZone(zone.id()); + return; + + } + + if (targetTemp != zone.currentSetpoint() || newStatus != zone.zoneStatus()) { + qCDebug(dcAirConditioning()) << "Modifying Zone: setpoint:" << targetTemp << "status:" << newStatus; + m_zones[zone.id()].setCurrentSetpoint(targetTemp); + m_zones[zone.id()].setZoneStatus(newStatus); + emit zoneChanged(m_zones.value(zone.id())); + } +} + +void AirConditioningManager::loadZones() +{ + qCDebug(dcAirConditioning()) << "Loading zones"; + QSettings settings(NymeaSettings::settingsPath() + "/airconditioning.conf", QSettings::IniFormat); + settings.beginGroup("zones"); + qCDebug(dcAirConditioning()) << "child groups of zones" << settings.childKeys() << settings.childGroups(); + foreach (const QString &key, settings.childGroups()) { + settings.beginGroup(key); + qCDebug(dcAirConditioning()) << "Loading zone" << key; + QUuid zoneId(key); + ZoneInfo zone(zoneId); + zone.setName(settings.value("name").toString()); + QMetaEnum modeEnum = QMetaEnum::fromType(); + ZoneInfo::SetpointOverrideMode mode = static_cast(modeEnum.keyToValue(settings.value("setpointOverrideMode", "SetpointOverrideModeNone").toByteArray())); + zone.setSetpointOverride(settings.value("setpointOverride").toDouble(), mode, settings.value("setpointOverrideEnd").toDateTime()); + zone.setStandbySetpoint(settings.value("standbySetpoint").toDouble()); + settings.beginGroup("weekSchedule"); + TemperatureWeekSchedule weekSchedule; + for (int day = 0; day < 7; day++) { + TemperatureDaySchedule daySchedule; + settings.beginGroup(QString::number(day)); + foreach (const QString &childGroup, settings.childGroups()) { + settings.beginGroup(childGroup); + QTime startTime = settings.value("startTime").toTime(); + QTime endTime = settings.value("endTime").toTime(); + double temperature = settings.value("temperature").toDouble(); + TemperatureSchedule schedule(startTime, endTime, temperature); + daySchedule.append(schedule); + settings.endGroup(); // schedule + } + weekSchedule.append(daySchedule); + settings.endGroup(); // daySchedule + } + settings.endGroup(); // weekSchedule + zone.setWeekSchedule(weekSchedule); + + qCDebug(dcAirConditioning()) << "Loading thermostats" << settings.value("thermostats").toStringList() << settings.value("thermostats").toList(); + QList thermostats, windowSensors, indoorSensors, outdoorSensors; + foreach (const QString &thingId, settings.value("thermostats").toStringList()) { + thermostats.append(ThingId(thingId)); + } + zone.setThermostats(thermostats); + foreach (const QString &thingId, settings.value("windowSensors").toStringList()) { + windowSensors.append(ThingId(thingId)); + } + zone.setWindowSensors(windowSensors); + foreach (const QString &thingId, settings.value("indoorSensors").toStringList()) { + indoorSensors.append(ThingId(thingId)); + } + zone.setIndoorSensors(indoorSensors); + foreach (const QString &thingId, settings.value("outdoorSensors").toStringList()) { + outdoorSensors.append(ThingId(thingId)); + } + zone.setOutdoorSensors(outdoorSensors); + + qCDebug(dcAirConditioning()) << "Zone Loaded:" << zone.thermostats(); + m_zones.insert(zoneId, zone); + settings.endGroup(); // zone + } + settings.endGroup(); // zones +} + +void AirConditioningManager::saveZones() +{ + qCDebug(dcAirConditioning()) << "Saving zones"; + QSettings settings(NymeaSettings::settingsPath() + "/airconditioning.conf", QSettings::IniFormat); + settings.beginGroup("zones"); + settings.clear(); + foreach (const ZoneInfo &zone, m_zones) { + settings.beginGroup(zone.id().toString()); + settings.setValue("name", zone.name()); + settings.setValue("standbySetpoint", zone.standbySetpoint()); + settings.setValue("setpointOverride", zone.setpointOverride()); + QMetaEnum modeEnum = QMetaEnum::fromType(); + settings.setValue("setpointOverrideMode", modeEnum.valueToKey(zone.setpointOverrideMode())); + settings.setValue("setpointOverrideEnd", zone.setpointOverrideEnd()); + + settings.beginGroup("weekSchedule"); + for (int day = 0; day < 7; day++) { + settings.beginGroup(QString::number(day)); + TemperatureDaySchedule daySchedule = zone.weekSchedule().at(day); + for (int i = 0; i < daySchedule.count(); i++) { + TemperatureSchedule schedule = daySchedule.at(i); + settings.beginGroup(QString::number(i)); + settings.setValue("startTime", schedule.startTime()); + settings.setValue("endTime", schedule.endTime()); + settings.setValue("temperature", schedule.temperature()); + settings.endGroup(); // schedule + } + settings.endGroup(); // daySchedule + } + settings.endGroup(); // weekSchedule + + QStringList thermostats, windowSensors, indoorSensors, outdoorSensors; + foreach (const ThingId &thingId, zone.thermostats()) { + thermostats.append(thingId.toString()); + } + settings.setValue("thermostats", thermostats); + foreach (const ThingId &thingId, zone.windowSensors()) { + windowSensors.append(thingId.toString()); + } + settings.setValue("windowSensors", windowSensors); + foreach (const ThingId &thingId, zone.indoorSensors()) { + indoorSensors.append(thingId.toString()); + } + settings.setValue("indoorSensors", indoorSensors); + foreach (const ThingId &thingId, zone.outdoorSensors()) { + outdoorSensors.append(thingId.toString()); + } + settings.setValue("outdoorSensors", outdoorSensors); + + settings.endGroup(); // zone + } + settings.endGroup(); + +} + +AirConditioningManager::AirConditioningError AirConditioningManager::verifyThingIds(const QList &thermostats, const QList &windowSensors, const QList &indoorSensors, const QList &outdoorSensors) +{ + foreach (const QUuid &thingId, thermostats) { + Thing *thing = m_thingManager->findConfiguredThing(thingId); + if (!thing) { + qCWarning(dcAirConditioning()) << "No thing with id" << thingId; + return AirConditioningErrorThingNotFound; + } + if (!thing->thingClass().interfaces().contains("thermostat")) { + qCWarning(dcAirConditioning()) << "Not a thermostat:" << thing->name(); + return AirConditioningErrorInvalidThingType; + } + } + foreach (const QUuid &thingId, windowSensors) { + Thing *thing = m_thingManager->findConfiguredThing(thingId); + if (!thing) { + qCWarning(dcAirConditioning()) << "No thing with id" << thingId; + return AirConditioningErrorThingNotFound; + } + if (!thing->thingClass().interfaces().contains("closablesensor")) { + qCWarning(dcAirConditioning()) << "Not a window sensor:" << thing->name(); + return AirConditioningErrorInvalidThingType; + } + } + foreach (const QUuid &thingId, indoorSensors + outdoorSensors) { + Thing *thing = m_thingManager->findConfiguredThing(thingId); + if (!thing) { + qCWarning(dcAirConditioning()) << "No thing with id" << thingId; + return AirConditioningErrorThingNotFound; + } + if (!thing->thingClass().interfaces().contains("temperaturesensor") + && !thing->thingClass().interfaces().contains("humiditysensor") + && !thing->thingClass().interfaces().contains("vocsensor") + && !thing->thingClass().interfaces().contains("pm25sensor")) { + qCWarning(dcAirConditioning()) << "Not a temperature, humidity, voc or pm25 sensor:" << thing->name(); + return AirConditioningErrorInvalidThingType; + } + } + return AirConditioningErrorNoError; +} + diff --git a/airconditioningmanager.h b/airconditioningmanager.h new file mode 100644 index 0000000..8e2c514 --- /dev/null +++ b/airconditioningmanager.h @@ -0,0 +1,104 @@ +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * +* +* Copyright 2013 - 2022, nymea GmbH +* Contact: contact@nymea.io +* +* This file is part of nymea. +* This project including source code and documentation is protected by +* copyright law, and remains the property of nymea GmbH. All rights, including +* reproduction, publication, editing and translation, are reserved. The use of +* this project is subject to the terms of a license agreement to be concluded +* with nymea GmbH in accordance with the terms of use of nymea GmbH, available +* under https://nymea.io/license +* +* GNU General Public License Usage +* Alternatively, this project may be redistributed and/or modified under the +* terms of the GNU General Public License as published by the Free Software +* Foundation, GNU version 3. This project 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 project. If not, see . +* +* For any further details and any questions please contact us under +* contact@nymea.io or see our FAQ/Licensing Information on +* https://nymea.io/license/faq +* +* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +#ifndef AIRCONDITIONINGMANAGER_H +#define AIRCONDITIONINGMANAGER_H + +#include +#include +#include + +#include + +#include "zoneinfo.h" +#include "thermostat.h" + +class AirConditioningManager : public QObject +{ + Q_OBJECT +public: + enum AirConditioningError { + AirConditioningErrorNoError, + AirConditioningErrorZoneNotFound, + AirConditioningErrorInvalidTimeSpec, + AirConditioningErrorThingNotFound, + AirConditioningErrorInvalidThingType + }; + Q_ENUM(AirConditioningError) + + explicit AirConditioningManager(ThingManager *thingManager, QObject *parent = nullptr); + + ZoneInfos zones() const; + ZoneInfo zone(const ThingId &thermostatId); + QPair addZone(const QString &name, const QList &thermostats, const QList windowSensors, const QList indoorSensors, const QList outdoorSensors); + AirConditioningError removeZone(const QUuid &zoneId); + + AirConditioningError setZoneName(const QUuid &zoneId, const QString &name); + AirConditioningError setZoneStandbySetpoint(const QUuid &zoneId, double standbySetpoint); + AirConditioningError setZoneSetpointOverride(const QUuid &zoneId, double setpoint, ZoneInfo::SetpointOverrideMode mode, uint minutes); + AirConditioningError setZoneWeekSchedules(const QUuid &zoneId, const TemperatureWeekSchedule &temperatureWeekSchedule); + + AirConditioningError setZoneThings(const QUuid &zoneId, const QList &thermostats, const QList &windowSensors, const QList &indoorSensors, const QList &outdoorSensors); +// AirConditioningError addThing(const QUuid &zoneId, const ThingId &thingId); +// AirConditioningError removeThing(const QUuid &zoneId, const ThingId &thingId); + + +signals: + void zoneAdded(const ZoneInfo &zone); + void zoneRemoved(const QUuid &zoneId); + void zoneChanged(const ZoneInfo &zoneInfo); + +private slots: + void onThingAdded(Thing *thing); + void onThingRemoved(const ThingId &thingId); + void onThingStateChaged(Thing *thing, const StateTypeId &stateTypeId, const QVariant &value, const QVariant &minValue, const QVariant &maxValue); + void onActionExecuted(const Action &action, Thing::ThingError status); + + void update(); + void updateZone(const QUuid &zoneId); + +private: + void loadZones(); + void saveZones(); + + AirConditioningError verifyThingIds(const QList &thermostats, const QList &windowSensors, const QList &indoorSensors, const QList &outdoorSensors); + +private: + ThingManager *m_thingManager = nullptr; + QTimer *m_updateTimer = nullptr; + + QHash m_thermostats; + QHash m_zones; + QHash m_eventualOverrideCache; + + QDateTime m_lastUpdateTime; +}; + +#endif // AIRCONDITIONINGMANAGER_H diff --git a/debian/changelog b/debian/changelog new file mode 100644 index 0000000..0494a8f --- /dev/null +++ b/debian/changelog @@ -0,0 +1,5 @@ +nymea-experience-plugin-airconditioning (0.1) xenial; urgency=medium + + + -- Jenkins Tue, 14 Dec 2021 14:04:04 +0100 + diff --git a/debian/compat b/debian/compat new file mode 100644 index 0000000..ec63514 --- /dev/null +++ b/debian/compat @@ -0,0 +1 @@ +9 diff --git a/debian/control b/debian/control new file mode 100644 index 0000000..2c26f4f --- /dev/null +++ b/debian/control @@ -0,0 +1,22 @@ +Source: nymea-experience-plugin-airconditioning +Section: utils +Priority: optional +Maintainer: Michael Zanetti +Standards-Version: 3.9.7 +Homepage: https://nymea.io +Build-Depends: debhelper (>= 9.0.0), + dpkg-dev (>= 1.16.1~), + libnymea-dev (>= 0.17), + nymea-dev-tools:native, + qt5-qmake, + qtbase5-dev, + +Package: nymea-experience-plugin-airconditioning +Section: libs +Architecture: any +Multi-Arch: same +Depends: ${shlibs:Depends}, + ${misc:Depends}, +Description: nymea experiece plugin for thermostat and air quality control + This nymea experience adds the support controlling heating/cooling devices + and monitoring air quality. diff --git a/debian/rules b/debian/rules new file mode 100755 index 0000000..f063fd2 --- /dev/null +++ b/debian/rules @@ -0,0 +1,27 @@ +#!/usr/bin/make -f +# -*- makefile -*- + +export DH_VERBOSE=1 +export QT_QPA_PLATFORM=minimal + +DEB_HOST_MULTIARCH ?= $(shell dpkg-architecture -qDEB_HOST_MULTIARCH) + +PREPROCESS_FILES := $(wildcard debian/*.in) + +$(PREPROCESS_FILES:.in=): %: %.in + sed 's,/@DEB_HOST_MULTIARCH@,$(DEB_HOST_MULTIARCH:%=/%),g' $< > $@ + +override_dh_install: $(PREPROCESS_FILES:.in=) + dh_install + +override_dh_auto_clean: + dh_auto_clean + rm -rf $(PREPROCESS_FILES:.in=) + +override_dh_auto_test: + +override_dh_install: $(PREPROCESS_FILES:.in=) + dh_install --fail-missing + +%: + dh $@ --buildsystem=qmake --parallel diff --git a/experiencepluginairconditioning.cpp b/experiencepluginairconditioning.cpp new file mode 100644 index 0000000..f9ce26e --- /dev/null +++ b/experiencepluginairconditioning.cpp @@ -0,0 +1,53 @@ +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * +* +* Copyright 2013 - 2022, nymea GmbH +* Contact: contact@nymea.io +* +* This file is part of nymea. +* This project including source code and documentation is protected by +* copyright law, and remains the property of nymea GmbH. All rights, including +* reproduction, publication, editing and translation, are reserved. The use of +* this project is subject to the terms of a license agreement to be concluded +* with nymea GmbH in accordance with the terms of use of nymea GmbH, available +* under https://nymea.io/license +* +* GNU General Public License Usage +* Alternatively, this project may be redistributed and/or modified under the +* terms of the GNU General Public License as published by the Free Software +* Foundation, GNU version 3. This project 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 project. If not, see . +* +* For any further details and any questions please contact us under +* contact@nymea.io or see our FAQ/Licensing Information on +* https://nymea.io/license/faq +* +* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +#include "experiencepluginairconditioning.h" + +#include "airconditioningmanager.h" +#include "airconditioningjsonhandler.h" + +#include +#include + +NYMEA_LOGGING_CATEGORY(dcAirConditioning, "AirConditioning") + +ExperiencePluginAirConditioning::ExperiencePluginAirConditioning() +{ + +} + +void ExperiencePluginAirConditioning::init() +{ + qCDebug(dcAirConditioning()) << "Initializing air conditioning experience"; + + m_manager = new AirConditioningManager(thingManager(), this); + jsonRpcServer()->registerExperienceHandler(new AirConditioningJsonHandler(m_manager, this), 1, 0); + +} diff --git a/experiencepluginairconditioning.h b/experiencepluginairconditioning.h new file mode 100644 index 0000000..8c3edc8 --- /dev/null +++ b/experiencepluginairconditioning.h @@ -0,0 +1,57 @@ +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * +* +* Copyright 2013 - 2022, nymea GmbH +* Contact: contact@nymea.io +* +* This file is part of nymea. +* This project including source code and documentation is protected by +* copyright law, and remains the property of nymea GmbH. All rights, including +* reproduction, publication, editing and translation, are reserved. The use of +* this project is subject to the terms of a license agreement to be concluded +* with nymea GmbH in accordance with the terms of use of nymea GmbH, available +* under https://nymea.io/license +* +* GNU General Public License Usage +* Alternatively, this project may be redistributed and/or modified under the +* terms of the GNU General Public License as published by the Free Software +* Foundation, GNU version 3. This project 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 project. If not, see . +* +* For any further details and any questions please contact us under +* contact@nymea.io or see our FAQ/Licensing Information on +* https://nymea.io/license/faq +* +* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +#ifndef EXPERIENCEPLUGINAIRCONDITIONING_H +#define EXPERIENCEPLUGINAIRCONDITIONING_H + +#include + +#include + +Q_DECLARE_LOGGING_CATEGORY(dcAirConditioning) + +class AirConditioningManager; + +class ExperiencePluginAirConditioning: public ExperiencePlugin +{ + Q_OBJECT + Q_PLUGIN_METADATA(IID "io.nymea.ExperiencePlugin") + Q_INTERFACES(ExperiencePlugin) + +public: + ExperiencePluginAirConditioning(); + void init() override; + +private: + + AirConditioningManager *m_manager = nullptr; +}; + +#endif // EXPERIENCEPLUGINAIRCONDITIONING_H diff --git a/nymea-experience-plugin-airconditioning.pro b/nymea-experience-plugin-airconditioning.pro new file mode 100644 index 0000000..e131c21 --- /dev/null +++ b/nymea-experience-plugin-airconditioning.pro @@ -0,0 +1,46 @@ +TEMPLATE = lib +TARGET = $$qtLibraryTarget(nymea_experiencepluginairconditioning) + +CONFIG += plugin link_pkgconfig c++11 +PKGCONFIG += nymea + +QT -= gui +QT += network sql + +include(../config.pri) + +HEADERS += experiencepluginairconditioning.h \ + airconditioningjsonhandler.h \ + airconditioningmanager.h \ + temperatureschedule.h \ + thermostat.h \ + zoneinfo.h + +SOURCES += experiencepluginairconditioning.cpp \ + airconditioningjsonhandler.cpp \ + airconditioningmanager.cpp \ + temperatureschedule.cpp \ + thermostat.cpp \ + zoneinfo.cpp + + +target.path = $$[QT_INSTALL_LIBS]/nymea/experiences/ +INSTALLS += target + +# Install translation files +TRANSLATIONS *= $$files($${_PRO_FILE_PWD_}/translations/*ts, true) +lupdate.depends = FORCE +lupdate.depends += qmake_all +lupdate.commands = lupdate -recursive -no-obsolete $${_PRO_FILE_PWD_}/experience.pro +QMAKE_EXTRA_TARGETS += lupdate + +# make lrelease to build .qm from .ts +lrelease.depends = FORCE +lrelease.commands += lrelease $$files($$_PRO_FILE_PWD_/translations/*.ts, true); +QMAKE_EXTRA_TARGETS += lrelease + +translations.depends += lrelease +translations.path = /usr/share/nymea/translations +translations.files = $$[QT_SOURCE_TREE]/translations/*.qm +INSTALLS += translations + diff --git a/temperatureschedule.cpp b/temperatureschedule.cpp new file mode 100644 index 0000000..7d3c029 --- /dev/null +++ b/temperatureschedule.cpp @@ -0,0 +1,139 @@ +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * +* +* Copyright 2013 - 2022, nymea GmbH +* Contact: contact@nymea.io +* +* This file is part of nymea. +* This project including source code and documentation is protected by +* copyright law, and remains the property of nymea GmbH. All rights, including +* reproduction, publication, editing and translation, are reserved. The use of +* this project is subject to the terms of a license agreement to be concluded +* with nymea GmbH in accordance with the terms of use of nymea GmbH, available +* under https://nymea.io/license +* +* GNU General Public License Usage +* Alternatively, this project may be redistributed and/or modified under the +* terms of the GNU General Public License as published by the Free Software +* Foundation, GNU version 3. This project 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 project. If not, see . +* +* For any further details and any questions please contact us under +* contact@nymea.io or see our FAQ/Licensing Information on +* https://nymea.io/license/faq +* +* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +#include "temperatureschedule.h" + +TemperatureSchedule::TemperatureSchedule() +{ + +} + +TemperatureSchedule::TemperatureSchedule(const QTime &startTime, const QTime &endTime, double temperature): + m_startTime(startTime), + m_endTime(endTime), + m_temperature(temperature) +{ + +} + +QTime TemperatureSchedule::startTime() const +{ + return m_startTime; +} + +void TemperatureSchedule::setStartTime(const QTime &startTime) +{ + m_startTime = startTime; +} + +QTime TemperatureSchedule::endTime() const +{ + return m_endTime; +} + +void TemperatureSchedule::setEndTime(const QTime &endTime) +{ + m_endTime = endTime; +} + +double TemperatureSchedule::temperature() const +{ + return m_temperature; +} + +void TemperatureSchedule::setTemperature(double temperature) +{ + m_temperature = temperature; +} + +TemperatureDaySchedule::TemperatureDaySchedule(const QList &other): + QList(other) +{ + +} + +QVariant TemperatureDaySchedule::get(int index) const +{ + return QVariant::fromValue(at(index)); +} + +void TemperatureDaySchedule::put(const QVariant &variant) +{ + append(variant.value()); +} + +TemperatureWeekSchedule TemperatureWeekSchedule::create() { + TemperatureWeekSchedule ret; + for (int day = 0; day < 7; day++) { + ret.append(TemperatureDaySchedule()); + } + return ret; +} + +QVariant TemperatureWeekSchedule::get(int index) const +{ + return QVariant::fromValue(at(index)); +} + +void TemperatureWeekSchedule::put(const QVariant &variant) +{ + append(variant.value()); +} + +QDebug operator<<(QDebug dbg, const TemperatureSchedule &schedule) +{ + QDebugStateSaver saver(dbg); + dbg.nospace().noquote() << schedule.startTime().toString("hh:mm") << " - " << schedule.endTime().toString("hh:mm") << ": " << schedule.temperature(); + return dbg; +} + +QDebug operator<<(QDebug dbg, const TemperatureDaySchedule &daySchedule) +{ + for (int i = 0; i < daySchedule.count(); i++) { + dbg << daySchedule.at(i); + if (i < daySchedule.count() - 1) { + QDebugStateSaver saver(dbg); + dbg.nospace() << ", "; + } + } + return dbg; +} + +QDebug operator<<(QDebug dbg, const TemperatureWeekSchedule &weekSchedule) +{ + QDebugStateSaver saver(dbg); + QStringList days = { "Mo", "Tu", "We", "Th", "Fr", "Sa", "Su" }; + dbg << "\n"; + for (int i = 0; i < qMin(weekSchedule.count(), 7); i++) { + dbg.nospace().noquote() << days.at(i) << ": " << weekSchedule.at(i) << "\n"; + } + return dbg; +} + diff --git a/temperatureschedule.h b/temperatureschedule.h new file mode 100644 index 0000000..9b8606c --- /dev/null +++ b/temperatureschedule.h @@ -0,0 +1,145 @@ +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * +* +* Copyright 2013 - 2022, nymea GmbH +* Contact: contact@nymea.io +* +* This file is part of nymea. +* This project including source code and documentation is protected by +* copyright law, and remains the property of nymea GmbH. All rights, including +* reproduction, publication, editing and translation, are reserved. The use of +* this project is subject to the terms of a license agreement to be concluded +* with nymea GmbH in accordance with the terms of use of nymea GmbH, available +* under https://nymea.io/license +* +* GNU General Public License Usage +* Alternatively, this project may be redistributed and/or modified under the +* terms of the GNU General Public License as published by the Free Software +* Foundation, GNU version 3. This project 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 project. If not, see . +* +* For any further details and any questions please contact us under +* contact@nymea.io or see our FAQ/Licensing Information on +* https://nymea.io/license/faq +* +* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +#ifndef TEMPERATURESCHEDULE_H +#define TEMPERATURESCHEDULE_H + +#include +#include +#include +#include + +class TemperatureSchedule +{ + Q_GADGET + + Q_PROPERTY(QTime startTime READ startTime WRITE setStartTime) + Q_PROPERTY(QTime endTime READ endTime WRITE setEndTime) + Q_PROPERTY(double temperature READ temperature WRITE setTemperature) + +public: + TemperatureSchedule(); + TemperatureSchedule(const QTime &startTime, const QTime &endTime, double temperature); + + QTime startTime() const; + void setStartTime(const QTime &startTime); + + QTime endTime() const; + void setEndTime(const QTime &endTime); + + double temperature() const; + void setTemperature(double temperature); + +private: + QTime m_startTime; + QTime m_endTime; + double m_temperature = 0; +}; +Q_DECLARE_METATYPE(TemperatureSchedule) + +class TemperatureDaySchedule: public QList +{ + Q_GADGET + Q_PROPERTY(int count READ count) +public: + TemperatureDaySchedule() = default; + TemperatureDaySchedule(const QList &other); + Q_INVOKABLE QVariant get(int index) const; + Q_INVOKABLE void put(const QVariant &variant); +}; +Q_DECLARE_METATYPE(QList) +Q_DECLARE_METATYPE(TemperatureDaySchedule) + +class TemperatureWeekSchedule: public QList +{ + Q_GADGET + Q_PROPERTY(int count READ count) +public: + static TemperatureWeekSchedule create(); + TemperatureWeekSchedule() = default; + Q_INVOKABLE QVariant get(int index) const; + Q_INVOKABLE void put(const QVariant &variant); +}; +Q_DECLARE_METATYPE(QList) +Q_DECLARE_METATYPE(TemperatureWeekSchedule) + +//class TemperatureWeekSchedules +//{ +// Q_GADGET +// Q_PROPERTY(TemperatureSchedules monday READ monday WRITE setMonday) +// Q_PROPERTY(TemperatureSchedules tuesday READ tuesday WRITE setTuesday) +// Q_PROPERTY(TemperatureSchedules wednesday READ wednesday WRITE setWednesday) +// Q_PROPERTY(TemperatureSchedules thursday READ thursday WRITE setThursday) +// Q_PROPERTY(TemperatureSchedules friday READ friday WRITE setFriday) +// Q_PROPERTY(TemperatureSchedules saturday READ saturday WRITE setSaturday) +// Q_PROPERTY(TemperatureSchedules sunday READ sunday WRITE setSunday) + +//public: +// TemperatureWeekSchedules() = default; + +// TemperatureSchedules monday() const { return m_monday; } +// void setMonday(const TemperatureSchedules &monday) { m_monday = monday; } + +// TemperatureSchedules tuesday() const { return m_tuesday; } +// void setTuesday(const TemperatureSchedules &tuesday) { m_tuesday = tuesday; } + +// TemperatureSchedules wednesday() const { return m_wednesday; } +// void setWednesday(const TemperatureSchedules &wednesday) { m_wednesday = wednesday; } + +// TemperatureSchedules thursday() const { return m_thursday; } +// void setThursday(const TemperatureSchedules &thursday) { m_thursday = thursday; } + +// TemperatureSchedules friday() const { return m_friday; } +// void setFriday(const TemperatureSchedules &friday) { m_friday = friday; } + +// TemperatureSchedules saturday() const { return m_saturday; } +// void setSaturday(const TemperatureSchedules &satuday) { m_saturday = satuday; } + +// TemperatureSchedules sunday() const { return m_sunday; } +// void setSunday(const TemperatureSchedules &sunday) { m_sunday = sunday; } + +//private: +// TemperatureSchedules m_monday; +// TemperatureSchedules m_tuesday; +// TemperatureSchedules m_wednesday; +// TemperatureSchedules m_thursday; +// TemperatureSchedules m_friday; +// TemperatureSchedules m_saturday; +// TemperatureSchedules m_sunday; + +//}; +//Q_DECLARE_METATYPE(TemperatureWeekSchedules) + + +QDebug operator<<(QDebug debug, const TemperatureSchedule &schedule); +QDebug operator<<(QDebug debug, const TemperatureDaySchedule &daySchedule); +QDebug operator<<(QDebug debug, const TemperatureWeekSchedule &weekSchedules); + +#endif // TEMPERATURESCHEDULE_H diff --git a/thermostat.cpp b/thermostat.cpp new file mode 100644 index 0000000..2456b0c --- /dev/null +++ b/thermostat.cpp @@ -0,0 +1,130 @@ +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * +* +* Copyright 2013 - 2022, nymea GmbH +* Contact: contact@nymea.io +* +* This file is part of nymea. +* This project including source code and documentation is protected by +* copyright law, and remains the property of nymea GmbH. All rights, including +* reproduction, publication, editing and translation, are reserved. The use of +* this project is subject to the terms of a license agreement to be concluded +* with nymea GmbH in accordance with the terms of use of nymea GmbH, available +* under https://nymea.io/license +* +* GNU General Public License Usage +* Alternatively, this project may be redistributed and/or modified under the +* terms of the GNU General Public License as published by the Free Software +* Foundation, GNU version 3. This project 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 project. If not, see . +* +* For any further details and any questions please contact us under +* contact@nymea.io or see our FAQ/Licensing Information on +* https://nymea.io/license/faq +* +* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +#include "thermostat.h" + +#include +Q_DECLARE_LOGGING_CATEGORY(dcAirConditioning) + +Thermostat::Thermostat(ThingManager *thingManager, Thing *thing, QObject *parent): + QObject(parent), + m_thingManager(thingManager), + m_thing(thing) +{ + m_cachedTargetTemperature = m_thing->stateValue("targetTemperature").toDouble(); +} + +Thing *Thermostat::thing() const +{ + return m_thing; +} + +void Thermostat::setTargetTemperature(double targetTemperature, bool force) +{ + qCDebug(dcAirConditioning()) << "setTargetTemp called. Window open:" << m_windowOpen << "force:" << force; + m_cachedTargetTemperature = targetTemperature; + if (m_windowOpen && !force) { + qCDebug(dcAirConditioning()) << "Not setting target temperature on" << m_thing->name() << "because a window is open"; + return; + } + + if (m_thing->stateValue("targetTemperature").toDouble() != targetTemperature) { + ActionType actionType = m_thing->thingClass().actionTypes().findByName("targetTemperature"); + Action action(actionType.id(), m_thing->id(), Action::TriggeredByRule); + action.setParams({Param(actionType.id(), targetTemperature)}); + qCDebug(dcAirConditioning()) << "Setting target temperature" << targetTemperature << "to" << m_thing->name() << "from" << m_thing->stateValue("targetTemperature").toDouble(); + ThingActionInfo *info = m_thingManager->executeAction(action); + connect(info, &ThingActionInfo::finished, this, [info, this](){ + if (info->status() != Thing::ThingErrorNoError) { + qCWarning(dcAirConditioning()) << "Unable to execute targetTemperature action on" << m_thing << info->status() << info->displayMessage(); + return; + } + qCDebug(dcAirConditioning()) << "Target temperature set successfully"; + }); + } +} + +void Thermostat::setWindowOpen(bool windowOpen) +{ + m_windowOpen = windowOpen; + + // First check if the device is capable of handling a window open locks + if (m_thing->hasState("windowOpen")) { + if (m_thing->stateValue("windowOpen").toBool() != windowOpen) { + ActionType actionType = m_thing->thingClass().actionTypes().findByName("windowOpen"); + Action action(actionType.id(), m_thing->id(), Action::TriggeredByRule); + action.setParams({Param(actionType.id(), windowOpen)}); + qCDebug(dcAirConditioning()) << "Setting window open" << windowOpen << "to" << m_thing->name(); + ThingActionInfo *info = m_thingManager->executeAction(action); + connect(info, &ThingActionInfo::finished, this, [info, this](){ + if (info->status() != Thing::ThingErrorNoError) { + qCWarning(dcAirConditioning()) << "Unable to execute window Open action on" << m_thing << info->status() << info->displayMessage(); + return; + } + }); + } + return; + } + + // Otherwise see if it can be turned off while the window is open + if (m_thing->hasState("power")) { + if (m_thing->stateValue("power").toBool() == windowOpen) { + ActionType actionType = m_thing->thingClass().actionTypes().findByName("power"); + Action action(actionType.id(), m_thing->id(), Action::TriggeredByRule); + action.setParams({Param(actionType.id(), !windowOpen)}); + qCDebug(dcAirConditioning()) << "Setting power" << !windowOpen << "to" << m_thing->name(); + ThingActionInfo *info = m_thingManager->executeAction(action); + connect(info, &ThingActionInfo::finished, this, [info, this](){ + if (info->status() != Thing::ThingErrorNoError) { + qCWarning(dcAirConditioning()) << "Unable to execute power action on" << m_thing << info->status() << info->displayMessage(); + return; + } + }); + } + } + + // If nothing works, let's assume it is a very dump radiator thermostat and set the temperature to minimum + double temp = windowOpen ? m_thing->state("targetTemperature").minValue().toDouble() : m_cachedTargetTemperature; + if (m_thing->stateValue("targetTemperature").toDouble() != temp) { + ActionType actionType = m_thing->thingClass().actionTypes().findByName("targetTemperature"); + Action action(actionType.id(), m_thing->id(), Action::TriggeredByRule); + action.setParams({Param(actionType.id(), temp)}); + qCDebug(dcAirConditioning()) << "Setting target temperature (window open control)" << temp << "to" << m_thing->name() << "from" << m_thing->stateValue("targetTemperature").toDouble(); + ThingActionInfo *info = m_thingManager->executeAction(action); + connect(info, &ThingActionInfo::finished, this, [info, this](){ + if (info->status() != Thing::ThingErrorNoError) { + qCWarning(dcAirConditioning()) << "Unable to execute targetTemperature action on" << m_thing << info->status() << info->displayMessage(); + return; + } + qCDebug(dcAirConditioning()) << "Target temperature set successfully"; + }); + } +} + diff --git a/thermostat.h b/thermostat.h new file mode 100644 index 0000000..ee7b4cd --- /dev/null +++ b/thermostat.h @@ -0,0 +1,59 @@ +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * +* +* Copyright 2013 - 2022, nymea GmbH +* Contact: contact@nymea.io +* +* This file is part of nymea. +* This project including source code and documentation is protected by +* copyright law, and remains the property of nymea GmbH. All rights, including +* reproduction, publication, editing and translation, are reserved. The use of +* this project is subject to the terms of a license agreement to be concluded +* with nymea GmbH in accordance with the terms of use of nymea GmbH, available +* under https://nymea.io/license +* +* GNU General Public License Usage +* Alternatively, this project may be redistributed and/or modified under the +* terms of the GNU General Public License as published by the Free Software +* Foundation, GNU version 3. This project 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 project. If not, see . +* +* For any further details and any questions please contact us under +* contact@nymea.io or see our FAQ/Licensing Information on +* https://nymea.io/license/faq +* +* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +#ifndef THERMOSTAT_H +#define THERMOSTAT_H + +#include + +#include +#include + +class Thermostat : public QObject +{ + Q_OBJECT +public: + explicit Thermostat(ThingManager *thingManager, Thing *thing, QObject *parent = nullptr); + + Thing *thing() const; + void setTargetTemperature(double targetTemperature, bool force = false); + void setWindowOpen(bool windowOpen); + +signals: + +private: + ThingManager *m_thingManager = nullptr; + Thing *m_thing = nullptr; + + double m_cachedTargetTemperature; + bool m_windowOpen = false; +}; + +#endif // THERMOSTAT_H diff --git a/zoneinfo.cpp b/zoneinfo.cpp new file mode 100644 index 0000000..add4624 --- /dev/null +++ b/zoneinfo.cpp @@ -0,0 +1,178 @@ +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * +* +* Copyright 2013 - 2022, nymea GmbH +* Contact: contact@nymea.io +* +* This file is part of nymea. +* This project including source code and documentation is protected by +* copyright law, and remains the property of nymea GmbH. All rights, including +* reproduction, publication, editing and translation, are reserved. The use of +* this project is subject to the terms of a license agreement to be concluded +* with nymea GmbH in accordance with the terms of use of nymea GmbH, available +* under https://nymea.io/license +* +* GNU General Public License Usage +* Alternatively, this project may be redistributed and/or modified under the +* terms of the GNU General Public License as published by the Free Software +* Foundation, GNU version 3. This project 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 project. If not, see . +* +* For any further details and any questions please contact us under +* contact@nymea.io or see our FAQ/Licensing Information on +* https://nymea.io/license/faq +* +* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +#include "zoneinfo.h" + + +ZoneInfo::ZoneInfo() +{ + +} + +ZoneInfo::ZoneInfo(const QUuid &id): + m_id(id) +{ + +} + +QUuid ZoneInfo::id() const +{ + return m_id; +} + +QString ZoneInfo::name() const +{ + return m_name; +} + +void ZoneInfo::setName(const QString &name) +{ + m_name = name; +} + +double ZoneInfo::currentSetpoint() const +{ + return m_currentSetpoint; +} + +void ZoneInfo::setCurrentSetpoint(double currentSetpoint) +{ + m_currentSetpoint = currentSetpoint; +} + +double ZoneInfo::standbySetpoint() const +{ + return m_standbySetpoint; +} + +void ZoneInfo::setStandbySetpoint(double standbySetpoint) +{ + m_standbySetpoint = standbySetpoint; +} + +double ZoneInfo::setpointOverride() const +{ + return m_setpointOverride; +} + +void ZoneInfo::setSetpointOverride(double setpointOverride, SetpointOverrideMode mode, const QDateTime &setpointOverrideEnd) +{ + m_setpointOverride = setpointOverride; + m_setpointOverrideMode = mode; + m_setpointOverrideEnd = setpointOverrideEnd; +} + +ZoneInfo::SetpointOverrideMode ZoneInfo::setpointOverrideMode() const +{ + return m_setpointOverrideMode; +} + +QDateTime ZoneInfo::setpointOverrideEnd() const +{ + return m_setpointOverrideEnd; +} + +QList ZoneInfo::thermostats() const +{ + return m_thermostats; +} + +void ZoneInfo::setThermostats(const QList &thermostats) +{ + m_thermostats = thermostats; +} + +QList ZoneInfo::windowSensors() const +{ + return m_windowSensors; +} + +void ZoneInfo::setWindowSensors(const QList &windowSensors) +{ + m_windowSensors = windowSensors; +} + +QList ZoneInfo::indoorSensors() const +{ + return m_indoorSensors; +} + +void ZoneInfo::setIndoorSensors(const QList &indoorSensors) +{ + m_indoorSensors = indoorSensors; +} + +QList ZoneInfo::outdoorSensors() const +{ + return m_outdoorSensors; +} + +void ZoneInfo::setOutdoorSensors(const QList &outdoorSensors) +{ + m_outdoorSensors = outdoorSensors; +} + +ZoneInfo::ZoneStatus ZoneInfo::zoneStatus() const +{ + return m_zoneStatus; +} + +void ZoneInfo::setZoneStatus(ZoneStatus zoneStatus) +{ + m_zoneStatus = zoneStatus; +} + +void ZoneInfo::setZoneStatusFlag(ZoneStatusFlag flag, bool set) +{ + m_zoneStatus.setFlag(flag, set); +} + +TemperatureWeekSchedule ZoneInfo::weekSchedule() const +{ + return m_weekSchedule; +} + +void ZoneInfo::setWeekSchedule(const TemperatureWeekSchedule &weekSchedule) +{ + m_weekSchedule = weekSchedule; + while (m_weekSchedule.count() < 7) { + m_weekSchedule.append(TemperatureDaySchedule()); + } +} + +QVariant ZoneInfos::get(int index) const +{ + return QVariant::fromValue(at(index)); +} + +void ZoneInfos::put(const QVariant &variant) +{ + append(variant.value()); +} diff --git a/zoneinfo.h b/zoneinfo.h new file mode 100644 index 0000000..dc9b405 --- /dev/null +++ b/zoneinfo.h @@ -0,0 +1,149 @@ +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * +* +* Copyright 2013 - 2022, nymea GmbH +* Contact: contact@nymea.io +* +* This file is part of nymea. +* This project including source code and documentation is protected by +* copyright law, and remains the property of nymea GmbH. All rights, including +* reproduction, publication, editing and translation, are reserved. The use of +* this project is subject to the terms of a license agreement to be concluded +* with nymea GmbH in accordance with the terms of use of nymea GmbH, available +* under https://nymea.io/license +* +* GNU General Public License Usage +* Alternatively, this project may be redistributed and/or modified under the +* terms of the GNU General Public License as published by the Free Software +* Foundation, GNU version 3. This project 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 project. If not, see . +* +* For any further details and any questions please contact us under +* contact@nymea.io or see our FAQ/Licensing Information on +* https://nymea.io/license/faq +* +* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +#ifndef ZONEINFO_H +#define ZONEINFO_H + +#include +#include +#include + +#include + +#include "temperatureschedule.h" + +class ZoneInfo +{ + Q_GADGET + Q_PROPERTY(QUuid id READ id) + Q_PROPERTY(QString name READ name) + Q_PROPERTY(double currentSetpoint READ currentSetpoint) + Q_PROPERTY(double standbySetpoint READ standbySetpoint) + Q_PROPERTY(SetpointOverrideMode setpointOverrideMode READ setpointOverrideMode) + Q_PROPERTY(double setpointOverride READ setpointOverride) + Q_PROPERTY(QDateTime setpointOverrideEnd READ setpointOverrideEnd) + Q_PROPERTY(QList thermostats READ thermostats) + Q_PROPERTY(QList windowSensors READ windowSensors) + Q_PROPERTY(QList indoorSensors READ indoorSensors) + Q_PROPERTY(QList outdoorSensors READ outdoorSensors) + Q_PROPERTY(ZoneStatus zoneStatus READ zoneStatus) + Q_PROPERTY(TemperatureWeekSchedule weekSchedule READ weekSchedule) + +public: + enum ZoneStatusFlag { + ZoneStatusFlagNone = 0x00, + ZoneStatusFlagTimeScheduleActive = 0x01, + ZoneStatusFlagSetpointOverrideActive = 0x02, + ZoneStatusFlagWindowOpen = 0x10, + ZoneStatusFlagBadAir = 0x20, + ZoneStatusFlagHighHumidity = 0x40 + }; + Q_ENUM(ZoneStatusFlag) + Q_DECLARE_FLAGS(ZoneStatus, ZoneStatusFlag) +// Q_DECLARE_OPERATORS_FOR_FLAGS(ZoneStatus) + Q_FLAG(ZoneStatus) + + enum SetpointOverrideMode { + SetpointOverrideModeNone = 0, + SetpointOverrideModeTimed, + SetpointOverrideModeUnlimited, + SetpointOverrideModeEventual + }; + Q_ENUM(SetpointOverrideMode) + + ZoneInfo(); + ZoneInfo(const QUuid &id); + + QUuid id() const; + + QString name() const; + void setName(const QString &name); + + double currentSetpoint() const; + void setCurrentSetpoint(double currentSetpoint); + + double standbySetpoint() const; + void setStandbySetpoint(double standbySetpoint); + + double setpointOverride() const; + void setSetpointOverride(double setpointOverride, SetpointOverrideMode mode, const QDateTime &setpointOverrideEnd = QDateTime()); + SetpointOverrideMode setpointOverrideMode() const; + QDateTime setpointOverrideEnd() const; + + QList thermostats() const; + void setThermostats(const QList &thermostats); + + QList windowSensors() const; + void setWindowSensors(const QList &windowSensors); + + QList indoorSensors() const; + void setIndoorSensors(const QList &indoorSensors); + + QList outdoorSensors() const; + void setOutdoorSensors(const QList &outdoorSensors); + + ZoneInfo::ZoneStatus zoneStatus() const; + void setZoneStatus(ZoneStatus zoneStatus); + void setZoneStatusFlag(ZoneStatusFlag flag, bool set); + + TemperatureWeekSchedule weekSchedule() const; + void setWeekSchedule(const TemperatureWeekSchedule &weekSchedule); + +private: + QUuid m_id; + QString m_name; + double m_currentSetpoint = 0; + double m_standbySetpoint = 18; + double m_setpointOverride; + SetpointOverrideMode m_setpointOverrideMode = SetpointOverrideModeNone; + QDateTime m_setpointOverrideEnd; + QList m_thermostats; + QList m_windowSensors; + QList m_indoorSensors; + QList m_outdoorSensors; + ZoneStatus m_zoneStatus = ZoneStatusFlagNone; + TemperatureWeekSchedule m_weekSchedule; +}; +Q_DECLARE_METATYPE(ZoneInfo) + +class ZoneInfos: public QList +{ + Q_GADGET + Q_PROPERTY(int count READ count) +public: + ZoneInfos() = default; + ZoneInfos(const QList &other): QList(other) {} + Q_INVOKABLE QVariant get(int index) const; + Q_INVOKABLE void put(const QVariant &variant); +}; +Q_DECLARE_METATYPE(QList) +Q_DECLARE_METATYPE(ZoneInfos) + +#endif // ZONEINFO_H