From: b Date: Tue, 9 Aug 2022 22:04:56 +0000 (+0200) Subject: first full version X-Git-Tag: v1.0.0 X-Git-Url: http://bicyclesonthemoon.info/git-projects/?a=commitdiff_plain;h=refs%2Fheads%2Fmain;p=staf%2Fpy-staf first full version --- cce8f85dbbdeaaacb20d8c9bde05520f407931c8 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2ba7c7f --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/dist +/ref diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..37251cd --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,6 @@ +[build-system] +requires = [ + "setuptools", + "wheel" +] +build-backend = "setuptools.build_meta" diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..341e821 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +pyserial diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..9b879a5 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,13 @@ +[metadata] +name = staf +version = 1.0.0 +author = Balthasar Szczepański +author_email = rowerynaksiezycu@gmail.com +description = SilentTimer Action Figure communication library +url = http://1190.bicyclesonthemoon.info/staf + +[options] +python_requires= >=3.9 +install_requires= + pyserial +py_modules = staf diff --git a/staf.py b/staf.py new file mode 100644 index 0000000..4071f9d --- /dev/null +++ b/staf.py @@ -0,0 +1,1418 @@ +# SilentTimer Action Figure communication library +# libstaf.py +# +# 09.08.2022 +# Copyright (C) 2022 Balthasar Szczepański +# +# 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 . + +from enum import IntEnum, IntFlag, Enum +from typing import NamedTuple, Union +from datetime import datetime, timezone +import serial + +class STAF: + TIMEOUT = 0.02 + BUFFER_SIZE = 32 + + class Event(IntFlag): + NONE = 0x00 + TICK = 0x01 + BUTTON_A = 0x02 + BUTTON_B = 0x04 + BUTTON_C = 0x08 + ALARM = 0x10 + COUNTDOWN = 0x40 + + class Command(IntEnum): + GET_TIME = ord('G') + GET_MODE = ord('H') + GET_DISPLAY = ord('I') + GET_VALUE = ord('J') + GET_CALCULATION = ord('K') + GET_RUN_MODE = ord('L') + GET_VERSION = ord('M') + GET_PINOUT = ord('N') + GET_EVENT = ord('O') + GET_ALARM = ord('P') + GET_DIGIT = ord('Q') + READ_MEMORY = ord('R') + SET_DISPLAY = ord('g') + FREE_DISPLAY = ord('h') + TRIGGER_EVENT = ord('i') + GOTO_MODE = ord('j') + SELECT_DIGIT = ord('k') + SET_DIGIT_VALUE = ord('l') + CONFIRM = ord('m') + SET_TIME = ord('n') + SET_ALARM = ord('o') + SET_DATE = ord('p') + SET_YEAR = ord('q') + SET_COUNTDOWN = ord('r') + SET_CALIBRATION = ord('s') + SET_DEBUG_ADDRESS = ord('t') + SET_DEBUG_VALUE = ord('u') + CALCULATE = ord('v') + SET_VALUE = ord('w') + SET_RUN_MODE = ord('x') + SET_BUZZER_MODE = ord('y') + WRITE_MEMORY = ord('z') + + class Mode(IntEnum): + TIME = 0x00 + ALARM = 0x01 + DATE = 0x02 + COUNTUP = 0x03 + COUNTDOWN = 0x04 + CALIBRATION = 0x05 + VERSION = 0x06 + DEBUG = 0x07 + RESET = 0x08 + CALCULATOR = 0x09 + SET_TIME = 0x80 + SET_ALARM = 0x81 + SET_DATE = 0x82 + SET_YEAR = 0x83 + SET_COUNTDOWN = 0x84 + SET_CALIBRATION = 0x85 + SET_DEBUG_ADDRESS = 0x86 + SET_DEBUG_VALUE = 0x87 + SET_CALC_NUMBER = 0x88 + SET_CALC_OPERATOR = 0x89 + + BUZZER = ord('U') + EndFrame = [ + ord('\r'), + ord('\n') + ] + GetCommand = range(ord('G'), ord('Z')+1) + SetCommand = range(ord('g'), ord('z')+1) + + class Register(IntEnum): + RTCHSEC = 0x00 + RTCSEC = 0x01 + RTCMIN = 0x02 + RTCHOUR = 0x03 + RTCWKDAY = 0x04 + RTCDATE = 0x05 + RTCMTH = 0x06 + RTCYEAR = 0x07 + CONTROL = 0x08 + OSCTRIM = 0x09 + ALM0SEC = 0x0C + ALM0MIN = 0x0D + ALM0HOUR = 0x0E + ALM0WKDAY = 0x0F + ALM0DATE = 0x10 + ALM0MTH = 0x11 + ALM1HSEC = 0x12 + ALM1SEC = 0x13 + ALM1MIN = 0x14 + ALM1HOUR = 0x15 + ALM1WKDAY = 0x16 + ALM1DATE = 0x17 + PWRDNMIN = 0x18 + PWRDNHOUR = 0x19 + PWRDNDATE = 0x1A + PWRDNMTH = 0x1B + PWRUPMIN = 0x1C + PWRUPHOUR = 0x1D + PWRUPDATE = 0x1E + PWRUPMTH = 0x1F + # in SRAM by STAF software: + ALARMFLAG = 0x20 + ALARMMIN = 0x21 + ALARMHOUR = 0x22 + CDNFLAG = 0x23 + CDNSEC = 0x24 + CDNMIN = 0x25 + YEARFLAG = 0x26 + YEARLOW = 0x27 + YEARHIGH = 0x28 + + ALARMFLAG = 0xA5 + + class BuzzerMode(IntEnum): + ENABLED = 0x00 + DISABLED = 0x01 + FORCED = 0x02 + + class CalculationFlag(IntFlag): + NEGATIVE = 0b00000001 + DEC_POINT = 0b00000010 + NEGATIVE2 = 0b00000100 + DEC_POINT2 = 0b00001000 + NEGATIVE1 = 0b00010000 + DEC_POINT1 = 0b00100000 + DIVIDE = 0b11000000 + MULTIPLY = 0b10000000 + SUBTRACT = 0b01000000 + ADD = 0b00000000 + OPERATOR = 0b11000000 + + class Calculation(IntEnum): + ADD = 0b00000000 + SUBTRACT = 0b01000000 + MULTIPLY = 0b10000000 + DIVIDE = 0b11000000 + + class Display(IntFlag): + none = 0x00000000 + a0 = 0x00000001 + b0 = 0x00000002 + c0 = 0x00000004 + d0 = 0x00000008 + e0 = 0x00000010 + f0 = 0x00000020 + g0 = 0x00000040 + h0 = 0x00000080 + a1 = 0x00000100 + b1 = 0x00000200 + c1 = 0x00000400 + d1 = 0x00000800 + e1 = 0x00001000 + f1 = 0x00002000 + g1 = 0x00004000 + h1 = 0x00008000 + a2 = 0x00010000 + b2 = 0x00020000 + c2 = 0x00040000 + d2 = 0x00080000 + e2 = 0x00100000 + f2 = 0x00200000 + g2 = 0x00400000 + h2 = 0x00800000 + a3 = 0x01000000 + b3 = 0x02000000 + c3 = 0x04000000 + d3 = 0x08000000 + e3 = 0x10000000 + f3 = 0x20000000 + g3 = 0x40000000 + h3 = 0x80000000 + n0 = 0x00000001 + ne0 = 0x00000002 + se0 = 0x00000004 + s0 = 0x00000008 + sw0 = 0x00000010 + nw0 = 0x00000020 + mid0= 0x00000040 + n1 = 0x00000100 + ne1 = 0x00000200 + se1 = 0x00000400 + s1 = 0x00000800 + sw1 = 0x00001000 + nw1 = 0x00002000 + mid1= 0x00004000 + n2 = 0x00010000 + ne2 = 0x00020000 + se2 = 0x00040000 + s2 = 0x00080000 + sw2 = 0x00100000 + nw2 = 0x00200000 + mid2= 0x00400000 + n3 = 0x01000000 + ne3 = 0x02000000 + se3 = 0x04000000 + s3 = 0x08000000 + sw3 = 0x10000000 + nw3 = 0x20000000 + mid3= 0x40000000 + dot_top = 0x00000080 + dot_bottom = 0x00008000 + dot_alarm = 0x80000000 + + class HSEC(IntFlag): + HSECONE0 = 0b00000001 + HSECONE1 = 0b00000010 + HSECONE2 = 0b00000100 + HSECONE3 = 0b00001000 + HSECTEN0 = 0b00010000 + HSECTEN1 = 0b00100000 + HSECTEN2 = 0b01000000 + HSECTEN3 = 0b10000000 + HSECONE = 0b00001111 + HSECTEN = 0b11110000 + HSEC = 0b11111111 + + class SEC(IntFlag): + SECONE0 = 0b00000001 + SECONE1 = 0b00000010 + SECONE2 = 0b00000100 + SECONE3 = 0b00001000 + SECTEN0 = 0b00010000 + SECTEN1 = 0b00100000 + SECTEN2 = 0b01000000 + ST = 0b10000000 + SECONE = 0b00001111 + SECTEN = 0b01110000 + SEC = 0b01111111 + + class MIN(IntFlag): + MINONE0 = 0b00000001 + MINONE1 = 0b00000010 + MINONE2 = 0b00000100 + MINONE3 = 0b00001000 + MINTEN0 = 0b00010000 + MINTEN1 = 0b00100000 + MINTEN2 = 0b01000000 + MINONE = 0b00001111 + MINTEN = 0b01110000 + MIN = 0b01111111 + + class HOUR(IntFlag): + HOURONE0 = 0b00000001 + HOURONE1 = 0b00000010 + HOURONE2 = 0b00000100 + HOURONE3 = 0b00001000 + HOURTEN0 = 0b00010000 + HOURTEN1 = 0b00100000 + AM_PM = 0b00100000 + H12_14 = 0b01000000 + TRIMSIGN = 0b10000000 + HOURONE = 0b00001111 + HOURTEN12 = 0b00010000 + HOURTEN24 = 0b00110000 + HOUR12 = 0b00011111 + HOUR24 = 0b00111111 + + class WKDAY(IntFlag): + WKDAY0 = 0b00000001 + WKDAY1 = 0b00000010 + WKDAY2 = 0b00000100 + VBATEN = 0b00001000 + PWRFAIL = 0b00010000 + OSCRUN = 0b00100000 + ALMxIF = 0b00001000 + ALMnMSK0 = 0b00010000 + ALMnMSK1 = 0b00100000 + ALMnMSK2 = 0b01000000 + ALMnPIN = 0b10000000 + WKDAY = 0b00000111 + ALMnMSK = 0b01110000 + + class DATE(IntFlag): + DATEONE0 = 0b00000001 + DATEONE1 = 0b00000010 + DATEONE2 = 0b00000100 + DATETEN0 = 0b00001000 + DATETEN1 = 0b00010000 + DATEONE = 0b00001111 + DATETEN = 0b00110000 + DATE = 0b00111111 + + class MTH(IntFlag): + MTHONE0 = 0b00000001 + MTHONE1 = 0b00000010 + MTHONE2 = 0b00000100 + MTHTEN0 = 0b00001000 + LPYR = 0b00010000 + MTHONE = 0b00001111 + MTHTEN = 0b00010000 + MTH = 0b00011111 + + class YEAR(IntFlag): + YRONE0 = 0b00000001 + YRONE1 = 0b00000010 + YRONE2 = 0b00000100 + YRTEN0 = 0b00001000 + YRTEN1 = 0b00010000 + YRTEN2 = 0b00010000 + YRTEN3 = 0b00100000 + YRONE = 0b00001111 + YRTEN = 0b11110000 + YR = 0b11111111 + + class CONTROL(IntFlag): + SQWFS0 = 0b00000001 + SQWFS1 = 0b00000010 + CRSTRIM = 0b00000100 + EXTOSC = 0b00001000 + ALM0EN = 0b00010000 + ALM1EN = 0b00100000 + SQWEN = 0b01000000 + SQWFS = 0b00000011 + + class OSCTRIM(IntFlag): + TRIMVAL0 = 0b00000001 + TRIMVAL1 = 0b00000010 + TRIMVAL2 = 0b00000100 + TRIMVAL3 = 0b00001000 + TRIMVAL4 = 0b00010000 + TRIMVAL5 = 0b00100000 + TRIMVAL6 = 0b01000000 + TRIMVAL7 = 0b10000000 + TRIMVAL = 0b11111111 + + class _frame(NamedTuple): + command: int + data: list[int] + + class _calc_arg(NamedTuple): + value: int + flags: int + + class State(NamedTuple): + mode: int + running: bool + digit: int + value: list[int] + + class Alarm(NamedTuple): + enabled: bool + hour: Union[int, None] + minute: Union[int, None] + + class Version(NamedTuple): + major: int + minor: int + + def __init__( + self, + port: str, + open: bool = False, + get_pinout: bool = False + ): + self._serial = serial.Serial( + port=None, + baudrate=9600, + bytesize=serial.EIGHTBITS, + parity=serial.PARITY_NONE, + stopbits=serial.STOPBITS_ONE, + timeout=self.TIMEOUT, + xonxoff=False, + rtscts=False, + dsrdtr=False, + write_timeout=self.TIMEOUT, + inter_byte_timeout=None, + # exclusive=False + ) + self._serial.port = port + self._event: int = self.Event.NONE + self._pinout: list[int] = None + + if open: + self.open(get_pinout) + + def __del__(self): + self.close() + + def open( + self, + get_pinout: bool = False + ): + if not (self._serial.is_open): + self._serial.open() + if get_pinout: + self.get_pinout() + + def close(self): + if self._serial.is_open: + self._serial.close() + + @staticmethod + def _enum( + enum_type: IntEnum.__class__, + value: int + ) -> Union[Enum, int]: + value = int(value) + if value in enum_type.__members__.values(): + return enum_type(value) + else: + return value + + @staticmethod + def _join_u8( + h: int, + l: int + ) -> int: + return h << 4 | l + + @staticmethod + def _split_u8( + x: int + ) -> tuple[int, int]: + h = x >> 4 + l = x & 0x0f + return h, l + + @staticmethod + def _join_u16( + h: int, + l: int + ) -> int: + return h << 8 | l + + @staticmethod + def _split_u16( + x: int + ) -> tuple[int, int]: + h = x >> 8 + l = x & 0xFF + return h, l + + @classmethod + def _encode_BCD_u8( + cls, + x: int + ) -> int: + p, q = divmod(x, 10) + y = cls._join_u8(p, q) + return y + + @classmethod + def _decode_BCD_u8( + cls, + x: int + ) -> int: + p, q = cls._split_u8(x) + y = p*10+q + return y + + @classmethod + def _encode_BCD_u16( + cls, + x: int + ) -> int: + p, q = divmod(x, 100) + y = cls._join_u16(cls._encode_BCD_u8(p), cls._encode_BCD_u8(q)) + return y + + @classmethod + def _decode_BCD_u16( + cls, + x: int + ) -> int: + p, q = cls._split_u16(x) + y = (cls._decode_BCD_u8(p) * 100) + cls._decode_BCD_u8(q) + return y + + @classmethod + def _encode_calc_arg( + cls, + x: float, + arg: int = 0 + ) -> _calc_arg: + if arg == 1: + negative = cls.CalculationFlag.NEGATIVE1 + dec_point = cls.CalculationFlag.DEC_POINT1 + elif arg == 2: + negative = cls.CalculationFlag.NEGATIVE2 + dec_point = cls.CalculationFlag.DEC_POINT2 + else: + negative = cls.CalculationFlag.NEGATIVE + dec_point = cls.CalculationFlag.DEC_POINT + + flags = 0x00 + if x < 0: + flags |= negative + x = -1.0 * x + limit = 999.5 + else: + limit = 9999.5 + + if x >= limit: + raise ValueError("Number out of range") + + xf = x * 100.0 + if xf >= limit: + y = x + else: + y = xf + flags |= dec_point + + return cls._calc_arg( + value=cls._encode_BCD_u16(int(y+0.5)), + flags=flags + ) + + @classmethod + def _decode_calc_arg( + cls, + x: int, + flags: int, + arg: int = 0 + ) -> float: + if arg == 1: + negative = cls.CalculationFlag.NEGATIVE1 + dec_point = cls.CalculationFlag.DEC_POINT1 + elif arg == 2: + negative = cls.CalculationFlag.NEGATIVE2 + dec_point = cls.CalculationFlag.DEC_POINT2 + else: + negative = cls.CalculationFlag.NEGATIVE + dec_point = cls.CalculationFlag.DEC_POINT + + y = float(cls._decode_BCD_u16(x)) + + if flags & negative: + y *= -1.0 + if flags & dec_point: + y *= 0.01 + + return y + + def _read( + self, + length: int + ) -> list[int]: + buffer = [] + while len(buffer) < length: + r = self._serial.read(1) + if len(r) == 0: + break + inbyte = r[0] + if inbyte == self.BUZZER: + continue + if (inbyte in self.GetCommand) or (inbyte in self.SetCommand): + buffer = [] + + buffer.append(inbyte) + + if inbyte in self.EndFrame: + if len(buffer) == 1: + buffer = [] + continue + else: + break + + return buffer + + def _write( + self, + buffer: list[int] + ) -> int: + length = len(buffer) + buffer = bytes(buffer) + + while len(buffer) > 0: + r = self._serial.write(buffer) + buffer = buffer[r:] + # break if ??? + + return length-len(buffer) + + def _get_frame( + self, + length: int + ) -> _frame: + length_b = 2 * length + 2 + + r = self._read(max(length_b, self.BUFFER_SIZE)) + + if (len(r) == 0) and (length != 0): + raise serial.SerialTimeoutException('No response from STAF.') + if len(r) < length_b: + raise serial.SerialException('Incomplete response from STAF.') + if (r[length_b-1] not in self.EndFrame) or ((r[0] not in self.GetCommand) and (r[0] not in self.SetCommand)): + raise serial.SerialException('Invalid response from STAF.') + + data = [] + j = 1 + for i in range(length): + b = 0 + for k in range(2): + if ord('0') <= r[j+k] <= ord('9'): + h = r[j+k] - ord('0') + elif ord('A') <= r[j+k] <= ord('F'): + h = r[j+k] - ord('A') + 10 + elif ord('a') <= r[j+k] <= ord('f'): + h = r[j+k] - ord('a') + 10 + else: + raise serial.SerialException('Invalid response from STAF.') + if k == 0: + b = h << 4 + else: + data.append(b | h) + j += 2 + + return self._frame( + command=r[0], + data=data + ) + + def _send_frame( + self, + command: int, + data: list[int] = [] + ) -> None: + if (command not in self.GetCommand) and (command not in self.SetCommand): + raise ValueError('Invalid command') + buffer = [command] + for b in data: + h = 0 + for k in range(2): + if k == 0: + h = b >> 4 + else: + h = b & 0x0F + if h < 10: + buffer.append(h + ord('0')) + else: + buffer.append(h + ord('a') - 10) + buffer.append(ord('\n')) + + r = self._write(buffer) + if r < len(buffer): + raise serial.SerialException(('Nothing' if r == 0 else 'Incomplete frame') + ' sent to STAF.') + + def _check_event(self) -> None: + while self._serial.in_waiting > 1: # don't get fooled by a single '\n' + try: + command, data = self._get_frame(length=1) + if command == self.Command.GET_EVENT: + self._event |= data[0] + else: + # raise serial.SerialException('Invalid data from STAF') + pass + except serial.SerialTimeoutException: + pass + + def _execute_command( + self, + command: int, + data_out: list[int] = [], + length_in: int = 0 + ) -> list[int]: + self._check_event() + self._serial.flushInput() + + self._send_frame( + command=command, + data=data_out + ) + if length_in > 0: + command_in, data_in = self._get_frame(length=length_in) + if command_in != command: + raise serial.SerialException('Invalid response from STAF.') + return data_in + else: + return [] + + def get_state(self) -> State: + mode = self.get_mode() + running = self.is_running() + digit = self.get_digit() + value = self.get_value() + return self.State( + mode=mode, + running=running, + digit=digit, + value=value + ) + + def set_state( + self, + state: State + ): + self.set_mode(state.mode) + self.set_running(state.running) + self.set_digit(state.digit) + self.set_value(state.value) + + def get_mode(self) -> Union[int, Mode]: + r = self._execute_command( + command=self.Command.GET_MODE, + length_in=1 + ) + return self._enum( + enum_type=self.Mode, + value=r[0] + ) + + def set_mode( + self, + mode: Union[int, Mode] + ) -> None: + if not (0x00 <= mode <= 0xFF): + raise ValueError('Invalid mode.') + self._execute_command( + command=self.Command.GOTO_MODE, + data_out=[mode] + ) + + def subscribe_event( + self, + event: Union[int, Event] + ) -> None: + if not (0x00 <= event <= 0xFF): + raise ValueError('Invalid event.') + r = self._execute_command( + command=self.Command.GET_EVENT, + data_out=[event], + length_in=1 + ) + self._event |= r[0] + + def get_event(self) -> Union[int, Event]: + event = self._event + self._event = self.Event.NONE + return event + + def trigger_event( + self, + event: Union[int, Event] + ) -> None: + if not (0x00 <= event <= 0xFF): + raise ValueError('Invalid event.') + self._execute_command( + command=self.Command.TRIGGER_EVENT, + data_out=[event], + ) + + def get_pinout( + self + ) -> list[int]: + r = self._execute_command( + command=self.Command.GET_PINOUT, + length_in=4 + ) + self._pinout = [] + for b in r: + self._pinout.append(0xFF & (~(1 << (b >> 4)))) + self._pinout.append(0xFF & (~(1 << (b & 0x0f)))) + return self._pinout + + def get_display( + self, + pinout: list[int] = None + ) -> Union[int, Display]: + if pinout is None: + pinout = self._pinout + if pinout is None: + raise RuntimeError('Unknown display pinout.') + if len(pinout) != 8: + raise ValueError('Invalid display pinout.') + r = self._execute_command( + command=self.Command.GET_DISPLAY, + length_in=4 + ) + display = self.Display.none + for i, b in enumerate(r): + for j, p in enumerate(pinout): + if (b | p) != 0xFF: + display |= 1 << ((i << 3) + j) + return display + + def set_display( + self, + display: int, + pinout: list[int] = None + ) -> None: + if pinout is None: + pinout = self._pinout + if pinout is None: + raise RuntimeError('Unknown display pinout.') + if len(pinout) != 8: + raise ValueError('Invalid display pinout.') + data = [] + for i in range(4): + d = 0xFF; + for j, p in enumerate(pinout): + if display & (1 << ((i << 3) +j)): + d &= p + data.append(d) + self._execute_command( + command=self.Command.SET_DISPLAY, + data_out=data + ) + + def free_display(self) -> None: + self._execute_command( + command=self.Command.FREE_DISPLAY + ) + + def get_time( + self, + tzinfo: timezone = None + ) -> datetime: + r = self._execute_command( + command=self.Command.GET_TIME, + length_in=8 + ) + return datetime( + year=self._decode_BCD_u16(self._join_u16(h=r[7], l=r[6])), + month=self._decode_BCD_u8(r[5]), + day=self._decode_BCD_u8(r[4]), + hour=self._decode_BCD_u8(r[3]), + minute=self._decode_BCD_u8(r[2]), + second=self._decode_BCD_u8(r[1]), + microsecond=self._decode_BCD_u8(r[0])*10000, + tzinfo=tzinfo + ) + + def set_time( + self, + hour: int, + minute: int, + second: int = None, + restore_state: bool = False + ) -> None: + if not ((0 <= hour <= 23) and (0 <= minute <= 59)): + raise ValueError('Invalid time setting.') + if (second is not None) and not (0 <= second <= 59): + raise ValueError('Invalid time setting.') + state = None + if restore_state: + state = self.get_state() + self._execute_command( + command=self.Command.SET_TIME, + data_out=[ + self._encode_BCD_u8(minute), + self._encode_BCD_u8(hour) + ] + ) + if second is not None: + v = self.get_debug_value( + address=self.Register.RTCSEC + ) + v = (v & self.SEC.ST) | (second & self.SEC.SEC) + self.set_debug_value( + address=self.Register.RTCSEC, + value=v + ) + if restore_state: + self.set_state(state) + + def set_date( + self, + month: int, + day: int, + restore_state: bool = False + ) -> None: + d = 29 if (month == 2) else 31 if (((month & 0b1000) >> 3) ^ (month & 0b0001)) else 30 + if not ((1 <= month <= 12) and (1 <= day <= d)): + raise ValueError('Invalid time setting.') + state = None + if restore_state: + state = self.get_state() + self._execute_command( + command=self.Command.SET_DATE, + data_out=[ + self._encode_BCD_u8(day), + self._encode_BCD_u8(month) + ] + ) + if restore_state: + self.set_state(state) + + def set_year( + self, + year: int, + restore_state: bool = False + ) -> None: + if not (0 <= year <= 9999): + raise ValueError('Invalid time setting.') + yh, yl = self._split_u16(self._encode_BCD_u16(year)) + state = None + if restore_state: + state = self.get_state() + self._execute_command( + command=self.Command.SET_YEAR, + data_out=[ + yl, + yh + ] + ) + if restore_state: + self.set_state(state) + + def set_full_time( + self, + time: datetime, + set_seconds: bool = False, + restore_state: bool = False + ) -> None: + state = None + if restore_state: + state = self.get_state() + self.set_time( + hour = time.hour, + minute = time.minute, + second = time.second if set_seconds else None, + ) + self.set_date( + month=time.month, + day=time.day + ) + self.set_year( + year=time.year + ) + if restore_state: + self.set_state(state) + + def get_alarm(self) -> Alarm: + r = self._execute_command( + command=self.Command.GET_ALARM, + length_in=2 + ) + hour = r[1] + minute = r[0] + enabled = (hour != 0xFF) or (minute != 0xFF) + return self.Alarm( + enabled=enabled, + hour=self._decode_BCD_u8(hour) if enabled else None, + minute=self._decode_BCD_u8(minute) if enabled else None, + ) + + def set_alarm( + self, + hour: int, + minute: int, + restore_state: bool = False + ) -> None: + if not ((0 <= hour <= 23) and (0 <= minute <= 59)): + raise ValueError('Invalid alarm setting.') + state = None + if restore_state: + state = self.get_state() + self._execute_command( + command=self.Command.SET_ALARM, + data_out=[ + self._encode_BCD_u8(minute), + self._encode_BCD_u8(hour) + ] + ) + if restore_state: + self.set_state(state) + + def clear_alarm( + self, + restore_state: bool = False + ) -> None: + state = None + if restore_state: + state = self.get_state() + self._execute_command( + command=self.Command.SET_ALARM, + data_out=[ + 0xFF, + 0xFF + ] + ) + if restore_state: + self.set_state(state) + + def set_countdown( + self, + minute: int, + second: int, + restore_state: bool = False + ) -> None: + if not ((0 <= minute <= 99) and (0 <= second <= 59)): + raise ValueError('Invalid countdown setting.') + state = None + if restore_state: + state = self.get_state() + self._execute_command( + command=self.Command.SET_COUNTDOWN, + data_out=[ + self._encode_BCD_u8(second), + self._encode_BCD_u8(minute) + ] + ) + if restore_state: + self.set_state(state) + + def is_running(self) -> bool: + r = self._execute_command( + command=self.Command.GET_RUN_MODE, + length_in=1 + ) + return bool(r[0]) + + def set_running( + self, + running: bool + ) -> None: + self._execute_command( + command=self.Command.SET_RUN_MODE, + data_out=[ + 1 if running else 0 + ] + ) + + def get_version(self) -> Version: + r = self._execute_command( + command=self.Command.GET_VERSION, + length_in=2 + ) + return self.Version( + major=self._decode_BCD_u8(r[1]), + minor=self._decode_BCD_u8(r[0]) + ) + + def get_digit(self) -> int: + r = self._execute_command( + command=self.Command.GET_DIGIT, + length_in=1 + ) + return r[0] + + def set_digit( + self, + digit: int + ) -> None: + if not (0 <= digit <= 4): + raise ValueError('Invalid digit.') + self._execute_command( + command=self.Command.SELECT_DIGIT, + data_out=[ + digit + ] + ) + + def get_digit_value(self) -> int: + digit = self.get_digit() + value = self.get_value() + value = value[digit >> 1] + if digit & 0x01: + return value >> 4 + else: + return value & 0x0f + + def set_digit_value( + self, + value: int + ) -> None: + if not (0x00 <= value <= 0x0f): + raise ValueError('Invalid digit value.') + self._execute_command( + command=self.Command.SET_DIGIT_VALUE, + data_out=[ + value + ] + ) + + def get_value(self) -> list[int]: + return self._execute_command( + command=self.Command.GET_VALUE, + length_in=3 + ) + + def set_value( + self, + value: list[int] + ) -> None: + if len(value) != 3: + raise ValueError('Invalid value length.') + for v in value: + if not (0x00 <= v <= 0xFF): + raise ValueError('Invalid value.') + self._execute_command( + command=self.Command.SET_VALUE, + data_out=value + ) + + def confirm(self) -> None: + self._execute_command( + command=self.Command.CONFIRM + ) + + def set_debug_address( + self, + address: int + ) -> None: + if not (0x00 <= address <= 0xFF): + raise ValueError('Invalid address.') + self._execute_command( + command=self.Command.SET_DEBUG_ADDRESS, + data_out=[ + address + ] + ) + + def get_debug_value( + self, + address: int, + restore_state: bool = False + ) -> int: + # if not (0x00 <= address <= 0xFF): + # raise ValueError('Invalid address.') + state = None + if restore_state: + state = self.get_state() + self.set_debug_address(address) + self.trigger_event(self.Event.TICK) + value = self.get_value()[0] + if restore_state: + self.set_state(state) + return value + + def set_debug_value( + self, + address: int, + value: int, + restore_state: bool = False + ) -> None: + if not (0x00 <= address <= 0xFF): + raise ValueError('Invalid address.') + if not (0x00 <= value <= 0xFF): + raise ValueError('Invalid value.') + state = None + if restore_state: + state = self.get_state() + self._execute_command( + command=self.Command.SET_DEBUG_VALUE, + data_out=[ + value, + address + ] + ) + if restore_state: + self.set_state(state) + + def read_memory( + self, + address: int + ) -> int: + if not (0x0000 <= address <= 0xFFFF): + raise ValueError('Invalid address.') + ah, al = self._split_u16(address) + return self._execute_command( + command=self.Command.READ_MEMORY, + data_out=[ + al, + ah + ], + length_in=1 + )[0] + + def write_memory( + self, + address: int, + value: int + ) -> None: + if not (0x0000 <= address <= 0xFFFF): + raise ValueError('Invalid address.') + if not (0x00 <= value <= 0xFF): + raise ValueError('Invalid value.') + ah, al = self._split_u16(address) + self._execute_command( + command=self.Command.WRITE_MEMORY, + data_out=[ + al, + ah, + value + ], + ) + + def get_calibration( + self, + restore_state: bool = False + ) -> int: + state = None + if restore_state: + state = self.get_state() + self.set_mode(s.Mode.CALIBRATION) + value = s.get_value() + calibration = (0 - value[0]) if value[1] else value[0] + if restore_state: + self.set_state(state) + return calibration + + def set_calibration( + self, + calibration: int, + restore_state: bool = False + ) -> None: + if not (-0xFF <= calibration <= 0xFF): + raise ValueError('Invalid calibration value.') + if calibration < 0: + sign = 1 + value = 0 - calibration + else: + sign = 0 + value = calibration + state = None + if restore_state: + state = self.get_state() + self._execute_command( + command=self.Command.SET_CALIBRATION, + data_out=[ + value, + sign + ] + ) + if restore_state: + self.set_state(state) + + def set_buzzer_mode( + self, + mode: Union[int, BuzzerMode] + ) -> None: + if not (mode in list(self.BuzzerMode)): + raise ValueError('Invalid buzzer mode.') + self._execute_command( + command=self.Command.SET_BUZZER_MODE, + data_out=[ + mode + ] + ) + + def calculate( + self, + a: float, + b: float, + operation: Union[int, CalculationFlag], + restore_state: bool = False + ) -> float: + if operation not in list(self.Calculation): + raise ValueError('Invalid operation.') + a = self._encode_calc_arg(a, arg=1) + b = self._encode_calc_arg(b, arg=2) + ah, al = self._split_u16(a.value) + bh, bl = self._split_u16(b.value) + flags = operation | a.flags | b.flags + state = None + if restore_state: + state = self.get_state() + self._execute_command( + command=self.Command.CALCULATE, + data_out=[ + bl, + bh, + al, + ah, + flags + ] + ) + r = self._execute_command( + command=self.Command.GET_CALCULATION, + length_in=8 + ) + if r[7]: + y = float('NaN') + else: + y = self._decode_calc_arg( + x=self._join_u16( + h=r[1], + l=r[0] + ), + flags=r[6] + ) + if restore_state: + self.set_state(state) + return y + + def reset(self): + self.set_mode(self.Mode.RESET) + + +# the test also works as usage example: +if __name__ == '__main__': + s = STAF('com5', open=True, get_pinout=True) + s.set_buzzer_mode(s.BuzzerMode.DISABLED) + + a = s.get_pinout() + s.get_display() + s.set_display(0x0000FFFF) + s.set_display(s.Display.dot_top | s.Display.dot_bottom) + s.free_display() + + a = s.get_time() + s.set_time( + hour=12, + minute=34 + ) + s.set_time( + hour=1, + minute=23, + second=45 + ) + s.set_date( + month=1, + day=24 + ) + s.set_year( + year=4567 + ) + s.set_full_time(a, restore_state=True) + + s.set_alarm( + hour=12, + minute=34, + restore_state=True + ) + a = s.get_alarm() + s.clear_alarm(restore_state=True) + a = s.get_alarm() + + s.set_countdown( + minute=4, + second=33 + ) + s.set_running(True) + a = s.is_running() + s.set_running(False) + a = s.is_running() + + a = s.get_version() + + s.set_mode(s.Mode.SET_COUNTDOWN) + a = s.get_mode() + s.set_digit(1) + a = s.get_digit() + s.set_digit_value(0x0E) + a = s.get_digit_value() + s.confirm() + s.set_value([0x33, 0x04, 0x00]) + a = s.get_value() + + s.set_debug_address(s.Register.RTCHSEC) + s.set_debug_value( + address=s.Register.ALARMFLAG, + value=s.ALARMFLAG + ) + a = s.get_debug_value( + address=s.Register.ALARMFLAG + ) + s.set_debug_value( + address=s.Register.ALARMFLAG, + value=0 + ) + a = s.get_debug_value(s.Register.ALARMFLAG) + + s.write_memory( + address=0x022F, + value=3 + ) + a = s.read_memory( + address=0x022F + ) + + a=s.get_calibration() + s.set_calibration(a) + + + a=s.calculate( + a=-4.1, + b=-2.9, + operation=s.Calculation.DIVIDE + ) + a=s.calculate( + a=9999, + b=-999, + operation=s.Calculation.SUBTRACT + ) + + s.set_full_time( + time=datetime.now(tz=None), #current local time + set_seconds=True + ) + s.set_buzzer_mode(s.BuzzerMode.ENABLED) + s.reset() + s.close() + +pass