ACTION_ACL_CONNECTED

String ACTION_ACL_CONNECTED

Broadcast Action: Indicates a low level (ACL) connection has been established with a remote device.

Always contains the extra field


EXTRA_DEVICE


.

ACL connections are managed automatically by the Android Bluetooth stack.

Requires


BLUETOOTH


to receive.

Constant Value: “android.bluetooth.device.action.ACL_CONNECTED”

ACTION_ACL_DISCONNECTED

String ACTION_ACL_DISCONNECTED

Broadcast Action: Indicates a low level (ACL) disconnection from a remote device.

Always contains the extra field


EXTRA_DEVICE


.

ACL connections are managed automatically by the Android Bluetooth stack.

Requires


BLUETOOTH


to receive.

Constant Value: “android.bluetooth.device.action.ACL_DISCONNECTED”

ACTION_ACL_DISCONNECT_REQUESTED

String ACTION_ACL_DISCONNECT_REQUESTED

Broadcast Action: Indicates that a low level (ACL) disconnection has been requested for a remote device, and it will soon be disconnected.

This is useful for graceful disconnection. Applications should use this intent as a hint to immediately terminate higher level connections (RFCOMM, L2CAP, or profile connections) to the remote device.

Always contains the extra field


EXTRA_DEVICE


.

Requires


BLUETOOTH


to receive.

Constant Value: “android.bluetooth.device.action.ACL_DISCONNECT_REQUESTED”

ACTION_BOND_STATE_CHANGED

String ACTION_BOND_STATE_CHANGED

Broadcast Action: Indicates a change in the bond state of a remote device. For example, if a device is bonded (paired).

Always contains the extra fields


EXTRA_DEVICE


,


EXTRA_BOND_STATE


and


EXTRA_PREVIOUS_BOND_STATE


.

Requires


BLUETOOTH


to receive.

Constant Value: “android.bluetooth.device.action.BOND_STATE_CHANGED”

ACTION_CLASS_CHANGED

String ACTION_CLASS_CHANGED

Broadcast Action: Bluetooth class of a remote device has changed.

Always contains the extra fields


EXTRA_DEVICE


and


EXTRA_CLASS


.

Requires


BLUETOOTH


to receive.

Constant Value: “android.bluetooth.device.action.CLASS_CHANGED”

ACTION_FOUND

String ACTION_FOUND

Broadcast Action: Remote device discovered.

Sent when a remote device is found during discovery.

Always contains the extra fields


EXTRA_DEVICE


and


EXTRA_CLASS


. Can contain the extra fields


EXTRA_NAME


and/or


EXTRA_RSSI


if they are available.

Requires


BLUETOOTH


and


ACCESS_COARSE_LOCATION


to receive.

Constant Value: “android.bluetooth.device.action.FOUND”

ACTION_NAME_CHANGED

String ACTION_NAME_CHANGED

Broadcast Action: Indicates the friendly name of a remote device has been retrieved for the first time, or changed since the last retrieval.

Always contains the extra fields


EXTRA_DEVICE


and


EXTRA_NAME


.

Requires


BLUETOOTH


to receive.

Constant Value: “android.bluetooth.device.action.NAME_CHANGED”

ACTION_PAIRING_REQUEST

String ACTION_PAIRING_REQUEST

Broadcast Action: This intent is used to broadcast PAIRING REQUEST

Requires


BLUETOOTH_ADMIN


to receive.

Constant Value: “android.bluetooth.device.action.PAIRING_REQUEST”

ACTION_UUID

String ACTION_UUID

Broadcast Action: This intent is used to broadcast the


UUID


wrapped as a


ParcelUuid


of the remote device after it has been fetched. This intent is sent only when the UUIDs of the remote device are requested to be fetched using Service Discovery Protocol

Always contains the extra field


EXTRA_DEVICE



Always contains the extra field


EXTRA_UUID



Requires


BLUETOOTH


to receive.

Constant Value: “android.bluetooth.device.action.UUID”

BOND_BONDED

int BOND_BONDED

Indicates the remote device is bonded (paired).

A shared link keys exists locally for the remote device, so communication can be authenticated and encrypted.

Being bonded (paired) with a remote device does not necessarily mean the device is currently connected. It just means that the pending procedure was completed at some earlier time, and the link key is still stored locally, ready to use on the next connection.

