@iotize/device-com-nfc.cordova 3.2.4 → 3.4.1

package/plugin.xml

@@ -1,97 +1,99 @@
-<?xml version="1.0" encoding="utf-8"?>
-<plugin xmlns="http://www.phonegap.com/ns/plugins/1.0" 
-    xmlns:android="http://schemas.android.com/apk/res/android" id="@iotize/device-com-nfc.cordova" version="3.0.1">
-
-    <name>@iotize/device-com-nfc.cordova</name>
-
-    <description>Near Field Communication (NFC) Plugin. Read and write NDEF messages to NFC tags and share NDEF messages with peers.</description>
-
-    <license>MIT</license>
-    <keywords>nfc, NFC, NDEF</keywords>
-    <repo>https://github.com/iotize-sas/device-com-nfc.cordova.git</repo>
-    <issue>https://github.com/iotize-sas/device-com-nfc.cordova/issues</issue>
-
-    <platform name="android">
-        <js-module src="www/phonegap-nfc.js" name="NFC">
-            <runs />
-        </js-module>
-
-        <config-file target="res/xml/config.xml" parent="/*">
-            <feature name="NfcPlugin">
-                <param name="android-package" value="com.chariotsolutions.nfc.plugin.NfcPlugin"/>
-                <param name="onload" value="true" />
-            </feature>
-            <feature name="NFCCom">
-                <param name="android-package" value="com.iotize.android.communication.nfc.cordovaplugin.NFCCom"/>
-            </feature>
-        </config-file>
-
-        <framework src="src/android/build.gradle" custom="true" type="gradleReference" />
-
-        <source-file src="src/android/src/com/chariotsolutions/nfc/plugin/NfcPlugin.java" target-dir="src/com/chariotsolutions/nfc/plugin"/>
-        <source-file src="src/android/src/com/chariotsolutions/nfc/plugin/Util.java" target-dir="src/com/chariotsolutions/nfc/plugin"/>
-        <source-file src="src/android/src/com/chariotsolutions/nfc/plugin/JSONBuilder.java" target-dir="src/com/chariotsolutions/nfc/plugin"/>
-        <source-file src="src/android/src/com/chariotsolutions/nfc/plugin/PluginResponse.java" target-dir="src/com/chariotsolutions/nfc/plugin"/>
-        <source-file src="src/android/src/com/chariotsolutions/nfc/plugin/NfcPluginError.java" target-dir="src/com/chariotsolutions/nfc/plugin"/>
-
-        <config-file target="AndroidManifest.xml" parent="/manifest">
-            <uses-permission android:name="android.permission.NFC"/>
-            <uses-feature android:name="android.hardware.nfc" android:required="false"/>
-        </config-file>
-
-        <config-file parent="/manifest/application/activity[@android:name='MainActivity']" target="AndroidManifest.xml" 
-            xmlns:android="http://schemas.android.com/apk/res/android">
-            <intent-filter>
-                <action android:name="android.nfc.action.NDEF_DISCOVERED" />
-                <category android:name="android.intent.category.DEFAULT" />
-                <data android:mimeType="application/$PACKAGE_NAME" />
-            </intent-filter>
-        </config-file>
-
-    </platform>
-
-    <platform name="ios">
-        <dependency id="cordova-plugin-add-swift-support"/>
-        <js-module src="www/phonegap-nfc.js" name="NFC">
-            <runs />
-        </js-module>
-
-        <config-file parent="/*" target="config.xml">
-            <feature name="NfcPlugin">
-                <param name="ios-package" value="NfcPlugin" />
-            </feature>
-            <preference name="deployment-target" value="11" />
-            <preference name="SwiftVersion" value="4" />
-
-        </config-file>
-        <source-file src="src/ios/NFCTapPlugin.swift" />
-        <source-file src="src/ios/ISO15Reader.swift" />
-        <source-file src="src/ios/NFCNDEFDelegate.swift" />
-        <source-file src="src/ios/AppDelegate+NFC.swift" />
-        <source-file src="src/ios/NFCPlugin-Bridging-Header.h" />
-
-
-        <config-file platform="ios" target="*-Debug.plist" parent="com.apple.developer.nfc.readersession.formats">
-            <array>
-                <string>NDEF</string>
-                <string>TAG</string>
-            </array>
-        </config-file>
-
-        <config-file platform="ios" target="*-Release.plist" parent="com.apple.developer.nfc.readersession.formats">
-            <array>
-                <string>NDEF</string>
-                <string>TAG</string>
-            </array>
-        </config-file>
-
-        <!-- frameworks -->
-        <framework src="CoreNFC.framework" weak="true"/>
-
-        <config-file target="*-Info.plist" parent="NFCReaderUsageDescription">
-            <string>Communicate with IoTize NFC Tags</string>
-        </config-file>
-    </platform>
-
-
-</plugin>
+<?xml version="1.0" encoding="utf-8"?>
+<plugin xmlns="http://www.phonegap.com/ns/plugins/1.0" 
+    xmlns:android="http://schemas.android.com/apk/res/android" id="@iotize/device-com-nfc.cordova" version="3.4.0">
+
+    <name>@iotize/device-com-nfc.cordova</name>
+
+    <description>Near Field Communication (NFC) Plugin. Read and write NDEF messages to NFC tags and share NDEF messages with peers.</description>
+
+    <license>MIT</license>
+    <keywords>nfc, NFC, NDEF</keywords>
+    <repo>https://github.com/iotize-sas/device-com-nfc.cordova.git</repo>
+    <issue>https://github.com/iotize-sas/device-com-nfc.cordova/issues</issue>
+
+    <platform name="android">
+        <js-module src="www/phonegap-nfc.js" name="NFC">
+            <runs />
+        </js-module>
+
+        <config-file target="res/xml/config.xml" parent="/*">
+            <feature name="NfcPlugin">
+                <param name="android-package" value="com.chariotsolutions.nfc.plugin.NfcPlugin"/>
+                <param name="onload" value="true" />
+            </feature>
+            <feature name="NFCCom">
+                <param name="android-package" value="com.iotize.android.communication.nfc.cordovaplugin.NFCCom"/>
+            </feature>
+        </config-file>
+
+        <framework src="src/android/build.gradle" custom="true" type="gradleReference" />
+
+        <source-file src="src/android/src/com/chariotsolutions/nfc/plugin/NfcPlugin.java" target-dir="src/com/chariotsolutions/nfc/plugin"/>
+        <source-file src="src/android/src/com/chariotsolutions/nfc/plugin/Util.java" target-dir="src/com/chariotsolutions/nfc/plugin"/>
+        <source-file src="src/android/src/com/chariotsolutions/nfc/plugin/JSONBuilder.java" target-dir="src/com/chariotsolutions/nfc/plugin"/>
+        <source-file src="src/android/src/com/chariotsolutions/nfc/plugin/PluginResponse.java" target-dir="src/com/chariotsolutions/nfc/plugin"/>
+        <source-file src="src/android/src/com/chariotsolutions/nfc/plugin/NfcPluginError.java" target-dir="src/com/chariotsolutions/nfc/plugin"/>
+
+        <config-file target="AndroidManifest.xml" parent="/manifest">
+            <uses-permission android:name="android.permission.NFC"/>
+            <uses-feature android:name="android.hardware.nfc" android:required="false"/>
+        </config-file>
+
+        <config-file parent="/manifest/application/activity[@android:name='MainActivity']" target="AndroidManifest.xml" 
+            xmlns:android="http://schemas.android.com/apk/res/android">
+            <intent-filter>
+                <action android:name="android.nfc.action.NDEF_DISCOVERED" />
+                <category android:name="android.intent.category.DEFAULT" />
+                <data android:mimeType="application/$PACKAGE_NAME" />
+            </intent-filter>
+        </config-file>
+
+    </platform>
+
+    <platform name="ios">
+        <dependency id="cordova-plugin-add-swift-support"/>
+        <js-module src="www/phonegap-nfc.js" name="NFC">
+            <runs />
+        </js-module>
+
+        <config-file parent="/*" target="config.xml">
+            <feature name="NfcPlugin">
+                <param name="ios-package" value="NfcPlugin" />
+            </feature>
+            <preference name="deployment-target" value="11" />
+            <preference name="SwiftVersion" value="4" />
+
+        </config-file>
+        <source-file src="src/ios/NFCTapPlugin.swift" />
+        <source-file src="src/ios/ISO15Reader.swift" />
+        <source-file src="src/ios/NFCNDEFDelegate.swift" />
+        <source-file src="src/ios/AppDelegate+NFC.swift" />
+        <source-file src="src/ios/NFCHelpers.swift" />
+        <source-file src="src/ios/NFCTagReader.swift" />
+        <source-file src="src/ios/NFCPlugin-Bridging-Header.h" />
+
+
+        <config-file platform="ios" target="*-Debug.plist" parent="com.apple.developer.nfc.readersession.formats">
+            <array>
+                <string>NDEF</string>
+                <string>TAG</string>
+            </array>
+        </config-file>
+
+        <config-file platform="ios" target="*-Release.plist" parent="com.apple.developer.nfc.readersession.formats">
+            <array>
+                <string>NDEF</string>
+                <string>TAG</string>
+            </array>
+        </config-file>
+
+        <!-- frameworks -->
+        <framework src="CoreNFC.framework" weak="true"/>
+
+        <config-file target="*-Info.plist" parent="NFCReaderUsageDescription">
+            <string>Communicate with IoTize NFC Tags</string>
+        </config-file>
+    </platform>
+
+
+</plugin>

