| /* |
| * Copyright (C) 2009 The Android Open Source Project |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package android.bluetooth; |
| |
| import android.annotation.SdkConstant; |
| import android.annotation.SdkConstant.SdkConstantType; |
| import android.content.Context; |
| import android.os.IBinder; |
| import android.os.Parcel; |
| import android.os.Parcelable; |
| import android.os.RemoteException; |
| import android.os.ServiceManager; |
| import android.util.Log; |
| |
| import java.io.IOException; |
| import java.io.UnsupportedEncodingException; |
| |
| /** |
| * Represents a remote Bluetooth device. |
| * |
| * <p>Use {@link BluetoothAdapter#getRemoteDevice} to create a {@link |
| * BluetoothDevice}. |
| * |
| * <p>This class is really just a thin wrapper for a Bluetooth hardware |
| * address. Objects of this class are immutable. Operations on this class |
| * are performed on the remote Bluetooth hardware address, using the |
| * {@link BluetoothAdapter} that was used to create this {@link |
| * BluetoothDevice}. |
| */ |
| public final class BluetoothDevice implements Parcelable { |
| private static final String TAG = "BluetoothDevice"; |
| |
| /** |
| * 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: |
| * <p><code>Intent.getIntExtra(BluetoothDevice.EXTRA_BOND_STATE, |
| * BluetoothDevice.ERROR)</code> |
| */ |
| public static final int ERROR = Integer.MIN_VALUE; |
| |
| /** |
| * Broadcast Action: Remote device discovered. |
| * <p>Sent when a remote device is found during discovery. |
| * <p>Always contains the extra fields {@link #EXTRA_DEVICE} and {@link |
| * #EXTRA_CLASS}. Can contain the extra fields {@link #EXTRA_NAME} and/or |
| * {@link #EXTRA_RSSI} if they are available. |
| * <p>Requires {@link android.Manifest.permission#BLUETOOTH} to receive. |
| */ |
| // TODO: Change API to not broadcast RSSI if not available (incoming connection) |
| @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) |
| public static final String ACTION_FOUND = |
| "android.bluetooth.device.action.FOUND"; |
| |
| /** |
| * Broadcast Action: Remote device disappeared. |
| * <p>Sent when a remote device that was found in the last discovery is not |
| * found in the current discovery. |
| * <p>Always contains the extra field {@link #EXTRA_DEVICE}. |
| * <p>Requires {@link android.Manifest.permission#BLUETOOTH} to receive. |
| * @hide |
| */ |
| @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) |
| public static final String ACTION_DISAPPEARED = |
| "android.bluetooth.device.action.DISAPPEARED"; |
| |
| /** |
| * Broadcast Action: Bluetooth class of a remote device has changed. |
| * <p>Always contains the extra fields {@link #EXTRA_DEVICE} and {@link |
| * #EXTRA_CLASS}. |
| * <p>Requires {@link android.Manifest.permission#BLUETOOTH} to receive. |
| * @see {@link BluetoothClass} |
| */ |
| @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) |
| public static final String ACTION_CLASS_CHANGED = |
| "android.bluetooth.device.action.CLASS_CHANGED"; |
| |
| /** |
| * Broadcast Action: Indicates a low level (ACL) connection has been |
| * established with a remote device. |
| * <p>Always contains the extra field {@link #EXTRA_DEVICE}. |
| * <p>ACL connections are managed automatically by the Android Bluetooth |
| * stack. |
| * <p>Requires {@link android.Manifest.permission#BLUETOOTH} to receive. |
| */ |
| @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) |
| public static final String ACTION_ACL_CONNECTED = |
| "android.bluetooth.device.action.ACL_CONNECTED"; |
| |
| /** |
| * Broadcast Action: Indicates that a low level (ACL) disconnection has |
| * been requested for a remote device, and it will soon be disconnected. |
| * <p>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. |
| * <p>Always contains the extra field {@link #EXTRA_DEVICE}. |
| * <p>Requires {@link android.Manifest.permission#BLUETOOTH} to receive. |
| */ |
| @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) |
| public static final String ACTION_ACL_DISCONNECT_REQUESTED = |
| "android.bluetooth.device.action.ACL_DISCONNECT_REQUESTED"; |
| |
| /** |
| * Broadcast Action: Indicates a low level (ACL) disconnection from a |
| * remote device. |
| * <p>Always contains the extra field {@link #EXTRA_DEVICE}. |
| * <p>ACL connections are managed automatically by the Android Bluetooth |
| * stack. |
| * <p>Requires {@link android.Manifest.permission#BLUETOOTH} to receive. |
| */ |
| @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) |
| public static final String ACTION_ACL_DISCONNECTED = |
| "android.bluetooth.device.action.ACL_DISCONNECTED"; |
| |
| /** |
| * Broadcast Action: Indicates the friendly name of a remote device has |
| * been retrieved for the first time, or changed since the last retrieval. |
| * <p>Always contains the extra fields {@link #EXTRA_DEVICE} and {@link |
| * #EXTRA_NAME}. |
| * <p>Requires {@link android.Manifest.permission#BLUETOOTH} to receive. |
| */ |
| @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) |
| public static final String ACTION_NAME_CHANGED = |
| "android.bluetooth.device.action.NAME_CHANGED"; |
| |
| /** |
| * Broadcast Action: Indicates a change in the bond state of a remote |
| * device. For example, if a device is bonded (paired). |
| * <p>Always contains the extra fields {@link #EXTRA_DEVICE}, {@link |
| * #EXTRA_BOND_STATE} and {@link #EXTRA_PREVIOUS_BOND_STATE}. |
| * <p>Requires {@link android.Manifest.permission#BLUETOOTH} to receive. |
| */ |
| // Note: When EXTRA_BOND_STATE is BOND_NONE then this will also |
| // contain a hidden extra field EXTRA_REASON with the result code. |
| @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) |
| public static final String ACTION_BOND_STATE_CHANGED = |
| "android.bluetooth.device.action.BOND_STATE_CHANGED"; |
| |
| /** |
| * Used as a Parcelable {@link BluetoothDevice} extra field in every intent |
| * broadcast by this class. It contains the {@link BluetoothDevice} that |
| * the intent applies to. |
| */ |
| public static final String EXTRA_DEVICE = "android.bluetooth.device.extra.DEVICE"; |
| |
| /** |
| * Used as a String extra field in {@link #ACTION_NAME_CHANGED} and {@link |
| * #ACTION_FOUND} intents. It contains the friendly Bluetooth name. |
| */ |
| public static final String EXTRA_NAME = "android.bluetooth.device.extra.NAME"; |
| |
| /** |
| * Used as an optional short extra field in {@link #ACTION_FOUND} intents. |
| * Contains the RSSI value of the remote device as reported by the |
| * Bluetooth hardware. |
| */ |
| public static final String EXTRA_RSSI = "android.bluetooth.device.extra.RSSI"; |
| |
| /** |
| * Used as an Parcelable {@link BluetoothClass} extra field in {@link |
| * #ACTION_FOUND} and {@link #ACTION_CLASS_CHANGED} intents. |
| */ |
| public static final String EXTRA_CLASS = "android.bluetooth.device.extra.CLASS"; |
| |
| /** |
| * Used as an int extra field in {@link #ACTION_BOND_STATE_CHANGED} intents. |
| * Contains the bond state of the remote device. |
| * <p>Possible values are: |
| * {@link #BOND_NONE}, |
| * {@link #BOND_BONDING}, |
| * {@link #BOND_BONDED}. |
| */ |
| public static final String EXTRA_BOND_STATE = "android.bluetooth.device.extra.BOND_STATE"; |
| /** |
| * Used as an int extra field in {@link #ACTION_BOND_STATE_CHANGED} intents. |
| * Contains the previous bond state of the remote device. |
| * <p>Possible values are: |
| * {@link #BOND_NONE}, |
| * {@link #BOND_BONDING}, |
| * {@link #BOND_BONDED}. |
| */ |
| public static final String EXTRA_PREVIOUS_BOND_STATE = |
| "android.bluetooth.device.extra.PREVIOUS_BOND_STATE"; |
| /** |
| * Indicates the remote device is not bonded (paired). |
| * <p>There is no shared link key with the remote device, so communication |
| * (if it is allowed at all) will be unauthenticated and unencrypted. |
| */ |
| public static final int BOND_NONE = 10; |
| /** |
| * Indicates bonding (pairing) is in progress with the remote device. |
| */ |
| public static final int BOND_BONDING = 11; |
| /** |
| * Indicates the remote device is bonded (paired). |
| * <p>A shared link keys exists locally for the remote device, so |
| * communication can be authenticated and encrypted. |
| * <p><i>Being bonded (paired) with a remote device does not necessarily |
| * mean the device is currently connected. It just means that the ponding |
| * procedure was compeleted at some earlier time, and the link key is still |
| * stored locally, ready to use on the next connection. |
| * </i> |
| */ |
| public static final int BOND_BONDED = 12; |
| |
| /** @hide */ |
| public static final String EXTRA_REASON = "android.bluetooth.device.extra.REASON"; |
| /** @hide */ |
| public static final String EXTRA_PAIRING_VARIANT = |
| "android.bluetooth.device.extra.PAIRING_VARIANT"; |
| /** @hide */ |
| public static final String EXTRA_PASSKEY = "android.bluetooth.device.extra.PASSKEY"; |
| |
| /** |
| * Broadcast Action: Indicates a failure to retrieve the name of a remote |
| * device. |
| * <p>Always contains the extra field {@link #EXTRA_DEVICE}. |
| * <p>Requires {@link android.Manifest.permission#BLUETOOTH} to receive. |
| * @hide |
| */ |
| //TODO: is this actually useful? |
| @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) |
| public static final String ACTION_NAME_FAILED = |
| "android.bluetooth.device.action.NAME_FAILED"; |
| |
| /** @hide */ |
| @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) |
| public static final String ACTION_PAIRING_REQUEST = |
| "android.bluetooth.device.action.PAIRING_REQUEST"; |
| /** @hide */ |
| @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) |
| public static final String ACTION_PAIRING_CANCEL = |
| "android.bluetooth.device.action.PAIRING_CANCEL"; |
| |
| /** A bond attempt succeeded |
| * @hide */ |
| public static final int BOND_SUCCESS = 0; |
| /** A bond attempt failed because pins did not match, or remote device did |
| * not respond to pin request in time |
| * @hide */ |
| public static final int UNBOND_REASON_AUTH_FAILED = 1; |
| /** A bond attempt failed because the other side explicilty rejected |
| * bonding |
| * @hide */ |
| public static final int UNBOND_REASON_AUTH_REJECTED = 2; |
| /** A bond attempt failed because we canceled the bonding process |
| * @hide */ |
| public static final int UNBOND_REASON_AUTH_CANCELED = 3; |
| /** A bond attempt failed because we could not contact the remote device |
| * @hide */ |
| public static final int UNBOND_REASON_REMOTE_DEVICE_DOWN = 4; |
| /** A bond attempt failed because a discovery is in progress |
| * @hide */ |
| public static final int UNBOND_REASON_DISCOVERY_IN_PROGRESS = 5; |
| /** A bond attempt failed because of authentication timeout |
| * @hide */ |
| public static final int UNBOND_REASON_AUTH_TIMEOUT = 6; |
| /** A bond attempt failed because of repeated attempts |
| * @hide */ |
| public static final int UNBOND_REASON_REPEATED_ATTEMPTS = 7; |
| /** An existing bond was explicitly revoked |
| * @hide */ |
| public static final int UNBOND_REASON_REMOVED = 8; |
| |
| /** The user will be prompted to enter a pin |
| * @hide */ |
| public static final int PAIRING_VARIANT_PIN = 0; |
| /** The user will be prompted to enter a passkey |
| * @hide */ |
| public static final int PAIRING_VARIANT_PASSKEY = 1; |
| /** The user will be prompted to confirm the passkey displayed on the screen |
| * @hide */ |
| public static final int PAIRING_VARIANT_PASSKEY_CONFIRMATION = 2; |
| /** The user will be prompted to accept or deny the incoming pairing request |
| * @hide */ |
| public static final int PAIRING_VARIANT_CONSENT = 3; |
| /** The user will be prompted to enter the passkey displayed on remote device |
| * @hide */ |
| public static final int PAIRING_VARIANT_DISPLAY_PASSKEY = 4; |
| |
| private static IBluetooth sService; /* Guarenteed constant after first object constructed */ |
| |
| private final String mAddress; |
| |
| /** |
| * Create a new BluetoothDevice |
| * Bluetooth MAC address must be upper case, such as "00:11:22:33:AA:BB", |
| * and is validated in this constructor. |
| * @param address valid Bluetooth MAC address |
| * @throws RuntimeException Bluetooth is not available on this platform |
| * @throws IllegalArgumentException address is invalid |
| * @hide |
| */ |
| /*package*/ BluetoothDevice(String address) { |
| synchronized (BluetoothDevice.class) { |
| if (sService == null) { |
| IBinder b = ServiceManager.getService(Context.BLUETOOTH_SERVICE); |
| if (b == null) { |
| throw new RuntimeException("Bluetooth service not available"); |
| } |
| sService = IBluetooth.Stub.asInterface(b); |
| } |
| } |
| |
| if (!BluetoothAdapter.checkBluetoothAddress(address)) { |
| throw new IllegalArgumentException(address + " is not a valid Bluetooth address"); |
| } |
| |
| mAddress = address; |
| } |
| |
| @Override |
| public boolean equals(Object o) { |
| if (o instanceof BluetoothDevice) { |
| return mAddress.equals(((BluetoothDevice)o).getAddress()); |
| } |
| return false; |
| } |
| |
| @Override |
| public int hashCode() { |
| return mAddress.hashCode(); |
| } |
| |
| /** |
| * Returns a string representation of this BluetoothDevice. |
| * <p>Currently this is the Bluetooth hardware address, for example |
| * "00:11:22:AA:BB:CC". However, you should always use {@link #getAddress} |
| * if you explicitly require the Bluetooth hardware address in case the |
| * {@link #toString} representation changes in the future. |
| * @return string representation of this BluetoothDevice |
| */ |
| @Override |
| public String toString() { |
| return mAddress; |
| } |
| |
| /** @hide */ |
| public int describeContents() { |
| return 0; |
| } |
| |
| /** @hide */ |
| public static final Parcelable.Creator<BluetoothDevice> CREATOR = |
| new Parcelable.Creator<BluetoothDevice>() { |
| public BluetoothDevice createFromParcel(Parcel in) { |
| return new BluetoothDevice(in.readString()); |
| } |
| public BluetoothDevice[] newArray(int size) { |
| return new BluetoothDevice[size]; |
| } |
| }; |
| |
| /** @hide */ |
| public void writeToParcel(Parcel out, int flags) { |
| out.writeString(mAddress); |
| } |
| |
| /** |
| * Returns the hardware address of this BluetoothDevice. |
| * <p> For example, "00:11:22:AA:BB:CC". |
| * @return Bluetooth hardware address as string |
| */ |
| public String getAddress() { |
| return mAddress; |
| } |
| |
| /** |
| * Get the friendly Bluetooth name of the remote device. |
| * |
| * <p>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. |
| * <p>Requires {@link android.Manifest.permission#BLUETOOTH} |
| * |
| * @return the Bluetooth name, or null if there was a problem. |
| */ |
| public String getName() { |
| try { |
| return sService.getRemoteName(mAddress); |
| } catch (RemoteException e) {Log.e(TAG, "", e);} |
| return null; |
| } |
| |
| /** |
| * Start the bonding (pairing) process with the remote device. |
| * <p>This is an asynchronous call, it will return immediately. Register |
| * for {@link #ACTION_BOND_STATE_CHANGED} intents to be notified when |
| * the bonding process completes, and its result. |
| * <p>Android system services will handle the necessary user interactions |
| * to confirm and complete the bonding process. |
| * <p>Requires {@link android.Manifest.permission#BLUETOOTH_ADMIN}. |
| * |
| * @return false on immediate error, true if bonding will begin |
| */ |
| public boolean createBond() { |
| try { |
| return sService.createBond(mAddress); |
| } catch (RemoteException e) {Log.e(TAG, "", e);} |
| return false; |
| } |
| |
| /** |
| * Cancel an in-progress bonding request started with {@link #createBond}. |
| * <p>Requires {@link android.Manifest.permission#BLUETOOTH_ADMIN}. |
| * |
| * @return true on sucess, false on error |
| */ |
| public boolean cancelBondProcess() { |
| try { |
| return sService.cancelBondProcess(mAddress); |
| } catch (RemoteException e) {Log.e(TAG, "", e);} |
| return false; |
| } |
| |
| /** |
| * Remove bond (pairing) with the remote device. |
| * <p>Delete the link key associated with the remote device, and |
| * immediately terminate connections to that device that require |
| * authentication and encryption. |
| * <p>Requires {@link android.Manifest.permission#BLUETOOTH_ADMIN}. |
| * |
| * @return true on sucess, false on error |
| */ |
| public boolean removeBond() { |
| try { |
| return sService.removeBond(mAddress); |
| } catch (RemoteException e) {Log.e(TAG, "", e);} |
| return false; |
| } |
| |
| /** |
| * Get the bond state of the remote device. |
| * <p>Possible values for the bond state are: |
| * {@link #BOND_NONE}, |
| * {@link #BOND_BONDING}, |
| * {@link #BOND_BONDED}. |
| * <p>Requires {@link android.Manifest.permission#BLUETOOTH}. |
| * |
| * @return the bond state |
| */ |
| public int getBondState() { |
| try { |
| return sService.getBondState(mAddress); |
| } catch (RemoteException e) {Log.e(TAG, "", e);} |
| return BOND_NONE; |
| } |
| |
| /** |
| * Get the Bluetooth class of the remote device. |
| * <p>Requires {@link android.Manifest.permission#BLUETOOTH}. |
| * |
| * @return Bluetooth class object, or null on error |
| */ |
| public BluetoothClass getBluetoothClass() { |
| try { |
| int classInt = sService.getRemoteClass(mAddress); |
| if (classInt == BluetoothClass.ERROR) return null; |
| return new BluetoothClass(classInt); |
| } catch (RemoteException e) {Log.e(TAG, "", e);} |
| return null; |
| } |
| |
| /** |
| * Get trust state of a remote device. |
| * @hide |
| */ |
| public boolean getTrustState() { |
| try { |
| return sService.getTrustState(mAddress); |
| } catch (RemoteException e) { |
| Log.e(TAG, "", e); |
| } |
| return false; |
| } |
| |
| /** |
| * Set trust state for a remote device. |
| * @param value the trust state value (true or false) |
| * @hide |
| */ |
| public boolean setTrust(boolean value) { |
| try { |
| return sService.setTrust(mAddress, value); |
| } catch (RemoteException e) { |
| Log.e(TAG, "", e); |
| } |
| return false; |
| } |
| |
| /** @hide */ |
| public String[] getUuids() { |
| try { |
| return sService.getRemoteUuids(mAddress); |
| } catch (RemoteException e) {Log.e(TAG, "", e);} |
| return null; |
| } |
| |
| /** @hide */ |
| public int getServiceChannel(String uuid) { |
| try { |
| return sService.getRemoteServiceChannel(mAddress, uuid); |
| } catch (RemoteException e) {Log.e(TAG, "", e);} |
| return BluetoothDevice.ERROR; |
| } |
| |
| /** @hide */ |
| public boolean setPin(byte[] pin) { |
| try { |
| return sService.setPin(mAddress, pin); |
| } catch (RemoteException e) {Log.e(TAG, "", e);} |
| return false; |
| } |
| |
| /** @hide */ |
| public boolean setPasskey(int passkey) { |
| try { |
| return sService.setPasskey(mAddress, passkey); |
| } catch (RemoteException e) {Log.e(TAG, "", e);} |
| return false; |
| } |
| |
| /** @hide */ |
| public boolean setPairingConfirmation(boolean confirm) { |
| try { |
| return sService.setPairingConfirmation(mAddress, confirm); |
| } catch (RemoteException e) {Log.e(TAG, "", e);} |
| return false; |
| } |
| |
| /** @hide */ |
| public boolean cancelPairingUserInput() { |
| try { |
| return sService.cancelPairingUserInput(mAddress); |
| } catch (RemoteException e) {Log.e(TAG, "", e);} |
| return false; |
| } |
| |
| /** |
| * Create an RFCOMM {@link BluetoothSocket} ready to start a secure |
| * outgoing connection to this remote device. |
| * <p>The remote device will be authenticated and communication on this |
| * socket will be encrypted. |
| * <p>Use {@link BluetoothSocket#connect} to intiate the outgoing |
| * connection. |
| * <p>Valid RFCOMM channels are in range 1 to 30. |
| * <p>Requires {@link android.Manifest.permission#BLUETOOTH} |
| * |
| * @param channel RFCOMM channel to connect to |
| * @return a RFCOMM BluetoothServerSocket ready for an outgoing connection |
| * @throws IOException on error, for example Bluetooth not available, or |
| * insufficient permissions |
| */ |
| public BluetoothSocket createRfcommSocket(int channel) throws IOException { |
| return new BluetoothSocket(BluetoothSocket.TYPE_RFCOMM, -1, true, true, this, channel); |
| } |
| |
| /** |
| * Construct an insecure RFCOMM socket ready to start an outgoing |
| * connection. |
| * Call #connect on the returned #BluetoothSocket to begin the connection. |
| * The remote device will not be authenticated and communication on this |
| * socket will not be encrypted. |
| * @param port remote port |
| * @return An RFCOMM BluetoothSocket |
| * @throws IOException On error, for example Bluetooth not available, or |
| * insufficient permissions. |
| * @hide |
| */ |
| public BluetoothSocket createInsecureRfcommSocket(int port) throws IOException { |
| return new BluetoothSocket(BluetoothSocket.TYPE_RFCOMM, -1, false, false, this, port); |
| } |
| |
| /** |
| * Construct a SCO socket ready to start an outgoing connection. |
| * Call #connect on the returned #BluetoothSocket to begin the connection. |
| * @return a SCO BluetoothSocket |
| * @throws IOException on error, for example Bluetooth not available, or |
| * insufficient permissions. |
| * @hide |
| */ |
| public BluetoothSocket createScoSocket() throws IOException { |
| return new BluetoothSocket(BluetoothSocket.TYPE_SCO, -1, true, true, this, -1); |
| } |
| |
| /** |
| * Check that a pin is valid and convert to byte array. |
| * |
| * Bluetooth pin's are 1 to 16 bytes of UTF8 characters. |
| * @param pin pin as java String |
| * @return the pin code as a UTF8 byte array, or null if it is an invalid |
| * Bluetooth pin. |
| * @hide |
| */ |
| public static byte[] convertPinToBytes(String pin) { |
| if (pin == null) { |
| return null; |
| } |
| byte[] pinBytes; |
| try { |
| pinBytes = pin.getBytes("UTF8"); |
| } catch (UnsupportedEncodingException uee) { |
| Log.e(TAG, "UTF8 not supported?!?"); // this should not happen |
| return null; |
| } |
| if (pinBytes.length <= 0 || pinBytes.length > 16) { |
| return null; |
| } |
| return pinBytes; |
| } |
| |
| } |