Constant Value: 12 (0x0000000c)

BOND_BONDING

int BOND_BONDING

Indicates bonding (pairing) is in progress with the remote device.

Constant Value: 11 (0x0000000b)

BOND_NONE

int BOND_NONE

Indicates the remote device is not bonded (paired).

There is no shared link key with the remote device, so communication (if it is allowed at all) will be unauthenticated and unencrypted.

Constant Value: 10 (0x0000000a)

DEVICE_TYPE_CLASSIC

int DEVICE_TYPE_CLASSIC

Bluetooth device type, Classic – BR/EDR devices

Constant Value: 1 (0x00000001)

DEVICE_TYPE_DUAL

int DEVICE_TYPE_DUAL

Bluetooth device type, Dual Mode – BR/EDR/LE

Constant Value: 3 (0x00000003)

DEVICE_TYPE_LE

int DEVICE_TYPE_LE

Bluetooth device type, Low Energy – LE-only

Constant Value: 2 (0x00000002)

DEVICE_TYPE_UNKNOWN

int DEVICE_TYPE_UNKNOWN

Bluetooth device type, Unknown

Constant Value: 0 (0x00000000)

ERROR

int ERROR

Sentinel error value for this class. Guaranteed to not equal any other integer constant in this class. Provided as a convenience for functions that require a sentinel error value, for example:


Intent.getIntExtra(BluetoothDevice.EXTRA_BOND_STATE, BluetoothDevice.ERROR)


Constant Value: -2147483648 (0x80000000)

EXTRA_BOND_STATE

String EXTRA_BOND_STATE

Used as an int extra field in


ACTION_BOND_STATE_CHANGED


intents. Contains the bond state of the remote device.

Possible values are:


BOND_NONE


,


BOND_BONDING


,


BOND_BONDED


.

Constant Value: “android.bluetooth.device.extra.BOND_STATE”

EXTRA_CLASS

String EXTRA_CLASS

Used as a Parcelable


BluetoothClass


extra field in


ACTION_FOUND


and


ACTION_CLASS_CHANGED


intents.

Constant Value: “android.bluetooth.device.extra.CLASS”

EXTRA_DEVICE

String EXTRA_DEVICE

Used as a Parcelable


BluetoothDevice


extra field in every intent broadcast by this class. It contains the


BluetoothDevice


that the intent applies to.

Constant Value: “android.bluetooth.device.extra.DEVICE”

EXTRA_NAME

String EXTRA_NAME

Used as a String extra field in


ACTION_NAME_CHANGED


and


ACTION_FOUND


intents. It contains the friendly Bluetooth name.

Constant Value: “android.bluetooth.device.extra.NAME”

EXTRA_PAIRING_KEY

String EXTRA_PAIRING_KEY

Used as an int extra field in


ACTION_PAIRING_REQUEST


intents as the value of passkey.

Constant Value: “android.bluetooth.device.extra.PAIRING_KEY”

EXTRA_PAIRING_VARIANT

String EXTRA_PAIRING_VARIANT

Used as an int extra field in


ACTION_PAIRING_REQUEST


intents to indicate pairing method used. Possible values are:


PAIRING_VARIANT_PIN


,


PAIRING_VARIANT_PASSKEY_CONFIRMATION


,

Constant Value: “android.bluetooth.device.extra.PAIRING_VARIANT”

EXTRA_PREVIOUS_BOND_STATE

String EXTRA_PREVIOUS_BOND_STATE

Used as an int extra field in


ACTION_BOND_STATE_CHANGED


intents. Contains the previous bond state of the remote device.

Possible values are:


BOND_NONE


,


BOND_BONDING


,


BOND_BONDED


.

Constant Value: “android.bluetooth.device.extra.PREVIOUS_BOND_STATE”

EXTRA_RSSI

String EXTRA_RSSI

Used as an optional short extra field in


ACTION_FOUND


intents. Contains the RSSI value of the remote device as reported by the Bluetooth hardware.

Constant Value: “android.bluetooth.device.extra.RSSI”

EXTRA_UUID

String EXTRA_UUID

Used as an extra field in


ACTION_UUID


intents, Contains the


ParcelUuid


s of the remote device which is a parcelable version of


