Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / sl4a / a99bc17911f88a9c8704122c5e6114bbe7dee8a1
commita99bc17911f88a9c8704122c5e6114bbe7dee8a1[log] [tgz]
authorAmit Mahajan <amitmahajan@google.com>Mon Jun 07 17:06:06 2021 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Mon Jun 07 17:06:06 2021 +0000
tree212d906b60581587216f920f6b09645163e1d28d
parent7c97bdf62c15a2d1c4b50c71d69905a907cbbb3f [diff]
parent283ebda050a92cdf9fbf42099b6c3e2b58a524e1 [diff]
Update API name to match source code change. am: 283ebda050

Original change: https://googleplex-android-review.googlesource.com/c/platform/external/sl4a/+/14847238

Change-Id: I7e680b0b7bc367e1ba65b50a6788006499140fbd
tree: 212d906b60581587216f920f6b09645163e1d28d
  1. Common/
  2. Docs/
  3. InterpreterForAndroid/
  4. ScriptingLayer/
  5. ScriptingLayerForAndroid/
  6. Utils/
  7. Android.bp
  8. METADATA
  9. MODULE_LICENSE_APACHE2
  10. NOTICE
  11. OWNERS
  12. PREUPLOAD.cfg
  13. README.md
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

  1. 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

  2. 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.