B2G/Bluetooth/WebBluetooth-v2/BluetoothGattService

Overview

BluetoothGattService represents the service provided by GATT server. BluetoothGattService consists of the service definition, a list of included services which this service references, and a list of characteristics in this service.

Interfaces

BluetoothGattService

BluetoothGattService

[CheckPermissions="bluetooth"]
interface BluetoothGattService
{
  [Cached, Pure]
  readonly attribute sequence<BluetoothGattCharacteristic> characteristics;
  [Cached, Pure]
  readonly attribute sequence<BluetoothGattService>        includedServices;
  readonly attribute boolean                               isPrimary;
  readonly attribute DOMString                             uuid;
  readonly attribute unsigned short                        instanceId;
};

Properties

• BluetoothGattService.characteristics
• BluetoothGattService.includeServices
• BluetoothGattService.isPrimary
• BluetoothGattService.uuid
• BluetoothGattService.instanceId

characteristics

Description

A cached array of charactertistics contained in this service.

Value Type

sequence<BluetoothGattCharacteristic>

Default Value

Empty array (array with length = 0)

includedServices

Description

A cached array of included services referenced by this service.

Value Type

sequence<BluetoothGattService>

Default Value

Empty array (array with length = 0)

isPrimary

Description

Indicate whether this is a primary or secondary service.

Value Type

boolean

Default Value

false

uuid

Description

This property stores the UUID of this service.

Value Type

DOMString

Default Value

Empty string ("")

instanceId

Description

This property stores the instance id of this service.

Value Type

unsigned short

Default Value

0

Methods

• BluetoothGattService.findCharacteristic(DOMString uuid)

findCharacteristic(DOMString uuid)

Description

The method finds a characteristic in this service from the characteristics property by the given UUID.

When there are multiple characteristics with the same UUID existed in the service, the first one will be returned.

Parameters

uuid

UUID DOMString of the characteristic to seek for.

Return

The first characteristic with the given uuid in characteristics property.

A null pointer is returned if no characteristic is found.

Sample

const HEART_RATE_SERVICE = "0000180d-0000-1000-8000-00805f9b34fb";
const HEART_RATE_MEASUREMENT = "00002a37-0000-1000-8000-00805f9b34fb";

if (device.gatt) {
  // get heart rate service
  var heartRateService = device.gatt.findService(HEART_RATE_SERVICE);

  // get heart rate measurement characteristic
  if (heartRateService) {
    var heartRateMeasurement = heartRateService.findCharacteristic(HEART_RATE_MEASUREMENT);
  }
}