Skip to main content
API docs by Redocly

ADB API (1.0.0)

Download OpenAPI specification:Download

URL: https://github.com/kookmin-sw/capstone-2024-03

ADB 서버와 연결된 API

Utility

Execute an ADB command on the device.

Request Body schema: application/json
command
required
string

The ADB command to be executed.

task_id
required
string

The ID of the task.

Responses

Request samples

Content type
application/json
{
  • "command": "string",
  • "task_id": "string"
}

Exit the loop based on the condition.

Request Body schema: application/json
condition
required
string

The condition to exit the loop.

task_id
required
string

The ID of the task.

Responses

Request samples

Content type
application/json
{
  • "condition": "string",
  • "task_id": "string"
}

Add a delay to the task queue.

Request Body schema: application/json
time
required
integer

The number of seconds to delay.

Responses

Request samples

Content type
application/json
{
  • "time": 0
}

Add a loop of functions to the task operator.

Request Body schema: application/json
functions
required
string

The functions to be executed.

task_id
required
string

The ID of the task.

time
required
integer

The number of iterations to execute the function.

Responses

Request samples

Content type
application/json
{
  • "functions": "string",
  • "task_id": "string",
  • "time": 0
}

Keyboard

Check the ADB keyboard on the device.

Responses

Install the ADB keyboard on the device.

Responses

Uninstall the ADB keyboard on the device.

Responses

Core

Clear all the ADB operations.

Responses

Execute the ADB operations.

Responses

Get all the ADB operations.

Responses

Update the ADB operations.

Request Body schema: application/json
new_param
required
Array of strings

The properties to be updated.

task_order
integer

The order of the task.

Responses

Request samples

Content type
application/json
{
  • "new_param": [
    ],
  • "task_order": 0
}

Image

Extract text from an image using OCR.

Request Body schema: application/x-www-form-urlencoded
required
image
required
string <binary>

The image file to extract text from.

Responses

Perform template matching on the device screen using the provided template image.

Request Body schema: application/x-www-form-urlencoded
required
template
required
string <binary>

The template image file to be used for matching.

Responses

Input

Execute an input text on the device.

Request Body schema: application/json
task_id
required
string

The ID of the task.

text
required
string

The text to be input.

time
required
integer

The number of times to input the text.

Responses

Request samples

Content type
application/json
{
  • "task_id": "string",
  • "text": "string",
  • "time": 0
}

Execute a shortcut on the device.

Request Body schema: application/json
key_event
required
integer

The key event to be executed.

task_id
required
string

The ID of the task.

time
required
integer

The number of times to single click.

Responses

Request samples

Content type
application/json
{
  • "key_event": 0,
  • "task_id": "string",
  • "time": 0
}

Click

Execute a long press on the device screen.

Request Body schema: application/json
task_id
required
string

The ID of the task.

time
required
integer

The number of times to long press.

x
required
integer

The x-coordinate of the click.

y
required
integer

The y-coordinate of the click.

Responses

Request samples

Content type
application/json
{
  • "task_id": "string",
  • "time": 0,
  • "x": 0,
  • "y": 0
}

Execute a single click on the device screen.

Request Body schema: application/json
task_id
required
string

The ID of the task.

time
required
integer

The number of times to single click.

x
required
integer

The x-coordinate of the click.

y
required
integer

The y-coordinate of the click.

Responses

Request samples

Content type
application/json
{
  • "task_id": "string",
  • "time": 0,
  • "x": 0,
  • "y": 0
}

manager

Render the manager page.

Responses

Clear the API data.

Responses

Download the API data as a JSON file.

Responses

Report

Create a new page in Notion.

Request Body schema: application/json
page_content
required
string

The content of the page.

page_title
required
string

The title of the page.

task_id
required
string

The ID of the task.

Responses

Request samples

Content type
application/json
{
  • "page_content": "string",
  • "page_title": "string",
  • "task_id": "string"
}

Send a message to a Slack channel.

Request Body schema: application/json
message
required
string

The message to be sent.

task_id
required
string

The ID of the task.

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "task_id": "string"
}

Python

Run a python script on studio client.

Request Body schema: application/json
code
required
string

The python script to be executed.

task_id
required
string

The ID of the task.

time
required
integer

The number of times to run the script.

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "task_id": "string",
  • "time": 0
}

Screen

Capture the screen of a device and return the image.

Responses

save the screen of a device and return the zip.

Responses

Capture the screen of a device for senario task.

Request Body schema: application/json
task_id
required
string

The ID of the task.

time
required
integer

The number of times to capture the screen.

Responses

Request samples

Content type
application/json
{
  • "task_id": "string",
  • "time": 0
}

Scroll

Scroll down on the device screen.

Request Body schema: application/json
task_id
required
string

The ID of the task.

time
required
integer

The number of times to scroll down.

Responses

Request samples

Content type
application/json
{
  • "task_id": "string",
  • "time": 0
}

Scroll up on the device screen.

Request Body schema: application/json
task_id
required
string

The ID of the task.

time
required
integer

The number of times to scroll up.

Responses

Request samples

Content type
application/json
{
  • "task_id": "string",
  • "time": 0
}

variable

Add a user variable to the task operator.

Request Body schema: application/json
task_id
required
string

The ID of the task.

variable_name
required
string

The name of the variable.

variable_value
required
string

The value of the variable.

Responses

Request samples

Content type
application/json
{
  • "task_id": "string",
  • "variable_name": "string",
  • "variable_value": "string"
}