Overview

Android library allows users to communicate and control with Android-based Mobile using ADB Tool .

The features provided by the Android library are as follows

Touch function: AndroidInputTouch, AndroidInputLongPress, AndroidInputSwipe
Screen Capture Feature: AndroidScreenCapture
Connection function: AndroidConnect
Object control functions: AndroidClick, AndroidInputText, AndroidInputKeyEvent
Object information functions: AndroidGetBounds, AndroidGetText, AndroidFind
Basic functions: AndroidShell, AndroidPull, AndroidPush

Install ADB Tools

ADB Tool installationAndroid SDK PlatformPlease refer to the page.
After decompressing the ADB Tool , add the corresponding path to the Windows system environment variable (Path).

Common Properties

MORE OPTIONS

Properties	Type	Required	Unit	Auto-setting	Description
Device	Text	N	-	N	Enter the target device name.
Timeout	Number	N	sec	N	Set the time to find the object. (Sec)
On Error	Combo Box	N	-	N	Specifies the action to take when an error occurs. - Unspecified: Outputs an error and terminates the task. - Ignore: Ignore the error. - Retry: Retry the activity once. - Goto: If the activity fails, perform the scenario for the specified activity. - Event: Calls the event registered in the project.

Properties

Type

Required

Unit

Auto-setting

Description

Device

Text

Enter the target device name.

Timeout

Number

sec

Set the time to find the object. (Sec)

On Error

Combo Box

Specifies the action to take when an error occurs.

- Unspecified: Outputs an error and terminates the task.

- Ignore: Ignore the error.

- Retry: Retry the activity once.

- Goto: If the activity fails, perform the scenario for the specified activity.

- Event: Calls the event registered in the project.

DESCRIPTION

Properties	Type	Required	Unit	Auto-Setting	Description
DESCRIPTION	Text	N	-	N	Enter the description for the activity card. The Description entered in the DESCRIPTION field is used as an description of the property. A representative value will be displayed in the absence of the DESCRIPTION input.

AndoridConnect

AndroidConnect

Overview

This activity card connects to your Android device.

Application procedures

In the Host field, enter the IP address to connect to Android.
In the Port field, enter the port number.

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Host	Text	Y	-	N	Enter the IP address of the Android device to connect.
N	Port	Number	Y	-	Y	Enter the port number.
Y	MORE OPTIONS	-	-	-	-	Common property of Android library.
Y	DESCRIPTION	-	-	-	-	Common property of Android library.

Example of utilization

It tries to connect to the Android device and displays the result in a message box.

AndroidConnect

Sample File

Menu > Help > Samples > Sample > Android

Used Properties

Host = '127.0.0.1'
Port = 9000

AndroidShell

Overview

This activity card runs the ADB Shell command on your Android device.

Application procedures

In the [Output] field, enter a variable to store the result.
In the Arguments field, enter arguments required for the execution command.

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Output	Variable	N	-	Y	Enter a variable to store the execution result.
N	Arguments	Text	Y	-	Y	Enter the arguments required for the execution command.
Y	MORE OPTIONS	-	-	-	-	Common property of the Android library.
Y	DESCRIPTION	-	-	-	-	Common property of the Android library.

Example of utilization

Call the OpenAI Text Completion API.

Androidshell

Sample File

Menu > Help > Samples > Sample > Android

Used variables

RESULT = variable to store execution result

Used Properties

[Output] Output = RESULT
Arguments = 'ls'

AndroidPush

Overview

This activity card ends files to your Android device.

Application procedures

In the SrcPath field, enter the local path of the file you want to upload to Android.
Enter the upload path for saving to Android in DestPath.

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	SrcPath	Text	Y	-	N	Enter the local path of the file to be uploaded to the Android device.
N	DestPath	Text	Y	-	Y	Enter the upload path of your Android device.
Y	MORE OPTIONS	-	-	-	-	Common property of the Android library.
Y	DESCRIPTION	-	-	-	-	Common property of the Android library.

