Skip to content

Commit 0a0b341

Browse files
authored
Update README.md
1 parent 071c504 commit 0a0b341

File tree

1 file changed

+77
-1
lines changed

1 file changed

+77
-1
lines changed

README.md

Lines changed: 77 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,78 @@
11
# RobotQA Android Studio Plugin - Real Device Debugging on Cloud
2-
Android application remote debugging plugin for Android Studio
2+
![RobotQA Plugin Main](https://github.com/robotqa/Android-Studio-Plugin-for-Debugging/blob/main/main-photo.png?raw=true)
3+
4+
RobotQA serves as a mobile application testing and development platform, a repertoire of over 60 real devices encompassing iOS, Android, Huawei, and Xiaomi operating systems. This plugin facilitates the integration of the RobotQA device farm, enabling remote debugging of Android applications across Android, Huawei, and Xiaomi OS devices.
5+
6+
## How to install Android Studio Plugin
7+
8+
This plugin is tailored for use with Android Studio and Intellij IDE. Therefore, it is imperative to ensure the prior installation of Android Studio, with support extending from versions released in 2021 onwards. The installation of the plugin can be executed through two distinct methods:
9+
10+
**Note: Please ensure that the adb tools are installed on your system before proceeding.**
11+
12+
### Manually install plugin
13+
14+
[Download](https://github.com/robotqa/Android-Studio-Plugin-for-Debugging/releases/tag/releases) the plugin file then start Android Studio. Click:
15+
> Settings-->Plugins-->Install Plugin from Disk
16+
17+
Select downloaded plugin file and install plugin.
18+
19+
### Upload using Android Studio Plugin Page
20+
21+
Start Android Studio and click
22+
> Settings-->Plugins-->Marketplace </code></pre>
23+
24+
Find **RobotQA Real Device Debugging on Cloud** plugin and install.
25+
26+
## How to start debugging
27+
28+
To start this plugin usage, firstly you have to register on RobotQA.com. We offer **1 week free** access to all users.
29+
When Android Studio starts, click **Help-->Find Action** and search: *RobotQA Device List*
30+
31+
### Register and get token
32+
33+
When you activate this plugin, Device List table will be displayed. After opening device list, click **Start free usage**.
34+
35+
![RobotQA Plugin Table Page](https://github.com/robotqa/Android-Studio-Plugin-for-Debugging/blob/main/first-page.png?raw=true)
36+
37+
Follow the opening link. When you register our platform we will send token to use on plugin.
38+
39+
### Activate device farm connection
40+
41+
Upon acquiring a token, input it into the designated textbox within the **RobotQA Token Setting** dialog. To access this dialog, navigate to **Help --> Find Action** and search for it accordingly. Once the token value has been entered, you will gain the capability to establish connections with devices and access the associated screen.
42+
43+
![RobotQA Plugin Enter Token](https://github.com/robotqa/Android-Studio-Plugin-for-Debugging/blob/main/token-enter.png?raw=true)
44+
45+
### Connect a device and start debugging
46+
47+
To connect a device, firstly click **Enable RobotQA Device Farm Connection** button.
48+
*Note that: When you enable connection and using our device farm, you will lost your local device connections*
49+
50+
After enabling device farm connection, you can connect any devices that you want. After connecting devices, select a device from connected devices and start project as you do in Android Studio.
51+
52+
![RobotQA Plugin Connect Device](https://github.com/robotqa/Android-Studio-Plugin-for-Debugging/blob/main/device-connected.png?raw=true)
53+
54+
After starting project, open **RobotQA console** and follow the logs. These logs give information about *user packages, device status, live testing links etc.*
55+
When device connection is ready, click the link in Notification to connect and use device manually. This functionality enables you to perform actions such as clicking, swiping, and navigating between pages with ease.
56+
57+
![RobotQA Plugin Live Testing](https://github.com/robotqa/Android-Studio-Plugin-for-Debugging/blob/main/live-testing-click.png?raw=true)
58+
59+
![RobotQA Plugin Live Testing Page](https://github.com/robotqa/Android-Studio-Plugin-for-Debugging/blob/main/live-testing-page.png?raw=true)
60+
61+
### Close debugging
62+
63+
When you finished your debugging, stop the project run as usual. * ***Important Note: Close the live testing page when you finished your testing*** *
64+
RobotQA offers reports for each debugging. To get video and logs about your debugging, login to [RobotQA login page](https://robotqa.com/login) and click the latest test on dashboard. You will see the this report.
65+
66+
![RobotQA Plugin Dashboard](https://github.com/robotqa/Android-Studio-Plugin-for-Debugging/blob/main/test-result.png?raw=true)
67+
68+
## About Issue Tracking
69+
70+
When you face a problem, please open a ticket here. We will use this repo for tracking all issues. Also you can write us *hello@robotqa.com*
71+
72+
## About RobotQA
73+
74+
RobotQA is a mobile application development and test platform. RobotQA has more than 60 real devices including iOS, Android, Huawei and Xiaomi OS. In terms of testing capabilities, RobotQA provides support for popular frameworks like Appium and UiPath, allowing users to remotely execute their test scripts on real devices. Additionally, the platform offers a convenient codeless testing feature to streamline the initiation of tests. On the development front, RobotQA facilitates debugging of Android applications through dedicated plugins, enabling remote debugging on real devices. For further details, please visit: [RobotQA](https://robotqa.com)
75+
76+
### Conclusion
77+
78+
This plugin is specifically crafted for testing Android mobile applications. Its functionality enables you to assess the performance of your mobile applications on real devices, ensuring accuracy and reliability. Moreover, in instances where debugging is necessary for a particular device, you can utilize this plugin to establish a connection and remotely debug your applications. Access to the live testing page grants you the opportunity to interact with devices as if they were physically in your possession, facilitating comprehensive testing and debugging procedures.

0 commit comments

Comments
 (0)