JSPM

webbluetooth

1.1.2-next.1675d90.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1236
  • Score
    100M100P100Q108586F
  • License MIT

Node.js implementation of the Web Bluetooth Specification

Package Exports

  • webbluetooth

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 (webbluetooth) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Node Web Bluetooth

Node.js implementation of the Web Bluetooth Specification

Circle CI npm Licence MIT

Prerequisites

Node.js > v6.15.0, which includes npm.

Installation

$ npm install webbluetooth

Getting Started

See the examples or view the API documentation at:

https://thegecko.github.io/webbluetooth/

Specification

The Web Bluetooth specification can be found here:

https://webbluetoothcg.github.io/web-bluetooth/

Implementation Status

bluetooth

  • referringDevice - specification unstable
  • getAvailability() - specification unstable
  • requestDevice()
  • RequestDeviceOptions.name
  • RequestDeviceOptions.namePrefix
  • RequestDeviceOptions.services
  • RequestDeviceOptions.optionalServices
  • RequestDeviceOptions.acceptAllDevices
  • RequestDeviceOptions.manufacturerData - specification unstable
  • RequestDeviceOptions.serviceData - specification unstable

BluetoothDevice

  • id
  • name
  • gatt
  • watchingAdvertisements - specification unstable
  • watchAdvertisements() - specification unstable
  • unwatchAdvertisements() - specification unstable

BluetoothRemoteGATTServer

  • connected
  • device
  • connect()
  • disconnect()
  • getPrimaryService()
  • getPrimaryServices()

BluetoothRemoteGATTService

  • device
  • uuid
  • isPrimary
  • getCharacteristic()
  • getCharacteristics()
  • getIncludedService()
  • getIncludedServices()

BluetoothRemoteGATTCharacteristic

  • service
  • uuid
  • properties
  • value
  • getDescriptor()
  • getDescriptors()
  • readValue()
  • writeValue()
  • startNotifications()
  • stopNotifications()

BluetoothRemoteGATTDescriptor

  • characteristic
  • uuid
  • value
  • readValue()
  • writeValue()

Events

  • availabilitychanged - specification unstable
  • gattserverdisconnected
  • characteristicvaluechanged
  • serviceadded
  • servicechanged - unsupported in noble
  • serviceremoved - unsupported in noble

Other

  • Device selector hook
  • Lookups for known services, characteristics and descriptors
  • Canonical UUID helper
  • Examples
  • API Documentation