Example of utilization

Send the file you create locally to your Android device.

Androidpush

Sample File

Menu > Help > Samples > Sample > Android

Used variables

RESULT = variable to store the entire response result
TextRESULT = A variable to store the first text result in choices among response results
Global.apiToken = API Token

Used Properties

SrcPath = 'D:\\AndroidTest.txt'
DestPath = '/sdcard'

AndroidPull

Overview

This activity card get files from your Android device.

Application procedures

In the SrcPath field, enter the path of the file to import from Android.
In the DestPath field, enter the local path where Android will save the fetched files

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	SrcPath	Text	Y	-	N	Enter the path of the target file to be downloaded from the Android device.
N	DestPath	Text	Y	-	Y	Enter the local path to save the target file.
Y	MORE OPTIONS	-	-	-	-	Common property of the Android library.
Y	DESCRIPTION	-	-	-	-	Common property of the Android library.

Example of utilization

Get files from your Android device.

Androidpull

Sample File

Menu > Help > Samples > Sample > Android

Used properties

SrcPath = '/sdcard/AndroidTest.txt'
DestPath = 'D:\\Temp\\AndroidTest2.txt'

Related/Similar Activities

AndroidRush

AndroidFind

Overview

Retrieves Android object information matching specified properties.

Application procedures

In the [Output] field, enter a variable to store object information in Output.
Enter a number to identify if there are more than two target objects in Index.
Enter the Text property of the Android target object.
Select whether to reload Android object information in Refresh.

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Output	Variable	Y	-	N	Enter a variable to store the execution result.
N	Index	Number	Y	-	Y	Enter a number to identity if two or more objects are to be searched for.
N	Text	Text	Y	-	N	Enter the Text property of the search target object.
N	Class	Text	Y	-	Y	Enter the Class property of the search target object.
N	ResourceID	Text	Y	-	N	Enter the Resource-id property of the search target object.
N	ContentDesc	Text	Y	-	Y	Enter the Content-Desc property of the search target object.
N	XPath	Text	Y	-	Y	Enter the XPath path of the target object.
N	Refresh	Toggle Button	N	-	N	Select whether to reload Android object information.
Y	MORE OPTIONS	-	-	-	-	Common property of the Android library.
Y	DESCRIPTION	-	-	-	-	Common property of the Android library.

Example of utilization

Fetch the information from the phone object on your Android device and display it as a message box.

ANdroidfind

Sample File

Menu > Help > Samples > Sample > Android

Used variables

RESULT = variable to store Android object information

Used properties

[Output] Output = RESULT
Index = 1
Text = 'phone'
Refresh=On

Related/Similar Activities

AndroidGetBounds, AndroidGetText, AndroidClick

AndroidGetBounds

Overview

This activity card gets zone information for Android objects that match the specified properties.

Application procedures

In the [Output] field, enter a variable to store object information in Output.
Enter a number to identify if there are more than two target objects in Index.
Enter the Text property of the Android target object.
Select whether to reload Android object information in Refresh.

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Output	Variable	Y	-	N	Enter a variable to store the execution result.
N	Index	Number	Y	-	Y	Enter a number to identity if two or more objects are to be searched for.
N	Text	Text	Y	-	N	Enter the Text property of the search target object.
N	Class	Text	Y	-	Y	Enter the Class property of the search target object.
N	ResourceID	Text	Y	-	N	Enter the Resource-id property of the search target object.
N	ContentDesc	Text	Y	-	Y	Enter the Content-Desc property of the search target object.
N	XPath	Text	Y	-	Y	Enter the XPath path of the target object.
N	Refresh	Toggle Button	N	-	N	Select whether to reload Android object information.
Y	MORE OPTIONS	-	-	-	-	Common property of the Android library.
Y	DESCRIPTION	-	-	-	-	Common property of the Android library.

Example of utilization

Get area information of phone objects from Android devices and display it as a message box.

ANdroidGetBounds

