- Android Debug Bridge
- Contents
- Installation
- Usage
- Connect device
- Figure out device IDs
- Adding udev rules
- Detect the device
- Transferring files
- Backup and restore
- Tips and tricks
- Bash completion
- Tools building on ADB
- Troubleshooting
- Empty device list
- No permissions error
- Android Debug Bridge
- In this document
- Enabling adb Debugging
- Syntax
- Commands
- Querying for Emulator/Device Instances
- Directing Commands to a Specific Emulator/Device Instance
- Installing an Application
- Forwarding Ports
- Copying Files to or from an Emulator/Device Instance
- Stopping the adb Server
- Wireless usage
Android Debug Bridge
The Android Debug Bridge (ADB) is a command-line tool that can be used to install, uninstall and debug apps, transfer files and access the device’s shell.
Contents
Installation
ADB is part of the Platform-Tools SDK package and the android-tools package.
Usage
Connect device
To connect to a real device or phone via ADB under Arch, you must:
- You might want to install android-udev if you wish to connect the device to the proper /dev/ entries.
- plug in your android device via USB.
- Enable USB Debugging on your phone or device:
- Jelly Bean (4.2) and newer: Go to Settings > About Phone tap Build Number 7 times until you get a popup that you have become a developer. Build number may be under a menu called Software info on newer Android OS versions. Then go to Settings > Developer > USB debugging and enable it. The device will ask to allow the computer with its fingerprint to connect. Allowing it permanently will copy
/.android/adbkey.pub onto the devices /data/misc/adb/adb_keys folder.
If ADB recognizes your device ( adb devices shows it as «device» and not as «unauthorized» , or it is visible and accessible in IDE), you are done. Otherwise see the instructions below.
Figure out device IDs
Each Android device has a USB vendor/product ID. An example for HTC Evo is:
Plug in your device and execute:
It should come up something like this:
Adding udev rules
Use the rules from android-udev (or android-udev-git AUR ), install them manually from Android developer, or use the following template for your udev rules, just replace [VENDOR ID] and [PRODUCT ID] with yours. Copy these rules into /etc/udev/rules.d/51-android.rules :
Then, to reload your new udev rules, execute:
Make sure you are member of adbusers user group to access adb devices.
Detect the device
After you have setup the udev rules, unplug your device and replug it.
you should see something like:
If adb still does not detect the device after plugging your device back in, kill and restart the adb server as root and check devices again:
If adb devices still shows «unauthorized» next to your device, make sure that that device has debugging permission allowed on the device itself. A ‘Allow USB Debugging?’ dialog should be presented when you physically connect the device. Select ‘Always Allow. «, then tap «OK». If the dialog was never presented, try Settings > Developer Options > Revoke USB Debugging Authorizations (then «OK»), and repeat the steps in this section. If you still do not see the ‘Allow USB Debugging?’ dialog, and the device is listed as unauthorized, then enter the Developer Options on the device and first uncheck «USB Debugging» and then check it again.
Transferring files
You can now use adb to transfer files between the device and your computer. To transfer files to the device, use
To transfer files from the device, use
Backup and restore
You can also backup and restore your device with adb. Moreover, no root is required to follow the process. The commands below led to backup your device to a single file which can also be successively restored.
The command to create a backup is
The command parameters list is
Then confirm the process on your device’s display and provide a password whether a backup password has been set before.
The command to restore a previous backup is
Tips and tricks
Bash completion
In order to enable Bash completion, install one of the following:
- android-completionAUR – Bash completion for adb and fastboot , taken from AOSP.
- android-bash-completionAUR – Bash completion for android , adb , emulator , fastboot , and repo , developed independently.
Tools building on ADB
- adbfs-rootless-gitAUR – a FUSE filesystem over ADB.
- adb-sync (available as adb-sync-gitAUR ) – a tool to synchronize files between a PC and an Android device using the ADB protocol.
- AndroidScreencast (available as androidscreencast-binAUR ) – view and control your Android device from a PC (via ADB).
- logcat-colorAUR – a colorful and highly configurable alternative to the standard adb logcat command.
- scrcpy (available as scrcpy ) – display and control your Android device.
- qtscrcpy (available as qtscrcpy-gitAUR ) – Android real-time display control software.
Troubleshooting
Empty device list
A possible cause for your device not showing up is not having enabled USB debugging on your device. You can do that by going to Settings > Applications > Development and enabling USB debugging. Since Android 4.2 (Jelly Bean), the development menu is hidden; to enable it go to Settings > About phone and tap Build number 7 times.
No permissions error
If the device shows up with a «no permissions» label, it probably has a different vendor/product ID with respect to the ones collected by android-udev .
This can happen for instance when the device uses a custom ROM, or when it is switched from MTP to USB tethering mode, sideload and/or fastboot mode. Verify the actual device’s ID with lsusb and add the appropriate udev rules as described above.
Источник
Android Debug Bridge
In this document
Android Debug Bridge (adb) is a versatile command line tool that lets you communicate with an emulator instance or connected Android-powered device. It is a client-server program that includes three components:
- A client, which runs on your development machine. You can invoke a client from a shell by issuing an adb command. Other Android tools such as the ADT plugin and DDMS also create adb clients.
- A server, which runs as a background process on your development machine. The server manages 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 /platform-tools/ .
When you start an adb client, the client first checks whether there is an adb server process 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 adb clients use port 5037 to communicate with the adb server.
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
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 to access those instances. Because the server manages connections to emulator/device instances and handles commands from multiple adb clients, you can control any emulator/device instance from any client (or from a script).
Enabling adb Debugging
In order to use adb with a device connected over USB, you must enable USB debugging in the device system settings, under Developer options.
On Android 4.2 and higher, the Developer options screen is hidden by default. To make it visible, go to Settings > About phone and tap Build number seven times. Return to the previous screen to find Developer 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 higher to 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 ensures that USB debugging and other adb commands cannot be executed unless you’re able to unlock the device and acknowledge the dialog. This requires that you have adb version 1.0.31 (available with SDK Platform-tools r16.0.1 and higher) in order to debug on a device running Android 4.2.2 or higher.
For more information about connecting to a device over USB, read Using Hardware Devices.
Syntax
You can issue adb commands from a command line on your development machine or from a script. The usage is:
If there’s only one emulator running or only one device connected, the adb command is sent to that device by default. If multiple emulators are running and/or multiple devices are attached, 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 | -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 | Direct an adb command a specific emulator/device instance, referred to by its adb-assigned serial number (such as «emulator-5556»). | See Directing Commands 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. | |
bugreport | 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: port-forwarding specification to connect to a specific JDWP process. For example: | |
Data | install | Pushes an Android application (specified as a full path to an .apk file) to an emulator/device. | |
pull | Copies a specified file from an emulator/device instance to your development computer. | ||
push | Copies a specified file from your development computer to an emulator/device instance. | ||
Ports and Networking | forward | 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 [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 is device . | 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: Note 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 would 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 the devices command:
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 — . 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:
Here’s an example showing the devices command and its output:
Directing Commands to a Specific Emulator/Device Instance
If multiple emulator/device instances are running, you must specify a target instance when issuing adb commands. To do so, use the -s option in the commands. The usage for the -s option is:
As shown, you specify the target instance for a command using its adb-assigned serial number. You can use the devices command to obtain the serial numbers of running emulator/device instances. For example:
Note that, if you issue a command without specifying a target emulator/device instance while 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 multiple devices but only one hardware device attached, use the -d option to send commands to the 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 the install command. With the command, you must specify the path to the .apk file that you want to install:
For more information about how to create an .apk file that you can install on an emulator/device instance, see Building 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:
You can also use adb to set up forwarding to named abstract UNIX domain sockets, as illustrated here:
Copying Files to or from an Emulator/Device Instance
You can use the adb commands pull and push to copy files to and from an emulator/device instance. Unlike the install command, which only copies an APK file to a specific location, the pull and push commands let you copy arbitrary directories and files to any location in an emulator/device instance.
To copy a file or directory (and its sub-directories) from the emulator or device, use
To copy a file or directory (and its sub-directories) to the emulator or device, use
In the commands, and refer to the paths to the target files/directory on your development machine (local) and on the emulator/device instance (remote). For example:
Stopping the adb Server
In some cases, you might need to terminate the adb server process and then restart it to 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 over Wi-Fi, as described here.
- Connect Android device and adb host computer to a common Wi-Fi network accessible to both. We have found that not all access points are suitable; you may need to use an access point whose firewall is configured properly to support adb.
- Connect the device with USB cable to host.
- Make sure adb is running in USB mode on host.
- Connect to the device over USB.
- Restart host adb in tcpip mode.
- Find out the IP address of the Android device: Settings -> About tablet -> Status -> IP address. Remember the IP address, of the form #.#.#.# .
- Connect adb host to device:
- Remove USB cable from device, and confirm you can still access 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: and then start over from the beginning.
Источник