tag	4bc585b96a59bbf91d1ed21cb29280cb4429d020
tagger	The Android Open Source Project <initial-contribution@android.com>	Mon Mar 13 23:05:11 2023 -0700
object	618296a2ec6b72ac8177c21ea6234d15c038351d

commit	618296a2ec6b72ac8177c21ea6234d15c038351d	[log] [tgz]
author	android-build-team Robot <android-build-team-robot@google.com>	Thu Jun 25 01:09:53 2020 +0000
committer	android-build-team Robot <android-build-team-robot@google.com>	Thu Jun 25 01:09:53 2020 +0000
tree	4d0c76a7c1f7041e0c6009fb9aa3b91b351af2a3
parent	c851ae2d0689b3bfc23e045c795b89d6db132e75 [diff]
parent	7efbbce7b187af28927efa8d609a8b5c49f6b08d [diff]

tree: 4d0c76a7c1f7041e0c6009fb9aa3b91b351af2a3

README.md

Scripting Layer For Android

Introduction

Originally authored by Damon Kohler, Scripting Layer for Android, SL4A, is an automation toolset for calling Android APIs in a platform-independent manner. It supports both remote automation via ADB as well as execution of scripts from on-device via a series of lightweight translation layers.

Build Instructions

Due to its inclusion in AOSP as a privileged app, building SL4A requires a system build.

For the initial build of Android:

cd <ANDROID_SOURCE_ROOT>
source build/envsetup.sh
lunch aosp_<TARGET>
make [-j15]

where <ANDROID_SOURCE_ROOT> is the root directory of the android tree and <TARGET> is the lunch target name

Then Build SL4A:

cd <ANDROID_SOURCE_ROOT>/external/sl4a
mm [-j15]

Adding SL4A Builds to Android Builds by Default

If you are not using a custom buildspec, create one as follows:

 cp <ANDROID_SOURCE_ROOT>/build/buildspec.mk.default <ANDROID_SOURCE_ROOT>/buildspec.mk

Modify the buildspec to build SL4A as a custom module by editing the line ‘#CUSTOM_MODULES:=’ to ‘CUSTOM_MODULES:=sl4a’:
```
 sed -i 's/#CUSTOM_MODULES:=/CUSTOM_MODULES:=sl4a/' <ANDROID_SOURCE_ROOT>/buildspec.mk
```

Install Instructions

Run the following command:

adb install -r <ANDROID_SOURCE_ROOT>/out/target/product/<TARGET>/data/app/sl4a/sl4a.apk

Run Instructions

a) SL4A may be launched from Android as a normal App; or
b) To enable RPC access from the command prompt:

adb forward tcp:<HOST_PORT_NUM> tcp:<DEVICE_PORT_NUM>
adb shell "am start -a com.googlecode.android_scripting.action.LAUNCH_SERVER \
           --ei com.googlecode.android_scripting.extra.USE_SERVICE_PORT <DEVICE_PORT_NUM> \
           com.googlecode.android_scripting/.activity.ScriptingLayerServiceLauncher"

where <HOST_PORT_NUM> and <DEVICE_PORT_NUM> are the tcp ports on the host computer and device.

Generate the API Documentation

From SL4A source directory run this command:

    python Docs/generate_api_reference_md.py

In the Docs directory there should now be an ApiReference.md file that contains which RPC functions are available in SL4A as well as documentation for the RPC functions.