UUID


.

Constant Value: “android.bluetooth.device.extra.UUID”

PAIRING_VARIANT_PASSKEY_CONFIRMATION

int PAIRING_VARIANT_PASSKEY_CONFIRMATION

The user will be prompted to confirm the passkey displayed on the screen or an app will confirm the passkey for the user.

Constant Value: 2 (0x00000002)

PAIRING_VARIANT_PIN

int PAIRING_VARIANT_PIN

The user will be prompted to enter a pin or an app will enter a pin for user.

Constant Value: 0 (0x00000000)

CREATOR

Creator<BluetoothDevice> CREATOR

connectGatt

BluetoothGatt connectGatt (Context context, 
                boolean autoConnect, 
                BluetoothGattCallback callback)

Connect to GATT Server hosted by this device. Caller acts as GATT client. The callback is used to deliver results to Caller, such as connection status as well as any further GATT client operations. The method returns a BluetoothGatt instance. You can use BluetoothGatt to conduct GATT client operations.

createBond

boolean createBond ()

Start the bonding (pairing) process with the remote device.

This is an asynchronous call, it will return immediately. Register for


ACTION_BOND_STATE_CHANGED


intents to be notified when the bonding process completes, and its result.

Android system services will handle the necessary user interactions to confirm and complete the bonding process.

Requires


BLUETOOTH_ADMIN


.

createInsecureRfcommSocketToServiceRecord

BluetoothSocket createInsecureRfcommSocketToServiceRecord (UUID uuid)

Create an RFCOMM


BluetoothSocket


socket ready to start an insecure outgoing connection to this remote device using SDP lookup of uuid.

The communication channel will not have an authenticated link key i.e it will be subject to man-in-the-middle attacks. For Bluetooth 2.1 devices, the link key will be encrypted, as encryption is mandatory. For legacy devices (pre Bluetooth 2.1 devices) the link key will be not be encrypted. Use


createRfcommSocketToServiceRecord(UUID)


if an encrypted and authenticated communication channel is desired.

This is designed to be used with


listenUsingInsecureRfcommWithServiceRecord(String, UUID)


for peer-peer Bluetooth applications.

Use


connect()


to initiate the outgoing connection. This will also perform an SDP lookup of the given uuid to determine which channel to connect to.

The remote device will be authenticated and communication on this socket will be encrypted.

Hint: If you are connecting to a Bluetooth serial board then try using the well-known SPP UUID 00001101-0000-1000-8000-00805F9B34FB. However if you are connecting to an Android peer then please generate your own unique UUID.

Requires


BLUETOOTH



createRfcommSocketToServiceRecord

BluetoothSocket createRfcommSocketToServiceRecord (UUID uuid)

Create an RFCOMM


BluetoothSocket


ready to start a secure outgoing connection to this remote device using SDP lookup of uuid.

This is designed to be used with


listenUsingRfcommWithServiceRecord(String, UUID)


for peer-peer Bluetooth applications.

Use


connect()


to initiate the outgoing connection. This will also perform an SDP lookup of the given uuid to determine which channel to connect to.

The remote device will be authenticated and communication on this socket will be encrypted.

