react-native-ble-manager 8.7.0 → 8.8.0

package/README.md

@@ -441,7 +441,7 @@ BleManager.writeWithoutResponse(
 ### readRSSI(peripheralId)
 
 Read the current value of the RSSI.
-Returns a `Promise` object.
+Returns a `Promise` object resolving with the updated RSSI value (`number`) if it succeeds.
 
 **Arguments**
 
@@ -464,7 +464,7 @@ BleManager.readRSSI("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
 ### requestConnectionPriority(peripheralId, connectionPriority) [Android only API 21+]
 
 Request a connection parameter update.
-Returns a `Promise` object.
+Returns a `Promise` object which fulfills with the status of the request.
 
 **Arguments**
 
@@ -708,7 +708,7 @@ The BLE change state.
 
 **Arguments**
 
-- `state` - `String` - the new BLE state ('on'/'off').
+- `state` - `String` - the new BLE state. can be one of `unknown` (iOS only), `resetting` (iOS only), `unsupported`, `unauthorized` (iOS only), `on`, `off`, `turning_on` (android only), `turning_off` (android only).
 
 **Examples**
 

package/android/src/main/java/it/innove/BleManager.java

@@ -470,8 +470,19 @@ class BleManager extends ReactContextBaseJavaModule {
                 case BluetoothAdapter.STATE_ON:
                     state = "on";
                     break;
+                case BluetoothAdapter.STATE_TURNING_ON:
+                    state = "turning_on";
+                    break;
                 case BluetoothAdapter.STATE_OFF:
                     state = "off";
+                    break;
+                case BluetoothAdapter.STATE_TURNING_OFF:
+                    state = "turning_off";
+                    break;
+                default:
+                    // should not happen as per https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#getState()
+                    state = "off";
+                    break;
             }
         }
 
@@ -512,6 +523,10 @@ class BleManager extends ReactContextBaseJavaModule {
                     case BluetoothAdapter.STATE_TURNING_ON:
                         stringState = "turning_on";
                         break;
+                    default:
+                        // should not happen as per https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#EXTRA_STATE
+                        stringState = "off";
+                        break;
                 }
 
                 WritableMap map = Arguments.createMap();

package/index.d.ts

@@ -1,4 +1,18 @@
 declare module "react-native-ble-manager" {
+
+  // android states: https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#EXTRA_STATE
+  // ios states: https://developer.apple.com/documentation/corebluetooth/cbcentralmanagerstate
+  export enum BleState {
+    Unknown = 'unknown', // [iOS only]
+    Resetting = 'resetting', // [iOS only]
+    Unsupported = 'unsupported',
+    Unauthorized = 'unauthorized', // [iOS only]
+    On = 'on',
+    Off = 'off',
+    TurningOn = 'turning_on', // [android only]
+    TurningOff = 'turning_off', // [android only]
+  }
+
   export interface Peripheral {
     id: string;
     rssi: number;
@@ -9,30 +23,75 @@ declare module "react-native-ble-manager" {
   export interface AdvertisingData {
     isConnectable?: boolean;
     localName?: string;
-    manufacturerData?: any;
+    manufacturerData?: CustomAdvertisingData,
+    serviceData?: CustomAdvertisingData,
     serviceUUIDs?: string[];
     txPowerLevel?: number;
   }
 
+  export interface CustomAdvertisingData {
+    CDVType : 'ArrayBuffer',
+    bytes: Uint8Array,
+    data: string // base64-encoded string of the data
+  }
+
   export interface StartOptions {
-    showAlert?: boolean;
-    restoreIdentifierKey?: string;
-    queueIdentifierKey?: string;
-    forceLegacy?: boolean;
+    showAlert?: boolean; // [iOS only]
+    restoreIdentifierKey?: string; // [iOS only]
+    queueIdentifierKey?: string; // [iOS only]
+    forceLegacy?: boolean; // [android only]
   }
 
   export function start(options?: StartOptions): Promise<void>;
 
+  // [android only]
+  // https://developer.android.com/reference/android/bluetooth/le/ScanSettings
   export interface ScanOptions {
-    numberOfMatches?: number;
-    matchMode?: number;
-    callbackType?: number;
-    scanMode?: number;
+    numberOfMatches?: BleScanMatchCount;
+    matchMode?: BleScanMatchMode;
+    callbackType?: BleScanCallbackType;
+    scanMode?: BleScanMode;
     reportDelay?: number;
-    phy?: number;
+    phy?: BleScanPhyMode;
     legacy?: boolean;
   }
 
+  // [android only]
+  export enum BleScanMode {
+    Opportunistic = -1,
+    LowPower = 0,
+    Balanced = 1,
+    LowLatency = 2,
+  }
+
+  // [android only]
+  export enum BleScanMatchMode {
+    Aggressive = 1,
+    Sticky = 2,
+  }
+
+  // [android only]
+  export enum BleScanCallbackType {
+    AllMatches = 1,
+    FirstMatch = 2,
+    MatchLost = 4,
+  }
+
+  // [android only]
+  export enum BleScanMatchCount {
+    OneAdvertisement = 1,
+    FewAdvertisements = 2,
+    MaxAdvertisements = 3,
+  }
+
+  // [android only]
+  export enum BleScanPhyMode {
+    LE_1M = 1,
+    LE_2M = 2,
+    LE_CODED = 3,
+    ALL_SUPPORTED = 255,
+  }
+
   export function scan(
     serviceUUIDs: string[],
     seconds: number,
@@ -45,14 +104,16 @@ declare module "react-native-ble-manager" {
     peripheralID: string,
     force?: boolean
   ): Promise<void>;
+
   export function checkState(): void;
+
   export function startNotification(
     peripheralID: string,
     serviceUUID: string,
     characteristicUUID: string
   ): Promise<void>;
 
-  /// Android only
+  // [android only]
   export function startNotificationUseBuffer(
     peripheralID: string,
     serviceUUID: string,
@@ -71,6 +132,7 @@ declare module "react-native-ble-manager" {
     serviceUUID: string,
     characteristicUUID: string
   ): Promise<any>;
+
   export function write(
     peripheralID: string,
     serviceUUID: string,
@@ -78,6 +140,7 @@ declare module "react-native-ble-manager" {
     data: any,
     maxByteSize?: number
   ): Promise<void>;
+
   export function writeWithoutResponse(
     peripheralID: string,
     serviceUUID: string,
@@ -87,12 +150,14 @@ declare module "react-native-ble-manager" {
     queueSleepTime?: number
   ): Promise<void>;
 
-  export function readRSSI(peripheralID: string): Promise<void>;
+  export function readRSSI(peripheralID: string): Promise<number>;
 
   export function getConnectedPeripherals(
     serviceUUIDs: string[]
   ): Promise<Peripheral[]>;
+
   export function getDiscoveredPeripherals(): Promise<Peripheral[]>;
+
   export function isPeripheralConnected(
     peripheralID: string,
     serviceUUIDs: string[]
@@ -104,14 +169,19 @@ declare module "react-native-ble-manager" {
     high = 1,
     low = 2,
   }
+
+  // [Android only 21+]
   export function requestConnectionPriority(
     peripheralID: string,
     connectionPriority: ConnectionPriority
-  ): Promise<void>;
-  /// Android only
+  ): Promise<boolean>;
+
+  // [Android only]
   export function enableBluetooth(): Promise<void>;
+
   // [Android only]
   export function refreshCache(peripheralID: string): Promise<void>;
+
   // [Android only API 21+]
   export function requestMTU(peripheralID: string, mtu: number): Promise<number>;
 
@@ -119,8 +189,11 @@ declare module "react-native-ble-manager" {
     peripheralID: string,
     peripheralPin?: string
   ): Promise<void>;
+
   export function removeBond(peripheralID: string): Promise<void>;
+
   export function getBondedPeripherals(): Promise<Peripheral[]>;
+
   export function removePeripheral(peripheralID: string): Promise<void>;
 
   // [Android only]
@@ -165,4 +238,57 @@ declare module "react-native-ble-manager" {
     peripheralID: string,
     serviceUUIDs?: string[]
   ): Promise<PeripheralInfo>;
+
+  export enum BleEventType {
+    BleManagerDidUpdateState = 'BleManagerDidUpdateState',
+    BleManagerStopScan = 'BleManagerStopScan',
+    BleManagerDiscoverPeripheral = 'BleManagerDiscoverPeripheral',
+    BleManagerDidUpdateValueForCharacteristic = 'BleManagerDidUpdateValueForCharacteristic',
+    BleManagerConnectPeripheral = 'BleManagerConnectPeripheral',
+    BleManagerDisconnectPeripheral = 'BleManagerDisconnectPeripheral',
+    BleManagerPeripheralDidBond = 'BleManagerPeripheralDidBond', // [Android only]
+    BleManagerCentralManagerWillRestoreState = 'BleManagerCentralManagerWillRestoreState', // [iOS only]
+    BleManagerDidUpdateNotificationStateFor = 'BleManagerDidUpdateNotificationStateFor', // [iOS only]
+  }
+
+  export interface BleStopScanEvent {
+    status?: number; // [iOS only]
+  }
+
+  export interface BleManagerDidUpdateStateEvent {
+    state: BleState;
+  }
+
+  export interface BleConnectPeripheralEvent {
+    readonly peripheral: string; // peripheral id
+    readonly status?: number; // [android only]
+  }
+
+  export type BleDiscoverPeripheralEvent = Peripheral;
+
+  // [Android only]
+  export type BleBondedPeripheralEvent = Peripheral;
+
+  export interface BleDisconnectPeripheralEvent {
+    readonly peripheral: string; // peripheral id
+    readonly status?: number; // [android only] disconnect reason.
+    readonly domain?: string; // [iOS only] disconnect error domain.
+    readonly code?: number; // [iOS only] disconnect error code.
+  }
+
+  export interface BleManagerDidUpdateValueForCharacteristicEvent {
+    readonly characteristic: string; // characteristic UUID
+    readonly peripheral: string; // peripheral id
+    readonly service: string; // service UUID
+    readonly value: Uint8Array;
+  }
+
+  // [iOS only]
+  export interface BleManagerDidUpdateNotificationStateForEvent {
+    readonly peripheral: string; // peripheral id
+    readonly characteristic: string; // characteristic UUID
+    readonly isNotifying: boolean; // is the characteristic notifying or not
+    readonly domain: string; // error domain.
+    readonly code: number; // error code.
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-ble-manager",
-  "version": "8.7.0",
+  "version": "8.8.0",
   "description": "A BLE module for react native.",
   "main": "BleManager",
   "types": "./index.d.ts",