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.

Type

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.

Type

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[]
  Chrome 52+

  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.

Type

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).

• callback

  function optional

  The callback parameter looks like: () => void

Returns

• Promise<void>
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Parameters

• characteristic

  Characteristic

  The characteristic to create.

• serviceId

  string

  ID of the service to create this characteristic for.

• callback

  function optional

  The callback parameter looks like: (characteristicId: string) => void

  • characteristicId

    string

Returns

• Promise<string>
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Parameters

• descriptor

  Descriptor

  The descriptor to create.

• characteristicId

  string

  ID of the characteristic to create this descriptor for.

• callback

  function optional

  The callback parameter looks like: (descriptorId: string) => void

  • descriptorId

    string

Returns

• Promise<string>
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Parameters

• service

  Service

  The service to create.

• callback

  function optional

  The callback parameter looks like: (serviceId: string) => void

  • serviceId

    string

Returns

• Promise<string>
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Parameters

• deviceAddress

  string

  The Bluetooth address of the remote device.

• callback

  function optional

  The callback parameter looks like: () => void

Returns

• Promise<void>
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Parameters

• characteristicId

  string

  The instance ID of the requested GATT characteristic.

• callback

  function optional

  The callback parameter looks like: (result: Characteristic) => void

  • result

    Characteristic

Returns

• Promise<Characteristic>
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Parameters

• serviceId

  string

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

• callback

  function optional

  The callback parameter looks like: (result: Characteristic[]) => void

  • result

    Characteristic[]

Returns

• Promise<Characteristic[]>
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Parameters

• descriptorId

  string

  The instance ID of the requested GATT characteristic descriptor.

• callback

  function optional

  The callback parameter looks like: (result: Descriptor) => void

  • result

    Descriptor

Returns

• Promise<Descriptor>
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Parameters

• characteristicId

  string

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

• callback

  function optional

  The callback parameter looks like: (result: Descriptor[]) => void

  • result

    Descriptor[]

Returns

• Promise<Descriptor[]>
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Parameters

• serviceId

  string

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

• callback

  function optional

  The callback parameter looks like: (result: Service[]) => void

  • result

    Service[]

Returns

• Promise<Service[]>
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Parameters

• serviceId

  string

  The instance ID of the requested GATT service.

• callback

  function optional

  The callback parameter looks like: (result: Service) => void

  • result

    Service

Returns

• Promise<Service>
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Parameters

• deviceAddress

  string

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

• callback

  function optional

  The callback parameter looks like: (result: Service[]) => void

  • result

    Service[]

Returns

• Promise<Service[]>
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Parameters

• characteristicId

  string

  The characteristic to send the notication for.

• notification

  Notification
• callback

  function optional

  The callback parameter looks like: () => void

Returns

• Promise<void>
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Parameters

• characteristicId

  string

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

• callback

  function optional

  The callback parameter looks like: (result: Characteristic) => void

  • result

    Characteristic

Returns

• Promise<Characteristic>
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Parameters

• descriptorId

  string

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

• callback

  function optional

  The callback parameter looks like: (result: Descriptor) => void

  • result

    Descriptor

Returns

• Promise<Descriptor>
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Parameters

• advertisement

  Advertisement

  The advertisement to advertise.

• callback

  function optional

  The callback parameter looks like: (advertisementId: number) => void

  • advertisementId

    number

Returns

• Promise<number>
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Parameters

• serviceId

  string

  Unique ID of a created service.

• callback

  function optional

  The callback parameter looks like: () => void

Returns

• Promise<void>
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Parameters

• serviceId

  string

  Unique ID of a current registered service.

• callback

  function optional

  The callback parameter looks like: () => void

Returns

• Promise<void>
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Parameters

• callback

  function optional

  The callback parameter looks like: () => void

Returns

• Promise<void>
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

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).

• callback

  function optional

  The callback parameter looks like: () => void

Returns

• Promise<void>
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Parameters

• characteristicId

  string

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

• properties

  NotificationProperties optional

  Notification session properties (optional).

• callback

  function optional

  The callback parameter looks like: () => void

Returns

• Promise<void>
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Parameters

• characteristicId

  string

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

• callback

  function optional

  The callback parameter looks like: () => void

Returns

• Promise<void>
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Parameters

• advertisementId

  number

  Id of the advertisement to unregister.

• callback

  function optional

  The callback parameter looks like: () => void

Returns

• Promise<void>
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Parameters

• serviceId

  string

  Unique ID of a current registered service.

• callback

  function optional

  The callback parameter looks like: () => void

Returns

• Promise<void>
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

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.

• callback

  function optional

  The callback parameter looks like: () => void

Returns

• Promise<void>
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

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.

• callback

  function optional

  The callback parameter looks like: () => void

Returns

• Promise<void>
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Parameters

• callback

  function

  The callback parameter looks like: (request: Request, characteristicId: string) => void

  • request

    Request
  • characteristicId

    string

Parameters

• callback

  function

  The callback parameter looks like: (characteristic: Characteristic) => void

  • characteristic

    Characteristic

Parameters

• callback

  function

  The callback parameter looks like: (request: Request, characteristicId: string) => void

  • request

    Request
  • characteristicId

    string

Parameters

• callback

  function

  The callback parameter looks like: (request: Request, descriptorId: string) => void

  • request

    Request
  • descriptorId

    string

Parameters

• callback

  function

  The callback parameter looks like: (descriptor: Descriptor) => void

  • descriptor

    Descriptor

Parameters

• callback

  function

  The callback parameter looks like: (request: Request, descriptorId: string) => void

  • request

    Request
  • descriptorId

    string

Parameters

• callback

  function

  The callback parameter looks like: (service: Service) => void

  • service

    Service

Parameters

• callback

  function

  The callback parameter looks like: (service: Service) => void

  • service

    Service

Parameters

• callback

  function

  The callback parameter looks like: (service: Service) => void

  • service

    Service