package/src/android/src/com/chariotsolutions/nfc/plugin/NfcPlugin.java

@@ -16,6 +16,7 @@ import android.nfc.Tag;
 import android.nfc.TagLostException;
 import android.nfc.tech.Ndef;
 import android.nfc.tech.NdefFormatable;
+import android.nfc.tech.TagTechnology;
 import android.os.Bundle;
 import android.os.Parcelable;
 import android.util.Log;
@@ -41,6 +42,7 @@ import org.json.JSONObject;
 import java.io.IOException;
 import java.lang.reflect.Field;
 import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Iterator;
@@ -81,6 +83,7 @@ public class NfcPlugin extends CordovaPlugin implements NfcAdapter.OnNdefPushCom
     // TagTechnology IsoDep, NfcA, NfcB, NfcV, NfcF, MifareClassic, MifareUltralight
     private static final String CONNECT = "connect";
     private static final String CLOSE = "close";
+    private static final String TRANSCEIVE_TAP = "transceiveTap";
     private static final String TRANSCEIVE = "transceive";
 
     private static final String NFC_TAP_DEVICE = "nfc-tap-device";
@@ -90,10 +93,13 @@ public class NfcPlugin extends CordovaPlugin implements NfcAdapter.OnNdefPushCom
     private static final String PREF_ENABLE_ENCRYPTION_WITH_NFC = "EnableEncryptionWithNFC";
     private static final String PREF_NFC_PAIRING_DONE_TOAST_MESSAGE = "NFCParingDoneToastMessage";
     private static final String REGISTER_NFC_TAP_DEVICE = "registerTapDevice";
