diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..2a84cc6 --- /dev/null +++ b/AUTHORS @@ -0,0 +1 @@ +Jiapeng Li \ No newline at end of file diff --git a/CHANGLOG.md b/CHANGLOG.md index 334a60e..3636a03 100644 --- a/CHANGLOG.md +++ b/CHANGLOG.md @@ -1,11 +1,18 @@ +## V0.2.0 +*2013-12-28* -##V0.1.1 ++ NDEF is supported on both Win32 and Linux ++ Net PN532 device is supported ++ Fix some bugs + +## V0.1.1 +*2013-12-17* + Serial Port Auto Detect + Read Felica/ISO14443-A/ISO14443-B types card ID, support verbose mode. + Read/Write Mifare S50 card blocks. + On Linux, support push/pull NDEF with Android 4.0+ -##V0.1.0 +## V0.1.0 -*Non-Release version, used for internal testing.* \ No newline at end of file +*Non-Release version, used for internal testing.* diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..cca7fc2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,165 @@ + 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/README.md b/README.md index 6e38161..9907805 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,30 @@ # GNFC -GNFC is a OpenSource GUI NFC tool which is based on QT and several nfc libraries(libnfc/libfreefare/libllcp/libndef), it aims at showing you how to use [ELECHOUSE USB NFC Device](http://elechouse.com) to read card and write card, even exchange data with Android4.0+(Linux version support this feature.). +GNFC is an OpenSource GUI NFC tool, it is based on QT and several nfc libraries(libnfc/libfreefare/libllcp/libndef). GNFC aims at showing how to NFC devices/modules to read card, write card, even exchange data with Android 4.0+ device. + +## Feature + ++ Support uart and net pn532 device ++ Serial Port Auto Detect ++ Read Felica/ISO14443-A/ISO14443-B types card ID, support verbose mode. ++ Read/Write Mifare S50 card blocks. ++ Support push/pull NDEF with Android 4.0+(Win32/Linux) ++ Beep function for Uart device + +## Supported Devices + ++ [Elechosue USB NFC Device]() ++ [Elechosue WIFI NFC Device]() ## Latest Release #### Windows -Pre-build binary file. [Download](https://github.com/JiapengLi/GNFC/releases/download/v0.1.1/gnfc-0.1.1-win.zip) +Pre-build binary file. [Download](https://github.com/JiapengLi/GNFC/releases/download/v0.2.0/gnfc-0.2.0-win.zip) #### Linux -Source code. [Download](https://github.com/JiapengLi/GNFC/archive/v0.1.1.zip) +Source code. [Download](https://github.com/JiapengLi/GNFC/archive/v0.2.0.zip) + +## Bugs ## DOC -[HOWTO](./doc/HOWTO.md) \ No newline at end of file +[HOWTO](./doc/HOWTO.md) diff --git a/TODO b/TODO new file mode 100644 index 0000000..4862dfb --- /dev/null +++ b/TODO @@ -0,0 +1,5 @@ +# TO DO + ++ Add support to MiFare s70 ++ MiFare NDEF Support ++ NDEF Card Emulator diff --git a/doc/HOWTO.md b/doc/HOWTO.md index bb357a4..db871b4 100644 --- a/doc/HOWTO.md +++ b/doc/HOWTO.md @@ -1,8 +1,18 @@ #GNFC -GNFC is a OpenSource GUI NFC tool which is based on QT and several nfc libraries(libnfc/libfreefare/libllcp/libndef), it aims at showing you how to use [ELECHOUSE USB NFC Device](http://elechouse.com) to read card and write card. -[ELECHOUSE USB NFC Device](http://elechouse.com) is based on PN532, it has an MCU and a beeper inside, user can send command(in PN532 frame format) to control beeper, the command value to control beeper is **0xA0**, after receive the `BEEP` command [ELECHOUSE USB NFC Device](http://elechouse.com) won't send ack package. +GNFC is an OpenSource GUI NFC tool, it is based on QT and several nfc libraries(libnfc/libfreefare/libllcp/libndef). GNFC aims at showing how to NFC devices/modules to read card, write card, even exchange data with Android 4.0+ device. +## Supported Devices + +### [Elechosue USB NFC Device](http://elechouse.com) + +[ELECHOUSE USB NFC Device]() is based on PN532, with an MCU and a beeper inside, the beeper can be controlled by sending command(in PN532 frame format) to it, the command value to control beeper is **0xA0**, after receive the `BEEP` command [ELECHOUSE USB NFC Device](http://elechouse.com) won't send ack package. + +### [Elechosue WIFI NFC Device](http://elechouse.com) +It is an OpenWrt based device, with a pn532 module in it. It is supported by pn532_net driver, pn532_net driver is at [JiapengLi/libnfc](https://github.com/JiapengLi/libnfc) + +[Elechosue WIFI NFC Device]() + ## Dependence + [libnfc](https://code.google.com/p/libnfc/) @@ -15,9 +25,7 @@ GNFC is a OpenSource GUI NFC tool which is based on QT and several nfc libraries ### Windows -There is a pre-build binary file. [Download](https://github.com/JiapengLi/GNFC/releases/download/v0.1.1/gnfc-0.1.1-win.zip) - -*Note: So far libllcp does not support Windows platform.* +There is a pre-build binary file. [Download](https://github.com/JiapengLi/GNFC/releases/download/v0.2.0/gnfc-0.2.0-win.zip) #### Tools Some tools is needed to compile libnfc and libfreefare. @@ -44,6 +52,14 @@ Use cmake to configure libfreefare, then generate Makefile for it. ![2](./img/02-configure-libfreefare.jpg) +#### libllcp +Download the libllcp source code. switch to **origin/socket** branch. Then use cmake to generate MinGW Makefiles just like *libfreefare*, by addition, specify the libws2_32.lib.a for it. + + mingw32-make + +#### libndef + + *Install programs by default and set parameter like pictures above may save some time.* ### Linux @@ -61,8 +77,10 @@ Use cmake to configure libfreefare, then generate Makefile for it. #### libnfc +*so far, pn532_net driver is not included by libnfc, checkout [JiapengLi/libnfc](https://github.com/JiapengLi/libnfc) instead, by which net driver is included. To use net driver specify a device name like "pn532_net:192.168.1.1:8000".* + autoreconf -vis - ./configure --with-drivers=pn532_uart --sysconfdir=/etc --prefix=/usr + ./configure --with-drivers=pn532_uart,pn532_net --sysconfdir=/etc --prefix=/usr make sudo make install all @@ -82,9 +100,10 @@ Use cmake to configure libfreefare, then generate Makefile for it. #### libndef - qmake PREFIX=/usr - make - sudo make install + qmake + mingw32-make + +lib files locate at *libndef/libndef/release/*, named **libndef1.a** and **ndef1.dll**, libndef/include/*.h is also needed. ## GNFC diff --git a/img/00-GNFC-0.2.0-default.jpg b/img/00-GNFC-0.2.0-default.jpg new file mode 100644 index 0000000..e14970e Binary files /dev/null and b/img/00-GNFC-0.2.0-default.jpg differ diff --git a/img/00-GNFC-0.2.0-ndef.jpg b/img/00-GNFC-0.2.0-ndef.jpg new file mode 100644 index 0000000..c4f5a8e Binary files /dev/null and b/img/00-GNFC-0.2.0-ndef.jpg differ