These instructions assume you have an Assuming you have an existing PhoneGap 2.3.0 Android project.
Use plugman to add phonegap-nfc to your Android project. Plugman requires node.js and is installed through npm.
Install plugman
$ npm install -g plugman
Install the plugin
$ plugman --platform android --project /path/to/your/project --plugin NFC
Modify your HTML to include phonegap-nfc.js
<script type="text/javascript" src="js/phonegap-nfc.js"></script>
Get the latest source code
$ git clone https://github.com/chariotsolutions/phonegap-nfc.git
The java code can be installed into your project as a jar file or by copying the source files.
Build the code
$ ant android
Copy phonegap-nfc-$VERSION.jar from dist/
to the libs/
directory in your project.
$ cp dist/phonegap-nfc-0.4.2.jar $YOUR_PROJECT/libs/
Copy the Java source files from src/android/src/ of phonegap-nfc project into the source directory of your Android project.
$ cp -R src/android/src/ $YOUR_PROJECT/src
Add the NfcPlugin in res/xml/config.xml
<plugin name="NfcPlugin" value="com.chariotsolutions.nfc.plugin.NfcPlugin"/>
Copy www/phonegap-nfc/js into assets/www
Include phonegap-nfc.js in index.html
<script type="text/javascript" charset="utf-8" src="phonegap-nfc.js"></script>
Add NFC permissions
<uses-permission android:name="android.permission.NFC" />
Ensure that the minSdkVersion
is 14
<uses-sdk android:minSdkVersion="14" />
If you want to restrict your application to only devices with NFC hardware, set uses-feature so Google Play will restrict the listing. If NFC is optional in your application, omit the uses-feature element.
<uses-feature android:name="android.hardware.nfc" android:required="true" />
Get the latest source code
$ git clone https://github.com/chariotsolutions/phonegap-nfc.git
The BB10 implementation is 100% JavaScript. You must build the code from source.
$ ant build-javascript
Copy dist/phonegap-nfc-VERSION.js and add it to your www folder
$ cp dist/phonegap-nfc-0.4.2.js $YOUR_PROJECT/www
Include phonegap-nfc-VERSION.js in index.html
<script type="text/javascript" src="phonegap-nfc-0.4.2.js"></script>
Create a filter in config.xml to read NDEF tags via the BlackBerry 10 Invocation Framework.
<rim:invoke-target id="<A unique ID for your project>">
<type>APPLICATION</type>
<filter>
<action>bb.action.OPEN</action>
<mime-type>application/vnd.rim.nfc.ndef</mime-type>
<property var="uris" value="ndef://0,ndef://1,ndef://2,def://3,ndef://4" />
</filter>
</rim:invoke-target>
The example filter above filters for all NDEF tags with TNF_EMPTY (0), TNF_WELL_KNOWN (1), TNF_MIME_MEDIA (2), TNF_ABSOLUTE_URI (3), TNF_EXTERNAL_TYPE (4).
The filter can also be more restrictive. For example we could only handle TNF_MIME_MEDIA tags with a mime type of 'text/pg'
<property var="uris" value="ndef://2/text/pg" />
Get the latest source code
$ git clone https://github.com/chariotsolutions/phonegap-nfc.git
Build the code
$ ant webworks
Copy dist/phonegap-nfc-VERSION.js and add it to your www folder
Include phonegap-nfc-VERSION.js in index.html
<script type="text/javascript" src="phonegap-nfc-0.4.2.js"></script>
The webworks jar contains source code that must be included in the Cordova jar file
Put phonegap-nfc-webworks-VERSION.jar in the root of your webworks project.
$ mkdir build/plugin
$ cd build/plugin/
$ jar xf ../../phonegap-nfc-webworks-0.4.2.jar
$ jar uf ../../www/ext/cordova.2.3.0.jar .
$ jar tf ../../www/ext/cordova.2.3.0.jar
Ensure that you see the NfcPlugin classes listed during the last step
$ jar tf ../..www/ext/cordova.2.3.0.jar
library.xml
org/
org/apache/
org/apache/cordova/
...
org/apache/cordova/util/StringUtils.java
com/
com/chariotsolutions/
com/chariotsolutions/nfc/
com/chariotsolutions/nfc/plugin/
com/chariotsolutions/nfc/plugin/NfcPlugin.java
com/chariotsolutions/nfc/plugin/Util.java
You can delete phonegap-nfc-webworks-VERSION.jar
Configure the NfcPlugin in www/plugins.xml
<plugin name="NfcPlugin" value="com.chariotsolutions.nfc.plugin.NfcPlugin"/>
Get the latest source code
c:\> git clone https://github.com/chariotsolutions/phonegap-nfc.git
Copy the plugin files from phonegap-nfc\src\windows-phone-8 to the Plugins directory of your project
c:\phonegap-nfc> copy src\windows-phone-8\*.cs %YOUR_PROJECT%\Plugins
Copy the javascript files from phonegap-nfc\www to the www directory of your project
c:\phonegap-nfc> copy src\www\phonegap-nfc.js %YOUR_PROJECT%\www
Include phonegap-nfc-VERSION.js in index.html
<script type="text/javascript" src="phonegap-nfc.js"></script>