Package Exports

react-bluetooth

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-bluetooth) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

WIP: This library is not ready for use in any projects

react-bluetooth

Tools to integrate the current web Bluetooth API spec in your React web applications.

The goal of this project is to create a unified API for working with Bluetooth across browser, iOS, Android, and PWAs.

References

Installation

yarn add react-bluetooth

Usage

Import the library into your JavaScript file:

import * as Bluetooth from 'react-bluetooth';

Methods

`requestDeviceAsync`

requestDeviceAsync(
  options: RequestDeviceOptions = { acceptAllDevices: true }
): Promise<{ type: 'cancel' } | { type: 'success'; device: BluetoothDevice }>

Example

try {
  const result = await Bluetooth.requestDeviceAsync();

  if (result.type === 'cancel') {
    return;
  }

  const device: BluetoothDevice = result.device;
} catch ({ message, code }) {
  console.log('Error:', message, code);
}

`getAvailabilityAsync`

getAvailabilityAsync(): Promise<boolean>

Returns a boolean that denotes bluetooth availability on the current device. This will also polyfill instances where navigator.bluetooth.getAvailability() is not supported.

Example

if (await Bluetooth.getAvailabilityAsync()) {
  // Is Available
}

`getReferringDevice`

getReferringDevice(): BluetoothDevice | undefined

`addPlatformHandler`

addPlatformHandler(eventName: BluetoothEvent, handler: PlatformHandler): Subscription

Example

const subscription = addPlatformHandler(BluetoothEvent.onServiceAdded, event => {
  console.log('addPlatformHandler');
});

`addEventListener`

addEventListener(
  listener: EventListenerOrEventListenerObject,
  useCapture?: boolean
): void

`dispatchEvent`

dispatchEvent(event: Event): boolean

`removeEventListener`

removeEventListener(
  callback: EventListenerOrEventListenerObject | null,
  options?: EventListenerOptions | boolean
): void

Types

`BluetoothEvent`

Used with Bluetooth.setPlatformHandler.

enum BluetoothEvent {
  onAvailabilityChanged = 'onavailabilitychanged',
  onGATTServerDisconnected = 'ongattserverdisconnected',
  onCharacteristicValueChanged = 'oncharacteristicvaluechanged',
  onServiceAdded = 'onserviceadded',
  onServiceChanged = 'onservicechanged',
  onServiceRemoved = 'onserviceremoved',
}

Examples

async function example_GetAnyDeviceAsync() {
  const isAvailable = await Bluetooth.getAvailabilityAsync();
  if (!isAvailable) {
    return;
  }
  try {
    const device = await Bluetooth.requestDeviceAsync();
    console.log('Success: Got any device: ', device);
  } catch (error) {
    console.log(`Error: Couldn't get any device`, error);
    console.error(`Error: Couldn't get any device`, error);
  }
}

async function example_GetBatteryLevelAsync() {
  const isAvailable = await Bluetooth.getAvailabilityAsync();
  if (!isAvailable) {
    return;
  }

  const options = {
    filters: [{ services: ['battery_service'] }],
  };

  try {
    const result = await Bluetooth.requestDeviceAsync(options);
    if (result.type === 'cancel') {
      return;
    }
    const { device } = result;

    console.log(`Bluetooth: Got device:`, device);
    if (device.gatt) {
      const server = await device.gatt.connect();
      console.log(`Bluetooth: Got server:`, server);
      const service = await server.getPrimaryService('battery_service');
      console.log(`Bluetooth: Got service:`, service);
      const characteristic = await service.getCharacteristic('battery_level');
      console.log(`Bluetooth: Got characteristic:`, characteristic);
      const value = await characteristic.readValue();
      console.log(`Bluetooth: Got value:`, value);
      const battery = value.getUint8(0);
      console.log(`Success: Got battery:`, battery);
    } else {
      // TODO: Bacon: Can we connect to the GATT or is that a no-op?
      console.error(`Error: connected device did not have a GATT`);
    }
  } catch ({ message }) {
    console.error(`Error: Couldn't get battery level: ${message}`);
  }
}