BluetoothRemoteGATTServer

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The BluetoothRemoteGATTServer interface of the Web Bluetooth API represents a GATT Server on a remote device.

This page describes the W3C Community Group Web Bluetooth API. For the Firefox OS Bluetooth API, see BluetoothGattServer (Firefox OS).

Interface

interface BluetoothRemoteGATTServer {
  readonly attribute BluetoothDevice device;
  readonly attribute boolean connected;

  Promise<BluetoothRemoteGATTServer> connect();
  void disconnect();
  Promise<BluetoothRemoteGATTService> getPrimaryService(BluetoothServiceUUID service);
  Promise<sequence<BluetoothRemoteGATTService>> getPrimaryServices(optional BluetoothServiceUUID service);
};

Properties

BluetoothRemoteGATTServer.connectedRead only: A boolean value that returns true while this script execution environment is connected to this.device. It can be false while the user agent is physically connected.
BluetoothRemoteGATTServer.deviceRead only: A reference to the BluetoothDevice running the server.

Methods

BluetoothRemoteGATTServer.connect(): Causes the script execution environment to connect to this.device.
BluetoothRemoteGATTServer.disconnect(): Causes the script execution environment to disconnect from this.device.
BluetoothRemoteGATTServer.getPrimaryService(): Returns a promise to the primary BluetoothGATTService offered by the bluetooth device for a specified BluetoothServiceUUID.
BluetoothRemoteGATTServer.getPrimaryServices(): Returns a promise to a list of primary BluetoothGATTService objects offered by the bluetooth device for a specified BluetoothServiceUUID.

Specifications

