@react-native-ohos/react-native-ble-plx 3.2.1-rc.2 → 3.2.1

package/src/Characteristic.js

@@ -1,166 +1,166 @@
-// @flow
-'use strict'
-
-import type { BleManager } from './BleManager'
-import type { BleError } from './BleError'
-import { Descriptor } from './Descriptor'
-import type { NativeCharacteristic } from './BleModule'
-import type { DeviceId, Identifier, UUID, TransactionId, Base64, Subscription } from './TypeDefinition'
-
-/**
- * Characteristic object.
- */
-export class Characteristic implements NativeCharacteristic {
-  /**
-   * Internal BLE Manager handle
-   * @private
-   */
-  _manager: BleManager
-  /**
-   * Characteristic unique identifier
-   */
-  id: Identifier
-  /**
-   * Characteristic UUID
-   */
-  uuid: UUID
-  /**
-   * Service's ID to which characteristic belongs
-   */
-  serviceID: Identifier
-  /**
-   * Service's UUID to which characteristic belongs
-   */
-  serviceUUID: UUID
-  /**
-   * Device's ID to which characteristic belongs
-   */
-  deviceID: DeviceId
-  /**
-   * True if characteristic can be read
-   */
-  isReadable: boolean
-  /**
-   * True if characteristic can be written with response
-   */
-  isWritableWithResponse: boolean
-  /**
-   * True if characteristic can be written without response
-   */
-  isWritableWithoutResponse: boolean
-  /**
-   * True if characteristic can monitor value changes.
-   */
-  isNotifiable: boolean
-  /**
-   * True if characteristic is monitoring value changes without ACK.
-   */
-  isNotifying: boolean
-  /**
-   * True if characteristic is monitoring value changes with ACK.
-   */
-  isIndicatable: boolean
-  /**
-   * Characteristic value if present
-   */
-  value: ?Base64
-
-  /**
-   * Private constructor used to create instance of {@link Characteristic}.
-   * @param {NativeCharacteristic} nativeCharacteristic NativeCharacteristic
-   * @param {BleManager} manager BleManager
-   * @private
-   */
-  constructor(nativeCharacteristic: NativeCharacteristic, manager: BleManager) {
-    Object.assign(this, nativeCharacteristic, { _manager: manager })
-  }
-
-  /**
-   * {@link #blemanagerdescriptorsfordevice|bleManager.descriptorsForDevice()} with partially filled arguments.
-   *
-   * @returns {Promise<Array<Descriptor>>} Promise which emits array of {@link Descriptor} objects which are
-   * discovered for this {@link Characteristic}.
-   */
-  descriptors(): Promise<Array<Descriptor>> {
-    return this._manager._descriptorsForCharacteristic(this.id)
-  }
-
-  /**
-   * {@link #blemanagerreadcharacteristicfordevice|bleManager.readCharacteristicForDevice()} with partially filled arguments.
-   *
-   * @param {?TransactionId} transactionId optional `transactionId` which can be used in
-   * {@link #blemanagercanceltransaction|bleManager.cancelTransaction()} function.
-   * @returns {Promise<Characteristic>} Promise which emits this {@link Characteristic}. Latest value will be stored
-   * inside returned object.
-   */
-  read(transactionId: ?TransactionId): Promise<Characteristic> {
-    return this._manager._readCharacteristic(this.id, transactionId)
-  }
-
-  /**
-   * {@link #blemanagerwritecharacteristicwithresponsefordevice|bleManager.writeCharacteristicWithResponseForDevice()} with partially filled arguments.
-   *
-   * @param {Base64} valueBase64 Value in Base64 format.
-   * @param {?TransactionId} transactionId optional `transactionId` which can be used in
-   * {@link #blemanagercanceltransaction|bleManager.cancelTransaction()} function.
-   * @returns {Promise<Characteristic>} Promise which emits this {@link Characteristic}. Latest value may
-   * not be stored inside returned object.
-   */
-  writeWithResponse(valueBase64: Base64, transactionId: ?TransactionId): Promise<Characteristic> {
-    return this._manager._writeCharacteristicWithResponse(this.id, valueBase64, transactionId)
-  }
-
-  /**
-   * {@link #blemanagerwritecharacteristicwithoutresponsefordevice|bleManager.writeCharacteristicWithoutResponseForDevice()} with partially filled arguments.
-   *
-   * @param {Base64} valueBase64 Value in Base64 format.
-   * @param {?TransactionId} transactionId optional `transactionId` which can be used in
-   * {@link #blemanagercanceltransaction|bleManager.cancelTransaction()} function.
-   * @returns {Promise<Characteristic>} Promise which emits this {@link Characteristic}. Latest value may
-   * not be stored inside returned object.
-   */
-  writeWithoutResponse(valueBase64: Base64, transactionId: ?TransactionId): Promise<Characteristic> {
-    return this._manager._writeCharacteristicWithoutResponse(this.id, valueBase64, transactionId)
-  }
-
-  /**
-   * {@link #blemanagermonitorcharacteristicfordevice|bleManager.monitorCharacteristicForDevice()} with partially filled arguments.
-   *
-   * @param {function(error: ?BleError, characteristic: ?Characteristic)} listener callback which emits
-   * this {@link Characteristic} with modified value for each notification.
-   * @param {?TransactionId} transactionId optional `transactionId` which can be used in
-   * {@link #blemanagercanceltransaction|bleManager.cancelTransaction()} function.
-   * @returns {Subscription} Subscription on which `remove()` function can be called to unsubscribe.
-   */
-  monitor(
-    listener: (error: ?BleError, characteristic: ?Characteristic) => void,
-    transactionId: ?TransactionId
-  ): Subscription {
-    return this._manager._monitorCharacteristic(this.id, listener, transactionId)
-  }
-
-  /**
-   * {@link #blemanagerreaddescriptorfordevice|bleManager.readDescriptorForDevice()} with partially filled arguments.
-   *
-   * @param {UUID} descriptorUUID {@link Descriptor} UUID.
-   * @param {?TransactionId} transactionId optional `transactionId` which can be used in
-   * {@link #blemanagercanceltransaction|cancelTransaction()} function.
-   * @returns {Promise<Descriptor>} Promise which emits first {@link Descriptor} object matching specified
-   * UUID paths. Latest value of {@link Descriptor} will be stored inside returned object.
-   */
-  async readDescriptor(descriptorUUID: UUID, transactionId: ?TransactionId): Promise<Descriptor> {
-    return this._manager._readDescriptorForCharacteristic(this.id, descriptorUUID, transactionId)
-  }
-
-  /**
-   * {@link #blemanagerwritedescriptorfordevice|bleManager.writeDescriptorForDevice()} with partially filled arguments.
-   *
-   * @param {UUID} descriptorUUID Descriptor UUID
-   * @param {Base64} valueBase64 Value to be set coded in Base64
-   * @param {?TransactionId} transactionId Transaction handle used to cancel operation
-   * @returns {Promise<Descriptor>} Descriptor which saved passed value.
-   */
-  async writeDescriptor(descriptorUUID: UUID, valueBase64: Base64, transactionId: ?TransactionId): Promise<Descriptor> {
-    return this._manager._writeDescriptorForCharacteristic(this.id, descriptorUUID, valueBase64, transactionId)
-  }
-}
+// @flow
+'use strict'
+
+import type { BleManager } from './BleManager'
+import type { BleError } from './BleError'
+import { Descriptor } from './Descriptor'
+import type { NativeCharacteristic } from './BleModule'
+import type { DeviceId, Identifier, UUID, TransactionId, Base64, Subscription } from './TypeDefinition'
+
+/**
+ * Characteristic object.
+ */
+export class Characteristic implements NativeCharacteristic {
+  /**
+   * Internal BLE Manager handle
+   * @private
+   */
+  _manager: BleManager
+  /**
+   * Characteristic unique identifier
+   */
+  id: Identifier
+  /**
+   * Characteristic UUID
+   */
+  uuid: UUID
+  /**
+   * Service's ID to which characteristic belongs
+   */
+  serviceID: Identifier
+  /**
+   * Service's UUID to which characteristic belongs
+   */
+  serviceUUID: UUID
+  /**
+   * Device's ID to which characteristic belongs
+   */
+  deviceID: DeviceId
+  /**
+   * True if characteristic can be read
+   */
+  isReadable: boolean
+  /**
+   * True if characteristic can be written with response
+   */
+  isWritableWithResponse: boolean
+  /**
+   * True if characteristic can be written without response
+   */
+  isWritableWithoutResponse: boolean
+  /**
+   * True if characteristic can monitor value changes.
+   */
+  isNotifiable: boolean
+  /**
+   * True if characteristic is monitoring value changes without ACK.
+   */
+  isNotifying: boolean
+  /**
+   * True if characteristic is monitoring value changes with ACK.
+   */
+  isIndicatable: boolean
+  /**
+   * Characteristic value if present
+   */
+  value: ?Base64
+
+  /**
+   * Private constructor used to create instance of {@link Characteristic}.
+   * @param {NativeCharacteristic} nativeCharacteristic NativeCharacteristic
+   * @param {BleManager} manager BleManager
+   * @private
+   */
+  constructor(nativeCharacteristic: NativeCharacteristic, manager: BleManager) {
+    Object.assign(this, nativeCharacteristic, { _manager: manager })
+  }
+
+  /**
+   * {@link #blemanagerdescriptorsfordevice|bleManager.descriptorsForDevice()} with partially filled arguments.
+   *
+   * @returns {Promise<Array<Descriptor>>} Promise which emits array of {@link Descriptor} objects which are
+   * discovered for this {@link Characteristic}.
+   */
+  descriptors(): Promise<Array<Descriptor>> {
+    return this._manager._descriptorsForCharacteristic(this.id)
+  }
+
+  /**
+   * {@link #blemanagerreadcharacteristicfordevice|bleManager.readCharacteristicForDevice()} with partially filled arguments.
+   *
+   * @param {?TransactionId} transactionId optional `transactionId` which can be used in
+   * {@link #blemanagercanceltransaction|bleManager.cancelTransaction()} function.
+   * @returns {Promise<Characteristic>} Promise which emits this {@link Characteristic}. Latest value will be stored
+   * inside returned object.
+   */
+  read(transactionId: ?TransactionId): Promise<Characteristic> {
+    return this._manager._readCharacteristic(this.id, transactionId)
+  }
+
+  /**
+   * {@link #blemanagerwritecharacteristicwithresponsefordevice|bleManager.writeCharacteristicWithResponseForDevice()} with partially filled arguments.
+   *
+   * @param {Base64} valueBase64 Value in Base64 format.
+   * @param {?TransactionId} transactionId optional `transactionId` which can be used in
+   * {@link #blemanagercanceltransaction|bleManager.cancelTransaction()} function.
+   * @returns {Promise<Characteristic>} Promise which emits this {@link Characteristic}. Latest value may
+   * not be stored inside returned object.
+   */
+  writeWithResponse(valueBase64: Base64, transactionId: ?TransactionId): Promise<Characteristic> {
+    return this._manager._writeCharacteristicWithResponse(this.id, valueBase64, transactionId)
+  }
+
+  /**
+   * {@link #blemanagerwritecharacteristicwithoutresponsefordevice|bleManager.writeCharacteristicWithoutResponseForDevice()} with partially filled arguments.
+   *
+   * @param {Base64} valueBase64 Value in Base64 format.
+   * @param {?TransactionId} transactionId optional `transactionId` which can be used in
+   * {@link #blemanagercanceltransaction|bleManager.cancelTransaction()} function.
+   * @returns {Promise<Characteristic>} Promise which emits this {@link Characteristic}. Latest value may
+   * not be stored inside returned object.
+   */
+  writeWithoutResponse(valueBase64: Base64, transactionId: ?TransactionId): Promise<Characteristic> {
+    return this._manager._writeCharacteristicWithoutResponse(this.id, valueBase64, transactionId)
+  }
+
+  /**
+   * {@link #blemanagermonitorcharacteristicfordevice|bleManager.monitorCharacteristicForDevice()} with partially filled arguments.
+   *
+   * @param {function(error: ?BleError, characteristic: ?Characteristic)} listener callback which emits
+   * this {@link Characteristic} with modified value for each notification.
+   * @param {?TransactionId} transactionId optional `transactionId` which can be used in
+   * {@link #blemanagercanceltransaction|bleManager.cancelTransaction()} function.
+   * @returns {Subscription} Subscription on which `remove()` function can be called to unsubscribe.
+   */
+  monitor(
+    listener: (error: ?BleError, characteristic: ?Characteristic) => void,
+    transactionId: ?TransactionId
+  ): Subscription {
+    return this._manager._monitorCharacteristic(this.id, listener, transactionId)
+  }
+
+  /**
+   * {@link #blemanagerreaddescriptorfordevice|bleManager.readDescriptorForDevice()} with partially filled arguments.
+   *
+   * @param {UUID} descriptorUUID {@link Descriptor} UUID.
+   * @param {?TransactionId} transactionId optional `transactionId` which can be used in
+   * {@link #blemanagercanceltransaction|cancelTransaction()} function.
+   * @returns {Promise<Descriptor>} Promise which emits first {@link Descriptor} object matching specified
+   * UUID paths. Latest value of {@link Descriptor} will be stored inside returned object.
+   */
+  async readDescriptor(descriptorUUID: UUID, transactionId: ?TransactionId): Promise<Descriptor> {
+    return this._manager._readDescriptorForCharacteristic(this.id, descriptorUUID, transactionId)
+  }
+
+  /**
+   * {@link #blemanagerwritedescriptorfordevice|bleManager.writeDescriptorForDevice()} with partially filled arguments.
+   *
+   * @param {UUID} descriptorUUID Descriptor UUID
+   * @param {Base64} valueBase64 Value to be set coded in Base64
+   * @param {?TransactionId} transactionId Transaction handle used to cancel operation
+   * @returns {Promise<Descriptor>} Descriptor which saved passed value.
+   */
+  async writeDescriptor(descriptorUUID: UUID, valueBase64: Base64, transactionId: ?TransactionId): Promise<Descriptor> {
+    return this._manager._writeDescriptorForCharacteristic(this.id, descriptorUUID, valueBase64, transactionId)
+  }
+}

