Google Git
Sign in
android / platform / external / sl4a / 94a9a3258564d62e367e9e61ddeb7a707338ea49
commit94a9a3258564d62e367e9e61ddeb7a707338ea49[log] [tgz]
authorTreehugger Robot <treehugger-gerrit@google.com>Tue Feb 28 19:33:24 2023 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Tue Feb 28 19:33:24 2023 +0000
tree7cab0974101f2dc35a727b463de59f0dfc8529a4
parent3dad1cabd086cd3b19be48a39cfcd26198991da3 [diff]
parent0ca0039118acb8ebbd313451068a40c2e82283c9 [diff]
Merge "Renamed name source to display name source" am: 0ca0039118

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

Change-Id: I5b835f981c6873fb08b00e7d15d67f18b8899f56
Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
tree: 7cab0974101f2dc35a727b463de59f0dfc8529a4
  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>/testcases/sl4a/arm64/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.