API reference

This is the reference of Scriptmanager API.

For each property you may find :

Android API compatibility level.
Underlying properties.
Usage and expected output if any.

usage

expected output

Bluetooth

bluetoothLEScanCallback _{try it}

Implementation here

function bluetoothLEScanCallback() {
     #rssi,ts,asid,dataStatus,remote,period,phy,phy2,txP,isConnectable,isLegacy
     echo "$@";
}

activate _{try it}

Android API level : 5+
Implementation here
Implementation here

bluetooth activate false;
sleep 1;
bluetooth activate true;
sleep 5;

setName _{try it}

Implementation here

bluetooth setName "myadaptater"

scan _{try it}

LowEnergyScan start the scan the first time then call it to get some results
Android API level : 18+
Implementation here
Implementation here

bluetooth scan;

stopScan _{try it}

Stop the scanner
Implementation here

bluetooth stopScan

getAddress _{try it}

API 23 will return 02:00:00:00:00:00
Android API level : 5-22
Implementation here

bluetooth getAddress;

02:00:00:00:00:00

getBondedDevices _{try it}

Android API level : 5+
Implementation here

bluetooth getBondedDevices;

02:00:00:00:00:00
11:22:33:44:55:66

getLeMaximumAdvertisingDataLength _{try it}

Android API level : 26+
Implementation here

bluetooth getLeMaximumAdvertisingDataLength

0 => LE unsupported
5

getName _{try it}

Android API level : 5+
Implementation here

bluetooth getName

getProfileConnectionState _{try it}

Android API level : 14+
Implementation here

bluetooth getProfileConnectionState HEADSET;
bluetooth getProfileConnectionState A2DP;

STATE_DISCONNECTED
STATE_DISCONNECTING
STATE_CONNECTED
STATE_CONNECTING

getScanMode _{try it}

Android API level : 5+
Implementation here

bluetooth getScanMode

SCAN_MODE_NONE
SCAN_MODE_CONNECTABLE
SCAN_MODE_CONNECTABLE_DISCOVERABLE

getState _{try it}

Android API level : 5+
Implementation here

bluetooth getState;

STATE_OFF
STATE_TURNING_ON
STATE_ON
STATE_TURNING_OFF

isDiscovering _{try it}

Android API level : 5+
Implementation here

bluetooth isDiscovering;

true
false

isEnabled _{try it}

Android API level : 5+
Implementation here

bluetooth isEnabled

true
false

isLe2MPhySupported _{try it}

Android API level : 26+
Implementation here

bluetooth isLe2MPhySupported

true
false

isLeCodedPhySupported _{try it}

Android API level : 26+
Implementation here

bluetooth isLeCodedPhySupported;

true
false

isLeExtendedAdvertisingSupported _{try it}

Android API level : 26+
Implementation here

bluetooth isLeExtendedAdvertisingSupported;

isLePeriodicAdvertisingSupported _{try it}

Android API level : 26+
Implementation here

bluetooth isLePeriodicAdvertisingSupported;

isMultipleAdvertisementSupported _{try it}

Android API level : 21+
Implementation here

bluetooth isMultipleAdvertisementSupported

true
false

isOffloadedFilteringSupported _{try it}

Android API level : 21+
Implementation here

bluetooth isOffloadedFilteringSupported

true
false

isOffloadedScanBatchingSupported _{try it}

Android API level : 21+
Implementation here

bluetooth isOffloadedScanBatchingSupported

true
false

checkAddress _{try it}

Android API level : 5+
Implementation here

bluetooth checkAddress "11:22:33:44:55:66";
bluetooth checkAddress "azeknaze";

true
false

LEAstartAdvertising _{try it}

Android API level : 21+
Implementation here

bluetooth LEAstartAdvertising ADVERTISE_MODE_LOW_POWER true 10000 ADVERTISE_TX_POWER_HIGH 0 "" "00001101-0000-1000-8000-00805F9B34FB" "" true true;

