@wisdomgarden/capacitor-plugin-beacon 0.0.1 → 0.0.3

package/CHANGE-LOG.md

@@ -0,0 +1,13 @@
+## 0.0.2 (2025-12-23)
+
+### Bug Fixes
+- Fix (Android): Resolved broadcast failure `ADVERTISE_FAILED_DATA_TOO_LARGE`.
+- Fix (Android/iOS): Resolved issue where stale/historical messages were received due to system caching.
+- Optimization: Standardized logToJsWithTag output format and logical sequence `[SEQ-XX]` .
+
+## 0.0.3 (2025-12-23)
+
+### Optimize code
+- Logic Optimization: Aligned cross-platform encoding and improved variable-length payload handling.
+- Code Fixes: Resolved naming conflicts and indexing safety issues.
+- Log Refinement: Simplified logs with concise method tags.

package/android/src/main/java/com/wisdomgarden/mobile/beacon/Beacon.java

@@ -10,10 +10,12 @@ import android.bluetooth.le.BluetoothLeAdvertiser;
 import android.bluetooth.le.BluetoothLeScanner;
 import android.bluetooth.le.ScanCallback;
 import android.bluetooth.le.ScanFilter;
+import android.bluetooth.le.ScanRecord;
 import android.bluetooth.le.ScanResult;
 import android.bluetooth.le.ScanSettings;
 import android.content.Context;
 import android.os.ParcelUuid;
+import android.util.Log;
 
 import com.getcapacitor.JSObject;
 import com.getcapacitor.NativePlugin;
@@ -25,22 +27,33 @@ import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
 
