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

JavaScript
[CheckPermissions="bluetooth"]
interface BluetoothLeDeviceEvent : Event
{
  readonly attribute <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothDevice#BluetoothDevice" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothDevice">BluetoothDevice</a> <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothDeviceEvent#device" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothDeviceEvent">device</a>;
  readonly attribute short <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothLeDeviceEvent#rssi" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothLeDeviceEvent">rssi</a>;
  readonly attribute ArrayBuffer <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothLeDeviceEvent#scanRecord" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothLeDeviceEvent">scanRecord</a>;
};

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

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support No support No support No support No support No support
Feature Android Android Webview Firefox Mobile (Gecko) Firefox OS IE Mobile Opera Mobile Safari Mobile Chrome for Android
Basic support No support No support No support 2.1 No support No support No support No support

 

See also

Using the Web Bluetooth API

License

© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/bluetoothledeviceevent

API B2G Bluetooth BluetoothLeDeviceEvent Certified Firefox OS Interface Non-standard Reference Web Bluetooth