React native bluetooth serial next

React Native Bluetooth Serial Next 🙂

React Native version of BluetoothSerial plugin for both Android and iOS. Pulled from React Native Bluetooth Serial.

For iOS, this module now support service declaration, by default, those services are Read Bear Lab, Adafruit BLE, Bluegiga, Laird Virtual Serial Port, and Rongta.

Table of Contents

Getting started

npm install react-native-bluetooth-serial-next --save react-native link react-native-bluetooth-serial-next

For Android, you need to put the following code to AndroidManifest.xml in android/app/src/main at your project root folder.

uses-permission android:name="android.permission.BLUETOOTH" /> uses-permission android:name="android.permission.BLUETOOTH_ADMIN" /> uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />

Manual Installation

iOS

1. npm install react-native-bluetooth-serial-next —save
2. In XCode, in the project navigator, right click Libraries ➜ Add Files to [your project’s name]
3. Go to node_modules ➜ react-native-bluetooth-serial-next and add RCTBluetoothSerial.xcodeproj
4. In XCode, in the project navigator, select your project. Add libRCTBluetoothSerial.a to your project’s Build Phases ➜ Link Binary With Libraries
5. Click RCTBluetoothSerial.xcodeproj in the project navigator and go the Build Settings tab. Make sure ‘All’ is toggled on (instead of ‘Basic’). In the Search Paths section, look for Header Search Paths and make sure it contains both $(SRCROOT)/../../react-native/React and $(SRCROOT)/../../../React — mark both as recursive .
6. Run your project ( Cmd+R )

Android

1. npm install react-native-bluetooth-serial-next —save
2. Open up android/app/src/main/java/[. ]/MainActivity.java or MainApplication.java for React Native >= 0.29
   • Add import com.nuttawutmalee.RCTBluetoothSerial.*; to the imports at the top of the file
   • Add new RCTBluetoothSerialPackage() to the list returned by the getPackages() method
3. Append the following lines to android/settings.gradle

include ':react-native-bluetooth-serial-next' project(':react-native-bluetooth-serial-next').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-bluetooth-serial-next/android')

compile project(':react-native-bluetooth-serial-next')

Example

1. git clone https://github.com/nuttawutmalee/react-native-bluetooth-serial-next.git
2. cd react-native-bluetooth-serial-next/example
3. npm install && npm link ../
4. npm start
5. react-native run-ios or react-native run-android

API References

Device object

This is basically the result object from API methods depending on operation system.

 id: '111-111-111-111', uuid: '111-111-111-111', name: 'Bluetooth Printer', rssi: 'This field might not be present in the object', >

 id: '111-111-111-111', address: '111-111-111-111', name: 'Bluetooth Printer', class: 'This field might not be present in the object', >

Service object

 name: 'This field might not be present in the object', service: 'BLE service UUID string', read: 'BLE read characteristic UUID string', write: 'BLE write characteristic UUID string', >

High order component

withSubscription( options : Object ) : React.Component

This method will create an event listener and send it though as a component prop and it will remove all event listeners on componentWillUnmount as well.

