chrome.bluetoothLowEnergy

Properties

• manufacturerData

  ManufacturerData[] optional

  List of manufacturer specific data to be included in "Manufacturer Specific Data" fields of the advertising data.

• serviceData

  ServiceData[] optional

  List of service data to be included in "Service Data" fields of the advertising data.

• serviceUuids

  string[] optional

  List of UUIDs to include in the "Service UUIDs" field of the Advertising Data. These UUIDs can be of the 16bit, 32bit or 128 formats.

• solicitUuids

  string[] optional

  List of UUIDs to include in the "Solicit UUIDs" field of the Advertising Data. These UUIDs can be of the 16bit, 32bit or 128 formats.

• type

  AdvertisementType

  Type of advertisement.

Enum

Properties

• instanceId

  string optional

  Returns the identifier assigned to this characteristic. Use the instance ID to distinguish between characteristics from a peripheral with the same UUID and to make function calls that take in a characteristic identifier. Present, if this instance represents a remote characteristic.

• properties

  CharacteristicProperty[]

  The properties of this characteristic.

• service

  Service optional

  The GATT service this characteristic belongs to.

• uuid

  string

  The UUID of the characteristic, e.g. 00002a37-0000-1000-8000-00805f9b34fb.

• value

  ArrayBuffer optional

  The currently cached characteristic value. This value gets updated when the value of the characteristic is read or updated via a notification or indication.

Enum

Properties

• persistent

  boolean

  Flag indicating whether a connection to the device is left open when the event page of the application is unloaded (see Manage App Lifecycle). The default value is false.

Properties

• characteristic

  Characteristic optional

  The GATT characteristic this descriptor belongs to.

• instanceId

  string optional

  Returns the identifier assigned to this descriptor. Use the instance ID to distinguish between descriptors from a peripheral with the same UUID and to make function calls that take in a descriptor identifier. Present, if this instance represents a remote characteristic.

• permissions

  DescriptorPermission[]

  The permissions of this descriptor.

• uuid

  string

  The UUID of the characteristic descriptor, e.g. 00002902-0000-1000-8000-00805f9b34fb.

• value

  ArrayBuffer optional

  The currently cached descriptor value. This value gets updated when the value of the descriptor is read.

Enum

Properties

• address

  string

  The address of the device, in the format 'XX:XX:XX:XX:XX:XX'.

• deviceClass

  number optional

  The class of the device, a bit-field defined by http://www.bluetooth.org/en-us/specification/assigned-numbers/baseband.

• name

  string optional

  The human-readable name of the device.

Properties

• data

  number[]
• id

  number

Properties

• shouldIndicate

  boolean optional

  Optional flag for sending an indication instead of a notification.

• value

  ArrayBuffer

  New value of the characteristic.

Properties

• persistent

  boolean

  Flag indicating whether the app should receive notifications when the event page of the application is unloaded (see Manage App Lifecycle). The default value is false.

Properties

• device

  Device

  Device that send this request.

• requestId

  number

  Unique ID for this request. Use this ID when responding to this request.

• value

  ArrayBuffer optional

  Value to write (if this is a write request).

Properties

• isError

  boolean

  If this is an error response, this should be true.

• requestId

  number

  Id of the request this is a response to.

• value

  ArrayBuffer optional

  Response value. Write requests and error responses will ignore this parameter.

Properties

• deviceAddress

  string optional

  The device address of the remote peripheral that the GATT service belongs to. Present, if this instance represents a remote service.

• instanceId

  string optional

  Returns the identifier assigned to this service. Use the instance ID to distinguish between services from a peripheral with the same UUID and to make function calls that take in a service identifier. Present, if this instance represents a remote service.

• isPrimary

  boolean

  Indicates whether the type of this service is primary or secondary.

• uuid

  string

  The UUID of the service, e.g. 0000180d-0000-1000-8000-00805f9b34fb.

Properties

• data

  number[]
• uuid

  string

Parameters

• deviceAddress

  string

  The Bluetooth address of the remote device to which a GATT connection should be opened.

• properties

  ConnectProperties optional

  Connection properties (optional).

Result

• return/callback

  async

  Called when the connect request has completed.

  The connect method provides its result via callback or returned as a Promise (MV3 only). It has no parameters.