10000 ADVERTISE_TX_POWER_HIGH true

Camera

Http

httpResponse _{try it}

handle http response
Android API level : 1+
Implementation here

function httpResponse() {
   method="$1";
   response_body="$2";
   response_headers="$3";
   echo "httpResponse ${method}";
   echo "${response_headers}";
   echo "Your ip is ${response_body}";
}
echo "get";
http get "https://gorest.co.in/public-api/users" "Accept: application/json" ;
http get "https://gorest.co.in/public-api/users" "Accept: application/html" ;

echo "delete";
#http delete "https://gorest.co.in/public-api/users/123" "Accept: application/json" "Content-Type: applicanntion/jsobb. n" "Authorization: Beajhhhrer ACCESS-TOKEN"
http delete "https://gorest.co.in/public-api/users/123" "Accept: application/json" "Content-Type: application/json" "Authorization: Bearer ACCESS-TOKEN"

echo "post";
jd='{"name":"Tenali Ramakrishna", "gender":"Male", "email":"[email protected]", "status":"Active"}';
http post "${jd}" "https://gorest.co.in/public-api/users" "Accept:application/json" "Content-Type:application/json" "Authorization: Bearer ACCESS-TOKEN"

sleep 10;
echo "settings";
http settings;
http settings list;
http settings get cookies;
http settings put cookies=false;
sleep 2;
http settings put cookies=true;
sleep 2;
http settings;

TODO

http _{try it}

Android API level : 1+
Implementation here

echo "get";
http get "https://gorest.co.in/public-api/users" "Accept: application/json" ;
http get "https://gorest.co.in/public-api/users" "Accept: application/html" ;

echo "delete";
#http delete "https://gorest.co.in/public-api/users/123" "Accept: application/json" "Content-Type: applicanntion/jsobb. n" "Authorization: Beajhhhrer ACCESS-TOKEN"
http delete "https://gorest.co.in/public-api/users/123" "Accept: application/json" "Content-Type: application/json" "Authorization: Bearer ACCESS-TOKEN"

echo "post";
jd='{"name":"Tenali Ramakrishna", "gender":"Male", "email":"[email protected]", "status":"Active"}';
http post "${jd}" "https://gorest.co.in/public-api/users" "Accept:application/json" "Content-Type:application/json" "Authorization: Bearer ACCESS-TOKEN"

sleep 10;
echo "settings";
http settings;
http settings list;
http settings get cookies;
http settings put cookies=false;
sleep 2;
http settings put cookies=true;
sleep 2;
http settings;

Mod

Notification

show _{try it}

Icon could be "alert", "play", "pause", "delete", "power", "lock"
Android API level : 14+
Implementation here

notification show "Test" "something play" "play";
notification show "Test" "pause notification" "pause";
notification show "Test" "delete notification" "delete";
notification show "Test" "power notification" "power";
notification show "Test" "lock notification" "lock";
notification show "Test" "alert notification" "alert";
notification show "Simple notification";

Test

TTS

speak _{try it}

Android API level : 4+
Implementation here
Implementation here

tts speak "This is a test"
tts speak "This is a test" en_GB

isLanguageAvailable _{try it}

Android API level : 4+
Implementation here

tts isLanguageAvailable en_GB

true
false

isSpeaking _{try it}

Android API level : 4+
Implementation here

tts isSpeaking

true
false

setPitch _{try it}

Android API level : 4+
Implementation here

tts setPitch 1.0
tts setPitch 2.0

error
success

setSpeechRate _{try it}

Android API level : 4+
Implementation here

tts setSpeechRate 1.0

error
success

shutdown _{try it}

Android API level : 4+
Implementation here

tts shutdown

Wifi

wifiGetConfiguredNetworksReceived _{try it}

function wifiGetConfiguredNetworksReceived() {
     ssid="$1";
     bssid="$2";
     hidden="$3";
     echo "Hotspot: ${ssid}(${bssid})/hidden=${hidden}";
}
wifi getConfiguredNetworks;