-@NativePlugin()
+@NativePlugin
 public class Beacon extends Plugin {
-    private static final String TAG = "Beacon";
-    private static final String WG_UUID = "1ed18c59-a7cc-4752-96b0-51d77a456584";
+
+    private static final String TAG = "WisdomGardenBeacon";
+
+    private static final int MANUFACTURER_ID = 0xFFFF;
 
     private BluetoothAdapter bluetoothAdapter;
     private BluetoothLeAdvertiser advertiser;
     private BluetoothLeScanner scanner;
     private boolean isBroadcasting = false;
     private boolean isMonitoring = false;
-    private int rollcallId = 0;
-    private String nonce = "";
     private String message = "";
 
+    /**
+     * Helper to send tagged logs to JS bridge with sequence prefix.
+     * Consolidates bridge communication and system logging.
+     */
+    private void logToJsWithTag(String seq, String msg) {
+        String formattedMessage = (seq != null ? " " + seq : "") + ": " + msg;
+        bridge.logToJs("[" + TAG + "]" + formattedMessage);
+        Log.i(TAG, formattedMessage);
+    }
+
     @PluginMethod
     public void initialize(PluginCall call) {
+        Log.i(TAG, "[SEQ-0] Plugin Initialized");
         call.resolve();
     }
 
@@ -51,11 +64,13 @@ public class Beacon extends Plugin {
         }
 
         if (bluetoothAdapter == null) {
+            Log.e(TAG, "Bluetooth hardware not supported on this device");
             call.reject("Bluetooth is not supported on this device");
             return false;
         }
 
         if (!bluetoothAdapter.isEnabled()) {
+            Log.w(TAG, "Bluetooth is currently disabled");
             call.reject("Bluetooth is not enabled");
             return false;
         }
@@ -65,40 +80,41 @@ public class Beacon extends Plugin {
 
     @PluginMethod
     public void startBroadcasting(PluginCall call) {
-        bridge.logToJs("[Debug] startBroadcasting 11");
+        logToJsWithTag("[SEQ-10]", "startBroadcasting invoked");
 
-        if (call.getString("message") != null && call.getString("message").length() == BeaconUtils.getMessageMaxLength()) {
-            message = call.getString("message");
+        String inputMsg = call.getString("message");
+        if (inputMsg != null && inputMsg.length() == BeaconUtils.getMessageMaxLength()) {
+            message = inputMsg;
         } else {
-            if (call.getInt("rollcallId") == null) {
+            Integer rId = call.getInt("rollcallId");
+            String nonce = call.getString("nonce");
+            if (rId == null) {
+                Log.e(TAG, "Broadcasting failed: Missing rollcallId");
                 call.reject("rollcallId is required");
                 return;
             }
-            if (call.getString("nonce") == null) {
+            if (nonce == null) {
+                Log.e(TAG, "Broadcasting failed: Missing nonce");
                 call.reject("nonce is required");
                 return;
             }
 
-            rollcallId = call.getInt("rollcallId");
-            nonce = call.getString("nonce");
-
-            message = BeaconUtils.buildMessage(rollcallId, nonce);
+            message = BeaconUtils.buildMessage(rId, nonce);
         }
-
-        bridge.logToJs("[Debug] startBroadcasting 11.1");
+        logToJsWithTag("[SEQ-11]", "Payload prepared: " + message);
 
         if (isBroadcasting) {
+            logToJsWithTag("[SEQ-12]", "Already broadcasting, skipping");
             call.resolve();
             return;
         }
-        bridge.logToJs("[Debug] startBroadcasting 11.2");
 
         if (!checkBluetoothEnabled(call)) {
             return;
         }
 
         startAdvertising();
-        bridge.logToJs("[Debug] startBroadcasting 11.3");
+        logToJsWithTag("[SEQ-16]", "startBroadcasting logic completed");
 
         call.resolve();
     }
@@ -106,6 +122,7 @@ public class Beacon extends Plugin {
     @PluginMethod
     @SuppressLint("MissingPermission")
     public void stopBroadcasting(PluginCall call) {
+        logToJsWithTag("[SEQ-20]", "stopBroadcasting called");
         if (advertiser != null) {
             advertiser.stopAdvertising(advertiseCallback);
             advertiser = null;
@@ -118,19 +135,19 @@ public class Beacon extends Plugin {
 
     @PluginMethod
     public void startMonitoring(PluginCall call) {
-        bridge.logToJs("[Debug] startMonitoring 21");
+        logToJsWithTag("[SEQ-30]", "startMonitoring invoked");
         if (isMonitoring) {
+            logToJsWithTag("[SEQ-31]", "Already monitoring, skipping");
             call.resolve();
             return;
         }
-        bridge.logToJs("[Debug] startMonitoring 21.1");
 
         if (!checkBluetoothEnabled(call)) {
             return;
         }
 
         scanForPeripherals();
-        bridge.logToJs("[Debug] startMonitoring 21.3");
+        logToJsWithTag("[SEQ-36]", "startMonitoring logic completed");
 
         call.resolve();
     }
@@ -138,6 +155,7 @@ public class Beacon extends Plugin {
     @PluginMethod
     @SuppressLint("MissingPermission")
     public void stopMonitoring(PluginCall call) {
+        logToJsWithTag("[SEQ-40]", "stopMonitoring called");
         if (scanner != null) {
             scanner.stopScan(scanCallback);
             scanner = null;
@@ -149,6 +167,7 @@ public class Beacon extends Plugin {
     @PluginMethod
     @SuppressLint("MissingPermission")
     public void cleanup(PluginCall call) {
+        Log.i(TAG, "[SEQ-90] Cleanup: Resetting all states");
         if (advertiser != null) {
             advertiser.stopAdvertising(advertiseCallback);
             advertiser = null;
@@ -165,8 +184,6 @@ public class Beacon extends Plugin {
         isMonitoring = false;
 
         message = "";
-        nonce = "";
-        rollcallId = 0;
 
         removeAllListeners(call);
 
@@ -176,6 +193,7 @@ public class Beacon extends Plugin {
     @PluginMethod
     public void parseMessage(PluginCall call) {
         String message = call.getString("message");
+        Log.v(TAG, "Parsing message: " + message);
         Map<String, Object> result = BeaconUtils.parseMessage(message);
         JSObject jsResult = new JSObject();
         jsResult.put("rollcallId", result.get("rollcallId"));
@@ -185,7 +203,7 @@ public class Beacon extends Plugin {
 
     @SuppressLint("MissingPermission")
     private void startAdvertising() {
-        bridge.logToJs("[Debug] startAdvertising 12");
+        logToJsWithTag("[SEQ-13]", "Initialising LE Advertiser");
         if (advertiser == null) {
             advertiser = bluetoothAdapter.getBluetoothLeAdvertiser();
         }
@@ -193,7 +211,7 @@ public class Beacon extends Plugin {
         if (isBroadcasting) {
             return;
         }
-        bridge.logToJs("[Debug] startAdvertising broadcasting 13");
+        logToJsWithTag("[SEQ-13-1]", "Preparing packet with message: " + message);
         isBroadcasting = true;
 
         AdvertiseSettings settings = new AdvertiseSettings.Builder()
@@ -203,24 +221,22 @@ public class Beacon extends Plugin {
                 .setTxPowerLevel(AdvertiseSettings.ADVERTISE_TX_POWER_MEDIUM)
                 .build();
 
-
-        bluetoothAdapter.setName(message);
-        bridge.logToJs("[Debug] startAdvertising broadcasting 13.1 " + message + " " + message.length());
+        byte[] payload = BeaconUtils.addPrefixToBytes(message);
 
         AdvertiseData advertiseData = new AdvertiseData.Builder()
-                .setIncludeDeviceName(true)
+                .setIncludeDeviceName(false)
                 .setIncludeTxPowerLevel(false)
-                .addServiceUuid(new ParcelUuid(java.util.UUID.fromString(WG_UUID)))
+                .addServiceUuid(new ParcelUuid(java.util.UUID.fromString(BeaconUtils.WG_UUID)))
+                .addManufacturerData(MANUFACTURER_ID, payload)
                 .build();
 
-        bridge.logToJs("[Debug] startAdvertising broadcasting 14");
+        logToJsWithTag("[SEQ-14]", "Calling advertiser.startAdvertising");
         advertiser.startAdvertising(settings, advertiseData, advertiseCallback);
-        bridge.logToJs("[Debug] startAdvertising broadcasting 15");
     }
 
     @SuppressLint("MissingPermission")
     private void scanForPeripherals() {
-        bridge.logToJs("[Debug] scanForPeripherals 22");
+        logToJsWithTag("[SEQ-32]", "Initialising LE Scanner");
         if (scanner == null) {
             scanner = bluetoothAdapter.getBluetoothLeScanner();
         }
@@ -228,30 +244,24 @@ public class Beacon extends Plugin {
         if (isMonitoring) {
             return;
         }
-        bridge.logToJs("[Debug] scanForPeripherals monitoring 23");
+
         isMonitoring = true;
 
-        ScanSettings settings = new ScanSettings.Builder()
-                .setScanMode(ScanSettings.SCAN_MODE_LOW_LATENCY)
-                .setReportDelay(0)
-                .build();
+        ScanSettings settings = new ScanSettings.Builder().setScanMode(ScanSettings.SCAN_MODE_LOW_LATENCY).setReportDelay(0).build();
 
         List<ScanFilter> filters = new ArrayList<>();
-        ScanFilter filter = new ScanFilter.Builder()
-                .setServiceUuid(new ParcelUuid(java.util.UUID.fromString(WG_UUID)))
-                .build();
+        ScanFilter filter = new ScanFilter.Builder().setServiceUuid(new ParcelUuid(java.util.UUID.fromString(BeaconUtils.WG_UUID))).build();
         filters.add(filter);
 
-        bridge.logToJs("[Debug] scanForPeripherals monitoring 24");
+        logToJsWithTag("[SEQ-33]", "Calling scanner.startScan");
         scanner.startScan(filters, settings, scanCallback);
-        bridge.logToJs("[Debug] scanForPeripherals monitoring 25");
     }
 
     private final AdvertiseCallback advertiseCallback = new AdvertiseCallback() {
         @Override
         public void onStartSuccess(AdvertiseSettings settingsInEffect) {
             super.onStartSuccess(settingsInEffect);
-            bridge.logToJs("[Beacon] Peripheral manager is powered on");
+            logToJsWithTag("[SEQ-15]", "AdvertiseCallback: Success (Peripheral Active)");
             JSObject data = new JSObject();
             data.put("type", "peripheral");
             data.put("state", "poweredOn");
@@ -261,7 +271,7 @@ public class Beacon extends Plugin {
         @Override
         public void onStartFailure(int errorCode) {
             super.onStartFailure(errorCode);
-            bridge.logToJs("[Beacon] Peripheral manager failed to start advertising: " + errorCode);
+            logToJsWithTag("[SEQ-15-F]", "AdvertiseCallback: Failure (Error: " + errorCode + ")");
             JSObject data = new JSObject();
             data.put("type", "peripheral");
             data.put("state", errorCode);
@@ -275,20 +285,52 @@ public class Beacon extends Plugin {
         @Override
         public void onScanResult(int callbackType, ScanResult result) {
             super.onScanResult(callbackType, result);
-            bridge.logToJs("[Debug] onScanResult 31");
-            if (result.getScanRecord() != null) {
-                bridge.logToJs("[Debug] onScanResult 32");
-                String deviceName = result.getScanRecord().getDeviceName();
-                if (deviceName != null && deviceName.length() == BeaconUtils.getMessageMaxLength()) {
-                    bridge.logToJs("[Debug] onScanResult 33" + deviceName);
-                    JSObject jsResult = new JSObject();
-                    jsResult.put("message", deviceName);
-                    jsResult.put("rssi", result.getRssi());
-                    jsResult.put("peripheralId", result.getDevice().getAddress());
-                    jsResult.put("timestamp", System.currentTimeMillis());
-                    notifyListeners("beaconReceived", jsResult);
+            ScanRecord record = result.getScanRecord();
+            Log.d(TAG, "start scan result received");
+            if (record == null) {
+                Log.w(TAG, "Scan result is null");
+                return;
+            }
+
+            String finalMsg;
+            /*
+             * [SEQ-50]
+             * Strategy 1: Attempt to extract message from Manufacturer Specific Data.
+             * This is the primary channel, typically used by Android broadcasters.
+             * The data is retrieved using the 0xFFFF Company ID.
+             */
+            byte[] vendorData = record.getManufacturerSpecificData(MANUFACTURER_ID);
+            finalMsg = BeaconUtils.extractMessageFromBytes(vendorData);
+
+            /*
+             * [SEQ-51]
+             * Strategy 2: Fallback to Device Name if Manufacturer Data is invalid or missing.
+             * This channel is used to support iOS broadcasters, which advertise the
+             * message within the Scan Response's Local Name field.
+             */
+            if (finalMsg == null) {
+                String deviceName = record.getDeviceName();
+                Log.d(TAG, "Valid message found in Device Name: " + deviceName);
+                String deviceMessage = BeaconUtils.extractMessageFromDeviceName(deviceName);
+                if (deviceMessage != null) {
+                    finalMsg = deviceMessage;
                 }
             }
+            /*
+             * Post-Processing: If a valid protocol message is identified, package the
+             * metadata (RSSI, MAC address, and timestamp) and notify the JavaScript layer.
+             */
+            if (finalMsg != null) {
+                logToJsWithTag("[SEQ-55]", "Beacon Resolved: " + finalMsg + " | RSSI: " + result.getRssi());
+                JSObject jsResult = new JSObject();
+                jsResult.put("message", finalMsg);
+                jsResult.put("rssi", result.getRssi());
+                jsResult.put("peripheralId", result.getDevice().getAddress());
+                jsResult.put("timestamp", System.currentTimeMillis());
+                notifyListeners("beaconReceived", jsResult);
+            } else {
+                logToJsWithTag("[SEQ-55-F]", "No valid message found in scan result");
+            }
         }
     };
-} 
+}

package/android/src/main/java/com/wisdomgarden/mobile/beacon/BeaconUtils.java

@@ -1,10 +1,41 @@
 package com.wisdomgarden.mobile.beacon;
 
+import android.util.Log;
+import java.nio.charset.StandardCharsets;
 import java.util.HashMap;
 import java.util.Map;
-import java.util.Random;
 
 public class BeaconUtils {
+
+    private static final String TAG = "BeaconUtils";
+
+    /**
+     * 16-bit Bluetooth Short UUID (0x5747)
+     * Logic & Rationale:
+     * 1. 'W' hex value is 0x57, 'G' hex value is 0x47.
+     * 2. Formatted according to the Bluetooth SIG Base UUID: 0000XXXX-0000-1000-8000-00805F9B34FB.
+     * 3. Replacing XXXX with 5747 results in this full string.
+     * 4. Using a 16-bit UUID reduces the UUID overhead in the broadcast packet from 18 bytes
+     * to 4 bytes, effectively fixing the 'ADVERTISE_FAILED_DATA_TOO_LARGE' error by
+     * staying well within the 31-byte BLE Legacy Advertising limit.
+     */
+    public static final String WG_UUID = "00005747-0000-1000-8000-00805F9B34FB";
+
+    /**
+     * Identification prefix for string-based payloads (Device Name).
+     * This prefix is used by iOS when advertising the message via the Device Name field.
+     * Both platforms use this string to identify and validate Wisdom Garden
+     * peripherals during the scanning process.
+     */
+    public static final String WG_PREFIX = "WG";
+    /**
+     * Hexadecimal representation of "WG" (0x57, 0x47).
+     * This prefix is specifically designed for Android's ManufacturerData field.
+     * It serves as a protocol identifier within the raw byte payload to
+     * distinguish our packets from other 0xFFFF manufacturer data.
+     */
+    private static final byte[] WG_PREFIX_BYTES = new byte[] { 0x57, 0x47 };
+
     private static final String CHARS = "2O9AuFNPDx4gtJwS3ye7l1Mq0dEB5HsaKInikRmLhjpG6b8fzQrCcvo";
     private static final int RADIX = CHARS.length();
     private static final int MESSAGE_MAX_LENGTH = 11;
@@ -16,10 +47,9 @@ public class BeaconUtils {
      * @return 编码后的字符串
      */
     public static String encode(int num) {
-        if (num == 0) return String.valueOf(CHARS.charAt(0));
+        if (num <= 0) return String.valueOf(CHARS.charAt(0));
         StringBuilder result = new StringBuilder();
-        boolean isNegative = num < 0;
-        int n = Math.abs(num);
+        int n = num;
 
         while (n > 0) {
             int remainder = n % RADIX;
@@ -27,7 +57,7 @@ public class BeaconUtils {
             n /= RADIX;
         }
 
-        return isNegative ? "-" + result.toString() : result.toString();
+        return result.toString();
     }
 
     /**
@@ -56,8 +86,7 @@ public class BeaconUtils {
      * @return 如果是 nonce 字母返回 true，否则返回 false
      */
     public static boolean isNonceLetter(char c) {
-        int code = (int) c;
-        return code >= 84 && code <= 90;
+        return c >= 'T' && c <= 'Z';
     }
 
     /**
@@ -89,18 +118,16 @@ public class BeaconUtils {
         payload.put("rollcallId", 0);
         payload.put("nonce", "");
 
-        if (message == null) {
+        if (message == null || message.isEmpty()) {
             return payload;
         }
 
-
         for (int i = 0; i < message.length(); i++) {
-            char c = message.charAt(i);
-            if (isNonceLetter(c)) {
+            if (isNonceLetter(message.charAt(i))) {
                 String rollcallIdStr = message.substring(0, i);
                 payload.put("rollcallId", decode(rollcallIdStr));
                 payload.put("nonce", message.substring(i));
-                break;
+                return payload;
             }
         }
 
@@ -115,4 +142,74 @@ public class BeaconUtils {
     public static int getMessageMaxLength() {
         return MESSAGE_MAX_LENGTH;
     }
-} 
+
+    /**
+     * Constructs the raw byte array for Android's Manufacturer Data.
+     * It prepends the "WG" hexadecimal prefix (0x57, 0x47) to the ASCII-encoded message.
+     * This format ensures that the data is recognizable as a "Wisdom Garden" packet
+     * when transmitted within a raw byte stream.
+     */
+    public static byte[] addPrefixToBytes(String message) {
+        Log.d(TAG, "[addPrefixToBytes]Adding hex prefix to message: " + message);
+
+        byte[] msgBytes = message.getBytes(StandardCharsets.US_ASCII);
+        byte[] data = new byte[WG_PREFIX_BYTES.length + msgBytes.length];
+        System.arraycopy(WG_PREFIX_BYTES, 0, data, 0, WG_PREFIX_BYTES.length);
+        System.arraycopy(msgBytes, 0, data, WG_PREFIX_BYTES.length, msgBytes.length);
+
+        Log.v(TAG, "[addPrefixToBytes]Resulting byte array length: " + data.length);
+        return data;
+    }
+
+    /**
+     * Extracts and validates the message from raw Manufacturer Data bytes.
+     * The method verifies the "WG" hexadecimal prefix and ensures the total
+     * length matches the protocol specification before returning the decoded string.
+     */
+    public static String extractMessageFromBytes(byte[] data) {
+        if (data == null) {
+            Log.w(TAG, "[extractBytes] data is null");
+            return null;
+        }
+
+        // Total length must be: length of WG_PREFIX_BYTES + length of message
+        int expectedLength = WG_PREFIX_BYTES.length + MESSAGE_MAX_LENGTH;
+
+        if (data.length < WG_PREFIX_BYTES.length || data.length > expectedLength) {
+            Log.w(TAG, "[extractBytes] Length out of bounds. Max: " + expectedLength + ", Got: " + data.length);
+            return null;
+        }
+        for (int i = 0; i < WG_PREFIX_BYTES.length; i++) {
+            if (data[i] != WG_PREFIX_BYTES[i]) {
+                return null;
+            }
+        }
+        int payloadLength = data.length - WG_PREFIX_BYTES.length;
+        String extracted = new String(data, WG_PREFIX_BYTES.length, payloadLength, StandardCharsets.US_ASCII);
+        Log.i(TAG, "[extractBytes] Successfully extracted message from bytes: " + extracted);
+        return extracted;
+    }
+
+    /**
+     * Extracts the message payload from a scanned Device Name string.
+     * Specifically designed for iOS-to-Android or iOS-to-iOS communication,
+     * where the message is prefixed with "WG" and advertised as the device's name.
+     */
+    public static String extractMessageFromDeviceName(String message) {
+        if (message == null || message.isEmpty()) {
+            Log.w(TAG, "[extractName] message is null");
+            return null;
+        }
+        if (!message.startsWith(WG_PREFIX)) {
+            return null;
+        }
+        int expectedLength = WG_PREFIX.length() + MESSAGE_MAX_LENGTH;
+        if (message.length() > expectedLength) {
+            Log.w(TAG, "[extractName] Length out of bounds. Max: " + expectedLength + ", Got: " + message.length());
+            return null;
+        }
+        String extracted = message.substring(WG_PREFIX.length());
+        Log.i(TAG, "[extractName] Successfully. " + extracted);
+        return extracted;
+    }
+}