commit 582c314ef2d1b47cc7c980cd56419e86b202cb8b Author: jens Date: Sat May 1 11:18:03 2021 +0100 first commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a677a6e --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +# Compiled python modules. +*.pyc + +# Setuptools distribution folder. +/dist/ + +# Python egg metadata, regenerated from source files by setuptools. +/*.egg-info + +# Build folder +/build/ diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..7a73a41 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,2 @@ +{ +} \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f61de92 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# mfrc522 + +A python library to read/write RFID tags via the budget MFRC522 RFID module. + +This code was published in relation to a [blog post](https://pimylifeup.com/raspberry-pi-rfid-rc522/) and you can find out more about how to hook up your MFRC reader to a Raspberry Pi there. + +## Installation + +Until the package is on PyPi, clone this repository and run `python setup.py install` in the top level directory. + +## Example Code + +The following code will read a tag from the MFRC522 + +```python +from time import sleep +import sys +from mfrc522 import SimpleMFRC522 +reader = SimpleMFRC522() + +try: + while True: + print("Hold a tag near the reader") + id, text = reader.read() + print("ID: %s\nText: %s" % (id,text)) + sleep(5) +except KeyboardInterrupt: + GPIO.cleanup() + raise +``` diff --git a/Sound1a.py b/Sound1a.py new file mode 100644 index 0000000..5ae7200 --- /dev/null +++ b/Sound1a.py @@ -0,0 +1,27 @@ +# Sound1a.py + +import time +from soundplayer import SoundPlayer + +# Use device with ID 1 (mostly USB audio adapter) +p = SoundPlayer("/home/pi/Track01.wav", 1) +print "play for 10 s with volume 0.5" +p.play(0.5) # non-blocking, volume = 0.5 +print "isPlaying:", p.isPlaying() +time.sleep(10) +print "pause for 5 s" +p.pause() +print "isPlaying:", p.isPlaying() +time.sleep(5) +print "resume for 10 s" +p.resume() +time.sleep(10) +print "stop" +p.stop() +print "isPlaying:", p.isPlaying() +p = SoundPlayer("/home/pi/Track02.wav",1) +p.play(0.5) +time.sleep(10) +p.stop() +print "done" + diff --git a/allmp3.py b/allmp3.py new file mode 100644 index 0000000..617cacb --- /dev/null +++ b/allmp3.py @@ -0,0 +1,28 @@ +from os import walk +import glob +f = [] + +for(dirpath,dirnamed,filenames) in walk("/home/pi/"): + f.extend(filenames) + break + +#print(f) + +names = glob.glob("/home/pi/*.mp3") + +#print(names) +musik = {} +for x in names: + p = int(x.split('-')[0].split('/')[3]) + musik[p] = x + +for i in range(len(musik)): + print(musik.get(i)) + + + +#dd = next(walk("/home"))[1] +#for xx in dd: +# ss = "/home"+"/"+xx+"/*.mp3" +# print(glob.glob(ss)) + diff --git a/interval.py b/interval.py new file mode 100644 index 0000000..3078cd6 --- /dev/null +++ b/interval.py @@ -0,0 +1,31 @@ +from threading import Thread, Event +from time import sleep + +# StoppableThread is from user Dolphin, from http://stackoverflow.com/questions/5849484/how-to-exit-a-multithreaded-program +class StoppableThread(Thread): + + def __init__(self): + Thread.__init__(self) + self.stop_event = Event() + + def stop(self): + if self.isAlive() == True: + # set event to signal thread to terminate + self.stop_event.set() + # block calling thread until thread really has terminated + self.join() + +class IntervalTimer(StoppableThread): + + def __init__(self, interval, worker_func): + super().__init__() + self._interval = interval + self._worker_func = worker_func + + def run(self): + while not self.stop_event.is_set(): + self._worker_func() + sleep(self._interval) + + + diff --git a/jfsgpio.py b/jfsgpio.py new file mode 100644 index 0000000..cca527a --- /dev/null +++ b/jfsgpio.py @@ -0,0 +1,18 @@ +import RPi.GPIO as GPIO +from time import sleep +from mfrc522 import SimpleMFRC522 + +GPIO.setmode(GPIO.BOARD) + +print(GPIO.getmode()) +GPIO.setup(37, GPIO.IN) +GPIO.setup(36, GPIO.IN) +i = 0 +while True : + if GPIO.input(37) == 1: + print("+") + sleep(0.1) + if GPIO.input(36) == 1: + print("-") + sleep(0.1) + \ No newline at end of file diff --git a/jfsread.py b/jfsread.py new file mode 100644 index 0000000..d28b7c2 --- /dev/null +++ b/jfsread.py @@ -0,0 +1,21 @@ +import RPi.GPIO as GPIO +from time import sleep +import sys +from mfrc522 import SimpleMFRC522 +reader = SimpleMFRC522() + +#GPIO.setmode(GPIO.BCM) +#print(GPIO.getmode()) +#GPIO.setup(37, GPIO.IN) + +try: + while True: + #if GPIO.input(37) == 1: + # print("+") + #py sleep(0.1) + print("Hold a tag near the reader") + id, text = reader.read() + print("ID: %s\nText: %s" % (id,text)) + sleep(1) +except KeyboardInterrupt: + GPIO.cleanup() \ No newline at end of file diff --git a/jfswrite.py b/jfswrite.py new file mode 100644 index 0000000..87c32ec --- /dev/null +++ b/jfswrite.py @@ -0,0 +1,14 @@ +#!/usr/bin/env python + +import RPi.GPIO as GPIO +from mfrc522 import SimpleMFRC522 + +reader = SimpleMFRC522() + +try: + text = str(input('New integer:')) + print("Now place your tag to write") + reader.write(text) + print("Written") +finally: + GPIO.cleanup() \ No newline at end of file diff --git a/joystick.py b/joystick.py new file mode 100644 index 0000000..e70af07 --- /dev/null +++ b/joystick.py @@ -0,0 +1,10 @@ +import RPi.GPIO as GPIO + +GPIO.setup(37, GPIO.IN) + +ok = True + +while ok : + if GPIO.input(37) == 1: + print("37 = 1") + ok = false diff --git a/loud.txt b/loud.txt new file mode 100644 index 0000000..9427fe0 --- /dev/null +++ b/loud.txt @@ -0,0 +1,4 @@ +numid=6,iface=MIXER,name='Speaker Playback Volume' + ; type=INTEGER,access=rw---R--,values=2,min=0,max=151,step=0 + : values=50,50 + | dBminmax-min=-28.37dB,max=-0.06dB diff --git a/mfrc522/MFRC522.py b/mfrc522/MFRC522.py new file mode 100644 index 0000000..1698351 --- /dev/null +++ b/mfrc522/MFRC522.py @@ -0,0 +1,425 @@ +#!/usr/bin/env python +# -*- coding: utf8 -*- +# +# Copyright 2014,2018 Mario Gomez +# +# This file is part of MFRC522-Python +# MFRC522-Python is a simple Python implementation for +# the MFRC522 NFC Card Reader for the Raspberry Pi. +# +# MFRC522-Python is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# MFRC522-Python 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 Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with MFRC522-Python. If not, see . +# +import RPi.GPIO as GPIO +import spidev +import signal +import time +import logging + +class MFRC522: + MAX_LEN = 16 + + PCD_IDLE = 0x00 + PCD_AUTHENT = 0x0E + PCD_RECEIVE = 0x08 + PCD_TRANSMIT = 0x04 + PCD_TRANSCEIVE = 0x0C + PCD_RESETPHASE = 0x0F + PCD_CALCCRC = 0x03 + + PICC_REQIDL = 0x26 + PICC_REQALL = 0x52 + PICC_ANTICOLL = 0x93 + PICC_SElECTTAG = 0x93 + PICC_AUTHENT1A = 0x60 + PICC_AUTHENT1B = 0x61 + PICC_READ = 0x30 + PICC_WRITE = 0xA0 + PICC_DECREMENT = 0xC0 + PICC_INCREMENT = 0xC1 + PICC_RESTORE = 0xC2 + PICC_TRANSFER = 0xB0 + PICC_HALT = 0x50 + + MI_OK = 0 + MI_NOTAGERR = 1 + MI_ERR = 2 + + Reserved00 = 0x00 + CommandReg = 0x01 + CommIEnReg = 0x02 + DivlEnReg = 0x03 + CommIrqReg = 0x04 + DivIrqReg = 0x05 + ErrorReg = 0x06 + Status1Reg = 0x07 + Status2Reg = 0x08 + FIFODataReg = 0x09 + FIFOLevelReg = 0x0A + WaterLevelReg = 0x0B + ControlReg = 0x0C + BitFramingReg = 0x0D + CollReg = 0x0E + Reserved01 = 0x0F + + Reserved10 = 0x10 + ModeReg = 0x11 + TxModeReg = 0x12 + RxModeReg = 0x13 + TxControlReg = 0x14 + TxAutoReg = 0x15 + TxSelReg = 0x16 + RxSelReg = 0x17 + RxThresholdReg = 0x18 + DemodReg = 0x19 + Reserved11 = 0x1A + Reserved12 = 0x1B + MifareReg = 0x1C + Reserved13 = 0x1D + Reserved14 = 0x1E + SerialSpeedReg = 0x1F + + Reserved20 = 0x20 + CRCResultRegM = 0x21 + CRCResultRegL = 0x22 + Reserved21 = 0x23 + ModWidthReg = 0x24 + Reserved22 = 0x25 + RFCfgReg = 0x26 + GsNReg = 0x27 + CWGsPReg = 0x28 + ModGsPReg = 0x29 + TModeReg = 0x2A + TPrescalerReg = 0x2B + TReloadRegH = 0x2C + TReloadRegL = 0x2D + TCounterValueRegH = 0x2E + TCounterValueRegL = 0x2F + + Reserved30 = 0x30 + TestSel1Reg = 0x31 + TestSel2Reg = 0x32 + TestPinEnReg = 0x33 + TestPinValueReg = 0x34 + TestBusReg = 0x35 + AutoTestReg = 0x36 + VersionReg = 0x37 + AnalogTestReg = 0x38 + TestDAC1Reg = 0x39 + TestDAC2Reg = 0x3A + TestADCReg = 0x3B + Reserved31 = 0x3C + Reserved32 = 0x3D + Reserved33 = 0x3E + Reserved34 = 0x3F + + serNum = [] + + def __init__(self, bus=0, device=0, spd=1000000, pin_mode=10, pin_rst=-1, debugLevel='WARNING'): + self.spi = spidev.SpiDev() + self.spi.open(bus, device) + self.spi.max_speed_hz = spd + + self.logger = logging.getLogger('mfrc522Logger') + self.logger.addHandler(logging.StreamHandler()) + level = logging.getLevelName(debugLevel) + self.logger.setLevel(level) + + gpioMode = GPIO.getmode() + + if gpioMode is None: + GPIO.setmode(pin_mode) + else: + pin_mode = gpioMode + + if pin_rst == -1: + if pin_mode == 11: + pin_rst = 15 + else: + pin_rst = 22 + + GPIO.setup(pin_rst, GPIO.OUT) + GPIO.output(pin_rst, 1) + self.MFRC522_Init() + + def MFRC522_Reset(self): + self.Write_MFRC522(self.CommandReg, self.PCD_RESETPHASE) + + def Write_MFRC522(self, addr, val): + val = self.spi.xfer2([(addr << 1) & 0x7E, val]) + + def Read_MFRC522(self, addr): + val = self.spi.xfer2([((addr << 1) & 0x7E) | 0x80, 0]) + return val[1] + + def Close_MFRC522(self): + self.spi.close() + GPIO.cleanup() + + def SetBitMask(self, reg, mask): + tmp = self.Read_MFRC522(reg) + self.Write_MFRC522(reg, tmp | mask) + + def ClearBitMask(self, reg, mask): + tmp = self.Read_MFRC522(reg) + self.Write_MFRC522(reg, tmp & (~mask)) + + def AntennaOn(self): + temp = self.Read_MFRC522(self.TxControlReg) + if (~(temp & 0x03)): + self.SetBitMask(self.TxControlReg, 0x03) + + def AntennaOff(self): + self.ClearBitMask(self.TxControlReg, 0x03) + + def MFRC522_ToCard(self, command, sendData): + backData = [] + backLen = 0 + status = self.MI_ERR + irqEn = 0x00 + waitIRq = 0x00 + lastBits = None + n = 0 + + if command == self.PCD_AUTHENT: + irqEn = 0x12 + waitIRq = 0x10 + if command == self.PCD_TRANSCEIVE: + irqEn = 0x77 + waitIRq = 0x30 + + self.Write_MFRC522(self.CommIEnReg, irqEn | 0x80) + self.ClearBitMask(self.CommIrqReg, 0x80) + self.SetBitMask(self.FIFOLevelReg, 0x80) + + self.Write_MFRC522(self.CommandReg, self.PCD_IDLE) + + for i in range(len(sendData)): + self.Write_MFRC522(self.FIFODataReg, sendData[i]) + + self.Write_MFRC522(self.CommandReg, command) + + if command == self.PCD_TRANSCEIVE: + self.SetBitMask(self.BitFramingReg, 0x80) + + i = 2000 + while True: + n = self.Read_MFRC522(self.CommIrqReg) + i -= 1 + if ~((i != 0) and ~(n & 0x01) and ~(n & waitIRq)): + break + + self.ClearBitMask(self.BitFramingReg, 0x80) + + if i != 0: + if (self.Read_MFRC522(self.ErrorReg) & 0x1B) == 0x00: + status = self.MI_OK + + if n & irqEn & 0x01: + status = self.MI_NOTAGERR + + if command == self.PCD_TRANSCEIVE: + n = self.Read_MFRC522(self.FIFOLevelReg) + lastBits = self.Read_MFRC522(self.ControlReg) & 0x07 + if lastBits != 0: + backLen = (n - 1) * 8 + lastBits + else: + backLen = n * 8 + + if n == 0: + n = 1 + if n > self.MAX_LEN: + n = self.MAX_LEN + + for i in range(n): + backData.append(self.Read_MFRC522(self.FIFODataReg)) + else: + status = self.MI_ERR + + return (status, backData, backLen) + + def MFRC522_Request(self, reqMode): + status = None + backBits = None + TagType = [] + + self.Write_MFRC522(self.BitFramingReg, 0x07) + + TagType.append(reqMode) + (status, backData, backBits) = self.MFRC522_ToCard(self.PCD_TRANSCEIVE, TagType) + + if ((status != self.MI_OK) | (backBits != 0x10)): + status = self.MI_ERR + + return (status, backBits) + + def MFRC522_Anticoll(self): + backData = [] + serNumCheck = 0 + + serNum = [] + + self.Write_MFRC522(self.BitFramingReg, 0x00) + + serNum.append(self.PICC_ANTICOLL) + serNum.append(0x20) + + (status, backData, backBits) = self.MFRC522_ToCard(self.PCD_TRANSCEIVE, serNum) + + if (status == self.MI_OK): + i = 0 + if len(backData) == 5: + for i in range(4): + serNumCheck = serNumCheck ^ backData[i] + if serNumCheck != backData[4]: + status = self.MI_ERR + else: + status = self.MI_ERR + + return (status, backData) + + def CalulateCRC(self, pIndata): + self.ClearBitMask(self.DivIrqReg, 0x04) + self.SetBitMask(self.FIFOLevelReg, 0x80) + + for i in range(len(pIndata)): + self.Write_MFRC522(self.FIFODataReg, pIndata[i]) + + self.Write_MFRC522(self.CommandReg, self.PCD_CALCCRC) + i = 0xFF + while True: + n = self.Read_MFRC522(self.DivIrqReg) + i -= 1 + if not ((i != 0) and not (n & 0x04)): + break + pOutData = [] + pOutData.append(self.Read_MFRC522(self.CRCResultRegL)) + pOutData.append(self.Read_MFRC522(self.CRCResultRegM)) + return pOutData + + def MFRC522_SelectTag(self, serNum): + backData = [] + buf = [] + buf.append(self.PICC_SElECTTAG) + buf.append(0x70) + + for i in range(5): + buf.append(serNum[i]) + + pOut = self.CalulateCRC(buf) + buf.append(pOut[0]) + buf.append(pOut[1]) + (status, backData, backLen) = self.MFRC522_ToCard(self.PCD_TRANSCEIVE, buf) + + if (status == self.MI_OK) and (backLen == 0x18): + self.logger.debug("Size: " + str(backData[0])) + return backData[0] + else: + return 0 + + def MFRC522_Auth(self, authMode, BlockAddr, Sectorkey, serNum): + buff = [] + + # First byte should be the authMode (A or B) + buff.append(authMode) + + # Second byte is the trailerBlock (usually 7) + buff.append(BlockAddr) + + # Now we need to append the authKey which usually is 6 bytes of 0xFF + for i in range(len(Sectorkey)): + buff.append(Sectorkey[i]) + + # Next we append the first 4 bytes of the UID + for i in range(4): + buff.append(serNum[i]) + + # Now we start the authentication itself + (status, backData, backLen) = self.MFRC522_ToCard(self.PCD_AUTHENT, buff) + + # Check if an error occurred + if not (status == self.MI_OK): + self.logger.error("AUTH ERROR!!") + if not (self.Read_MFRC522(self.Status2Reg) & 0x08) != 0: + self.logger.error("AUTH ERROR(status2reg & 0x08) != 0") + + # Return the status + return status + + def MFRC522_StopCrypto1(self): + self.ClearBitMask(self.Status2Reg, 0x08) + + def MFRC522_Read(self, blockAddr): + recvData = [] + recvData.append(self.PICC_READ) + recvData.append(blockAddr) + pOut = self.CalulateCRC(recvData) + recvData.append(pOut[0]) + recvData.append(pOut[1]) + (status, backData, backLen) = self.MFRC522_ToCard(self.PCD_TRANSCEIVE, recvData) + if not (status == self.MI_OK): + self.logger.error("Error while reading!") + + if len(backData) == 16: + self.logger.debug("Sector " + str(blockAddr) + " " + str(backData)) + return backData + else: + return None + + def MFRC522_Write(self, blockAddr, writeData): + buff = [] + buff.append(self.PICC_WRITE) + buff.append(blockAddr) + crc = self.CalulateCRC(buff) + buff.append(crc[0]) + buff.append(crc[1]) + (status, backData, backLen) = self.MFRC522_ToCard(self.PCD_TRANSCEIVE, buff) + if not (status == self.MI_OK) or not (backLen == 4) or not ((backData[0] & 0x0F) == 0x0A): + status = self.MI_ERR + + self.logger.debug("%s backdata &0x0F == 0x0A %s" % (backLen, backData[0] & 0x0F)) + if status == self.MI_OK: + buf = [] + for i in range(16): + buf.append(writeData[i]) + + crc = self.CalulateCRC(buf) + buf.append(crc[0]) + buf.append(crc[1]) + (status, backData, backLen) = self.MFRC522_ToCard(self.PCD_TRANSCEIVE, buf) + if not (status == self.MI_OK) or not (backLen == 4) or not ((backData[0] & 0x0F) == 0x0A): + self.logger.error("Error while writing") + if status == self.MI_OK: + self.logger.debug("Data written") + + + def MFRC522_DumpClassic1K(self, key, uid): + for i in range(64): + status = self.MFRC522_Auth(self.PICC_AUTHENT1A, i, key, uid) + # Check if authenticated + if status == self.MI_OK: + self.MFRC522_Read(i) + else: + self.logger.error("Authentication error") + + def MFRC522_Init(self): + self.MFRC522_Reset() + + self.Write_MFRC522(self.TModeReg, 0x8D) + self.Write_MFRC522(self.TPrescalerReg, 0x3E) + self.Write_MFRC522(self.TReloadRegL, 30) + self.Write_MFRC522(self.TReloadRegH, 0) + + self.Write_MFRC522(self.TxAutoReg, 0x40) + self.Write_MFRC522(self.ModeReg, 0x3D) + self.AntennaOn() diff --git a/mfrc522/SimpleMFRC522.py b/mfrc522/SimpleMFRC522.py new file mode 100644 index 0000000..91eca06 --- /dev/null +++ b/mfrc522/SimpleMFRC522.py @@ -0,0 +1,90 @@ +# Code by Simon Monk https://github.com/simonmonk/ + +from . import MFRC522 +import RPi.GPIO as GPIO + +class SimpleMFRC522: + + READER = None + + KEY = [0xFF,0xFF,0xFF,0xFF,0xFF,0xFF] + BLOCK_ADDRS = [8, 9, 10] + + def __init__(self): + self.READER = MFRC522() + + def read(self): + id, text = self.read_no_block() + while not id: + id, text = self.read_no_block() + return id, text + + def read_id(self): + id = self.read_id_no_block() + while not id: + id = self.read_id_no_block() + return id + + def read_id_no_block(self): + (status, TagType) = self.READER.MFRC522_Request(self.READER.PICC_REQIDL) + if status != self.READER.MI_OK: + return None + (status, uid) = self.READER.MFRC522_Anticoll() + if status != self.READER.MI_OK: + return None + return self.uid_to_num(uid) + + def read_no_block(self): + (status, TagType) = self.READER.MFRC522_Request(self.READER.PICC_REQIDL) + if status != self.READER.MI_OK: + return None, None + (status, uid) = self.READER.MFRC522_Anticoll() + if status != self.READER.MI_OK: + return None, None + id = self.uid_to_num(uid) + self.READER.MFRC522_SelectTag(uid) + status = self.READER.MFRC522_Auth(self.READER.PICC_AUTHENT1A, 11, self.KEY, uid) + data = [] + text_read = '' + if status == self.READER.MI_OK: + for block_num in self.BLOCK_ADDRS: + block = self.READER.MFRC522_Read(block_num) + if block: + data += block + if data: + text_read = ''.join(chr(i) for i in data) + self.READER.MFRC522_StopCrypto1() + return id, text_read + + def write(self, text): + id, text_in = self.write_no_block(text) + while not id: + id, text_in = self.write_no_block(text) + return id, text_in + + def write_no_block(self, text): + (status, TagType) = self.READER.MFRC522_Request(self.READER.PICC_REQIDL) + if status != self.READER.MI_OK: + return None, None + (status, uid) = self.READER.MFRC522_Anticoll() + if status != self.READER.MI_OK: + return None, None + id = self.uid_to_num(uid) + self.READER.MFRC522_SelectTag(uid) + status = self.READER.MFRC522_Auth(self.READER.PICC_AUTHENT1A, 11, self.KEY, uid) + self.READER.MFRC522_Read(11) + if status == self.READER.MI_OK: + data = bytearray() + data.extend(bytearray(text.ljust(len(self.BLOCK_ADDRS) * 16).encode('ascii'))) + i = 0 + for block_num in self.BLOCK_ADDRS: + self.READER.MFRC522_Write(block_num, data[(i*16):(i+1)*16]) + i += 1 + self.READER.MFRC522_StopCrypto1() + return id, text[0:(len(self.BLOCK_ADDRS) * 16)] + + def uid_to_num(self, uid): + n = 0 + for i in range(0, 5): + n = n * 256 + uid[i] + return n diff --git a/mfrc522/__init__.py b/mfrc522/__init__.py new file mode 100644 index 0000000..5b0eae8 --- /dev/null +++ b/mfrc522/__init__.py @@ -0,0 +1,4 @@ +from .MFRC522 import MFRC522 +from .SimpleMFRC522 import SimpleMFRC522 + +name = "mfrc522" diff --git a/mfrc522/testgpio.py b/mfrc522/testgpio.py new file mode 100644 index 0000000..fd0f73f --- /dev/null +++ b/mfrc522/testgpio.py @@ -0,0 +1,57 @@ +import RPi.GPIO as GPIO +import MFRC522 +import signal + +continue_reading = True + +# Capture SIGINT for cleanup when the script is aborted +def end_read(signal,frame): + global continue_reading + print "Ctrl+C captured, ending read." + continue_reading = False + GPIO.cleanup() + +# Hook the SIGINT +signal.signal(signal.SIGINT, end_read) + +# Create an object of the class MFRC522 +MIFAREReader = MFRC522.MFRC522() + +# Welcome message +print "Welcome to the jfs data read example" +print "Press Ctrl-C to stop." + +# This loop keeps checking for chips. If one is near it will get the UID and authenticate +while continue_reading: + + # Scan for cards + (status,TagType) = MIFAREReader.MFRC522_Request(MIFAREReader.PICC_REQIDL) + + # If a card is found + if status == MIFAREReader.MI_OK: + print "Card detected" + + # Get the UID of the card + (status,uid) = MIFAREReader.MFRC522_Anticoll() + + # If we have the UID, continue + if status == MIFAREReader.MI_OK: + + # Print UID + print "Card read UID: %s,%s,%s,%s" % (uid[0], uid[1], uid[2], uid[3]) + + # This is the default key for authentication + key = [0xFF,0xFF,0xFF,0xFF,0xFF,0xFF] + + # Select the scanned tag + MIFAREReader.MFRC522_SelectTag(uid) + + # Authenticate + status = MIFAREReader.MFRC522_Auth(MIFAREReader.PICC_AUTHENT1A, 8, key, uid) + + # Check if authenticated + if status == MIFAREReader.MI_OK: + MIFAREReader.MFRC522_Read(8) + MIFAREReader.MFRC522_StopCrypto1() + else: + print "Authentication error" diff --git a/muttiOne.py b/muttiOne.py new file mode 100644 index 0000000..3b9c428 --- /dev/null +++ b/muttiOne.py @@ -0,0 +1,35 @@ +from time import sleep +import RPi.GPIO as GPIO +from soundplayer import SoundPlayer +import sys +from mfrc522 import SimpleMFRC522 + + +reader = SimpleMFRC522() +p = SoundPlayer("/home/pi/Track03.wav", 1) +GPIO.setup(37, GPIO.IN) +#p.play(0.5) +status = 0 +print("Hold a tag near the reader") +try: + while True: + if GPIO.input(37) == 1: + print("+") + sleep(0.1) + id, text = reader.read() + sleep(1) + print("ID: %s\nText: %s" % (id,text)) + ss = text.strip() + i = int(ss) + if i != status or p.isPlaying()==False : + status = i + s = "/home/pi/Track0"+ss+".wav" + print(s) + p.stop() + sleep(2) + p = SoundPlayer(s,1) + p.play(0.5) # non-blocking, volume = 0.5 + print ("isPlaying:", p.isPlaying(),s) + #sleep(5) +except KeyboardInterrupt: + GPIO.cleanup() diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..eaeea22 --- /dev/null +++ b/setup.py @@ -0,0 +1,27 @@ +import setuptools + +with open("README.md", "r") as fh: + long_description = fh.read() + +setuptools.setup( + name="mfrc522", + version="0.0.7", + author="Pi My Life Up", + author_email="support@pimylifeup.com", + description="A library to integrate the MFRC522 RFID readers with the Raspberry Pi", + long_description=long_description, + long_description_content_type="text/markdown", + url="https://github.com/pimylifeup/MFRC522-python", + packages=setuptools.find_packages(), + install_requires=[ + 'RPi.GPIO', + 'spidev' + ], + classifiers=[ + "Programming Language :: Python :: 2.7", + "Programming Language :: Python :: 3", + "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", + "Operating System :: POSIX :: Linux", + 'Topic :: System :: Hardware', + ], +) diff --git a/soundplayer.py b/soundplayer.py new file mode 100644 index 0000000..d97f735 --- /dev/null +++ b/soundplayer.py @@ -0,0 +1,108 @@ +# soundplayer.py + +import _thread +import os + +class SoundPlayer: + ''' + Sound player based on SoX, called "the Swiss Army knife of sound processing programs" by its developper. + This simple Python wrapper is based on Linux shell commands running in extra threads. + For the Raspberry Pi the following installation are needed: + sudo apt-get install sox + sudo apt-get install mp3 + ''' + @staticmethod + def playTone(frequencies, duration, blocking = False, device = 0): + ''' + Plays one or several sine tones with given frequencies and duration. + @param frequencies: the frequency or a list of several frequencies in Hz + @param duration: the duration in s + @param blocking: if True, the functions blocks until playing is finished; otherwise it returns immediately (default: False) + @param device: the sound device ID (e.g. 0: standard device, 1: USB sound adapter) + ''' + if not type(frequencies) == list: + frequencies = [frequencies] + if blocking: + SoundPlayer._emit(frequencies, duration, device) + else: + _thread.start_new_thread(SoundPlayer._emit, (frequencies, duration, device)) + + @staticmethod + def isPlaying(): + ''' + Checks if the sound is still playing. + @return: True, if the sound is playing; otherwise False + ''' + info = os.popen("ps -Af").read() + process_count = info.count("play") + return process_count >= 2 + + @staticmethod + def _emit(frequencies, duration, device): + s = " " + for f in frequencies: + s += "sin " + str(f) + " " + cmd = "AUDIODEV=hw:" + str(device) + " play -q -n synth " + str(duration) + \ + s + " 2> /dev/null" + os.system(cmd) + + def __init__(self, audiofile, device = 0): + ''' + Creates a sound player to play the given audio file (wav, mp3, etc.) + to be played at given device ID. Throws exception, if the sound resource is not found. + @param audiofile: the sound file to play + @param device: the sound device ID (e.g. 0: standard device, 1: USB sound adapter) + ''' + if not os.path.isfile(audiofile) : + raise Exception("Audio resource " + audiofile + " not found") + self.audiofile = audiofile + self.device = device + + def set_file(self,audiofile): + self.audiofile = audiofile + + @staticmethod + def _run(cmd): + os.system(cmd) + + def play(self, volume = 1, blocking = False): + ''' + Plays the sound with given volume (default: 1). The function returns immediately. + @param volume: the sound level (default: 1) + @param blocking: if True, the functions blocks until playing is finished; otherwise it returns immediately (default: False) + ''' + self.volume = volume + cmd = "AUDIODEV=hw:" + str(self.device) + \ + " play -v " + str(self.volume) + \ + " -q " + self.audiofile + " 2> /dev/null" + + if blocking: + self._run(cmd) + else: + _thread.start_new_thread(SoundPlayer._run, (cmd,)) + + @staticmethod + def stop(): + ''' + Stops playing. + ''' + cmd = "sudo killall -9 play" + _thread.start_new_thread(SoundPlayer._run, (cmd,)) + + @staticmethod + def pause(): + ''' + Pauses playing momentarily. + ''' + cmd = "sudo pkill -STOP play" + _thread.start_new_thread(SoundPlayer._run, (cmd,)) + + @staticmethod + def resume(): + ''' + Resumes playing (after it has been stopped). + ''' + cmd = "sudo pkill -CONT play" + _thread.start_new_thread(SoundPlayer._run, (cmd,)) + + \ No newline at end of file diff --git a/testgpio.py b/testgpio.py new file mode 100644 index 0000000..318194b --- /dev/null +++ b/testgpio.py @@ -0,0 +1,218 @@ +import RPi.GPIO as GPIO +from mfrc522 import MFRC522 +import signal +from time import sleep +from soundplayer import SoundPlayer +import os +import glob + +#from interval import IntervalTimer + +maxload = 50 +maxtitel = 15 +titelnr = 1 +load = 50 +titel = "/home/pi/1-43ImmergruenePartyKnueller.mp3" +p = SoundPlayer(titel, 1) + +musik = {} + +playlist = True +lastcheck = 0 + +def loadSongs(): + global maxtitel + names = glob.glob("/home/pi/*.mp3") + for x in names: + p = int(x.split('-')[0].split('/')[3]) + musik[p] = x + maxtitel = len(musik) + +def showSongs(): + for i in range(len(musik)+1): + print(i,musik.get(i)) + +def playSong(nr): + global p + global titelnr + titelnr = nr + titel = musik.get(titelnr) + print("Now playing "+titel) + p.stop() + sleep(2) + p = SoundPlayer(titel,1) + p.play(1) # non-blocki + +def nextSong(): + global titelnr + global maxtitel + + if titelnr >= maxtitel: + titelnr = 1 + else: + titelnr = titelnr +1 + playSong(titelnr) + +def previousSong(): + global titelnr + global maxtitel + + if titelnr <= 1: + titelnr = maxtitel + else: + titelnr = titelnr -1 + playSong(titelnr) + + +def gibLaut(): + global lastcheck + global playlist + oks = p.isPlaying() + if oks == True: + lastcheck = 0 + else: + if lastcheck == 0: + lastcheck = 1 + else: + if lastcheck == 1: + lastcheck = 0 + if playlist == True: + nextSong() + + +#inter = IntervalTimer(2,gibLaut) + +continue_reading = True + +def setLoad(load): + s = "amixer -c 1 cset numid=6 "+str(load)+ "," + str(load) + " > /home/pi/loud.txt" + #print(s) + os.system(s) + f = open("/home/pi/loud.txt") + f.readline() + f.readline() + s=f.readline() + x = s.split(',') + + print(x[1]) + +def change_loudness(): + global load + f = open("/home/pi/start.txt","w") + f.write(str(load)) + print(str(load)) + f.close() + +def read_info(): + global maxload + global load + f = open("/home/pi/sound.txt") + f.readline() + s = f.readline() + x = s.split(',')[4].split('=') + maxload = int(x[1]) + g = open("/home/pi/start.txt") + s = g.readline() + load = int(s) + print(load) + setLoad(load) + +# Capture SIGINT for cleanup when the script is aborted +def end_read(signal,frame): + global continue_reading + print ("Ctrl+C captured, ending read.") + inter.stop() + continue_reading = False + GPIO.cleanup() + +# Hook the SIGINT +signal.signal(signal.SIGINT, end_read) + +# Create an object of the class MFRC522 +MIFAREReader = MFRC522() + +#Lauter +GPIO.setup(37, GPIO.IN) +#Leiser +GPIO.setup(36, GPIO.IN) +#Next Song +GPIO.setup(33, GPIO.IN) +#prevoius Song +GPIO.setup(35, GPIO.IN) +#set loudness +GPIO.setup(38, GPIO.IN) + +# Welcome message +print("Welcome to the jfs World of Sounds") + +loadSongs() +showSongs() + +info1 = os.system("amixer -c 1 cget numid=6 > /home/pi/sound.txt") +read_info() + +print ("Press Ctrl-C to stop.") +p.play(1) + + +#os.system("amixer -c 1 cset numid=6 50,50") +#inter.start() + +# This loop keeps checking for chips. If one is near it will get the UID and authenticate +while continue_reading: + # other pins + if GPIO.input(37) == 1: + #print("+") + if load < maxload: + load = load +5 + setLoad(load) + if GPIO.input(36) == 1: + #print("-") + if load > 0: + load = load - 5 + setLoad(load) + if GPIO.input(33) == 1 : + print(">>>>>") + nextSong() + if GPIO.input(35) == 1 : + print("<<<<<") + previousSong() + if GPIO.input(38) == 1 : + print("set loudness") + change_loudness() + + # Scan for cards + (status,TagType) = MIFAREReader.MFRC522_Request(MIFAREReader.PICC_REQIDL) + # If a card is found + if status == MIFAREReader.MI_OK: + print ("Card detected") + # Get the UID of the card + (status,uid) = MIFAREReader.MFRC522_Anticoll() + # If we have the UID, continue + if status == MIFAREReader.MI_OK: + # Print UID + print ("Card read UID: %s,%s,%s,%s" % (uid[0], uid[1], uid[2], uid[3]) ) + # This is the default key for authentication + key = [0xFF,0xFF,0xFF,0xFF,0xFF,0xFF] + # Select the scanned tag + MIFAREReader.MFRC522_SelectTag(uid) + # Authenticate + status = MIFAREReader.MFRC522_Auth(MIFAREReader.PICC_AUTHENT1A, 8, key, uid) + # Check if authenticated + if status == MIFAREReader.MI_OK: + data = [] + text_read = '' + #print(MIFAREReader.MFRC522_Read(8)) + block = MIFAREReader.MFRC522_Read(8) + if block: + data += block + if data: + text_read = ''.join(chr(i) for i in data) + MIFAREReader.MFRC522_StopCrypto1() + print(text_read) + s = text_read.strip() + i = int(s) + print("Card No "+str(i)) + playSong(i) + else: + print ( "Authentication error")