This API is available on Firefox OS for internal applications only.
The BluetoothDevice
interface of the Web Bluetooth API provides information regarding a given Bluetooth device.
Interface overview
[CheckPermissions="bluetooth"] interface BluetoothDevice: EventTarget { readonly attribute DOMString address; readonly attribute BluetoothClassOfDevice cod; readonly attribute DOMString name; readonly attribute boolean paired; [Cached, Pure] readonly attribute sequence<DOMString> uuids; readonly attribute BluetoothDeviceType type; readonly attribute BluetoothGatt? gatt; attribute EventHandler onattributechanged; [NewObject] Promise<sequence<DOMString>> fetchUuids(); };
Properties
BluetoothDevice.address
Read only- A string representing the address of the device on the Bluetooth micro-network.
BluetoothDevice.cod
Read only- Returns a
BluetoothClassOfDevice
object containing information about the device's capabilities. BluetoothDevice.gatt
Read only- Returns a
BluetoothGatt
object that allows JavaScript to conduct GATT client operations on a remote LE device. This property will returnnull
for devices of type classic or unknown. BluetoothDevice.name
Read only- The human readable name of the device.
BluetoothDevice.paired
Read only- A boolean indicating if the device is paired to the adapter (
true
) or not (false
). BluetoothDevice.services
Read only- An
Array
of strings indicating what kind of Bluetooth services the device is able to provide. BluetoothDevice.type
Read only- Returns the device type of the remote device.
BluetoothDevice.uuids
Read only- An
Array
of strings indicating the UUIDs of each Bluetooth service the device is able to provide.
Event handlers
BluetoothDevice.onattributechanged
- Defines a handler for the
attributechanged
event; triggers when a remote device's properties have changed (has aBluetoothAttributeEvent
as a parameter.)
Obsolete properties
BluetoothDevice.class
Read only- A number representing the Bluetooth "Class of Device" number for the device.
BluetoothDevice.connected
Read only- A boolean indicating if the device is connected to the adapter (
true
) or not (false
). BluetoothDevice.icon
Read only- A string indicating which kind of icon could be used to represent the device.
Methods
BluetoothDevice.fetchUuids()
- Fetches the up-to-date UUID list of services that the device provides. If the operation succeeds, an
BluetoothDevice_%28Firefox_OS%29.onattributechanged
is triggered right before the Promise is resolved to indicateBluetoothDevice.uuids
has changed.
Specifications
Specification | Status | Comment |
---|---|---|
Web Bluetooth The definition of 'BluetoothDevice' 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 |
---|---|---|---|---|---|---|---|---|
Bluetooth v2 support: cod , type , gatt , onattributechanged , fetchUuids() |
No support | No support | No support | 2.1 | No support | No support | No support | No support |
Initial bluetooth support: address , connected , class , icon , name , paired , uuids |
No support | No support | No support | 1.0.1 | No support | No support | No support | No support |