+    private static final String SET_TAP_DEVICE_DISCOVERY_ENABLED = "setTapDeviceDiscoveryEnabled";
 
-//    @Nullable
-//    private TagTechnology tagTechnology = null;
-//    private Class<?> tagTechnologyClass;
+    @Nullable
+    private TagTechnology tagTechnology = null;
+
+    @Nullable
+    private Class<?> tagTechnologyClass;
 
     private static final String CHANNEL = "channel";
 
@@ -124,10 +130,12 @@ public class NfcPlugin extends CordovaPlugin implements NfcAdapter.OnNdefPushCom
     @Nullable
     private Intent mLastTapDiscoveredIntent;
 
+    private boolean _isTapDeviceDiscoveryEnabled = true;
+
     @Override
     public boolean execute(String action, JSONArray data, CallbackContext callbackContext) throws JSONException {
 
-        Log.d(TAG, "execute " + action);
+            Log.d(TAG, "execute " + action);
 
         // showSettings can be called if NFC is disabled
         // might want to skip this if NO_NFC
@@ -219,13 +227,23 @@ public class NfcPlugin extends CordovaPlugin implements NfcAdapter.OnNdefPushCom
             CordovaArgs args = new CordovaArgs(data); // execute is using the old signature with JSON data
 
             byte[] command = args.getArrayBuffer(0);
-            transceive(command, callbackContext);
+            transceiveRaw(command, callbackContext);
+
+        } else if (action.equalsIgnoreCase(TRANSCEIVE_TAP)) {
+            CordovaArgs args = new CordovaArgs(data); // execute is using the old signature with JSON data
+
+            byte[] command = args.getArrayBuffer(0);
+            transceiveTap(command, callbackContext);
 
         } else if (action.equalsIgnoreCase(CLOSE)) {
             close(callbackContext);
 
+        } else if (action.equalsIgnoreCase(SET_TAP_DEVICE_DISCOVERY_ENABLED)) {
+            CordovaArgs args = new CordovaArgs(data);
+            this._isTapDeviceDiscoveryEnabled = args.getBoolean(0);
         } else {
             // invalid action
+            callbackContext.error("Invalid NFC action \"" + action +"\"");
             return false;
         }
 