Parameters

• characteristic

  Characteristic

  The characteristic to create.

• serviceId

  string

  ID of the service to create this characteristic for.

Result

• return/callback

  async

  Called with the created characteristic's unique ID.

  The createCharacteristic method provides its result via callback or returned as a Promise (MV3 only).

  • characteristicId

    string

Parameters

• descriptor

  Descriptor

  The descriptor to create.

• characteristicId

  string

  ID of the characteristic to create this descriptor for.

Result

• return/callback

  async

  Called with the created descriptor's unique ID.

  The createDescriptor method provides its result via callback or returned as a Promise (MV3 only).

  • descriptorId

    string

Parameters

• service

  Service

  The service to create.

Result

• return/callback

  async

  Called with the created services's unique ID.

  The createService method provides its result via callback or returned as a Promise (MV3 only).

  • serviceId

    string

Parameters

• deviceAddress

  string

  The Bluetooth address of the remote device.

Result

• return/callback

  async

  Called when the disconnect request has completed.

  The disconnect method provides its result via callback or returned as a Promise (MV3 only). It has no parameters.

Parameters

• characteristicId

  string

  The instance ID of the requested GATT characteristic.

Result

• return/callback

  async

  Called with the requested Characteristic object.

  The getCharacteristic method provides its result via callback or returned as a Promise (MV3 only).

  • result

    Characteristic

Parameters

• serviceId

  string

  The instance ID of the GATT service whose characteristics should be returned.

Result

• return/callback

  async

  Called with the list of characteristics that belong to the given service.

  The getCharacteristics method provides its result via callback or returned as a Promise (MV3 only).

  • result

    Characteristic[]

Parameters

• descriptorId

  string

  The instance ID of the requested GATT characteristic descriptor.

Result

• return/callback

  async

  Called with the requested Descriptor object.

  The getDescriptor method provides its result via callback or returned as a Promise (MV3 only).

  • result

    Descriptor

Parameters

• characteristicId

  string

  The instance ID of the GATT characteristic whose descriptors should be returned.

Result

• return/callback

  async

  Called with the list of descriptors that belong to the given characteristic.

  The getDescriptors method provides its result via callback or returned as a Promise (MV3 only).

  • result

    Descriptor[]

Parameters

• serviceId

  string

  The instance ID of the GATT service whose included services should be returned.

Result

• return/callback

  async

  Called with the list of GATT services included from the given service.

  The getIncludedServices method provides its result via callback or returned as a Promise (MV3 only).

  • result

    Service[]

Parameters

• serviceId

  string

  The instance ID of the requested GATT service.

Result

• return/callback

  async

  Called with the requested Service object.

  The getService method provides its result via callback or returned as a Promise (MV3 only).

  • result

    Service

Parameters

• deviceAddress

  string

  The Bluetooth address of the remote device whose GATT services should be returned.

Result

• return/callback

  async

  Called with the list of requested Service objects.

  The getServices method provides its result via callback or returned as a Promise (MV3 only).

  • result

    Service[]

Parameters

• characteristicId

  string

  The characteristic to send the notication for.

• notification

  Notification

Result

• return/callback

  async

  Callback called once the notification or indication has been sent successfully.

  The notifyCharacteristicValueChanged method provides its result via callback or returned as a Promise (MV3 only). It has no parameters.

Parameters

• characteristicId

  string

  The instance ID of the GATT characteristic whose value should be read from the remote device.

Result

• return/callback

  async

  Called with the Characteristic object whose value was requested. The value field of the returned Characteristic object contains the result of the read request.

  The readCharacteristicValue method provides its result via callback or returned as a Promise (MV3 only).

  • result

    Characteristic

Parameters

• descriptorId

  string

  The instance ID of the GATT characteristic descriptor whose value should be read from the remote device.

Result

• return/callback

  async

  Called with the Descriptor object whose value was requested. The value field of the returned Descriptor object contains the result of the read request.

  The readDescriptorValue method provides its result via callback or returned as a Promise (MV3 only).

  • result

    Descriptor

Parameters

• advertisement

  Advertisement

  The advertisement to advertise.