package/src/Descriptor.js

@@ -1,82 +1,82 @@
-// @flow
-'use strict'
-
-import type { BleManager } from './BleManager'
-import type { NativeDescriptor } from './BleModule'
-import type { DeviceId, Identifier, UUID, TransactionId, Base64 } from './TypeDefinition'
-
-/**
- * Descriptor object.
- */
-export class Descriptor implements NativeDescriptor {
-  /**
-   * Internal BLE Manager handle
-   * @private
-   */
-  _manager: BleManager
-  /**
-   * Descriptor unique identifier
-   */
-  id: Identifier
-  /**
-   * Descriptor UUID
-   */
-  uuid: UUID
-  /**
-   * Characteristic's ID to which descriptor belongs
-   */
-  characteristicID: Identifier
-  /**
-   * Characteristic's UUID to which descriptor belongs
-   */
-  characteristicUUID: UUID
-  /**
-   * Service's ID to which descriptor belongs
-   */
-  serviceID: Identifier
-  /**
-   * Service's UUID to which descriptor belongs
-   */
-  serviceUUID: UUID
-  /**
-   * Device's ID to which descriptor belongs
-   */
-  deviceID: DeviceId
-  /**
-   * Descriptor value if present
-   */
-  value: ?Base64
-
-  /**
-   * Private constructor used to create instance of {@link Descriptor}.
-   * @param {NativeDescriptor} nativeDescriptor NativeDescriptor
-   * @param {BleManager} manager BleManager
-   * @private
-   */
-  constructor(nativeDescriptor: NativeDescriptor, manager: BleManager) {
-    Object.assign(this, nativeDescriptor, { _manager: manager })
-  }
-
-  /**
-   * {@link #blemanagerreaddescriptorfordevice|bleManager.readDescriptorForDevice()} with partially filled arguments.
-   *
-   * @param {?TransactionId} transactionId optional `transactionId` which can be used in
-   * {@link #blemanagercanceltransaction|cancelTransaction()} function.
-   * @returns {Promise<Descriptor>} Promise which emits first {@link Descriptor} object matching specified
-   * UUID paths. Latest value of {@link Descriptor} will be stored inside returned object.
-   */
-  async read(transactionId: ?TransactionId): Promise<Descriptor> {
-    return this._manager._readDescriptor(this.id, transactionId)
-  }
-
-  /**
-   * {@link #blemanagerwritedescriptorfordevice|bleManager.writeDescriptorForDevice()} with partially filled arguments.
-   *
-   * @param {Base64} valueBase64 Value to be set coded in Base64
-   * @param {?TransactionId} transactionId Transaction handle used to cancel operation
-   * @returns {Promise<Descriptor>} Descriptor which saved passed value.
-   */
-  async write(valueBase64: Base64, transactionId: ?TransactionId): Promise<Descriptor> {
-    return this._manager._writeDescriptor(this.id, valueBase64, transactionId)
-  }
-}
+// @flow
+'use strict'
+
+import type { BleManager } from './BleManager'
+import type { NativeDescriptor } from './BleModule'
+import type { DeviceId, Identifier, UUID, TransactionId, Base64 } from './TypeDefinition'
+
+/**
+ * Descriptor object.
+ */
+export class Descriptor implements NativeDescriptor {
+  /**
+   * Internal BLE Manager handle
+   * @private
+   */
+  _manager: BleManager
+  /**
+   * Descriptor unique identifier
+   */
+  id: Identifier
+  /**
+   * Descriptor UUID
+   */
+  uuid: UUID
+  /**
+   * Characteristic's ID to which descriptor belongs
+   */
+  characteristicID: Identifier
+  /**
+   * Characteristic's UUID to which descriptor belongs
+   */
+  characteristicUUID: UUID
+  /**
+   * Service's ID to which descriptor belongs
+   */
+  serviceID: Identifier
+  /**
+   * Service's UUID to which descriptor belongs
+   */
+  serviceUUID: UUID
+  /**
+   * Device's ID to which descriptor belongs
+   */
+  deviceID: DeviceId
+  /**
+   * Descriptor value if present
+   */
+  value: ?Base64
+
+  /**
+   * Private constructor used to create instance of {@link Descriptor}.
+   * @param {NativeDescriptor} nativeDescriptor NativeDescriptor
+   * @param {BleManager} manager BleManager
+   * @private
+   */
+  constructor(nativeDescriptor: NativeDescriptor, manager: BleManager) {
+    Object.assign(this, nativeDescriptor, { _manager: manager })
+  }
+
+  /**
+   * {@link #blemanagerreaddescriptorfordevice|bleManager.readDescriptorForDevice()} with partially filled arguments.
+   *
+   * @param {?TransactionId} transactionId optional `transactionId` which can be used in
+   * {@link #blemanagercanceltransaction|cancelTransaction()} function.
+   * @returns {Promise<Descriptor>} Promise which emits first {@link Descriptor} object matching specified
+   * UUID paths. Latest value of {@link Descriptor} will be stored inside returned object.
+   */
+  async read(transactionId: ?TransactionId): Promise<Descriptor> {
+    return this._manager._readDescriptor(this.id, transactionId)
+  }
+
+  /**
+   * {@link #blemanagerwritedescriptorfordevice|bleManager.writeDescriptorForDevice()} with partially filled arguments.
+   *
+   * @param {Base64} valueBase64 Value to be set coded in Base64
+   * @param {?TransactionId} transactionId Transaction handle used to cancel operation
+   * @returns {Promise<Descriptor>} Descriptor which saved passed value.
+   */
+  async write(valueBase64: Base64, transactionId: ?TransactionId): Promise<Descriptor> {
+    return this._manager._writeDescriptor(this.id, valueBase64, transactionId)
+  }
+}