@@ -440,7 +458,7 @@ public class NfcPlugin extends CordovaPlugin implements NfcAdapter.OnNdefPushCom
     }
 
     private boolean isTapDeviceDiscoveryEnabled() {
-        return preferences.getBoolean(PREF_ENABLE_TAP_DEVICE_DISCOVERY, false);
+        return this._isTapDeviceDiscoveryEnabled && preferences.getBoolean(PREF_ENABLE_TAP_DEVICE_DISCOVERY, false);
     }
 
     // Cheating and writing an empty record. We may actually be able to erase some tag types.
@@ -826,7 +844,7 @@ public class NfcPlugin extends CordovaPlugin implements NfcAdapter.OnNdefPushCom
             Tag tag = intent.getParcelableExtra(NfcAdapter.EXTRA_TAG);
             Parcelable[] messages = intent.getParcelableArrayExtra((NfcAdapter.EXTRA_NDEF_MESSAGES));
 
-            if (isTapDeviceDiscoveryEnabled() && tag != null) {
+            if (isTapDeviceDiscoveryEnabled() && isIoTizeTag(tag)) {
                 onTapDeviceDiscoveredIntent(intent);
             }
 
@@ -856,8 +874,25 @@ public class NfcPlugin extends CordovaPlugin implements NfcAdapter.OnNdefPushCom
         });
     }
 