Sample File

Menu > Help > Samples > Sample > Android

Used variables

RESULT = variable to store Android object area information

Used properties

[Output] Output = RESULT
Index = 1
Text = 'phone'
Refresh=On

Related/Similar Activities

AndroidFind, AndroidGetText, AndroidClick

AndroidGetText

Overview

This activity card retrieves the text information of an Android object that matches a specified property.

Application procedures

In the [Output] field, enter a variable to store object information in Output.
Enter a number to identify if there are more than two target objects in Index.
In the XPath field, enter the XPath of the Android target object.
Select whether to reload Android object information in Refresh.

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Output	Variable	Y	-	N	Specifies a variable to store the execution result.
N	Index	Number	Y	-	Y	Enter a number to identity if two or more objects are to be searched for.
N	Text	Text	Y	-	N	Enter the Text property of the search target object.
N	Class	Text	Y	-	Y	Enter the Class property of the search target object.
N	ResourceID	Text	Y	-	N	Enter the Resource-id property of the search target object.
N	ContentDesc	Text	Y	-	Y	Enter the Content-Desc property of the search target object.
N	XPath	Text	Y	-	Y	Enter the XPath path of the target object.
N	Refresh	Toggle Button	N	-	N	Select whether to reload Android object information.
Y	MORE OPTIONS	-	-	-	-	Common property of the Android library.
Y	DESCRIPTION	-	-	-	-	Common property of the Android library.

Example of utilization

I am getting the text information of a phone object from an Android device and displaying it as a message box.

androidgettext

Sample File

Menu > Help > Samples > Sample > Android

Used variables

RESULT = variable to store Android object text information

Used properties

[Output] Output = RESULT
Index = 1
XPath = '//node[@resource-id="com.sec.android.app.launcher:id/apps_icon"]'
Refresh=On

Related/Similar Activities

AndroidFind, AndroidGetBounds, AndroidClick

AndroidInputTouch

Overview

This activity card touches the coordinates you specified on your Android device.

Application procedures

In the DestPoint field, enter the point you want to touch.

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	DestPoint	Text	Y	-	N	Enter the destination point of the touch event.
Y	MORE OPTIONS	-	-	-	-	Common property of the Android library.
Y	DESCRIPTION	-	-	-	-	Common property of the Android library.

Example of utilization

Touch the contact icon to get area information of the contact object from the Android device.

AndroidInputTouch

Sample file

Menu > Help > Samples > Sample > Android

Used variables

RESULT = variable to store median value of android object area

Used properties

[Output] Output = RESULT

Related/Similar activities

AndroidInputLongPress, AndroidInputSwipe

AndroidInputLongPress

Overview

This activity card presses and holds the specified coordinates on your Android device.

Application procedures

Enter the start point of the touch event in SrcPoint.
Enter the duration of the touch point in Duration.

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	SrcPoint	Text	Y	-	N	Enter the start point of the touch event.
N	Duration	Number	Y	msec	Y	Enter the duration of the touch event.
Y	MORE OPTIONS	-	-	-	-	Common property of Android library.
Y	DESCRIPTION	-	-	-	-	Common property of Android library.

Example of utilization

Get the location information of the message object from the Android device and press and hold the object's centre.

AndroidInputLongPress

Sample file

Menu > Help > Samples > Sample > Android

Used variables

this.var1 = A variable to store the median value of the Android object area

Used properties

SrcPoint = this.var1
Duration = 1000

Related/Similar activities

AndroidInputTouch AndroidInputSwipe

AndroidInputSwipe

Overview

This activity card swipes the screen at the specified coordinates on the Android device.

Application procedures

Enter the screen sliding start point in SrcPoint.
Enter the last point of the screen slide in DestPoint.
In the Duration field, enter the time to move from the screen swipe's start point to the end.

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	SrcPoint	Text	Y	-	N	Enter the start point of the touch event.
N	DestPoint	Text	Y	-	N	Enter the last point of the touch event.
N	Duration	Number	Y	msec	Y	Enter the duration of the touch event.
Y	MORE OPTIONS	-	-	-	-	Common property of the Android library.
Y	DESCRIPTION	-	-	-	-	Common property of the Android library.