Result

• return/callback

  async

  Called once the registeration is done and we've started advertising. Returns the id of the created advertisement.

  The registerAdvertisement method provides its result via callback or returned as a Promise (MV3 only).

  • advertisementId

    number

Parameters

• serviceId

  string

  Unique ID of a created service.

Result

• return/callback

  async

  Callback with the result of the register operation.

  The registerService method provides its result via callback or returned as a Promise (MV3 only). It has no parameters.

Parameters

• serviceId

  string

  Unique ID of a current registered service.

Result

• return/callback

  async

  Callback called once the service is removed.

  The removeService method provides its result via callback or returned as a Promise (MV3 only). It has no parameters.

Result

• return/callback

  async

  Called once the advertisements are reset.

  The resetAdvertising method provides its result via callback or returned as a Promise (MV3 only). It has no parameters.

Parameters

• response

  Response

  The response to the request.

Parameters

• minInterval

  number

  Minimum interval between advertisments (in milliseconds). This cannot be lower than 20ms (as per the spec).

• maxInterval

  number

  Maximum interval between advertisments (in milliseconds). This cannot be more than 10240ms (as per the spec).

Result

• return/callback

  async

  Called once the interval has been set.

  The setAdvertisingInterval method provides its result via callback or returned as a Promise (MV3 only). It has no parameters.

Parameters

• characteristicId

  string

  The instance ID of the GATT characteristic that notifications should be enabled on.

• properties

  NotificationProperties optional

  Notification session properties (optional).

Result

• return/callback

  async

  Called when the request has completed.

  The startCharacteristicNotifications method provides its result via callback or returned as a Promise (MV3 only). It has no parameters.

Parameters

• characteristicId

  string

  The instance ID of the GATT characteristic on which this app's notification session should be stopped.

Result

• return/callback

  async

  Called when the request has completed (optional).

  The stopCharacteristicNotifications method provides its result via callback or returned as a Promise (MV3 only). It has no parameters.

Parameters

• advertisementId

  number

  Id of the advertisement to unregister.

Result

• return/callback

  async

  Called once the advertisement is unregistered and is no longer being advertised.

  The unregisterAdvertisement method provides its result via callback or returned as a Promise (MV3 only). It has no parameters.

Parameters

• serviceId

  string

  Unique ID of a current registered service.

Result

• return/callback

  async

  Callback with the result of the register operation.

  The unregisterService method provides its result via callback or returned as a Promise (MV3 only). It has no parameters.

Parameters

• characteristicId

  string

  The instance ID of the GATT characteristic whose value should be written to.

• value

  ArrayBuffer

  The value that should be sent to the remote characteristic as part of the write request.

Result

• return/callback

  async

  Called when the write request has completed.

  The writeCharacteristicValue method provides its result via callback or returned as a Promise (MV3 only). It has no parameters.

Parameters

• descriptorId

  string

  The instance ID of the GATT characteristic descriptor whose value should be written to.

• value

  ArrayBuffer

  The value that should be sent to the remote descriptor as part of the write request.

Result

• return/callback

  async

  Called when the write request has completed.

  The writeDescriptorValue method provides its result via callback or returned as a Promise (MV3 only). It has no parameters.

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (request: Request, characteristicId: string) => {...}
  • request

    Request

    Request data for this request.

  • characteristicId

    string

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (characteristic: Characteristic) => {...}
  • characteristic

    Characteristic

    The GATT characteristic whose value has changed.

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (request: Request, characteristicId: string) => {...}
  • request

    Request

    Request data for this request.

  • characteristicId

    string

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (request: Request, descriptorId: string) => {...}
  • request

    Request

    Request data for this request.

  • descriptorId

    string

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (descriptor: Descriptor) => {...}
  • descriptor

    Descriptor

    The GATT characteristic descriptor whose value has changed.

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (request: Request, descriptorId: string) => {...}
  • request

    Request

    Request data for this request.

  • descriptorId

    string

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (service: Service) => {...}
  • service

    Service

    The GATT service that was added.

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (service: Service) => {...}
  • service

    Service

    The GATT service whose state has changed.

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (service: Service) => {...}
  • service

    Service

    The GATT service that was removed.