Clipboard APIs¶

setClipboard(text)¶

Put text in the clipboard

Parameters

text (str) – text

getClipboard(text)¶

Read text from the clipboard

Returns

The text in the clipboard

from androidhelper import Android
droid = Android()

#setClipboard
droid.setClipboard("Hello World")

#getClipboard
clipboard = droid.getClipboard().result

Intent & startActivity APIs¶

makeIntent(action, uri, type, extras, categories, packagename, classname, flags)¶

Starts an activity and returns the result

Parameters

• action (str) – action

• uri(Optional) (str) – uri

• type(Optional) (str) – MIME type/subtype of the URI

• extras(Optional) (object) – a Map of extras to add to the Intent

• categories(Optional) (list) – a List of categories to add to the Intent

• packagename(Optional) (str) – name of package. If used, requires classname to be useful

• classname(Optional) (str) – name of class. If used, requires packagename to be useful

• flags(Optional) (int) – Intent flags

Returns

An object representing an Intent

sample code to show makeIntent

getIntent()¶

Returns the intent that launched the script

sample code to show getIntent

startActivityForResult(action, uri, type, extras, packagename, classname)¶

Starts an activity and returns the result

Parameters

• action (str) – action

• uri(Optional) (str) – uri

• type(Optional) (str) – MIME type/subtype of the URI

• extras(Optional) (object) – a Map of extras to add to the Intent

• packagename(Optional) (str) – name of package. If used, requires classname to be useful

• classname(Optional) (str) – name of class. If used, requires packagename to be useful

Returns

A Map representation of the result Intent

sample code to show startActivityForResult

startActivityForResultIntent(intent)¶

Starts an activity and returns the result

Parameters

intent (Intent) – Intent in the format as returned from makeIntent

Returns

A Map representation of the result Intent

sample code to show startActivityForResultIntent

startActivityIntent(intent, wait)¶

Starts an activity

Parameters

• intent (Intent) – Intent in the format as returned from makeIntent

• wait(Optional) (bool) – block until the user exits the started activity

sample code to show startActivityIntent

startActivity(action, uri, type, extras, wait, packagename, classname)¶

Starts an activity

Parameters

• action (str) – action

• uri(Optional) (str) – uri

• type(Optional) (str) – MIME type/subtype of the URI

• extras(Optional) (object) – a Map of extras to add to the Intent

• wait(Optional) (bool) – block until the user exits the started activity

• packagename(Optional) (str) – name of package. If used, requires classname to be useful

• classname(Optional) (str) – name of class. If used, requires packagename to be useful

sample code to show startActivityForResultIntent

SendBroadcast APIs¶

sendBroadcast(action, uri, type, extras, packagename, classname)¶

Send a broadcast

Parameters

• action (str) – action

• uri(Optional) (str) – uri

• type(Optional) (str) – MIME type/subtype of the URI

• extras(Optional) (object) – a Map of extras to add to the Intent

• packagename(Optional) (str) – name of package. If used, requires classname to be useful

• classname(Optional) (str) – name of class. If used, requires packagename to be useful

sample code to show sendBroadcast

sendBroadcastIntent(intent)¶

Send a broadcast

Parameters

intent (Intent) – Intent in the format as returned from makeIntent

sample code to show sendBroadcastIntent

Vibrate¶

vibrate(intent)¶

Vibrates the phone or a specified duration in milliseconds

Parameters

duration (int) – duration in milliseconds

sample code to show vibrate

NetworkStatus¶

getNetworkStatus()¶

Returns the status of network connection

sample code to show getNetworkStatus

PackageVersion APIs¶

requiredVersion(requiredVersion)¶

Checks if version of QPython SL4A is greater than or equal to the specified version

Parameters

requiredVersion (int) – requiredVersion

Returns

true or false

getPackageVersionCode(packageName)¶

Returns package version code

Parameters

packageName (str) – packageName

Returns

Package version code

getPackageVersion(packageName)¶

Returns package version name

Parameters

packageName (str) – packageName

Returns

Package version name

sample code to show getPackageVersionCode & getPackageVersion

System APIs¶

getConstants(classname)¶

Get list of constants (static final fields) for a class

Parameters

classname (str) – classname

Returns

list

sample code to show getConstants

environment()¶

A map of various useful environment details

Returns

environment map object includes id, display, offset, TZ, SDK, download, appcache, availblocks, blocksize, blockcount, sdcard

sample code to show environment

log(message)¶

Writes message to logcat

Parameters

message (str) – message

sample code to show log

SendEmail¶

sendEmail(to, subject, body, attachmentUri)¶

