diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..c118a60 --- /dev/null +++ b/README.md @@ -0,0 +1,108 @@ + +# Raspberry Pi x708 Power Management Control + +## Description + +This tool is a replacement of the original scripts provided by Suptronics for the control of the [x708 expansion board](http://www.suptronics.com/miniPCkits/x708-hardware.html). +It is coded in python and can be used as a systemd service. + +Use the tool at your own risk. I am not part of Suptronics and I am not responsible for any damage that may be caused by the tool or by the hardware. + +``` +usage: rpi-x708pwm.py [-h] [-n seconds] [--min-voltage volts] [--ncurses] [-q] [-w] + +RPI x708 Power Management Control + +optional arguments: + -h, --help show this help message and exit + -n seconds, --interval seconds + Specify update interval. + --min-voltage volts Specify minimum battery voltage (auto-shutdown). + --ncurses Enable ncurses output. + -q, --quiet Disable output. + -w, --watch Watch only, without GPIO actuators. +``` + + +## How to install (as root) + +Place the tool in /usr/bin/ and give it execution permissions +``` +# cp rpi-x708pwm.py /usr/bin/ +# chown root:root /usr/bin/rpi-x708pwm.py +# chmod +x /usr/bin/rpi-x708pwm.py +``` + + + +Copy the systemd service unit file & enable it + +``` +# cp systemd-service/rpi-x708pwm.service /etc/systemd/system/ +# systemctl enable rpi-x708pwm.service +``` + + + +## Additional notes + +### Power physical button timings + +The power button timings of the [wiki](http://www.suptronics.com/miniPCkits/x708-hardware.html) do not correspond with my hardware. +For me, the timings are as follows: + +| Seconds | Action | +| ------- | -------------- | +| < 2 | Reboot | +| 2 - 6 | Shutdown | +| > 6 | Force Shutdown | + + + +### Shutdown +In order to shutdown x708 unit by hardware, we need to turn on the GPIO PWM1 (pin 13 using BCM numbering, or Physical/Board pin 33). The problem is that it shuts down all the x708 unit, ungratefully. This may lead to problems with the filesystem and SD cards. +One workaround is to do this just at the last actions performed bysystemd, in `/usr/lib/systemd/system-shutdown/` + +However, the files in that directory seems to be executed in parallel. Although this is probably a motive for being slaughtered by +a systemd developer, the workaround I've done is to merge all the files into a single one to make sure that the snippet below is +executed at the very end. I'm sure there's a better alternative. If you know it and tell me, I'll appreciate it. However, I personally +don't mind too much if it takes a few more seconds to shutdown the pi, so *messirve*. + +For more info, see https://www.freedesktop.org/software/systemd/man/systemd-halt.service.html + +``` +# --> /usr/lib/systemd/system-shutdown/merged.shutdown + +# Power off hardware @ x708 power management +# If this code is reached from a normal shutdown/poweroff from software, +# the x708 hard-poweroff performed by using the GPIO 13 works fine. We just +# need to wait for it to complete, which in my rpi is ~5 seconds. +# Even if we sleep for more seconds, the entire x708 hardware shuts down when +# the operation is complete. However, when the x708 button is long-pressed (shutdown), +# this gpio behaves differently for some reason. Therefore, when we shutdown the rpi +# by using the physical button, the following action (GPIO 13) does nothing and +# the sleep operation is done without interruption. This only affects to the shutdown, +# and the reboot works as normal. This distinction can be checked by reading the value +# of the GPIO 5. Therefore, if its returned value is 1, it means that the physical button +# was pressed, so the whole logic with GPIO 13 should be skipped. + +if [ "$1" = "halt" ] || [ "$1" = "poweroff" ]; then + GPIO_PWR_BUTTON=5 + /usr/bin/echo ${GPIO_PWR_BUTTON} > /sys/class/gpio/export + echo "in" > /sys/class/gpio/gpio${GPIO_PWR_BUTTON}/direction + PWR_BUTTON_PRESSED=$(/usr/bin/cat /sys/class/gpio/gpio${GPIO_PWR_BUTTON}/value) + + if [ ${PWR_BUTTON_PRESSED} -eq 0 ]; then + TIMEOUT=60 + SHUTDOWN=13 + /usr/bin/echo ${SHUTDOWN} > /sys/class/gpio/export + /usr/bin/echo "out" > /sys/class/gpio/gpio${SHUTDOWN}/direction + /usr/bin/echo "1" > /sys/class/gpio/gpio${SHUTDOWN}/value + + # Wait for it + /usr/bin/sleep ${TIMEOUT} + fi +fi +``` +------------------------------------ + diff --git a/rpi-x708pwm.py b/rpi-x708pwm.py new file mode 100755 index 0000000..b6b6bdb --- /dev/null +++ b/rpi-x708pwm.py @@ -0,0 +1,354 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- + +''' Raspberry Pi x708 Power Management Control + +Copyright (C) 2020 Fernando Vano Garcia + +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 . + + Fernando Vano Garcia +''' + +from argparse import ArgumentParser, ArgumentTypeError +from datetime import datetime +from sys import stderr +import subprocess +import gpiozero +import curses +import struct +import smbus +import time +import sys +import os + +# --------------------------------------- # +# -- Constants -- # + +# Using BCM numbering for GPIO :: https://pinout.xyz/pinout +_GPIO_PIN_PWR_BUTTON = 5 # Physical/Board pin 29 +_GPIO_PIN_AC_LOST = 6 # Physical/Board pin 31 +_GPIO_PIN_PWR_TRIGGER = 12 # Physical/Board pin 32 + +I2C_BATTERY_ADDR = 0x36 + +_RAW_TEMPERATURE_FILE_ = "/sys/class/thermal/thermal_zone0/temp" + +# --------------------------------------- # +# -- Lambdas & Types -- # + +pos_int = lambda x: int(x) if is_positive_int(x) else raise_ex( + ArgumentTypeError("'%s' is not a positive int value" % str(x)) +) +pos_float = lambda x: float(x) if is_positive_float(x) else raise_ex( + ArgumentTypeError("'%s' is not a positive float value" % str(x)) +) + +# --------------------------------------- # +# -- Objects -- # + +class NcursesOutput(): + def __init__(self): + # -- Initialize ncurses -- # + self._stdscr = curses.initscr() # initialize curses screen + curses.curs_set(0) # hide cursor + curses.noecho() # turn off auto echoing of keypress on to screen + curses.cbreak() # enter break mode where pressing Enter key + # after keystroke is not required for it to register + self._stdscr.keypad(1) # enable special Key values such as curses.KEY_LEFT etc + self._stdscr.nodelay(1) # this will make calls to stdscr.getch() non-blocking + + self._line = 1 + self._rows, self._cols = self._stdscr.getmaxyx() + + # -- Draw a border -- # + self._stdscr.border(0) + + def cleanup(self): + self._stdscr.keypad(0) + curses.echo() + curses.nocbreak() + curses.endwin() + + def set_line(self, line): + self._line = line + + def print(self, string, row = -1, col = 1, fmt = curses.A_NORMAL): + if -1 == row: + row = self._line + self._line += 1 + self._stdscr.addstr(row, col, string, fmt) + + def draw_hline(self, cstart = 1, cend = -1, row = -1): + if -1 == row: + row = self._line + self._line += 1 + if -1 == cend: + cend = self._cols - 2 + self._stdscr.hline(row, cstart, curses.ACS_HLINE, cend) + + def refresh(self): + self._stdscr.refresh() + + def sleep(self, timeout = 0): + self._stdscr.timeout(timeout) + + def getchar(self): + return self._stdscr.getch() + +# --------------------------------------- # + +def error(*msg): + print(*msg, file=stderr) + # stderr.flush() + + +def is_positive_int(n): + try: + i = int(n) + return (i > 0) + except ValueError: + return False + + +def is_positive_float(n): + try: + f = float(n) + return (f > 0) + except ValueError: + return False + + +def raise_ex(e): + raise e + + +def open_file(f, p): + try: + return open(f, p) + except IOError as e: + error("Error opening file '%s': %s" % (f, e.strerror)) + return None + +# --------------------------------------- # + +def read_temperature(fd): + try: + fd.seek(0) + t = int(fd.readline()) + if not is_positive_int(t): + raise Exception("Invalid value: '%s'. Aborting." % t) + except Exception as e: + error(e) + return -1 + + return (t / 1000) + + +def read_voltage(bus): + read = bus.read_word_data(I2C_BATTERY_ADDR, 2) + swapped = struct.unpack("H", read))[0] + voltage = swapped * 1.25 /1000/16 + return voltage + + +def read_capacity(bus): + read = bus.read_word_data(I2C_BATTERY_ADDR, 4) + swapped = struct.unpack("H", read))[0] + capacity = swapped/256 + return capacity + + +def get_params(bus, temperature_fd): + if temperature_fd is not None: + temperature = read_temperature(temperature_fd) + voltage = read_voltage(bus) + battery = read_capacity(bus) + timestamp = datetime.now().strftime("%d/%m/%Y - %H:%M:%S") + return (temperature, voltage, battery, timestamp) + + +def battery_monitor(update_interval, min_voltage, use_ncurses, flag_quiet, flag_watch): + # 0 = /dev/i2c-0 (port I2C0), + # 1 = /dev/i2c-1 (port I2C1) + bus = smbus.SMBus(1) + + temp_fd = open_file(_RAW_TEMPERATURE_FILE_, "r") + if temp_fd is None: + print("[!] WARNING: Couldn't open %s" % _RAW_TEMPERATURE_FILE_) + + if (not flag_quiet) and use_ncurses: + # --- Initialize ncurses --- # + nco = NcursesOutput() + nco.print("x708 Monitor", fmt = curses.A_BOLD) + ui_sec = update_interval / 1000 + ui_sec = ("%d" % ui_sec) if float(ui_sec).is_integer() else ("%.1f" % ui_sec) + nco.print("Refreshing every %s second%s." + % (ui_sec, 's' if update_interval != 1000 else '')) + nco.print("Press q to exit") + + try: + while True: + temp, volt, batt, timestamp = get_params(bus, temp_fd) + + # --- Monitor voltage --- # + if not flag_watch and (volt < min_voltage): + msg = "[!] Battery voltage below threshold (%.1fV)." % min_voltage + msg += " Emergency poweroff." + #print(msg) + subprocess.call(['/usr/bin/wall', msg]) + do_shutdown() + + if flag_quiet: + time.sleep(update_interval / 1000) + continue + + # --- Print info --- # + + if use_ncurses: + nco.set_line(5) + + nco.draw_hline() + nco.print(timestamp) + nco.draw_hline() + + if temp_fd is not None: + nco.print("CPU Temperature: %dºC" % temp) + nco.print("Voltage: %5.2fV" % volt) + nco.print("Battery: %5i%%" % batt) + + nco.refresh() + nco.sleep(update_interval) + + if ord('q') == nco.getchar(): + return 0 + + else: + # without ncurses + print(" ---- %s ----" % timestamp) + if temp_fd is not None: + print("CPU Temperature: %dºC" % temp) + print("Voltage: %5.2fV" % volt) + print("Battery: %5i%%" % batt) + print() + time.sleep(update_interval / 1000) + + except KeyboardInterrupt: + return 0 + + finally: + if (not flag_quiet) and use_ncurses: + nco.cleanup() + +# --------------------------------------- # + + +def do_shutdown(): + exit(subprocess.call(['/usr/sbin/poweroff'])) + + +def do_reboot(): + exit(subprocess.call(['/usr/sbin/reboot'])) + + +# --------------------------------------- # +# --- Power Button Callbacks --- # + +def pwr_btn_released_callback(pwr_button): + if not pwr_button.is_held: + do_reboot() + + +def pwr_btn_held_callback(pwr_button): + do_shutdown() + + +# --------------------------------------- # +# --- Power Loss Detection Callbacks --- # + +def ac_power_connected_callback(pld_gpio): + #print("AC power restored.") + pass + +def ac_power_lost_callback(pld_gpio): + #print("AC power lost. Running on batteries.") + pass + +# --------------------------------------- # + + +def main(): + parser = ArgumentParser(description="RPI x708 Power Management Control") + parser.add_argument("-n", "--interval", type = pos_float, metavar = "seconds", required = False, + dest = 'interval', default = 2.0, help = "Specify update interval.") + parser.add_argument("--min-voltage", type = pos_float, metavar = "volts", required = False, + dest = 'min_voltage', default = 3.5, + help = "Specify minimum battery voltage (auto-shutdown).") + parser.add_argument("--ncurses", dest="flag_ncurses", action="store_true", + help = "Enable ncurses output.") + parser.add_argument("-q", "--quiet", dest="flag_quiet", action="store_true", + help = "Disable output.") + parser.add_argument("-w", "--watch", dest="flag_watch", action="store_true", + help = "Watch only, without GPIO actuators.") + + parser.set_defaults(flag_ncurses = False) + parser.set_defaults(flag_quiet = False) + parser.set_defaults(flag_watch = False) + args = vars(parser.parse_args()) + + if os.geteuid() != 0: + error("[!] Error: Root privileges are needed to run this script.") + return -1 + + update_interval = args['interval'] * 1000 + min_voltage = args['min_voltage'] + use_ncurses = args['flag_ncurses'] + flag_quiet = args['flag_quiet'] + flag_watch = args['flag_watch'] + + if flag_watch and flag_quiet: + print("[+] Both --watch and --quiet flags are set. Nothing to do.") + return 0 + + if not flag_watch: + # --- Power Loss Detection --- # + pld_gpio = gpiozero.DigitalInputDevice(_GPIO_PIN_AC_LOST) + + pld_gpio.when_activated = ac_power_lost_callback + pld_gpio.when_deactivated = ac_power_connected_callback + + # --- Physical Power Button --- # + pwr_trigger = gpiozero.DigitalOutputDevice(_GPIO_PIN_PWR_TRIGGER) + pwr_button = gpiozero.Button(_GPIO_PIN_PWR_BUTTON, + pull_up = False, hold_time = 2) + + pwr_trigger.on() + if pwr_button.value: + error("[!] Error: PWR_BUTTON is pulled high. Aborting...") + return -1 + + pwr_button.when_released = pwr_btn_released_callback + pwr_button.when_held = pwr_btn_held_callback + + # --- Battery Monitor --- # + if not flag_watch and min_voltage < 3: + print("[!] WARNING: min_voltage below 3V") + return battery_monitor(int(update_interval), min_voltage, use_ncurses, flag_quiet, flag_watch) + +# --------------------------------------- # + + +if __name__ == '__main__': + sys.exit(main()) + + +# --------------------------------------- # diff --git a/systemd-service/rpi-x708pwm.service b/systemd-service/rpi-x708pwm.service new file mode 100644 index 0000000..ecdbc8e --- /dev/null +++ b/systemd-service/rpi-x708pwm.service @@ -0,0 +1,13 @@ +[Unit] +Description=RPI x708 Power Manager daemon +After=sysinit.target + +[Service] +Type=simple +ExecStart=/usr/bin/rpi-x708pwm.py --min-voltage 3.5 -q +ExecReload=/usr/bin/kill -HUP $MAINPID +PIDFile=/run/rpi-x708pwm.pid +Restart=always + +[Install] +WantedBy=sysinit.target diff --git a/x708.sh b/x708.sh deleted file mode 100644 index ff2d53d..0000000 --- a/x708.sh +++ /dev/null @@ -1,152 +0,0 @@ -#x708 Powering on /reboot /full shutdown through hardware -#!/bin/bash - - sudo sed -e '/shutdown/ s/^#*/#/' -i /etc/rc.local - - echo '#!/bin/bash - -SHUTDOWN=5 -REBOOTPULSEMINIMUM=200 -REBOOTPULSEMAXIMUM=600 -echo "$SHUTDOWN" > /sys/class/gpio/export -echo "in" > /sys/class/gpio/gpio$SHUTDOWN/direction -BOOT=12 -echo "$BOOT" > /sys/class/gpio/export -echo "out" > /sys/class/gpio/gpio$BOOT/direction -echo "1" > /sys/class/gpio/gpio$BOOT/value - -echo "X708 Shutting down..." - -while [ 1 ]; do - shutdownSignal=$(cat /sys/class/gpio/gpio$SHUTDOWN/value) - if [ $shutdownSignal = 0 ]; then - /bin/sleep 0.2 - else - pulseStart=$(date +%s%N | cut -b1-13) - while [ $shutdownSignal = 1 ]; do - /bin/sleep 0.02 - if [ $(($(date +%s%N | cut -b1-13)-$pulseStart)) -gt $REBOOTPULSEMAXIMUM ]; then - echo "X708 Shutting down", SHUTDOWN, ", halting Rpi ..." - sudo poweroff - exit - fi - shutdownSignal=$(cat /sys/class/gpio/gpio$SHUTDOWN/value) - done - if [ $(($(date +%s%N | cut -b1-13)-$pulseStart)) -gt $REBOOTPULSEMINIMUM ]; then - echo "X708 Rebooting", SHUTDOWN, ", recycling Rpi ..." - sudo reboot - exit - fi - fi -done' > /etc/x708pwr.sh -sudo chmod +x /etc/x708pwr.sh -sudo sed -i '$ i /etc/x708pwr.sh &' /etc/rc.local - - -#X708 full shutdown through Software -#!/bin/bash - - sudo sed -e '/button/ s/^#*/#/' -i /etc/rc.local - - echo '#!/bin/bash - -BUTTON=13 - -echo "$BUTTON" > /sys/class/gpio/export; -echo "out" > /sys/class/gpio/gpio$BUTTON/direction -echo "1" > /sys/class/gpio/gpio$BUTTON/value - -SLEEP=${1:-4} - -re='^[0-9\.]+$' -if ! [[ $SLEEP =~ $re ]] ; then - echo "error: sleep time not a number" >&2; exit 1 -fi - -echo "X708 Shutting down..." -/bin/sleep $SLEEP - -#restore GPIO 13 -echo "0" > /sys/class/gpio/gpio$BUTTON/value -' > /usr/local/bin/x708softsd.sh -sudo chmod +x /usr/local/bin/x708softsd.sh - -#X708 Battery voltage & precentage reading -#!/bin/bash - - sudo sed -e '/shutdown/ s/^#*/#/' -i /etc/rc.local - - echo '#!/usr/bin/env python -import struct -import smbus -import sys -import time - - -def readVoltage(bus): - - address = 0x36 - read = bus.read_word_data(address, 2) - swapped = struct.unpack("H", read))[0] - voltage = swapped * 1.25 /1000/16 - return voltage - - -def readCapacity(bus): - - address = 0x36 - read = bus.read_word_data(address, 4) - swapped = struct.unpack("H", read))[0] - capacity = swapped/256 - return capacity - - -bus = smbus.SMBus(1) # 0 = /dev/i2c-0 (port I2C0), 1 = /dev/i2c-1 (port I2C1) - -while True: - - print "******************" - print "Voltage:%5.2fV" % readVoltage(bus) - - print "Battery:%5i%%" % readCapacity(bus) - - if readCapacity(bus) == 100: - - print "Battery FULL" - - if readCapacity(bus) < 20: - - - print "Battery LOW" - print "******************" - time.sleep(2) -' > /home/pi/x708bat.py -sudo chmod +x /home/pi/x708bat.py - -#X708 AC Power loss / power adapter failture detection -#!/bin/bash - - sudo sed -e '/button/ s/^#*/#/' -i /etc/rc.local - - echo '#!/usr/bin/env python -import RPi.GPIO as GPIO - -GPIO.setmode(GPIO.BCM) -GPIO.setup(6, GPIO.IN) - -def my_callback(channel): - if GPIO.input(6): # if port 6 == 1 - print "---AC Power Loss OR Power Adapter Failure---" - else: # if port 6 != 1 - print "---AC Power OK,Power Adapter OK---" - -GPIO.add_event_detect(6, GPIO.BOTH, callback=my_callback) - -print "1.Make sure your power adapter is connected" -print "2.Disconnect and connect the power adapter to test" -print "3.When power adapter disconnected, you will see: AC Power Loss or Power Adapter Failure" -print "4.When power adapter reconnected, you will see: AC Power OK, Power Adapter OK" - -raw_input("Testing Started") -' > /home/pi/x708pld.py -sudo chmod +x /home/pi/x708pld.py