From df147630e52994263a910253a85fda8acefde205 Mon Sep 17 00:00:00 2001 From: denis Date: Mon, 23 Sep 2024 15:10:59 +0200 Subject: [PATCH] first commit --- LICENSE | 674 ++++++++++++++++++++++++++++++ README_english | 39 ++ README_french | 38 ++ README_german | 39 ++ etc/bin/client-certs.sh | 22 + etc/bin/server-certs.sh | 39 ++ etc/bin/v3.ext | 4 + etc/bin/venv-install.sh | 12 + etc/conf/solarmax_service.conf | 12 + etc/install/1-root-install-sys.sh | 25 ++ etc/install/requirements.txt | 2 + solarmax/SolarMax/README_french | 39 ++ solarmax/SolarMax/README_german | 39 ++ solarmax/SolarMax/__init__.py | 0 solarmax/SolarMax/solarmax.py | 366 ++++++++++++++++ solarmax/SolarMax/solarmax_fr.py | 381 +++++++++++++++++ solarmax/config_example.yaml | 19 + solarmax/contrib/__init__.py | 0 solarmax/contrib/mqttc.py | 149 +++++++ solarmax/contrib/utils.py | 138 ++++++ solarmax/solarmaxd.py | 233 +++++++++++ 21 files changed, 2270 insertions(+) create mode 100644 LICENSE create mode 100644 README_english create mode 100644 README_french create mode 100644 README_german create mode 100755 etc/bin/client-certs.sh create mode 100755 etc/bin/server-certs.sh create mode 100644 etc/bin/v3.ext create mode 100755 etc/bin/venv-install.sh create mode 100644 etc/conf/solarmax_service.conf create mode 100755 etc/install/1-root-install-sys.sh create mode 100644 etc/install/requirements.txt create mode 100644 solarmax/SolarMax/README_french create mode 100644 solarmax/SolarMax/README_german create mode 100644 solarmax/SolarMax/__init__.py create mode 100644 solarmax/SolarMax/solarmax.py create mode 100644 solarmax/SolarMax/solarmax_fr.py create mode 100644 solarmax/config_example.yaml create mode 100644 solarmax/contrib/__init__.py create mode 100644 solarmax/contrib/mqttc.py create mode 100644 solarmax/contrib/utils.py create mode 100755 solarmax/solarmaxd.py diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README_english b/README_english new file mode 100644 index 0000000..5111f5d --- /dev/null +++ b/README_english @@ -0,0 +1,39 @@ +This document translated from the original German version using Google Translate. + + +Under the brand name "SolarMax" sells the Swiss company +Sputnik Engineering AG photovoltaic inverter. + +The SolarMax inverters can be customized with normal Ethernet connection +query, taking advantage of a (sort of) text-based protocol over +a TCP connection. + +The protocol used was reverse engineered by me (using +Network-capturing using the MaxTalk software). + +Only after implementation of the basic functionality I received yet +still a documentation of the protocol used by the manufacturer. +The license of this interface description, however, does not allow +to make them publicly: +| The user shall refrain from the data log Third +| To be disclosed to. Next he refrains from the +| MaxComm data protocol for serial production +| Of data visualization and -überwachungsgeräten and +| By alerting devices for inverter systems to +| Use which the corresponding standard solutions +| The Supplier compete. However, permitted the +| Used for the production of such devices +| For your own use or as part of the authoritative +|-Tailored data communication system individual solutions +| For certain customers. If in doubt, Sputnik +| To ask. + +Contact the manufacturer: +   Sputnik Engineering AG +   CH-Biel +   www.solarmax.com + + + +The present here Python library but not based on this +Interface description and therefore not subject to this restriction. \ No newline at end of file diff --git a/README_french b/README_french new file mode 100644 index 0000000..f26b278 --- /dev/null +++ b/README_french @@ -0,0 +1,38 @@ +Ce document est en langue allemande. N'hésitez pas à traduire. + + +L'entreprise suisse vend sous la marque "SolarMax". +Onduleur photovoltaïque Sputnik Engineering AG. + +Les onduleurs SolarMax peuvent être utilisés avec une connexion Ethernet normale +requête utilisant un (sorte de) protocole basé sur du texte +une connexion TCP. + +Le protocole utilisé a été rétro-conçu par moi (en utilisant +capture réseau lors de l'utilisation du logiciel MaxTalk). + +Ce n'est qu'après avoir implémenté la fonctionnalité de base que je l'ai reçu +ni la documentation du protocole utilisé par le fabricant. +Cependant, la licence de cette description d'interface ne permet pas +pour les rendre publics : +| L'utilisateur s'abstient de fournir le journal de données à des tiers +| divulguer à. Il s'abstient en outre de le faire +| Protocole de données MaxComm pour la production en série +| de dispositifs de visualisation et de surveillance des données, et +| de dispositifs d'alarme pour les systèmes d'onduleurs +| utiliser les solutions étalons correspondantes +| du fournisseur en concurrence. En revanche, il est permis +| Utilisation pour la fabrication de tels dispositifs +| pour un usage personnel ou dans le cadre de +| système de communication de données sur mesure solutions individuelles +| pour des clients spécifiques. En cas de doute, Spoutnik +| demander. + +Coordonnées du fabricant : + Sputnik Engineering AG + CH-Bienne + www.solarmax.com + +Cependant, la bibliothèque Python présentée ici n'est pas basée sur celle-ci +Description de l'interface et n'est donc pas soumis à cette restriction. + diff --git a/README_german b/README_german new file mode 100644 index 0000000..f5d4a0c --- /dev/null +++ b/README_german @@ -0,0 +1,39 @@ +This document is in german language. Feel free to translate. + + +Unter dem Markennamen "SolarMax" vertreibt die schweizer Firma +Sputnik Engineering AG Fotovoltaik-Wechselrichter. + +Die SolarMax-Wechselrichter lassen sich mit normaler Ethernet-Verbindung +abfragen und nutzen dabei ein (gewissermaßen) Text-basiertes Protokoll über +eine TCP-Verbindung. + +Das verwendete Protokoll wurde von mir reverse engineered (mittels +Netzwerk-capturing bei Verwendung der MaxTalk-Software). + +Erst nach Implementierung der Basisfunktionalität erhielt ich doch +noch eine Dokumentation des verwendeten Protokolls vom Hersteller. +Die Lizenz dieser Schnittstellenbeschreibung erlaubt es jedoch nicht, +diese öffentlich zu machen: +| Der Nutzer sieht davon ab, das Datenprotokoll Dritten +| gegenüber offenzulegen. Weiter sieht er davon ab, das +| MaxComm Datenprotokoll zur serienmässigen Herstellung +| von Datenvisualisierungs und –überwachungsgeräten sowie +| von Alarmierungsgeräten für Wechselrichteranlagen zu +| verwenden, welche die entsprechenden Standardlösungen +| des Lieferers konkurrenzieren. Erlaubt ist dagegen die +| Verwendung für die Herstellung von derartigen Geräten +| für den eigenen Gebrauch oder im Rahmen von massge- +| schneiderten Datenkommunikations-System-Einzellösungen +| für bestimmte Kunden. Im Zweifelsfall ist Sputnik +| anzufragen. + +Kontaktdaten des Herstellers: + Sputnik Engineering AG + CH-Biel + www.solarmax.com + + + +Die hier vorliegende Python-Bibliothek basiert jedoch nicht auf dieser +Schnittstellenbeschreibung und unterliegt daher nicht dieser Einschränkung. diff --git a/etc/bin/client-certs.sh b/etc/bin/client-certs.sh new file mode 100755 index 0000000..d2e7beb --- /dev/null +++ b/etc/bin/client-certs.sh @@ -0,0 +1,22 @@ +#!/bin/bash +set -x +#doesn't currently work using variables +cacert = 'server-certs/ca.crt' +cakey = 'server-certs/ca.key' + +dir="client-certs" +echo "Creating Client Key" +openssl genrsa -out client.key 2048 +echo "Creating certificate request" +openssl req -new -out client.csr -key client.key +echo "Signing client certificate with CA key" +echo "The CA key File must be in the server-certs folder" +openssl x509 -req -in client.csr -CA server-certs/ca.crt -CAkey server-certs/ca.key -CAcreateserial -out client.crt -days 3650 + +if [ -d $dir ];then + echo "directory Exists" +else + mkdir $dir +fi + +mv client.* $dir diff --git a/etc/bin/server-certs.sh b/etc/bin/server-certs.sh new file mode 100755 index 0000000..bfb1ac4 --- /dev/null +++ b/etc/bin/server-certs.sh @@ -0,0 +1,39 @@ +dir="server-certs" +FILE="v3.ext" +echo "Creating CA key The passkey is important so remember it" +openssl genrsa -des3 -out ca.key 2048 +echo "Created CA Certificate 10 years expiry" +openssl req -new -x509 -days 3650 -key ca.key -out ca.crt +echo "Creating Server key" +openssl genrsa -out server.key 2048 +echo "Creating Server certificate" +openssl req -new -out server.csr -key server.key +echo "Signing Server certificate Server certificate" +echo "Common Name should be the FQDN or IP address of the server" +echo "It is what you would use to ping the server" + +if [ -f "$FILE" ];then +echo "$FILE exists" +break +else +echo "You need an external file called $FILE to continue" +fi +echo "Press enter to continue" +read var1 + +if [ ! -f "$FILE" ];then +exit 1 +fi + +openssl x509 -req -in server.csr -CA ca.crt -CAkey ca.key -CAcreateserial -out server.crt -days 3650 -extfile $FILE +echo "copying files to certs subdirectory" +if [ -d $dir ] +then + echo "directory Exists" +else + mkdir $dir +fi +mv *.crt $dir +mv *.key $dir +mv *.csr $dir +mv *.srl $dir diff --git a/etc/bin/v3.ext b/etc/bin/v3.ext new file mode 100644 index 0000000..3b50ef9 --- /dev/null +++ b/etc/bin/v3.ext @@ -0,0 +1,4 @@ +authorityKeyIdentifier = keyid,issuer +basicConstraints=CA:FALSE +keyUsage = digitalSignature, nonRepudiation, keyEncipherment, dataEncipherment, keyAgreement, keyCertSign + diff --git a/etc/bin/venv-install.sh b/etc/bin/venv-install.sh new file mode 100755 index 0000000..27f524a --- /dev/null +++ b/etc/bin/venv-install.sh @@ -0,0 +1,12 @@ +#!/bin/bash + +rm -rf .venv +python3 -m venv .venv +source $(pwd)/.venv/bin/activate +echo "Activate virtual environment .venv" +echo "PIP path: $(command -v pip)" + +pip install -U pip wheel setuptools +pip install -r $1 + + diff --git a/etc/conf/solarmax_service.conf b/etc/conf/solarmax_service.conf new file mode 100644 index 0000000..1583a81 --- /dev/null +++ b/etc/conf/solarmax_service.conf @@ -0,0 +1,12 @@ + +[program:solarmax] +directory = /home/opiwin/solarmax/solarmax +command=/home/opiwin/solarmax/solarmax/solarmaxd.py +user=opiwin +group=opiwin +stopasgroup=true +stopsignal=SIGINT +autostart=true +autorestart=true +redirect_stderr=true +redirect_stdout=true diff --git a/etc/install/1-root-install-sys.sh b/etc/install/1-root-install-sys.sh new file mode 100755 index 0000000..c1f5065 --- /dev/null +++ b/etc/install/1-root-install-sys.sh @@ -0,0 +1,25 @@ +#!/bin/bash +if [ $EUID -ne 0 ]; then + echo "Lancer en root: # $0" 1>&2 + exit 1 +fi +apt update +#apt upgrade + +apt install build-essential binutils supervisor + +# supervisor http access +if [ ! -e "/etc/supervisor/supervisord.conf.old" ]; then + cp /etc/supervisor/supervisord.conf /etc/supervisor/supervisord.conf.old + cat >> /etc/supervisor/supervisord.conf << EOF + [inet_http_server] + port = *:9001 + username = root + password = toor + EOF +fi + +apt install python3-dev python3-pip python3-venv + +#python3-paho-mqtt python3-pyaml + diff --git a/etc/install/requirements.txt b/etc/install/requirements.txt new file mode 100644 index 0000000..f32a41c --- /dev/null +++ b/etc/install/requirements.txt @@ -0,0 +1,2 @@ +pyyaml +paho-mqtt==1.6.1 diff --git a/solarmax/SolarMax/README_french b/solarmax/SolarMax/README_french new file mode 100644 index 0000000..39a69bd --- /dev/null +++ b/solarmax/SolarMax/README_french @@ -0,0 +1,39 @@ +Ce document est en langue allemande. N'hésitez pas à traduire. + + +L'entreprise suisse vend sous la marque "SolarMax". +Onduleur photovoltaïque Sputnik Engineering AG. + +Les onduleurs SolarMax peuvent être utilisés avec une connexion Ethernet normale +requête utilisant un (sorte de) protocole basé sur du texte +une connexion TCP. + +Le protocole utilisé a été rétro-conçu par moi (en utilisant +capture réseau lors de l'utilisation du logiciel MaxTalk). + +Ce n'est qu'après avoir implémenté la fonctionnalité de base que je l'ai reçu +ni la documentation du protocole utilisé par le fabricant. +Cependant, la licence de cette description d'interface ne permet pas +pour les rendre publics : +| L'utilisateur s'abstient de fournir le journal de données à des tiers +| divulguer à. Il s'abstient en outre de le faire +| Protocole de données MaxComm pour la production en série +| de dispositifs de visualisation et de surveillance des données, et +| de dispositifs d'alarme pour les systèmes d'onduleurs +| utiliser les solutions étalons correspondantes +| du fournisseur en concurrence. En revanche, il est permis +| Utilisation pour la fabrication de tels dispositifs +| pour un usage personnel ou dans le cadre de +| système de communication de données sur mesure solutions individuelles +| pour des clients spécifiques. En cas de doute, Spoutnik +| demander. + +Coordonnées du fabricant : + Sputnik Engineering AG + CH-Bienne + www.solarmax.com + + + +Cependant, la bibliothèque Python présentée ici n'est pas basée sur celle-ci +Description de l'interface et n'est donc pas soumis à cette restriction. \ No newline at end of file diff --git a/solarmax/SolarMax/README_german b/solarmax/SolarMax/README_german new file mode 100644 index 0000000..f5d4a0c --- /dev/null +++ b/solarmax/SolarMax/README_german @@ -0,0 +1,39 @@ +This document is in german language. Feel free to translate. + + +Unter dem Markennamen "SolarMax" vertreibt die schweizer Firma +Sputnik Engineering AG Fotovoltaik-Wechselrichter. + +Die SolarMax-Wechselrichter lassen sich mit normaler Ethernet-Verbindung +abfragen und nutzen dabei ein (gewissermaßen) Text-basiertes Protokoll über +eine TCP-Verbindung. + +Das verwendete Protokoll wurde von mir reverse engineered (mittels +Netzwerk-capturing bei Verwendung der MaxTalk-Software). + +Erst nach Implementierung der Basisfunktionalität erhielt ich doch +noch eine Dokumentation des verwendeten Protokolls vom Hersteller. +Die Lizenz dieser Schnittstellenbeschreibung erlaubt es jedoch nicht, +diese öffentlich zu machen: +| Der Nutzer sieht davon ab, das Datenprotokoll Dritten +| gegenüber offenzulegen. Weiter sieht er davon ab, das +| MaxComm Datenprotokoll zur serienmässigen Herstellung +| von Datenvisualisierungs und –überwachungsgeräten sowie +| von Alarmierungsgeräten für Wechselrichteranlagen zu +| verwenden, welche die entsprechenden Standardlösungen +| des Lieferers konkurrenzieren. Erlaubt ist dagegen die +| Verwendung für die Herstellung von derartigen Geräten +| für den eigenen Gebrauch oder im Rahmen von massge- +| schneiderten Datenkommunikations-System-Einzellösungen +| für bestimmte Kunden. Im Zweifelsfall ist Sputnik +| anzufragen. + +Kontaktdaten des Herstellers: + Sputnik Engineering AG + CH-Biel + www.solarmax.com + + + +Die hier vorliegende Python-Bibliothek basiert jedoch nicht auf dieser +Schnittstellenbeschreibung und unterliegt daher nicht dieser Einschränkung. diff --git a/solarmax/SolarMax/__init__.py b/solarmax/SolarMax/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/solarmax/SolarMax/solarmax.py b/solarmax/SolarMax/solarmax.py new file mode 100644 index 0000000..40e3db5 --- /dev/null +++ b/solarmax/SolarMax/solarmax.py @@ -0,0 +1,366 @@ +#!/usr/bin/python +# -* coding: utf-8 *- + +# 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 . + +# Developed 2009-2010 by Bernd Wurst +# for own use. +# Released to the public in 2012. + + +import socket, datetime + + +# Konstanten +inverter_types = { + 20010: { 'desc': 'SolarMax 2000S', 'max': 2000, }, # Nur geraten + 20020: { 'desc': 'SolarMax 3000S', 'max': 3000, }, + 20030: { 'desc': 'SolarMax 4200S', 'max': 4200, }, + 20040: { 'desc': 'SolarMax 6000S', 'max': 6000, }, + } + + +query_types = ['KDY', 'KYR', 'KMT', 'KT0', 'IL1', 'IDC', 'PAC', 'PRL', + 'SYS', 'SAL', 'TNF', 'PAC', 'PRL', 'TKK', 'UL1', 'UDC', + 'ADR', 'TYP', 'PIN', 'MAC', 'CAC', 'KHR', 'EC00', 'EC01', + 'EC02', 'EC03', 'EC04', 'EC05', 'EC06', 'EC07', 'EC08', + 'BDN', 'SWV', 'DIN', 'LAN', 'SDAT', 'FDAT'] + + +status_codes = { +20000: 'Keine Kommunikation', +20001: 'In Betrieb', +20002: 'Zu wenig Einstrahlung', +20003: 'Anfahren', +20004: 'Betrieb auf MPP', +20005: 'Ventilator läuft', +20006: 'Betrieb auf Maximalleistung', +20007: 'Temperaturbegrenzung', +20008: 'Netzbetrieb', + } + + +alarm_codes = { + 0: 'kein Fehler', + 1: 'Externer Fehler 1', + 2: 'Isolationsfehler DC-Seite', + 4: 'Fehlerstrom Erde zu Groß', + 8: 'Sicherungsbruch Mittelpunkterde', + 16: 'Externer Alarm 2', + 32: 'Langzeit-Temperaturbegrenzung', + 64: 'Fehler AC-Einspeisung', + 128: 'Externer Alarm 4', + 256: 'Ventilator defekt', + 512: 'Sicherungsbruch', + 1024: 'Ausfall Temperatursensor', + 2048: 'Alarm 12', + 4096: 'Alarm 13', + 8192: 'Alarm 14', + 16384: 'Alarm 15', + 32768: 'Alarm 16', + 65536: 'Alarm 17', + } + + + +# Hilfs-Routine (DEBUG) + +def DEBUG(*s): + out = [datetime.datetime.now().isoformat()+':',] + [str(x) for x in s] + print(' '.join(out)) + + + +#################################### +## Haupt-Klasse +#################################### + + +class SolarMax ( object ): + def __init__(self, host, port): + self.__host = host + self.__port = port + self.__inverters = {} + self.__socket = None + self.__connected = False + self.__allinverters = False + self.__inverter_list = [] + self.__connect() + + def __repr__(self): + return 'SolarMax[%s:%s / socket=%s]' % (self.__host, self.__port, self.__socket) + + def __str__(self): + return 'SolarMax[%s:%s / socket=%s / inverters=%s]' % (self.__host, self.__port, self.__socket, self.inverters()) + + def __disconnect(self): + try: + DEBUG('Closing open connection to %s:%s' % (self.__host, self.__port)) + self.__socket.shutdown(socket.SHUT_RDWR) + self.__socket.close() + del self.__socket + except: + pass + finally: + self.__connected = False + self.__allinverters = False + self.__socket = None + + def __del__(self): + DEBUG('destructor called') + self.__disconnect() + + def __connect(self): + self.__disconnect() + DEBUG('establishing connection to %s:%i...' % (self.__host, self.__port)) + try: + # Python 2.5 + self.__socket = socket.socket() + s = self.__socket + s.settimeout(2) + s.connect((self.__host, self.__port)) + s.settimeout(10) + self.__connected = True + DEBUG('connected.') + except: + DEBUG('connection to %s:%i failed' % (self.__host, self.__port)) + self.__connected = False + self.__allinverters = False + + # Python 2.6 + ## Socket-timeout: 5 secs + #self.__socket = socket.create_connection((self.__host, self.__port), 5) + + + # Utility-functions + def hexval(self, i): + return (hex(i)[2:]).upper() + + + def checksum(self, s): + total = 0 + for c in s: + total += ord(c) + h = self.hexval(total) + while len(h) < 4: + h = '0'+h + return h + + + def __receive(self): + try: + data = '' + tmp = '' + while True: + tmp = self.__socket.recv(1) + data += tmp + if len(tmp) < 1 or tmp == '}': + break + tmp = '' + return data + except: + self.__allinverters = False + return "" + + + def __parse(self, answer): + # convenience checks + if answer[0] != '{' or answer[-1] != '}': + raise ValueError('malformed answer: %s' % answer) + raw_answer = answer + answer = answer[1:-1] + checksum = answer[-4:] + content = answer[:-4] + # checksum + if checksum != self.checksum(content): + raise ValueError('checksum error') + + (header, content) = content[:-1].split('|', 2) + (inverter, fb, length) = header.split(';', 3) + if fb != 'FB': + raise ValueError('answer not understood') + # length + length = int(length, 16) + if length != len(raw_answer): + raise ValueError('length mismatch') + + inverter = int(inverter) + + # Bei schreibzugriff antwortet der WR mit 'C8' + #if not content.startswith('64:'): + # raise ValueError('Inverter did not understand our query') + + content = content[3:] + data = {} + + for item in content.split(';'): + (key, value) = item.split('=') + if key not in query_types: + raise NotImplementedError("Don't know %s" % item) + data[key] = value + return (inverter, data) + + + + + def __build_query(self, id, values, qtype=100): + qtype = self.hexval(qtype) + if type(values) == list: + for v in values: + if v not in query_types: + raise ValueError('Unknown data type »'+v+'«') + values = ';'.join(values) + elif type(values) in [str, unicode]: + pass + else: + raise ValueError('value has unsupported type') + + querystring = '|' + qtype + ':' + values + '|' + # Länge vergrößern um: 2 x { (2), WR-Nummer (2), "FB" (2), zwei Semikolon (2), Länge selbst (2), checksumme (4) + l = len(querystring) + 2 + 2 + 2 + 2 +2 + 4 + querystring = 'FB;%02i;%s%s' % (int(id), self.hexval(l), querystring) + querystring += self.checksum(querystring) + return '{%s}' % querystring + + + def __send_query(self, querystring): + try: + DEBUG(self.__host, '=>', querystring) + self.__socket.send(querystring) + except socket.timeout: + self.__allinverters = False + except socket.error: + self.__connected = False + + + + def query(self, id, values, qtype=100): + q = self.__build_query(id, values, qtype) + #DEBUG("WR %i: %s" % (id, q)) + self.__send_query(q) + answer = self.__receive() + if answer: + (inverter, data) = self.__parse(answer) + for d in data.keys(): + data[d] = self.normalize_value(d, data[d]) + return (inverter, data) + else: + self.__allinverters = False + + if not self.__allinverters and not self.__detection_running: + self.detect_inverters() + elif not self.__connected: + self.__connect() + else: + raise socket.timeout + return None + + + + def normalize_value(self, key, value): + if key in [ 'KDY', 'UL1', 'UDC']: + return float(int(value, 16)) / 10 + elif key in [ 'IL1', 'IDC', 'TNF', ]: + return float(int(value, 16)) / 100 + elif key in [ 'PAC', 'PIN', ]: + return float(int(value, 16)) / 2 + elif key in [ 'SAL', ]: + return int(value, 16) + elif key in [ 'SYS', ]: + (x,y) = value.split(',',2) + x = int(x, 16) + y = int(y, 16) + return (x,y) + elif key in [ 'SDAT', 'FDAT' ]: + (date, time) = value.split(',',2) + time = int(time, 16) + return datetime.datetime(int(date[:3], 16), int(date[3:5], 16), int(date[5:], 16), time/3600, (time % 3600) / 60, time % (3600*60)) + else: + return int(value, 16) + + + def write_setting(self, inverter, data): + rawdata = [] + for key,value in data.iteritems(): + key = key.upper() + if key not in query_types: + raise ValueError('unknown type') + value = self.hexval(value) + rawdata.append('%s=%s' % (key, value)) + DEBUG(self.query(inverter, ';'.join(rawdata), 200)) + + + def status(self, inverter): + result = self.query(inverter, ['SYS', 'SAL']) + if not result: + return ('Offline', 'Offline') + result = result[1] + errors = [] + if result['SAL'] > 0: + for (code, descr) in alarm_codes.iteritems(): + if code & result['SAL']: + errors.append(descr) + + status = status_codes[result['SYS'][0]] + return (status, ', '.join(errors)) + + + def use_inverters(self, list_of): + self.__inverter_list = list_of + self.detect_inverters() + + + def detect_inverters(self): + self.__inverters = {} + if not self.__connected: + self.__connect() + self.__detection_running = True + for inverter in self.__inverter_list: + try: + DEBUG('searching for #%i (socket: %s)' % (inverter, self.__socket)) + (inverter, data) = self.query(inverter, [ 'ADR', 'TYP', 'PIN' ]) + if data['TYP'] in inverter_types.keys(): + self.__inverters[inverter] = inverter_types[data['TYP']].copy() + self.__inverters[inverter]['installed'] = data['PIN'] + else: + DEBUG('Unknown inverter type: %s (ID #%i)' % (data['TYP'], data['ADR'])) + except: + DEBUG('Inverter #%i not found' % inverter) + self.__allinverters = False + self.__detection_running = False + if len(self.__inverters) == len(self.__inverter_list): + self.__allinverters = True + DEBUG('found all inverters:') + DEBUG(self.__inverters) + else: + DEBUG('not all invertes found, reconnection!') + self.__connect() + + + def inverters(self): + if not self.__allinverters: + self.detect_inverters() + return self.__inverters + + + + + + + + + + + + + diff --git a/solarmax/SolarMax/solarmax_fr.py b/solarmax/SolarMax/solarmax_fr.py new file mode 100644 index 0000000..2d6d857 --- /dev/null +++ b/solarmax/SolarMax/solarmax_fr.py @@ -0,0 +1,381 @@ +#!/usr/bin/python +# -* coding: utf-8 *- + +# 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 . + +# Developed 2009-2010 by Bernd Wurst +# for own use. +# Released to the public in 2012. + + +import socket, datetime, logging + +logging.basicConfig(level=logging.INFO) +logger = logging.getLogger(__name__) + +# Constantes +inverter_types = { + 20010: { 'desc': 'SolarMax 2000S', 'max': 2000, }, # Juste deviner + 20020: { 'desc': 'SolarMax 3000S', 'max': 3000, }, + 20030: { 'desc': 'SolarMax 4200S', 'max': 4200, }, + 20040: { 'desc': 'SolarMax 6000S', 'max': 6000, }, + } + + +query_types = [ + 'KDY', 'KYR', 'KMT', 'KT0', 'IL1', 'IDC', 'PAC', 'PRL', + 'SYS', 'SAL', 'TNF', 'PAC', 'PRL', 'TKK', 'UL1', 'UDC', + 'ADR', 'TYP', 'PIN', 'MAC', 'CAC', 'KHR', 'EC00', 'EC01', + 'EC02', 'EC03', 'EC04', 'EC05', 'EC06', 'EC07', 'EC08', + 'BDN', 'SWV', 'DIN', 'LAN', 'SDAT', 'FDAT' + ] + +status_codes = { + 20000: 'Pas de communication', + 20001: 'En cours d\'utilisation', + 20002: 'Trop peu de rayonnement', + 20003: 'Démarrage', + 20004: 'Opération sur MPP', + 20005: 'Le ventilateur tourne', + 20006: 'Fonctionnement à puissance maximale', + 20007: 'Limite de température', + 20008: 'Fonctionnement sur secteur', +} + +alarm_codes = { + 0: "pas d'erreur", + 1: "Erreur externe 1", + 2: "Erreur d'isolement côté DC", + 4: "Courant de défaut à la terre trop important", + 8: "Rupture du fusible de la protection terre", + 16: "Alarme externe 2", + 32: "Limitation de température à long terme", + 64: "Erreur alimentation CA", + 128: "Alarme externe 4", + 256: "Ventilateur défectueux", + 512: "Casser le fusible", + 1024: "Défaillance du capteur de température", + 2048: "Alarme 12", + 4096: "Alarme 13", + 8192: "Alarme 14", + 16384: "Alarme 15", + 32768: "Alarme 16", + 65536: "Alarme 17", + } + +# Hilfs-Routine (DEBUG) + +def DEBUG(*s): + out = [datetime.datetime.now().isoformat()+':',] + [str(x) for x in s] + #print(' '.join(out)) + logger.debug(' '.join(out)) + +def get_status_code(v): + for i in status_codes: + if status_codes[i]==v: + return i + return None + +#################################### +## main class +#################################### +class SolarMax ( object ): + + def __init__(self, host, port): + self.__host = host + self.__port = port + self.__inverters = {} + self.__socket = None + self.__connected = False + self.__allinverters = False + self.__inverter_list = [] + self.__connect() + + def __repr__(self): + return 'SolarMax[%s:%s / socket=%s]' % (self.__host, self.__port, self.__socket) + + def __str__(self): + return 'SolarMax[%s:%s / socket=%s / inverters=%s]' % (self.__host, self.__port, self.__socket, self.inverters()) + + def __disconnect(self): + try: + DEBUG('Closing open connection to %s:%s' % (self.__host, self.__port)) + self.__socket.shutdown(socket.SHUT_RDWR) + self.__socket.close() + del self.__socket + except: + pass + finally: + self.__connected = False + self.__allinverters = False + self.__socket = None + + def __del__(self): + DEBUG('destructor called') + self.__disconnect() + + def __connect(self): + self.__disconnect() + DEBUG('establishing connection to %s:%i...' % (self.__host, self.__port)) + try: + self.__socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) + + self.__socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) + + s = self.__socket + s.settimeout(2) + s.connect((self.__host, self.__port)) + s.settimeout(10) + + self.__connected = True + DEBUG('connected.') + except: + DEBUG('connection to %s:%i failed' % (self.__host, self.__port)) + self.__connected = False + self.__allinverters = False + + + # Utility-functions + def hexval(self, i): + return (hex(i)[2:]).upper() + + + def checksum(self, s): + total = 0 + for c in s: + total += ord(c) + h = self.hexval(total) + while len(h) < 4: + h = '0'+h + return h + + def __read_char(self): + byte = self.__socket.recv(1) + if len(byte) > 0: + return ord(byte) & 0x7F + return 0 + + def __receive(self): + try: + data = [] + while True: + c = self.__read_char() + if c: + data.append(chr(c)) + if not c or chr(c) == '}': + break + return ''.join(data) + + except: + self.__allinverters = False + return '' + + + def __parse(self, answer): + # convenience checks + if answer[0] != '{' or answer[-1] != '}': + raise ValueError('malformed answer: %s' % answer) + raw_answer = answer + answer = answer[1:-1] + checksum = answer[-4:] + content = answer[:-4] + # checksum + if checksum != self.checksum(content): + raise ValueError('checksum error') + + (header, content) = content[:-1].split('|', 2) + (inverter, fb, length) = header.split(';', 3) + if fb != 'FB': + raise ValueError('answer not understood') + # length + length = int(length, 16) + if length != len(raw_answer): + raise ValueError('length mismatch') + + inverter = int(inverter) + + # Bei schreibzugriff antwortet der WR mit 'C8' + # Avec un accès en écriture, le WR répond par 'C8' + #if not content.startswith('64:'): + # raise ValueError('Inverter did not understand our query') + + content = content[3:] + data = {} + + for item in content.split(';'): + (key, value) = item.split('=') + if key not in query_types: + raise NotImplementedError("Don't know %s" % item) + data[key] = value + return (inverter, data) + + + def __build_query(self, idn, values, qtype=100): + qtype = self.hexval(qtype) + if type(values) == list: + for v in values: + if v not in query_types: + raise ValueError('Unknown data type »'+v+'«') + values = ';'.join(values) + + #elif type(values) in [str, unicode]: + elif type(values) in [str,]: + pass + else: + raise ValueError('value has unsupported type') + + querystring = '|' + qtype + ':' + values + '|' + # Länge vergrößern um: 2 x { (2), WR-Nummer (2), "FB" (2), zwei Semikolon (2), Länge selbst (2), checksumme (4) + # Augmentez la longueur de : 2 x { (2), le numéro WR (2), "FB" (2), deux points-virgules (2), la longueur elle-même (2), la somme de contrôle (4) + l = len(querystring) + 2 + 2 + 2 + 2 +2 + 4 + querystring = 'FB;%02i;%s%s' % (int(idn), self.hexval(l), querystring) + querystring += self.checksum(querystring) + return '{%s}' % querystring + + + def __send_query(self, querystring): + try: + DEBUG(self.__host, '=>', querystring) + #self.__socket.send(querystring) + self.__socket.send(querystring.encode()) + except socket.timeout: + self.__allinverters = False + self.__connected = False + + + def query(self, idn, values, qtype=100): + q = self.__build_query(idn, values, qtype) + DEBUG("WR %i: %s" % (idn, q)) + + self.__send_query(q) + answer = self.__receive() + + if answer: + (inverter, data) = self.__parse(answer) + for d in data.keys(): + data[d] = self.normalize_value(d, data[d]) + return (inverter, data) + else: + self.__allinverters = False + + if not self.__allinverters and not self.__detection_running: + self.detect_inverters() + elif not self.__connected: + self.__connect() + else: + raise socket.timeout + return None + + + def normalize_value(self, key, value): + if key in [ 'KDY', 'UL1', 'UDC']: + return float(int(value, 16)/10) + + elif key in [ 'IL1', 'IDC', 'TNF', ]: + return float(int(value, 16)/100) + + elif key in [ 'PAC', 'PIN', ]: + return float(int(value, 16)/2) + + elif key in [ 'SAL', ]: + return int(value, 16) + + elif key in [ 'SYS', ]: + (x,y) = value.split(',',2) + x = int(x, 16) + y = int(y, 16) + return (x,y) + + elif key in [ 'SDAT', 'FDAT' ]: + (date, time) = value.split(',',2) + time = int(time, 16) + return datetime.datetime(int(date[:3], 16), int(date[3:5], 16), int(date[5:], 16), time//3600, (time % 3600) // 60, time % (3600*60)) + else: + return int(value, 16) + + + def write_setting(self, inverter, data): + rawdata = [] + for key,value in data.iteritems(): + key = key.upper() + if key not in query_types: + raise ValueError('unknown type') + value = self.hexval(value) + rawdata.append('%s=%s' % (key, value)) + + DEBUG(self.query(inverter, ';'.join(rawdata), 200)) + + + def status(self, inverter): + result = self.query(inverter, ['SYS', 'SAL']) + if not result: + return ('Offline', 'Offline') + + result = result[1] + errors = [] + if result['SAL'] > 0: + for (code, descr) in alarm_codes.iteritems(): + if code & result['SAL']: + errors.append(descr) + + status = status_codes[result['SYS'][0]] + + return (status, ', '.join(errors)) + + + def use_inverters(self, list_of): + self.__inverter_list = list_of + self.detect_inverters() + + + def detect_inverters(self): + self.__inverters = {} + if not self.__connected: + self.__connect() + + self.__detection_running = True + for inverter in self.__inverter_list: + try: + DEBUG('searching for #%i (socket: %s)' % (inverter, self.__socket)) + (inverter, data) = self.query(inverter, [ 'ADR', 'TYP', 'PIN' ]) + + if data['TYP'] in inverter_types.keys(): + self.__inverters[inverter] = inverter_types[data['TYP']].copy() + self.__inverters[inverter]['installed'] = data['PIN'] + else: + DEBUG('Unknown inverter type: %s (ID #%i)' % (data['TYP'], data['ADR'])) + + except Exception as e: + DEBUG('Inverter #%i not found: %s' % (inverter, e)) + + self.__allinverters = False + + self.__detection_running = False + + if len(self.__inverters) == len(self.__inverter_list): + self.__allinverters = True + DEBUG('found all inverters:') + DEBUG(self.__inverters) + else: + DEBUG('not all invertes found, reconnection!') + self.__connect() + + + def inverters(self): + if not self.__allinverters: + self.detect_inverters() + return self.__inverters + + + + diff --git a/solarmax/config_example.yaml b/solarmax/config_example.yaml new file mode 100644 index 0000000..ce4a057 --- /dev/null +++ b/solarmax/config_example.yaml @@ -0,0 +1,19 @@ +mqtt: + ca_cert: null + clean_session: true + host: 192.168.1.x + keepalive: 60 + password: xxxx + port: 1883 + reconnect_timeout: 5 + use_ssl: null + username: xxxx +solarmax: + inverters: + 192.168.1.123: + - 1 + ip: 192.168.1.4 + loop_timeout: 5 + origine: automation + topic_base: + uuid: diff --git a/solarmax/contrib/__init__.py b/solarmax/contrib/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/solarmax/contrib/mqttc.py b/solarmax/contrib/mqttc.py new file mode 100644 index 0000000..280f90b --- /dev/null +++ b/solarmax/contrib/mqttc.py @@ -0,0 +1,149 @@ +# +# mqtt service +# +import json, time, logging, ssl +import paho.mqtt.client as mqtt + +logging.basicConfig(level=logging.INFO) +logger = logging.getLogger(__name__) + + +class MqttBase(object): + def __init__(self, **p): + super().__init__() + self.host = p.get('host') + self.port = p.get('port') + self.username = p.get('username') + self.password = p.get('password') + self.keepalive = p.get('keepalive') + self.use_ssl = p.get('use_ssl', False) + self.ca_cert = p.get('ca_cert') + self.tls_version = p.get('tls_version', ssl.PROTOCOL_TLSv1_2) + self.subscriptions = [(topic, qos) for topic, qos in p.get('topic_subs', [])] + self.unsubs = self.client_get_unsubs() + self.topic_base = p.get('topic_base', '') + + self.on_message_callback = p.get('on_messages', self._on_message_callback) + self.on_bytes_callback = p.get('on_bytes', self._on_bytes_callback) + # mqtt Client + self.client = mqtt.Client() + if self.username: + self.client.username_pw_set(username=self.username, password=self.password) + if self.use_ssl and self.ca_cert: + self.client.tls_set(ca_certs=self.ca_cert, tls_version=self.tls_version) + + self.client.on_connect = self._on_connect + self.client.on_disconnect = self._on_disconnect + self.client.on_message = self._on_message + self.client.on_log = self._on_log + + def client_get_unsubs(self): + return [topic for topic, _ in self.subscriptions ] + + + def client_set_subscriptions(self): + self.client.unsubscribe(self.client_get_unsubs()) + self.client.subscribe(self.subscriptions) + logger.info(f"\n client_set_subscription {self.subscriptions}") + + + def client_add_subscriptions(self, subs=[]): + self.subscriptions += subs + self.subscriptions = list(set(self.subscriptions)) + + + def _publish_message(self, topic, **payload): + try: + qos = payload.pop('qos', 0) + retain = payload.pop('retain', False) + message = json.dumps(payload) + self.client.publish(topic, payload=message.encode('utf-8'), qos=qos, retain=retain) + except Exception as e: + logger.error(e) + + + def _publish_bytes(self, topic, payload, **conf): + try: + qos = conf.pop('qos', 0) + retain = conf.pop('retain', False) + self.client.publish(topic, payload=payload, qos=qos, retain=retain) + except Exception as e: + logger.error(f"\n _publish_bytes error: {e}") + + + def _on_log(self, mqttc, obj, level, string): # @UnusedVariable + pass + + + def _on_connect_info(self, info): + logger.info(info) + + + def _on_connect(self, client, userdata, flags, rc): + msg = f"\n {client._client_id} connected\n status {rc}\n host={self.host}:{self.port}\n username={self.username}" + try: + if rc: + raise + self.client_set_subscriptions() + self._on_connect_info(msg) + except Exception as e: + logger.error(f"\n _on_connect error {e}") + + + def _on_disconnect(self, client, userdata, rc): + logger.info(f"\n Disconnected: {client._client_id} with status {rc}") + try: + j = 3 + for i in range(j): + #client.unsubscribe(self.unsubs) + try: + client.reconnect() + break + except Exception as e: + if i < j: + logger.warn(e) + time.sleep(1) + continue + else: + raise + except Exception as e: + logger.error(f"\n _on_disconnect error {e}") + + + def _on_stop_mqtt(self): + pass + + + def _on_message_callback(self, topic, payload): + pass + + + def _on_bytes_callback(self, topic, payload): + pass + + + def _on_message(self, client, userdata, message): + try: + try: + payload = json.loads(message.payload.decode("utf-8")) + self.on_message_callback(message.topic, payload) + except: + self.on_bytes_callback(message.topic, message.payload) + + except Exception as e: + logger.error(f"\n _on_message error {e}\n {message.topic} {message.payload[:80]}") + + + def connectMQTT(self): + self.client.connect_async(self.host, self.port, self.keepalive) + + + def startMQTT(self): + self.connectMQTT() + self.client.loop_forever() + + + def stopMQTT(self): + self._on_stop_mqtt() + self.client.disconnect() + diff --git a/solarmax/contrib/utils.py b/solarmax/contrib/utils.py new file mode 100644 index 0000000..7768d6d --- /dev/null +++ b/solarmax/contrib/utils.py @@ -0,0 +1,138 @@ +''' +Created on 20 avr. 2022 + +@author: denis +''' +import json, yaml +import importlib +from datetime import datetime +from decimal import Decimal +import string, secrets +import uuid, socket + + +class TopicBase: + topickeys = {} + + def __init__(self, topics): + self.topics = topics.split('/') or [] + + def get(self, k): + try: + return self.topics[self.topickeys.get(k)] + except: + pass + return None + + @classmethod + def arg(cls, topic, k): + topics = topic.split('/') or [] + return topics[cls.get(k)] + + + +def yaml_load(f): + with open(f, 'r') as stream: + return yaml.safe_load(stream) + return {} + + +def yaml_save(f, context): + with open(f, 'w') as stream: + yaml.dump(context, stream, default_flow_style = False) + + + +def bitread(b, bitpos): + return (b>>bitpos) & 0x1 + + +def get_fqdn(): + return socket.getfqdn() + + +def get_uuid(): + return str(hex(uuid.getnode()))[2:] + + +def ts_now(m=1): + now = datetime.now().timestamp()*m + return int(now) + + +def random_num(n=16): + alphabet = string.digits + return ''.join(secrets.choice(alphabet) for i in range(n)) # @UnusedVariable + +def random_chars(n=6): + alphabet = string.ascii_letters + string.digits + return ''.join(secrets.choice(alphabet) for i in range(n)) # @UnusedVariable + + +def get_apikey(n=32): + chars = 'abcdefgh01234ijklABCD4567EFGHIJKLmnopqrstuvwxyz0123456789MNOPQRS789TUVWXYZ' + return ''.join(secrets.choice(chars) for i in range(n)) # @UnusedVariable + + +def str_to_float(n, default='NaN'): + try: + return float(str(n).strip().replace(',', '.')) + except: + return default + +def str_to_int(n, default='NaN'): + try: + return int(str(n).strip()) + except: + return default + +def gps_conv(s, n=1000000, default='NaN'): + try: + return str( int(Decimal(s)*n) ) + except: + return default + + +def conv_gps(v, default=None): + try: + if v == 'NaN': + raise + return float(Decimal(v)/1000000) + except: + return default + + +def js_serialize_array_to_dict(jsarray): + d = {} + for f in json.loads(jsarray): + name = f.get('name') + value = f.get('value') + if name: + d[name] = value + return d + + +def get_instance_class(module): + modulename, classname = module.rsplit(".", 1) + return getattr(importlib.import_module(modulename), classname) + + +def gen_keywords(s): + c = s.replace(',', ' ').replace('+', ' ') + return [ w.strip() for w in c.split(' ') if w] + + +def gen_device_uuid(n=19): + return hex(int(random_num(n)))[2:] + +def get_device_uuid(n=19): + return f'0x{gen_device_uuid(n)}' + +def dimensions(s): + w, h = s.split('x') + return int(w), int(h) + + +def dim_to_size(w, h): + return f'{w}x{h}' + diff --git a/solarmax/solarmaxd.py b/solarmax/solarmaxd.py new file mode 100755 index 0000000..37d7bd7 --- /dev/null +++ b/solarmax/solarmaxd.py @@ -0,0 +1,233 @@ +#!../.venv/bin/python +##!/opt/lib/python/venv_app/bin/python +''' +Created on 7 nov. 2023 + +@author: denis +''' +import threading, logging, argparse +from SolarMax.solarmax_fr import SolarMax, get_status_code +from contrib.mqttc import MqttBase +from contrib import utils + + +logging.basicConfig(level=logging.INFO) +logger = logging.getLogger(__name__) + + +INVERTERS = { + '192.168.1.123': [1,], + #'192.168.0.202': [2,], + #'192.168.0.203': [3,], + #'192.168.0.204': [4,], +} + +ACCESS = [ + (1, "Pub only"), + (2, "/set only"), + (5, "/get, pub"), + (7, "/get, /set, pub"), +] + +class SolarmaxMqttWorker(MqttBase): + + def __init__(self, parent=None, **p): + super().__init__(**p) + self.parent = parent + + def makeReport(self): + data = dict( + name = 'Onduleur Solarmax', + uuid = self.parent.uuid, + sensor = 'solarmax', + vendor = 'Solarmax', + model_id = 'SM2000S', + description = "Onduleur Solarmax SM2000S, 1980 W", + ip = self.parent.ip, + org = self.parent.org, + datas = [ + {"access":1,"description":"Linux timestamp en secondes","label":"Timestamp","name":"time","property":"time","type":"numeric","unit":"s"}, + {"access":1,"description":"Numéro d'onduleur","label":"Inverter","name":"inv","property":"range","type":"numeric","unit":""}, + {"access":1,"description":"Intensité max","label":"Ivmax","name":"ivmax","property":"intensity","type":"numeric","unit":"A"}, + {"access":1,"description":"Production AC","label":"PAC","name":"pac","property":"power","type":"numeric","unit":"W"}, + {"access":1,"description":"Rendement AC","label":"Eac","name":"eac","property":"efficiency","type":"numeric","unit":""}, + {"access":1,"description":"Production DC.","label":"PDC","name":"pdc","property":"power","type":"numeric","unit":"W"}, + {"access":1,"description":"Efficacity DC","label":"Edc","name":"edc","property":"efficiency","type":"numeric","unit":""}, + {"access":1,"description":"Production du jour","label":"Qday","name":"qdy","property":"days","type":"numeric","unit":"kWh"}, + {"access":1,"description":"Production totale","label":"Qtotal","name":"qt0","property":"days","type":"numeric","unit":"kWh"}, + {"access":1,"description":"Status onduleur","label":"Status","name":"stat","property":"state","type":"text","unit":""}, + {"access":1,"description":"Température des panneaux","label":"Temperature","name":"tmpr","property":"temperature","type":"numeric","unit":"°C"}, + ], + ) + return data + + + def publish_to_client(self, evt, **payload): + #logger.info(f"{self.topic_base}/{utils.ts_now()}/{evt}\n{payload}") + self._publish_message(f'{self.topic_base}/{evt}', **payload) + + + def _on_stop_mqtt(self): + self.publish_to_client('stop', alive=False) + logger.info(f'WAITING 1s for last message') + threading.Event().wait(1) + + + def _on_connect_info(self, info): + logger.info(f"{info}\n subs: {self.subscriptions}") + self.publish_to_client('report', retain=True, **self.makeReport()) + + + def _on_message_callback(self, topic, payload): + try: + pass + #if topic.endswith('registry'): + # self.publish_to_client('report', **self.makeReport()) + + except Exception as e: + logger.error(e) + + +class SolarmaxDaemon(): + + def __init__(self, conf_file, **settings): + super().__init__() + self.conf_file = conf_file + self.settings = settings + topic_subs = self.settings['solarmax']['topic_subs'] + topic_base = self.settings['solarmax']['topic_base'] + inverters = self.settings['solarmax']['inverters'] + self.timeout = self.settings['solarmax']['loop_timeout'] + self.uuid = hex(self.settings['solarmax']['uuid']) + self.ip = self.settings['solarmax']['ip'] + self.org = self.settings['solarmax']['origine'] + self.solar_stop = threading.Event() + + self.smlist = [] + for host in inverters.keys(): + sm = SolarMax(host, 12345) + sm.use_inverters(inverters[host]) + self.smlist.append(sm) + + self.allinverters = [] + for host in inverters.keys(): + self.allinverters.extend(inverters[host]) + + self.inverters_size = len(self.allinverters) + self.mqtt = SolarmaxMqttWorker(parent=self, topic_base=topic_base ,topic_subs=topic_subs, **settings['mqtt']) + self.mqtt.connectMQTT() + + + def start(self): + self.mqtt.client.loop_start() + self.run_forever() + + + def stop(self): + self.mqtt.client.loop_stop() + self.solar_stop.set() + + + def run_forever(self): + logger.info(f'Module SolarmaxDaemon::run_forever is started') + while not self.solar_stop.is_set(): + try: + count = 0 + for sm in self.smlist: + for (no, ivdata) in sm.inverters().items(): + try: + (inverter, current) = sm.query(no, ['PAC', 'TKK', 'KDY', 'KT0', 'IDC', 'UDC', 'IL1', 'UL1', 'FDAT', 'SYS']) + count += 1 + except: + logger.info(f'Erreur de communication, éventuellement onduleur éteint, WR {no}') + threading.Event().wait(self.timeout) + continue + ivmax = ivdata['installed'] + ivname = ivdata['desc'] + UAC = current['UL1'] + IAC = current['IL1'] + PAC = UAC * IAC + IDC = current['IDC'] + UDC = current['UDC'] + tmpr = current['TKK'] + eac = int((PAC/ivmax) * 100) # rendement AC + PDC = UDC * IDC + edc = int((float(PAC)/PDC) * 100) # efficacity DC + + (status, errors) = sm.status(no) + if errors: + logger.error(f'WR {no}: {status} ({errors})') + continue + + logger.debug( +f''' + Onduleur..............: n° {inverter} ({ivname}) + Status................: {status} + Température panneaux..: {tmpr} °C + Tension CC............: {UDC} V + Intensité CC..........: {IDC} A + Tension AC............: {UAC} V + Intensité AC..........: {IAC} A + Production AC.........: {current['PAC']:9.1f} Watt / calculée: {PAC:9.1f} W rendement: ({eac}% de {ivmax} Watt) + Production DC.........: {PDC:9.1f} Watt (Efficacité: {edc}%) + Total aujourd'hui.....: {current['KDY']:9.1f} kWh + Total jusqu'à présent.: {current['KT0']:9.1f} kWh (depuis le {current['FDAT'].date()}) +''' + ) + if count < self.inverters_size: + raise Exception(f"({count} < {self.inverters_size} => Erreur de communication, éventuellement onduleur éteint") + + payload = dict( + time=utils.ts_now(), + inv=inverter, + ivmax=ivmax, + tmpr=tmpr, + pac=round(PAC, 1), + eac=eac, + pdc=round(PDC, 1), + edc=edc, + qdy=current['KDY'], + qt0=current['KT0'], + stat=get_status_code(status), + ) + self.mqtt.publish_to_client('production', **payload) + except Exception as e: + logger.error(e) + threading.Event().wait(self.timeout) + + +def load_configuration(conf_file): + settings = utils.yaml_load(conf_file) + if not settings['solarmax']['uuid']: + uuid = f'0x{utils.gen_device_uuid(19)}' + origine = settings['solarmax']['origine'] + settings['solarmax']['uuid'] = uuid + settings['solarmax']['inverters'] = INVERTERS + settings['solarmax']['topic_base'] = f"{origine}/{uuid}" + settings['solarmax']['topic_subs']= [[f"{origine}/{uuid}/#", 0], ] + utils.yaml_save(conf_file, settings) + return settings + + +def main(conf_file): + daemon = None + try: + config = load_configuration(conf_file) + daemon = SolarmaxDaemon(conf_file, **config) + daemon.start() + + except Exception as e: + print(f'\n SolarmaxDaemon error {e}') + finally: + if daemon: + daemon.stop() + + +if __name__ == '__main__': + parser = argparse.ArgumentParser(description="Solarmax device") + parser.add_argument("--config", default='config.yaml', help="Config yaml file path", required=False) + args = parser.parse_args() + if args.config: + main(args.config) + +