Example of utilization

Swipe the screen to specific coordinates on the Android device.

AndroidInputSwipe

Sample file

Menu > Help > Samples > Sample > Android

Used properties

SrcPoint = '500, 500'
DestPoint = '100, 100'
Duration = 250

Related/Similar activites

AndroidInputTouch, AndroidInputLongPress

AndroidClick

Overview

This activity card clicks the Android object that matches the specified properties.

Application procedures

Enter a number to identify the same object in Index.
In the XPath field, enter the XPath path to the target object.
Select whether to reload Android object information in Refresh.

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Index	Number	Y	-	Y	Enter a number to identity if two or more objects are to be searched for.
N	Text	Text	Y	-	N	Enter the Text property of the search target object.
N	Class	Text	Y	-	Y	Enter the Class property of the search target object.
N	ResourceID	Text	Y	-	N	Enter the Resource-id property of the search target object.
N	ContentDesc	Text	Y	-	Y	Enter the Content-Desc property of the search target object.
N	Xpath	Text	Y	-	Y	Enter the XPath path of the target object.
N	Refresh	Toggle Button	N	-	N	Select whether to reload Android object information.
Y	MORE OPTIONS	-	-	-	-	Common property of Android library.
Y	DESCRIPTION	-	-	-	-	Common property of Android library.

Example of utilization

Find the camera object specified by xpath on the Android device and click it.

AndroidClick

Sample file

Menu > Help > Samples > Sample > Android

Used properties

Index = 1
XPath = '//node[@text="Camera"]'
Refresh=On

Related/Similar activites

AndroidFind, AndroidGetBounds, AndroidGetText

AndroidInputKeyEvent

Overview

This activity card fires a key event on the Android device.

Application procedures

Select a key event from KeyEvent.

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	KeyInput	Combo Box	Y	-	N	Select a key event.
Y	MORE OPTIONS	-	-	-	-	Common property of Android library.
Y	DESCRIPTION	-	-	-	-	Common property of Android library.

Example of utilization

Generates a Call key event on the Android device.

AndroidInputKeyEvent

Sample file

Menu > Help > Samples > Sample > Android

Used properties

KeyInput = KEYCODE_CALL

Related/Similar activites

AndroidInputText

Overview

Enter the specified string (English only) on the Android device.

To use other languages, a keyboard app on your Android device (ADBKeyboardetc.) can be transferred using the AndroidShell library after installation.

Application procedures

Enter the string to be sent to Android in Input Text.

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Input Text	Text	Y	-	N	Enter your text.
Y	MORE OPTIONS	-	-	-	-	Common property of Android library.
Y	DESCRIPTION	-	-	-	-	Common property of Android library.

Example of utilization

Open the Messages app on your Android device and enter the string stored in this.var1 into the search box.

Androidinputtext

Sample file

Menu > Help > Samples > Sample > Android

Used vairable

this.var1 = A variable that stores the string to be input to the Android object.

Used properties

Input Text = this.var1

Related/Similar activites

AndroidInputKeyEvent

AndroidScreenCapture

Overview

This activity card captures the screen of your Android device and import it to a file.

Application procedures

In the DestPath field, enter the local path to save the file that captures the Android screen.

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	DestPath	Text	Y	-	N	Enter the local path to save the target file.
Y	MORE OPTIONS	-	-	-	-	Common property of Android library.
Y	DESCRIPTION	-	-	-	-	Common property of Android library.

Example of utilization

Captures the current screen of the Android device and saves it as a local file (D:\\temp\\test.png).

Androidscreencapture

Sample file

Menu > Help > Samples > Sample > Android

Used properties

DestPath = 'D:\\temp\\test.png'

Related/Similar activites

N/A