diff options
53 files changed, 2642 insertions, 281 deletions
@@ -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>. diff --git a/COPYING.LGPL b/COPYING.LGPL new file mode 100644 index 0000000..0a04128 --- /dev/null +++ b/COPYING.LGPL @@ -0,0 +1,165 @@ + GNU LESSER 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. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser 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 +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. @@ -20,13 +20,12 @@ only on BLE for updates. Videos ------ +[](https://www.youtube.com/watch?v=tuk9Nmr3Jo8)\ +[How to develop wasp-os python applications on a Pine64 PineTime](https://www.youtube.com/watch?v=tuk9Nmr3Jo8) [](https://www.youtube.com/watch?v=kf1VHj587Mc)\ [Developing for Pine64 PineTime using wasp-os and MicroPython](https://www.youtube.com/watch?v=kf1VHj587Mc) -[](https://www.youtube.com/watch?v=W0CmqOnl4jk)\ -[WASP bootloader and MicroPython running on Pine64 PineTime](https://www.youtube.com/watch?v=W0CmqOnl4jk) - Building from a git clone ------------------------- @@ -77,16 +76,22 @@ demo.run() # After watching the demo for a bit... ^C wasp.app.draw(watch) -wasp.run() +wasp.system.run() ~~~ To set the time and restart the main application: ~~~ ^C -watch.rtc.set_time((hh, mm, ss)) -wasp.run() +watch.rtc.set_localtime((yyyy, mm, dd, HH, MM, SS)) +wasp.system.run() +~~~ + +Or just use: +~~~ +./tools/wasptool --rtc ~~~ +which can run these commands automatically. As mentioned above there are many drivers and features still to be developed, see the [TODO list](TODO.md) for current status. @@ -61,16 +61,19 @@ applications. ### WASP * [X] Add dd/mm/yyyy support to RTC - * [ ] Button driver (interrupt based) - * [ ] Touch sensor driver - * [ ] Event driven application framework + * [X] Button driver (interrupt based) + * [X] Touch sensor driver + * [X] Event driven application framework * [ ] Stopwatch app - * [ ] Settings app + * [X] Settings app * [X] PC-hosted simulation platform - * [ ] Documentation - - [ ] Sphinx framework and integration with github.io + * [.] Documentation + - [X] Sphinx framework and integration with github.io - [ ] Document bootloader protocols - [ ] Write full docstring documentation for all WASP components + * [ ] Application Launcher + * [ ] Debug notifications + * [ ] Multi-colour RLE images ## M3: Smartwatch diff --git a/docs/five-clause-nordic.rst b/docs/five-clause-nordic.rst new file mode 100644 index 0000000..aa3f629 --- /dev/null +++ b/docs/five-clause-nordic.rst @@ -0,0 +1,38 @@ +5-Clause Nordic License
+=======================
+
+Copyright (c) 2007 - 2018, Nordic Semiconductor ASA
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+
+2. Redistributions in binary form, except as embedded into a Nordic
+ Semiconductor ASA integrated circuit in a product or a software update for
+ such product, must reproduce the above copyright notice, this list of
+ conditions and the following disclaimer in the documentation and/or other
+ materials provided with the distribution.
+
+3. Neither the name of Nordic Semiconductor ASA nor the names of its
+ contributors may be used to endorse or promote products derived from this
+ software without specific prior written permission.
+
+4. This software, with or without modification, must only be used with a
+ Nordic Semiconductor ASA integrated circuit.
+
+5. Any software provided in binary form under this license must not be reverse
+ engineered, decompiled, modified and/or disassembled.
+
+THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
+OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
+GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/docs/gnu-gpl-v3.0.rst b/docs/gnu-gpl-v3.0.rst new file mode 100644 index 0000000..002514a --- /dev/null +++ b/docs/gnu-gpl-v3.0.rst @@ -0,0 +1,616 @@ +GNU General Public License +========================== + +*Version 3, 29 June 2007* +*Copyright © 2007 Free Software Foundation, Inc* <http://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 <http://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 +<http://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 +<http://www.gnu.org/philosophy/why-not-lgpl.html>. diff --git a/docs/gnu-lgpl-v3.0.rst b/docs/gnu-lgpl-v3.0.rst new file mode 100644 index 0000000..8b04219 --- /dev/null +++ b/docs/gnu-lgpl-v3.0.rst @@ -0,0 +1,170 @@ +GNU Lesser General Public License +================================= + +*Version 3, 29 June 2007* +*Copyright © 2007 Free Software Foundation, Inc* <http://fsf.org/> + +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. + + +This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + +0. Additional Definitions +~~~~~~~~~~~~~~~~~~~~~~~~~ + +As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + +"The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + +An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + +A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + +The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + +The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + +1. Exception to Section 3 of the GNU GPL +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + +2. Conveying Modified Versions +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + +* **a)** under this License, provided that you make a good faith effort to +ensure that, in the event an Application does not supply the +function or data, the facility still operates, and performs +whatever part of its purpose remains meaningful, or + +* **b)** under the GNU GPL, with none of the additional permissions of +this License applicable to that copy. + +### 3. Object Code Incorporating Material from Library Header Files + +The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + +* **a)** Give prominent notice with each copy of the object code that the +Library is used in it and that the Library and its use are +covered by this License. +* **b)** Accompany the object code with a copy of the GNU GPL and this license +document. + +4. Combined Works +~~~~~~~~~~~~~~~~~ + +You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + +* **a)** Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + +* **b)** Accompany the Combined Work with a copy of the GNU GPL and this license + document. + +* **c)** For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + +* **d)** Do one of the following: + + - **0)** Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + - **1)** Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that **(a)** uses at run time + a copy of the Library already present on the user's computer + system, and **(b)** will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + +* **e)** Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option **4d0**, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option **4d1**, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + +5. Combined Libraries +~~~~~~~~~~~~~~~~~~~~~ + +You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + +* **a)** Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. +* **b)** Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + +6. Revised Versions of the GNU Lesser General Public License +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser 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 +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + +If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/docs/index.rst b/docs/index.rst index 84c9765..5249459 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,6 +13,7 @@ Welcome to WASP-OS's documentation! README wasp TODO + license Indices and tables diff --git a/docs/license.rst b/docs/license.rst new file mode 100644 index 0000000..47c585a --- /dev/null +++ b/docs/license.rst @@ -0,0 +1,28 @@ +Licensing +========= + +wasp-os is licensed to you under the GNU Lesser General Public License, as +published by the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +wasp-os 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 and the +GNU Lesser General Public License along with this program. If not, see +<https://www.gnu.org/licenses/>. + +Notwithstanding the above some essential components of wasp-os, such as +the MicroPython distribution, are licensed under under different open +source licenses. The licensing for these components is clearly +indicated and reinforced by the directory and sub-module structure. + +Additionally binary releases of wasp-os include the Nordic Softdevice +which is licensed under the 5-clause Nordic license. + +.. toctree:: + gnu-lgpl-v3.0.rst + gnu-gpl-v3.0.rst + mit.rst + five-clause-nordic.rst diff --git a/docs/mit.rst b/docs/mit.rst new file mode 100644 index 0000000..b9e2903 --- /dev/null +++ b/docs/mit.rst @@ -0,0 +1,27 @@ +The MIT License (MIT) +===================== + +Copyright © `<year>` `<copyright holders>` (see individual files for +copyright information) + +Permission is hereby granted, free of charge, to any person +obtaining a copy of this software and associated documentation +files (the "Software"), to deal in the Software without +restriction, including without limitation the rights to use, +copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE. + diff --git a/docs/wasp.rst b/docs/wasp.rst index 039e819..e1f5bec 100644 --- a/docs/wasp.rst +++ b/docs/wasp.rst @@ -4,7 +4,7 @@ WASP Internals System management ----------------- -.. automodule:: manager +.. automodule:: wasp :members: :undoc-members: diff --git a/res/app_icon.png b/res/app_icon.png Binary files differnew file mode 100644 index 0000000..574f75f --- /dev/null +++ b/res/app_icon.png diff --git a/res/clock_icon.png b/res/clock_icon.png Binary files differnew file mode 100644 index 0000000..165bf51 --- /dev/null +++ b/res/clock_icon.png diff --git a/res/down_arrow.png b/res/down_arrow.png Binary files differnew file mode 100644 index 0000000..ef94eb3 --- /dev/null +++ b/res/down_arrow.png diff --git a/res/micropython.png b/res/micropython.png Binary files differindex 7af9a6c..1e0b9e8 100644 --- a/res/micropython.png +++ b/res/micropython.png diff --git a/res/pine64.png b/res/pine64.png Binary files differindex ba52eb2..4fc74da 100644 --- a/res/pine64.png +++ b/res/pine64.png diff --git a/res/settings_icon.png b/res/settings_icon.png Binary files differnew file mode 100644 index 0000000..d1141b0 --- /dev/null +++ b/res/settings_icon.png diff --git a/res/torch_icon.png b/res/torch_icon.png Binary files differnew file mode 100644 index 0000000..bbd4db3 --- /dev/null +++ b/res/torch_icon.png diff --git a/res/up_arrow.png b/res/up_arrow.png Binary files differnew file mode 100644 index 0000000..c990949 --- /dev/null +++ b/res/up_arrow.png diff --git a/tools/rle_encode.py b/tools/rle_encode.py index a938c76..64b920e 100755 --- a/tools/rle_encode.py +++ b/tools/rle_encode.py @@ -1,5 +1,8 @@ #!/usr/bin/env python3 +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + import argparse import sys import os.path @@ -42,7 +45,76 @@ def encode(im): return (im.width, im.height, bytes(rle)) +def encode_2bit(im): + """2-bit palette based RLE encoder. + + This encoder has a reprogrammable 2-bit palette. This allows it to encode + arbitrary images with a full 8-bit depth but the 2-byte overhead each time + a new colour is introduced means it is not efficient unless the image is + carefully constructed to keep a good locality of reference for the three + non-background colours. + + The encoding competes well with the 1-bit encoder for small monochrome + images but once run-lengths longer than 62 start to become frequent then + this encoding is about 30% larger than a 1-bit encoding. + """ + pixels = im.load() + + rle = [] + rl = 0 + px = pixels[0, 0] + palette = [0, 0xfc, 0x2d, 0xff] + next_color = 1 + + def encode_pixel(px, rl): + nonlocal next_color + px = (px[0] & 0xe0) | ((px[1] & 0xe0) >> 3) | ((px[2] & 0xc0) >> 6) + if px not in palette: + rle.append(next_color << 6) + rle.append(px) + palette[next_color] = px + next_color += 1 + if next_color >= len(palette): + next_color = 1 + px = palette.index(px) + if rl >= 63: + rle.append((px << 6) + 63) + rl -= 63 + while rl >= 255: + rle.append(255) + rl -= 255 + rle.append(rl) + else: + rle.append((px << 6) + rl) + + for y in range(im.height): + for x in range(im.width): + newpx = pixels[x, y] + if newpx == px: + rl += 1 + assert(rl < (1 << 21)) + continue + + # Code the previous run + encode_pixel(px, rl) + + # Start a new run + rl = 1 + px = newpx + + # Handle the final run + encode_pixel(px, rl) + + return (im.width, im.height, bytes(rle)) + def encode_8bit(im): + """Experimental 8-bit RLE encoder. + + For monochrome images this is about 3x less efficient than the 1-bit + encoder. This encoder is not currently used anywhere in wasp-os and + currently there is no decoder either (so don't assume this code + actually works). + """ pixels = im.load() rle = [] @@ -50,7 +122,6 @@ def encode_8bit(im): px = pixels[0, 0] def encode_pixel(px, rl): - print(rl) px = (px[0] & 0xe0) | ((px[1] & 0xe0) >> 3) | ((px[2] & 0xc0) >> 6) rle.append(px) @@ -135,17 +206,38 @@ parser.add_argument('--ascii', action='store_true', help='Run the resulting image(s) through an ascii art decoder') parser.add_argument('--c', action='store_true', help='Render the output as C instead of python') +parser.add_argument('--indent', default=0, type=int, + help='Add extra indentation in the generated code') +parser.add_argument('--2bit', action='store_true', dest='twobit', + help='Generate 2-bit image') +parser.add_argument('--8bit', action='store_true', dest='eightbit', + help='Generate 8-bit image') args = parser.parse_args() for fname in args.files: - image = encode(Image.open(fname)) + if args.eightbit: + image = encode_8bit(Image.open(fname)) + depth = 8 + elif args.twobit: + image = encode_2bit(Image.open(fname)) + depth = 2 + else: + image = encode(Image.open(fname)) + depth = 1 if args.c: render_c(image, fname) else: - print(f'# 1-bit RLE, generated from {fname}, {len(image[2])} bytes') - print(f'{varname(fname)} = {image}') - print() + print(f'# {depth}-bit RLE, generated from {fname}, {len(image[2])} bytes') + # Split the bytestring to ensure each line is short enough to be absorbed + # on the target if needed. + #print(f'{varname(fname)} = {image}') + (x, y, pixels) = image + extra_indent = ' ' * args.indent + print(f'{extra_indent}{varname(fname)} = (\n{extra_indent} {x}, {y},') + for i in range(0, len(pixels), 16): + print(f'{extra_indent} {pixels[i:i+16]}') + print(f'{extra_indent})') if args.ascii: print() diff --git a/tools/wasptool b/tools/wasptool index 72e88bc..698cc6c 100755 --- a/tools/wasptool +++ b/tools/wasptool @@ -1,9 +1,7 @@ #!/usr/bin/python3 -# -# SPDX-License-Identifier: MIT +# SPDX-License-Identifier: LGPL-3.0-or-later # Copyright (c) 2020 Daniel Thompson -# import argparse import random @@ -13,7 +11,23 @@ import time import string import sys +def pbar(iterable, quiet=False): + step = 100 / len(iterable) + for i, v in enumerate(iterable): + if not quiet: + percent = round(step * i, 1) + bar = int(percent) // 2 + print(f'[{"="*bar}{"-"*(50-bar)}] {percent}%', end='\r', flush=True) + yield v + if not quiet: + print(f'[{"="*50}] 100% ') + def sync(c): + """Stop the watch and synchronize with the command prompt. + + Sending a random print ensure the final export (of the prompt) + does not accidentally match a previously issued prompt. + """ tag = ''.join([random.choice(string.ascii_uppercase) for i in range(6)]) c.send('\x03') @@ -23,11 +37,20 @@ def sync(c): c.expect('>>> ') def unsync(c): - # Set the watch running again - c.sendline('wasp.run()') + """Set the watch running again. + + There must be an expect (or a sleep) since if we kill the subordinate + process too early then the sendline will not have completed. + """ + c.sendline('wasp.system.run()') + c.expect('Watch is running, use Ctrl-C to stop') + c.send('\x18') def paste(c, f, verbose=False): docstring = False + + tosend = [] + for ln in f.readlines(): ln = ln.rstrip() @@ -43,12 +66,11 @@ def paste(c, f, verbose=False): if ln.lstrip().startswith('#'): continue + tosend.append(ln) - c.sendline(ln) - c.expect('=== ') - - if not verbose: - print('.', end='', flush=True) + for ln in pbar(tosend, verbose): + c.sendline(ln) + c.expect('=== ') def handle_eval(c, cmd): verbose = bool(c.logfile) @@ -69,14 +91,13 @@ def handle_exec(c, fname): with open(fname) as f: if not verbose: - print(f'Preparing to run {fname} ...', end='', flush=True) + print(f'Preparing to run {fname}:') c.send('\x05') c.expect('=== ') paste(c, f, verbose) - print(' done') c.logfile = sys.stdout c.send('\x04') c.expect('>>> ') @@ -101,14 +122,13 @@ def handle_upload(c, fname): with open(fname) as f: if not verbose: - print(f'Uploading {fname} ...', end='', flush=True) + print(f'Uploading {fname}:') c.sendline(f'upload("{os.path.basename(fname)}")') c.expect('=== ') paste(c, f, verbose) c.send('\x04') - print(' done') c.expect('>>> ') if __name__ == '__main__': diff --git a/wasp/apps/clock.py b/wasp/apps/clock.py index f99091a..4236d9a 100644 --- a/wasp/apps/clock.py +++ b/wasp/apps/clock.py @@ -1,7 +1,10 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + +import wasp + +import icons import fonts.clock as digits -import watch -import widgets -import manager DIGITS = ( digits.clock_0, @@ -18,35 +21,22 @@ DIGITS = ( MONTH = 'JanFebMarAprMayJunJulAugSepOctNovDec' -class ClockApp(object): +class ClockApp(): """Simple digital clock application. Shows a time (as HH:MM) together with a battery meter and the date. """ + NAME = 'Clock' + ICON = icons.clock def __init__(self): - self.meter = widgets.BatteryMeter() - - def handle_event(self, event_view): - """Process events that the app is subscribed to.""" - if event_view[0] == manager.EVENT_TICK: - self.update() - else: - # TODO: Raise an unexpected event exception - pass + self.meter = wasp.widgets.BatteryMeter() - def foreground(self, manager, effect=None): + def foreground(self): """Activate the application.""" self.on_screen = ( -1, -1, -1, -1, -1, -1 ) - self.draw(effect) - manager.request_tick(1000) - - def tick(self, ticks): - self.update() - - def background(self): - """De-activate the application (without losing state).""" - pass + self.draw() + wasp.system.request_tick(1000) def sleep(self): return True @@ -54,9 +44,12 @@ class ClockApp(object): def wake(self): self.update() - def draw(self, effect=None): + def tick(self, ticks): + self.update() + + def draw(self): """Redraw the display from scratch.""" - draw = watch.drawable + draw = wasp.watch.drawable draw.fill() draw.rleblit(digits.clock_colon, pos=(2*48, 80), fg=0xb5b6) @@ -70,14 +63,14 @@ class ClockApp(object): The updates are a lazy as possible and rely on an prior call to draw() to ensure the screen is suitably prepared. """ - now = watch.rtc.get_localtime() + now = wasp.watch.rtc.get_localtime() if now[3] == self.on_screen[3] and now[4] == self.on_screen[4]: if now[5] != self.on_screen[5]: self.meter.update() self.on_screen = now return False - draw = watch.drawable + draw = wasp.watch.drawable draw.rleblit(DIGITS[now[4] % 10], pos=(4*48, 80)) draw.rleblit(DIGITS[now[4] // 10], pos=(3*48, 80), fg=0xbdb6) draw.rleblit(DIGITS[now[3] % 10], pos=(1*48, 80)) diff --git a/wasp/apps/flashlight.py b/wasp/apps/flashlight.py index f1f9418..c4702a0 100644 --- a/wasp/apps/flashlight.py +++ b/wasp/apps/flashlight.py @@ -1,32 +1,33 @@ -import watch -import manager +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + +import wasp + +import icons class FlashlightApp(object): """Trivial flashlight application. Shows a pure white screen with the backlight set to maximum. """ + NAME = 'Torch' + ICON = icons.torch - def __init__(self): - self.backlight = None - - def foreground(self, manager, effect=None): + def foreground(self): """Activate the application.""" - self.on_screen = ( -1, -1, -1, -1, -1, -1 ) - self.draw(effect) - manager.request_tick(1000) + self.draw() + wasp.system.request_tick(1000) + + self._brightness = wasp.system.brightness + wasp.system.brightness = 3 def background(self): """De-activate the application (without losing state).""" - pass - - def sleep(self): - return False + wasp.system.brightness = self._brightness def tick(self, ticks): - pass + wasp.system.keep_awake() - def draw(self, effect=None): + def draw(self): """Redraw the display from scratch.""" - display = watch.display - display.fill(0xffff) + wasp.watch.display.fill(0xffff) diff --git a/wasp/apps/launcher.py b/wasp/apps/launcher.py new file mode 100644 index 0000000..274ea9c --- /dev/null +++ b/wasp/apps/launcher.py @@ -0,0 +1,80 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + +import wasp +import icons + +class LauncherApp(): + """An application launcher application. + """ + NAME = 'Launcher' + ICON = icons.app + + def foreground(self): + """Activate the application.""" + self._page = 0 + self._draw() + wasp.system.request_event(wasp.EventMask.TOUCH | + wasp.EventMask.SWIPE_UPDOWN) + + def swipe(self, event): + i = self._page + n = self._num_pages + if event[0] == wasp.EventType.UP: + i += 1 + if i >= n: + i -= 1 + wasp.watch.vibrator.pulse() + return + else: + i -= 1 + if i < 0: + wasp.system.switch(wasp.system.applications[0]) + return + + self._page = i + wasp.watch.display.mute(True) + self._draw() + wasp.watch.display.mute(False) + + def touch(self, event): + page = self._get_page(self._page) + x = event[1] + y = event[2] + app = page[2 * (y // 120) + (x // 120)] + if app: + wasp.system.switch(app) + else: + wasp.watch.vibrator.pulse() + + @property + def _num_pages(self): + """Work out what the highest possible pages it.""" + num_apps = len(wasp.system.applications) + return (num_apps + 3) // 4 + + def _get_page(self, i): + apps = wasp.system.applications + page = apps[4*i: 4*(i+1)] + while len(page) < 4: + page.append(None) + return page + + def _draw(self): + """Redraw the display from scratch.""" + def draw_app(app, x, y): + if not app: + return + draw.set_color(0xffff) + draw.rleblit(app.ICON, (x+13, y+12)) + draw.set_color(0xbdb6) + draw.string(app.NAME, x, y+120-30, 120) + + draw = wasp.watch.drawable + page = self._get_page(self._page) + + draw.fill() + draw_app(page[0], 0, 0) + draw_app(page[1], 120, 0) + draw_app(page[2], 0, 120) + draw_app(page[3], 120, 120) diff --git a/wasp/apps/testapp.py b/wasp/apps/testapp.py index 9f512f1..eece822 100644 --- a/wasp/apps/testapp.py +++ b/wasp/apps/testapp.py @@ -1,62 +1,157 @@ -import watch -import widgets -import manager +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + import machine +import wasp +import icons class TestApp(): """Simple test application. """ + NAME = 'Self Test' + ICON = icons.app + + # 2-bit RLE, generated from res/app_icon.png, 457 bytes + RLE_2BIT = ( + 96, 64, + b'\x1e@md<d<d;f?X\xec2\xf0/' + b'\xf2-\xf4,\xc3.\xc3,\xc3.\xc3,\xc3.\xc3,' + b'\xc3.\xc3,\xc3.\xc3,\xc3\x0c\x80\xfc\x83\x10\xc0]' + b'\xc3\x0c@\xffC,C\n\x87\x0c\xc7\nC,C\t' + b'\x83\x02\x84\n\xc4\x02\xc3\tC,C\x08\x82\x07\x82\x08' + b'\xc2\x07\xc2\x08C,C\x07\x82\t\x82\x06\xc2\t\xc2\x07' + b'C,C\x06\x82\x0b\x82\x04\xc2\x0b\xc2\x06C,C\x06' + b'\x82\x0b\x82\x04\xc2\x0b\xc2\x06C,C\x05\x82\x0c\x82\x04' + b'\xc2\x0c\xc2\x05C,C\x05\x82\x0c\x82\x04\xc2\x0c\xc2\x05' + b'C,C\x05\x83\x0b\x82\x04\xc2\x0b\xc3\x05C,C\x06' + b'\x82\x0b\x82\x04\xc2\x0b\xc2\x06C,C\x06\x82\x0b\x82\x04' + b'\xc2\x0b\xc1\x07C,C\x07\x82\n\x82\x04\xc2\n\xc2\x07' + b'C+D\x08\x82\t\x82\x04\xc2\t\xc2\x08C*E\t' + b'\x8c\x04\xcc\tC*E\n\x8b\x04\xcb\nC*E.' + b'C*E.C*E.C*E.C*E\n' + b'\x80\xe9\x8b\x04\xc0o\xcb\nC+D\t\x8c\x04\xcc\t' + b'C,C\x08\x82\t\x82\x04\xc2\t\xc2\x08C,C\x07' + b'\x82\n\x82\x04\xc2\n\xc2\x07C,C\x06\x82\x0b\x82\x04' + b'\xc2\x0b\xc1\x07C,C\x06\x82\x0b\x82\x04\xc2\x0b\xc2\x06' + b'C,C\x05\x83\x0b\x82\x04\xc2\x0b\xc3\x05C,C\x05' + b'\x82\x0c\x82\x04\xc2\x0c\xc2\x05C,C\x05\x82\x0c\x82\x04' + b'\xc2\x0c\xc2\x05C,C\x06\x82\x0b\x82\x04\xc2\x0b\xc2\x06' + b'C,C\x06\x82\x0b\x82\x04\xc2\x0b\xc2\x06C,C\x07' + b'\x82\t\x82\x06\xc2\t\xc2\x07C,C\x08\x82\x07\x82\x08' + b'\xc2\x07\xc2\x08C,C\t\x83\x02\x84\n\xc4\x02\xc3\t' + b'C,C\n\x86\x0e\xc6\nC,C\x0c\x83\x10\xc3\x0c' + b'C,C.C,C.C,C.C,C.' + b'C,C.C,t-r/p2l?X@' + b'mf;d<d<d\x1e' + ) def __init__(self): - self.tests = ('Touch', 'String') + self.tests = ('Touch', 'String', 'Button', 'Crash', '1-bit RLE', '2-bit RLE') self.test = self.tests[0] + self.scroll = wasp.widgets.ScrollIndicator() - def foreground(self, system, effect=None): + def foreground(self): """Activate the application.""" self.on_screen = ( -1, -1, -1, -1, -1, -1 ) - self.draw(effect) - system.request_event(manager.EVENT_TOUCH | manager.EVENT_SWIPE_LEFTRIGHT) - - def background(self): - """De-activate the application (without losing state).""" - pass + self.draw() + wasp.system.request_event(wasp.EventMask.TOUCH | + wasp.EventMask.SWIPE_UPDOWN | + wasp.EventMask.BUTTON) - def sleep(self): - return False + def press(self, button, state): + draw = wasp.watch.drawable + if self.test == 'Touch': + draw.string('Button', 0, 108, width=240) + if self.test == 'String': + self.benchmark_string() + elif self.test == 'Button': + draw.string('{}: {}'.format(button, state), 0, 108, width=240) + elif self.test == 'Crash': + self.crash() def swipe(self, event): tests = self.tests - i = tests.index(self.test) + 1 - if i >= len(tests): - i = 0 + i = tests.index(self.test) + + if event[0] == wasp.EventType.UP: + i += 1 + if i >= len(tests): + i = 0 + else: + i -= 1 + if i < 0: + i = len(tests) - 1 self.test = tests[i] self.draw() def touch(self, event): - draw = watch.drawable if self.test == 'Touch': - draw.string('({}, {})'.format(event[1], event[2]), - 0, 108, width=240) + wasp.watch.drawable.string('({}, {})'.format( + event[1], event[2]), 0, 108, width=240) elif self.test == 'String': - draw.fill(0, 0, 30, 240, 240-30) - t = machine.Timer(id=1, period=8000000) - t.start() - draw.string("The quick brown", 12, 24+24) - draw.string("fox jumped over", 12, 24+48) - draw.string("the lazy dog.", 12, 24+72) - draw.string("0123456789", 12, 24+120) - draw.string('!"£$%^&*()', 12, 24+144) - elapsed = t.time() - t.stop() - del t - draw.string('{}s'.format(elapsed / 1000000), 12, 24+192) - - return True - - def draw(self, effect=None): + self.benchmark_string() + elif self.test == '1-bit RLE': + self.benchmark_rle_1bit() + elif self.test == '2-bit RLE': + self.benchmark_rle_2bit() + + def benchmark_rle_1bit(self): + draw = wasp.watch.drawable + draw.fill(0, 0, 30, 240, 240-30) + self.scroll.draw() + t = machine.Timer(id=1, period=8000000) + t.start() + for i in range(0, 128, 16): + draw.rleblit(self.ICON, (i, 30 + i)) + elapsed = t.time() + t.stop() + del t + draw.string('{}s'.format(elapsed / 1000000), 12, 24+192) + + def benchmark_rle_2bit(self): + draw = wasp.watch.drawable + draw.fill(0, 0, 30, 240, 240-30) + self.scroll.draw() + t = machine.Timer(id=1, period=8000000) + t.start() + for i in range(0, 128, 16): + draw.rle2bit(self.RLE_2BIT, i, 30 + i) + elapsed = t.time() + t.stop() + del t + draw.string('{}s'.format(elapsed / 1000000), 12, 24+192) + + def benchmark_string(self): + draw = wasp.watch.drawable + draw.fill(0, 0, 30, 240, 240-30) + self.scroll.draw() + t = machine.Timer(id=1, period=8000000) + t.start() + draw.string("The quick brown", 12, 24+24) + draw.string("fox jumped over", 12, 24+48) + draw.string("the lazy dog.", 12, 24+72) + draw.string("0123456789", 12, 24+120) + draw.string('!"£$%^&*()', 12, 24+144) + elapsed = t.time() + t.stop() + del t + draw.string('{}s'.format(elapsed / 1000000), 12, 24+192) + + def draw(self): """Redraw the display from scratch.""" - watch.display.mute(True) - watch.drawable.fill() - watch.drawable.string('{} test'.format(self.test), + wasp.watch.display.mute(True) + draw = wasp.watch.drawable + draw.fill() + draw.string('{} test'.format(self.test), 0, 6, width=240) - watch.display.mute(False) + self.scroll.draw() + + if self.test == 'Crash': + draw.string("Press button to", 12, 24+24) + draw.string("throw exception.", 12, 24+48) + elif self.test == '1-bit RLE': + draw.rleblit(self.ICON, (120-48, 120-32)) + elif self.test == '2-bit RLE': + draw.rle2bit(self.RLE_2BIT, 120-48, 120-32) + + wasp.watch.display.mute(False) diff --git a/wasp/boards/dsd6/manifest.py b/wasp/boards/dsd6/manifest.py index 9efab20..bee48c0 100644 --- a/wasp/boards/dsd6/manifest.py +++ b/wasp/boards/dsd6/manifest.py @@ -1,3 +1,6 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + freeze('../..', ( 'demo.py', diff --git a/wasp/boards/dsd6/watch.py b/wasp/boards/dsd6/watch.py index fdfdba9..0148d95 100644 --- a/wasp/boards/dsd6/watch.py +++ b/wasp/boards/dsd6/watch.py @@ -1,3 +1,6 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + from machine import RTCounter as RTC # Start measuring time (and feeding the watchdog) diff --git a/wasp/boards/nitrogen/manifest.py b/wasp/boards/nitrogen/manifest.py index f60ebd9..b17711b 100644 --- a/wasp/boards/nitrogen/manifest.py +++ b/wasp/boards/nitrogen/manifest.py @@ -1,3 +1,6 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + freeze('../..', ( 'demo.py', diff --git a/wasp/boards/nitrogen/watch.py b/wasp/boards/nitrogen/watch.py index fdfdba9..0148d95 100644 --- a/wasp/boards/nitrogen/watch.py +++ b/wasp/boards/nitrogen/watch.py @@ -1,3 +1,6 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + from machine import RTCounter as RTC # Start measuring time (and feeding the watchdog) diff --git a/wasp/boards/pinetime/manifest.py b/wasp/boards/pinetime/manifest.py index 6a19c1a..30d54e2 100644 --- a/wasp/boards/pinetime/manifest.py +++ b/wasp/boards/pinetime/manifest.py @@ -1,9 +1,13 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + freeze('.', 'watch.py', opt=3) freeze('../..', ( 'apps/clock.py', - 'apps/testapp.py', 'apps/flashlight.py', + 'apps/launcher.py', + 'apps/testapp.py', 'boot.py', 'demo.py', 'draw565.py', @@ -17,8 +21,8 @@ freeze('../..', 'fonts/sans24.py', 'icons.py', 'logo.py', - 'manager.py', 'shell.py', + 'wasp.py', 'widgets.py', ), opt=3 diff --git a/wasp/boards/pinetime/watch.py b/wasp/boards/pinetime/watch.py index 8248d9e..1caeea5 100644 --- a/wasp/boards/pinetime/watch.py +++ b/wasp/boards/pinetime/watch.py @@ -1,3 +1,6 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + # Start measuring time (and feeding the watchdog) before *anything* else from machine import RTCounter from drivers.nrf_rtc import RTC diff --git a/wasp/boards/simulator/display.py b/wasp/boards/simulator/display.py index 3d7d388..c226050 100644 --- a/wasp/boards/simulator/display.py +++ b/wasp/boards/simulator/display.py @@ -1,3 +1,6 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + """ Simulated ST7789 display and CST816S touchscreen. """ import sys @@ -38,7 +41,8 @@ class ST7789Sim(object): self.y = self.rowclip[0] elif self.cmd == RAMWR: - pixelview = sdl2.ext.PixelView(windowsurface) + #pixelview = sdl2.ext.PixelView(windowsurface) + pixelview = sdl2.ext.pixels2d(windowsurface) half = False for d in data: @@ -49,11 +53,14 @@ class ST7789Sim(object): rgb |= d half = False - pixel = ((rgb & 0xf800) >> 8, - (rgb & 0x07e0) >> 3, - (rgb & 0x001f) << 3) + #pixel = ((rgb & 0xf800) >> 8, + # (rgb & 0x07e0) >> 3, + # (rgb & 0x001f) << 3) + pixel = (((rgb & 0xf800) << 8) + + ((rgb & 0x07e0) << 5) + + ((rgb & 0x001f) << 3)) - pixelview[self.y][self.x] = pixel + pixelview[self.x][self.y] = pixel self.x += 1 if self.x > self.colclip[1]: @@ -83,14 +90,22 @@ class CST816SSim(): self.regs[1] = 0 def handle_key(self, key): + """Use key presses to provoke different touchscreen events. + + Note: The Down key provokes an upward swipe and vice versa. + Same for left and right. That is because the swipe up + gesture means show me the screen the is below me (hence + the controls are inverted compared to joystick-like + direction control). + """ if key.keysym.sym == sdl2.SDLK_DOWN: - self.regs[1] = 1 - elif key.keysym.sym == sdl2.SDLK_UP: self.regs[1] = 2 + elif key.keysym.sym == sdl2.SDLK_UP: + self.regs[1] = 1 elif key.keysym.sym == sdl2.SDLK_LEFT: - self.regs[1] = 3 - elif key.keysym.sym == sdl2.SDLK_RIGHT: self.regs[1] = 4 + elif key.keysym.sym == sdl2.SDLK_RIGHT: + self.regs[1] = 3 self.regs[3] = 0x80 self.raise_interrupt() diff --git a/wasp/boards/simulator/machine.py b/wasp/boards/simulator/machine.py index 62a95c5..2fc9754 100644 --- a/wasp/boards/simulator/machine.py +++ b/wasp/boards/simulator/machine.py @@ -1,3 +1,6 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + import display import time diff --git a/wasp/boards/simulator/micropython.py b/wasp/boards/simulator/micropython.py index 578a12d..41c30a4 100644 --- a/wasp/boards/simulator/micropython.py +++ b/wasp/boards/simulator/micropython.py @@ -1,3 +1,6 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + def const(fn): return fn diff --git a/wasp/boards/simulator/watch.py b/wasp/boards/simulator/watch.py index f38d7a1..ce281f4 100644 --- a/wasp/boards/simulator/watch.py +++ b/wasp/boards/simulator/watch.py @@ -1,3 +1,6 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + import time def sleep_ms(ms): time.sleep(ms / 1000) diff --git a/wasp/boards/sphinx/machine.py b/wasp/boards/sphinx/machine.py index b35a2a7..dfddb6d 100644 --- a/wasp/boards/sphinx/machine.py +++ b/wasp/boards/sphinx/machine.py @@ -1,3 +1,6 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + class ADC(): pass diff --git a/wasp/boards/sphinx/watch.py b/wasp/boards/sphinx/watch.py index dccee44..57b590e 100644 --- a/wasp/boards/sphinx/watch.py +++ b/wasp/boards/sphinx/watch.py @@ -1,3 +1,6 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + import time def sleep_ms(ms): time.sleep(ms / 1000) diff --git a/wasp/boot.py b/wasp/boot.py index de05e13..3e9cae3 100644 --- a/wasp/boot.py +++ b/wasp/boot.py @@ -1 +1,4 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + import watch diff --git a/wasp/demo.py b/wasp/demo.py index 6d3f6f5..a16c306 100644 --- a/wasp/demo.py +++ b/wasp/demo.py @@ -1,3 +1,6 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + # # Logo demo for PineTime # diff --git a/wasp/draw565.py b/wasp/draw565.py index bd72c65..50ff592 100644 --- a/wasp/draw565.py +++ b/wasp/draw565.py @@ -1,3 +1,6 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + import fonts.sans24 import micropython @@ -30,6 +33,17 @@ def _bitblit(bitbuf, pixels, bgfg: int, count: int): pxp += 1 @micropython.viper +def _expand_rgb(eightbit: int) -> int: + r = eightbit >> 5 + r = (r << 2) | (r >> 1) + g = (eightbit >> 2) & 7 + g *= 9 + b = eightbit & 3 + b *= 10 + + return (r << 11) | (g << 5) | b + +@micropython.viper def _fill(mv, color: int, count: int, offset: int): p = ptr8(mv) colorhi = color >> 8 @@ -75,6 +89,10 @@ class Draw565(object): and 24 pt Sans Serif text. """ self._display = display + self.reset() + + def reset(self): + """Restore the default colour and font.""" self.set_color(0xffff) self.set_font(fonts.sans24) @@ -116,6 +134,53 @@ class Draw565(object): else: color = bg + @micropython.native + def rle2bit(self, image, x, y): + """Decode and draw a 2-bit RLE image.""" + display = self._display + (sx, sy, rle) = image + + display.set_window(x, y, sx, sy) + + buf = memoryview(display.linebuffer)[0:2*sx] + bp = 0 + rl = 0 + palette = [ 0, 0xfffe, 0x7bef, 0xffff ] + next_color = 1 + + def blit_run(color, rl): + nonlocal bp + while rl: + count = min(sx - bp, rl) + _fill(buf, color, count, bp) + bp += count + rl -= count + + if bp >= sx: + display.write_data(buf) + bp = 0 + + for op in rle: + if rl == 0: + px = op >> 6 + rl = op & 0x3f + if 0 == rl: + rl = -1 + elif rl < 63: + blit_run(palette[px], rl) + rl = 0 + elif rl > 0: + rl += op + if op < 255: + blit_run(palette[px], rl) + rl = 0 + else: + palette[next_color] = _expand_rgb(op) + next_color += 1 + if next_color >= len(palette): + next_color = 1 + rl = 0 + def set_color(self, color, bg=0): """Set the foreground (color) and background (bg) color. diff --git a/wasp/drivers/battery.py b/wasp/drivers/battery.py index cc1eafb..c13f117 100644 --- a/wasp/drivers/battery.py +++ b/wasp/drivers/battery.py @@ -1,3 +1,6 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + # Generic lithium ion battery driver from machine import Pin, ADC diff --git a/wasp/drivers/cst816s.py b/wasp/drivers/cst816s.py index 323b9cc..d0f3cd2 100644 --- a/wasp/drivers/cst816s.py +++ b/wasp/drivers/cst816s.py @@ -1,3 +1,6 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + """Hynitron CST816S touch contoller driver for MicroPython. After modifying this file we can test the changes by replacing the diff --git a/wasp/drivers/nrf_rtc.py b/wasp/drivers/nrf_rtc.py index d907461..497c3d6 100644 --- a/wasp/drivers/nrf_rtc.py +++ b/wasp/drivers/nrf_rtc.py @@ -1,3 +1,6 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + """ Real Time Clock based on the nRF-family low power counter """ import time diff --git a/wasp/drivers/signal.py b/wasp/drivers/signal.py index 18ce8bf..974adb5 100644 --- a/wasp/drivers/signal.py +++ b/wasp/drivers/signal.py @@ -1,3 +1,6 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + class Signal(object): '''Simplified Signal class diff --git a/wasp/drivers/st7789.py b/wasp/drivers/st7789.py index 89ebc4c..980435b 100644 --- a/wasp/drivers/st7789.py +++ b/wasp/drivers/st7789.py @@ -1,3 +1,6 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + """Sitronix ST7789 display driver for MicroPython. Note: Although the ST7789 supports a variety of communication protocols diff --git a/wasp/drivers/vibrator.py b/wasp/drivers/vibrator.py index eba6018..359e738 100644 --- a/wasp/drivers/vibrator.py +++ b/wasp/drivers/vibrator.py @@ -1,3 +1,6 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + # Generic PWM capable vibrator import time @@ -11,7 +14,7 @@ class Vibrator(object): self.period = 16000 self.active_low = active_low - def pulse(self, duty=50, ms=100): + def pulse(self, duty=25, ms=40): pwm = PWM(0, self.pin, freq=self.freq, duty=duty, period=self.period) pwm.init() time.sleep_ms(ms) diff --git a/wasp/icons.py b/wasp/icons.py index 409a3d6..76b5ee7 100644 --- a/wasp/icons.py +++ b/wasp/icons.py @@ -1,3 +1,20 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + # 1-bit RLE, generated from res/battery.png, 189 bytes battery = (36, 48, b'\x97\x0e\x14\x12\x11\x14\x10\x14\x0c\x08\x0c\x08\x08\x08\x0c\x08\x08\x08\x0c\x08\x08\x08\x0c\x08\x08\x04\x14\x04\x08\x04\x14\x04\x08\x04\x0c\x04\x04\x04\x08\x04\x0b\x05\x04\x04\x08\x04\n\x06\x04\x04\x08\x04\t\x07\x04\x04\x08\x04\x08\x07\x05\x04\x08\x04\x07\x07\x06\x04\x08\x04\x06\x07\x07\x04\x08\x04\x05\x07\x08\x04\x08\x04\x04\x0e\x02\x04\x08\x04\x03\x0f\x02\x04\x08\x04\x02\x10\x02\x04\x08\x04\x02\x10\x02\x04\x08\x04\x02\x0f\x03\x04\x08\x04\x02\x0e\x04\x04\x08\x04\x08\x07\x05\x04\x08\x04\x07\x07\x06\x04\x08\x04\x06\x07\x07\x04\x08\x04\x05\x07\x08\x04\x08\x04\x04\x07\t\x04\x08\x04\x04\x06\n\x04\x08\x04\x04\x05\x0b\x04\x08\x04\x04\x04\x0c\x04\x08\x04\x14\x04\x08\x04\x14\x04\x08\x04\x14\x04\x08\x04\x14\x04\x08\x1c\x08\x1c\x08\x1c\x08\x1c\x98') +# 1-bit RLE, generated from res/app_icon.png, 441 bytes +app = (96, 64, b'\x1e$<$<$;&\x97,20/2-4,\x03.\x03,\x03.\x03,\x03.\x03,\x03.\x03,\x03.\x03,\x03\x0c\x03\x10\x03\x0c\x03,\x03\n\x07\x0c\x07\n\x03,\x03\t\x03\x02\x04\n\x04\x02\x03\t\x03,\x03\x08\x02\x07\x02\x08\x02\x07\x02\x08\x03,\x03\x07\x02\t\x02\x06\x02\t\x02\x07\x03,\x03\x06\x02\x0b\x02\x04\x02\x0b\x02\x06\x03,\x03\x06\x02\x0b\x02\x04\x02\x0b\x02\x06\x03,\x03\x05\x02\x0c\x02\x04\x02\x0c\x02\x05\x03,\x03\x05\x02\x0c\x02\x04\x02\x0c\x02\x05\x03,\x03\x05\x03\x0b\x02\x04\x02\x0b\x03\x05\x03,\x03\x06\x02\x0b\x02\x04\x02\x0b\x02\x06\x03,\x03\x06\x02\x0b\x02\x04\x02\x0b\x01\x07\x03,\x03\x07\x02\n\x02\x04\x02\n\x02\x07\x03+\x04\x08\x02\t\x02\x04\x02\t\x02\x08\x03*\x05\t\x0c\x04\x0c\t\x03*\x05\n\x0b\x04\x0b\n\x03*\x05.\x03*\x05.\x03*\x05.\x03*\x05.\x03*\x05\n\x0b\x04\x0b\n\x03+\x04\t\x0c\x04\x0c\t\x03,\x03\x08\x02\t\x02\x04\x02\t\x02\x08\x03,\x03\x07\x02\n\x02\x04\x02\n\x02\x07\x03,\x03\x06\x02\x0b\x02\x04\x02\x0b\x01\x07\x03,\x03\x06\x02\x0b\x02\x04\x02\x0b\x02\x06\x03,\x03\x05\x03\x0b\x02\x04\x02\x0b\x03\x05\x03,\x03\x05\x02\x0c\x02\x04\x02\x0c\x02\x05\x03,\x03\x05\x02\x0c\x02\x04\x02\x0c\x02\x05\x03,\x03\x06\x02\x0b\x02\x04\x02\x0b\x02\x06\x03,\x03\x06\x02\x0b\x02\x04\x02\x0b\x02\x06\x03,\x03\x07\x02\t\x02\x06\x02\t\x02\x07\x03,\x03\x08\x02\x07\x02\x08\x02\x07\x02\x08\x03,\x03\t\x03\x02\x04\n\x04\x02\x03\t\x03,\x03\n\x06\x0e\x06\n\x03,\x03\x0c\x03\x10\x03\x0c\x03,\x03.\x03,\x03.\x03,\x03.\x03,\x03.\x03,\x03.\x03,4-2/02,\x97&;$<$<$\x1e') + +# 1-bit RLE, generated from res/clock_icon.png, 301 bytes +clock = (96, 64, b'\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xcd\x06\r\x06!\x05\x0b\x08\x0c\x08\x0b\n\x1d\t\x07\x0c\n\x08\n\x0c\x1b\x0b\x06\x0e\x08\x03\x02\x03\n\x04\x05\x04\x1a\x04\x03\x04\x06\x02\x08\x04\r\x03\t\x04\x07\x03\x19\x04\x05\x04\x10\x04\x0c\x03\t\x03\t\x02\x19\x03\x07\x03\x11\x03\x0c\x03\t\x03\t\x03\n\x04\t\x04\x07\x04\x10\x03\x0c\x03\t\x03\t\x03\n\x04\t\x03\t\x03\x10\x03\x0c\x03\t\x03\t\x03\n\x04\t\x03\t\x03\x10\x03\x0c\x03\t\x04\x07\x04\n\x04\t\x03\t\x03\x0f\x04\x0c\x03\n\x04\x05\x05\n\x04\t\x03\x03\x02\x04\x03\x0e\x04\r\x03\n\n\x01\x03\x17\x03\x02\x04\x03\x03\r\x05\r\x03\x0b\t\x01\x03\x17\x03\x02\x03\x04\x03\x0c\x05\x0e\x03\r\x05\x03\x03\x17\x03\t\x03\x0b\x05\x0f\x03\x15\x03\x17\x03\t\x03\n\x05\x10\x03\x14\x04\x17\x03\t\x03\t\x05\x11\x03\x14\x03\x18\x04\x07\x04\x08\x04\x13\x03\x14\x03\x19\x03\x07\x03\x08\x04\x14\x03\x13\x04\x0b\x04\n\x03\x06\x04\x07\x04\x15\x03\x0b\x01\x05\x05\x0c\x04\x0b\x04\x03\x04\x07\x03\x12\r\x06\n\r\x04\x0b\x0b\x06\x0f\x07\r\x06\t\x0e\x04\x0c\t\x07\x0f\x07\r\x07\x06\x10\x04\x0e\x05\t\x0f\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xaa') + +# 1-bit RLE, generated from res/torch_icon.png, 283 bytes +torch = (96, 64, b'\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00e\x06W\nT\x04\x06\x02S\x03\x07\x02S\x02\n\x01\x0b\x029\x05\x08\x02\t\x02\x08\x03:\x07\x06\x02\x0b\x01\x06\x02$(\n\x02\x03\x03%(\x0c\x01+\x02%\x01\x0b\x02+\x02%\x01\x0c\x01+\x02\x05\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x05\x01\x0b\x02+\x02\x04\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x04\x01\x0c\x01+\x02%\x01\x0b\x02\x03\n\x1e\x02\x05\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x05\x01\x0c\x01+\x02\x04\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x04\x01\x0b\x02+\x02%\x01\x0c\x01+\x02%\x01\x0b\x02+(\x0c\x01,(\n\x02\x03\x03L\x02\x0b\x01\x06\x02K\x02\t\x02\x08\x03H\x02\n\x01\x0b\x02G\x03\x07\x02U\x04\x06\x02V\nY\x06\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xe2') + +# 1-bit RLE, generated from res/up_arrow.png, 16 bytes +up_arrow = (16, 9, b'\x07\x02\r\x04\x0b\x06\t\x08\x07\n\x05\x0c\x03\x0e\x01 ') + +# 1-bit RLE, generated from res/down_arrow.png, 17 bytes +down_arrow = (16, 9, b'\x00 \x01\x0e\x03\x0c\x05\n\x07\x08\t\x06\x0b\x04\r\x02\x07') diff --git a/wasp/logo.py b/wasp/logo.py index f526e2a..2020550 100644 --- a/wasp/logo.py +++ b/wasp/logo.py @@ -1,3 +1,6 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + pine64 = (240, 240, b'x\x01\xee\x03\xec\x05\xea\x07\xe8\t\xe6\x0b\xe4\r\xe2\x0f\xe0\x11\xde\x13\xdc\x15\xda\x17\xd8\x19\xd6\x1b\xd4\x1d\xd2\x1f\xd1 \xcf!\xce#\xcc%\xca\'\xc8)\xc6+\xc4-\xc3-\xc6\'\xcb#\xd0\x1d\xb6\x02\x1d\x19\x1b\x03\x99\x05\x1e\x13\x1c\x05\x99\x08\x1d\x0f\x1c\x08\x98\n\x1e\t\x1d\n\x97\r\x1e\x05\x1c\r\x97\x10:\x10\x96\x126\x12\x95\x151\x15\x95\x17-\x18\x93\x1b(\x1a\x93\x1d$\x1c\x93\x1e!\x1f\x91\x1d%\x1d\x91\x1b*\x1a\x91\x19.\x19\x8f\x17\x19\x01\x19\x17\x8f\x15\x19\x05\x19\x15\x8f\x13\x19\t\x1a\x13\x8d\x12\x19\r\x1a\x11\x8d\x10\x18\x12\x1a\x10\x8c\r\x19\x17\x19\x0e\x8b\x0c\x19\x1b\x19\x0c\x8b\n\x19\x1f\x1a\n\x89\t\x18$\x1a\x08\x89\x07\x18)\x19\x06\x89\x04\x19-\x19\x05\x87\x03\x191\x19\x03\x87\x01\x186\x19\x01\x9e;\xb3?\xafC\xabG\xa6L\xa2Q\x9dU\x98Z\x94^\x90c\x8bg\x87k\x85kn\x01\x18f\x1a\x01V\x03\x19a\x1a\x03V\x05\x19]\x1a\x05V\x07\x19Y\x19\x08V\n\x18T\x1a\nV\x0c\x19O\x1a\x0cV\x0e\x19K\x19\x0fV\x11\x18G\x19\x11V\x13\x18B\x1a\x13V\x16\x18=\x19\x16V\x18\x189\x19\x18V\x1a\x185\x19\x1aV\x1c\x181\x19\x1cV\x1f\x18+\x19\x1fV!\x18\'\x19!V#\x18#\x19#V%\x18\x1f\x18&V(\x17\x1a\x19(V*\x18\x15\x19*V,\x18\x11\x18-V/\x17\r\x18/V1\x17\x08\x191V4\x17\x03\x184V6.6V8*8V:&:V= =V<"<V:&:V7+8V505V3\x19\x01\x1a3V0\x1a\x05\x1b0V.\x19\x0b\x1a.V,\x19\x0f\x1a,V)\x1a\x13\x1b)V\'\x1a\x17\x1b\'V%\x19\x1d\x1a%V#\x19!\x1a#V \x1a%\x1b V\x1e\x1a)\x1b\x1eV\x1c\x1a.\x1a\x1cV\x19\x1b2\x1b\x19V\x17\x1a7\x1b\x17V\x14\x1b<\x1a\x15V\x12\x1b@\x1b\x12V\x10\x1aE\x1b\x10V\x0e\x1aI\x1b\x0eV\x0b\x1bM\x1c\x0bV\t\x1bQ\x1c\tV\x07\x1aW\x1b\x07V\x04\x1b[\x1b\x05V\x02\x1b_\x1c\x02qc\x8ai\x85m\x81q}uyzvyZ\x03\x1cu\x1d\x03=\x04\x1cq\x1d\x04>\x06\x1cm\x1d\x06?\x08\x1ch\x1c\x08@\n\x1cd\x1c\nA\x0c\x1b_\x1c\x0cB\x0e\x1b[\x1c\x0eB\x11\x1bV\x1b\x11C\x12\x1bR\x1b\x12D\x14\x1bM\x1c\x14E\x16\x1aI\x1b\x16F\x18\x1aE\x1b\x18G\x1a\x1a?\x1b\x1aH\x1c\x1a;\x1b\x1cI\x1e\x197\x1a\x1eJ \x193\x1a J"\x1a-\x1b!L$\x19)\x1a$L&\x19%\x1a&M(\x18!\x1a\'N*\x19\x1c\x19*O+\x19\x18\x19+P.\x18\x13\x19.Q/\x18\x0f\x19/R2\x18\n\x182S3\x18\x05\x193T5\x18\x01\x195T8,8U9(9V<"<W< <X:$:Y7(7Z4-5Z222[/\x1a\x01\x1b/\\-\x19\x06\x1b-])\x1a\x0b\x1b)^\'\x1a\x0f\x1b\'_$\x1a\x13\x1b$`!\x1a\x19\x1b!a\x1e\x1a\x1d\x1b\x1eb\x1c\x1a!\x1b\x1cc\x19\x1a%\x1b\x19d\x16\x1a*\x1c\x16d\x14\x1a/\x1b\x14e\x11\x1a3\x1b\x11f\x0f\x1a7\x1b\x0fg\x0b\x1a<\x1c\x0bh\t\x1a@\x1c\ti\x06\x1aE\x1b\x06j\x03\x1bI\x1c\x03\x86M\xa0S\x9bW\x97[\x93_\x8ee\x89i\x85m\x85i\x89e\x8d`\x93[\x97W\x9bS\x9fN\xa5I\xa9E\xadA\xb1<\xb68\xbb3\xbf/\xc3+\xc7&\xcd!\xd1\x1d\xd5\x19\xda\x13\xdf\x0f\xe2\x0c\xe4\x0c\xe4\x0c\xe4\x0c\xe4\x0c\xe4\x0c\xe4\x0c\xe4\x0c\xe4\x0c\xe4\x0c\xe4\x0c\xe4\x0c\xe4\x0c\xe4\x0c\xe4\x0c\xe4\x0c\xe4\x0c\xe4\x0c\xe4\x0c\xe4\x0c\xe4\x0c\xe4\x0c\xe4\x0c\xe4\x0c\xe4\x0c\xe4\x0c\xe4\x0c\xe4\x0c\xe4\x0c\xe4\x0cs') micropython = (240, 240, b'\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\x1fc\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!c\tc!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\t-\t-\t-!-\tc\t-!-\tc\t-!-\tc\t-!-\tc\t-!-\tc\t-!-\tc\t-!-\tc\t\x12\x0c\x0f!-\tc\t\x12\x0c\x0f!-\tc\t\x12\x0c\x0f!-\tc\t\x12\x0c\x0f!-\tc\t\x12\x0c\x0f!-\tc\t\x12\x0c\x0f!-\tc\t\x12\x0c\x0f!-\tc\t\x12\x0c\x0f!-\tc\t\x12\x0c\x0f!-\tc\t\x12\x0c\x0f!-\tc\t\x12\x0c\x0f!-\tc\t\x12\x0c\x0f!-\tc\t\x12\x0c\x0f!-\tc\t\x12\x0c\x0f!-\tc\t\x12\x0c\x0f!-\tc\t\x12\x0c\x0f!-\tc\t\x12\x0c\x0f!-\tc\t\x12\x0c\x0f!-\tc\t\x12\x0c\x0f!-\tc\t\x12\x0c\x0f!-\tc\t\x12\x0c\x0f!-\tc\t-!-\tc\t-!-\tc\t-!-\tc\t-!-\tc\t-!-\tc\t-!-\tc\t-!-\tc\t-!-\tc\t-!-\tc\t-!-\tc\t-!-\tc\t-!-\tc\t-!-\tc\t-!-\tc\t-!-\tc\t-!-\tc\t-!-\tc\t-\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\xff\x00\x11') diff --git a/wasp/main.py b/wasp/main.py index cc4c8b6..88fb87e 100644 --- a/wasp/main.py +++ b/wasp/main.py @@ -1,3 +1,5 @@ -import manager, watch -wasp = manager.Manager(watch) -wasp.run() +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + +import wasp +wasp.system.run() diff --git a/wasp/manager.py b/wasp/manager.py deleted file mode 100644 index 3dafebe..0000000 --- a/wasp/manager.py +++ /dev/null @@ -1,150 +0,0 @@ -import gc -import machine - -from apps.clock import ClockApp -from apps.flashlight import FlashlightApp -from apps.testapp import TestApp - -DOWN = 1 -UP = 2 -LEFT = 3 -RIGHT = 4 - -EVENT_TOUCH = 0x0001 -EVENT_SWIPE_LEFTRIGHT = 0x0002 -EVENT_SWIPE_UPDOWN = 0x0004 -EVENT_BUTTON = 0x0008 - -class Manager(object): - def __init__(self, watch): - self.watch = watch - - self.app = None - - self.applications = [ - ClockApp(), - FlashlightApp(), - TestApp() - ] - - self.watch.display.poweron() - self.switch(self.applications[0]) - self.watch.backlight.set(2) - - self.sleep_at = watch.rtc.uptime + 90 - self.charging = True - - def switch(self, app): - if self.app: - self.app.background() - - # Clear out any configuration from the old application - self.event_mask = 0 - self.tick_period_ms = 0 - self.tick_expiry = None - - self.app = app - self.watch.display.mute(True) - app.foreground(self) - self.watch.display.mute(False) - - def navigate(self, direction=None): - """Navigate between different applications. - - Currently the direction is ignored. - """ - app_list = self.applications - - if direction == DOWN: - i = app_list.index(self.app) + 1 - if i >= len(app_list): - i = 0 - self.switch(app_list[i]) - elif direction == UP: - i = app_list.index(self.app) - 1 - if i < 0: - i = len(app_list)-1 - self.switch(app_list[i]) - - def request_event(self, event_mask): - self.event_mask |= event_mask - - def request_tick(self, period_ms=None): - """Request (and subscribe to) a periodic tick event. - - Note: With the current simplistic timer implementation sub-second - tick intervals are not possible. - """ - self.tick_period_ms = period_ms - self.tick_expiry = self.watch.rtc.get_uptime_ms() + period_ms - - def handle_event(self, event): - self.sleep_at = self.watch.rtc.uptime + 15 - - event_mask = self.event_mask - if event[0] < 5: - updown = event[0] == 1 or event[0] == 2 - if (bool(event_mask & EVENT_SWIPE_UPDOWN) and updown) or \ - (bool(event_mask & EVENT_SWIPE_LEFTRIGHT) and not updown): - if not self.app.swipe(event): - self.navigate(event[0]) - else: - self.navigate(event[0]) - elif event[0] == 5 and self.event_mask & EVENT_TOUCH: - self.app.touch(event) - - def tick(self): - rtc = self.watch.rtc - - if self.sleep_at: - if rtc.update() and self.tick_expiry: - now = rtc.get_uptime_ms() - - if self.tick_expiry <= now: - ticks = 0 - while self.tick_expiry <= now: - self.tick_expiry += self.tick_period_ms - ticks += 1 - self.app.tick(ticks) - - if self.watch.button.value(): - self.sleep_at = self.watch.rtc.uptime + 15 - - event = self.watch.touch.get_event() - if event: - self.handle_event(event) - - if self.watch.rtc.uptime > self.sleep_at: - self.watch.backlight.set(0) - if not self.app.sleep(): - self.switch(self.applications[0]) - self.app.sleep() - self.watch.display.poweroff() - self.charging = self.watch.battery.charging() - self.sleep_at = None - - gc.collect() - else: - self.watch.rtc.update() - - charging = self.watch.battery.charging() - if self.watch.button.value() or self.charging != charging: - self.watch.display.poweron() - self.app.wake() - self.watch.backlight.set(2) - - # Discard any pending touch events - _ = self.watch.touch.get_event() - - self.sleep_at = self.watch.rtc.uptime + 15 - - def run(self): - """Run the system manager synchronously. - - This allows all watch management activities to handle in the - normal execution context meaning any exceptions and other problems - can be observed interactively via the console. - """ - while True: - self.tick() - machine.deepsleep() diff --git a/wasp/shell.py b/wasp/shell.py index 5ad9623..ace9513 100644 --- a/wasp/shell.py +++ b/wasp/shell.py @@ -1,3 +1,6 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + # SPDX-License-Identifier: MIT # Copyright (c) 2020 Daniel Thompson # Copyright (c) 2016 Paul Sokolovsky diff --git a/wasp/wasp.py b/wasp/wasp.py new file mode 100644 index 0000000..6016bd5 --- /dev/null +++ b/wasp/wasp.py @@ -0,0 +1,321 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson +"""WASP system management (including constants) + +.. data:: system = Manager() + + system is the system-wide instance of the Manager class. Applications + can use this instance to access system services. +""" + +import gc +import machine +import watch +import widgets + +from apps.clock import ClockApp +from apps.flashlight import FlashlightApp +from apps.launcher import LauncherApp +from apps.testapp import TestApp + +class EventType(): + """Enumerated interface actions. + + MicroPython does not implement the enum module so EventType + is simply a regular object which acts as a namespace. + """ + DOWN = 1 + UP = 2 + LEFT = 3 + RIGHT = 4 + TOUCH = 5 + + HOME = 256 + +class EventMask(): + """Enumerated event masks. + """ + TOUCH = 0x0001 + SWIPE_LEFTRIGHT = 0x0002 + SWIPE_UPDOWN = 0x0004 + BUTTON = 0x0008 + +class PinHandler(): + """Pin (and Signal) event generator. + + TODO: Currently this driver doesn't actually implement any + debounce but it will! + """ + + def __init__(self, pin): + """ + :param Pin pin: The pin to generate events from + """ + self._pin = pin + self._value = pin.value() + + def get_event(self): + """Receive a pin change event. + + Check for a pending pin change event and, if an event is pending, + return it. + + :return: boolean of the pin state if an event is received, None + otherwise. + """ + new_value = self._pin.value() + if self._value == new_value: + return None + + self._value = new_value + return new_value + +class Manager(): + """WASP system manager + + The manager is responsible for handling top-level UI events and + dispatching them to the foreground application. It also provides + services to the application. + + The manager is expected to have a single system-wide instance + which can be accessed via :py:data:`wasp.system` . + """ + + def __init__(self): + self.app = None + + self.applications = [] + self.blank_after = 15 + self.charging = True + self.launcher = LauncherApp() + + self._brightness = 2 + self._button = PinHandler(watch.button) + + # TODO: Eventually these should move to main.py + self.register(ClockApp(), True) + self.register(FlashlightApp(), True) + self.register(TestApp(), True) + + def register(self, app, quick_ring=True): + """Register an application with the system. + + :param object app: The application to regsister + """ + self.applications.append(app) + + @property + def brightness(self): + """Cached copy of the brightness current written to the hardware.""" + return self._brightness + + @brightness.setter + def brightness(self, value): + self._brightness = value + watch.backlight.set(self._brightness) + + def switch(self, app): + """Switch to the requested application. + """ + if self.app: + if 'background' in dir(self.app): + self.app.background() + else: + # System start up... + watch.display.poweron() + watch.display.mute(True) + watch.backlight.set(self._brightness) + self.sleep_at = watch.rtc.uptime + 90 + + # Clear out any configuration from the old application + self.event_mask = 0 + self.tick_period_ms = 0 + self.tick_expiry = None + + self.app = app + watch.display.mute(True) + watch.drawable.reset() + app.foreground() + watch.display.mute(False) + + def navigate(self, direction=None): + """Navigate to a new application. + + Left/right navigation is used to switch between applications in the + quick application ring. Applications on the ring are not permitted + to subscribe to :py:data`EventMask.SWIPE_LEFTRIGHT` events. + + Swipe up is used to bring up the launcher. Clock applications are not + permitted to subscribe to :py:data`EventMask.SWIPE_UPDOWN` events since + they should expect to be the default application (and is important that + we can trigger the launcher from the default application). + + :param int direction: The direction of the navigation + """ + app_list = self.applications + + if direction == EventType.LEFT: + if self.app in app_list: + i = app_list.index(self.app) + 1 + if i >= len(app_list): + i = 0 + else: + i = 0 + self.switch(app_list[i]) + elif direction == EventType.RIGHT: + if self.app in app_list: + i = app_list.index(self.app) - 1 + if i < 0: + i = len(app_list)-1 + else: + i = 0 + self.switch(app_list[i]) + elif direction == EventType.UP: + self.switch(self.launcher) + elif direction == EventType.DOWN: + if self.app != app_list[0]: + self.switch(app_list[0]) + else: + watch.vibrator.pulse() + elif direction == EventType.HOME: + if self.app != app_list[0]: + self.switch(app_list[0]) + else: + self.sleep() + + def request_event(self, event_mask): + """Subscribe to events. + + :param int event_mask: The set of events to subscribe to. + """ + self.event_mask |= event_mask + + def request_tick(self, period_ms=None): + """Request (and subscribe to) a periodic tick event. + + Note: With the current simplistic timer implementation sub-second + tick intervals are not possible. + """ + self.tick_period_ms = period_ms + self.tick_expiry = watch.rtc.get_uptime_ms() + period_ms + + def keep_awake(self): + """Reset the keep awake timer.""" + self.sleep_at = watch.rtc.uptime + self.blank_after + + def sleep(self): + """Enter the deepest sleep state possible. + """ + watch.backlight.set(0) + if 'sleep' not in dir(self.app) or not self.app.sleep(): + self.switch(self.applications[0]) + self.app.sleep() + watch.display.poweroff() + self.charging = watch.battery.charging() + self.sleep_at = None + + def wake(self): + """Return to a running state. + """ + watch.display.poweron() + self.app.wake() + watch.backlight.set(self._brightness) + + # Discard any pending touch events + _ = watch.touch.get_event() + + self.keep_awake() + + def _handle_button(self, state): + """Process a button-press (or unpress) event. + """ + self.keep_awake() + + if bool(self.event_mask & EventMask.BUTTON): + # Currently we only support one button + if not self.app.press(EventType.HOME, state): + # If app reported None or False then we are done + return + + if state: + self.navigate(EventType.HOME) + + def _handle_touch(self, event): + """Process a touch event. + """ + self.keep_awake() + + event_mask = self.event_mask + if event[0] < 5: + updown = event[0] == 1 or event[0] == 2 + if (bool(event_mask & EventMask.SWIPE_UPDOWN) and updown) or \ + (bool(event_mask & EventMask.SWIPE_LEFTRIGHT) and not updown): + if self.app.swipe(event): + self.navigate(event[0]) + else: + self.navigate(event[0]) + elif event[0] == 5 and self.event_mask & EventMask.TOUCH: + self.app.touch(event) + + def _tick(self): + """Handle the system tick. + + This function may be called frequently and includes short + circuit logic to quickly exit if we haven't reached a tick + expiry point. + """ + rtc = watch.rtc + + if self.sleep_at: + if rtc.update() and self.tick_expiry: + now = rtc.get_uptime_ms() + + if self.tick_expiry <= now: + ticks = 0 + while self.tick_expiry <= now: + self.tick_expiry += self.tick_period_ms + ticks += 1 + self.app.tick(ticks) + + state = self._button.get_event() + if None != state: + self._handle_button(state) + + event = watch.touch.get_event() + if event: + self._handle_touch(event) + + if self.sleep_at and watch.rtc.uptime > self.sleep_at: + self.sleep() + + gc.collect() + else: + watch.rtc.update() + + charging = watch.battery.charging() + if 1 == self._button.get_event() or self.charging != charging: + self.wake() + + def run(self): + """Run the system manager synchronously. + + This allows all watch management activities to handle in the + normal execution context meaning any exceptions and other problems + can be observed interactively via the console. + """ + if not self.app: + self.switch(self.applications[0]) + + # Reminder: wasptool uses this string to confirm the device has + # been set running again. + print('Watch is running, use Ctrl-C to stop') + + while True: + self._tick() + # Currently there is no code to control how fast the system + # ticks. In other words this code will break if we improve the + # power management... we are currently relying on no being able + # to stay in the low-power state for very long. + machine.deepsleep() + +system = Manager() diff --git a/wasp/widgets.py b/wasp/widgets.py index 3b2d6e1..9aa39a0 100644 --- a/wasp/widgets.py +++ b/wasp/widgets.py @@ -1,3 +1,6 @@ +# SPDX-License-Identifier: LGPL-3.0-or-later +# Copyright (C) 2020 Daniel Thompson + import icons import watch @@ -8,7 +11,7 @@ class BatteryMeter(object): def draw(self): self.level = -2 self.update() - + def update(self): icon = icons.battery draw = watch.drawable @@ -47,3 +50,19 @@ class BatteryMeter(object): draw.fill(rgb, x, 38 - h, w, h) self.level = level + +class ScrollIndicator(): + def __init__(self, x=240-18, y=240-24): + self._pos = (x, y) + self.up = True + self.down = True + + def draw(self): + self.update() + + def update(self): + draw = watch.drawable + if self.up: + draw.rleblit(icons.up_arrow, pos=self._pos, fg=0x7bef) + if self.down: + draw.rleblit(icons.down_arrow, pos=(self._pos[0], self._pos[1] + 13), fg=0x7bef) |