Use this socket only if an authenticated socket link is possible. Authentication refers to the authentication of the link key to prevent man-in-the-middle type of attacks. For example, for Bluetooth 2.1 devices, if any of the devices does not have an input and output capability or just has the ability to display a numeric key, a secure socket connection is not possible. In such a case, use {#link createInsecureRfcommSocketToServiceRecord}. For more details, refer to the Security Model section 5.2 (vol 3) of Bluetooth Core Specification version 2.1 + EDR.

Hint: If you are connecting to a Bluetooth serial board then try using the well-known SPP UUID 00001101-0000-1000-8000-00805F9B34FB. However if you are connecting to an Android peer then please generate your own unique UUID.

Requires


BLUETOOTH



describeContents

int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance’s marshaled representation. For example, if the object will include a file descriptor in the output of


writeToParcel(Parcel, int)


, the return value of this method must include the


CONTENTS_FILE_DESCRIPTOR


bit.

equals

boolean equals (Object o)

Indicates whether some other object is “equal to” this one.

The

equals

method implements an equivalence relation on non-null object references:

• It is
  
  reflexive
  
  : for any non-null reference value
  
x

  ,
  
x.equals(x)

  should return
  
true

  .
• It is
  
  symmetric
  
  : for any non-null reference values
  
x

  and
  
y

  ,
  
x.equals(y)

  should return
  
true

  if and only if
  
y.equals(x)

  returns
  
true

  .
• It is
  
  transitive
  
  : for any non-null reference values
  
x

  ,
  
y

  , and
  
z

  , if
  
x.equals(y)

  returns
  
true

  and
  
y.equals(z)

  returns
  
true

  , then
  
x.equals(z)

  should return
  
true

  .
• It is
  
  consistent
  
  : for any non-null reference values
  
x

  and
  
y

  , multiple invocations of
  
x.equals(y)

  consistently return
  
true

  or consistently return
  
false

  , provided no information used in
  
equals

  comparisons on the objects is modified.
• For any non-null reference value
  
x

  ,
  
x.equals(null)

  should return
  
false

  .

The

equals

method for class

Object

implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values

x

and

y

, this method returns

true

if and only if

x

and

y

refer to the same object (

x == y

has the value

true

).

Note that it is generally necessary to override the

hashCode

method whenever this method is overridden, so as to maintain the general contract for the

hashCode

method, which states that equal objects must have equal hash codes.

fetchUuidsWithSdp

boolean fetchUuidsWithSdp ()

Perform a service discovery on the remote device to get the UUIDs supported.

This API is asynchronous and


ACTION_UUID


intent is sent, with the UUIDs supported by the remote end. If there is an error in getting the SDP records or if the process takes a long time,


ACTION_UUID


intent is sent with the UUIDs that is currently present in the cache. Clients should use the


getUuids()


to get UUIDs if service discovery is not to be performed.

Requires


BLUETOOTH


.

getAddress

String getAddress ()

Returns the hardware address of this BluetoothDevice.

For example, “00:11:22:AA:BB:CC”.

getBluetoothClass

BluetoothClass getBluetoothClass ()

Get the Bluetooth class of the remote device.

Requires


BLUETOOTH


.

getBondState

int getBondState ()

Get the bond state of the remote device.

Possible values for the bond state are:


BOND_NONE


,


BOND_BONDING


,


BOND_BONDED


.

Requires


BLUETOOTH


.

getName

String getName ()

Get the friendly Bluetooth name of the remote device.

The local adapter will automatically retrieve remote names when performing a device scan, and will cache them. This method just returns the name for this device from the cache.

Requires


BLUETOOTH



getType

int getType ()

Get the Bluetooth device type of the remote device.

Requires


BLUETOOTH



getUuids

ParcelUuid[] getUuids ()

Returns the supported features (UUIDs) of the remote device.

This method does not start a service discovery procedure to retrieve the UUIDs from the remote device. Instead, the local cached copy of the service UUIDs are returned.

Use


fetchUuidsWithSdp()


if fresh UUIDs are desired.

Requires


BLUETOOTH


.

hashCode

int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by


HashMap


.

The general contract of

hashCode

is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the
  
hashCode

  method must consistently return the same integer, provided no information used in
  
equals

  comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the
  
equals(Object)

  method, then calling the
  
hashCode

  method on each of the two objects must produce the same integer result.
• It is
  
  not
  
  required that if two objects are unequal according to the
  

equals(java.lang.Object)


  method, then calling the
  
hashCode

  method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class

Object

does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java


^TM


programming language.)

setPairingConfirmation

boolean setPairingConfirmation (boolean confirm)

Confirm passkey for


PAIRING_VARIANT_PASSKEY_CONFIRMATION


pairing.

Requires


BLUETOOTH_ADMIN


.

setPin

boolean setPin (byte[] pin)

Set the pin during pairing when the pairing method is


PAIRING_VARIANT_PIN



Requires


BLUETOOTH_ADMIN


.

toString

String toString ()

Returns a string representation of this BluetoothDevice.

Currently this is the Bluetooth hardware address, for example “00:11:22:AA:BB:CC”. However, you should always use


getAddress()


if you explicitly require the Bluetooth hardware address in case the


toString()


representation changes in the future.

writeToParcel

void writeToParcel (Parcel out, 
                int flags)

Flatten this object in to a Parcel.