B2G OS

BluetoothLeDeviceEvent (Firefox OS)

This API is available on Firefox OS for internal applications only.

The BluetoothLeDeviceEvent interface of the Web Bluetooth API provides access to an LE device BluetoothDevice object and its RSSI value and advertisement record, as the parameter of a devicefound event handler (see BluetoothDiscoveryHandle.ondevicefound), when fired.

Interface overview

[CheckPermissions="bluetooth"]
interface BluetoothLeDeviceEvent : Event
{
  readonly attribute BluetoothDevice device;
  readonly attribute short rssi;
  readonly attribute ArrayBuffer scanRecord;
};

Properties

BluetoothLeDeviceEvent.device Read only
Returns a BluetoothDevice representing the discovered remote LE device.
BluetoothLeDeviceEvent.rssi Read only
Returns the RSSI value for the remote LE device as reported by the bluetooth hardware. The value is given as 0 if no RSSI value is available.
BluetoothLeDeviceEvent.scanRecord Read only
Returns an ArrayBuffer representing the content of the advertisement record offered by the remote LE device.

Methods

None.

Specifications

Specification Status Comment
Web Bluetooth
The definition of 'BluetoothLeDeviceEvent' in that specification.
Draft Rough draft; not part of any official specification yet. It should be discussed as part of the W3C's System Applications Working Group.

Browser Compatibility

Supported in Firefox OS 2.1

See also

Using the Web Bluetooth API

Document Tags and Contributors

Contributors to this page: fscholz, chrisdavidmills
Last updated by: fscholz,