diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9c95fc0 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +MFRC522.pyc diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..34aa050 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,18 @@ +FROM armv7/armhf-ubuntu +RUN apt-get update && apt-get install -y \ + python \ + python-dev \ + python-pip \ + python-virtualenv \ + python-setuptools \ + gcc-multilib \ + git \ + ssh \ + --no-install-recommends \ + && pip install --upgrade pip \ + && pip install wheel +WORKDIR /usr/app +COPY requirements.txt /usr/app +RUN pip install -r requirements.txt +COPY . /usr/app +CMD python Read.py diff --git a/Dump.py b/Dump.py index 0125801..3b528e4 100644 --- a/Dump.py +++ b/Dump.py @@ -1,5 +1,25 @@ #!/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 MFRC522 diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..5357f69 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,166 @@ + GNU LESSER 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. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. + diff --git a/MFRC522.py b/MFRC522.py index 88789f2..441482a 100644 --- a/MFRC522.py +++ b/MFRC522.py @@ -1,5 +1,25 @@ #!/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 spi @@ -110,7 +130,7 @@ class MFRC522: def __init__(self, dev='/dev/spidev0.0', spd=1000000): spi.openSPI(device=dev,speed=spd) GPIO.setmode(GPIO.BOARD) - GPIO.setup(22, GPIO.OUT) + GPIO.setup(NRSTPD, GPIO.OUT) GPIO.output(self.NRSTPD, 1) self.MFRC522_Init() diff --git a/README.md b/README.md index 7671fc0..1b3150a 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,12 @@ MFRC522-python ============== - A small class to interface with the NFC reader Module MFRC522 on the Raspberry Pi. This is a Python port of the example code for the NFC module MF522-AN. +**Important notice:** This library has not being actively updated in almost four years. +It might not work as intended on more recent Raspberry Pi devices. You might want to +take a look to the open pull-requests and forks to see other implementations and bug-fixes. + ## Requirements This code requires you to have SPI-Py installed from the following repository: https://github.com/lthiery/SPI-Py @@ -27,3 +30,6 @@ You can use [this](http://i.imgur.com/y7Fnvhq.png) image for reference. ## Usage Import the class by importing MFRC522 in the top of your script. For more info see the examples. + +## License +This code and examples are licensed under the GNU Lesser General Public License 3.0. diff --git a/Read.py b/Read.py index c7ef047..cc395c5 100644 --- a/Read.py +++ b/Read.py @@ -1,5 +1,25 @@ #!/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 MFRC522 diff --git a/Write.py b/Write.py index de74ed0..237e268 100644 --- a/Write.py +++ b/Write.py @@ -1,5 +1,25 @@ #!/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 MFRC522 diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..7d616f4 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +RPi.GPIO==0.6.3 +-e git+https://github.com/lthiery/SPI-Py.git#egg=spi-pi