ADB Usage¶
Preface¶
ADB, full name Android Debug Bridge, is Android command line debugging tool, can complete a variety of functions, such as tracking system logs, upload and download files, install applications.
Ready to connect¶
Connects device OTG port and host USB port with dual male USB data cable. You need to turn on USB Debug item in advance in system setting.
ADB installation on Windows¶
First of all, follow the section installing RK USB drives to install any of these drivers.
Then, go to http://adbshell.com/download/download-adb-for-windows.html to download adb.zip，and extract it to C:\adb.
Open a command line window and type:
cd C:\adb
adb shell
If everything is normal, you can enter adb shell to run commands on the device.
ADB installation on Ubuntu¶
Install adb tools:
sudo apt-get install android-tools-adb
Add device identification:
mkdir -p ~/.android
vi ~/.android/adb_usb.ini
# Add the following line
0x2207
Add the udev rule:
sudo vi /etc/udev/rules.d/51-android.rules
# Add the following line:
SUBSYSTEM=="usb", ATTR{idVendor}=="2207", MODE="0666"
Replug the USB cable, or run the following command to make the udev rule work:
sudo udevadm control --reload-rules
sudo udevadm trigger
Restart the adb server
sudo adb kill-server
adb start-server
Frequently-used ADB command¶
Connection management¶
Lists all connected devices and their serial Numbers
adb devices
If you have multiple connected devices, you need to use serial Numbers to distinguish them:
export ANDROID_SERIAL=<Device serial number>
adb shell ls
Connect the specified device under multiple devices
adb -s serial number shell
The adb can be connected through the network:
# Restart adb on the device side and listen at TCP port 5555
adb tcpip 5555
# Disconnect the USB connection, the IP address of the device is 192.168.1.100
adb connect 192.168.1.100:5555
# Disconnect
adb disconnect 192.168.1.100:5555
Get system log¶
usage
adb logcat [options] [Apply labels]
For example
# View all logs
adb logcat
# view only partial logs
adb logcat -s WifiStateMachine StateMachine
Get detailed running information¶
adb bugreport for error report, containing a large number of useful information.
For example
adb bugreport
# Save to local, easy to view with the editor
adb bugreport > bugreport.txt
Root permissions¶
If TARGET_BUILD_VARIANT is in userdebug mode, you need to run it to get root permission:
adb root
Switch the device of adb to root mode so that adb remount and other commands which need root permission can be used.
Install the application¶
Usage:
adb install [Options] application.apk
Options:
-l forward-lock
-r reinstall the application and retain the original data
-s installed on the SD card instead of internal storage
For example:
# Install facebook.apk
adb install facebook.apk
# Update twitter.apk
adb install -r twitter.apk
If the installation is successful, the tool will return a prompt of Success. Otherwise, is generally the following circumstances:
INSTALL_FAILED_ALREADY_EXISTS: You need to reinstall with the -r parameter.
INSTALL_FAILED_SIGNATURE_ERROR: The applied signatures may not be the same, and may be due to differences between the release and debug signatures. If you are sure that the APK file signature is ok, you can uninstall the old application by using the adb uninstall command. Then install again.
INSTALL_FAILED_INSUFFICIENT_STORAGE: Insufficient storage space, you need to check the device storage.
Uninstall the application¶
Usage:
adb uninstall Application package name
For example:
adb uninstall com.android.chrome
Application package names can be listed with the followsing commands:
adb shell pm list packages -f
The running result:
package:/system/app/Bluetooth.apk=com.android.bluetooth
The apk file is ahead，and the follows is the corresponding package name.
Command line help information¶
Android Debug Bridge version 1.0.31
-a - directs adb to listen on all interfaces for a connection
-d - directs command to the only connected USB device
returns an error if more than one USB device is present.
-e - directs command to the only running emulator.
returns an error if more than one emulator is running.
-s <specific device> - directs command to the device or emulator with the given
serial number or qualifier. Overrides ANDROID_SERIAL
environment variable.
-p <product name or path> - simple product name like 'sooner', or
a relative/absolute path to a product
out directory like 'out/target/product/sooner'.
If -p is not specified, the ANDROID_PRODUCT_OUT
environment variable is used, which must
be an absolute path.
-H - Name of adb server host (default: localhost)
-P - Port of adb server (default: 5037)
devices [-l] - list all connected devices
('-l' will also list device qualifiers)
connect <host>[:<port>] - connect to a device via TCP/IP
Port 5555 is used by default if no port number is specified.
disconnect [<host>[:<port>]] - disconnect from a TCP/IP device.
Port 5555 is used by default if no port number is specified.
Using this command with no additional arguments
will disconnect from all connected TCP/IP devices.
device commands:
adb push [-p] <local> <remote>
- copy file/dir to device
('-p' to display the transfer progress)
adb pull [-p] [-a] <remote> [<local>]
- copy file/dir from device
('-p' to display the transfer progress)
('-a' means copy timestamp and mode)
adb sync [ <directory> ] - copy host->device only if changed
(-l means list but don't copy)
(see 'adb help all')
adb shell - run remote shell interactively
adb shell <command> - run remote shell command
adb emu <command> - run emulator console command
adb logcat [ <filter-spec> ] - View device log
adb forward --list - list all forward socket connections.
the format is a list of lines with the following format:
<serial> " " <local> " " <remote> "\n"
adb forward <local> <remote> - forward socket connections
forward specs are one of:
tcp:<port>
localabstract:<unix domain socket name>
localreserved:<unix domain socket name>
localfilesystem:<unix domain socket name>
dev:<character device name>
jdwp:<process pid> (remote only)
adb forward --no-rebind <local> <remote>
- same as 'adb forward <local> <remote>' but fails
if <local> is already forwarded
adb forward --remove <local> - remove a specific forward socket connection
adb forward --remove-all - remove all forward socket connections
adb jdwp - list PIDs of processes hosting a JDWP transport
adb install [-l] [-r] [-d] [-s] [--algo <algorithm name> --key <hex-encoded key> --iv <hex-encoded iv>] <file>
- push this package file to the device and install it
('-l' means forward-lock the app)
('-r' means reinstall the app, keeping its data)
('-d' means allow version code downgrade)
('-s' means install on SD card instead of internal storage)
('--algo', '--key', and '--iv' mean the file is encrypted already)
adb uninstall [-k] <package> - remove this app package from the device
('-k' means keep the data and cache directories)
adb bugreport - return all information from the device
that should be included in a bug report.
adb backup [-f <file>] [-apk|-noapk] [-obb|-noobb] [-shared|-noshared] [-all] [-system|-nosystem] [<packages...>]
- write an archive of the device's data to <file>.
If no -f option is supplied then the data is written
to "backup.ab" in the current directory.
(-apk|-noapk enable/disable backup of the .apks themselves
in the archive; the default is noapk.)
(-obb|-noobb enable/disable backup of any installed apk expansion
(aka .obb) files associated with each application; the default
is noobb.)
(-shared|-noshared enable/disable backup of the device's
shared storage / SD card contents; the default is noshared.)
(-all means to back up all installed applications)
(-system|-nosystem toggles whether -all automatically includes
system applications; the default is to include system apps)
(<packages...> is the list of applications to be backed up. If
the -all or -shared flags are passed, then the package
list is optional. Applications explicitly given on the
command line will be included even if -nosystem would
ordinarily cause them to be omitted.)
adb restore <file> - restore device contents from the <file> backup archive
adb help - show this help message
adb version - show version num
scripting:
adb wait-for-device - block until device is online
adb start-server - ensure that there is a server running
adb kill-server - kill the server if it is running
adb get-state - prints: offline | bootloader | device
adb get-serialno - prints: <serial-number>
adb get-devpath - prints: <device-path>
adb status-window - continuously print device status for a specified device
adb remount - remounts the /system partition on the device read-write
adb reboot [bootloader|recovery] - reboots the device, optionally into the bootloader or recovery program
adb reboot-bootloader - reboots the device into the bootloader
adb root - restarts the adbd daemon with root permissions
adb usb - restarts the adbd daemon listening on USB
adb tcpip <port> - restarts the adbd daemon listening on TCP on the specified port
networking:
adb ppp <tty> [parameters] - Run PPP over USB.
Note: you should not automatically start a PPP connection.
<tty> refers to the tty for PPP stream. Eg. dev:/dev/omap_csmi_tty1
[parameters] - Eg. defaultroute debug dump local notty usepeerdns
adb sync notes: adb sync [ <directory> ]
<localdir> can be interpreted in several ways:
- If <directory> is not specified, both /system and /data partitions will be updated.
- If it is "system" or "data", only the corresponding partition
is updated.
environmental variables:
ADB_TRACE - Print debug information. A comma separated list of the following values
1 or all, adb, sockets, packets, rwx, usb, sync, sysdeps, transport, jdwp
ANDROID_SERIAL - The serial number to connect to. -s takes priority over this if given.
ANDROID_LOG_TAGS - When used with the logcat option, only these debug tags are printed.