Launches an activity that sends an e-mail message to a given recipient

Parameters

• to (str) – A comma separated list of recipients

• subject (str) – subject

• body (str) – mail body

• attachmentUri(Optional) (str) – message

sample code to show sendEmail

Toast, getInput, getPassword, notify APIs¶

makeToast(message)¶

Displays a short-duration Toast notification

Parameters

message (str) – message

sample code to show makeToast

getInput(title, message)¶

Queries the user for a text input

Parameters

• title (str) – title of the input box

• message (str) – message to display above the input box

sample code to show getInput

getPassword(title, message)¶

Queries the user for a password

Parameters

• title (str) – title of the input box

• message (str) – message to display above the input box

sample code to show getPassword

notify(title, message, url)¶

Displays a notification that will be canceled when the user clicks on it

Parameters

• title (str) – title

• message (str) – message

• url(optional) (str) – url

::

import androidhelper droid = androidhelper.Android() droid.notify(‘Hello’,’QPython’,’http://qpython.org’) # you could set the 3rd parameter None also

Manager APIs¶

getLaunchableApplications()¶

Returns a list of all launchable application class names

Returns

map object

sample code to show getLaunchableApplications

launch(classname)¶

Start activity with the given class name

Parameters

classname (str) – classname

sample code to show launch

getRunningPackages()¶

Returns a list of packages running activities or services

Returns

List of packages running activities

sample code to show getRunningPackages

forceStopPackage(packageName)¶

Force stops a package

Parameters

packageName (str) – packageName

sample code to show forceStopPackage

Barcode¶

scanBarcode()¶

Starts the barcode scanner

Returns

A Map representation of the result Intent

View APIs¶

pick(uri)¶

Display content to be picked by URI (e.g. contacts)

Returns

A map of result values

view(uri, type, extras)¶

Start activity with view action by URI (i.e. browser, contacts, etc.)

viewMap(query)¶

Opens a map search for query (e.g. pizza, 123 My Street)

viewContacts()¶

Opens the list of contacts

viewHtml(path)¶

Opens the browser to display a local HTML file

search(query)¶

Starts a search for the given query

Providers APIs¶

locationProviders()¶

Returns availables providers on the phone

locationProviderEnabled(provider)¶

Ask if provider is enabled

Location APIs¶

startLocating(minDistance, minUpdateDistance)¶

Starts collecting location data

readLocation()¶

Returns the current location as indicated by all available providers

Returns

A map of location information by provider

stopLocating()¶

Stops collecting location data

getLastKnownLocation()¶

Returns the last known location of the device

Returns

A map of location information by provider

sample code

Droid = androidhelper.Android()
location = Droid.getLastKnownLocation().result
location = location.get('network', location.get('gps'))

GEO¶

geocode(latitude, longitude, maxResults)¶

Returns a list of addresses for the given latitude and longitude

Returns

A list of addresses

PhoneStat APIs¶

startTrackingPhoneState()¶

Starts tracking phone state

readPhoneState()¶

Returns the current phone state and incoming number

Returns

A Map of “state” and “incomingNumber”

stopTrackingPhoneState()¶

Stops tracking phone state

Call & Dia APIs¶

phoneCall(uri)¶

Calls a contact/phone number by URI

phoneCallNumber(number)¶

Calls a phone number

phoneDial(uri)¶

Dials a contact/phone number by URI

phoneDialNumber(number)¶

Dials a phone number

Get information APIs¶

getCellLocation()¶

Returns the current cell location

getNetworkOperator()¶

Returns the numeric name (MCC+MNC) of current registered operator

getNetworkOperatorName()¶

Returns the alphabetic name of current registered operator

getNetworkType()¶

Returns a the radio technology (network type) currently in use on the device

getPhoneType()¶

Returns the device phone type

getSimCountryIso()¶

Returns the ISO country code equivalent for the SIM provider’s country code

getSimOperator()¶

Returns the MCC+MNC (mobile country code + mobile network code) of the provider of the SIM. 5 or 6 decimal digits

getSimOperatorName()¶

Returns the Service Provider Name (SPN)

getSimSerialNumber()¶

Returns the serial number of the SIM, if applicable. Return null if it is unavailable

getSimState()¶

Returns the state of the device SIM card

getSubscriberId()¶

Returns the unique subscriber ID, for example, the IMSI for a GSM phone. Return null if it is unavailable

getVoiceMailAlphaTag()¶

Retrieves the alphabetic identifier associated with the voice mail number

getVoiceMailNumber()¶

Returns the voice mail number. Return null if it is unavailable

checkNetworkRoaming()¶

Returns true if the device is considered roaming on the current network, for GSM purposes

getDeviceId()¶

Returns the unique device ID, for example, the IMEI for GSM and the MEID for CDMA phones. Return null if device ID is not available

getDeviceSoftwareVersion()¶

Returns the software version number for the device, for example, the IMEI/SV for GSM phones. Return null if the software version is not available

getLine1Number()¶

Returns the phone number string for line 1, for example, the MSISDN for a GSM phone. Return null if it is unavailable

getNeighboringCellInfo()¶

Returns the neighboring cell information of the device

Audio¶

recorderStartMicrophone(targetPath)¶

Records audio from the microphone and saves it to the given location

Video APIs¶

recorderStartVideo(targetPath, duration, videoSize)¶

Records video from the camera and saves it to the given location. Duration specifies the maximum duration of the recording session. If duration is 0 this method will return and the recording will only be stopped when recorderStop is called or when a scripts exits. Otherwise it will block for the time period equal to the duration argument. videoSize: 0=160x120, 1=320x240, 2=352x288, 3=640x480, 4=800x480.

recorderCaptureVideo(targetPath, duration, recordAudio)¶

Records video (and optionally audio) from the camera and saves it to the given location. Duration specifies the maximum duration of the recording session. If duration is not provided this method will return immediately and the recording will only be stopped when recorderStop is called or when a scripts exits. Otherwise it will block for the time period equal to the duration argument.

startInteractiveVideoRecording(path)¶

Starts the video capture application to record a video and saves it to the specified path

Stop¶

recorderStop()¶

Stops a previously started recording

Start & Stop¶

startSensingTimed(sensorNumber, delayTime)¶

Starts recording sensor data to be available for polling

startSensingThreshold(ensorNumber, threshold, axis)¶

Records to the Event Queue sensor data exceeding a chosen threshold

startSensing(sampleSize)¶

Starts recording sensor data to be available for polling

stopSensing()¶

Stops collecting sensor data

Read data APIs¶

readSensors()¶

Returns the most recently recorded sensor data

sensorsGetAccuracy()¶

Returns the most recently received accuracy value

sensorsGetLight()¶

Returns the most recently received light value

sensorsReadAccelerometer()¶

Returns the most recently received accelerometer values

Returns

a List of Floats [(acceleration on the) X axis, Y axis, Z axis]

sensorsReadMagnetometer()¶

Returns the most recently received magnetic field values

Returns

a List of Floats [(magnetic field value for) X axis, Y axis, Z axis]

sensorsReadOrientation()¶

Returns the most recently received orientation values

Returns

a List of Doubles [azimuth, pitch, roll]

sample code

Droid = androidhelper.Android()
Droid.startSensingTimed(1, 250)
sensor = Droid.sensorsReadOrientation().result
Droid.stopSensing()

Screen¶

setScreenTimeout(value)¶

Sets the screen timeout to this number of seconds

Returns

The original screen timeout

getScreenTimeout()¶

Gets the screen timeout

Returns

the current screen timeout in seconds

AirplanerMode¶

checkAirplaneMode()¶

Checks the airplane mode setting

Returns

True if airplane mode is enabled

toggleAirplaneMode(enabled)¶

Toggles airplane mode on and off

Returns

True if airplane mode is enabled

Ringer Silent Mode¶

checkRingerSilentMode()¶

Checks the ringer silent mode setting

Returns

True if ringer silent mode is enabled

toggleRingerSilentMode(enabled)¶

Toggles ringer silent mode on and off

Returns

True if ringer silent mode is enabled

Vibrate Mode¶

toggleVibrateMode(enabled)¶

Toggles vibrate mode on and off. If ringer=true then set Ringer setting, else set Notification setting

Returns

True if vibrate mode is enabled

getVibrateMode(ringer)¶

Checks Vibration setting. If ringer=true then query Ringer setting, else query Notification setting

Returns

True if vibrate mode is enabled

Ringer & Media Volume¶

getMaxRingerVolume()¶

Returns the maximum ringer volume

getRingerVolume()¶

Returns the current ringer volume

setRingerVolume(volume)¶

Sets the ringer volume

getMaxMediaVolume()¶

Returns the maximum media volume

getMediaVolume()¶

Returns the current media volume

setMediaVolume(volume)¶

Sets the media volume

Screen Brightness¶

getScreenBrightness()¶

Returns the screen backlight brightness

Returns

the current screen brightness between 0 and 255

setScreenBrightness(value)¶

Sets the the screen backlight brightness

Returns

the original screen brightness

checkScreenOn()¶

Checks if the screen is on or off (requires API level 7)

Returns

True if the screen is currently on

Control¶

mediaPlay(url, tag, play)¶

Open a media file

Parameters

• url (str) – url of media resource

• tag(optional) (str) – string identifying resource (default=default)

• play(optional) (bool) – start playing immediately

Returns

true if play successful

mediaPlayPause(tag)¶

pause playing media file

Parameters

tag (str) – string identifying resource (default=default)

Returns

true if successful

mediaPlayStart(tag)¶

start playing media file

Parameters

tag (str) – string identifying resource (default=default)

Returns

true if successful

mediaPlayClose(tag)¶

Close media file

Parameters

tag (str) – string identifying resource (default=default)

Returns

true if successful

mediaIsPlaying(tag)¶

Checks if media file is playing

Parameters

tag (str) – string identifying resource (default=default)

Returns

true if successful

mediaPlaySetLooping(enabled, tag)¶

Set Looping

Parameters

• enabled (bool) – default true

• tag (str) – string identifying resource (default=default)

Returns

True if successful

mediaPlaySeek(msec, tag)¶

Seek To Position

Parameters

• msec (int) – default true

• tag (str) – string identifying resource (default=default)

Returns

New Position (in ms)

Get Information¶

mediaPlayInfo(tag)¶

Information on current media

Parameters

tag (str) – string identifying resource (default=default)

Returns

Media Information

mediaPlayList()¶

Lists currently loaded media

Returns

List of Media Tags

Dialog¶

dialogCreateInput(title, message, defaultText, inputType)¶

Create a text input dialog

Parameters

• title (str) – title of the input box

• message (str) – message to display above the input box

• defaultText(optional) (str) – text to insert into the input box

• inputType(optional) (str) – type of input data, ie number or text

dialogCreatePassword(title, message)¶

Create a password input dialog

Parameters

• title (str) – title of the input box

• message (str) – message to display above the input box

dialogGetInput(title, message, defaultText)¶

Create a password input dialog

Parameters

• title (str) – title of the input box

• message (str) – message to display above the input box

• defaultText(optional) (str) – text to insert into the input box

dialogGetPassword(title, message)¶

Queries the user for a password

Parameters

• title (str) – title of the password box

• message (str) – message to display above the input box

dialogCreateSeekBar(start, maximum, title)¶

Create seek bar dialog

Parameters

• start (int) – default=50

• maximum (int) – default=100

• title (int) – title

dialogCreateTimePicker(hour, minute, is24hour)¶

Create time picker dialog

Parameters

• hour (int) – default=0

• miute (int) – default=0

• is24hour (bool) – default=false

dialogCreateDatePicker(year, month, day)¶

Create date picker dialog

Parameters

• year (int) – default=1970

• month (int) – default=1

• day (int) – default=1

NFC¶

Data structs QPython NFC json result

{
"role": <role>, # could be self/master/slave
"stat": <stat>, # could be ok / fail / cancl
"message": <message get>
}

APIs

dialogCreateNFCBeamMaster(title, message, inputType)¶

Create a dialog where you could create a qpython beam master

Parameters

• title (str) – title of the input box

• message (str) – message to display above the input box

• inputType(optional) (str) – type of input data, ie number or text

NFCBeamMessage(content, title, message)¶

Create a dialog where you could create a qpython beam master

Parameters

• content (str) – message you want to sent

• title (str) – title of the input box

• message (str) – message to display above the input box

• inputType(optional) (str) – type of input data, ie number or text

dialogCreateNFCBeamSlave(title, message)¶

Create a qpython beam slave

Parameters

• title (str) – title of the input box

• message (str) – message to display above the input box

Progress¶

dialogCreateSpinnerProgress(message, maximumProgress)¶

Create a spinner progress dialog

Parameters

• message(optional) (str) – message

• maximunProgress(optional) (int) – dfault=100

dialogSetCurrentProgress(current)¶

Set progress dialog current value

Parameters

current (int) – current

dialogSetMaxProgress(max)¶

Set progress dialog maximum value

Parameters

max (int) – max

dialogCreateHorizontalProgress(title, message, maximumProgress)¶

Create a horizontal progress dialog

Parameters

• title(optional) (str) – title

• message(optional) (str) – message

• maximunProgress(optional) (int) – dfault=100

Alert¶

dialogCreateAlert(title, message)¶

Create alert dialog

Parameters

• title(optional) (str) – title

• message(optional) (str) – message

• maximunProgress(optional) (int) – dfault=100

Dialog Control¶

dialogSetPositiveButtonText(text)¶

Set alert dialog positive button text

Parameters

text (str) – text

dialogSetNegativeButtonText(text)¶

Set alert dialog negative button text

Parameters

text (str) – text

dialogSetNeutralButtonText(text)¶

Set alert dialog button text

Parameters

text (str) – text

dialogSetItems(items)¶

Set alert dialog list items

Parameters

items (list) – items

dialogSetSingleChoiceItems(items, selected)¶

Set alert dialog list items

Parameters

• items (list) – items

• selected (int) – selected item index (default=0)

dialogSetMultiChoiceItems(items, selected)¶

Set dialog multiple choice items and selection

Parameters

• items (list) – items

• selected (int) – selected item index (default=0)

addContextMenuItem(label, event, eventData)¶

Adds a new item to context menu

Parameters

• label (str) – label for this menu item

• event (str) – event that will be generated on menu item click

• eventData (object) – event object

addOptionsMenuItem(label, event, eventData, iconName)¶

Adds a new item to context menu

Parameters

• label (str) – label for this menu item

• event (str) – event that will be generated on menu item click

• eventData (object) – event object

• iconName (str) – Android system menu icon, see http://developer.android.com/reference/android/R.drawable.html

dialogGetResponse()¶

Returns dialog response

dialogGetSelectedItems()¶

This method provides list of items user selected

dialogDismiss()¶

Dismiss dialog

dialogShow()¶

Show dialog

Layout¶

fullShow(layout)¶

Show Full Screen

Parameters

layout (string) – String containing View layout

fullDismiss()¶

Dismiss Full Screen

fullQuery()¶

Get Fullscreen Properties

fullQueryDetail(id)¶

Get fullscreen properties for a specific widget

Parameters

id (str) – id of layout widget

fullSetProperty(id)¶

Set fullscreen widget property

Parameters

• id (str) – id of layout widget

• property (str) – name of property to set

• value (str) – value to set property to

fullSetList(id, list)¶

Attach a list to a fullscreen widget

Parameters

• id (str) – id of layout widget

• list (list) – List to set

fullKeyOverride(keycodes, enable)¶

Override default key actions

Parameters

• keycodes (str) – id of layout widget

• enable (bool) – List to set (default=true)

WebView¶

webViewShow()¶

Display a WebView with the given URL

Parameters

• url (str) – url

• wait(optional) (bool) – block until the user exits the WebView

Requirements¶

• Android device which has USB Host controller (and enabled in that firmware).

• Android 4.0 (API14) or later.

• USB Serial devices (see [Status](#Status)).

• USB Serial devices were not handled by Android kernel.

  > I heard some android phone handle USB Serial devices > make /dev/ttyUSB0 in kernel level. > In this case, Android does not be able to handle the device > from OS level.

  please check Android Applications be able to grab the target USB Devices, such as USB Device Info.

Status¶

• probably work with USB CDC, like FTDI, Arduino or else.

• 2012/09/10: work with 78K0F0730 device (new RL78) with Tragi BIOS board.

  M78K0F0730

• 2012/09/24: work with some pl2303 devcies.

Author¶

This facade developped by Kuri65536 you can see the commit log in it.

APIs¶

usbserialGetDeviceList()¶

Returns USB devices reported by USB Host API.

Returns

Returns “Map of id and string information Map<String, String>

usbserialDisconnect(connID)¶

Disconnect all USB-device

Parameters

connID (str) – connection ID

usbserialActiveConnections()¶

Returns active USB-device connections.

Returns

Returns “Active USB-device connections by Map UUID vs device-name.”

usbserialWriteBinary(base64, connID)¶

Send bytes over the currently open USB Serial connection.

Parameters

• base64 (str) –

• connId (str) –

usbserialReadBinary(bufferSize, connID)¶

Read up to bufferSize bytes and return a chunked, base64 encoded string

Parameters

• bufferSize (int) –

• connId (str) –

usbserialConnect(hash, options)¶

Connect to a device with USB-Host. request the connection and exit

Parameters

• hash (str) –

• options (str) –

Returns

Returns messages the request status

usbserialHostEnable()¶

Requests that the host be enable for USB Serial connections.

Returns

True if the USB Device is accesible

usbserialWrite(String ascii, String connID)¶

Sends ASCII characters over the currently open USB Serial connection

Parameters

• ascii (str) –

• connID (str) –

usbserialReadReady(connID)¶

Parameters

connID (str) –

Returns

True if the next read is guaranteed not to block

usbserialRead(connID, bufferSize)¶

Read up to bufferSize ASCII characters.

Parameters

• connID (str) –

• bufferSize (int) –

usbserialGetDeviceName(connID)¶

Queries a remote device for it’s name or null if it can’t be resolved

Parameters

connID (str) –