• options : Object
  • subscriptionName : String = ‘subscription’ The event listener prop name.
  • destroyOnWillUnmount : Boolean = true Should event listeners remove all listeners and subscription

  class MyComponent extends React.Component  . > export default withSubscription( subscriptionName: 'events', destroyOnWillUnmount: true, >)(MyComponent);

  Methods

  Bluetooth adapter

  requestEnable() : Promise

  Prompts the application device to enable bluetooth adapter.

  • For iOS, this method will throw an error.
  • For Android, if the user does not enable bluetooth upon request, it will throw an error.

  await BluetoothSerial.requestEnable();

  enable() : Promise

  Enable bluetooth adapter service.

  await BluetoothSerial.enable();

  disable() : Promise

  Disable bluetooth adapter service.

  await BluetoothSerial.disable();

  isEnabled() : Promise

  Indicates bluetooth adapter service status.

  const isEnabled = await BluetoothSerial.isEnabled();

  list() : Promise

  List all paired (Android) or connected (iOS) bluetooth devices.

  const devices = await BluetoothSerial.list();

  listUnpaired() : Promise | discoverUnpairedDevices() : Promise

  List all unpaired bluetooth devices.

  const devices = await BluetoothSerial.listUnpaired(); const devices = await BluetoothSerial.discoverUnpairedDevices();

  cancelDiscovery() : Promise | stopScanning() : Promise

  Cancel bluetooth device discovery process.

  await BluetoothSerial.cancelDiscovery(); await BluetoothSerial.stopScanning();

  setAdapterName( name : String ) : Promise

  Give bluetooth adapter a new name.

  const newName = await BluetoothSerial.setAdapterName("New Adapter Name");

  Device pairing

  pairDevice( id : String ) : Promise

  Pair with a bluetooth device.

  const device = await BluetoothSerial.pairDevice(id);

  unpairDevice( id : String ) : Promise

  Unpair from a bluetooth device.

  const device = await BluetoothSerial.unpairDevice(id);

  Device connection

  connect( id : String ): Promise

  Connect to a specific bluetooth device.

  const device = await BluetoothSerial.connect(id);

  disconnect( id? : String ) : Promise

  Disconnect from the specific connected bluetooth device. If id is omitted, the first connected device will be disconnected.

  await BluetoothSerial.disconnect();

  disconnectAll() : Promise

  Disconnect all connected bluetooth devices.

  await BluetoothSerial.disconnectAll();

  isConnected( id? : String ) : Promise

  Indicates the specific connected bluetooth device connection status. If id is omitted, it will return the connection status of the first connected device.

  const isConnected = await BluetoothSerial.isConnected();

  Device IO

  read( callback : Function , delimiter? : String , id? : String ) : void

  Listen and read data from the selected or first connected device.

  BluetoothSerial.read((data, subscription) =>  console.log(data); if (this.imBoredNow && subscription)  BluetoothSerial.removeSubscription(subscription); > >, "\r\n");

  readOnce( delimiter? : String , id? : String ) : Promise

  Read data from the selected or first connected device once.

  const data = await BluetoothSerial.readOnce("\r\n");

  readEvery( callback : Function , ms? : Number , delimiter? : String , id? : String ) : void

  Read data from the selected or first connected device every n ms.

  BluetoothSerial.readEvery( (data, intervalId) =>  console.log(data); if (this.imBoredNow && intervalId)  clearInterval(intervalId); > >, 5000, "\r\n" );

  readFromDevice( id? : String ) : Promise

  Read all buffer data from the selected or first connected device.

  const data = await BluetoothSerial.readFromDevice();

  readUntilDelimiter( delimiter : String , id? : String ) : Promise

  Read all buffer data up to certain delimiter from the selected or first connected device.

  const data = await BluetoothSerial.readUntilDelimiter("\r\n");

  write( data : Buffer | String , id? : String ) : Promise

  Write buffer or string to the selected or first connected device.

  await BluetoothSerial.write("This is the test message");

  writeToDevice( data : String , id? : String ) : Promise

  Write string to the selected or first connected device.

  await BluetoothSerial.writeToDevice("This is the test message");

  Device buffer

  clear( id? : String ) : Promise

  Clear all buffer data of the selected or first connected device.

  await BluetoothSerial.clear();

  available( id? : String ) : Promise

  Get length of current buffer data of the selected or first connected device.

  const bufferLength = await BluetoothSerial.available();

  withDelimiter( delimiter : String , id? : String ) : Promise

  Set delimiter that will split the buffer data when you are reading from device.

  const deviceId = await BluetoothSerial.withDelimiter("\r\n");

  Service declaration for iOS

  You can get the default services which are Read Bear Lab, Adafruit BLE, Bluegiga, Laird Virtual Serial Port, and Rongta via BluetoothSerial.DEFAULT_SERVICES array.

  setServices( services : Service[] , includeDefaultServices? : Boolean ) : Promise

  Set custom bluetooth services for filtering out the specific protocols that you need.

  • For Android, this method has no effect and will return empty array.
  • services : Service[] Array of custom service object; each of them must have service , read , and write key-value.
  • includeDefaultServices? : Boolean = true Should we include BluetoothSerial.DEFAULT_SERVICES in the services array?

  const updatedServices = await BluetoothSerial.setServices([ name: 'Custom Bluetooth Service', service: '111-111-111-111-111-111', read: '111-111-111-111-111-111', write: '111-111-111-111-111-111', ], false);

  getServices() : Promise

  const currentServices = await BluetoothSerial.getServices();

  restoreServices() : Promise

  Restore services and set them to default services ( BluetoothSerial.DEFAULT_SERVICES .)

  const services = await BluetoothSerial.restoreServices();

  Multiple devices connection

  This module supports multiple devices connection, as you can see in API Methods, most of the connection, IO, and buffer methods have id parameter that you can pass and specify which bluetooth device that you want to control.

  However, to keep it clean and simple, you can use the following method to simplify them.

  device( id? : String ) : Object

  This method gives the ability to call group of API methods instead of pass id parameter at the end of each methods.

  The followings are group of methods that you can use with this method.

  • connect
  • disconnect
  • isConnected
  • clear
  • available
  • withDelimiter
  • read
  • readOnce
  • readEvery
  • readUntilDelimiter
  • readFromDevice
  • write
  • writeToDevice

  const myDevice = BluetoothSerial.device(myId); const yourDevice = BluetoothSerial.device(yourId); await myDevice.connect(); await myDevice.write('This is a message for my device.'); let yourReadSubscription; await yourDevice.connect(); await yourDevice.read((data, subscription) =>  yourReadSubscription = subscription; console.log('Your data:', data); if (/** */ )  BluetoothSerial.removeSubscription(subscription); yourReadSubscription = null; > >); await myDevice.disconnect(); if (yourReadSubscription)  BluetoothSerial.removeSubscription(yourReadSubscription); > await yourDevice.disconnect();

  Events

  Types

  • bluetoothEnabled : When bluetooth adapter is turned on.
  • bluetoothDisabled : When bluetooth adapter is turned off.
  • connectionSuccess : When device is connected. You get object of message and device.

  Источник

  Читайте также:  Беспроводная клавиатура palmexx bluetooth apple style