Specification	Status	Comment
Web Bluetooth The definition of 'BluetoothRemoteGATTServer' in that specification.	Draft	Initial definition.

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Edge Mobile	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
Basic support Experimental	Chrome Full support 56 Notes Full support 56 Notes Notes macOS only. Full support 56 Notes Disabled Notes Linux and versions of Windows earlier than 10. Disabled From version 56: this feature is behind the `#enable-experimental-web-platform-features` preference (needs to be set to `enabled`). To change preferences in Chrome, visit chrome://flags. Full support 70 Notes Notes Windows 10.	Edge ?	Firefox No support No	IE ?	Opera Full support 43 Notes Full support 43 Notes Notes macOS only. Full support 43 Notes Disabled Notes Linux and versions of Windows earlier than 10. Disabled From version 43: this feature is behind the `#enable-experimental-web-platform-features` preference (needs to be set to `enabled`). Full support 57 Notes Notes Windows 10.	Safari ?	WebView Android No support No	Chrome Android Full support 56	Edge Mobile ?	Firefox Android No support No	Opera Android Full support 43	Safari iOS ?	Samsung Internet Android ?
`connect` Experimental	Chrome Full support 56 Notes Full support 56 Notes Notes macOS only. Full support 56 Notes Disabled Notes Linux and versions of Windows earlier than 10. Disabled From version 56: this feature is behind the `#enable-experimental-web-platform-features` preference (needs to be set to `enabled`). To change preferences in Chrome, visit chrome://flags. Full support 70 Notes Notes Windows 10.	Edge ?	Firefox No support No	IE ?	Opera Full support 43 Notes Full support 43 Notes Notes macOS only. Full support 43 Notes Disabled Notes Linux and versions of Windows earlier than 10. Disabled From version 43: this feature is behind the `#enable-experimental-web-platform-features` preference (needs to be set to `enabled`). Full support 57 Notes Notes Windows 10.	Safari ?	WebView Android No support No	Chrome Android Full support 56	Edge Mobile ?	Firefox Android No support No	Opera Android Full support 43	Safari iOS ?	Samsung Internet Android ?
`connected` Experimental	Chrome Full support 56 Notes Full support 56 Notes Notes macOS only. Full support 56 Notes Disabled Notes Linux and versions of Windows earlier than 10. Disabled From version 56: this feature is behind the `#enable-experimental-web-platform-features` preference (needs to be set to `enabled`). To change preferences in Chrome, visit chrome://flags. Full support 70 Notes Notes Windows 10.	Edge ?	Firefox No support No	IE ?	Opera Full support 43 Notes Full support 43 Notes Notes macOS only. Full support 43 Notes Disabled Notes Linux and versions of Windows earlier than 10. Disabled From version 43: this feature is behind the `#enable-experimental-web-platform-features` preference (needs to be set to `enabled`). Full support 57 Notes Notes Windows 10.	Safari ?	WebView Android No support No	Chrome Android Full support 56	Edge Mobile ?	Firefox Android No support No	Opera Android Full support 43	Safari iOS ?	Samsung Internet Android ?
`device` Experimental	Chrome Full support 56 Notes Full support 56 Notes Notes macOS only. Full support 56 Notes Disabled Notes Linux and versions of Windows earlier than 10. Disabled From version 56: this feature is behind the `#enable-experimental-web-platform-features` preference (needs to be set to `enabled`). To change preferences in Chrome, visit chrome://flags. Full support 70 Notes Notes Windows 10.	Edge ?	Firefox No support No	IE ?	Opera Full support 43 Notes Full support 43 Notes Notes macOS only. Full support 43 Notes Disabled Notes Linux and versions of Windows earlier than 10. Disabled From version 43: this feature is behind the `#enable-experimental-web-platform-features` preference (needs to be set to `enabled`). Full support 57 Notes Notes Windows 10.	Safari ?	WebView Android No support No	Chrome Android Full support 56	Edge Mobile ?	Firefox Android No support No	Opera Android Full support 43	Safari iOS ?	Samsung Internet Android ?
`disconnect` Experimental	Chrome Full support 56 Notes Full support 56 Notes Notes macOS only. Full support 56 Notes Disabled Notes Linux and versions of Windows earlier than 10. Disabled From version 56: this feature is behind the `#enable-experimental-web-platform-features` preference (needs to be set to `enabled`). To change preferences in Chrome, visit chrome://flags. Full support 70 Notes Notes Windows 10.	Edge ?	Firefox No support No	IE ?	Opera Full support 43 Notes Full support 43 Notes Notes macOS only. Full support 43 Notes Disabled Notes Linux and versions of Windows earlier than 10. Disabled From version 43: this feature is behind the `#enable-experimental-web-platform-features` preference (needs to be set to `enabled`). Full support 57 Notes Notes Windows 10.	Safari ?	WebView Android No support No	Chrome Android Full support 56	Edge Mobile ?	Firefox Android No support No	Opera Android Full support 43	Safari iOS ?	Samsung Internet Android ?
`getPrimaryService` Experimental	Chrome Full support 56 Notes Full support 56 Notes Notes macOS only. Full support 56 Notes Disabled Notes Linux and versions of Windows earlier than 10. Disabled From version 56: this feature is behind the `#enable-experimental-web-platform-features` preference (needs to be set to `enabled`). To change preferences in Chrome, visit chrome://flags. Full support 70 Notes Notes Windows 10.	Edge ?	Firefox No support No	IE ?	Opera Full support 43 Notes Full support 43 Notes Notes macOS only. Full support 43 Notes Disabled Notes Linux and versions of Windows earlier than 10. Disabled From version 43: this feature is behind the `#enable-experimental-web-platform-features` preference (needs to be set to `enabled`). Full support 57 Notes Notes Windows 10.	Safari ?	WebView Android No support No	Chrome Android Full support 56	Edge Mobile ?	Firefox Android No support No	Opera Android Full support 43	Safari iOS ?	Samsung Internet Android ?
`getPrimaryServices` Experimental	Chrome Full support 56 Notes Full support 56 Notes Notes macOS only. Full support 56 Notes Disabled Notes Linux and versions of Windows earlier than 10. Disabled From version 56: this feature is behind the `#enable-experimental-web-platform-features` preference (needs to be set to `enabled`). To change preferences in Chrome, visit chrome://flags. Full support 70 Notes Notes Windows 10.	Edge ?	Firefox No support No	IE ?	Opera Full support 43 Notes Full support 43 Notes Notes macOS only. Full support 43 Notes Disabled Notes Linux and versions of Windows earlier than 10. Disabled From version 43: this feature is behind the `#enable-experimental-web-platform-features` preference (needs to be set to `enabled`). Full support 57 Notes Notes Windows 10.	Safari ?	WebView Android No support No	Chrome Android Full support 56	Edge Mobile ?	Firefox Android No support No	Opera Android Full support 43	Safari iOS ?	Samsung Internet Android ?

Legend

Full support: Full support
No support: No support
Compatibility unknown: Compatibility unknown
Experimental. Expect behavior to change in the future.: Experimental. Expect behavior to change in the future.
See implementation notes.: See implementation notes.
User must explicitly enable this feature.: User must explicitly enable this feature.