Hotspot: .*

wifiGetScanResultsRecv _{try it}

To use this function, you have to manually activate wifi, otherwise it will raise an error notification

function wifiGetScanResultsRecv() {
     ssid="$1";bssid="$2";capabilities="$3";
     frequency="$4";level="$5";
     timestamp="$6"; # empty if API < 17
     ## empty if API < 23
       centerFreq0="$7";centerFreq1="$8";channelWidth="$9";
     ##
     echo "Wifi AP found : ssid=$ssid,bssid=$bssid,capabilities=$capabilities,frequency=$frequency,level=$level,timestamp=$timestamp,centerFreq0=$centerFreq0,centerFreq1=$centerFreq1,channelWidth=$channelWidth";
}
wifi getScanResults;

Wifi AP found : ssid=testnet,bssid=00:00:00:00:00:00,capabilities=[WPA2-PSK-CCMP],frequency=2412,level=-80,timestamp=1615469755,centerFreq0=0,centerFreq1=0,channelWidth=0

LocalOnlyHotspotCallback _{try it}

Implementation here

function LocalOnlyHotspotCallback() {
    type="$1";
    optionnal="$2";
    echo "$type $optionnal";
}
wifi startLocalOnlyHotspot;

stopped
started
failed ERROR_TETHERING_DISALLOWED
failed ERROR_GENERIC
failed ERROR_INCOMPATIBLE_MODE
failed ERROR_NO_CHANNEL

getSoftApConfiguration _{try it}

Android API level : 26+
Implementation here
Implementation here

wifi startLocalOnlyHotspot
wifi getSoftApConfiguration;

AndroidShare_1000 false mymdp SECURITY_TYPE_WPA3_SAE_TRANSITION 02:00:00:00:00:00
AndroidShare_1000 true  mymdp SECURITY_TYPE_WPA3_SAE_TRANSITION 02:00:00:00:00:00
AndroidShare_1000 false mymdp

stopLocalOnlyHotspot _{try it}

Android API level : 26+
Implementation here

wifi stopLocalOnlyHotspot;

true
false

startLocalOnlyHotspot _{try it}

Android API level : 26+
Implementation here

wifi startLocalOnlyHotspot

startScan _{try it}

On SDK 28 and later the scan is trigger by indirect way rather than startScan
Android API level : 1+
Implementation here

wifi startScan

getConfiguredNetworks _{try it}

Android API level : 1-28
Implementation here

wifi getConfiguredNetworks;

addNetwork _{try it}

Android API level : 1+
Implementation here

wifi addNetwork "testnet" "password";
wifi addNetwork "testnet2";

activate _{try it}

Android API level : 1-28
Implementation here

wifi activate true ;
sleep 5;
wifi activate false ;

getScanResults _{try it}

Android API level : 1+
Implementation here

wifi getScanResults ;

isEnabled _{try it}

Android API level : 1+
Implementation here

wifi isEnabled;

true
false

getState _{try it}

Android API level : 1+
Implementation here

wifi getState;

enabled
disabled
enabling
disabling
unknow

getMaxSignalLevel _{try it}

Android API level : 30+
Implementation here

wifi getMaxSignalLevel;

calculateSignalLevel _{try it}

Android API level : 30+
Implementation here
Implementation here

wifi calculateSignalLevel -60;

compareSignalLevel _{try it}

Android API level : 1+
Implementation here

wifi compareSignalLevel -60 -65;

Returns <0 if the first signal is weaker than the second signal, 0 if the two signals have the same strength, and >0 if the first signal is stronger than the second signal.

is5GHzBandSupported _{try it}

Android API level : 21+
Implementation here

wifi is5GHzBandSupported;

true
false

is6GHzBandSupported _{try it}

Android API level : 30+
Implementation here

wifi is6GHzBandSupported;

true
false

isAutoWakeupEnabled _{try it}

Android API level : 30+
Implementation here

