Android Debug Bridge
In this document
- Enabling adb Debugging启用USB调试
- Syntax语法
- Commands命令
- Querying for Emulator/Device Instances查看连接的Android
- Directing Commands to a Specific Emulator/Device Instance指定连接的Android
- Installing an Application安装APP
- Forwarding Ports映射端口
- Copying Files to or from an Emulator/Device InstancePC/Android文件传输
- Stopping the adb Server停止adb 服务
- Wireless usage无线连接使用
Android Debug Bridge (adb)安卓调试桥 is a versatile command line tool that lets you communicate with anemulator instance or connected Android-powered device. It is a client-server program that includesthree components:
- A client, which runs on your development machine. You can invoke a client from a shellby issuing an adb command. Other Android tools such as the ADT plugin and DDMS also createadb clients.
- A server, which runs as a background process on your development machine. The servermanages communication between the client and the adb daemon running on an emulator or device.
- A daemon, which runs as a background process on each emulator or device instance.
You can find the adb
tool in <sdk>/platform-tools/
.
When you start an adb client, the client first checks whether there is an adb serverprocess already running. If there isn't, it starts the server process. When the server starts,it binds to local TCP port 5037 and listens for commands sent from adb clients—all adbclients use port 5037 to communicate with the adb server.C/S架构,所有的adb客户端通过5037端口与服务端通信
The server then sets up connections to all running emulator/device instances. It locates emulator/device instances by scanning odd-numbered ports in the range 5555 to 5585, the range used by emulators/devices. Where the server finds an adb daemon, it sets up a connection to that port. Note that each emulator/device instance acquires a pair of sequential ports — an even-numbered port for console connections and an odd-numbered port for adb connections. For example:
Emulator 1, console: 5554 监听端口偶数
Emulator 1, adb: 5555 adb端口奇数5555~5585
Emulator 2, console: 5556
Emulator 2, adb: 5557
and so on...
As shown, the emulator instance connected to adb on port 5555 is the same as the instance whose console listens on port 5554.
Once the server has set up connections to all emulator instances, you can use adb commands toaccess those instances. Because the server manages connections to emulator/deviceinstances and handles commands from multiple adb clients, you can control any emulator/deviceinstance from any client (or from a script).
Enabling adb Debugging
In order to use adb with a device connected over USB, you must enableUSB debugging in the device system settings, underDeveloper options.
On Android 4.2 and higher, the Developer options screen ishidden by default. To make it visible, go toSettings > About phone and tapBuild number seven times. Return to the previousscreen to findDeveloper options at the bottom.
On some devices, the Developer options screen may be located or named differently.
Note: When you connect a device running Android 4.2.2 or higherto your computer, the system shows a dialog asking whether to accept an RSA key that allows debugging through this computer. This security mechanism protects user devices because it ensuresthat USB debugging and other adb commands cannot be executed unless you're able to unlock thedevice and acknowledge the dialog. This requires that you have adb version 1.0.31 (available withSDK Platform-tools r16.0.1 and higher) in order to debug on a device running Android 4.2.2 orhigher.
For more information about connecting to a device over USB, readUsing Hardware Devices.
连接adb的前提是开启USB调试,Android 4.2.2以上为了设备安全,开启USB调试后还需要手动同意关于RSK key的对话框,若未同意对话框,则提示如:
error: device unauthorized. Please check the confirmation dialog on your device.
Syntax
You can issue adb commands from a command line on your development machine or from a script.The usage is:
adb [-d|-e|-s <serialNumber>] <command> 语法
If there's only one emulator running or only one device connected, the adb command issent to that device by default. If multiple emulators are running and/or multiple devices areattached, you need to use the-d
,-e
, or -s
option to specify the target device to which the command should be directed.
Commands
The table below lists all of the supported adb commands and explains their meaning and usage.
Table 1. Available adb commands
Category | Command | Description | Comments |
---|---|---|---|
Target Device 目标设备,当PC连接多台Android设备时需要指定 | -d | Direct an adb command to the only attached USB device. | Returns an error if more than one USB device is attached. |
-e | Direct an adb command to the only running emulator instance. | Returns an error if more than one emulator instance is running. | |
-s <serialNumber> | Direct an adb command a specific emulator/device instance, referred to by its adb-assigned serial number (such as "emulator-5556"). | See DirectingCommands to a Specific Emulator/Device Instance. | |
General 一般 | devices | Prints a list of all attached emulator/device instances. | See Querying for Emulator/Device Instances for more information. |
help | Prints a list of supported adb commands. | ||
version | Prints the adb version number. | ||
Debug 调试 | logcat [option] [filter-specs] | Prints log data to the screen. | |
| Prints dumpsys , dumpstate , and logcat data to the screen, for the purposes of bug reporting. | ||
jdwp | Prints a list of available JDWP processes on a given device. | You can use the forward jdwp:<pid> port-forwarding specification to connect to a specific JDWP process. For example:adb forward tcp:8000 jdwp:472 jdb -attach localhost:8000 | |
Data 数据 | install <path-to-apk> | Pushes an Android application (specified as a full path to an .apk file) to an emulator/device. | |
pull <remote> <local> | Copies a specified file from an emulator/device instance to your development computer. | ||
push <local> <remote> | Copies a specified file from your development computer to an emulator/device instance. | ||
Ports and Networking 端口/网络 | forward <local> <remote> | Forwards socket connections from a specified local port to a specified remote port on the emulator/device instance. | Port specifications can use these schemes:
|
ppp <tty> [parm]... | Run PPP over USB.
Note that you should not automatically start a PPP connection. | ||
Scripting 脚本 | get-serialno | Prints the adb instance serial number string. | See Querying for Emulator/Device Instances for more information. |
get-state | Prints the adb state of an emulator/device instance. | ||
wait-for-device | Blocks execution until the device is online — that is, until the instance state isdevice . | You can prepend this command to other adb commands, in which case adb will wait until the emulator/device instance is connected before issuing the other commands. Here's an example: adb wait-for-device shell getpropNote that this command does not cause adb to wait until the entire system is fully booted. For that reason, you should not prepend it to other commands that require a fully booted system. As an example, the install requires the Android package manager, which is available only after the system is fully booted. A command such as adb wait-for-device install <app>.apkwould issue the install command as soon as the emulator or device instance connected to the adb server, but before the Android system was fully booted, so it would result in an error. | |
Server 服务 | start-server | Checks whether the adb server process is running and starts it, if not. | |
kill-server | Terminates the adb server process. | ||
Shell | shell | Starts a remote shell in the target emulator/device instance. | See ADB Shell Commands for more information. |
shell [shellCommand] | Issues a shell command in the target emulator/device instance and then exits the remote shell. |
下列详情:
Querying for Emulator/Device Instances
Before issuing adb commands, it is helpful to know what emulator/device instances are connected to the adb server. You can generate a list of attached emulators/devices using thedevices
command:
adb devices
In response, adb prints this status information for each instance:
- Serial number — A string created by adb to uniquely identify an emulator/device instance by its console port number. The format of the serial number is
<type>-<consolePort>
. Here's an example serial number:emulator-5554
- State — The connection state of the instance may be one of the following:
offline
— the instance is not connected to adb or is not responding.device
— the instance is now connected to the adb server. Note that this state does not imply that the Android system is fully booted and operational, since the instance connects to adb while the system is still booting. However, after boot-up, this is the normal operational state of an emulator/device instance.no device
— there is no emulator/device connected.
The output for each instance is formatted like this:
[serialNumber] [state]
Here's an example showing the devices
command and its output:
adb devices List of devices attached emulator-5554 device emulator-5556 device emulator-5558 device
Directing Commands to a Specific Emulator/Device Instance
If multiple emulator/device instances are running, you must specify a target instancewhen issuing adb commands. To do so, use the-s
option in the commands. The usagefor the-s
option is:
adb -s <serialNumber> <command>
As shown, you specify the target instance for a command using its adb-assigned serial number.You can use thedevices
command to obtain the serial numbers of runningemulator/device instances. For example:
adb -s emulator-5556 install helloWorld.apk
Note that, if you issue a command without specifying a target emulator/device instancewhile multiple devices are available, adb generates an error.
If you have multiple devices available (hardware or emulated), but only one is an emulator,simply use the-e
option to send commands to the emulator. Likewise if there's multipledevices but only one hardware device attached, use the-d
option to send commands tothe hardware device.
Installing an Application
You can use adb to copy an application from your development computer and install it on an emulator/device instance. To do so, use theinstall
command. With the command, you must specify the path to the .apk file that you want to install:
adb install <path_to_apk>
For more information about how to create an .apk file that you can install on an emulator/deviceinstance, seeBuilding and Running
Note that, if you are using the Eclipse IDE and have the ADT plugin installed, you do not need to use adb (or aapt) directly to install your application on the emulator/device. Instead, the ADT plugin handles the packaging and installation of the application for you.
Forwarding Ports
You can use the forward
command to set up arbitrary port forwarding — forwarding of requests on a specific host port to a different port on an emulator/device instance. Here's how you would set up forwarding of host port 6100 to emulator/device port 7100:
adb forward tcp:6100 tcp:7100
You can also use adb to set up forwarding to named abstract UNIX domain sockets, as illustrated here:
adb forward tcp:6100 local:logd
Copying Files to or from an Emulator/Device Instance
You can use the adb commands pull
and push
to copy files toand from an emulator/device instance. Unlike theinstall
command,which only copies an APK file to a specific location, thepull
andpush
commands let you copy arbitrary directories and files to any location in anemulator/device instance.
To copy a file or directory (and its sub-directories) from the emulator or device, use
adb pull <remote> <local>
To copy a file or directory (and its sub-directories) to the emulator or device, use
adb push <local> <remote>
In the commands, <local>
and <remote>
refer to thepaths to the target files/directory on your development machine (local) and on theemulator/device instance (remote). For example:
adb push foo.txt /sdcard/foo.txt
Stopping the adb Server
In some cases, you might need to terminate the adb server process and then restart itto resolve the problem (e.g., if adb does not respond to a command).
To stop the adb server, use the kill-server
command.You can then restart the server by issuing any other adb command.
Wireless usage 无线连接使用
adb is usually used over USB. However, it is also possible to use overWi-Fi, as described here.
-
Connect your Android device and adb host computerto a common Wi-Fi network accessible to both.We have found that not all access pointsare suitable; you may need to use an access pointwhose firewall is configured properly to support adb.
Note: If you are attempting to connectto a Wear device, force it to connect to Wi-Fi by shutting off Bluetoothon the phone connected to it.
- Connect the device to the host computer with a USB cable.
- Set the target device to listen for a TCP/IP connection on port 5555.
$ adb tcpip 5555
- Disconnect the USB cable from the target device.
- Find the IP address of the Android device. For example, on a Nexus device, you can findthe IP address atSettings >About tablet(or About phone) >Status >IP address. Or,on an Android Wear device, you can find the IP address atSettings >Wi-Fi Settings >Advanced >IP address.
- Connect to the device, identifying it by IP address.
$ adb connect <device-ip-address>
- Confirm that your host computer is connected to the target device:
$ adb devices List of devices attached <device-ip-address>:5555 device
You're now good to go!
If the adb connection is ever lost:
- Make sure that your host is still connected to the same Wi-Fi network your Android device is.
- Reconnect by executing the "adb connect" step again.
- Or if that doesn't work, reset your adb host:
adb kill-server
and then start over from the beginning.