]> bicyclesonthemoon.info Git - staf/py-staf/commitdiff
first full version main v1.0.0
authorb <rowerynaksiezycu@gmail.com>
Tue, 9 Aug 2022 22:04:56 +0000 (00:04 +0200)
committerb <rowerynaksiezycu@gmail.com>
Tue, 9 Aug 2022 22:04:56 +0000 (00:04 +0200)
.gitignore [new file with mode: 0644]
LICENSE [new file with mode: 0644]
pyproject.toml [new file with mode: 0644]
requirements.txt [new file with mode: 0644]
setup.cfg [new file with mode: 0644]
staf.py [new file with mode: 0644]

diff --git a/.gitignore b/.gitignore
new file mode 100644 (file)
index 0000000..2ba7c7f
--- /dev/null
@@ -0,0 +1,2 @@
+/dist
+/ref
diff --git a/LICENSE b/LICENSE
new file mode 100644 (file)
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. <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/pyproject.toml b/pyproject.toml
new file mode 100644 (file)
index 0000000..37251cd
--- /dev/null
@@ -0,0 +1,6 @@
+[build-system]\r
+requires = [\r
+    "setuptools",\r
+    "wheel"\r
+]\r
+build-backend = "setuptools.build_meta"\r
diff --git a/requirements.txt b/requirements.txt
new file mode 100644 (file)
index 0000000..341e821
--- /dev/null
@@ -0,0 +1 @@
+pyserial\r
diff --git a/setup.cfg b/setup.cfg
new file mode 100644 (file)
index 0000000..9b879a5
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,13 @@
+[metadata]\r
+name = staf\r
+version = 1.0.0\r
+author = Balthasar SzczepaÅ„ski\r
+author_email = rowerynaksiezycu@gmail.com\r
+description = SilentTimer Action Figure communication library\r
+url = http://1190.bicyclesonthemoon.info/staf\r
+\r
+[options]\r
+python_requires= >=3.9\r
+install_requires=\r
+    pyserial\r
+py_modules = staf\r
diff --git a/staf.py b/staf.py
new file mode 100644 (file)
index 0000000..4071f9d
--- /dev/null
+++ b/staf.py
@@ -0,0 +1,1418 @@
+# SilentTimer Action Figure communication library\r
+# libstaf.py\r
+#\r
+# 09.08.2022\r
+# Copyright (C) 2022 Balthasar SzczepaÅ„ski\r
+#\r
+# This program is free software: you can redistribute it and/or modify\r
+# it under the terms of the GNU General Public License as published by\r
+# the Free Software Foundation, either version 3 of the License, or\r
+# (at your option) any later version.\r
+#\r
+# This program is distributed in the hope that it will be useful,\r
+# but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
+# GNU General Public License for more details.\r
+#\r
+# You should have received a copy of the GNU General Public License\r
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.\r
+\r
+from enum import IntEnum, IntFlag, Enum\r
+from typing import NamedTuple, Union\r
+from datetime import datetime, timezone\r
+import serial\r
+\r
+class STAF:\r
+    TIMEOUT = 0.02\r
+    BUFFER_SIZE = 32\r
+\r
+    class Event(IntFlag):\r
+        NONE      = 0x00\r
+        TICK      = 0x01\r
+        BUTTON_A  = 0x02\r
+        BUTTON_B  = 0x04\r
+        BUTTON_C  = 0x08\r
+        ALARM     = 0x10\r
+        COUNTDOWN = 0x40\r
+\r
+    class Command(IntEnum):\r
+        GET_TIME        = ord('G')\r
+        GET_MODE        = ord('H')\r
+        GET_DISPLAY     = ord('I')\r
+        GET_VALUE       = ord('J')\r
+        GET_CALCULATION = ord('K')\r
+        GET_RUN_MODE    = ord('L')\r
+        GET_VERSION     = ord('M')\r
+        GET_PINOUT      = ord('N')\r
+        GET_EVENT       = ord('O')\r
+        GET_ALARM       = ord('P')\r
+        GET_DIGIT       = ord('Q')\r
+        READ_MEMORY     = ord('R')\r
+        SET_DISPLAY       = ord('g')\r
+        FREE_DISPLAY      = ord('h')\r
+        TRIGGER_EVENT     = ord('i')\r
+        GOTO_MODE         = ord('j')\r
+        SELECT_DIGIT      = ord('k')\r
+        SET_DIGIT_VALUE   = ord('l')\r
+        CONFIRM           = ord('m')\r
+        SET_TIME          = ord('n')\r
+        SET_ALARM         = ord('o')\r
+        SET_DATE          = ord('p')\r
+        SET_YEAR          = ord('q')\r
+        SET_COUNTDOWN     = ord('r')\r
+        SET_CALIBRATION   = ord('s')\r
+        SET_DEBUG_ADDRESS = ord('t')\r
+        SET_DEBUG_VALUE   = ord('u')\r
+        CALCULATE         = ord('v')\r
+        SET_VALUE         = ord('w')\r
+        SET_RUN_MODE      = ord('x')\r
+        SET_BUZZER_MODE   = ord('y')\r
+        WRITE_MEMORY      = ord('z')\r
+\r
+    class Mode(IntEnum):\r
+        TIME        = 0x00\r
+        ALARM       = 0x01\r
+        DATE        = 0x02\r
+        COUNTUP     = 0x03\r
+        COUNTDOWN   = 0x04\r
+        CALIBRATION = 0x05\r
+        VERSION     = 0x06\r
+        DEBUG       = 0x07\r
+        RESET       = 0x08\r
+        CALCULATOR  = 0x09\r
+        SET_TIME          = 0x80\r
+        SET_ALARM         = 0x81\r
+        SET_DATE          = 0x82\r
+        SET_YEAR          = 0x83\r
+        SET_COUNTDOWN     = 0x84\r
+        SET_CALIBRATION   = 0x85\r
+        SET_DEBUG_ADDRESS = 0x86\r
+        SET_DEBUG_VALUE   = 0x87\r
+        SET_CALC_NUMBER   = 0x88\r
+        SET_CALC_OPERATOR = 0x89\r
+\r
+    BUZZER = ord('U')\r
+    EndFrame = [\r
+        ord('\r'),\r
+        ord('\n')\r
+    ]\r
+    GetCommand = range(ord('G'), ord('Z')+1)\r
+    SetCommand = range(ord('g'), ord('z')+1)\r
+\r
+    class Register(IntEnum):\r
+        RTCHSEC   = 0x00\r
+        RTCSEC    = 0x01\r
+        RTCMIN    = 0x02\r
+        RTCHOUR   = 0x03\r
+        RTCWKDAY  = 0x04\r
+        RTCDATE   = 0x05\r
+        RTCMTH    = 0x06\r
+        RTCYEAR   = 0x07\r
+        CONTROL   = 0x08\r
+        OSCTRIM   = 0x09\r
+        ALM0SEC   = 0x0C\r
+        ALM0MIN   = 0x0D\r
+        ALM0HOUR  = 0x0E\r
+        ALM0WKDAY = 0x0F\r
+        ALM0DATE  = 0x10\r
+        ALM0MTH   = 0x11\r
+        ALM1HSEC  = 0x12\r
+        ALM1SEC   = 0x13\r
+        ALM1MIN   = 0x14\r
+        ALM1HOUR  = 0x15\r
+        ALM1WKDAY = 0x16\r
+        ALM1DATE  = 0x17\r
+        PWRDNMIN  = 0x18\r
+        PWRDNHOUR = 0x19\r
+        PWRDNDATE = 0x1A\r
+        PWRDNMTH  = 0x1B\r
+        PWRUPMIN  = 0x1C\r
+        PWRUPHOUR = 0x1D\r
+        PWRUPDATE = 0x1E\r
+        PWRUPMTH  = 0x1F\r
+        # in SRAM by STAF software:\r
+        ALARMFLAG = 0x20\r
+        ALARMMIN  = 0x21\r
+        ALARMHOUR = 0x22\r
+        CDNFLAG   = 0x23\r
+        CDNSEC    = 0x24\r
+        CDNMIN    = 0x25\r
+        YEARFLAG  = 0x26\r
+        YEARLOW   = 0x27\r
+        YEARHIGH  = 0x28\r
+\r
+    ALARMFLAG = 0xA5\r
+\r
+    class BuzzerMode(IntEnum):\r
+        ENABLED  = 0x00\r
+        DISABLED = 0x01\r
+        FORCED   = 0x02\r
+\r
+    class CalculationFlag(IntFlag):\r
+        NEGATIVE   = 0b00000001\r
+        DEC_POINT  = 0b00000010\r
+        NEGATIVE2  = 0b00000100\r
+        DEC_POINT2 = 0b00001000\r
+        NEGATIVE1  = 0b00010000\r
+        DEC_POINT1 = 0b00100000\r
+        DIVIDE     = 0b11000000\r
+        MULTIPLY   = 0b10000000\r
+        SUBTRACT   = 0b01000000\r
+        ADD        = 0b00000000\r
+        OPERATOR   = 0b11000000\r
+\r
+    class Calculation(IntEnum):\r
+        ADD        = 0b00000000\r
+        SUBTRACT   = 0b01000000\r
+        MULTIPLY   = 0b10000000\r
+        DIVIDE     = 0b11000000\r
+\r
+    class Display(IntFlag):\r
+        none = 0x00000000\r
+        a0 = 0x00000001\r
+        b0 = 0x00000002\r
+        c0 = 0x00000004\r
+        d0 = 0x00000008\r
+        e0 = 0x00000010\r
+        f0 = 0x00000020\r
+        g0 = 0x00000040\r
+        h0 = 0x00000080\r
+        a1 = 0x00000100\r
+        b1 = 0x00000200\r
+        c1 = 0x00000400\r
+        d1 = 0x00000800\r
+        e1 = 0x00001000\r
+        f1 = 0x00002000\r
+        g1 = 0x00004000\r
+        h1 = 0x00008000\r
+        a2 = 0x00010000\r
+        b2 = 0x00020000\r
+        c2 = 0x00040000\r
+        d2 = 0x00080000\r
+        e2 = 0x00100000\r
+        f2 = 0x00200000\r
+        g2 = 0x00400000\r
+        h2 = 0x00800000\r
+        a3 = 0x01000000\r
+        b3 = 0x02000000\r
+        c3 = 0x04000000\r
+        d3 = 0x08000000\r
+        e3 = 0x10000000\r
+        f3 = 0x20000000\r
+        g3 = 0x40000000\r
+        h3 = 0x80000000\r
+        n0  = 0x00000001\r
+        ne0 = 0x00000002\r
+        se0 = 0x00000004\r
+        s0  = 0x00000008\r
+        sw0 = 0x00000010\r
+        nw0 = 0x00000020\r
+        mid0= 0x00000040\r
+        n1  = 0x00000100\r
+        ne1 = 0x00000200\r
+        se1 = 0x00000400\r
+        s1  = 0x00000800\r
+        sw1 = 0x00001000\r
+        nw1 = 0x00002000\r
+        mid1= 0x00004000\r
+        n2  = 0x00010000\r
+        ne2 = 0x00020000\r
+        se2 = 0x00040000\r
+        s2  = 0x00080000\r
+        sw2 = 0x00100000\r
+        nw2 = 0x00200000\r
+        mid2= 0x00400000\r
+        n3  = 0x01000000\r
+        ne3 = 0x02000000\r
+        se3 = 0x04000000\r
+        s3  = 0x08000000\r
+        sw3 = 0x10000000\r
+        nw3 = 0x20000000\r
+        mid3= 0x40000000\r
+        dot_top     = 0x00000080\r
+        dot_bottom  = 0x00008000\r
+        dot_alarm   = 0x80000000\r
+\r
+    class HSEC(IntFlag):\r
+        HSECONE0 = 0b00000001\r
+        HSECONE1 = 0b00000010\r
+        HSECONE2 = 0b00000100\r
+        HSECONE3 = 0b00001000\r
+        HSECTEN0 = 0b00010000\r
+        HSECTEN1 = 0b00100000\r
+        HSECTEN2 = 0b01000000\r
+        HSECTEN3 = 0b10000000\r
+        HSECONE  = 0b00001111\r
+        HSECTEN  = 0b11110000\r
+        HSEC     = 0b11111111\r
+\r
+    class SEC(IntFlag):\r
+        SECONE0 = 0b00000001\r
+        SECONE1 = 0b00000010\r
+        SECONE2 = 0b00000100\r
+        SECONE3 = 0b00001000\r
+        SECTEN0 = 0b00010000\r
+        SECTEN1 = 0b00100000\r
+        SECTEN2 = 0b01000000\r
+        ST      = 0b10000000\r
+        SECONE  = 0b00001111\r
+        SECTEN  = 0b01110000\r
+        SEC     = 0b01111111\r
+\r
+    class MIN(IntFlag):\r
+        MINONE0 = 0b00000001\r
+        MINONE1 = 0b00000010\r
+        MINONE2 = 0b00000100\r
+        MINONE3 = 0b00001000\r
+        MINTEN0 = 0b00010000\r
+        MINTEN1 = 0b00100000\r
+        MINTEN2 = 0b01000000\r
+        MINONE  = 0b00001111\r
+        MINTEN  = 0b01110000\r
+        MIN     = 0b01111111\r
+\r
+    class HOUR(IntFlag):\r
+        HOURONE0  = 0b00000001\r
+        HOURONE1  = 0b00000010\r
+        HOURONE2  = 0b00000100\r
+        HOURONE3  = 0b00001000\r
+        HOURTEN0  = 0b00010000\r
+        HOURTEN1  = 0b00100000\r
+        AM_PM     = 0b00100000\r
+        H12_14    = 0b01000000\r
+        TRIMSIGN  = 0b10000000\r
+        HOURONE   = 0b00001111\r
+        HOURTEN12 = 0b00010000\r
+        HOURTEN24 = 0b00110000\r
+        HOUR12    = 0b00011111\r
+        HOUR24    = 0b00111111\r
+\r
+    class WKDAY(IntFlag):\r
+        WKDAY0   = 0b00000001\r
+        WKDAY1   = 0b00000010\r
+        WKDAY2   = 0b00000100\r
+        VBATEN   = 0b00001000\r
+        PWRFAIL  = 0b00010000\r
+        OSCRUN   = 0b00100000\r
+        ALMxIF   = 0b00001000\r
+        ALMnMSK0 = 0b00010000\r
+        ALMnMSK1 = 0b00100000\r
+        ALMnMSK2 = 0b01000000\r
+        ALMnPIN  = 0b10000000\r
+        WKDAY    = 0b00000111\r
+        ALMnMSK  = 0b01110000\r
+\r
+    class DATE(IntFlag):\r
+        DATEONE0 = 0b00000001\r
+        DATEONE1 = 0b00000010\r
+        DATEONE2 = 0b00000100\r
+        DATETEN0 = 0b00001000\r
+        DATETEN1 = 0b00010000\r
+        DATEONE  = 0b00001111\r
+        DATETEN  = 0b00110000\r
+        DATE     = 0b00111111\r
+\r
+    class MTH(IntFlag):\r
+        MTHONE0 = 0b00000001\r
+        MTHONE1 = 0b00000010\r
+        MTHONE2 = 0b00000100\r
+        MTHTEN0 = 0b00001000\r
+        LPYR    = 0b00010000\r
+        MTHONE  = 0b00001111\r
+        MTHTEN  = 0b00010000\r
+        MTH     = 0b00011111\r
+\r
+    class YEAR(IntFlag):\r
+        YRONE0 = 0b00000001\r
+        YRONE1 = 0b00000010\r
+        YRONE2 = 0b00000100\r
+        YRTEN0 = 0b00001000\r
+        YRTEN1 = 0b00010000\r
+        YRTEN2 = 0b00010000\r
+        YRTEN3 = 0b00100000\r
+        YRONE  = 0b00001111\r
+        YRTEN  = 0b11110000\r
+        YR     = 0b11111111\r
+\r
+    class CONTROL(IntFlag):\r
+        SQWFS0  = 0b00000001\r
+        SQWFS1  = 0b00000010\r
+        CRSTRIM = 0b00000100\r
+        EXTOSC  = 0b00001000\r
+        ALM0EN  = 0b00010000\r
+        ALM1EN  = 0b00100000\r
+        SQWEN   = 0b01000000\r
+        SQWFS   = 0b00000011\r
+\r
+    class OSCTRIM(IntFlag):\r
+        TRIMVAL0 = 0b00000001\r
+        TRIMVAL1 = 0b00000010\r
+        TRIMVAL2 = 0b00000100\r
+        TRIMVAL3 = 0b00001000\r
+        TRIMVAL4 = 0b00010000\r
+        TRIMVAL5 = 0b00100000\r
+        TRIMVAL6 = 0b01000000\r
+        TRIMVAL7 = 0b10000000\r
+        TRIMVAL  = 0b11111111\r
+\r
+    class _frame(NamedTuple):\r
+        command: int\r
+        data: list[int]\r
+\r
+    class _calc_arg(NamedTuple):\r
+        value: int\r
+        flags: int\r
+\r
+    class State(NamedTuple):\r
+        mode: int\r
+        running: bool\r
+        digit: int\r
+        value: list[int]\r
+\r
+    class Alarm(NamedTuple):\r
+        enabled: bool\r
+        hour: Union[int, None]\r
+        minute: Union[int, None]\r
+\r
+    class Version(NamedTuple):\r
+        major: int\r
+        minor: int\r
+\r
+    def __init__(\r
+            self,\r
+            port: str,\r
+            open: bool = False,\r
+            get_pinout: bool = False\r
+    ):\r
+        self._serial = serial.Serial(\r
+            port=None,\r
+            baudrate=9600,\r
+            bytesize=serial.EIGHTBITS,\r
+            parity=serial.PARITY_NONE,\r
+            stopbits=serial.STOPBITS_ONE,\r
+            timeout=self.TIMEOUT,\r
+            xonxoff=False,\r
+            rtscts=False,\r
+            dsrdtr=False,\r
+            write_timeout=self.TIMEOUT,\r
+            inter_byte_timeout=None,\r
+            # exclusive=False\r
+        )\r
+        self._serial.port = port\r
+        self._event: int = self.Event.NONE\r
+        self._pinout: list[int] = None\r
+\r
+        if open:\r
+            self.open(get_pinout)\r
+\r
+    def __del__(self):\r
+        self.close()\r
+\r
+    def open(\r
+            self,\r
+            get_pinout: bool = False\r
+    ):\r
+        if not (self._serial.is_open):\r
+            self._serial.open()\r
+        if get_pinout:\r
+            self.get_pinout()\r
+\r
+    def close(self):\r
+        if self._serial.is_open:\r
+            self._serial.close()\r
+\r
+    @staticmethod\r
+    def _enum(\r
+            enum_type: IntEnum.__class__,\r
+            value: int\r
+    ) -> Union[Enum, int]:\r
+        value = int(value)\r
+        if value in enum_type.__members__.values():\r
+            return enum_type(value)\r
+        else:\r
+            return value\r
+\r
+    @staticmethod\r
+    def _join_u8(\r
+            h: int,\r
+            l: int\r
+    ) -> int:\r
+        return h << 4 | l\r
+\r
+    @staticmethod\r
+    def _split_u8(\r
+            x: int\r
+    ) -> tuple[int, int]:\r
+        h = x >> 4\r
+        l = x & 0x0f\r
+        return h, l\r
+\r
+    @staticmethod\r
+    def _join_u16(\r
+            h: int,\r
+            l: int\r
+    ) -> int:\r
+        return h << 8 | l\r
+\r
+    @staticmethod\r
+    def _split_u16(\r
+            x: int\r
+    ) -> tuple[int, int]:\r
+        h = x >> 8\r
+        l = x & 0xFF\r
+        return h, l\r
+\r
+    @classmethod\r
+    def _encode_BCD_u8(\r
+            cls,\r
+            x: int\r
+    ) -> int:\r
+        p, q = divmod(x, 10)\r
+        y = cls._join_u8(p, q)\r
+        return y\r
+\r
+    @classmethod\r
+    def _decode_BCD_u8(\r
+            cls,\r
+            x: int\r
+    ) -> int:\r
+        p, q = cls._split_u8(x)\r
+        y = p*10+q\r
+        return y\r
+\r
+    @classmethod\r
+    def _encode_BCD_u16(\r
+        cls,\r
+        x: int\r
+    ) -> int:\r
+        p, q = divmod(x, 100)\r
+        y = cls._join_u16(cls._encode_BCD_u8(p), cls._encode_BCD_u8(q))\r
+        return y\r
+\r
+    @classmethod\r
+    def _decode_BCD_u16(\r
+        cls,\r
+        x: int\r
+    ) -> int:\r
+        p, q = cls._split_u16(x)\r
+        y = (cls._decode_BCD_u8(p) * 100) + cls._decode_BCD_u8(q)\r
+        return y\r
+\r
+    @classmethod\r
+    def _encode_calc_arg(\r
+            cls,\r
+            x: float,\r
+            arg: int = 0\r
+    ) -> _calc_arg:\r
+        if arg == 1:\r
+            negative = cls.CalculationFlag.NEGATIVE1\r
+            dec_point = cls.CalculationFlag.DEC_POINT1\r
+        elif arg == 2:\r
+            negative = cls.CalculationFlag.NEGATIVE2\r
+            dec_point = cls.CalculationFlag.DEC_POINT2\r
+        else:\r
+            negative = cls.CalculationFlag.NEGATIVE\r
+            dec_point = cls.CalculationFlag.DEC_POINT\r
+\r
+        flags = 0x00\r
+        if x < 0:\r
+            flags |= negative\r
+            x = -1.0 * x\r
+            limit = 999.5\r
+        else:\r
+            limit = 9999.5\r
+\r
+        if x >= limit:\r
+            raise ValueError("Number out of range")\r
+\r
+        xf = x * 100.0\r
+        if xf >= limit:\r
+            y = x\r
+        else:\r
+            y = xf\r
+            flags |= dec_point\r
+\r
+        return cls._calc_arg(\r
+            value=cls._encode_BCD_u16(int(y+0.5)),\r
+            flags=flags\r
+        )\r
+\r
+    @classmethod\r
+    def _decode_calc_arg(\r
+            cls,\r
+            x: int,\r
+            flags: int,\r
+            arg: int = 0\r
+    ) -> float:\r
+        if arg == 1:\r
+            negative = cls.CalculationFlag.NEGATIVE1\r
+            dec_point = cls.CalculationFlag.DEC_POINT1\r
+        elif arg == 2:\r
+            negative = cls.CalculationFlag.NEGATIVE2\r
+            dec_point = cls.CalculationFlag.DEC_POINT2\r
+        else:\r
+            negative = cls.CalculationFlag.NEGATIVE\r
+            dec_point = cls.CalculationFlag.DEC_POINT\r
+\r
+        y = float(cls._decode_BCD_u16(x))\r
+\r
+        if flags & negative:\r
+            y *= -1.0\r
+        if flags & dec_point:\r
+            y *= 0.01\r
+\r
+        return y\r
+\r
+    def _read(\r
+            self,\r
+            length: int\r
+    ) -> list[int]:\r
+        buffer = []\r
+        while len(buffer) < length:\r
+            r = self._serial.read(1)\r
+            if len(r) == 0:\r
+                break\r
+            inbyte = r[0]\r
+            if inbyte == self.BUZZER:\r
+                continue\r
+            if (inbyte in self.GetCommand) or (inbyte in self.SetCommand):\r
+                buffer = []\r
+\r
+            buffer.append(inbyte)\r
+\r
+            if inbyte in self.EndFrame:\r
+                if len(buffer) == 1:\r
+                    buffer = []\r
+                    continue\r
+                else:\r
+                    break\r
+\r
+        return buffer\r
+\r
+    def _write(\r
+            self,\r
+            buffer: list[int]\r
+    ) -> int:\r
+        length = len(buffer)\r
+        buffer =  bytes(buffer)\r
+\r
+        while len(buffer) > 0:\r
+            r = self._serial.write(buffer)\r
+            buffer = buffer[r:]\r
+            # break if ???\r
+\r
+        return length-len(buffer)\r
+\r
+    def _get_frame(\r
+            self,\r
+            length: int\r
+    ) -> _frame:\r
+        length_b = 2 * length + 2\r
+\r
+        r = self._read(max(length_b, self.BUFFER_SIZE))\r
+\r
+        if (len(r) == 0) and (length != 0):\r
+            raise serial.SerialTimeoutException('No response from STAF.')\r
+        if len(r) < length_b:\r
+            raise serial.SerialException('Incomplete response from STAF.')\r
+        if (r[length_b-1] not in self.EndFrame) or ((r[0] not in self.GetCommand) and (r[0] not in self.SetCommand)):\r
+            raise serial.SerialException('Invalid response from STAF.')\r
+\r
+        data = []\r
+        j = 1\r
+        for i in range(length):\r
+            b = 0\r
+            for k in range(2):\r
+                if ord('0') <= r[j+k] <= ord('9'):\r
+                    h = r[j+k] - ord('0')\r
+                elif ord('A') <= r[j+k] <= ord('F'):\r
+                    h = r[j+k] - ord('A') + 10\r
+                elif ord('a') <= r[j+k] <= ord('f'):\r
+                    h = r[j+k] - ord('a') + 10\r
+                else:\r
+                    raise serial.SerialException('Invalid response from STAF.')\r
+                if k == 0:\r
+                    b = h << 4\r
+                else:\r
+                    data.append(b | h)\r
+                    j += 2\r
+\r
+        return self._frame(\r
+            command=r[0],\r
+            data=data\r
+        )\r
+\r
+    def _send_frame(\r
+            self,\r
+            command: int,\r
+            data: list[int] = []\r
+    ) -> None:\r
+        if (command not in self.GetCommand) and (command not in self.SetCommand):\r
+            raise ValueError('Invalid command')\r
+        buffer = [command]\r
+        for b in data:\r
+            h = 0\r
+            for k in range(2):\r
+                if k == 0:\r
+                    h = b >> 4\r
+                else:\r
+                    h = b & 0x0F\r
+                if h < 10:\r
+                    buffer.append(h + ord('0'))\r
+                else:\r
+                    buffer.append(h + ord('a') - 10)\r
+        buffer.append(ord('\n'))\r
+\r
+        r = self._write(buffer)\r
+        if r < len(buffer):\r
+            raise serial.SerialException(('Nothing' if r == 0 else 'Incomplete frame') + ' sent to STAF.')\r
+\r
+    def _check_event(self) -> None:\r
+        while self._serial.in_waiting > 1:  # don't get fooled by a single '\n'\r
+            try:\r
+                command, data = self._get_frame(length=1)\r
+                if command == self.Command.GET_EVENT:\r
+                    self._event |= data[0]\r
+                else:\r
+                    # raise serial.SerialException('Invalid data from STAF')\r
+                    pass\r
+            except serial.SerialTimeoutException:\r
+                pass\r
+\r
+    def _execute_command(\r
+            self,\r
+            command: int,\r
+            data_out: list[int] = [],\r
+            length_in: int = 0\r
+    ) -> list[int]:\r
+        self._check_event()\r
+        self._serial.flushInput()\r
+\r
+        self._send_frame(\r
+            command=command,\r
+            data=data_out\r
+        )\r
+        if length_in > 0:\r
+            command_in, data_in = self._get_frame(length=length_in)\r
+            if command_in != command:\r
+                raise serial.SerialException('Invalid response from STAF.')\r
+            return data_in\r
+        else:\r
+            return []\r
+\r
+    def get_state(self) -> State:\r
+        mode = self.get_mode()\r
+        running = self.is_running()\r
+        digit = self.get_digit()\r
+        value = self.get_value()\r
+        return self.State(\r
+            mode=mode,\r
+            running=running,\r
+            digit=digit,\r
+            value=value\r
+        )\r
+\r
+    def set_state(\r
+            self,\r
+            state: State\r
+    ):\r
+        self.set_mode(state.mode)\r
+        self.set_running(state.running)\r
+        self.set_digit(state.digit)\r
+        self.set_value(state.value)\r
+\r
+    def get_mode(self) -> Union[int, Mode]:\r
+        r = self._execute_command(\r
+            command=self.Command.GET_MODE,\r
+            length_in=1\r
+        )\r
+        return self._enum(\r
+            enum_type=self.Mode,\r
+            value=r[0]\r
+        )\r
+\r
+    def set_mode(\r
+            self,\r
+            mode: Union[int, Mode]\r
+    ) -> None:\r
+        if not (0x00 <= mode <= 0xFF):\r
+            raise ValueError('Invalid mode.')\r
+        self._execute_command(\r
+            command=self.Command.GOTO_MODE,\r
+            data_out=[mode]\r
+        )\r
+\r
+    def subscribe_event(\r
+            self,\r
+            event: Union[int, Event]\r
+    ) -> None:\r
+        if not (0x00 <= event <= 0xFF):\r
+            raise ValueError('Invalid event.')\r
+        r = self._execute_command(\r
+            command=self.Command.GET_EVENT,\r
+            data_out=[event],\r
+            length_in=1\r
+        )\r
+        self._event |= r[0]\r
+\r
+    def get_event(self) -> Union[int, Event]:\r
+        event = self._event\r
+        self._event = self.Event.NONE\r
+        return event\r
+\r
+    def trigger_event(\r
+        self,\r
+        event: Union[int, Event]\r
+    ) -> None:\r
+        if not (0x00 <= event <= 0xFF):\r
+            raise ValueError('Invalid event.')\r
+        self._execute_command(\r
+            command=self.Command.TRIGGER_EVENT,\r
+            data_out=[event],\r
+        )\r
+\r
+    def get_pinout(\r
+            self\r
+    ) -> list[int]:\r
+        r = self._execute_command(\r
+            command=self.Command.GET_PINOUT,\r
+            length_in=4\r
+        )\r
+        self._pinout = []\r
+        for b in r:\r
+            self._pinout.append(0xFF & (~(1 << (b >> 4))))\r
+            self._pinout.append(0xFF & (~(1 << (b & 0x0f))))\r
+        return self._pinout\r
+\r
+    def get_display(\r
+            self,\r
+            pinout: list[int] = None\r
+    ) -> Union[int, Display]:\r
+        if pinout is None:\r
+            pinout = self._pinout\r
+        if pinout is None:\r
+            raise RuntimeError('Unknown display pinout.')\r
+        if len(pinout) != 8:\r
+            raise ValueError('Invalid display pinout.')\r
+        r = self._execute_command(\r
+            command=self.Command.GET_DISPLAY,\r
+            length_in=4\r
+        )\r
+        display = self.Display.none\r
+        for i, b in enumerate(r):\r
+            for j, p in enumerate(pinout):\r
+                if (b | p) != 0xFF:\r
+                    display |= 1 << ((i << 3) + j)\r
+        return display\r
+\r
+    def set_display(\r
+            self,\r
+            display: int,\r
+            pinout: list[int] = None\r
+    ) -> None:\r
+        if pinout is None:\r
+            pinout = self._pinout\r
+        if pinout is None:\r
+            raise RuntimeError('Unknown display pinout.')\r
+        if len(pinout) != 8:\r
+            raise ValueError('Invalid display pinout.')\r
+        data = []\r
+        for i in range(4):\r
+            d = 0xFF;\r
+            for j, p in enumerate(pinout):\r
+                if display & (1 << ((i << 3) +j)):\r
+                    d &= p\r
+            data.append(d)\r
+        self._execute_command(\r
+            command=self.Command.SET_DISPLAY,\r
+            data_out=data\r
+        )\r
+\r
+    def free_display(self) -> None:\r
+        self._execute_command(\r
+            command=self.Command.FREE_DISPLAY\r
+        )\r
+\r
+    def get_time(\r
+            self,\r
+            tzinfo: timezone = None\r
+    ) -> datetime:\r
+        r = self._execute_command(\r
+            command=self.Command.GET_TIME,\r
+            length_in=8\r
+        )\r
+        return datetime(\r
+            year=self._decode_BCD_u16(self._join_u16(h=r[7], l=r[6])),\r
+            month=self._decode_BCD_u8(r[5]),\r
+            day=self._decode_BCD_u8(r[4]),\r
+            hour=self._decode_BCD_u8(r[3]),\r
+            minute=self._decode_BCD_u8(r[2]),\r
+            second=self._decode_BCD_u8(r[1]),\r
+            microsecond=self._decode_BCD_u8(r[0])*10000,\r
+            tzinfo=tzinfo\r
+        )\r
+\r
+    def set_time(\r
+            self,\r
+            hour: int,\r
+            minute: int,\r
+            second: int = None,\r
+            restore_state: bool = False\r
+    ) -> None:\r
+        if not ((0 <= hour <= 23) and (0 <= minute <= 59)):\r
+            raise ValueError('Invalid time setting.')\r
+        if (second is not None) and not (0 <= second <= 59):\r
+            raise ValueError('Invalid time setting.')\r
+        state = None\r
+        if restore_state:\r
+            state = self.get_state()\r
+        self._execute_command(\r
+            command=self.Command.SET_TIME,\r
+            data_out=[\r
+                self._encode_BCD_u8(minute),\r
+                self._encode_BCD_u8(hour)\r
+            ]\r
+        )\r
+        if second is not None:\r
+            v = self.get_debug_value(\r
+                address=self.Register.RTCSEC\r
+            )\r
+            v = (v & self.SEC.ST) | (second & self.SEC.SEC)\r
+            self.set_debug_value(\r
+                address=self.Register.RTCSEC,\r
+                value=v\r
+            )\r
+        if restore_state:\r
+            self.set_state(state)\r
+\r
+    def set_date(\r
+            self,\r
+            month: int,\r
+            day: int,\r
+            restore_state: bool = False\r
+    ) -> None:\r
+        d = 29 if (month == 2) else 31 if (((month & 0b1000) >> 3) ^ (month & 0b0001)) else 30\r
+        if not ((1 <= month <= 12) and (1 <= day <= d)):\r
+            raise ValueError('Invalid time setting.')\r
+        state = None\r
+        if restore_state:\r
+            state = self.get_state()\r
+        self._execute_command(\r
+            command=self.Command.SET_DATE,\r
+            data_out=[\r
+                self._encode_BCD_u8(day),\r
+                self._encode_BCD_u8(month)\r
+            ]\r
+        )\r
+        if restore_state:\r
+            self.set_state(state)\r
+\r
+    def set_year(\r
+            self,\r
+            year: int,\r
+            restore_state: bool = False\r
+    ) -> None:\r
+        if not (0 <= year <= 9999):\r
+            raise ValueError('Invalid time setting.')\r
+        yh, yl = self._split_u16(self._encode_BCD_u16(year))\r
+        state = None\r
+        if restore_state:\r
+            state = self.get_state()\r
+        self._execute_command(\r
+            command=self.Command.SET_YEAR,\r
+            data_out=[\r
+                yl,\r
+                yh\r
+            ]\r
+        )\r
+        if restore_state:\r
+            self.set_state(state)\r
+\r
+    def set_full_time(\r
+            self,\r
+            time: datetime,\r
+            set_seconds: bool = False,\r
+            restore_state: bool = False\r
+    ) -> None:\r
+        state = None\r
+        if restore_state:\r
+            state = self.get_state()\r
+        self.set_time(\r
+            hour = time.hour,\r
+            minute = time.minute,\r
+            second = time.second if set_seconds else None,\r
+        )\r
+        self.set_date(\r
+            month=time.month,\r
+            day=time.day\r
+        )\r
+        self.set_year(\r
+            year=time.year\r
+        )\r
+        if restore_state:\r
+            self.set_state(state)\r
+\r
+    def get_alarm(self) -> Alarm:\r
+        r = self._execute_command(\r
+            command=self.Command.GET_ALARM,\r
+            length_in=2\r
+        )\r
+        hour = r[1]\r
+        minute = r[0]\r
+        enabled = (hour != 0xFF) or (minute != 0xFF)\r
+        return self.Alarm(\r
+            enabled=enabled,\r
+            hour=self._decode_BCD_u8(hour) if enabled else None,\r
+            minute=self._decode_BCD_u8(minute) if enabled else None,\r
+        )\r
+\r
+    def set_alarm(\r
+            self,\r
+            hour: int,\r
+            minute: int,\r
+            restore_state: bool = False\r
+    ) -> None:\r
+        if not ((0 <= hour <= 23) and (0 <= minute <= 59)):\r
+            raise ValueError('Invalid alarm setting.')\r
+        state = None\r
+        if restore_state:\r
+            state = self.get_state()\r
+        self._execute_command(\r
+            command=self.Command.SET_ALARM,\r
+            data_out=[\r
+                self._encode_BCD_u8(minute),\r
+                self._encode_BCD_u8(hour)\r
+            ]\r
+        )\r
+        if restore_state:\r
+            self.set_state(state)\r
+\r
+    def clear_alarm(\r
+            self,\r
+            restore_state: bool = False\r
+    ) -> None:\r
+        state = None\r
+        if restore_state:\r
+            state = self.get_state()\r
+        self._execute_command(\r
+            command=self.Command.SET_ALARM,\r
+            data_out=[\r
+                0xFF,\r
+                0xFF\r
+            ]\r
+        )\r
+        if restore_state:\r
+            self.set_state(state)\r
+\r
+    def set_countdown(\r
+            self,\r
+            minute: int,\r
+            second: int,\r
+            restore_state: bool = False\r
+    ) -> None:\r
+        if not ((0 <= minute <= 99) and (0 <= second <= 59)):\r
+            raise ValueError('Invalid countdown setting.')\r
+        state = None\r
+        if restore_state:\r
+            state = self.get_state()\r
+        self._execute_command(\r
+            command=self.Command.SET_COUNTDOWN,\r
+            data_out=[\r
+                self._encode_BCD_u8(second),\r
+                self._encode_BCD_u8(minute)\r
+            ]\r
+        )\r
+        if restore_state:\r
+            self.set_state(state)\r
+\r
+    def is_running(self) -> bool:\r
+        r = self._execute_command(\r
+            command=self.Command.GET_RUN_MODE,\r
+            length_in=1\r
+        )\r
+        return bool(r[0])\r
+\r
+    def set_running(\r
+            self,\r
+            running: bool\r
+    ) -> None:\r
+        self._execute_command(\r
+            command=self.Command.SET_RUN_MODE,\r
+            data_out=[\r
+                1 if running else 0\r
+            ]\r
+        )\r
+\r
+    def get_version(self) -> Version:\r
+        r = self._execute_command(\r
+            command=self.Command.GET_VERSION,\r
+            length_in=2\r
+        )\r
+        return self.Version(\r
+            major=self._decode_BCD_u8(r[1]),\r
+            minor=self._decode_BCD_u8(r[0])\r
+        )\r
+\r
+    def get_digit(self) -> int:\r
+        r = self._execute_command(\r
+            command=self.Command.GET_DIGIT,\r
+            length_in=1\r
+        )\r
+        return r[0]\r
+\r
+    def set_digit(\r
+            self,\r
+            digit: int\r
+    ) -> None:\r
+        if not (0 <= digit <= 4):\r
+            raise ValueError('Invalid digit.')\r
+        self._execute_command(\r
+            command=self.Command.SELECT_DIGIT,\r
+            data_out=[\r
+                digit\r
+            ]\r
+        )\r
+\r
+    def get_digit_value(self) -> int:\r
+        digit = self.get_digit()\r
+        value = self.get_value()\r
+        value = value[digit >> 1]\r
+        if digit & 0x01:\r
+            return value >> 4\r
+        else:\r
+            return value & 0x0f\r
+\r
+    def set_digit_value(\r
+            self,\r
+            value: int\r
+    ) -> None:\r
+        if not (0x00 <= value <= 0x0f):\r
+            raise ValueError('Invalid digit value.')\r
+        self._execute_command(\r
+            command=self.Command.SET_DIGIT_VALUE,\r
+            data_out=[\r
+                value\r
+            ]\r
+        )\r
+\r
+    def get_value(self) -> list[int]:\r
+        return self._execute_command(\r
+            command=self.Command.GET_VALUE,\r
+            length_in=3\r
+        )\r
+\r
+    def set_value(\r
+            self,\r
+            value: list[int]\r
+    ) -> None:\r
+        if len(value) != 3:\r
+            raise ValueError('Invalid value length.')\r
+        for v in value:\r
+            if not (0x00 <= v <= 0xFF):\r
+                raise ValueError('Invalid value.')\r
+        self._execute_command(\r
+            command=self.Command.SET_VALUE,\r
+            data_out=value\r
+        )\r
+\r
+    def confirm(self) -> None:\r
+        self._execute_command(\r
+            command=self.Command.CONFIRM\r
+        )\r
+\r
+    def set_debug_address(\r
+            self,\r
+            address: int\r
+    ) -> None:\r
+        if not (0x00 <= address <= 0xFF):\r
+            raise ValueError('Invalid address.')\r
+        self._execute_command(\r
+            command=self.Command.SET_DEBUG_ADDRESS,\r
+            data_out=[\r
+                address\r
+            ]\r
+        )\r
+\r
+    def get_debug_value(\r
+            self,\r
+            address: int,\r
+            restore_state: bool = False\r
+    ) -> int:\r
+        # if not (0x00 <= address <= 0xFF):\r
+        #     raise ValueError('Invalid address.')\r
+        state = None\r
+        if restore_state:\r
+            state = self.get_state()\r
+        self.set_debug_address(address)\r
+        self.trigger_event(self.Event.TICK)\r
+        value = self.get_value()[0]\r
+        if restore_state:\r
+            self.set_state(state)\r
+        return value\r
+\r
+    def set_debug_value(\r
+            self,\r
+            address: int,\r
+            value: int,\r
+            restore_state: bool = False\r
+    ) -> None:\r
+        if not (0x00 <= address <= 0xFF):\r
+            raise ValueError('Invalid address.')\r
+        if not (0x00 <= value <= 0xFF):\r
+            raise ValueError('Invalid value.')\r
+        state = None\r
+        if restore_state:\r
+            state = self.get_state()\r
+        self._execute_command(\r
+            command=self.Command.SET_DEBUG_VALUE,\r
+            data_out=[\r
+                value,\r
+                address\r
+            ]\r
+        )\r
+        if restore_state:\r
+            self.set_state(state)\r
+\r
+    def read_memory(\r
+            self,\r
+            address: int\r
+    ) -> int:\r
+        if not (0x0000 <= address <= 0xFFFF):\r
+            raise ValueError('Invalid address.')\r
+        ah, al = self._split_u16(address)\r
+        return self._execute_command(\r
+            command=self.Command.READ_MEMORY,\r
+            data_out=[\r
+                al,\r
+                ah\r
+            ],\r
+            length_in=1\r
+        )[0]\r
+\r
+    def write_memory(\r
+            self,\r
+            address: int,\r
+            value: int\r
+    ) -> None:\r
+        if not (0x0000 <= address <= 0xFFFF):\r
+            raise ValueError('Invalid address.')\r
+        if not (0x00 <= value <= 0xFF):\r
+            raise ValueError('Invalid value.')\r
+        ah, al = self._split_u16(address)\r
+        self._execute_command(\r
+            command=self.Command.WRITE_MEMORY,\r
+            data_out=[\r
+                al,\r
+                ah,\r
+                value\r
+            ],\r
+        )\r
+\r
+    def get_calibration(\r
+                self,\r
+                restore_state: bool = False\r
+        ) -> int:\r
+        state = None\r
+        if restore_state:\r
+            state = self.get_state()\r
+        self.set_mode(s.Mode.CALIBRATION)\r
+        value = s.get_value()\r
+        calibration = (0 - value[0]) if value[1] else value[0]\r
+        if restore_state:\r
+            self.set_state(state)\r
+        return calibration\r
+\r
+    def set_calibration(\r
+            self,\r
+            calibration: int,\r
+            restore_state: bool = False\r
+    ) -> None:\r
+        if not (-0xFF <= calibration <= 0xFF):\r
+            raise ValueError('Invalid calibration value.')\r
+        if calibration < 0:\r
+            sign = 1\r
+            value = 0 - calibration\r
+        else:\r
+            sign = 0\r
+            value = calibration\r
+        state = None\r
+        if restore_state:\r
+            state = self.get_state()\r
+        self._execute_command(\r
+            command=self.Command.SET_CALIBRATION,\r
+            data_out=[\r
+                value,\r
+                sign\r
+            ]\r
+        )\r
+        if restore_state:\r
+            self.set_state(state)\r
+\r
+    def set_buzzer_mode(\r
+            self,\r
+            mode: Union[int, BuzzerMode]\r
+    ) -> None:\r
+        if not (mode in list(self.BuzzerMode)):\r
+            raise ValueError('Invalid buzzer mode.')\r
+        self._execute_command(\r
+            command=self.Command.SET_BUZZER_MODE,\r
+            data_out=[\r
+                mode\r
+            ]\r
+        )\r
+\r
+    def calculate(\r
+            self,\r
+            a: float,\r
+            b: float,\r
+            operation: Union[int, CalculationFlag],\r
+            restore_state: bool = False\r
+    ) -> float:\r
+        if operation not in list(self.Calculation):\r
+            raise ValueError('Invalid operation.')\r
+        a = self._encode_calc_arg(a, arg=1)\r
+        b = self._encode_calc_arg(b, arg=2)\r
+        ah, al = self._split_u16(a.value)\r
+        bh, bl = self._split_u16(b.value)\r
+        flags = operation | a.flags | b.flags\r
+        state = None\r
+        if restore_state:\r
+            state = self.get_state()\r
+        self._execute_command(\r
+            command=self.Command.CALCULATE,\r
+            data_out=[\r
+                bl,\r
+                bh,\r
+                al,\r
+                ah,\r
+                flags\r
+            ]\r
+        )\r
+        r = self._execute_command(\r
+            command=self.Command.GET_CALCULATION,\r
+            length_in=8\r
+        )\r
+        if r[7]:\r
+            y = float('NaN')\r
+        else:\r
+            y = self._decode_calc_arg(\r
+                x=self._join_u16(\r
+                    h=r[1],\r
+                    l=r[0]\r
+                ),\r
+                flags=r[6]\r
+            )\r
+        if restore_state:\r
+            self.set_state(state)\r
+        return y\r
+\r
+    def reset(self):\r
+        self.set_mode(self.Mode.RESET)\r
+\r
+\r
+# the test also works as usage example:\r
+if __name__ == '__main__':\r
+    s = STAF('com5', open=True, get_pinout=True)\r
+    s.set_buzzer_mode(s.BuzzerMode.DISABLED)\r
+\r
+    a = s.get_pinout()\r
+    s.get_display()\r
+    s.set_display(0x0000FFFF)\r
+    s.set_display(s.Display.dot_top | s.Display.dot_bottom)\r
+    s.free_display()\r
+\r
+    a = s.get_time()\r
+    s.set_time(\r
+        hour=12,\r
+        minute=34\r
+    )\r
+    s.set_time(\r
+        hour=1,\r
+        minute=23,\r
+        second=45\r
+    )\r
+    s.set_date(\r
+        month=1,\r
+        day=24\r
+    )\r
+    s.set_year(\r
+        year=4567\r
+    )\r
+    s.set_full_time(a, restore_state=True)\r
+\r
+    s.set_alarm(\r
+        hour=12,\r
+        minute=34,\r
+        restore_state=True\r
+    )\r
+    a = s.get_alarm()\r
+    s.clear_alarm(restore_state=True)\r
+    a = s.get_alarm()\r
+\r
+    s.set_countdown(\r
+        minute=4,\r
+        second=33\r
+    )\r
+    s.set_running(True)\r
+    a = s.is_running()\r
+    s.set_running(False)\r
+    a = s.is_running()\r
+\r
+    a = s.get_version()\r
+\r
+    s.set_mode(s.Mode.SET_COUNTDOWN)\r
+    a = s.get_mode()\r
+    s.set_digit(1)\r
+    a = s.get_digit()\r
+    s.set_digit_value(0x0E)\r
+    a = s.get_digit_value()\r
+    s.confirm()\r
+    s.set_value([0x33, 0x04, 0x00])\r
+    a = s.get_value()\r
+\r
+    s.set_debug_address(s.Register.RTCHSEC)\r
+    s.set_debug_value(\r
+        address=s.Register.ALARMFLAG,\r
+        value=s.ALARMFLAG\r
+    )\r
+    a = s.get_debug_value(\r
+        address=s.Register.ALARMFLAG\r
+    )\r
+    s.set_debug_value(\r
+        address=s.Register.ALARMFLAG,\r
+        value=0\r
+    )\r
+    a = s.get_debug_value(s.Register.ALARMFLAG)\r
+\r
+    s.write_memory(\r
+        address=0x022F,\r
+        value=3\r
+    )\r
+    a = s.read_memory(\r
+        address=0x022F\r
+    )\r
+\r
+    a=s.get_calibration()\r
+    s.set_calibration(a)\r
+\r
+\r
+    a=s.calculate(\r
+        a=-4.1,\r
+        b=-2.9,\r
+        operation=s.Calculation.DIVIDE\r
+    )\r
+    a=s.calculate(\r
+        a=9999,\r
+        b=-999,\r
+        operation=s.Calculation.SUBTRACT\r
+    )\r
+\r
+    s.set_full_time(\r
+        time=datetime.now(tz=None),  #current local time\r
+        set_seconds=True\r
+    )\r
+    s.set_buzzer_mode(s.BuzzerMode.ENABLED)\r
+    s.reset()\r
+    s.close()\r
+\r
+pass\r