Settings API¶

Control system settings including screen, sound, and network settings.

Screen Settings¶

setScreenTimeout()¶

Set the screen timeout value.

setScreenTimeout(value)

Parameters: - value (int): Screen timeout in seconds

Returns: Previous timeout value

getScreenTimeout()¶

Get the current screen timeout.

getScreenTimeout()

Returns: Current screen timeout in seconds

getScreenBrightness()¶

Get the screen brightness value.

getScreenBrightness()

Returns: Brightness value (0-255)

setScreenBrightness()¶

Set the screen brightness.

setScreenBrightness(value=None)

Parameters: - value (int, optional): Brightness value (0-255), or None for auto

Returns: Previous brightness value

checkScreenOn()¶

Check if the screen is on.

checkScreenOn()

Returns: True if screen is on, False otherwise

Airplane Mode¶

checkAirplaneMode()¶

Check if airplane mode is enabled.

checkAirplaneMode()

Returns: True if airplane mode is on

Ringer Settings¶

checkRingerSilentMode()¶

Check if ringer is in silent mode.

checkRingerSilentMode()

Returns: True if silent mode is on

toggleRingerSilentMode()¶

Toggle ringer silent mode.

toggleRingerSilentMode(enabled=None)

Parameters: - enabled (bool, optional): True to enable, False to disable, None to toggle

Returns: New state

toggleVibrateMode()¶

Toggle vibrate mode.

toggleVibrateMode(enabled=None, ringer=None)

Parameters: - enabled (bool, optional): Toggle vibrate on/off - ringer (bool, optional): Apply to ringer mode

Returns: New state

getVibrateMode()¶

Get the vibrate mode setting.

getVibrateMode(ringer=None)

Parameters: - ringer (bool, optional): Check ringer vibrate mode

Returns: True if vibrate is enabled

Volume Settings¶

getRingerVolume()¶

Get the current ringer volume.

getRingerVolume()

Returns: Ringer volume level (0-7 typically)

getMaxRingerVolume()¶

Get the maximum ringer volume.

getMaxRingerVolume()

Returns: Maximum ringer volume

setRingerVolume()¶

Set the ringer volume.

setRingerVolume(volume)

Parameters: - volume (int): Volume level

getMediaVolume()¶

Get the current media volume.

getMediaVolume()

Returns: Media volume level (0-15 typically)

getMaxMediaVolume()¶

Get the maximum media volume.

getMaxMediaVolume()

Returns: Maximum media volume

setMediaVolume()¶

Set the media volume.

setMediaVolume(volume)

Parameters: - volume (int): Volume level

System Info¶

elapsedRealtimeNanos()¶

Get nanoseconds since system startup.

elapsedRealtimeNanos()

Returns: Nanoseconds (can be used for timing)

getTrafficStats()¶

Get network traffic statistics.

getTrafficStats(flags=7)

Parameters: - flags (int): Which stats to retrieve (default: 7 = all)

Returns: Dict with transmit/receive bytes

getAppTxBytes()¶

Get transmit bytes for QPython app.

getAppTxBytes(packageName)

Parameters: - packageName (str): Package name

Returns: Dict with tx/rx bytes

Usage Example¶

import androidhelper

droid = androidhelper.Android()

# Screen settings
current_timeout = droid.getScreenTimeout().result
print(f"Current timeout: {current_timeout}s")
droid.setScreenTimeout(30)

# Check screen
if droid.checkScreenOn().result:
    print("Screen is on")

# Volume control
media_vol = droid.getMediaVolume().result
print(f"Media volume: {media_vol}")
droid.setMediaVolume(10)

# Check airplane mode
if droid.checkAirplaneMode().result:
    print("Airplane mode is on")