wifi isAutoWakeupEnabled;

true
false

isDeviceToApRttSupported _{try it}

Android API level : 21+
Implementation here

wifi isDeviceToApRttSupported

true
false

isEasyConnectSupported _{try it}

Android API level : 29+
Implementation here

wifi isEasyConnectSupported

true
false

isEnhancedOpenSupported _{try it}

Android API level : 29+
Implementation here

wifi isEnhancedOpenSupported

true
false

isEnhancedPowerReportingSupported _{try it}

Android API level : 21+
Implementation here

wifi isEnhancedPowerReportingSupported

true
false

isP2pSupported _{try it}

Android API level : 21+
Implementation here

wifi isP2pSupported

true
false

isPreferredNetworkOffloadSupported _{try it}

Android API level : 21+
Implementation here

wifi isPreferredNetworkOffloadSupported

true
false

isScanAlwaysAvailable _{try it}

Android API level : 18-28
Implementation here

wifi isScanAlwaysAvailable

true
false

isStaApConcurrencySupported _{try it}

Android API level : 30+
Implementation here

wifi isStaApConcurrencySupported

true
false

isScanThrottleEnabled _{try it}

Android API level : 30+
Implementation here

wifi isScanThrottleEnabled

true
false

isTdlsSupported _{try it}

Android API level : 21+
Implementation here

wifi isTdlsSupported

true
false

isWapiSupported _{try it}

Android API level : 30+
Implementation here

wifi isWapiSupported

true
false

isStandardSupported _{try it}

Android API level : 30+
Implementation here

wifi isStandardSupported unknow
wifi isStandardSupported legacy
wifi isStandardSupported 11n
wifi isStandardSupported 11ac
wifi isStandardSupported 11ax

true
false

isWpa3SaeSupported _{try it}

Android API level : 29+
Implementation here

wifi isWpa3SaeSupported

true
false

isWpa3SuiteBSupported _{try it}

Android API level : 29+
Implementation here

wifi isWpa3SuiteBSupported

true
false

wakeLockAcquire _{try it}

Android API level : 1+
Implementation here

wifi wakeLockAcquire

wakeLockRelease _{try it}

Android API level : 1+
Implementation here

wifi wakeLockRelease

wakeLockIsHeld _{try it}

Android API level : 1+
Implementation here

wifi wakeLockIsHeld

true
false

setTdlsEnabled _{try it}

Android API level : 19+
Implementation here
Implementation here

wifi setTdlsEnabled "02:00:00:00:00:00" true;
wifi setTdlsEnabled "02:00:00:00:00:00" false;
wifi setTdlsEnabled "127.0.0.1" false;
wifi setTdlsEnabled "127.0.0.1" true;

getConnectionInfo _{try it}

Android API level : 1-30
Implementation here

wifi getConnectionInfo;

#ssid bssid hidden mac rssi frequency passpfn getRxLinkSpeedMbps getTxLinkSpeedMbps getWifiStandard
testnet 02:00:00:00:00:00 false 02:00:00:00:00:00 5 2412 test 2.1 0.5 11n

API - ReleaseStandard/ScriptManagerFree GitHub Wiki

API reference

Bluetooth

bluetoothLEScanCallback try it

activate try it

setName try it

scan try it

stopScan try it

getAddress try it

getBondedDevices try it

getLeMaximumAdvertisingDataLength try it

getName try it

getProfileConnectionState try it

getScanMode try it

getState try it

isDiscovering try it

isEnabled try it

isLe2MPhySupported try it

isLeCodedPhySupported try it

isLeExtendedAdvertisingSupported try it

isLePeriodicAdvertisingSupported try it

isMultipleAdvertisementSupported try it

isOffloadedFilteringSupported try it

isOffloadedScanBatchingSupported try it

checkAddress try it

LEAstartAdvertising try it

Camera

Http

httpResponse try it

http try it

Mod

Notification

show try it

Test

TTS

speak try it