-    private boolean notifyWhenNfcPairingDone() {
-        return true; // TODO
+    private boolean isIoTizeTag(@Nullable Tag tag) {
+        if (tag == null) {
+            return false;
+        }
+        boolean hasNfcV = Arrays.stream(tag.getTechList()).anyMatch(s -> s.endsWith("NfcV"));
+        if (!hasNfcV) {
+            return false;
+        }
+        Ndef ndef = Ndef.get(tag);
+        if (ndef == null) {
+            return false;
+        }
+        NdefMessage ndefMessages = ndef.getCachedNdefMessage();
+        if (ndefMessages == null) {
+            return false;
+        }
+        NdefRecord[] records = ndefMessages.getRecords();
+
+        return records.length > 0;
     }
 
     private void sendEvent(String type, JSONObject tag, JSONObject tap) {
@@ -1077,29 +1112,9 @@ public class NfcPlugin extends CordovaPlugin implements NfcAdapter.OnNdefPushCom
                          final CallbackContext callbackContext) {
         this.cordova.getThreadPool().execute(() -> {
             try {
+                this._initIntentTag(tech);
 
-                Tag tag = getIntent().getParcelableExtra(NfcAdapter.EXTRA_TAG);
-                if (tag == null) {
-                    tag = savedIntent.getParcelableExtra(NfcAdapter.EXTRA_TAG);
-                }
-
-                if (tag == null) {
-                    Log.e(TAG, "No Tag");
-                    callbackContext.error("No Tag");
-                    return;
-                }
-
-                // get technologies supported by this tag
-                List<String> techList = Arrays.asList(tag.getTechList());
-                if (techList.contains(tech)) {
-                    // use reflection to call the static function Tech.get(tag)
-//                    tagTechnologyClass = Class.forName(tech);
-                    nfcProtocol = NFCProtocol.create(tag);
-//                    Method method = tagTechnologyClass.getMethod("get", Tag.class);
-//                    tagTechnology = (TagTechnology) method.invoke(null, tag);
-                }
-
-                if (nfcProtocol == null) {
+                if (nfcProtocol == null) {        
                     callbackContext.error("Tag does not support " + tech);
                     return;
                 }
@@ -1118,6 +1133,41 @@ public class NfcPlugin extends CordovaPlugin implements NfcAdapter.OnNdefPushCom
         });
     }
 
+    private void _initIntentTag() throws Exception {
+        this._initIntentTag("android.nfc.tech.NfcV"); // TODO
+    }
+
+    private void _initIntentTag(final String tech) throws Exception {
+        Intent intent = getIntent();
+        Tag tag = null;
+        if (intent != null) {
+            tag = intent.getParcelableExtra(NfcAdapter.EXTRA_TAG);
+        }
+        if (tag == null && savedIntent != null) {
+            tag = savedIntent.getParcelableExtra(NfcAdapter.EXTRA_TAG);
+        }
+
+        if (tag == null) {
+            Log.e(TAG, "No Tag");
+            throw new Exception("No Tag");
+        }
+
+        // get technologies supported by this tag
+        List<String> techList = Arrays.asList(tag.getTechList());
+        if (!techList.contains(tech)) {
+            throw new Exception("Tech " + tech + " not available");
+        }
+        // use reflection to call the static function Tech.get(tag)
+        tagTechnologyClass = Class.forName(tech);
+        nfcProtocol = NFCProtocol.create(tag);
+        Method method = tagTechnologyClass.getMethod("get", Tag.class);
+        tagTechnology = (TagTechnology) method.invoke(null, tag);
+        if (tagTechnology == null) {
+            Log.e(TAG, "No Tag Technology");
+            throw new Exception("No Tag");
+        }
+    }
+
     private void setTimeout(int timeout) {
         if (timeout < 0) {
             return;
@@ -1144,6 +1194,11 @@ public class NfcPlugin extends CordovaPlugin implements NfcAdapter.OnNdefPushCom
                 Log.e(TAG, "Error closing nfc connection", ex);
                 callbackContext.error("Error closing nfc connection " + ex.getLocalizedMessage());
             }
+            finally {
+                nfcProtocol = null;
+                tagTechnology = null;
+                tagTechnologyClass = null;
+            }
         });
     }
 
@@ -1153,7 +1208,62 @@ public class NfcPlugin extends CordovaPlugin implements NfcAdapter.OnNdefPushCom
      * @param data            byte[] command to be passed to the tag
      * @param callbackContext Cordova callback context
      */
-    private void transceive(final byte[] data, final CallbackContext callbackContext) {
+    private void transceiveRaw(final byte[] data, final CallbackContext callbackContext) {
+        cordova.getThreadPool().execute(() -> {
+            try {
+                this._connectIntentTagIfNeeded();
+                Method transceiveMethod = tagTechnologyClass.getMethod("transceive", byte[].class);
+                try {
+                    @SuppressWarnings("PrimitiveArrayArgumentToVarargsMethod")
+                    byte[] response = (byte[]) transceiveMethod.invoke(tagTechnology, data);
+                    callbackContext.success(Helper.ByteArrayToHexString(response));
+                }
+                catch (InvocationTargetException e) {
+                    Throwable targetException = e.getTargetException();
+                    String errorMessage = targetException.getMessage();
+                    if (errorMessage != null && (errorMessage.endsWith("is out of date") ||
+                            errorMessage.contains("Call connect() first"))) {
+                        this._connectIntentTag();
+                        // Retry
+                        byte[] response = (byte[]) transceiveMethod.invoke(tagTechnology, data);
+                        callbackContext.success(Helper.ByteArrayToHexString(response));
+                    }
+                    else {
+                        throw e;
+                    }
+                }
+            }
+            catch (InvocationTargetException e) {
+                String msg = e.getTargetException().getMessage();
+                Log.e(TAG, msg, e);
+                callbackContext.error(msg);
+            }
+            catch (Throwable e) {
+                Log.e(TAG, e.getMessage(), e);
+                callbackContext.error(e.getMessage());
+            }
+        });
+    }
+
+    private void _connectIntentTag() throws Exception {
+        this._initIntentTag();
+        tagTechnology.connect();
+    }
+
+    private void _connectIntentTagIfNeeded() throws Exception {
+        if (tagTechnology == null) {
+            this._initIntentTag();
+            tagTechnology.connect();
+        }
+    }
+
+    /**
+     * Send raw commands to the tag and receive the response.
+     *
+     * @param data            byte[] command to be passed to the tag
+     * @param callbackContext Cordova callback context
+     */
+    private void transceiveTap(final byte[] data, final CallbackContext callbackContext) {
         cordova.getThreadPool().execute(() -> {
             try {
                 if (nfcProtocol == null) {
@@ -1166,11 +1276,6 @@ public class NfcPlugin extends CordovaPlugin implements NfcAdapter.OnNdefPushCom
                     callbackContext.error("Not connected");
                     return;
                 }
-
-                // Use reflection so we can support many tag types
-                //Method transceiveMethod = tagTechnologyClass.getMethod("transceive", byte[].class);
-//                @SuppressWarnings("PrimitiveArrayArgumentToVarargsMethod")
-//                byte[] response = (byte[]) transceiveMethod.invoke(tagTechnology, data);
                 byte[] response = nfcProtocol.send(data);
                 callbackContext.success(Helper.ByteArrayToHexString(response));
             } catch (Exception e) {
@@ -1179,5 +1284,4 @@ public class NfcPlugin extends CordovaPlugin implements NfcAdapter.OnNdefPushCom
             }
         });
     }
-
 }