@ionic-native/bluetooth-le - npm Package Compare versions

Comparing version 5.29.0 to 5.30.0

index.d.ts

@@ -51,2 +51,30 @@ import { IonicNativePlugin } from '@ionic-native/core';
 }
+export interface ConnectionParams {
+    /** The address/identifier provided by the scan's return object */
+    address: string;
+    /** Automatically connect as soon as the remote device becomes available (Android) */
+    autoConnect?: boolean;
+    /**
+     * Transport mode. Available from API 23 (Android).
+     * If none is specified the default behavior is TRANSPORT_AUTO
+     *
+     * Note: On Android 10, TRANSPORT_AUTO can lead to connection errors with Status code 133.
+     * In this case TRANSPORT_LE can be used.
+     */
+    transport?: AndroidGattTransportMode;
+}
+export declare enum AndroidGattTransportMode {
+    /**
+     * No preference of physical transport for GATT connections to remote dual-mode devices
+     */
+    TRANSPORT_AUTO = 0,
+    /**
+     * Prefer BR/EDR transport for GATT connections to remote dual-mode devices
+     */
+    TRANSPORT_BREDR = 1,
+    /**
+     * Prefer LE transport for GATT connections to remote dual-mode devices
+     */
+    TRANSPORT_LE = 2
+}
 export interface CharacteristicParams extends Params {
@@ -421,5 +449,5 @@ /** An array of characteristic IDs to discover or empty array / null */
      * @param connectError   The callback that will be triggered when the connect operation fails
-     * @param params         The address/identifier
+     * @param params         The connection params
      *
-     * @param {{address: string, autoConnect: boolean}} params
+     * @param {ConnectionParams} params
      * @returns {(Observable<{ status: DeviceInfo }>)}
@@ -429,6 +457,3 @@ *    success: device object with status
      */
-    connect(params: {
-        address: string;
-        autoConnect?: boolean;
-    }): Observable<DeviceInfo>;
+    connect(params: ConnectionParams): Observable<DeviceInfo>;
     /**
@@ -435,0 +460,0 @@ * @name reconnect

ngx/index.d.ts

@@ -51,2 +51,30 @@ import { IonicNativePlugin } from '@ionic-native/core';
 }
+export interface ConnectionParams {
+    /** The address/identifier provided by the scan's return object */
+    address: string;
+    /** Automatically connect as soon as the remote device becomes available (Android) */
+    autoConnect?: boolean;
+    /**
+     * Transport mode. Available from API 23 (Android).
+     * If none is specified the default behavior is TRANSPORT_AUTO
+     *
+     * Note: On Android 10, TRANSPORT_AUTO can lead to connection errors with Status code 133.
+     * In this case TRANSPORT_LE can be used.
+     */
+    transport?: AndroidGattTransportMode;
+}
+export declare enum AndroidGattTransportMode {
+    /**
+     * No preference of physical transport for GATT connections to remote dual-mode devices
+     */
+    TRANSPORT_AUTO = 0,
+    /**
+     * Prefer BR/EDR transport for GATT connections to remote dual-mode devices
+     */
+    TRANSPORT_BREDR = 1,
+    /**
+     * Prefer LE transport for GATT connections to remote dual-mode devices
+     */
+    TRANSPORT_LE = 2
+}
 export interface CharacteristicParams extends Params {
@@ -421,5 +449,5 @@ /** An array of characteristic IDs to discover or empty array / null */
      * @param connectError   The callback that will be triggered when the connect operation fails
-     * @param params         The address/identifier
+     * @param params         The connection params
      *
-     * @param {{address: string, autoConnect: boolean}} params
+     * @param {ConnectionParams} params
      * @returns {(Observable<{ status: DeviceInfo }>)}
@@ -429,6 +457,3 @@ *    success: device object with status
      */
-    connect(params: {
-        address: string;
-        autoConnect?: boolean;
-    }): Observable<DeviceInfo>;
+    connect(params: ConnectionParams): Observable<DeviceInfo>;
     /**
@@ -435,0 +460,0 @@ * @name reconnect

ngx/index.metadata.json

@@ -1,1 +0,1 @@
-[{"__symbolic":"module","version":4,"metadata":{"Status":{"__symbolic":"interface"},"ConnectionPriority":{"__symbolic":"interface"},"Params":{"__symbolic":"interface"},"InitPeripheralParams":{"__symbolic":"interface"},"InitParams":{"__symbolic":"interface"},"ScanParams":{"__symbolic":"interface"},"NotifyParams":{"__symbolic":"interface"},"RespondParams":{"__symbolic":"interface"},"CharacteristicParams":{"__symbolic":"interface"},"DescriptorParams":{"__symbolic":"interface"},"OperationDescriptorParams":{"__symbolic":"interface"},"WriteCharacteristicParams":{"__symbolic":"interface"},"WriteDescriptorParams":{"__symbolic":"interface"},"AdvertisingParams":{"__symbolic":"interface"},"AdvertiseMode":{"__symbolic":"interface"},"TxPowerLevel":{"__symbolic":"interface"},"AdvertisingParamsAndroid":{"__symbolic":"interface"},"AdvertisingParamsIOS":{"__symbolic":"interface"},"CommonInfo":{"__symbolic":"interface"},"DeviceInfo":{"__symbolic":"interface"},"RSSI":{"__symbolic":"interface"},"MTU":{"__symbolic":"interface"},"BondedStatus":{"__symbolic":"interface"},"PrevConnectionStatus":{"__symbolic":"interface"},"CurrConnectionStatus":{"__symbolic":"interface"},"DiscoverStatus":{"__symbolic":"interface"},"ScanStatus":{"__symbolic":"interface"},"Service":{"__symbolic":"interface"},"Characteristic":{"__symbolic":"interface"},"Descriptor":{"__symbolic":"interface"},"Device":{"__symbolic":"interface"},"Services":{"__symbolic":"interface"},"Descriptors":{"__symbolic":"interface"},"OperationResult":{"__symbolic":"interface"},"UnsubscribeResult":{"__symbolic":"interface"},"DescriptorResult":{"__symbolic":"interface"},"Characteristics":{"__symbolic":"interface"},"InitializeResult":{"__symbolic":"interface"},"BluetoothScanMode":{"SCAN_MODE_OPPORTUNISTIC":-1,"SCAN_MODE_LOW_POWER":0,"SCAN_MODE_BALANCED":1,"SCAN_MODE_LOW_LATENCY":2},"BluetoothMatchMode":{"MATCH_MODE_AGRESSIVE":1,"MATCH_MODE_STICKY":2},"BluetoothMatchNum":{"MATCH_NUM_ONE_ADVERTISEMENT":1,"MATCH_NUM_FEW_ADVERTISEMENT":2,"MATCH_NUM_MAX_ADVERTISEMENT":3},"BluetoothCallbackType":{"CALLBACK_TYPE_ALL_MATCHES":1,"CALLBACK_TYPE_FIRST_MATCH":2,"CALLBACK_TYPE_MATCH_LOST":4},"Error":{"__symbolic":"interface"},"AdapterInfo":{"__symbolic":"interface"},"BluetoothLE":{"__symbolic":"class","extends":{"__symbolic":"reference","module":"@ionic-native/core","name":"IonicNativePlugin","line":425,"character":33},"decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"Injectable","line":424,"character":1}}],"members":{"initialize":[{"__symbolic":"method"}],"enable":[{"__symbolic":"method"}],"disable":[{"__symbolic":"method"}],"getAdapterInfo":[{"__symbolic":"method"}],"startScan":[{"__symbolic":"method"}],"stopScan":[{"__symbolic":"method"}],"retrieveConnected":[{"__symbolic":"method"}],"bond":[{"__symbolic":"method"}],"unbond":[{"__symbolic":"method"}],"connect":[{"__symbolic":"method"}],"reconnect":[{"__symbolic":"method"}],"disconnect":[{"__symbolic":"method"}],"close":[{"__symbolic":"method"}],"discover":[{"__symbolic":"method"}],"services":[{"__symbolic":"method"}],"characteristics":[{"__symbolic":"method"}],"descriptors":[{"__symbolic":"method"}],"read":[{"__symbolic":"method"}],"subscribe":[{"__symbolic":"method"}],"unsubscribe":[{"__symbolic":"method"}],"write":[{"__symbolic":"method"}],"writeQ":[{"__symbolic":"method"}],"readDescriptor":[{"__symbolic":"method"}],"writeDescriptor":[{"__symbolic":"method"}],"rssi":[{"__symbolic":"method"}],"mtu":[{"__symbolic":"method"}],"requestConnectionPriority":[{"__symbolic":"method"}],"isInitialized":[{"__symbolic":"method"}],"isEnabled":[{"__symbolic":"method"}],"isScanning":[{"__symbolic":"method"}],"isBonded":[{"__symbolic":"method"}],"wasConnected":[{"__symbolic":"method"}],"isConnected":[{"__symbolic":"method"}],"isDiscovered":[{"__symbolic":"method"}],"hasPermission":[{"__symbolic":"method"}],"requestPermission":[{"__symbolic":"method"}],"isLocationEnabled":[{"__symbolic":"method"}],"requestLocation":[{"__symbolic":"method"}],"initializePeripheral":[{"__symbolic":"method"}],"addService":[{"__symbolic":"method"}],"removeService":[{"__symbolic":"method"}],"removeAllServices":[{"__symbolic":"method"}],"startAdvertising":[{"__symbolic":"method"}],"stopAdvertising":[{"__symbolic":"method"}],"isAdvertising":[{"__symbolic":"method"}],"respond":[{"__symbolic":"method"}],"notify":[{"__symbolic":"method"}],"encodedStringToBytes":[{"__symbolic":"method"}],"bytesToEncodedString":[{"__symbolic":"method"}],"stringToBytes":[{"__symbolic":"method"}],"bytesToString":[{"__symbolic":"method"}],"SCAN_MODE_OPPORTUNISTIC":[{"__symbolic":"property"}],"SCAN_MODE_LOW_POWER":[{"__symbolic":"property"}],"SCAN_MODE_BALANCED":[{"__symbolic":"property"}],"SCAN_MODE_LOW_LATENCY":[{"__symbolic":"property"}],"MATCH_MODE_AGGRESSIVE":[{"__symbolic":"property"}],"MATCH_MODE_STICKY":[{"__symbolic":"property"}],"MATCH_NUM_ONE_ADVERTISEMENT":[{"__symbolic":"property"}],"MATCH_NUM_FEW_ADVERTISEMENT":[{"__symbolic":"property"}],"MATCH_NUM_MAX_ADVERTISEMENT":[{"__symbolic":"property"}],"CALLBACK_TYPE_ALL_MATCHES":[{"__symbolic":"property"}],"CALLBACK_TYPE_FIRST_MATCH":[{"__symbolic":"property"}],"CALLBACK_TYPE_MATCH_LOST":[{"__symbolic":"property"}]}}}}]
+[{"__symbolic":"module","version":4,"metadata":{"Status":{"__symbolic":"interface"},"ConnectionPriority":{"__symbolic":"interface"},"Params":{"__symbolic":"interface"},"InitPeripheralParams":{"__symbolic":"interface"},"InitParams":{"__symbolic":"interface"},"ScanParams":{"__symbolic":"interface"},"NotifyParams":{"__symbolic":"interface"},"RespondParams":{"__symbolic":"interface"},"ConnectionParams":{"__symbolic":"interface"},"AndroidGattTransportMode":{"TRANSPORT_AUTO":0,"TRANSPORT_BREDR":1,"TRANSPORT_LE":2},"CharacteristicParams":{"__symbolic":"interface"},"DescriptorParams":{"__symbolic":"interface"},"OperationDescriptorParams":{"__symbolic":"interface"},"WriteCharacteristicParams":{"__symbolic":"interface"},"WriteDescriptorParams":{"__symbolic":"interface"},"AdvertisingParams":{"__symbolic":"interface"},"AdvertiseMode":{"__symbolic":"interface"},"TxPowerLevel":{"__symbolic":"interface"},"AdvertisingParamsAndroid":{"__symbolic":"interface"},"AdvertisingParamsIOS":{"__symbolic":"interface"},"CommonInfo":{"__symbolic":"interface"},"DeviceInfo":{"__symbolic":"interface"},"RSSI":{"__symbolic":"interface"},"MTU":{"__symbolic":"interface"},"BondedStatus":{"__symbolic":"interface"},"PrevConnectionStatus":{"__symbolic":"interface"},"CurrConnectionStatus":{"__symbolic":"interface"},"DiscoverStatus":{"__symbolic":"interface"},"ScanStatus":{"__symbolic":"interface"},"Service":{"__symbolic":"interface"},"Characteristic":{"__symbolic":"interface"},"Descriptor":{"__symbolic":"interface"},"Device":{"__symbolic":"interface"},"Services":{"__symbolic":"interface"},"Descriptors":{"__symbolic":"interface"},"OperationResult":{"__symbolic":"interface"},"UnsubscribeResult":{"__symbolic":"interface"},"DescriptorResult":{"__symbolic":"interface"},"Characteristics":{"__symbolic":"interface"},"InitializeResult":{"__symbolic":"interface"},"BluetoothScanMode":{"SCAN_MODE_OPPORTUNISTIC":-1,"SCAN_MODE_LOW_POWER":0,"SCAN_MODE_BALANCED":1,"SCAN_MODE_LOW_LATENCY":2},"BluetoothMatchMode":{"MATCH_MODE_AGRESSIVE":1,"MATCH_MODE_STICKY":2},"BluetoothMatchNum":{"MATCH_NUM_ONE_ADVERTISEMENT":1,"MATCH_NUM_FEW_ADVERTISEMENT":2,"MATCH_NUM_MAX_ADVERTISEMENT":3},"BluetoothCallbackType":{"CALLBACK_TYPE_ALL_MATCHES":1,"CALLBACK_TYPE_FIRST_MATCH":2,"CALLBACK_TYPE_MATCH_LOST":4},"Error":{"__symbolic":"interface"},"AdapterInfo":{"__symbolic":"interface"},"BluetoothLE":{"__symbolic":"class","extends":{"__symbolic":"reference","module":"@ionic-native/core","name":"IonicNativePlugin","line":457,"character":33},"decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"Injectable","line":456,"character":1}}],"members":{"initialize":[{"__symbolic":"method"}],"enable":[{"__symbolic":"method"}],"disable":[{"__symbolic":"method"}],"getAdapterInfo":[{"__symbolic":"method"}],"startScan":[{"__symbolic":"method"}],"stopScan":[{"__symbolic":"method"}],"retrieveConnected":[{"__symbolic":"method"}],"bond":[{"__symbolic":"method"}],"unbond":[{"__symbolic":"method"}],"connect":[{"__symbolic":"method"}],"reconnect":[{"__symbolic":"method"}],"disconnect":[{"__symbolic":"method"}],"close":[{"__symbolic":"method"}],"discover":[{"__symbolic":"method"}],"services":[{"__symbolic":"method"}],"characteristics":[{"__symbolic":"method"}],"descriptors":[{"__symbolic":"method"}],"read":[{"__symbolic":"method"}],"subscribe":[{"__symbolic":"method"}],"unsubscribe":[{"__symbolic":"method"}],"write":[{"__symbolic":"method"}],"writeQ":[{"__symbolic":"method"}],"readDescriptor":[{"__symbolic":"method"}],"writeDescriptor":[{"__symbolic":"method"}],"rssi":[{"__symbolic":"method"}],"mtu":[{"__symbolic":"method"}],"requestConnectionPriority":[{"__symbolic":"method"}],"isInitialized":[{"__symbolic":"method"}],"isEnabled":[{"__symbolic":"method"}],"isScanning":[{"__symbolic":"method"}],"isBonded":[{"__symbolic":"method"}],"wasConnected":[{"__symbolic":"method"}],"isConnected":[{"__symbolic":"method"}],"isDiscovered":[{"__symbolic":"method"}],"hasPermission":[{"__symbolic":"method"}],"requestPermission":[{"__symbolic":"method"}],"isLocationEnabled":[{"__symbolic":"method"}],"requestLocation":[{"__symbolic":"method"}],"initializePeripheral":[{"__symbolic":"method"}],"addService":[{"__symbolic":"method"}],"removeService":[{"__symbolic":"method"}],"removeAllServices":[{"__symbolic":"method"}],"startAdvertising":[{"__symbolic":"method"}],"stopAdvertising":[{"__symbolic":"method"}],"isAdvertising":[{"__symbolic":"method"}],"respond":[{"__symbolic":"method"}],"notify":[{"__symbolic":"method"}],"encodedStringToBytes":[{"__symbolic":"method"}],"bytesToEncodedString":[{"__symbolic":"method"}],"stringToBytes":[{"__symbolic":"method"}],"bytesToString":[{"__symbolic":"method"}],"SCAN_MODE_OPPORTUNISTIC":[{"__symbolic":"property"}],"SCAN_MODE_LOW_POWER":[{"__symbolic":"property"}],"SCAN_MODE_BALANCED":[{"__symbolic":"property"}],"SCAN_MODE_LOW_LATENCY":[{"__symbolic":"property"}],"MATCH_MODE_AGGRESSIVE":[{"__symbolic":"property"}],"MATCH_MODE_STICKY":[{"__symbolic":"property"}],"MATCH_NUM_ONE_ADVERTISEMENT":[{"__symbolic":"property"}],"MATCH_NUM_FEW_ADVERTISEMENT":[{"__symbolic":"property"}],"MATCH_NUM_MAX_ADVERTISEMENT":[{"__symbolic":"property"}],"CALLBACK_TYPE_ALL_MATCHES":[{"__symbolic":"property"}],"CALLBACK_TYPE_FIRST_MATCH":[{"__symbolic":"property"}],"CALLBACK_TYPE_MATCH_LOST":[{"__symbolic":"property"}]}}}}]

ngx/package.json

@@ -1,1 +0,1 @@
-{"description":"Ionic Native - Native plugins for ionic apps","module":"index.js","typings":"index.d.ts","author":"ionic","license":"MIT","repository":{"type":"git","url":"https://github.com/ionic-team/ionic-native.git"},"name":"@ionic-native/bluetooth-le","dependencies":{"@types/cordova":"latest"},"peerDependencies":{"rxjs":"^5.5.0 || ^6.5.0","@ionic-native/core":"^5.1.0"},"version":"5.29.0"}
+{"description":"Ionic Native - Native plugins for ionic apps","module":"index.js","typings":"index.d.ts","author":"ionic","license":"MIT","repository":{"type":"git","url":"https://github.com/ionic-team/ionic-native.git"},"name":"@ionic-native/bluetooth-le","dependencies":{"@types/cordova":"latest"},"peerDependencies":{"rxjs":"^5.5.0 || ^6.5.0","@ionic-native/core":"^5.1.0"},"version":"5.30.0"}

package.json

@@ -1,1 +0,1 @@
-{"description":"Ionic Native - Native plugins for ionic apps","module":"index.js","typings":"index.d.ts","author":"ionic","license":"MIT","repository":{"type":"git","url":"https://github.com/ionic-team/ionic-native.git"},"name":"@ionic-native/bluetooth-le","dependencies":{"@types/cordova":"latest"},"peerDependencies":{"rxjs":"^5.5.0 || ^6.5.0","@ionic-native/core":"^5.1.0"},"version":"5.29.0"}
+{"description":"Ionic Native - Native plugins for ionic apps","module":"index.js","typings":"index.d.ts","author":"ionic","license":"MIT","repository":{"type":"git","url":"https://github.com/ionic-team/ionic-native.git"},"name":"@ionic-native/bluetooth-le","dependencies":{"@types/cordova":"latest"},"peerDependencies":{"rxjs":"^5.5.0 || ^6.5.0","@ionic-native/core":"^5.1.0"},"version":"5.30.0"}

README.md

@@ -1,2 +0,2 @@
-<a style="float:right;font-size:12px;" href="http://github.com/ionic-team/ionic-native/edit/master/src/@ionic-native/plugins/bluetooth-le/index.ts#L385">
+<a style="float:right;font-size:12px;" href="http://github.com/ionic-team/ionic-native/edit/master/src/@ionic-native/plugins/bluetooth-le/index.ts#L417">
   Improve this doc
@@ -3,0 +3,0 @@ </a>

No alert changes

Improved metrics

Total package byte prevSize

202958

increased by3.23%

Lines of code

2084

increased by3.99%

No dependency changes