isLanguageAvailable try it

isSpeaking try it

setPitch try it

setSpeechRate try it

shutdown try it

Wifi

wifiGetConfiguredNetworksReceived try it

wifiGetScanResultsRecv try it

LocalOnlyHotspotCallback try it

getSoftApConfiguration try it

stopLocalOnlyHotspot try it

startLocalOnlyHotspot try it

startScan try it

getConfiguredNetworks try it

addNetwork try it

activate try it

getScanResults try it

isEnabled try it

getState try it

getMaxSignalLevel try it

calculateSignalLevel try it

compareSignalLevel try it

is5GHzBandSupported try it

is6GHzBandSupported try it

isAutoWakeupEnabled try it

isDeviceToApRttSupported try it

isEasyConnectSupported try it

isEnhancedOpenSupported try it

isEnhancedPowerReportingSupported try it

isP2pSupported try it

isPreferredNetworkOffloadSupported try it

isScanAlwaysAvailable try it

isStaApConcurrencySupported try it

isScanThrottleEnabled try it

isTdlsSupported try it

isWapiSupported try it

isStandardSupported try it

isWpa3SaeSupported try it

isWpa3SuiteBSupported try it

wakeLockAcquire try it

wakeLockRelease try it

wakeLockIsHeld try it

setTdlsEnabled try it

getConnectionInfo try it

bluetoothLEScanCallback _{try it}

activate _{try it}

setName _{try it}

scan _{try it}

stopScan _{try it}

getAddress _{try it}

getBondedDevices _{try it}

getLeMaximumAdvertisingDataLength _{try it}

getName _{try it}

getProfileConnectionState _{try it}

getScanMode _{try it}

getState _{try it}

isDiscovering _{try it}

isEnabled _{try it}

isLe2MPhySupported _{try it}

isLeCodedPhySupported _{try it}

isLeExtendedAdvertisingSupported _{try it}

isLePeriodicAdvertisingSupported _{try it}

isMultipleAdvertisementSupported _{try it}

isOffloadedFilteringSupported _{try it}

isOffloadedScanBatchingSupported _{try it}

checkAddress _{try it}

LEAstartAdvertising _{try it}

httpResponse _{try it}

http _{try it}

show _{try it}

speak _{try it}

isLanguageAvailable _{try it}

isSpeaking _{try it}

setPitch _{try it}

setSpeechRate _{try it}

shutdown _{try it}

wifiGetConfiguredNetworksReceived _{try it}

wifiGetScanResultsRecv _{try it}

LocalOnlyHotspotCallback _{try it}

getSoftApConfiguration _{try it}

stopLocalOnlyHotspot _{try it}

startLocalOnlyHotspot _{try it}

startScan _{try it}

getConfiguredNetworks _{try it}

addNetwork _{try it}

activate _{try it}

getScanResults _{try it}

isEnabled _{try it}

getState _{try it}

getMaxSignalLevel _{try it}

calculateSignalLevel _{try it}

compareSignalLevel _{try it}

is5GHzBandSupported _{try it}

is6GHzBandSupported _{try it}

isAutoWakeupEnabled _{try it}

isDeviceToApRttSupported _{try it}

isEasyConnectSupported _{try it}

isEnhancedOpenSupported _{try it}

isEnhancedPowerReportingSupported _{try it}

isP2pSupported _{try it}

isPreferredNetworkOffloadSupported _{try it}

isScanAlwaysAvailable _{try it}

isStaApConcurrencySupported _{try it}

isScanThrottleEnabled _{try it}

isTdlsSupported _{try it}

isWapiSupported _{try it}

isStandardSupported _{try it}

isWpa3SaeSupported _{try it}

isWpa3SuiteBSupported _{try it}

wakeLockAcquire _{try it}

wakeLockRelease _{try it}

wakeLockIsHeld _{try it}

setTdlsEnabled _{try it}

getConnectionInfo _{try it}

⚠️ GitHub.com Fallback ⚠️