Compare commits
7 Commits
93f77776e0
...
9ec91e2575
Author | SHA1 | Date | |
---|---|---|---|
9ec91e2575 | |||
071d9741af | |||
71c62845d8 | |||
bd6b57d1ed | |||
a804818792 | |||
418fd48a25 | |||
8b436c70d2 |
1
.gitignore
vendored
Normal file
1
.gitignore
vendored
Normal file
@ -0,0 +1 @@
|
||||
__pycache__
|
674
LICENSE
Normal file
674
LICENSE
Normal file
@ -0,0 +1,674 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
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:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
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
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
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
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
29
README.md
29
README.md
@ -1,10 +1,29 @@
|
||||
# SolarEdge Cloud API Exporter
|
||||
# SolarEdge Inverter Exporter
|
||||
|
||||
## Configuration
|
||||
## Local Modbus/TCP Exporter
|
||||
|
||||
Edit the script and put your API key, site id and inverter serial number
|
||||
Usage:
|
||||
```
|
||||
solaredge_modbus.py [-d] [-l LISTEN] [-p PORT] HOST [PORT]
|
||||
|
||||
Prometheus exporter for SolarEdge inverters
|
||||
|
||||
positional arguments:
|
||||
HOST Inverter Network Address
|
||||
PORT Inverter Modbus/TCP port (default: 1502)
|
||||
|
||||
options:
|
||||
-h, --help show this help message and exit
|
||||
-d, --debug Enable debug info in HTTP answers (default: False)
|
||||
-l LISTEN, --listen LISTEN
|
||||
Address to bind for the HTTP server (default: localhost)
|
||||
-p PORT, --listen-port PORT
|
||||
Port of the HTTP server (default: 9150)
|
||||
```
|
||||
|
||||
## Cloud API Exporter
|
||||
|
||||
Edit the `solaredge_api` script and put your API key, site id and inverter serial number
|
||||
Edit the listening host and port if needed
|
||||
|
||||
## Usage
|
||||
|
||||
Run the script as a service, add the URL to prometheus.
|
||||
|
1
dashboard/README.md
Normal file
1
dashboard/README.md
Normal file
@ -0,0 +1 @@
|
||||
Grafana dashboard configuration compatible with this exporter
|
1645
dashboard/solar.json
Normal file
1645
dashboard/solar.json
Normal file
File diff suppressed because it is too large
Load Diff
57
prom.py
Executable file
57
prom.py
Executable file
@ -0,0 +1,57 @@
|
||||
#!/usr/bin/python3
|
||||
|
||||
import bottle
|
||||
import datetime
|
||||
import logging
|
||||
from collections import defaultdict
|
||||
from sys import stderr
|
||||
|
||||
|
||||
def format_metrics(metric_data, entries, timestamps=False):
|
||||
""" metric_data = { 'metric_name' : ('gauge'|'counter', 'description')
|
||||
entries = [ (datetime, 'metric_name', { 'attr': 'key' }, value) ]
|
||||
"""
|
||||
|
||||
collected = defaultdict(list)
|
||||
for entry in entries:
|
||||
collected[entry[1]].append(entry)
|
||||
|
||||
for metric in collected:
|
||||
md = metric_data.get(metric)
|
||||
if md is not None:
|
||||
yield "# TYPE {} {}\n".format(metric, md[0])
|
||||
yield "# HELP {} {}\n".format(metric, md[1])
|
||||
|
||||
for (time, metric, attrs, value) in collected[metric]:
|
||||
time_s = int(time.timestamp() * 1000)
|
||||
attr_s = ""
|
||||
if attrs:
|
||||
attr_s = "{" + ','.join('{}="{}"'.format(k, attrs[k]) for k in attrs ) + "}"
|
||||
if timestamps:
|
||||
yield f"{metric} {attr_s} {value} {time_s}\n"
|
||||
else:
|
||||
yield f"{metric} {attr_s} {value}\n"
|
||||
|
||||
def run(collect, metric_data, description='Mini Prometheus Exporter',
|
||||
host='localhost', port=9150, timestamps=False, debug=False):
|
||||
|
||||
@bottle.route('/')
|
||||
def root():
|
||||
return description
|
||||
|
||||
@bottle.route('/metrics')
|
||||
def metrics():
|
||||
return format_metrics(metric_data, collect(), timestamps)
|
||||
|
||||
bottle.run(host=host, port=port, debug=debug)
|
||||
|
||||
if __name__ == "__main__":
|
||||
def collect_dummy():
|
||||
now = datetime.datetime.now()
|
||||
yield (now, 'pi', {'one': '1', 'two': '2' }, 3.14)
|
||||
yield (now, 'e', {'three': '3'}, 2.72)
|
||||
|
||||
metric_data = { 'pi': ['gauge', 'Pi value'],
|
||||
'e': ['counter', 'E counter'] }
|
||||
|
||||
run(collect_dummy, metric_data, port=9159)
|
11
solaredge.py
11
solaredge.py
@ -7,7 +7,7 @@ import requests
|
||||
from collections import defaultdict
|
||||
from sys import stderr
|
||||
|
||||
api_key = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
|
||||
api_key = "ZYR991B0ZO9S530WW21B0RRNYBJGO482"
|
||||
site_id = 4143190
|
||||
|
||||
inverter = '7B0E5700-E0'
|
||||
@ -78,13 +78,16 @@ def get_inverters():
|
||||
def energy(**kw):
|
||||
return get(f"site/{site_id}/energyDetails.json",
|
||||
kw | {"timeUnit": "QUARTER_OF_AN_HOUR"})
|
||||
11
|
||||
|
||||
def tech_data(**kw):
|
||||
return get(f"equipment/{site_id}/{inverter}/data.json", kw)
|
||||
return get(f"equipment/{site_id}/{inverter}/data.json", kw | {"timeUnit": "QUARTER_OF_AN_HOUR"})
|
||||
|
||||
def meters(**kw):
|
||||
return get(f"site/{site_id}/meters.json", kw | {"timeUnit": "QUARTER_OF_AN_HOUR"})
|
||||
|
||||
def flow(**kw):
|
||||
return get(f"site/{site_id}/currentPowerFlow.json", kw)
|
||||
|
||||
def latest(method, timefn, **kw):
|
||||
name = method.__name__
|
||||
if name in cache and is_fresh(timefn(cache[name])):
|
||||
@ -131,6 +134,8 @@ def collect():
|
||||
yield (date, 'ac_active_power_watts', {'phase': p[1:2] }, phase.get('activePower'))
|
||||
yield (date, 'ac_reactive_power_watts', {'phase': p[1:2] }, phase.get('reactivePower'))
|
||||
yield (date, 'ac_cos_phi', {'phase': p[1:2] }, phase.get('cosPhi'))
|
||||
else:
|
||||
yield (datetime.datetime.now(), 'inverter_mode', {}, 1)
|
||||
|
||||
for m in ms:
|
||||
point = m['values'][-1]
|
||||
|
182
solaredge_api.py
Executable file
182
solaredge_api.py
Executable file
@ -0,0 +1,182 @@
|
||||
#!/usr/bin/python3
|
||||
|
||||
import bottle
|
||||
import datetime
|
||||
import logging
|
||||
import requests
|
||||
from collections import defaultdict
|
||||
from sys import stderr
|
||||
|
||||
api_key = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
|
||||
site_id = 4143190
|
||||
|
||||
inverter = '7B0E5700-E0'
|
||||
|
||||
listen = 'localhost'
|
||||
port = 9150
|
||||
|
||||
endpoint = "https://monitoringapi.solaredge.com/"
|
||||
|
||||
query_delta = datetime.timedelta(minutes=20)
|
||||
freshness_delta = datetime.timedelta(minutes=20)
|
||||
cache = {}
|
||||
|
||||
numeric_modes = {
|
||||
'OFF': 0,
|
||||
'SLEEPING': 1,
|
||||
'STARTING': 2,
|
||||
'MPPT': 3,
|
||||
'SHUTTING_DOWN': 4,
|
||||
'FAULT': 5,
|
||||
'STANDBY': 6,
|
||||
'LOCKED': 7,
|
||||
}
|
||||
|
||||
metric_data = {
|
||||
"dc_voltage_volts": ["gauge", "Input bus voltage"],
|
||||
"meter_energy_watthours_total": ["counter", "Power meter"],
|
||||
"temperature_celsius": ["gauge", "Temperature"],
|
||||
"inverter_mode": ["gauge", "Inverter state (0=off, 3=producing, 5=fault)"],
|
||||
"ac_phase_volts": ["gauge", "Output bus phase voltage"],
|
||||
"ac_current_amps": ["gauge", "Output bus current"],
|
||||
"ac_voltage_volts": ["gauge", "Output bus voltage"],
|
||||
'ac_frequency_hertz': ["gauge", "Output bus frequency"],
|
||||
'ac_apparent_power_watts': ["gauge", "Apparent AC power"],
|
||||
'ac_active_power_watts': ["gauge", "Active AC power"],
|
||||
'ac_reactive_power_watts': ["gauge", "Reactive AC power"],
|
||||
'ac_cos_phi': ["gauge", "AC Phase factor"]
|
||||
}
|
||||
|
||||
last_ts = {}
|
||||
|
||||
def is_fresh(date):
|
||||
return (datetime.datetime.now()) - date < freshness_delta
|
||||
|
||||
def numeric_mode(s):
|
||||
if s in numeric_modes:
|
||||
return numeric_modes[s]
|
||||
if s.startswith('LOCKED'):
|
||||
return 7
|
||||
|
||||
def time(t):
|
||||
return t.strftime("%F %T")
|
||||
|
||||
def ptime(s):
|
||||
return datetime.datetime.strptime(s, "%Y-%m-%d %H:%M:%S")
|
||||
|
||||
def get(path, params={}, **kw):
|
||||
r = requests.get(endpoint + path, params | { "api_key": api_key }, **kw)
|
||||
r.raise_for_status()
|
||||
return r.json() | { 'fetch_time': datetime.datetime.now().timestamp() }
|
||||
|
||||
def details():
|
||||
return get(f"site/{site_id}/details.json")
|
||||
|
||||
def inventory():
|
||||
return get(f"site/{site_id}/inventory.json")
|
||||
|
||||
def get_inverters():
|
||||
return [ i['SN'] for i in inventory()['Inventory']['inverters'] ]
|
||||
|
||||
def energy(**kw):
|
||||
return get(f"site/{site_id}/energyDetails.json",
|
||||
kw | {"timeUnit": "QUARTER_OF_AN_HOUR"})
|
||||
|
||||
def tech_data(**kw):
|
||||
return get(f"equipment/{site_id}/{inverter}/data.json", kw | {"timeUnit": "QUARTER_OF_AN_HOUR"})
|
||||
|
||||
def meters(**kw):
|
||||
return get(f"site/{site_id}/meters.json", kw | {"timeUnit": "QUARTER_OF_AN_HOUR"})
|
||||
|
||||
def flow(**kw):
|
||||
return get(f"site/{site_id}/currentPowerFlow.json", kw)
|
||||
|
||||
def latest(method, timefn, **kw):
|
||||
name = method.__name__
|
||||
if name in cache and is_fresh(timefn(cache[name])):
|
||||
logging.info("Cache for {} is fresh", method.__name__)
|
||||
return cache[name]
|
||||
|
||||
logging.info("Cache for {} is stale, requesting", method.__name__)
|
||||
end = datetime.datetime.now()
|
||||
start = end - query_delta
|
||||
data = method(startTime=time(start), endTime=time(end), **kw)
|
||||
cache[name] = data
|
||||
return data
|
||||
|
||||
def tech_check(c):
|
||||
if c['data']['telemetries']:
|
||||
return ptime(c['data']['telemetries'][-1]['date'])
|
||||
else:
|
||||
return datetime.datetime.fromtimestamp(c['fetch_time'])
|
||||
|
||||
|
||||
def meters_check(c):
|
||||
return ptime(c['meterEnergyDetails']['meters'][0]['values'][-1]['date'])
|
||||
|
||||
def collect():
|
||||
tech = latest(tech_data, tech_check)['data']['telemetries']
|
||||
ms = latest(meters, meters_check)['meterEnergyDetails']['meters']
|
||||
if len(tech):
|
||||
point = tech[-1]
|
||||
date = ptime(point['date'])
|
||||
yield (date, 'dc_voltage_volts', {}, point.get('dcVoltage'))
|
||||
yield (date, 'meter_energy_watthours_total', {'meter': 'production'}, point.get('totalEnergy'))
|
||||
yield (date, 'temperature_celsius', {}, point.get('temperature'))
|
||||
yield (date, 'inverter_mode', {}, numeric_mode(point.get('inverterMode')))
|
||||
yield (date, 'ac_phase_volts', {'phase':'1-2'}, point.get('vL1To2'))
|
||||
yield (date, 'ac_phase_volts', {'phase':'2-3'}, point.get('vL2To3'))
|
||||
yield (date, 'ac_phase_volts', {'phase':'3-1'}, point.get('vL3To1'))
|
||||
|
||||
for p in ('L1Data','L2Data','L3Data'):
|
||||
phase = point[p]
|
||||
yield (date, 'ac_current_amps', {'phase': p[1:2] }, phase.get('acCurrent'))
|
||||
yield (date, 'ac_voltage_volts', {'phase': p[1:2] }, phase.get('acVoltage'))
|
||||
yield (date, 'ac_frequency_hertz', {'phase': p[1:2] }, phase.get('acFrequency'))
|
||||
yield (date, 'ac_apparent_power_watts', {'phase': p[1:2] }, phase.get('apparentPower'))
|
||||
yield (date, 'ac_active_power_watts', {'phase': p[1:2] }, phase.get('activePower'))
|
||||
yield (date, 'ac_reactive_power_watts', {'phase': p[1:2] }, phase.get('reactivePower'))
|
||||
yield (date, 'ac_cos_phi', {'phase': p[1:2] }, phase.get('cosPhi'))
|
||||
else:
|
||||
yield (datetime.datetime.now(), 'inverter_mode', {}, 1)
|
||||
|
||||
for m in ms:
|
||||
point = m['values'][-1]
|
||||
date = ptime(point['date'])
|
||||
yield (date, 'meter_energy_watthours_total', {'meter': m['meterType'].lower()}, point['value'])
|
||||
|
||||
def format_metrics(entries, timestamps=False):
|
||||
collected = defaultdict(list)
|
||||
for entry in entries:
|
||||
collected[entry[1]].append(entry)
|
||||
|
||||
for metric in collected:
|
||||
md = metric_data.get(metric)
|
||||
if md is not None:
|
||||
yield "# TYPE {} {}\n".format(metric, md[0])
|
||||
yield "# HELP {} {}\n".format(metric, md[1])
|
||||
|
||||
for (time, metric, attrs, value) in collected[metric]:
|
||||
time_s = int(time.timestamp() * 1000)
|
||||
attr_s = ""
|
||||
if attrs:
|
||||
attr_s = "{" + ','.join('{}="{}"'.format(k, attrs[k]) for k in attrs ) + "}"
|
||||
if timestamps:
|
||||
yield f"{metric} {attr_s} {value} {time_s}\n"
|
||||
else:
|
||||
yield f"{metric} {attr_s} {value}\n"
|
||||
|
||||
@bottle.route('/')
|
||||
def root():
|
||||
return "SolarEdge prometheus exporter"
|
||||
|
||||
@bottle.route('/metrics')
|
||||
def metrics():
|
||||
return format_metrics(collect())
|
||||
|
||||
def main():
|
||||
bottle.run(host=listen, port=port)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
93
solaredge_modbus.py
Normal file
93
solaredge_modbus.py
Normal file
@ -0,0 +1,93 @@
|
||||
#!/usr/bin/env python3
|
||||
|
||||
import argparse
|
||||
import datetime
|
||||
import prom
|
||||
import sunspec
|
||||
|
||||
metric_data = {
|
||||
"dc_voltage_volts": ["gauge", "Input bus voltage"],
|
||||
"dc_current_amps": ["gauge", "Input bus current"],
|
||||
"dc_power_watts": ["gauge", "Input bus power"],
|
||||
"energy_watthours_total": ["counter", "Power meter total"],
|
||||
"temperature_celsius": ["gauge", "Temperature"],
|
||||
"inverter_status": ["gauge", "Inverter state (0=off, 3=producing, 5=fault)"],
|
||||
"inverter_status_vendor": ["gauge", "Inverter vendor-specific fault code"],
|
||||
"ac_current_amps": ["gauge", "Output bus current"],
|
||||
"ac_voltage_volts": ["gauge", "Output bus voltage"],
|
||||
'ac_frequency_hertz': ["gauge", "Output bus frequency"],
|
||||
'ac_power_watts': ["gauge", "Active/Reactive/Apparent AC power"],
|
||||
'ac_power_factor': ["gauge", "AC Phase factor"],
|
||||
'meter_event': ["gauge", 'Power meter event']
|
||||
}
|
||||
|
||||
def export(d, m):
|
||||
yield ('dc_voltage_volts', {}, d.dc_voltage)
|
||||
yield ('dc_current_amps', {}, d.dc_current)
|
||||
yield ('dc_power_watts', {}, d.dc_power)
|
||||
yield ('ac_current_amps', {'phase': 'a', 'meter': 'production'}, d.ac_current_a)
|
||||
yield ('ac_current_amps', {'phase': 'b', 'meter': 'production'}, d.ac_current_b)
|
||||
yield ('ac_current_amps', {'phase': 'c', 'meter': 'production'}, d.ac_current_c)
|
||||
yield ('ac_power_watts', {'power': 'active', 'meter': 'production'}, d.ac_power)
|
||||
yield ('ac_power_watts', {'power': 'reactive', 'meter': 'production'}, d.ac_apparent_power)
|
||||
yield ('ac_power_watts', {'power': 'apparent', 'meter': 'production'}, d.ac_reactive_power)
|
||||
yield ('energy_watthours_total', {'meter': 'production'}, d.ac_energy)
|
||||
yield ('ac_voltage_volts', {'phase': 'ab', 'meter': 'production'}, d.ac_voltage_ab)
|
||||
yield ('ac_voltage_volts', {'phase': 'bc', 'meter': 'production'}, d.ac_voltage_bc)
|
||||
yield ('ac_voltage_volts', {'phase': 'ca', 'meter': 'production'}, d.ac_voltage_ca)
|
||||
yield ('ac_frequency_hertz', {'meter': 'production'}, d.frequency)
|
||||
yield ('inverter_status', {}, d.status_code)
|
||||
yield ('inverter_status_vendor', {}, d.status_vendor)
|
||||
|
||||
for phase in ('a','b','c','total'):
|
||||
yield ('ac_current_amps', {'phase': phase, 'meter': 'mains'}, m.ac_current[phase])
|
||||
yield ('ac_power_watts', {'phase': phase, 'meter': 'mains', 'power': 'active'}, m.ac_real_power[phase])
|
||||
yield ('ac_power_watts', {'phase': phase, 'meter': 'mains', 'power': 'reactive'}, m.ac_reactive_power[phase])
|
||||
yield ('ac_power_watts', {'phase': phase, 'meter': 'mains', 'power': 'apparent'}, m.ac_apparent_power[phase])
|
||||
for phase in ('a', 'b', 'c', 'average'):
|
||||
yield ('ac_power_factor', {'phase': phase, 'meter': 'mains'}, m.power_factor[phase])
|
||||
yield ('ac_voltage_volts', {'phase': phase, 'meter': 'mains'}, m.ac_voltage[phase])
|
||||
|
||||
for meter in ('import', 'export'):
|
||||
yield ('energy_watthours_total', {'meter': meter}, m.energy_real[meter])
|
||||
|
||||
yield ('ac_frequency_hertz', {'meter': 'mains'}, m.frequency)
|
||||
for event in m.events:
|
||||
yield ('meter_event', {'event': event}, float(m.events[event]))
|
||||
|
||||
|
||||
|
||||
def main():
|
||||
|
||||
parser = argparse.ArgumentParser(prog='solaredge_modbus.py',
|
||||
description='Prometheus exporter for SolarEdge inverters',
|
||||
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
|
||||
parser.add_argument('-d', '--debug', action='store_true', help="Enable debug info in HTTP answers")
|
||||
parser.add_argument('-l', '--listen', default='localhost', help="Address to bind for the HTTP server")
|
||||
parser.add_argument('-p', '--listen-port', default='9150', help="Port of the HTTP server")
|
||||
parser.add_argument('host', help="Network address of the inverter to monitor")
|
||||
parser.add_argument('port', nargs='?', default=1502, help="Inverter Modbus/TCP port")
|
||||
|
||||
args = parser.parse_args()
|
||||
|
||||
inverter = sunspec.Inverter(host=args.host, port=args.port)
|
||||
|
||||
def collect():
|
||||
date = datetime.datetime.now()
|
||||
|
||||
common = inverter.common_block()
|
||||
inv = inverter.data()
|
||||
meters = inverter.meter(0)
|
||||
|
||||
yield (date, 'firmware_version', {'version': common.version}, 1)
|
||||
for (m,a,v) in export(inv, meters):
|
||||
if v is not None:
|
||||
yield (date,m,a,v)
|
||||
|
||||
|
||||
prom.run(collect, metric_data, 'SolarEdge Modbus/TCP Exporter\n',
|
||||
host=args.bind, port=args.bind_port, debug=args.debug)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
4
solaredge_modbus.sh
Executable file
4
solaredge_modbus.sh
Executable file
@ -0,0 +1,4 @@
|
||||
#!/bin/sh
|
||||
cd $HOME
|
||||
. venv/bin/activate
|
||||
exec python3 solaredge_modbus.py solaredge
|
182
sunspec.py
Normal file
182
sunspec.py
Normal file
@ -0,0 +1,182 @@
|
||||
|
||||
from pymodbus.client import ModbusTcpClient
|
||||
|
||||
class ConnectionFailed(Exception): pass
|
||||
class InvalidAddress(Exception): pass
|
||||
|
||||
class Registers:
|
||||
def __init__(self, lower, count=1):
|
||||
self.count = count
|
||||
self.lower = lower
|
||||
self.range = range(count)
|
||||
|
||||
def check_address(self, address):
|
||||
if address not in self.range:
|
||||
raise InvalidAddress(f"requested {address} for {self.range}")
|
||||
|
||||
def scale(self, value, scale):
|
||||
if scale is None:
|
||||
return value
|
||||
return value * self.read_scale(scale)
|
||||
|
||||
def read_uint16(self, address, scale=None):
|
||||
self.check_address(address)
|
||||
value = self.lower.getRegister(address)
|
||||
return self.scale(value, scale)
|
||||
|
||||
def read_int16(self, address, scale=None):
|
||||
value = self.read_uint16(address)
|
||||
if value & 0x8000:
|
||||
value = value - 0x10000
|
||||
return self.scale(value, scale)
|
||||
|
||||
def read_uint32(self, address, scale=None):
|
||||
value = self.read_uint16(address) * 65536 + self.read_uint16(address + 1)
|
||||
return self.scale(value, scale)
|
||||
|
||||
def read_bytes(self, address, length):
|
||||
string = bytearray(length)
|
||||
for n in range(length//2):
|
||||
nibble = self.read_uint16(address + n)
|
||||
string[2*n] = nibble >> 8
|
||||
string[2*n+1] = nibble & 0xFF
|
||||
return bytes(string).split(b'\x00', 1)[0]
|
||||
|
||||
def read_scale(self, address):
|
||||
return 10 ** self.read_int16(address)
|
||||
|
||||
class Header:
|
||||
def __init__(self, regs, base):
|
||||
self.did = regs.read_uint16(0)
|
||||
self.len = regs.read_uint16(1)
|
||||
self.base = base
|
||||
self.end = base + self.len
|
||||
|
||||
def __str__(self):
|
||||
return f"SunSpec(DID={self.did}, [{self.base}:{self.end}]"
|
||||
|
||||
class CommonBlock:
|
||||
def __init__(self, regs):
|
||||
self.did = regs.read_uint16(0)
|
||||
self.info_len = regs.read_uint16(1)
|
||||
self.manufacturer = regs.read_bytes(2, 32)
|
||||
self.model = regs.read_bytes(18, 32)
|
||||
self.version = '.'.join(s.lstrip('0') for s in regs.read_bytes(42, 16).decode('ascii').split('.'))
|
||||
self.serial = regs.read_bytes(50, 32)
|
||||
self.device = regs.read_uint16(66)
|
||||
|
||||
meter_events_bits = { 2: 'Power Failure',
|
||||
3: 'Under Voltage',
|
||||
4: 'Low PF',
|
||||
5: 'Over Current',
|
||||
6: 'Over Voltage',
|
||||
7: 'Missing Sensor' }
|
||||
|
||||
|
||||
class Meter:
|
||||
def __init__(self, regs):
|
||||
blocks16 = (('ac_current', 0, ('total', 'a', 'b', 'c'), 0.1),
|
||||
('ac_voltage', 5, ('average', 'a', 'b', 'c',
|
||||
'll', 'ab', 'bc', 'ca'), 1),
|
||||
('ac_real_power', 16, ('total', 'a', 'b', 'c'), 0.1),
|
||||
('ac_apparent_power', 21, ('total', 'a', 'b', 'c'), 0.1),
|
||||
('ac_reactive_power', 26, ('total', 'a', 'b', 'c'), 0.1),
|
||||
('power_factor', 31, ('average', 'a', 'b', 'c'), 1))
|
||||
|
||||
quadrants = ['_'.join((k,q,p)) for (k, qs) in (
|
||||
('import', ('1','2')),
|
||||
('export', ('3','4'))
|
||||
)
|
||||
for q in qs
|
||||
for p in ['total', 'a', 'b', 'c']]
|
||||
|
||||
blocks32 = (('energy_real', 36, ('export', 'ex_a', 'ex_b', 'ex_c',
|
||||
'import', 'im_a', 'im_b', 'im_c')),
|
||||
('energy_apparent', 53, ('export', 'ex_a', 'ex_b', 'ex_c',
|
||||
'import', 'im_a', 'im_b', 'im_c')),
|
||||
('energy_reactive', 70, quadrants))
|
||||
|
||||
|
||||
for (metric, offset, labels, fix) in blocks16:
|
||||
data = {}
|
||||
scale = regs.read_scale(offset + len(labels)) * fix
|
||||
for (i, key) in enumerate(labels):
|
||||
data[key] = regs.read_int16(offset + i) * scale
|
||||
self.__dict__[metric] = data
|
||||
|
||||
for (metric, offset, labels) in blocks32:
|
||||
data = {}
|
||||
scale = regs.read_scale(offset + len(labels)*2)
|
||||
for (i, key) in enumerate(labels):
|
||||
value = regs.read_uint32(offset + 2*i) * scale / 10
|
||||
data[key] = value if value > 1 else None
|
||||
self.__dict__[metric] = data
|
||||
|
||||
self.frequency = regs.read_int16(14, scale=15)
|
||||
|
||||
event_bits = regs.read_uint32(103)
|
||||
self.events = {}
|
||||
for bit in meter_events_bits:
|
||||
self.events[meter_events_bits[bit]] = bool(event_bits & (1 << bit))
|
||||
|
||||
|
||||
status_codes = [None, 'off', 'sleep', 'start', 'on', 'throttled', 'stop', 'fault', 'setup']
|
||||
|
||||
class InverterBlock:
|
||||
def __init__(self, regs):
|
||||
current_scale = regs.read_scale(6)
|
||||
self.ac_current = current_scale * regs.read_uint16(2)
|
||||
self.ac_current_a = current_scale * regs.read_uint16(3)
|
||||
self.ac_current_b = current_scale * regs.read_uint16(4)
|
||||
self.ac_current_c = current_scale * regs.read_uint16(5)
|
||||
|
||||
voltage_scale = regs.read_scale(13)
|
||||
self.ac_voltage_ab = voltage_scale * regs.read_uint16(7)
|
||||
self.ac_voltage_bc = voltage_scale * regs.read_uint16(8)
|
||||
self.ac_voltage_ca = voltage_scale * regs.read_uint16(9)
|
||||
|
||||
self.ac_power = regs.read_int16(14, scale=15)
|
||||
self.frequency = regs.read_int16(16, scale=17)
|
||||
self.ac_apparent_power = regs.read_int16(18, scale=19)
|
||||
self.ac_reactive_power = regs.read_int16(20, scale=21)
|
||||
|
||||
self.power_factor = regs.read_int16(22, scale=23)
|
||||
self.dc_current = regs.read_uint16(27, scale=28)
|
||||
self.dc_voltage = regs.read_uint16(29, scale=30)
|
||||
self.dc_power = regs.read_int16(31, scale=32)
|
||||
self.temperature = regs.read_int16(34, scale=37)
|
||||
self.status_code = regs.read_uint16(38)
|
||||
self.status = status_codes[self.status_code]
|
||||
self.status_vendor = regs.read_uint16(39)
|
||||
|
||||
ac_energy = regs.read_uint32(24, scale=26)
|
||||
self.ac_energy = ac_energy if ac_energy > 1 else None
|
||||
|
||||
class Inverter:
|
||||
def __init__(self, host, port=1502, device=1):
|
||||
self._conn = ModbusTcpClient(host, port)
|
||||
self._device = 1
|
||||
|
||||
def connect(self):
|
||||
if not self._conn.connect():
|
||||
raise ConnectionFailed()
|
||||
|
||||
def registers(self, addr, length, device=None):
|
||||
if device is None:
|
||||
device = self._device
|
||||
self.connect()
|
||||
rs = self._conn.read_holding_registers(addr, length, slave=device)
|
||||
return Registers(rs, length)
|
||||
|
||||
def header(self, base):
|
||||
return Header(self.registers(base, 2), base)
|
||||
|
||||
def common_block(self):
|
||||
return CommonBlock(self.registers(40002, 67))
|
||||
|
||||
def data(self):
|
||||
return InverterBlock(self.registers(40069, 40))
|
||||
|
||||
def meter(self, n):
|
||||
base = 40190 + 174*n
|
||||
return Meter(self.registers(base, 105))
|
Loading…
Reference in New Issue
Block a user